paper_trail 1.4.5 → 1.4.6

data/VERSION

@@ -1 +1 @@
-1.4.4
+1.4.6

data/lib/paper_trail.rb

@@ -1,19 +1,12 @@
 require 'yaml'
 require 'paper_trail/config'
+require 'paper_trail/controller'
 require 'paper_trail/has_paper_trail'
 require 'paper_trail/version'
 
+# PaperTrail's module methods can be called in both models and controllers.
 module PaperTrail
 
-  def self.included(base)
-    base.before_filter :set_whodunnit
-  end
-
-  # Returns PaperTrail's configuration object.
-  def self.config
-    @@config ||= PaperTrail::Config.instance
-  end
-
   # Switches PaperTrail on or off.
   def self.enabled=(value)
     PaperTrail.config.enabled = value
@@ -25,6 +18,11 @@ module PaperTrail
     !!PaperTrail.config.enabled
   end
 
+  # Returns PaperTrail's configuration object.
+  def self.config
+    @@config ||= PaperTrail::Config.instance
+  end
+
   # Returns who is reponsible for any changes that occur.
   def self.whodunnit
     Thread.current[:whodunnit]
@@ -38,13 +36,4 @@ module PaperTrail
     Thread.current[:whodunnit] = value
   end
 
-  protected
-
-  # Sets who is responsible for any changes that occur: the controller's
-  # `current_user`.
-  def set_whodunnit
-    Thread.current[:whodunnit] = self.send :current_user rescue nil
-  end
 end
-
-ActionController::Base.send :include, PaperTrail

data/lib/paper_trail/controller.rb

@@ -0,0 +1,19 @@
+module PaperTrail
+  module Controller
+
+    def self.included(base)
+      base.before_filter :set_whodunnit
+    end
+
+    protected
+
+    # Sets who is responsible for any changes that occur: the controller's
+    # `current_user`.
+    def set_whodunnit
+      ::PaperTrail.whodunnit = self.send :current_user rescue nil
+    end
+
+  end
+end
+
+ActionController::Base.send :include, PaperTrail::Controller

data/lib/paper_trail/has_paper_trail.rb

@@ -1,117 +1,119 @@
 module PaperTrail
+  module Model
 
-  def self.included(base)
-    base.send :extend, ClassMethods
-  end
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
 
 
-  module ClassMethods
-    # Options:
-    # :ignore    an array of attributes for which a new +Version+ will not be created if only they change.
-    # :meta      a hash of extra data to store.  You must add a column to the versions table for each key.
-    #            Values are objects or procs (which are called with +self+, i.e. the model with the paper
-    #            trail).
-    def has_paper_trail(options = {})
-      send :include, InstanceMethods
+    module ClassMethods
+      # Options:
+      # :ignore    an array of attributes for which a new +Version+ will not be created if only they change.
+      # :meta      a hash of extra data to store.  You must add a column to the versions table for each key.
+      #            Values are objects or procs (which are called with +self+, i.e. the model with the paper
+      #            trail).
+      def has_paper_trail(options = {})
+        send :include, InstanceMethods
 
-      cattr_accessor :ignore
-      self.ignore = (options[:ignore] || []).map &:to_s
+        cattr_accessor :ignore
+        self.ignore = (options[:ignore] || []).map &:to_s
 
-      cattr_accessor :meta
-      self.meta = options[:meta] || {}
+        cattr_accessor :meta
+        self.meta = options[:meta] || {}
 
-      # Indicates whether or not PaperTrail is active for this class.
-      # This is independent of whether PaperTrail is globally enabled or disabled.
-      cattr_accessor :paper_trail_active
-      self.paper_trail_active = true
+        # Indicates whether or not PaperTrail is active for this class.
+        # This is independent of whether PaperTrail is globally enabled or disabled.
+        cattr_accessor :paper_trail_active
+        self.paper_trail_active = true
 
-      has_many :versions, :as => :item, :order => 'created_at ASC, id ASC'
+        has_many :versions, :as => :item, :order => 'created_at ASC, id ASC'
 
-      after_create  :record_create
-      before_update :record_update
-      after_destroy :record_destroy
-    end
+        after_create  :record_create
+        before_update :record_update
+        after_destroy :record_destroy
+      end
 
-    # Switches PaperTrail off for this class.
-    def paper_trail_off
-      self.paper_trail_active = false
-    end
+      # Switches PaperTrail off for this class.
+      def paper_trail_off
+        self.paper_trail_active = false
+      end
 
-    # Switches PaperTrail on for this class.
-    def paper_trail_on
-      self.paper_trail_active = true
+      # Switches PaperTrail on for this class.
+      def paper_trail_on
+        self.paper_trail_active = true
+      end
     end
-  end
 
 
-  module InstanceMethods
-    def record_create
-      if switched_on?
-        versions.create merge_metadata(:event => 'create', :whodunnit => PaperTrail.whodunnit)
+    module InstanceMethods
+      def record_create
+        if switched_on?
+          versions.create merge_metadata(:event => 'create', :whodunnit => PaperTrail.whodunnit)
+        end
       end
-    end
 
-    def record_update
-      if switched_on? && changed_and_we_care?
-        versions.build merge_metadata(:event     => 'update',
-                                      :object    => object_to_string(previous_version),
-                                      :whodunnit => PaperTrail.whodunnit)
+      def record_update
+        if switched_on? && changed_and_we_care?
+          versions.build merge_metadata(:event     => 'update',
+                                        :object    => object_to_string(previous_version),
+                                        :whodunnit => PaperTrail.whodunnit)
+        end
       end
-    end
 
-    def record_destroy
-      if switched_on?
-        versions.create merge_metadata(:event     => 'destroy',
-                                       :object    => object_to_string(previous_version),
-                                       :whodunnit => PaperTrail.whodunnit)
+      def record_destroy
+        if switched_on?
+          versions.create merge_metadata(:event     => 'destroy',
+                                         :object    => object_to_string(previous_version),
+                                         :whodunnit => PaperTrail.whodunnit)
+        end
       end
-    end
 
-    # Returns the object (not a Version) as it was at the given timestamp.
-    def version_at(timestamp)
-      # Short-circuit if the current state is applicable.
-      return self if self.updated_at <= timestamp
-      # Look for the first version created after, rather than before, the
-      # timestamp because a version stores how the object looked before the
-      # change.
-      version = versions.first :conditions => ['created_at > ?', timestamp],
-                               :order      => 'created_at ASC'
-      version.reify if version
-    end
+      # Returns the object (not a Version) as it was at the given timestamp.
+      def version_at(timestamp)
+        # Short-circuit if the current state is applicable.
+        return self if self.updated_at <= timestamp
+        # Look for the first version created after, rather than before, the
+        # timestamp because a version stores how the object looked before the
+        # change.
+        version = versions.first :conditions => ['created_at > ?', timestamp],
+          :order      => 'created_at ASC'
+        version.reify if version
+      end
 
-    private
+      private
 
-    def merge_metadata(data)
-      meta.each do |k,v|
-        data[k] = v.respond_to?(:call) ? v.call(self) : v
+      def merge_metadata(data)
+        meta.each do |k,v|
+          data[k] = v.respond_to?(:call) ? v.call(self) : v
+        end
+        data
       end
-      data
-    end
 
-    def previous_version
-      previous = self.clone
-      previous.id = id
-      changes.each do |attr, ary|
-        previous.send "#{attr}=", ary.first
+      def previous_version
+        previous = self.clone
+        previous.id = id
+        changes.each do |attr, ary|
+          previous.send "#{attr}=", ary.first
+        end
+        previous
       end
-      previous
-    end
 
-    def object_to_string(object)
-      object.attributes.to_yaml
-    end
+      def object_to_string(object)
+        object.attributes.to_yaml
+      end
 
-    def changed_and_we_care?
-      changed? and !(changed - self.class.ignore).empty?
-    end
+      def changed_and_we_care?
+        changed? and !(changed - self.class.ignore).empty?
+      end
 
-    # Returns `true` if PaperTrail is globally enabled and active for this class,
-    # `false` otherwise.
-    def switched_on?
-      PaperTrail.enabled? && self.class.paper_trail_active
+      # Returns `true` if PaperTrail is globally enabled and active for this class,
+      # `false` otherwise.
+      def switched_on?
+        PaperTrail.enabled? && self.class.paper_trail_active
+      end
     end
-  end
 
+  end
 end
 
-ActiveRecord::Base.send :include, PaperTrail
+ActiveRecord::Base.send :include, PaperTrail::Model

data/paper_trail.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{paper_trail}
-  s.version = "1.4.5"
+  s.version = "1.4.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Stewart"]
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "install.rb",
      "lib/paper_trail.rb",
      "lib/paper_trail/config.rb",
+     "lib/paper_trail/controller.rb",
      "lib/paper_trail/has_paper_trail.rb",
      "lib/paper_trail/version.rb",
      "paper_trail.gemspec",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors: 
 - Andy Stewart
@@ -34,6 +34,7 @@ files:
 - install.rb
 - lib/paper_trail.rb
 - lib/paper_trail/config.rb
+- lib/paper_trail/controller.rb
 - lib/paper_trail/has_paper_trail.rb
 - lib/paper_trail/version.rb
 - paper_trail.gemspec