operator_recordable 1.1.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a738b794ff45332a5df918bcec227d8c22683cefca6505b4127d53ca664ae78
-  data.tar.gz: 2d895a62c309fc3b45d5b1dc8c9c31eeadf43e580e0fbea8ccb1b565beb50887
+  metadata.gz: 49732162b7408905bf8df338339f939127bc749d307fcf6639d52f173c645372
+  data.tar.gz: 1e2358023c22551afb02a430d5bb43c4f1908d867616f30e52754564cfb93b27
 SHA512:
-  metadata.gz: df72ca9f3c177e9f237bd8af23bbb9ac03df004dfc46a4db268cae137a91a9a80cbcc04c564406d04cb3ae92e51c050ba92ca94d8ebf6ebb7be38e52b03ea4c3
-  data.tar.gz: cb82594ea68b88414faf85d8ab556f6e58b44ee971b9886d1d34617c0618c290163761309b5e279fd8f4e589f8a7acca0397ef566215f391ea5697d0de94bf32
+  metadata.gz: 4453ea3b593441f2761abacdcf3407a9612adbe3d38758a3c6852c0a34b9147fb90d587aea8f95be986aa749611170d8547e5bbe4ab76ea05824a2cd80b11f93
+  data.tar.gz: f8833708e12cae1002924cb2d682936f0b5b43d10f65ee7fc4a92b1b2462ce0c1d01adb5431c57236c7064ddb38bf98a970232df3df181b5f97ec97454afed46

data/.github/workflows/ruby.yml

@@ -59,15 +59,6 @@ jobs:
           activerecord: '5.2'
           plugin: '_with_request_store'
           experimental: false
-        # Rails 7.0.1 will start supporting Ruby 3.1, but Rails 7.0.1 has not been released yet
-        - ruby: '3.1'
-          activerecord: '7.0'
-          plugin: ''
-          experimental: false
-        - ruby: '3.1'
-          activerecord: '7.0'
-          plugin: '_with_request_store'
-          experimental: false
         include:
         - ruby: '2.7'
           activerecord: '5.2'

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/Appraisals

@@ -32,12 +32,12 @@ appraise "activerecord_6.1_with_request_store" do
 end
 
 appraise "activerecord_7.0" do
-  gem "activerecord", "~> 7.0.0"
+  gem "activerecord", "~> 7.0.1"
   gem "sqlite3", "~> 1.4"
 end
 
 appraise "activerecord_7.0_with_request_store" do
-  gem "activerecord", "~> 7.0.0"
+  gem "activerecord", "~> 7.0.1"
   gem "request_store"
   gem "sqlite3", "~> 1.4"
 end

data/CHANGELOG.md

@@ -1,20 +1,69 @@
 ## Unreleased
 
+
+## 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/28)
+
+### Misc
+
+* CI against for Rails 7.0 running on Ruby 3.1
+  + [PR#26](https://github.com/yujideveloper/operator_recordable/pull/26)
+* Call `super` in `OperatorRecordable::Recorder#initialize`
+  + [PR#30](https://github.com/yujideveloper/operator_recordable/pull/30)
+
+
 ## 1.1.0 (2022-01-07)
 
 ### Changes
 
 * Add gem metadata
+  + [PR#24](https://github.com/yujideveloper/operator_recordable/pull/24)
 * Drop Ruby 2.4 support
+  + [PR#25](https://github.com/yujideveloper/operator_recordable/pull/25)
 * Drop ActiveRecord 5.0 and 5.1 support
+  + [PR#25](https://github.com/yujideveloper/operator_recordable/pull/25)
 
 ### Misc
 
 * Introduce Appraisal
+  + [PR#19](https://github.com/yujideveloper/operator_recordable/pull/19)
 * CI against for ActiveRecord 6.1 and 7.0
+  + [PR#19](https://github.com/yujideveloper/operator_recordable/pull/19)
+  + [PR#22](https://github.com/yujideveloper/operator_recordable/pull/22)
 * Use GitHub Actions and stop using Travis CI
+  + [PR#20](https://github.com/yujideveloper/operator_recordable/pull/20)
 * CI against for Ruby 3.0 and 3.1
+  + [PR#23](https://github.com/yujideveloper/operator_recordable/pull/23)
+  + [PR#25](https://github.com/yujideveloper/operator_recordable/pull/25)
 * Require MFA to release gem
+  + [PR#24](https://github.com/yujideveloper/operator_recordable/pull/24)
 
 
 ## 1.0.0 (2020-10-16)
@@ -22,6 +71,7 @@
 ### Changes
 
 * Support Ruby 2.7
+  + [PR#14](https://github.com/yujideveloper/operator_recordable/pull/14)
 
 
 ## 0.4.0 (2019-08-22)
@@ -29,10 +79,12 @@
 ### Changes
 
 * Support ActiveRecord 6.0.0
+  + [PR#13](https://github.com/yujideveloper/operator_recordable/pull/13)
 
 ### Misc
 
 * Improve rspec and CI
+  + [PR#11](https://github.com/yujideveloper/operator_recordable/pull/11)
 
 
 ## 0.3.0 (2018-10-05)
@@ -40,6 +92,7 @@
 ### Breaking changes
 
 * Change mixin module from `OperatorRecordable` to `OperatorRecordable::Extension`
+  + [PR#5](https://github.com/yujideveloper/operator_recordable/pull/5)
 
 
 ## 0.2.0 (2018-09-27)
@@ -47,11 +100,14 @@
 ### Changes
 
 * Add association name options
+  + [PR#2](https://github.com/yujideveloper/operator_recordable/pull/2)
 * Modify not to define unnecessary class methods for ActiveRecord model
+  + [PR#3](https://github.com/yujideveloper/operator_recordable/pull/3)
 
 ### Misc
 
 * Remove unecessary `require`
+  + [PR#4](https://github.com/yujideveloper/operator_recordable/pull/4)
 
 
 ## 0.1.1 (2018-09-19)
@@ -59,6 +115,7 @@
 ### Misc
 
 * Refactor internal structures
+  + [PR#1](https://github.com/yujideveloper/operator_recordable/pull/1)
 
 
 ## 0.1.0 (2018-09-14)

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
@@ -19,7 +21,7 @@ gem 'operator_recordable'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -38,9 +40,11 @@ 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
@@ -55,10 +59,12 @@ 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"` |
-| `operator_association_options` | Hash | options of operator associations. e.g. `{ optional: true }` | `{}` |
+| `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` |
 
@@ -99,7 +105,7 @@ This is default store.
 This store is implemented by using [RequestStore gem](https://github.com/steveklabnik/request_store).  
 So, this requires RequestStore gem.
 
-RequestStore must be required before OperatorRecordable.
+RequestStore must be loaded before OperatorRecordable.
 
 ``` ruby
 gem "request_store"
@@ -112,15 +118,14 @@ require "request_store"
 require "operator_recordable"
 ```
 
-Otherwise, you need to require it yourself.
+Otherwise, you need to load it yourself.
 ``` ruby
 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/gemfiles/activerecord_7.0.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 7.0.0"
+gem "activerecord", "~> 7.0.1"
 gem "sqlite3", "~> 1.4"
 
 gemspec path: "../"

data/gemfiles/activerecord_7.0_with_request_store.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 7.0.0"
+gem "activerecord", "~> 7.0.1"
 gem "request_store"
 gem "sqlite3", "~> 1.4"
 

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

@@ -5,6 +5,7 @@ require "operator_recordable/configuration"
 module OperatorRecordable
   class Recorder < ::Module
     def initialize(config)
+      super()
       define_activate_method(config)
     end
 
@@ -30,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
 
@@ -48,46 +54,63 @@ 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,
                        **{ foreign_key: config.column_name_for(type),
-                           class_name: config.operator_class_name }.merge(config.operator_association_options)
+                           class_name: config.operator_class_name,
+                           optional: true }.merge(config.operator_association_options)
     end
 
     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.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.1.0"
+  VERSION = "1.3.1"
 end

data/operator_recordable.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(__dir__) do
+  spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -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.1.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Yuji Hanamura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-06-20 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
@@ -171,7 +185,7 @@ metadata:
   source_code_uri: https://github.com/yujideveloper/operator_recordable
   changelog_uri: https://github.com/yujideveloper/operator_recordable/tree/master/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.2.21
-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.