loggable_activity 0.1.56 → 0.1.59

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +10 -1
  3. data/CHANGELOG.md +9 -0
  4. data/GETTING-STARTED.md +8 -47
  5. data/PAYLOAD_EXAMPLE.md +63 -0
  6. data/docs/LoggableActivity/Activity.html +92 -241
  7. data/docs/LoggableActivity/Configuration.html +162 -15
  8. data/docs/LoggableActivity/ConfigurationError.html +148 -0
  9. data/docs/LoggableActivity/DataOwner.html +138 -0
  10. data/docs/LoggableActivity/Encryption.html +18 -14
  11. data/docs/LoggableActivity/EncryptionError.html +47 -1
  12. data/docs/LoggableActivity/EncryptionKey.html +54 -35
  13. data/docs/LoggableActivity/Error.html +48 -0
  14. data/docs/LoggableActivity/Hooks.html +221 -89
  15. data/docs/LoggableActivity/Payload.html +103 -27
  16. data/docs/LoggableActivity/Services/BasePayloadsBuilder.html +442 -0
  17. data/docs/LoggableActivity/Services/DestroyPayloadsBuilder.html +395 -0
  18. data/docs/LoggableActivity/Services/PayloadsBuilder.html +342 -0
  19. data/docs/LoggableActivity/Services/UpdatePayloadsBuilder.html +490 -0
  20. data/docs/LoggableActivity/Services.html +93 -0
  21. data/docs/created.rid +14 -10
  22. data/docs/index.html +10 -2
  23. data/docs/js/navigation.js.gz +0 -0
  24. data/docs/js/search_index.js +1 -1
  25. data/docs/js/search_index.js.gz +0 -0
  26. data/docs/js/searcher.js.gz +0 -0
  27. data/docs/table_of_contents.html +253 -85
  28. data/lib/generators/loggable_activity/install_generator.rb +2 -18
  29. data/lib/generators/loggable_activity/templates/.DS_Store +0 -0
  30. data/lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb +9 -10
  31. data/lib/generators/loggable_activity/templates/create_loggable_activities.rb +16 -13
  32. data/lib/loggable_activity/activity.rb +53 -102
  33. data/lib/loggable_activity/configuration.rb +60 -3
  34. data/lib/loggable_activity/data_owner.rb +18 -0
  35. data/lib/loggable_activity/encryption.rb +14 -14
  36. data/lib/loggable_activity/encryption_key.rb +26 -25
  37. data/lib/loggable_activity/error.rb +34 -0
  38. data/lib/loggable_activity/hooks.rb +78 -43
  39. data/lib/loggable_activity/payload.rb +70 -20
  40. data/lib/loggable_activity/services/base_payloads_builder.rb +127 -0
  41. data/lib/loggable_activity/services/destroy_payloads_builder.rb +127 -0
  42. data/lib/loggable_activity/services/payloads_builder.rb +98 -0
  43. data/lib/loggable_activity/services/update_payloads_builder.rb +170 -0
  44. data/lib/loggable_activity/version.rb +1 -1
  45. data/lib/loggable_activity.rb +6 -6
  46. data/lib/schemas/config_schema.json +90 -0
  47. metadata +37 -26
  48. data/docs/LoggableActivity/PayloadsBuilder.html +0 -441
  49. data/docs/LoggableActivity/UpdatePayloadsBuilder.html +0 -424
  50. data/lib/generators/loggable_activity/install_templates_generator.rb +0 -105
  51. data/lib/generators/loggable_activity/templates/helpers/activity_helper.rb +0 -37
  52. data/lib/generators/loggable_activity/templates/helpers/router.rb +0 -52
  53. data/lib/generators/loggable_activity/templates/helpers/routes_helper.rb +0 -20
  54. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.erb +0 -23
  55. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.slim +0 -18
  56. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_destroy.html.erb +0 -18
  57. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_destroy.html.slim +0 -17
  58. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_show.html.erb +0 -18
  59. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_show.html.slim +0 -17
  60. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_update.html.erb +0 -18
  61. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_update.html.slim +0 -12
  62. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_activity_info.html.erb +0 -12
  63. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_activity_info.html.slim +0 -11
  64. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_list_attrs.html.erb +0 -8
  65. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_list_attrs.html.slim +0 -6
  66. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_update_attrs.html.erb +0 -17
  67. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_update_attrs.html.slim +0 -14
  68. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_updated_relations.html.erb +0 -23
  69. data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_updated_relations.html.slim +0 -21
  70. data/lib/loggable_activity/payloads_builder.rb +0 -153
  71. data/lib/loggable_activity/update_payloads_builder.rb +0 -127
@@ -0,0 +1,490 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class LoggableActivity::Services::UpdatePayloadsBuilder - 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"><a href="BasePayloadsBuilder.html">LoggableActivity::Services::BasePayloadsBuilder</a>
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-i-build">#build</a>
76
+ <li ><a href="#method-i-build_belongs_to_update_payload">#build_belongs_to_update_payload</a>
77
+ <li ><a href="#method-i-build_encrypted_update_payload">#build_encrypted_update_payload</a>
78
+ <li ><a href="#method-i-build_has_many_create_payload">#build_has_many_create_payload</a>
79
+ <li ><a href="#method-i-build_has_many_update_payload">#build_has_many_update_payload</a>
80
+ <li ><a href="#method-i-build_has_many_update_payloads">#build_has_many_update_payloads</a>
81
+ <li ><a href="#method-i-build_has_one_update_payload">#build_has_one_update_payload</a>
82
+ <li ><a href="#method-i-build_primary_update_payload">#build_primary_update_payload</a>
83
+ <li ><a href="#method-i-build_relation_update_payload">#build_relation_update_payload</a>
84
+ <li ><a href="#method-i-build_relations_update_payloads">#build_relations_update_payloads</a>
85
+ <li ><a href="#method-i-encrypted_update_attrs">#encrypted_update_attrs</a>
86
+ </ul>
87
+ </div>
88
+
89
+ </div>
90
+ </nav>
91
+
92
+ <main role="main" aria-labelledby="class-LoggableActivity::Services::UpdatePayloadsBuilder">
93
+ <h1 id="class-LoggableActivity::Services::UpdatePayloadsBuilder" class="class">
94
+ class LoggableActivity::Services::UpdatePayloadsBuilder
95
+ </h1>
96
+
97
+ <section class="description">
98
+
99
+ <p>This service class builds update payloads when an instance of a model is updated.</p>
100
+
101
+ </section>
102
+
103
+ <section id="5Buntitled-5D" class="documentation-section">
104
+
105
+
106
+
107
+
108
+
109
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
110
+ <header>
111
+ <h3>Public Instance Methods</h3>
112
+ </header>
113
+
114
+ <div id="method-i-build" class="method-detail ">
115
+ <div class="method-header">
116
+ <div class="method-heading">
117
+ <span class="method-name">build</span><span
118
+ class="method-args">()</span>
119
+ <span class="method-click-advice">click to toggle source</span>
120
+ </div>
121
+ </div>
122
+
123
+ <div class="method-description">
124
+ <p>Builds payloads for a <a href="../Activity.html"><code>::LoggableActivity::Activity</code></a>.</p>
125
+
126
+ <div class="method-source-code" id="build-source">
127
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 8</span>
128
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build</span>
129
+ <span class="ruby-identifier">build_primary_update_payload</span>
130
+ <span class="ruby-identifier">build_relations_update_payloads</span>
131
+ <span class="ruby-ivar">@payloads</span>
132
+ <span class="ruby-keyword">end</span></pre>
133
+ </div>
134
+ </div>
135
+
136
+
137
+ </div>
138
+
139
+ </section>
140
+
141
+ <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
142
+ <header>
143
+ <h3>Private Instance Methods</h3>
144
+ </header>
145
+
146
+ <div id="method-i-build_belongs_to_update_payload" class="method-detail ">
147
+ <div class="method-header">
148
+ <div class="method-heading">
149
+ <span class="method-name">build_belongs_to_update_payload</span><span
150
+ class="method-args">(relation_config)</span>
151
+ <span class="method-click-advice">click to toggle source</span>
152
+ </div>
153
+ </div>
154
+
155
+ <div class="method-description">
156
+ <p>Builds the update payload for a belongs_to relation.</p>
157
+
158
+ <div class="method-source-code" id="build_belongs_to_update_payload-source">
159
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 52</span>
160
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_belongs_to_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
161
+ <span class="ruby-identifier">relation_id</span> = <span class="ruby-node">&quot;#{relation_config[&#39;belongs_to&#39;]}_id&quot;</span>
162
+ <span class="ruby-identifier">model_class_name</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;model&#39;</span>]
163
+ <span class="ruby-identifier">model_class</span> = <span class="ruby-identifier">model_class_name</span>.<span class="ruby-identifier">constantize</span>
164
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>]
165
+
166
+ <span class="ruby-identifier">model_ids</span> = <span class="ruby-identifier">saved_changes</span>(<span class="ruby-ivar">@record</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span><span class="ruby-operator">|</span> <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">relation_id</span>] }
167
+
168
+ <span class="ruby-identifier">model_ids</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">id</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
169
+ <span class="ruby-identifier">record</span> = <span class="ruby-identifier">id</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">model_class</span>.<span class="ruby-identifier">find_by</span>(<span class="ruby-value">id:</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
170
+ <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>
171
+
172
+ <span class="ruby-identifier">options</span> =
173
+ { <span class="ruby-value">related_to_activity_as:</span> <span class="ruby-string">&#39;belongs_to_update_payload&#39;</span>, <span class="ruby-value">current_payload:</span> <span class="ruby-identifier">index</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>, <span class="ruby-value">data_owner:</span> }
174
+
175
+ <span class="ruby-identifier">build_encrypted_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">options</span>)
176
+ <span class="ruby-keyword">end</span>
177
+ <span class="ruby-keyword">end</span></pre>
178
+ </div>
179
+ </div>
180
+
181
+
182
+ </div>
183
+
184
+ <div id="method-i-build_encrypted_update_payload" class="method-detail ">
185
+ <div class="method-header">
186
+ <div class="method-heading">
187
+ <span class="method-name">build_encrypted_update_payload</span><span
188
+ class="method-args">(record, current_values, previous_values, options = {})</span>
189
+ <span class="method-click-advice">click to toggle source</span>
190
+ </div>
191
+ </div>
192
+
193
+ <div class="method-description">
194
+ <p>Builds the encrypted update payload for a record.</p>
195
+
196
+ <div class="method-source-code" id="build_encrypted_update_payload-source">
197
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 150</span>
198
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_encrypted_update_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">current_values</span>, <span class="ruby-identifier">previous_values</span>, <span class="ruby-identifier">options</span> = {})
199
+ <span class="ruby-identifier">encryption_key</span> = <span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">EncryptionKey</span>.<span class="ruby-identifier">for_record</span>(<span class="ruby-identifier">record</span>)
200
+
201
+ <span class="ruby-identifier">encrypted_attrs</span> = <span class="ruby-identifier">encrypted_update_attrs</span>(
202
+ <span class="ruby-identifier">current_values</span>,
203
+ <span class="ruby-identifier">previous_values</span>,
204
+ <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">secret_key</span>
205
+ )
206
+
207
+ <span class="ruby-identifier">build_payload</span>(
208
+ <span class="ruby-identifier">record</span>,
209
+ <span class="ruby-identifier">encryption_key</span>,
210
+ <span class="ruby-identifier">encrypted_attrs</span>,
211
+ <span class="ruby-identifier">options</span>
212
+ )
213
+ <span class="ruby-keyword">end</span></pre>
214
+ </div>
215
+ </div>
216
+
217
+
218
+ </div>
219
+
220
+ <div id="method-i-build_has_many_create_payload" class="method-detail ">
221
+ <div class="method-header">
222
+ <div class="method-heading">
223
+ <span class="method-name">build_has_many_create_payload</span><span
224
+ class="method-args">(relation_config, record)</span>
225
+ <span class="method-click-advice">click to toggle source</span>
226
+ </div>
227
+ </div>
228
+
229
+ <div class="method-description">
230
+
231
+
232
+ <div class="method-source-code" id="build_has_many_create_payload-source">
233
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 106</span>
234
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_has_many_create_payload</span>(<span class="ruby-identifier">relation_config</span>, <span class="ruby-identifier">record</span>)
235
+ <span class="ruby-identifier">record</span>.<span class="ruby-identifier">disable_hooks</span> = <span class="ruby-keyword">true</span>
236
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>]
237
+ <span class="ruby-identifier">options</span> =
238
+ { <span class="ruby-value">related_to_activity_as:</span> <span class="ruby-string">&#39;has_many_create_payload&#39;</span>, <span class="ruby-value">current_payload:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">data_owner:</span> }
239
+ <span class="ruby-identifier">build_encrypted_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">options</span>)
240
+ <span class="ruby-keyword">end</span></pre>
241
+ </div>
242
+ </div>
243
+
244
+
245
+ </div>
246
+
247
+ <div id="method-i-build_has_many_update_payload" class="method-detail ">
248
+ <div class="method-header">
249
+ <div class="method-heading">
250
+ <span class="method-name">build_has_many_update_payload</span><span
251
+ class="method-args">(relation_config, record)</span>
252
+ <span class="method-click-advice">click to toggle source</span>
253
+ </div>
254
+ </div>
255
+
256
+ <div class="method-description">
257
+
258
+
259
+ <div class="method-source-code" id="build_has_many_update_payload-source">
260
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 88</span>
261
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_has_many_update_payload</span>(<span class="ruby-identifier">relation_config</span>, <span class="ruby-identifier">record</span>)
262
+ <span class="ruby-identifier">record</span>.<span class="ruby-identifier">disable_hooks</span> = <span class="ruby-keyword">true</span>
263
+ <span class="ruby-identifier">previous_values</span>, <span class="ruby-identifier">current_values</span> = <span class="ruby-identifier">changes_to_save</span>(<span class="ruby-identifier">record</span>)
264
+ <span class="ruby-identifier">loggable_attrs</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;loggable_attrs&#39;</span>]
265
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">previous_values</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">current_values</span>
266
+
267
+ <span class="ruby-identifier">previous_values</span> = <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">loggable_attrs</span>)
268
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>]
269
+ <span class="ruby-identifier">options</span> = { <span class="ruby-value">related_to_activity_as:</span> <span class="ruby-string">&#39;has_many_update_payload&#39;</span>, <span class="ruby-value">current_payload:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">data_owner:</span> }
270
+
271
+ <span class="ruby-identifier">build_encrypted_update_payload</span>(
272
+ <span class="ruby-identifier">record</span>,
273
+ <span class="ruby-identifier">current_values</span>,
274
+ <span class="ruby-identifier">previous_values</span>,
275
+ <span class="ruby-identifier">options</span>
276
+ )
277
+ <span class="ruby-keyword">end</span></pre>
278
+ </div>
279
+ </div>
280
+
281
+
282
+ </div>
283
+
284
+ <div id="method-i-build_has_many_update_payloads" class="method-detail ">
285
+ <div class="method-header">
286
+ <div class="method-heading">
287
+ <span class="method-name">build_has_many_update_payloads</span><span
288
+ class="method-args">(relation_config)</span>
289
+ <span class="method-click-advice">click to toggle source</span>
290
+ </div>
291
+ </div>
292
+
293
+ <div class="method-description">
294
+ <p>Builds payloads for has_many relations.</p>
295
+
296
+ <div class="method-source-code" id="build_has_many_update_payloads-source">
297
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 72</span>
298
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_has_many_update_payloads</span>(<span class="ruby-identifier">relation_config</span>)
299
+ <span class="ruby-identifier">relation</span> = (<span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;has_many&#39;</span>]).<span class="ruby-identifier">to_s</span>
300
+ <span class="ruby-identifier">records</span> = <span class="ruby-ivar">@record</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">relation</span>)
301
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">records</span>.<span class="ruby-identifier">empty?</span>
302
+
303
+ <span class="ruby-identifier">records</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">record</span><span class="ruby-operator">|</span>
304
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">persisted?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">changes_to_save</span>.<span class="ruby-identifier">any?</span>
305
+ <span class="ruby-identifier">build_has_many_update_payload</span>(<span class="ruby-identifier">relation_config</span>, <span class="ruby-identifier">record</span>)
306
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">persisted?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">saved_changes</span>.<span class="ruby-identifier">any?</span>
307
+ <span class="ruby-comment"># &quot;no changes to save&quot;</span>
308
+ <span class="ruby-keyword">else</span>
309
+ <span class="ruby-identifier">build_has_many_create_payload</span>(<span class="ruby-identifier">relation_config</span>, <span class="ruby-identifier">record</span>)
310
+ <span class="ruby-keyword">end</span>
311
+ <span class="ruby-keyword">end</span>
312
+ <span class="ruby-keyword">end</span></pre>
313
+ </div>
314
+ </div>
315
+
316
+
317
+ </div>
318
+
319
+ <div id="method-i-build_has_one_update_payload" class="method-detail ">
320
+ <div class="method-header">
321
+ <div class="method-heading">
322
+ <span class="method-name">build_has_one_update_payload</span><span
323
+ class="method-args">(relation_config)</span>
324
+ <span class="method-click-advice">click to toggle source</span>
325
+ </div>
326
+ </div>
327
+
328
+ <div class="method-description">
329
+ <p>Builds the update payload for a has_one relation.</p>
330
+
331
+ <div class="method-source-code" id="build_has_one_update_payload-source">
332
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 115</span>
333
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_has_one_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
334
+ <span class="ruby-identifier">relation</span> = (<span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;has_one&#39;</span>]).<span class="ruby-identifier">to_s</span>
335
+ <span class="ruby-identifier">record</span> = <span class="ruby-ivar">@record</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">relation</span>)
336
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">nil?</span>
337
+
338
+ <span class="ruby-identifier">previous_values</span>, <span class="ruby-identifier">current_values</span> = <span class="ruby-identifier">changes_to_save</span>(<span class="ruby-identifier">record</span>)
339
+ <span class="ruby-identifier">loggable_attrs</span> = <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">loggable_attrs</span>
340
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">previous_values</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">current_values</span>
341
+
342
+ <span class="ruby-identifier">previous_values</span> = <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">loggable_attrs</span>)
343
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>]
344
+ <span class="ruby-identifier">options</span> = { <span class="ruby-value">related_to_activity_as:</span> <span class="ruby-string">&#39;has_one_update_payload&#39;</span>, <span class="ruby-value">current_payload:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">data_owner:</span> }
345
+
346
+ <span class="ruby-identifier">build_encrypted_update_payload</span>(
347
+ <span class="ruby-identifier">record</span>,
348
+ <span class="ruby-identifier">current_values</span>,
349
+ <span class="ruby-identifier">previous_values</span>,
350
+ <span class="ruby-identifier">options</span>
351
+ )
352
+ <span class="ruby-keyword">end</span></pre>
353
+ </div>
354
+ </div>
355
+
356
+
357
+ </div>
358
+
359
+ <div id="method-i-build_primary_update_payload" class="method-detail ">
360
+ <div class="method-header">
361
+ <div class="method-heading">
362
+ <span class="method-name">build_primary_update_payload</span><span
363
+ class="method-args">()</span>
364
+ <span class="method-click-advice">click to toggle source</span>
365
+ </div>
366
+ </div>
367
+
368
+ <div class="method-description">
369
+ <p>Builds the primary payload.</p>
370
+
371
+ <div class="method-source-code" id="build_primary_update_payload-source">
372
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 17</span>
373
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_primary_update_payload</span>
374
+ <span class="ruby-identifier">previous_values</span>, <span class="ruby-identifier">current_values</span> = <span class="ruby-identifier">saved_changes</span>(<span class="ruby-ivar">@record</span>)
375
+ <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@loggable_attrs</span>)
376
+ <span class="ruby-identifier">options</span> = { <span class="ruby-value">related_to_activity_as:</span> <span class="ruby-string">&#39;primary_update_payload&#39;</span>, <span class="ruby-value">current_payload:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">data_owner:</span> <span class="ruby-keyword">true</span> }
377
+
378
+ <span class="ruby-identifier">build_encrypted_update_payload</span>(
379
+ <span class="ruby-ivar">@record</span>,
380
+ <span class="ruby-identifier">current_values</span>,
381
+ <span class="ruby-identifier">previous_values</span>,
382
+ <span class="ruby-identifier">options</span>
383
+ )
384
+ <span class="ruby-keyword">end</span></pre>
385
+ </div>
386
+ </div>
387
+
388
+
389
+ </div>
390
+
391
+ <div id="method-i-build_relation_update_payload" class="method-detail ">
392
+ <div class="method-header">
393
+ <div class="method-heading">
394
+ <span class="method-name">build_relation_update_payload</span><span
395
+ class="method-args">(relation_config)</span>
396
+ <span class="method-click-advice">click to toggle source</span>
397
+ </div>
398
+ </div>
399
+
400
+ <div class="method-description">
401
+
402
+
403
+ <div class="method-source-code" id="build_relation_update_payload-source">
404
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 38</span>
405
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_relation_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
406
+ <span class="ruby-identifier">relation_config</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
407
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">key</span>
408
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;belongs_to&#39;</span>
409
+ <span class="ruby-identifier">build_belongs_to_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
410
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;has_one&#39;</span>
411
+ <span class="ruby-identifier">build_has_one_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
412
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;has_many&#39;</span>
413
+ <span class="ruby-identifier">build_has_many_update_payloads</span>(<span class="ruby-identifier">relation_config</span>)
414
+ <span class="ruby-keyword">end</span>
415
+ <span class="ruby-keyword">end</span>
416
+ <span class="ruby-keyword">end</span></pre>
417
+ </div>
418
+ </div>
419
+
420
+
421
+ </div>
422
+
423
+ <div id="method-i-build_relations_update_payloads" class="method-detail ">
424
+ <div class="method-header">
425
+ <div class="method-heading">
426
+ <span class="method-name">build_relations_update_payloads</span><span
427
+ class="method-args">()</span>
428
+ <span class="method-click-advice">click to toggle source</span>
429
+ </div>
430
+ </div>
431
+
432
+ <div class="method-description">
433
+ <p>Build the payloads for the relations of the record. only relations included in the configuration, will be logged.</p>
434
+
435
+ <div class="method-source-code" id="build_relations_update_payloads-source">
436
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 32</span>
437
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_relations_update_payloads</span>
438
+ <span class="ruby-ivar">@relations</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">relation_config</span><span class="ruby-operator">|</span>
439
+ <span class="ruby-identifier">build_relation_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
440
+ <span class="ruby-keyword">end</span>
441
+ <span class="ruby-keyword">end</span></pre>
442
+ </div>
443
+ </div>
444
+
445
+
446
+ </div>
447
+
448
+ <div id="method-i-encrypted_update_attrs" class="method-detail ">
449
+ <div class="method-header">
450
+ <div class="method-heading">
451
+ <span class="method-name">encrypted_update_attrs</span><span
452
+ class="method-args">(current_values, previous_values, encryption_key)</span>
453
+ <span class="method-click-advice">click to toggle source</span>
454
+ </div>
455
+ </div>
456
+
457
+ <div class="method-description">
458
+ <p>Returns the encrypted attributes for the update payload.</p>
459
+
460
+ <div class="method-source-code" id="encrypted_update_attrs-source">
461
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 137</span>
462
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encrypted_update_attrs</span>(<span class="ruby-identifier">current_values</span>, <span class="ruby-identifier">previous_values</span>, <span class="ruby-identifier">encryption_key</span>)
463
+ <span class="ruby-identifier">changes</span> = []
464
+
465
+ <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">from_value</span><span class="ruby-operator">|</span>
466
+ <span class="ruby-identifier">from</span> = <span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">encrypt</span>(<span class="ruby-identifier">from_value</span>, <span class="ruby-identifier">encryption_key</span>)
467
+ <span class="ruby-identifier">to_value</span> = <span class="ruby-identifier">current_values</span>[<span class="ruby-identifier">key</span>]
468
+ <span class="ruby-identifier">to</span> = <span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Encryption</span>.<span class="ruby-identifier">encrypt</span>(<span class="ruby-identifier">to_value</span>, <span class="ruby-identifier">encryption_key</span>)
469
+ <span class="ruby-identifier">changes</span> <span class="ruby-operator">&lt;&lt;</span> { <span class="ruby-identifier">key</span> <span class="ruby-operator">=&gt;</span> { <span class="ruby-value">from:</span>, <span class="ruby-value">to:</span> } }
470
+ <span class="ruby-keyword">end</span>
471
+ { <span class="ruby-value">changes:</span> }
472
+ <span class="ruby-keyword">end</span></pre>
473
+ </div>
474
+ </div>
475
+
476
+
477
+ </div>
478
+
479
+ </section>
480
+
481
+ </section>
482
+ </main>
483
+
484
+
485
+ <footer id="validator-badges" role="contentinfo">
486
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
487
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
488
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
489
+ </footer>
490
+
@@ -0,0 +1,93 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>module LoggableActivity::Services - 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="module">
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
+
62
+
63
+
64
+ </div>
65
+ </nav>
66
+
67
+ <main role="main" aria-labelledby="module-LoggableActivity::Services">
68
+ <h1 id="module-LoggableActivity::Services" class="module">
69
+ module LoggableActivity::Services
70
+ </h1>
71
+
72
+ <section class="description">
73
+
74
+ <p>Namespace for services</p>
75
+
76
+ </section>
77
+
78
+ <section id="5Buntitled-5D" class="documentation-section">
79
+
80
+
81
+
82
+
83
+
84
+ </section>
85
+ </main>
86
+
87
+
88
+ <footer id="validator-badges" role="contentinfo">
89
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
90
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
91
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
92
+ </footer>
93
+
data/docs/created.rid CHANGED
@@ -1,10 +1,14 @@
1
- Fri, 01 Mar 2024 15:34:22 +0100
2
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/activity.rb Fri, 01 Mar 2024 15:34:11 +0100
3
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/configuration.rb Sat, 24 Feb 2024 19:02:46 +0100
4
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/encryption.rb Sat, 24 Feb 2024 19:02:46 +0100
5
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/encryption_key.rb Fri, 01 Mar 2024 15:13:47 +0100
6
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/hooks.rb Fri, 01 Mar 2024 12:52:17 +0100
7
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/payload.rb Fri, 01 Mar 2024 15:32:15 +0100
8
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/payloads_builder.rb Fri, 01 Mar 2024 15:13:47 +0100
9
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/update_payloads_builder.rb Fri, 01 Mar 2024 14:51:07 +0100
10
- /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/version.rb Sat, 24 Feb 2024 19:02:46 +0100
1
+ Thu, 21 Mar 2024 09:00:53 +0100
2
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/activity.rb Tue, 19 Mar 2024 13:24:04 +0100
3
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/configuration.rb Thu, 21 Mar 2024 09:00:20 +0100
4
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/data_owner.rb Wed, 20 Mar 2024 08:40:23 +0100
5
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/encryption.rb Wed, 20 Mar 2024 08:36:29 +0100
6
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/encryption_key.rb Wed, 20 Mar 2024 08:41:28 +0100
7
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/error.rb Thu, 21 Mar 2024 08:53:55 +0100
8
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/hooks.rb Thu, 21 Mar 2024 08:59:10 +0100
9
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/payload.rb Wed, 20 Mar 2024 08:45:20 +0100
10
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/services/base_payloads_builder.rb Wed, 20 Mar 2024 07:57:14 +0100
11
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/services/destroy_payloads_builder.rb Thu, 21 Mar 2024 08:55:20 +0100
12
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/services/payloads_builder.rb Wed, 20 Mar 2024 07:51:10 +0100
13
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/services/update_payloads_builder.rb Wed, 20 Mar 2024 08:38:25 +0100
14
+ /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/version.rb Tue, 05 Mar 2024 18:10:09 +0100