rolemodel_sower 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a83f928ff615025f32fe7060888fbf45508825a44593de8752447324d9c3b53
-  data.tar.gz: cd767fdd458dfd25c62a87a247068d467e3b13bf4cfbbb612b8e6fd4f96356b6
+  metadata.gz: afa9c43c72ba7bef3fda89928296f16c18fedda9829b56b49aea9da7c8446e81
+  data.tar.gz: d2d0b1075dff10a91b0a27ca9409eeb58ae9fc7c32b59218ff8f0e83323babe0
 SHA512:
-  metadata.gz: 701c5bfc6fab930f3c0038420e3b24c8828a6677512af4314cea13dac80d808ea798773036c336911419526ea0c1c54ea9a505467ad88947dae2844278d2ef64
-  data.tar.gz: 26aef1405e5a63fdf383f5ea257de0e7ba9c218f70ec5b4e3f686ddecb8c982dbc264b55e9d57f9208e5fed090325232180dca65fc3acf2963b7488a4a8587e1
+  metadata.gz: 52cf43b5235e4bb8a61ccc31fc7b18e41b4b1e71dd9c43582021a295ea52a5cb5ebd7bb5f1828c2345fa53132d38da362ef0672e0015c2bfa7454c57e2fc2d35
+  data.tar.gz: 4ae6ce8841263815b315ff3b57550f9a95af7e878c7011de407662daa9c41c8432c7de004c11399709f5b2befe71b3038340db68c30b457371e2d6b2c14bfcfa

data/README.md

@@ -30,9 +30,17 @@ Seed data is created by placing files in the `db/rolemodel_sower_data` directory
 
 `db/rolemodel_sower_data/users.json`
 
+The seed data directory can be configured in the initializer generated by the install generator.
+
+```ruby
+RolemodelSower.setup do |config|
+  config.data_path = 'db/seed_data'
+end
+```
+
 ### Translating Seed Data
 
-You will need to define a rolemodel_sower file to take the data parsed from your seed data and turn create the records in your database.
+You will need to define a rolemodel_sower file to take the data parsed from your seed data and create the records in your database.
 
 Sower files should be created in `app/seeds/rolemodel_sower`. The files should be named after the model they are creating data for. For example, a file named `user.rb` would create seed data for the `User` model.
 
@@ -57,12 +65,12 @@ In `app/seeds/rolemodel_sower/user.rb`
 # frozen_string_literal: true
 
 module RolemodelSower
-  class User < Sower::Base
+  class User < RolemodelSower::Base
     def load!
       ::User.find_or_create_by!(
-        first_name: @data[:first_name],
-        last_name: @data[:last_name],
-        email: @data[:last_name]
+        first_name: data[:first_name],
+        last_name: data[:last_name],
+        email: data[:last_name]
       )
     end
   end
@@ -73,9 +81,23 @@ end
 
 Seeds can be generated by calling the `seed!` method on `RolemodelSower`.
 
-It takes one or more symbol arguments that correspond to sets of seed data and runs then in the order passed.
+It takes one or more symbol arguments that correspond to sets of seed data and runs them in the order passed.
+
+```ruby
+RolemodelSower.seed!(
+  :users,
+  :organizations,
+  :facilities
+)
+```
+
+If you want to add conditions to each run, you can separate out each call to seed.
 
-`RolemodelSower.seed!(:users, :organizations, :facilities)`
+```ruby
+RolemodelSower.seed!(:users) if my_condition
+RolemodelSower.seed!(:organizations) if other_condition
+RolemodelSower.seed!(:facilities) if another_condition
+```
 
 ## Adapters
 
@@ -86,3 +108,41 @@ RolemodelSower.setup do |config|
   config.adapter = :json
 end
 ```
+
+You can also specify the adapter when calling `seed!`. This will override the default adapter or what is set in the initializer.
+
+```ruby
+RolemodelSower.seed!(
+  { users: :csv },
+  :organizations,
+  { facilities: :json }
+)
+```
+
+```ruby
+RolemodelSower.seed!({ users: :csv }) if my_condition
+RolemodelSower.seed!(:organizations) if other_condition
+RolemodelSower.seed!({ facilities: :json }) if another_condition
+```
+
+## Development
+
+To build the gem locally, run: `gem build rolemodel_sower.gemspec`
+
+To test the gem locally, use the path option in your Gemfile:
+
+```ruby
+gem 'rolemodel_sower', path: '../rolemodel_sower'
+```
+
+## Publishing
+
+Make sure you are an owner of the gem.
+
+You also need to be signed in to rubygmes by running:
+
+`gem signin`
+
+To publish, run:
+
+`gem push rolemodel_sower-{major.minor.patch}.gem`

data/examples/seeds/rolemodel_sower/organization.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module Sower
-  class Organization < Sower::Base
+module RolemodelSower
+  class Organization < RolemodelSower::Base
     def load!
-      ::Organization.find_or_create_by! name: @data[:name]
+      ::Organization.find_or_create_by! name: data[:name]
     end
   end
 end

data/examples/seeds/rolemodel_sower/user.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-module Sower
-  class User < Sower::Base
+module RolemodelSower
+  class User < RolemodelSower::Base
     def load!
       user = ::User.create_with(
-        first_name: @data[:first_name],
-        last_name: @data[:last_name],
-        password: @data[:password],
-        password_confirmation: @data[:password],
+        first_name: data[:first_name],
+        last_name: data[:last_name],
+        password: data[:password],
+        password_confirmation: data[:password],
         organization: ::Organization.first,
-      ).find_or_create_by! email: @data[:email]
+      ).find_or_create_by! email: data[:email]
 
       # Any models can be affected here.
       ::Profile.find_or_create_by!(user: user)

data/lib/generators/rolemodel_sower/USAGE

@@ -1,3 +1,3 @@
 To copy a Sower initializer to your Rails App, with some configuration values, just do:
 
-    rails generate sower:install
+    rails generate rolemodel_sower:install

data/lib/generators/rolemodel_sower/templates/config/initializers/rolemodel_sower.rb

@@ -3,4 +3,7 @@
 RolemodelSower.setup do |config|
   # Available Adapters :yaml, :csv, :tsv, :json
   # config.adapter = :yaml
+
+  # Path to the directory containing the seed data files
+  # config.data_path = 'db/rolemodel_sower_data'
 end

data/lib/rolemodel_sower/adapters/base.rb

@@ -12,7 +12,7 @@ module RolemodelSower
       end
 
       def self.path(seed_name)
-        Rails.root.join("db/rolemodel_sower_data/#{seed_name.to_s.pluralize}#{file_extension}")
+        Rails.root.join("#{RolemodelSower.data_path}/#{seed_name.to_s.pluralize}#{file_extension}")
       end
 
       def self.class_name(seed_name)

data/lib/rolemodel_sower/base.rb

@@ -2,6 +2,8 @@
 
 module RolemodelSower
   class Base
+    attr_reader :data
+
     def initialize(data)
       @data = data
     end

data/lib/rolemodel_sower/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RolemodelSower
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/lib/rolemodel_sower.rb

@@ -14,6 +14,9 @@ module RolemodelSower
   mattr_accessor :adapter
   @@adapter = :yaml
 
+  mattr_accessor :data_path
+  @@data_path = 'db/rolemodel_sower_data'
+
   def self.setup
     yield self
   end
@@ -22,10 +25,15 @@ module RolemodelSower
 
   def self.seed!(*seed_names)
     seed_names.each do |seed_name|
+      current_seed_name = seed_name.try(:keys)&.first || seed_name
+      current_adapter = seed_name.try(:values)&.first || adapter
+      pluralized_name = current_seed_name.to_s.classify
+
       logger = Logger.new($stdout)
-      pluralized_name = seed_name.to_s.classify
       logger.info "Seeding #{pluralized_name}..." if Rails.env.development?
-      "RolemodelSower::Adapters::#{adapter.to_s.upcase}".constantize.all(seed_name).each(&:load!)
+
+      "RolemodelSower::Adapters::#{current_adapter.to_s.upcase}".constantize.all(current_seed_name).each(&:load!)
+
       logger.info "Seeding #{pluralized_name}... done" if Rails.env.development?
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel_sower
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Jeremy Walton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby gem to simplify Seed data creation for Rails applications.
 email: consult@rolemodelsoftware.com