loggable_activity 0.2.1 → 0.5.0

data/lib/generators/loggable_activity/install_generator.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_record'
-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 data_owner].freeze
-      TIME = Time.now
-
-      def install
-        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
-          template "binary_ids/#{migration_file_name}", destination
-        else
-          template migration_file_name, destination
-        end
-      end
-
-      def create_translation_file
-        copy_file 'config/locales/loggable_activity.en.yml', 'config/locales/loggable_activity.en.yml'
-      end
-
-      def create_config_file
-        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
-            ::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
-
-          ------------------------------------------------
-        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
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-# 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 :actor_display_name
-      t.string :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 :activity, foreign_key: { to_table: 'loggable_activities', class_name: '::LoggableActivity::Activity' }, type: :uuid
-      t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_encryption_keys', class_name: '::LoggableActivity::EncryptionKey' }, type: :uuid
-      t.references :record, polymorphic: true, null: true, type: :uuid
-      t.json :encrypted_attrs
-      t.integer :related_to_activity_as, default: 0
-      t.string :route
-    end
-
-    create_table :loggable_encryption_keys, id: :uuid, default: 'gen_random_uuid()' do |t|
-      t.string :secret_key
-      # t.references :parent_key, foreign_key: { to_table: 'loggable_encryption_keys', type: :uuid }
-      # t.references :record, polymorphic: true, type: :uuid
-    end
-  end
-end

data/lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml

@@ -1,36 +0,0 @@
-en:
-  loggable:
-    activity:
-      deleted: "***** DELETED *****"
-      demo/address:
-        update: An address was updated
-        create: An address was created
-        show: An address was shown
-        destroy: An address was deleted
-      demo/club:
-        update: A club was updated
-        create: A club was created
-        show: A club was shown
-        destroy: A club was deleted
-      demo/journal:
-        update: A journal was updated
-        create: A journal was created
-        show: A journal was shown
-        destroy: A journal was deleted
-      demo/product:
-        update: A product was updated
-        create: A product was created
-        show: A product was shown
-        destroy: A product was deleted
-      user:
-        update: A user was updated
-        create: A user was created
-        show: "A user was shown"
-        destroy: A user was deleted
-      models:
-        Demo::Address: Address
-        Demo::UserProfile: Profile
-        Demo::Club: Club
-        Demo::Journal: Journal
-        Demo/Product: Product
-        User: User

data/lib/generators/loggable_activity/templates/config/loggable_activity.yaml

@@ -1,29 +0,0 @@
-# User: 
-#   record_display_name: full_name
-#   loggable_attrs: 
-#     - first_name
-#     - last_name 
-#     - age 
-#     - email
-#     - user_type 
-#   auto_log:
-#     - create
-#     - update
-#     - destroy
-#   relations:
-#     - has_one: :demo_user_profile
-#       model: Demo::UserProfile 
-#       loggable_attrs:
-#         - sex
-#         - religion
-#     - belongs_to: :demo_address
-#       model: Demo::Address
-#       loggable_attrs:
-#         - street
-#         - city
-#         - country
-#         - postal_code
-#     - belongs_to: :demo_club
-#       model: Demo::Club
-#       loggable_attrs:
-#         - name

data/lib/generators/loggable_activity/templates/loggable_activity.en.yaml

@@ -1,36 +0,0 @@
-en:
-  loggable:
-    activity:
-      deleted: "***** DELETED *****"
-      demo/address:
-        update: An address was updated
-        create: An address was created
-        show: An address was shown
-        destroy: An address was deleted
-      demo/club:
-        update: A club was updated
-        create: A club was created
-        show: A club was shown
-        destroy: A club was deleted
-      demo/journal:
-        update: A journal was updated
-        create: A journal was created
-        show: A journal was shown
-        destroy: A journal was deleted
-      demo/product:
-        update: A product was updated
-        create: A product was created
-        show: A product was shown
-        destroy: A product was deleted
-      user:
-        update: A user was updated
-        create: A user was created
-        show: "A user was shown"
-        destroy: A user was deleted
-      models:
-        Demo::Address: Address
-        Demo::UserProfile: Profile
-        Demo::Club: Club
-        Demo::Journal: Journal
-        Demo/Product: Product
-        User: User

data/sig/loggable_activity.rbs

@@ -1,4 +0,0 @@
-module LoggableActivity
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end