logga 6.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a816cf8594e1bc18bba798c03ce28d73c05210cf396951f7f6850493deaf5029
-  data.tar.gz: 20e9e662498165522363f68a03cc51908ba58d62762e766eecb17468acb2084f
+  metadata.gz: a7b492a4ed4bdf31b51aa0c37a16e30e8f5d3aa2a3251e94c4ab34ee37c6e830
+  data.tar.gz: 38c9bb8054121cd8c8d300621ac253f96080765a3d2d1eec5332f8af07d806b9
 SHA512:
-  metadata.gz: f6a639733d7e1674246a118d76f28a33193a664fa3b6c7d13c2a9970b286e2da97862c7c42a752ffce76c186d862759b4a6428f3c2587d66fa42e4e63b74ff0b
-  data.tar.gz: 0b581d6df25fa0857fa82da1a2c335f24895b0e1d67bf1b946d700caa22d70fd87f8d709f14b3d9c3e2d00efc8e5e165a6e05c317c3564a963c2858561f11047
+  metadata.gz: a458eb5d44c828e9021d3e6ff065862291d56a2111fe724d231a1fc670df180296fa0439800586007534bf58ede9f312664b100e7855fb522a325dd0e2976516
+  data.tar.gz: 731f4d712c9d5eccf03ff86fe3e98927015478ac93fbe5eb0a48b8ff84f455b83d42f66b1a9d1794ef5b72ee88e795d8b6aa28fa6794d52357080354b678aafd

data/README.md

@@ -79,7 +79,7 @@ add_log_entries_for(
 )
 ```
 
-This is with the exeception on `:created_at` which only takes the created record.
+This is with the exception on `:created_at` which only takes the created record.
 
 ```ruby
 add_log_entries_for(
@@ -113,6 +113,29 @@ Logga.configure do |config|
 end
 ```
 
+## Class Name
+
+Logga automatically figures out class names and construct a sensible log line if you have not provided one. It `.demodulize` and `.titelize` the model class name to come up with the log line.
+
+However in some cases, it may be desirable to override the default name. To support such cases, you can pass in class_name param:
+
+```ruby
+  add_log_entries_for(
+    :create, # Log on object create
+    :update, # Log on object update
+    class_name: "My Class"
+  )
+```
+
+This will result in log lines like following:
+
+```ruby
+my_model.update(active: true)
+
+# will result in log entry as follows:
+# "My Class active set to true"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec appraisal rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -8,5 +8,4 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = Dir.glob("spec/**/*_spec.rb")
 end
 
-desc "Map rake test to rake spec"
-task test: :spec
+task default: :appraisal if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]

data/VERSION

@@ -1 +1 @@
-6.0.0
+7.1.0

data/lib/logga/active_record.rb

@@ -5,25 +5,38 @@ module Logga
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :allowed_fields, instance_writer: false
-      class_attribute :excluded_fields, instance_writer: false
-      class_attribute :fields, instance_writer: false
-
-      self.allowed_fields = []
-      self.excluded_fields = []
-      self.fields = {}
+      class_attribute :logga_options, instance_writer: false
     end
 
     class_methods do
-      def add_log_entries_for(*actions, allowed_fields: [], exclude_fields: [], fields: {}, to: :self)
+      def add_log_entries_for(*actions, **options)
+        configure_logga_options(options)
+        setup_logga_callbacks(actions)
+        define_logga_receiver_method
+      end
+
+      def configure_logga_options(options)
+        default_logga_options = {
+          allowed_fields: [],
+          excluded_fields: [],
+          fields: {},
+          class_name: nil,
+          to: :itself
+        }
+        self.logga_options = default_logga_options.merge(options.slice(:allowed_fields, :fields, :class_name, :to))
+        return if options[:allowed_fields].present?
+
+        self.logga_options = logga_options.merge(excluded_fields: options[:exclude_fields] || [])
+      end
+
+      def setup_logga_callbacks(actions)
         after_create :log_model_creation if actions.include?(:create)
         after_destroy :log_model_deletion if actions.include?(:delete)
         after_update :log_model_changes if actions.include?(:update)
-        define_method(:log_receiver) { to == :self ? self : send(to) }
+      end
 
-        self.allowed_fields = Array(allowed_fields)
-        self.excluded_fields = allowed_fields.blank? ? Array(exclude_fields) : []
-        self.fields = fields
+      def define_logga_receiver_method
+        define_method(:log_receiver) { send(logga_options[:to]) }
       end
     end
 
@@ -33,23 +46,23 @@ module Logga
       body = field_changes_to_message(changes)
       return if body.blank?
 
-      create_log_entry(author_data.merge(body: body))
+      create_log_entry(author_data.merge(body:))
     end
 
     def log_model_creation
       return unless should_log?
 
       body_generator = ->(record) { default_creation_log_body(record) }
-      body = fields.fetch(:created_at, body_generator).call(self)
-      create_log_entry(author_data.merge(body: body, created_at: creation_at))
+      body = logga_options[:fields].fetch(:created_at, body_generator).call(self)
+      create_log_entry(author_data.merge(body:, created_at: creation_at))
     end
 
     def log_model_deletion
       return unless should_log?
 
       body_generator = ->(record) { default_deletion_log_body(record) }
-      body = fields.fetch(:deleted_at, body_generator).call(self)
-      create_log_entry(author_data.merge(body: body))
+      body = logga_options[:fields].fetch(:deleted_at, body_generator).call(self)
+      create_log_entry(author_data.merge(body:))
     end
 
     def log_model_changes
@@ -109,18 +122,22 @@ module Logga
         default_change_log_body(record, field, old_value, new_value)
       }
       changes.inject([]) do |result, (field, (old_value, new_value))|
-        result << fields.fetch(field.to_sym, body_generator).call(self, field, old_value, new_value)
+        result << logga_options[:fields].fetch(field.to_sym, body_generator).call(self, field, old_value, new_value)
       end.compact.join("\n")
     end
 
     def reject_change?(key)
       sym_key = key.to_sym
-      return allowed_fields.exclude?(sym_key) if allowed_fields.present?
+      return logga_options[:allowed_fields].exclude?(sym_key) if logga_options[:allowed_fields].present?
+
+      excluded_change?(key, sym_key)
+    end
 
+    def excluded_change?(key, sym_key)
       config_excluded_fields.include?(sym_key) ||
-        (fields.exclude?(sym_key) &&
-         (excluded_fields.include?(sym_key) ||
-          config_excluded_suffixes.any? { |suffix| key.to_s.end_with?(suffix.to_s) }))
+        (logga_options[:fields].exclude?(sym_key) &&
+          (logga_options[:excluded_fields].include?(sym_key) ||
+             config_excluded_suffixes.any? { |suffix| key.to_s.end_with?(suffix.to_s) }))
     end
 
     def should_log?
@@ -128,7 +145,7 @@ module Logga
     end
 
     def titleized_model_class_name(record)
-      record.class.name.demodulize.titleize
+      logga_options[:class_name] || record.class.name.demodulize.titleize
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logga
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Boxt
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -36,7 +35,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -46,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -70,7 +69,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,15 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: ActiveRecord log entries on model changes
 test_files: []