planter 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a542b8919dda44137996b078e0ac3f773fc8b85bed2225193de3f2a36bdfe099
-  data.tar.gz: '058271874209001fd8de03630c2e3f162959621769225bb354060f1ed8848354'
+  metadata.gz: e17464950e5c9388e88fa5c7567920ec3e71543f67440d8ac2ae61ff5d058f1e
+  data.tar.gz: a5ceb84a52cdf6f04f34283ab1fb96dcffbd3c59bf0e84a7926ee7c80ef8a6ae
 SHA512:
-  metadata.gz: c9728b99a23877a7f96f4267b963dd7f4e15f4c385303759476937f7f3f33bd6335ec0e6b89fde733ecfd7f5380386ba86ca26bfbdb9ac70f587b8a05efc8812
-  data.tar.gz: 1af8f9af55ca77f91f2ef7c01b8cb2c1919166be12f8785d779137d68237050b1ab259726da9546dea7dd2184f85431930e9ec8785d269c16ee1ba6add884b92
+  metadata.gz: 21a073b1fdbbdad594f328ac020382d72fc48d5ceb08103727748eab37b0138ed88e4f07d0e3a40a4dc2d881e7cefce94ef8311fc16d3e87c747e23ca4a229db
+  data.tar.gz: 5b45a2c739c47c184b2fc9a3f1dc1b2b766122565e780b77a162a9a5767fca665b972f4f62af88182f51b02a4c031239d1019788ce93462275f80e950d13b420

data/README.md

@@ -1,10 +1,9 @@
 # Planter
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fplanter%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/planter/goto?ref=master)
 [![Gem Version](https://badge.fury.io/rb/planter.svg)](https://badge.fury.io/rb/planter)
+![Language: Ruby](https://img.shields.io/static/v1?label=language&message=Ruby&color=CC342D&style=flat&logo=ruby&logoColor=CC342D)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-> Pre-release version! Anything is subject to change in the near future!
-
 Seeds for Rails applications can get complicated fast, and Rails doesn't provide
 much for assisting with this process. This plugin seeks to rectify that by
 providing easy ways to seed specific tables.
@@ -24,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.1.3'
+gem 'planter', '0.2.0'
 ```
 
 And then execute:
@@ -146,12 +145,23 @@ end
 ```
 
 `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`.
+`.erb.csv`. For example, `users.csv.erb`. When using ERB, instance variables set
+in the seeder can be used in the CSV.
+
+```ruby
+class UsersSeeder < Planter::Seeder
+  seeding_method :csv, csv_name: :people
+
+  def initialize
+    @name_prefix = 'Test User'
+  end
+end
+```
 
 ```
 participant_id,name
-<%= Participant.find_by(email: 'test1@example.com').id %>,"Test User1"
-<%= Participant.find_by(email: 'test2@example.com').id %>,"Test User2"
+<%= Participant.find_by(email: 'test1@example.com').id %>,<%= @name_prefix %> 1
+<%= Participant.find_by(email: 'test2@example.com').id %>,<%= @name_prefix %> 2
 ```
 
 Note that, if you need to change the trim mode for ERB, you can set a default in
@@ -277,7 +287,7 @@ class UsersSeeder < Planter::Seeder
   }
 
   def seed
-    USERS.each { |email, attrs| User.where(email).first_or_create!(attrs) }
+    USERS.each { |email, attrs| User.where(email: email).first_or_create!(attrs) }
   end
 end
 ```

data/Rakefile

@@ -1,18 +1,65 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'rdoc/task'
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
 RDoc::Task.new do |rdoc|
-  rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'docs'
-  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = "docs"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
 end
 
 task default: :test
+
+namespace :version do
+  desc "Print the current version from the version.rb file"
+  task :current do
+    puts Planter::VERSION
+  end
+
+  namespace :increment do
+    desc "Increment the version's PATCH level"
+    task :patch do
+      File.join(__dir__, "lib", "planter", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file).sub(/(PATCH\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+    desc "Increment the version's MINOR level"
+    task :minor do
+      File.join(__dir__, "lib", "planter", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file)
+            .sub(/(PATCH\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MINOR\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+    desc "Increment the version's MAJOR level"
+    task :major do
+      File.join(__dir__, "lib", "planter", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file)
+            .sub(/(PATCH\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MINOR\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MAJOR\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+  end
+end
+

data/lib/generators/planter/initializer_generator.rb

@@ -1,10 +1,10 @@
 module Planter
   module Generators
     class InitializerGenerator < Rails::Generators::Base
-      desc 'Genrates an initializer for Planter at config/initializers/planter.rb'
+      desc "Genrates an initializer for Planter at config/initializers/planter.rb"
 
       def create_initializer_file
-        create_file 'config/initializers/planter.rb', <<~EOF
+        create_file "config/initializers/planter.rb", <<~EOF
           require 'planter'
 
           Planter.configure do |config|

data/lib/generators/planter/seeder_generator.rb

@@ -6,7 +6,7 @@ module Planter
       desc "Creates a seeder file at #{::Planter.config.seeders_directory}"
 
       def generate_seeders
-        seeder == 'ALL' ? tables.each { |t| generate(t) } : generate(seeder)
+        (seeder == "ALL") ? tables.each { |t| generate(t) } : generate(seeder)
       end
 
       private
@@ -25,7 +25,7 @@ module Planter
           end
         EOF
 
-        inject_into_file 'config/initializers/planter.rb',
+        inject_into_file "config/initializers/planter.rb",
           "    #{seeder}\n",
           before: /^\s*\]\s*$/
       end

data/lib/planter/config.rb

@@ -55,8 +55,8 @@ module Planter
     # Create a new instance of the config.
     def initialize
       @quiet = false
-      @seeders_directory = ::File.join('db', 'seeds')
-      @csv_files_directory = ::File.join('db', 'seed_files')
+      @seeders_directory = ::File.join("db", "seeds")
+      @csv_files_directory = ::File.join("db", "seed_files")
     end
   end
 end

data/lib/planter/railtie.rb

@@ -4,10 +4,10 @@ module Planter
   class Railtie < ::Rails::Railtie # :nodoc:
     rake_tasks do
       load File.join(
-        File.expand_path(File.dirname(__FILE__)),
-        '..',
-        'tasks',
-        'planter_tasks.rake'
+        __dir__,
+        "..",
+        "tasks",
+        "planter_tasks.rake"
       )
     end
   end

data/lib/planter/seeder.rb

@@ -219,14 +219,14 @@ module Planter
       erb_trim_mode: nil
     )
       unless SEEDING_METHODS.include?(seed_method.intern)
-        raise ArgumentError, "Method must be: #{SEEDING_METHODS.join(', ')}"
+        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.model = model || to_s.delete_suffix("Seeder").singularize
       self.parent = parent
-      self.csv_name = csv_name || to_s.delete_suffix('Seeder').underscore
+      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
@@ -275,16 +275,16 @@ module Planter
       when :csv
         raise "Couldn't find csv for #{model}" unless full_csv_name
       when :data_array
-        raise 'data is not defined in the seeder' if public_send(:data).nil?
+        raise "data is not defined in the seeder" if public_send(:data).nil?
       else
-        raise 'seeding_method not defined in the seeder'
+        raise "seeding_method not defined in the seeder"
       end
     end
 
     def apply_transformations(record)
       return record if public_send(:transformations).nil?
 
-      Hash[record.map { |field, value| map_record(field, value, record) }]
+      record.map { |field, value| map_record(field, value, record) }.to_h
     end
 
     def map_record(field, value, record)
@@ -338,7 +338,7 @@ module Planter
 
     def extract_data_from_csv
       contents = ::File.read(full_csv_name)
-      if full_csv_name.include?('.erb')
+      if full_csv_name.include?(".erb")
         contents = ERB.new(contents, trim_mode: erb_trim_mode).result(binding)
       end
 

data/lib/planter/version.rb

@@ -15,19 +15,21 @@ module Planter
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 1
+    MINOR = 3
 
     ##
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 3
+    PATCH = 0
+
+    module_function
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
     #
     # @return [Array]
-    def self.to_a
+    def to_a
       [MAJOR, MINOR, PATCH]
     end
 
@@ -35,16 +37,16 @@ module Planter
     # Version as +MAJOR.MINOR.PATCH+
     #
     # @return [String]
-    def self.to_s
-      to_a.join('.')
+    def 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)]
+    def to_h
+      %i[major minor patch].zip(to_a).to_h
     end
   end
 

data/lib/planter.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'csv'
-require 'erb'
-require 'planter/version'
-require 'planter/railtie'
-require 'planter/config'
-require 'planter/seeder'
+require "csv"
+require "erb"
+require "planter/version"
+require "planter/railtie"
+require "planter/config"
+require "planter/seeder"
 
 ##
 # The main module for the plugin. It nicely wraps the +Planter::Config+ class
@@ -24,11 +24,13 @@ require 'planter/seeder'
 #
 #   Planter.seed
 module Planter
+  module_function
+
   ##
   # The seeder configuration.
   #
   # @return [Planter::Config]
-  def self.config
+  def config
     @config ||= Planter::Config.new
   end
 
@@ -36,7 +38,7 @@ module Planter
   # Resets the config back to its initial state.
   #
   # @return [Planter::Config]
-  def self.reset_config
+  def reset_config
     @config = Planter::Config.new
   end
 
@@ -52,7 +54,7 @@ module Planter
   #     config.seeders_directory = 'db/seeds'
   #     config.csv_files_directory = 'db/seed_files'
   #   end
-  def self.configure
+  def configure
     config.tap { |c| yield c }
   end
 
@@ -65,9 +67,9 @@ module Planter
   # @example
   #   # db/seeds.rb, assuming your +configure+ block is in an initializer.
   #   Planter.seed
-  def self.seed
-    seeders = ENV['SEEDERS']&.split(',') || config.seeders&.map(&:to_s)
-    raise RuntimeError, 'No seeders specified' if seeders.blank?
+  def seed
+    seeders = ENV["SEEDERS"]&.split(",") || config.seeders&.map(&:to_s)
+    raise "No seeders specified" if seeders.blank?
 
     seeders.each do |s|
       require Rails.root.join(config.seeders_directory, "#{s}_seeder.rb").to_s

data/lib/tasks/planter_tasks.rake

@@ -1,12 +1,12 @@
-require 'planter'
+require "planter"
 
 namespace :planter do
-  desc 'Seed application. Use this to keep planter separate from db:seed'
+  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']
+      ENV["SEEDERS_DIRECTORY"] && config.seeders_directory = ENV["SEEDERS_DIRECTORY"]
+      ENV["CSV_FILES_DIRECTORY"] && config.csv_files_directory = ENV["CSV_FILES_DIRECTORY"]
     end
     Planter.seed
   end

metadata

@@ -1,29 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Evan Gray
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 6.1.4.4
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.4
+        version: 8.1.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create a seeder for each table in your database, and easily seed from
   CSV or custom methods
 email:
@@ -51,7 +84,6 @@ 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: 
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +91,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Framework for seeding rails applications.
 test_files: []