audited_change_set 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*log

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 David Chelimsky, Brian Tatnall, Corey Haines, Nate Jackson
+
+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.markdown

@@ -0,0 +1,10 @@
+# audited_change_set
+
+Change sets for acts_as_audited.
+
+More info coming soon. In the mean time, feel free to look, poke, use.
+
+## Copyright
+
+Copyright (c) 2010 David Chelimsky, Brian Tatnall, Corey Haines, Nate Jackson
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "audited_change_set"
+    gem.summary = %Q{change_set for acts_as_audited}
+    gem.description = gem.summary
+    gem.email = "dchelimsky@gmail.com"
+    gem.homepage = "http://github.com/dchelimsky/audited_change_set"
+    gem.authors = ["David Chelimsky","Brian Tatnall", "Nate Jackson", "Corey Haines"]
+    gem.add_dependency "acts_as_audited", ">= 1.1.1"
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.8"
+    gem.add_development_dependency "sqlite3-ruby", ">= 1.2.5"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+Rspec::Core::RakeTask.new(:spec)
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "audited_change_set #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/audited_change_set.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{audited_change_set}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Chelimsky", "Brian Tatnall", "Nate Jackson", "Corey Haines"]
+  s.date = %q{2010-05-13}
+  s.description = %q{change_set for acts_as_audited}
+  s.email = %q{dchelimsky@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "audited_change_set.gemspec",
+     "lib/audited_change_set.rb",
+     "lib/audited_change_set/change.rb",
+     "lib/audited_change_set/change_set.rb",
+     "spec/audited_change_set/change_set_spec.rb",
+     "spec/audited_change_set/change_spec.rb",
+     "spec/db/schema.rb",
+     "spec/spec_helper.rb",
+     "specs.watchr"
+  ]
+  s.homepage = %q{http://github.com/dchelimsky/audited_change_set}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{change_set for acts_as_audited}
+  s.test_files = [
+    "spec/audited_change_set/change_set_spec.rb",
+     "spec/audited_change_set/change_spec.rb",
+     "spec/db/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<acts_as_audited>, [">= 1.1.1"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.8"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+    else
+      s.add_dependency(%q<acts_as_audited>, [">= 1.1.1"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.8"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+    end
+  else
+    s.add_dependency(%q<acts_as_audited>, [">= 1.1.1"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.8"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+  end
+end
+

data/lib/audited_change_set.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require "active_record/base"
+require "acts_as_audited"
+require "acts_as_audited/audit"
+require "audited_change_set/change"
+require "audited_change_set/change_set"

data/lib/audited_change_set/change.rb

@@ -0,0 +1,134 @@
+module AuditedChangeSet
+  class Change
+    module Hooks
+      def self.included(mod)
+        mod.extend ClassMethods
+      end
+
+      module ClassMethods
+        def hooks
+          @hooks ||= {}
+        end
+
+        def hook(method, &block)
+          hooks[method] = block
+        end
+      end
+
+      def hooks
+        self.class.hooks
+      end
+
+    private
+
+      def hook(key, *args)
+        hooks[key] && instance_exec(*args, &hooks[key])
+      end
+
+    end
+
+    include Enumerable
+    include Hooks
+
+    class Field
+      include Hooks
+
+      attr_reader :name, :old_value, :new_value
+
+      def initialize(name, new_val, old_val=nil)
+        @name = name.to_s
+        @new_value, @old_value = [new_val, old_val].map {|val| transform_value(val) }
+      end
+
+      def transform_value(val)
+        hook(:transform_value, val) || (association_field? ? get_associated_object(val).to_s : val.to_s)
+      end
+
+      def association_class
+        @association_class ||= begin
+          name.to_s =~ /(.*)_id$/
+          $1.camelize.constantize
+        end
+      end
+
+      def get_associated_object(id)
+        hook(:get_associated_object, id) || association_class.find_by_id(id)
+      end
+
+      def association_field?
+        name.ends_with? "_id"
+      end
+    end
+
+    class << self
+      def for_audits(audits, fields=nil, unfiltered_change_id=nil)
+        audits_to_changes(audits, fields, unfiltered_change_id).select(&:relevant?).reverse
+      end
+
+      def field_names_for_audits(audits)
+        audits_to_changes(audits).map(&:field_names).flatten.uniq.sort
+      end
+
+    private
+
+      def audits_to_changes(audits, fields=nil, unfiltered_change_id=nil)
+        audits.map do |a|
+          filter = (a.id == unfiltered_change_id.to_i) ? nil : fields
+          new(a, filter)
+        end
+      end
+    end
+
+    def initialize(audit, fields=nil)
+      @audit = audit
+      @fields = fields
+    end
+
+    def create_field(name, changes)
+      Field.new(name,*[changes].flatten.reverse) 
+    end
+
+    delegate :id, :to => :@audit
+
+    delegate :action, :to => :@audit
+
+    def username
+      if @audit.user
+        hook(:username, @audit.user) || @audit.username
+      else
+        'unknown'
+      end
+    end
+
+    def date
+      @audit.created_at
+    end
+
+    def relevant?
+      any?(&:present?)
+    end
+    
+    def relevant_field?(field) 
+      @fields ? @fields.map(&:downcase).include?(field.name) : true
+    end
+
+    def field_names
+      non_empty_fields.map { |name, vals| name }
+    end
+
+    def each(&block)
+      changed_fields.each(&block)
+    end
+
+  private
+    
+    def changed_fields
+      @changes_fields ||= non_empty_fields.map { |name, vals| create_field(name, vals) }.select {|field| relevant_field?(field) }
+    end
+
+    def non_empty_fields
+      @audit[:changes].reject { |name, val| val.to_s.empty? }
+    end
+  end
+end
+

data/lib/audited_change_set/change_set.rb

@@ -0,0 +1,31 @@
+module AuditedChangeSet
+  class ChangeSet
+    include Enumerable
+
+    def self.for_auditable(klass, id, fields=nil, change_id=nil)
+      new(klass.find(id), fields, change_id)
+    end
+
+    def initialize(auditable, fields=nil, change_id=nil)
+      @auditable = auditable
+      @fields = fields
+      @change_id = change_id
+    end
+
+    delegate :name, :to => :@auditable, :prefix => :auditable
+
+    def each(&block)
+      changes.each(&block)
+    end
+
+    def changed_fields
+      Change.field_names_for_audits(@auditable.audits).sort
+    end
+
+  private
+
+    def changes
+      @changes ||= Change.for_audits(@auditable.audits, @fields, @change_id)
+    end
+  end
+end

data/spec/audited_change_set/change_set_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+
+module AuditedChangeSet
+  describe ChangeSet do
+    describe "::for_auditable" do
+      let(:klass)     { double(Class) }
+      let(:auditable) { double('auditable') }
+      before { klass.stub(:find) { auditable } }
+
+      it "returns the change_set for the given auditable object" do
+        ChangeSet.should_receive(:new).with(auditable, nil, nil).and_return(change_set = double(ChangeSet))
+        ChangeSet.for_auditable(klass, 37).should be(change_set)
+      end
+
+      it "passes the fields into the ChangeSet constructor" do
+        fields = ["field"]
+        ChangeSet.should_receive(:new).with(auditable, fields, nil)
+        ChangeSet.for_auditable(klass, 37, fields)
+      end
+
+      it "passes the change id into the ChangeSet constructor" do
+        fields = ["field"]
+        ChangeSet.should_receive(:new).with(auditable, fields, 42)
+        ChangeSet.for_auditable(klass, 37, fields, 42)
+      end
+    end
+
+    describe "#auditable_name" do
+      let(:auditable) { double('auditable', :name => 'irrelevant') }
+      let(:change_set) { ChangeSet.new(auditable) } 
+
+      it "returns the name of the auditable object" do
+        change_set.auditable_name.should == 'irrelevant'
+      end
+    end
+
+    context "change_set for an auditable model" do
+      let(:auditable_model) { stub(AuditableModel, :name => 'irrelevant') }
+      let(:change_set) { ChangeSet.new(auditable_model) } 
+
+      describe "#each" do
+        context "without specified fields" do
+          it "yields changes for the auditable_model audits" do
+            audits = [double(Audit), double(Audit)]
+            auditable_model.stub(:audits).and_return(audits)
+
+            changes = [stub(Change), stub(Change)]
+            Change.should_receive(:for_audits).with(audits, nil, nil).and_return(changes)
+
+            yielded_changes = []
+            change_set.each do |change|
+              yielded_changes << change
+            end
+
+            yielded_changes.should == changes
+          end
+        end
+
+        context "with specified fields" do
+          let(:fields) { ["name", "intent"] }
+          let(:change_set) { ChangeSet.new(auditable_model, fields) }
+          it "provides the specified fields to the changes factory" do
+            audits = [double(Audit), double(Audit)]
+            auditable_model.stub(:audits).and_return(audits)
+
+            changes = [stub(Change), stub(Change)]
+            Change.should_receive(:for_audits).with(audits, fields, nil).and_return(changes)
+            change_set.each do
+              #just need to invoke this
+            end
+          end
+
+          context "and an change id" do
+            let(:change_id) { 42 }
+            let(:change_set) { ChangeSet.new(auditable_model, fields, change_id) }
+            it "provides the change id to the changes factory" do
+              audits = [double(Audit), double(Audit)]
+              auditable_model.stub(:audits).and_return(audits)
+
+              changes = [stub(Change), stub(Change)]
+              Change.should_receive(:for_audits).with(audits, fields, change_id).and_return(changes)
+              change_set.each do
+                #just need to invoke this
+              end
+            end
+          end
+        end
+
+      end
+
+      describe "#changed_fields" do
+        it "returns all of the changed field names" do
+          audits = [double(Audit), double(Audit)]
+          auditable_model.stub(:audits).and_return(audits)
+          Change.stub(:field_names_for_audits).with(audits).and_return(["intent", "executive_status"])
+          
+          change_set.changed_fields.should == ["executive_status", "intent"]
+        end
+      end
+
+    end
+  end
+end

data/spec/audited_change_set/change_spec.rb

@@ -0,0 +1,395 @@
+require 'spec_helper'
+
+module AuditedChangeSet
+  describe Change do
+
+    let(:audit) { double(Audit) }
+
+    describe "::for_audits" do
+      let(:audits) {[double(Audit), double(Audit)]}
+
+      it "constructs an array of changes from the audits" do
+        changes = [double(Change), double(Change)]
+        changes.each do |change|
+          change.stub(:relevant?).and_return(true)
+        end
+        audits.each_with_index do |audit, index|
+          audit.stub(:id).and_return(53)
+          Change.stub(:new).with(audit, nil).and_return(changes[index])
+        end
+        Change.for_audits(audits).should == changes.reverse
+      end
+
+      context "with specified fields" do
+        let(:audits) { [double(Audit), double(Audit)] }
+        let(:fields) { ["name", "intent"] }
+        let(:changes) { [double(Change), double(Change)] }
+
+        it "constructs an array of changes filtered by the specified fields from the audits" do
+          audits.each_with_index do |audit, index|
+            audit.stub(:id).and_return(53)
+            Change.stub(:new).with(audit, fields).and_return(changes[index])
+          end
+          changes.first.should_receive(:relevant?).and_return(true)
+          changes.last.should_receive(:relevant?).and_return(false)
+          Change.for_audits(audits, fields).should == [changes.first]
+        end
+
+        context "with a change id" do
+          it "doesn't pass the fields into any audits whose id matches the change id" do
+            change_id = 42
+            audits.first.stub(:id).and_return(53)
+            audits.second.stub(:id).and_return(change_id)
+
+            changes.first.stub(:relevant?).and_return(true)
+            changes.second.stub(:relevant?).and_return(true)
+
+            Change.should_receive(:new).with(audits.first, fields).and_return(changes.first)
+            Change.should_receive(:new).with(audits.second, nil).and_return(changes.second)
+
+            Change.for_audits(audits, fields, change_id.to_s) # this just needs to get invoked
+          end
+        end
+      end
+    end
+
+    describe "::field_names_for_audits" do
+      let(:audits) {[double(Audit), double(Audit)]}
+      it "returns an array of the fields which have changed across the audits" do
+        changes = [double(Change), double(Change)]
+        audits.each_with_index do |audit, index|
+          audit.stub(:id).and_return(53)
+          Change.stub(:new).with(audit, nil).and_return(changes[index])
+        end
+        changes.first.stub(:field_names).and_return(["intent", "name"])
+        changes.last.stub(:field_names).and_return(["name", "executive_status"])
+        Change.field_names_for_audits(audits).should == ["executive_status", "intent", "name"]
+      end
+    end
+
+    describe "#field_names" do
+      it "returns a list of field names for this change" do
+        audit_changes = {'intent' => [nil, 'irrelevant'], 'name' => [nil, 'irrelevant'], 'executive_status' => [nil, '']}
+        audit.stub(:[]).with(:changes).and_return(audit_changes)
+        change = Change.new(audit)
+        change.field_names.should == ['name', 'intent']
+      end
+    end
+
+    describe "#username" do
+      it "returns user.username" do
+        audit.stub(:user) { double("user") }
+        audit.stub(:username) { "Example User" }
+        change = Change.new(audit)
+        change.username.should == "Example User"
+      end
+
+      it "returns 'unknown' if no user associated" do
+        audit.stub(:user).and_return nil
+        change = Change.new(audit)
+        change.username.should == 'unknown'
+      end
+    end
+
+    it "#date returns the date when the audit was made" do
+      d = DateTime.now
+      audit.stub(:created_at).and_return(d)
+      change = Change.new(audit)
+      change.date.should == d
+    end
+
+    it "#id returns the audit id" do
+      audit.stub(:id).and_return(42)
+      change = Change.new(audit)
+      change.id.should == audit.id
+    end
+
+    it "#action returns the audit action" do
+      audit.stub(:action).and_return("create")
+      change = Change.new(audit)
+      change.action.should == "create"
+    end
+
+    describe "#relevant?" do
+      context "any of the audits match the specified fields" do
+        it "returns true" do
+          audit.stub(:[]).with(:changes).and_return("intent" => "irrelevant")
+          Change.new(audit, ["intent"]).should be_relevant
+        end
+      end
+      context "none of the audits match the specified fields" do
+        it "returns false" do
+          audit.stub(:[]).with(:changes).and_return("name" => "irrelevant")
+          Change.new(audit, ["intent"]).should_not be_relevant
+        end
+      end
+      context "no specified fields" do
+        it "returns true" do
+          audit.stub(:[]).with(:changes).and_return("intent" => "irrelevant")
+          Change.new(audit).should be_relevant
+        end
+      end
+    end
+
+    describe "#each yields fields for each changed attribute" do
+      Rspec::Matchers.define :yield_these do |field_values|
+        match do |change|
+          @yielded_fields = []
+          change.each do |field|
+            @yielded_fields << field
+          end
+          matching_fields = @yielded_fields.select do |field|
+            field_values[field.name].present? && 
+            field_values[field.name].first == field.old_value &&
+            field_values[field.name].second == field.new_value
+          end
+          matching_fields.size == field_values.size && @yielded_fields.size == field_values.size
+        end
+
+        failure_message_for_should do |changes_hash|
+          "expected Change to yield #{field_values.to_a.inspect}, but got #{@yielded_fields.map{|f| [f.name, [f.old_value, f.new_value]]}.inspect}"
+        end
+      end
+
+      context "change is a create" do
+        before(:each) do
+          audit.stub(:action).and_return("create")
+        end
+
+        it "sets old value to nil and new value to attribute value" do
+          changes = { "name" => "new name", "intent" => "new intent"}
+
+          yielded_fields ={"name" => ["", "new name"], "intent" => ["", "new intent"]}
+
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+
+        it "does not show empty string values" do
+          changes = { "blank_field" => "", "non_blank" => "something"}
+          yielded_fields = { "non_blank" => ["", "something"] }
+
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+
+        it "does show 'false' values" do
+          changes = { "false_field" => false}
+          yielded_fields = { "false_field" => ["", "false"] }
+
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+      end
+
+      context "change is an update" do
+        before(:each) do
+          audit.stub(:action).and_return("update")
+        end
+
+        it "sets the old and new values" do
+          changes = { "name" => ["old name", "changed name"] }
+          yielded_fields = {"name" => ["old name", "changed name"] }
+
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+
+        it "shows if we changed to empty string" do
+          changes = { "changed_to_empty" => ["not empty", ""]}
+          yielded_fields = {"changed_to_empty" => ["not empty", ""]}
+
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+      end
+
+      context "field is an association" do
+
+        before :each do
+          AuditableModel.stub(:find_by_id).and_return(nil)
+          AuditableModel.stub(:find_by_id).with("1").and_return(double(AuditableModel, :to_s => 'to_s_ified'))
+        end
+
+        it "uses associated object for new value" do
+          changes = { "auditable_model_id" => "1"}
+          yielded_fields ={"auditable_model_id" => ["", "to_s_ified"]}
+
+          audit.stub(:action).and_return("create")
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+
+        it "uses associated object for old value" do
+          changes = { "auditable_model_id" => ["1", nil]}
+          yielded_fields ={"auditable_model_id" => ["to_s_ified", ""]}
+
+          audit.stub(:action).and_return("create")
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit).should yield_these(yielded_fields)
+        end
+      end
+
+      context "fields are specified" do
+        it "uses only the relevant fields" do
+          changes = { "name" => "irrelevant", "intent" => "win"}
+          yielded_fields ={"intent" => ["", "win"]}
+
+          audit.stub(:action).and_return("create")
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit, ["intent"]).should yield_these(yielded_fields)
+        end
+
+        it "uses the relevant fields after downcasing" do
+          changes = { "name" => "irrelevant", "intent" => "win"}
+          yielded_fields ={"intent" => ["", "win"]}
+
+          audit.stub(:action).and_return("create")
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit, ["Intent"]).should yield_these(yielded_fields)
+        end
+
+        it "uses only the relevant fields that are associations" do
+          models = [
+            double(AuditableModel, :to_s => "more revenue"),
+            double(AuditableModel, :to_s => "less cost")
+          ]
+          AuditableModel.stub(:find_by_id) do |options|
+            models.shift
+          end
+            
+          changes = { "title" => "irrelevant", "auditable_model_id" => ["1", "2"]}
+          yielded_fields ={"auditable_model_id" => ["less cost", "more revenue"]}
+
+          audit.stub(:action).and_return("create")
+          audit.stub(:[]).and_return(changes)
+          Change.new(audit, ["auditable_model_id"]).should yield_these(yielded_fields)
+        end
+      end
+    end
+
+    describe "hooks" do
+      let(:field_class)  { Class.new(Change::Field) }
+      let(:change_class) { Class.new(Change) }
+
+      describe "Field::transform_value" do
+        it "yields the new and old values" do
+          yielded_args = []
+          
+          field_class::hook(:transform_value) do |block_arg|
+            yielded_args << block_arg
+          end
+
+          field_class.new("anything", "new", "old")
+          yielded_args.should == ["new", "old"]
+        end
+
+        context "given the callback returns a non-nil value" do
+          it "uses the returned value" do
+            field_class::hook(:transform_value) do |block_arg|
+              "#{block_arg} modified by callback"
+            end
+
+            field = field_class.new("anything", "new value", "old value")
+
+            field.new_value.should == "new value modified by callback"
+            field.old_value.should == "old value modified by callback"
+          end
+        end
+
+        context "given the callback returns nil" do
+          it "uses it's unhooked value" do
+            field_class::hook(:transform_value) do |block_arg|
+              nil
+            end
+
+            field = field_class.new("anything", "new value", "old value")
+
+            field.new_value.should == "new value"
+            field.old_value.should == "old value"
+          end
+        end
+      end
+
+      describe "Field::get_associated_object" do
+        it "yields the id of the associated object" do
+          yielded_args = []
+          
+          field_class::hook(:get_associated_object) do |block_arg|
+            yielded_args << block_arg
+          end
+
+          field_class.new("audited_model_id", 37, 42)
+          yielded_args.should == [37, 42]
+        end
+
+        context "given the callback returns a non-nil value" do
+          it "uses the returned value" do
+            field_class::hook(:get_associated_object) do |block_arg|
+              "#{block_arg} returned by callback"
+            end
+
+            field = field_class.new("anything_id", "new value", "old value")
+
+            field.new_value.should == "new value returned by callback"
+            field.old_value.should == "old value returned by callback"
+          end
+        end
+
+        context "given the callback returns nil" do
+          it "uses the default strategy to find the associated object" do
+            returned_object = Object.new
+            AuditableModel.stub(:find_by_id).with(37) { returned_object }
+            field_class::hook(:get_associated_object) do |block_arg|
+              nil
+            end
+
+            field = field_class.new("auditable_model_id", 37)
+            field.new_value.should == returned_object.to_s
+          end
+        end
+      end
+
+      describe "Change::username" do
+        let(:user) { double("User") }
+        let(:audit) { double("Audit", :user => user, :username => "supplied username") }
+
+        it "yields the user" do
+          yielded_args = []
+          
+          change_class::hook(:username) do |user_arg|
+            yielded_args << user_arg
+          end
+
+          change = change_class.new(audit)
+          change.username # to invoke the hook
+          yielded_args.should == [user]
+        end
+
+        context "given the callback returns a non-nil value" do
+          it "uses the returned value" do
+            change_class::hook(:username) do |user_arg|
+              "returned username"
+            end
+
+            change = change_class.new(audit)
+            change.username.should == "returned username"
+          end
+        end
+
+        context "given the callback returns nil" do
+          it "uses the audit's username" do
+            yielded_args = []
+            
+            change_class::hook(:username) do |user_arg|
+              nil
+            end
+
+            change = change_class.new(audit)
+            change.username.should == "supplied username"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/db/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :audits, :force => true do |t|
+    t.column :auditable_id, :integer
+    t.column :auditable_type, :string
+    t.column :user_id, :integer
+    t.column :user_type, :string
+    t.column :username, :string
+    t.column :action, :string
+    t.column :changes, :text
+    t.column :version, :integer, :default => 0
+    t.column :created_at, :datetime
+  end
+
+  create_table :auditable_models do; end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "audited_change_set"
+require "rspec"
+require "sqlite3"
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+ActiveRecord::Migration.verbose = false
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+class AuditableModel < ActiveRecord::Base; end
+

data/specs.watchr

@@ -0,0 +1,59 @@
+# Run me with:
+#
+#   $ watchr specs.watchr
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+def all_spec_files
+  Dir['spec/**/*_spec.rb']
+end
+
+def run_spec_matching(thing_to_match)
+  matches = all_spec_files.grep(/#{thing_to_match}/i)
+  if matches.empty?
+    puts "Sorry, thanks for playing, but there were no matches for #{thing_to_match}"  
+  else
+    run matches.join(' ')
+  end
+end
+
+def run(files_to_run)
+  puts("Running: #{files_to_run}")
+  system("clear;rspec -cfs #{files_to_run}")
+  no_int_for_you
+end
+
+def run_all_specs
+  run(all_spec_files.join(' '))
+end
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch('^spec/(.*)_spec\.rb')   { |m| run_spec_matching(m[1]) }
+watch('^lib/(.*)\.rb')         { |m| run_spec_matching(m[1]) }
+watch('^spec/spec_helper\.rb') { run_all_specs }
+watch('^spec/support/.*\.rb')   { run_all_specs }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+
+def no_int_for_you
+  @sent_an_int = nil
+end
+
+Signal.trap 'INT' do
+  if @sent_an_int then      
+    puts "   A second INT?  Ok, I get the message.  Shutting down now."
+    exit
+  else
+    puts "   Did you just send me an INT? Ugh.  I'll quit for real if you do it again."
+    @sent_an_int = true
+    Kernel.sleep 1.5
+    run_all_specs
+  end
+end
+
+# vim:ft=ruby

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: audited_change_set
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Chelimsky
+- Brian Tatnall
+- Nate Jackson
+- Corey Haines
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: acts_as_audited
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 8
+        version: 2.0.0.beta.8
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :development
+  version_requirements: *id003
+description: change_set for acts_as_audited
+email: dchelimsky@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- audited_change_set.gemspec
+- lib/audited_change_set.rb
+- lib/audited_change_set/change.rb
+- lib/audited_change_set/change_set.rb
+- spec/audited_change_set/change_set_spec.rb
+- spec/audited_change_set/change_spec.rb
+- spec/db/schema.rb
+- spec/spec_helper.rb
+- specs.watchr
+has_rdoc: true
+homepage: http://github.com/dchelimsky/audited_change_set
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: change_set for acts_as_audited
+test_files: 
+- spec/audited_change_set/change_set_spec.rb
+- spec/audited_change_set/change_spec.rb
+- spec/db/schema.rb
+- spec/spec_helper.rb