activerecord-diff 0.0.2 → 2.0.0

data/README.md

@@ -0,0 +1,55 @@
+activerecord-diff
+=================
+
+
+Simple ActiveRecord diff functionality.
+
+
+Example usage
+-------------
+
+```ruby
+require 'active_record/diff'
+
+class User < ActiveRecord::Base
+  include ActiveRecord::Diff
+end
+
+alice = User.create(:name => 'alice', :email_address => 'alice@example.org')
+
+bob = User.create(:name => 'bob', :email_address => 'bob@example.org')
+
+alice.diff?(bob)  # => true
+
+alice.diff(bob)  # => {:name => ['alice', 'bob'], :email_address => ['alice@example.org', 'bob@example.org']}
+
+alice.diff({:name => 'eve'})  # => {:name => ['alice', 'eve']}
+```
+
+
+Configuration
+-------------
+
+By default, ActiveRecord::Base.content_columns is used to decide which attributes
+to compare. You can include or exclude attributes from this as follows:
+
+```ruby
+class User < ActiveRecord::Base
+  diff :include => [:id], :exclude => [:password_hash]
+end
+```
+
+Alternatively, you can specify exactly which columns to compare:
+
+```ruby
+class User < ActiveRecord::Base
+  diff :id, :name, :email_address
+end
+```
+
+Copyright
+---------
+
+To the extent possible under law, Tim Fletcher has waived all copyright and
+related or neighboring rights to activerecord-diff. This work is published
+from the United Kingdom. http://creativecommons.org/publicdomain/zero/1.0/

data/activerecord-diff.gemspec

@@ -1,28 +1,18 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "active_record_diff/version"
-
 Gem::Specification.new do |s|
-  s.name        = "activerecord-diff"
-  s.version     = ActiveRecordDiff::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Stephen Prater"]
-  s.email       = ["stephenp@agrussell.com"]
-  s.homepage    = "http://github.com/agrussellknives/activerecord-diff"
-  s.summary     = %q{Gemify Simple diff for ActiveRecord objects.}
-  s.description = %q{Simple diff for ActiveRecord }
-
-  s.rubyforge_project = "activerecord-diff"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency('activerecord')
-  s.add_dependency('activesupport')
+  s.name = 'activerecord-diff'
+  s.version = '2.0.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Fletcher']
+  s.email = ['mail@tfletcher.com']
+  s.homepage = 'http://github.com/tim/activerecord-diff'
+  s.description = 'Simple ActiveRecord diff functionality'
+  s.summary = 'See description'
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md activerecord-diff.gemspec)
+  s.add_development_dependency('rake', '~> 10.0.3')
+  s.add_development_dependency('sqlite3', '~> 1.3.6')
+  s.require_path = 'lib'
 
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('sqlite3-ruby')
+  if RUBY_VERSION == '1.8.7'
+    s.add_development_dependency('minitest', '>= 4.2.0')
+  end
 end

data/lib/active_record/diff.rb

@@ -0,0 +1,58 @@
+module ActiveRecord
+  module Diff
+    module ClassMethod
+      def diff(*attrs)
+        self.diff_attrs = attrs
+      end
+    end
+
+    def self.included(base)
+      base.class_attribute :diff_attrs
+      base.extend ClassMethod
+    end
+
+    def diff?(record = nil)
+      not diff(record).empty?
+    end
+
+    def diff(other_record = nil)
+      if other_record.nil?
+        old_record, new_record = self.class.find(id), self
+      else
+        old_record, new_record = self, other_record
+      end
+
+      if new_record.is_a?(Hash)
+        diff_each(new_record) do |(attr_name, hash_value)|
+          [attr_name, old_record.send(attr_name), hash_value]
+        end
+      else
+        attrs = self.class.diff_attrs
+
+        if attrs.nil?
+          attrs = self.class.content_columns.map { |column| column.name.to_sym }
+        elsif attrs.length == 1 && Hash === attrs.first
+          columns = self.class.content_columns.map { |column| column.name.to_sym }
+
+          attrs = columns + (attrs.first[:include] || []) - (attrs.first[:exclude] || [])
+        end
+
+        diff_each(attrs) do |attr_name|
+          [attr_name, old_record.send(attr_name), new_record.send(attr_name)]
+        end
+      end
+    end
+
+    def diff_each(enum)
+      enum.inject({}) do |diff_hash, attr_name|
+        attr_name, old_value, new_value = *yield(attr_name)
+
+        unless old_value === new_value
+          diff_hash[attr_name.to_sym] = [old_value, new_value]
+        end
+
+        diff_hash
+      end
+    end
+  end
+end

data/spec/active_record_diff_spec.rb

@@ -0,0 +1,88 @@
+require 'minitest/autorun'
+require 'active_record'
+require 'active_record/diff'
+
+ActiveRecord::Base.establish_connection('adapter' => 'sqlite3', 'database' => ':memory:')
+
+ActiveRecord::Schema.define do
+  create_table :people do |table|
+    table.column :name, :string
+    table.column :email_address, :string
+  end
+end
+
+describe 'ActiveRecord::Diff' do
+  before do
+    @person = Class.new(ActiveRecord::Base) do
+      self.table_name = :people
+
+      include ActiveRecord::Diff
+    end
+
+    @person.create! :name => 'alice', :email_address => 'alice@example.com'
+    @person.create! :name => 'bob', :email_address => 'bob@example.com'
+    @person.create! :name => 'eve', :email_address => 'bob@example.com'
+
+    @people = @person.all
+
+    @alice, @bob, @eve = *@people
+  end
+
+  describe 'diff method' do
+    it 'returns a hash of the differences between the attributes of the records' do
+      @bob.diff(@alice).must_equal({:name => %w( bob alice ), :email_address => %w( bob@example.com alice@example.com )})
+
+      @bob.diff(@eve).must_equal({:name => %w( bob eve )})
+    end
+
+    it 'excludes and includes attributes as specified by the diff class method' do
+      @person.diff :include => [:id], :exclude => [:email_address]
+
+      @alice.diff(@bob).must_equal({:id => [1, 2], :name => %w( alice bob )})
+    end
+
+    it 'uses the list of attributes specified by the diff class method' do
+      @person.diff :id, :name
+
+      @alice.diff(@bob).must_equal({:id => [1, 2], :name => %w( alice bob )})
+    end
+  end
+
+  describe 'diff method called with a hash argument' do
+    it 'returns a hash of the differences between the attributes of the record and the given hash' do
+      @bob.diff({:name => 'joe'}).must_equal({:name => %w( bob joe )})
+    end
+  end
+
+  describe 'diff method called without arguments' do
+    it 'returns a hash of the differences when the record has changes' do
+      @eve.name = 'bob'
+
+      @eve.diff.must_equal({:name => %w( eve bob )})
+    end
+
+    it 'returns an empty hash when the record has no changes' do
+      @eve.diff.must_equal({})
+    end
+  end
+
+  describe 'diff query method' do
+    it 'returns true when there are differences between the argument and the receiver' do
+      @alice.diff?(@bob).must_equal(true)
+    end
+
+    it 'returns true when there are no differences between the argument and the receiver' do
+      @alice.diff?(@alice).must_equal(false)
+    end
+  end
+
+  describe 'diff query method called without arguments' do
+    it 'returns true when the record has changes' do
+      @alice.diff?(@alice).must_equal(false)
+    end
+
+    it 'returns false when the record has no changes' do
+      @alice.diff?.must_equal(false)
+    end
+  end
+end

metadata

@@ -1,90 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-diff
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
-- Stephen Prater
+- Tim Fletcher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000 -05:00
-default_executable: 
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: &9846140 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *9846140
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &9845930 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 10.0.3
+  type: :development
   prerelease: false
-  version_requirements: *9845930
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &9845720 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *9845720
+        version: 10.0.3
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &9845510 !ruby/object:Gem::Requirement
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
-  version_requirements: *9845510
-- !ruby/object:Gem::Dependency
-  name: sqlite3-ruby
-  requirement: &9845300 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *9845300
-description: ! 'Simple diff for ActiveRecord '
+        version: 1.3.6
+description: Simple ActiveRecord diff functionality
 email:
-- stephenp@agrussell.com
+- mail@tfletcher.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- README.txt
-- Rakefile
+- lib/active_record/diff.rb
+- spec/active_record_diff_spec.rb
+- README.md
 - activerecord-diff.gemspec
-- lib/..rb
-- lib/active_record_diff/version.rb
-- lib/activerecord-diff.rb
-- test/test.rb
-has_rdoc: true
-homepage: http://github.com/agrussellknives/activerecord-diff
+homepage: http://github.com/tim/activerecord-diff
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -103,10 +73,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: activerecord-diff
-rubygems_version: 1.5.2
+rubyforge_project: 
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Gemify Simple diff for ActiveRecord objects.
-test_files:
-- test/test.rb
+summary: See description
+test_files: []

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/Gemfile

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

data/README.txt

@@ -1,42 +0,0 @@
-Simple ActiveRecord diff functionality.
-
-Example usage:
-
-  require 'active_record/diff'
-
-  class User < ActiveRecord::Base
-    include ActiveRecord::Diff
-  end
-
-  alice = User.create(:name => 'alice', :email_address => 'alice@example.org')
-
-  bob = User.create(:name => 'bob', :email_address => 'bob@example.org')
-
-  alice.diff?(bob)  # => true
-
-  alice.diff(bob)  # => {:name => ['alice', 'bob'], :email_address => ['alice@example.org', 'bob@example.org']}
-
-  alice.diff({:name => 'eve'})  # => {:name => ['alice', 'eve']}
-
-
-By default, ActiveRecord::Base.content_columns is used to decide which attributes
-to compare. You can include or exclude attributes from this as follows:
-
-  class User < ActiveRecord::Base
-    diff :include => [:id], :exclude => [:password_hash]
-  end
-
-
-Alternatively, you can specify exactly which columns to compare:
-
-  class User < ActiveRecord::Base
-    diff :id, :name, :email_address
-  end
-
-
-This is an updated version of the "riff" rails plugin.
-
-
-To the extent possible under law, Tim Fletcher has waived all copyright and
-related or neighboring rights to activerecord-diff. This work is published
-from the United Kingdom. http://creativecommons.org/publicdomain/zero/1.0/

data/Rakefile

@@ -1,11 +0,0 @@
-require 'bundler'
-require 'rake/testtask'
-
-Bundler::GemHelper.install_tasks
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
-end
-

data/lib/..rb

@@ -1,3 +0,0 @@
-module .
-  # Your code goes here...
-end

data/lib/active_record_diff/version.rb

@@ -1,3 +0,0 @@
-module ActiveRecordDiff
-  VERSION = "0.0.2"
-end

data/lib/activerecord-diff.rb

@@ -1,73 +0,0 @@
-require 'active_support/core_ext'
-require 'active_record'
-
-module ActiveRecord
-  module Diff
-    module ClassMethods
-      def diff(*attrs)
-        write_inheritable_attribute(:diff_attrs, attrs)
-      end
-
-      def diff_attrs
-        attrs = read_inheritable_attribute(:diff_attrs)
-
-        if attrs.nil?
-          content_columns.map { |column| column.name }
-        elsif attrs.length == 1 && Hash === attrs.first
-          columns = content_columns.map { |column| column.name.to_sym }
-
-          columns + (attrs.first[:include] || []) - (attrs.first[:exclude] || [])
-        else
-          attrs
-        end
-      end
-    end
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    def diff?(record = nil)
-      not diff(record).empty?
-    end
-
-    def diff(other_record = nil)
-      
-      if other_record.nil?
-        old_record, new_record = self.class.find(id), self
-      else
-        old_record, new_record = self, other_record
-      end
-
-      if new_record.is_a?(Hash)
-        diff_each(new_record) do |(attr_name, hash_value)|
-          if block_given?
-            yield attr_name, old_record.send(attr_name), hash_value
-          else
-            [attr_name, old_record.send(attr_name), hash_value]
-          end
-        end
-      else
-        diff_each(self.class.diff_attrs) do |attr_name|
-          if block_given?
-            yield attr_name, old_record.send(attr_name), new_record.send(attr_name)
-          else
-            [attr_name, old_record.send(attr_name), new_record.send(attr_name)]
-          end
-        end
-      end
-    end
-
-    def diff_each(enum)
-      enum.inject({}) do |diff_hash, attr_name|
-        attr_name, old_value, new_value = *yield(attr_name)
-
-        unless old_value === new_value
-          diff_hash[attr_name.to_sym] = [old_value, new_value]
-        end
-
-        diff_hash
-      end
-    end
-  end
-end

data/test/test.rb

@@ -1,90 +0,0 @@
-require 'activerecord-diff'
-require 'test/unit'
-
-require 'pry'
-
-class Person < ActiveRecord::Base
-  include ActiveRecord::Diff
-end
-
-ActiveRecord::Base.establish_connection('adapter' => 'sqlite3', 'database' => ':memory:')
-
-ActiveRecord::Schema.define do
-  create_table :people do |table|
-    table.column :name, :string
-    table.column :email_address, :string
-  end
-end
-
-Person.create :name => 'alice', :email_address => 'alice@example.org'
-
-Person.create :name => 'bob', :email_address => 'bob@example.org'
-Person.create :name => 'BOB', :email_address => 'BOB@EXAMPLE.ORG'
-
-Person.create :name => 'eve', :email_address => 'bob@example.org'
-
-
-class TestCase < Test::Unit::TestCase
-  def setup
-    @people = Person.find(:all)
-
-    @alice, @bob, @capital_bob, @eve = *@people
-  end
-
-  def keysort(hash)
-    hash.sort_by { |k, v| k.to_s }
-  end
-
-  def assert_diff(a, b, diff)
-    assert_equal keysort(diff), keysort(a.diff(b))
-  end
-
-  def test_diff_query
-    @people.each do |person|
-      @people.each do |other_person|
-        if other_person == person
-          assert_equal false, person.diff?(other_person)
-        else
-          assert person.diff?(other_person)
-        end
-      end
-    end
-  end
-
-  def test_diff_against_other_record
-    assert_diff @bob, @alice, {:name => %w( bob alice ), :email_address => %w( bob@example.org alice@example.org )}
-
-    assert_diff @bob, @eve, {:name => %w( bob eve )}
-  end
-
-  def test_diff_with_block
-    assert_diff @bob, @capital_bob, {:name => %w( bob BOB), :email_address => %w( bob@example.org BOB@EXAMPLE.ORG )}
-    
-    diff = @bob.diff(@capital_bob) do |attrib, old, new|
-      [attrib, old.downcase, new.downcase]
-    end
-
-    assert diff.empty?
-  end
-
-
-  def test_diff_against_saved_self
-    assert ! @eve.diff?
-
-    @eve.name = 'alice'
-
-    assert @eve.diff?
-
-    assert_diff @eve, nil, {:name => ['eve', 'alice']}
-  end
-
-  def test_diff_against_hash
-    assert_diff @bob, {:name => 'joe'}, {:name => ['bob', 'joe']}
-  end
-
-  def test_inclusion_and_exclusion
-    Person.diff :include => [:id], :exclude => [:email_address]
-
-    assert_diff @alice, @bob, {:id => [1, 2], :name => %w( alice bob )}
-  end
-end