custom_seeds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9602b763569053bcf931f449a65f4a2137eebec44c7503db21e040fe0cef193f
+  data.tar.gz: 9823e21e7d44e4c3bf2189b672600c4828525f221d091612da00b1f1f66e8a7c
+SHA512:
+  metadata.gz: 94217e6c650f77bd1b247260fc5105fed80aeb75b4f3ab49bdb8c4ce81bd07631634b7e2c806ed514f4ab5963b52dd28875ff3a29f494779b4a4756c957488a9
+  data.tar.gz: eeac7048aba9934c5efc21b47e6f567503f3d1c47eea2b2dbf62e2a776e3f69bbcabe94e1d8eb86f64468bad17e091ee3b34a9f7e76c2d78e17ebdc4da25ad88

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.4

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    custom_seeds (0.1.0)
+      progress_bar (= 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.1)
+    highline (2.1.0)
+    method_source (1.1.0)
+    options (2.3.2)
+    progress_bar (1.3.1)
+      highline (>= 1.6, < 3)
+      options (~> 2.3.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.2.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-darwin-23
+
+DEPENDENCIES
+  bundler
+  custom_seeds!
+  pry
+  rake (~> 13.0)
+  rspec (= 3.10.0)
+
+BUNDLED WITH
+   2.4.20

data/README.md

@@ -0,0 +1,58 @@
+# CustomSeeds
+
+Seed file helpers for Rails applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+    gem 'custom_seeds'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create a seedfile under `db/seeds`:
+
+```ruby
+# db/seeds/users/followed_products.rb
+
+CustomSeeds.define do
+  title 'Followed Products'
+  description 'Add followed products to user accounts'
+
+  let(:products) { Product.validated.sample }
+
+  before do
+    FollowedProduct.destroy_all
+  end
+
+  records do
+    User.all
+  end
+
+  each_record do |user|
+    products.each do { |product| user.followed_products.create!(product: product) }
+  end
+
+  log_each do |user|
+    "User #{user.email} followed #{user.followed_products.count} products"
+  end
+end
+```
+
+Run the file using the rake task:
+
+```bash
+$ rake db:seed:users:followed_products
+```
+
+Run all seeds using the rake task:
+
+```bash
+$ rake db:seed:all
+```

data/Rakefile

@@ -0,0 +1,4 @@
+require 'custom_seeds'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/lib/custom_seeds/tasks/*.rake").each { |f| import f }

data/custom_seeds.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'custom_seeds/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'custom_seeds'
+  spec.version       = CustomSeeds::VERSION
+  spec.authors       = ['Michael Wheeler']
+  spec.email         = ['mwheeler@g2.com']
+
+  spec.summary       = 'custom_seeds gem'
+
+  spec.files         = `[ -d ".git" ] > /dev/null && type git > /dev/null && git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'progress_bar', '1.3.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '3.10.0'
+end

data/lib/custom_seeds/railtie.rb

@@ -0,0 +1,11 @@
+module CustomSeeds
+  class Railtie < Rails::Railtie
+    railtie_name :custom_seeds
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+
+      Dir.glob("#{path}/tasks/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/custom_seeds/seed_file.rb

@@ -0,0 +1,96 @@
+require 'progress_bar'
+
+module CustomSeeds
+  class SeedFile
+    attr_reader :build_block, :log_block
+
+    MAP = {
+      blue: 34,
+      green: 32
+    }.freeze
+
+    def self.define(&block)
+      new.tap do |seed_file|
+        seed_file.instance_eval(&block)
+        seed_file.run
+      end
+    end
+
+    def initialize
+      @records = []
+      @build_block = ->(_record) { raise 'No build block defined' }
+      @log_block = nil
+    end
+
+    def colorize(string, color_code)
+      "\e[#{MAP[color_code]}m#{string}\e[0m"
+    end
+
+    def title(value)
+      puts colorize("🌱 #{value}", :green)
+    end
+
+    def description(value)
+      puts colorize(value, :blue)
+    end
+
+    def records(&block)
+      return @records if block.nil?
+      @records = block.call
+    end
+
+    def each_record(&block)
+      return @build_block if block.nil?
+
+      @build_block = block
+    end
+
+    def before(&block)
+      return @before_block if block.nil?
+
+      @before_block = block
+    end
+
+    # memoize block
+    def let(name, &block)
+      @memoized ||= {}
+
+      @memoized[name] ||= block.call
+    end
+
+    def respond_to_missing?(method_name, _include_private = false)
+      @memoized&.key?(method_name) || super
+    end
+
+    def method_missing(method_name, **_args)
+      if @memoized&.key?(method_name)
+        @memoized[method_name]
+      else
+        super
+      end
+    end
+
+    def log_each(&block)
+      return @log_block if block.nil?
+
+      @log_block = block
+    end
+
+    def run
+      before&.call
+      progress_bar = ProgressBar.new(records.size)
+
+      records.each do |record|
+        build_block.call(record)
+
+        if log_block
+          puts colorize(log_block.call(record), :blue)
+        else
+          progress_bar.increment!
+        end
+      end
+
+      puts colorize('✅ Seeding completed', :green)
+    end
+  end
+end

data/lib/custom_seeds/seed_list.rb

@@ -0,0 +1,45 @@
+module CustomSeeds
+  class SeedList
+    include Enumerable
+
+    attr_reader :directory
+
+    class Item
+      attr_reader :filename, :name
+
+      def initialize(filename, name)
+        @filename = filename
+        @name = name
+      end
+    end
+
+    def initialize(directory: Rails.root.join('db/seeds/'))
+      @directory = directory
+    end
+
+    def seeds
+      @seeds ||= Dir.glob("#{directory}/**/*.rb").map do |filename|
+        namespaces = namespaces_for(filename)
+        task_name = taskname_for(filename)
+
+        Item.new(filename, (namespaces + [task_name]).join(':').intern)
+      end
+    end
+
+    def each(&block)
+      seeds.each(&block)
+    end
+
+    private
+
+    def taskname_for(filename)
+      filename.split('/').last.sub('.rb', '').intern
+    end
+
+    def namespaces_for(filename)
+      parts = filename.sub(@directory.to_s, '').split('/').filter { |part| part != '' }
+
+      parts[0..-2].map(&:intern)
+    end
+  end
+end

data/lib/custom_seeds/task_builder.rb

@@ -0,0 +1,53 @@
+require 'custom_seeds/seed_list'
+# This class exercises the Rake API to generate rake tasks based on a given seed file
+# directory.
+#
+# Given a directory structure like:
+#  db/seeds/
+#  ├── foo
+#  │   └── bar.rb
+#  └── baz.rb
+#
+#  The following rake tasks will be generated:
+#
+#  db:seed:foo:bar
+#  db:seed:baz
+#  db:seed:all
+
+module CustomSeeds
+  class TaskBuilder
+    attr_reader :directory, :rake_dsl
+
+    def initialize(rake_dsl:, directory: Rails.root.join('db/seeds/'))
+      @directory = directory
+      @rake_dsl = rake_dsl
+    end
+
+    def build
+      build_individual_tasks
+      build_global_task
+    end
+
+    def build_individual_tasks
+      SeedList.new(directory: @directory).each do |seed|
+        rake_dsl.send(:task, seed.name => :environment) do
+          load(seed.filename)
+        end
+      end
+    end
+
+    def build_global_task
+      rake_dsl.send(:task, :all, [:directory] => :environment) do |_, args|
+        files = if args[:directory]
+                  Dir.glob("#{@directory}/#{args[:directory]}/**/*.rb")
+                else
+                  Dir.glob("#{@directory}/**/*.rb")
+                end
+
+        ProgressBar.each(files) do |filename|
+          load(filename)
+        end
+      end
+    end
+  end
+end

data/lib/custom_seeds/tasks/custom_seed.rake

@@ -0,0 +1,18 @@
+require 'custom_seeds'
+
+namespace :db do
+  namespace :seed do
+    # This will load all files in db/seeds and create a task for each file
+    # The task is named after the full filename and directory name, but with underscores
+    # instead of slashes. For example, db/seeds/foo/bar.rb will create a task called
+    # db:seed:foo:bar
+    CustomSeeds::TaskBuilder.new(rake_dsl: self).build
+
+    task :list do
+      puts 'Available seed tasks:'
+      CustomSeeds::SeedList.new.each do |seed|
+        puts seed.name
+      end
+    end
+  end
+end

data/lib/custom_seeds/version.rb

@@ -0,0 +1,3 @@
+module CustomSeeds
+  VERSION = '0.1.0'.freeze
+end

data/lib/custom_seeds.rb

@@ -0,0 +1,11 @@
+require 'custom_seeds/version'
+require 'custom_seeds/seed_file'
+require 'custom_seeds/task_builder'
+
+module CustomSeeds
+  require 'custom_seeds/railtie' if defined?(Rails)
+
+  def self.define(&block)
+    CustomSeeds::SeedFile.define(&block)
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: custom_seeds
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Wheeler
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description:
+email:
+- mwheeler@g2.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- custom_seeds.gemspec
+- lib/custom_seeds.rb
+- lib/custom_seeds/railtie.rb
+- lib/custom_seeds/seed_file.rb
+- lib/custom_seeds/seed_list.rb
+- lib/custom_seeds/task_builder.rb
+- lib/custom_seeds/tasks/custom_seed.rake
+- lib/custom_seeds/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: custom_seeds gem
+test_files: []