planter 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39fe6b05679379fdcf8c619b1db28fdac6a6f89eec521b3e8cf3f3667a471c49
-  data.tar.gz: 42693cdccc9239a069996c74455edc658b339a894eff5b984ec00bba47a88797
+  metadata.gz: a542b8919dda44137996b078e0ac3f773fc8b85bed2225193de3f2a36bdfe099
+  data.tar.gz: '058271874209001fd8de03630c2e3f162959621769225bb354060f1ed8848354'
 SHA512:
-  metadata.gz: c3ffd760187e67c1f57b7daf7a1bba7f019470f1324ddaf72d1412c34930ea520eea449aebd0cea43b6b48de948f93ba80f47bafe6de782f550c35daf0bb8508
-  data.tar.gz: cfd8daff8e7d45a9d72411c195b31be7d1ddde9b562a03397b43f0848360c701d569289ab32e3260bf03f765752cd81fa123f3b597d9b08cc69ac9a6cab7bb6f
+  metadata.gz: c9728b99a23877a7f96f4267b963dd7f4e15f4c385303759476937f7f3f33bd6335ec0e6b89fde733ecfd7f5380386ba86ca26bfbdb9ac70f587b8a05efc8812
+  data.tar.gz: 1af8f9af55ca77f91f2ef7c01b8cb2c1919166be12f8785d779137d68237050b1ab259726da9546dea7dd2184f85431930e9ec8785d269c16ee1ba6add884b92

data/README.md

@@ -21,10 +21,10 @@ You can view the documentation [here](https://evanthegrayt.github.io/planter/).
 ## Installation
 Add the following line to your application's Gemfile. Because this plugin is
 currently a pre-release version, it's recommended to lock it to a specific
-version, as breaking changes may occur, even at the patch level.
+version, as breaking changes may occur, even at the minor level.
 
 ```ruby
-gem 'planter', '0.0.10'
+gem 'planter', '0.1.3'
 ```
 
 And then execute:
@@ -83,6 +83,7 @@ allows you to use `db:seed` for other purposes. If you want Planter to hook
 into the existing `db:seed` task, simply add the following to `db/seeds.rb`.
 
 ```ruby
+# db/seeds.rb
 Planter.seed
 ```
 
@@ -175,6 +176,38 @@ end
 
 For help with `erb_trim_mode`, see the help documentation for `ERB::new`.
 
+Lastly, it's worth mentioning `transformations` under the CSV section, as that's
+usually the pace where they're needed most, but it will work with any method.
+
+If you're seeding with a CSV, and it contains values that need to have code
+executed on them before it's imported into the database, you can define an
+instance variable called `@transformations`, or a method called
+`transformations`, that returns a Hash of field names, and Procs to run on the
+value. For example, if you have an `admin` column, and the CSV contains "true",
+it will come through as a String, but you probably want it to be a Boolean. This
+can be solved with the following.
+
+```ruby
+class UsersSeeder < Planter::Seeder
+  seeding_method :csv
+
+  def transformations
+    {
+      admin: ->(value) { value == 'true' },
+      last_name: ->(value, row) { "#{value} #{row[:suffix]}".squish }
+    }
+  end
+end
+```
+
+When defining a Proc/Lambda, you can make it accept 0, 1, or 2 arguments.
+- When `0`, the value is replaced by the result of the Lambda
+- When `1`, the value is passed to the Lambda, and is subsequently replaced by
+  the result of the Lambda
+- When `2`, the value is the first argument, and the entire row, as a Hash, is
+  the second argument. This allows for more complicated transformations that can
+  be dependent on other fields and values in the record.
+
 Running `rails planter:seed` will now seed your `users` table.
 
 ## Seeding from a data array

data/lib/planter/seeder.rb

@@ -102,6 +102,35 @@ module Planter
     # @return [Array]
     attr_reader :data
 
+    ##
+    # A hash of user-defined column names and procs to be run on values. This
+    # is most useful for when seeding from csv, and you need to transform, say,
+    # 'true' (String) into true (Boolean). The user may define this as an
+    # instance variable, or define a method that returns the hash.
+    #
+    # When defining a Proc/Lambda, you can make it accept 0, 1, or 2 arguments.
+    # - When 0, the value is replaced by the result of the Lambda.
+    # - When 1, the value is passed to the Lambda, and is subsequently
+    #   replaced by the result of the Lambda.
+    # - When 2, the value is the first argument, and the entire row, as a
+    #   Hash, is the second argument. This allows for more complicated
+    #   transformations that can be dependent on other fields and values in the
+    #   record.
+    #
+    # @return [Hash, nil]
+    #
+    # @example
+    #   class UsersSeeder < Planter::Seeder
+    #     seeding_method :csv
+    #     def transformations
+    #       {
+    #         admin: ->(v) { v == 'true' },
+    #         last_name: ->(value, row) { "#{value} #{row[:suffix]}".squish }
+    #       }
+    #     end
+    #   end
+    attr_reader :transformations
+
     ##
     # What trim mode should ERB use?
     #
@@ -189,7 +218,7 @@ module Planter
       unique_columns: nil,
       erb_trim_mode: nil
     )
-      if !SEEDING_METHODS.include?(seed_method.intern)
+      unless SEEDING_METHODS.include?(seed_method.intern)
         raise ArgumentError, "Method must be: #{SEEDING_METHODS.join(', ')}"
       end
 
@@ -216,7 +245,7 @@ module Planter
       parent ? create_records_from_parent : create_records
     end
 
-    protected
+    private
 
     ##
     # Creates records from the +data+ attribute.
@@ -234,7 +263,7 @@ module Planter
 
     def create_record(record, parent_id: nil)
       number_of_records.times do
-        unique, attrs = split_record(record)
+        unique, attrs = split_record(apply_transformations(record))
         model.constantize.where(
           unique.tap { |u| u[foreign_key] = parent_id if parent_id }
         ).first_or_create!(attrs)
@@ -252,6 +281,27 @@ module Planter
       end
     end
 
+    def apply_transformations(record)
+      return record if public_send(:transformations).nil?
+
+      Hash[record.map { |field, value| map_record(field, value, record) }]
+    end
+
+    def map_record(field, value, record)
+      [
+        field,
+        transformations.key?(field) ? transform(field, value, record) : value
+      ]
+    end
+
+    def transform(field, value, record)
+      case transformations[field].arity
+      when 0 then transformations[field].call
+      when 1 then transformations[field].call(value)
+      when 2 then transformations[field].call(value, record)
+      end
+    end
+
     def split_record(rec) # :nodoc:
       return [rec, {}] unless unique_columns
 

data/lib/planter/version.rb

@@ -21,7 +21,7 @@ module Planter
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 2
+    PATCH = 3
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Evan Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails