phlexible 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21073cfcdc42c7f7e5b45acded4e215b292dc6a4ba249680421e5773d1fb4f71
-  data.tar.gz: ca39ee5c91a5cd5f6a69bde6a630078877485b0f68233c639c4fede9d1cca0a6
+  metadata.gz: 70c94bf6c1a9eb6c37f22444fb384f9083ade53cee6939d1d651dc5ac3d9d43e
+  data.tar.gz: 48740ed58950fe01c78f8fdc5cb8953839e416f8d4b0d50337fc8b063cc9fc77
 SHA512:
-  metadata.gz: e3bc48aace4119e705d9125de82e854ce0bf1c3d1ad6e9a041381903d5e7bf5e2f8ce3be61eb81f0c9b7c252d5163f7566a8098132bffc866feccee7aecd2b66
-  data.tar.gz: 1a0a10ace59181e18d07ef13321ce24d8991767df940f4bd1e16e6f93e357915df0a8ee2208895919f9ecc6de05759fba60b74f5ff4d3af8b16fd1c12232bcf8
+  metadata.gz: 8c31e7fd6181675ca02be9d25939adc858777224844c9cfaa0c767551ffad050cb1078d9f537a25887a3226b7b693901a62ec06faabf604a7c8d698ee5217e37
+  data.tar.gz: 1de0fab43ab9d7ec708b5b6388d1071cf1a9002a7d29967095f7e4fffa89d7cc07e6f47c9ebb24384c6baeed6bc9cbcb1393b07a28417232c334e54508e55364

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phlexible (2.1.0)
+    phlexible (2.2.0)
       phlex (>= 1.10.0, < 2.0.0)
       phlex-rails (>= 1.2.1, < 2.0.0)
 
@@ -50,6 +50,9 @@ GEM
     connection_pool (2.5.0)
     crass (1.0.6)
     date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     drb (2.2.1)
     erubi (1.13.1)
     i18n (1.14.7)
@@ -155,6 +158,7 @@ PLATFORMS
 
 DEPENDENCIES
   combustion
+  debug
   phlex-testing-nokogiri
   phlexible!
   rake (~> 13.0)

data/README.md

@@ -36,6 +36,32 @@ class UsersController
 end
 ```
 
+#### `Callbacks`
+
+While Phlex does have `before_template`, `after_template`, and `around_template` hooks, they must be defined as regular Ruby methods, meaning you have to always remember to call `super` when redefining any hook method.
+
+This module provides a more Rails-like interface for defining callbacks in your Phlex views, using `ActiveSupport::Callbacks`. It implements the same `before_template`, `after_template`, and `around_template` hooks as callbacks.
+
+```ruby
+class Views::Users::Index < Views::Base
+  include Phlexible::Callbacks
+
+  before_template :set_title
+
+  def view_template
+    h1 { @title }
+  end
+
+  private
+
+    def set_title
+      @title = 'Users'
+    end
+end
+```
+
+You can still use the regular `before_template`, `after_template`, and `around_template` hooks as well, but I recommend that if you include this module, that you use callbacks instead.
+
 #### `ControllerVariables`
 
 > Available in **>= 1.0.0**

data/lib/phlexible/callbacks.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_support/callbacks'
+
+module Phlexible
+  module Callbacks
+    extend ActiveSupport::Concern
+    include ActiveSupport::Callbacks
+
+    included do
+      define_callbacks :initialize, :template
+    end
+
+    class_methods do
+      def new(...)
+        obj = super
+        obj.run_callbacks :initialize, :after
+        obj
+      end
+
+      def after_initialize(*names, &block)
+        set_callback(:initialize, :after, *names, &block)
+      end
+
+      def around_template(*names, &block)
+        set_callback(:template, :around, *names, &block)
+      end
+
+      def before_template(*names, &block)
+        set_callback(:template, :before, *names, &block)
+      end
+
+      def after_template(*names, &block)
+        set_callback(:template, :after, *names, &block)
+      end
+    end
+
+    def around_template
+      run_callbacks :template do
+        super
+      end
+    end
+  end
+end

data/lib/phlexible/rails/controller_variables.rb

@@ -26,6 +26,8 @@ module Phlexible
       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,27 +38,27 @@ 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 # rubocop:disable Metrics
+        return unless respond_to?(:__controller_variables__)
 
-            raise ControllerVariables::UndefinedVariable, k if !allow_undefined && !view_assigns.key?(k)
+        view_assigns = helpers.controller.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

data/lib/phlexible/version.rb

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

data/lib/phlexible.rb

@@ -6,5 +6,6 @@ require 'phlex'
 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.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Joel Moss
 bindir: exe
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -79,6 +79,7 @@ files:
 - fixtures/rails_helper.rb
 - 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