planter 0.0.8 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cefea9dd4547f81df2480f10a92ed64738475a21db8237dac4599a060a80cf19
-  data.tar.gz: 660ecdca12dc88752d353a39e0a6fc0bef2582b7203628002e23f6d246d49589
+  metadata.gz: 37c19399e25198fe0545690d5b5568c5bd91b4736258af3d8664c36abe882889
+  data.tar.gz: a399b54a606d7c0e98d49f0bad5abff1fc4726d96eab3573c82d1dc649b83b1e
 SHA512:
-  metadata.gz: 486bf0a34ac192c6c1295a1b628d25b5e685a83d92700f99291ef35e2ea58b30f5db976057ae87e03a76d48ee29bceacfcde5e5d1018488976f2304f079aafd1
-  data.tar.gz: 3ab0665aa4c97a0a7f405bc93604256a90c2c7e88745d5ded6f908fc17f914fb76cc883f69c5a709fd5210902bc5039f80a294cc26548a8eead99695a1dda529
+  metadata.gz: 6275a47f463227b86374e327781edd92bbd9cdf9399bafa68c6c4cb3316ae812cf081509a26e81e04101f9cd4af43396f2c008477741f00f475ea09436353ba8
+  data.tar.gz: 1a5a27d9253b78ae0c1c0526c1f8dcb977a428ec5c62cb4239f5542413e1f5020c68d8ee0d356ded4c1f3094c7f449f03fefb72180250388de81f8c44c2c6a63

data/README.md

@@ -19,10 +19,12 @@ Features include:
 You can view the documentation [here](https://evanthegrayt.github.io/planter/).
 
 ## Installation
-Add this line to your application's Gemfile:
+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.
 
 ```ruby
-gem 'planter'
+gem 'planter', '0.0.10'
 ```
 
 And then execute:
@@ -50,8 +52,8 @@ Planter.configure do |config|
   ##
   # The list of seeders. These files are stored in the
   # config.seeders_directory, which can be changed below. When a new
-  # seeeder is generated, it will be appended to the bottom of this
-  # list. If the order is incorrect, you'll need to adjust the it.
+  # seeder is generated, it will be appended to the bottom of this
+  # list. If the order is incorrect, you'll need to adjust it.
   # Just be sure to keep the ending bracket on its own line, or the
   # generator won't know where to put new elements.
   config.seeders = %i[
@@ -64,6 +66,10 @@ Planter.configure do |config|
   ##
   # The directory where CSVs are kept.
   # config.csv_files_directory = 'db/seed_files'
+
+  ##
+  # The default trim mode for ERB.
+  # config.erb_trim_mode = nil
 end
 ```
 
@@ -133,18 +139,37 @@ class UsersSeeder < Planter::Seeder
 end
 ```
 
-`ERB` can be used in the CSV files if you name it with `.erb` at the end of the
-file name. For example, `users.csv.erb`. Note that lines starting with `<%` and
-ending with `%>` will not be considered rows, so you can use `ERB` rows to set
-values. For example:
+`ERB` can be used in the CSV files if you end the file name with `.csv.erb`.
+For example, `users.csv.erb`.
+
+```
+participant_id,name
+<%= Participant.find_by(email: 'test1@example.com').id %>,"Test User1"
+<%= Participant.find_by(email: 'test2@example.com').id %>,"Test User2"
+```
+
+Note that, if you need to change the trim mode for ERB, you can set a default in
+the initializer.
+
+```ruby
+Planter.configure do |config|
+  config.seeders = %i[
+    users
+  ]
+  config.erb_trim_mode = '<>'
+end
+```
+
+...or, for individual seeders, via `seeding_method`.
 
-```csv.erb
-email,login_attempts
-<% count = 1 %>
-test2@example.com,<%= count += 1 %>
-test2@example.com,<%= count += 1 %>
+```ruby
+class UsersSeeder < Planter::Seeder
+  seeding_method :csv, erb_trim_mode: '<>'
+end
 ```
 
+For help with `erb_trim_mode`, see the help documentation for `ERB::new`.
+
 Running `rails planter:seed` will now seed your `users` table.
 
 ## Seeding from a data array

data/lib/generators/planter/initializer_generator.rb

@@ -11,8 +11,8 @@ module Planter
             ##
             # The list of seeders. These files are stored in the
             # config.seeders_directory, which can be changed below. When a new
-            # seeeder is generated, it will be appended to the bottom of this
-            # list. If the order is incorrect, you'll need to adjust the it.
+            # seeder is generated, it will be appended to the bottom of this
+            # list. If the order is incorrect, you'll need to adjust it.
             # Just be sure to keep the ending bracket on its own line, or the
             # generator won't know where to put new elements.
             config.seeders = %i[
@@ -25,6 +25,10 @@ module Planter
             ##
             # The directory where CSVs are kept.
             # config.csv_files_directory = 'db/seed_files'
+
+            ##
+            # The default trim mode for ERB.
+            # config.erb_trim_mode = nil
           end
         EOF
       end

data/lib/planter/config.rb

@@ -42,6 +42,15 @@ module Planter
     # @return [Boolean]
     attr_accessor :quiet
 
+    ##
+    # The default trim mode for ERB. Must be "%", "<>", ">", or "-".
+    # For more information, see documentation for +ERB::new+.
+    #
+    # @param [String] erb_trim_mode
+    #
+    # @return [String]
+    attr_accessor :erb_trim_mode
+
     ##
     # Create a new instance of the config.
     def initialize

data/lib/planter/seeder.rb

@@ -65,6 +65,23 @@ module Planter
   #     end
   #   end
   #
+  # By default, all fields are used to look up the record. If it already
+  # exists, it is not re-created. If you have specific fields that a record
+  # should be looked-up by, you can pass the +unique_columns+ option. This will
+  # attempt to look up the record by those fields only, and if one doesn't
+  # exist, one will be created with the rest of the attributes. An example of
+  # when this would be useful is with Devise; you can't pass +password+ in the
+  # create method, so specifying +unique_columns+ on everything except
+  # +password+ allows it to be passed as an attribute to the +first_or_create+
+  # call.
+  #   require 'planter'
+  #   class UsersSeeder < Planter::Seeder
+  #     seeding_method :data_array, unique_columns: %i[username email]
+  #     def data
+  #       [{username: 'foo', email: 'bar', password: 'Example'}]
+  #     end
+  #   end
+  #
   # If you need to seed a different way, put your own custom +seed+ method in
   # your seeder class and do whatever needs to be done.
   class Seeder
@@ -101,6 +118,10 @@ module Planter
     #
     # @kwarg [Symbol, String] csv_name
     #
+    # @kwarg [Symbol, String] unique_columns
+    #
+    # @kwarg [String] erb_trim_mode
+    #
     # @example
     #   require 'planter'
     #   class UsersSeeder < Planter::Seeder
@@ -109,15 +130,19 @@ module Planter
     #       model: 'User'
     #       parent_model: 'Person',
     #       association: :users,
-    #       csv_name: :awesome_users
+    #       csv_name: :awesome_users,
+    #       unique_columns %i[username email],
+    #       erb_trim_mode: '<>'
     #   end
     def self.seeding_method(
       method,
       number_of_records: 1,
-      model: to_s.delete_suffix('Seeder').singularize,
+      model: nil,
       parent_model: nil,
       association: nil,
-      csv_name: nil
+      csv_name: nil,
+      unique_columns: nil,
+      erb_trim_mode: nil
     )
       if !SEEDING_METHODS.include?(method.intern)
         raise ArgumentError, "Method must be one of #{SEEDING_METHODS.join(', ')}"
@@ -127,10 +152,16 @@ module Planter
 
       @seeding_method = method
       @number_of_records = number_of_records
-      @model = model
+      @model = model || to_s.delete_suffix('Seeder').singularize
       @parent_model = parent_model
       @association = @parent_model && (association || determine_association)
       @csv_file = determine_csv_filename(csv_name) if @seeding_method == :csv
+      @erb_trim_mode = erb_trim_mode || Planter.config.erb_trim_mode
+      @unique_columns =
+        case unique_columns
+        when String, Symbol then [unique_columns.intern]
+        when Array then unique_columns.map(&:intern)
+        end
     end
 
     def self.determine_association # :nodoc:
@@ -152,7 +183,7 @@ module Planter
       ).to_s + '.csv'
       [file, "#{file}.erb"].each do |f|
         fname = Rails.root.join(Planter.config.csv_files_directory, f).to_s
-        return fname if File.file?(fname)
+        return fname if ::File.file?(fname)
       end
 
       raise ArgumentError, "Couldn't find csv for #{@model}"
@@ -225,14 +256,31 @@ module Planter
       @csv_file ||= self.class.instance_variable_get('@csv_file')
     end
 
+    ##
+    # When creating a record, the fields that will be used to look up the
+    # record. If it already exists, a new one will not be created.
+    #
+    # @return [Array]
+    def unique_columns
+      @unique_columns ||= self.class.instance_variable_get('@unique_columns')
+    end
+
+    ##
+    # What trim mode should ERB use?
+    #
+    # @return [String]
+    def erb_trim_mode
+      @erb_trim_mode ||= self.class.instance_variable_get('@erb_trim_mode')
+    end
+
     ##
     # Creates records from the +data+ attribute.
     def create_records
       data.each do |rec|
         number_of_records.times do
-          model.constantize.where(
-            rec.transform_values { |value| value == 'NULL' ? nil : value }
-          ).first_or_create!
+          rec.transform_values { |value| value == 'NULL' ? nil : value }
+          unique, attrs = split_record(rec)
+          model.constantize.where(unique).first_or_create!(attrs)
         end
       end
     end
@@ -250,34 +298,47 @@ module Planter
 
     private
 
-    def create_method
+    def create_method # :nodoc:
       parent_model.constantize.reflect_on_association(
         association
       ).macro.to_s.include?('many') ? :create_has_many : :create_has_one
     end
 
-    def create_has_many(assoc_rec, association, rec)
-      assoc_rec.public_send(association).where(rec).first_or_create!
+    def create_has_many(assoc_rec, association, rec) # :nodoc:
+      unique, attrs = split_record(rec)
+      assoc_rec.public_send(association).where(unique).first_or_create!(attrs)
     end
 
-    def create_has_one(assoc_rec, association, rec)
-      assoc_rec.public_send("create_#{association}", rec)
+    def create_has_one(assoc_rec, association, rec) # :nodoc:
+      if assoc_rec.public_send(association)
+        assoc_rec.public_send(association).update_attributes(rec)
+      else
+        assoc_rec.public_send("create_#{association}", rec)
+      end
     end
 
     def validate_attributes # :nodoc:
       case seeding_method.intern
       when :csv
-        contents = File.read(csv_file)
+        contents = ::File.read(csv_file)
         if csv_file.end_with?('.erb')
-          contents = ERB.new(contents, trim_mode: '<>').result(binding)
+          contents = ERB.new(contents, trim_mode: erb_trim_mode).result(binding)
         end
 
-        @data ||= ::CSV.parse(contents, headers: true).map(&:to_hash)
+        @data ||= ::CSV.parse(
+          contents, headers: true, header_converters: :symbol
+        ).map(&:to_hash)
       when :data_array
         raise "Must define '@data'" if public_send(:data).nil?
       else
         raise("Must set 'seeding_method'")
       end
     end
+
+    def split_record(rec) # :nodoc:
+      return [rec, {}] unless unique_columns
+      u = unique_columns.each_with_object({}) { |c, h| h[c] = rec.delete(c) }
+      [u, rec]
+    end
   end
 end

data/lib/planter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.12
 platform: ruby
 authors:
 - Evan Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Framework for seeding rails applications.