proscenium 0.19.0.beta18 → 0.19.0.beta20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5db88847b4fad16f8c3c4bfd96c5f7f40f59726c65280fd81cf2cdeb0fd09c89
-  data.tar.gz: 4056f395c8f45fda017c334402ce4b7b268b72a2ec75cec47c190c63f565220a
+  metadata.gz: '080d5f311b0065c945326e31473f04cf50562a193210f7cc737b8efe0decf517'
+  data.tar.gz: ce1f8e3c8165b153ccc409c2a2ff9126282ac376d2607472e1d7bb120b0bf368
 SHA512:
-  metadata.gz: abde8e210ea532b606bbc66282553491b7e06910e5f4ce48faab5f68518d154e9ce746a4bd3ad9e4e0f5b71b19ad569b345ad9db5b83ea35124e64af3698f416
-  data.tar.gz: dca5b7f3ce4bd5fe17e62c7372e38b86444b75e27999a3c5ad1e10ebb4a910630aa7f2dce922d4a025b0b7bac822a905b26e62bf5463b007fd2f03c5821190da
+  metadata.gz: 5548d17d416cf00d14685eb54b7e23e6865fc52e0ec40715339ba3490e8f547b87b1ca33f436905cdbf89284b508692886329c2df1f9d513bab18cfa422a5b91
+  data.tar.gz: 6a9c0844565ea5f0acdd93a4e2d2723dd039e6076bafbac2f1b4e255332c49cd7bcdb206a7986e89e5b49a9947cde6da9e7932960fd5f8632ad7a6f09f75c411

data/README.md

@@ -48,7 +48,6 @@
   - [Typescript Caveats](#typescript-caveats)
 - [JSX](#jsx)
 - [JSON](#json)
-- [Phlex Support](#phlex-support)
 - [Cache Busting](#cache-busting)
 - [rjs is back!](#rjs-is-back)
 - [Resolution](#resolution)
@@ -681,93 +680,6 @@ import { version } from "./package.json";
 console.log(version);
 ```
 
-## Phlex Support
-
-[Phlex](https://www.phlex.fun/) is a framework for building fast, reusable, testable views in pure Ruby. Proscenium works perfectly with Phlex, with support for side-loading, CSS modules, and more. Simply write your Phlex classes and inherit from `Proscenium::Phlex`.
-
-```ruby
-class MyView < Proscenium::Phlex
-  def view_template
-    h1 { 'Hello World' }
-  end
-end
-```
-
-In your layouts, include `Proscenium::Phlex::AssetInclusions`, and call the `include_assets` helper.
-
-```ruby
-class ApplicationLayout < Proscenium::Phlex
-  include Proscenium::Phlex::AssetInclusions # <--
-
-  def view_template(&)
-    doctype
-    html do
-      head do
-        title { 'My Awesome App' }
-        include_assets # <--
-      end
-      body(&)
-    end
-  end
-end
-```
-
-You can specifically include CCS and JS assets using the `include_stylesheets` and `include_javascripts` helpers, allowing you to control where they are included in the HTML.
-
-### Side-loading
-
-Any Phlex class that inherits `Proscenium::Phlex` will automatically be [side-loaded](#side-loading).
-
-### CSS Modules
-
-[CSS Modules](#css-modules) are fully supported in Phlex classes, with access to the [`css_module` helper](#in-your-views) if you need it. However, there is a better and more seemless way to reference CSS module classes in your Phlex classes.
-
-Within your Phlex classes, any class names that begin with `@` will be treated as a CSS module class.
-
-```ruby
-# /app/views/users/show_view.rb
-class Users::ShowView < Proscenium::Phlex
-  def view_template
-    h1 class: :@user_name do
-      @user.name
-    end
-  end
-end
-```
-
-```css
-/* /app/views/users/show_view.module.css */
-.userName {
-  color: red;
-  font-size: 50px;
-}
-```
-
-In the above `Users::ShowView` Phlex class, the `@user_name` class will be resolved to the `userName` class in the `users/show_view.module.css` file.
-
-The view above will be rendered something like this:
-
-```html
-<h1 class="user_name-ABCD1234"></h1>
-```
-
-You can of course continue to reference regular class names in your view, and they will be passed through as is. This will allow you to mix and match CSS modules and regular CSS classes in your views.
-
-```ruby
-# /app/views/users/show_view.rb
-class Users::ShowView < Proscenium::Phlex
-  def view_template
-    h1 class: :[@user_name, :title] do
-      @user.name
-    end
-  end
-end
-```
-
-```html
-<h1 class="user_name-ABCD1234 title">Joel Moss</h1>
-```
-
 ## Cache Busting
 
 > _COMING SOON_

data/lib/proscenium/css_module/path.rb

@@ -18,7 +18,8 @@ module Proscenium
       unless @css_module_path
         klass = superclass
 
-        while klass.respond_to?(:css_module_path) && !klass.abstract_class
+        while klass.respond_to?(:css_module_path) &&
+              (klass.respond_to?(:abstract_class) ? !klass.abstract_class : true)
           break if (@css_module_path = klass.css_module_path)
 
           klass = klass.superclass

data/lib/proscenium/css_module.rb

@@ -16,6 +16,27 @@ module Proscenium::CssModule
     end
   end
 
+  module ClassMethods
+    def css_module(*names, path: nil)
+      path ||= respond_to?(:css_module_path) ? css_module_path : path
+
+      cssm = Transformer.new(path)
+      cssm.class_names(*names, require_prefix: false).map { |name, _| name }.join(' ')
+    end
+
+    def class_names(*names, path: nil)
+      path ||= respond_to?(:css_module_path) ? css_module_path : path
+      names = names.flatten.compact
+
+      cssm = Transformer.new(path)
+      cssm.class_names(*names).map { |name, _| name }.join(' ') unless names.empty?
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
   # Accepts one or more CSS class names, and transforms them into CSS module names.
   #
   # @param name [String,Symbol,Array<String,Symbol>]

data/lib/proscenium/log_subscriber.rb

@@ -36,5 +36,3 @@ module Proscenium
     end
   end
 end
-
-Proscenium::LogSubscriber.attach_to :proscenium

data/lib/proscenium/railtie.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rails'
-require 'proscenium/log_subscriber'
 
 ENV['RAILS_ENV'] = Rails.env
 
@@ -11,6 +10,7 @@ module Proscenium
 
     config.proscenium = ActiveSupport::OrderedOptions.new
     config.proscenium.debug = false
+    config.proscenium.logging = true
     config.proscenium.bundle = true
     config.proscenium.side_load = true
     config.proscenium.code_splitting = true
@@ -28,6 +28,11 @@ module Proscenium
     }
 
     config.after_initialize do |_app|
+      if config.proscenium.logging
+        require 'proscenium/log_subscriber'
+        Proscenium::LogSubscriber.attach_to :proscenium
+      end
+
       ActiveSupport.on_load(:action_view) do
         include Proscenium::Helper
       end

data/lib/proscenium/react_componentable.rb

@@ -11,7 +11,7 @@ module Proscenium
       # The HTML tag to use as the wrapping element for the component. You can reassign this in your
       # component class to use a different tag:
       #
-      #   class MyComponent < Proscenium::Phlex::ReactComponent
+      #   class MyComponent < Proscenium::ReactComponent
       #     self.root_tag = :span
       #   end
       #

data/lib/proscenium/side_load.rb

@@ -116,7 +116,8 @@ module Proscenium
         css_imports = []
 
         klass = obj.class
-        while klass.respond_to?(:source_path) && klass.source_path && !klass.abstract_class
+        while klass.respond_to?(:source_path) && klass.source_path &&
+              (klass.respond_to?(:abstract_class) ? !klass.abstract_class : true)
           if options[:css] == false
             Importer.sideload klass.source_path, **options
           else

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.19.0.beta18'
+  VERSION = '0.19.0.beta20'
 end

data/lib/proscenium.rb

@@ -28,7 +28,6 @@ module Proscenium
   autoload :SideLoad
   autoload :CssModule
   autoload :ReactComponentable
-  autoload :Phlex
   autoload :Helper
   autoload :Builder
   autoload :Importer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.19.0.beta18
+  version: 0.19.0.beta20
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-30 00:00:00.000000000 Z
+date: 2025-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.0
-- !ruby/object:Gem::Dependency
-  name: phlex-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: prism
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +44,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: require-hooks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 description:
 email:
 - joel@developwithstyle.com
@@ -101,7 +59,6 @@ files:
 - lib/proscenium/bundled_gems.rb
 - lib/proscenium/css_module.rb
 - lib/proscenium/css_module/path.rb
-- lib/proscenium/css_module/rewriter.rb
 - lib/proscenium/css_module/transformer.rb
 - lib/proscenium/ensure_loaded.rb
 - lib/proscenium/ext/proscenium
@@ -114,10 +71,6 @@ files:
 - lib/proscenium/middleware/esbuild.rb
 - lib/proscenium/middleware/ruby_gems.rb
 - lib/proscenium/monkey.rb
-- lib/proscenium/phlex.rb
-- lib/proscenium/phlex/asset_inclusions.rb
-- lib/proscenium/phlex/css_modules.rb
-- lib/proscenium/phlex/react_component.rb
 - lib/proscenium/railtie.rb
 - lib/proscenium/react-manager/index.jsx
 - lib/proscenium/react-manager/react.js

data/lib/proscenium/css_module/rewriter.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require 'prism'
-require 'require-hooks/setup'
-
-module Proscenium
-  module CssModule
-    class Rewriter
-      def self.init(include: [], exclude: [])
-        RequireHooks.source_transform(
-          patterns: include,
-          exclude_patterns: exclude
-        ) do |path, source|
-          source ||= File.read(path)
-          Processor.call(source)
-        end
-      end
-
-      class Processor < Prism::Visitor
-        def self.call(source)
-          visitor = new
-          visitor.visit(Prism.parse(source).value)
-
-          buffer = source.dup
-          annotations = visitor.annotations
-          annotations.sort_by!(&:first)
-
-          annotations.reverse_each do |offset, action|
-            case action
-            when :start
-              buffer.insert(offset, 'class_names(*')
-            when :end
-              buffer.insert(offset, ')')
-            else
-              raise 'Invalid annotation'
-            end
-          end
-
-          buffer
-        end
-
-        def initialize
-          @annotations = []
-        end
-
-        PREFIX = '@'
-
-        attr_reader :annotations
-
-        def visit_assoc_node(node)
-          # Skip if the key is not a symbol or string
-          return if %i[symbol_node string_node].exclude?(node.key.type)
-
-          return if node.key.type == :symbol_node && node.key.value != 'class'
-          return if node.key.type == :string_node && node.key.content != 'class'
-
-          value = node.value
-          type = value.type
-
-          if (type == :symbol_node && value.value.start_with?(PREFIX)) ||
-             (type == :array_node && value.elements.any? { |it| it.value.start_with?(PREFIX) })
-            build_annotation value
-          end
-        end
-
-        def build_annotation(value)
-          location = value.location
-
-          @annotations <<
-            [location.start_character_offset, :start] <<
-            [location.end_character_offset, :end]
-        end
-      end
-    end
-  end
-end

data/lib/proscenium/phlex/asset_inclusions.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium::Phlex::AssetInclusions
-  def include_stylesheets
-    comment { '[PROSCENIUM_STYLESHEETS]' }
-  end
-
-  def include_javascripts
-    comment { '[PROSCENIUM_JAVASCRIPTS]' }
-  end
-
-  def include_assets
-    include_stylesheets
-    include_javascripts
-  end
-end

data/lib/proscenium/phlex/css_modules.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium
-  module Phlex::CssModules
-    include Proscenium::CssModule
-
-    def self.included(base)
-      base.extend CssModule::Path
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      # Set of CSS module paths that have been resolved after being transformed from 'class' HTML
-      # attributes. See #process_attributes. This is here because Phlex caches attributes. Which
-      # means while the CSS class names will be transformed, any resolved paths will be lost in
-      # subsequent requests.
-      attr_accessor :resolved_css_module_paths
-    end
-
-    def before_template
-      self.class.resolved_css_module_paths ||= Concurrent::Set.new
-      super
-    end
-
-    def after_template
-      self.class.resolved_css_module_paths ||= Concurrent::Set.new
-      self.class.resolved_css_module_paths.each do |path|
-        Proscenium::Importer.import path, sideloaded: true
-      end
-
-      super
-    end
-
-    # Resolve and side load any CSS modules in the "class" attributes, where a CSS module is a class
-    # name beginning with a `@`. The class name is resolved to a CSS module name based on the file
-    # system path of the Phlex class, and any CSS file is side loaded.
-    #
-    # For example, the following will side load the CSS module file at
-    # app/components/user/component.module.css, and add the CSS Module name `user_name` to the
-    # <div>.
-    #
-    #   # app/components/user/component.rb
-    #   class User::Component < Proscenium::Phlex
-    #     def view_template
-    #       div class: :@user_name do
-    #         'Joel Moss'
-    #       end
-    #     end
-    #   end
-    #
-    # Additionally, any class name containing a `/` is resolved as a CSS module path. Allowing you
-    # to use the same syntax as a CSS module, but without the need to manually import the CSS file.
-    #
-    # For example, the following will side load the CSS module file at /lib/users.module.css, and
-    # add the CSS Module name `name` to the <div>.
-    #
-    #   class User::Component < Proscenium::Phlex
-    #     def view_template
-    #       div class: '/lib/users@name' do
-    #         'Joel Moss'
-    #       end
-    #     end
-    #   end
-    #
-    # @raise [Proscenium::CssModule::Resolver::NotFound] If a CSS module file is not found for the
-    #   Phlex class file path.
-    def process_attributes(**attributes)
-      if attributes.key?(:class) && (attributes[:class] = tokens(attributes[:class])).include?('@')
-        names = attributes[:class].is_a?(Array) ? attributes[:class] : attributes[:class].split
-
-        self.class.resolved_css_module_paths ||= Concurrent::Set.new
-
-        attributes[:class] = cssm.class_names(*names).map do |name, path|
-          self.class.resolved_css_module_paths << path if path
-          name
-        end
-      end
-
-      attributes
-    end
-  end
-end

data/lib/proscenium/phlex/react_component.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium
-  # Renders a <div> for use with React components, with data attributes specifying the component
-  # path and props.
-  #
-  # If a block is given, it will be yielded within the div, allowing for a custom "loading" UI. If
-  # no block is given, then a "loading..." text will be rendered. It is intended that the component
-  # is mounted to this div, and the loading UI will then be replaced with the component's rendered
-  # output.
-  #
-  # You can pass props to the component in the `:props` keyword argument.
-  class Phlex::ReactComponent < Phlex
-    self.abstract_class = true
-
-    include ReactComponentable
-
-    # Override this to provide your own loading UI.
-    #
-    # @example
-    #   def view_template(**attributes, &block)
-    #     super do
-    #       'Look at me! I am loading now...'
-    #     end
-    #   end
-    #
-    # @yield the given block to a `div` within the top level component div.
-    def view_template(**attributes, &)
-      send(root_tag, **{ data: data_attributes }.deep_merge(attributes), &)
-    end
-  end
-end

data/lib/proscenium/phlex.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'phlex-rails'
-
-module Proscenium
-  class Phlex < ::Phlex::HTML
-    extend ActiveSupport::Autoload
-
-    autoload :CssModules
-    autoload :ReactComponent
-    autoload :AssetInclusions
-
-    include Proscenium::SourcePath
-    include CssModules
-    include AssetInclusions
-
-    module Sideload
-      def before_template
-        Proscenium::SideLoad.sideload_inheritance_chain self,
-                                                        helpers.controller.sideload_assets_options
-
-        super
-      end
-    end
-
-    class_attribute :sideload_assets_options
-
-    class << self
-      attr_accessor :abstract_class
-
-      def inherited(child)
-        child.prepend Sideload
-
-        super
-      end
-
-      def sideload_assets(value)
-        self.sideload_assets_options = value
-      end
-    end
-  end
-end