activerecord-userstamp 2.1.1 → 3.0.0

data/Rakefile

@@ -1,17 +1,17 @@
-require 'bundler/setup'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-require 'rdoc/task'
-desc 'Generate documentation for the userstamp plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Userstamp'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('Readme.rdoc', 'CHANGELOG', 'LICENSE')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+desc 'Generate documentation for the userstamp plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Userstamp'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('Readme.rdoc', 'CHANGELOG', 'LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/activerecord-userstamp.gemspec

@@ -1,34 +1,34 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'active_record/userstamp/version'
-
-Gem::Specification.new do |s|
-  s.name = 'activerecord-userstamp'
-  s.version = ActiveRecord::Userstamp::VERSION
-  s.authors = ['Joel Low']
-  s.email = ['joel@joelsplace.sg']
-
-  s.summary = 'Adds magic creator and updater attributes to your ActiveRecord models.'
-  s.description = 'This gem extends ActiveRecord::Base to add automatic updating of created_by and updated_by attributes of your models in much the same way that the ActiveRecord::Timestamp module updates created_(at/on) and updated_(at/on) attributes.'
-  s.homepage = 'https://github.com/lowjoel/activerecord-userstamp'
-  s.license  = 'MIT'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.add_dependency 'activesupport', '~> 4.2'
-  s.add_dependency 'activerecord', '~> 4.2'
-
-  s.add_development_dependency 'actionview', '~> 4.2'
-  s.add_development_dependency 'tzinfo-data'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rdoc'
-  s.add_development_dependency 'rspec-rails', '~> 3.3'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'codeclimate-test-reporter'
-  s.add_development_dependency 'sqlite3'
-end
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/userstamp/version'
+
+Gem::Specification.new do |s|
+  s.name = 'activerecord-userstamp'
+  s.version = ActiveRecord::Userstamp::VERSION
+  s.authors = ['Joel Low']
+  s.email = ['joel@joelsplace.sg']
+
+  s.summary = 'Adds magic creator and updater attributes to your ActiveRecord models.'
+  s.description = 'This gem extends ActiveRecord::Base to add automatic updating of created_by and updated_by attributes of your models in much the same way that the ActiveRecord::Timestamp module updates created_(at/on) and updated_(at/on) attributes.'
+  s.homepage = 'https://github.com/lowjoel/activerecord-userstamp'
+  s.license  = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '~> 4.2'
+  s.add_dependency 'activerecord', '~> 4.2'
+
+  s.add_development_dependency 'actionview', '~> 4.2'
+  s.add_development_dependency 'tzinfo-data'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rspec-rails', '~> 3.3'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/active_record/userstamp.rb

@@ -1,14 +1,30 @@
-module ActiveRecord::Userstamp
-  extend ActiveSupport::Autoload
-
-  autoload :Stampable
-  autoload :Stamper
-
-  eager_autoload do
-    autoload :ControllerAdditions
-    autoload :MigrationAdditions
-    autoload :ModelAdditions
-  end
-
-  eager_load!
-end
+module ActiveRecord::Userstamp
+  extend ActiveSupport::Autoload
+
+  autoload :Configuration
+  autoload :Stampable
+  autoload :Stamper
+  autoload :Utilities
+
+  eager_autoload do
+    autoload :ControllerAdditions
+    autoload :MigrationAdditions
+    autoload :ModelAdditions
+  end
+
+  # Retrieves the configuration for the userstamp gem.
+  #
+  # @return [ActiveRecord::Userstamp::Configuration]
+  def self.config
+    Configuration
+  end
+
+  # Configures the gem.
+  #
+  # @yield [ActiveRecord::Userstamp::Configuration] The configuration for the gem.
+  def self.configure
+    yield config
+  end
+
+  eager_load!
+end

data/lib/active_record/userstamp/configuration.rb

@@ -0,0 +1,49 @@
+module ActiveRecord::Userstamp::Configuration
+  # !@attribute [r] default_stamper
+  #   Determines the default model used to stamp other models.
+  #
+  #   By default, this is set to +'User'+.
+  def self.default_stamper
+    ActiveRecord::Base.stamper_class_name
+  end
+
+  # !@attribute [rw] default_stamper
+  # @see {.default_stamper}
+  def self.default_stamper=(stamper)
+    ActiveRecord::Base.stamper_class_name = stamper
+  end
+  self.default_stamper = 'User'.freeze
+
+  # @!attribute [r] default_stamper_class
+  #   Determines the default model used to stamp other models.
+  def self.default_stamper_class
+    ActiveRecord::Base.stamper_class
+  end
+
+  # !@attribute [rw] creator_attribute
+  #   Determines the name of the column in the database which stores the name of the creator.
+  #
+  #   Override the attribute by using the stampable class method within a model.
+  #
+  #   By default, this is set to +:creator_id+.
+  mattr_accessor :creator_attribute
+  self.creator_attribute = :creator_id
+
+  # !@attribute [rw] updater_attribute
+  #   Determines the name of the column in the database which stores the name of the updater.
+  #
+  #   Override the attribute by using the stampable class method within a model.
+  #
+  #   By default, this is set to +:updater_id+.
+  mattr_accessor :updater_attribute
+  self.updater_attribute = :updater_id
+
+  # !@attribute [rw] deleter_attribute
+  #   Determines the name of the column in the database which stores the name of the deleter.
+  #
+  #   Override the attribute by using the stampable class method within a model.
+  #
+  #   By default, this is set to +:deleter_id+.
+  mattr_accessor :deleter_attribute
+  self.deleter_attribute = :deleter_id
+end

data/lib/active_record/userstamp/controller_additions.rb

@@ -1,41 +1,38 @@
-# The Userstamp module, when included into a controller, adds a before filter
-# (named <tt>set_stamper</tt>) and an after filter (name <tt>reset_stamper</tt>).
-# These methods assume a couple of things, but can be re-implemented in your
-# controller to better suite your application.
-#
-# See the documentation for <tt>set_stamper</tt> and <tt>reset_stamper</tt> for
-# specific implementation details.
-module ActiveRecord::Userstamp::ControllerAdditions
-  def self.included(base) # :nodoc:
-    base.send           :include, InstanceMethods
-    base.before_filter  :set_stamper
-    base.after_filter   :reset_stamper
-  end
-
-  module InstanceMethods
-    private
-    # The <tt>set_stamper</tt> method as implemented here assumes a couple
-    # of things. First, that you are using a +User+ model as the stamper
-    # and second that your controller has a <tt>current_user</tt> method
-    # that contains the currently logged in stamper. If either of these
-    # are not the case in your application you will want to manually add
-    # your own implementation of this method to the private section of
-    # the controller where you are including the Userstamp module.
-    def set_stamper
-      User.stamper = self.current_user
-    end
-
-    # The <tt>reset_stamper</tt> method as implemented here assumes that a
-    # +User+ model is being used as the stamper. If this is not the case then
-    # you will need to manually add your own implementation of this method to
-    # the private section of the controller where you are including the
-    # Userstamp module.
-    def reset_stamper
-      User.reset_stamper
-    end
-  end
-end
-
-if defined?(ActionController)
-  ActionController::Base.send(:include, ActiveRecord::Userstamp::ControllerAdditions)
-end
+# The +ControllerAdditions+ module, when included into a controller, adds an +before_action+
+# callback (named +set_stamper+) and an +after_action+ callback (named +reset_stamper+). These
+# methods assume a couple of things, but can be re-implemented in your controller to better suit
+# your application.
+#
+# See the documentation for `set_stamper` and `reset_stamper` for specific implementation details.
+module ActiveRecord::Userstamp::ControllerAdditions
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :set_stamper
+    after_filter :reset_stamper
+  end
+
+  private
+
+  # The +set_stamper+ method as implemented here assumes a couple of things. First, that you are
+  # using a +User+ model as the stamper and second that your controller has a +current_user+
+  # method that contains the currently logged in stamper. If either of these are not the case in
+  # your application you will want to manually add your own implementation of this method to the
+  # private section of your +ApplicationController+
+  def set_stamper
+    ActiveRecord::Userstamp.config.default_stamper_class.stamper = current_user
+  end
+
+  # The +reset_stamper+ method as implemented here assumes that a +User+ model is being used as
+  # the stamper. If this is not the case then you will need to manually add your own
+  # implementation of this method to the private section of your +ApplicationController+
+  def reset_stamper
+    ActiveRecord::Userstamp.config.default_stamper_class.reset_stamper
+  end
+end
+
+if defined?(ActionController)
+  ActionController::Base.class_eval do
+    include ActiveRecord::Userstamp::ControllerAdditions
+  end
+end

data/lib/active_record/userstamp/migration_additions.rb

@@ -1,16 +1,14 @@
-module ActiveRecord::Userstamp::MigrationHelper
-  def self.included(base) # :nodoc:
-    base.send(:include, InstanceMethods)
-  end
-
-  module InstanceMethods
-    def userstamps(include_deleted_by = false, *args)
-      column(ActiveRecord::Userstamp.compatibility_mode ? :created_by : :creator_id, :integer, *args)
-      column(ActiveRecord::Userstamp.compatibility_mode ? :updated_by : :updater_id, :integer, *args)
-      column(ActiveRecord::Userstamp.compatibility_mode ? :deleted_by : :deleter_id, :integer, *args) if include_deleted_by
-    end
-  end
-end
-
-ActiveRecord::ConnectionAdapters::TableDefinition.send(:include,
-  ActiveRecord::Userstamp::MigrationHelper)
+module ActiveRecord::Userstamp::MigrationHelper
+  extend ActiveSupport::Concern
+
+  def userstamps(*args)
+    config = ActiveRecord::Userstamp.config
+    column(config.creator_attribute, :integer, *args)
+    column(config.updater_attribute, :integer, *args)
+    column(config.deleter_attribute, :integer, *args) if config.deleter_attribute.present?
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.class_eval do
+  include ActiveRecord::Userstamp::MigrationHelper
+end

data/lib/active_record/userstamp/model_additions.rb

@@ -1,3 +1,10 @@
-module ActiveRecord::Userstamp::ModelAdditions; end
-ActiveRecord::Base.send(:include, ActiveRecord::Userstamp::Stampable)
-ActiveRecord::Base.send(:include, ActiveRecord::Userstamp::Stamper)
+module ActiveRecord::Userstamp::ModelAdditions
+  extend ActiveSupport::Concern
+
+  include ActiveRecord::Userstamp::Stampable
+  include ActiveRecord::Userstamp::Stamper
+end
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Userstamp::ModelAdditions
+end

data/lib/active_record/userstamp/stampable.rb

@@ -1,174 +1,121 @@
-module ActiveRecord::Userstamp
-  # Determines what default columns to use for recording the current stamper.
-  # By default this is set to false, so the plug-in will use columns named
-  # <tt>creator_id</tt>, <tt>updater_id</tt>, and <tt>deleter_id</tt>.
-  #
-  # To turn compatibility mode on, place the following line in your environment.rb
-  # file:
-  #
-  #   Ddb::Userstamp.compatibility_mode = true
-  #
-  # This will cause the plug-in to use columns named <tt>created_by</tt>,
-  # <tt>updated_by</tt>, and <tt>deleted_by</tt>.
-  mattr_accessor :compatibility_mode
-  @@compatibility_mode = false
-
-  # Extends the stamping functionality of ActiveRecord by automatically recording the model
-  # responsible for creating, updating, and deleting the current object. See the Stamper
-  # and Userstamp modules for further documentation on how the entire process works.
-  module Stampable
-    def self.included(base) #:nodoc:
-      super
-
-      base.extend(ClassMethods)
-      base.class_eval do
-        include InstanceMethods
-
-        # Should ActiveRecord record userstamps? Defaults to true.
-        class_attribute  :record_userstamp
-        self.record_userstamp = true
-
-        # Which class is responsible for stamping? Defaults to :user.
-        class_attribute  :stamper_class_name
-
-        # What column should be used for the creator stamp?
-        # Defaults to :creator_id when compatibility mode is off
-        # Defaults to :created_by when compatibility mode is on
-        class_attribute  :creator_attribute
-
-        # What column should be used for the updater stamp?
-        # Defaults to :updater_id when compatibility mode is off
-        # Defaults to :updated_by when compatibility mode is on
-        class_attribute  :updater_attribute
-
-        # What column should be used for the deleter stamp?
-        # Defaults to :deleter_id when compatibility mode is off
-        # Defaults to :deleted_by when compatibility mode is on
-        class_attribute  :deleter_attribute
-      end
-    end
-
-    module ClassMethods
-      # This method is automatically called on for all classes that inherit from
-      # ActiveRecord, but if you need to customize how the plug-in functions, this is the
-      # method to use. Here's an example:
-      #
-      #   class Post < ActiveRecord::Base
-      #     stampable :stamper_class_name => :person,
-      #               :creator_attribute  => :create_user,
-      #               :updater_attribute  => :update_user,
-      #               :deleter_attribute  => :delete_user,
-      #               :deleter            => true,
-      #               :with_deleted       => true
-      #   end
-      #
-      # The method will automatically setup all the associations,
-      # and create <tt>before_validation</tt> & <tt>before_destroy</tt> callbacks for doing the stamping.
-      #
-      # By default, the deleter association and before filter are not defined unless
-      # you set the :deleter_attribute or set the :deleter option to true.
-      #
-      # When using the new acts_as_paranoid gem (https://github.com/goncalossilva/rails3_acts_as_paranoid)
-      # the :with_deleted option can be used to setup the associations to return objects that have been soft deleted.
-      #
-      def stampable(options = {})
-        compatability = ActiveRecord::Userstamp.compatibility_mode
-        defaults  = {
-          :stamper_class_name => :user,
-          :creator_attribute  => (compatability ? :created_by : :creator_id),
-          :updater_attribute  => (compatability ? :updated_by : :updater_id),
-          :deleter_attribute  => (compatability ? :deleted_by : :deleter_id),
-          :deleter            => options.has_key?(:deleter_attribute),
-          :with_deleted       => false
-        }.merge(options)
-
-        self.stamper_class_name = defaults[:stamper_class_name].to_sym
-        self.creator_attribute  = defaults[:creator_attribute].to_sym
-        self.updater_attribute  = defaults[:updater_attribute].to_sym
-        self.deleter_attribute  = defaults[:deleter_attribute].to_sym
-
-        class_eval do
-          klass = "::#{stamper_class_name.to_s.singularize.camelize}"
-
-          if defaults[:with_deleted]
-            belongs_to :creator, :class_name => klass, :foreign_key => creator_attribute, :with_deleted => true
-            belongs_to :updater, :class_name => klass, :foreign_key => updater_attribute, :with_deleted => true
-          else
-            belongs_to :creator, :class_name => klass, :foreign_key => creator_attribute
-            belongs_to :updater, :class_name => klass, :foreign_key => updater_attribute
-          end
-
-          before_validation :set_updater_attribute
-          before_validation :set_creator_attribute, :on => :create
-          before_save :set_updater_attribute
-          before_save :set_creator_attribute, :on => :create
-
-          if defaults[:deleter]
-            if defaults[:with_deleted]
-              belongs_to :deleter, :class_name => klass, :foreign_key => deleter_attribute, :with_deleted => true
-            else
-              belongs_to :deleter, :class_name => klass, :foreign_key => deleter_attribute
-            end
-
-            before_destroy :set_deleter_attribute
-
-          end
-        end
-      end
-
-      # Temporarily allows you to turn stamping off. For example:
-      #
-      #   Post.without_stamps do
-      #     post = Post.find(params[:id])
-      #     post.update_attributes(params[:post])
-      #     post.save
-      #   end
-      def without_stamps
-        original_value = self.record_userstamp
-        self.record_userstamp = false
-        yield
-      ensure
-        self.record_userstamp = original_value
-      end
-
-      def stamper_class #:nodoc:
-        stamper_class_name.to_s.camelize.constantize rescue nil
-      end
-    end
-
-    module InstanceMethods #:nodoc:
-      private
-        def has_stamper?
-          !self.class.stamper_class.nil? && !self.class.stamper_class.stamper.nil? rescue false
-        end
-
-        def set_creator_attribute
-          return unless self.record_userstamp
-          if respond_to?(self.creator_attribute.to_sym) && has_stamper?
-            if self.send(self.creator_attribute.to_sym).blank?
-              self.send("#{self.creator_attribute}=".to_sym, self.class.stamper_class.stamper)
-            end
-          end
-        end
-
-        def set_updater_attribute
-          return unless self.record_userstamp
-          # only set updater if the record is new or has changed
-          # or contains a serialized attribute (in which case the attribute value is always updated)
-          return unless self.new_record? || self.changed? || self.class.serialized_attributes.present?
-          if respond_to?(self.updater_attribute.to_sym) && has_stamper?
-            self.send("#{self.updater_attribute}=".to_sym, self.class.stamper_class.stamper)
-          end
-        end
-
-        def set_deleter_attribute
-          return unless self.record_userstamp
-          if respond_to?(self.deleter_attribute.to_sym) && has_stamper?
-            self.send("#{self.deleter_attribute}=".to_sym, self.class.stamper_class.stamper)
-            save
-          end
-        end
-      #end private
-    end
-  end
-end
+# Extends the stamping functionality of ActiveRecord by automatically recording the model
+# responsible for creating, updating, and deleting the current object. See the +Stamper+ and
+# +ControllerAdditions+ modules for further documentation on how the entire process works.
+module ActiveRecord::Userstamp::Stampable
+  extend ActiveSupport::Concern
+
+  included do
+    # Should ActiveRecord record userstamps? Defaults to true.
+    class_attribute  :record_userstamp
+    self.record_userstamp = true
+
+    class_attribute  :stamper_class_name
+
+    before_validation :set_updater_attribute, if: :record_userstamp
+    before_validation :set_creator_attribute, on: :create, if: :record_userstamp
+    before_save :set_updater_attribute, if: :record_userstamp
+    before_save :set_creator_attribute, on: :create, if: :record_userstamp
+    before_destroy :set_deleter_attribute, if: :record_userstamp
+  end
+
+  module ClassMethods
+    def inherited(klass)
+      super
+
+      klass.class_eval do
+        add_userstamp_associations({})
+      end
+    end
+
+    # This method customizes how the gem functions. For example:
+    #
+    #   class Post < ActiveRecord::Base
+    #     stampable stamper_class_name: Person.name,
+    #               with_deleted:       true
+    #   end
+    #
+    # The method will set up all the associations. Extra arguments (like +:with_deleted+) will be
+    # propagated to the associations.
+    #
+    # By default, the deleter association is not defined unless the :deleter_attribute is set in
+    # the gem configuration.
+    def stampable(options = {})
+      self.stamper_class_name = options.delete(:stamper_class_name) if options.key?(:stamper_class_name)
+
+      add_userstamp_associations(options)
+    end
+
+    # Temporarily allows you to turn stamping off. For example:
+    #
+    #   Post.without_stamps do
+    #     post = Post.find(params[:id])
+    #     post.update_attributes(params[:post])
+    #     post.save
+    #   end
+    def without_stamps
+      original_value = self.record_userstamp
+      self.record_userstamp = false
+      yield
+    ensure
+      self.record_userstamp = original_value
+    end
+
+    def stamper_class #:nodoc:
+      stamper_class_name.to_s.camelize.constantize rescue nil
+    end
+
+    private
+
+    # Defines the associations for Userstamp.
+    def add_userstamp_associations(options)
+      config = ActiveRecord::Userstamp.config
+      klass = stamper_class.try(:name)
+      relation_options = options.reverse_merge(class_name: klass)
+
+      ActiveRecord::Userstamp::Utilities.remove_association(self, :creator)
+      ActiveRecord::Userstamp::Utilities.remove_association(self, :updater)
+      ActiveRecord::Userstamp::Utilities.remove_association(self, :deleter)
+
+      belongs_to :creator, relation_options.reverse_merge(foreign_key: config.creator_attribute)
+      belongs_to :updater, relation_options.reverse_merge(foreign_key: config.updater_attribute)
+
+      if config.deleter_attribute
+        remove_method(:deleter) if method_defined?(:deleter)
+        belongs_to :deleter, relation_options.reverse_merge(foreign_key: config.deleter_attribute)
+      end
+    end
+  end
+
+  private
+
+  def has_stamper?
+    !self.class.stamper_class.nil? && !self.class.stamper_class.stamper.nil?
+  end
+
+  def set_creator_attribute
+    creator_attribute = ActiveRecord::Userstamp.config.creator_attribute
+    return if !has_stamper? || creator_attribute.nil? || !has_attribute?(creator_attribute)
+
+    current_attribute_value = send(creator_attribute)
+    return if current_attribute_value.present?
+
+    send("#{creator_attribute}=", self.class.stamper_class.stamper)
+  end
+
+  def set_updater_attribute
+    updater_attribute = ActiveRecord::Userstamp.config.updater_attribute
+    return if !has_stamper? || updater_attribute.nil? || !has_attribute?(updater_attribute)
+
+    return if !self.new_record? && !self.changed?
+
+    send("#{updater_attribute}=", self.class.stamper_class.stamper)
+  end
+
+  def set_deleter_attribute
+    deleter_attribute = ActiveRecord::Userstamp.config.deleter_attribute
+    return if !has_stamper? || deleter_attribute.nil? || !has_attribute?(deleter_attribute)
+
+    send("#{deleter_attribute}=", self.class.stamper_class.stamper)
+    save
+  end
+end