RubyGems - loggable_activity - Versions diffs - 0.2.1 → 0.5.0 - Mend

loggable_activity 0.2.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (150) hide show

checksums.yaml +4 -4
data/.rubocop.yml +29 -42
data/.vscode/commands.json +2 -2
data/.vscode/terminals.json +8 -8
data/CHEAT_SHEET.md +31 -0
data/MIT-LICENSE +21 -0
data/README.md +31 -45
data/Rakefile +6 -4
data/app/assets/config/loggable_activity_manifest.js +4 -0
data/app/assets/javascripts/loggable_activity/application.js +2 -0
data/app/assets/stylesheets/loggable_activity/application.scss +20 -0
data/app/controllers/concerns/.keep +0 -0
data/app/controllers/loggable_activity/activities_controller.rb +12 -0
data/app/controllers/loggable_activity/application_controller.rb +6 -0
data/app/helpers/loggable_activity/activities_helper.rb +17 -0
data/app/helpers/loggable_activity/application_helper.rb +6 -0
data/app/jobs/loggable_activity/application_job.rb +6 -0
data/app/mailers/loggable_activity/application_mailer.rb +8 -0
data/app/models/loggable_activity/application_record.rb +7 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_first_page.html.erb +14 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_gap.html.erb +8 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_last_page.html.erb +13 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_next_page.html.erb +13 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_page.html.erb +14 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_paginator.html.erb +27 -0
data/app/views/kaminari/kaminari-turbo-bootstrap/_prev_page.html.erb +14 -0
data/app/views/layouts/loggable_activity/application.html.erb +19 -0
data/app/views/loggable_activity/activities/_activities.html.erb +56 -0
data/app/views/loggable_activity/activities/index.html.erb +7 -0
data/app/views/loggable_activity/activities/show.html.erb +2 -0
data/config/initializers/kaminari_config.rb +14 -0
data/config/routes.rb +7 -0
data/{lib/generators/loggable_activity/templates/create_loggable_activities.rb → db/migrate/20240702092648_create_loggable_activity_tables.rb} +18 -10
data/git-org/HEAD +1 -0
data/git-org/config +7 -0
data/git-org/description +1 -0
data/git-org/hooks/applypatch-msg.sample +15 -0
data/git-org/hooks/commit-msg.sample +24 -0
data/git-org/hooks/fsmonitor-watchman.sample +174 -0
data/git-org/hooks/post-update.sample +8 -0
data/git-org/hooks/pre-applypatch.sample +14 -0
data/git-org/hooks/pre-commit.sample +49 -0
data/git-org/hooks/pre-merge-commit.sample +13 -0
data/git-org/hooks/pre-push.sample +53 -0
data/git-org/hooks/pre-rebase.sample +169 -0
data/git-org/hooks/pre-receive.sample +24 -0
data/git-org/hooks/prepare-commit-msg.sample +42 -0
data/git-org/hooks/push-to-checkout.sample +78 -0
data/git-org/hooks/update.sample +128 -0
data/git-org/info/exclude +6 -0
data/lib/loggable_activity/activity.rb +3 -3
data/lib/{schemas → loggable_activity}/config_schema.json +3 -3
data/lib/loggable_activity/configuration.rb +51 -75
data/lib/loggable_activity/data_owner.rb +0 -1
data/lib/loggable_activity/encryption.rb +16 -7
data/lib/loggable_activity/encryption_key.rb +4 -7
data/lib/loggable_activity/engine.rb +27 -0
data/lib/loggable_activity/error.rb +0 -10
data/lib/loggable_activity/hooks.rb +10 -5
data/lib/loggable_activity/payload.rb +8 -11
data/lib/loggable_activity/sanitizer.rb +6 -2
data/lib/loggable_activity/services/base_payloads_builder.rb +14 -5
data/lib/loggable_activity/services/destroy_payloads_builder.rb +2 -1
data/lib/loggable_activity/services/payloads_builder.rb +9 -2
data/lib/loggable_activity/services/update_payloads_builder.rb +30 -2
data/lib/loggable_activity/version.rb +1 -1
data/lib/loggable_activity.rb +51 -14
data/lib/tasks/loggable_activity_tasks.rake +6 -0
metadata +129 -117
data/.document +0 -1
data/.nojekyll +0 -1
data/.rspec +0 -3
data/CONSIDERTIONS.md +0 -129
data/GETTING-STARTED.md +0 -119
data/LICENSE.txt +0 -21
data/PAYLOAD_EXAMPLE.md +0 -63
data/ROADMAP.md +0 -23
data/docs/LoggableActivity/Activity.html +0 -555
data/docs/LoggableActivity/Configuration.html +0 -330
data/docs/LoggableActivity/ConfigurationError.html +0 -148
data/docs/LoggableActivity/DataOwner.html +0 -138
data/docs/LoggableActivity/Encryption.html +0 -234
data/docs/LoggableActivity/EncryptionError.html +0 -145
data/docs/LoggableActivity/EncryptionKey.html +0 -351
data/docs/LoggableActivity/Error.html +0 -145
data/docs/LoggableActivity/Hooks.html +0 -759
data/docs/LoggableActivity/Payload.html +0 -432
data/docs/LoggableActivity/Services/BasePayloadsBuilder.html +0 -442
data/docs/LoggableActivity/Services/DestroyPayloadsBuilder.html +0 -395
data/docs/LoggableActivity/Services/PayloadsBuilder.html +0 -342
data/docs/LoggableActivity/Services/UpdatePayloadsBuilder.html +0 -490
data/docs/LoggableActivity/Services.html +0 -93
data/docs/LoggableActivity.html +0 -102
data/docs/created.rid +0 -14
data/docs/css/fonts.css +0 -167
data/docs/css/rdoc.css +0 -687
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 +0 -99
data/docs/js/darkfish.js +0 -97
data/docs/js/navigation.js +0 -105
data/docs/js/navigation.js.gz +0 -0
data/docs/js/search.js +0 -110
data/docs/js/search_index.js +0 -1
data/docs/js/search_index.js.gz +0 -0
data/docs/js/searcher.js +0 -229
data/docs/js/searcher.js.gz +0 -0
data/docs/table_of_contents.html +0 -617
data/help/loggable_activity_help.txt +0 -19
data/lib/generators/.DS_Store +0 -0
data/lib/generators/loggable_activity/.DS_Store +0 -0
data/lib/generators/loggable_activity/install_generator.rb +0 -109
data/lib/generators/loggable_activity/templates/.DS_Store +0 -0
data/lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb +0 -30
data/lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml +0 -36
data/lib/generators/loggable_activity/templates/config/loggable_activity.yaml +0 -29
data/lib/generators/loggable_activity/templates/loggable_activity.en.yaml +0 -36
data/pkg/loggable_activity-0.1.35.gem +0 -0
data/sig/loggable_activity.rbs +0 -4
/data/{.rspec_status → app/assets/images/loggable_activity/.keep} +0 -0
/data/lib/{generators/loggable_activity/templates → loggable_activity/concerns}/current_user.rb +0 -0

data/PAYLOAD_EXAMPLE.md DELETED Viewed

@@ -1,63 +0,0 @@
-# Example of a payload attributes
-```
-{
-  'actor_type' => 'User'
-  'actor_id' => "12"
-  'action' => 'user.update'
-  'payloads' =>
-    [
-        {
-          :related_to_activity_as => 'primary',
-          :record_type => 'User',
-          :record_id => 7,
-          :route => 'show_user',
-          'attrs' => {
-            :first_name =>
-              'changed' =>
-                {
-                  'from' => 'Vo5qr2ZXdnUNvZlFPzPivVnZ4JJMHvftPKR9F5ZidDQ=\n',
-                  'to' => 'c4849GlicNeNw/7arZBRu6BCAYNlc7bjfHfpPv4Ra1I=\n'
-                }
-            last_name => 'Vo9apehbkapd=\n',
-            'age' => {
-              'from' => 'Whybq9OToAIYjYlP2gbXaieKDXH5Ut/uXc+M9R1OAk8=\n',
-              'to' => 'SUvxCLFBl3HUxqYihoj7VU3Ai/GK/ji5APJZNwbERqQ=\n'
-            }
-          }
-        },
-        {
-          :related_to_activity_as => 'has_one'
-          :record_type => 'Demo::UserProfile',
-          :record_id => 7,
-          :route => 'show_user'
-          :attrs => {,
-            :sex =>
-             'changed' =>
-                {
-                  'from' => 'aNY4G6dyaYyg7xiPwGMnGORsMvt8rzOKl7S+sEq1jYY=\n',
-                  'to' => 'Pqo5vaojL1SV0DMLL5WQsuNjxcZY+Av/ckCbT00ZKUk=\n'
-                },
-            religion => 'christianity'
-          }
-        },
-        {
-          :related_to_activity_as => 'belongs_to,
-          :changed =>
-          :payload_attrs => {
-            :from => {
-              :state => 'current_association'
-              :record_type => 'Demo::Address',
-              :record_id => 7,
-              :route => 'show_address'
-            }
-            :to => {
-            }
-          }
-        }
-    ]
-}
-```

data/ROADMAP.md DELETED Viewed

@@ -1,23 +0,0 @@
-# Roadmap
-Outline of steps to get the LoggableActivity adapted.
-### Demo project
-Nothing is better than gain som experience by getting som real world tests and experiences.
-<br/>
-Try the [Live Demo]("https://loggableactivity-efe7b931c886.herokuapp.com/") here or download it from [Github]("https://github.com/maxgronlund/LoggableActivityDemoApp") here
-### Open Source
-More eyes and brains on the project wil make it mature and better.
-### Investigations
-- Does there exists a protocol for activity logging
-- Will a bigger company like platformatec sponsor the project
-- Legal approval, official, medical approval.
-- RFC for protocol
-- Commercial potentials, business models.
-- Explainers
-- Documentation RDoc
-- Rest API
-- GraphQL API
-- Integration with other languages, node, elixir...

data/docs/LoggableActivity/Activity.html DELETED Viewed

@@ -1,555 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class LoggableActivity::Activity - RDoc Documentation</title>
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../";
-  var index_rel_prefix = "../";
-</script>
-<script src="../js/navigation.js" defer></script>
-<script src="../js/search.js" defer></script>
-<script src="../js/search_index.js" defer></script>
-<script src="../js/searcher.js" defer></script>
-<script src="../js/darkfish.js" defer></script>
-<link href="../css/fonts.css" rel="stylesheet">
-<link href="../css/rdoc.css" rel="stylesheet">
-<body id="top" role="document" class="class">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="../index.html" rel="home">Home</a>
-  </h2>
-  <div id="table-of-contents-navigation">
-    <a href="../table_of_contents.html#pages">Pages</a>
-    <a href="../table_of_contents.html#classes">Classes</a>
-    <a href="../table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-  <div id="class-metadata">
-<div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link">ActiveRecord::Base
-</div>
-<!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-activities_for_actor">::activities_for_actor</a>
-    <li ><a href="#method-c-last">::last</a>
-    <li ><a href="#method-c-latest">::latest</a>
-    <li ><a href="#method-i-actor_deleted-3F">#actor_deleted?</a>
-    <li ><a href="#method-i-actor_display_name">#actor_display_name</a>
-    <li ><a href="#method-i-actor_secret_key">#actor_secret_key</a>
-    <li ><a href="#method-i-attrs">#attrs</a>
-    <li ><a href="#method-i-must_have_at_least_one_payload">#must_have_at_least_one_payload</a>
-    <li ><a href="#method-i-ordered_payloads">#ordered_payloads</a>
-    <li ><a href="#method-i-payloads_attrs">#payloads_attrs</a>
-    <li ><a href="#method-i-primary_payload">#primary_payload</a>
-    <li ><a href="#method-i-primary_route">#primary_route</a>
-    <li ><a href="#method-i-record_display_name">#record_display_name</a>
-    <li ><a href="#method-i-record_key">#record_key</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-LoggableActivity::Activity">
-  <h1 id="class-LoggableActivity::Activity" class="class">
-    class LoggableActivity::Activity
-  </h1>
-  <section class="description">
-<p>Represents one action in the activity log.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-activities_for_actor" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">activities_for_actor</span><span
-              class="method-args">(actor, limit = 20, params = { offset: 0 })</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns a list of activities for a given actor.</p>
-          <div class="method-source-code" id="activities_for_actor-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 124</span>
-<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> })
-  <span class="ruby-operator">::</span><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>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-c-last" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">last</span><span
-              class="method-args">(limit = 1)</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the last activity. This is done to support of UUID primary keys.</p>
-          <div class="method-source-code" id="last-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 142</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">last</span>(<span class="ruby-identifier">limit</span> = <span class="ruby-value">1</span>)
-  <span class="ruby-keyword">return</span> <span class="ruby-identifier">latest</span>(<span class="ruby-value">1</span>).<span class="ruby-identifier">first</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
-  <span class="ruby-identifier">latest</span>(<span class="ruby-identifier">limit</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-c-latest" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">latest</span><span
-              class="method-args">(limit = 20, params = { offset: 0 })</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns a list of activities ordered by creation date. This is done to support UUID primary keys.</p>
-          <div class="method-source-code" id="latest-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 130</span>
-<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> })
-  <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>
-  <span class="ruby-operator">::</span><span class="ruby-constant">LoggableActivity</span><span class="ruby-operator">::</span><span class="ruby-constant">Activity</span>
-    .<span class="ruby-identifier">all</span>
-    .<span class="ruby-identifier">order</span>(<span class="ruby-value">created_at:</span> <span class="ruby-value">:desc</span>)
-    .<span class="ruby-identifier">includes</span>(<span class="ruby-value">payloads:</span> <span class="ruby-value">:encryption_key</span>)
-    .<span class="ruby-identifier">offset</span>(<span class="ruby-identifier">offset</span>)
-    .<span class="ruby-identifier">limit</span>(<span class="ruby-identifier">limit</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-actor_display_name" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">actor_display_name</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the display name for a actor. what method to use if defined in ‘/config/loggable_activity.yaml’</p>
-<p>Example:</p>
-<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">actor_display_name</span>
-</pre>
-<p>Returns:</p>
-<pre class="ruby"><span class="ruby-string">&quot;Elvis Presley&quot;</span>
-</pre>
-          <div class="method-source-code" id="actor_display_name-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 117</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">actor_display_name</span>
-  <span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">&#39;loggable.activity.deleted&#39;</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">actor_deleted?</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">decrypt</span>(<span class="ruby-identifier">encrypted_actor_name</span>, <span class="ruby-identifier">actor_secret_key</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-attrs" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">attrs</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns an array of hashes, each representing an activity’s attributes and its associated relations. The structure and relations to include are specified in ‘config/loggable_activity.yaml’. This format is designed for UI display purposes.</p>
-<p>Each hash in the array contains:</p>
-<ul><li>
-<p>:record_type: The class name of the record.</p>
-</li><li>
-<p>:related_to_activity_as: A descriptor of the payload’s role (e.g., ‘primary_payload’ or ‘current_association’).</p>
-</li><li>
-<p>:attrs: A hash of the record’s attributes.</p>
-</li></ul>
-<p>Example usage:</p>
-<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">attrs</span>
-</pre>
-<p>Sample return value:</p>
-<pre>[
-  { record_type: MODEL_NAME, related_to_activity_as: &quot;primary_payload&quot;, attrs: { &quot;KEY&quot; =&gt; &quot;VALUE&quot;, ... } },
-  { record_type: MODEL_NAME, related_to_activity_as: &quot;current_association&quot;, attrs: { &quot;KEY&quot; =&gt; &quot;VALUE&quot;, ... } },
-  ...
-]</pre>
-          <div class="method-source-code" id="attrs-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 37</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attrs</span>
-  {
-    <span class="ruby-value">actor_type:</span>,
-    <span class="ruby-value">actor_id:</span>,
-    <span class="ruby-value">action:</span>,
-    <span class="ruby-value">actor_display_name:</span>,
-    <span class="ruby-value">record_display_name:</span>,
-    <span class="ruby-value">payloads:</span> <span class="ruby-identifier">payloads_attrs</span>
-  }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-payloads_attrs" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">payloads_attrs</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <div class="method-source-code" id="payloads_attrs-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 48</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">payloads_attrs</span>
-  <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>
-    {
-      <span class="ruby-value">related_to_activity_as:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">related_to_activity_as</span>,
-      <span class="ruby-value">record_type:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">record_type</span>,
-      <span class="ruby-value">record_id:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">deleted?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">record_id</span>,
-      <span class="ruby-value">attrs:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">attrs</span>,
-      <span class="ruby-value">route:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">payload_route</span>,
-      <span class="ruby-value">record_display_name:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">record_display_name</span>,
-      <span class="ruby-value">current_payload:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">current_payload</span>,
-      <span class="ruby-value">data_owner:</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">data_owner</span>
-    }
-  <span class="ruby-keyword">end</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-primary_route" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">primary_route</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the path for the activity.</p>
-<p>Example:</p>
-<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">path</span>
-</pre>
-<p>Returns:</p>
-<pre class="ruby"><span class="ruby-string">&quot;/path/to/activity&quot;</span>
-</pre>
-          <div class="method-source-code" id="primary_route-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 104</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">primary_route</span>
-  <span class="ruby-identifier">primary_payload</span>.<span class="ruby-identifier">payload_route</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-record_display_name" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">record_display_name</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the display name for a record. what method to use if defined in ‘/config/loggable_activity.yaml’</p>
-<p>Example:</p>
-<pre class="ruby"><span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">record_display_name</span>
-</pre>
-<p>Returns:</p>
-<pre class="ruby"><span class="ruby-string">&quot;David Bowie&quot;</span>
-</pre>
-          <div class="method-source-code" id="record_display_name-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 91</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">record_display_name</span>
-  <span class="ruby-identifier">primary_payload</span>.<span class="ruby-identifier">record_display_name</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Private Instance Methods</h3>
-       </header>
-      <div id="method-i-actor_deleted-3F" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">actor_deleted?</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Check if the actor is deleted. If the actor is deleted, it will return true. This way we don’t rely on access to the main DB to check if the actor is deleted.</p>
-          <div class="method-source-code" id="actor_deleted-3F-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 177</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">actor_deleted?</span>
-  <span class="ruby-identifier">actor_secret_key</span>.<span class="ruby-identifier">nil?</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-actor_secret_key" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">actor_secret_key</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the key for the actor.</p>
-          <div class="method-source-code" id="actor_secret_key-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 182</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">actor_secret_key</span>
-  <span class="ruby-comment"># @actor_key_secret_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_by_type_and_id</span>(<span class="ruby-identifier">actor_type</span>, <span class="ruby-identifier">actor_id</span>)&amp;.<span class="ruby-identifier">secret_key</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-must_have_at_least_one_payload" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">must_have_at_least_one_payload</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Validates that the activity has at least one payload.</p>
-          <div class="method-source-code" id="must_have_at_least_one_payload-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 188</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">must_have_at_least_one_payload</span>
-  <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-value">:payloads</span>, <span class="ruby-string">&#39;must have at least one payload&#39;</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">payloads</span>.<span class="ruby-identifier">empty?</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-ordered_payloads" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">ordered_payloads</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns payloads sorted by :related_to_activity_as.</p>
-          <div class="method-source-code" id="ordered_payloads-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 162</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ordered_payloads</span>
-  <span class="ruby-comment"># payloads.order(related_to_activity_as: :desc)</span>
-  <span class="ruby-identifier">payloads</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-primary_payload" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">primary_payload</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the primary payload associated with the activity.</p>
-<p>Example usage:</p>
-<pre class="ruby"><span class="ruby-identifier">payload</span> = <span class="ruby-ivar">@activity</span>.<span class="ruby-identifier">primary_payload</span>
-<span class="ruby-identifier">payload</span>.<span class="ruby-identifier">record_type</span>  <span class="ruby-comment"># =&gt; &#39;SOMD_MODEL_NAME&#39;</span>
-</pre>
-          <div class="method-source-code" id="primary_payload-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 156</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">primary_payload</span>
-  <span class="ruby-identifier">related_to_activity_as</span> = <span class="ruby-node">%w[primary_payload primary_update_payload primary_destroy_payload]</span>
-  <span class="ruby-identifier">payloads</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">related_to_activity_as</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">p</span>.<span class="ruby-identifier">related_to_activity_as</span>) }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-record_key" class="method-detail ">
-        <div class="method-header">
-          <div class="method-heading">
-            <span class="method-name">record_key</span><span
-              class="method-args">()</span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-        </div>
-        <div class="method-description">
-          <p>Returns the key for the logged record.</p>
-          <div class="method-source-code" id="record_key-source">
-            <pre><span class="ruby-comment"># File lib/loggable_activity/activity.rb, line 168</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">record_key</span>
-  <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>
-  <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>)&amp;.<span class="ruby-identifier">secret_key</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="https://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>