loggable_activity 0.1.53 → 0.1.54

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780e8614a8e5b1c9e97a70a9cb432e8a277d3617dd845fc38b7c41a235b282a9
-  data.tar.gz: fea7bb11d9abcbeeb0423381c4a462df03c07e4ea4487d8e958e9ffe3479ff1f
+  metadata.gz: 4e3c72b18d402ce0870b6882beeb7438e46f4955e38ca9182c02bbe8b945ea23
+  data.tar.gz: e2484e4bec3907cff1d3974b9c58cde65e9c5b48dfd91cc0ab9302ced561d6b7
 SHA512:
-  metadata.gz: 262803990c60f23a9edcd0484105e0ecac141350d8d4710c5344db7dbe5836587b3959fea74be0890f9abb0e4b0c3a5324f8725d02e3fdd493cbdb3dbcbb53c2
-  data.tar.gz: 1ee1f8eb1850e8150665d9fc65b075c2eac86d7054f6921dee10fd35329e0643e3aa101d416b60278a5695eb8e1b4ef64e3a0ff76e0a13611f31868c31d7d0e2
+  metadata.gz: c39842b15b3fe0ea14970a381ba4b17222549884d90c4b96236d3bffd5a23ed97803011bef1aea4da1586fae6cdba7ab010a6ebe0e4f229b666fe174a49a4748
+  data.tar.gz: d44d7c04e0b5fcde4f7c8609da270ad7989bae25e84b5d6adaa2428ba5226284fb6e4187320eaa8fb8cbbe697c7804b3ec5b4fd4c9a78afc22d09084582fc305

data/.rubocop.yml

@@ -38,3 +38,5 @@ Metrics/AbcSize:
   Exclude:
     - lib/loggable_activity/encryption.rb
     - lib/loggable_activity/update_payloads_builder.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,3 +1,9 @@
+## [0.1.54] - 2024-02-24
+- Support for BinaryID's 
+- Updated README.md
+- Quick start guid in terminal after installations
+- Support for slim
+
 ## [0.1.53] - 2024-02-22
 - Generator for presentation layer
 - GETTING-STARTED.md guide 

data/GETTING-STARTED.md

@@ -26,17 +26,9 @@ This will install the following files
 - config/loggable_activity.yml
 - config/locales/loggable_activity.en.yml
 - db/migrate/xxxxxxxxxxxxxx_create_loggable_activities
-- db/migrate/xxxxxxxxxxxxxx_create_loggable_payloads
-- db/migrate/xxxxxxxxxxxxxx_create_loggable_encryption_keys
 
-Then we have to run
-```
-$ bundle install
-```
-
-## Add hoks to models you want to be logged
-Include hooks to the model we want to log.
 
+## Add hoks to models to be logged
 ```
 class User < ApplicationRecord
   include LoggableActivity::Hooks
@@ -67,8 +59,9 @@ This file defines:
 *Here is an example of content for the config/loggable_activity.yaml file*
 ```
 Demo::Club: 
-  record_display_name: name 
+  record_display_name: email 
   loggable_attrs: 
+    - email
     - name
   auto_log:
     - create

data/README.md

@@ -4,6 +4,8 @@ Secure protect data and log how it is handled
 - Protect and secure the privacy of data stored in Activity Logs
 - Prepare for General Data Protection Regulation (GDPR) compliance.
 - Handles activities that involves more than one table in the DB.
+- Encrypt data stored in the activity log
+- Support binary_ids
 
 ### Important!
 This project is under development and not ready for production. There might be breaking changes, so please consult the CHANGELOG.md

data/docs/LoggableActivity/UpdatePayloadsBuilder.html

@@ -230,7 +230,7 @@
           <div class="method-source-code" id="build_relation_update_for_has_many-source">
             <pre><span class="ruby-comment"># File lib/loggable_activity/update_payloads_builder.rb, line 64</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_relation_update_for_has_many</span>(<span class="ruby-identifier">relation_config</span>)
-  <span class="ruby-comment"># Note: This method is not implemented yet.</span>
+  <span class="ruby-comment"># NOTE: This method is not implemented yet.</span>
   <span class="ruby-comment"># It requires that there is a form where it is possible to change</span>
   <span class="ruby-comment"># the related records. This is not implemented yet. in the Demo app</span>
   <span class="ruby-comment"># puts relation_config[&#39;has_many&#39;]</span>
@@ -256,7 +256,7 @@
           <div class="method-source-code" id="build_relation_update_for_has_one-source">
             <pre><span class="ruby-comment"># File lib/loggable_activity/update_payloads_builder.rb, line 71</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_relation_update_for_has_one</span>(<span class="ruby-identifier">relation_config</span>)
-  <span class="ruby-comment"># Note: This method is not implemented yet.</span>
+  <span class="ruby-comment"># NOTE: This method is not implemented yet.</span>
   <span class="ruby-comment"># It requires that there is a form where it is possible to change</span>
   <span class="ruby-comment"># the related records. This is not implemented yet. in the Demo app</span>
   <span class="ruby-comment"># puts relation_config[&#39;has_many&#39;]</span>

data/docs/created.rid

@@ -1,10 +1,10 @@
-Wed, 21 Feb 2024 21:47:04 +0100
+Sat, 24 Feb 2024 15:48:31 +0100
 /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/activity.rb	Wed, 21 Feb 2024 12:58:24 +0100
 /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/configuration.rb	Mon, 19 Feb 2024 15:59:34 +0100
 /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/encryption.rb	Fri, 16 Feb 2024 15:03:24 +0100
 /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/encryption_key.rb	Wed, 21 Feb 2024 12:58:24 +0100
 /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/hooks.rb	Wed, 21 Feb 2024 12:58:24 +0100
 /Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/payload.rb	Wed, 21 Feb 2024 12:58:24 +0100
-/Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/payloads_builder.rb	Wed, 21 Feb 2024 21:46:26 +0100
-/Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/update_payloads_builder.rb	Wed, 21 Feb 2024 21:46:26 +0100
-/Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/version.rb	Wed, 21 Feb 2024 21:46:16 +0100
+/Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/payloads_builder.rb	Thu, 22 Feb 2024 17:26:16 +0100
+/Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/update_payloads_builder.rb	Thu, 22 Feb 2024 17:26:16 +0100
+/Users/maxgronlund/Documents/Max/open-source/LoggableActivity/lib/loggable_activity/version.rb	Thu, 22 Feb 2024 17:26:42 +0100

data/help/loggable_activity_help.txt

@@ -0,0 +1,19 @@
+Loggable Activity Generator Help
+--------------------------------
+
+Description:
+  This generator creates files and configurations for integrating the Loggable Activity gem into your Rails application.
+
+Usage:
+  rails generate loggable_activity [options]
+
+Options:
+  -h, [--help], [--no-help]           # Display usage instructions (this message)
+  -m, [--uuid]                        # Use uuids for primary_keys
+
+Examples:
+  rails generate loggable_activity  --uuid  # Generate loggable activity migration files with uuids for primary_keys 
+
+Note:
+  - This generator assumes that you have already installed the Loggable Activity gem.
+  - Ensure that your database schema supports UUIDs if using them as primary keys.

data/lib/generators/loggable_activity/install_generator.rb

@@ -6,17 +6,27 @@ require 'rails/generators/named_base'
 module LoggableActivity
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      def self.banner
+        'rails generate loggable_activity:install [options]'
+      end
+
+      desc 'This generator configures LoggableActivity by creating migration files and initializing necessary configuration files.'
+
       source_root File.expand_path('templates', __dir__)
+      class_option :uuid, type: :boolean, desc: 'use UUID for primary keys'
 
       FILE_NAMES = %w[activity payload encryption_key].freeze
       TIME = Time.now
 
-      def create_migration
+      def install
+        binary_ids = options['uuid'] ? true : false
         time = Time.now.utc
-        FILE_NAMES.each_with_index do |file_name, index|
-          timestamp = (time + index.minutes).strftime('%Y%m%d%H%M%S')
-          migration_file_name = "create_loggable_#{file_name.pluralize}.rb"
-          destination = File.join('db', 'migrate', "#{timestamp}_#{migration_file_name}")
+        timestamp = time.strftime('%Y%m%d%H%M%S')
+        migration_file_name = 'create_loggable_activities.rb'
+        destination = File.join('db', 'migrate', "#{timestamp}_#{migration_file_name}")
+        if binary_ids
+          template "binary_ids/#{migration_file_name}", destination
+        else
           template migration_file_name, destination
         end
       end
@@ -26,12 +36,90 @@ module LoggableActivity
       end
 
       def create_config_file
-        copy_file 'config/loggable_activity.yml', 'config/loggable_activity.yml'
+        copy_file 'config/loggable_activity.yaml', 'config/loggable_activity.yaml'
       end
 
       def create_current_user_concern
         copy_file 'current_user.rb', 'app/controllers/concerns/loggable_activity/current_user.rb'
       end
+
+      def completion_message
+        message = <<~MESSAGE
+          ------------------------------------------------
+           ___             _        _       _   _#{'             '}
+          |_ _|  _ __  ___| |_ __ _| | __ _| |_(_) ___  _ __#{'  '}
+           | |  | '_ \\/ __| __/ _` | |/ _` | __| |/ _ \\| '_ \\#{' '}
+           | |  | | | \\__ \\ || (_| | | (_| | |_| | (_) | | | |
+          |___| |_| |_|___/\\__\\__,_|_|\\__,_|\\__|_|\\___/|_| |_|
+            ____                         _      _           _#{' '}
+           / ___|   ___  _ __ ___  _ __ | | ___| |_ ___  __| |
+          | |      / _ \\| '_ ` _ \\| '_ \\| |/ _ \\ __/ _ \\/ _` |
+          | |___  | (_) | | | | | | |_) | |  __/ ||  __/ (_| |
+           \\____|  \\___/|_| |_| |_| .__/|_|\\___|\\__\\___|\\__,_|
+                                  |_|#{'                                               '}
+
+          LoggableActivity installation completed successfully!
+
+          Quick Start:
+
+          1. include hooks to the model we want to log.
+            class MY_MODEL < ApplicationRecord
+              include LoggableActivity::Hooks
+
+          2. Update `config/application.rb
+            config.loggable_activity = ActiveSupport::OrderedOptions.new
+            config.loggable_activity.actor_display_name = :email
+            config.loggable_activity.current_user_model_name = 'User'
+            LoggableActivity::Configuration.load_config_file('config/loggable_activity.yaml')
+
+          3. Include current_user ApplicationController
+            class ApplicationController < ActionController::Base
+              include LoggableActivity::CurrentUser
+
+          4. Update the 'config/loggable_activity.yaml' file with the necessary configuration.
+
+          5. Run the migration to create the necessary tables.
+
+
+          For more information, please visit:
+          https://github.com/maxgronlund/LoggableActivity/blob/main/GETTING-STARTED.md
+
+          Install templates
+          $ rails generate loggable_activity:install_templates
+
+
+
+          ------------------------------------------------
+        MESSAGE
+
+        puts message
+      end
+
+      private
+
+      def create_migration_files
+        binary_ids = options['uuid'] ? true : false
+        time = Time.now.utc
+        timestamp = time.strftime('%Y%m%d%H%M%S')
+        migration_file_name = 'create_loggable_activities.rb'
+        destination = File.join('db', 'migrate', "#{timestamp}_#{migration_file_name}")
+        if binary_ids
+          # Copy binary_id migration file
+          template "binary_ids/#{migration_file_name}", destination
+        else
+          # Copy integer migration file
+          template migration_file_name, destination
+        end
+      end
+
+      # def display_help
+      #   help_path = File.expand_path('../../../help/loggable_activity_help.txt', __dir__)
+      #   puts '-----------------------------'
+      #   puts help_path
+      #   puts File.read(help_path)
+      #   exit
+      # end
+      # Define a method to display a message after generation
     end
   end
 end

data/lib/generators/loggable_activity/install_templates_generator.rb

@@ -26,6 +26,67 @@ module LoggableActivity
         end
       end
 
+      def completion_message
+        message = <<~MESSAGE
+          ------------------------------------------------
+           ___             _        _       _   _#{'             '}
+          |_ _|  _ __  ___| |_ __ _| | __ _| |_(_) ___  _ __#{'  '}
+           | |  | '_ \\/ __| __/ _` | |/ _` | __| |/ _ \\| '_ \\#{' '}
+           | |  | | | \\__ \\ || (_| | | (_| | |_| | (_) | | | |
+          |___| |_| |_|___/\\__\\__,_|_|\\__,_|\\__|_|\\___/|_| |_|
+            ____                         _      _           _#{' '}
+           / ___|   ___  _ __ ___  _ __ | | ___| |_ ___  __| |
+          | |      / _ \\| '_ ` _ \\| '_ \\| |/ _ \\ __/ _ \\/ _` |
+          | |___  | (_) | | | | | | |_) | |  __/ ||  __/ (_| |
+           \\____|  \\___/|_| |_| |_| .__/|_|\\___|\\__\\___|\\__,_|
+                                  |_|#{'                                               '}
+
+          LoggableActivity templates installed successfully!
+
+          Quick Start:
+
+          1. Create a new controller to show the list of activities.
+            $ rails generate controller LoggableActivities index
+
+          2 Add the following to the loggable_activities_controller.rb
+            def index
+              @loggable_activities = LoggableActivity::Activity.latest(50)
+            end
+
+          3. Update routes.rb
+          resources :loggable_activities, only: [:index]
+
+          4. update the index view in app/views/loggable_activities/index.html.TEMPLATE_TYPE
+          h1 Activities#{' '}
+          table.table#{' '}
+            thead
+              tr
+                th Info#{' '}
+                th Attributes
+                th Actions
+            tbody
+              - @loggable_activities.each do |activity|
+                = render_activity(activity)
+
+          5. Visit
+          http://localhost:3000/loggable_activities
+
+
+
+          For more information, please visit:
+          https://github.com/maxgronlund/LoggableActivity/blob/main/GETTING-STARTED.md
+
+          Install templates
+          $ rails generate loggable_activity:install_templates
+
+
+
+          ------------------------------------------------
+        MESSAGE
+
+        puts message
+      end
+
       private
 
       def copy_files(type)

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class CreateLoggableActivities < ActiveRecord::Migration[7.1]
+  def change
+    create_table :loggable_activities, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.string :action
+      t.references :actor, polymorphic: true, null: true, type: :uuid
+      t.string :encrypted_actor_display_name
+      t.string :encrypted_record_display_name
+      t.references :record, polymorphic: true, null: true, type: :uuid
+
+      t.timestamps
+    end
+
+    create_table :loggable_payloads, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.references :record, polymorphic: true, null: true, type: :uuid
+      t.json :encrypted_attrs
+      t.integer :payload_type, default: 0
+      t.boolean :data_owner, default: false
+      t.references :activity, type: :uuid, foreign_key: { to_table: 'loggable_activities', class_name: 'LoggableActivity::Activity' }
+
+      t.timestamps
+    end
+
+    create_table :loggable_encryption_keys, id: :uuid, default: 'gen_random_uuid()' do |t|
+      t.string :key
+      t.references :parent_key, type: :uuid, foreign_key: { to_table: 'loggable_encryption_keys', on_delete: :nullify }
+      t.references :record, polymorphic: true, type: :uuid
+    end
+  end
+end

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

@@ -11,5 +11,21 @@ class CreateLoggableActivities < ActiveRecord::Migration[6.1]
 
       t.timestamps
     end
+
+    create_table :loggable_payloads do |t|
+      t.references :record, polymorphic: true, null: true
+      t.json :encrypted_attrs
+      t.integer :payload_type, default: 0
+      t.boolean :data_owner, default: false
+      t.references :activity, foreign_key: { to_table: 'loggable_activities', class_name: 'LoggableActivity::Activity' }
+
+      t.timestamps
+    end
+
+    create_table :loggable_encryption_keys do |t|
+      t.references :parent_key, foreign_key: { to_table: 'loggable_encryption_keys', on_delete: :nullify }
+      t.string :key
+      t.references :record, polymorphic: true, on_delete: :nullify
+    end
   end
 end

data/lib/loggable_activity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggableActivity
-  VERSION = '0.1.53'
+  VERSION = '0.1.54'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.53
+  version: 0.1.54
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -207,20 +207,20 @@ files:
 - docs/js/searcher.js
 - docs/js/searcher.js.gz
 - docs/table_of_contents.html
+- help/loggable_activity_help.txt
 - lib/.DS_Store
 - lib/generators/.DS_Store
 - lib/generators/loggable_activity/.DS_Store
 - lib/generators/loggable_activity/install_generator.rb
 - lib/generators/loggable_activity/install_templates_generator.rb
 - lib/generators/loggable_activity/templates/.DS_Store
+- lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb
 - lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml
-- lib/generators/loggable_activity/templates/config/loggable_activity.yml
+- lib/generators/loggable_activity/templates/config/loggable_activity.yaml
 - lib/generators/loggable_activity/templates/create_loggable_activities.rb
-- lib/generators/loggable_activity/templates/create_loggable_encryption_keys.rb
-- lib/generators/loggable_activity/templates/create_loggable_payloads.rb
 - lib/generators/loggable_activity/templates/current_user.rb
 - lib/generators/loggable_activity/templates/helpers/loggable_activity_helper.rb
-- lib/generators/loggable_activity/templates/loggable_activity.en.yml
+- lib/generators/loggable_activity/templates/loggable_activity.en.yaml
 - lib/generators/loggable_activity/templates/loggable_activity_helper.rb
 - lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.erb
 - lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.slim

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class CreateLoggableEncryptionKeys < ActiveRecord::Migration[6.1]
-  def change
-    create_table :loggable_encryption_keys do |t|
-      t.references :parent_key, foreign_key: { to_table: 'loggable_encryption_keys', on_delete: :nullify }
-      t.string :key
-      t.references :record, polymorphic: true, on_delete: :nullify
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-class CreateLoggablePayloads < ActiveRecord::Migration[6.1]
-  def change
-    create_table :loggable_payloads do |t|
-      t.references :record, polymorphic: true, null: true
-      t.json :encrypted_attrs
-      t.integer :payload_type, default: 0
-      t.boolean :data_owner, default: false
-      t.references :activity, foreign_key: { to_table: 'loggable_activities', class_name: 'LoggableActivity::Activity' }
-
-      t.timestamps
-    end
-  end
-end