planter 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cefea9dd4547f81df2480f10a92ed64738475a21db8237dac4599a060a80cf19
-  data.tar.gz: 660ecdca12dc88752d353a39e0a6fc0bef2582b7203628002e23f6d246d49589
+  metadata.gz: 61c2952a2b44b89c48245554cd6be4b19598891aa958b3f2f0dd3e3d2548a079
+  data.tar.gz: 91e099c652ce4bfb0bf87320f9efa3d1e0e0826ae031e17e967563beb8561f19
 SHA512:
-  metadata.gz: 486bf0a34ac192c6c1295a1b628d25b5e685a83d92700f99291ef35e2ea58b30f5db976057ae87e03a76d48ee29bceacfcde5e5d1018488976f2304f079aafd1
-  data.tar.gz: 3ab0665aa4c97a0a7f405bc93604256a90c2c7e88745d5ded6f908fc17f914fb76cc883f69c5a709fd5210902bc5039f80a294cc26548a8eead99695a1dda529
+  metadata.gz: d70a187f4064ab1081a5a4b3df180f4ced5436601151029fca74b985cc0658e0422b56f338693b08a885a5dfc7d241357ef86144373825d8553117c3e7f6f30e
+  data.tar.gz: 923979e971e3cbc573a9eaffbc39481d8fc8a4930894de1ea8d8f4ef79c3f6d7bbaba0ab111d0099ee67298b336373a0836802126c5d5bba4c237eb41ab0c5d8

data/README.md

@@ -50,7 +50,7 @@ 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
+  # 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.
   # Just be sure to keep the ending bracket on its own line, or the
   # generator won't know where to put new elements.

data/lib/generators/planter/initializer_generator.rb

@@ -11,7 +11,7 @@ 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
+            # 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.
             # Just be sure to keep the ending bracket on its own line, or the
             # generator won't know where to put new elements.

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,8 @@ module Planter
     #
     # @kwarg [Symbol, String] csv_name
     #
+    # @kwarg [Symbol, String] unique_columns
+    #
     # @example
     #   require 'planter'
     #   class UsersSeeder < Planter::Seeder
@@ -109,7 +128,8 @@ module Planter
     #       model: 'User'
     #       parent_model: 'Person',
     #       association: :users,
-    #       csv_name: :awesome_users
+    #       csv_name: :awesome_users,
+    #       unique_columns %i[username email]
     #   end
     def self.seeding_method(
       method,
@@ -117,7 +137,8 @@ module Planter
       model: to_s.delete_suffix('Seeder').singularize,
       parent_model: nil,
       association: nil,
-      csv_name: nil
+      csv_name: nil,
+      unique_columns: nil
     )
       if !SEEDING_METHODS.include?(method.intern)
         raise ArgumentError, "Method must be one of #{SEEDING_METHODS.join(', ')}"
@@ -131,6 +152,11 @@ module Planter
       @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:
@@ -152,7 +178,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 +251,23 @@ 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
+
     ##
     # 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 +285,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)
         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 = 9
 
     ##
     # 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.9
 platform: ruby
 authors:
 - Evan Gray
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-06-11 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.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Framework for seeding rails applications.
 test_files: []