loggable_activity 0.5.4 → 0.5.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (137) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +10 -0
  3. data/CHANGELOG.md +12 -3
  4. data/GETTING-STARTED.md +61 -0
  5. data/README.md +4 -7
  6. data/app/views/loggable_activity/activities/_activities.html.slim +6 -6
  7. data/docker-compose.yml +27 -0
  8. data/docs/CHANGELOG_md.html +318 -0
  9. data/docs/CHEAT_SHEET_md.html +168 -0
  10. data/docs/CODE_OF_CONDUCT_md.html +250 -0
  11. data/docs/CreateLoggableActivities.html +175 -0
  12. data/docs/CreateLoggableActivityTables.html +173 -0
  13. data/docs/GETTING-STARTED_md.html +211 -0
  14. data/docs/Gemfile.html +153 -0
  15. data/docs/Gemfile_lock.html +438 -0
  16. data/docs/LoggableActivity/ActivitiesController.html +160 -0
  17. data/docs/LoggableActivity/ActivitiesHelper.html +158 -0
  18. data/docs/LoggableActivity/Activity.html +565 -0
  19. data/docs/LoggableActivity/ApplicationController.html +97 -0
  20. data/docs/LoggableActivity/ApplicationHelper.html +91 -0
  21. data/docs/LoggableActivity/ApplicationJob.html +97 -0
  22. data/docs/LoggableActivity/ApplicationMailer.html +97 -0
  23. data/docs/LoggableActivity/ApplicationRecord.html +97 -0
  24. data/docs/LoggableActivity/Configuration.html +237 -0
  25. data/docs/LoggableActivity/ConfigurationError.html +142 -0
  26. data/docs/LoggableActivity/CurrentActor.html +166 -0
  27. data/docs/LoggableActivity/DataOwner.html +138 -0
  28. data/docs/LoggableActivity/Encryption.html +321 -0
  29. data/docs/LoggableActivity/EncryptionError.html +142 -0
  30. data/docs/LoggableActivity/EncryptionKey.html +399 -0
  31. data/docs/LoggableActivity/Engine.html +108 -0
  32. data/docs/LoggableActivity/Error.html +142 -0
  33. data/docs/LoggableActivity/Generators/InstallGenerator.html +212 -0
  34. data/docs/LoggableActivity/Generators.html +91 -0
  35. data/docs/LoggableActivity/Hooks.html +841 -0
  36. data/docs/LoggableActivity/Payload.html +430 -0
  37. data/docs/LoggableActivity/Sanitizer.html +134 -0
  38. data/docs/LoggableActivity/Services/BasePayloadsBuilder.html +472 -0
  39. data/docs/LoggableActivity/Services/CustomPayloadsBuilder.html +225 -0
  40. data/docs/LoggableActivity/Services/DestroyPayloadsBuilder.html +396 -0
  41. data/docs/LoggableActivity/Services/PayloadsBuilder.html +348 -0
  42. data/docs/LoggableActivity/Services/UpdatePayloadsBuilder.html +540 -0
  43. data/docs/LoggableActivity/Services.html +93 -0
  44. data/docs/LoggableActivity.html +173 -0
  45. data/docs/MIT-LICENSE.html +132 -0
  46. data/docs/Object.html +110 -0
  47. data/docs/README_md.html +186 -0
  48. data/docs/Rakefile.html +134 -0
  49. data/docs/app/assets/config/loggable_activity_manifest_js.html +126 -0
  50. data/docs/app/assets/javascripts/loggable_activity/application_js.html +124 -0
  51. data/docs/app/assets/stylesheets/loggable_activity/activities_scss.html +154 -0
  52. data/docs/app/assets/stylesheets/loggable_activity/application_scss.html +142 -0
  53. data/docs/app/views/layouts/loggable_activity/application_html_slim.html +145 -0
  54. data/docs/app/views/loggable_activity/activities/_activities_html_slim.html +159 -0
  55. data/docs/created.rid +74 -0
  56. data/docs/css/fonts.css +167 -0
  57. data/docs/css/rdoc.css +687 -0
  58. data/docs/fonts/Lato-Light.ttf +0 -0
  59. data/docs/fonts/Lato-LightItalic.ttf +0 -0
  60. data/docs/fonts/Lato-Regular.ttf +0 -0
  61. data/docs/fonts/Lato-RegularItalic.ttf +0 -0
  62. data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
  63. data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
  64. data/docs/git-org/HEAD.html +126 -0
  65. data/docs/git-org/config.html +128 -0
  66. data/docs/git-org/description.html +126 -0
  67. data/docs/git-org/hooks/applypatch-msg_sample.html +128 -0
  68. data/docs/git-org/hooks/commit-msg_sample.html +138 -0
  69. data/docs/git-org/hooks/fsmonitor-watchman_sample.html +302 -0
  70. data/docs/git-org/hooks/post-update_sample.html +128 -0
  71. data/docs/git-org/hooks/pre-applypatch_sample.html +128 -0
  72. data/docs/git-org/hooks/pre-commit_sample.html +174 -0
  73. data/docs/git-org/hooks/pre-merge-commit_sample.html +133 -0
  74. data/docs/git-org/hooks/pre-push_sample.html +161 -0
  75. data/docs/git-org/hooks/pre-rebase_sample.html +282 -0
  76. data/docs/git-org/hooks/pre-receive_sample.html +144 -0
  77. data/docs/git-org/hooks/prepare-commit-msg_sample.html +136 -0
  78. data/docs/git-org/hooks/push-to-checkout_sample.html +178 -0
  79. data/docs/git-org/hooks/update_sample.html +226 -0
  80. data/docs/git-org/info/exclude.html +126 -0
  81. data/docs/images/add.png +0 -0
  82. data/docs/images/arrow_up.png +0 -0
  83. data/docs/images/brick.png +0 -0
  84. data/docs/images/brick_link.png +0 -0
  85. data/docs/images/bug.png +0 -0
  86. data/docs/images/bullet_black.png +0 -0
  87. data/docs/images/bullet_toggle_minus.png +0 -0
  88. data/docs/images/bullet_toggle_plus.png +0 -0
  89. data/docs/images/date.png +0 -0
  90. data/docs/images/delete.png +0 -0
  91. data/docs/images/find.png +0 -0
  92. data/docs/images/loadingAnimation.gif +0 -0
  93. data/docs/images/macFFBgHack.png +0 -0
  94. data/docs/images/package.png +0 -0
  95. data/docs/images/page_green.png +0 -0
  96. data/docs/images/page_white_text.png +0 -0
  97. data/docs/images/page_white_width.png +0 -0
  98. data/docs/images/plugin.png +0 -0
  99. data/docs/images/ruby.png +0 -0
  100. data/docs/images/tag_blue.png +0 -0
  101. data/docs/images/tag_green.png +0 -0
  102. data/docs/images/transparent.png +0 -0
  103. data/docs/images/wrench.png +0 -0
  104. data/docs/images/wrench_orange.png +0 -0
  105. data/docs/images/zoom.png +0 -0
  106. data/docs/index.html +166 -0
  107. data/docs/js/darkfish.js +97 -0
  108. data/docs/js/navigation.js +105 -0
  109. data/docs/js/navigation.js.gz +0 -0
  110. data/docs/js/search.js +110 -0
  111. data/docs/js/search_index.js +1 -0
  112. data/docs/js/search_index.js.gz +0 -0
  113. data/docs/js/searcher.js +229 -0
  114. data/docs/js/searcher.js.gz +0 -0
  115. data/docs/lib/loggable_activity/config_schema_json.html +205 -0
  116. data/docs/lib/tasks/loggable_activity_tasks_rake.html +128 -0
  117. data/docs/table_of_contents.html +954 -0
  118. data/lib/generators/loggable_activity/install/install_generator.rb +68 -0
  119. data/lib/generators/loggable_activity/install/templates/create_loggable_activities.rb +45 -0
  120. data/lib/generators/loggable_activity/install/templates/loggable_activity.en.yml +32 -0
  121. data/lib/generators/loggable_activity/install/templates/loggable_activity.rb +27 -0
  122. data/lib/generators/loggable_activity/install/templates/loggable_activity.yml +103 -0
  123. data/lib/loggable_activity/activity.rb +4 -4
  124. data/lib/loggable_activity/concerns/current_actor.rb +25 -0
  125. data/lib/loggable_activity/config_schema.json +2 -13
  126. data/lib/loggable_activity/configuration.rb +0 -10
  127. data/lib/loggable_activity/encryption.rb +33 -12
  128. data/lib/loggable_activity/encryption_key.rb +1 -1
  129. data/lib/loggable_activity/error.rb +3 -3
  130. data/lib/loggable_activity/hooks.rb +74 -18
  131. data/lib/loggable_activity/payload.rb +6 -4
  132. data/lib/loggable_activity/services/base_payloads_builder.rb +2 -1
  133. data/lib/loggable_activity/services/custom_payloads_builder.rb +55 -0
  134. data/lib/loggable_activity/version.rb +1 -1
  135. data/lib/loggable_activity.rb +5 -2
  136. metadata +121 -111
  137. data/lib/loggable_activity/concerns/current_user.rb +0 -26
@@ -0,0 +1,540 @@
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
+ <li ><a href="#method-i-updated_public_attrs">#updated_public_attrs</a>
87
+ </ul>
88
+ </div>
89
+
90
+ </div>
91
+ </nav>
92
+
93
+ <main role="main" aria-labelledby="class-LoggableActivity::Services::UpdatePayloadsBuilder">
94
+ <h1 id="class-LoggableActivity::Services::UpdatePayloadsBuilder" class="class">
95
+ class LoggableActivity::Services::UpdatePayloadsBuilder
96
+ </h1>
97
+
98
+ <section class="description">
99
+
100
+ <p>This service class builds update payloads when an instance of a model is updated.</p>
101
+
102
+ </section>
103
+
104
+ <section id="5Buntitled-5D" class="documentation-section">
105
+
106
+
107
+
108
+
109
+
110
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
111
+ <header>
112
+ <h3>Public Instance Methods</h3>
113
+ </header>
114
+
115
+ <div id="method-i-build" class="method-detail ">
116
+ <div class="method-header">
117
+ <div class="method-heading">
118
+ <span class="method-name">build</span><span
119
+ class="method-args">()</span>
120
+ <span class="method-click-advice">click to toggle source</span>
121
+ </div>
122
+ </div>
123
+
124
+ <div class="method-description">
125
+ <p>Builds payloads for a <a href="../Activity.html"><code>::LoggableActivity::Activity</code></a>.</p>
126
+
127
+ <div class="method-source-code" id="build-source">
128
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 8</span>
129
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build</span>
130
+ <span class="ruby-identifier">build_primary_update_payload</span>
131
+ <span class="ruby-identifier">build_relations_update_payloads</span>
132
+ <span class="ruby-ivar">@payloads</span>
133
+ <span class="ruby-keyword">end</span></pre>
134
+ </div>
135
+ </div>
136
+
137
+
138
+ </div>
139
+
140
+ </section>
141
+
142
+ <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
143
+ <header>
144
+ <h3>Private Instance Methods</h3>
145
+ </header>
146
+
147
+ <div id="method-i-build_belongs_to_update_payload" class="method-detail ">
148
+ <div class="method-header">
149
+ <div class="method-heading">
150
+ <span class="method-name">build_belongs_to_update_payload</span><span
151
+ class="method-args">(relation_config)</span>
152
+ <span class="method-click-advice">click to toggle source</span>
153
+ </div>
154
+ </div>
155
+
156
+ <div class="method-description">
157
+ <p>Builds the update payload for a belongs_to relation.</p>
158
+
159
+ <div class="method-source-code" id="build_belongs_to_update_payload-source">
160
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 55</span>
161
+ <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>)
162
+ <span class="ruby-identifier">relation_id</span> = <span class="ruby-node">&quot;#{relation_config[&#39;belongs_to&#39;]}_id&quot;</span>
163
+ <span class="ruby-identifier">model_class_name</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;model&#39;</span>]
164
+ <span class="ruby-identifier">model_class</span> = <span class="ruby-identifier">model_class_name</span>.<span class="ruby-identifier">constantize</span>
165
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>
166
+
167
+ <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>] }
168
+
169
+ <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>
170
+ <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>
171
+ <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>
172
+
173
+ <span class="ruby-identifier">options</span> =
174
+ { <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> }
175
+
176
+ <span class="ruby-identifier">build_encrypted_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">options</span>)
177
+ <span class="ruby-keyword">end</span>
178
+ <span class="ruby-keyword">end</span></pre>
179
+ </div>
180
+ </div>
181
+
182
+
183
+ </div>
184
+
185
+ <div id="method-i-build_encrypted_update_payload" class="method-detail ">
186
+ <div class="method-header">
187
+ <div class="method-heading">
188
+ <span class="method-name">build_encrypted_update_payload</span><span
189
+ class="method-args">(record, current_values, previous_values, public_attrs, options = {})</span>
190
+ <span class="method-click-advice">click to toggle source</span>
191
+ </div>
192
+ </div>
193
+
194
+ <div class="method-description">
195
+ <p>Builds the encrypted update payload for a record.</p>
196
+
197
+ <div class="method-source-code" id="build_encrypted_update_payload-source">
198
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 179</span>
199
+ <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">public_attrs</span>, <span class="ruby-identifier">options</span> = {})
200
+ <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>)
201
+
202
+ <span class="ruby-identifier">encrypted_attrs</span> = <span class="ruby-identifier">encrypted_update_attrs</span>(
203
+ <span class="ruby-identifier">current_values</span>,
204
+ <span class="ruby-identifier">previous_values</span>,
205
+ <span class="ruby-identifier">encryption_key</span>.<span class="ruby-identifier">secret_key</span>
206
+ )
207
+
208
+ <span class="ruby-identifier">build_payload</span>(
209
+ <span class="ruby-identifier">record</span>,
210
+ <span class="ruby-identifier">encryption_key</span>,
211
+ <span class="ruby-identifier">encrypted_attrs</span>,
212
+ <span class="ruby-identifier">public_attrs</span>,
213
+ <span class="ruby-identifier">options</span>
214
+ )
215
+ <span class="ruby-keyword">end</span></pre>
216
+ </div>
217
+ </div>
218
+
219
+
220
+ </div>
221
+
222
+ <div id="method-i-build_has_many_create_payload" class="method-detail ">
223
+ <div class="method-header">
224
+ <div class="method-heading">
225
+ <span class="method-name">build_has_many_create_payload</span><span
226
+ class="method-args">(relation_config, record)</span>
227
+ <span class="method-click-advice">click to toggle source</span>
228
+ </div>
229
+ </div>
230
+
231
+ <div class="method-description">
232
+
233
+
234
+ <div class="method-source-code" id="build_has_many_create_payload-source">
235
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 116</span>
236
+ <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>)
237
+ <span class="ruby-identifier">record</span>.<span class="ruby-identifier">disable_hooks</span> = <span class="ruby-keyword">true</span>
238
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>
239
+ <span class="ruby-identifier">options</span> =
240
+ { <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> }
241
+ <span class="ruby-identifier">build_encrypted_payload</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">options</span>)
242
+ <span class="ruby-keyword">end</span></pre>
243
+ </div>
244
+ </div>
245
+
246
+
247
+ </div>
248
+
249
+ <div id="method-i-build_has_many_update_payload" class="method-detail ">
250
+ <div class="method-header">
251
+ <div class="method-heading">
252
+ <span class="method-name">build_has_many_update_payload</span><span
253
+ class="method-args">(relation_config, record)</span>
254
+ <span class="method-click-advice">click to toggle source</span>
255
+ </div>
256
+ </div>
257
+
258
+ <div class="method-description">
259
+
260
+
261
+ <div class="method-source-code" id="build_has_many_update_payload-source">
262
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 91</span>
263
+ <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>)
264
+ <span class="ruby-identifier">record</span>.<span class="ruby-identifier">disable_hooks</span> = <span class="ruby-keyword">true</span>
265
+ <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>)
266
+ <span class="ruby-identifier">loggable_attrs</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;loggable_attrs&#39;</span>]
267
+ <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>
268
+
269
+ <span class="ruby-identifier">public_attributes</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;public_attrs&#39;</span>]
270
+ <span class="ruby-identifier">public_attrs</span> = <span class="ruby-identifier">updated_public_attrs</span>(
271
+ <span class="ruby-identifier">current_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">public_attributes</span>),
272
+ <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">public_attributes</span>)
273
+ )
274
+
275
+ <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>)
276
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>
277
+ <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> }
278
+
279
+ <span class="ruby-identifier">build_encrypted_update_payload</span>(
280
+ <span class="ruby-identifier">record</span>,
281
+ <span class="ruby-identifier">current_values</span>,
282
+ <span class="ruby-identifier">previous_values</span>,
283
+ <span class="ruby-identifier">public_attrs</span>,
284
+ <span class="ruby-identifier">options</span>
285
+ )
286
+ <span class="ruby-keyword">end</span></pre>
287
+ </div>
288
+ </div>
289
+
290
+
291
+ </div>
292
+
293
+ <div id="method-i-build_has_many_update_payloads" class="method-detail ">
294
+ <div class="method-header">
295
+ <div class="method-heading">
296
+ <span class="method-name">build_has_many_update_payloads</span><span
297
+ class="method-args">(relation_config)</span>
298
+ <span class="method-click-advice">click to toggle source</span>
299
+ </div>
300
+ </div>
301
+
302
+ <div class="method-description">
303
+ <p>Builds payloads for has_many relations.</p>
304
+
305
+ <div class="method-source-code" id="build_has_many_update_payloads-source">
306
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 75</span>
307
+ <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>)
308
+ <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>
309
+ <span class="ruby-identifier">records</span> = <span class="ruby-ivar">@record</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">relation</span>)
310
+ <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>
311
+
312
+ <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>
313
+ <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>
314
+ <span class="ruby-identifier">build_has_many_update_payload</span>(<span class="ruby-identifier">relation_config</span>, <span class="ruby-identifier">record</span>)
315
+ <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>
316
+ <span class="ruby-comment"># &quot;no changes to save&quot;</span>
317
+ <span class="ruby-keyword">else</span>
318
+ <span class="ruby-identifier">build_has_many_create_payload</span>(<span class="ruby-identifier">relation_config</span>, <span class="ruby-identifier">record</span>)
319
+ <span class="ruby-keyword">end</span>
320
+ <span class="ruby-keyword">end</span>
321
+ <span class="ruby-keyword">end</span></pre>
322
+ </div>
323
+ </div>
324
+
325
+
326
+ </div>
327
+
328
+ <div id="method-i-build_has_one_update_payload" class="method-detail ">
329
+ <div class="method-header">
330
+ <div class="method-heading">
331
+ <span class="method-name">build_has_one_update_payload</span><span
332
+ class="method-args">(relation_config)</span>
333
+ <span class="method-click-advice">click to toggle source</span>
334
+ </div>
335
+ </div>
336
+
337
+ <div class="method-description">
338
+ <p>Builds the update payload for a has_one relation.</p>
339
+
340
+ <div class="method-source-code" id="build_has_one_update_payload-source">
341
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 125</span>
342
+ <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>)
343
+ <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>
344
+ <span class="ruby-identifier">record</span> = <span class="ruby-ivar">@record</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">relation</span>)
345
+ <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>
346
+
347
+ <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>)
348
+ <span class="ruby-identifier">loggable_attrs</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;loggable_attrs&#39;</span>]
349
+ <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>
350
+
351
+ <span class="ruby-identifier">public_attrs</span> = <span class="ruby-identifier">updated_public_attrs</span>(
352
+ <span class="ruby-identifier">current_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">public_attrs</span>),
353
+ <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">public_attrs</span>)
354
+ )
355
+
356
+ <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>)
357
+ <span class="ruby-identifier">current_values</span> = <span class="ruby-identifier">current_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">loggable_attrs</span>)
358
+ <span class="ruby-identifier">data_owner</span> = <span class="ruby-identifier">relation_config</span>[<span class="ruby-string">&#39;data_owner&#39;</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>
359
+ <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> }
360
+
361
+ <span class="ruby-identifier">build_encrypted_update_payload</span>(
362
+ <span class="ruby-identifier">record</span>,
363
+ <span class="ruby-identifier">current_values</span>,
364
+ <span class="ruby-identifier">previous_values</span>,
365
+ <span class="ruby-identifier">public_attrs</span>,
366
+ <span class="ruby-identifier">options</span>
367
+ )
368
+ <span class="ruby-keyword">end</span></pre>
369
+ </div>
370
+ </div>
371
+
372
+
373
+ </div>
374
+
375
+ <div id="method-i-build_primary_update_payload" class="method-detail ">
376
+ <div class="method-header">
377
+ <div class="method-heading">
378
+ <span class="method-name">build_primary_update_payload</span><span
379
+ class="method-args">()</span>
380
+ <span class="method-click-advice">click to toggle source</span>
381
+ </div>
382
+ </div>
383
+
384
+ <div class="method-description">
385
+ <p>Builds the primary payload.</p>
386
+
387
+ <div class="method-source-code" id="build_primary_update_payload-source">
388
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 17</span>
389
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_primary_update_payload</span>
390
+ <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>)
391
+ <span class="ruby-identifier">public_attrs</span> = <span class="ruby-identifier">updated_public_attrs</span>(<span class="ruby-identifier">current_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@public_attrs</span>), <span class="ruby-identifier">previous_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@public_attrs</span>))
392
+ <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-ivar">@loggable_attrs</span>)
393
+ <span class="ruby-identifier">current_values</span> = <span class="ruby-identifier">current_values</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@loggable_attrs</span>)
394
+ <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> }
395
+
396
+ <span class="ruby-identifier">build_encrypted_update_payload</span>(
397
+ <span class="ruby-ivar">@record</span>,
398
+ <span class="ruby-identifier">current_values</span>,
399
+ <span class="ruby-identifier">previous_values</span>,
400
+ <span class="ruby-identifier">public_attrs</span>,
401
+ <span class="ruby-identifier">options</span>
402
+ )
403
+ <span class="ruby-keyword">end</span></pre>
404
+ </div>
405
+ </div>
406
+
407
+
408
+ </div>
409
+
410
+ <div id="method-i-build_relation_update_payload" class="method-detail ">
411
+ <div class="method-header">
412
+ <div class="method-heading">
413
+ <span class="method-name">build_relation_update_payload</span><span
414
+ class="method-args">(relation_config)</span>
415
+ <span class="method-click-advice">click to toggle source</span>
416
+ </div>
417
+ </div>
418
+
419
+ <div class="method-description">
420
+
421
+
422
+ <div class="method-source-code" id="build_relation_update_payload-source">
423
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 41</span>
424
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_relation_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
425
+ <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>
426
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">key</span>
427
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;belongs_to&#39;</span>
428
+ <span class="ruby-identifier">build_belongs_to_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
429
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;has_one&#39;</span>
430
+ <span class="ruby-identifier">build_has_one_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
431
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;has_many&#39;</span>
432
+ <span class="ruby-identifier">build_has_many_update_payloads</span>(<span class="ruby-identifier">relation_config</span>)
433
+ <span class="ruby-keyword">end</span>
434
+ <span class="ruby-keyword">end</span>
435
+ <span class="ruby-keyword">end</span></pre>
436
+ </div>
437
+ </div>
438
+
439
+
440
+ </div>
441
+
442
+ <div id="method-i-build_relations_update_payloads" class="method-detail ">
443
+ <div class="method-header">
444
+ <div class="method-heading">
445
+ <span class="method-name">build_relations_update_payloads</span><span
446
+ class="method-args">()</span>
447
+ <span class="method-click-advice">click to toggle source</span>
448
+ </div>
449
+ </div>
450
+
451
+ <div class="method-description">
452
+ <p>Build the payloads for the relations of the record. only relations included in the configuration, will be logged.</p>
453
+
454
+ <div class="method-source-code" id="build_relations_update_payloads-source">
455
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 35</span>
456
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_relations_update_payloads</span>
457
+ <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>
458
+ <span class="ruby-identifier">build_relation_update_payload</span>(<span class="ruby-identifier">relation_config</span>)
459
+ <span class="ruby-keyword">end</span>
460
+ <span class="ruby-keyword">end</span></pre>
461
+ </div>
462
+ </div>
463
+
464
+
465
+ </div>
466
+
467
+ <div id="method-i-encrypted_update_attrs" class="method-detail ">
468
+ <div class="method-header">
469
+ <div class="method-heading">
470
+ <span class="method-name">encrypted_update_attrs</span><span
471
+ class="method-args">(current_values, previous_values, encryption_key)</span>
472
+ <span class="method-click-advice">click to toggle source</span>
473
+ </div>
474
+ </div>
475
+
476
+ <div class="method-description">
477
+ <p>Returns the encrypted attributes for the update payload.</p>
478
+
479
+ <div class="method-source-code" id="encrypted_update_attrs-source">
480
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 154</span>
481
+ <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>)
482
+ <span class="ruby-identifier">changes</span> = []
483
+
484
+ <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>
485
+ <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>)
486
+ <span class="ruby-identifier">to_value</span> = <span class="ruby-identifier">current_values</span>[<span class="ruby-identifier">key</span>]
487
+ <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>)
488
+ <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> } }
489
+ <span class="ruby-keyword">end</span>
490
+ { <span class="ruby-value">changes:</span> }
491
+ <span class="ruby-keyword">end</span></pre>
492
+ </div>
493
+ </div>
494
+
495
+
496
+ </div>
497
+
498
+ <div id="method-i-updated_public_attrs" class="method-detail ">
499
+ <div class="method-header">
500
+ <div class="method-heading">
501
+ <span class="method-name">updated_public_attrs</span><span
502
+ class="method-args">(current_values, previous_values)</span>
503
+ <span class="method-click-advice">click to toggle source</span>
504
+ </div>
505
+ </div>
506
+
507
+ <div class="method-description">
508
+
509
+
510
+ <div class="method-source-code" id="updated_public_attrs-source">
511
+ <pre><span class="ruby-comment"># File lib/loggable_activity/services/update_payloads_builder.rb, line 166</span>
512
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">updated_public_attrs</span>(<span class="ruby-identifier">current_values</span>, <span class="ruby-identifier">previous_values</span>)
513
+ <span class="ruby-identifier">changes</span> = []
514
+
515
+ <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>
516
+ <span class="ruby-identifier">from</span> = <span class="ruby-identifier">from_value</span>
517
+ <span class="ruby-identifier">to_value</span> = <span class="ruby-identifier">current_values</span>[<span class="ruby-identifier">key</span>]
518
+ <span class="ruby-identifier">to</span> = <span class="ruby-identifier">to_value</span>
519
+ <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> } }
520
+ <span class="ruby-keyword">end</span>
521
+ { <span class="ruby-value">changes:</span> }
522
+ <span class="ruby-keyword">end</span></pre>
523
+ </div>
524
+ </div>
525
+
526
+
527
+ </div>
528
+
529
+ </section>
530
+
531
+ </section>
532
+ </main>
533
+
534
+
535
+ <footer id="validator-badges" role="contentinfo">
536
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
537
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.7.0.
538
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
539
+ </footer>
540
+