bp3-formtastic 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: badca2d2bd57d4a8e74bf01fb63699e98b556e9bde9bacf841493003085218a5
-  data.tar.gz: 71e33e1a799e9b1a4329f1e8470056dfd75ee3c6a816f703f0559487de8063ff
+  metadata.gz: e1603f265734ec82fa61ee1d03f6098acbd898cc1caf6d5362340dde619f36ed
+  data.tar.gz: dba9f2dd5248e1426cb065d2b76c8a187b6c2c8e6005143725eaa6d1d09ec896
 SHA512:
-  metadata.gz: c2c5fe8aa33f2389357a510b7fc50383924369cf27d7177391bd389fbb6c5b54a56a44cec8109536680941d658c98c948bd22a14bfab11ab5346e6b57ac8e607
-  data.tar.gz: ed2e4a9f370d0dde477a0e72c7ce8b660da795b9fcc00fea36ce3865d276875169b0f05e4d54544fe0dce024cd515311b6ffaaf77e1ffa0dfb7e01f3ab8041cc
+  metadata.gz: 78a3bc4fd2dd535e89e5fff5eed8522fecc1572a76016ad1e4224f18c2010c6afde894f6133bc9dc09467c06def15dd5b746790ddb3fa0ab3d885a0664f7305c
+  data.tar.gz: b4b4871c0d0f222434190b62961db96a58ad694dde513ca0602e9caaa33f780770c865f170ba97cd9e3d08f71e187e12289447ffa8a7f6358adf13cb3e7ada47

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [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
+- Tweaks
+
 ## [0.1.1] - 2024-05-31
 
 - Tweaks and documentation

data/Gemfile.lock

@@ -1,17 +1,19 @@
 PATH
   remote: .
   specs:
-    bp3-formtastic (0.1.1)
+    bp3-formtastic (0.2.0)
       actionpack (>= 7.1.2, < 8)
+      actionview (>= 7.1.2, < 8)
       activesupport (>= 7.1.2, < 8)
       formtastic (~> 5.0)
+      railties (>= 7.1.2, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.3)
-      actionview (= 7.1.3)
-      activesupport (= 7.1.3)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -19,13 +21,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.3)
-      activesupport (= 7.1.3)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -37,39 +39,47 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    builder (3.2.4)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
     byebug (11.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
-    diff-lcs (1.5.0)
-    drb (2.2.0)
-      ruby2_keywords
-    erubi (1.12.0)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    erubi (1.13.0)
     formtastic (5.0.0)
       actionpack (>= 6.0.0)
-    i18n (1.14.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.21.2)
+    minitest (5.24.1)
     mutex_m (0.2.0)
-    nokogiri (1.16.0-x86_64-darwin)
+    nokogiri (1.16.6-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.24.0)
-    parser (3.3.0.4)
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
-    rack (3.0.8)
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
+    rack (3.1.4)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -77,24 +87,37 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
+    rexml (3.3.1)
+      strscan
+    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-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.60.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -102,26 +125,33 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    rubocop-ast (1.31.3)
+      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.26.1)
+    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 (~> 1.61)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    thor (1.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    zeitwerk (2.6.17)
 
 PLATFORMS
   x86_64-darwin-22

data/README.md

@@ -4,7 +4,6 @@ bp3-formtastic adapts formtastic for BP3, the persuavis/black_phoebe_3
 multi-site multi-tenant rails application.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,14 +19,23 @@ 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'
 ```
-## Development
 
+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 
 prompt that will allow you to experiment.
@@ -44,5 +52,4 @@ Run `rake` to run rspec tests and rubocop linting.
 A `.yardopts` file is provided to support yard documentation.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bp3-formtastic.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Wim den Braven']
   spec.email = ['wimdenbraven@persuavis.com']
 
-  spec.summary = 'bp3-formtastic adapts formtastic for BP3 (persuavis/black_phoebe_3)..'
+  spec.summary = 'bp3-formtastic adapts formtastic for BP3 (persuavis/black_phoebe_3).'
   # spec.description = "TODO: Write a longer description or delete this line."
   spec.homepage = 'https://www.black-phoebe.com'
   spec.license = 'MIT'
@@ -32,8 +32,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'actionpack', ['>= 7.1.2', '< 8']
+  spec.add_dependency 'actionview', ['>= 7.1.2', '< 8']
   spec.add_dependency 'activesupport', ['>= 7.1.2', '< 8']
   spec.add_dependency 'formtastic', '~> 5.0'
+  spec.add_dependency 'railties', ['>= 7.1.2', '< 8']
 
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 13.0'

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
+                    builder.id&.gsub(/_#{UUID_REGEX}/, '')
+                    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.1'
+    VERSION = '0.2.0'
   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

@@ -3,6 +3,8 @@
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/inflector'
 
+require_relative 'formtastic/viz_form_builder'
+require_relative 'formtastic/viz_form_builder_with_create'
 require_relative 'formtastic/railtie'
 require_relative 'formtastic/version'
 
@@ -11,7 +13,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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Wim den Braven
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +84,26 @@ dependencies:
     - - "~>"
       - !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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +209,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:
@@ -197,5 +239,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: bp3-formtastic adapts formtastic for BP3 (persuavis/black_phoebe_3)..
+summary: bp3-formtastic adapts formtastic for BP3 (persuavis/black_phoebe_3).
 test_files: []