phlexible 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c45035fcfe50f425a2876e79f5973399b74b76f5923357dd02c355575d0eac
-  data.tar.gz: 49e7ddc371aaad6e53316cdd4aa5bb0bfb76cda8f6fa1052779e40306d1e339a
+  metadata.gz: de2a41c9efa577146733f7e842f503818c594d726995a8f62fd39f5e87749b61
+  data.tar.gz: 89306b9e9ca8b83ed58a4b598197cabe3c745c554645c0555b684c8dc653ac39
 SHA512:
-  metadata.gz: 9149698fef1b20d16ca297db60e847172a7454dcab4a53e2798a9cbe38f04ab5b87124453861c312f8002365a895b4e97b76494541568cd3c8c1714c5d99cf4b
-  data.tar.gz: 7e4782383a6f3f542b460739c2e3ed7d27dbf677ab2dab2b73794bb12f0298e19833e63e329ab744e510a750f0db3465546ae5a6704503755c6fa54df034ec48
+  metadata.gz: 87c4b0ece2ba0ce51a1b8d865a48fe09dfcd41cec04ee9f862fb05c8e82140946ebabf71056fb863fd38364bf1a80e836d2024a2dd6d80893a50c4f637231e7a
+  data.tar.gz: 2fdfd0d7c354df97d8d932bc4eb695876bb87a6434a54b16ce0de729050225acbdbb564e04feb7b6315dc2bde0ee5987456ba67ed684bbfc660c7fae04723356

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   SuggestExtensions: false
   NewCops: enable
 
@@ -14,3 +14,5 @@ Lint/ConstantDefinitionInBlock:
 Style/ClassAndModuleChildren:
   Exclude:
     - fixtures/**/*
+Metrics/MethodLength:
+  Max: 15

data/Gemfile

@@ -6,6 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'combustion'
+gem 'phlex-testing-nokogiri'
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.21'
 gem 'sus', '~> 0.16.0'

data/Gemfile.lock

@@ -123,6 +123,9 @@ GEM
       phlex (>= 1, < 2)
       rails (>= 6.1, < 8)
       zeitwerk (~> 2)
+    phlex-testing-nokogiri (0.1.0)
+      nokogiri (~> 1.13)
+      phlex (>= 0.5)
     racc (1.6.2)
     rack (2.2.5)
     rack-test (2.0.2)
@@ -188,6 +191,7 @@ PLATFORMS
 
 DEPENDENCIES
   combustion
+  phlex-testing-nokogiri
   phlexible!
   rake (~> 13.0)
   rubocop (~> 1.21)

data/README.md

@@ -16,14 +16,61 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### Rails
 
-#### `AnchorElement`
+#### `ActionController::ImplicitRender`
+
+Adds support for default and `action_missing` rendering of Phlex views. So instead of this:
+
+```ruby
+class UsersController
+  def index
+    render Views::Users::Index.new
+  end
+end
+```
+
+You can do this:
+
+```ruby
+class UsersController
+  include Phlexible::Rails::ActionController::ImplicitRender
+end
+```
+
+#### `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.
+
+Just include it in your ApplicationResponder:
+
+```ruby
+class ApplicationResponder < ActionController::Responder
+  include Phlexible::Rails::Responder
+end
+```
+
+Then simply `respond_with` in your action method as normal:
+
+```ruby
+class UsersController < ApplicationController
+  def new
+    respond_with User.new
+  end
+end
+```
+
+This responder requires the use of `ActionController::ImplicitRender`, so dont't forget to include
+that in your `ApplicationController`.
+
+#### `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.
 
-The `Phlexible::Rails::AnchorElement` module redefines the `a` tag, and 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
@@ -33,14 +80,48 @@ end
 
 ```ruby
 class MyView < Phlex::HTML
-    include Phlexible::Rails::AnchorElement
+  include Phlexible::Rails::AElement
 
-    def template
-        a(href: :articles) { 'View articles' }
-    end
+  def template
+    a(href: :articles) { 'View articles' }
+  end
 end
 ```
 
+#### 'ButtonTo`
+
+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.
+
+```ruby
+Phlexible::Rails::ButtonTo.new(:root) { 'Go Home 👉' }
+```
+
+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.
+
+```ruby
+Phlexible::Rails::ButtonTo.new 'My Button', :root, method: :patch
+```
+
+##### Options
+
+- `: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.
+
 ### `AliasView`
 
 Create an alias at a given `element`, to the given view class.
@@ -49,11 +130,11 @@ So instead of:
 
 ```ruby
 class MyView < Phlex::HTML
-    def template
-        div do
-            render My::Awesome::Component.new
-        end
+  def template
+    div do
+      render My::Awesome::Component.new
     end
+  end
 end
 ```
 
@@ -61,18 +142,32 @@ You can instead do:
 
 ```ruby
 class MyView < Phlex::HTML
-    extend Phlexible::AliasView
+  extend Phlexible::AliasView
 
-    alias_view :awesome, -> { My::Awesome::Component }
+  alias_view :awesome, -> { My::Awesome::Component }
 
-    def template
-        div do
-            awesome
-        end
+  def template
+    div do
+      awesome
     end
+  end
+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:
+
+```ruby
+class MyView
+  self.page_title = 'My Title'
 end
 ```
 
+Then call the `page_title` method in the `<head>` of your page.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/fixtures/dummy/app/views/articles/link.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class Views::Articles::Link < Phlex::HTML
-  include Phlexible::Rails::AnchorElement
+  include Phlexible::Rails::AElement
 
   def template
-    a(href: :root) { 'A link to root' }
+    a(href: :root, class: :foo) { 'A link to root' }
   end
 end

data/lib/phlexible/alias_view.rb

@@ -30,8 +30,9 @@ module Phlexible
   #
   module AliasView
     def alias_view(element, view_class)
-      define_method element do |*args, **kwargs, &block|
-        render view_class.call.new(*args, **kwargs, &block)
+      define_method element do |*args, **kwargs, &blk|
+        render view_class.call.new(*args, **kwargs), &blk
+        # view_class.call.new(*args, **kwargs).call(@_target, view_context: @_view_context, parent: self, &blk)
       end
     end
   end

data/lib/phlexible/page_title.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Phlexible
+  #
+  # 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:
+  #
+  #   class MyView
+  #     self.page_title = 'My Title'
+  #   end
+  #
+  # Then call the `page_title` method in the <head> of your page.
+  #
+  module PageTitle
+    def self.included(base)
+      base.class_eval do
+        self.class.attr_accessor :page_title
+      end
+    end
+
+    private
+
+    def page_title
+      title = []
+
+      klass = self.class
+      while klass.respond_to?(:page_title)
+        title << if klass.page_title.is_a?(Proc)
+                   instance_exec(&klass.page_title)
+                 else
+                   klass.page_title
+                 end
+
+        klass = klass.superclass
+      end
+
+      title.compact.join(' - ')
+    end
+  end
+end

data/lib/phlexible/rails/a_element.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Phlexible
+  module Rails
+    # Calls `url_for` for the `href` attribute.
+    module AElement
+      def a(href:, **kwargs, &block)
+        super(href: helpers.url_for(href), **kwargs, &block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Adds support for default and action_missing rendering of Phlex views. So instead of this:
+#
+#   class UsersController
+#     def index
+#       render Views::Users::Index.new
+#     end
+#   end
+#
+# You can do this:
+#
+#   class UsersController
+#   end
+#
+module Phlexible
+  module Rails
+    module ActionController
+      module ImplicitRender
+        NUFFIN = 'NUFFIN'
+
+        def default_render
+          render_view_class || super
+        end
+
+        def render_view_class(view_options = NUFFIN, render_options = {})
+          klass = render_options&.key?(:action) ? phlex_view(render_options[:action]) : phlex_view
+          return unless klass
+
+          render view_options == NUFFIN ? klass.new : klass.new(view_options), render_options
+        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
+        end
+
+        def _handle_view_class(*_args)
+          render_view_class
+        end
+
+        def phlex_view(action_name = @_action_name)
+          "views/#{controller_path}/#{action_name}".classify.safe_constantize
+        end
+      end
+    end
+  end
+end

data/lib/phlexible/rails/button_to.rb

@@ -0,0 +1,82 @@
+# 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.
+module Phlexible
+  module Rails
+    module ButtonToConcerns
+      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
+        @url = url
+        @options = options
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      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)
+
+        method = (@options.delete(:method).presence || method_for_options(@options)).to_s
+        form_method = method == 'get' ? 'get' : 'post'
+
+        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)
+
+          block_given? ? button(**button_attrs, &block) : button(**button_attrs) { @name }
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+      private
+
+      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
+    end
+
+    class ButtonTo < Phlex::HTML
+      include ButtonToConcerns
+    end
+  end
+end

data/lib/phlexible/rails/responder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Phlexible
+  module Rails
+    module Responder
+      # Overridden to support implicit rendering of phlex views.
+      def default_render
+        if @default_response
+          @default_response.call(options)
+        elsif !get? && has_errors?
+          render_phlex_view options.merge(status: :unprocessable_entity)
+        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.
+      #
+      # @see Phlexible::Rails::ActionController::ImplicitRender#render_view_class
+      def render_phlex_view(options)
+        controller.render_view_class(@resource, options) || controller.render(options)
+      end
+      alias render render_phlex_view
+    end
+  end
+end

data/lib/phlexible/rails.rb

@@ -4,6 +4,14 @@ require 'phlex-rails'
 
 module Phlexible
   module Rails
-    autoload :AnchorElement, 'phlexible/rails/anchor_element'
+    autoload :Responder, 'phlexible/rails/responder'
+    autoload :AElement, 'phlexible/rails/a_element'
+
+    autoload :ButtonTo, 'phlexible/rails/button_to'
+    autoload :ButtonToConcerns, 'phlexible/rails/button_to'
+
+    module ActionController
+      autoload :ImplicitRender, 'phlexible/rails/action_controller/implicit_render'
+    end
   end
 end

data/lib/phlexible/version.rb

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

data/lib/phlexible.rb

@@ -5,5 +5,6 @@ require 'phlex'
 
 module Phlexible
   autoload :AliasView, 'phlexible/alias_view'
+  autoload :PageTitle, 'phlexible/page_title'
   autoload :Rails, 'phlexible/rails'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexible
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: A bunch of helpers and goodies intended to make life with [Phlex](https://phlex.fun)
-  even easier!
+description: A bunch of helpers and goodies intended to make life with Phlex even
+  easier!
 email:
 - joel@developwithstyle.com
 executables: []
@@ -67,8 +67,12 @@ files:
 - fixtures/rails_helper.rb
 - lib/phlexible.rb
 - lib/phlexible/alias_view.rb
+- lib/phlexible/page_title.rb
 - lib/phlexible/rails.rb
-- lib/phlexible/rails/anchor_element.rb
+- lib/phlexible/rails/a_element.rb
+- lib/phlexible/rails/action_controller/implicit_render.rb
+- lib/phlexible/rails/button_to.rb
+- lib/phlexible/rails/responder.rb
 - lib/phlexible/version.rb
 homepage: https://github.com/joelmoss/phlexible
 licenses:
@@ -86,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -96,6 +100,5 @@ requirements: []
 rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
-summary: A bunch of helpers and goodies intended to make life with [Phlex](https://phlex.fun)
-  even easier!
+summary: A bunch of helpers and goodies intended to make life with Phlex even easier!
 test_files: []

data/lib/phlexible/rails/anchor_element.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexible
-  module Rails
-    module AnchorElement
-      # @override Calls `url_for` for the :href attribute.
-      def a(**attributes, &block)
-        attributes[:href] = helpers.url_for(attributes[:href]) if attributes.key?(:href)
-
-        super(**attributes, &block)
-      end
-    end
-  end
-end