loggable_activity 0.1.56 → 0.1.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0026d9021dbb8d457f89aae37cefeab76c25307392f7df9bf33576ced785ab2a
-  data.tar.gz: 1a7e30aee22dad70a1d5b6cfdbc8fbc5647ed9a84acb8e1793a12342dbd2845f
+  metadata.gz: 3443b88743e80e04335aeb6b192af90e69d6e79c22906784d8fde0efc303371e
+  data.tar.gz: 010db4535422917b8c7595e60d61e15a309c70456a95dfc4809bc6bcd382119e
 SHA512:
-  metadata.gz: 4207be61cc5c3fc3c9f6f8a37a6d589b92c0c5067cfc76dc8187ff94a4c8fcf4f8438c0682830bd609ff78883c3ee863985642926ddbece92a2a230c6b96e7a9
-  data.tar.gz: c770403638780d4708ef561eea6e3522dc1d16de6ac916d656db608e52ec24d88ba24a8314410f542d31a56d1f192a6869a67a0a486721dffc7d2b01dea8d7a8
+  metadata.gz: 503bc1adc73fb22312c8ae21b2a68dfd12e4f452687bd0b3be947a73a2a5aa06e4c643461b5c6f768915cd09c00117ec5020028bb91c30bcc9e618226d8efeda
+  data.tar.gz: b6f50f7877b2164f8b58267c87a1a2b0ede19f85d9c05a9cd32cb7b1188405f738704fd0e17907ed521f51db0893a40a4102e48e6b8b998ecd422143cf1f546c

data/.rubocop.yml

@@ -31,12 +31,21 @@ Style/IfUnlessModifier:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Metrics/ClassLength:
+  Exclude:
+    - lib/loggable_activity/services/update_payloads_builder.rb
+
+Metrics/ParameterLists:
+  Exclude:
+    - lib/loggable_activity/services/base_payloads_builder.rb
+
 Metrics/ModuleLength:
   Exclude:
     - lib/loggable_activity/hooks.rb
+
 Metrics/AbcSize:
   Exclude:
     - lib/loggable_activity/encryption.rb
-    - lib/loggable_activity/update_payloads_builder.rb
+    # - lib/loggable_activity/update_payloads_builderx.rb
     - lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb
     - lib/generators/loggable_activity/templates/create_loggable_activities.rb

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 
+## [0.1.58] - 2024-03-21
+### Breaking change
+- All presentations generators are removed
+- Service modules for building of payloads
+- Schema validation of configuration file
+- Schema validation in tests of generated attrs
+- Support for UUID's hanging, tbd
+- 100 pct test coverage 
+
 ## [0.1.56] - 2024-03-04
 ### Breaking change
 - Generate links in helpers

data/GETTING-STARTED.md

@@ -40,7 +40,7 @@ Update `config/application.rb`, you might do it differently in production
   config.loggable_activity = ActiveSupport::OrderedOptions.new
   config.loggable_activity.actor_display_name = :full_name
   config.loggable_activity.current_user_model_name = 'User'
-  LoggableActivity::Configuration.load_config_file('config/loggable_activity.yaml')
+  ::LoggableActivity::Configuration.load_config_file('config/loggable_activity.yaml')
 ```
 - actor_display_name: this is a method on the User model we want to use when presenting the actor.
 - current_user_model: This is the name of the model we use for current_user
@@ -60,6 +60,7 @@ This file defines:
 ```
 Demo::Club: 
   record_display_name: email 
+  route: show_demo_club
   loggable_attrs: 
     - email
     - name
@@ -70,6 +71,7 @@ Demo::Club:
   relations:
     - belongs_to: :address
       model: Demo::Address
+      route: show_address
       loggable_attrs:
         - street
         - city
@@ -78,10 +80,11 @@ Demo::Club:
 Lets break this down.
 - First we can se that we are logging a model named Demo::Club.
 - `record_display_name:` is the field/method on the on the model we want to display as a headline in the log
-- Then we can se that we are logging the **name** of the club, in this example that's all there is to log.
-- Then we can se that we are **logging create, update, and destroy** automatically.
+- `route` is a flag used to generate a link to the model logged, more on that later.
+- Then we can se that we are logging the `email` and `name`.
+- Then we can se that we are logging `create`, `update`, and `destroy` automatically.
 - Then there are some relations: that we want to collect and add to the log.<br/> 
-In this example the club belongs to an addres so we add the street and city from the address to the log.
+In this example the club belongs to an address so we add the street and city from the address to the log.
 
 
 ## Set current user
@@ -107,49 +110,7 @@ Supported relations at the moment is
 - has_one
 - has_many
 
-## Render templates
-*Optional*
-<br/>You can install all the files needed to render a list of activities<br/> 
-The following command will generate all the files need for showing the activity log
-```
-$ rails g loggable_activity:install_templates
-```
-or for the slim template language. (don't run both)
-```
-$ rails g loggable_activity:install_templates --template=slim
-```
-Now you got the `loggable_activity_helper.rb' installed.<br/>
-You can use the `render_activity` method from your view like this.
-```
-  <table>
-    <thead>
-      <tr>
-        <th>Info</th>
-        <th>Attributes</th>
-        <th>Actions</th>
-      </tr>
-    </thead>
-    <tbody>
-      <% @loggable_activities.each do |activity| %>
-        <%= render_activity(activity) %>
-      <% end %>
-    </tbody>
-  </table>
-```
-Create a route and a controller and fetch the `@loggable_activities` like this
-```
-class ActivityLogsController < ApplicationController
-  def index
-    @loggable_activities = LoggableActivity::Activity.latest(50)
-  end
-end
-```
-Or you can fetch all activities for a given actor like this
-```
-def show
-  @loggable_activities = LoggableActivity::Activity.where(actor: @user)
-end
-```
+
 
 ## For developers and contributors 
 If you can download and play around with a demo app

data/PAYLOAD_EXAMPLE.md

@@ -0,0 +1,63 @@
+# 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 => {
+
+            }
+
+          }
+        }
+    ]
+}
+```