activerecord-diff 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.txt

@@ -0,0 +1,42 @@
+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

@@ -0,0 +1,11 @@
+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/activerecord-diff.gemspec

@@ -0,0 +1,28 @@
+# -*- 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.add_development_dependency('bundler')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('sqlite3-ruby')
+end

data/lib/..rb

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

data/lib/active_record_diff/version.rb

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

data/lib/activerecord-diff.rb

@@ -0,0 +1,64 @@
+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)|
+          [attr_name, old_record.send(attr_name), hash_value]
+        end
+      else
+        diff_each(self.class.diff_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/test/test.rb

@@ -0,0 +1,77 @@
+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 => 'eve', :email_address => 'bob@example.org'
+
+class TestCase < Test::Unit::TestCase
+  def setup
+    @people = Person.find(:all)
+
+    @alice, @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_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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-diff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Prater
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-13 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &10351960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10351960
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &10351750 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10351750
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &10351540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10351540
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &10351330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10351330
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &10351120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10351120
+description: ! 'Simple diff for ActiveRecord '
+email:
+- stephenp@agrussell.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.txt
+- Rakefile
+- 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
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: activerecord-diff
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Gemify Simple diff for ActiveRecord objects.
+test_files:
+- test/test.rb