happymapper-differ 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8762cf0e3b779fa85dad307850b73fff48980c87
+  data.tar.gz: 5d77b1d3cae7582cf841387ec3c98473a46866ff
+SHA512:
+  metadata.gz: e034ea0d0d7455438b6afe0cc6c60d870e78b85fe7afcc9c22a671a8af8e84546e222e64a51cad1d3223c1d3808250f52f78e48ea97dd8031923d69734dbfe1e
+  data.tar.gz: a1d3704b0af7d435e5625404f1ac4c847af7a72463b2304815e55fb9c6fd1fd1a1c496c34c67bd63abf112c51a45f26441e3219381e9db2a6b36c067e53cc612

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    happymapper_differ (0.1)
+      nokogiri-happymapper (~> 0.5.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.9.0)
+    debugger-linecache (1.2.0)
+    mini_portile (0.6.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    nokogiri-happymapper (0.5.9)
+      nokogiri (~> 1.5)
+    rake (10.4.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  byebug (~> 3.5)
+  happymapper_differ!
+  rake (~> 10.0)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Weir john.weir@pharos-ei.com, Pharos Enterprise Intelligence LLC
+
+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,89 @@
+# HappyMapper::Differ
+
+In the unlikely scenario you use [HappyMapper](
+https://github.com/dam5s/happymapper ) and you need to find differences between
+two documents, this could be a solution.
+
+Ok, your probably won't use or need this. But since I enjoy writing to myself here is how to use it.
+
+__Note: this library is wildly memory inefficient__
+
+````ruby
+def left
+  %Q{
+  <person name="James">
+    <item><name>Car</name></item>
+    <item><name>Box</name></item>
+  </person>
+  }
+end
+
+def right
+  %Q{
+  <person name="Carl">
+    <item><name>Car</name></item>
+    <item><name>Red Box</name></item>
+    <item><name>Cup</name></item>
+  </person>
+  }
+end
+
+require 'happymapper_differ'
+
+class Person
+  include HappyMapper
+
+  tag 'person'
+  attribute :name, String
+  has_many :items, "Item"
+end
+
+class Item
+  include HappyMapper
+  has_one :name, String
+end
+
+result = HappyMapper::Differ.new(Person.parse(left), Person.parse(right)).diff
+
+result.changed?
+#=> true
+
+result.changes
+#=> {"name"=>"Carl", "items"=>[#<Item:0x007ffd2d8d5a68 @name="Red Box">, #<Item:0x007ffd2d8d5630 @name="Cup">]}
+
+result.name.changed?
+#=> true
+
+result.name.was
+#=> "Carl"
+
+result.items[0].changed?
+#=> false
+result.items[1].changes?
+#=> {"name"=>"Red Box"}
+result.items[2].changed?
+#=> true
+result.items[2]
+#=> nil
+result.items[2].was
+#=> #<Item:0x007fde2c045ee0 @name="Cup">
+````
+
+### Extended methods
+
+HappyMapper::Differ extends each HappyMapper instance and element with the following methods:
+
+|method|purpose|
+|------|-------|
+|changed?| returns true if this element, or a child has changed |
+|changes | returns a has with each element or attribute which changed, and changed value |
+|was | returns the prior(value from the right). If there is no change this will be the current value. |
+
+
+## Contributing
+
+1. Fork it ( https://github.com/pharos-ie/happymapper-differ/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end
+

data/happymapper-differ.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'happymapper_differ'
+
+Gem::Specification.new do |spec|
+  spec.name          = "happymapper-differ"
+  spec.version       = HappyMapper::Differ::VERSION
+  spec.authors       = ["John Weir"]
+  spec.email         = ["john@smokinggun.com"]
+  spec.summary       = %q{Find changes between two like HappyMapper objects}
+  spec.description   = %q{
+    In the unlikely event you are using HappyMapper, and the more unlikely
+    event you need to find changes between two HappyMapper objects,
+    HappyMapper::Differ might help you.
+
+    HappyMapper::Differ takes two HappyMapper objects and compares all the
+    attributes and elements.  It modfies each element to include if it has changed
+    and what it changes are.
+  }
+
+  spec.homepage      = "https://github.com/pharos-ei/happymapper-differ"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri-happymapper", "~> 0.5"
+
+  spec.add_development_dependency "byebug", "~> 3.5"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/happymapper/differ.rb

@@ -0,0 +1,132 @@
+module HappyMapper
+  class Differ 
+    VERSION = 0.1
+
+    def initialize(left, right)
+      @left = left
+      @right = right
+    end
+
+    def changed?
+      @left.to_xml == @right.to_xml
+    end
+
+    # Diff is a memory ineffecient and ugly method to find what elements and
+    # attributes have changed and how.
+    #
+    # It extends each element and attribute with the DiffedItem module
+    # and makes a clone of the original element for comparison.
+    def diff
+      out = @left
+      setup(@left, @right)
+
+      all = out.class.attributes + out.class.elements
+
+      # setup for each element (has_one and has_many) and attribute
+      all.map(&:name).compact.each do |name|
+        value = out.send(name)
+        if value.nil?
+          value = NilLike.new 
+          out.send("#{name}=", value)
+        end
+
+        if value.is_a?(Array)
+          # Find the side with the most items
+          # If the right has more, the left will be padded with NilLike instances
+          count = [value.size, (@right.send(name) || []).size].max
+
+          count.times do |i|
+            value[i] = NilLike.new if value[i].nil?
+            setup_element(value[i], @right.send(name)[i])
+          end
+        else
+          setup_element(value, @right.send(name))
+        end
+      end
+
+      out
+    end
+
+    def handle_nil(name)
+      out.send("#{name}=", NilLike.new)
+    end
+
+    def setup(item, compared)
+      n = item.clone
+      item.extend(DiffedItem)
+      item.compared = compared 
+      item.original = n
+    end
+
+    def setup_element(item, compared)
+      if(item.is_a?(HappyMapper))
+        Differ.new(item, compared).diff
+      else
+        setup(item, compared)
+      end
+    end
+
+    # nil can't be cloned or extended
+    # so this object behaves like nil
+    class NilLike
+      def nil?
+        true
+      end
+
+      def to_s
+        "nil"
+      end
+
+      def inspect
+        nil.inspect
+      end
+    end
+  end
+
+  module DiffedItem
+    attr_accessor :original
+
+    # The object this item is being compared to
+    attr_accessor :compared
+    alias :was :compared
+
+    def changed?
+      original != compared
+    end
+
+    def changes
+      cs = {} # the changes
+
+      original.class.attributes.map(&:name).each do |attr|
+        other_value = compared.send(attr)
+        if original.send(attr) != other_value
+          cs[attr] = other_value
+        end
+      end
+
+      original.class.elements.map(&:name).each do |name|
+        other_els = compared.send(name)
+        this_els  = original.send(name)
+
+        if this_els.is_a?(Array)
+          this_els.each_with_index do |el, i|
+            if el != other_els[i]
+              cs[name] ||= []
+              cs[name] << other_els[i]
+            end
+          end
+        else
+          if this_els != other_els
+            cs[name] = other_els
+          end
+        end
+      end
+
+      cs
+    end
+
+    def ==(other)
+      original == other
+    end
+  end
+end

data/lib/happymapper_differ.rb

@@ -0,0 +1,11 @@
+require 'happymapper'
+
+module HappyMapper
+  require 'happymapper/differ'
+
+  # equality based on the underlying XML
+  def ==(other)
+    self.to_xml == other.to_xml
+  end
+end
+

data/test/happymapper_differ_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+describe "HappyMapper with Comparable" do
+  let(:left) { TParent.parse(sample_a) }
+  let(:right) { TParent.parse(sample_b) }
+
+  it "sez two identical documents should be equal" do
+    assert_equal left, TParent.parse(sample_a)
+  end
+
+  it "sez two different documents should not be equal" do
+    refute_equal left, right
+  end
+
+  describe HappyMapper::Differ do
+    let(:result) { HappyMapper::Differ.new(left, right).diff }
+
+    it "finds attribute changes" do
+      result = HappyMapper::Differ.new(
+        TParent.parse("<parent name='Roz'/>"),
+        TParent.parse("<parent name='Alex'/>"),
+      ).diff
+
+      assert result.changed?
+      assert result.name.changed?
+      assert_equal({"name" => "Alex"}, result.changes)
+    end
+
+    it "finds changes to has_one elements" do
+      a = TAddress.parse(address_a)
+      b = TAddress.parse(address_b)
+      result = HappyMapper::Differ.new(a, b).diff
+
+      assert_equal({"street" => "123 Park Ave"}, result.changes)
+    end
+
+    it "finds changes to has_many elements" do
+      assert ! result.children[0].changed?
+      assert ! result.children[1].changed?
+      assert result.children[2].changed?
+      assert_equal({"name" => "Vlad", "children" => [right.children[2]]}, result.changes)
+      assert_equal({}, result.children[1].changes)
+      assert_equal({"name" => "Alex"}, result.children[2].changes)
+    end
+
+    it "finds changes to  nested data" do
+      result = HappyMapper::Differ.new(
+        TParent.parse(nested_a),
+        TParent.parse(nested_b),
+      ).diff
+
+      assert result.changed?
+      assert result.children[0].changed?
+      assert result.children[0].address.changed?
+      assert result.children[0].address.street.changed?
+
+      assert_equal({"children" => [result.children[0].compared]}, result.changes)
+      assert_equal({"street" => "789 Maple St"}, result.children[0].address.changes)
+      assert_equal("789 Maple St", result.children[0].address.street.compared)
+    end
+
+    it "find changes when the value is nil" do
+      result = HappyMapper::Differ.new(
+        TParent.parse("<parent/>"),
+        TParent.parse("<parent name='Alex'/>"),
+      ).diff
+
+      assert result.changed?
+      assert result.name.changed?
+      assert_equal 'Alex', result.name.compared
+    end
+
+    it "finds changes when the left side element count is less than the right" do
+      result = HappyMapper::Differ.new(
+        TParent.parse(sample_a),
+        TParent.parse(sample_a_plus),
+      ).diff
+
+      assert result.changed?
+      assert result.children[3].changed?
+    end
+  end
+
+  def sample_a
+    <<-XML
+<parent name="Roz">
+  <child name="Joe"/>
+  <child name="Jane"/>
+  <child name="Jason"/>
+</parent>
+    XML
+  end
+
+  def sample_a_plus
+    <<-XML
+<parent name="Roz">
+  <child name="Joe"/>
+  <child name="Jane"/>
+  <child name="Jason"/>
+  <child name="Baxter"/>
+</parent>
+    XML
+  end
+
+  def sample_b
+    <<-XML
+<parent name="Vlad">
+  <child name="Joe"/>
+  <child name="Jane"/>
+  <child name="Alex"/>
+</parent>
+    XML
+  end
+
+  def address_a
+    <<-XML
+    <address>
+      <name>Mr. Jones</name>
+      <street>123 Maple St</street>
+      <city>Brooklyn</city>
+    </address>
+    XML
+  end
+
+  def address_b
+    <<-XML
+    <address>
+      <name>Mr. Jones</name>
+      <street>123 Park Ave</street>
+      <city>Brooklyn</city>
+    </address>
+    XML
+  end
+
+  def nested_a
+    <<-XML
+<parent name="Roz">
+  <child name="Joe">
+    <address>
+      <street>123 Maple St</street>
+      <city>Brooklyn</city>
+    </address>
+  </child>
+  <child name="Jane">
+    <address>
+      <street>567 Olice St</street>
+      <city>Brooklyn</city>
+    </address>
+  </child>
+</parent>
+    XML
+  end
+
+  # Joe's address changed
+  def nested_b
+    <<-XML
+<parent name="Roz">
+  <child name="Joe">
+    <address>
+      <street>789 Maple St</street>
+      <city>Brooklyn</city>
+    </address>
+  </child>
+  <child name="Jane">
+    <address>
+      <street>567 Olice St</street>
+      <city>Brooklyn</city>
+    </address>
+  </child>
+</parent>
+    XML
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/pride'
+require './lib/happymapper_differ'
+require 'byebug'
+
+class TParent
+  include HappyMapper
+  tag 'parent'
+
+  attribute :name, String
+  has_many :children, "TChild", tag: 'child'
+end
+
+class TChild
+  include HappyMapper
+  tag 'child'
+
+  attribute :name, String
+  has_one :address, "TAddress"
+end
+
+class TAddress
+  include HappyMapper
+  tag 'address'
+
+  has_one :name, String
+  has_one :street, String
+  has_one :city, String
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: happymapper-differ
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- John Weir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri-happymapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: "\n    In the unlikely event you are using HappyMapper, and the more
+  unlikely\n    event you need to find changes between two HappyMapper objects,\n
+  \   HappyMapper::Differ might help you.\n\n    HappyMapper::Differ takes two HappyMapper
+  objects and compares all the\n    attributes and elements.  It modfies each element
+  to include if it has changed\n    and what it changes are.\n  "
+email:
+- john@smokinggun.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- happymapper-differ.gemspec
+- lib/happymapper/differ.rb
+- lib/happymapper_differ.rb
+- test/happymapper_differ_test.rb
+- test/test_helper.rb
+homepage: https://github.com/pharos-ei/happymapper-differ
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Find changes between two like HappyMapper objects
+test_files:
+- test/happymapper_differ_test.rb
+- test/test_helper.rb