rolemodel-rails 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fede781704d5a6d3f851f7dfafe1ab6a6d3be865609e009b6eaff8610c510656
-  data.tar.gz: ae9be94c16906a8ccb1bca770b9e6f385ef6f7e5e8e97a8c6c830502d567b145
+  metadata.gz: 9dec1145653dd0763c5df4ac4f21c6f2f2961ee3776fb30cf100529aacdb061e
+  data.tar.gz: be40ee27b145627cb7945eb8a7f478ef2520c7b0b6f8ab247466cfa45fdd57b4
 SHA512:
-  metadata.gz: bd3700f56df8e270774d4036bdebe388d86c37bcd190fb75f39022640dee94200ae7fe7eef23474a58c2c10e5aafea2809619bc34a6b6d4e86777798287b603b
-  data.tar.gz: d75431fd64ce262417b5468ae9af0f60ec5125d499c3f2bdbb91b6278c60fe20bb3d312bce1a3b85dc2882aef931968cc499a91e5e457579667248795e603ec6
+  metadata.gz: 8be97f77d771928e00785f143c43424d5557b395d2115dcd08c2243814037a830f081e51722a3a4f2318efc6467d7ca9fa4e643c68d31a2ac3af12ddc45e240c
+  data.tar.gz: ad3e144e4d3400e60f443cbe577484dafcb5640af32c803c92cdb9dedb18076b31628b4c801c91615d37e70fb69c99e0665b3de48487a1db2287459186157d9e

data/README.md

@@ -107,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
@@ -331,6 +332,19 @@ We use the embeded Rails apps (`example_rails_current` & `example_rails_legacy`)
 
 ## 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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  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

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