auditable 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-# 0.0.5 (2012-03-12)
+## 0.0.6 (2012-03-12)
+### Fixes
+* Fix error when calling `audit_tag_with` on a record without audits and without `audit_tag` virtual attribute defined.
 
-## Changes
+### Changes
+* `.changed_by`, `.audit_tag`, `.audit_action` virtual attributes are now added to the auditable model by default. The extra check `respond_to?` on these guys is just cumbersome to carry along.
 
+## 0.0.5 (2012-03-12)
+### Changes
 Easier to explain with code
 
     # Given

data/README.md

@@ -120,7 +120,7 @@ It guessable from the above that `audits.modifications` will just be a serialize
 
 If you want to store the user who made the changed to the record, just assigned it to the record's `changed_by` attribute, like so:
 
-    # note you have to define `attr_accessor :changed_by` yourself
+    # note `attr_accessor :changed_by` is defined in your Survey class by the gem
     >> @survey.update_attributes(:changed_by => current_user, # and other attributes you want to set)
     # then @surveys.audits.last.user will be set to current_user
     # also works when you set changed_by and call save later, of course

data/lib/auditable/auditing.rb

@@ -1,5 +1,3 @@
-#require 'active_support/concern'
-
 module Auditable
   module Auditing
     extend ActiveSupport::Concern
@@ -26,8 +24,8 @@ module Auditable
       #   end
       def audit(*options)
         has_many :audits, :class_name => "Auditable::Audit", :as => :auditable
-        after_create {|record| record.snap!("create")}
-        after_update {|record| record.snap!("update")}
+        after_create {|record| record.snap!(:action => "create")}
+        after_update {|record| record.snap!(:action => "update")}
 
         self.audited_attributes = Array.wrap options
       end
@@ -35,6 +33,8 @@ module Auditable
 
     # INSTANCE METHODS
 
+    attr_accessor :changed_by, :audit_action, :audit_tag
+
     # Get the latest audit record
     def last_audit
       audits.last
@@ -52,18 +52,19 @@ module Auditable
     end
 
     # Take a snapshot of and save the current state of the audited record's audited attributes
-    def snap!(action_default = "update")
+    #
+    # Accept values for :tag, :action and :user in the argument hash. However, these are overridden by the values set by the auditable record's virtual attributes (#audit_tag, #audit_action, #changed_by) if defined
+    def snap!(options = {})
       snap = {}.tap do |s|
         self.class.audited_attributes.each do |attr|
           s[attr.to_s] = self.send attr
         end
       end
-      audits.create! do |audit|
-        audit.modifications = snap
-        audit.tag = self.audit_tag if self.respond_to?(:audit_tag)
-        audit.action = (self.respond_to?(:audit_action) && self.audit_action) || action_default
-        audit.user = self.changed_by if self.respond_to?(:changed_by)
-      end
+      options[:modifications] = snap
+      options[:tag]           = self.audit_tag    || options[:tag]
+      options[:action]        = self.audit_action || options[:action]
+      options[:user]          = self.changed_by   || options[:user]
+      audits.create(options)
     end
 
     # Get the latest changes by comparing the latest two audits

data/lib/auditable/version.rb

@@ -1,3 +1,3 @@
 module Auditable
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/lib/auditable_spec.rb

@@ -142,4 +142,12 @@ describe Auditable do
       another_survey.audited_changes.should == {"title" => ["another survey", "another title 1"]}
     end
   end
+
+  context "virtual attributes" do
+    it "should be there!" do
+      survey.should respond_to :changed_by
+      survey.should respond_to :audit_tag
+      survey.should respond_to :audit_action
+    end
+  end
 end

data/spec/support/models.rb

@@ -1,11 +1,11 @@
 class Survey < ActiveRecord::Base
   attr_accessor :current_page
-  attr_accessor :changed_by, :audit_action, :audit_tag
 
   audit :title, :current_page
 end
 
 class User < ActiveRecord::Base
+  audit :name
 end
 
 # TODO add Question class to give examples on association stuff

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auditable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164398120 !ruby/object:Gem::Requirement
+  requirement: &2157436600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164398120
+  version_requirements: *2157436600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164397600 !ruby/object:Gem::Requirement
+  requirement: &2157436100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2164397600
+  version_requirements: *2157436100
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &2164397060 !ruby/object:Gem::Requirement
+  requirement: &2157435620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164397060
+  version_requirements: *2157435620
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2164396480 !ruby/object:Gem::Requirement
+  requirement: &2157435000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164396480
+  version_requirements: *2157435000
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2164395960 !ruby/object:Gem::Requirement
+  requirement: &2157434460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164395960
+  version_requirements: *2157434460
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2164395540 !ruby/object:Gem::Requirement
+  requirement: &2157434040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164395540
+  version_requirements: *2157434040
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164395020 !ruby/object:Gem::Requirement
+  requirement: &2157433280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164395020
+  version_requirements: *2157433280
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2164394000 !ruby/object:Gem::Requirement
+  requirement: &2157432480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164394000
+  version_requirements: *2157432480
 description: A simple gem that audit models' attributes or methods by taking snapshots
   and diff them for you. Starting from scratch to work with Rails 3.2.2 onwards
 email:
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3768124813629379873
+      hash: -2723570149025110749
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3768124813629379873
+      hash: -2723570149025110749
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17