rolemodel-rails 2.4.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab7ce13bbc4227eedf045d0ce216b341049445daab3856f6b1d435f9799ffb53
-  data.tar.gz: 5e5ce9316bd729ad8dd3bacf21d849aa274d9c870768fd6d7866f5cb2ae093bf
+  metadata.gz: 9dec1145653dd0763c5df4ac4f21c6f2f2961ee3776fb30cf100529aacdb061e
+  data.tar.gz: be40ee27b145627cb7945eb8a7f478ef2520c7b0b6f8ab247466cfa45fdd57b4
 SHA512:
-  metadata.gz: 74101aeb24869c8e84b1bb645573df9b95e97dfaf79d8c0d4d5980efafe46c64f414b9afded5511a9f4ae8bf0ee2339074e841710f08ba8314d996bd27a847db
-  data.tar.gz: 6438c65a802314259eaa3c0ebe8cdd94301e95f3dc5a1e82c1809f2285c219f731953da1b1bfe45ac5c877273a958b7ba5cd17f6052d4500dd12302590f194c4
+  metadata.gz: 8be97f77d771928e00785f143c43424d5557b395d2115dcd08c2243814037a830f081e51722a3a4f2318efc6467d7ca9fa4e643c68d31a2ac3af12ddc45e240c
+  data.tar.gz: ad3e144e4d3400e60f443cbe577484dafcb5640af32c803c92cdb9dedb18076b31628b4c801c91615d37e70fb69c99e0665b3de48487a1db2287459186157d9e

data/README.md

@@ -2,6 +2,8 @@
 
 Executable Best Practices for Rails apps, based on RoleModel's best approaches
 
+![title image](title_image.png)
+
 Attempts to solve the pain of:
 
 * Setup of a new Rails app is harder than it needs to be
@@ -105,6 +107,7 @@ bin/rails g
 * [GoodJob](./lib/generators/rolemodel/good_job)
 * [Editors](./lib/generators/rolemodel/editors)
 * [Tailored Select](./lib/generators/rolemodel/tailored_select)
+* [Tom Select](./lib/generators/rolemodel/tom_select)
 * [Lograge](./lib/generators/rolemodel/lograge)
 
 ## Utilities
@@ -324,11 +327,24 @@ e.g.
 bin/new_generator testing/fantasitic_specs 'A Fantastic Testing Framework'
 ```
 
-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.
+We use the embeded Rails apps (`example_rails_current` & `example_rails_legacy`) to test generators against. The specs run generators against a copy of `example_rails_current`.
+`example_rails_legacy` references the rolemodel-rails gem by local path, so you can navigate into it and run your generator for immediate feedback while developing.
 
 ## Testing
 
+Run the full suite with `bin/ci`. It splits the spec files across parallel processes, so it is much faster than a plain `bundle exec rspec`. CI uses the same command.
+
+```shell
+bin/ci
+```
+
+During development, you can still run a single file or example with RSpec directly:
+
+```shell
+bundle exec rspec spec/generators/rolemodel/turbo/form_generator_spec.rb
+bundle exec rspec spec/generators/rolemodel/turbo/form_generator_spec.rb:11
+```
+
 Generator specs should be added to the [spec](./spec) directory.
 
 Setup & Teardown of the test-dummy app is handled for you.  All you need to do is run the provided helper method:

data/lib/generators/rolemodel/README.md

@@ -4,20 +4,31 @@
 
 ## What you get
 
+* [Editors](./editors)
 * [Github](./github)
 * [GoodJob](./good_job)
 * [Heroku](./heroku)
+* [Kaminari](./kaminari)
 * [Linters](./linters)
+* [Lograge](./lograge)
 * [Mailers](./mailers)
-* [Modals](./modals)
 * [Optics](./optics)
+* [React](./react)
 * [README](./readme)
 * [SaaS](./saas)
+* [Sentry](./sentry)
 * [SimpleForm](./simple_form)
 * [Slim](./slim)
 * [SoftDestroyable](./soft_destroyable)
 * [Source Map](./source_map)
 * [Testing](./testing)
+* [Tom Select](./tom_select)
+* [Turbo](./turbo/all)
+  * [Ready](./turbo/ready)
+  * [Confirm](./turbo/confirm)
+  * [Modals](./turbo/modals)
+  * [Form](./turbo/form)
+* [UI Components](./ui_components)
 * [Webpack](./webpack)
 
 ## Helpful documentation

data/lib/generators/rolemodel/all_generator.rb

@@ -12,7 +12,9 @@ module Rolemodel
       generate 'rolemodel:slim'
       generate 'rolemodel:optics:all'
       generate 'rolemodel:testing:all'
+      generate 'rolemodel:turbo:all'
       generate 'rolemodel:simple_form'
+      generate 'rolemodel:tom_select'
       generate 'rolemodel:soft_destroyable'
       generate 'rolemodel:saas:all'
       generate 'rolemodel:mailers'

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

@@ -21,6 +21,7 @@ app you can push straight to Heroku right after generation.
   - [Testing](../testing) — RSpec, FactoryBot, parallel_tests, TestProf
     (pass `--js-runner` to include jasmine-playwright-runner)
   - [SimpleForm](../simple_form) — SimpleForm with our configuration
+  - [Tom Select](../tom_select) — Tom Select with a Stimulus controller and SimpleForm inputs
   - [Linters](../linters) — Rubocop and ESLint
   - [UI Components](../ui_components) — flash, the modal pattern, & Turbo 8 support
   - [Editors](../editors) — EditorConfig and recommended VSCode extensions

data/lib/generators/rolemodel/core_setup/core_setup_generator.rb

@@ -7,6 +7,7 @@ module Rolemodel
       generate 'rolemodel:webpack'
       generate 'rolemodel:optics:all'
       generate 'rolemodel:simple_form'
+      generate 'rolemodel:tom_select'
       generate 'rolemodel:testing:all'
       generate 'rolemodel:turbo:all'
       generate 'rolemodel:ui_components:flash'

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

@@ -10,3 +10,10 @@ Adds icon helper for handling icon generation using the provider of your choice.
 
 Run the generator with the `-i` option to install the IconBuilders themselves in your
 application's `lib/rolemodel/optics` directory.
+
+## SVG icons (for example, Hugeicons)
+
+Use `--custom`. Put each SVG in `app/assets/images/icons/`, and `icon('name')` inlines it with
+Optics' `.icon--svg` modifier (Optics 2.5+), so size, weight and emphasis modifiers apply. A subfolder
+works as part of the name: `icon('duotone-rounded/home-01')`. Draw the SVGs with `currentColor`
+so they follow the text color.

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

@@ -8,9 +8,7 @@ module Rolemodel
                                    desc: 'Install the tailored_select experimental component input'
 
     def add_gem
-      Bundler.with_unbundled_env do
-        bundle_command 'add simple_form'
-      end
+      bundle_command 'add simple_form'
     end
 
     def add_files

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

@@ -0,0 +1,15 @@
+# Tom Select Generator
+
+`rails g rolemodel:tom_select`
+
+## What you get
+
+* The [Tom Select](https://tom-select.js.org/) package and its stylesheet
+* A `tom-select` Stimulus controller that survives Turbo morphs
+* `tom_select` and `grouped_tom_select` SimpleForm inputs, if the app uses SimpleForm
+
+```slim
+= f.input :project_manager, as: :tom_select, collection: User.all
+= f.input :substance, as: :tom_select, collection: Substance.all, allow_create: true
+= f.input :material, as: :grouped_tom_select, collection: Category.all, group_method: :materials
+```

data/lib/generators/rolemodel/tom_select/USAGE

@@ -0,0 +1,7 @@
+Description:
+  Installs the tom-select package, its stylesheet, and a tom-select Stimulus
+  controller. If the app is using SimpleForm, it also installs the matching
+  tom_select and grouped_tom_select SimpleForm inputs.
+
+Example:
+  rails generate rolemodel:tom_select

data/lib/generators/rolemodel/tom_select/templates/app/inputs/grouped_tom_select_input.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class GroupedTomSelectInput < SimpleForm::Inputs::GroupedCollectionSelectInput
+  def input(wrapper_options = nil)
+    super(merge_wrapper_options(tom_select_options, wrapper_options))
+  end
+
+  def input_html_classes = []
+
+  private
+
+  def tom_select_options
+    { data: { controller: 'tom-select', action: TomSelectInput::MORPH_ACTIONS } }
+  end
+end

data/lib/generators/rolemodel/tom_select/templates/app/inputs/tom_select_input.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class TomSelectInput < SimpleForm::Inputs::CollectionSelectInput
+  MORPH_ACTIONS = 'turbo:before-morph-element->tom-select#disconnect:self turbo:morph-element->tom-select#afterMorph:self'
+
+  def input(wrapper_options = nil)
+    super(merge_wrapper_options(tom_select_options, wrapper_options))
+  end
+
+  def input_html_classes = []
+
+  private
+
+  def tom_select_options
+    { data: { controller: 'tom-select', tom_select_create_value: options.delete(:allow_create) || false, action: MORPH_ACTIONS } }
+  end
+end

data/lib/generators/rolemodel/tom_select/templates/app/javascript/controllers/tom_select_controller.js

@@ -0,0 +1,36 @@
+import { Controller } from '@hotwired/stimulus'
+import TomSelect from 'tom-select'
+
+export default class extends Controller {
+  static values = { create: Boolean }
+
+  connect() {
+    this.tomSelect = new TomSelect(this.element, this.settings)
+    this.element.tomSelect = this.tomSelect
+  }
+
+  disconnect() {
+    // In case a Turbo morph is happening, we need to update TomSelect's revertSettings,
+    // in order to preserve the current value(s) when reconnecting.
+    this.tomSelect.revertSettings.innerHTML = this.element.innerHTML
+
+    this.tomSelect.destroy()
+    delete this.element.tomSelect
+  }
+
+  afterMorph() {
+    queueMicrotask(() => this.connect())
+  }
+
+  get settings() {
+    return {
+      create: this.createValue,
+      persist: false,
+      maxOptions: null,
+      delimiter: null,
+      maxItems: this.element.multiple ? null : 1,
+      plugins: this.element.multiple ? ['remove_button'] : [],
+      onItemAdd: () => this.tomSelect.setTextboxValue(''), // clear the input text box when a selection is made
+    }
+  }
+}

data/lib/generators/rolemodel/tom_select/tom_select_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class TomSelectGenerator < GeneratorBase
+    source_root File.expand_path('templates', __dir__)
+
+    def add_tom_select_package
+      say 'Installing Tom Select package', :green
+
+      yarn_command 'add tom-select'
+    end
+
+    def import_stylesheet
+      say 'Importing Tom Select stylesheet', :green
+
+      prepend_to_file application_stylesheet_path, <<~CSS
+        @import 'tom-select/dist/css/tom-select.css';
+      CSS
+    end
+
+    def add_stimulus_controller
+      say 'Adding Tom Select Stimulus controller', :green
+
+      directory 'app/javascript/controllers'
+
+      rails_command 'stimulus:manifest:update'
+    end
+
+    def add_simple_form_inputs
+      return unless simple_form?
+
+      say 'Installing the Tom Select SimpleForm inputs', :green
+
+      directory 'app/inputs'
+    end
+
+    private
+
+    def simple_form?
+      File.exist?(File.expand_path('config/initializers/simple_form.rb', destination_root))
+    end
+  end
+end

data/lib/generators/rolemodel/turbo/all/README.md

@@ -13,4 +13,4 @@ Runs all Turbo Generators
   - Turbo meta tags in HEAD
   - TurboConfirm setup
   - Turbo Frame Modals setup
-  - Turbo-Form stimulus controller
+  - turbo_form gem for dynamic forms

data/lib/generators/rolemodel/turbo/form/README.md

@@ -1,8 +1,9 @@
 # Form Generator
 
-Enable the "turbo-fetch" (now Turbo-Form) pattern in new/existing rails apps.
+Enable dynamic form interactions in new/existing rails apps with the [turbo_form](https://github.com/OutlawAndy/turbo_form) gem.
 
 ## What you get
 
-  - turbo-form controller
-  - system spec helper
+  - the `turbo_form` gem, set up by its `turbo_form:install` generator
+
+Draw the `:turbo_form` route concern on each resource with a dynamic form. See the gem's README for usage.

data/lib/generators/rolemodel/turbo/form/form_generator.rb

@@ -1,28 +1,13 @@
 module Rolemodel
   module Turbo
     class FormGenerator < GeneratorBase
-      source_root File.expand_path('templates', __dir__)
+      def install_turbo_form
+        say 'Installing turbo_form', :green
 
-      def add_rails_request_package
-        say 'Installing @rails/request.js package', :green
+        bundle_command 'add turbo_form'
 
-        yarn_command 'add @rails/request.js'
-      end
-
-      def add_stimulus_controller
-        say 'Adding Turbo Form Stimulus Controller', :green
-
-        directory 'app/javascript/controllers'
-
-        rails_command 'stimulus:manifest:update'
-      end
-
-      def add_system_spec_helper
-        say 'Adding Turbo Form System Spec Helper', :green
-
-        directory 'spec/support/helpers'
+        generate 'turbo_form:install'
       end
     end
   end
 end
-

data/lib/rolemodel/optics/custom_icon_builder.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 # CustomIconBuilder is an IconBuilder that allows for custom SVG icons to be used in the application.
+# It inlines app/assets/images/icons/<name>.svg, so any SVG set works, including Hugeicons:
+#
+#   icon('home-01')                   # icons/home-01.svg
+#   icon('duotone-rounded/home-01')   # icons/duotone-rounded/home-01.svg
 class Rolemodel::Optics::CustomIconBuilder < Rolemodel::Optics::IconBuilder
   def self.flash_icons
     {
@@ -15,28 +19,28 @@ class Rolemodel::Optics::CustomIconBuilder < Rolemodel::Optics::IconBuilder
     :span
   end
 
-  # NOTE: This does not work with propshaft and the latest asset pipeline
-  # We will need to find a way to make this work in Rails 8 with propshaft.
-  def tag_contents # rubocop:disable Metrics/AbcSize
+  def tag_contents
     # Inspired by https://blog.cloud66.com/using-svgs-in-a-rails-stack
-    asset = Rails.application.assets_manifest.find_sources(svg_path).first
+    source = svg_source
+    return "<!-- SVG #{svg_path} not found -->".html_safe if source.nil?
 
-    if asset
-      file = asset.source.force_encoding('UTF-8')
-      doc = Nokogiri::HTML::DocumentFragment.parse file
-      svg = doc.at_css 'svg'
-      svg['class'] = options[:class] if options[:class].present?
+    # These SVG files can safely be marked html_safe since we created them and they are part of this app's code.
+    source.dup.force_encoding('UTF-8').html_safe
+  end
+
+  # Propshaft and Sprockets find assets differently.
+  def svg_source
+    assets = Rails.application.assets
+    if assets.respond_to?(:load_path)
+      assets.load_path.find(svg_path)&.content
     else
-      doc = "<!-- SVG #{svg_path} not found -->"
+      Rails.application.assets_manifest.find_sources(svg_path).first&.source
     end
-
-    # These SVG files can safely be marked html_safe since we created them and they are part of this app's code.
-    raw doc
   end
 
   def tag_classes
     [
-      'custom-icons',
+      'icon--svg',
       filled ? 'icon--filled' : '',
       weight == DEFAULT_WEIGHT ? '' : "icon--weight-#{weight}",
       emphasis == DEFAULT_EMPHASIS ? '' : "icon--#{emphasis}-emphasis"

data/lib/rolemodel/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.6.0
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  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
@@ -379,6 +393,12 @@ files:
 - lib/generators/rolemodel/testing/vitest/templates/spec/javascript/test-setup.js
 - lib/generators/rolemodel/testing/vitest/templates/vitest.config.js
 - lib/generators/rolemodel/testing/vitest/vitest_generator.rb
+- lib/generators/rolemodel/tom_select/README.md
+- lib/generators/rolemodel/tom_select/USAGE
+- lib/generators/rolemodel/tom_select/templates/app/inputs/grouped_tom_select_input.rb
+- lib/generators/rolemodel/tom_select/templates/app/inputs/tom_select_input.rb
+- lib/generators/rolemodel/tom_select/templates/app/javascript/controllers/tom_select_controller.js
+- lib/generators/rolemodel/tom_select/tom_select_generator.rb
 - lib/generators/rolemodel/turbo/all/README.md
 - lib/generators/rolemodel/turbo/all/USAGE
 - lib/generators/rolemodel/turbo/all/all_generator.rb
@@ -390,8 +410,6 @@ files:
 - lib/generators/rolemodel/turbo/form/README.md
 - lib/generators/rolemodel/turbo/form/USAGE
 - lib/generators/rolemodel/turbo/form/form_generator.rb
-- lib/generators/rolemodel/turbo/form/templates/app/javascript/controllers/turbo_form_controller.js
-- lib/generators/rolemodel/turbo/form/templates/spec/support/helpers/turbo_form_helper.rb
 - lib/generators/rolemodel/turbo/modals/README.md
 - lib/generators/rolemodel/turbo/modals/USAGE
 - lib/generators/rolemodel/turbo/modals/modals_generator.rb
@@ -459,7 +477,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: The RoleModel Way of building Rails apps.
 test_files: []

data/lib/generators/rolemodel/turbo/form/templates/app/javascript/controllers/turbo_form_controller.js

@@ -1,15 +0,0 @@
-import { Controller } from '@hotwired/stimulus'
-import { patch } from '@rails/request.js'
-
-export default class extends Controller {
-  static values = { url: String, count: Number }
-
-  async perform({ params: { url: urlParam, query: queryParams } }) {
-    const body = new FormData(this.element)
-
-    if (queryParams) Object.keys(queryParams).forEach(key => body.append(key, queryParams[key]))
-
-    const response = await patch(urlParam || this.urlValue, { body, responseKind: 'turbo-stream' })
-    if (response.ok) this.countValue += 1
-  }
-}

data/lib/generators/rolemodel/turbo/form/templates/spec/support/helpers/turbo_form_helper.rb

@@ -1,8 +0,0 @@
-module TurboFormHelper
-  def expect_turbo_form_request
-    count_value = find("[data-controller='turbo-form']")['data-turbo-form-count-value'] || 0
-    yield
-    expect(page).to have_selector("[data-turbo-form-count-value='#{count_value.to_i + 1}']"),
-                    'Expected a successful Turbo-Form request, but none was detected'
-  end
-end