rolemodel_sower 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a83f928ff615025f32fe7060888fbf45508825a44593de8752447324d9c3b53
+  data.tar.gz: cd767fdd458dfd25c62a87a247068d467e3b13bf4cfbbb612b8e6fd4f96356b6
+SHA512:
+  metadata.gz: 701c5bfc6fab930f3c0038420e3b24c8828a6677512af4314cea13dac80d808ea798773036c336911419526ea0c1c54ea9a505467ad88947dae2844278d2ef64
+  data.tar.gz: 26aef1405e5a63fdf383f5ea257de0e7ba9c218f70ec5b4e3f686ddecb8c982dbc264b55e9d57f9208e5fed090325232180dca65fc3acf2963b7488a4a8587e1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 RoleModel Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Sower
+
+A Ruby gem to simplify Seed data creation for Rails applications.
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'rolemodel_sower'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+Run the generator:
+
+```console
+rails generate rolemodel_sower:install
+```
+
+## Usage
+
+### Creating Seed Data
+
+Seed data is created by placing files in the `db/rolemodel_sower_data` directory. The files should be named after the model they are creating data for. For example, a file named `users.json` would create seed data for the `User` model.
+
+`db/rolemodel_sower_data/users.json`
+
+### 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.
+
+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.
+
+In `db/rolemodel_sower_data/users.json`
+```json
+[
+  {
+    "first_name": "John",
+    "last_name": "Doe",
+    "email": "john.doe@example.com"
+  },
+  {
+    "first_name": "Jane",
+    "last_name": "Doe",
+    "email": "jane.doe@example.com"
+  }
+]
+```
+
+In `app/seeds/rolemodel_sower/user.rb`
+```ruby
+# frozen_string_literal: true
+
+module RolemodelSower
+  class User < Sower::Base
+    def load!
+      ::User.find_or_create_by!(
+        first_name: @data[:first_name],
+        last_name: @data[:last_name],
+        email: @data[:last_name]
+      )
+    end
+  end
+end
+```
+
+### Loading Seed Data
+
+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.
+
+`RolemodelSower.seed!(:users, :organizations, :facilities)`
+
+## Adapters
+
+RolemodelSower defaults to loading yml files, but can be configured to load json, csv, or tsv files. This can be configured in `config/initializers/rolemodel_sower.rb`. (Can be generated by running `rails generate rolemodel_sower:install`)
+
+```ruby
+RolemodelSower.setup do |config|
+  config.adapter = :json
+end
+```

data/examples/rolemodel_sower_data/organizations.csv

@@ -0,0 +1,2 @@
+name
+RoleModel Software

data/examples/rolemodel_sower_data/organizations.json

@@ -0,0 +1,5 @@
+[
+  {
+    "name": "RoleModel Software"
+  }
+]

data/examples/rolemodel_sower_data/organizations.tsv

@@ -0,0 +1,2 @@
+name
+RoleModel Software

data/examples/rolemodel_sower_data/organizations.yml

@@ -0,0 +1,2 @@
+-
+  name: RoleModel Software

data/examples/rolemodel_sower_data/users.csv

@@ -0,0 +1,4 @@
+first_name,last_name,email,password
+First,User,first.user@example.com,password
+Second,User,second.user@example.com,password
+Third,User,third.user@example.com,password

data/examples/rolemodel_sower_data/users.json

@@ -0,0 +1,20 @@
+[
+  {
+    "first_name": "First",
+    "last_name": "User",
+    "email": "first.user@example.com",
+    "password": "password"
+  },
+  {
+    "first_name": "Second",
+    "last_name": "User",
+    "email": "second.user@example.com",
+    "password": "password"
+  },
+  {
+    "first_name": "Third",
+    "last_name": "User",
+    "email": "third.user@example.com",
+    "password": "password"
+  }
+]

data/examples/rolemodel_sower_data/users.tsv

@@ -0,0 +1,4 @@
+first_name	last_name	email	password
+First	User	first.user@example.com	password
+Second	User	second.user@example.com	password
+Third	User	third.user@example.com	password

data/examples/rolemodel_sower_data/users.yml

@@ -0,0 +1,15 @@
+-
+  first_name: 'First'
+  last_name: 'User'
+  email: 'first.user@example.com'
+  password: 'password'
+-
+  first_name: 'Second'
+  last_name: 'User'
+  email: 'second.user@example.com'
+  password: 'password'
+-
+  first_name: 'Third'
+  last_name: 'User'
+  email: 'third.user@example.com'
+  password: 'password'

data/examples/seeds/rolemodel_sower/organization.rb

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

data/examples/seeds/rolemodel_sower/user.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sower
+  class User < Sower::Base
+    def load!
+      user = ::User.create_with(
+        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]
+
+      # Any models can be affected here.
+      ::Profile.find_or_create_by!(user: user)
+    end
+  end
+end

data/lib/generators/rolemodel_sower/USAGE

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

data/lib/generators/rolemodel_sower/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RolemodelSower
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copy RolemodelSower default files'
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_config
+        template 'config/initializers/rolemodel_sower.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+RolemodelSower.setup do |config|
+  # Available Adapters :yaml, :csv, :tsv, :json
+  # config.adapter = :yaml
+end

data/lib/rolemodel_sower/adapters/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RolemodelSower
+  module Adapters
+    class Base
+      def self.file_extension
+        raise NotImplementedError
+      end
+
+      def self.load_data(seed_name)
+        raise NotImplementedError
+      end
+
+      def self.path(seed_name)
+        Rails.root.join("db/rolemodel_sower_data/#{seed_name.to_s.pluralize}#{file_extension}")
+      end
+
+      def self.class_name(seed_name)
+        "RolemodelSower::#{seed_name.to_s.classify}".constantize
+      end
+
+      def self.all(seed_name)
+        load_data(seed_name).map do |template|
+          data = ActiveSupport::HashWithIndifferentAccess.new(template)
+          class_name(seed_name).new(data)
+        end
+      end
+    end
+  end
+end

data/lib/rolemodel_sower/adapters/csv.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module RolemodelSower
+  module Adapters
+    class CSV < Base
+      def self.file_extension
+        '.csv'
+      end
+
+      def self.load_data(seed_name)
+        ::CSV.read(path(seed_name), headers: true)
+      end
+    end
+  end
+end

data/lib/rolemodel_sower/adapters/json.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RolemodelSower
+  module Adapters
+    class JSON < Base
+      def self.file_extension
+        '.json'
+      end
+
+      def self.load_data(seed_name)
+        ::JSON.parse(path(seed_name).read)
+      end
+    end
+  end
+end

data/lib/rolemodel_sower/adapters/tsv.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module RolemodelSower
+  module Adapters
+    class TSV < Base
+      def self.file_extension
+        '.tsv'
+      end
+
+      def self.load_data(seed_name)
+        ::CSV.read(path(seed_name), headers: true, col_sep: "\t")
+      end
+    end
+  end
+end

data/lib/rolemodel_sower/adapters/yaml.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RolemodelSower
+  module Adapters
+    class YAML < Base
+      def self.file_extension
+        '.yml'
+      end
+
+      def self.load_data(seed_name)
+        ::YAML.safe_load(ERB.new(path(seed_name).read).result)
+      end
+    end
+  end
+end

data/lib/rolemodel_sower/adapters.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RolemodelSower
+  module Adapters
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :CSV
+    autoload :JSON
+    autoload :TSV
+    autoload :YAML
+  end
+end

data/lib/rolemodel_sower/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RolemodelSower
+  class Base
+    def initialize(data)
+      @data = data
+    end
+
+    def load!
+      raise NotImplementedError
+    end
+  end
+end

data/lib/rolemodel_sower/version.rb

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

data/lib/rolemodel_sower.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RolemodelSower
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Adapters
+    autoload :Base
+  end
+
+  # CONFIGURATION OPTIONS
+
+  # Available adapters: :yaml, :csv, :tsv, :json
+  mattr_accessor :adapter
+  @@adapter = :yaml
+
+  def self.setup
+    yield self
+  end
+
+  # END CONFIGURATION OPTIONS
+
+  def self.seed!(*seed_names)
+    seed_names.each do |seed_name|
+      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!)
+      logger.info "Seeding #{pluralized_name}... done" if Rails.env.development?
+    end
+  end
+end

data/rolemodel_sower.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rolemodel_sower/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rolemodel_sower'
+  s.version     = RolemodelSower::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = 'A Ruby gem to simplify Seed data creation for Rails applications.'
+  s.email       = 'consult@rolemodelsoftware.com'
+  s.homepage    = 'https://github.com/RoleModel/sower'
+  s.description = 'A Ruby gem to simplify Seed data creation for Rails applications.'
+  s.authors     = ['Jeremy Walton']
+  s.license     = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.6.0'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rolemodel_sower
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Walton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-19 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem to simplify Seed data creation for Rails applications.
+email: consult@rolemodelsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- examples/rolemodel_sower_data/organizations.csv
+- examples/rolemodel_sower_data/organizations.json
+- examples/rolemodel_sower_data/organizations.tsv
+- examples/rolemodel_sower_data/organizations.yml
+- examples/rolemodel_sower_data/users.csv
+- examples/rolemodel_sower_data/users.json
+- examples/rolemodel_sower_data/users.tsv
+- examples/rolemodel_sower_data/users.yml
+- examples/seeds/rolemodel_sower/organization.rb
+- examples/seeds/rolemodel_sower/user.rb
+- lib/generators/rolemodel_sower/USAGE
+- lib/generators/rolemodel_sower/install_generator.rb
+- lib/generators/rolemodel_sower/templates/config/initializers/rolemodel_sower.rb
+- lib/rolemodel_sower.rb
+- lib/rolemodel_sower/adapters.rb
+- lib/rolemodel_sower/adapters/base.rb
+- lib/rolemodel_sower/adapters/csv.rb
+- lib/rolemodel_sower/adapters/json.rb
+- lib/rolemodel_sower/adapters/tsv.rb
+- lib/rolemodel_sower/adapters/yaml.rb
+- lib/rolemodel_sower/base.rb
+- lib/rolemodel_sower/version.rb
+- rolemodel_sower.gemspec
+homepage: https://github.com/RoleModel/sower
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: A Ruby gem to simplify Seed data creation for Rails applications.
+test_files: []