auditing 1.0.0 → 1.1.0

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 group :development, :test do
-  gem 'rspec-rails',  '~> 2.0.0.beta.20'
+  gem 'rspec',  '~> 2.0'
   gem 'sqlite3-ruby', '~> 1.3'
   gem 'activerecord', '~> 3.0.0.rc2'
 end

data/Gemfile.lock

@@ -24,8 +24,6 @@ GEM
     rspec-expectations (2.0.0.beta.20)
       diff-lcs (>= 1.1.2)
     rspec-mocks (2.0.0.beta.20)
-    rspec-rails (2.0.0.beta.20)
-      rspec (= 2.0.0.beta.20)
     sqlite3-ruby (1.3.1)
     tzinfo (0.3.23)
 
@@ -34,5 +32,5 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (~> 3.0.0.rc2)
-  rspec-rails (~> 2.0.0.beta.20)
+  rspec (~> 2.0)
   sqlite3-ruby (~> 1.3)

data/README.rdoc

@@ -1,4 +1,4 @@
-= auditing (currently in development)
+= auditing
 
 Auditing is a simple way to track and rollback changes to a record.
 
@@ -23,6 +23,7 @@ You will have to supply a model named Audit in your rails application with the f
   end
   
 If you want to track the user, uncomment the t.integer :user_id above.
+
 TODO: more to follow about tracking the user
 
   class Audit < ActiveRecord::Base
@@ -70,8 +71,10 @@ to enable a similar type of auditing on the other model(s)
 
 As above, you can supply a :fields hash of which attributes will be logged.
 If your relationship is polymorphic, you can supply an array of classes
-that you :only want to log.
+that you only want to log.
 
+  audit_relationship_enabled :only => [Company, Person]
+  
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "brad.cantin@gmail.com"
     gem.homepage = "http://github.com/bcantin/auditing"
     gem.authors = ["Brad Cantin"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec", ">= 2.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/auditing.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{auditing}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brad Cantin"]
-  s.date = %q{2010-10-09}
+  s.date = %q{2010-10-16}
   s.description = %q{acts_as_versioned is good. This allows an attribute level rollback instead}
   s.email = %q{brad.cantin@gmail.com}
   s.extra_rdoc_files = [
@@ -56,12 +56,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rspec>, [">= 2.0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rspec>, [">= 2.0"])
   end
 end
 

data/lib/auditing/base.rb

@@ -60,8 +60,11 @@ module Auditing
       end
 
       def log_association_destroy(item)
+        mark_as_undoable = audits.where({:association_id => item.id, :association_type => item.class.to_s})
+        mark_as_undoable.each do |i|
+          i.update_attribute('undoable', false)
+        end
         add_audit(:action => 'removed', :association => item, :undoable => false)
-        # TODO: update all of this items previous audits to be undoable
       end
 
       private

data/spec/auditing/audit_relationship_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe "AuditingRelationship" do
-  
+
   describe "adding audit_relationship_enabled on a model" do
     before do
       class Company < ActiveRecord::Base
@@ -13,52 +13,145 @@ describe "AuditingRelationship" do
         audit_relationship_enabled
       end
     end
-    
+
     it "should respond to audit_relationship_enabled when we add audit_relationship_enabled" do
       PhoneNumber.should respond_to(:audit_relationship_enabled)
     end
-    
+
     it "should build an array of audit_enabled_models" do
       PhoneNumber.audit_enabled_models.should == [:phoneable]
     end
-    
+
     it "should build an array of field_names" do
       PhoneNumber.field_names.should =~ ['number', 'extension']
     end
-  
-    describe "creating a new belongs_to object" do
+
+    describe "creating a new has_many object" do
       before do
         @company = Company.create(:name => 'Apple')
       end
-    
       it "should add an audit to the parent instance object (company) when we create a phone number" do
         lambda {
           @company.phone_numbers << PhoneNumber.new(:number => '1-800-orange')
-          }.should change{@company.audits.count}
+        }.should change{@company.audits.count}
       end
-    
+
       it "should add an audit for each field" do
         lambda {
           @company.phone_numbers << PhoneNumber.new(:number => '1-800-orange', :extension => '1')
-          }.should change{@company.audits.count}.by(2)
+        }.should change{@company.audits.count}.by(2)
       end
-  
-      describe "updating an existing belongs_to object" do
+
+      describe "updating an existing has_many object" do
         before do
           @ph = PhoneNumber.new(:number => '1-800-orange', :extension => '1')
           @company.phone_numbers << @ph
         end
-    
         it "should add an audit to the parent instance when we update a phone number" do
-          lambda {@ph.update_attributes(:number => '1-800-apple')}.should change{@company.audits.count}
+          lambda {@ph.update_attributes(:number => '1-800-apple')
+                  }.should change{@company.audits.count}
         end
-        
+
         describe "deleting a child_object" do
           it "should add an audit to the parent instance when we delete a phone number" do
             lambda {PhoneNumber.destroy(@ph)}.should change{@company.audits.count}
           end
+
+          it "should mark previous audits involving this has_many object so they can not be reversed" do
+            ph_id    = @ph.id
+            ph_assoc = @ph.class.to_s
+
+            PhoneNumber.destroy(@ph)
+            ph_audits = @company.audits.where(
+              {:association_id => ph_id, :association_type => ph_assoc}
+            )
+            collection = ph_audits.collect(&:undoable)
+            collection.uniq.should == [false]
+          end
         end
       end
     end
   end
-end
+
+  describe "has_many :through" do
+    before do
+      class Company < ActiveRecord::Base
+        has_many :employments
+        has_many :people, :through => :employments
+        audit_enabled
+      end
+      class Person < ActiveRecord::Base
+        has_many :employments
+        has_many :companies, :through => :employments
+        audit_enabled
+      end
+      class Employment < ActiveRecord::Base
+        belongs_to :person
+        belongs_to :company
+        audit_relationship_enabled :fields => :start_date
+      end
+      @company = Company.create(:name => 'Apple')
+      @person  = Person.create(:first_name => 'Steve')
+    end
+
+    it "adds an audit to the company" do
+      lambda {Employment.create(:person     => @person,
+                                :company    => @company,
+                                :start_date => 'yesterdayish')
+              }.should change{@company.audits.count}.by(1)
+    end
+    it "adds an audit to the person" do
+      lambda {Employment.create(:person     => @person,
+                                :company    => @company,
+                                :start_date => 'yesterdayish')
+              }.should change{@person.audits.count}.by(1)
+    end
+    it "increases the total audit count" do
+      lambda {Employment.create(:person     => @person,
+                                :company    => @company,
+                                :start_date => 'yesterdayish')
+              }.should change{Audit.count}.by(2)
+    end
+
+    describe "updating" do
+      before do
+        @emp = Employment.create(:person     => @person,
+                                 :company    => @company,
+                                 :start_date => 'yesterdayish')
+      end
+      it "increases the audit log for the company" do
+        lambda {@emp.update_attribute(:start_date, 'today')
+                }.should change{@company.audits.count}.by(1)
+      end
+      it "increases the audit log for the person" do
+        lambda {@emp.update_attribute(:start_date, 'today')
+                }.should change{@person.audits.count}.by(1)
+      end
+      it "increases the total audit count" do
+        lambda {@emp.update_attribute(:start_date, 'today')
+                }.should change{Audit.count}.by(2)
+      end
+    end
+
+    describe "deleting" do
+      before do
+        @emp = Employment.create(:person     => @person,
+                                 :company    => @company,
+                                 :start_date => 'yesterdayish')
+      end
+      it "increases the audit log for the company" do
+        lambda {Employment.destroy(@emp)
+                }.should change{@company.audits.count}.by(1)
+      end
+      it "increases the audit log for the person" do
+        lambda {Employment.destroy(@emp)
+                }.should change{@person.audits.count}.by(1)
+      end
+      it "increases the total audit count" do
+        lambda {Employment.destroy(@emp)
+                }.should change{Audit.count}.by(2)
+      end
+    end
+  end
+
+end

data/spec/auditing/auditor_spec.rb

@@ -4,7 +4,7 @@ describe "Auditor" do
   it 'adds the Auditing::Auditor module to the Audit class' do
     Audit.new.should respond_to(:show_action)
   end
-  
+
   describe "#rollback" do
     before do
       class School < ActiveRecord::Base
@@ -14,24 +14,24 @@ describe "Auditor" do
       @school.update_attributes(:name => 'PS99')
       @audit = @school.audits.first
     end
-    
+
     it "the latest audit should be the audit we want to rollback" do
       @audit.action.should      == 'updated'
       @audit.new_value.should   == 'PS99'
       @audit.old_value.should   == 'PS118'
       @audit.association.should == nil
     end
-    
+
     it "performs the rollback" do
       @audit.rollback
       @school.reload
       @school.name.should == 'PS118'
     end
-    
+
     it "creates an audit when a rollback is performed" do
       lambda { @audit.rollback }.should change { Audit.count }.by(1)
     end
-    
+
     it "the latest audit after a rollback should contain the changed values" do
       @audit.rollback
       @school.reload
@@ -39,7 +39,7 @@ describe "Auditor" do
       @school.audits.first.new_value.should == 'PS118'
     end
   end
-  
+
   describe "#rollback belongs_to attribute" do
     before do
       class Car < ActiveRecord::Base
@@ -51,12 +51,12 @@ describe "Auditor" do
       end
       @automaker     = AutoMaker.create(:name => 'maker of fast cars')
       @new_automaker = AutoMaker.create(:name => 'maker of safe cars')
-      
+
       @car = Car.create(:name => 'fast car', :auto_maker => @automaker)
       @car.update_attributes(:auto_maker => @new_automaker)
       @audit = @car.audits.first
     end
-    
+
     it "the latest audit should be the audit we want to rollback" do
       @audit.action.should      == 'updated'
       @audit.new_value.should   == @new_automaker.id
@@ -64,17 +64,17 @@ describe "Auditor" do
       @audit.association.should == nil
       @car.auto_maker.should    == @new_automaker
     end
-    
+
     it "performs the rollback" do
       @audit.rollback
       @car.reload
       @car.auto_maker.should == @automaker
     end
-    
+
     it "creates an audit when a rollback is performed" do
       lambda { @audit.rollback }.should change { Audit.count }.by(1)
     end
-    
+
     it "the latest audit after a rollback should contain the changed values" do
       @audit.rollback
       @car.reload
@@ -82,7 +82,7 @@ describe "Auditor" do
       @car.audits.first.new_value.should == @automaker.id
     end
   end
-  
+
   describe "rollback has_many attributes" do
     before do
       class Company < ActiveRecord::Base
@@ -99,24 +99,24 @@ describe "Auditor" do
       @ph.update_attributes(:number => '1-800-call-apple')
       @audit = @company.audits.first
     end
-    
+
     it "the latest audit should be the audit we want to rollback" do
       @audit.action.should      == 'updated'
       @audit.new_value.should   == '1-800-call-apple'
       @audit.old_value.should   == '1-800-orange'
       @audit.association.should == @ph
     end
-    
+
     it "performs the rollback" do
       @audit.rollback
       @company.reload
       @company.phone_numbers.first.number.should == '1-800-orange'
     end
-    
+
     it "creates an audit when a rollback is performed" do
       lambda { @audit.rollback }.should change { Audit.count }.by(1)
     end
-    
+
     it "the latest audit after a rollback should contain the changed values" do
       @audit.rollback
       @company.reload
@@ -124,4 +124,4 @@ describe "Auditor" do
       @company.audits.first.new_value.should == '1-800-orange'
     end
   end
-end
+end

data/spec/auditing/base_spec.rb

@@ -1,24 +1,25 @@
 require 'spec_helper'
 
 describe "Auditing" do
-  
+
   describe "auditing default values" do
     before do
       class School < ActiveRecord::Base
         audit_enabled
       end
     end
-    
+
     it "responds to audit_enabled when auditing is added to an AR object" do
       School.should respond_to(:audit_enabled)
     end
-    
+
     it "responds to @auditing_fields" do
       School.should respond_to(:auditing_fields)
     end
-    
+
     it "has default values when no fields are passed in" do
-      School.stub!(:column_names).and_return(["id", "name", "established_on", "created_at", "updated_at"])
+      School.stub!(:column_names).and_return(
+      ["id", "name", "established_on", "created_at", "updated_at"])
       School.gather_fields_for_auditing.should == ["name", "established_on"]
     end
   end # auditing default values
@@ -30,21 +31,21 @@ describe "Auditing" do
       end
       School.auditing_fields.should == ['name']
     end
-    
+
     it "accepts a single value as a string" do
       class School < ActiveRecord::Base
         audit_enabled :fields => 'name'
       end
       School.auditing_fields.should == ['name']
     end
-    
+
     it "accepts an array of symbols" do
       class School < ActiveRecord::Base
         audit_enabled :fields => [:name, :established_on]
       end
       School.auditing_fields.should == ['name', 'established_on']
     end
-    
+
     it "accepts an array of strings" do
       class School < ActiveRecord::Base
         audit_enabled :fields => ['name', 'established_on']
@@ -52,7 +53,7 @@ describe "Auditing" do
       School.auditing_fields.should == ['name', 'established_on']
     end
   end # auditing :fields => [:foo,:bar]
-  
+
   describe "creating a new instance" do
     before do
       class School < ActiveRecord::Base
@@ -63,23 +64,23 @@ describe "Auditing" do
     it "creates an audit" do
       lambda { School.create(:name => 'PS118') }.should change { Audit.count }.by(1)
     end
-    
+
     it "the first audit has an action of 'created'" do
       school = School.create(:name => 'PS118')
       school.audits.first.action.should == 'created'
     end
-    
+
     it "the first audit should not be reversable" do
       school = School.create(:name => 'PS118')
       school.audits.first.reversable?.should == false
     end
-    
+
     it "the audit.auditable should be the object that created the audit" do
       school = School.create(:name => 'PS118')
       school.audits.first.auditable.should == school
     end
   end # creating a new instance
-  
+
   describe "updating an existing record" do
     before do
       class School < ActiveRecord::Base
@@ -87,47 +88,50 @@ describe "Auditing" do
       end
       @school = School.create(:name => 'PS118')
     end
-    
+
     it "creates an audit" do
-      lambda { @school.update_attributes(:name => 'PS99') }.should change { Audit.count }.by(1)
+      lambda {@school.update_attributes(:name => 'PS99')
+              }.should change { Audit.count }.by(1)
     end
-    
+
     it "the first audit has an action of 'updated" do
       @school.update_attributes(:name => 'PS99')
       @school.audits.first.action.should == 'updated'
     end
-    
+
     it "the first audit should be reversable" do
       @school.update_attributes(:name => 'PS99')
       @school.audits.first.reversable?.should == true
     end
-    
+
     it "the first audit stored the new value" do
       @school.update_attributes(:name => 'PS99')
       @school.audits.first.new_value.should == 'PS99'
     end
-    
+
     it "the first audit stored the old value" do
       @school.update_attributes(:name => 'PS99')
       @school.audits.first.old_value.should == 'PS118'
     end
-    
+
     it "the audit.auditable should be the object that created the audit" do
       @school.update_attributes(:name => 'PS99')
       @school.audits.first.auditable.should == @school
     end
-    
+
     describe "does not create an audit when" do
       it "a value did not change" do
-        lambda { @school.update_attributes(:name => 'PS118') }.should_not change { Audit.count }
+        lambda {@school.update_attributes(:name => 'PS118')
+                }.should_not change { Audit.count }
       end
-      
+
       it "a value is not part of auditing_fields" do
-        lambda { @school.update_attributes(:established_on => Time.now) }.should_not change { Audit.count }
+        lambda {@school.update_attributes(:established_on => Time.now)
+                }.should_not change { Audit.count }
       end
     end
   end # updating an existing record
-  
+
   describe "belongs_to relationships" do
     before do
       class Car < ActiveRecord::Base
@@ -137,24 +141,25 @@ describe "Auditing" do
       class AutoMaker < ActiveRecord::Base
         has_many :cars
       end
-      
+
       @car       = Car.create(:name => 'fast car')
       @automaker = AutoMaker.create(:name => 'maker of fast cars')
     end
-    
+
     it "creates an audit when we add a belongs_to relationship" do
-      lambda { @car.update_attributes(:auto_maker => @automaker) }.should change { Audit.count }.by(1)
+      lambda {@car.update_attributes(:auto_maker => @automaker)
+              }.should change { Audit.count }.by(1)
     end
-    
+
     describe "our latest audit" do
       before do
         @car.update_attributes(:auto_maker => @automaker)
       end
-      
+
       it "the action should be 'updated" do
         @car.audits.first.action.should == 'updated'
       end
-      
+
       it "new_value should be an id" do
         @car.audits.first.new_value.should == @automaker.id
       end
@@ -163,17 +168,18 @@ describe "Auditing" do
         @car.audits.first.reversable?.should == true
       end
     end
-    
+
     describe "updating a belongs_to" do
       before do
         @new_automaker = AutoMaker.create(:name => 'maker of safe car')
         @car.update_attributes(:auto_maker => @automaker)
       end
-      
+
       it "creates an audit when we change a belongs_to relationship" do
-        lambda { @car.update_attributes(:auto_maker => @new_automaker) }.should change { Audit.count }.by(1)
+        lambda {@car.update_attributes(:auto_maker => @new_automaker)
+                }.should change { Audit.count }.by(1)
       end
-      
+
       describe "our latest audit" do
         before do
           @car.update_attributes(:auto_maker => @new_automaker)
@@ -186,16 +192,16 @@ describe "Auditing" do
         it "new_value should be an id" do
           @car.audits.first.new_value.should == @new_automaker.id
         end
-        
+
         it "old_value should be an id" do
           @car.audits.first.old_value.should == @automaker.id
         end
-        
+
         it "should be reversable" do
           @car.audits.first.reversable?.should == true
         end
       end
     end
   end # belongs_to relationships
-  
+
 end

data/spec/schema.rb

@@ -36,19 +36,25 @@ ActiveRecord::Schema.define(:version => 0) do
     t.timestamps
   end
   
+  create_table :phone_numbers do |t|
+    t.string  :number
+    t.string  :extension
+    t.string  :phoneable_type
+    t.integer :phoneable_id
+    t.timestamps
+  end
+  
   create_table :people do |t|
     t.string :first_name
     t.string :last_name
     t.timestamps
   end
   
-  create_table :phone_numbers do |t|
-    t.string  :number
-    t.string  :extension
-    t.string  :phoneable_type
-    t.integer :phoneable_id
+  create_table :employments do |t|
+    t.integer  :person_id
+    t.integer  :company_id
+    t.string   :start_date
     t.timestamps
   end
- 
 
 end

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'active_record'
 require 'auditing'
 require 'rspec'
-# require 'spec/autorun'
 
 # our test database
 TEST_DB = File.join(File.dirname(__FILE__), '..', 'test.sqlite3')

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brad Cantin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-09 00:00:00 -04:00
+date: 2010-10-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +26,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 2
-        - 9
-        version: 1.2.9
+        - 0
+        version: "2.0"
   type: :development
   version_requirements: *id001
 description: acts_as_versioned is good. This allows an attribute level rollback instead