icmp 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c63d2ee1af9ab07e259eeaa5b75892d277701f70
+  data.tar.gz: e0bbe8d2704c9d118a026bb739aecf9cf73a4595
+SHA512:
+  metadata.gz: 2226f3934d31d0352ea17a289d89a4dad36f0dc5bfac9ed84ac29385cc9086f3f132837b068e27e64e4213ab6239a792e0f8a04d8ddd0fe73dd3eccfc6dc4234
+  data.tar.gz: d34b9ef5e3b1eb9bc55232fdc98be1c0a172679b50d0844696183c350df03fe697448d98e27c38240ae314cea4d6dafbdc6eed02d26ce52f43391b0f479aad8f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Artem Baikuzin
+
+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,127 @@
+# Interactive comparison of two sorted arrays
+
+This gem provides module `Icmp` with only method `compare(current, previous)`. It yields events while comparing two arrays:
+
+1. `:compare` - items present in both arrays
+2. `:added` - item present only in current array
+3. `:removed` - item present only in previous array
+
+Arrays should be sorted by key. Method takes O(n) time to process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'icmp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install icmp
+
+## Usage
+
+```ruby
+require 'icmp'
+
+# id - key element
+current = [{ id: 1, state: :accept },
+           { id: 2, state: :new },
+           { id: 4, state: :canceled }]
+           
+previous = [{ id: 1, state: :new },
+            { id: 3, state: :in_progress },
+            { id: 4, state: :canceled }]
+            
+# Sets proc for key retrieve
+Icmp.compare(current, previous, proc { |i| i[:id] }) do |event, cur_item, prev_item|
+  print "ID: #{cur_item[:id]}, "
+
+  case event
+  when :compare
+    if cur_item[:state] != prev_item[:state]
+      puts "new state = #{cur_item[:state]}, old state = #{prev_item[:state]}"
+    else
+      puts "item is not changed, state = #{cur_item[:state]}"
+    end
+  when :added
+    puts "item added with state = #{cur_item[:state]}"
+  when :removed
+    puts "item removed with state = #{cur_item[:state]}"
+  end
+end
+```
+
+#### Output
+```
+ID: 1, new state = accept, old state = new
+ID: 2, item added with state = new
+ID: 3, item removed with state = in_progress
+ID: 4, item is not changed, state = canceled
+```
+
+## Benchmark
+```ruby
+require 'icmp'
+require 'benchmark/ips'
+
+current = (1..20_000).to_a
+previous = current.dup
+
+Benchmark.ips do |x|
+  x.report('icmp') do
+    Icmp.compare(current, previous) do |event, cur_item, prev_item|
+    end
+  end
+
+  x.report('binary search') do
+    current.each do |cur_item|
+      prev_item = previous.bsearch { |i| cur_item - i }
+    end
+  end
+
+  x.report('nested loops') do
+    current.each do |cur_item|
+      previous.each do |i|
+        if cur_item == i
+          break
+        end
+      end
+    end
+  end
+
+  x.compare!
+end
+```
+
+#### Output
+```
+Warming up --------------------------------------
+                icmp    12.000  i/100ms
+       binary search     7.000  i/100ms
+        nested loops     1.000  i/100ms
+Calculating -------------------------------------
+                icmp    135.101  (± 5.9%) i/s -    684.000  in   5.079674s
+       binary search     74.424  (± 4.0%) i/s -    378.000  in   5.089745s
+        nested loops      0.111  (± 0.0%) i/s -      1.000  in   8.970797s
+
+Comparison:
+                icmp:      135.1 i/s
+       binary search:       74.4 i/s - 1.82x  slower
+        nested loops:        0.1 i/s - 1211.96x  slower
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ybinzu/icmp.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/icmp.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'icmp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'icmp'
+  spec.version       = Icmp::VERSION
+  spec.authors       = ['Artem Baikuzin']
+  spec.email         = ['artembaykuzin@gmail.com']
+
+  spec.summary       = %q{Interactive comparison of two sorted arrays}
+  spec.description   = %q{Compare two arrays in interactive way, yields block with arguments: event, current_item, previous_item. Takes O(n) time.}
+  spec.homepage      = 'https://github.com/ybinzu/icmp'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|benchmark)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/icmp.rb

@@ -0,0 +1,83 @@
+module Icmp
+  ##
+  # Interactively compares two sorted enumerables by key. Yields a block with
+  # event (:compare, :added, :removed), current and previous enumerable items.
+  #
+  # ==== Parameters
+  # * <tt>current</tt> - Array with current values
+  # * <tt>previous</tt> - Array to compare with, previous values
+  # * <tt>key_proc</tt> - Proc for retrieve key value from item. Sets to item
+  #   by default
+  #
+  # ==== Example
+  #   require 'icmp'
+  #
+  #   # id - key element
+  #   current = [{ id: 1, state: :accept },
+  #              { id: 2, state: :new },
+  #              { id: 4, state: :canceled }]
+  #
+  #   previous = [{ id: 1, state: :new },
+  #               { id: 3, state: :in_progress },
+  #               { id: 4, state: :canceled }]
+  #
+  #   # Sets proc for key retrieve
+  #   Icmp.compare(current, previous, proc { |i| i[:id] }) do |event, cur_item, prev_item|
+  #     print "ID: #{cur_item[:id]}, "
+  #
+  #     case event
+  #     when :compare
+  #       if cur_item[:state] != prev_item[:state]
+  #         puts "new state = #{cur_item[:state]}, old state = #{prev_item[:state]}"
+  #       else
+  #         puts "item is not changed, state = #{cur_item[:state]}"
+  #       end
+  #     when :added
+  #       puts "item added with state = #{cur_item[:state]}"
+  #     when :removed
+  #       puts "item removed with state = #{cur_item[:state]}"
+  #     end
+  #   end
+  #
+  # ===== Output
+  #
+  #  ID: 1, new state = accept, old state = new
+  #  ID: 2, item added with state = new
+  #  ID: 3, item removed with state = in_progress
+  #  ID: 4, item is not changed, state = canceled
+  #
+  def self.compare(current, previous, key_proc = proc { |item| item })
+    raise RuntimeError.new('Block should be specified') unless block_given?
+
+    while current.size > 0 && previous.size > 0
+      cur_item = current.first
+      prev_item = previous.first
+
+      cur_key = key_proc.call(cur_item)
+      prev_key = key_proc.call(prev_item)
+
+      if cur_key == prev_key
+        yield :compare, cur_item, prev_item
+
+        current = current.drop(1)
+        previous = previous.drop(1)
+      elsif cur_key < prev_key
+        yield :added, cur_item
+
+        current = current.drop(1)
+      else
+        yield :removed, prev_item
+
+        previous = previous.drop(1)
+      end
+    end
+
+    current.each do |item|
+      yield :added, item
+    end
+
+    previous.each do |item|
+      yield :removed, item
+    end
+  end
+end

data/lib/icmp/version.rb

@@ -0,0 +1,3 @@
+module Icmp
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: icmp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Artem Baikuzin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 'Compare two arrays in interactive way, yields block with arguments:
+  event, current_item, previous_item. Takes O(n) time.'
+email:
+- artembaykuzin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- icmp.gemspec
+- lib/icmp.rb
+- lib/icmp/version.rb
+homepage: https://github.com/ybinzu/icmp
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Interactive comparison of two sorted arrays
+test_files: []