delta_changes 0.0.1

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails2" do
+  version = "2.3.14"
+  gem 'activerecord', version
+end
+
+appraise "rails30" do
+  version = "3.2.3"
+  gem 'activerecord', version
+end
+
+
+appraise "rails32" do
+  version = "3.2.3"
+  gem 'activerecord', version
+end

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+gemspec
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    delta_changes (0.0.1)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.3)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.3.6)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  delta_changes!
+  rake
+  rspec (~> 2)
+  sqlite3

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "appraisal"
+
+task :spec do
+  sh "rspec spec/"
+end
+
+task :default do
+  sh "bundle exec rake appraisal:install && bundle exec rake appraisal spec"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  file = "lib/delta_changes/version.rb"
+
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ["major", "minor", "patch"].index(t.name.split(':').last)
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+
+  File.open(file,"w"){|f| f.write(version_file.sub(old_version, new_version)) }
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/Readme.md

@@ -0,0 +1,34 @@
+Additional real/virtual attribute change tracking independent of ActiveRecords
+
+
+Install
+=======
+
+    gem install delta_changes
+
+Usage
+=====
+
+    class User < ActiveRecord::Base
+      include DeltaChanges::Extension
+      delta_changes :columns => [:name], :attributes => [:full_name]
+    end
+
+    user.name = "bar"
+    user.delta_changes # => {"name" => [nil, "bar"]}
+
+    user.full_name_will_change!
+    user.delta_changes # => {"name" => [nil, "bar"], "full_name" => [nil, "Mr. Bar"]}
+
+    user.save!
+    user.delta_changes # => {"name" => [nil, "bar"], "full_name" => [nil, "Mr. Bar"]}
+
+    user.reset_delta_changes!
+    user.delta_changes # => {}
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://secure.travis-ci.org/grosser/delta_changes.png)](http://travis-ci.org/grosser/delta_changes)

data/delta_changes.gemspec

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+name = "delta_changes"
+require "#{name}/version"
+
+Gem::Specification.new name, DeltaChanges::VERSION do |s|
+  s.summary = "Additional real/virtual attribute change tracking independent of ActiveRecords"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.add_runtime_dependency "activerecord"
+  s.license = "MIT"
+end

data/gemfiles/rails2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "2.3.14"
+
+gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: /Users/mgrosser/code/tools/delta_changes
+  specs:
+    delta_changes (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    sqlite3 (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.14)
+  appraisal
+  delta_changes!
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/rails30.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "3.2.3"
+
+gemspec :path=>"../"

data/gemfiles/rails30.gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: /Users/mgrosser/code/tools/delta_changes
+  specs:
+    delta_changes (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.3)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.2.3)
+  appraisal
+  delta_changes!
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/rails32.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "3.2.3"
+
+gemspec :path=>"../"

data/gemfiles/rails32.gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: /Users/mgrosser/code/tools/delta_changes
+  specs:
+    delta_changes (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.3)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.2.3)
+  appraisal
+  delta_changes!
+  rake
+  rspec (~> 2)
+  sqlite3

data/lib/delta_changes/version.rb

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

data/lib/delta_changes.rb

@@ -0,0 +1,109 @@
+require "delta_changes/version"
+
+module DeltaChanges
+  module Extension
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.cattr_accessor :delta_changes_options
+      base.attribute_method_suffix '_delta_changed?', '_delta_change', '_delta_was', '_delta_will_change!'
+      base.alias_method_chain :write_attribute, :delta_changes
+    end
+
+    module ClassMethods
+      def delta_changes(options)
+        self.delta_changes_options = options
+        define_virtual_attribute_delta_methods
+      end
+
+      #
+      # Provide for delta tracking of virtual (non-column) attributes.
+      #
+      def define_virtual_attribute_delta_methods
+        delta_changes_options[:attributes].each do |tracked_attribute|
+          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+            def #{tracked_attribute}_delta_changed?
+              attribute_delta_changed?('#{tracked_attribute}')
+            end
+
+            def #{tracked_attribute}_delta_change
+              attribute_delta_change('#{tracked_attribute}')
+            end
+
+            def #{tracked_attribute}_delta_was
+              attribute_delta_was('#{tracked_attribute}')
+            end
+
+            def #{tracked_attribute}_delta_will_change!
+              attribute_delta_will_change!('#{tracked_attribute}')
+            end
+          RUBY
+        end
+      end
+    end
+
+    def delta_changes
+      delta_changed_attributes.keys.inject({}) { |h, attr| h[attr] = attribute_delta_change(attr); h }
+    end
+
+    def delta_changes?
+      delta_changed_attributes.keys.present?
+    end
+
+    ####################################
+
+    def reset_delta_changes!
+      delta_changed_attributes.clear
+    end
+
+    private
+
+    # Map of change attr => original value.
+    def delta_changed_attributes
+      @delta_changed_attributes ||= {}
+    end
+
+    # Handle *_delta_changed? for method_missing.
+    def attribute_delta_changed?(attr)
+      delta_changed_attributes.include?(attr)
+    end
+
+    # Handle *_delta_change for method_missing.
+    def attribute_delta_change(attr)
+      [delta_changed_attributes[attr], __send__(attr)] if attribute_delta_changed?(attr)
+    end
+
+    # Handle *_delta_was for method_missing.
+    def attribute_delta_was(attr)
+      attribute_delta_changed?(attr) ? delta_changed_attributes[attr] : __send__(attr)
+    end
+
+    # Handle <tt>*_will_change!</tt> for +method_missing+.
+    def attribute_delta_will_change!(attr, options = {})
+      attribute_value = if self.class.delta_changes_options[:attributes].include?(attr)
+        value = send(attr)
+        value.duplicable? ? value.clone : value
+      else
+        options[:from] || clone_attribute_value(:read_attribute, attr)
+      end
+      delta_changed_attributes[attr] = attribute_value
+    end
+
+    # Wrap write_attribute to remember original attribute value.
+    def write_attribute_with_delta_changes(attr, value)
+      attr = attr.to_s
+
+      if self.class.delta_changes_options[:columns].include?(attr)
+        # The attribute already has an unsaved change.
+        if delta_changed_attributes.include?(attr)
+          old = delta_changed_attributes[attr]
+          delta_changed_attributes.delete(attr) unless field_changed?(attr, old, value)
+        else
+          old = clone_attribute_value(:read_attribute, attr)
+          delta_changed_attributes[attr] = old if field_changed?(attr, old, value)
+        end
+      end
+
+      write_attribute_without_delta_changes(attr, value)
+    end
+  end
+end

data/spec/delta_changes_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe DeltaChanges do
+  it "has a VERSION" do
+    DeltaChanges::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  it "should not create methods on unspecified attributes" do
+    # TODO broken, but that might be rails 2 ...
+    #expect{
+    #  User.new.email_delta_will_change!
+    #}.to raise_error
+
+    expect{
+      User.new.bar_delta_will_change!
+    }.to raise_error
+
+    expect{
+      User.new.does_not_exist_delta_will_change!
+    }.to raise_error
+  end
+
+  describe "#delta_changes" do
+    it "should be empty on unchanged" do
+      User.new.delta_changes.should == {}
+    end
+
+    it "should be filled by tracked column changes" do
+      User.new(:name => "Peter").delta_changes.should == {"name"=>[nil, "Peter"]}
+    end
+
+    it "should be filled by tracked number column change" do
+      User.new(:score => 5).delta_changes.should == {"score"=>[nil, 5]}
+    end
+
+    it "should be filled by tracked number column change that have the wrong type" do
+      User.new(:score => "5").delta_changes.should == {"score"=>[nil, 5]}
+    end
+
+    it "should not be filled by untracked column changes" do
+      User.new(:email => "Peter").delta_changes.should == {}
+    end
+
+    it "should not be filled implicit tracked attribute changes" do
+      user = User.new(:foo => 1)
+      user.delta_changes.should == {}
+    end
+
+    it "should be filled by explicit tracked attribute changes" do
+      user = User.new(:foo => 1)
+      user.foo_delta_will_change!
+      user.foo = 2
+      user.delta_changes.should == {"foo"=>[1, 2]}
+    end
+
+    it "should not mess with normal changes" do
+      User.new(:email => "EMAIL", :name => "NAME", :foo => "FOO").changes.should ==
+        {"email"=>[nil, "EMAIL"], "name"=>[nil, "NAME"]}
+    end
+
+    it "should not reset columns on save" do
+      user = User.create!(:name => "NAME", :foo => "FOO", :bar => "BAR")
+      user.delta_changes.should == {"name"=>[nil, "NAME"]}
+    end
+
+    it "should not reset columns on update" do
+      user = User.create!(:name => "NAME", :foo => "FOO", :bar => "BAR")
+      user.update_attributes(:name => "NAME-2")
+      user.delta_changes.should == {"name"=>[nil, "NAME-2"]}
+    end
+
+    # that might change, I'd consider this a bug ... but just documenting for now
+    it "should not reset columns on reload" do
+      user = User.create!(:name => "NAME", :foo => "FOO", :bar => "BAR")
+      user.reload
+      user.delta_changes.should == {"name"=>[nil, "NAME"]}
+    end
+
+    it "should have previouse value from db" do
+      user = User.create!(:name => "NAME", :foo => "FOO", :bar => "BAR")
+      user = User.find(user)
+      user.name = "NAME-2"
+      user.delta_changes.should == {"name"=>["NAME", "NAME-2"]}
+    end
+
+    it "should not track non-changes on tracked columns" do
+      user = User.create!(:score => 5).reload
+      user.reset_delta_changes!
+
+      user.delta_changes.should == {}
+
+      user.score = 5
+      user.delta_changes.should == {}
+
+      user.score = "5"
+      user.delta_changes.should == {}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require "bundler/setup"
+require "delta_changes"
+require "active_record"
+
+# connect
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+# create tables
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+    t.string :email
+    t.integer :score
+    t.timestamps
+  end
+end
+
+# create models
+class User < ActiveRecord::Base
+  include DeltaChanges::Extension
+  attr_accessor :foo, :bar
+
+  delta_changes :columns => ["name", "score"], :attributes => ["foo"]
+
+  def full_name
+    "Mr. #{name}"
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: delta_changes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-20 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- delta_changes.gemspec
+- gemfiles/rails2.gemfile
+- gemfiles/rails2.gemfile.lock
+- gemfiles/rails30.gemfile
+- gemfiles/rails30.gemfile.lock
+- gemfiles/rails32.gemfile
+- gemfiles/rails32.gemfile.lock
+- lib/delta_changes.rb
+- lib/delta_changes/version.rb
+- spec/delta_changes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/delta_changes
+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: 3940600882562868341
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3940600882562868341
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Additional real/virtual attribute change tracking independent of ActiveRecords
+test_files: []