auditable 0.0.4 → 0.0.5

data/.yardopts

@@ -0,0 +1 @@
+- CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# 0.0.5 (2012-03-12)
+
+## Changes
+
+Easier to explain with code
+
+    # Given
+    >> s = Survey.create :title => "something"
+    >> s.audits.delete_all
+
+    # Before 0.0.5
+    >> s.audit_tag_with("some tag") # do nothing when no audits exist
+    >> s.audits.empty? # => true
+
+    # From 0.0.5 onwards
+    >> s.audit_tag_with("some tag") # create an audit with tag if no audits exist
+    >> s.audits.first.tag == "some tag"
+

data/README.md

@@ -18,9 +18,9 @@ Basically:
 * I don't want the default to track all my columns. Only the attributes or methods I specify please.
 * I don't want to deal with association mess. Use methods instead.
 * I care about tracking the values of certain virtual attributes or methods, not just database columns
-* I want something simple, similar to [ActiveRecord::Dirty#changes](http://ar.rubyonrails.org/classes/ActiveRecord/Dirty.html#M000291) but persistent across saves. See `Auditable::Auditing#audited_changes` below.
+* I want something simple, similar to [ActiveRecord::Dirty#changes](http://ar.rubyonrails.org/classes/ActiveRecord/Dirty.html#M000291) but persistent across saves. See the usage of {Auditable::Auditing#audited_changes} below.
 
-See examples under Usage section.
+See examples under {file:README.md#Usage Usage} section. Please check the {file:CHANGELOG.md} as well.
 
 ## Installation
 
@@ -130,12 +130,11 @@ If you want to store the user who made the changed to the record, just assigned
     >> @survey.changed_action = "add page"
     >> @survey.update_attribute :page_count, 2
 
-**Don't store a new row in `audits` table if the `modifications` column is the same as the one immediately before it. This makes it easier to review change**
-
 That's all I can do for this README Driven approach. Back soon.
 
 ## TODO
 
+* **Don't store a new row in the `audits` table if the `modifications` column is the same as the one immediately before it. This makes it easier to review change**
 * improve api (still clumsy) -- come up with better syntax
 * get some suggestions and feedback
 * update README
@@ -152,3 +151,7 @@ e.g. right now, changes are serialized into `audits.modifications` column, but w
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## CHANGELOG
+
+{include:file:CHANGELOG.md}

data/lib/auditable/auditing.rb

@@ -40,9 +40,15 @@ module Auditable
       audits.last
     end
 
-    # Mark the latest record in order to easily find and perform diff against later
+    # Mark the latest record with a tag in order to easily find and perform diff against later
+    # If there are no audits for this record, create a new audit with this tag
     def audit_tag_with(tag)
-      last_audit.update_attribute(:tag, tag) if last_audit
+      if last_audit
+        last_audit.update_attribute(:tag, tag)
+      else
+        self.audit_tag = tag
+        snap!
+      end
     end
 
     # Take a snapshot of and save the current state of the audited record's audited attributes

data/lib/auditable/version.rb

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

data/spec/lib/auditable_spec.rb

@@ -23,18 +23,24 @@ describe Auditable do
     end
 
     it "should not not fail with errors" do
-      survey.audit_tag_with("something") # no audit to tag but should be ok with it
       survey.audits.count.should == 0
       survey.audited_changes.should == {}
       survey.audited_changes(:tag => "something").should == {}
     end
 
-    it "should work after first update " do
+    it "should work after first update" do
       survey.update_attributes :title => "new title"
       survey.audited_changes.should == {"title" => ["test survey", "new title"]}
       survey.audited_changes(:tag => "something").should == {"title" => [nil, "new title"]}
       survey.audits.count.should == 1
     end
+
+    it "should create a new audit when calling audit_tag_with without existing audits" do
+      survey.audits.count.should == 0
+      survey.audit_tag_with("something") # no audit to tag but should be ok with it
+      survey.audits.count.should == 1
+      survey.audits.last.tag.should == "something"
+    end
   end
 
   it "should behave similar to ActiveRecord::Dirty#changes" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auditable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-12 00:00:00.000000000 Z
+date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156151900 !ruby/object:Gem::Requirement
+  requirement: &2164398120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156151900
+  version_requirements: *2164398120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156151400 !ruby/object:Gem::Requirement
+  requirement: &2164397600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2156151400
+  version_requirements: *2164397600
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &2156150840 !ruby/object:Gem::Requirement
+  requirement: &2164397060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156150840
+  version_requirements: *2164397060
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2156150280 !ruby/object:Gem::Requirement
+  requirement: &2164396480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156150280
+  version_requirements: *2164396480
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156149760 !ruby/object:Gem::Requirement
+  requirement: &2164395960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156149760
+  version_requirements: *2164395960
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2156149340 !ruby/object:Gem::Requirement
+  requirement: &2164395540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156149340
+  version_requirements: *2164395540
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156148740 !ruby/object:Gem::Requirement
+  requirement: &2164395020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156148740
+  version_requirements: *2164395020
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2156147660 !ruby/object:Gem::Requirement
+  requirement: &2164394000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156147660
+  version_requirements: *2164394000
 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:
@@ -111,6 +111,8 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -141,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2973896956305891645
+      hash: 3768124813629379873
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2973896956305891645
+      hash: 3768124813629379873
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17