Project

archimate-diff

0.0
No commit activity in last 3 years
No release in over 3 years
archimate-diffmmorga/archimate-diffHomepageDocumentationSource CodeBug TrackerWiki
A collection of tools to diff and merge ArchiMate files
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,637
Stars
1
Forks
0
Watchers
1
 Releases
Current version
0.1.0
Total releases
1
First release
2017-10-18
Latest release
2017-10-18
 Development
Primary Language
Ruby
Average date of last 50 commits
2017-07-05
Reverse Dependencies
0

 Dependencies

Development

awesome_print
>= 0
bundler
>= 0
faker
>= 0
guard
>= 0
guard-bundler
>= 0
guard-ctags-bundler
>= 0
guard-minitest
>= 0
kramdown
>= 0
minitest
>= 0
minitest-color
>= 0
minitest-matchers
>= 0
minitest-profile
>= 0
pry
>= 0
pry-byebug
>= 0
rake
>= 0
rsense
>= 0
ruby-prof
>= 0
simplecov
>= 0
simplecov-json
>= 0
yard
>= 0

Runtime

archimate
~> 1.1
highline
~> 1.7
nokogiri
~> 1.6
parallel
~> 1.11
ruby-progressbar
~> 1.8.1
thor
~> 0.19
 Project Readme

Archimate

Build Status

I also have included some Ruby code that plays with the .archimate file format produces by Archi to produce useful output.

Installation

Add this line to your application's Gemfile:

gem 'archimate'

And then execute:

$ bundle

Or install it yourself as:

$ gem install archimate

Usage

archimate

The example scripts are (some are planned):

command description
archimate help [COMMAND] Describe available commands or one specific command
archimate convert ARCHIFILE Convert the incoming file to the desired type
archimate dedupe ARCHIFILE de-duplicate elements in Archi file
archimate map ARCHIFILE EXPERIMENTAL: Produce a map of diagram links to a diagram
archimate merge ARCHIFILE1 ARCHIFILE2 *EXPERIMENTAL:*Merge two archimate files
archimate project ARCHIFILE PROJECTFILE *EXPERIMENTAL:*Synchronize an Archi file and an MSProject XML file
archimate svg ARCHIFILE Produce semantically meaningful SVG files from an Archi file
archimate lint ARCHIFILE Produce a report of warnings and issues in the Archi file

archidiff & archimerge

Archidiff is a set of tools to help with versioning an .archimate file from Archi in a version control system (like git). Eventually I want to provide diff and (3-way) merge tools that understand how Archi files are structured and avoid problems that happen when multiple people collaborate on a model.

To enable using these from the command line git, add these lines to your ~/.gitconfig replacing {PATH_TO_ARCHIDIFF} with the path to the archidiff binaries.

[difftool "archidiff"]
    cmd = {PATH_TO_ARCHIDIFF}/archidiff $LOCAL $REMOTE

[difftool "archidiff-summary"]
    cmd = {PATH_TO_ARCHIDIFF}/archidiff-summary $LOCAL $REMOTE

[mergetool "archimerge"]
	cmd = {PATH_TO_ARCHIDIFF}/archimerge $PWD/$BASE $PWD/$REMOTE $PWD/$LOCAL $PWD/$MERGED
	trustExitCode = false

Then to use the tool for diffing you can do this:

git difftool --tool archidiff 833cbb7 HEAD  -- path_to/my.archimate

or to see a summary of what changed between versions:

git difftool --tool archidiff-summary 833cbb7 HEAD  -- path_to/my.archimate

Finally, if you have a merge conflict, you can use archimerge to help make the merge sane:

git mergetool --tool archimerge -- path_to/my.archimate

fmtxml

Can be used as a textconv filter in .gitconfig to pre-format files for better diff use (for visual scanning). You'd set this up in your $HOME/.gitconfig file like this.

[diff "archimate"]
    textconv = fmtxml
    cachetextconv = true

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mmorga/archimate-diff.