planter 0.0.10 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259e8d195e480b9b5f16d67ee729d822f9c67131650997d2c95958f1356d76ab
-  data.tar.gz: f2722663f8f1628268208dd0e35da17507a62b339e0dc45004ba16c59f0879b5
+  metadata.gz: 65eb2897cfca2aa456d13a8044d6a86ed9b898aced01a3718e4d11f5dc718da1
+  data.tar.gz: 2dec806f05018f1bdf1e81282047dba3f049274cf6397aeaa8db55ff7bf8856c
 SHA512:
-  metadata.gz: 3598c5503a8fef0db359b9ba6bcbd29e22ca3566e6f9ec0ebf0daa9a23961a227cad94478178b700d7b696b638fed51ea9bb61c5a71fb7a1874eb0765c6334ec
-  data.tar.gz: 92d6beec3c0c16fb9dd03d3b26fe6aadf94e28298f058795508c18863e6e41c0f3034c254eb995804d59f211c14bbdc1565848260026b0cf4c2e87f9bd1f7f6e
+  metadata.gz: 752f29be613b3ce52fad80262ec500db79176329ac802c44f582375be3304c2435653fea1698ac1475f7da938250833f6807fa4b98f558806594db331024dc21
+  data.tar.gz: 46c6632d2faed5ab3ee96a4084de5043dd4312048cd1299dbb45910b537e0f5376b087f80e0e97f5ebc041334876cf47f048bbc8df97e6b052489e5c4bccd8d4

data/README.md

@@ -60,12 +60,21 @@ Planter.configure do |config|
   ]
 
   ##
-  # The directory where the seeder files are kept.
+  # The directory where the seeders are kept.
   # config.seeders_directory = 'db/seeds'
 
   ##
   # The directory where CSVs are kept.
   # config.csv_files_directory = 'db/seed_files'
+
+  ##
+  # The default trim mode for ERB. Valid modes are:
+  # '%'  enables Ruby code processing for lines beginning with %
+  # '<>' omit newline for lines starting with <% and ending in %>
+  # '>'  omit newline for lines ending in %>
+  # '-'  omit blank lines ending in -%>
+  # I recommend reading the help documentation for ERB::new()
+  # config.erb_trim_mode = nil
 end
 ```
 
@@ -135,18 +144,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`.
 
 ```
-email,login_attempts
-<% count = 1 %>
-test2@example.com,<%= count += 1 %>
-test2@example.com,<%= count += 1 %>
+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`.
+
+```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
@@ -234,4 +262,4 @@ Request.
 I do these projects for fun, and I enjoy knowing that they're helpful to people.
 Consider starring [the repository](https://github.com/evanthegrayt/planter)
 if you like it! If you love it, follow me [on
-Github](https://github.com/evanthegrayt)!
+GitHub](https://github.com/evanthegrayt)!

data/lib/generators/planter/initializer_generator.rb

@@ -19,12 +19,21 @@ module Planter
             ]
 
             ##
-            # The directory where the seeder files are kept.
+            # The directory where the seeders are kept.
             # config.seeders_directory = 'db/seeds'
 
             ##
             # The directory where CSVs are kept.
             # config.csv_files_directory = 'db/seed_files'
+
+            ##
+            # The default trim mode for ERB. Valid modes are:
+            # '%'  enables Ruby code processing for lines beginning with %
+            # '<>' omit newline for lines starting with <% and ending in %>
+            # '>'  omit newline for lines ending in %>
+            # '-'  omit blank lines ending in -%>
+            # I recommend reading the help documentation for ERB::new()
+            # config.erb_trim_mode = nil
           end
         EOF
       end

data/lib/generators/planter/seeder_generator.rb

@@ -3,7 +3,7 @@ module Planter
     class SeederGenerator < Rails::Generators::Base
       argument :seeder, required: true
 
-      desc "This generator creates a seeder file at #{::Planter.config.seeders_directory}"
+      desc "Creates a seeder file at #{::Planter.config.seeders_directory}"
 
       def generate_seeders
         seeder == 'ALL' ? tables.each { |t| generate(t) } : generate(seeder)

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

@@ -2,13 +2,13 @@
 
 module Planter
   ##
-  # Class that seeders should inherit from. Seeder files should be in
-  # +db/seeds+, and named +TABLE_seeder.rb+, where +TABLE+ is the name of the
-  # table being seeded (I.E. +users_seeder.rb+). If your seeder is named
-  # differently than the table, you'll need to specify the table with the
-  # +model+ option. The seeder's class name should be the same as the file
-  # name, but camelized. So, +UsersSeeder+. The directory where the seeder
-  # files are located can be changed via an initializer.
+  # Class that seeders should inherit from. Seeders should be in +db/seeds+,
+  # and named +TABLE_seeder.rb+, where +TABLE+ is the name of the table being
+  # seeded (I.E. +users_seeder.rb+). If your seeder is named differently than
+  # the table, you'll need to specify the table with the +model+ option. The
+  # seeder's class name should be the same as the file name, but camelized. So,
+  # +UsersSeeder+. The directory where the seeder files are located can be
+  # changed via an initializer.
   #
   # The most basic way to seed is to have a CSV file with the same name as the
   # table in +db/seed_files/+. So, +users.csv+. This CSV should have the
@@ -102,118 +102,24 @@ module Planter
     attr_reader :data
 
     ##
-    # If your class is going to use the inherited +seed+ method, you must tell
-    # it which +seeding_method+ to use. The argument to this method must be
-    # included in the +SEEDING_METHODS+ array.
+    # What trim mode should ERB use?
     #
-    # @param [Symbol] seeding_method
-    #
-    # @kwarg [Integer] number_of_records
-    #
-    # @kwarg [String] model
-    #
-    # @kwarg [String] parent_model
-    #
-    # @kwarg [Symbol, String] association
-    #
-    # @kwarg [Symbol, String] csv_name
-    #
-    # @kwarg [Symbol, String] unique_columns
-    #
-    # @example
-    #   require 'planter'
-    #   class UsersSeeder < Planter::Seeder
-    #     seeding_method :csv,
-    #       number_of_records: 2,
-    #       model: 'User'
-    #       parent_model: 'Person',
-    #       association: :users,
-    #       csv_name: :awesome_users,
-    #       unique_columns %i[username email]
-    #   end
-    def self.seeding_method(
-      method,
-      number_of_records: 1,
-      model: to_s.delete_suffix('Seeder').singularize,
-      parent_model: nil,
-      association: nil,
-      csv_name: nil,
-      erb_trim_mode: nil,
-      unique_columns: nil
-    )
-      if !SEEDING_METHODS.include?(method.intern)
-        raise ArgumentError, "Method must be one of #{SEEDING_METHODS.join(', ')}"
-      elsif association && !parent_model
-        raise ArgumentError, "Must specify :parent_model with :association"
-      end
-
-      @seeding_method = method
-      @number_of_records = number_of_records
-      @model = model
-      @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
-      @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:
-      associations =
-        @parent_model.constantize.reflect_on_all_associations.map(&:name)
-      table = to_s.delete_suffix('Seeder').underscore.split('/').last
-
-      [table, table.singularize].map(&:intern).each do |t|
-        return t if associations.include?(t)
-      end
-
-      raise ArgumentError, "Couldn't determine association name"
-    end
-    private_class_method :determine_association
-
-    def self.determine_csv_filename(csv_name) # :nodoc:
-      file = (
-        csv_name || "#{to_s.delete_suffix('Seeder').underscore}"
-      ).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)
-      end
-
-      raise ArgumentError, "Couldn't find csv for #{@model}"
-    end
-    private_class_method :determine_csv_filename
-
-    ##
-    # The default seed method. To use this method, your class must provide a
-    # valid +seeding_method+, and not implement its own +seed+ method.
-    def seed
-      validate_attributes
-
-      parent_model ? create_records_from_parent : create_records
-    end
-
-    protected
+    # @return [String]
+    class_attribute :erb_trim_mode
 
     ##
-    # The seeding method specified.
+    # 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 [Symbol]
-    def seeding_method
-      @seeding_method ||= self.class.instance_variable_get('@seeding_method')
-    end
+    # @return [Array]
+    class_attribute :unique_columns
 
     ##
     # The model for the table being seeded. If the model name you need is
     # different, change via +seeding_method+.
     #
     # @return [String]
-    def model
-      @model ||= self.class.instance_variable_get('@model')
-    end
+    class_attribute :model
 
     ##
     # The model of the parent. When provided with +association+, records in the
@@ -221,18 +127,7 @@ module Planter
     # class must set this attribute via +seeding_method+.
     #
     # @return [String]
-    def parent_model
-      @parent_model ||= self.class.instance_variable_get('@parent_model')
-    end
-
-    ##
-    # When using +parent_model+, the association name. Your class can set this
-    # attribute via +seeding_method+.
-    #
-    # @return [Symbol]
-    def association
-      @association ||= self.class.instance_variable_get('@association')
-    end
+    class_attribute :parent_model
 
     ##
     # The number of records to create from each record in the +data+ array. If
@@ -240,36 +135,131 @@ module Planter
     # +seeding_method+.
     #
     # @return [Integer]
-    def number_of_records
-      @number_of_records ||=
-        self.class.instance_variable_get('@number_of_records')
-    end
+    class_attribute :number_of_records
+
+    ##
+    # When using +parent_model+, the association name. Your class can set this
+    # attribute via +seeding_method+.
+    #
+    # @return [Symbol]
+    class_attribute :association
 
     ##
     # The csv file corresponding to the model.
     #
     # @return [String]
-    def csv_file
-      @csv_file ||= self.class.instance_variable_get('@csv_file')
-    end
+    class_attribute :csv_file
 
     ##
-    # 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.
+    # The seeding method specified.
     #
-    # @return [Array]
-    def unique_columns
-      @unique_columns ||= self.class.instance_variable_get('@unique_columns')
+    # @return [Symbol]
+    class_attribute :seed_method
+
+    ##
+    # Access the metaclass so we can define public and private class methods.
+    class << self
+      ##
+      # If your class is going to use the inherited +seed+ method, you must tell
+      # it which +seeding_method+ to use. The argument to this method must be
+      # included in the +SEEDING_METHODS+ array.
+      #
+      # @param [Symbol] seeding_method
+      #
+      # @kwarg [Integer] number_of_records
+      #
+      # @kwarg [String] model
+      #
+      # @kwarg [String] parent_model
+      #
+      # @kwarg [Symbol, String] association
+      #
+      # @kwarg [Symbol, String] csv_name
+      #
+      # @kwarg [Symbol, String] unique_columns
+      #
+      # @kwarg [String] erb_trim_mode
+      #
+      # @example
+      #   require 'planter'
+      #   class UsersSeeder < Planter::Seeder
+      #     seeding_method :csv,
+      #       number_of_records: 2,
+      #       model: 'User'
+      #       parent_model: 'Person',
+      #       association: :users,
+      #       csv_name: :awesome_users,
+      #       unique_columns %i[username email],
+      #       erb_trim_mode: '<>'
+      #   end
+      def seeding_method(
+        method,
+        number_of_records: 1,
+        model: nil,
+        parent_model: nil,
+        association: nil,
+        csv_name: nil,
+        unique_columns: nil,
+        erb_trim_mode: nil
+      )
+        if !SEEDING_METHODS.include?(method.intern)
+          raise ArgumentError, "Method must be: #{SEEDING_METHODS.join(', ')}"
+        elsif association && !parent_model
+          raise ArgumentError, "Must specify :parent_model with :association"
+        end
+
+        self.seed_method = method
+        self.number_of_records = number_of_records
+        self.model = model || to_s.delete_suffix('Seeder').singularize
+        self.parent_model = parent_model
+        self.association = parent_model && (association || determine_association)
+        self.csv_file = determine_csv_filename(csv_name) if self.seed_method == :csv
+        self.erb_trim_mode = erb_trim_mode || Planter.config.erb_trim_mode
+        self.unique_columns =
+          case unique_columns
+          when String, Symbol then [unique_columns.intern]
+          when Array then unique_columns.map(&:intern)
+          end
+      end
+
+      private
+
+      def determine_association # :nodoc:
+        associations =
+          parent_model.constantize.reflect_on_all_associations.map(&:name)
+        table = to_s.delete_suffix('Seeder').underscore.split('/').last
+
+        [table, table.singularize].map(&:intern).each do |t|
+          return t if associations.include?(t)
+        end
+
+        raise ArgumentError, "Couldn't determine association name"
+      end
+
+      def determine_csv_filename(csv_name) # :nodoc:
+        file = (
+          csv_name || "#{to_s.delete_suffix('Seeder').underscore}"
+        ).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)
+        end
+
+        raise ArgumentError, "Couldn't find csv for #{model}"
+      end
     end
 
     ##
-    # Trim mode for ERB when parsing CSVs.
-    #
-    # @return [String, nil]
-    def erb_trim_mode
-      @erb_trim_mode ||= self.class.instance_variable_get('@erb_trim_mode')
+    # The default seed method. To use this method, your class must provide a
+    # valid +seeding_method+, and not implement its own +seed+ method.
+    def seed
+      validate_attributes
+
+      parent_model ? create_records_from_parent : create_records
     end
 
+    protected
+
     ##
     # Creates records from the +data+ attribute.
     def create_records
@@ -315,7 +305,7 @@ module Planter
     end
 
     def validate_attributes # :nodoc:
-      case seeding_method.intern
+      case seed_method.intern
       when :csv
         contents = ::File.read(csv_file)
         if csv_file.end_with?('.erb')
@@ -333,13 +323,8 @@ module Planter
     end
 
     def split_record(rec) # :nodoc:
-      u = {}
-      model.constantize.reflect_on_all_associations.map(&:name).each do |a|
-        u[a] = rec.delete(a) if rec.key?(a)
-      end
-      return [u, rec] unless unique_columns
-
-      unique_columns.each { |c, h| h[c] = rec.delete(c) }
+      return [rec, {}] unless unique_columns
+      u = unique_columns.each_with_object({}) { |c, h| h[c] = rec.delete(c) }
       [u, rec]
     end
   end

data/lib/planter/version.rb

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

data/lib/planter.rb

@@ -67,7 +67,7 @@ module Planter
   #   Planter.seed
   def self.seed
     seeders = ENV['SEEDERS']&.split(',') || config.seeders&.map(&:to_s)
-    raise RuntimeError, 'No seeders specified' unless seeders&.any?
+    raise RuntimeError, 'No seeders specified' if seeders.blank?
 
     seeders.each do |s|
       require Rails.root.join(config.seeders_directory, "#{s}_seeder.rb").to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.14
 platform: ruby
 authors:
 - Evan Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails