planter 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa1e7b38b742bb8c31851ad06c330d2e7d49992b99b65d7a2237112747aa270
-  data.tar.gz: 939d28bdbebd8b62c1e98336ba567fe448fb9483249fd1d4af047aa6e320a3d4
+  metadata.gz: 95ab85b49c50ea3b7ee077d4225083884558ae89c6fa5b2ea4e9410284f890eb
+  data.tar.gz: 2fd36b19ab5064d681323eb5f7e73a95cf710b7af8a587031c84b7175610cfbe
 SHA512:
-  metadata.gz: 167c28a3afd2ae9249812ec60c528aab980380e98f22acd81ed660f6bc3dedeb15ff533935934c01d71f92d7300830342e44c67f86a85c8465c6069ed95565e2
-  data.tar.gz: 9faf05d221dc68b52f3e1f0f9c4694b2c84e418361585aa9c69182ccd5d70a40bb33f51332b041b9e510a83460c46bc4a1f13c3ba2d0a2676ec07393ff9076a7
+  metadata.gz: fa74216b4529bcb3d21ccd697574c175ad7dd641d477921108ff9949e1ab9a9537cf6f4847b6e2aaadeb91e8aecedc6afec243c72250d9b77cce1da0e4926580
+  data.tar.gz: 9b9cb5dd5a29b8a66c8cd9a6c49d5192c1395a5d935a98628928f65babcd709c2a6480ed356bf2f575e0710856a214025efdf91942acf3fe034a39a1369f302a

data/README.md

@@ -13,7 +13,7 @@ db:seed` task.
 Features include:
 
 - Seed tables from CSV files, an array of hashes, or custom methods.
-- Seed specific tables with `rails db:seed TABLES=users,addresses`.
+- Call specific seeders with `rails db:seed SEEDERS=users,addresses`.
 - Control the number of records being created.
 - Seed associations.
 
@@ -42,14 +42,14 @@ $ gem install planter
 Let's assume you'd like to seed your `users` table.
 
 To get started, simply add the following to your `db/seeds.rb` file. Note that
-the `config.tables` should be an array of the tables to seed. They should be in
+the `config.seeders` should be an array of the seeders to use. They should be in
 the correct order to successfully seed the tables when considering associations.
 
 ```ruby
 require 'planter'
 
 Planter.configure do |config|
-  config.tables = %i[ users ]
+  config.seeders = %i[ users ]
 end
 
 Planter.seed
@@ -179,7 +179,7 @@ require 'planter'
 Planter.configure do |config|
   config.seeders_directory = 'db/seeder_classes'
   config.csv_files_directory = 'db/csvs'
-  config.tables = %i[
+  config.seeders = %i[
     users
     addresses
   ]

data/lib/planter.rb

@@ -93,7 +93,7 @@ module Planter
   #
   # @example
   #   Planter.configure do |app_seeder|
-  #     app_seeder.tables = %i[users]
+  #     app_seeder.seeders = %i[users]
   #     app_seeder.seeders_directory = 'db/seeds'
   #     app_seeder.csv_files_directory = 'db/seed_files'
   #   end
@@ -102,18 +102,18 @@ module Planter
   end
 
   ##
-  # This is the method to call from your +db/seeds.rb+. It seeds the tables
-  # listed in +Planter.config.tables+. To seed specific tables at
-  # runtime, you can set the +TABLES+ environmental variable to a
-  # comma-separated list of tables.
+  # This is the method to call from your +db/seeds.rb+. It callse 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 of seeders.
   #
   # @example
-  #   rails db:seed TABLES=users,accounts
+  #   rails db:seed SEEDERS=users,accounts
   def self.seed
-    tables = ENV['TABLES']&.split(',') || config.tables&.map(&:to_s)
-    raise RuntimeError, 'No tables specified; nothing to do' unless tables&.any?
+    seeders = ENV['SEEDERS']&.split(',') || config.seeders&.map(&:to_s)
+    raise RuntimeError, 'No seeders specified; nothing to do' unless seeders&.any?
 
-    tables.each do |table|
+    seeders.each do |table|
       require Rails.root.join(config.seeders_directory, "#{table}_seeder.rb").to_s
       puts "Seeding #{table}" unless config.quiet
       "#{table.camelize}Seeder".constantize.new.seed

data/lib/planter/config.rb

@@ -5,7 +5,7 @@ module Planter
   # Configure the application seeder.
   #
   # @example
-  #   Planter.configure { |seeder| seeder.tables = %i[users] }
+  #   Planter.configure { |seeder| seeder.seeders = %i[users] }
   class Config
     ##
     # Tell the application where the seeder classes are kept. Must be a path
@@ -26,13 +26,13 @@ module Planter
     attr_accessor :csv_files_directory
 
     ##
-    # Tell the application what tables to seed. Elements should be in the correct
-    # order, and can be strings or symbols.
+    # Tell the application what seeders exist. Elements should be in the correct
+    # order to seed the tables successfully, and can be strings or symbols.
     #
-    # @param [Array] tables
+    # @param [Array] seeders
     #
     # @return [Array]
-    attr_accessor :tables
+    attr_accessor :seeders
 
     ##
     # When true, don't print output when seeding.

data/lib/planter/version.rb

@@ -1,7 +1,54 @@
 # frozen_string_literal: true
 
 module Planter
+  ##
+  # Module that contains all gem version information. Follows semantic
+  # versioning. Read: https://semver.org/
+  module Version
+    ##
+    # Major version.
+    #
+    # @return [Integer]
+    MAJOR = 0
+
+    ##
+    # Minor version.
+    #
+    # @return [Integer]
+    MINOR = 0
+
+    ##
+    # Patch version.
+    #
+    # @return [Integer]
+    PATCH = 6
+
+    ##
+    # Version as +[MAJOR, MINOR, PATCH]+
+    #
+    # @return [Array]
+    def self.to_a
+      [MAJOR, MINOR, PATCH]
+    end
+
+    ##
+    # Version as +MAJOR.MINOR.PATCH+
+    #
+    # @return [String]
+    def self.to_s
+      to_a.join('.')
+    end
+
+    ##
+    # Version as +{major: MAJOR, minor: MINOR, patch: PATCH}+
+    #
+    # @return [Hash]
+    def self.to_h
+      Hash[%i[major minor patch].zip(to_a)]
+    end
+  end
+
   ##
   # Gem version, semantic.
-  VERSION = '0.0.5'.freeze
+  VERSION = Version.to_s.freeze
 end

metadata

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