1
0
Fork 0
mirror of https://github.com/paper-trail-gem/paper_trail.git synced 2022-11-09 11:33:19 -05:00
paper-trail-gem--paper_trail/lib/paper_trail/frameworks/rails/controller.rb
2016-03-05 17:11:08 -05:00

109 lines
3.8 KiB
Ruby

module PaperTrail
module Rails
module Controller
def self.included(base)
before = [
:set_paper_trail_enabled_for_controller,
:set_paper_trail_controller_info
]
after = [
:warn_about_not_setting_whodunnit
]
if base.respond_to? :before_action
# Rails 4+
before.map { |sym| base.before_action sym }
after.map { |sym| base.after_action sym }
else
# Rails 3.
before.map { |sym| base.before_filter sym }
after.map { |sym| base.after_filter sym }
end
end
protected
# Returns the user who is responsible for any changes that occur.
# By default this calls `current_user` and returns the result.
#
# Override this method in your controller to call a different
# method, e.g. `current_person`, or anything you like.
def user_for_paper_trail
return unless defined?(current_user)
ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
rescue NoMethodError
current_user
end
# Returns any information about the controller or request that you
# want PaperTrail to store alongside any changes that occur. By
# default this returns an empty hash.
#
# Override this method in your controller to return a hash of any
# information you need. The hash's keys must correspond to columns
# in your `versions` table, so don't forget to add any new columns
# you need.
#
# For example:
#
# {:ip => request.remote_ip, :user_agent => request.user_agent}
#
# The columns `ip` and `user_agent` must exist in your `versions` # table.
#
# Use the `:meta` option to
# `PaperTrail::Model::ClassMethods.has_paper_trail` to store any extra
# model-level data you need.
def info_for_paper_trail
{}
end
# Returns `true` (default) or `false` depending on whether PaperTrail
# should be active for the current request.
#
# Override this method in your controller to specify when PaperTrail
# should be off.
def paper_trail_enabled_for_controller
::PaperTrail.enabled?
end
private
# Tells PaperTrail whether versions should be saved in the current
# request.
def set_paper_trail_enabled_for_controller
::PaperTrail.enabled_for_controller = paper_trail_enabled_for_controller
end
# Tells PaperTrail who is responsible for any changes that occur.
def set_paper_trail_whodunnit
@set_paper_trail_whodunnit_called = true
::PaperTrail.whodunnit = user_for_paper_trail if ::PaperTrail.enabled_for_controller?
end
# Tells PaperTrail any information from the controller you want to store
# alongside any changes that occur.
def set_paper_trail_controller_info
::PaperTrail.controller_info = info_for_paper_trail if ::PaperTrail.enabled_for_controller?
end
def warn_about_not_setting_whodunnit
enabled = ::PaperTrail.enabled_for_controller?
user_present = user_for_paper_trail.present?
whodunnit_blank = ::PaperTrail.whodunnit.blank?
if enabled && user_present && whodunnit_blank && !@set_paper_trail_whodunnit_called
warn <<-EOS.strip_heredoc
user_for_paper_trail is present, but whodunnit has not been set.
PaperTrail no longer adds the set_paper_trail_whodunnit
before_filter for you. Please add this before_filter to your
ApplicationController to continue recording whodunnit. See the
PaperTrail readme for an example.
EOS
end
end
end
end
if defined?(::ActionController)
::ActiveSupport.on_load(:action_controller) { include PaperTrail::Rails::Controller }
end
end