track_changes 1.0.0.pre1 → 1.0.0.pre2

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 1
 :minor: 0
 :patch: 0
-:build: pre1
+:build: pre2

data/app/helpers/audits_helper.rb

@@ -0,0 +1,36 @@
+module AuditsHelper
+  # Given a <tt>value</tt>, returns the string NONE if the value is <tt>blank?</tt>,
+  # otherwise returns the given <tt>value</tt>
+  def blank_is_none(value)
+    value.blank? ? "NONE" : value
+  end
+
+  # Allows you to iterate over a given Audit#change_set. Given a block, each time
+  # yield is called, it will return the attribute, the old version and the new
+  # version as arguments. If the Audit is a message audit, it will set the new
+  # attribute to the audit message.
+  #
+  # Example:
+  #  <% change_set_iter(audit.change_set) do |attr, old, new| %>
+  #    <p class="audit"><strong><%=h attr %></strong>
+  #      <% if audit.message %>
+  #        <em><%= new %></em>
+  #      <% else %>
+  #        changed from <em><%=h old %></em> to <em><%=h new %></em>.
+  #      <% end %>
+  #    </p>
+  #  <% end %>
+  def change_set_iter(change_set, &block)
+    change_set.each_pair do |attr, change|
+      if change.is_a?(Array)
+        old_val = blank_is_none(change.first)
+        new_val = blank_is_none(change.last)
+      else
+        old_val = blank_is_none("")
+        new_val = blank_is_none(change)
+      end
+
+      yield attr.titleize, old_val, new_val
+    end
+  end
+end

data/app/models/audit.rb

@@ -0,0 +1,54 @@
+# == Audit
+# A model for handling audits. Expects a User model to be available.
+#
+# Provides the following scopes:
+#
+# * <tt>desc</tt> - Orders by <tt>created_at</tt> DESC and then <tt>id</tt> DESC
+# * <tt>recent</tt> - Returns the last 25 audits
+# * <tt>changes_on_attributes</tt> - Returns the audits with changes to the given attribute.
+#
+# If you want to simply provide some notification of an event or a message.
+# Assign to the <tt>messsage</tt> attribute instead of the <tt>change_set</tt>
+# attribute.
+#
+# == Schema Information
+#
+# Table name: audits
+#
+#  id           :integer         not null, primary key
+#  audited_type :string(255)     not null
+#  audited_id   :integer         not null
+#  user_id      :integer         not null
+#  change_set   :text            not null
+#  created_at   :datetime        not null
+#
+class Audit < ActiveRecord::Base
+  MESSAGE = "Message"
+
+  belongs_to :audited, :polymorphic => true
+  belongs_to :user
+
+  serialize :change_set, Hash
+
+  scope :desc, :order => "audits.created_at DESC, audits.id DESC"
+  scope :recent, :order => "aduits.created_at DESC", :limit => 25
+  scope :changees_on_attribute, lambda { |attr|
+    { :conditions => ["audits.change_set LIKE ?", "%#{attr}:%"]}
+  }
+
+  # Create an Audit given the <tt>model</tt>, <tt>change_set</tt> and <tt>user</tt>.
+  def self.create_changes(model, change_set, user=nil)
+    user_id = user && user.id
+    self.create!(:audited => model, :user_id => user_id, :change_set => change_set)
+  end
+
+  # Returns a message if this audit was a message.
+  def message
+    self.change_set.has_key?(MESSAGE) && self.change_set[MESSAGE]
+  end
+
+  # Sets this audit to be a message with the given message.
+  def message=(message)
+    self.change_set = {MESSAGE => message}
+  end
+end

data/app/views/audits/_audit.html.erb

@@ -0,0 +1,15 @@
+<li class="audit">
+  <h4 class="audit"><%= audit.audited.class.to_s.humanize %> Modification
+    <span class="audit_meta">by <%= audit.try(:user).try(:name) %> on <%= audit.created_at.to_formatted_s(:long) %></span>
+  </h4>
+  <% change_set_iter(audit.change_set) do |attr, old, new| %>
+    <p class="audit"><strong><%=h attr %></strong>
+      <% if nil %>
+      <%# if audit.message %>
+        <em><%= new %></em>
+      <% else %>
+        changed from <em><%=h old %></em> to <em><%=h new %></em>.
+      <% end %>
+    </p>
+  <% end %>
+</li>

data/lib/track_changes/action_controller.rb

@@ -29,3 +29,5 @@ module TrackChanges
     end
   end
 end
+
+ActionController::Base.send :include, TrackChanges::ActionController

data/lib/track_changes/active_record.rb

@@ -24,3 +24,5 @@ module TrackChanges
     end
   end
 end
+
+ActiveRecord::Base.send :include, TrackChanges::ActiveRecord

data/lib/track_changes/engine.rb

@@ -1,5 +1,7 @@
 require 'track_changes'
 require 'rails'
+require 'action_controller'
+require 'active_record'
 
 module TrackChanges
   class Engine < Rails::Engine #:nodoc:

data/lib/track_changes.rb

@@ -1,13 +1,11 @@
 module TrackChanges
-  require 'track_changes/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
-  require 'track_changes/action_controller'
-  require 'track_changes/active_record'
-  require 'track_changes/around_save'
-  require 'track_changes/changes'
-  require 'track_changes/configuration'
-  require 'track_changes/current_user'
-  require 'track_changes/current_user_filter'
+  require 'track_changes/engine' if defined?(Rails)
 end
 
-ActiveRecord::Base.send :include, TrackChanges::ActiveRecord
-ActionController::Base.send :include, TrackChanges::ActionController
+require 'track_changes/action_controller'
+require 'track_changes/active_record'
+require 'track_changes/around_save'
+require 'track_changes/changes'
+require 'track_changes/configuration'
+require 'track_changes/current_user'
+require 'track_changes/current_user_filter'

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
     - 1
     - 0
     - 0
-    - pre1
-  version: 1.0.0.pre1
+    - pre2
+  version: 1.0.0.pre2
 platform: ruby
 authors: 
   - Matt Haley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-19 00:00:00 -07:00
+date: 2010-08-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -74,6 +74,9 @@ files:
   - LICENSE
   - TODO
   - VERSION.yml
+  - app/helpers/audits_helper.rb
+  - app/models/audit.rb
+  - app/views/audits/_audit.html.erb
   - lib/generators/track_changes/templates/initializer.rb
   - lib/generators/track_changes/templates/migration.rb
   - lib/generators/track_changes/templates/stylesheet.css