planter 0.4.2 → 1.0.0

data/lib/planter.rb

@@ -5,7 +5,11 @@ require "erb"
 require "planter/version"
 require "planter/railtie"
 require "planter/config"
+require "planter/seed_context"
+require "planter/csv_data_source"
+require "planter/record_attributes"
 require "planter/seeder"
+require "planter/validator"
 
 ##
 # The main module for the plugin. It nicely wraps the +Planter::Config+ class
@@ -59,9 +63,9 @@ module Planter
   end
 
   ##
-  # This is the method to call from your +db/seeds.rb+. It callse the seeders
+  # This is the method to call from your +db/seeds.rb+. It calls the seeders
   # listed in +Planter.config.seeders+. To call specific seeders at runtime,
-  # you can set the +SEEDERS+ environmental variable to a comma-separated list
+  # you can set the +SEEDERS+ environment variable to a comma-separated list
   # of seeders, like +rails db:seed SEEDERS=users,accounts+.
   #
   # @example
@@ -80,4 +84,14 @@ module Planter
       "#{s.camelize}Seeder".constantize.new.seed
     end
   end
+
+  ##
+  # Validate the configured seed plan without creating records. This checks
+  # seeder files, seeder classes, built-in seeding method configuration, CSV
+  # headers where possible, and the configured adapter API.
+  #
+  # @return [Planter::Validator::Result]
+  def validate
+    Planter::Validator.new.validate
+  end
 end

data/lib/tasks/planter_tasks.rake

@@ -1,13 +1,39 @@
 require "planter"
 
 namespace :planter do
+  apply_directory_overrides = lambda do
+    if ENV["SEEDERS_DIRECTORY"]
+      Planter.config.seeders_directory = ENV["SEEDERS_DIRECTORY"]
+    end
+
+    if ENV["CSV_FILES_DIRECTORY"]
+      Planter.config.csv_files_directory = ENV["CSV_FILES_DIRECTORY"]
+    end
+  end
+
   desc "Seed application. Use this to keep planter separate from db:seed"
   task seed: :environment do
-    Planter.configure do |config|
-      # NOTE: the seed method already looks for ENV['SEEDERS']
-      ENV["SEEDERS_DIRECTORY"] && config.seeders_directory = ENV["SEEDERS_DIRECTORY"]
-      ENV["CSV_FILES_DIRECTORY"] && config.csv_files_directory = ENV["CSV_FILES_DIRECTORY"]
-    end
+    # NOTE: the seed method already looks for ENV['SEEDERS']
+    apply_directory_overrides.call
     Planter.seed
   end
+
+  desc "Validate Planter configuration without creating records"
+  task validate: :environment do
+    apply_directory_overrides.call
+    result = Planter.validate
+
+    result.warnings.each { |warning| warn "WARNING: #{warning}" }
+    result.errors.each { |error| warn "ERROR: #{error}" }
+
+    if result.success?
+      puts(
+        result.warnings.empty? ?
+          "Planter validation passed." :
+          "Planter validation completed with warnings."
+      )
+    else
+      abort "Planter validation failed."
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Evan Gray
@@ -102,8 +102,12 @@ files:
 - lib/planter.rb
 - lib/planter/adapters/active_record.rb
 - lib/planter/config.rb
+- lib/planter/csv_data_source.rb
 - lib/planter/railtie.rb
+- lib/planter/record_attributes.rb
+- lib/planter/seed_context.rb
 - lib/planter/seeder.rb
+- lib/planter/validator.rb
 - lib/planter/version.rb
 - lib/tasks/planter_tasks.rake
 homepage: https://github.com/evanthegrayt/planter