loggable_activity 0.5.0 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62e1b197ae053af29d55c9b183c358a773f43186691c20c8e124ba7786bde586
-  data.tar.gz: ae8bd2c8d9a9718c02fc246c2a5a703b6fad9b27823cf357a51020d96b0a5a16
+  metadata.gz: e8d0d096b34f0b29dc9d0af6fb1c44e7fb4ba79b85b92e0e6aee4d895e5dcc57
+  data.tar.gz: 35ffb9e0e97409e8da7d659a37a37a66e2305f441505c4852af03d9681b8d90d
 SHA512:
-  metadata.gz: 7ed08eae394bc830b08d21f68de6b3f77811fde3b73d4278351bc807ee7c9de3369632bb349f16e45dd518e74297064494b1f810bb1b2c3cf1744d34f898adf9
-  data.tar.gz: 91891b25f6826cd70fcacc3bd3365a14b50e319c6d3af6ceecf72cb8340adb1298a79d28a1d08964087011c9e3766e188fe80193a3d293d087611a543817a7f4
+  metadata.gz: f2cae0fe288f7ac429004f9318e833af33d2b629b57041dfa6d2da11e81b6cf10cd282ee0672b5a8aab4a0529ff9637f682979c9b91749559827863b42281c10
+  data.tar.gz: 7f068e3bf66ac331a646e909c631d79ef9e455643f13b2ac9a3e574d99e9dfefc046d76885a6f38bba275a5763c8c7f64980076a86cbc4e230dd4d65aaa64d2c

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   Exclude:
     - 'db/migrate/20240702092648_create_loggable_activity_tables.rb'
 Layout/LineLength:
@@ -9,6 +10,8 @@ Layout/LineLength:
 Metrics/AbcSize:
   Exclude:
     - 'lib/loggable_activity/encryption.rb'
+    - 'lib/loggable_activity/services/update_payloads_builder.rb'
+    - 'lib/generators/loggable_activity/install/templates/create_loggable_activities.rb'
 Metrics/BlockLength:
   Exclude:
     - 'test/dummy/config/environments/development.rb'
@@ -18,6 +21,7 @@ Metrics/ClassLength:
   Exclude:
     - 'lib/loggable_activity/services/update_payloads_builder.rb'
 Metrics/MethodLength:
+  Enabled: true
   Exclude:
     - 'lib/loggable_activity/services/update_payloads_builder.rb'
     - 'lib/loggable_activity/services/destroy_payloads_builder.rb'
@@ -27,6 +31,9 @@ Metrics/MethodLength:
     - 'lib/loggable_activity/activity.rb'
     - 'lib/loggable_activity/services/payloads_builder.rb'
     - 'lib/loggable_activity/hooks.rb'
+    - 'test/dummy/db/migrate/20240629154538_create_users.rb'
+    - 'lib/loggable_activity/services/custom_payloads_builder.rb'
+    - 'lib/generators/loggable_activity/install/templates/create_loggable_activities.rb'
 Metrics/ModuleLength:
   Exclude:
     - 'lib/loggable_activity/hooks.rb'
@@ -36,3 +43,6 @@ Style/Documentation:
     - 'app/models/loggable_activity/application_record.rb'
     - 'app/mailers/loggable_activity/application_mailer.rb'
     - 'app/helpers/loggable_activity/application_helper.rb'
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/loggable_activity/hooks.rb'

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [0.5.6] - 2024-07-18
+- Documentation updated
+- Generator updated
+
+## [0.5.5] - 2024-07-16
+- Custom attrs added
+### Breaking change
+- Configuration.yml changed 
+
+## [0.5.4] - 2024-03-21
+- Styling with bootstrap css
+
+## [0.5.2] - 2024-03-21
+- Styling with pico css
+- Public attrs added
 
 ## [0.2.0] - 2024-07-03
 - Keys kan be kept until LoggableActivity::Sanitizer.run is called

data/GETTING-STARTED.md

@@ -0,0 +1,60 @@
+# Getting started 
+This document should you getting started with `LoggableActivity`
+
+## Prerequisite
+1 A running Rails Application<br/>
+2 An authorization system where a current user or similar is available.
+
+## Installation
+Add the loggable_activity gem to the Gemfile `gem 'loggable_activity', '~> 0.5.4` and then<br/>
+```
+$ bundle install
+```
+Then we have to generate some migrations and execute them<br/>
+```
+$ bin/rails generate loggable_activity:install
+$ bin/rails db:migrate
+```
+
+## Add hoks to models
+```
+class User < ApplicationRecord
+  include LoggableActivity::Hooks
+```
+
+## Configuration
+Update `config/initializers/loggable_activity.rb` documentation is in the file.
+
+## loggable_activity.yaml
+You have to update the configuration file installed inside the `config/loggable_activity.yaml`
+This file defines how data are logged.
+
+## Automatically log show from controllers
+This assumes that there is a current_user. E.g provided by the Devise gem</br>
+Add a this to the application_controller.rb if you want automatically log show
+```
+class ApplicationController < ActionController::Base
+  include LoggableActivity::CurrentUser
+```
+Otherwise you might create `app/controllers/concerns/current_user.rb` and alter it . 
+
+## Manually log show from controllers
+If you want to log the show action you can add this to your controllers show method
+```
+def show
+  @user.log(:show)
+```
+
+## For developers and contributors 
+You can download and play around with a demo app
+- 1 Download the project from [github](https://github.com/LoggableActivity/LoggableActivity) 
+- 1 Download the demo application from [github](https://github.com/LoggableActivity/LoggableActivityDemoApp)
+- 2 Update the Gemfile in the demo project so it points to your localhost.
+```
+Gemfile
+
+gem 'loggable_activity', '~> VERSION', path: '/PATH_TO_PROJECT/LoggableActivityEngine/LoggableActivityEngine'
+# gem 'loggable_activity', '~> VERSION'
+```
+*VERSION is the version number found in the gemfile*<br/>
+*PATH_TO_PROJECT* is where you have stored the project on your local drive

data/README.md

@@ -1,31 +1,42 @@
-# LoggableActivity
-Short description and motivation.
-
-## Usage
-How to use my plugin.
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem "loggable_activity"
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install loggable_activity
-```
-
-## Contributing
-Contribution directions go here.
-
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-##
-bin/rails loggable_activity:install:migrations
+# Loggable Activity 🌟
+Super easy to use activity log with views out of the box
+- Just add the gem and mount the engine and you have a cool looking activity log.
+- Easy and simple to customize and configure
+- All data are encrypted, and 
+
+### Important!
+This project is under development and not ready for production. There might be breaking changes, so please consult the CHANGELOG.md
+### What it is not
+- An error logging system
+- A paper trails system with rollback.
+- A backup system
+
+### Applications
+Most organizations needs to keep a log of how users interact with data stored in the DB
+- Finance
+- Healthcare
+- Sales and Support
+
+*Super simplified example from the healthcare.*
+- Each patient has a journal, that is updated on a regular basis.
+- Supervisor needs to follow the journal, how was it updated, who read it, did it get deleted.
+- Security personnel needs to know how the journal is handled, who did what when.
+- Patients has the right to know how their journal is handled and that their data will be removed when required.
+
+Beside the journal in the db, an activity log is kept so it is possible to track how the journal is used.<br/>
+At some point in time the patients data from the DB and the activity log has to be removed according to GDPR.<br/>
+
+### Getting started
+please read the [GETTING-STARTED.md](https://github.com/LoggableActivity/LoggableActivity/blob/main/GETTING-STARTED.md) guide
+
+### Contribute
+👉 Join the Slack channel here: [LoggableActivity Slack Workspace](https://join.slack.com/t/loggableactivity/shared_invite/zt-2a3tvgv37-mGwjHJTrBXBH2srXFRRSXQ)
+<br/>
+👉 Want to play around with an online version: [Show Demo](https://loggableactivity-efe7b931c886.herokuapp.com/)
+<br/>
+We value each contribution and believe in the power of community. Looking forward to seeing you there!
+
+
+### Test
+We embrace the philosophy of black-box testing, where we focus on the input and output of the public interface without worrying about internal implementation details.<br/>
+This approach aligns with the principle of testing behavior rather than implementation.

data/app/assets/config/loggable_activity_manifest.js

@@ -1,4 +1,2 @@
 //= link_directory ../stylesheets/loggable_activity .css
-//= link application.css
-//= link_directory ../javascripts/loggable_activity .js
-//= link application.js
+

data/app/assets/javascripts/loggable_activity/application.js

@@ -1,2 +1 @@
-//= require bootstrap
 

data/app/assets/stylesheets/loggable_activity/activities.scss

@@ -0,0 +1,25 @@
+.activity {
+  --bs-alert-bg: transparent;
+  --bs-alert-padding-x: 1rem;
+  --bs-alert-padding-y: 0.5rem;
+  // --bs-alert-margin-bottom: 1rem;
+  --bs-alert-color: inherit;
+  --bs-alert-border-color: transparent;
+  --bs-alert-border: var(--bs-border-width) solid var(--bs-alert-border-color);
+  --bs-alert-border-radius: var(--bs-border-radius);
+  --bs-alert-link-color: inherit;
+  position: relative;
+  padding: var(--bs-alert-padding-y) var(--bs-alert-padding-x);
+  margin-bottom: var(--bs-alert-margin-bottom);
+  color: var(--bs-alert-color);
+  background-color: var(--bs-alert-bg);
+  border: var(--bs-alert-border);
+  // border-radius: 0;
+}
+
+.activity-info {
+  --bs-alert-color: var(--bs-info-text-emphasis);
+  --bs-alert-bg: var(--bs-info-bg-subtle);
+  --bs-alert-border-color: var(--bs-info-border-subtle);
+  --bs-alert-link-color: var(--bs-info-text-emphasis);
+}

data/app/assets/stylesheets/loggable_activity/application.scss

@@ -12,9 +12,5 @@
  *
  *= require_tree .
  *= require_self
- */
-
-@import "bootstrap/functions";
-@import "bootstrap/variables";
-@import "bootstrap/mixins";
-@import "bootstrap";
+ *= require loggable_activity/activities
+ */

data/app/views/kaminari/{kaminari-turbo-bootstrap → pico}/_first_page.html.erb

@@ -8,7 +8,6 @@
 -%>
 <% unless current_page.first? %>
 <li class="page-item">
-  <%# <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, :class => 'page-link', :remote => remote %> 
   <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, class: 'page-link', data: { turbo: true } %>
 </li>
 <% end %>

data/app/views/kaminari/pico/_last_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.last? %>
+  <%= link_to_unless current_page.last?, raw(t('views.pagination.last')), url, class: 'page-link', data: { turbo: true } %>
+</li>
+<% end %>

data/app/views/layouts/loggable_activity/application.html.slim

@@ -0,0 +1,20 @@
+doctype html
+html
+  head
+    title Loggable activity
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag "loggable_activity/application", media: "all"
+    
+    link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/themes/prism.min.css" rel="stylesheet"
+    script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/prism.min.js"
+    
+    = stylesheet_link_tag 'https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css', 
+                          integrity: 'sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH', 
+                          crossorigin: 'anonymous'
+
+  body data-bs-theme="dark"
+    = yield
+    = javascript_include_tag 'https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js', 
+                             integrity: 'sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz', 
+                             crossorigin: 'anonymous'

data/app/views/loggable_activity/activities/_activities.html.slim

@@ -0,0 +1,28 @@
+
+.row 
+  .col-3 
+    b.text-secondary = t('loggable_activity.activity.action') 
+  .col-3 
+    b.text-secondary = t('loggable_activity.activity.record') 
+  .col-3 
+    b.text-secondary = t('loggable_activity.activity.actor')
+  .col-3 
+    b.text-secondary = t('loggable_activity.activity.created_at')
+
+- @activities.each do |activity|
+  .activity.activity-info[type="button" data-bs-toggle="collapse" data-bs-target="#activity_#{activity.id}" aria-expanded="false" aria-controls="collapseExample"]
+    .row 
+      .col-3
+        = activity_action(activity) 
+      .col-3
+        = activity.record_display_name
+      .col-3 
+        = activity.actor_display_name
+      .col-3 
+        = l(activity.created_at, format: :long)
+  .collapse id="activity_#{activity.id}"
+    pre
+      code.language-json
+        = format_json_for_display(activity.attrs)
+javascript:
+  Prism.highlightAll();

data/app/views/loggable_activity/activities/index.html.erb

@@ -1,7 +1,6 @@
-<h1>Activities</h1>
- <%= render partial: "activities", activities: @activities %>
+<div class="container">
+    <h1>Activities</h1>
+    <%= paginate @activities, views_prefix: "loggable_activity/bootstrap" %> 
+    <%= render partial: "activities", activities: @activities %>
+</div>
  
- <%= paginate @activities, theme: 'kaminari-turbo-bootstrap' %>
-
-
-

data/app/views/loggable_activity/bootstrap/kaminari/_first_page.html.erb

@@ -0,0 +1,13 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.first? %>
+<li class="page-item">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, class: 'page-link', data: { turbo: true } %>
+</li>
+<% end %>

data/app/views/loggable_activity/bootstrap/kaminari/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="page-item disabled"><a href="#" onclick="return false;" class="page-link"><%= raw(t 'views.pagination.truncate') %></a></li>

data/app/views/loggable_activity/bootstrap/kaminari/_next_page.html.erb

@@ -0,0 +1,13 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.last? %>
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t('views.pagination.next')), url, class: 'page-link', rel: 'next', data: { turbo: true }, remote: remote %>
+</li>
+<% end %>

data/app/views/loggable_activity/bootstrap/kaminari/_page.html.erb

@@ -0,0 +1,14 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="page-item<%= ' active' if page.current? %>">
+  <%#= link_to page, url, opts = {:remote => remote, :class => 'page-link', :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
+  <%= link_to page, url, class: 'page-link', rel: page.next? ? 'next' : page.prev? ? 'prev' : nil, data: { turbo: true }, remote: remote %>
+
+</li>

data/app/views/loggable_activity/bootstrap/kaminari/_paginator.html.erb

@@ -0,0 +1,27 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%- pagination_class ||= '' %>
+<%- nav_class ||= '' %>
+<%= paginator.render do -%>
+<nav class="<%= nav_class %>">
+  <ul class="pagination <%= pagination_class %>">
+    <%= first_page_tag unless current_page.first? %>
+    <%= prev_page_tag unless current_page.first? %>
+    <% each_page do |page| -%>
+      <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
+        <%= page_tag page %>
+      <% elsif !page.was_truncated? -%>
+        <%= gap_tag %>
+      <% end -%>
+    <% end -%>
+    <%= next_page_tag unless current_page.last? %>
+    <%= last_page_tag unless current_page.last? %>
+  </ul>
+</nav>
+<% end -%>

data/app/views/loggable_activity/bootstrap/kaminari/_prev_page.html.erb

@@ -0,0 +1,13 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.first? %>
+<li class="page-item">
+  <%= link_to_unless current_page.first?, raw(t('views.pagination.previous')), url, rel: 'prev', class: 'page-link', data: { turbo: true }, remote: remote %>
+</li>
+<% end %>

data/config/initializers/kaminari_config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Kaminari.configure do |config|
-  config.default_per_page = 3
+  # config.default_per_page = 10
   # config.max_per_page = nil
   # config.window = 4
   # config.outer_window = 0

data/lib/generators/loggable_activity/install/install_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# This module provides generators for installing and configuring LoggableActivity.
+# It includes generators for creating initializer, migration, and locale files.
+#
+# Example usage:
+#   rails generate loggable_activity:install
+#
+# This will:
+# - Create an initializer file in config/initializers/loggable_activity.rb
+# - Create a migration file in db/migrate/
+# - Create a locale file in config/locales/loggable_activity.en.yml
+#
+# After running the generator, remember to:
+# - Add `mount LoggableActivity::Engine => '/loggable_activity'` to your routes.rb file.
+# - Run `rails db:migrate` to create the necessary database tables.
+# - Include `LoggableActivity::Hook` in the models you want to track.
+# - Update the config/loggable_activity.yaml file with the fields you want to track.
+# - Ensure the locale files are properly set up in config/locales/loggable_activity.en.yml.
+module LoggableActivity
+  module Generators
+    # The InstallGenerator class is responsible for copying the necessary
+    # files to set up LoggableActivity in a Rails application.
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates a LoggableActivity initializer in your application.'
+      def copy_initializer
+        template 'loggable_activity.rb', 'config/initializers/loggable_activity.rb'
+      end
+
+      desc 'Creates a migration file for LoggableActivity in your application.'
+      def copy_migration
+        template 'create_loggable_activities.rb', "db/migrate/#{migration_number}_create_loggable_activities.rb"
+      end
+
+      desc 'Creates a locale file for LoggableActivity in your application.'
+      def copy_locale
+        template 'loggable_activity.en.yml', 'config/locales/loggable_activity.en.yml'
+      end
+
+      # Generates a timestamp to use in the migration filename.
+      #
+      # @return [String] the current UTC time formatted as a timestamp
+      def migration_number
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+
+      puts ''
+      puts "\e[1m\e[32m* ----------------------------- LoggableActivity ----------------------------- *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* LoggableActivity has been successfully installed.                            *\e[0m"
+      puts "\e[1m\e[32m* Add the following to your routes.rb file.                                    *\e[0m"
+      puts "\e[1m\e[32m* Mount LoggableActivity::Engine => '/loggable_activity'                       *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* $ rails db:migrate to create the tables.                                     *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* Add include LoggableActivity::Hook to the models you want to track.          *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* Update the config/loggable_activity.yaml file with fields to track.          *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* Locale files are found in config/locale/loggable_activity.en.yaml.           *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* ---------------------------------------------------------------------------- *\e[0m"
+      puts ''
+    end
+  end
+end

data/lib/generators/loggable_activity/install/templates/create_loggable_activities.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# This migration creates the necessary tables for LoggableActivity.
+class CreateLoggableActivities < ActiveRecord::Migration[7.1]
+  def change
+    create_table :loggable_activity_encryption_keys do |t|
+      t.references :record, polymorphic: true, null: true, index: true
+      t.string :secret_key
+      t.datetime :delete_at
+
+      t.timestamps
+    end
+
+    create_table :loggable_activity_activities do |t|
+      t.string :action
+      t.references :actor, polymorphic: true, null: true
+      t.string :encrypted_actor_name
+      t.references :record, polymorphic: true, null: true
+
+      t.timestamps
+    end
+
+    create_table :loggable_activity_payloads do |t|
+      t.references :activity, null: false, foreign_key: { to_table: 'loggable_activity_activities' }
+      t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_activity_encryption_keys' }
+      t.references :record, polymorphic: true, null: true, index: true
+      t.string :encrypted_record_name
+      t.json :encrypted_attrs
+      t.integer :related_to_activity_as, default: 0
+      t.boolean :data_owner, default: false
+      t.string :route
+      t.boolean :current_payload, default: true
+      t.json :public_attrs, default: {}
+
+      t.timestamps
+    end
+
+    create_table :loggable_activity_data_owners do |t|
+      t.references :record, polymorphic: true, null: true, index: true
+      t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_activity_encryption_keys' }
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/loggable_activity/install/templates/loggable_activity.en.yml

@@ -0,0 +1,32 @@
+
+# This file was generated when you installed Loggable Activity and is used for internationalization.
+# When a model 'includes LoggableActivity::Hooks' tags for translations are generated.
+# Example:
+# class User < ApplicationRecord
+#   include LoggableActivity::Hooks
+# end
+# This will make the following tags for translations available:
+# - loggable_activity.user.create
+# - loggable_activity.user.show
+# - loggable_activity.user.update
+# - loggable_activity.user.destroy
+# - loggable_activity.user.login
+# - loggable_activity.user.logout
+# 
+en:
+  loggable_activity:
+    activity:
+      actor: Actor
+      action: Action
+      record: Record
+      created_at: Created at
+      deleted: "*** DELETED ***"
+    user:
+      update: A user was updated
+      create: A user was created
+      show: "A user was shown"
+      destroy: A user was deleted
+      sign_up: A user signed up
+      login: A user logged in
+      logout: A user logged out
+      

data/lib/generators/loggable_activity/install/templates/loggable_activity.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# This configuration file is for setting up the LoggableActivity gem in your Rails application.
+
+# Specify the name of the model that represents the actor performing the activities.
+# This should be a string that matches the class name of the model.
+# Example: If your user model is named "User", set it to 'User'.
+LoggableActivity.actor_model_name = 'User'
+
+# Specify the attribute from which to fetch the actor's name.
+# This should be eighter a string representing the attribute name of the actor model
+# or a method that returns the actor's name.
+# Example: If you want to use the user's email as their name, set it to 'email'.
+LoggableActivity.fetch_actor_name_from = 'email'
+
+# Specify the path to the configuration file for LoggableActivity.
+# This file should be a YAML file that contains the necessary configuration for logging activities.
+# The path is set relative to the Rails root directory.
+# Example: The default configuration file path is 'config/loggable_activity.yaml'.
+LoggableActivity.config_file_path = Rails.root.join('config/loggable_activity.yaml')
+
+# Specify whether the sanitazion should be performed by a task or not
+# If set to 'false' the sanitization is performed immediately.
+# If set to 'true' the data is inaccessible, but can be restored.
+# If set to 'true' you have to permanently delete
+# the data by calling 'LoggableActivity::Sanitizer.run' from a task.
+LoggableActivity.task_for_sanitization = false