logga 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e701347d79260bff1bb8db40f220512a456720b66efa246de76dac9a9790bac2
-  data.tar.gz: a8b56e341270752b63f5d1195232e0ac90972d3e66bf0368561b0775ea45e99d
+  metadata.gz: 175040125db02fd1bda317f34c45ea3bd45d003f07270c7e4f6942653a39967b
+  data.tar.gz: 737bfad69f886d068d83b99f8a574ffb52e18d6aeb8fa93e9efe9605e652918e
 SHA512:
-  metadata.gz: 4991d4f6fb02cb56c5f3b952416fb2c58209eae7a84d65d8db9147b797cab1c40af9123d1be4e70a4b59a9d5a46247f7a1a913695558bf9d7641e76b1fcc38c0
-  data.tar.gz: ccdd5e59e29546563dc5cbba93796682dcdb07286aa91da7974d544daa41a3d43724b93d749d41b7dd5e957240f08f0b9ca062e74e22242d4c22e727dc34e799
+  metadata.gz: 3f93d4828418904ef7fddf845ac09268e9d2f3cf20b3f56c617df107d7026f6840be34d08723d039cde0f4551f9b9d8bc6b6a8e76dc5c3e20e446784f33a1199
+  data.tar.gz: 128d151bd2e65cb28fc0d2ab42b7baf58ec0518e52cadf439b0175478abd7740cbae0bb1c9ed1b6d60b86ab131e87eb056c34c76828fd650433b36ef813e0a1a

data/README.md

@@ -2,7 +2,9 @@
 
 Provides attribute logging functionality to ActiveRecord objects.
 
-[![CircleCI](https://circleci.com/gh/boxt/logga/tree/master.svg?style=svg&circle-token=f9550ac25744c292e3680638bad3d5deafb1c4e1)](https://circleci.com/gh/boxt/logga/tree/master)
+## Requirements
+
+Requires Ruby 2.7.3 or above
 
 ## Installation
 
@@ -59,3 +61,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 - Write some tests
 - Improve the documentation
+- Remove explicit `EXCLUDED_KEYS` and `EXCLUDED_SUFFIXES` for something that can be set in an initializer

data/VERSION

@@ -1 +1 @@
-2.1.2
+2.2.0

data/lib/logga/active_record.rb

@@ -5,24 +5,28 @@ module Logga
     extend ActiveSupport::Concern
 
     EXCLUDED_KEYS = %i[id created_at deleted_at initial updated_at log sent_after_sales_emails].freeze
-    EXCLUDED_KEYS_SUFFIXES = %i[_id _filenames].freeze
+    EXCLUDED_SUFFIXES = %i[_id _filenames].freeze
 
     included do
-      class_attribute :log_fields, instance_writer: false
+      class_attribute :allowed_fields, instance_writer: false
       class_attribute :excluded_fields, instance_writer: false
+      class_attribute :log_fields, instance_writer: false
+
+      self.allowed_fields = []
+      self.excluded_fields = []
       self.log_fields = {}
-      self.excluded_fields = {}
     end
 
     class_methods do
-      def add_log_entries_for(*actions, to: :self, fields: {}, exclude_fields: [])
-        after_create  :log_model_creation if actions.include?(:create)
+      def add_log_entries_for(*actions, to: :self, fields: {}, allowed_fields: [], exclude_fields: [])
+        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)
+        after_update :log_model_changes if actions.include?(:update)
         define_method(:log_receiver) { to == :self ? self : send(to) }
 
+        self.allowed_fields = Array(allowed_fields)
+        self.excluded_fields = allowed_fields.blank? ? Array(exclude_fields) : []
         self.log_fields = fields
-        self.excluded_fields = Array(exclude_fields)
       end
     end
 
@@ -105,10 +109,13 @@ module Logga
     end
 
     def reject_change?(key)
-      EXCLUDED_KEYS.include?(key.to_sym) ||
-        (!log_fields.include?(key.to_sym) &&
-         (excluded_fields.include?(key.to_sym) ||
-          EXCLUDED_KEYS_SUFFIXES.any? { |suffix| key.to_s.end_with?(suffix.to_s) }))
+      sym_key = key.to_sym
+      return allowed_fields.exclude?(sym_key) if allowed_fields.present?
+
+      EXCLUDED_KEYS.include?(sym_key) ||
+        (log_fields.exclude?(sym_key) &&
+         (excluded_fields.include?(sym_key) ||
+          EXCLUDED_SUFFIXES.any? { |suffix| key.to_s.end_with?(suffix.to_s) }))
     end
 
     def should_not_log?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logga
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,104 +50,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: boxt_ruby_style_guide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 7.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 7.2.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rspec-nc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
 description: Extensions to ActiveRecord to log entries on model changes
 email:
 - developers@boxt.co.uk
@@ -174,14 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: ActiveRecord log entries on model changes