phlexible 2.2.0 → 3.1.0

data/lib/phlexible/rails/button_to.rb

@@ -15,119 +15,6 @@
 # - :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', params: {} }.freeze
-
-      def initialize(url, options = nil)
-        @url = url
-        @options = options
-      end
-
-      def view_template(&block) # rubocop:disable Metrics/AbcSize
-        action = helpers.url_for(@url)
-        @options = DEFAULT_OPTIONS.merge((@options || {}).symbolize_keys)
-
-        method = (@options.delete(:method).presence || method_for_options(@options)).to_s
-        form_method = method == 'get' ? 'get' : 'post'
-
-        form action: action, method: form_method, **form_attributes 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
-      end
-
-      private
-
-      def form_attributes
-        {
-          class: @options.delete(:form_class), # @deprecated
-          **(@options.delete(:form_attributes) || {})
-        }
-      end
-
-      def button_attrs
-        {
-          type: 'submit',
-          **@options
-        }
-      end
-
-      def method_for_options(options)
-        if options.is_a?(Array)
-          method_for_options(options.last)
-        elsif options.respond_to?(:persisted?)
-          options.persisted? ? :patch : :post
-        elsif options.respond_to?(:to_model)
-          method_for_options(options.to_model)
-        end
-      end
-
-      def token_input(action, method)
-        return unless helpers.protect_against_forgery?
-
-        name = helpers.request_forgery_protection_token.to_s
-        value = helpers.form_authenticity_token(form_options: { action: action, method: method })
-
-        input type: 'hidden', name: name, value: value, autocomplete: 'off'
-      end
-
-      def method_tag(method)
-        return unless BUTTON_TAG_METHOD_VERBS.include?(method)
-
-        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
       include ButtonToConcerns
     end

data/lib/phlexible/rails/button_to_concerns.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Generates a form containing a single button that submits to the URL created by the set of options.
+# Similar to Rails `button_to` helper.
+#
+# 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.
+#   Default is :post.
+# - :form_attributes - Hash of HTML attributes to be rendered on the form tag.
+# - :form_class - This controls the class of the form within which the submit button will be placed.
+#   Default is 'button_to'. @deprecated: use :form_attributes instead if you want to override this.
+# - :params - Hash of parameters to be rendered as hidden fields within the form.
+module Phlexible
+  module Rails
+    module ButtonToConcerns
+      extend ActiveSupport::Concern
+
+      included do
+        include Phlex::Rails::Helpers::URLFor
+
+        register_value_helper :protect_against_forgery?
+        register_value_helper :request_forgery_protection_token
+        register_value_helper :form_authenticity_token
+      end
+
+      BUTTON_TAG_METHOD_VERBS = %w[patch put delete].freeze
+      DEFAULT_OPTIONS = { method: 'post', form_class: 'button_to', params: {} }.freeze
+
+      def initialize(url, options = nil)
+        @url = url
+        @options = options
+      end
+
+      def view_template(&block)
+        action = url_for(@url)
+        @options = DEFAULT_OPTIONS.merge((@options || {}).symbolize_keys)
+
+        method = (@options.delete(:method).presence || method_for_options(@options)).to_s
+        form_method = method == 'get' ? 'get' : 'post'
+
+        form action: action, method: form_method, **form_attributes 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
+      end
+
+      private
+
+        def form_attributes
+          {
+            class: @options.delete(:form_class), # @deprecated
+            **(@options.delete(:form_attributes) || {})
+          }
+        end
+
+        def button_attrs
+          {
+            type: 'submit',
+            **@options
+          }
+        end
+
+        def method_for_options(options)
+          if options.is_a?(Array)
+            method_for_options(options.last)
+          elsif options.respond_to?(:persisted?)
+            options.persisted? ? :patch : :post
+          elsif options.respond_to?(:to_model)
+            method_for_options(options.to_model)
+          end
+        end
+
+        def token_input(action, method)
+          return if !protect_against_forgery?
+
+          name = request_forgery_protection_token.to_s
+          value = form_authenticity_token(form_options: { action: action, method: method })
+
+          input type: 'hidden', name: name, value: value, autocomplete: 'off'
+        end
+
+        def method_tag(method)
+          return if BUTTON_TAG_METHOD_VERBS.exclude?(method)
+
+          input type: 'hidden', name: '_method', value: method.to_s, autocomplete: 'off'
+        end
+
+        def param_inputs
+          return if !(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
+  end
+end

data/lib/phlexible/rails/controller_variables.rb

@@ -23,6 +23,8 @@
 module Phlexible
   module Rails
     module ControllerVariables
+      include ViewAssigns
+
       def self.included(klass)
         klass.class_attribute :__controller_variables__, instance_predicate: false, default: Set.new
         klass.extend ClassMethods
@@ -40,67 +42,71 @@ module Phlexible
 
       private
 
-      def define_controller_variables # rubocop:disable Metrics
-        return unless respond_to?(:__controller_variables__)
-
-        view_assigns = helpers.controller.view_assigns
-        view = @view
+        def define_controller_variables
+          return if !respond_to?(:__controller_variables__)
 
-        vars = (view&.__controller_variables__ || Set.new) + __controller_variables__
-        vars.each do |k, v|
-          allow_undefined = true
-          if k.ends_with?('!')
-            allow_undefined = false
-            k = k.chop
-          end
+          view_assigns = view_assigns()
+          view = @view
 
-          raise ControllerVariables::UndefinedVariable, k if !allow_undefined && !view_assigns.key?(k)
+          vars = (view&.__controller_variables__ || Set.new) + __controller_variables__
+          vars.each do |k, v|
+            allow_undefined = true
+            if k.ends_with?('!')
+              allow_undefined = false
+              k = k.chop
+            end
 
-          instance_variable_set(:"@#{v}", view_assigns[k])
-          view&.instance_variable_set(:"@#{v}", view_assigns[k])
-        end
-      end
+            if !allow_undefined && !view_assigns.key?(k)
+              raise ControllerVariables::UndefinedVariable,
+                    k
+            end
 
-      module ClassMethods
-        def controller_variable(*names, **kwargs) # rubocop:disable Metrics/*
-          if names.empty? && kwargs.empty?
-            raise ArgumentError, 'You must provide at least one variable name and/or a hash of ' \
-                                 'variable names and options.'
+            instance_variable_set(:"@#{v}", view_assigns[k])
+            view&.instance_variable_set(:"@#{v}", view_assigns[k])
           end
+        end
 
-          allow_undefined = kwargs.delete(:allow_undefined)
-          as = kwargs.delete(:as)
+        module ClassMethods
+          # /*
+          def controller_variable(*names, **kwargs)
+            if names.empty? && kwargs.empty?
+              raise ArgumentError, 'You must provide at least one variable name and/or a hash of ' \
+                                   'variable names and options.'
+            end
 
-          if names.count > 1 && as
-            raise ArgumentError, 'You cannot provide the `as:` option when passing multiple ' \
-                                 'variable names.'
-          end
+            allow_undefined = kwargs.delete(:allow_undefined)
+            as = kwargs.delete(:as)
 
-          names.each do |name|
-            name_as = as || name
-            name = "#{name}!" unless allow_undefined
+            if names.many? && as
+              raise ArgumentError, 'You cannot provide the `as:` option when passing multiple ' \
+                                   'variable names.'
+            end
 
-            self.__controller_variables__ += { name.to_s => name_as.to_s }
-          end
+            names.each do |name|
+              name_as = as || name
+              name = "#{name}!" if !allow_undefined
 
-          kwargs.each do |k, v|
-            if v.is_a?(Hash)
-              name = v.key?(:as) ? v[:as].to_s : k.to_s
+              self.__controller_variables__ += { name.to_s => name_as.to_s }
+            end
 
-              if v.key?(:allow_undefined)
-                k = "#{k}!" unless v[:allow_undefined]
-              elsif !allow_undefined
-                k = "#{k}!"
+            kwargs.each do |k, v|
+              if v.is_a?(Hash)
+                name = v.key?(:as) ? v[:as].to_s : k.to_s
+
+                if v.key?(:allow_undefined)
+                  k = "#{k}!" if !v[:allow_undefined]
+                elsif !allow_undefined
+                  k = "#{k}!"
+                end
+              else
+                name = v.to_s
+                k = "#{k}!" if !allow_undefined
               end
-            else
-              name = v.to_s
-              k = "#{k}!" unless allow_undefined
-            end
 
-            self.__controller_variables__ += { k.to_s => name }
+              self.__controller_variables__ += { k.to_s => name }
+            end
           end
         end
-      end
     end
   end
 end

data/lib/phlexible/rails/meta_tags_component.rb

@@ -3,8 +3,10 @@
 module Phlexible
   module Rails
     class MetaTagsComponent < Phlex::HTML
+      include ViewAssigns
+
       def view_template
-        helpers.controller.view_assigns['meta_tags']&.each do |name, content|
+        view_assigns['meta_tags']&.each do |name, content|
           meta name: name, content: content.is_a?(String) ? content : content.to_json
         end
       end

data/lib/phlexible/rails/view_assigns.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Phlexible
+  module Rails
+    module ViewAssigns
+      def view_assigns
+        if respond_to?(:view_context)
+          # Phlex 2
+          view_context.controller.view_assigns
+        else
+          # Phlex 1
+          helpers.controller.view_assigns
+        end
+      end
+    end
+  end
+end

data/lib/phlexible/version.rb

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

data/lib/phlexible.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require_relative 'phlexible/version'
-require 'phlex'
+require 'zeitwerk'
+require 'rails'
+require 'phlex-rails'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 module Phlexible
-  autoload :AliasView, 'phlexible/alias_view'
-  autoload :PageTitle, 'phlexible/page_title'
-  autoload :Callbacks, 'phlexible/callbacks'
-  autoload :Rails, 'phlexible/rails'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: phlexible
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Joel Moss
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-02-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -18,7 +18,7 @@ dependencies:
         version: 1.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,27 +28,61 @@ dependencies:
         version: 1.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: phlex-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
 description: A bunch of helpers and goodies intended to make life with Phlex even
   easier!
 email:
@@ -58,39 +92,36 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
+- Appraisals
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- config/sus.rb
-- config/view_helper.rb
-- fixtures/dummy/app/controllers/articles_controller.rb
-- fixtures/dummy/app/views/articles/index.html.erb
-- fixtures/dummy/app/views/articles/link.rb
-- fixtures/dummy/app/views/articles/show.rb
-- fixtures/dummy/config/database.yml
-- fixtures/dummy/config/routes.rb
-- fixtures/dummy/config/storage.yml
-- fixtures/dummy/db/schema.rb
-- fixtures/dummy/log/.gitignore
-- fixtures/dummy/public/favicon.ico
-- fixtures/rails_helper.rb
+- gemfiles/.bundle/config
+- gemfiles/phlex1_rails7.gemfile
+- gemfiles/phlex1_rails7.gemfile.lock
+- gemfiles/phlex1_rails8.gemfile
+- gemfiles/phlex1_rails8.gemfile.lock
+- gemfiles/phlex2_rails7.gemfile
+- gemfiles/phlex2_rails7.gemfile.lock
+- gemfiles/phlex2_rails8.gemfile
+- gemfiles/phlex2_rails8.gemfile.lock
 - lib/phlexible.rb
 - lib/phlexible/alias_view.rb
 - lib/phlexible/callbacks.rb
 - lib/phlexible/page_title.rb
-- lib/phlexible/rails.rb
+- lib/phlexible/process_attributes.rb
 - lib/phlexible/rails/a_element.rb
 - lib/phlexible/rails/action_controller/implicit_render.rb
 - lib/phlexible/rails/action_controller/meta_tags.rb
 - lib/phlexible/rails/button_to.rb
+- lib/phlexible/rails/button_to_concerns.rb
 - lib/phlexible/rails/controller_variables.rb
 - lib/phlexible/rails/meta_tags_component.rb
 - lib/phlexible/rails/responder.rb
+- lib/phlexible/rails/view_assigns.rb
 - lib/phlexible/version.rb
-- phlexible.gemspec
 homepage: https://github.com/joelmoss/phlexible
 licenses:
 - MIT
@@ -113,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A bunch of helpers and goodies intended to make life with Phlex even easier!
 test_files: []

data/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in phlexible.gemspec
-gemspec
-
-gem 'combustion'
-gem 'debug'
-gem 'phlex-testing-nokogiri'
-gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.55'
-gem 'sus'