csv_step_importer 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364fc1eeae6383c6eb807dd0465db9a1e234fa52ee3b7d24df31593f52d5db64
-  data.tar.gz: 382c087af1d90bdaa69027e4877db716aa5e7ee4ecc7d9c5c3c4eea88efd7004
+  metadata.gz: c7e47c79367ebc96d77f98f8a222efed6058b41e297fd330a5819a3e7449214a
+  data.tar.gz: c60c54fbca29a869584a8ef08bd0149a6d90c4f4f6bfafc6addf89847922c740
 SHA512:
-  metadata.gz: ecff99122347cbb5850788383793df8406ce6cbda00fbb4883b72757b06bb55d2cf119b03806662c671f7fd289d26a227d7b1a15eab5599fd87bb50f31f8be67
-  data.tar.gz: '08a4c0ae13854c7b0e265ecb8590213fe27733b5f3698386c19e69371cd7610416ca2ed17ed4f858f8ec1a662292b009ab3bac7a1312cefdc4cf0543c813692b'
+  metadata.gz: d03d12132eeccfa84468e1f861f25bc462b1d00957f3ccb0719d40437d6a23a8058a35997ada9eadeaaf087fb7051f5950c4a35780404426fcb4df99381ca19d
+  data.tar.gz: aefe551280cb52ca746f57d4d5c5bcd13ade807b3bececd1561fe81bfeea953a93a5ee3b7184b97a4d39d6f1ff91000ee5f12db83d704607f065395e78959e6a

data/CHANGELOG.md

@@ -141,3 +141,19 @@ See lib/csv_step_importer/file.rb for more options
 - Revert "ImportableModel's Importer (uses ActiveRecord::Import) now raises an exception if the import fails"
   Since import! runs validations on the model, I reverted import! to import (validations should be performed inside csv_step_importers logic)
 
+## 2018-09-14 Version 0.12.0
+### Added
+- Added a `set` method to Base, in order to make settings shorter
+  Usage:
+  ```ruby
+    class X < Node
+      set :config_a, true
+      set :config_b, -> { row.some_array.first }
+    end
+  ```
+- Added dao_for to Row
+### Changed
+- Changed settings to use the new set method
+- dao_for's interface changed
+  Before: `dao_for(model: some_model_class_or_instance, pluralize: optional_boolean)`
+  After: `dao_for(some_model_class_or_instance, pluralize: optional_boolean)`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv_step_importer (0.11.2)
+    csv_step_importer (0.12.0)
       activemodel
       activerecord-import
       activesupport

data/lib/csv_step_importer/base.rb

@@ -12,6 +12,12 @@ module CSVStepImporter
     class CSVImportError < RuntimeError; end
     class CSVFileImportError < CSVImportError; end
 
+    # defines a method with the specified proc or a proc returning the value of the second attribute
+    def self.set name, value_or_proc
+      procedure = value_or_proc.is_a?(Proc) ? value_or_proc : -> { value_or_proc }
+      define_method name, procedure
+    end
+
     def assign_attributes(attributes)
       attributes.each do |key, value|
         send("#{key}=", value)

data/lib/csv_step_importer/model/dao.rb

@@ -6,9 +6,21 @@ module CSVStepImporter
       attr_accessor :id, :row, :attributes
 
       delegate :columns, to: :model
+      delegate :dao_for, to: :row
 
       validates :row, presence: true
 
+      #########################################################
+      # Configuration
+      #########################################################
+
+      set :created_at, -> { current_timestamp }
+      set :updated_at, -> { current_timestamp }
+
+      #########################################################
+      # Logic
+      #########################################################
+
       def initialize(parent:, row:, **attributes)
         super parent: parent
 
@@ -51,19 +63,6 @@ module CSVStepImporter
         model.cache[:updated_at] ||= (::ActiveRecord::Base.default_timezone == :utc ? ::Time.now.utc : ::Time.now).to_s(:db)
       end
 
-      def created_at
-        current_timestamp
-      end
-
-      def updated_at
-        current_timestamp
-      end
-
-      # retrieve a dao for a different model using the same CSV row. This is useful e.g. if you use the reflector to get ids of related data
-      def dao_for(model:, pluralize: false)
-        row.cache[model.cache_key(pluralize: pluralize)]
-      end
-
       # link this dao to a row
       def link!
         # add to cache with pluralized key

data/lib/csv_step_importer/model/importable_model.rb

@@ -8,45 +8,31 @@ module CSVStepImporter
       #########################################################
 
       # example: User
-      def model_class
-        raise "please extend and implement"
-      end
+      set :model_class, -> { raise "please extend and implement" }
 
       # set to nil in order to deactivate
-      def importer_class
-        CSVStepImporter::Model::Importer
-      end
+      set :importer_class, CSVStepImporter::Model::Importer
 
       # return CSVStepImporter::Model::Reflector in order to enable reflections (e.g. get ids of all rows)
       # disabled by default
-      def reflector_class
-        nil
-      end
+      set :reflector_class, nil
 
       # NOTE: required only when reflector class is set
       # example: env[:company].company_users
-      def finder_scope
-        model_class.all
-      end
+      set :finder_scope, -> { model_class.all }
 
       # NOTE: required only when reflector class is set
       # example: [:email]
-      def finder_keys
-        composite_key_columns || raise("please extend and implement")
-      end
+      set :finder_keys, -> { composite_key_columns || raise("please extend and implement") }
 
       # NOTE: required only when importer class is set
       # see: https://github.com/zdennis/activerecord-import/wiki/On-Duplicate-Key-Update
-      def on_duplicate_key_ignore
-        false
-      end
+      set :on_duplicate_key_ignore, false
 
       # NOTE: required only when importer class is set
       # example [:email, :updated_at]
       # see: https://github.com/zdennis/activerecord-import/wiki/On-Duplicate-Key-Update
-      def on_duplicate_key_update
-        raise "please extend and implement"
-      end
+      set :on_duplicate_key_update, -> { raise "please extend and implement" }
 
       #########################################################
       # Logic

data/lib/csv_step_importer/model/model.rb

@@ -9,6 +9,18 @@ module CSVStepImporter
       delegate :rows, :cache, to: :parent
       delegate :cache_key, to: :class
 
+      #########################################################
+      # Configuration
+      #########################################################
+
+      set :columns, -> { raise "please extend and implement" } # example: [:email, :updated_at, :created_at]
+      set :composite_key_columns, nil # specify to an array of columns in order filter duplicates from daos
+      set :dao_class, CSVStepImporter::Model::DAO
+
+      #########################################################
+      # Logic
+      #########################################################
+
       def initialize(**attributes)
         super **attributes
 
@@ -26,20 +38,6 @@ module CSVStepImporter
         (pluralize ? key.pluralize : key.singularize).to_sym
       end
 
-      # example: [:email, :updated_at, :created_at]
-      def columns
-        raise "please extend and implement"
-      end
-
-      def dao_class
-        CSVStepImporter::Model::DAO
-      end
-
-      # specify to an array of columns in order filter duplicates from daos
-      def composite_key_columns
-        nil
-      end
-
       #########################################################
       # Logic
       #########################################################

data/lib/csv_step_importer/node.rb

@@ -50,7 +50,7 @@ module CSVStepImporter
     def run_validations!
       super
       errors.empty?
-     end
+    end
 
     def validate_children
       return unless errors.empty?

data/lib/csv_step_importer/row.rb

@@ -16,5 +16,10 @@ module CSVStepImporter
       # Rowの保存処理は基本的にstepsで行います
       true
     end
+
+    # retrieve a dao for a different model using the same CSV row. This is useful e.g. if you use the reflector to get ids of related data
+    def dao_for(model, pluralize: false)
+      cache[model.cache_key(pluralize: pluralize)]
+    end
   end
 end

data/lib/csv_step_importer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CSVStepImporter
-  VERSION = "0.11.2"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_step_importer
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Christian-Manuel Butzke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler