proscenium-phlex 0.1.0

data/gemfiles/rails_8.gemfile.lock

@@ -0,0 +1,361 @@
+PATH
+  remote: ../../proscenium
+  specs:
+    proscenium (0.19.0.beta19)
+      ffi (~> 1.17.0)
+      rails (>= 7.1.0, < 9.0)
+
+PATH
+  remote: ..
+  specs:
+    proscenium-phlex (0.1.0)
+      phlex-rails (~> 1.2.2)
+      prism
+      proscenium (~> 0.19.0.beta19)
+      rails (>= 7.1.0, < 9.0)
+      require-hooks (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    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)
+    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
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    amazing_print (1.8.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    bindex (0.8.1)
+    builder (3.3.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    crass (1.0.6)
+    date (3.4.1)
+    debug (1.11.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.3)
+    erb (5.0.2)
+    erubi (1.13.1)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.13.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    matrix (0.4.3)
+    maxitest (6.0.0)
+      minitest (>= 5.20.0, < 5.26.0)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    minitest-spec-rails (7.4.1)
+      minitest (>= 5.0)
+      railties (>= 4.1)
+    net-imap (0.5.9)
+      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-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-musl)
+      racc (~> 1.4)
+    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)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    psych (5.2.6)
+      date
+      stringio
+    public_suffix (6.0.2)
+    puma (6.6.0)
+      nio4r (~> 2.0)
+    racc (1.8.1)
+    rack (3.1.16)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      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.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    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.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    rdoc (6.14.2)
+      erb
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    require-hooks (0.2.2)
+    rubocop (1.78.0)
+      json (~> 2.3)
+      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.45.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-disable_syntax (0.2.0)
+      lint_roller
+      rubocop (>= 1.72.0)
+    rubocop-minitest (0.38.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-packaging (0.6.0)
+      lint_roller (~> 1.1.0)
+      rubocop (>= 1.72.1, < 2.0)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rails (2.32.0)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sqlite3 (2.7.3-aarch64-linux-gnu)
+    sqlite3 (2.7.3-aarch64-linux-musl)
+    sqlite3 (2.7.3-arm-linux-gnu)
+    sqlite3 (2.7.3-arm-linux-musl)
+    sqlite3 (2.7.3-arm64-darwin)
+    sqlite3 (2.7.3-x86_64-darwin)
+    sqlite3 (2.7.3-x86_64-linux-gnu)
+    sqlite3 (2.7.3-x86_64-linux-musl)
+    stringio (3.1.7)
+    thor (1.4.0)
+    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.3)
+    useragent (0.16.11)
+    web-console (4.2.1)
+      actionview (>= 6.0.0)
+      activemodel (>= 6.0.0)
+      bindex (>= 0.4.0)
+      railties (>= 6.0.0)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  amazing_print
+  appraisal
+  capybara
+  debug
+  maxitest
+  minitest-focus
+  minitest-spec-rails
+  proscenium!
+  proscenium-phlex!
+  puma
+  rails (~> 8.0.1)
+  rubocop-capybara
+  rubocop-disable_syntax
+  rubocop-minitest
+  rubocop-packaging
+  rubocop-performance
+  rubocop-rails
+  rubocop-rake
+  sqlite3
+  web-console
+
+BUNDLED WITH
+   2.6.8

data/lib/proscenium/phlex/abstract_class.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Proscenium::Phlex
+  module AbstractClass
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_accessor :abstract_class
+    end
+  end
+end

data/lib/proscenium/phlex/css_module_rewriter.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'prism'
+require 'require-hooks/setup'
+
+module Proscenium::Phlex
+  class CssModuleRewriter
+    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

data/lib/proscenium/phlex/css_modules.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Proscenium::Phlex
+  module CssModules
+    extend ActiveSupport::Concern
+
+    included do
+      include Proscenium::CssModule
+      include Proscenium::SourcePath
+      extend Proscenium::CssModule::Path
+    end
+
+    class_methods do
+      # 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/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+
+module Proscenium
+  module Phlex
+    # @api private
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/proscenium/phlex/include_assets.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Proscenium::Phlex
+  module IncludeAssets
+    extend ActiveSupport::Concern
+    include AbstractClass
+
+    def include_stylesheets
+      comment { '[PROSCENIUM_STYLESHEETS]' }
+    end
+
+    def include_javascripts
+      comment { '[PROSCENIUM_JAVASCRIPTS]' }
+    end
+
+    def include_assets
+      include_stylesheets
+      include_javascripts
+    end
+  end
+end

data/lib/proscenium/phlex/react.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Proscenium::Phlex
+  # 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.
+  module React
+    extend ActiveSupport::Concern
+    include Sideload
+    include Proscenium::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/sideload.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Proscenium::Phlex
+  module Sideload
+    extend ActiveSupport::Concern
+    include AbstractClass
+
+    included do
+      include Proscenium::SourcePath
+      class_attribute :sideload_assets_options
+    end
+
+    class_methods do
+      def sideload_assets(value)
+        self.sideload_assets_options = value
+      end
+    end
+
+    def before_template
+      Proscenium::SideLoad.sideload_inheritance_chain self,
+                                                      helpers.controller.sideload_assets_options
+
+      super
+    end
+  end
+end

data/lib/proscenium/phlex/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Proscenium
+  module Phlex
+    VERSION = '0.1.0'
+  end
+end

data/lib/proscenium/phlex.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'proscenium'
+require 'proscenium/phlex/engine'
+require 'phlex-rails'
+
+module Proscenium
+  module Phlex
+    class Error < StandardError; end
+
+    autoload :AbstractClass, 'proscenium/phlex/abstract_class'
+    autoload :IncludeAssets, 'proscenium/phlex/include_assets'
+    autoload :Sideload, 'proscenium/phlex/sideload'
+    autoload :CssModules, 'proscenium/phlex/css_modules'
+    autoload :CssModuleRewriter, 'proscenium/phlex/css_module_rewriter'
+    autoload :React, 'proscenium/phlex/react'
+  end
+end

data/lib/proscenium-phlex.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'proscenium/phlex'