phlexible 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6d20a51dd488d65ba2a2ca84ffd702e5cff5505dce12595cdd1d2ca3f0c8b6
-  data.tar.gz: 12bdc3b31f359f5e974ba21d7cb154145c3e0444604c6a20cf706d94eb6a07f8
+  metadata.gz: 4f5bc2167c1561048483003a2409f70153abcb79a94107c3fec5408ccfe33436
+  data.tar.gz: 8e59526996b1734e16933da161d42f930febc4f0f960852c2fec6a3a531293da
 SHA512:
-  metadata.gz: '09db42fc189ffefa64ca54bdedf9e171d0bf9d3084b4bc89a1c18953141f4fbad978e1a10b0d9d81a522df5ddf633ddca6f34aff214f2e69542f5ca197f232fa'
-  data.tar.gz: 0bb3d5026764d1366fe31f1b57f05e8c0ec8eeb24947c73c85448ecb4e9f7f9fcf6a0fd425e3150548e34525405c483a86c0725df8f03690d5df0fff225f1768
+  metadata.gz: 7f6344c05d305195c98828c7709d229b45616fb31e2bb73403990f8d402aa3184b54c83cb04924e21373923aeaf00a92fd152ed9f780b84a6ba3f5451472f8a4
+  data.tar.gz: 2c2e2367325c27ab5055543a2b0e88d573bf186ae1a31ec3c94d2f73515a1db27e93f8b86687e09e968f186a734f392862c0548a295a1a29e56f67be04c3b2b1

data/Gemfile.lock

@@ -1,74 +1,74 @@
 PATH
   remote: .
   specs:
-    phlexible (0.2.0)
-      phlex (~> 1.5.1)
-      phlex-rails (~> 0.8.0)
+    phlexible (0.4.0)
+      phlex (~> 1.8.1)
+      phlex-rails (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    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)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    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)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    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)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activestorage (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    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)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -91,7 +91,7 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.19.1)
+    loofah (2.20.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.8.1)
@@ -112,72 +112,72 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.2-arm64-darwin)
+    nio4r (2.5.9)
+    nokogiri (1.14.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-darwin)
+    nokogiri (1.14.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-linux)
+    nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
-    phlex (1.5.1)
+    phlex (1.8.1)
       concurrent-ruby (~> 1.2)
       erb (>= 4)
       zeitwerk (~> 2.6)
-    phlex-rails (0.8.0)
-      phlex (~> 1.5)
+    phlex-rails (1.0.0)
+      phlex (~> 1.7)
       rails (>= 6.1, < 8)
       zeitwerk (~> 2.6)
     phlex-testing-nokogiri (0.1.0)
       nokogiri (~> 1.13)
       phlex (>= 0.5)
     racc (1.6.2)
-    rack (2.2.6.3)
-    rack-test (2.0.2)
+    rack (2.2.6.4)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.2)
-      actioncable (= 7.0.4.2)
-      actionmailbox (= 7.0.4.2)
-      actionmailer (= 7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actiontext (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    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)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
+      railties (= 7.0.4.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rubocop (1.48.0)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     sus (0.20.3)

data/README.md

@@ -36,6 +36,32 @@ class UsersController
 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.
+
+```ruby
+class Views::Users::Index < Views::Base
+  include Phlexible::Rails::ControllerAttributes
+
+  controller_attribute :first_name, :last_name
+
+  def template
+    h1 { "#{@first_name} #{@last_name}" }
+  end
+end
+```
+
+##### Options
+
+- `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.
+
+```ruby
+controller_attribute :users, attr_reader: true, alias: :my_users
+```
+
 #### `Responder`
 
 If you use [Responders](https://github.com/heartcombo/responders), Phlexible provides a responder to
@@ -65,24 +91,12 @@ class UsersController < ApplicationController
 end
 ```
 
-As Phlex views expect explicit arguments, you can pass these in the `:view_options` keyword
-argument:
-
-```ruby
-class UsersController < ApplicationController
-  def index
-    respond_with User.all, view_options: { page: 1 }
-  end
-end
-
-class Views::Users::Index < Phlex::HTML
-  def initialize(users, page:); end
-end
-```
-
-This responder requires the use of `ActionController::ImplicitRender`, so dont't forget to include
+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.
+
 #### `AElement`
 
 No need to call Rails `link_to` helper, when you can simply render an anchor tag directly with
@@ -112,17 +126,11 @@ 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 value/content of the button as the
-first argument, and a URL or route helper as the second argument.
-
-```ruby
-Phlexible::Rails::ButtonTo.new 'My Button', :root
-```
-
-Alternatively you can pass a block; the result of which will be used as the value of the button.
+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) { 'Go Home 👉' }
+Phlexible::Rails::ButtonTo.new(:root) { 'My Button' }
 ```
 
 The url argument accepts the same options as Rails `url_for`.
@@ -131,7 +139,7 @@ The form submits a POST request by default. You can specify a different HTTP ver
 option.
 
 ```ruby
-Phlexible::Rails::ButtonTo.new 'My Button', :root, method: :patch
+Phlexible::Rails::ButtonTo.new(:root, method: :patch) { 'My Button' }
 ```
 
 ##### Options

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

@@ -11,48 +11,44 @@
 # You can do this:
 #
 #   class UsersController
+#     include Phlexible::Rails::ActionController::ImplicitRender
 #   end
 #
 module Phlexible
   module Rails
     module ActionController
       module ImplicitRender
-        NUFFIN = 'NUFFIN'
-
         def default_render
-          render_view_class || super
+          render_plex_view({ action: action_name }) || super
         end
 
-        # Renders the Phlex view.
-        def render_view_class(view_options = NUFFIN, render_options = {})
-          klass = render_options&.key?(:action) ? phlex_view(render_options[:action]) : phlex_view
-          return unless klass
-
-          if view_options == NUFFIN
-            view_options = render_options.delete(:view_options) { {} }
-            render klass.new(**view_options), render_options
-          else
-            kwargs = {}
-            kwargs = render_options.delete(:view_options) if render_options.key?(:view_options)
-
-            render klass.new(view_options, **kwargs), render_options
+        def assign_phlex_accessors(pview)
+          pview.tap do |view|
+            if view.respond_to?(:__controller_attributes__)
+              view.__controller_attributes__.each do |attr|
+                view.instance_variable_set :"@#{attr}", view_assigns[attr.to_s]
+              end
+            end
           end
         end
 
-        private
-
         def method_for_action(action_name)
-          if action_method?(action_name)
-            action_name
-          elsif phlex_view
-            '_handle_view_class'
-          elsif respond_to?(:action_missing, true)
-            '_handle_action_missing'
-          end
+          super || ('default_phlex_render' if phlex_view(action_name))
         end
 
-        def _handle_view_class(*_args)
-          render_view_class
+        def default_phlex_render
+          render assign_phlex_accessors(phlex_view(action_name).new)
+        end
+
+        # @param options [Hash] At a minimum this may contain an `:action` key, which will be used
+        #   as the name of the view to render. If no `:action` key is provided, the current
+        #   `action_name` is used.
+        def render_plex_view(options)
+          options[:action] ||= action_name
+
+          return unless (view = phlex_view(options[:action]))
+
+          render assign_phlex_accessors(view.new)
         end
 
         def phlex_view(action_name = @_action_name)

data/lib/phlexible/rails/button_to.rb

@@ -11,20 +11,13 @@ module Phlexible
       BUTTON_TAG_METHOD_VERBS = %w[patch put delete].freeze
       DEFAULT_OPTIONS = { method: 'post', form_class: 'button_to' }.freeze
 
-      def initialize(name = nil, url = nil, options = nil)
-        @name = name
+      def initialize(url, options = nil)
         @url = url
         @options = options
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/AbcSize
       def template(&block)
-        if block_given?
-          @options = @url
-          @url = @name
-          @name = nil
-        end
-
         action = helpers.url_for(@url)
         @options = DEFAULT_OPTIONS.merge((@options || {}).symbolize_keys)
 
@@ -38,7 +31,7 @@ module Phlexible
           block_given? ? button(**button_attrs, &block) : button(**button_attrs) { @name }
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize
 
       private
 

data/lib/phlexible/rails/controller_attributes.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# 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. Simply
+# call `controller_attribute` with the name of any controller instance variable you want to access
+# in your view.
+#
+# @example
+#   class Views::Users::Index < Views::Base
+#     controller_attribute :user_name
+#
+#     def template
+#       h1 { @user_name }
+#     end
+#   end
+#
+# Options
+#   - `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.
+#
+module Phlexible
+  module Rails
+    module ControllerAttributes
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :__controller_attributes__, instance_predicate: false, default: Set.new
+      end
+
+      class_methods do
+        def controller_attribute(*names, **kwargs)
+          self.__controller_attributes__ += names
+
+          return if kwargs.empty?
+
+          names.each do |name|
+            attr_reader name if kwargs[:attr_reader]
+            alias_method kwargs[:alias], name if kwargs[:alias]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexible/rails/responder.rb

@@ -5,22 +5,25 @@ module Phlexible
     module Responder
       # Overridden to support implicit rendering of phlex views.
       def default_render
+        return super if format != :html
+
         if @default_response
           @default_response.call(options)
         elsif !get? && has_errors?
-          render_phlex_view options.merge(status: :unprocessable_entity)
+          render_phlex_view({ status: error_status }.merge!(options))
         else
           render_phlex_view options
         end
       end
 
       # Render the Phlex view with the current resource. Falls back to default controller rendering
-      # if no Phlex view exists. If a `view_options` keyword argument is given, this will be passed
-      # as the keyword arguments of the view initializer.
+      # if no Phlex view exists. Also passes the current resource to the view, which is then
+      # available as `@resource`.
       #
-      # @see Phlexible::Rails::ActionController::ImplicitRender#render_view_class
+      # @see Phlexible::Rails::ActionController::ImplicitRender#render_plex_view
       def render_phlex_view(options)
-        controller.render_view_class(@resource, options) || controller.render(options)
+        controller.instance_variable_set :@resource, @resource
+        controller.render_plex_view(options) || controller.render(options)
       end
       alias render render_phlex_view
     end

data/lib/phlexible/rails.rb

@@ -4,6 +4,7 @@ require 'phlex-rails'
 
 module Phlexible
   module Rails
+    autoload :ControllerAttributes, 'phlexible/rails/controller_attributes'
     autoload :Responder, 'phlexible/rails/responder'
     autoload :AElement, 'phlexible/rails/a_element'
 

data/lib/phlexible/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexible
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: phlex-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.0.0
 description: A bunch of helpers and goodies intended to make life with Phlex even
   easier!
 email:
@@ -72,6 +72,7 @@ files:
 - lib/phlexible/rails/a_element.rb
 - lib/phlexible/rails/action_controller/implicit_render.rb
 - lib/phlexible/rails/button_to.rb
+- lib/phlexible/rails/controller_attributes.rb
 - lib/phlexible/rails/responder.rb
 - lib/phlexible/version.rb
 homepage: https://github.com/joelmoss/phlexible
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A bunch of helpers and goodies intended to make life with Phlex even easier!