loggable_activity 0.1.38b → 0.1.40
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.document +1 -0
- data/.nojekyll +1 -0
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +2 -0
- data/GETTING-STARTED.md +10 -10
- data/README.md +8 -5
- data/ROADMAP.md +9 -5
- data/doc/.nojekyll +1 -0
- data/doc/CHANGELOG_md.html +125 -0
- data/doc/CODE_OF_CONDUCT_md.html +220 -0
- data/doc/CONSIDERTIONS_md.html +227 -0
- data/doc/CreateLoggableActivities.html +144 -0
- data/doc/CreateLoggableEncryptionKeys.html +140 -0
- data/doc/CreateLoggablePayloads.html +144 -0
- data/doc/GETTING-STARTED_md.html +186 -0
- data/doc/Gemfile.html +104 -0
- data/doc/Gemfile_lock.html +152 -0
- data/doc/LICENSE_txt.html +104 -0
- data/doc/LoggableActivity/CurrentUser.html +99 -0
- data/doc/LoggableActivity/Generators/InstallGenerator.html +178 -0
- data/doc/LoggableActivity/Generators.html +91 -0
- data/doc/README_md.html +138 -0
- data/doc/ROADMAP_md.html +151 -0
- data/doc/Rakefile.html +102 -0
- data/doc/bin/setup.html +100 -0
- data/doc/notes/CHEAT_SHEET_md.html +130 -0
- data/doc/sig/loggable_activity_rbs.html +101 -0
- data/docs/LoggableActivity/Activity.html +494 -0
- data/docs/LoggableActivity/Configuration.html +183 -0
- data/docs/LoggableActivity/Encryption.html +220 -0
- data/docs/LoggableActivity/EncryptionError.html +99 -0
- data/docs/LoggableActivity/EncryptionKey.html +327 -0
- data/docs/LoggableActivity/Error.html +97 -0
- data/docs/LoggableActivity/Hooks.html +172 -0
- data/docs/LoggableActivity/Payload.html +159 -0
- data/docs/LoggableActivity/PayloadsBuilder.html +154 -0
- data/docs/LoggableActivity/UpdatePayloadsBuilder.html +199 -0
- data/docs/LoggableActivity.html +100 -0
- data/docs/created.rid +10 -0
- data/docs/css/fonts.css +167 -0
- data/docs/css/rdoc.css +687 -0
- data/docs/fonts/Lato-Light.ttf +0 -0
- data/docs/fonts/Lato-LightItalic.ttf +0 -0
- data/docs/fonts/Lato-Regular.ttf +0 -0
- data/docs/fonts/Lato-RegularItalic.ttf +0 -0
- data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
- data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
- data/docs/images/add.png +0 -0
- data/docs/images/arrow_up.png +0 -0
- data/docs/images/brick.png +0 -0
- data/docs/images/brick_link.png +0 -0
- data/docs/images/bug.png +0 -0
- data/docs/images/bullet_black.png +0 -0
- data/docs/images/bullet_toggle_minus.png +0 -0
- data/docs/images/bullet_toggle_plus.png +0 -0
- data/docs/images/date.png +0 -0
- data/docs/images/delete.png +0 -0
- data/docs/images/find.png +0 -0
- data/docs/images/loadingAnimation.gif +0 -0
- data/docs/images/macFFBgHack.png +0 -0
- data/docs/images/package.png +0 -0
- data/docs/images/page_green.png +0 -0
- data/docs/images/page_white_text.png +0 -0
- data/docs/images/page_white_width.png +0 -0
- data/docs/images/plugin.png +0 -0
- data/docs/images/ruby.png +0 -0
- data/docs/images/tag_blue.png +0 -0
- data/docs/images/tag_green.png +0 -0
- data/docs/images/transparent.png +0 -0
- data/docs/images/wrench.png +0 -0
- data/docs/images/wrench_orange.png +0 -0
- data/docs/images/zoom.png +0 -0
- data/docs/index.html +91 -0
- data/docs/js/darkfish.js +97 -0
- data/docs/js/navigation.js +105 -0
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +110 -0
- data/docs/js/search_index.js +1 -0
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +229 -0
- data/docs/js/searcher.js.gz +0 -0
- data/docs/table_of_contents.html +184 -0
- data/lib/generators/loggable_activity/install_generator.rb +2 -1
- data/lib/generators/loggable_activity/templates/current_user.rb +1 -1
- data/lib/generators/loggable_activity/templates/loggable_activity.yml +29 -0
- data/lib/loggable_activity/activity.rb +208 -59
- data/lib/loggable_activity/configuration.rb +18 -0
- data/lib/loggable_activity/encryption.rb +20 -1
- data/lib/loggable_activity/encryption_key.rb +81 -14
- data/lib/loggable_activity/hooks.rb +10 -7
- data/lib/loggable_activity/payload.rb +45 -11
- data/lib/loggable_activity/payloads_builder.rb +50 -4
- data/lib/loggable_activity/update_payloads_builder.rb +64 -2
- data/lib/loggable_activity/version.rb +1 -1
- metadata +82 -10
- data/.DS_Store +0 -0
- data/loggable_activity-0.1.32.gem +0 -0
- data/loggable_activity-0.1.33.gem +0 -0
- data/loggable_activity-0.1.34.gem +0 -0
|
@@ -0,0 +1,494 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class LoggableActivity::Activity - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="class">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<div id="class-metadata">
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<div id="parent-class-section" class="nav-section">
|
|
62
|
+
<h3>Parent</h3>
|
|
63
|
+
|
|
64
|
+
<p class="link">ActiveRecord::Base
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- Method Quickref -->
|
|
71
|
+
<div id="method-list-section" class="nav-section">
|
|
72
|
+
<h3>Methods</h3>
|
|
73
|
+
|
|
74
|
+
<ul class="link-list" role="directory">
|
|
75
|
+
<li ><a href="#method-c-activities_for_actor">::activities_for_actor</a>
|
|
76
|
+
<li ><a href="#method-c-latest">::latest</a>
|
|
77
|
+
<li ><a href="#method-i-actor_display_name">#actor_display_name</a>
|
|
78
|
+
<li ><a href="#method-i-attrs">#attrs</a>
|
|
79
|
+
<li ><a href="#method-i-primary_payload_attrs">#primary_payload_attrs</a>
|
|
80
|
+
<li ><a href="#method-i-record_display_name">#record_display_name</a>
|
|
81
|
+
<li ><a href="#method-i-relations_attrs">#relations_attrs</a>
|
|
82
|
+
<li ><a href="#method-i-update_activity_attrs">#update_activity_attrs</a>
|
|
83
|
+
</ul>
|
|
84
|
+
</div>
|
|
85
|
+
|
|
86
|
+
</div>
|
|
87
|
+
</nav>
|
|
88
|
+
|
|
89
|
+
<main role="main" aria-labelledby="class-LoggableActivity::Activity">
|
|
90
|
+
<h1 id="class-LoggableActivity::Activity" class="class">
|
|
91
|
+
class LoggableActivity::Activity
|
|
92
|
+
</h1>
|
|
93
|
+
|
|
94
|
+
<section class="description">
|
|
95
|
+
|
|
96
|
+
<p>Represents one action in the activity log.</p>
|
|
97
|
+
|
|
98
|
+
</section>
|
|
99
|
+
|
|
100
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
107
|
+
<header>
|
|
108
|
+
<h3>Public Class Methods</h3>
|
|
109
|
+
</header>
|
|
110
|
+
|
|
111
|
+
<div id="method-c-activities_for_actor" class="method-detail ">
|
|
112
|
+
<div class="method-header">
|
|
113
|
+
<div class="method-heading">
|
|
114
|
+
<span class="method-name">activities_for_actor</span><span
|
|
115
|
+
class="method-args">(actor, limit = 20, params = { offset: 0 })</span>
|
|
116
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
<div class="method-description">
|
|
121
|
+
<p>Returns a list of activities for a given actor.</p>
|
|
122
|
+
|
|
123
|
+
<div class="method-source-code" id="activities_for_actor-source">
|
|
124
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 212</span>
|
|
125
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">activities_for_actor</span>(<span class="ruby-identifier">actor</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-value">20</span>, <span class="ruby-identifier">params</span> = { <span class="ruby-value">offset:</span> <span class="ruby-value">0</span> })
|
|
126
|
+
<span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Activity</span>.<span class="ruby-identifier">latest</span>(<span class="ruby-identifier">limit</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">where</span>(<span class="ruby-value">actor:</span>)
|
|
127
|
+
<span class="ruby-keyword">end</span></pre>
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
<div id="method-c-latest" class="method-detail ">
|
|
135
|
+
<div class="method-header">
|
|
136
|
+
<div class="method-heading">
|
|
137
|
+
<span class="method-name">latest</span><span
|
|
138
|
+
class="method-args">(limit = 20, params = { offset: 0 })</span>
|
|
139
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
|
|
143
|
+
<div class="method-description">
|
|
144
|
+
<p>Returns a list of activities ordered by creation date.</p>
|
|
145
|
+
|
|
146
|
+
<div class="method-source-code" id="latest-source">
|
|
147
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 217</span>
|
|
148
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">latest</span>(<span class="ruby-identifier">limit</span> = <span class="ruby-value">20</span>, <span class="ruby-identifier">params</span> = { <span class="ruby-value">offset:</span> <span class="ruby-value">0</span> })
|
|
149
|
+
<span class="ruby-identifier">offset</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:offset</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>
|
|
150
|
+
<span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Activity</span>
|
|
151
|
+
.<span class="ruby-identifier">all</span>
|
|
152
|
+
.<span class="ruby-identifier">order</span>(<span class="ruby-value">created_at:</span> <span class="ruby-value">:desc</span>)
|
|
153
|
+
.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:payloads</span>)
|
|
154
|
+
.<span class="ruby-identifier">offset</span>(<span class="ruby-identifier">offset</span>)
|
|
155
|
+
.<span class="ruby-identifier">limit</span>(<span class="ruby-identifier">limit</span>)
|
|
156
|
+
<span class="ruby-keyword">end</span></pre>
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
</section>
|
|
164
|
+
|
|
165
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
166
|
+
<header>
|
|
167
|
+
<h3>Public Instance Methods</h3>
|
|
168
|
+
</header>
|
|
169
|
+
|
|
170
|
+
<div id="method-i-actor_display_name" class="method-detail ">
|
|
171
|
+
<div class="method-header">
|
|
172
|
+
<div class="method-heading">
|
|
173
|
+
<span class="method-name">actor_display_name</span><span
|
|
174
|
+
class="method-args">()</span>
|
|
175
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
176
|
+
</div>
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
<div class="method-description">
|
|
180
|
+
<p>Returns the display name for a actor. what method to use if defined in ‘/config/loggable_activity.yaml’</p>
|
|
181
|
+
|
|
182
|
+
<p>Example:</p>
|
|
183
|
+
|
|
184
|
+
<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">actor_display_name</span>
|
|
185
|
+
</pre>
|
|
186
|
+
|
|
187
|
+
<p>Returns:</p>
|
|
188
|
+
|
|
189
|
+
<pre class="ruby"><span class="ruby-string">"Elvis Presley"</span>
|
|
190
|
+
</pre>
|
|
191
|
+
|
|
192
|
+
<div class="method-source-code" id="actor_display_name-source">
|
|
193
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 205</span>
|
|
194
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">actor_display_name</span>
|
|
195
|
+
<span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">'loggable.activity.deleted'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">encrypted_actor_display_name</span>.<span class="ruby-identifier">nil?</span>
|
|
196
|
+
|
|
197
|
+
<span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">decrypt</span>(<span class="ruby-identifier">encrypted_actor_display_name</span>, <span class="ruby-identifier">actor_key</span>)
|
|
198
|
+
<span class="ruby-keyword">end</span></pre>
|
|
199
|
+
</div>
|
|
200
|
+
</div>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
<div id="method-i-attrs" class="method-detail ">
|
|
206
|
+
<div class="method-header">
|
|
207
|
+
<div class="method-heading">
|
|
208
|
+
<span class="method-name">attrs</span><span
|
|
209
|
+
class="method-args">()</span>
|
|
210
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
211
|
+
</div>
|
|
212
|
+
</div>
|
|
213
|
+
|
|
214
|
+
<div class="method-description">
|
|
215
|
+
<p>Returns a list of attributes of the activity includig the indliced relations. The included relations are devined in the ‘config/loggable_activity.yaml’ file. The attributes are packed in a way that they can be used to display the activity in the UI.</p>
|
|
216
|
+
|
|
217
|
+
<p>Example:</p>
|
|
218
|
+
|
|
219
|
+
<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">attrs</span>
|
|
220
|
+
</pre>
|
|
221
|
+
|
|
222
|
+
<p>Returns:</p>
|
|
223
|
+
|
|
224
|
+
<pre class="ruby"> [
|
|
225
|
+
{
|
|
226
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"User"</span>,
|
|
227
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"primary_payload"</span>,
|
|
228
|
+
<span class="ruby-value">attrs:</span> {
|
|
229
|
+
<span class="ruby-string">"first_name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"David"</span>,
|
|
230
|
+
<span class="ruby-string">"last_name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Bowie"</span>,
|
|
231
|
+
<span class="ruby-string">"age"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"69"</span>,
|
|
232
|
+
<span class="ruby-string">"email"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"david@example.com"</span>,
|
|
233
|
+
<span class="ruby-string">"user_type"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Patient"</span>
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::UserProfile"</span>,
|
|
238
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"current_association"</span>,
|
|
239
|
+
<span class="ruby-value">attrs:</span> {
|
|
240
|
+
<span class="ruby-string">"sex"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Male"</span>,
|
|
241
|
+
<span class="ruby-string">"religion"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Agnostic"</span>
|
|
242
|
+
}
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Address"</span>,
|
|
246
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"current_association"</span>,
|
|
247
|
+
<span class="ruby-value">attrs:</span> {
|
|
248
|
+
<span class="ruby-string">"street"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Eiffel Tower"</span>,
|
|
249
|
+
<span class="ruby-string">"city"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Paris"</span>,
|
|
250
|
+
<span class="ruby-string">"country"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"France"</span>,
|
|
251
|
+
<span class="ruby-string">"postal_code"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"75007"</span>
|
|
252
|
+
}
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Club"</span>,
|
|
256
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"current_association"</span>,
|
|
257
|
+
<span class="ruby-value">attrs:</span> {
|
|
258
|
+
<span class="ruby-string">"name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Mystic Fusion Lounge"</span>
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
]
|
|
262
|
+
</pre>
|
|
263
|
+
|
|
264
|
+
<div class="method-source-code" id="attrs-source">
|
|
265
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 66</span>
|
|
266
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attrs</span>
|
|
267
|
+
<span class="ruby-identifier">ordered_payloads</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">payload</span><span class="ruby-operator">|</span>
|
|
268
|
+
{
|
|
269
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">record_type</span>,
|
|
270
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">payload_type</span>,
|
|
271
|
+
<span class="ruby-value">attrs:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">attrs</span>
|
|
272
|
+
}
|
|
273
|
+
<span class="ruby-keyword">end</span>
|
|
274
|
+
<span class="ruby-keyword">end</span></pre>
|
|
275
|
+
</div>
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
|
|
281
|
+
<div id="method-i-primary_payload_attrs" class="method-detail ">
|
|
282
|
+
<div class="method-header">
|
|
283
|
+
<div class="method-heading">
|
|
284
|
+
<span class="method-name">primary_payload_attrs</span><span
|
|
285
|
+
class="method-args">()</span>
|
|
286
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
287
|
+
</div>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
<div class="method-description">
|
|
291
|
+
<p>Returns the attributes for the primary payload, without the relations.</p>
|
|
292
|
+
|
|
293
|
+
<p>Example:</p>
|
|
294
|
+
|
|
295
|
+
<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">primary_payload_attrs</span>
|
|
296
|
+
</pre>
|
|
297
|
+
|
|
298
|
+
<p>Returns:</p>
|
|
299
|
+
|
|
300
|
+
<pre class="ruby">{
|
|
301
|
+
<span class="ruby-string">"first_name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"David"</span>,
|
|
302
|
+
<span class="ruby-string">"last_name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Bowie"</span>,
|
|
303
|
+
<span class="ruby-string">"age"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"69"</span>,
|
|
304
|
+
<span class="ruby-string">"email"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"david@example.com"</span>,
|
|
305
|
+
<span class="ruby-string">"user_type"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Patient"</span>
|
|
306
|
+
}
|
|
307
|
+
</pre>
|
|
308
|
+
|
|
309
|
+
<div class="method-source-code" id="primary_payload_attrs-source">
|
|
310
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 152</span>
|
|
311
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">primary_payload_attrs</span>
|
|
312
|
+
<span class="ruby-identifier">primary_payload</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">primary_payload</span>.<span class="ruby-identifier">attrs</span> <span class="ruby-operator">:</span> {}
|
|
313
|
+
<span class="ruby-keyword">end</span></pre>
|
|
314
|
+
</div>
|
|
315
|
+
</div>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
</div>
|
|
319
|
+
|
|
320
|
+
<div id="method-i-record_display_name" class="method-detail ">
|
|
321
|
+
<div class="method-header">
|
|
322
|
+
<div class="method-heading">
|
|
323
|
+
<span class="method-name">record_display_name</span><span
|
|
324
|
+
class="method-args">()</span>
|
|
325
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
326
|
+
</div>
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
<div class="method-description">
|
|
330
|
+
<p>Returns the display name for a record. what method to use if defined in ‘/config/loggable_activity.yaml’</p>
|
|
331
|
+
|
|
332
|
+
<p>Example:</p>
|
|
333
|
+
|
|
334
|
+
<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">record_display_name</span>
|
|
335
|
+
</pre>
|
|
336
|
+
|
|
337
|
+
<p>Returns:</p>
|
|
338
|
+
|
|
339
|
+
<pre class="ruby"><span class="ruby-string">"David Bowie"</span>
|
|
340
|
+
</pre>
|
|
341
|
+
|
|
342
|
+
<div class="method-source-code" id="record_display_name-source">
|
|
343
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 190</span>
|
|
344
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">record_display_name</span>
|
|
345
|
+
<span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">'loggable.activity.deleted'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">encrypted_record_display_name</span>.<span class="ruby-identifier">nil?</span>
|
|
346
|
+
|
|
347
|
+
<span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">decrypt</span>(<span class="ruby-identifier">encrypted_record_display_name</span>, <span class="ruby-identifier">record_key</span>)
|
|
348
|
+
<span class="ruby-keyword">end</span></pre>
|
|
349
|
+
</div>
|
|
350
|
+
</div>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
<div id="method-i-relations_attrs" class="method-detail ">
|
|
356
|
+
<div class="method-header">
|
|
357
|
+
<div class="method-heading">
|
|
358
|
+
<span class="method-name">relations_attrs</span><span
|
|
359
|
+
class="method-args">()</span>
|
|
360
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
361
|
+
</div>
|
|
362
|
+
</div>
|
|
363
|
+
|
|
364
|
+
<div class="method-description">
|
|
365
|
+
<p>Returns the attributes for the relations.</p>
|
|
366
|
+
|
|
367
|
+
<p>Example:</p>
|
|
368
|
+
|
|
369
|
+
<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">relations_attrs</span>
|
|
370
|
+
</pre>
|
|
371
|
+
|
|
372
|
+
<p>Returns:</p>
|
|
373
|
+
|
|
374
|
+
<pre class="ruby">[
|
|
375
|
+
{
|
|
376
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Address"</span>,
|
|
377
|
+
<span class="ruby-comment"># Current association payload type</span>
|
|
378
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"current_association"</span>,
|
|
379
|
+
<span class="ruby-comment"># Current attributes for Demo::Address</span>
|
|
380
|
+
<span class="ruby-value">attrs:</span> {
|
|
381
|
+
<span class="ruby-string">"street"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"The Palace of Versailles"</span>,
|
|
382
|
+
<span class="ruby-string">"city"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Versailles"</span>,
|
|
383
|
+
<span class="ruby-string">"country"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"France"</span>,
|
|
384
|
+
<span class="ruby-string">"postal_code"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"78000"</span>
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
]
|
|
388
|
+
</pre>
|
|
389
|
+
|
|
390
|
+
<div class="method-source-code" id="relations_attrs-source">
|
|
391
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 177</span>
|
|
392
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">relations_attrs</span>
|
|
393
|
+
<span class="ruby-identifier">attrs</span>.<span class="ruby-identifier">filter</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span>[<span class="ruby-value">:payload_type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'current_association'</span> }
|
|
394
|
+
<span class="ruby-keyword">end</span></pre>
|
|
395
|
+
</div>
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</div>
|
|
400
|
+
|
|
401
|
+
<div id="method-i-update_activity_attrs" class="method-detail ">
|
|
402
|
+
<div class="method-header">
|
|
403
|
+
<div class="method-heading">
|
|
404
|
+
<span class="method-name">update_activity_attrs</span><span
|
|
405
|
+
class="method-args">()</span>
|
|
406
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
407
|
+
</div>
|
|
408
|
+
</div>
|
|
409
|
+
|
|
410
|
+
<div class="method-description">
|
|
411
|
+
<p>Returns the attributes of an upddate activity.</p>
|
|
412
|
+
|
|
413
|
+
<p>Example:</p>
|
|
414
|
+
|
|
415
|
+
<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">update_activity_attrs</span>
|
|
416
|
+
</pre>
|
|
417
|
+
|
|
418
|
+
<p>Returns:</p>
|
|
419
|
+
|
|
420
|
+
<pre class="ruby">{
|
|
421
|
+
<span class="ruby-comment"># Update attributes for Demo::Club</span>
|
|
422
|
+
<span class="ruby-value">update_attrs:</span> {
|
|
423
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Club"</span>,
|
|
424
|
+
<span class="ruby-value">attrs:</span> [
|
|
425
|
+
{
|
|
426
|
+
<span class="ruby-string">"name"</span> <span class="ruby-operator">=></span> {
|
|
427
|
+
<span class="ruby-comment"># Previous name</span>
|
|
428
|
+
<span class="ruby-value">from:</span> <span class="ruby-string">"Electric Oasis Club"</span>,
|
|
429
|
+
<span class="ruby-comment"># New name</span>
|
|
430
|
+
<span class="ruby-value">to:</span> <span class="ruby-string">"Electric Oasis Club nr 5"</span>
|
|
431
|
+
}
|
|
432
|
+
}
|
|
433
|
+
]
|
|
434
|
+
},
|
|
435
|
+
<span class="ruby-comment"># Updated relations attributes</span>
|
|
436
|
+
<span class="ruby-value">updated_relations_attrs:</span> [
|
|
437
|
+
{
|
|
438
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Address"</span>,
|
|
439
|
+
<span class="ruby-value">previous_attrs:</span> {
|
|
440
|
+
<span class="ruby-comment"># Record class</span>
|
|
441
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Address"</span>,
|
|
442
|
+
<span class="ruby-comment"># Previous association payload type</span>
|
|
443
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"previous_association"</span>,
|
|
444
|
+
<span class="ruby-comment"># Previous attributes for Demo::Address</span>
|
|
445
|
+
<span class="ruby-value">attrs:</span> {
|
|
446
|
+
<span class="ruby-string">"street"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Ice Hotel, Marknadsvägen 63"</span>,
|
|
447
|
+
<span class="ruby-string">"city"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Jukkasjärvi"</span>,
|
|
448
|
+
<span class="ruby-string">"country"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Sweden"</span>,
|
|
449
|
+
<span class="ruby-string">"postal_code"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"981 91"</span>
|
|
450
|
+
}
|
|
451
|
+
},
|
|
452
|
+
<span class="ruby-value">current_attrs:</span> {
|
|
453
|
+
<span class="ruby-value">record_class:</span> <span class="ruby-string">"Demo::Address"</span>,
|
|
454
|
+
<span class="ruby-comment"># Current association payload type</span>
|
|
455
|
+
<span class="ruby-value">payload_type:</span> <span class="ruby-string">"current_association"</span>,
|
|
456
|
+
<span class="ruby-comment"># Current attributes for Demo::Address</span>
|
|
457
|
+
<span class="ruby-value">attrs:</span> {
|
|
458
|
+
<span class="ruby-string">"street"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"The Palace of Versailles"</span>,
|
|
459
|
+
<span class="ruby-string">"city"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Versailles"</span>,
|
|
460
|
+
<span class="ruby-string">"country"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"France"</span>,
|
|
461
|
+
<span class="ruby-string">"postal_code"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"78000"</span>
|
|
462
|
+
}
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
]
|
|
466
|
+
}
|
|
467
|
+
</pre>
|
|
468
|
+
|
|
469
|
+
<div class="method-source-code" id="update_activity_attrs-source">
|
|
470
|
+
<pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 130</span>
|
|
471
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_activity_attrs</span>
|
|
472
|
+
{
|
|
473
|
+
<span class="ruby-value">update_attrs:</span>,
|
|
474
|
+
<span class="ruby-value">updated_relations_attrs:</span>
|
|
475
|
+
}
|
|
476
|
+
<span class="ruby-keyword">end</span></pre>
|
|
477
|
+
</div>
|
|
478
|
+
</div>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
</div>
|
|
482
|
+
|
|
483
|
+
</section>
|
|
484
|
+
|
|
485
|
+
</section>
|
|
486
|
+
</main>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<footer id="validator-badges" role="contentinfo">
|
|
490
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
491
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
|
492
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
493
|
+
</footer>
|
|
494
|
+
|