planter 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ab85b49c50ea3b7ee077d4225083884558ae89c6fa5b2ea4e9410284f890eb
-  data.tar.gz: 2fd36b19ab5064d681323eb5f7e73a95cf710b7af8a587031c84b7175610cfbe
+  metadata.gz: 42b61a78b5034eadac54f7e5a570073851b4a9a6fc20c4fae71a1e49fb8d3df1
+  data.tar.gz: c02538d3a776a89b221b135c4aa2d355a278df35e514d53872f200556bc720dd
 SHA512:
-  metadata.gz: fa74216b4529bcb3d21ccd697574c175ad7dd641d477921108ff9949e1ab9a9537cf6f4847b6e2aaadeb91e8aecedc6afec243c72250d9b77cce1da0e4926580
-  data.tar.gz: 9b9cb5dd5a29b8a66c8cd9a6c49d5192c1395a5d935a98628928f65babcd709c2a6480ed356bf2f575e0710856a214025efdf91942acf3fe034a39a1369f302a
+  metadata.gz: 119f4f0a790efd00eb4e537734ab51e9416b5017f0891a07698d291b44604b2a81e7ea73d1a8893da1e3f4c24b4790a4a18a352388240d9ed9de32a1f19206b5
+  data.tar.gz: 3c066efbe8b1325bec3218de0840bf91688c6ed1da29e06446756603f370620d5a57af4afc57313fa42171ba977f1dab9cbe73a9578fcb3379e2433935c609b3

data/README.md

@@ -72,7 +72,7 @@ To seed from CSV, you simply need to add the following to your seeder class.
 
 ```ruby
 class UsersSeeder < Planter::Seeder
-  seeding_method :standard_csv
+  seeding_method :csv
 end
 ```
 
@@ -86,15 +86,27 @@ test1@example.com,test1
 test2@example.com,test2
 ```
 
-If the CSV files are not located in the project, you can specify a `:csv_file`
-option. Note that the value must be a full path.
+If the CSV file is named differently than the seeder, you can specify the
+`:csv_name` option. Note that the value should not include the file extension.
 
 ```ruby
 class UsersSeeder < Planter::Seeder
-  seeding_method :standard_csv, csv_file: '/home/me/users.csv'
+  seeding_method :csv, csv_name: :people
 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:
+
+```csv.erb
+email,login_attempts
+<% count = 1 %>
+test2@example.com,<%= count += 1 %>
+test2@example.com,<%= count += 1 %>
+```
+
 Running `rails db:seed` will now seed your `users` table.
 
 ## Seeding from a data array
@@ -148,7 +160,7 @@ end
 
 Note that specifying `number_of_records` in this instance will create that many
 records *for each record of the parent model*. You can also specify the
-association if it's different from the table name, using the `assocation:`
+association if it's different from the table name, using the `:assocation`
 option.
 
 ### Custom seeds
@@ -169,7 +181,7 @@ end
 ```
 
 ## Customization
-You can change the directories of both the seeder files and the csv files. In
+You can change the directories of both the seeder files and the CSV files. In
 your `configure` block in `db/seeds.rb`, you can add the following. Note that,
 in both instances, the path should be relative to `Rails.root`.
 

data/lib/planter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'csv'
+require 'erb'
 require 'planter/version'
 require 'planter/railtie'
 require 'planter/config'
@@ -16,13 +17,13 @@ require 'planter/seeder'
 # 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 table's
 # column names as header. To seed using this method, your class should look
-# like the following. Note that +:csv_file+ is not required; it defaults to the
+# like the following. Note that +:csv_name+ is not required; it defaults to the
 # table name with a +csv+ file extension. The directory where the seed files
 # are kept can be changed via an initializer.
 #   # db/seeds/users_seeder.rb
 #   require 'planter'
 #   class UsersSeeder < Planter::Seeder
-#     seeding_method :standard_csv, csv_file: '/home/me/users.csv'
+#     seeding_method :csv, csv_name: '/home/me/users.csv'
 #   end
 #
 # Another way to seed is to create records from a data array. To do this, your

data/lib/planter/seeder.rb

@@ -8,14 +8,14 @@ module Planter
     # The allowed seeding methods.
     #
     # @return [Array]
-    SEEDING_METHODS = %i[standard_csv data_array].freeze
+    SEEDING_METHODS = %i[csv data_array].freeze
 
     ##
     # Array of hashes used to create records. Your class must set this
     # attribute when using +data_hash+ seeding method, although it's probably
     # more likely that you'll want to define a method that returns a new set of
     # data each time (via +Faker+, +Array#sample+, etc.). When using
-    # +standard_csv+, +data+ will be set to the data within the csv. You can
+    # +csv+, +data+ will be set to the data within the csv. You can
     # override this.
     #
     # @return [Array]
@@ -28,40 +28,49 @@ module Planter
     #
     # @param [Symbol] seeding_method
     #
-    # @param [Hash] options
+    # @kwarg [Integer] number_of_records
+    #
+    # @kwarg [String] model
+    #
+    # @kwarg [String] parent_model
+    #
+    # @kwarg [Symbol, String] association
+    #
+    # @kwarg [Symbol, String] csv_name
     #
     # @example
     #   require 'planter'
     #   class UsersSeeder < Planter::Seeder
-    #     seeding_method :data_array,
+    #     seeding_method :csv,
+    #       number_of_records: 2,
     #       model: 'User'
     #       parent_model: 'Person',
     #       association: :users,
-    #       number_of_records: 2
+    #       csv_name: :awesome_users
     #   end
-    def self.seeding_method(method, **options)
+    def self.seeding_method(
+      method,
+      number_of_records: 1,
+      model: to_s.delete_suffix('Seeder').singularize,
+      parent_model: nil,
+      association: nil,
+      csv_name: nil
+    )
       if !SEEDING_METHODS.include?(method.intern)
         raise ArgumentError, "Method must be one of #{SEEDING_METHODS.join(', ')}"
-      elsif options[:association] && !options[:parent_model]
+      elsif association && !parent_model
         raise ArgumentError, "Must specify :parent_model with :association"
       end
 
       @seeding_method = method
-      @number_of_records = options.fetch(:number_of_records, 1)
-      @model = options.fetch(:model, to_s.delete_suffix('Seeder').singularize)
-      @parent_model = options[:parent_model]
-      @association = @parent_model && options.fetch(:association) do
-        determine_association(options)
-      end
-      return unless @seeding_method == :standard_csv
-
-      @csv_file = options.fetch(:csv_file, Rails.root.join(
-        Planter.config.csv_files_directory,
-        "#{to_s.delete_suffix('Seeder').underscore}.csv"
-      ).to_s)
+      @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
     end
 
-    def self.determine_association(options) # :nodoc:
+    def self.determine_association # :nodoc:
       associations =
         @parent_model.constantize.reflect_on_all_associations.map(&:name)
       table = to_s.delete_suffix('Seeder').underscore.split('/').last
@@ -70,10 +79,23 @@ module Planter
         return t if associations.include?(t)
       end
 
-      raise ArgumentError, 'Could not determine association name'
+      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.
@@ -181,10 +203,13 @@ module Planter
 
     def validate_attributes # :nodoc:
       case seeding_method.intern
-      when :standard_csv
-        raise "#{csv_file} does not exist" unless ::File.file?(csv_file)
+      when :csv
+        contents = File.read(csv_file)
+        if csv_file.end_with?('.erb')
+          contents = ERB.new(contents, trim_mode: '<>').result(binding)
+        end
 
-        @data ||= ::CSV.table(csv_file).map(&:to_hash)
+        @data ||= ::CSV.parse(contents, headers: true).map(&:to_hash)
       when :data_array
         raise "Must define '@data'" if public_send(:data).nil?
       else

data/lib/planter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Evan Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails