operator_recordable 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab283fd134cf058f9e80fd77978564891460512b16d25dcad77f36ce07675b6c
-  data.tar.gz: fbfd74ee91030399f4637ab535ce38b7163b377a69cc9797b5261a211ee96b93
+  metadata.gz: 17d5261fe9e0dde7d722753e707a2a5210bc183866be7d9509b6670e2187e432
+  data.tar.gz: 7c569a64a127e3b293ac7d5ed66ba0762774163ef7395d16acd49bd7e30bba85
 SHA512:
-  metadata.gz: d8777d0962188046f0cc556f1a9d399117d6a695b6f5b6e46d96b1cad036dd8de274cc6da2421788046e6dbe7fc5fde56169e75162767f77b3f513b75b1f8e58
-  data.tar.gz: 052113312da2cacdd349e15c47b2c993baeb05c4b7f40f1b06f5cf83e8864015594dd54bffe75dea1946c18a5e4dd3d780f1695b0fe15809a40f60dd5fddb920
+  metadata.gz: 6e5d5deec10df7399288037211bf9de8d53ec2b21b4763818e74759de35e84704ee8857945d2afc603fe156aa9bdd541f364e74d871643665dc96adaa8cb8cae
+  data.tar.gz: 6d9ea5667096bd04be4705fc97fe0beccd34aa5d37b1925ede9c7868bd6558a1812db6b798ce1b871505b7461b954fee356bd9cc810a42d2e05ffac3385002ad

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
     - gemfiles/**/*
   TargetRubyVersion: 2.5
+  NewCops: enable
 
 Style/AsciiComments:
   Enabled: false
@@ -23,6 +24,10 @@ Layout/EndOfLine:
 Layout/LineLength:
   Max: 128
 
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*

data/CHANGELOG.md

@@ -1,12 +1,48 @@
 ## Unreleased
 
 
+## 1.4.0 (2022-08-18)
+
+### Changes
+
+* Deprecate `:thread_store`
+  + [PR#36](https://github.com/yujideveloper/operator_recordable/pull/36)
+
+### Misc
+
+* Change the default branch from master to main
+  + [PR#35](https://github.com/yujideveloper/operator_recordable/pull/35)
+
+
+## 1.3.1 (2022-06-20)
+
+### Bug fixes
+
+* Fix recording discarded_by if the target table uses optimistic lock
+  + [PR#34](https://github.com/yujideveloper/operator_recordable/pull/34)
+
+
+## 1.3.0 (2022-06-01)
+
+### Changes
+
+* Support discard gem for soft deletes
+  + [PR#31](https://github.com/yujideveloper/operator_recordable/pull/31)
+* Get rid of needless guard clauses for ActiveSupport 5.1 and older
+  + [PR#32](https://github.com/yujideveloper/operator_recordable/pull/32)
+
+### Misc
+
+* Fix RuboCop offenses
+  + [PR#33](https://github.com/yujideveloper/operator_recordable/pull/33)
+
+
 ## 1.2.0 (2022-04-26)
 
 ### Changes
 
 * Make associations optional
-  + [PR#28](https://github.com/yujideveloper/operator_recordable/pull/25)
+  + [PR#28](https://github.com/yujideveloper/operator_recordable/pull/28)
 
 ### Misc
 

data/README.md

@@ -7,6 +7,8 @@
 OperatorRecordable is a Rails plugin gem that makes your ActiveRecord models to be saved or logically deleted with automatically set `created_by`, `updated_by`, and `deleted_by`.
 Also it makes `creator`, `updater`, and `deleter` `belongs_to` association if a class has `created_by`, `updated_by`, or `deleted_by`.
 
+It also supports `discarded_by` column if [discard gem](https://github.com/jhawthorn/discard) is available.
+
 This gem is inspired by [RecordWithOperator](https://github.com/nay/record_with_operator).
 
 ## Installation
@@ -38,12 +40,14 @@ OperatorRecordable.config = {
   creator_column_name: "created_by",
   updater_column_name: "updated_by",
   deleter_column_name: "deleted_by",
+  discarder_column_name: "discarded_by",
   creator_association_name: "creator",
   updater_association_name: "updater",
   deleter_association_name: "deleter",
+  discarder_association_name: "discarder",
   operator_association_options: {},
   operator_association_scope: nil,
-  store: :thread_store
+  store: :current_attributes_store
 }
 ```
 
@@ -55,9 +59,11 @@ OperatorRecordable.config = {
 | `creator_column_name` | String | column name of creator. | `"created_by"` |
 | `updater_column_name` | String | column name of updater. | `"updated_by"` |
 | `deleter_column_name` | String | column name of deleter. | `"deleted_by"` |
+| `discarder_column_name` | String | column name of discarder. | `"discarded_by"` |
 | `creator_association_name` | String | association name of creator. | `"creator"` |
 | `updater_association_name` | String | association name of updater. | `"updater"` |
 | `deleter_association_name` | String | association name of deleter. | `"deleter"` |
+| `discarder_association_name` | String | association name of discarder. | `"discarder"` |
 | `operator_association_options` | Hash | options of operator associations. e.g. `{ touch: true }` | `{}` |
 | `operator_association_scope` | Proc | The scope of operator associations. e.g. `-> { with_deleted }`  | `nil` |
 | `store` | Enum | operator store. any value of `:thread_store`, `:request_store` or `:current_attributes_store` | `:thread_store` |
@@ -91,7 +97,7 @@ OperatorRecordable.operator = current_operator
 #### `:thread_store`
 
 This store is implemented by `Thread.current`.  
-This is default store.
+This is default store. **But this is deprecated and will be removed in v2.0. Please consider using `:current_attributes_store` instead.**
 
 
 #### `:request_store`
@@ -119,8 +125,7 @@ require "operator_recordable/store/request_store"
 
 #### `:current_attributes_store`
 
-This store is implemented by using [`ActiveSupport::CurrentAttributes`](https://api.rubyonrails.org/v5.2.0/classes/ActiveSupport/CurrentAttributes.html).  
-So, this requires ActiveSupport 5.2 or later.
+This store is implemented by using [`ActiveSupport::CurrentAttributes`](https://api.rubyonrails.org/v5.2.0/classes/ActiveSupport/CurrentAttributes.html).
 
 
 ## Development

data/lib/operator_recordable/configuration.rb

@@ -11,8 +11,8 @@ module OperatorRecordable
       @store = initialize_store
     end
 
-    %i[operator_class_name creator_column_name updater_column_name deleter_column_name
-       creator_association_name updater_association_name deleter_association_name
+    %i[operator_class_name creator_column_name updater_column_name deleter_column_name discarder_column_name
+       creator_association_name updater_association_name deleter_association_name discarder_association_name
        operator_association_options operator_association_scope].each do |name|
       define_method name do
         config[name]
@@ -37,9 +37,11 @@ module OperatorRecordable
         creator_column_name: "created_by",
         updater_column_name: "updated_by",
         deleter_column_name: "deleted_by",
+        discarder_column_name: "discarded_by",
         creator_association_name: "creator",
         updater_association_name: "updater",
         deleter_association_name: "deleter",
+        discarder_association_name: "discarder",
         operator_association_options: {},
         operator_association_scope: nil,
         store: :thread_store
@@ -53,7 +55,7 @@ module OperatorRecordable
     end
 
     class Model
-      VALID_ACTIONS = %i[create update destroy].freeze
+      VALID_ACTIONS = %i[create update destroy discard].freeze
 
       def initialize(actions)
         @actions = actions
@@ -72,6 +74,10 @@ module OperatorRecordable
         actions.include? :destroy
       end
 
+      def record_discarder?
+        actions.include? :discard
+      end
+
       private
 
       attr_reader :actions

data/lib/operator_recordable/recorder.rb

@@ -31,6 +31,11 @@ module OperatorRecordable
           m.__send__(:run_deleter_dsl, self, config)
           m.__send__(:define_deleter_instance_methods, self, config)
         end
+
+        if c.record_discarder?
+          m.__send__(:run_discarder_dsl, self, config)
+          m.__send__(:define_discarder_instance_methods, self, config)
+        end
       end
     end
 
@@ -49,6 +54,11 @@ module OperatorRecordable
       run_add_association_dsl(:deleter, klass, config)
     end
 
+    def run_discarder_dsl(klass, config)
+      klass.before_discard :"assign_#{config.discarder_association_name}"
+      run_add_association_dsl(:discarder, klass, config)
+    end
+
     def run_add_association_dsl(type, klass, config)
       klass.belongs_to config.association_name_for(type).to_sym,
                        config.operator_association_scope,
@@ -59,37 +69,48 @@ module OperatorRecordable
 
     def define_creator_instance_methods(klass, config)
       klass.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
-        private def assign_#{config.creator_association_name}
-          return unless (op = OperatorRecordable.operator)
-
-          self.#{config.creator_column_name} = op.id
-        end
+        private def assign_#{config.creator_association_name}  # private def assign_creator
+          return unless (op = OperatorRecordable.operator)     #   return unless (op = OperatorRecordable.operator)
+                                                               #
+          self.#{config.creator_column_name} = op.id           #   self.created_by = op.id
+        end                                                    # end
       END_OF_DEF
     end
 
     def define_updater_instance_methods(klass, config)
       klass.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
-        private def assign_#{config.updater_association_name}
-          return if !self.new_record? && !self.changed?
-          return unless (op = OperatorRecordable.operator)
-
-          self.#{config.updater_column_name} = op.id
-        end
+        private def assign_#{config.updater_association_name}  # private def assign_updater
+          return if !self.new_record? && !self.changed?        #   return if !self.new_record? && !self.changed?
+          return unless (op = OperatorRecordable.operator)     #   return unless (op = OperatorRecordable.operator)
+                                                               #
+          self.#{config.updater_column_name} = op.id           #   self.updated_by = op.id
+        end                                                    # end
       END_OF_DEF
     end
 
     def define_deleter_instance_methods(klass, config)
       klass.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
-        private def assign_#{config.deleter_association_name}
-          return if self.frozen?
-          return unless (op = OperatorRecordable.operator)
-
-          self
-            .class
-            .where(self.class.primary_key => id)
-            .update_all('#{config.deleter_column_name}' => op.id)
-          self.#{config.deleter_column_name} = op.id
-        end
+        private def assign_#{config.deleter_association_name}      # private def assign_deleter
+          return if self.frozen?                                   #   return if self.frozen?
+          return unless (op = OperatorRecordable.operator)         #   return unless (op = OperatorRecordable.operator)
+                                                                   #
+          self                                                     #   self
+            .class                                                 #     .class
+            .where(self.class.primary_key => id)                   #     .where(self.class.primary_key => id)
+            .update_all('#{config.deleter_column_name}' => op.id)  #     .update_all('deleted_by' => op.id)
+          self.#{config.deleter_column_name} = op.id               #   self.deleted_by = op.id
+        end                                                        # end
+      END_OF_DEF
+    end
+
+    def define_discarder_instance_methods(klass, config)
+      klass.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
+        private def assign_#{config.discarder_association_name}      # private def assign_discarder
+          return if self.frozen?                                     #   return if self.frozen?
+          return unless (op = OperatorRecordable.operator)           #   return unless (op = OperatorRecordable.operator)
+                                                                     #
+          self.#{config.discarder_column_name} = op.id               #   self.discarded_by = op.id
+        end                                                          # end
       END_OF_DEF
     end
   end

data/lib/operator_recordable/store/thread_store.rb

@@ -2,6 +2,10 @@
 
 module OperatorRecordable
   class ThreadStore
+    def initialize
+      warn "DEPRECATION WARNING: `:thread_store` is deprecated. It will be removed in v2.0"
+    end
+
     def [](key)
       ::Thread.current[key]
     end

data/lib/operator_recordable/store.rb

@@ -15,4 +15,4 @@ end
 
 require "operator_recordable/store/thread_store"
 require "operator_recordable/store/request_store" if defined? ::RequestStore
-require "operator_recordable/store/current_attributes_store" if defined? ::ActiveSupport::CurrentAttributes
+require "operator_recordable/store/current_attributes_store"

data/lib/operator_recordable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OperatorRecordable
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

data/operator_recordable.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   spec.metadata["homepage_uri"]      = spec.homepage
   spec.metadata["source_code_uri"]   = spec.homepage
-  spec.metadata["changelog_uri"]     = "https://github.com/yujideveloper/operator_recordable/tree/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"]     = "https://github.com/yujideveloper/operator_recordable/tree/main/CHANGELOG.md"
 
   spec.metadata["rubygems_mfa_required"] = "true"
 
@@ -46,9 +46,10 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_dependency "activerecord", ">= 5.2"
   spec.add_development_dependency "appraisal", ">= 2.3.0"
   spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "discard", ">= 1.2"
   spec.add_development_dependency "pry", ">= 0.10.0"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
-  spec.add_development_dependency "rubocop", ">= 0.78.0"
+  spec.add_development_dependency "rubocop", ">= 1.13.0"
   spec.add_development_dependency "sqlite3", ">= 1.3.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operator_recordable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Yuji Hanamura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: discard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -169,9 +183,9 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/yujideveloper/operator_recordable
   source_code_uri: https://github.com/yujideveloper/operator_recordable
-  changelog_uri: https://github.com/yujideveloper/operator_recordable/tree/master/CHANGELOG.md
+  changelog_uri: https://github.com/yujideveloper/operator_recordable/tree/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,8 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: OperatorRecordable is a Rails plugin to set created_by, updated_by, and deleted_by
   to ActiveRecord objects.