phlexible 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21073cfcdc42c7f7e5b45acded4e215b292dc6a4ba249680421e5773d1fb4f71
-  data.tar.gz: ca39ee5c91a5cd5f6a69bde6a630078877485b0f68233c639c4fede9d1cca0a6
+  metadata.gz: af9a39dba0e25b8381fc0f513111e488e27e6fa6d31d3d41ec7d7b7d4aa07cd1
+  data.tar.gz: b1e271a6e412e7e05aabed4b8c4f3a35157a04c6a7e0723ee70b9414beb65565
 SHA512:
-  metadata.gz: e3bc48aace4119e705d9125de82e854ce0bf1c3d1ad6e9a041381903d5e7bf5e2f8ce3be61eb81f0c9b7c252d5163f7566a8098132bffc866feccee7aecd2b66
-  data.tar.gz: 1a0a10ace59181e18d07ef13321ce24d8991767df940f4bd1e16e6f93e357915df0a8ee2208895919f9ecc6de05759fba60b74f5ff4d3af8b16fd1c12232bcf8
+  metadata.gz: 27635a6f6135a15af61920b630269372199777701ec92b216f6e7309880fd46d93705890ef8545fb7d47101d295ad0744406cc1cd9beddfdf81fe03c3b849f71
+  data.tar.gz: c22b9d2d997f94ee86ee3c3c854ec631e2864f549c76d3ffc10138de0df0e2eeafbb2c7c5d9f6e15f2cea4fa1bb1a2982ed38e784878f433edef563f1d6bf8f6

data/.rubocop.yml

@@ -2,6 +2,9 @@ AllCops:
   TargetRubyVersion: 3.3.0
   SuggestExtensions: false
   NewCops: enable
+  Exclude:
+    - "vendor/**/*"
+    - gemfiles/**/*
 
 Lint/ConstantDefinitionInBlock:
   Exclude:
@@ -13,10 +16,5 @@ Style/ClassAndModuleChildren:
   Exclude:
     - fixtures/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - test/**/*
-Metrics/MethodLength:
-  Max: 20
-Metrics/CyclomaticComplexity:
-  Max: 8
+Metrics:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/Appraisals

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+appraise 'phlex-1' do
+  gem 'phlex', '>= 1.10.0', '< 2.0.0'
+  gem 'phlex-rails', '>= 1.2.1', '< 2.0.0'
+end
+
+appraise 'phlex-2' do
+  gem 'phlex', '>= 2.1.0', '< 3.0.0'
+  gem 'phlex-rails', '>= 2.1.0', '< 3.0.0'
+end

data/Gemfile

@@ -5,8 +5,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in phlexible.gemspec
 gemspec
 
+gem 'appraisal'
 gem 'combustion'
-gem 'phlex-testing-nokogiri'
+gem 'debug'
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.55'
 gem 'sus'

data/Gemfile.lock

@@ -1,16 +1,38 @@
 PATH
   remote: .
   specs:
-    phlexible (2.1.0)
-      phlex (>= 1.10.0, < 2.0.0)
-      phlex-rails (>= 1.2.1, < 2.0.0)
+    phlexible (3.0.0)
+      phlex (>= 1.10.0, < 3.0.0)
+      phlex-rails (>= 1.2.0, < 3.0.0)
+      rails (>= 7.2.0, < 9.0.0)
+      zeitwerk (~> 2.7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (8.0.1)
-      actionview (= 8.0.1)
-      activesupport (= 8.0.1)
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
       nokogiri (>= 1.8.5)
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
@@ -18,13 +40,35 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actionview (8.0.1)
-      activesupport (= 8.0.1)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (8.0.1)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -37,7 +81,11 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
-    ast (2.4.2)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
     base64 (0.2.0)
     benchmark (0.4.0)
     bigdecimal (3.1.9)
@@ -47,50 +95,72 @@ GEM
       railties (>= 3.0.0)
       thor (>= 0.14.6)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
+    connection_pool (2.5.1)
     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)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     io-console (0.8.0)
-    irb (1.15.1)
+    irb (1.15.2)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.9.1)
+    json (2.10.2)
     language_server-protocol (3.17.0.4)
-    logger (1.6.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
     loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.25.4)
-    nokogiri (1.18.2-arm64-darwin)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    net-imap (0.5.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
-    parallel (1.26.3)
-    parser (3.3.7.1)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    phlex (1.11.0)
-    phlex-rails (1.2.2)
-      phlex (>= 1.10, < 2)
-      railties (>= 6.1, < 9)
-    phlex-testing-nokogiri (0.1.0)
-      nokogiri (~> 1.13)
-      phlex (>= 0.5)
+    phlex (2.2.1)
+      zeitwerk (~> 2.7)
+    phlex-rails (2.2.0)
+      phlex (~> 2.2.1)
+      railties (>= 7.1, < 9)
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
+    prism (1.4.0)
     psych (5.2.3)
       date
       stringio
     racc (1.8.1)
-    rack (3.1.9)
+    rack (3.1.13)
     rack-session (2.1.0)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
@@ -98,6 +168,20 @@ GEM
       rack (>= 1.3)
     rackup (2.2.1)
       rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -105,9 +189,9 @@ GEM
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.1)
-      actionpack (= 8.0.1)
-      activesupport (= 8.0.1)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -115,36 +199,43 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
-    rdoc (6.11.0)
+    rdoc (6.13.1)
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
-    reline (0.6.0)
+    reline (0.6.1)
       io-console (~> 0.5)
-    rubocop (1.71.2)
+    rubocop (1.75.3)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
-      parser (>= 3.3.1.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    stringio (3.1.2)
+    stringio (3.1.7)
     sus (0.32.0)
     thor (1.3.2)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
+    uri (1.0.3)
     useragent (0.16.11)
-    zeitwerk (2.7.1)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   arm64-darwin-22
@@ -154,8 +245,9 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  appraisal
   combustion
-  phlex-testing-nokogiri
+  debug
   phlexible!
   rake (~> 13.0)
   rubocop (~> 1.55)

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**
@@ -237,7 +263,26 @@ 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.
+After checking out the repo, install dependencies with:
+
+```bash
+bin/setup
+```
+
+This gem supports varios major Phlex versions, as defined in the `Appraisal` file.
+
+To run tests for all supported Phlex versions:
+
+```
+bundle exec appraisal sus
+```
+
+To run tests for a specific Phlex versions, call:
+
+```bash
+bundle exec appraisal phlex-1 sus
+bundle exec appraisal phlex-2 sus
+```
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/config/render_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RenderHelper
+  def render_to_html(component)
+    view_context.render(component)
+  end
+
+  def render_to_nokogiri_fragment(...)
+    html = render_to_html(...)
+    Nokogiri::HTML5.fragment(html)
+  end
+
+  def render_to_nokogiri_document(...)
+    html = render_to_html(...)
+    Nokogiri::HTML5(html)
+  end
+
+  private
+
+  def view_context
+    controller.view_context
+  end
+
+  def controller
+    @controller ||= ActionView::TestCase::TestController.new
+  end
+end

data/config/sus.rb

@@ -5,4 +5,4 @@ require 'bundler'
 
 Bundler.require :test
 
-require_relative 'view_helper'
+require_relative 'render_helper'

data/fixtures/rails_helper.rb

@@ -7,4 +7,5 @@ Combustion.path = 'fixtures/dummy'
 Combustion.initialize! :action_controller do
   config.load_defaults 7.0
   config.autoload_paths << "#{root}/app"
+  config.active_support.to_time_preserves_timezone = :zone
 end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/phlex_1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "combustion"
+gem "debug"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.55"
+gem "sus"
+gem "phlex", ">= 1.10.0", "< 2.0.0"
+gem "phlex-rails", ">= 1.2.1", "< 2.0.0"
+
+gemspec path: "../"