1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# frozen_string_literal: true
module PaperTrail
module Rails
# Extensions to rails controllers. Provides convenient ways to pass certain
# information to the model layer, with `controller_info` and `whodunnit`.
# Also includes a convenient on/off switch,
# `paper_trail_enabled_for_controller`.
module Controller
def self.included(controller)
controller.before_action(
:set_paper_trail_enabled_for_controller,
:set_paper_trail_controller_info
)
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.
#
# @api public
def user_for_paper_trail
return unless defined?(current_user)
current_user.try(:id) || 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.
#
# @api public
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
# # Don't omit `super` without a good reason.
# super && request.user_agent != 'Disable User-Agent'
# end
# ```
#
# @api public
def paper_trail_enabled_for_controller
::PaperTrail.enabled?
end
private
# Tells PaperTrail whether versions should be saved in the current
# request.
#
# @api public
def set_paper_trail_enabled_for_controller
::PaperTrail.request.enabled = paper_trail_enabled_for_controller
end
# Tells PaperTrail who is responsible for any changes that occur.
#
# @api public
def set_paper_trail_whodunnit
if ::PaperTrail.request.enabled?
::PaperTrail.request.whodunnit = user_for_paper_trail
end
end
# Tells PaperTrail any information from the controller you want to store
# alongside any changes that occur.
#
# @api public
def set_paper_trail_controller_info
if ::PaperTrail.request.enabled?
::PaperTrail.request.controller_info = info_for_paper_trail
end
end
end
end
end
|
