Differin

Differin this is gem for showing diff between files. Differin has multiple Engines to process data and Renderers to show the results.

Add this line to your application's Gemfile:

gem 'differin', '~> 0.1.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install differin

require 'differin'

diff = Differin::Diff.new('examples/file1.txt', 'examples/file2.txt')
diff.process

# or

Differin.diff('examples/file1.txt', 'examples/file2.txt')

Result of these commands:

[
  {
    status: :modified,
    lines: [1, 1],
    values: ['Some', 'Another']
  } ...
]

You can choose the Renderer for rendering processed data.

diff = Differin::Diff.new('examples/file1.txt', 'examples/file2.txt')

# These commands run processing and render data as Array or JSON
diff.process(renderer: Differin::Renderers::Array)
diff.process(renderer: Differin::Renderers::JSON)

# This command just re-render already processed data
diff.render(Differin::Renderers::Array)

# Short version
Differin.diff('examples/file1.txt', 'examples/file2.txt', renderer: Differin::Renderers::JSON)

• Differin::Renderers::Array
• Differin::Renderers::JSON
• Differin::Renderers::Hash
• More renderers in section Extensions

You can choose the Engine for file processing.

diff = Differin::Diff.new('examples/file1.txt', 'examples/file2.txt')

diff.process(engine: Differin::Engines::LCS)
diff.process(engine: Differin::Engines::LCS, renderer: Differin::Renderers::Hash)

• Differin::Engines::LCS
• More engines in section Extensions

Differin is flexible. You can easy create or just connect new renderers and engines.

• Differin::Renderers::Text

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Bug reports and pull requests are welcome on GitHub at MrEmelianenko/differin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.