Contents

# The +Userstamper::Controller+ 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 Userstamper::ControllerConcern
  extend ActiveSupport::Concern

  included do
    around_action :with_stamper
  end

  private

  # This {#with_stamper} method sets the stamper for the duration of the action. This ensures
  # that exceptions raised within the controller action would properly restore the previous stamper.
  #
  # TODO: Remove set_stamper/reset_stamper
  def with_stamper
    set_stamper
    yield
  ensure
    reset_stamper
  end

  # 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
    @_userstamp_stamper = Userstamper.config.default_stamper_class.stamper
    Userstamper.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
    Userstamper.config.default_stamper_class.stamper = @_userstamp_stamper
    @_userstamp_stamper = nil
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
userstamper-4.1.0	lib/userstamper/controller_concern.rb
userstamper-4.0.1	lib/userstamper/controller_concern.rb
userstamper-4.0.0	lib/userstamper/controller_concern.rb