planter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b346415e35c538e46222ced2131792a27f778fafe169143116c6908ddca88aac
-  data.tar.gz: ed3952a7fd92566b2acb31e0fee881549675f40aa579ebe9115db2f86f302eb0
+  metadata.gz: 39fe6b05679379fdcf8c619b1db28fdac6a6f89eec521b3e8cf3f3667a471c49
+  data.tar.gz: 42693cdccc9239a069996c74455edc658b339a894eff5b984ec00bba47a88797
 SHA512:
-  metadata.gz: d07501dd0544476e04b768277d870f035626f6c00218a9f248e6fe6f7dcae833757162b688a269066bc8daa5dae1d2fb6f20db7c45273245da60f900cde80f3f
-  data.tar.gz: '09e7ba1054d15f7aa68aedaac7915fdda444eac1bff9630402e5f5999f872283e978b5e60b9581310cdd2bbc9ea4688d73b3fd7d6c8781b802b8bb21cee7fb8c'
+  metadata.gz: c3ffd760187e67c1f57b7daf7a1bba7f019470f1324ddaf72d1412c34930ea520eea449aebd0cea43b6b48de948f93ba80f47bafe6de782f550c35daf0bb8508
+  data.tar.gz: cfd8daff8e7d45a9d72411c195b31be7d1ddde9b562a03397b43f0848360c701d569289ab32e3260bf03f765752cd81fa123f3b597d9b08cc69ac9a6cab7bb6f

data/README.md

@@ -144,8 +144,8 @@ class UsersSeeder < Planter::Seeder
 end
 ```
 
-`ERB` can be used in the CSV files if you end the file name with `.csv.erb`.
-For example, `users.csv.erb`.
+`ERB` can be used in the CSV files if you end the file name with `.csv.erb` or
+`.erb.csv`. For example, `users.csv.erb`.
 
 ```
 participant_id,name

data/lib/planter/seeder.rb

@@ -142,7 +142,7 @@ module Planter
     # The csv file corresponding to the model.
     #
     # @return [String]
-    class_attribute :csv_file
+    class_attribute :csv_name
 
     ##
     # The seeding method specified.
@@ -151,79 +151,59 @@ module Planter
     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] seed_method
-      #
-      # @kwarg [Integer] number_of_records
-      #
-      # @kwarg [String] model
-      #
-      # @kwarg [String] parent
-      #
-      # @kwarg [Symbol, String] parent
-      #
-      # @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: :person,
-      #       csv_name: :awesome_users,
-      #       unique_columns %i[username email],
-      #       erb_trim_mode: '<>'
-      #   end
-      def seeding_method(
-        seed_method,
-        number_of_records: 1,
-        model: nil,
-        parent: nil,
-        csv_name: nil,
-        unique_columns: nil,
-        erb_trim_mode: nil
-      )
-        if !SEEDING_METHODS.include?(seed_method.intern)
-          raise ArgumentError, "Method must be: #{SEEDING_METHODS.join(', ')}"
-        end
-
-        self.seed_method = seed_method
-        self.number_of_records = number_of_records
-        self.model = model || to_s.delete_suffix('Seeder').singularize
-        self.parent = parent
-        self.csv_file = determine_csv_filename(csv_name) if 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
+    # 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] seed_method
+    #
+    # @kwarg [Integer] number_of_records
+    #
+    # @kwarg [String] model
+    #
+    # @kwarg [Symbol, String] parent
+    #
+    # @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: :person,
+    #       csv_name: :awesome_users,
+    #       unique_columns %i[username email],
+    #       erb_trim_mode: '<>'
+    #   end
+    def self.seeding_method(
+      seed_method,
+      number_of_records: 1,
+      model: nil,
+      parent: nil,
+      csv_name: nil,
+      unique_columns: nil,
+      erb_trim_mode: nil
+    )
+      if !SEEDING_METHODS.include?(seed_method.intern)
+        raise ArgumentError, "Method must be: #{SEEDING_METHODS.join(', ')}"
       end
 
-      private
-
-      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)
+      self.seed_method = seed_method
+      self.number_of_records = number_of_records
+      self.model = model || to_s.delete_suffix('Seeder').singularize
+      self.parent = parent
+      self.csv_name = csv_name || to_s.delete_suffix('Seeder').underscore
+      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
-
-        raise ArgumentError, "Couldn't find csv for #{model}"
-      end
     end
 
     ##
@@ -231,6 +211,7 @@ module Planter
     # valid +seeding_method+, and not implement its own +seed+ method.
     def seed
       validate_attributes
+      extract_data_from_csv if seed_method == :csv
 
       parent ? create_records_from_parent : create_records
     end
@@ -263,18 +244,11 @@ module Planter
     def validate_attributes # :nodoc:
       case seed_method.intern
       when :csv
-        contents = ::File.read(csv_file)
-        if csv_file.end_with?('.erb')
-          contents = ERB.new(contents, trim_mode: erb_trim_mode).result(binding)
-        end
-
-        @data ||= ::CSV.parse(
-          contents, headers: true, header_converters: :symbol
-        ).map(&:to_hash)
+        raise "Couldn't find csv for #{model}" unless full_csv_name
       when :data_array
-        raise "Must define '@data'" if public_send(:data).nil?
+        raise 'data is not defined in the seeder' if public_send(:data).nil?
       else
-        raise("Must set 'seeding_method'")
+        raise 'seeding_method not defined in the seeder'
       end
     end
 
@@ -304,5 +278,25 @@ module Planter
       @parent_model ||=
         association_options.fetch(:class_name, parent.to_s.classify)
     end
+
+    def full_csv_name
+      @full_csv_name ||=
+        %W[#{csv_name}.csv #{csv_name}.csv.erb #{csv_name}.erb.csv]
+          .map { |f| Rails.root.join(Planter.config.csv_files_directory, f).to_s }
+          .find { |f| ::File.file?(f) }
+    end
+
+    def extract_data_from_csv
+      contents = ::File.read(full_csv_name)
+      if full_csv_name.include?('.erb')
+        contents = ERB.new(contents, trim_mode: erb_trim_mode).result(binding)
+      end
+
+      @data ||= ::CSV.parse(
+        contents,
+        headers: true,
+        header_converters: :symbol
+      ).map(&:to_hash)
+    end
   end
 end

data/lib/planter/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Evan Gray