rolemodel-rails 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0fc94b9f1782c5251c05b2ec1e9f8de40ff8021383c4d358c1cf67dae0c2e86
-  data.tar.gz: 8eb5debdc363920c4b21f06381b4c6789162a5dcd984c40ba377fecfb1eb90a2
+  metadata.gz: 2cbd3c1b81aa62c00354cd5faa3cc5bea47c48c2ede2c86470b391372751db9c
+  data.tar.gz: c9bd14d2787122907369daaf9bfa26b63d0cc882449247ae5da26af15de9586f
 SHA512:
-  metadata.gz: be60dc3620a2d22b8ed1148a1966219c830d685e48df12ed5abafd884cd1f749f4251360173f42b355b10865238f000a95da825624c21ee898fde25c7c9dc9d9
-  data.tar.gz: b76c9375e38755a22e66aff75109727a7a03273d9ee4dc9e44049774259f2b60ca793f3a550b79550cdd729cca9154e400547a2472f2565fe18fedb05cfd10e3
+  metadata.gz: d79a388d4221587a777dddeddaea260f389924272c49299fed129b7f5e364df154fa09161217b0087d975168fda59ce6c75e7fd36468c0b0a5b5767cddecea28
+  data.tar.gz: 960b18a4e997a18092a6bacd69f0833da0154a54717d41215b401f4f8c9cf08034ba8aa10f4daf0fef560a7bd54154a470d650e4427122b3db6c47ac687087ee

data/README.md

@@ -14,7 +14,7 @@ Attempts to solve the pain of:
 The rolemodel-rails gem expects to be added to an existing Rails project. Typically those are started with:
 
 ```shell
-rails new <app-name> --javascript=webpack --database=postgresql --skip-test
+rails new <app-name> --javascript=webpack --database=postgresql --skip-test --skip-solid
 ```
 
 The Devise generator requires your database to exist before running.
@@ -28,14 +28,15 @@ rails db:create
 Add this line to your application's Gemfile:
 
 ```ruby
-group :development do
-  gem 'rolemodel-rails', github: 'RoleModel/rolemodel_rails'
-end
+gem 'rolemodel-rails'
 ```
 
+> [!IMPORTANT]
+> We used to recommend putting rolemodel-rails in the development gem group. This is no longer supported, because some Rolemodel namespaced utility modules and classes are expected to be available at runtime.
+
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 ## Usage
 
@@ -115,13 +116,9 @@ e.g.
 bin/new_generator testing/fantasitic_specs 'A Fantastic Testing Framework'
 ```
 
-We use the embeded Rails apps (`example_rails*`) to test generators against. They reference the rolemodel-rails gem by local path,
+We use the embeded Rails apps (`example_rails_current` & `example_rails_legacy`) to test generators against. They reference the rolemodel-rails gem by local path,
 so you can navigate into one of them and run your generator for immediate feedback while developing.
 
-> [!IMPORTANT]
-> Before submitting a PR, run `bin/bump_version` to ensure the Gem builds successfully & that everything continues to stay in sync & up-to-date.<br /><br />
-> For very small changes & bug fixes, prefer `bin/bump_version --patch`.
-
 ## Testing
 
 Generator specs should be added to the [spec](./spec) directory.
@@ -146,6 +143,19 @@ RSpec.describe Rolemodel::Testing::JasminePlaywrightGenerator, type: :generator
 end
 ```
 
+If the generator you're testing depends on being run after another generator, you should run that one first.
+
+e.g.
+
+```ruby
+RSpec.describe Rolemodel::MyGenerator, type: :generator do
+  before do
+    run_generator_against_test_app(generator: ::Rolemodel::PrereqGenerator)
+    run_generator_against_test_app
+  end
+end
+```
+
 Additional information about testing generators and the available assertions & matchers can be found at the following resources.
 
 * [Rails Guide](https://guides.rubyonrails.org/generators.html#testing-generators)

data/lib/generators/rolemodel/all_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class AllGenerator < BaseGenerator
+  class AllGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def run_all_the_generators

data/lib/generators/rolemodel/editors/editors_generator.rb

@@ -4,7 +4,7 @@ require_relative 'vscode_helpers'
 
 module Rolemodel
   # Add standard editorconfig and any extensions to enable it
-  class EditorsGenerator < BaseGenerator
+  class EditorsGenerator < GeneratorBase
     include Rolemodel::VSCodeHelpers
 
     # This is bringing in the root from this gem, so we only modify

data/lib/generators/rolemodel/github/github_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class GithubGenerator < BaseGenerator
+  class GithubGenerator < GeneratorBase
     GITHUB_ACTIONS_REPO = 'https://github.com/RoleModel/actions.git'
     # Files which are both used by the gem source and copied to the target app without modification
     # are placed in the `.github` folder at the top level of this repository. This folder is then

data/lib/generators/rolemodel/good_job/good_job_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class GoodJobGenerator < BaseGenerator
+  class GoodJobGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_good_job

data/lib/generators/rolemodel/heroku/heroku_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class HerokuGenerator < BaseGenerator
+  class HerokuGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_app_json

data/lib/generators/rolemodel/kaminari/kaminari_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class KaminariGenerator < BaseGenerator
+  class KaminariGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_kaminari

data/lib/generators/rolemodel/linters/all_generator.rb

@@ -1,6 +1,6 @@
 module Rolemodel
   module Linters
-    class AllGenerator < BaseGenerator
+    class AllGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def run_all_the_generators

data/lib/generators/rolemodel/linters/eslint/eslint_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Linters
-    class EslintGenerator < BaseGenerator
+    class EslintGenerator < GeneratorBase
       include ReplaceContentHelper
       source_root File.expand_path('templates', __dir__)
 

data/lib/generators/rolemodel/linters/rubocop/rubocop_generator.rb

@@ -3,7 +3,7 @@
 module Rolemodel
   module Linters
     # Install the standard rubocop and a custom cop
-    class RubocopGenerator < BaseGenerator
+    class RubocopGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def install_rubocop

data/lib/generators/rolemodel/lograge/lograge_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class LogrageGenerator < BaseGenerator
+  class LogrageGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_lograge

data/lib/generators/rolemodel/mailers/mailers_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class MailersGenerator < BaseGenerator
+  class MailersGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_premailer_rails

data/lib/generators/rolemodel/optics/all_generator.rb

@@ -1,6 +1,6 @@
 module Rolemodel
   module Optics
-    class AllGenerator < Rolemodel::BaseGenerator
+    class AllGenerator < Rolemodel::GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def run_all_the_generators

data/lib/generators/rolemodel/optics/base/base_generator.rb

@@ -1,6 +1,6 @@
 module Rolemodel
   module Optics
-    class BaseGenerator < Rolemodel::BaseGenerator
+    class BaseGenerator < Rolemodel::GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def add_optics_package
@@ -12,7 +12,7 @@ module Rolemodel
       def copy_templates
         say 'importing stylesheet', :green
 
-        prepend_to_file 'app/assets/stylesheets/application.scss', <<~SCSS
+        prepend_to_file Dir.glob('app/assets/stylesheets/application.*').first, <<~SCSS
           @import '@rolemodel/optics/dist/css/optics';
         SCSS
       end

data/lib/generators/rolemodel/optics/icons/README.md

@@ -4,4 +4,9 @@
 
 ## What you get
 
-Adds icon helper for handling material icons and custom icons
+Adds icon helper for handling icon generation using the provider of your choice.
+
+## Icon Builder Customization
+
+Run the generator with the `-i` option to install the IconBuilders themselves in your
+application's `lib/rolemodel/optics` directory.

data/lib/generators/rolemodel/optics/icons/icons_generator.rb

@@ -3,7 +3,8 @@
 module Rolemodel
   module Optics
     # Generates the icon helper and icon builders for the chosen icon library
-    class IconsGenerator < Rolemodel::BaseGenerator
+    class IconsGenerator < Rolemodel::GeneratorBase
+      BUILDER_DIR = 'rolemodel/optics'
       SUPPORTED_LIBRARIES = HashWithIndifferentAccess.new(
         material: 'filled, size, weight, emphasis, additional_classes, color, hover_text',
         phosphor: 'duotone, filled, size, weight, additional_classes, color, hover_text',
@@ -14,30 +15,34 @@ module Rolemodel
       ).freeze
 
       source_root File.expand_path('templates', __dir__)
+      class_option :install_builders, aliases: '-i', type: :boolean, default: false,
+                   desc: "Install IconBuilder classes for customization"
+
       class_exclusive do
         SUPPORTED_LIBRARIES.keys.each do |library|
           class_option library, type: :boolean, lazy_default: false, desc: "Use #{library} icon library"
         end
       end
 
-      def remove_existing_icon_helper_and_builders
-        remove_dir 'app/icon_builders'
-        remove_file 'app/helpers/icon_helper.rb'
-      end
-
       def add_view_helper
         @chosen_library = capture_user_selection
         @supported_properties = SUPPORTED_LIBRARIES.fetch(@chosen_library)
 
-        template 'app/icon_builders/icon_builder.rb'
-        template "app/icon_builders/#{@chosen_library}_icon_builder.rb"
-        template 'app/helpers/icon_helper.rb'
+        template 'app/helpers/icon_helper.rb', force: true
+      end
+
+      def install_builders
+        return unless options.install_builders?
+
+        source_paths << File.expand_path(BUILDER_DIR, Rolemodel::GEM_LIB)
+        copy_file 'icon_builder.rb', "lib/#{BUILDER_DIR}/icon_builder.rb", force: true
+        copy_file "#{@chosen_library}_icon_builder.rb", "lib/#{BUILDER_DIR}/#{@chosen_library}_icon_builder.rb", force: true
       end
 
     private
 
       def capture_user_selection
-        options.except(*%i[skip_namespace skip_collision_check]).invert[true] || ask(
+        options.slice(*SUPPORTED_LIBRARIES.keys).invert[true] || ask(
           'What icon library would you like to add?',
           default: SUPPORTED_LIBRARIES.keys.first.to_s,
           limited_to: SUPPORTED_LIBRARIES.keys.map(&:to_s)

data/lib/generators/rolemodel/optics/icons/templates/app/helpers/icon_helper.rb.tt

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rolemodel/optics'
+
 # Helper method that renders icons from your icon library of choice.
 #
 # Usage:
@@ -14,11 +16,11 @@
 module IconHelper
   # <%= @supported_properties %>
   def icon(name, **)
-    <%= @chosen_library.classify %>IconBuilder.new(name, **).build
+    Rolemodel::Optics::<%= @chosen_library.classify %>IconBuilder.new(name, **).build
   end
 
   # <%= @supported_properties %>
   def flash_icon(type, **)
-    <%= @chosen_library.classify %>IconBuilder.flash_icon(type, **).build
+    Rolemodel::Optics::<%= @chosen_library.classify %>IconBuilder.flash_icon(type, **).build
   end
 end

data/lib/generators/rolemodel/react/react_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class ReactGenerator < BaseGenerator
+  class ReactGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def add_npm_packages

data/lib/generators/rolemodel/readme/readme_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class ReadmeGenerator < BaseGenerator
+  class ReadmeGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_readme

data/lib/generators/rolemodel/saas/all_generator.rb

@@ -1,6 +1,6 @@
 module Rolemodel
   module Saas
-    class AllGenerator < BaseGenerator
+    class AllGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def run_all_the_generators

data/lib/generators/rolemodel/saas/devise/devise_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Saas
-    class DeviseGenerator < BaseGenerator
+    class DeviseGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def add_organization

data/lib/generators/rolemodel/semaphore/semaphore_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class SemaphoreGenerator < BaseGenerator
+  class SemaphoreGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def create_base_semaphore_config

data/lib/generators/rolemodel/simple_form/simple_form_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class SimpleFormGenerator < BaseGenerator
+  class SimpleFormGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def add_gem

data/lib/generators/rolemodel/slim/slim_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class SlimGenerator < BaseGenerator
+  class SlimGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def add_slim

data/lib/generators/rolemodel/soft_destroyable/soft_destroyable_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class SoftDestroyableGenerator < BaseGenerator
+  class SoftDestroyableGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def add_concern

data/lib/generators/rolemodel/source_map/source_map_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class SourceMapGenerator < BaseGenerator
+  class SourceMapGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def inject_config_for_production

data/lib/generators/rolemodel/tailored_select/tailored_select_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class TailoredSelectGenerator < BaseGenerator
+  class TailoredSelectGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def add_tailored_select_package

data/lib/generators/rolemodel/testing/README.md

@@ -5,7 +5,10 @@
 ## What you get
 
 * [RSpec](./rspec)
-* [JasminePlaywright](./jasmine_playwright)
 * [FactoryBot](./factory_bot)
 * [TestProf](./test_prof)
 * [ParallelTests](./parallel_tests)
+
+Include the `--js-runner` flag (off by default) to also install the private `@rolemodel/jasmine-playwright-runner` package.
+
+* [JasminePlaywright](./jasmine_playwright)

data/lib/generators/rolemodel/testing/all_generator.rb

@@ -1,13 +1,13 @@
 module Rolemodel
   module Testing
-    class AllGenerator < BaseGenerator
+    class AllGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
+      class_option :js_runner, type: :boolean, default: false, desc: 'Include jasmine-playwright-runner for browser testing'
+
       def run_all_the_generators
         generate 'rolemodel:testing:factory_bot'
-        if yes?('Would you like to add jasmine-playwright-runner for browser testing?')
-          generate 'rolemodel:testing:jasmine_playwright'
-        end
+        generate 'rolemodel:testing:jasmine_playwright' if options.js_runner?
         generate 'rolemodel:testing:parallel_tests'
         generate 'rolemodel:testing:rspec'
         generate 'rolemodel:testing:test_prof'

data/lib/generators/rolemodel/testing/factory_bot/factory_bot_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Testing
-    class FactoryBotGenerator < BaseGenerator
+    class FactoryBotGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def install_factory_bot_rails

data/lib/generators/rolemodel/testing/jasmine_playwright/jasmine_playwright_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Testing
-    class JasminePlaywrightGenerator < BaseGenerator
+    class JasminePlaywrightGenerator < GeneratorBase
       include ReplaceContentHelper
       source_root File.expand_path('templates', __dir__)
       class_option :github_package_token, type: :string, default: ENV['GITHUB_PACKAGES_TOKEN'], desc: 'GitHub Packages token with access to @rolemodel packages'
@@ -15,7 +15,7 @@ module Rolemodel
       ].freeze
 
       def fail_without_github_token
-        raise 'a --github_package_token option or GITHUB_PACKAGES_TOKEN environment variable is required' if options[:github_package_token].blank?
+        raise Thor::InvocationError, 'a --github_package_token option or GITHUB_PACKAGES_TOKEN environment variable is required' if options[:github_package_token].blank?
       end
 
       def yarn_init_unless_package_json_exists

data/lib/generators/rolemodel/testing/parallel_tests/parallel_tests_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Testing
-    class ParallelTestsGenerator < BaseGenerator # rubocop:disable Style/Documentation
+    class ParallelTestsGenerator < GeneratorBase # rubocop:disable Style/Documentation
       source_root File.expand_path('templates', __dir__)
 
       def install_parallel_tests

data/lib/generators/rolemodel/testing/rspec/README.md

@@ -29,7 +29,7 @@ it 'saves the form data', :js do
 end
 ```
 
-#### Chrome - visible browser
+#### Chrome - visible browser (For debugging only - do not commit headful system specs)
 
 ```rb
 it 'saves the form data', :chrome do

data/lib/generators/rolemodel/testing/rspec/USAGE

@@ -8,7 +8,7 @@ Example:
         spec/rails_helper.rb
         spec/spec_helper.rb
         spec/support/capybara_drivers.rb
-        spec/support/capybara_testid.rb
+        spec/support/capybara_config.rb
         spec/support/helpers.rb
         spec/support/webpacker.rb
         .rspec

data/lib/generators/rolemodel/testing/rspec/rspec_generator.rb

@@ -2,20 +2,27 @@
 
 module Rolemodel
   module Testing
-    class RspecGenerator < BaseGenerator
+    class RspecGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
+      class_option :marsh_grass, type: :boolean, default: false, desc: 'Include marsh_grass for debugging RSpec tests'
+
       def install_rspec
+        say 'Installing RSpec-rails', :green
+
         gem_group :development, :test do
           gem 'rspec-rails'
         end
-        run_bundle
+
+        say 'Installing capybara-playwright-driver for system tests', :green
 
         gem_group :test do
           gem 'capybara-playwright-driver'
-          gem 'marsh_grass'
-          gem 'pry'
-          gem 'webdrivers'
+
+          if options.marsh_grass?
+            gem 'marsh_grass'
+            gem 'pry'
+          end
         end
         run_bundle
       end
@@ -28,17 +35,10 @@ module Rolemodel
       end
 
       def add_spec_files
-        template 'rails_helper.rb', 'spec/rails_helper.rb'
-        template 'spec_helper.rb', 'spec/spec_helper.rb'
-        template '.rspec', '.rspec'
-        template 'support/capybara_drivers.rb', 'spec/support/capybara_drivers.rb'
-        template 'support/capybara_testid.rb', 'spec/support/capybara_testid.rb'
-        template 'support/helpers/action_cable_helper.rb', 'spec/support/helpers/action_cable_helper.rb'
-        template 'support/helpers/capybara_helper.rb', 'spec/support/helpers/capybara_helper.rb'
-        template 'support/helpers/playwright_helper.rb', 'spec/support/helpers/playwright_helper.rb'
-        template 'support/helpers/select_helper.rb', 'spec/support/helpers/select_helper.rb'
-        template 'support/helpers/test_element_helper.rb', 'spec/support/helpers/test_element_helper.rb'
-        template 'support/helpers.rb', 'spec/support/helpers.rb'
+        say 'Adding Support Files', :green
+
+        directory 'spec'
+
         append_file '.gitignore', 'spec/examples.txt'
       end
     end

data/lib/generators/rolemodel/testing/rspec/templates/{rails_helper.rb → spec/rails_helper.rb.tt}

@@ -9,6 +9,10 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym "MCP"
+end
+
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end

data/lib/generators/rolemodel/testing/rspec/templates/spec/support/capybara_config.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Capybara.configure do |config|
+  config.test_id = 'data-testid'
+  config.default_normalize_ws = true
+  config.save_path = './tmp/screenshots'
+  config.automatic_label_click = true
+  config.threadsafe = true
+end

data/lib/generators/rolemodel/testing/rspec/templates/{support/capybara_drivers.rb → spec/support/capybara_drivers.rb.tt}

@@ -47,5 +47,3 @@ Capybara.server = :puma, { Silent: true }
 
 # try to remove any potential for parallel tests to conflict
 Capybara.threadsafe = true
-
-Webdrivers.cache_time = 24.hours.to_i

data/lib/generators/rolemodel/testing/test_prof/test_prof_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Testing
-    class TestProfGenerator < BaseGenerator
+    class TestProfGenerator < GeneratorBase
       def install_test_prof
         gem_group :test do
           gem 'test-prof'

data/lib/generators/rolemodel/testing/vitest/vitest_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Testing
-    class VitestGenerator < BaseGenerator
+    class VitestGenerator < GeneratorBase
       include ReplaceContentHelper
       source_root File.expand_path('templates', __dir__)
 

data/lib/generators/rolemodel/ui_components/all_generator.rb

@@ -1,6 +1,6 @@
 module Rolemodel
   module UiComponents
-    class AllGenerator < BaseGenerator
+    class AllGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def run_all_the_generators

data/lib/generators/rolemodel/ui_components/flash/flash_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module UiComponents
-    class FlashGenerator < BaseGenerator
+    class FlashGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def generate_files

data/lib/generators/rolemodel/ui_components/modals/modals_generator.rb

@@ -1,6 +1,6 @@
 module Rolemodel
   module UiComponents
-    class ModalsGenerator < BaseGenerator
+    class ModalsGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
       class_option :panels, type: :boolean, default: false, desc: 'Include RoleModel Panel Setup'
 

data/lib/generators/rolemodel/ui_components/navbar/navbar_generator.rb

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module UiComponents
-    class NavbarGenerator < BaseGenerator
+    class NavbarGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def copy_navbar_files

data/lib/generators/rolemodel/webpack/webpack_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class WebpackGenerator < BaseGenerator
+  class WebpackGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     DEV_DEPS = %w[

data/lib/rolemodel/engine.rb

@@ -2,8 +2,10 @@
 
 module Rolemodel
   class Engine < ::Rails::Engine
+    require_relative 'generator_base'
+
     generators do
-      require 'generators/rolemodel/base_generator'
+      require 'generators/rolemodel/all_generator'
     end
   end
 end

data/lib/rolemodel/generator_base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/bundle_helper'
+require_relative 'replace_content_helper'
+
+module Rolemodel
+  class GeneratorBase < ::Rails::Generators::Base
+    include ::Rails::Generators::BundleHelper, ReplaceContentHelper
+
+    private
+    # based on https://github.com/rails/rails/blob/main/railties/lib/rails/generators/app_base.rb#L713
+    def run_bundle
+      bundle_command("install --quiet", "BUNDLE_IGNORE_MESSAGES" => "1")
+    end
+  end
+end

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/custom_icon_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # CustomIconBuilder is an IconBuilder that allows for custom SVG icons to be used in the application.
-class CustomIconBuilder < IconBuilder
+class Rolemodel::Optics::CustomIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
       notice: 'circle-check',

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/feather_icon_builder.rb

@@ -2,7 +2,7 @@
 
 # FeatherIconBuilder is an IconBuilder that allows for Feather icons to be used in the application.
 # https://feathericons.com/
-class FeatherIconBuilder < IconBuilder
+class Rolemodel::Optics::FeatherIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
       notice: 'check-circle',

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/icon_builder.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-class IconBuilder
+class Rolemodel::Optics::IconBuilder
   include ActionView::Helpers::TagHelper
 
   attr_reader :name, :filled, :size, :weight, :emphasis, :duotone, :additional_classes, :color, :hover_text
+  alias title hover_text
 
   DEFAULT_SIZE = 'medium'
   DEFAULT_WEIGHT = 'normal'
   DEFAULT_EMPHASIS = 'normal'
 
+  # TODO: consider Data.define a custom options object if all of these parameters are indeed necessary.
   def initialize( # rubocop:disable Metrics/ParameterLists
     name,
     filled: false,
@@ -42,32 +44,21 @@ class IconBuilder
   def build
     options = {
       class: tag_classes.compact_blank.join(' '),
-      title: hover_text
-    }
-
-    if color.present?
+      title: hover_text,
       # color: primary, neutral, alerts-notice, alerts-warning, alerts-danger, alerts-info
-      options[:style] = "#{color_attribute}: var(--op-color-#{color}-base);"
-    end
+      style: ("#{color_attribute}: var(--op-color-#{color}-base);" if color.present?)
+    }.compact_blank
 
-    tag.send(tag_method, tag_contents, **options)
+    tag.public_send(tag_method, tag_contents, **options)
   end
 
   private
 
-  def tag_method
-    raise NotImplementedError
-  end
-
-  def tag_contents
-    ''
-  end
-
   def tag_classes
     ['icon', size == DEFAULT_SIZE ? '' : "icon--#{size}", additional_classes]
   end
 
-  def color_attribute
-    'color'
-  end
+  def color_attribute = 'color'
+  def tag_contents = ''
+  def tag_method = :i
 end

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/lucide_icon_builder.rb

@@ -2,7 +2,7 @@
 
 # LucideIconBuilder is an IconBuilder that allows for Lucide icons to be used in the application.
 # https://lucide.dev/icons/
-class LucideIconBuilder < IconBuilder
+class Rolemodel::Optics::LucideIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
       notice: 'circle-check',

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/material_icon_builder.rb

@@ -2,7 +2,7 @@
 
 # MaterialIconBuilder is an IconBuilder that allows for Material icons to be used in the application.
 # https://fonts.google.com/icons
-class MaterialIconBuilder < IconBuilder
+class Rolemodel::Optics::MaterialIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
       notice: 'check_circle',

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/phosphor_icon_builder.rb

@@ -2,7 +2,7 @@
 
 # PhosphorIconBuilder is an IconBuilder that allows for Phosphor icons to be used in the application.
 # https://phosphoricons.com/
-class PhosphorIconBuilder < IconBuilder
+class Rolemodel::Optics::PhosphorIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
       notice: 'check-circle',

data/lib/{generators/rolemodel/optics/icons/templates/app/icon_builders → rolemodel/optics}/tabler_icon_builder.rb

@@ -2,7 +2,7 @@
 
 # TablerIconBuilder is an IconBuilder that allows for Tabler icons to be used in the application.
 # https://tablericons.com/
-class TablerIconBuilder < IconBuilder
+class Rolemodel::Optics::TablerIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
       notice: 'circle-check',

data/lib/rolemodel/optics.rb

@@ -0,0 +1,9 @@
+module Rolemodel::Optics
+  autoload :IconBuilder, 'rolemodel/optics/icon_builder'
+  autoload :CustomIconBuilder, 'rolemodel/optics/custom_icon_builder'
+  autoload :FeatherIconBuilder, 'rolemodel/optics/feather_icon_builder'
+  autoload :LucideIconBuilder, 'rolemodel/optics/lucide_icon_builder'
+  autoload :MaterialIconBuilder, 'rolemodel/optics/material_icon_builder'
+  autoload :PhosphorIconBuilder, 'rolemodel/optics/phosphor_icon_builder'
+  autoload :TablerIconBuilder, 'rolemodel/optics/tabler_icon_builder'
+end

data/lib/rolemodel/utility/task_tools.rb

@@ -0,0 +1,42 @@
+require 'benchmark'
+
+module Rolemodel
+  module Utility
+    module TaskTools
+      PROGRESS = %w[⠏ ⠇ ⠧ ⠦ ⠴ ⠼ ⠸ ⠹ ⠙ ⠋].cycle
+
+      # based on the migration helper of the same name
+      def say_with_time(message, &)
+        say message
+        time = Benchmark.measure(&)
+        say '%.4fs' % time.real, subitem: true
+      end
+
+      def say(message, subitem: false)
+        puts "#{subitem ? '   ->' : '--'} #{message}" # rubocop:disable Rails/Output
+      end
+
+      ##
+      # Indicate the progress of a long-running process
+      #
+      # Usage (with a known total):
+      # 100.times do |i|
+      #   indicate_progress(i, 100)
+      # end
+      #
+      # Only update every 'report_interval' iteration for eye-trackable animation speed
+      # Also displays a completion percentage if a total is provided
+      def indicate_progress(index, total = nil, report_interval: 9)
+        return unless (index % report_interval).zero?
+
+        print("#{PROGRESS.next} #{to_percent(index, total) if total}\r") # rubocop:disable Rails/Output
+      end
+
+      private
+
+      def to_percent(index, total)
+        '%3.f%%' % (index / total.to_f * 100.0)
+      end
+    end
+  end
+end

data/lib/rolemodel/utility.rb

@@ -0,0 +1,3 @@
+module Rolemodel::Utility
+  autoload :TaskTools, 'rolemodel/utility/task_tools'
+end

data/lib/rolemodel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  VERSION = '1.0.0'
+  VERSION = '2.0.1'
 end

data/lib/rolemodel-rails.rb

@@ -3,6 +3,8 @@
 module Rolemodel
   NODE_VERSION = '24.12.0'
   RUBY_VERSION = '4.0.1'
+
+  GEM_LIB = File.expand_path(__dir__)
 end
 
 require 'rolemodel/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -23,6 +23,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +163,6 @@ files:
 - lib/generators/rolemodel/README.md
 - lib/generators/rolemodel/USAGE
 - lib/generators/rolemodel/all_generator.rb
-- lib/generators/rolemodel/base_generator.rb
 - lib/generators/rolemodel/editors/README.md
 - lib/generators/rolemodel/editors/USAGE
 - lib/generators/rolemodel/editors/editors_generator.rb
@@ -219,13 +232,6 @@ files:
 - lib/generators/rolemodel/optics/icons/USAGE
 - lib/generators/rolemodel/optics/icons/icons_generator.rb
 - lib/generators/rolemodel/optics/icons/templates/app/helpers/icon_helper.rb.tt
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/custom_icon_builder.rb
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/feather_icon_builder.rb
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/icon_builder.rb
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/lucide_icon_builder.rb
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/material_icon_builder.rb
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/phosphor_icon_builder.rb
-- lib/generators/rolemodel/optics/icons/templates/app/icon_builders/tabler_icon_builder.rb
 - lib/generators/rolemodel/react/README.md
 - lib/generators/rolemodel/react/USAGE
 - lib/generators/rolemodel/react/react_generator.rb
@@ -236,7 +242,6 @@ files:
 - lib/generators/rolemodel/readme/USAGE
 - lib/generators/rolemodel/readme/readme_generator.rb
 - lib/generators/rolemodel/readme/templates/README.md.erb
-- lib/generators/rolemodel/replace_content_helper.rb
 - lib/generators/rolemodel/saas/README.md
 - lib/generators/rolemodel/saas/USAGE
 - lib/generators/rolemodel/saas/all_generator.rb
@@ -338,16 +343,16 @@ files:
 - lib/generators/rolemodel/testing/rspec/README.md
 - lib/generators/rolemodel/testing/rspec/USAGE
 - lib/generators/rolemodel/testing/rspec/rspec_generator.rb
-- lib/generators/rolemodel/testing/rspec/templates/rails_helper.rb
-- lib/generators/rolemodel/testing/rspec/templates/spec_helper.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/capybara_drivers.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/capybara_testid.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/helpers.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/helpers/action_cable_helper.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/helpers/capybara_helper.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/helpers/playwright_helper.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/helpers/select_helper.rb
-- lib/generators/rolemodel/testing/rspec/templates/support/helpers/test_element_helper.rb
+- lib/generators/rolemodel/testing/rspec/templates/spec/rails_helper.rb.tt
+- lib/generators/rolemodel/testing/rspec/templates/spec/spec_helper.rb.tt
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/capybara_config.rb.tt
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/capybara_drivers.rb.tt
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers.rb.tt
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/action_cable_helper.rb
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/capybara_helper.rb
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/playwright_helper.rb
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/select_helper.rb
+- lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/test_element_helper.rb
 - lib/generators/rolemodel/testing/test_prof/README.md
 - lib/generators/rolemodel/testing/test_prof/USAGE
 - lib/generators/rolemodel/testing/test_prof/test_prof_generator.rb
@@ -390,12 +395,20 @@ files:
 - lib/generators/rolemodel/webpack/templates/postcss.config.cjs
 - lib/generators/rolemodel/webpack/templates/webpack.config.js
 - lib/generators/rolemodel/webpack/webpack_generator.rb
-- lib/generators/templates/generator/%filename%.rb.tt
-- lib/generators/templates/generator/README.md.tt
-- lib/generators/templates/generator/USAGE.tt
-- lib/generators/templates/generator_spec/%filename%_spec.rb.tt
 - lib/rolemodel-rails.rb
 - lib/rolemodel/engine.rb
+- lib/rolemodel/generator_base.rb
+- lib/rolemodel/optics.rb
+- lib/rolemodel/optics/custom_icon_builder.rb
+- lib/rolemodel/optics/feather_icon_builder.rb
+- lib/rolemodel/optics/icon_builder.rb
+- lib/rolemodel/optics/lucide_icon_builder.rb
+- lib/rolemodel/optics/material_icon_builder.rb
+- lib/rolemodel/optics/phosphor_icon_builder.rb
+- lib/rolemodel/optics/tabler_icon_builder.rb
+- lib/rolemodel/replace_content_helper.rb
+- lib/rolemodel/utility.rb
+- lib/rolemodel/utility/task_tools.rb
 - lib/rolemodel/version.rb
 homepage: https://github.com/RoleModel/rolemodel_rails
 licenses:

data/lib/generators/rolemodel/base_generator.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/base'
-require 'rails/generators/bundle_helper'
-require_relative 'replace_content_helper'
-
-class Rolemodel::BaseGenerator < Rails::Generators::Base
-  include Rails::Generators::BundleHelper,
-          Rolemodel::ReplaceContentHelper
-
-  private
-  # based on https://github.com/rails/rails/blob/main/railties/lib/rails/generators/app_base.rb#L713
-  def run_bundle
-    bundle_command("install --quiet", "BUNDLE_IGNORE_MESSAGES" => "1")
-  end
-end

data/lib/generators/rolemodel/testing/rspec/templates/support/capybara_testid.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-Capybara.configure do |config|
-  config.test_id = 'data-testid'
-end

data/lib/generators/templates/generator/%filename%.rb.tt

@@ -1,11 +0,0 @@
-module Rolemodel
-  <%= "module #{module_name}" if module_name %>
-    class <%= class_name %> < BaseGenerator
-      source_root File.expand_path('templates', __dir__)
-
-      def generate_stuff
-        say 'generating stuff', :green
-      end
-    end
-  <%= 'end' if module_name %>
-end

data/lib/generators/templates/generator/README.md.tt

@@ -1,11 +0,0 @@
-# <%= class_name.titleize %>
-
-<%= description %>
-
-## Prerequisites
-
-  - ...
-
-## What you get
-
-  - ...

data/lib/generators/templates/generator/USAGE.tt

@@ -1,5 +0,0 @@
-Description:
-  <%= description %>
-
-Example:
-  rails generate <%= command_name %>

data/lib/generators/templates/generator_spec/%filename%_spec.rb.tt

@@ -1,5 +0,0 @@
-RSpec.describe Rolemodel::<%= name.camelize %>Generator, type: :generator do
-  before { run_generator_against_test_app }
-
-  pending "add some examples to #{__FILE__}"
-end