planter 0.0.9 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c2952a2b44b89c48245554cd6be4b19598891aa958b3f2f0dd3e3d2548a079
-  data.tar.gz: 91e099c652ce4bfb0bf87320f9efa3d1e0e0826ae031e17e967563beb8561f19
+  metadata.gz: 23a4116a1fe8a8d499e8522e5d4da4dadd76cb95ba917d54855f36adeaec519f
+  data.tar.gz: 523fcef8dd453614e4c1045aafd1ae57b54e7b6043c4fac3b3638ef35c577862
 SHA512:
-  metadata.gz: d70a187f4064ab1081a5a4b3df180f4ced5436601151029fca74b985cc0658e0422b56f338693b08a885a5dfc7d241357ef86144373825d8553117c3e7f6f30e
-  data.tar.gz: 923979e971e3cbc573a9eaffbc39481d8fc8a4930894de1ea8d8f4ef79c3f6d7bbaba0ab111d0099ee67298b336373a0836802126c5d5bba4c237eb41ab0c5d8
+  metadata.gz: eb5d69e3807c0595c4a149cc0eeb487712a18381d86cad82a9e459ca28a19286c77e35b92820932b9be3ced37563632f7d8a27d1a85bf15c55621895bc5f923b
+  data.tar.gz: 9d32d66773a92b393fdac8a90a67ca410251588d61270a35ba8a21f8d1afe74963c5ef81702fffc33ffb59674b7fb953029f19d887f17a26bd7a5b7ae3522df3

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:
@@ -51,19 +53,28 @@ 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
   # seeder is generated, it will be appended to the bottom of this
-  # list. If the order is incorrect, you'll need to adjust the it.
+  # 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[
   ]
 
   ##
-  # 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
 ```
 
@@ -133,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`.
+
+```
+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
@@ -232,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

@@ -12,19 +12,28 @@ module Planter
             # The list of seeders. These files are stored in the
             # config.seeders_directory, which can be changed below. When a new
             # seeder is generated, it will be appended to the bottom of this
-            # list. If the order is incorrect, you'll need to adjust the it.
+            # 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[
             ]
 
             ##
-            # 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,116 +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,
-      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
-      @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
@@ -219,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
@@ -238,28 +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 :seeding_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.seeding_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 seeding_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
 
+    ##
+    # 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
@@ -309,7 +309,7 @@ module Planter
       when :csv
         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(

data/lib/planter/version.rb

@@ -21,7 +21,7 @@ module Planter
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 9
+    PATCH = 13
 
     ##
     # 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.9
+  version: 0.0.13
 platform: ruby
 authors:
 - Evan Gray
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -57,7 +57,7 @@ metadata:
   homepage_uri: https://github.com/evanthegrayt/planter
   source_code_uri: https://github.com/evanthegrayt/planter
   documentation_uri: https://evanthegrayt.github.io/planter/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: Framework for seeding rails applications.
 test_files: []