phlexible 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e792518495712903ee8eb0ea65f89dce5d56918a0ffc966ebfc11339093ee5ab
-  data.tar.gz: 5d260ec103129ec9c9b945e0f862830200d777b72bc3602866c04beb468f1945
+  metadata.gz: d396818a6eb976923deb622cc3a991b1d9720a1ae9866d98580634e0ac068072
+  data.tar.gz: 9c869afbe9da2ff0d7229b7101204e4b27b266c03679061468629cb663604e55
 SHA512:
-  metadata.gz: 9e6bf020811e5e42b513c42420d437c8aa59676398bd08a8ac57c5e7c5239a1287f36e4ab5b2fb7f81226d6350ed937d0008a15da1b659efbf00f5bdf3e2e5b9
-  data.tar.gz: c12372151829b8b5effbd308c4258731fd83d7c59edf3bdb6c3ec48cc9e2ac9c7862b20c8de1b2f3e3ebaf16a8f69e5dfd120bd22ba7a4b2f68ab4ebb562ebd7
+  metadata.gz: 86ef75286d70e4fc05cfcfa67f5bab635240f843e56415cf855344c75ce7ab0ee6e0bc5768b2c573f0294aa2a35b31fab1121a60a36718e88e5cb049222d54de
+  data.tar.gz: ae2b2b5805b40f559f3159b05e86607054e201f27c6db71fc4734c3a37597b9fd8354d68071abd4cd0d98fe1fb3d8d9f3adc5d78931eb78c89081be39965de86

data/.rubocop.yml

@@ -3,16 +3,20 @@ AllCops:
   SuggestExtensions: false
   NewCops: enable
 
-Style/Documentation:
-  Enabled: false
-Metrics/BlockLength:
-  Exclude:
-    - test/**/*
 Lint/ConstantDefinitionInBlock:
   Exclude:
     - test/**/*
+
+Style/Documentation:
+  Enabled: false
 Style/ClassAndModuleChildren:
   Exclude:
     - fixtures/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 8

data/Gemfile

@@ -8,5 +8,5 @@ gemspec
 gem 'combustion'
 gem 'phlex-testing-nokogiri'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.21'
-gem 'sus', '~> 0.20.0'
+gem 'rubocop', '~> 1.55'
+gem 'sus'

data/Gemfile.lock

@@ -1,79 +1,80 @@
 PATH
   remote: .
   specs:
-    phlexible (0.4.1)
+    phlexible (0.5.0)
       phlex (~> 1.8.1)
       phlex-rails (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actioncable (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activestorage (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actionmailbox (7.0.8)
+      actionpack (= 7.0.8)
+      activejob (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      actionview (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actionmailer (7.0.8)
+      actionpack (= 7.0.8)
+      actionview (= 7.0.8)
+      activejob (= 7.0.8)
+      activesupport (= 7.0.8)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.3)
-      actionview (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activestorage (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actiontext (7.0.8)
+      actionpack (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.3)
-      activesupport (= 7.0.4.3)
+    activejob (7.0.8)
+      activesupport (= 7.0.8)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activestorage (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activestorage (7.0.8)
+      actionpack (= 7.0.8)
+      activejob (= 7.0.8)
+      activerecord (= 7.0.8)
+      activesupport (= 7.0.8)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.3)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.1.1)
     builder (3.2.4)
     cgi (0.3.6)
     combustion (1.3.7)
@@ -83,17 +84,18 @@ GEM
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     date (3.3.3)
-    erb (4.0.2)
+    erb (4.0.3)
       cgi (>= 0.3.3)
     erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.20.0)
+    language_server-protocol (3.17.0.3)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -101,9 +103,9 @@ GEM
       net-smtp
     marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.18.0)
-    net-imap (0.3.4)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    net-imap (0.3.7)
       date
       net-protocol
     net-pop (0.1.2)
@@ -113,15 +115,16 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.14.3-arm64-darwin)
+    nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.3-x86_64-darwin)
+    nokogiri (1.15.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.3-x86_64-linux)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     phlex (1.8.1)
       concurrent-ruby (~> 1.2)
       erb (>= 4)
@@ -133,63 +136,67 @@ GEM
     phlex-testing-nokogiri (0.1.0)
       nokogiri (~> 1.13)
       phlex (>= 0.5)
-    racc (1.6.2)
-    rack (2.2.6.4)
+    racc (1.7.1)
+    rack (2.2.8)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.3)
-      actioncable (= 7.0.4.3)
-      actionmailbox (= 7.0.4.3)
-      actionmailer (= 7.0.4.3)
-      actionpack (= 7.0.4.3)
-      actiontext (= 7.0.4.3)
-      actionview (= 7.0.4.3)
-      activejob (= 7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activerecord (= 7.0.4.3)
-      activestorage (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    rails (7.0.8)
+      actioncable (= 7.0.8)
+      actionmailbox (= 7.0.8)
+      actionmailer (= 7.0.8)
+      actionpack (= 7.0.8)
+      actiontext (= 7.0.8)
+      actionview (= 7.0.8)
+      activejob (= 7.0.8)
+      activemodel (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.0.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rubocop (1.50.2)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    sus (0.20.3)
-    thor (1.2.1)
-    timeout (0.3.2)
+    sus (0.23.0)
+    thor (1.2.2)
+    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   arm64-darwin-22
@@ -201,8 +208,8 @@ DEPENDENCIES
   phlex-testing-nokogiri
   phlexible!
   rake (~> 13.0)
-  rubocop (~> 1.21)
-  sus (~> 0.20.0)
+  rubocop (~> 1.55)
+  sus
 
 BUNDLED WITH
    2.4.1

data/README.md

@@ -38,8 +38,7 @@ end
 
 #### `ControllerAttributes`
 
-Include this module in your Phlex views to get access to the controller's instance variables. It
-provides an explicit interface for accessing controller instance variables from the view.
+Include this module in your Phlex views to get access to the controller's instance variables. It provides an explicit interface for accessing controller instance variables from the view.
 
 ```ruby
 class Views::Users::Index < Views::Base
@@ -64,9 +63,7 @@ controller_attribute :users, attr_reader: true, alias: :my_users
 
 #### `Responder`
 
-If you use [Responders](https://github.com/heartcombo/responders), Phlexible provides a responder to
-support implicit rendering similar to `ActionController::ImplicitRender` above. It will render the
-Phlex view using `respond_with` if one exists, and fall back to default rendering.
+If you use [Responders](https://github.com/heartcombo/responders), Phlexible provides a responder to support implicit rendering similar to `ActionController::ImplicitRender` above. It will render the Phlex view using `respond_with` if one exists, and fall back to default rendering.
 
 Just include it in your ApplicationResponder:
 
@@ -91,20 +88,15 @@ class UsersController < ApplicationController
 end
 ```
 
-This responder requires the use of `ActionController::ImplicitRender`, so don't forget to include
-that in your `ApplicationController`.
+This responder requires the use of `ActionController::ImplicitRender`, so don't forget to include that in your `ApplicationController`.
 
-If you use `ControllerAttributes` in your view, and define a `resource` attribute, the responder
-will pass that to your view.
+If you use `ControllerAttributes` in your view, and define a `resource` attribute, the responder will pass that to your view.
 
 #### `AElement`
 
-No need to call Rails `link_to` helper, when you can simply render an anchor tag directly with
-Phlex. But unfortunately that means you lose some of the magic that `link_to` provides. Especially
-the automatic resolution of URL's and Rails routes.
+No need to call Rails `link_to` helper, when you can simply render an anchor tag directly with Phlex. But unfortunately that means you lose some of the magic that `link_to` provides. Especially the automatic resolution of URL's and Rails routes.
 
-The `Phlexible::Rails::AElement` module passes through the `href` attribute to Rails `url_for`
-helper. So you can do this:
+The `Phlexible::Rails::AElement` module passes through the `href` attribute to Rails `url_for` helper. So you can do this:
 
 ```ruby
 Rails.application.routes.draw do
@@ -126,8 +118,7 @@ end
 
 Generates a form containing a single button that submits to the URL created by the set of options.
 
-It is similar to Rails `button_to` helper, which accepts the URL or route helper as the first
-argument, and the value/content of the button as the block.
+It is similar to Rails `button_to` helper, which accepts the URL or route helper as the first argument, and the value/content of the button as the block.
 
 ```ruby
 Phlexible::Rails::ButtonTo.new(:root) { 'My Button' }
@@ -135,8 +126,7 @@ Phlexible::Rails::ButtonTo.new(:root) { 'My Button' }
 
 The url argument accepts the same options as Rails `url_for`.
 
-The form submits a POST request by default. You can specify a different HTTP verb via the :method
-option.
+The form submits a POST request by default. You can specify a different HTTP verb via the :method option.
 
 ```ruby
 Phlexible::Rails::ButtonTo.new(:root, method: :patch) { 'My Button' }
@@ -144,11 +134,11 @@ Phlexible::Rails::ButtonTo.new(:root, method: :patch) { 'My Button' }
 
 ##### Options
 
-- `:class` - Specify the HTML class name of the button (not the form).
+- `:class`      - Specify the HTML class name of the button (not the form).
 - `:form_class` - Specify the HTML class name of the form (default: 'button_to').
-- `:data` - This option can be used to add custom data attributes.
-- `:method` - Symbol of the HTTP verb. Supported verbs are :post (default), :get, :delete, :patch,
-              and :put.
+- `:data`       - This option can be used to add custom data attributes.
+- `:params`     - Hash of parameters to be rendered as hidden fields within the form.
+- `:method`     - Symbol of the HTTP verb. Supported verbs are :post (default), :get, :delete, :patch, and :put.
 
 ### `AliasView`
 
@@ -184,9 +174,7 @@ end
 
 ### PageTitle
 
-Helper to assist in defining page titles within Phlex views. Also includes support for nested views,
-where each desendent view class will have its title prepended to the page title. Simply assign the
-title to the `page_title` class variable:
+Helper to assist in defining page titles within Phlex views. Also includes support for nested views, where each desendent view class will have its title prepended to the page title. Simply assign the title to the `page_title` class variable:
 
 ```ruby
 class MyView
@@ -204,7 +192,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/phlexible. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/phlexible/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/joelmoss/phlexible>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/phlexible/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/config/sus.rb

@@ -5,4 +5,4 @@ require 'bundler'
 
 Bundler.require :test
 
-require_relative './view_helper'
+require_relative 'view_helper'

data/lib/phlexible/rails/action_controller/implicit_render.rb

@@ -6,7 +6,7 @@
 #     def index
 #       render Views::Users::Index.new
 #     end
-
+#
 #     def show
 #       render Views::Users::Show.new(user)
 #     end
@@ -30,6 +30,8 @@ module Phlexible
           pview.tap do |view|
             if view.respond_to?(:__controller_attributes__)
               view.__controller_attributes__.each do |attr|
+                raise ControllerAttributes::UndefinedVariable, attr unless view_assigns.key?(attr.to_s)
+
                 view.instance_variable_set :"@#{attr}", view_assigns[attr.to_s]
               end
             end

data/lib/phlexible/rails/button_to.rb

@@ -5,11 +5,18 @@
 #
 # The form submits a POST request by default. You can specify a different HTTP verb via the :method
 # option.
+#
+# Additional arguments are passed through to the button element, with a few exceptions:
+#  - :method - Symbol of HTTP verb. Supported verbs are :post, :get, :delete, :patch, and :put. By
+#    default it will be :post.
+#  - :form_class - This controls the class of the form within which the submit button will be
+#    placed. By default it will be 'button_to'.
+#  - :params - Hash of parameters to be rendered as hidden fields within the form.
 module Phlexible
   module Rails
     module ButtonToConcerns
       BUTTON_TAG_METHOD_VERBS = %w[patch put delete].freeze
-      DEFAULT_OPTIONS = { method: 'post', form_class: 'button_to' }.freeze
+      DEFAULT_OPTIONS = { method: 'post', form_class: 'button_to', params: {} }.freeze
 
       def initialize(url, options = nil)
         @url = url
@@ -27,6 +34,7 @@ module Phlexible
         form action: action, class: @options.delete(:form_class), method: form_method do
           method_tag method
           form_method == 'post' && token_input(action, method.empty? ? 'post' : method)
+          param_inputs
 
           block_given? ? button(**button_attrs, &block) : button(**button_attrs) { @name }
         end
@@ -66,6 +74,52 @@ module Phlexible
 
         input type: 'hidden', name: '_method', value: method.to_s, autocomplete: 'off'
       end
+
+      def param_inputs
+        return unless (params = @options.delete(:params))
+
+        to_form_params(params).each do |param|
+          input type: 'hidden', name: param[:name], value: param[:value], autocomplete: 'off'
+        end
+      end
+
+      # Returns an array of hashes each containing :name and :value keys
+      # suitable for use as the names and values of form input fields:
+      #
+      #   to_form_params(name: 'David', nationality: 'Danish')
+      #   # => [{name: 'name', value: 'David'}, {name: 'nationality', value: 'Danish'}]
+      #
+      #   to_form_params(country: { name: 'Denmark' })
+      #   # => [{name: 'country[name]', value: 'Denmark'}]
+      #
+      #   to_form_params(countries: ['Denmark', 'Sweden']})
+      #   # => [{name: 'countries[]', value: 'Denmark'}, {name: 'countries[]', value: 'Sweden'}]
+      #
+      # An optional namespace can be passed to enclose key names:
+      #
+      #   to_form_params({ name: 'Denmark' }, 'country')
+      #   # => [{name: 'country[name]', value: 'Denmark'}]
+      def to_form_params(attribute, namespace = nil)
+        attribute = attribute.to_h if attribute.respond_to?(:permitted?)
+
+        params = []
+        case attribute
+        when Hash
+          attribute.each do |key, value|
+            prefix = namespace ? "#{namespace}[#{key}]" : key
+            params.push(*to_form_params(value, prefix))
+          end
+        when Array
+          array_prefix = "#{namespace}[]"
+          attribute.each do |value|
+            params.push(*to_form_params(value, array_prefix))
+          end
+        else
+          params << { name: namespace.to_s, value: attribute.to_param }
+        end
+
+        params.sort_by { |pair| pair[:name] }
+      end
     end
 
     class ButtonTo < Phlex::HTML

data/lib/phlexible/rails/controller_attributes.rb

@@ -18,11 +18,21 @@
 #   - `attr_reader:` - If set to `true`, an `attr_reader` will be defined for the given attributes.
 #   - `alias:` - If set, the given attribute will be aliased to the given alias value.
 #
+# NOTE: Phlexible::Rails::ActionController::ImplicitRender is required for this to work.
+#
 module Phlexible
   module Rails
     module ControllerAttributes
       extend ActiveSupport::Concern
 
+      class UndefinedVariable < NameError
+        def initialize(name)
+          @variable_name = name
+          super "Attempted to expose controller attribute `#{@variable_name}`, but instance " \
+                'variable is not defined in the controller.'
+        end
+      end
+
       included do
         class_attribute :__controller_attributes__, instance_predicate: false, default: Set.new
       end

data/lib/phlexible/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phlexible
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexible
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: A bunch of helpers and goodies intended to make life with Phlex even easier!