differin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10eb8045cd648d291502b0a6cd8eb6bbb130bb41
+  data.tar.gz: b87230296af679bfeb816e0e1dce9f19740ed430
+SHA512:
+  metadata.gz: 10f03deb0ad5dd7cf088479060b557741e1f401b1de4c68f49411479d0718573c4bc88dc47a83a0e5b401559147341234884467d38cdbab3be8af9fdbc13c13e
+  data.tar.gz: 3ac81d3fc130ae0dbadd6d80259395d1b3f9c2f0c40c6d9cd372f7bd6d819502127939d0a96bde2ae5b921ffc4d55d345ff2728b32fd5ba51b92f822d5752600

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at andrew.emelianenko@dev-pro.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in differin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 andrew.emelianenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# Differin
+
+#### IMPORTANT: This GEM is created as test task and not ready for production yet.
+
+**Differin** this is gem for showing diff between files. Differin has multiple Engines to process data and Renderers to show the results.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'differin', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install differin
+
+## Usage
+
+~~~ruby
+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:
+~~~ruby
+[
+  {
+    status: :modified,
+    lines: [1, 1],
+    values: ['Some', 'Another']
+  } ...
+]
+~~~
+
+### Renderers
+
+You can choose the Renderer for rendering processed data.
+
+~~~ruby
+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)
+~~~
+
+#### Available renderers
+
+- `Differin::Renderers::Array`
+- `Differin::Renderers::JSON`
+- `Differin::Renderers::Hash`
+- More renderers in section **Extensions**
+
+### Engines
+
+You can choose the Engine for file processing.
+
+~~~ruby
+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)
+~~~
+
+#### Available engines
+
+- `Differin::Engines::LCS`
+- More engines in section **Extensions**
+
+## Extensions
+
+**Differin is flexible.** You can easy create or just connect new **renderers** and **engines**.
+
+#### Available renderers
+
+- [Differin::Renderers::Text](http://github.com/MrEmelianenko/differin-renderers-text)
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/differin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'differin'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/differin.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'differin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'differin'
+  spec.version       = Differin::VERSION
+  spec.authors       = ['Andrew Emelianenko']
+  spec.email         = ['emelianenko.web@gmail.com']
+
+  spec.summary       = 'Show diff of files'
+  spec.description   = 'Diff files with multiple engines and renderers.'
+  spec.homepage      = 'http://github.com/MrEmelianenko/differin'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'diff-lcs', '~> 1.2.5'
+end

data/examples/file1.txt

@@ -0,0 +1,4 @@
+Some
+Simple
+Text
+File

data/examples/file2.txt

@@ -0,0 +1,6 @@
+Another
+Text
+File
+With
+Additional
+Lines

data/lib/differin.rb

@@ -0,0 +1,52 @@
+# frozen-string-literal: true
+require 'differin/null'
+require 'differin/exceptions'
+require 'differin/file'
+require 'differin/diff'
+require 'differin/version'
+require 'differin/engines/base'
+require 'differin/engines/lcs'
+require 'differin/engines/system'
+require 'differin/renderers/base'
+require 'differin/renderers/hash'
+require 'differin/renderers/json'
+require 'differin/renderers/array'
+
+module Differin
+  # List of allowed extensions
+  ALLOWED_EXTENSIONS = %w(txt)
+
+  # List of allowed engines
+  ALLOWED_ENGINES = [
+    Differin::Engines::LCS,
+    Differin::Engines::System
+  ]
+
+  # List of allowed renderers
+  ALLOWED_RENDERERS = [
+    Differin::Renderers::Hash,
+    Differin::Renderers::JSON,
+    Differin::Renderers::Array
+  ]
+
+  # Line statuses
+  MODIFIED = :modified
+  ADDED = :added
+  REMOVED = :removed
+  EQUAL = :equal
+
+  class << self
+    def diff(file1, file2, options = {})
+      diff = Differin::Diff.new(file1, file2)
+      diff.process(options)
+    end
+
+    def engine_exists?(engine)
+      ALLOWED_ENGINES.include?(engine)
+    end
+
+    def renderer_exists?(renderer)
+      ALLOWED_RENDERERS.include?(renderer)
+    end
+  end
+end

data/lib/differin/diff.rb

@@ -0,0 +1,53 @@
+# frozen-string-literal: true
+module Differin
+  class Diff
+    # Getters
+    attr_reader :file1, :file2, :options
+
+    def initialize(file1, file2)
+      @file1 = Differin::File.new(file1)
+      @file2 = Differin::File.new(file2)
+    end
+
+    def process(options_outer = {})
+      load_options(options_outer)
+
+      self.engine = options[:engine].new(self)
+      engine.run
+
+      self.renderer = options[:renderer].new(self)
+      renderer.render
+    end
+
+    def result
+      engine.result
+    end
+
+    def render(as = nil)
+      return renderer.render if as.nil?
+      Differin.renderer_exists?(as) or fail Differin::InvalidRenderer
+
+      renderer = as.new(self)
+      renderer.render
+    end
+
+    private
+
+    # Setters
+    attr_writer :file1, :file2, :options
+
+    # Getters/Setters
+    attr_accessor :engine, :renderer
+
+    def load_options(options_outer)
+      # noinspection RubyArgCount
+      self.options = {
+        engine: Differin::Engines::LCS,
+        renderer: Differin::Renderers::Hash
+      }.merge(options_outer)
+
+      Differin.engine_exists?(options[:engine]) or fail Differin::InvalidEngine
+      Differin.renderer_exists?(options[:renderer]) or fail Differin::InvalidRenderer
+    end
+  end
+end

data/lib/differin/engines/base.rb

@@ -0,0 +1,29 @@
+# frozen-string-literal: true
+module Differin
+  module Engines
+    class Base
+      # Getters
+      attr_reader :diff, :result, :options
+
+      def initialize(diff, options = {})
+        @diff = diff
+        @result = Differin::NULL
+        @options = options
+      end
+
+      def run
+        return result if result != Differin::NULL
+        self.result = run_engine
+      end
+
+      private
+
+      # Setters
+      attr_writer :diff, :result, :options
+
+      def run_engine
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/differin/engines/lcs.rb

@@ -0,0 +1,50 @@
+# frozen-string-literal: true
+require 'diff-lcs'
+
+module Differin
+  module Engines
+    class LCS < Differin::Engines::Base
+      private
+
+      # Getters/Setters
+      attr_accessor :sequence1, :sequence2, :engine_result
+
+      def run_engine
+        load_sequences
+        run_diff_lcs
+        convert_result
+      end
+
+      def load_sequences
+        self.sequence1 = diff.file1.lines
+        self.sequence2 = diff.file2.lines
+      end
+
+      def run_diff_lcs
+        self.engine_result = ::Diff::LCS.sdiff(sequence1, sequence2)
+      end
+
+      def convert_result
+        engine_result.map do |row|
+          row = row.to_a
+
+          {
+            status: map_status(row[0]),
+            lines: [row[1][0], row[2][0]],
+            values: [row[1][1], row[2][1]]
+          }
+        end
+      end
+
+      # Map statuses from LCS to Differin
+      def map_status(status)
+        {
+          Differin::MODIFIED  => '!',
+          Differin::EQUAL     => '=',
+          Differin::ADDED     => '+',
+          Differin::REMOVED   => '-'
+        }.key(status)
+      end
+    end
+  end
+end

data/lib/differin/engines/system.rb

@@ -0,0 +1,15 @@
+# frozen-string-literal: true
+module Differin
+  module Engines
+    class System < Differin::Engines::Base
+      private
+
+      def run_engine
+        {
+          a: :a,
+          b: :b
+        }
+      end
+    end
+  end
+end

data/lib/differin/exceptions.rb

@@ -0,0 +1,14 @@
+# frozen-string-literal: true
+module Differin
+  class BaseError < StandardError; end
+
+  # Files
+  class FileNotFound < Differin::BaseError; end
+  class InvalidFile < Differin::BaseError; end
+
+  # Engines
+  class InvalidEngine < Differin::BaseError; end
+
+  # Renderers
+  class InvalidRenderer < Differin::BaseError; end
+end

data/lib/differin/file.rb

@@ -0,0 +1,48 @@
+# frozen-string-literal: true
+module Differin
+  class File
+    # Getters
+    attr_reader :file
+
+    def initialize(file)
+      @file = load_file(file)
+      fail Differin::InvalidFile unless valid?
+    end
+
+    def filename
+      ::File.basename(file.path)
+    end
+
+    def extension
+      ::File.extname(file.path).delete('.')
+    end
+
+    def lines
+      return @lines if defined?(@lines)
+      @lines = readlines
+    end
+
+    def valid?
+      return false unless ALLOWED_EXTENSIONS.include?(extension)
+      true
+    end
+
+    private
+
+    # Setters
+    attr_writer :file
+
+    def load_file(file)
+      return file if file.is_a?(::File)
+      fail Differin::FileNotFound unless ::File.exist?(file.to_s)
+
+      ::File.open(file.to_s, 'r')
+    end
+
+    def readlines
+      file.readlines.map do |line|
+        line.delete("\r").delete("\n")
+      end
+    end
+  end
+end

data/lib/differin/null.rb

@@ -0,0 +1,18 @@
+# frozen-string-literal: true
+module Differin
+  class NULL
+    class << self
+      def nil?
+        true
+      end
+
+      def present?
+        false
+      end
+
+      def blank?
+        true
+      end
+    end
+  end
+end

data/lib/differin/renderers/array.rb

@@ -0,0 +1,16 @@
+# frozen-string-literal: true
+module Differin
+  module Renderers
+    class Array < Differin::Renderers::Base
+      def render
+        diff.result.map do |row|
+          [
+            row[:status],
+            [row[:lines].first, row[:values].first],
+            [row[:lines].last, row[:values].last]
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/differin/renderers/base.rb

@@ -0,0 +1,23 @@
+# frozen-string-literal: true
+module Differin
+  module Renderers
+    class Base
+      # Getters
+      attr_reader :diff, :options
+
+      def initialize(diff, options = {})
+        @diff = diff
+        @options = options
+      end
+
+      def render
+        fail NotImplementedError
+      end
+
+      private
+
+      # Setters
+      attr_writer :diff, :options
+    end
+  end
+end

data/lib/differin/renderers/hash.rb

@@ -0,0 +1,10 @@
+# frozen-string-literal: true
+module Differin
+  module Renderers
+    class Hash < Differin::Renderers::Base
+      def render
+        diff.result
+      end
+    end
+  end
+end

data/lib/differin/renderers/json.rb

@@ -0,0 +1,12 @@
+# frozen-string-literal: true
+require 'json'
+
+module Differin
+  module Renderers
+    class JSON < Differin::Renderers::Base
+      def render
+        diff.result.to_json
+      end
+    end
+  end
+end

data/lib/differin/version.rb

@@ -0,0 +1,4 @@
+# frozen-string-literal: true
+module Differin
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: differin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Emelianenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+description: Diff files with multiple engines and renderers.
+email:
+- emelianenko.web@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- differin.gemspec
+- examples/file1.txt
+- examples/file2.txt
+- lib/differin.rb
+- lib/differin/diff.rb
+- lib/differin/engines/base.rb
+- lib/differin/engines/lcs.rb
+- lib/differin/engines/system.rb
+- lib/differin/exceptions.rb
+- lib/differin/file.rb
+- lib/differin/null.rb
+- lib/differin/renderers/array.rb
+- lib/differin/renderers/base.rb
+- lib/differin/renderers/hash.rb
+- lib/differin/renderers/json.rb
+- lib/differin/version.rb
+homepage: http://github.com/MrEmelianenko/differin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Show diff of files
+test_files: []