phlexible 2.2.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70c94bf6c1a9eb6c37f22444fb384f9083ade53cee6939d1d651dc5ac3d9d43e
-  data.tar.gz: 48740ed58950fe01c78f8fdc5cb8953839e416f8d4b0d50337fc8b063cc9fc77
+  metadata.gz: 4d390495147c1fddfdf6eb14e2297dbb7d93526f4cfc3887d0833067950f893a
+  data.tar.gz: 1cd7d1fca0f0bb57f9e0fa9c5f066dc6749f42f4ebe0fd0f31c54f2c4984b044
 SHA512:
-  metadata.gz: 8c31e7fd6181675ca02be9d25939adc858777224844c9cfaa0c767551ffad050cb1078d9f537a25887a3226b7b693901a62ec06faabf604a7c8d698ee5217e37
-  data.tar.gz: 1de0fab43ab9d7ec708b5b6388d1071cf1a9002a7d29967095f7e4fffa89d7cc07e6f47c9ebb24384c6baeed6bc9cbcb1393b07a28417232c334e54508e55364
+  metadata.gz: e768da8e19b5b62e373859bca93d5b46c70ffe888208983a358cb59148ef3d0d37ecdf550c9281075a1715b87ec1226be6d25c621d8603acff2636fdd5339deb
+  data.tar.gz: 06260c6309159d5536dbd7cd8c7515ab285e3f1ff37e8e991a8a4112165f9b1d1dc95ebbaa0aa4a41a0378a7fc2c3704a6601a8e3f5ab5ad2538c92827bbc4bf

data/.rubocop.yml

@@ -1,22 +1,54 @@
+plugins:
+  - rubocop-rails
+  - rubocop-minitest
+  - rubocop-disable_syntax
+  - rubocop-packaging
+  - rubocop-rake
+  - rubocop-performance
+
 AllCops:
-  TargetRubyVersion: 3.3.0
-  SuggestExtensions: false
+  TargetRubyVersion: 3.3
   NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "gemfiles/**/*"
+
+Naming/FileName:
+  Exclude:
+    - "lib/proscenium-phlex.rb"
+
+Layout/LineLength:
+  Max: 100
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
 
 Lint/ConstantDefinitionInBlock:
   Exclude:
-    - test/**/*
+    - "test/**/*"
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
 
+Metrics:
+  Enabled: false
+
+Style/DisableSyntax:
+  DisableSyntax:
+    - unless
+    - and_or_not
+    - numbered_parameters
+
+Style/CaseEquality:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/ClassAndModuleChildren:
-  Exclude:
-    - fixtures/**/*
+  Enabled: false
+Style/NegatedIf:
+  Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - test/**/*
-Metrics/MethodLength:
-  Max: 20
-Metrics/CyclomaticComplexity:
-  Max: 8
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false
+Minitest/MultipleAssertions:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.8

data/Appraisals

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+appraise 'phlex1/rails7' do
+  gem 'phlex', '~> 1.11.0'
+  gem 'phlex-rails', '~> 1.2.1'
+  gem 'rails', '~> 7.2.0'
+end
+
+appraise 'phlex1/rails8' do
+  gem 'phlex', '~> 1.11.0'
+  gem 'phlex-rails', '~> 1.2.1'
+  gem 'rails', '>= 8.0.0'
+end
+
+appraise 'phlex2/rails7' do
+  gem 'phlex', '>= 2.1.0', '< 3.0.0'
+  gem 'phlex-rails', '>= 2.1.0', '< 3.0.0'
+  gem 'rails', '~> 7.2.0'
+end
+
+appraise 'phlex2/rails8' do
+  gem 'phlex', '>= 2.1.0', '< 3.0.0'
+  gem 'phlex-rails', '>= 2.1.0', '< 3.0.0'
+  gem 'rails', '>= 8.0.0'
+end

data/README.md

@@ -36,6 +36,26 @@ class UsersController
 end
 ```
 
+##### View Resolution
+
+By default, views are resolved using the `phlex_view_path` method, which constructs a path based on the controller and action name. For example, `UsersController#index` will look for `Users::IndexView`.
+
+You can customize this behavior by overriding `phlex_view_path` in your controller:
+
+```ruby
+class UsersController
+  include Phlexible::Rails::ActionController::ImplicitRender
+
+  private
+
+    def phlex_view_path(action_name)
+      "views/#{controller_path}/#{action_name}"
+    end
+end
+```
+
+This would resolve `UsersController#index` to `Views::Users::Index` instead.
+
 #### `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.
@@ -251,7 +271,7 @@ 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:
+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 include *Phlexible::PageTitle* module and assign the title to the `page_title` class variable:
 
 ```ruby
 class MyView
@@ -261,9 +281,72 @@ end
 
 Then call the `page_title` method in the `<head>` of your page.
 
+### `ProcessAttributes`
+
+> This functionality is already built in to **Phlex >= 1**. This module is only needed for **Phlex >= 2**.
+
+Allows you to intercept and modify HTML element attributes before they are rendered. This is useful for adding default attributes, transforming values, or conditionally modifying attributes based on other attributes.
+
+Extend your view class with `Phlexible::ProcessAttributes` and define a `process_attributes` instance method that receives the attributes hash and returns the modified hash.
+
+```ruby
+class MyView < Phlex::HTML
+  extend Phlexible::ProcessAttributes
+
+  def process_attributes(attrs)
+    # Add a default class to all elements
+    attrs[:class] ||= 'my-default-class'
+    attrs
+  end
+
+  def view_template
+    div(id: 'container') { 'Hello' }
+  end
+end
+```
+
+This will output:
+
+```html
+<div id="container" class="my-default-class">Hello</div>
+```
+
+The `process_attributes` method is called for all standard HTML elements and void elements, as well as any custom elements registered with `register_element`.
+
+```ruby
+class MyView < Phlex::HTML
+  extend Phlexible::ProcessAttributes
+
+  register_element :my_custom_element
+
+  def process_attributes(attrs)
+    attrs[:data_processed] = true
+    attrs
+  end
+
+  def view_template
+    my_custom_element(name: 'test') { 'Custom content' }
+  end
+end
+```
+
 ## 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 rails t
+```
+
+To run tests for a specific Phlex versions, call:
 
 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/Rakefile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
+require 'bundler/setup'
 
-RuboCop::RakeTask.new
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
 
-task default: :rubocop
+require 'bundler/gem_tasks'

data/gemfiles/.bundle/config

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

data/gemfiles/phlex1_rails7.gemfile

@@ -0,0 +1,24 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "amazing_print"
+gem "appraisal"
+gem "debug"
+gem "rubocop-disable_syntax", require: false
+gem "rubocop-minitest", require: false
+gem "rubocop-packaging", require: false
+gem "rubocop-performance", require: false
+gem "rubocop-rails", require: false
+gem "rubocop-rake", require: false
+gem "capybara"
+gem "maxitest"
+gem "minitest", "~> 5.0"
+gem "minitest-difftastic"
+gem "minitest-focus"
+gem "minitest-spec-rails"
+gem "phlex", "~> 1.11.0"
+gem "phlex-rails", "~> 1.2.1"
+gem "rails", "~> 7.2.0"
+
+gemspec path: "../"