operator_recordable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9439bc5b4ce5623c61b5d9c4f4ad0d9da08fdec39f7bfdb19000d8e622dc2ce0
-  data.tar.gz: 27c6348566975088b2a1b43523a41d1a7e4997c1152794ab9e9c8a7ba378f335
+  metadata.gz: 3e05ee5e40a24819f5628847408a64657df213e1f96bf7060b87b9b86f45d6aa
+  data.tar.gz: 6491c0178099e81c2b423e5344e018b76de979e76009d7ef21df9d3bb0bfdec6
 SHA512:
-  metadata.gz: 4cef8201a40b1e628177f249ae8f0978a42d8e78c18ab43cef3e9d159cb14e3e7dd9ba230c75d54ed3576c45ede68d086900a580f53a4a508a281360b85d89e2
-  data.tar.gz: 775227886773bb67f8f57fb08b403f50b84c2bbb63077273cb0825e160e0fdd8f3cb990987a925cd09f74210bc8f71dbe69b71b288946f49e9a31856043ab9aa
+  metadata.gz: d24f2ffdcb2a74658cf298da772d5b5945c56c5283b0087fb0f52c4d07afb56a144265a26633df7fb5c5399d4aed38e43f1a4700f489d5741bccca24867748f1
+  data.tar.gz: a4803ce15c437240371fb6e32433880e2862d2598fe8616f5681fda4d21647550ad017dd5471578d95a9ea4e1b070103b39a729f16ab83526d8a698de7950555

data/CHANGELOG.md

@@ -1,13 +1,25 @@
 ## Unreleased
 
 
-## 0.1.1 (2018/09/19)
+## 0.2.0 (2018-09-27)
+
+### Cbanges
+
+* Add association name options
+* Modify not to define unnecessary class methods for ActiveRecord model
+
+### Misc
+
+* Remove unecessary `require`
+
+
+## 0.1.1 (2018-09-19)
 
 ### Misc
 
 * Refactor internal structures
 
 
-## 0.1.0 (2018/09/14)
+## 0.1.0 (2018-09-14)
 
 * Initial release

data/README.md

@@ -38,6 +38,9 @@ OperatorRecordable.config = {
   creator_column_name: "created_by",
   updater_column_name: "updated_by",
   deleter_column_name: "deleted_by",
+  creator_association_name: "creator",
+  updater_association_name: "updater",
+  deleter_association_name: "deleter",
   operator_association_options: {},
   operator_association_scope: nil,
   store: :thread_store
@@ -52,6 +55,9 @@ 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"` |
+| `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 }` | `{}` |
 | `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` |

data/lib/operator_recordable/configuration.rb

@@ -12,12 +12,21 @@ module OperatorRecordable
     end
 
     %i[operator_class_name creator_column_name updater_column_name deleter_column_name
+       creator_association_name updater_association_name deleter_association_name
        operator_association_options operator_association_scope].each do |name|
       define_method name do
         config[name]
       end
     end
 
+    def column_name_for(type)
+      config[:"#{type}_column_name"]
+    end
+
+    def association_name_for(type)
+      config[:"#{type}_association_name"]
+    end
+
     private
 
     attr_reader :config
@@ -28,6 +37,9 @@ module OperatorRecordable
         creator_column_name: "created_by",
         updater_column_name: "updated_by",
         deleter_column_name: "deleted_by",
+        creator_association_name: "creator",
+        updater_association_name: "updater",
+        deleter_association_name: "deleter",
         operator_association_options: {},
         operator_association_scope: nil,
         store: :thread_store

data/lib/operator_recordable/recorder.rb

@@ -6,7 +6,6 @@ module OperatorRecordable
   class Recorder < ::Module
     def initialize(config)
       define_activate_method(config)
-      define_predicate_methods
     end
 
     private
@@ -15,55 +14,50 @@ module OperatorRecordable
       m = self
 
       define_method :record_operator_on do |*actions|
-        @_record_operator_on = Configuration::Model.new(actions)
+        c = Configuration::Model.new(actions)
 
-        if record_creator?
+        if c.record_creator?
           m.__send__(:run_creator_dsl, self, config)
           m.__send__(:define_creator_instance_methods, self, config)
         end
 
-        if record_updater?
+        if c.record_updater?
           m.__send__(:run_updater_dsl, self, config)
           m.__send__(:define_updater_instance_methods, self, config)
         end
 
-        if record_deleter?
+        if c.record_deleter?
           m.__send__(:run_deleter_dsl, self, config)
           m.__send__(:define_deleter_instance_methods, self, config)
         end
       end
     end
 
-    def run_creator_dsl(class_or_module, config)
-      class_or_module.class_exec do
-        before_create :assign_creator
-        belongs_to :creator, config.operator_association_scope,
-                   { foreign_key: config.creator_column_name,
-                     class_name: config.operator_class_name }.merge(config.operator_association_options)
-      end
+    def run_creator_dsl(klass, config)
+      klass.before_create :"assign_#{config.creator_association_name}"
+      run_add_association_dsl(:creator, klass, config)
     end
 
-    def run_updater_dsl(class_or_module, config)
-      class_or_module.class_exec do
-        before_save :assign_updater
-        belongs_to :updater, config.operator_association_scope,
-                   { foreign_key: config.updater_column_name,
-                     class_name: config.operator_class_name }.merge(config.operator_association_options)
-      end
+    def run_updater_dsl(klass, config)
+      klass.before_save :"assign_#{config.updater_association_name}"
+      run_add_association_dsl(:updater, klass, config)
     end
 
-    def run_deleter_dsl(class_or_module, config)
-      class_or_module.class_exec do
-        before_destroy :assign_deleter
-        belongs_to :deleter, config.operator_association_scope,
-                   { foreign_key: config.deleter_column_name,
-                     class_name: config.operator_class_name }.merge(config.operator_association_options)
-      end
+    def run_deleter_dsl(klass, config)
+      klass.before_destroy :"assign_#{config.deleter_association_name}"
+      run_add_association_dsl(:deleter, klass, config)
     end
 
-    def define_creator_instance_methods(class_or_module, config)
-      class_or_module.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
-        private def assign_creator
+    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)
+    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
@@ -71,9 +65,9 @@ module OperatorRecordable
       END_OF_DEF
     end
 
-    def define_updater_instance_methods(class_or_module, config)
-      class_or_module.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
-        private def assign_updater
+    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)
 
@@ -82,9 +76,9 @@ module OperatorRecordable
       END_OF_DEF
     end
 
-    def define_deleter_instance_methods(class_or_module, config)
-      class_or_module.class_eval <<~END_OF_DEF, __FILE__, __LINE__ + 1
-        private def assign_deleter
+    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)
 
@@ -96,25 +90,5 @@ module OperatorRecordable
         end
       END_OF_DEF
     end
-
-    def define_predicate_methods
-      define_method :record_creator? do
-        instance_variable_defined?(:@_record_operator_on) &&
-          @_record_operator_on.record_creator?
-      end
-      private :record_creator?
-
-      define_method :record_updater? do
-        instance_variable_defined?(:@_record_operator_on) &&
-          @_record_operator_on.record_updater?
-      end
-      private :record_updater?
-
-      define_method :record_deleter? do
-        instance_variable_defined?(:@_record_operator_on) &&
-          @_record_operator_on.record_deleter?
-      end
-      private :record_deleter?
-    end
   end
 end

data/lib/operator_recordable/version.rb

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

data/lib/operator_recordable.rb

@@ -2,7 +2,6 @@
 
 require "operator_recordable/version"
 require "operator_recordable/configuration"
-require "operator_recordable/store"
 require "operator_recordable/recorder"
 
 module OperatorRecordable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operator_recordable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuji Hanamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord