activerecord-bixformer 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0fefe763e939aad7ff7e50f2961962e24164a4d
-  data.tar.gz: 435fbfa1250fa0f8cb11c6c1b97c678e0a808e02
+  metadata.gz: dd4ea598a0c120a784bbeb9f5a296471a5385f57
+  data.tar.gz: 7078cc54cd2675e0081362d897ee7ff74985b2c8
 SHA512:
-  metadata.gz: bb7926a45c574069f491893edc80ece85d8a0782976bcb21bbd22d2f0b7b912d87c351bc7335d198c875bfa8576ba2dcb9d4ceab159a6cbda826734e529f0b6d
-  data.tar.gz: f9bfe143d8be2fe6c0101f9703f3fe219ba4cc8cc239a108004a6687f5ba539a8d445644f91b88e6d5c297a8dbc64acd5810534e944116842acf7f53ee17f001
+  metadata.gz: 868cd4eba053a212776bb8c5b1ea4b1c25d0da8c5dcddd5f0e48cd302e13db17bd4ed4d497f4b9f157544de472d22b46a3462ae97b814fa16a8d69f6cc8f2f20
+  data.tar.gz: 2856bb8d614bbd9e64bbf6c4bd47d85e7c064123d0603dec9d236478580dd93b30225e8cbc25d6c327fc98f402e269592ebadc4863dcaf5d432a4ae345d3d00a

data/README-ja.md

@@ -5,7 +5,7 @@
 以下のような特徴があります。  
 
 * `accepts_nested_attributes_for` で定義された関連モデルを同時に扱える
-* インポートデータに `primary_key` が含まれる場合、それが正当な値かどうかをチェックできる
+* インポート時、インポートデータが正当な値かどうかをチェックする
 * 設定用クラスを定義して使い、モデル、属性単位で処理をカスタマイズ可能
 
 現在のところ、インポート/エクスポート可能なデータ形式は
@@ -124,7 +124,9 @@ class SamplePlan
   #   - 配列を返すProcオブジェクトかメソッド名/シンボルで指定
   #   - 有効な値については、「インポート時に有効な値」を参照
   #
-  bixformer_preferred_skip_attributes -> do
+  bixformer_preferred_skip_attributes :skippable_attributes
+
+  def skippable_attributes
     [
       # ルートの要素は、対象モデル（上の例なら user ）への指定
       # bixformer_entry で定義されている属性で指定
@@ -242,13 +244,13 @@ class SamplePlan
       scope: :bixformer,
       
       # translation を検索するスコープを、基点のスコープ配下に増やしたい場合に指定
-      extend_scopes: [:version1, :version2]
+      extend_scopes: [:version2, :version1]
       
       # 上記の場合、ユーザが投稿したタイトルは
       #
-      # bixformer.version2.user/posts.title
-      # bixformer.version1.user/posts.title
-      # bixformer.user/posts.title
+      # bixformer.version2.attributes.user/posts.title
+      # bixformer.version1.attributes.user/posts.title
+      # bixformer.attributes.user/posts.title
       #
       # の順で検索され、最初に見つかった translation を実行します
       
@@ -317,7 +319,9 @@ end
 
 ### 本フレームワークに定義されたModel一覧
 
-#### For CSV
+Model は各データ形式毎に異なる処理が必要になるため、データ形式毎に使えるクラスが異なります。  
+
+#### CSV
 
 * base
     * has_one な関連モデル用。 has_many な関連モデルには使えない
@@ -329,6 +333,8 @@ end
 
 ### 本フレームワークに定義されたAttribute一覧
 
+Attribute は、基本的にデータ形式に依らず、使用可能な想定をしています。  
+
 * string
     * エクスポートでは `to_s` し、インポートでは `strip` して `presence` する
 * boolean
@@ -349,7 +355,7 @@ end
 * override
     * モデルに処理を委譲する
     * モデルに `override_import_属性名` / `override_export_属性名` を定義すること
-    * インポートでは、インポートデータ、エクスポートでは、 ActiveRecord の属性値が引数となる
+    * インポートでは、インポートデータ、エクスポートでは、 ActiveRecord のインスタンスが引数となる
     * インポート/エクスポートする値を返すこと
 
 ### インポート時に有効な値

data/lib/activerecord-bixformer/autoload.rb

@@ -5,6 +5,7 @@ module ActiveRecord
     autoload :ImportValueValidatable,         'activerecord-bixformer/import_value_validatable'
     autoload :Plan,                           'activerecord-bixformer/plan'
     autoload :PlanAccessor,                   'activerecord-bixformer/plan_accessor'
+    autoload :ModelCallback,                  'activerecord-bixformer/model_callback'
 
     module Attribute
       autoload :Base,       'activerecord-bixformer/attribute/base'

data/lib/activerecord-bixformer/model/base.rb

@@ -12,10 +12,9 @@ module ActiveRecord
       # @attr_reader [Hash<String, ActiveRecord::Bixformer::Model::Base>] associations
       #   the import/export target association names and its instance.
       # @attr_reader [ActiveRecord::Bixformer::Translator::I18n] translator
-      # @attr_reader [ActiveRecord::Bixformer::Plan::Base] plan
-      #   active plan in the import/export process.
       class Base
         include ::ActiveRecord::Bixformer::ImportValueValidatable
+        include ::ActiveRecord::Bixformer::ModelCallback
 
         attr_reader :name, :options, :parent, :attributes, :associations,
                     :preferred_skip_attributes, :translator
@@ -92,14 +91,18 @@ module ActiveRecord
           values     = {}.with_indifferent_access
           normalizer = ::ActiveRecord::Bixformer::AssignableAttributesNormalizer.new(plan, self, parent_record_id)
 
-          @attributes.each do |attr|
-            attribute_value = block.call(attr)
+          run_callback :import, type: :attribute do
+            @attributes.each do |attr|
+              attribute_value = run_callback :import, on: attr.name do
+                block.call(attr)
+              end
 
-            # 取り込み時は、 preferred_skip な属性では、有効でない値は取り込まない
-            next if ! presence_value?(attribute_value) &&
-                    @preferred_skip_attributes.include?(attr.name.to_s)
+              # 取り込み時は、 preferred_skip な属性では、有効でない値は取り込まない
+              next if ! presence_value?(attribute_value) &&
+                      @preferred_skip_attributes.include?(attr.name.to_s)
 
-            values[attr.name] = attribute_value
+              values[attr.name] = attribute_value
+            end
           end
 
           # データの検証と正規化
@@ -120,19 +123,23 @@ module ActiveRecord
         def make_each_association_import_value(values, &block)
           self_record_id = values[activerecord_constant.primary_key]
 
-          @associations.each do |association|
-            association_value = block.call(association, self_record_id)
+          run_callback :import, type: :association do
+            @associations.each do |association|
+              association_value = run_callback :import, on: association.name do
+                block.call(association, self_record_id)
+              end
 
-            if association_value.is_a?(::Array)
-              # has_many な場合は、配列が返ってくるが、空と思われる要素は結果に含めない
-              association_value = association_value.reject { |v| ! presence_value?(v) }
-            end
+              if association_value.is_a?(::Array)
+                # has_many な場合は、配列が返ってくるが、空と思われる要素は結果に含めない
+                association_value = association_value.reject { |v| ! presence_value?(v) }
+              end
 
-            # 取り込み時は、 preferred_skip な関連では、有効でない値は取り込まない
-            next if ! presence_value?(association_value) &&
-                    @preferred_skip_attributes.include?(association.name.to_s)
+              # 取り込み時は、 preferred_skip な関連では、有効でない値は取り込まない
+              next if ! presence_value?(association_value) &&
+                      @preferred_skip_attributes.include?(association.name.to_s)
 
-            values["#{association.name}_attributes".to_sym] = association_value
+              values["#{association.name}_attributes".to_sym] = association_value
+            end
           end
 
           values

data/lib/activerecord-bixformer/model/csv/base.rb

@@ -4,31 +4,47 @@ module ActiveRecord
       module Csv
         class Base < ::ActiveRecord::Bixformer::Model::Base
           def export(record_or_records)
-            # has_one でしか使わない想定なので record_or_records は ActiveRecord::Base のはず
-            values = @attributes.map do |attr|
-              attribute_value = record_or_records && attr.export(record_or_records)
+            run_callback :export do
+              values = run_callback :export, type: :attribute do
+                # has_one でしか使わない想定なので record_or_records は ActiveRecord::Base のはず
+                @attributes.map do |attr|
+                  attribute_value = if record_or_records
+                                      run_callback :export, on: attr.name do
+                                        attr.export(record_or_records)
+                                      end
+                                    end
 
-              [csv_title(attr.name), attribute_value]
-            end.to_h.with_indifferent_access
+                  [csv_title(attr.name), attribute_value]
+                end.to_h.with_indifferent_access
+              end
 
-            @associations.inject(values) do |each_values, association|
-              association_value = record_or_records && record_or_records.__send__(association.name)
+              run_callback :export, type: :association do
+                @associations.inject(values) do |each_values, association|
+                  association_value = if record_or_records
+                                        run_callback :export, on: association.name do
+                                          record_or_records.__send__(association.name)
+                                        end
+                                      end
 
-              association_value = association_value.to_a if association_value.is_a?(::ActiveRecord::Relation)
+                  association_value = association_value.to_a if association_value.is_a?(::ActiveRecord::Relation)
 
-              each_values.merge(association.export(association_value))
+                  each_values.merge(association.export(association_value))
+                end
+              end
             end
           end
 
           def import(csv_body_row, parent_record_id = nil)
-            values = make_each_attribute_import_value(parent_record_id) do |attr|
-              csv_value = csv_body_row[csv_title(attr.name)]
+            run_callback :import do
+              values = make_each_attribute_import_value(parent_record_id) do |attr|
+                csv_value = csv_body_row[csv_title(attr.name)]
 
-              attr.import(csv_value)
-            end
+                attr.import(csv_value)
+              end
 
-            make_each_association_import_value(values) do |association, self_record_id|
-              association.import(csv_body_row, self_record_id)
+              make_each_association_import_value(values) do |association, self_record_id|
+                association.import(csv_body_row, self_record_id)
+              end
             end
           end
 

data/lib/activerecord-bixformer/model_callback.rb

@@ -0,0 +1,92 @@
+module ActiveRecord
+  module Bixformer
+    module ModelCallback
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :__bixformer_export_callbacks
+        class_attribute :__bixformer_import_callbacks
+
+        self.__bixformer_export_callbacks = {}
+        self.__bixformer_import_callbacks = {}
+
+        private
+
+        def self.callback_store_key(options)
+          if options[:on]
+            "on:#{options[:on]}"
+          elsif options[:type]
+            "type:#{options[:type]}"
+          else
+            "global"
+          end
+        end
+      end
+
+      module ClassMethods
+        [:export, :import].each do |target|
+          [:before, :around, :after].each do |timing|
+            define_method "bixformer_#{timing}_#{target}" do |*callback, &block|
+              callback_store = self.__send__("__bixformer_#{target}_callbacks")[timing] ||= {}
+
+              options = callback.extract_options!.with_indifferent_access
+              key     = callback_store_key(options)
+
+              callback_store[key] = options.merge(
+                body: block ? block : options[:body] || callback.first
+              )
+            end
+          end
+        end
+      end
+
+      private
+
+      def run_callback(target, options = {}, &body)
+        options = options.with_indifferent_access
+
+        before_callback = callback(target, :before, options)
+        if before_callback
+          return nil unless invoke_callback(before_callback)
+        end
+
+        around_callback = callback(target, :around, options)
+        result          = invoke_callback(around_callback, &body)
+
+        after_callback = callback(target, :after, options)
+        invoke_callback(after_callback, args_required: true, args_value: result) if after_callback
+
+        result
+      end
+
+      def invoke_callback(callback, args_required: false, args_value: nil, &block)
+        if callback.is_a?(::Proc)
+          if block
+            self.instance_exec block, &callback
+          elsif args_required
+            self.instance_exec args_value, &callback
+          else
+            self.instance_exec &callback
+          end
+        elsif callback.is_a?(::Symbol) || callback.is_a?(::String)
+          if block
+            self.__send__(callback, &block)
+          elsif args_required
+            self.__send__(callback, args_value)
+          else
+            self.__send__(callback)
+          end
+        elsif block
+          yield block
+        end
+      end
+
+      def callback(target, timing, options)
+        callback_store  = self.__send__("__bixformer_#{target}_callbacks")[timing] || {}
+        callback_values = callback_store[self.class.callback_store_key(options)] || {}
+
+        callback_values[:body]
+      end
+    end
+  end
+end

data/lib/activerecord-bixformer/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Bixformer
-    VERSION = "0.2.6"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-bixformer
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Hiroaki Otsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -239,6 +239,7 @@ files:
 - lib/activerecord-bixformer/model/base.rb
 - lib/activerecord-bixformer/model/csv/base.rb
 - lib/activerecord-bixformer/model/csv/indexed.rb
+- lib/activerecord-bixformer/model_callback.rb
 - lib/activerecord-bixformer/plan.rb
 - lib/activerecord-bixformer/plan_accessor.rb
 - lib/activerecord-bixformer/to/csv.rb