cia 0.3.7 → 0.4.0

data/Appraisals

@@ -1,5 +1,6 @@
 appraise "rails2" do
   gem 'activerecord', "2.3.14"
+  gem 'after_commit'
 end
 
 appraise "rails3" do

data/Gemfile.lock

@@ -1,42 +1,42 @@
 PATH
   remote: .
   specs:
-    cia (0.3.7)
+    cia (0.4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.2)
-      activesupport (= 3.2.2)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
       builder (~> 3.0.0)
-    activerecord (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.2)
+    activesupport (3.2.11)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    appraisal (0.4.1)
+    appraisal (0.5.1)
       bundler
       rake
     arel (3.0.2)
-    builder (3.0.0)
-    bump (0.3.7)
+    builder (3.0.4)
+    bump (0.3.9)
     diff-lcs (1.1.3)
-    i18n (0.6.0)
-    multi_json (1.3.4)
-    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)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
     sqlite3 (1.3.6)
-    tzinfo (0.3.33)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby

data/gemfiles/rails2.gemfile

@@ -2,10 +2,12 @@
 
 source :rubygems
 
+gem "bump"
 gem "rake"
 gem "rspec", "~>2"
 gem "appraisal"
 gem "sqlite3"
 gem "activerecord", "2.3.14"
+gem "after_commit"
 
 gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/cia
   specs:
-    cia (0.3.6)
+    cia (0.3.7)
 
 GEM
   remote: http://rubygems.org/
@@ -9,9 +9,12 @@ GEM
     activerecord (2.3.14)
       activesupport (= 2.3.14)
     activesupport (2.3.14)
+    after_commit (1.0.10)
+      activerecord (>= 1.15.6, < 3.0.0)
     appraisal (0.4.1)
       bundler
       rake
+    bump (0.3.9)
     diff-lcs (1.1.3)
     rake (0.9.2.2)
     rspec (2.10.0)
@@ -29,7 +32,9 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (= 2.3.14)
+  after_commit
   appraisal
+  bump
   cia!
   rake
   rspec (~> 2)

data/gemfiles/rails3.gemfile

@@ -2,6 +2,7 @@
 
 source :rubygems
 
+gem "bump"
 gem "rake"
 gem "rspec", "~>2"
 gem "appraisal"

data/gemfiles/rails3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/cia
   specs:
-    cia (0.3.6)
+    cia (0.3.7)
 
 GEM
   remote: http://rubygems.org/
@@ -17,25 +17,26 @@ GEM
     activesupport (3.2.3)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    appraisal (0.4.1)
+    appraisal (0.5.1)
       bundler
       rake
     arel (3.0.2)
-    builder (3.0.0)
+    builder (3.0.4)
+    bump (0.3.9)
     diff-lcs (1.1.3)
-    i18n (0.6.0)
-    multi_json (1.3.5)
-    rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    rspec-mocks (2.12.1)
     sqlite3 (1.3.6)
-    tzinfo (0.3.33)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby
@@ -43,6 +44,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (= 3.2.3)
   appraisal
+  bump
   cia!
   rake
   rspec (~> 2)

data/lib/cia/auditable.rb

@@ -1,11 +1,8 @@
 module CIA
   module Auditable
     def self.included(base)
-      base.class_attribute :audited_attributes, :audited_attribute_options
+      base.class_attribute :audited_attributes, :audited_attribute_options, :audited_attributes_callbacks_added
       base.send :extend, ClassMethods
-      base.after_create {|record| CIA.record(:create, record) }
-      base.after_update {|record| CIA.record(:update, record) }
-      base.after_destroy {|record| CIA.record(:destroy, record) }
     end
 
     def cia_changes
@@ -15,17 +12,34 @@ module CIA
     module ClassMethods
       def audit_attribute(*attributes)
         options = (attributes.last.is_a?(Hash) ? attributes.pop : {})
+        setup_auditing_callbacks(options)
 
-        self.audited_attributes = Set.new unless audited_attributes
-        self.audited_attributes += attributes.map(&:to_s)
+        self.audited_attributes = attributes.map(&:to_s)
 
         raise "cannot have :if and :unless" if options[:if] && options[:unless]
-        self.audited_attribute_options ||= {}
-        self.audited_attribute_options.merge!(options)
+        self.audited_attribute_options = options
 
         has_many :cia_events, :class_name => "CIA::Event", :as => :source
         has_many :cia_attribute_changes, :class_name => "CIA::AttributeChange", :as => :source
       end
+
+      def setup_auditing_callbacks(options)
+        return if audited_attributes_callbacks_added
+        self.audited_attributes_callbacks_added = true
+
+        [:create, :update, :destroy].each do |callback|
+          method, args = if options[:callback] == :after_commit
+            if ActiveRecord::VERSION::MAJOR == 2
+              ["after_commit_on_#{callback}"]
+            else # rails 3+
+              [:after_commit, [{:on => callback}]]
+            end
+          else
+            ["after_#{callback}", []]
+          end
+          send(method, *args) { |record| CIA.record(callback, record) }
+        end
+      end
     end
   end
 end

data/lib/cia/version.rb

@@ -1,3 +1,3 @@
 module CIA
-  VERSION = '0.3.7'
+  VERSION = '0.4.0'
 end

data/spec/cia_spec.rb

@@ -84,6 +84,65 @@ describe CIA do
       CIA::Event.last.action.should == "update"
     end
 
+    it "does not track failed changes" do
+      car = Car.create!(:wheels => 1).id
+      expect{
+        expect{ FailCar.new(:wheels => 4).save  }.to raise_error(FailCar::Oops)
+        car = FailCar.find(car)
+        expect{ car.update_attributes(:wheels => 2) }.to raise_error(FailCar::Oops)
+        expect{ car.destroy }.to raise_error(FailCar::Oops)
+      }.to_not change{ CIA::Event.count }
+    end
+
+    it "is rolled back if auditing fails" do
+      CIA.should_receive(:record).and_raise("XXX")
+      expect{
+        expect{
+          CIA.audit{ object.save! }
+        }.to raise_error("XXX")
+      }.to_not change{ object.class.count }
+    end
+
+    context "nested classes with multiple audited_attributes" do
+      let(:object){ NestedCar.new }
+
+      it "has the exclusive sub-classes attributes of the nested class" do
+        object.class.audited_attributes.should == ["drivers"]
+      end
+
+      it "does not record twice for nested classes" do
+        expect{
+          CIA.audit{ object.save! }
+        }.to change{ CIA::Event.count }.by(+1)
+      end
+
+      it "does not record twice for super classes" do
+        expect{
+          CIA.audit{ Car.new.save! }
+        }.to change{ CIA::Event.count }.by(+1)
+      end
+    end
+
+    context "nested classes with 1 audited_attributes" do
+      let(:object){ InheritedCar.new }
+
+      it "has the super-classes attributes" do
+        object.class.audited_attributes.should == ["wheels"]
+      end
+
+      it "does not record twice for nested classes" do
+        expect{
+          CIA.audit{ object.save! }
+        }.to change{ CIA::Event.count }.by(+1)
+      end
+
+      it "does not record twice for super classes" do
+        expect{
+          CIA.audit{ Car.new.save! }
+        }.to change{ CIA::Event.count }.by(+1)
+      end
+    end
+
     context "custom changes" do
       let(:object) { CarWithCustomChanges.new }
 
@@ -254,6 +313,28 @@ describe CIA do
         ex.inspect.should == '#<StandardError: foo>'
       end
     end
+
+    context "with after_commit" do
+      let(:object){ CarWithTransactions.new }
+
+      it "still tracks" do
+        expect{
+          CIA.audit{ object.save! }
+        }.to change{ CIA::Event.count }.by(+1)
+      end
+
+      it "is not rolled back if auditing fails" do
+        CIA.should_receive(:record).and_raise("XXX")
+        begin
+          expect{
+            CIA.audit{ object.save! }
+          }.to change{ object.class.count }.by(+1)
+        rescue RuntimeError => e
+          # errors from after_commit are never raised in rails 3+
+          raise e if ActiveRecord::VERSION::MAJOR != 2 || e.message != "XXX"
+        end
+      end
+    end
   end
 
   context ".current_actor" do

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift 'lib'
 require 'cia'
+require 'after_commit' if ActiveRecord::VERSION::MAJOR == 2
 
 RSpec.configure do |config|
   config.before do
@@ -45,8 +46,7 @@ end
 class CarWith3Attributes < ActiveRecord::Base
   self.table_name = "cars"
   include CIA::Auditable
-  audit_attribute :wheels, :color
-  audit_attribute :drivers
+  audit_attribute :wheels, :color, :drivers
 end
 
 class CarWithIf < ActiveRecord::Base
@@ -73,6 +73,32 @@ class CarWithCustomChanges < ActiveRecord::Base
   end
 end
 
+class FailCar < ActiveRecord::Base
+  self.table_name = "cars"
+  include CIA::Auditable
+  audit_attribute :wheels
+
+  class Oops < Exception
+  end
+
+  after_update { |x| raise Oops }
+  after_create { |x| raise Oops }
+  after_destroy { |x| raise Oops }
+end
+
+class CarWithTransactions < ActiveRecord::Base
+  self.table_name = "cars"
+  include CIA::Auditable
+  audit_attribute :wheels, :callback => :after_commit
+end
+
+class NestedCar < Car
+  audit_attribute :drivers
+end
+
+class InheritedCar < Car
+end
+
 def create_event(options={})
   CIA::Event.create!({:source => Car.create!, :actor => User.create!, :action => "update"}.merge(options))
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cia
 version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  version: 0.3.7
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: michael@grosser.it
@@ -46,23 +46,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: 933978664134993553
-  none: false
+      hash: 2880596585810436598
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: 933978664134993553
-  none: false
+      hash: 2880596585810436598
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24