diffable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Liz Conlan
+
+MIT License
+
+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,112 @@
+# Diffable
+
+Diffable provides a mixin that can be used to extend any ActiveRecord object to provide diff 
+functionality. Calling the diff method compares the receiver against another 
+object and returns a Hash of differences found (presented as a description of 
+the changes between the second object and the receiver - as if trying to restore
+the calling object from its replacement).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'diffable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install diffable
+
+## Usage
+
+Require the gem in the source file that includes the relevant model code:
+
+    require 'diffable'
+    
+Use the include statement to add Diffable support to each model that needs it:
+
+    class ModelA < ActiveRecord::Base
+      include Diffable
+    end
+    
+You can then call the `diff` method on any instance of that model class:
+
+    object1 = ModelA.new(:name => "test")
+    object2 = ModelA.new(:name => "test2")
+    difference = object1.diff(object2)
+
+## Behaviour
+
+There are 3 different types of change that can be returned by the diff method: 
+modified, new and deleted. These are indicated using a `:change_type` 
+key/value within the results Hash.
+
+When an object is flagged as **modified**, its identifier and any of the altered 
+fields are returned, e.g.:
+
+    {:change_type => "modified", :id => 42, :name => "test1"}
+
+When an object is flagged as **new**, only its identifier is returned. Sample output:
+
+    {:change_type => "new", :id => 42}
+
+When an object is flagged as **deleted**, all of its attributes are returned in 
+the diff Hash. Sample output:
+
+    {:change_type => "deleted", :id => 42, :name => "test", :desc => "db test"}
+
+### Excluding fields
+
+If there are any database fields that should not be returned as part of 
+a **deleted** object's data, they can be excluded at the model level using 
+`set_excluded_fields`:
+
+    class ModelB < ActiveRecord::Base
+      include Diffable
+      set_excluded_fields :ignore_me
+    end
+
+### Conditional fields
+
+If a field value should always be included as part of a modified object's 
+data, this can be set at the model level using `set_conditional_fields`:
+
+    class ModelC < ActiveRecord::Base
+      include Diffable
+      set_conditional_fields :metadata, :history
+    end
+
+### Using with related tables
+
+If your model uses `has_many` or `has_one`, the changes to these dependent 
+objects can also be captured by the diff method, provided that their model 
+definitions also use the `include Diffable` statement (otherwise they will 
+be ignored). However, you will also need to inform the model which field can 
+be used to uniquely identify records within the set returned for a particular 
+parent object using `set_unique_within_group`. This should be a generated 
+field as `:id` is unlikely to be suitable.
+
+    class ModelD < ActiveRecord::Base
+      include Diffable
+      has_many :catalogue_entries
+    end
+    
+    class CatalogueEntries < ActiveRecord::Base
+      include Diffable
+      belongs_to :model_d
+      set_unique_within_group :generated_identifier
+      
+      ...
+      
+    end
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Run the rake spec task"
+task :test => [:spec]
+ 
+task :default => :test

data/diffable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diffable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "diffable"
+  spec.version       = Diffable::VERSION
+  spec.authors       = ["Liz Conlan"]
+  spec.email         = ["lizconlan@gmail.com"]
+  spec.description   = %q{Facilitates Active::Record object diffing}
+  spec.summary       = %q{Adds ability to compare 2 Active::Record objects; returns the differences as a hash}
+  spec.homepage      = "https://github.com/lizconlan/diffable"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files`.split($/)
+  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 "activerecord", ">= 3.2"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "activerecord-nulldb-adapter"
+end

data/lib/diffable.rb

@@ -0,0 +1,302 @@
+require "diffable/version"
+
+# :main: README.rdoc
+
+##
+# Diffable provides a mixin that can be used to extend any ActiveRecord object 
+# to provide diff functionality. Calling the diff method compares the receiver 
+# against another object and returns a Hash of differences found (presented as 
+# a description of the changes between the second object and the receiver - as 
+# if trying to restore the calling object from its replacement).
+
+module Diffable
+  def self.included base # :nodoc:
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+  
+  module InstanceMethods
+    ##
+    # Produces a Hash containing the differences between the calling object
+    # and the object passed in as a parameter
+    def diff(other)
+      check_class_compatibility(self, other)
+      
+      self_attribs = self.get_attributes(self.class.excluded_fields)
+      other_attribs = other.get_attributes(other.class.excluded_fields)
+      
+      change = compare_objects(self_attribs, other_attribs, self, other)
+      
+      #the last bit - no change, no report; simples
+      if other.class.conditional_fields
+        other.class.conditional_fields.each do |key|
+          change[key.to_sym] = eval("other.#{key}") unless change.empty?
+        end
+      end
+      change
+    end
+    
+    ##
+    # Fetches the attributes of the calling object, exluding the +id+ field 
+    # and any fields specified passed as an array of symbols via the +excluded+
+    # parameter
+    def get_attributes(excluded)
+      attribs = attributes.dup
+      attribs.delete_if { |key, value|
+        (!excluded.nil? and excluded.include?(key)) or key == "id" }
+    end
+    
+    ##
+    # Uses reflection to fetch the eligible associated objects for the current 
+    # object, excluding parent objects and child objects that do not include
+    # the Diffable mixin
+    def reflected_names(obj)
+      classes = obj.reflections
+      class_names = []
+      classes.each do |key, cl|
+        if eval(cl.class_name).respond_to?("diffable") \
+           and cl.association_class != ActiveRecord::Associations::BelongsToAssociation
+          class_names << key
+        end
+      end
+      class_names
+    end
+    
+    private
+    
+    def check_class_compatibility(current, other)
+      current_super = current.class.superclass
+      other_super = other.class.superclass
+      if current_super == ActiveRecord::Base || other_super == ActiveRecord::Base
+        if other.class != current.class && other.class != current_super && other_super != current.class
+          raise "Unable to compare #{current.class} to #{other.class}"
+        end
+      else
+        if current.class != other.class && other.class.superclass != current.class.superclass
+          raise "Unable to compare #{current.class} to #{other.class}"
+        end
+      end
+    end
+    
+    def find_in_array_by_ident(arr, value)
+      arr.select { |x| eval(%Q|x.#{x.class.unique_within_group}|) == value }.first
+    end
+    
+    def map_obj_idents(obj)
+      obj.map { |x| x.attributes[x.class.unique_within_group] }
+    end
+    
+    def ident_in_list?(ident, ident_list)
+      return true if ident_list.include?(ident)
+      false
+    end
+    
+    def compare_current_subs(current_obj_idents, previous_obj_idents, current_subs, previous_subs)
+      objects = []
+      current_obj_idents.each do |idnt|
+        current_sub = find_in_array_by_ident(current_subs, idnt)
+        previous_sub = find_in_array_by_ident(previous_subs, idnt)
+        
+        if ident_in_list?(idnt, previous_obj_idents)
+          #pre-existing thing, compare the differences...
+          current_attribs = current_sub.get_attributes(current_sub.class.excluded_fields)
+          previous_attribs = previous_sub.get_attributes(previous_sub.class.excluded_fields)
+          
+          obj = compare_objects(current_attribs, previous_attribs, current_sub, previous_sub, obj)
+          
+          #...and only store if something's changed
+          unless obj.empty?
+            obj[:change_type] = "modified"
+            objects << obj
+          end
+        else
+          #a new thing, just need to note its arrival
+          unique_field = current_sub.class.unique_within_group
+          objects << {unique_field.to_sym => eval("current_sub.#{unique_field}"), :change_type => "new"}
+        end
+      end
+      objects
+    end
+    
+    def preserve_deleted_by_ident(deleted_idents, previous_subs, previous_obj, sub)
+      objects = []
+      deleted_idents.each do |ident|
+        previous_sub = find_in_array_by_ident(eval("previous_obj.#{sub}.to_a"), ident)
+        obj = preserve_deleted_obj(previous_sub)
+        objects << obj
+      end
+      objects
+    end
+    
+    def compare_attributes(current, previous, current_obj, change={})
+      previous.each do |key, value|
+        change[key.to_sym] = value if value != current[key]
+      end
+      unless change.empty?
+        if current_obj.class.unique_within_group
+          unique_field = current_obj.class.unique_within_group
+          change[unique_field.to_sym] = eval("current_obj.#{unique_field}")
+        end
+      end
+      change
+    end
+    
+    def analyze_subobjects(current_obj, previous_obj, change={})
+      #need both - comparable objects need not have the same reflections
+      current_subs = reflected_names(current_obj)
+      previous_subs = reflected_names(previous_obj)
+      
+      #things that are available to the current object
+      current_subs.each do |sub|
+        objects = []
+        current_objects = current_obj.association(sub).target
+        previous_objects = previous_obj.respond_to?(sub) ? eval("previous_obj.#{sub}.to_a") : []
+        current_obj_idents = map_obj_idents(current_objects)
+        previous_obj_idents = map_obj_idents(previous_objects)
+        
+        #loop through the ids in the current block
+        objects += compare_current_subs(current_obj_idents, previous_obj_idents, current_objects, previous_objects)
+        
+        #look for ids that only exist in the previous block
+        objects += preserve_deleted_by_ident((previous_obj_idents - current_obj_idents), previous_subs, previous_obj, sub)
+        
+        #update time_blocks if any changes were found
+        change[sub] = objects unless objects.empty?
+      end
+      
+      #things that are only available to the previous object
+      (previous_subs - current_subs).each do |sub|
+        objects = []
+        previous_obj_idents = map_obj_idents(previous_obj)
+        objects += preserve_deleted_by_ident(previous_obj_idents, (previous_subs - current_subs), previous_obj, sub)
+        change[sub] = objects unless objects.empty?
+      end
+      change
+    end
+    
+    def preserve_deleted_obj(deleted, excluded_fields=self.class.excluded_fields)
+      obj = {}
+      #get attributes of object marked for deletion...
+      attribs = deleted.get_attributes(deleted.class.excluded_fields)
+      #...and copy them for preservation
+      attribs.keys.each do |att|
+        value = nil
+        if deleted.respond_to?(att)
+          value = eval("deleted.#{att}")
+        end
+        
+        obj[att.to_sym] = value unless value.nil?
+      end
+      
+      #look to see if our target object has sub-objects of its own
+      previous_sub_keys = reflected_names(deleted)
+      
+      #preserve subs
+      obj = preserve_deleted_subs(previous_sub_keys, deleted, obj)
+      
+      unless obj.empty?
+        if deleted.class.conditional_fields
+          deleted.class.conditional_fields.each do |key|
+            obj[key.to_sym] = eval("deleted.#{key}") unless obj.empty?
+          end
+        end
+        obj[:change_type] = "deleted"
+      end
+      obj
+    end
+    
+    def compare_objects(current_attribs, other_attribs, current, other, change={})
+      #compare the simple values
+      change = compare_attributes(current_attribs, other_attribs, current)
+      
+      #analyse the subobjects
+      change = analyze_subobjects(current, other, change)
+      
+      if other.class.conditional_fields
+        other.class.conditional_fields.each do |key|
+          change[key.to_sym] = eval("other.#{key}") unless change.empty?
+        end
+      end
+      change
+    end
+    
+    def preserve_deleted_subs(keys, deleted, change={})
+      keys.each do |sub|
+        subs = []
+        previous_subs = deleted.respond_to?(sub) ? eval("deleted.#{sub}.to_a") : []
+        previous_subs.each do |deleted_sub|  
+          preserved = preserve_deleted_obj(deleted_sub)
+          subs << preserved
+        end
+        change[sub] = subs unless subs.empty?
+      end
+      change
+    end
+  end
+  
+  module ClassMethods
+    ##
+    # Holds an array of excluded fields which will not be used
+    # for comparison tests or when copying deleted values
+    attr_reader :excluded_fields
+    
+    ##
+    # String value corresponding to the field that uniquely identifies
+    # a child record from among its siblings 
+    # (should not be id unless id is being generated)
+    attr_reader :unique_within_group
+    
+    ##
+    # Holds an array of fields which will be added to a modified change Hash
+    # (regardless of whether its value has changed or not) unless there are 
+    # no other changes
+    attr_reader :conditional_fields
+    
+    ##
+    # A shortcut, used to quickly check whether a class implements Diffable
+    attr_reader :diffable
+    
+    @diffable = true
+    
+    ##
+    # Sets the class's conditional_fields values.
+    #
+    # If required, should be placed in the model definition code:
+    #
+    #    class ModelA < ActiveRecord::Base
+    #      include Diffable
+    #      set_conditional_fields :meta
+    #    end
+    def set_conditional_fields(*h)
+      @conditional_fields = []
+      h.each { |key| eval(%Q|@conditional_fields << "#{key.to_s}"|) }
+    end
+    
+    ##
+    # Sets the class's excluded_fields values.
+    #
+    # If required, should be placed in the model definition code:
+    #
+    #     class ModelB < ActiveRecord::Base
+    #       include Diffable
+    #       set_excluded_fields :ignore_me, :test
+    #     end
+    def set_excluded_fields(*h)
+      @excluded_fields = []
+      h.each { |key| eval(%Q|@excluded_fields << "#{key.to_s}"|) }
+    end
+    
+    ##
+    # Sets the class's unique_within_group value
+    #
+    # If required, should be placed in the model definition code:
+    #
+    #     class ModelC < ActiveRecord::Base
+    #       include Diffable
+    #       set_unique_within_set :generated_identifier
+    #     end
+    def set_unique_within_group(value)
+      eval(%Q|@unique_within_group = "#{value.to_s}"|)
+    end
+  end
+end

data/lib/diffable/version.rb

@@ -0,0 +1,6 @@
+module Diffable
+  ##
+  # Diffable version you are using
+  
+  VERSION = "0.0.1"
+end

data/spec/db/schema.rb

@@ -0,0 +1,35 @@
+ActiveRecord::Schema.define do
+  create_table(:notdiff) do |t|
+    t.string  :name
+  end
+  
+  create_table(:hazdiffs) do |t|
+    t.string  :name
+    t.integer :price
+  end
+  
+  create_table(:multidiffs) do |t|
+    t.string  :name
+    t.integer :price
+  end
+  
+  create_table(:subrecs) do |t|
+    t.integer :hazdiff_id
+    t.string  :name
+    t.string  :ident
+  end
+  
+  create_table(:alt_subrecs) do |t|
+    t.integer :hazdiff_id
+    t.string  :name
+    t.string  :ident
+    t.string  :ignore_me
+    t.string  :tracker
+  end
+  
+  create_table(:subrec_no_diffs) do |t|
+    t.integer :hazdiff_id
+    t.string  :name
+    t.string  :ident
+  end
+end

data/spec/lib/diffable_spec.rb

@@ -0,0 +1,240 @@
+require 'active_record'
+require 'rspec'
+require 'nulldb_rspec'
+
+require "./lib/diffable"
+
+class Hazdiff < ActiveRecord::Base
+  include Diffable
+end
+
+class Notdiff < ActiveRecord::Base
+end
+
+class Multidiff < ActiveRecord::Base
+  include Diffable
+  has_many :subrecs
+  has_many :alt_subrecs
+  has_many :subrec_no_diffs
+end
+
+class Subrec < ActiveRecord::Base
+  include Diffable
+  set_unique_within_group :ident
+  belongs_to :multidiff
+end
+
+class SubrecNoDiff < ActiveRecord::Base
+  belongs_to :multidiff
+end
+
+class AltSubrec < ActiveRecord::Base
+  include Diffable
+  set_unique_within_group :ident
+  set_excluded_fields :ignore_me
+  set_conditional_fields :tracker
+end
+
+class Altdiff < Hazdiff
+end
+
+class AltdiffToo < Hazdiff
+end
+
+describe Diffable do
+  before(:all) do  
+    NullDB.configure {|ndb| ndb.project_root = './spec/'}
+    ActiveRecord::Base.establish_connection :adapter => :nulldb
+    ActiveRecord::Migration.verbose = false
+  end
+  
+  def should_have_column(klass, col_name, col_type)
+    col = klass.columns_hash[col_name.to_s]
+    col.should_not be_nil
+    col.type.should == col_type
+  end
+    
+  context "sanity checks" do
+    it "should remember columns defined in migrations" do
+      should_have_column(Hazdiff, :name, :string)
+    end
+    
+    it "should be defined" do
+      Diffable::VERSION.is_a?(String)
+      !Diffable::VERSION.empty?
+    end
+  end
+  
+  context "checking class compatibility" do
+    it "should be able to compare 2 things of the same class" do
+      hd1 = Hazdiff.new()
+      hd2 = Hazdiff.new()
+      lambda { hd1.diff(hd2) }.should_not raise_error
+    end
+    
+    it "should not be able to compare 2 things with different base classes" do
+      hd = Hazdiff.new
+      md = Multidiff.new
+      lambda { hd.diff(md) }.should raise_error
+      lambda { md.diff(hd) }.should raise_error
+    end
+    
+    it "should be able to compare 2 things with the same base class" do
+      ad1 = Altdiff.new
+      ad2 = AltdiffToo.new
+      lambda { ad1.diff(ad2) }.should_not raise_error
+    end
+    
+    it "should be able to compare base object with inherited object" do
+      hd = Hazdiff.new
+      ad = Altdiff.new
+      lambda { hd.diff(ad) }.should_not raise_error
+      lambda { ad.diff(hd) }.should_not raise_error
+    end
+  end
+  
+  context "an object not including Diffable" do
+    it "should not inherit the instance methods" do
+      object = Notdiff.new
+      object.respond_to?(:diff).should be_false
+      object.respond_to?(:get_attributes).should be_false
+      object.respond_to?(:reflected_names).should be_false
+      object.class.respond_to?(:diffable).should be_false
+    end
+  end
+  
+  context "a simple object including Diffable" do
+    it "should inherit the expected instance methods" do
+      object = Hazdiff.new(:name => "meep")
+      object.respond_to?(:diff).should be_true
+      object.respond_to?(:get_attributes).should be_true
+      object.respond_to?(:reflected_names).should be_true
+      object.class.respond_to?(:diffable).should be_true
+    end
+    
+    describe "when asked for diff" do
+      describe "and given an object with identical attribute values" do
+        it "should return a blank hash" do
+          obj1 = Hazdiff.new(:name => "test1", :price => 0)
+          obj2 = Hazdiff.new(:name => "test1", :price => 0)
+          obj1.diff(obj2).should eq({})
+        end
+      end
+      
+      describe "and given an object with different attribute values" do
+        it "should return a hash of differences" do
+          obj1 = Hazdiff.new(:name => "test1", :price => 0)
+          obj2 = Hazdiff.new(:name => "test2", :price => 0)
+          obj3 = Hazdiff.new(:name => "test2", :price => 1)
+          obj1.diff(obj2).should eq({:name => "test2"})
+          obj2.diff(obj1).should eq({:name => "test1"})
+          obj1.diff(obj3).should eq({:name => "test2", :price => 1})
+        end
+      end
+    end
+  end
+  
+  context "an object including Diffable that has subobjects" do
+    describe "when asked for diff" do
+      describe "and the subobjects do not include Diffable" do
+        it "should ignore the ineligible subobjects" do
+          obj1 = Multidiff.new(:name => "test1")
+          sub1 = SubrecNoDiff.new(:name => "sub1")
+          
+          obj2 = Multidiff.new(:name => "test1")
+          sub2 = SubrecNoDiff.new(:name => "sub2")
+          
+          obj1.diff(obj2).should eq({})
+        end
+      end
+      
+      describe "and there are no difference between the subobjects" do
+        it "should return a blank hash" do
+          obj1 = Multidiff.new(:name => "test1")
+          sub1 = Subrec.new(:name => "sub1")
+          obj1.subrecs << sub1
+          obj2 = Multidiff.new(:name => "test1")
+          obj2.subrecs << sub1.dup
+          
+          obj1.diff(obj2).should eq({})
+        end
+      end
+      
+      describe "and there are 2 different sets of subobjects" do
+        it "should return 1 deleted subobject and 1 new one" do
+          obj1 = Multidiff.new(:name => "test1")
+          sub1 = Subrec.new(:name => "sub1", :ident => "s1")
+          obj1.subrecs << sub1
+          
+          obj2 = Multidiff.new(:name => "test1")
+          sub2 = Subrec.new(:name => "sub2", :ident => "s2")
+          obj2.subrecs << sub2
+          
+          obj1.diff(obj2).should eq({:subrecs=>[{:ident=>"s1", :change_type=>"new"}, {:name=>"sub2", :ident=>"s2", :change_type=>"deleted"}]})
+        end
+      end
+      
+      describe "and there are changes to the subobject" do
+        it "should return the subobject changes" do
+          obj1 = Multidiff.new(:name => "test1")
+          sub1 = Subrec.new(:name => "sub1", :ident => "s1")
+          obj1.subrecs << sub1
+          
+          obj2 = Multidiff.new(:name => "test1")
+          sub2 = Subrec.new(:name => "sub01", :ident => "s1")
+          obj2.subrecs << sub2
+          
+          obj1.diff(obj2).should eq({:subrecs=>[{:name=>"sub01", :ident=>"s1", :change_type=>"modified"}]})
+        end
+        
+        it "should include conditional fields where there has been a change" do
+          obj1 = Multidiff.new(:name => "test1")
+          sub1 = AltSubrec.new(:name => "sub1", :ident => "s1", :tracker => "t")
+          obj1.alt_subrecs << sub1
+          
+          obj2 = Multidiff.new(:name => "test1")
+          sub2 = AltSubrec.new(:name => "sub01", :ident => "s1", :tracker => "t")
+          obj2.alt_subrecs << sub2
+          
+          obj1.diff(obj2).should eq({:alt_subrecs=>[{:name=>"sub01", :ident=>"s1", :tracker => "t", :change_type=>"modified"}]})
+        end
+      end
+      
+      describe "and the subobject has been removed" do
+        #diffs are retrospective, this is where things get a bit weird
+        it "should return a new subobject" do
+          obj1 = Multidiff.new(:name => "test1")
+          sub1 = Subrec.new(:name => "sub1", :ident => "s1")
+          obj1.subrecs << sub1
+          
+          obj2 = Multidiff.new(:name => "test1")
+          
+          obj1.diff(obj2).should eq({:subrecs=>[{:ident=>"s1", :change_type=>"new"}]})
+        end
+      end
+      
+      describe "and a subobject has been added" do
+        #diffs are retrospective, this is where things get a bit weird
+        it "should return a deleted subobject" do
+          obj1 = Multidiff.new(:name => "test1")
+          obj2 = Multidiff.new(:name => "test1")
+          sub1 = Subrec.new(:name => "sub1", :ident => "s1")
+          obj2.subrecs << sub1
+          
+          obj1.diff(obj2).should eq({:subrecs=>[{:ident=>"s1", :name => "sub1", :change_type=>"deleted"}]})
+        end
+        
+        it "should not return excluded fields" do
+          obj1 = Multidiff.new(:name => "test1")
+          obj2 = Multidiff.new(:name => "test1")
+          sub1 = AltSubrec.new(:name => "sub1", :ident => "s1", :tracker => "t", :ignore_me => "??")
+          obj2.alt_subrecs << sub1
+          
+          obj1.diff(obj2).should eq({:alt_subrecs=>[{:name => "sub1", :ident=>"s1", :tracker => "t", :change_type=>"deleted"}]})
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.configurations['test'] = {'adapter' => 'nulldb'}

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: diffable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Liz Conlan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Facilitates Active::Record object diffing
+email:
+- lizconlan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- diffable.gemspec
+- lib/diffable.rb
+- lib/diffable/version.rb
+- spec/db/schema.rb
+- spec/lib/diffable_spec.rb
+homepage: https://github.com/lizconlan/diffable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -907652915963392506
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -907652915963392506
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds ability to compare 2 Active::Record objects; returns the differences
+  as a hash
+test_files:
+- spec/db/schema.rb
+- spec/lib/diffable_spec.rb