simple_audit 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+# Version 0.2.0 (May 3, 2011)
+* audit belongs_to associations
+* fixed html safety of helper
+
+# Version 0.1.1 (?)
+
 # Version 0.1.0 (Sept 29, 2010)
 * Rails 3 compatibility
 * minor API changes break backwards compatibility

data/README.markdown

@@ -85,6 +85,35 @@ Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs
     <%= render_audits(@booking) %>
     ...     
 
+## Sample styling
+      .audits {
+      	clear: both;
+      }
+      .audit {
+      	-moz-border-radius:8px;
+        -webkit-border-radius: 8px;
+        background-color: #dfdfdf;
+        padding: 6px;
+        margin-bottom: 8px;
+      	font-size: 12px;
+      }
+      .audit .action, .audit .user, .audit .timestamp{
+      	float: left;
+      	margin-right: 6px;
+      }
+      .audit .changes {
+      	clear: both;
+      	white-space: pre;
+      }
+
+      .audit .current {
+      	margin-left: 6px;
+      }
+      .audit .previous {
+      	margin-left: 6px;
+      	text-decoration: line-through;
+      }  
+
 # Assumptions and limitations
 
   * Your user model is called User and the current user User.current
@@ -93,7 +122,7 @@ Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs
     
 ## Customize auditing
 
-By default after each save, all model's attributes are saved in the audits table.
+By default after each save, all model's attributes and `belongs_to` associations (their `id` and `to_s` on these) are saved in the audits table.
 You can customize the data which is saved by supplying a block which will return all relevant data for the audited model.
 
     # app/models/booking.rb

data/Rakefile

@@ -45,7 +45,7 @@ begin
     gemspec.email = ["gabriel.tarnovan@cubus.ro", "mihai.tarnovan@cubus.ro"]
     gemspec.homepage = "http://github.com/gtarnovan/simple_audit"
     gemspec.authors = ["Gabriel Tarnovan", "Mihai Tarnovan"]
-    gemspec.version = "0.1.1"
+    gemspec.version = "0.2.0"
     gemspec.files = gem_files
     gemspec.test_files = test_files
     

data/TODO

@@ -3,6 +3,8 @@
 * ORM agnosticism
 
 # Functionality
+* configure object used as current user
+* fallback to :to_s for username_method
 * provide some sort of UUID for audited models that identify these independently from the database provided ID.
   in case of deletion and creation of a new entity with the same UUID, the audit trails of both entities could be bound.
   e.g. for an invoice the UUID could be its number/series combination. when someone deletes an invoice and creates a new one

data/lib/simple_audit/helper.rb

@@ -15,21 +15,22 @@ module SimpleAudit #:nodoc:
           content_tag(:div, l(audit.created_at), :class => "timestamp") + 
           content_tag(:div, :class => 'changes') do
             changes = if older_audit.present?
-              audit.delta(older_audit).collect do |k, v| 
+              audit.delta(older_audit).sort{|x,y| audited_model.class.human_attribute_name(x.first) <=> audited_model.class.human_attribute_name(y.first)}.collect do |k, v|                
+                next if k.to_s == 'created_at' || k.to_s == 'updated_at'
                 "\n" + 
                 audited_model.class.human_attribute_name(k) +
                 ":" +
                 content_tag(:span, v.last, :class => 'current') +
-                content_tag(:span, v.first, :class => 'previous') 
+                content_tag(:span, v.first, :class => 'previous')
               end
             else
-              audit.change_log.reject{|k, v| v.blank?}.collect {|k, v| "\n#{audited_model.class.human_attribute_name(k)}: #{v}"}
+              audit.change_log.sort{|x,y| audited_model.class.human_attribute_name(x.first) <=> audited_model.class.human_attribute_name(y.first)}.reject{|k, v| v.blank?}.collect {|k, v| "\n#{audited_model.class.human_attribute_name(k)}: #{v}"}
             end
-            changes.join    
+            raw changes.join
           end        
         end
       end
-      res
+      raw res
     end 
     
   end

data/lib/simple_audit/simple_audit.rb

@@ -20,7 +20,7 @@ module SimpleAudit
       #
       # * <tt>username_method => symbol</tt> - Call this method on the current user to get the name
       #
-      # With no block, all the attributes of the audited model will be logged.
+      # With no block, all the attributes and <tt>belongs_to</tt> associations (id and to_s) of the audited model will be logged.
       #
       #    class Booking
       #      # this is equivalent to passing no block
@@ -49,7 +49,14 @@ module SimpleAudit
           write_inheritable_attribute :username_method, (options[:username_method] || :name).to_sym
           class_inheritable_reader :username_method
 
-          audit_changes_proc = block_given? ? block.to_proc : Proc.new {|record| record.attributes}
+          attributes_and_associations = proc do |record|
+            changes = record.attributes
+            record.class.reflect_on_all_associations(:belongs_to).each do |assoc|
+              changes[assoc.name] = record.send(assoc.name).to_s
+            end
+            changes
+          end
+          audit_changes_proc = block_given? ? block.to_proc : attributes_and_associations
           write_inheritable_attribute :audit_changes, audit_changes_proc
           class_inheritable_reader :audit_changes
 

data/simple_audit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_audit}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabriel Tarnovan", "Mihai Tarnovan"]
-  s.date = %q{2010-11-09}
+  s.date = %q{2011-05-03}
   s.description = %q{      Provides a straightforward way for auditing changes on active record models, especially for composite entities. 
       Also provides helper methods for easily rendering an audit trail in Ruby on Rails views.
 }
@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{simple_audit}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Simple auditing solution for ActiveRecord models}
   s.test_files = [
     "test/fixtures",
@@ -62,7 +62,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else
     end
   else

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: simple_audit
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gabriel Tarnovan
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 +01:00
+date: 2011-05-03 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -65,27 +64,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: simple_audit
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Simple auditing solution for ActiveRecord models