activerecord-bixformer 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3cf0d6744f510047d870eed824bb57d7646fbf8
-  data.tar.gz: cee67069dc05abc816ca590bfd10ca1ecee7f710
+  metadata.gz: 18bbd017fde0b78cc6edbcbea84f68cf62088a48
+  data.tar.gz: 7560282ebbd8bc2474a2b91534a76ec453ff4a53
 SHA512:
-  metadata.gz: 3d5df8e0c7258482caf4ffbb3e71d5f168f03034eb03459c348e4121722f6b8d1ec1a189c87cc8c27cb443c7d4320b9081612bb2b17514f1d22809c19f491f61
-  data.tar.gz: 818e84c966120c820eebec7f3838a41f8828f934b5cc30c73c7aefebd00430332e070e632d273d4f3161d16ea841f582d45ddc7c5e7f42c6d5aa1ef2c0fd93cd
+  metadata.gz: 546d0e273f0e30697b54b5b30cb200f21ab7d36834db166fb4faa777f2eb3b175bf595fe6a4e997669e3233fef5aad4ac60cecfa980412bbfe6126783ddc47c5
+  data.tar.gz: fa1063540a8d61e068c74f4af2a7e8b6be2ead2034f02686266fd187339302257d1fc06e241251d850dd2fbb85e7f30f72fa6e6c9f9be6fb8a67044ad4844529

data/README-ja.md

@@ -104,7 +104,7 @@ ActiveRecord::Bixformer::Plan::Base を継承して、以下のメソッドを
 }
 ```
 
-### optional_attributes
+### preferred_skip_attributes
 
 インポート時に、有効な値でない場合に、登録対象としない属性を定義した以下のような配列を返して下さい。  
 
@@ -148,14 +148,14 @@ end
 ### required_attributes
 
 インポート時に、有効な値でない場合に、インポート自体を行わない属性を定義した配列を返して下さい。  
-データ構成は、 `optional_attributes` と同様です。  
+データ構成は、 `preferred_skip_attributes` と同様です。  
 
-### unique_indexes
+### unique_attributes
 
 インポートは、対象の ActiveRecord モデルの `primary_key` に対応するインポートデータの有無によって、  
 追加か更新かを判定しますが、 `primary_key` の属性がインポートデータに含まれていない場合でも、  
 更新処理を行いたい場合に、対象レコードを特定できる属性を定義した配列を返して下さい。  
-データ構成は、 `optional_attributes` と同様です。  
+データ構成は、 `preferred_skip_attributes` と同様です。  
 
 ```ruby
 [
@@ -181,7 +181,7 @@ end
 }
 ```
 
-* `primary_key` や `unique_indexes` が指定されている場合のデータベース検索の条件に追加されます
+* `primary_key` や `unique_attributes` が指定されている場合のデータベース検索の条件に追加されます
 * 関連モデルの場合は、親レコードの foreign_key が代わりに使用されます
 * `primary_key` が指定されているのに、データベース検索に失敗した場合には、 `ActiveRecord::RecordNotFound` 例外が raise されます
 

data/lib/activerecord-bixformer/assignable_attributes_normalizer.rb

@@ -3,10 +3,10 @@ module ActiveRecord
     class AssignableAttributesNormalizer
       include ::ActiveRecord::Bixformer::ImportValueValidatable
 
-      def initialize(plan, model, parent_activerecord_id)
+      def initialize(plan, model, parent_record_id)
         @plan                   = ActiveRecord::Bixformer::PlanAccessor.new(plan)
         @model                  = model
-        @parent_activerecord_id = parent_activerecord_id
+        @parent_record_id = parent_record_id
         @identified_column_name = @model.activerecord_constant.primary_key
       end
 
@@ -47,9 +47,9 @@ module ActiveRecord
         # 設定するのは親がいる場合のみ
         return unless @model.parent
 
-        if @parent_activerecord_id
+        if @parent_record_id
           # 親のレコードが見つかっているなら、それも結果ハッシュに追加する
-          @model_attributes[@model.parent_foreign_key] = @parent_activerecord_id
+          @model_attributes[@model.parent_foreign_key] = @parent_record_id
         else
           # 見つかっていないなら、間違った値が指定されている可能性があるので、キー自体を削除
           @model_attributes.delete(@model.parent_foreign_key)
@@ -58,7 +58,7 @@ module ActiveRecord
 
       def set_identified_attribute
         # 更新の場合は、インポートデータを元にデータベースから対象のレコードを検索してIDを取得
-        verified_id = verified_activerecord_id
+        verified_id = verified_record_id
 
         if verified_id
           # 更新なら、ID属性を改めて設定
@@ -69,7 +69,7 @@ module ActiveRecord
         end
       end
 
-      def verified_activerecord_id
+      def verified_record_id
         # 更新対象のレコードを特定できるかチェック
         identified_value = @model_attributes[@identified_column_name]
 
@@ -99,19 +99,19 @@ module ActiveRecord
         # 検証条件とマージして、データベースに登録されているか確認する
         verified_condition = uniqueness_condition.merge(required_condition)
 
-        @model.find_activerecord_by!(verified_condition).__send__(@identified_column_name)
+        @model.find_record_by!(verified_condition).__send__(@identified_column_name)
       rescue ::ActiveRecord::RecordNotFound => e
         # ID属性が指定されているのに、データベースに見つからない場合はエラーにする
         raise e if identified_value
       end
 
       def find_unique_condition
-        unique_indexes = @plan.pickup_value_for(@model, :unique_indexes, [])
+        unique_attributes = @plan.pickup_value_for(@model, :unique_attributes, [])
 
         # ユニーク条件が指定されていないなら終了
-        return nil if unique_indexes.empty?
+        return nil if unique_attributes.empty?
 
-        unique_condition = unique_indexes.map do |key|
+        unique_condition = unique_attributes.map do |key|
           [key, @model_attributes[key]]
         end.to_h
 

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

@@ -10,8 +10,8 @@ module ActiveRecord
           @options = (options.is_a?(::Hash) ? options : {}).with_indifferent_access
         end
 
-        def export(activerecord_value)
-          activerecord_value
+        def export(record_attribute_value)
+          record_attribute_value
         end
 
         def import(value)

data/lib/activerecord-bixformer/attribute/boolean.rb

@@ -2,11 +2,11 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class Boolean < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
+        def export(record_attribute_value)
           true_value = (@options.is_a?(::Hash) && @options[:true]) || 'true'
           false_value = (@options.is_a?(::Hash) && @options[:false]) || 'false'
 
-          activerecord_value.present? ? true_value : false_value
+          record_attribute_value.present? ? true_value : false_value
         end
 
         def import(value)

data/lib/activerecord-bixformer/attribute/booletania.rb

@@ -2,9 +2,9 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class Booletania < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
+        def export(record_attribute_value)
           @model.activerecord_constant.__send__("#{@name}_options").find do |text, bool|
-            bool == activerecord_value
+            bool == record_attribute_value
           end&.first
         end
 

data/lib/activerecord-bixformer/attribute/date.rb

@@ -2,10 +2,10 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class Date < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
-          return nil unless activerecord_value
+        def export(record_attribute_value)
+          return nil unless record_attribute_value
 
-          activerecord_value.to_s(option_format)
+          record_attribute_value.to_s(option_format)
         end
 
         def import(value)

data/lib/activerecord-bixformer/attribute/enumerize.rb

@@ -2,11 +2,11 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class Enumerize < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
-          activerecord_value = activerecord_value.to_s
+        def export(record_attribute_value)
+          record_attribute_value = record_attribute_value.to_s
 
           @model.activerecord_constant.__send__(@name).options.find do |text, key|
-            key == activerecord_value
+            key == record_attribute_value
           end&.first
         end
 

data/lib/activerecord-bixformer/attribute/override.rb

@@ -2,8 +2,8 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class Override < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
-          @model.__send__("override_export_#{@name}", activerecord_value)
+        def export(record_attribute_value)
+          @model.__send__("override_export_#{@name}", record_attribute_value)
         end
 
         def import(value)

data/lib/activerecord-bixformer/attribute/string.rb

@@ -2,8 +2,8 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class String < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
-          activerecord_value.to_s
+        def export(record_attribute_value)
+          record_attribute_value.to_s
         end
 
         def import(value)

data/lib/activerecord-bixformer/attribute/time.rb

@@ -2,10 +2,10 @@ module ActiveRecord
   module Bixformer
     module Attribute
       class Time < ::ActiveRecord::Bixformer::Attribute::Base
-        def export(activerecord_value)
-          return nil unless activerecord_value
+        def export(record_attribute_value)
+          return nil unless record_attribute_value
 
-          activerecord_value.to_s(option_format)
+          record_attribute_value.to_s(option_format)
         end
 
         def import(value)

data/lib/activerecord-bixformer/from/csv.rb

@@ -6,8 +6,12 @@ module ActiveRecord
           super(:csv, plan)
         end
 
-        def assignable_attributes(csv_row)
-          compile.import(csv_row)
+        def verify_csv_titles(csv_title_row)
+          compile.verify_csv_titles(csv_title_row)
+        end
+
+        def assignable_attributes(csv_body_row)
+          compile.import(csv_body_row)
         end
       end
     end

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

@@ -7,7 +7,7 @@ module ActiveRecord
       #   the instance has parent association.
       # @attr_reader [Hash<String, ActiveRecord::Bixformer::Attribute::Base>] attributes
       #   the import/export target attribute names and its instance.
-      # @attr_reader [Array<String>] optional_attributes
+      # @attr_reader [Array<String>] preferred_skip_attributes
       #   the list of attribute name to not make key if its value is blank.
       # @attr_reader [Hash<String, ActiveRecord::Bixformer::Model::Base>] associations
       #   the import/export target association names and its instance.
@@ -18,7 +18,7 @@ module ActiveRecord
         include ::ActiveRecord::Bixformer::ImportValueValidatable
 
         attr_reader :name, :options, :parent, :attributes, :associations,
-                    :optional_attributes, :translator
+                    :preferred_skip_attributes, :translator
 
         def initialize(model_or_association_name, options)
           @name         = model_or_association_name.to_s
@@ -37,7 +37,7 @@ module ActiveRecord
             @plan.new_module_instance(:attribute, attribute_type, self, attribute_name, attribute_options)
           end
 
-          @optional_attributes = @plan.pickup_value_for(self, :optional_attributes, [])
+          @preferred_skip_attributes = @plan.pickup_value_for(self, :preferred_skip_attributes, [])
           @default_values      = @plan.pickup_value_for(self, :default_values, {})
 
           # At present, translation function is only i18n
@@ -82,21 +82,21 @@ module ActiveRecord
             end
         end
 
-        def find_activerecord_by!(condition)
+        def find_record_by!(condition)
           activerecord_constant.find_by!(condition)
         end
 
-        def export(activerecord_or_activerecords)
-          # has_one でしか使わない想定なので activerecord_or_activerecords は ActiveRecord::Base のはず
+        def export(record_or_records)
+          # has_one でしか使わない想定なので record_or_records は ActiveRecord::Base のはず
           values = @attributes.map do |attr|
             value_reader    = attr.options[:reader] || attr.name
-            attribute_value = activerecord_or_activerecords && activerecord_or_activerecords.__send__(value_reader)
+            attribute_value = record_or_records && record_or_records.__send__(value_reader)
 
             [csv_title(attr.name), attr.export(attribute_value)]
           end.to_h.with_indifferent_access
 
           @associations.inject(values) do |each_values, association|
-            association_value = activerecord_or_activerecords && activerecord_or_activerecords.__send__(association.name)
+            association_value = record_or_records && record_or_records.__send__(association.name)
 
             association_value = association_value.to_a if association_value.is_a?(::ActiveRecord::Relation)
 
@@ -106,9 +106,9 @@ module ActiveRecord
 
         private
 
-        def make_each_attribute_import_value(parent_activerecord_id = nil, &block)
+        def make_each_attribute_import_value(parent_record_id = nil, &block)
           values     = {}.with_indifferent_access
-          normalizer = ::ActiveRecord::Bixformer::AssignableAttributesNormalizer.new(plan, self, parent_activerecord_id)
+          normalizer = ::ActiveRecord::Bixformer::AssignableAttributesNormalizer.new(plan, self, parent_record_id)
 
           @attributes.each do |attr|
             attribute_value = block.call(attr)
@@ -117,7 +117,7 @@ module ActiveRecord
 
             # 取り込み時は、オプショナルな属性では、空と思われる値は取り込まない
             next if ! presence_value?(attribute_value) &&
-                    @optional_attributes.include?(attr.name.to_s)
+                    @preferred_skip_attributes.include?(attr.name.to_s)
 
             values[attr.name] = attribute_value
           end
@@ -126,10 +126,10 @@ module ActiveRecord
         end
 
         def make_each_association_import_value(values, &block)
-          self_activerecord_id = values[activerecord_constant.primary_key]
+          self_record_id = values[activerecord_constant.primary_key]
 
           @associations.each do |association|
-            association_value = block.call(association, self_activerecord_id)
+            association_value = block.call(association, self_record_id)
 
             if association_value.is_a?(::Array)
               # has_many な場合は、配列が返ってくるが、空と思われる要素は結果に含めない
@@ -138,7 +138,7 @@ module ActiveRecord
 
             # 取り込み時は、オプショナルな関連では、空と思われる値は取り込まない
             next if ! presence_value?(association_value) &&
-                    @optional_attributes.include?(association.name.to_s)
+                    @preferred_skip_attributes.include?(association.name.to_s)
 
             values["#{association.name}_attributes".to_sym] = association_value
           end

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

@@ -3,18 +3,23 @@ module ActiveRecord
     module Model
       module Csv
         class Base < ::ActiveRecord::Bixformer::Model::Base
-          def import(csv_row, parent_activerecord_id = nil)
-            values = make_each_attribute_import_value(parent_activerecord_id) do |attr|
-              csv_value = csv_row[csv_title(attr.name)]
+          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)]
 
               attr.import(csv_value)
             end
 
-            make_each_association_import_value(values) do |association, self_activerecord_id|
-              association.import(csv_row, self_activerecord_id)
+            make_each_association_import_value(values) do |association, self_record_id|
+              association.import(csv_body_row, self_record_id)
             end
           end
 
+          def verify_csv_titles(csv_title_row)
+            @attributes.map { |attr| csv_title(attr.name) }.all? { |title| csv_title_row.include?(title) } &&
+              @associations.all? { |ass| ass.verify_csv_titles(csv_title_row) }
+          end
+
           def csv_titles
             [
               *@attributes.map { |attr| csv_title(attr.name) },

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

@@ -9,18 +9,18 @@ module ActiveRecord
             @options[:size] ||= 1
           end
 
-          def export(activerecord_or_activerecords)
-            activerecord_or_activerecords ||= []
+          def export(record_or_records)
+            record_or_records ||= []
 
-            # has_many でしか使わない想定なので activerecord_or_activerecords は Array のはず
+            # has_many でしか使わない想定なので record_or_records は Array のはず
             (1..options[:size]).inject({}) do |values, index|
               update_translator(index)
 
-              values.merge(super(activerecord_or_activerecords[index-1]))
+              values.merge(super(record_or_records[index-1]))
             end
           end
 
-          def import(csv_row, parent_activerecord_id = nil)
+          def import(csv_body_row, parent_record_id = nil)
             # has_many でしか使わない想定なので Array を返却
             (1..options[:size]).map do |index|
               update_translator(index)
@@ -29,6 +29,13 @@ module ActiveRecord
             end
           end
 
+          def verify_csv_titles(csv_title_row)
+            # size は可変長なので、'1'だけ検証する
+            update_translator(1)
+
+            super
+          end
+
           def csv_titles
             (1..options[:size]).flat_map do |index|
               update_translator(index)

data/lib/activerecord-bixformer/plan.rb

@@ -9,20 +9,20 @@ module ActiveRecord
         class_attribute :__bixformer_model
         class_attribute :__bixformer_namespace
         class_attribute :__bixformer_entry
-        class_attribute :__bixformer_optional_attributes
+        class_attribute :__bixformer_preferred_skip_attributes
         class_attribute :__bixformer_required_attributes
-        class_attribute :__bixformer_unique_indexes
+        class_attribute :__bixformer_unique_attributes
         class_attribute :__bixformer_required_condition
         class_attribute :__bixformer_default_values
         class_attribute :__bixformer_translation_config
 
-        self.__bixformer_entry               = {}
-        self.__bixformer_optional_attributes = []
-        self.__bixformer_required_attributes = []
-        self.__bixformer_unique_indexes      = []
-        self.__bixformer_required_condition  = {}
-        self.__bixformer_default_values      = {}
-        self.__bixformer_translation_config  = { scope: :bixformer, extend_scopes: [] }
+        self.__bixformer_entry                     = {}
+        self.__bixformer_preferred_skip_attributes = []
+        self.__bixformer_required_attributes       = []
+        self.__bixformer_unique_attributes         = []
+        self.__bixformer_required_condition        = {}
+        self.__bixformer_default_values            = {}
+        self.__bixformer_translation_config        = { scope: :bixformer, extend_scopes: [] }
       end
 
       module ClassMethods
@@ -35,7 +35,7 @@ module ActiveRecord
         end
 
         [
-          :entry, :optional_attributes, :required_attributes, :unique_indexes,
+          :entry, :preferred_skip_attributes, :required_attributes, :unique_attributes,
           :required_condition, :default_values, :translation_config
         ].each do |config_name|
           define_method "bixformer_#{config_name}" do |v|

data/lib/activerecord-bixformer/plan_accessor.rb

@@ -11,6 +11,10 @@ module ActiveRecord
         @plan
       end
 
+      def for
+        @plan.class.__bixformer_model
+      end
+
       def value_of(config_name)
         compile_config_value(config_name).dup
       end

data/lib/activerecord-bixformer/to/csv.rb

@@ -16,40 +16,6 @@ module ActiveRecord
 
           model.csv_titles.map { |title| body_map[title] }
         end
-
-        # private
-
-        # def csv_body_map_by_model(model, activerecord_or_activerecords)
-        #   activerecord_or_activerecords = if activerecord_or_activerecords.is_a?(::ActiveRecord::Relation)
-        #                                     activerecord_or_activerecords.to_a
-        #                                   else
-        #                                     activerecord_or_activerecords
-        #                                   end
-
-        #   model.generate_export_value(activerecord_or_activerecords).merge(
-        #     csv_body_map_by_association(model, activerecord_or_activerecords)
-        #   )
-        # end
-
-        # def csv_body_map_by_association(model, activerecord_or_activerecords)
-        #   model.associations.inject({}) do |body_map, association_model|
-        #     activerecords = if activerecord_or_activerecords.is_a?(::Array)
-        #                       activerecord_or_activerecords
-        #                     else
-        #                       [activerecord_or_activerecords]
-        #                     end
-
-        #     body_map.merge(
-        #       activerecords.inject({}) do |body_each_map, activerecord|
-        #         association_value = activerecord.__send__(association_model.name)
-
-        #         body_each_map.merge(
-        #           csv_body_map_by_model(association_model, association_value)
-        #         )
-        #       end
-        #     )
-        #   end
-        # end
       end
     end
   end

data/lib/activerecord-bixformer/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Bixformer
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-bixformer
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Hiroaki Otsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord