activerecord-bixformer 0.4.14 → 0.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ece796f327a3cf4bcf833c066b98121ef08a02a3
-  data.tar.gz: a48f51c405fed75321430c14b0a75f16f3c7ee52
+  metadata.gz: a97223c0df1544574cc93f7cdd489c06fe73fb41
+  data.tar.gz: 2c4870fb05bbef0c998415c6aa929073511a982e
 SHA512:
-  metadata.gz: 34db4f8782098149e84d145ed0ae9d496cfe0753d2771aa1e5cc7337d268e0848aba6558bd56c1deb0c442c559e6497f72deafa4436a2e6208c0f7cddad7af4b
-  data.tar.gz: 7aa3470ff539d7c68fd5e5a6cd25c75f323809b69c51e13a4ab92dd4b0ce0a96331394cab3b9e7d4c78b7634685dfb6a04b1d396d8113db4bc809656ee6b80a9
+  metadata.gz: 1d0aad4cbddfd3fd860b17bd2c0479281c65ef7fca3f000e366fed9a1764d442c926f58e3582cdf399c0785e7c2a5dd4069aad347b0a0222056c9aec8bcfb17b
+  data.tar.gz: d9671482f4a175a2bfaadcfb29a39945e73ff63327949af83ba52746469977af966c538ccc9418026fcc6316391ed37486da7d877f749dbdd2de2645f54a9743

data/README-ja.md

@@ -198,13 +198,16 @@ class SamplePlan
     {
       # 対象モデル（上の例なら user ）は、現在処理対象になっている group に属している
       group_id: current_group.id
-      
+
+      # 関連モデルに対する指定
+      # 関連モデルの場合は、親レコードの foreign_key（上記の場合、 user_id ）も自動で加わります
+      posts: {
+        private: true
+      }
+
       # インポートデータに primary_key や bixformer_unique_attributes がある場合、
       # 更新レコードをデータベース検索しますが、その際にも条件に追加されます
       
-      # 関連モデルの場合は、この設定の有無に関わらず、親レコードの foreign_key が使用されるため、
-      # 関連モデルへの指定はできません
-      
       # primary_key が指定されているのに、データベース検索に失敗した場合には、
       # ActiveRecord::RecordNotFound 例外が raise されます
     }
@@ -230,6 +233,26 @@ class SamplePlan
   end
 
 
+  # [bixformer_sort_indexes] エクスポート時に、出力データ内の属性の出力順の定義
+  #
+  #   - ハッシュを返すProcオブジェクトかメソッド名/シンボルで指定
+  #   - 出力順を整数で指定。それの昇順で出力される
+  #   - 未定義の場合、 bixformer_entry で定義された全属性数（ attributes に指定されたハッシュのキーの合計 ）になる
+  #   - 出力順が同じ場合、 bixformer_entry の定義順になる
+  #
+  bixformer_sort_indexes -> do
+    {
+      # 投稿のタイトルを1番先に出力
+      posts: {
+        title: 1
+      },
+
+      # 次はユーザ名
+      name: 2
+    }
+  end
+
+
   # [bixformer_translation_config] インポート/エクスポートで行われる translation の設定の定義
   #
   #   - CSVでは
@@ -307,9 +330,13 @@ CSV.parse(csv_data).each do |csv_row|
 
     attributes = bixformer.assignable_attributes(csv_row)
     user       = User.new
-    
-    user.assign_attributes(attributes)
-    user.save!
+
+    begin
+      user.assign_attributes(attributes)
+      user.save!
+    rescue ActiveRecord::Bixformer::ImportError => e
+      logger.error e.model.errors.full_messages.join(',')
+    end
 
   end
 end
@@ -327,9 +354,19 @@ Model は各データ形式毎に異なる処理が必要になるため、デ
     * has_one な関連モデル用。 has_many な関連モデルには使えない
 * indexed
     * has_many な関連モデル用。 has_one な関連モデルには使えない
+    * 関連レコード群に 1 から順に index を割当てて、それによってレコードを特定する
     * `size` オプションでインポート/エクスポートするサイズを指定
     * 属性の translation は `投稿%{index}のタイトル` のように指定
-    * モデルの translation は `ユーザ%{index}の` のように指定（関連モデルがさらに indexed だった場合に使われます）
+    * モデルの translation は `ユーザ%{index}の` のように指定（関連モデルがさらに has_many だった場合に使われます）
+* mapped
+    * has_many な関連モデル用。 has_one な関連モデルには使えない
+    * 関連レコード群が、特定の属性の値によって特定できる（自身の foreign_key と、その属性で unique な）場合に使える
+    * `key` オプションに、その属性名を指定
+    * `in` オプションに、関連レコード群の `key` オプションの属性値を配列で指定
+    * 属性の translation は `投稿の種別%{key}` のように指定
+    * モデルの translation は `投稿の種別%{key}の` のように指定（関連モデルがさらに has_many だった場合に使われます）
+    * `translate` オプションで、 translation の `key` 引数の値を変更可能
+        * `key` オプションの属性値が引数になる。 translation の `key` 引数に渡す値を返すこと
 
 ### 本フレームワークに定義されたAttribute一覧
 
@@ -339,19 +376,36 @@ Attribute は、基本的にデータ形式に依らず、使用可能な想定
     * エクスポートでは `to_s` し、インポートでは `strip` して `presence` する
 * boolean
     * `true` / `false` オプションに、それぞれに対応する文字列を指定。デフォルトは、 `"true"` / `"false"`
-    * インポート時、合致しない値は `nil` になる
+    * インポート時、合致しない値だった場合、 `raise` オプションが `true` ならエラーに、 `false` なら nil になる。デフォルトは、 `true`
 * date
     * `format` オプションで、 `Date::DATE_FORMATS` のキーを指定。デフォルトは、 `default`
-    * インポート時、合致しない値はエラーになる
+    * インポート時、合致しない値だった場合、 `raise` オプションが `true` ならエラーに、 `false` なら nil になる。デフォルトは、 `true`
+* integer
+    * エクスポートでは `to_s` し、インポートでは `to_i` する
+    * `greater_than` / `greater_than_or_equal_to` / `less_than` / `less_than_or_equal_to` オプションで、インポートする範囲指定が可能。
+    * インポート時、合致しない値だった場合、 `raise` オプションが `true` ならエラーに、 `false` なら nil になる。デフォルトは、 `true`
 * time
     * `format` オプションで、 `Time::DATE_FORMATS` のキーを指定。デフォルトは、 `default`
-    * インポート時、合致しない値はエラーになる
+    * インポート時、合致しない値だった場合、 `raise` オプションが `true` ならエラーに、 `false` なら nil になる。デフォルトは、 `true`
 * booletania
     * 詳細は、 https://github.com/ryoff/booletania
-    * インポート時、合致しない値は `nil` になる
+    * インポート時、合致しない値だった場合、 `raise` オプションが `true` ならエラーに、 `false` なら nil になる。デフォルトは、 `true`
 * enumerize
     * 詳細は、 https://github.com/brainspec/enumerize
-    * インポート時、合致しない値はエラーになる
+    * インポート時、合致しない値だった場合、 `raise` オプションが `e` ならエラーに、 `false` なら nil になる。デフォルトは、 `true`
+* formatted_foreign_key
+    * belongs_to な関連レコードを id でない値で扱うことができる
+    * 以下のオプションがある
+        * `formatter` (必須) : エクスポート時の出力値を 属性名/メソッド名/Proc で指定
+            * Procの場合、出力対象のActiveRecordインスタンスが引数となる
+        * `parser` : インポート時の関連レコードの検索条件を返すProcを指定。デフォルトは、 `{ #{formatter} => #{インポート値} }`
+        * `scope` : インポート時の関連レコードを検索するスコープを scope名/Proc で指定。デフォルトは、 `対象モデル.all`
+        * `find_by` : インポート時の関連レコードを検索するメソッドを メソッド名/Proc で指定。デフォルトは、 `find_by`
+            * Procの場合、 `scope` オプションの戻り値、 `parser` の戻り値が引数となり、
+            * 関連レコードが検索で見つかった場合は、対象のActiveRecordインスタンスを返すこと
+        * `create` : インポート時、関連レコードが見つからない場合、対応する関連レコードを作成するかどうかを指定。デフォルトは、 `false`
+        * `creator` : インポート時、関連レコードを作成するメソッドを メソッド名/Proc で指定。デフォルトは、 `save`
+            * Procの場合、 buildされたActiveRecordインスタンスが引数となる。それを保存すること。
 * override
     * モデルに処理を委譲する
     * モデルに `override_import_属性名` / `override_export_属性名` を定義すること

data/lib/activerecord-bixformer/assignable_attributes_normalizer.rb

@@ -37,10 +37,7 @@ module ActiveRecord
       end
 
       def set_required_condition
-        # 設定するのはルートの場合のみ
-        return if @model.parent
-
-        @model_attributes.merge!(@plan.value_of(:required_condition))
+        @model_attributes.merge!(@plan.pickup_value_for(@model, :required_condition, {}))
       end
 
       def set_parent_foreign_key
@@ -83,13 +80,14 @@ module ActiveRecord
         return nil unless uniqueness_condition
 
         # 更新対象のレコードを正しく特定できているか確認するための検証条件を取得
-        required_condition = if @model.parent
-                               key = @model.parent_foreign_key
+        required_condition = @plan.pickup_value_for(@model, :required_condition, {})
+
+        # 親がいる場合は、親のID属性を検証条件に追加
+        if @model.parent
+          key = @model.parent_foreign_key
 
-                               { key => @model_attributes[key] }
-                             else
-                               @plan.value_of(:required_condition)
-                             end
+          required_condition[key] = @model_attributes[key]
+        end
 
         # 検証条件は、必ず値がなければならない
         return nil if required_condition.any? { |_k, v| ! presence_value?(v) }

data/lib/activerecord-bixformer/plan_accessor.rb

@@ -47,7 +47,10 @@ module ActiveRecord
           config_value.extract_options!
 
           # Arrayなら、要素は文字列化しておく
-          config_value = config_value.map { |v| v.to_s }
+          config_value = config_value.map(&:to_s)
+        elsif config_name != :entry && config_value.is_a?(::Hash)
+          # 子要素の設定を排除
+          config_value = config_value.except(*model.associations.map(&:name))
         end
 
         config_value || default_value

data/lib/activerecord-bixformer/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Bixformer
-    VERSION = "0.4.14"
+    VERSION = "0.4.15"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-bixformer
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.4.15
 platform: ruby
 authors:
 - Hiroaki Otsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord