phlexible 0.7.0 → 1.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebbba0bcc30f99c8db48f4c58b0a1206094134083914eef072b7e2e973fca4e9
-  data.tar.gz: 1811a856e1c676818f56756bc0230fe5429e83578715d57bb7becbc44eebeeff
+  metadata.gz: 64179e5e683be255a3bbd07a5da7fcec2c9e077fc52bffa854b9f9c2b3d4786d
+  data.tar.gz: 87c196d1421e5845f961ad3b79a63d0aa7d9d8966b79778400eb0bc0ea39daf6
 SHA512:
-  metadata.gz: c422ce495faed5f85e81d189683ddb8eb332f0268c1701923bea7b2d005eb648e0e9750ce8a6b4091bf5a164dfa0329a26eccfb9c9f123c9e82e319b6e1b0457
-  data.tar.gz: 53d11e9fced4091ee9119078e05f26bdcf5629aa0adaf7108e2b4b326a463a1feeacbd0b920c4e549bfc8385224214336a27cfc32d7830689b40a3c66c34b8c5
+  metadata.gz: e180904344267c2fd9911dbaa8c7c9a1a7c66ba26cb459fec7e7b3df7bbc419b16352b6c008c42cbdd6f456fd67a3bab27a2412c112746c1ca0329834c0f439a
+  data.tar.gz: 842c6c4db2390a5a9abd9f5ceb01bb0b4a45c97d1ef7a02dac7cd77a2b4824a6c6f0b6dd268de7e933f9dadd252051f2b3eb2dd94034e441e93e96f9740bb842

data/.rubocop.yml

@@ -1,5 +1,4 @@
 AllCops:
-  TargetRubyVersion: 3.0
   SuggestExtensions: false
   NewCops: enable
 

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    phlexible (0.7.0)
+    phlexible (1.0.0.beta.1)
       phlex (>= 1.8.1)
       phlex-rails (>= 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.2)
-      actionview (= 7.1.2)
-      activesupport (= 7.1.2)
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.3)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -18,13 +18,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.2)
-      activesupport (= 7.1.2)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.2)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -36,59 +36,59 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.4)
+    bigdecimal (3.1.6)
     builder (3.2.4)
-    cgi (0.4.0)
-    combustion (1.3.7)
+    cgi (0.4.1)
+    combustion (1.4.0)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     crass (1.0.6)
     drb (2.2.0)
       ruby2_keywords
-    erb (4.0.3)
+    erb (4.0.4)
       cgi (>= 0.3.3)
     erubi (1.12.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.9.1)
+    io-console (0.7.2)
+    irb (1.11.1)
       rdoc
-      reline (>= 0.3.8)
-    json (2.6.3)
+      reline (>= 0.4.2)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.20.0)
+    minitest (5.21.2)
     mutex_m (0.2.0)
-    nokogiri (1.15.5-arm64-darwin)
+    nokogiri (1.16.0-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-darwin)
+    nokogiri (1.16.0-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-linux)
+    nokogiri (1.16.0-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     phlex (1.9.0)
       concurrent-ruby (~> 1.2)
       erb (>= 4)
       zeitwerk (~> 2.6)
-    phlex-rails (1.1.0)
+    phlex-rails (1.1.1)
       phlex (~> 1.9)
       railties (>= 6.1, < 8)
       zeitwerk (~> 2.6)
     phlex-testing-nokogiri (0.1.0)
       nokogiri (~> 1.13)
       phlex (>= 0.5)
-    psych (5.1.1.1)
+    psych (5.1.2)
       stringio
     racc (1.7.3)
-    rack (3.0.8)
+    rack (3.0.9)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -103,9 +103,9 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.2)
-      actionpack (= 7.1.2)
-      activesupport (= 7.1.2)
+    railties (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -113,29 +113,29 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.1.0)
-    rdoc (6.6.0)
+    rdoc (6.6.2)
       psych (>= 4.0.0)
-    regexp_parser (2.8.2)
-    reline (0.4.0)
+    regexp_parser (2.9.0)
+    reline (0.4.2)
       io-console (~> 0.5)
     rexml (3.2.6)
-    rubocop (1.57.2)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    stringio (3.0.9)
-    sus (0.23.0)
+    stringio (3.1.0)
+    sus (0.24.5)
     thor (1.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -36,15 +36,19 @@ class UsersController
 end
 ```
 
-#### `ControllerAttributes`
+#### `ControllerVariables`
 
-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.
+> Available in **>= 1.0.0**
+
+> **NOTE:** Prior to **1.0.0**, this module was called `ControllerAttributes` with a very different API. This is no longer available since **1.0.0**.
+
+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 within the view.
 
 ```ruby
 class Views::Users::Index < Views::Base
-  include Phlexible::Rails::ControllerAttributes
+  include Phlexible::Rails::ControllerVariables
 
-  controller_attribute :first_name, :last_name
+  controller_variable :first_name, :last_name
 
   def template
     h1 { "#{@first_name} #{@last_name}" }
@@ -54,13 +58,29 @@ 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.
+`controller_variable` accepts one or many symbols, or a hash of symbols to options.
+
+- `as:` - If set, the given attribute will be renamed to the given value. Helpful to avoid naming conflicts.
+- `allow_undefined:` - By default, if the instance variable is not defined in the controller, an
+  exception will be raised. If this option is to `true`, an error will not be raised.
+
+You can also pass a hash of attributes to `controller_variable`, where the key is the controller
+attribute, and the value is the renamed value, or options hash.
 
 ```ruby
-controller_attribute :users, attr_reader: true, alias: :my_users
+class Views::Users::Index < Views::Base
+  include Phlexible::Rails::ControllerVariables
+
+  controller_variable last_name: :surname, first_name: { as: :given_name, allow_undefined: true }
+
+  def template
+    h1 { "#{@given_name} #{@surname}" }
+  end
+end
 ```
 
+Please note that defining a variable with the same name as an existing variable in the view will be overwritten.
+
 #### `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.
@@ -90,7 +110,7 @@ end
 
 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 `ControllerVariables` in your view, and define a `resource` attribute, the responder will pass that to your view.
 
 #### `AElement`
 
@@ -138,7 +158,39 @@ Phlexible::Rails::ButtonTo.new(:root, method: :patch) { 'My Button' }
 - `:form_attributes` - Hash of HTML attributes for the form tag.
 - `: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.
+- `:method` - Symbol of the HTTP verb. Supported verbs are :post (default), :get, :delete, :patch,
+  and :put.
+
+#### `MetaTags`
+
+> Available in **>= 1.0.0**
+
+
+A super simple way to define and render meta tags in your Phlex views. Just render the
+`Phlexible::Rails::MetaTagsComponent` component in the head element of your page, and define the
+meta tags using the `meta_tag` method in your controllers.
+
+```ruby
+class MyController < ApplicationController
+  meta_tag :description, 'My description'
+  meta_tag :keywords, 'My keywords'
+end
+```
+
+```ruby
+class MyView < Phlex::HTML
+  def template
+    html do
+      head do
+        render Phlexible::Rails::MetaTagsComponent
+      end
+      body do
+        # ...
+      end
+    end
+  end
+end
+```
 
 ### `AliasView`
 

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Views::Articles::Show < Phlex::HTML
+  include Phlexible::Rails::ControllerVariables
+
+  def template; end
+end

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

@@ -26,24 +26,12 @@ module Phlexible
           render_plex_view({ action: action_name }) || super
         end
 
-        def assign_phlex_accessors(pview)
-          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
-          end
-        end
-
         def method_for_action(action_name)
           super || ('default_phlex_render' if phlex_view(action_name))
         end
 
         def default_phlex_render
-          render assign_phlex_accessors(phlex_view(action_name).new)
+          render phlex_view(action_name).new
         end
 
         # @param options [Hash] At a minimum this may contain an `:action` key, which will be used
@@ -54,7 +42,7 @@ module Phlexible
 
           return unless (view = phlex_view(options[:action]))
 
-          render assign_phlex_accessors(view.new), options
+          render view.new, options
         end
 
         private

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Phlexible
+  module Rails
+    module ActionController
+      module MetaTags
+        extend ActiveSupport::Concern
+
+        def meta_tags
+          @meta_tags ||= {}
+        end
+
+        def meta_tag(name, content)
+          meta_tags[name] = content
+        end
+
+        module ClassMethods
+          def meta_tag(name, content, **kwargs)
+            before_action(**kwargs) do |ctrl|
+              ctrl.meta_tag name, content.is_a?(Proc) ? ctrl.instance_exec(&content) : content
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexible/rails/controller_variables.rb

@@ -0,0 +1,101 @@
+# 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_variable` with the name of any controller instance variable you want to access
+# in your view.
+#
+# @example
+#   class Views::Users::Index < Views::Base
+#     controller_variable :user_name
+#
+#     def template
+#       h1 { @user_name }
+#     end
+#   end
+#
+# Options
+#   - `as:` - If set, the given attribute will be renamed to the given value. Helpful to avoid
+#     naming conflicts.
+#   - `allow_undefined:` - If set to `true`, the view will not raise an error if the controller
+#     instance variable is not defined.
+#
+module Phlexible
+  module Rails
+    module ControllerVariables
+      def self.included(klass)
+        klass.class_attribute :__controller_variables__, instance_predicate: false, default: Set.new
+        klass.extend ClassMethods
+      end
+
+      class UndefinedVariable < NameError
+        def initialize(name)
+          @variable_name = name
+          super "Attempted to expose controller variable `#{@variable_name}`, but instance " \
+                'variable is not defined in the controller.'
+        end
+      end
+
+      def before_template
+        if respond_to?(:__controller_variables__)
+          view_assigns = helpers.controller.view_assigns
+
+          __controller_variables__.each do |k, v|
+            allow_undefined = true
+            if k.ends_with?('!')
+              allow_undefined = false
+              k = k.chop
+            end
+
+            raise ControllerVariables::UndefinedVariable, k if !allow_undefined && !view_assigns.key?(k)
+
+            instance_variable_set(:"@#{v}", view_assigns[k])
+          end
+        end
+
+        super
+      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.'
+          end
+
+          allow_undefined = kwargs.delete(:allow_undefined)
+          as = kwargs.delete(:as)
+
+          if names.count > 1 && as
+            raise ArgumentError, 'You cannot provide the `as:` option when passing multiple ' \
+                                 'variable names.'
+          end
+
+          names.each do |name|
+            name_as = as || name
+            name = "#{name}!" unless allow_undefined
+
+            self.__controller_variables__ += { name.to_s => name_as.to_s }
+          end
+
+          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}!" unless v[:allow_undefined]
+              elsif !allow_undefined
+                k = "#{k}!"
+              end
+            else
+              name = v.to_s
+              k = "#{k}!" unless allow_undefined
+            end
+
+            self.__controller_variables__ += { k.to_s => name }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexible/rails/meta_tags_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Phlexible
+  module Rails
+    class MetaTagsComponent < Phlex::HTML
+      def template
+        helpers.controller.view_assigns['meta_tags']&.each do |name, content|
+          meta name: name, content: content.is_a?(String) ? content : content.to_json
+        end
+      end
+    end
+  end
+end

data/lib/phlexible/rails.rb

@@ -4,15 +4,17 @@ require 'phlex-rails'
 
 module Phlexible
   module Rails
-    autoload :ControllerAttributes, 'phlexible/rails/controller_attributes'
+    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

data/lib/phlexible/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phlexible
-  VERSION = '0.7.0'
+  VERSION = '1.0.0.beta.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexible
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0.beta.1
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -58,6 +58,7 @@ files:
 - 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
@@ -71,8 +72,10 @@ files:
 - 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/controller_attributes.rb
+- lib/phlexible/rails/controller_variables.rb
+- lib/phlexible/rails/meta_tags_component.rb
 - lib/phlexible/rails/responder.rb
 - lib/phlexible/version.rb
 homepage: https://github.com/joelmoss/phlexible
@@ -98,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: A bunch of helpers and goodies intended to make life with Phlex even easier!

data/lib/phlexible/rails/controller_attributes.rb

@@ -1,61 +0,0 @@
-# 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.
-#
-# 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
-
-      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]
-
-            if kwargs[:alias]
-              if kwargs[:attr_reader]
-                alias_method kwargs[:alias], name
-              else
-                define_method(kwargs[:alias]) { instance_variable_get :"@#{name}" }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end