phlexible 2.1.0 → 3.0.0

data/lib/phlexible/rails/button_to_concerns.rb

@@ -0,0 +1,140 @@
+# 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 unless 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 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
+  end
+end

data/lib/phlexible/rails/controller_variables.rb

@@ -23,9 +23,13 @@
 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
+        klass.include Callbacks
+        klass.before_template :define_controller_variables
       end
 
       class UndefinedVariable < NameError
@@ -36,31 +40,32 @@ module Phlexible
         end
       end
 
-      def before_template # rubocop:disable Metrics
-        if respond_to?(:__controller_variables__)
-          view_assigns = helpers.controller.view_assigns
-          view = @view
-
-          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
+      private
+
+      def define_controller_variables
+        return unless respond_to?(:__controller_variables__)
 
-            raise ControllerVariables::UndefinedVariable, k if !allow_undefined && !view_assigns.key?(k)
+        view_assigns = view_assigns()
+        view = @view
 
-            instance_variable_set(:"@#{v}", view_assigns[k])
-            view&.instance_variable_set(:"@#{v}", view_assigns[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
-        end
 
-        super
+          raise ControllerVariables::UndefinedVariable, k if !allow_undefined && !view_assigns.key?(k)
+
+          instance_variable_set(:"@#{v}", view_assigns[k])
+          view&.instance_variable_set(:"@#{v}", view_assigns[k])
+        end
       end
 
       module ClassMethods
-        def controller_variable(*names, **kwargs) # rubocop:disable Metrics/*
+        # /*
+        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.'

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.1.0'
+  VERSION = '3.0.0'
 end

data/lib/phlexible.rb

@@ -1,10 +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 :Rails, 'phlexible/rails'
 end

data/phlexible.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'phlex', '>= 1.10.0', '< 2.0.0'
-  spec.add_dependency 'phlex-rails', '>= 1.2.1', '< 2.0.0'
+  spec.add_dependency 'phlex', '>= 1.10.0', '< 3.0.0'
+  spec.add_dependency 'phlex-rails', '>= 1.2.0', '< 3.0.0'
+  spec.add_dependency 'rails', '>= 7.2.0', '< 9.0.0'
+  spec.add_dependency 'zeitwerk', '~> 2.7.2'
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexible
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Joel Moss
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -18,7 +19,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 +29,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,14 +93,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/render_helper.rb
 - 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
@@ -77,17 +114,24 @@ files:
 - fixtures/dummy/log/.gitignore
 - fixtures/dummy/public/favicon.ico
 - fixtures/rails_helper.rb
+- gemfiles/.bundle/config
+- gemfiles/phlex_1.gemfile
+- gemfiles/phlex_1.gemfile.lock
+- gemfiles/phlex_2.gemfile
+- gemfiles/phlex_2.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/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
@@ -98,6 +142,7 @@ metadata:
   source_code_uri: https://github.com/joelmoss/phlexible
   changelog_uri: https://github.com/joelmoss/phlexible/releases
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,7 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A bunch of helpers and goodies intended to make life with Phlex even easier!
 test_files: []

data/config/view_helper.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module ViewHelper
-  def self.extended(parent)
-    parent.class_exec do
-      let(:output) { example.call }
-      let(:example) { view.new }
-    end
-  end
-
-  def view(&block)
-    let :view do
-      Class.new(Phlex::HTML, &block)
-    end
-  end
-end

data/lib/phlexible/rails.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'phlex-rails'
-
-module Phlexible
-  module Rails
-    autoload :ControllerVariables, 'phlexible/rails/controller_variables'
-    autoload :Responder, 'phlexible/rails/responder'
-    autoload :AElement, 'phlexible/rails/a_element'
-
-    autoload :MetaTagsComponent, 'phlexible/rails/meta_tags_component'
-    autoload :ButtonTo, 'phlexible/rails/button_to'
-    autoload :ButtonToConcerns, 'phlexible/rails/button_to'
-
-    module ActionController
-      autoload :ImplicitRender, 'phlexible/rails/action_controller/implicit_render'
-      autoload :MetaTags, 'phlexible/rails/action_controller/meta_tags'
-    end
-  end
-end