loggable_activity 0.2.1 → 0.5.0

data/git-org/hooks/push-to-checkout.sample

@@ -0,0 +1,78 @@
+#!/bin/sh
+
+# An example hook script to update a checked-out tree on a git push.
+#
+# This hook is invoked by git-receive-pack(1) when it reacts to git
+# push and updates reference(s) in its repository, and when the push
+# tries to update the branch that is currently checked out and the
+# receive.denyCurrentBranch configuration variable is set to
+# updateInstead.
+#
+# By default, such a push is refused if the working tree and the index
+# of the remote repository has any difference from the currently
+# checked out commit; when both the working tree and the index match
+# the current commit, they are updated to match the newly pushed tip
+# of the branch. This hook is to be used to override the default
+# behaviour; however the code below reimplements the default behaviour
+# as a starting point for convenient modification.
+#
+# The hook receives the commit with which the tip of the current
+# branch is going to be updated:
+commit=$1
+
+# It can exit with a non-zero status to refuse the push (when it does
+# so, it must not modify the index or the working tree).
+die () {
+	echo >&2 "$*"
+	exit 1
+}
+
+# Or it can make any necessary changes to the working tree and to the
+# index to bring them to the desired state when the tip of the current
+# branch is updated to the new commit, and exit with a zero status.
+#
+# For example, the hook can simply run git read-tree -u -m HEAD "$1"
+# in order to emulate git fetch that is run in the reverse direction
+# with git push, as the two-tree form of git read-tree -u -m is
+# essentially the same as git switch or git checkout that switches
+# branches while keeping the local changes in the working tree that do
+# not interfere with the difference between the branches.
+
+# The below is a more-or-less exact translation to shell of the C code
+# for the default behaviour for git's push-to-checkout hook defined in
+# the push_to_deploy() function in builtin/receive-pack.c.
+#
+# Note that the hook will be executed from the repository directory,
+# not from the working tree, so if you want to perform operations on
+# the working tree, you will have to adapt your code accordingly, e.g.
+# by adding "cd .." or using relative paths.
+
+if ! git update-index -q --ignore-submodules --refresh
+then
+	die "Up-to-date check failed"
+fi
+
+if ! git diff-files --quiet --ignore-submodules --
+then
+	die "Working directory has unstaged changes"
+fi
+
+# This is a rough translation of:
+#
+#   head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX
+if git cat-file -e HEAD 2>/dev/null
+then
+	head=HEAD
+else
+	head=$(git hash-object -t tree --stdin </dev/null)
+fi
+
+if ! git diff-index --quiet --cached --ignore-submodules $head --
+then
+	die "Working directory has staged changes"
+fi
+
+if ! git read-tree -u -m "$commit"
+then
+	die "Could not update working tree to new HEAD"
+fi

data/git-org/hooks/update.sample

@@ -0,0 +1,128 @@
+#!/bin/sh
+#
+# An example hook script to block unannotated tags from entering.
+# Called by "git receive-pack" with arguments: refname sha1-old sha1-new
+#
+# To enable this hook, rename this file to "update".
+#
+# Config
+# ------
+# hooks.allowunannotated
+#   This boolean sets whether unannotated tags will be allowed into the
+#   repository.  By default they won't be.
+# hooks.allowdeletetag
+#   This boolean sets whether deleting tags will be allowed in the
+#   repository.  By default they won't be.
+# hooks.allowmodifytag
+#   This boolean sets whether a tag may be modified after creation. By default
+#   it won't be.
+# hooks.allowdeletebranch
+#   This boolean sets whether deleting branches will be allowed in the
+#   repository.  By default they won't be.
+# hooks.denycreatebranch
+#   This boolean sets whether remotely creating branches will be denied
+#   in the repository.  By default this is allowed.
+#
+
+# --- Command line
+refname="$1"
+oldrev="$2"
+newrev="$3"
+
+# --- Safety check
+if [ -z "$GIT_DIR" ]; then
+	echo "Don't run this script from the command line." >&2
+	echo " (if you want, you could supply GIT_DIR then run" >&2
+	echo "  $0 <ref> <oldrev> <newrev>)" >&2
+	exit 1
+fi
+
+if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
+	echo "usage: $0 <ref> <oldrev> <newrev>" >&2
+	exit 1
+fi
+
+# --- Config
+allowunannotated=$(git config --type=bool hooks.allowunannotated)
+allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch)
+denycreatebranch=$(git config --type=bool hooks.denycreatebranch)
+allowdeletetag=$(git config --type=bool hooks.allowdeletetag)
+allowmodifytag=$(git config --type=bool hooks.allowmodifytag)
+
+# check for no description
+projectdesc=$(sed -e '1q' "$GIT_DIR/description")
+case "$projectdesc" in
+"Unnamed repository"* | "")
+	echo "*** Project description file hasn't been set" >&2
+	exit 1
+	;;
+esac
+
+# --- Check types
+# if $newrev is 0000...0000, it's a commit to delete a ref.
+zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
+if [ "$newrev" = "$zero" ]; then
+	newrev_type=delete
+else
+	newrev_type=$(git cat-file -t $newrev)
+fi
+
+case "$refname","$newrev_type" in
+	refs/tags/*,commit)
+		# un-annotated tag
+		short_refname=${refname##refs/tags/}
+		if [ "$allowunannotated" != "true" ]; then
+			echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
+			echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,delete)
+		# delete tag
+		if [ "$allowdeletetag" != "true" ]; then
+			echo "*** Deleting a tag is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,tag)
+		# annotated tag
+		if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
+		then
+			echo "*** Tag '$refname' already exists." >&2
+			echo "*** Modifying a tag is not allowed in this repository." >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,commit)
+		# branch
+		if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
+			echo "*** Creating a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,delete)
+		# delete branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/remotes/*,commit)
+		# tracking branch
+		;;
+	refs/remotes/*,delete)
+		# delete tracking branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a tracking branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	*)
+		# Anything else (is there anything else?)
+		echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
+		exit 1
+		;;
+esac
+
+# --- Finished
+exit 0

data/git-org/info/exclude

@@ -0,0 +1,6 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

data/lib/loggable_activity/activity.rb

@@ -5,7 +5,6 @@ require 'active_record'
 module LoggableActivity
   # Represents one action in the activity log.
   class Activity < ActiveRecord::Base
-    self.table_name = 'loggable_activities'
     # Associations
     has_many :payloads, class_name: '::LoggableActivity::Payload', dependent: :destroy
     belongs_to :actor, polymorphic: true, optional: true
@@ -33,7 +32,7 @@ module LoggableActivity
       'belongs_to_payload' => 'belongs_to',
       'belongs_to_destroy_payload' => 'belongs_to',
       'belongs_to_update_payload' => 'belongs_to'
-    }
+    }.freeze
 
     # 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.
     #
@@ -72,7 +71,8 @@ module LoggableActivity
           route: payload.payload_route,
           record_display_name: payload.record_display_name,
           current_payload: payload.current_payload,
-          data_owner: payload.data_owner
+          data_owner: payload.data_owner,
+          public_attrs: payload.public_attrs
         }
       end
     end

data/lib/{schemas → loggable_activity}/config_schema.json

@@ -5,7 +5,7 @@
     "current_user_model_name": {
       "type": "string"
     },
-    "fetch_current_user_name_from": {
+    "current_user_name": {
       "type": "string"
     },
     "task_for_sanitization": {
@@ -13,7 +13,7 @@
     }
   },
   "patternProperties": {
-    "^(?!current_user_model_name$|fetch_current_user_name_from$|task_for_sanitization)[A-Za-z0-9_:]+$": {
+    "^(?!current_user_model_name$|current_user_name$|task_for_sanitization)[A-Za-z0-9_:]+$": {
       "type": "object",
       "properties": {
         "data_owner": {
@@ -91,6 +91,6 @@
   "additionalProperties": false,
   "required": [
     "current_user_model_name",
-    "fetch_current_user_name_from"
+    "current_user_name"
   ]
 }

data/lib/loggable_activity/configuration.rb

@@ -2,94 +2,70 @@
 
 require 'json-schema'
 require 'json'
-require 'awesome_print'
 
 module LoggableActivity
-  # This class is used to load the configuration file located at config/loggable_activity.yml
-  class ConfigurationError < StandardError
-    def initialize(msg = '')
-      # https://api.loggable_activity.com/msg
-      puts '---------------- LOGGABLE ACTIVITY -----------------'
-      puts msg
-      puts '----------------------------------------------------'
-      super(msg)
-    end
-  end
-
   # This class is used to load the configuration file located at config/loggable_activity.yml
   # When the LoggableActivity::Hook is included in a model
   # it takes the model's name and find the configuration for that model in the configuration file.
   class Configuration
-    # Loads the configuration file
-    def self.load_config_file(config_file_path)
-      @config_data = YAML.load_file(config_file_path)
-      validate_config_file
-    rescue Errno::ENOENT
-      raise ConfigurationError, 'config/loggable_activity.yaml not found'
-    end
-
-    # Loads the schema file for the configuration file
-    def self.load_schema
-      schema_path = File.join(__dir__, '..', 'schemas', 'config_schema.json')
-      JSON.parse(File.read(schema_path))
-    end
-
-    # Validates the configuration file againss the schema
-    def self.validate_config_file
-      schema = load_schema
-      errors = JSON::Validator.fully_validate(schema, @config_data)
-      return unless errors.any?
+    class << self
+      # Loads the schema file for the configuration file
+      def load_schema
+        schema_path = File.join(__dir__, 'config_schema.json')
+        JSON.parse(File.read(schema_path))
+      end
 
-      raise ConfigurationError,
-            "config/loggable_activity.yaml is invalid: #{errors.join(', ')}"
-    end
+      # Loads the configuration file, and store it as a hash
+      def config_data
+        @config_data ||= YAML.load_file(LoggableActivity.config_file_path)
+      end
 
-    # Returns true if the configuration file has been loaded
-    def self.loaded?
-      !@config_data.nil?
-    end
+      # Validates the configuration file againss the schema
+      def validate_config_file
+        schema = load_schema
+        errors = JSON::Validator.fully_validate(schema, config_data)
+        return true unless errors.any?
 
-    # Returns the configuration data
-    class << self
-      # @return [Hash]
-      attr_reader :config_data
-    end
+        raise ConfigurationError,
+              "config/loggable_activity.yaml is invalid: #{errors.join(', ')}"
+      end
 
-    # Returns the configuration data for the given class
-    #
-    # Example:
-    #   ::LoggableActivity::Configuration.for_class('User')
-    # Returns:
-    #   {
-    #     "fetch_record_name_from": "full_name",
-    #     "loggable_attrs": [
-    #       "first_name",
-    #       "last_name",
-    #     ],
-    #     "auto_log": [
-    #       "create",
-    #       "update",
-    #       "destroy"
-    #     ],
-    #   ....
-    #   }
-    def self.for_class(class_name)
-      @config_data[class_name]
-    end
+      # Returns the configuration data for the given class
+      #
+      # Example:
+      #   ::LoggableActivity::Configuration.for_class('User')
+      # Returns:
+      #   {
+      #     "fetch_record_name_from": "full_name",
+      #     "loggable_attrs": [
+      #       "first_name",
+      #       "last_name",
+      #     ],
+      #     "auto_log": [
+      #       "create",
+      #       "update",
+      #       "destroy"
+      #     ],
+      #   ....
+      #   }
+      def for_class(class_name)
+        config_data[class_name]
+      end
 
-    # Returns the name of the field or method to use for the actor's display name.
-    def self.fetch_current_user_name_from
-      @config_data['fetch_current_user_name_from']
-    end
+      # Returns the name of the field or method to use for the actor's display name.
+      def current_user_name
+        config_data['current_user_name']
+      end
 
-    # Returns the name of the model to use for the current user.
-    def self.current_user_model_name
-      @config_data['current_user_model_name']
-    end
+      # Returns the name of the model to use for the current user.
+      def current_user_model_name
+        config_data['current_user_model_name']
+      end
 
-    # Returns whatever models should be sanitized on delete.
-    def self.task_for_sanitization
-      @config_data['task_for_sanitization']
+      # Returns whatever models should be sanitized on delete.
+      def task_for_sanitization
+        config_data['task_for_sanitization']
+      end
     end
   end
 end

data/lib/loggable_activity/data_owner.rb

@@ -6,7 +6,6 @@ module LoggableActivity
   # This class represends an additional data owner for a record.
   # For it to kick in, the data_owner configuration has to be set to true in the loggable_activity.yaml file.
   class DataOwner < ActiveRecord::Base
-    self.table_name = 'loggable_data_owners'
     belongs_to :record, polymorphic: true, optional: true
     belongs_to :encryption_key, class_name: '::LoggableActivity::EncryptionKey'
 

data/lib/loggable_activity/encryption.rb

@@ -20,7 +20,10 @@ module LoggableActivity
       return nil if data.nil?
 
       encryption_key = Base64.decode64(secret_key)
-      raise EncryptionError, "Encryption failed: Invalid encoded_key length #{encryption_key.bytesize}" unless encryption_key.bytesize == 32
+      unless encryption_key.bytesize == 32
+        raise EncryptionError,
+              "Encryption failed: Invalid encoded_key length #{encryption_key.bytesize}"
+      end
 
       cipher = OpenSSL::Cipher.new('AES-256-CBC').encrypt
       cipher.key = encryption_key
@@ -42,11 +45,14 @@ module LoggableActivity
     #   "my secret data"
     #
     def self.decrypt(data, secret_key)
-      return I18n.t('loggable.activity.deleted') if secret_key.nil?
+      return I18n.t('loggable_activity.activity.deleted') if secret_key.nil?
       return '' if data.blank?
 
       encryption_key = Base64.decode64(secret_key)
-      raise EncryptionError, "Decryption failed: Invalid encoded_key length: #{encryption_key.bytesize}" unless encryption_key.bytesize == 32
+      unless encryption_key.bytesize == 32
+        raise EncryptionError,
+              "Decryption failed: Invalid encoded_key length: #{encryption_key.bytesize}"
+      end
 
       cipher = OpenSSL::Cipher.new('AES-256-CBC').decrypt
       cipher.key = encryption_key
@@ -58,11 +64,14 @@ module LoggableActivity
 
       decrypted_data.force_encoding('UTF-8')
     rescue OpenSSL::Cipher::CipherError => e
-      puts "CipherError Decryption failed: #{e.message}"
-      '*** DECRYPTION FAILED ***'
+      Rails.logger.error "CipherError Decryption failed: #{e.message}"
+      I18n.t('loggable_activity.decryption.failed')
     rescue EncryptionError => e
-      puts "EncryptionError failed: #{e.message}"
-      '*** DECRYPTION FAILED ***'
+      Rails.logger.error "EncryptionError: #{e.message}"
+      I18n.t('loggable_activity.decryption.failed')
+    rescue ArgumentError => e
+      Rails.logger.error "ArgumentError Decryption failed: #{e.message}"
+      I18n.t('loggable_activity.decryption.failed')
     end
 
     # Returns true if the given value is blank

data/lib/loggable_activity/encryption_key.rb

@@ -6,15 +6,13 @@ module LoggableActivity
   # This class represents the encryption key used to unlock the data for one payload.
   # When deleted, only the encryption_key field is deleted.
   class EncryptionKey < ActiveRecord::Base
-    self.table_name = 'loggable_encryption_keys'
-
     # Associations
     belongs_to :record, polymorphic: true, optional: true
     # belongs_to :payload, class_name: '::LoggableActivity::Payload', optional: true
     # belongs_to :parent_key, class_name: '::LoggableActivity::EncryptionKey', optional: true,
     # foreign_key: 'parent_key_id'
 
-    # Prepare the record for deletion 
+    # Prepare the record for deletion
     def mark_as_deleted!
       LoggableActivity::Configuration.task_for_sanitization ? update(delete_at: DateTime.now + 1.month) : delete
     end
@@ -25,17 +23,16 @@ module LoggableActivity
     end
 
     # Delete the encryption key by updating the key to nil.
+    # Nullify the delete_at field, so the key is not deleted when the sanitization task runs.
     def delete
-      update(secret_key: nil, delete_at: nil) 
+      update(secret_key: nil, delete_at: nil)
     end
 
     # Restores the encryption key by updating the delete_at field to nil.
     def restore!
-      update(delete_at: nil) if delete_at &&  DateTime.now < delete_at
+      update(delete_at: nil) if delete_at && DateTime.now < delete_at
     end
 
-
-
     # Returns an encryption key for a record by its type and ID, optionally using a parent key.
     #
     #  @param record_type [String] The type of the record.

data/lib/loggable_activity/engine.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  # Engine
+  #
+  # This module defines the LoggableActivity engine for use within a Rails application.
+  # It leverages Rails::Engine to create an isolated namespace, ensuring that the components
+  # of the LoggableActivity engine (such as models, controllers, and views) do not interfere
+  # with those of the host application or other engines.
+  #
+  # Example Usage:
+  # In a Rails application, you can mount this engine to make its functionality available:
+  #
+  #   mount LoggableActivity::Engine, at: "/loggable_activity"
+  #
+  # This will allow the application to utilize the features provided by the LoggableActivity engine
+  # under the specified mount path.
+  #
+  class Engine < ::Rails::Engine
+    isolate_namespace LoggableActivity
+
+    # initializer 'loggable_activity.assets.precompile' do |app|
+    #   app.config.assets.precompile += %w( loggable_activity/application.css )
+    #   app.config.assets.precompile += %w( loggable_activity/bootstrap.css )
+    # end
+  end
+end

data/lib/loggable_activity/error.rb

@@ -4,9 +4,6 @@ module LoggableActivity
   # Error class for loggable activity.
   class Error < StandardError
     def initialize(msg = '')
-      puts '---------------- LOGGABLE ACTIVITY -----------------'
-      puts msg
-      puts '----------------------------------------------------'
       super(msg)
     end
   end
@@ -14,9 +11,6 @@ module LoggableActivity
   # Error class for encryption.
   class EncryptionError < StandardError
     def initialize(msg = '')
-      puts '---------------- LOGGABLE ACTIVITY -----------------'
-      puts msg
-      puts '----------------------------------------------------'
       super(msg)
     end
   end
@@ -24,10 +18,6 @@ module LoggableActivity
   # This class is used to load the configuration file located at config/loggable_activity.yml
   class ConfigurationError < StandardError
     def initialize(msg = '')
-      # https://api.loggable_activity.com/msg
-      puts '---------------- LOGGABLE ACTIVITY -----------------'
-      puts msg
-      puts '----------------------------------------------------'
       super(msg)
     end
   end

data/lib/loggable_activity/hooks.rb

@@ -24,6 +24,7 @@ module LoggableActivity
 
       # Initializes attributes based on configuration.
       self.loggable_attrs = config&.fetch('loggable_attrs', []) || []
+      self.public_attrs = config&.fetch('public_attrs', []) || []
       self.relations = config&.fetch('relations', []) || []
       self.auto_log = config&.fetch('auto_log', []) || []
       self.fetch_record_name_from = config&.fetch('fetch_record_name_from', nil)
@@ -60,6 +61,10 @@ module LoggableActivity
       end
     end
 
+    def disable_hooks!
+      self.disable_hooks = true
+    end
+
     private
 
     # Logs an activity for the current action.
@@ -134,6 +139,7 @@ module LoggableActivity
     # Logs a create activity automatically if configured.
     def log_create_activity
       return unless hooks_enabled?
+      return if id.nil?
 
       log(:create) if self.class.auto_log.include?('create')
     end
@@ -159,13 +165,13 @@ module LoggableActivity
 
     # Returns the encrypted name of the actor.
     def encrypted_actor_name
-      name = @actor.send(fetch_current_user_name_from)
+      name = @actor.send(current_user_name)
       ::LoggableActivity::Encryption.encrypt(name, actor_secret_key)
     end
 
     # Reads the field to feetch the record name from.
-    def fetch_current_user_name_from
-      ::LoggableActivity::Configuration.fetch_current_user_name_from
+    def current_user_name
+      ::LoggableActivity::Configuration.current_user_name
     end
 
     # Returns the action key for the current action.
@@ -200,13 +206,12 @@ module LoggableActivity
 
     class_methods do
       # The loggable_attrs attribute is used read the configuration for the model that included LoggableActivity::Hooks.
-      attr_accessor :loggable_attrs, :relations, :auto_log, :fetch_record_name_from, :route
+      attr_accessor :loggable_attrs, :relations, :auto_log, :fetch_record_name_from, :route, :public_attrs
 
       # Convert the model name and name space in to 'base_action'.
       def base_action
         name.downcase.gsub('::', '/')
       end
-
     end
   end
 end