planter 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ca5902ca8e033fca09dedeed1c7f62efbffc3a347149787b7282030045c740
-  data.tar.gz: b79c752f9db2e5ab8b7067a0a7c41066e4ad731d7090f861eb38cfd5d73ef8cc
+  metadata.gz: 65e5880dfef8ccce0bf8fec627a74ab7ee76c9d0f84379079056d934b9210e58
+  data.tar.gz: 2bc7f2d1e88618db03c882291e8dc48b3aa453199f96e235eeab49ec554d0273
 SHA512:
-  metadata.gz: 9db7c6dc7a76a834aa21a69423f4e3bf97d637eee7169c32ec75dc773dfda69a622510ba947c969691ab894d4ed9d098222653273caae06e0e00424d9a166df3
-  data.tar.gz: 6923ec3963d9b6af5c48bc2deb418ab2d9885814e97243501269eb0b6379376457e2dddbc23bd907d00ed75362441bd40563de5349bf71957259ca87244beb34
+  metadata.gz: 011cec287611791d0585a80c83e51bd602eafb9bba60755c5079b1eff6f5218ca3a05e21f1651098acda55055590ae4d9ca649f50e3f4559ca7cd971acf647c4
+  data.tar.gz: 5a11daf5df589cda533596d9039820c0da140f2c2f44eafb40d33a110cbd3aa7fef0a18c78c8c2f7f8d7a4a6dd8ab1f2e3a4d1a0a7a9f3dee3665fece5ff4fd6

data/README.md

@@ -23,7 +23,7 @@ currently a pre-release version, it's recommended to lock it to a specific
 version, as breaking changes may occur, even at the minor level.
 
 ```ruby
-gem 'planter', '0.4.0'
+gem 'planter', '0.4.2'
 ```
 
 And then execute:
@@ -67,11 +67,15 @@ Planter.configure do |config|
 
   ##
   # The directory where the seeders are kept.
-  # config.seeders_directory = 'db/seeds'
+  config.seeders_directory = 'db/seeds'
 
   ##
   # The directory where CSVs are kept.
-  # config.csv_files_directory = 'db/seed_files'
+  config.csv_files_directory = 'db/seed_files'
+
+  ##
+  # When true, don't print output when seeding.
+  config.quiet = false
 
   ##
   # The default trim mode for ERB. Valid modes are:
@@ -80,7 +84,7 @@ Planter.configure do |config|
   # '>'  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
+  config.erb_trim_mode = nil
 end
 ```
 
@@ -348,6 +352,10 @@ class MyAdapter
     # Return the attribute used to attach a parent id to the seeded record.
   end
 
+  def table_columns(model_name:)
+    # Return native columns or fields for model_name.
+  end
+
   def table_names
     # Return table or collection names used by `rails generate planter:seeder ALL`.
   end

data/lib/generators/planter/adapter_generator.rb

@@ -53,6 +53,16 @@ module Planter
                   raise NotImplementedError, "\#{self.class} must implement #foreign_key"
                 end
 
+                ##
+                # Return native columns or fields for the model being seeded.
+                #
+                # @param [String] model_name the model being seeded
+                #
+                # @return [Array<String>]
+                def table_columns(model_name:)
+                  raise NotImplementedError, "\#{self.class} must implement #table_columns"
+                end
+
                 ##
                 # Return table or collection names that can have seeders generated.
                 #

data/lib/generators/planter/initializer_generator.rb

@@ -27,11 +27,15 @@ module Planter
 
             ##
             # The directory where the seeders are kept.
-            # config.seeders_directory = 'db/seeds'
+            config.seeders_directory = 'db/seeds'
 
             ##
             # The directory where CSVs are kept.
-            # config.csv_files_directory = 'db/seed_files'
+            config.csv_files_directory = 'db/seed_files'
+
+            ##
+            # When true, don't print output when seeding.
+            config.quiet = false
 
             ##
             # The default trim mode for ERB. Valid modes are:
@@ -40,7 +44,7 @@ module Planter
             # '>'  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
+            config.erb_trim_mode = nil
           end
         EOF
       end

data/lib/planter/adapters/active_record.rb

@@ -9,6 +9,7 @@ module Planter
     # - +create_record(model_name:, lookup_attributes:, create_attributes:)+
     # - +parent_ids(model_name:, parent:)+
     # - +foreign_key(model_name:, parent:)+
+    # - +table_columns(model_name:)+
     # - +table_names+
     #
     # +model_name+ is the configured seeder model name. +parent+ is the
@@ -56,6 +57,16 @@ module Planter
         association_options(model_name, parent).fetch(:foreign_key, "#{parent}_id")
       end
 
+      ##
+      # Return native table columns for the model being seeded.
+      #
+      # @param [String] model_name the model being seeded
+      #
+      # @return [Array<String>]
+      def table_columns(model_name:)
+        model_name.constantize.column_names
+      end
+
       ##
       # Return application table names that can have seeders generated.
       #

data/lib/planter/seeder.rb

@@ -268,6 +268,7 @@ module Planter
     def create_record(record, parent_id: nil)
       unique, attrs = split_record(apply_transformations(record))
       unique = unique.merge(foreign_key => parent_id) if parent_id
+      unique, attrs = filter_lookup_attributes(unique, attrs)
       adapter.create_record(
         model_name: model,
         lookup_attributes: unique,
@@ -334,6 +335,42 @@ module Planter
       [u, rec.except(*unique_columns)]
     end
 
+    def filter_lookup_attributes(lookup_attributes, create_attributes)
+      return [lookup_attributes, create_attributes] unless adapter.respond_to?(:table_columns)
+
+      table_columns = adapter.table_columns(model_name: model).map(&:to_s)
+      native_lookup_attributes = lookup_attributes.select do |field, _value|
+        table_columns.include?(field.to_s)
+      end
+      non_column_lookup_attributes = lookup_attributes.except(*native_lookup_attributes.keys)
+
+      if non_column_lookup_attributes.any?
+        warn_non_column_lookup_attributes(non_column_lookup_attributes.keys)
+      end
+
+      if native_lookup_attributes.empty?
+        raise "No native lookup columns found for #{model}. " \
+          "Add a native table column to the seed data or unique_columns."
+      end
+
+      [
+        native_lookup_attributes,
+        non_column_lookup_attributes.merge(create_attributes)
+      ]
+    end
+
+    def warn_non_column_lookup_attributes(fields)
+      warning_key = [model, fields.map(&:to_s).sort]
+      @warned_non_column_lookup_attributes ||= []
+      return if @warned_non_column_lookup_attributes.include?(warning_key)
+
+      @warned_non_column_lookup_attributes << warning_key
+      warn(
+        "WARNING: Planter moved non-column lookup attributes for #{model} " \
+        "into create attributes: #{warning_key.last.join(", ")}"
+      )
+    end
+
     def foreign_key
       adapter.foreign_key(model_name: model, parent: parent)
     end

data/lib/planter/version.rb

@@ -21,7 +21,7 @@ module Planter
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 0
+    PATCH = 2
 
     module_function
 

metadata

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