bp3-formtastic 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fd4667ebdd632b2a5fb80e8b9498dc1594990719d2cbae101d52618d97793ac
-  data.tar.gz: 57b9b6579614d3e4cfd9e439a85fefdcc6eb6b0f391501133997035b25132b20
+  metadata.gz: '08532c4a91d95f44af218f6ae3d8a6654d56ab203f591644a3636480996446ad'
+  data.tar.gz: 77239e4c3ab2c980a2be5cad63e3b2e4c39f587fa57c8eec86b6b7db48028462
 SHA512:
-  metadata.gz: 1def99fea2ec09af93804aa32d9229debaf918222126a08bf5470c30d3b6900476aa22995b7231025a3e502599149f76e5e2f39d7057ccf797f5a0028e0acb6b
-  data.tar.gz: 3797ae7d099d5044f65813981963e5d2559d64b57557e2514c49d494675a6840e14a4ae1d4e106e03e98d615d2e8a39fca0c8358a2ba911c1b0974732843edfa
+  metadata.gz: 7e2bf675dcef6cac9f6e632d87a0129b3db9378bda79bf665b717cbe75f647dac0b3a2c3399d58245ab2d17f88db8878a7a9c3bcc0a0535213c4a70c3f2f6048
+  data.tar.gz: 6df43393c541cd157bb4313d21a46efc9d698aec342743a38498f748be1c803b6c6c2f2b87a66e0e0b97cf5e3270bdd5b5ed917d35639a3c330df938cc86b226

data/.rubocop.yml

@@ -1,8 +1,6 @@
 require:
   - rubocop-rake
   - rubocop-rspec
-  - rubocop-capybara
-  - rubocop-factory_bot
 
 AllCops:
   TargetRubyVersion: 3.2.2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.2.1] - 2024-11-18
+
+- Relax gem constraints
+
+## [0.2.0] - 2024-08-20
+
+- Create form builders
+- Update #input_wrapping to use new form builders
+- Allow nil input_control_class_name
+
 ## [0.1.2] - 2024-07-01
 
 - Check for builder.id

data/Gemfile.lock

@@ -1,46 +1,52 @@
 PATH
   remote: .
   specs:
-    bp3-formtastic (0.1.2)
-      actionpack (>= 7.1.2, < 8)
-      activesupport (>= 7.1.2, < 8)
-      formtastic (~> 5.0)
+    bp3-formtastic (0.2.1)
+      actionpack (>= 7.1.2)
+      actionview (>= 7.1.2)
+      activesupport (>= 7.1.2)
+      formtastic (>= 5.0)
+      railties (>= 7.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.3.4)
-      actionview (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionpack (8.0.0)
+      actionview (= 8.0.0)
+      activesupport (= 8.0.0)
       nokogiri (>= 1.8.5)
-      racc
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.3.4)
-      activesupport (= 7.1.3.4)
+      useragent (~> 0.16)
+    actionview (8.0.0)
+      activesupport (= 8.0.0)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3.4)
+    activesupport (8.0.0)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
     base64 (0.2.0)
+    benchmark (0.4.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
     byebug (11.1.3)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
     diff-lcs (1.5.1)
@@ -48,27 +54,35 @@ GEM
     erubi (1.13.0)
     formtastic (5.0.0)
       actionpack (>= 6.0.0)
-    i18n (1.14.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
+    io-console (0.7.2)
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.8.2)
     language_server-protocol (3.17.0.3)
-    loofah (2.22.0)
+    logger (1.6.1)
+    loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.24.1)
-    mutex_m (0.2.0)
-    nokogiri (1.16.6-x86_64-darwin)
+    minitest (5.25.1)
+    nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.25.1)
-    parser (3.3.3.0)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
-    rack (3.1.4)
+    psych (5.2.0)
+      stringio
+    racc (1.8.1)
+    rack (3.1.8)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -76,55 +90,60 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
+    railties (8.0.0)
+      actionpack (= 8.0.0)
+      activesupport (= 8.0.0)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    rexml (3.3.1)
-      strscan
+    reline (0.5.11)
+      io-console (~> 0.5)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.2)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.64.1)
+    rubocop (1.68.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.36.1)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.1)
-      rubocop (~> 1.61)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.31.0)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.29.1)
+    rubocop-rspec (3.2.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
+    securerandom (0.3.2)
+    stringio (3.1.2)
+    thor (1.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (2.6.0)
+    uri (1.0.2)
+    useragent (0.16.10)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   x86_64-darwin-22
@@ -132,11 +151,11 @@ PLATFORMS
 DEPENDENCIES
   bp3-formtastic!
   byebug
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  rubocop-rake (~> 0.6)
-  rubocop-rspec (~> 2.25)
+  rake (>= 13.0)
+  rspec (>= 3.0)
+  rubocop (>= 1.21)
+  rubocop-rake (>= 0.6)
+  rubocop-rspec (>= 2.25)
 
 BUNDLED WITH
-   2.5.11
+   2.5.17

data/README.md

@@ -19,12 +19,22 @@ Or install it yourself as:
     $ gem install bp3-formtastic
 
 ## Usage
-In your application's `config/initializers/bp3-action_dispatch` initializer, specify the name of the class 
+In your application's `config/initializers/bp3-formtastic` initializer, specify the name of the class 
 that controls whether to show a formtastic input control or not:
 ```ruby
 Bp3::Formtastic.input_control_class_name = 'Vizfact::Input'
 ```
 
+In your application's formtastic configuration file (typically `config/initializers/formtastic`), 
+specify which form builder to use:
+```ruby
+Rails.application.config.after_initialize do
+  Formtastic::Helpers::FormHelper.builder = Bp3::Formtastic::VizFormBuilder
+end
+```
+Specify `Bp3::Formtastice::VizFormBuilderWithCreate` if you want new `Bp3::Formtastic.input_control_class_name` 
+records to be added for each form input encountered on a form.
+
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run 
 `rake spec` to run the tests. You can also run `bin/console` for an interactive 

data/Rakefile

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
 require 'rubocop/rake_task'
 
+Dir.glob('lib/tasks/**/*.rake').each { |file| load file }
+
+RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]

data/bp3-formtastic.gemspec

@@ -31,16 +31,18 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionpack', ['>= 7.1.2', '< 8']
-  spec.add_dependency 'activesupport', ['>= 7.1.2', '< 8']
-  spec.add_dependency 'formtastic', '~> 5.0'
+  spec.add_dependency 'actionpack', '>= 7.1.2'
+  spec.add_dependency 'actionview', '>= 7.1.2'
+  spec.add_dependency 'activesupport', '>= 7.1.2'
+  spec.add_dependency 'formtastic', '>= 5.0'
+  spec.add_dependency 'railties', '>= 7.1.2'
 
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.21'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.25'
+  spec.add_development_dependency 'rake', '>= 13.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop', '>= 1.21'
+  spec.add_development_dependency 'rubocop-rake', '>= 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.25'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/bp3/formtastic/railtie.rb

@@ -12,31 +12,16 @@ module Bp3
                 EXCLUDED_COLUMNS = %w[rqid sqnr].freeze
                 UUID_REGEX = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
 
-                # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
                 # PrependInputs provides formtastic input overrides
                 module PrependInputs
                   def input_wrapping(&)
                     return super if column.nil? # e.g. when called for individual details fields
+                    return super if Bp3::Formtastic.input_control_class.nil?
+                    return super unless builder.respond_to?(:viz)
                     return nil if column.name.in?(EXCLUDED_COLUMNS)
 
-                    # url = template.controller.request.url
-                    site = template.controller.send(:current_site)
-                    # tenant = template.controller.send(:current_tenant)
-                    # workspace = template.controller.send(:current_workspace)
-                    controller = template.controller.class.name
-                    action = template.controller.action_name
                     builder.id&.gsub(/_#{UUID_REGEX}/, '')
-                    # puts "input_wrapping s:#{site.id} c:#{controller} a:#{action} " \
-                    #                     "e:#{method} n:#{field_name} as:#{options[:as].inspect}"
-
-                    viz = input_control_class.where(sites_site: site,
-                                                    element_controller: controller,
-                                                    element_action: action,
-                                                    element_name: field_name)
-                                             .or(input_control_class.where(sites_site: site,
-                                                                           element_controller: controller,
-                                                                           element_action: action,
-                                                                           element_ident: dom_id)).first
+                    viz = builder.viz(field_name, dom_id)
                     return nil if viz.present? && !viz.show_element
 
                     super
@@ -52,7 +37,6 @@ module Bp3
                     "#{object_name}[#{input_name}]"
                   end
                 end
-                # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
                 module Base
                   prepend PrependInputs

data/lib/bp3/formtastic/version.rb

@@ -2,6 +2,6 @@
 
 module Bp3
   module Formtastic
-    VERSION = '0.1.2'
+    VERSION = '0.2.1'
   end
 end

data/lib/bp3/formtastic/viz_form_builder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'action_view/helpers/form_options_helper'
+require 'rails/engine'
+require 'formtastic'
+
+module Bp3
+  module Formtastic
+    class VizFormBuilder < ::Formtastic::FormBuilder
+      attr_reader :vizfacts
+
+      def initialize(...)
+        super
+        load_vizfacts
+      end
+
+      def input(method, options = {})
+        super
+      end
+
+      def viz(element_name, element_ident)
+        return if vizfacts.nil?
+
+        vizfacts.detect { |vf| vf.element_name == element_name || vf.element_ident == element_ident }
+      end
+
+      private
+
+      def vizfact_attrs(element_name, element_ident)
+        {
+          element_controller: template.controller.class.name,
+          element_action: template.controller.action_name,
+          element_name:,
+          element_ident:,
+          show_element: true
+        }
+      end
+
+      def load_vizfacts
+        return if input_control_class.nil?
+
+        site = template.controller.send(:current_site)
+        controller = template.controller.class.name
+        action = template.controller.action_name
+        @vizfacts = input_control_class.where(sites_site: site, element_controller: controller,
+                                              element_action: action).to_a
+      end
+
+      def input_control_class
+        Bp3::Formtastic.input_control_class
+      end
+    end
+  end
+end

data/lib/bp3/formtastic/viz_form_builder_with_create.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bp3
+  module Formtastic
+    class VizFormBuilderWithCreate < VizFormBuilder
+      def viz(element_name, element_ident)
+        return if vizfacts.nil?
+
+        record = super
+        return record if record
+
+        create_input_control_record(element_name, element_ident)
+      end
+
+      private
+
+      def create_input_control_record(element_name, element_ident)
+        attrs = vizfact_attrs(element_name, element_ident)
+        Vizfact::Input.unscoped.create!(attrs)
+      end
+    end
+  end
+end

data/lib/bp3/formtastic.rb

@@ -2,7 +2,12 @@
 
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/inflector'
+require 'action_dispatch' # to avoid the following ActionDispatch loading error
+#   uninitialized constant Rails::Engine::Configuration::ActionDispatch
+#     ./vendor/bundle/ruby/3.2.0/gems/railties-8.0.0/lib/rails/engine/configuration.rb:47:in `initialize'
 
+require_relative 'formtastic/viz_form_builder'
+require_relative 'formtastic/viz_form_builder_with_create'
 require_relative 'formtastic/railtie'
 require_relative 'formtastic/version'
 
@@ -11,7 +16,7 @@ module Bp3
     mattr_accessor :input_control_class_name
 
     def self.input_control_class
-      @@input_control_class ||= input_control_class_name.constantize # rubocop:disable Style/ClassVars
+      @@input_control_class ||= input_control_class_name&.constantize # rubocop:disable Style/ClassVars
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bp3-formtastic
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Wim den Braven
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.2
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '8'
+        version: 7.1.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +45,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,23 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
 - !ruby/object:Gem::Dependency
   name: formtastic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -82,70 +98,70 @@ dependencies:
   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.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.25'
 description:
@@ -169,6 +185,8 @@ files:
 - lib/bp3/formtastic.rb
 - lib/bp3/formtastic/railtie.rb
 - lib/bp3/formtastic/version.rb
+- lib/bp3/formtastic/viz_form_builder.rb
+- lib/bp3/formtastic/viz_form_builder_with_create.rb
 - sig/bp3/formtastic.rbs
 homepage: https://www.black-phoebe.com
 licenses:
@@ -194,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: bp3-formtastic adapts formtastic for BP3 (persuavis/black_phoebe_3).