proscenium 0.10.0-arm64-darwin → 0.11.0-arm64-darwin

data/lib/proscenium/view_component/react_component.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-#
-# Renders a <div> for use with React components, with data attributes specifying the component path
-# and props.
-#
-# If a content block is given, that content will be rendered inside the component, allowing for a
-# "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.
-#
-class Proscenium::ViewComponent::ReactComponent < Proscenium::ViewComponent
-  self.abstract_class = true
+module Proscenium
+  # Renders a <div> for use with React components, with data attributes specifying the component
+  # path and props.
+  #
+  # If a content block is given, that content will be rendered inside the component, allowing for a
+  # "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.
+  class ViewComponent::ReactComponent < ViewComponent
+    self.abstract_class = true
 
-  include Proscenium::Componentable
+    include ReactComponentable
 
-  def call
-    tag.send root_tag, data: data_attributes do
-      tag.div content || 'loading...'
+    def call
+      tag.send root_tag, data: data_attributes do
+        tag.div content || 'loading...'
+      end
     end
   end
 end

data/lib/proscenium/view_component/sideload.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module Proscenium::ViewComponent::Sideload
+end

data/lib/proscenium/view_component.rb

@@ -4,59 +4,29 @@ require 'view_component'
 
 class Proscenium::ViewComponent < ViewComponent::Base
   extend ActiveSupport::Autoload
-  include Proscenium::CssModule
 
-  autoload :TagBuilder
+  autoload :Sideload
   autoload :ReactComponent
+  autoload :CssModules
+
+  include Proscenium::SourcePath
+  include CssModules
 
-  # Side loads the class, and its super classes that respond to `.path`. Assign the `abstract_class`
-  # class variable to any abstract class, and it will not be side loaded. Additionally, if the class
-  # responds to `side_load`, then that method is called.
   module Sideload
     def before_render
-      klass = self.class
-
-      if !klass.abstract_class && respond_to?(:side_load, true)
-        side_load
-        klass = klass.superclass
-      end
-
-      while !klass.abstract_class && klass.respond_to?(:path) && klass.path
-        Proscenium::SideLoad.append klass.path
-        klass = klass.superclass
-      end
+      Proscenium::SideLoad.sideload_inheritance_chain self
 
       super
     end
   end
 
   class << self
-    attr_accessor :path, :abstract_class
+    attr_accessor :abstract_class
 
     def inherited(child)
-      child.path = if caller_locations(1, 1).first.label == 'inherited'
-                     Pathname.new caller_locations(2, 1).first.path
-                   else
-                     Pathname.new caller_locations(1, 1).first.path
-                   end
-
-      child.prepend Sideload if Rails.application.config.proscenium.side_load
+      child.prepend Sideload
 
       super
     end
   end
-
-  # @override Auto compilation of class names to css modules.
-  def render_in(...)
-    cssm.compile_class_names(super(...))
-  end
-
-  private
-
-  # Overrides ActionView::Helpers::TagHelper::TagBuilder, allowing us to intercept the
-  # `css_module` option from the HTML options argument of the `tag` and `content_tag` helpers, and
-  # prepend it to the HTML `class` attribute.
-  def tag_builder
-    @tag_builder ||= Proscenium::ViewComponent::TagBuilder.new(self)
-  end
 end

data/lib/proscenium.rb

@@ -5,19 +5,35 @@ require 'active_support/dependencies/autoload'
 module Proscenium
   extend ActiveSupport::Autoload
 
-  autoload :Current
+  FILE_EXTENSIONS = ['js', 'mjs', 'ts', 'jsx', 'tsx', 'css', 'js.map', 'mjs.map', 'jsx.map',
+                     'ts.map', 'tsx.map', 'css.map'].freeze
+
+  ALLOWED_DIRECTORIES = 'app,lib,config,vendor,node_modules'
+
+  # Environment variables that should always be passed to the builder.
+  DEFAULT_ENV_VARS = Set['RAILS_ENV', 'NODE_ENV'].freeze
+
+  autoload :SourcePath
+  autoload :Utils
+  autoload :Monkey
   autoload :Middleware
+  autoload :EnsureLoaded
   autoload :SideLoad
   autoload :CssModule
-  autoload :Componentable
+  autoload :ReactComponentable
   autoload :ViewComponent
   autoload :Phlex
   autoload :Helper
   autoload :Builder
-
-  def self.reset_current_side_loaded
-    Current.reset
-    Current.loaded = SideLoad::EXTENSIONS.to_h { |e| [e, Set.new] }
+  autoload :Importer
+  autoload :Resolver
+
+  class Deprecator
+    def deprecation_warning(name, message, _caller_backtrace = nil)
+      msg = "`#{name}` is deprecated and will be removed in a near future release of Proscenium"
+      msg << " (#{message})" if message
+      Kernel.warn msg
+    end
   end
 
   class PathResolutionFailed < StandardError
@@ -30,68 +46,6 @@ module Proscenium
       "Path #{@path.inspect} cannot be resolved"
     end
   end
-
-  module Utils
-    module_function
-
-    # @param value [#to_s] The value to create the digest from. This will usually be a `Pathname`.
-    # @return [String] string digest of the given value.
-    def digest(value)
-      Digest::SHA1.hexdigest(value.to_s)[..7]
-    end
-
-    # Resolve the given `path` to a URL path.
-    #
-    # @param path [String] Can be URL path, file system path, or bare specifier (ie. NPM package).
-    # @return [String] URL path.
-    def resolve_path(path) # rubocop:disable Metrics/AbcSize
-      raise ArgumentError, 'path must be a string' unless path.is_a?(String)
-
-      if path.starts_with?('./', '../')
-        raise ArgumentError, 'path must be an absolute file system or URL path'
-      end
-
-      matched_gem = Proscenium.config.side_load_gems.find do |_, opts|
-        path.starts_with?("#{opts[:root]}/")
-      end
-
-      if matched_gem
-        sroot = "#{matched_gem[1][:root]}/"
-        relpath = path.delete_prefix(sroot)
-
-        if (package_name = matched_gem[1][:package_name] || matched_gem[0])
-          return Builder.resolve("#{package_name}/#{relpath}")
-        end
-
-        # TODO: manually resolve the path without esbuild
-        raise PathResolutionFailed, path
-      end
-
-      return path.delete_prefix(Rails.root.to_s) if path.starts_with?("#{Rails.root}/")
-
-      Builder.resolve(path)
-    end
-
-    # Resolves CSS class `names` to CSS module names. Each name will be converted to a CSS module
-    # name, consisting of the camelCased name (lower case first character), and suffixed with the
-    # given `digest`.
-    #
-    # @param names [String, Array]
-    # @param digest: [String]
-    # @returns [Array] of class names generated from the given CSS module `names` and `digest`.
-    def css_modularise_class_names(*names, digest: nil)
-      names.flatten.compact.map { |name| css_modularise_class_name name, digest: digest }
-    end
-
-    def css_modularise_class_name(name, digest: nil)
-      sname = name.to_s
-      if sname.starts_with?('_')
-        "_#{sname[1..].camelize(:lower)}#{digest}"
-      else
-        "#{sname.camelize(:lower)}#{digest}"
-      end
-    end
-  end
 end
 
 require 'proscenium/railtie'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: arm64-darwin
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -36,28 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.16.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.5
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.16.3
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -104,34 +90,41 @@ files:
 - README.md
 - lib/proscenium.rb
 - lib/proscenium/builder.rb
-- lib/proscenium/componentable.rb
 - lib/proscenium/css_module.rb
-- lib/proscenium/css_module/class_names_resolver.rb
-- lib/proscenium/css_module/resolver.rb
-- lib/proscenium/current.rb
+- lib/proscenium/css_module/path.rb
+- lib/proscenium/css_module/transformer.rb
+- lib/proscenium/ensure_loaded.rb
 - lib/proscenium/ext/proscenium
 - lib/proscenium/ext/proscenium.h
 - lib/proscenium/helper.rb
+- lib/proscenium/importer.rb
+- lib/proscenium/libs/react-manager/index.jsx
+- lib/proscenium/libs/react-manager/react.js
 - lib/proscenium/libs/stimulus-loading.js
+- lib/proscenium/libs/test.js
 - lib/proscenium/log_subscriber.rb
 - lib/proscenium/middleware.rb
 - lib/proscenium/middleware/base.rb
+- lib/proscenium/middleware/engines.rb
 - lib/proscenium/middleware/esbuild.rb
+- lib/proscenium/middleware/runtime.rb
 - lib/proscenium/middleware/url.rb
+- lib/proscenium/monkey.rb
 - lib/proscenium/phlex.rb
-- lib/proscenium/phlex/component_concerns.rb
-- lib/proscenium/phlex/page.rb
+- lib/proscenium/phlex/css_modules.rb
 - lib/proscenium/phlex/react_component.rb
-- lib/proscenium/phlex/resolve_css_modules.rb
 - lib/proscenium/railtie.rb
+- lib/proscenium/react_componentable.rb
+- lib/proscenium/resolver.rb
 - lib/proscenium/side_load.rb
-- lib/proscenium/side_load/ensure_loaded.rb
-- lib/proscenium/side_load/helper.rb
-- lib/proscenium/side_load/monkey.rb
+- lib/proscenium/source_path.rb
+- lib/proscenium/templates/rescues/build_error.html.erb
+- lib/proscenium/utils.rb
 - lib/proscenium/version.rb
 - lib/proscenium/view_component.rb
+- lib/proscenium/view_component/css_modules.rb
 - lib/proscenium/view_component/react_component.rb
-- lib/proscenium/view_component/tag_builder.rb
+- lib/proscenium/view_component/sideload.rb
 homepage: https://github.com/joelmoss/proscenium
 licenses:
 - MIT
@@ -155,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: The engine powering your Rails frontend

data/lib/proscenium/componentable.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium::Componentable
-  extend ActiveSupport::Concern
-
-  included do
-    # @return [Hash] the props to pass to the React component.
-    attr_writer :props
-
-    # 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::ViewComponent::ReactComponent
-    #     self.root_tag = :span
-    #   end
-    #
-    # @return [Symbol]
-    class_attribute :root_tag, instance_predicate: false, default: :div
-
-    # Should the template block be forwarded as children to the React component?
-    #
-    # @return [Boolean]
-    class_attribute :forward_children, default: false
-  end
-
-  # @param props: [Hash]
-  def initialize(props: {})
-    @props = props
-
-    super()
-  end
-
-  def virtual_path
-    Proscenium::Utils.resolve_path path.sub_ext('.jsx').to_s
-  end
-
-  private
-
-  def data_attributes
-    d = {
-      proscenium_component_path: virtual_path,
-      proscenium_component_props: prepared_props
-    }
-
-    d[:proscenium_component_forward_children] = true if forward_children?
-
-    d
-  end
-
-  def props
-    @props ||= {}
-  end
-
-  def prepared_props
-    props.deep_transform_keys do |term|
-      # This ensures that the first letter after a slash is not capitalized.
-      string = term.to_s.split('/').map { |str| str.camelize :lower }.join('/')
-
-      # Reverses the effect of ActiveSupport::Inflector.camelize converting slashes into `::`.
-      string.gsub '::', '/'
-    end.to_json
-  end
-end

data/lib/proscenium/css_module/class_names_resolver.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium
-  class CssModule::ClassNamesResolver
-    def initialize(class_names, phlex_path)
-      @class_names = class_names.split
-      @stylesheets = {}
-      @phlex_path = phlex_path.sub_ext('.module.css')
-
-      resolve_class_names
-    end
-
-    def class_names
-      @class_names.join(' ')
-    end
-
-    def stylesheets
-      @stylesheets.map { |_, values| values[:resolved_path] }
-    end
-
-    private
-
-    def resolve_class_names
-      @class_names.map! do |class_name|
-        if class_name.include?('/')
-          if class_name.starts_with?('@')
-            # Scoped bare specifier (eg. "@scoped/package/lib/button@default").
-            _, path, name = class_name.split('@')
-            path = "@#{path}"
-          elsif class_name.starts_with?('/')
-            # Local path with leading slash.
-            path, name = class_name[1..].split('@')
-          else
-            # Bare specifier (eg. "mypackage/lib/button@default").
-            path, name = class_name.split('@')
-          end
-
-          path += '.module.css'
-
-          Utils.css_modularise_class_name name, digest: add_stylesheet(path)[:digest]
-        elsif class_name.starts_with?('@')
-          Utils.css_modularise_class_name class_name[1..],
-                                          digest: add_stylesheet(@phlex_path)[:digest]
-        else
-          class_name
-        end
-      end
-    end
-
-    def add_stylesheet(path)
-      return @stylesheets[path] if @stylesheets.key?(path)
-
-      resolved_path = Utils.resolve_path(path.to_s)
-
-      unless Rails.root.join(resolved_path[1..]).exist?
-        raise CssModule::StylesheetNotFound, resolved_path
-      end
-
-      # Note that the digest is based on the resolved (URL) path, not the original path.
-      @stylesheets[path] = {
-        resolved_path: resolved_path,
-        digest: Utils.digest(resolved_path)
-      }
-    end
-  end
-end

data/lib/proscenium/css_module/resolver.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium
-  class CssModule::Resolver
-    attr_reader :side_loaded_paths
-
-    # @param path [Pathname] Absolute file system path to the Ruby file that will be side loaded.
-    def initialize(path, side_load: true, hash: nil)
-      raise ArgumentError, "'#{path}' must be a `Pathname`" unless path.is_a?(Pathname)
-
-      @path = path
-      @hash = hash
-      @css_module_path = path.sub_ext('.module.css')
-      @side_load = side_load
-      @side_loaded_paths = nil
-    end
-
-    # Parses the given `content` for CSS modules names ('class' attributes beginning with '@'), and
-    # returns the content with said CSS Modules replaced with the compiled class names.
-    #
-    # Example:
-    #   <div class="@my_css_module_name"></div>
-    def compile_class_names(content)
-      doc = Nokogiri::HTML::DocumentFragment.parse(content)
-
-      return content if (modules = doc.css('[class*="@"]')).empty?
-
-      modules.each do |ele|
-        classes = ele.classes.map { |cls| cls.starts_with?('@') ? class_names!(cls[1..]) : cls }
-        ele['class'] = classes.join(' ')
-      end
-
-      doc.to_html.html_safe
-    end
-
-    # Resolves the given CSS class names to CSS modules. This will also side load the stylesheet if
-    # it exists.
-    #
-    # @param names [String, Array]
-    # @returns [Array] of class names generated from the given CSS module `names`.
-    def class_names(*names)
-      side_load_css_module
-      Utils.css_modularise_class_names names, digest: @hash
-    end
-
-    # Like #class_names, but requires that the stylesheet exists.
-    #
-    # @param names [String, Array]
-    # @raises Proscenium::CssModule::NotFound if stylesheet does not exists.
-    # @see #class_names
-    def class_names!(...)
-      raise CssModule::StylesheetNotFound, @css_module_path unless @css_module_path.exist?
-
-      class_names(...)
-    end
-
-    def side_loaded?
-      @side_loaded_paths.present?
-    end
-
-    private
-
-    def side_load_css_module
-      return if !@side_load || !Rails.application.config.proscenium.side_load
-
-      paths = SideLoad.append @path, { '.module.css' => :css }
-
-      @side_loaded_paths = if paths.empty?
-                             nil
-                           else
-                             @hash = Utils.digest(paths[0])
-                             paths
-                           end
-    end
-  end
-end

data/lib/proscenium/current.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/current_attributes'
-
-module Proscenium
-  class Current < ActiveSupport::CurrentAttributes
-    attribute :loaded
-  end
-end

data/lib/proscenium/phlex/component_concerns.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium::Phlex::ComponentConcerns
-  module CssModules
-    extend ActiveSupport::Concern
-    include Proscenium::CssModule
-    include Proscenium::Phlex::ResolveCssModules
-  end
-end

data/lib/proscenium/phlex/page.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'phlex/rails'
-
-# Include this in your view for additional logic for rendering a full HTML page, usually from a
-# controller.
-module Proscenium::Phlex::Page
-  include Phlex::Rails::Helpers::CSPMetaTag
-  include Phlex::Rails::Helpers::CSRFMetaTags
-  include Phlex::Rails::Helpers::FaviconLinkTag
-  include Phlex::Rails::Helpers::PreloadLinkTag
-  include Phlex::Rails::Helpers::StyleSheetLinkTag
-  include Phlex::Rails::Helpers::ActionCableMetaTag
-  include Phlex::Rails::Helpers::AutoDiscoveryLinkTag
-  include Phlex::Rails::Helpers::JavaScriptIncludeTag
-  include Phlex::Rails::Helpers::JavaScriptImportMapTags
-  include Phlex::Rails::Helpers::JavaScriptImportModuleTag
-
-  def self.included(klass)
-    klass.extend(Phlex::Rails::Layout::Interface)
-  end
-
-  def template(&block)
-    doctype
-    html do
-      head
-      body(&block)
-    end
-  end
-
-  private
-
-  def after_template
-    super
-    @_buffer.gsub!('<!-- [SIDE_LOAD_STYLESHEETS] -->', capture { side_load_stylesheets })
-  end
-
-  def page_title
-    Rails.application.class.name.deconstantize
-  end
-
-  def head
-    super do
-      title { page_title }
-
-      yield if block_given?
-
-      csp_meta_tag
-      csrf_meta_tags
-
-      comment { '[SIDE_LOAD_STYLESHEETS]' }
-    end
-  end
-
-  def body
-    super do
-      yield if block_given?
-
-      side_load_javascripts type: :module, defer: true
-    end
-  end
-end

data/lib/proscenium/side_load/ensure_loaded.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-class Proscenium::SideLoad
-  module EnsureLoaded
-    def self.included(child)
-      child.class_eval do
-        append_after_action do
-          if request.format.html? && Proscenium::Current.loaded
-            if Proscenium::Current.loaded[:js].present?
-              raise NotIncludedError, 'There are javascripts to be side loaded, but they have ' \
-                                      'not been included. Did you forget to add the ' \
-                                      '`#side_load_javascripts` helper in your views?'
-            end
-
-            if Proscenium::Current.loaded[:css].present?
-              raise NotIncludedError, 'There are stylesheets to be side loaded, but they have  ' \
-                                      'notbeen included. Did you forget to add the ' \
-                                      '`#side_load_stylesheets` helper in your views?'
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/proscenium/side_load/helper.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium
-  module SideLoad::Helper
-    def side_load_stylesheets(**options)
-      return unless Proscenium::Current.loaded
-
-      out = []
-      Proscenium::Current.loaded[:css].delete_if do |path|
-        out << stylesheet_link_tag(path, extname: false, **options)
-      end
-      out.join("\n").html_safe
-    end
-
-    def side_load_javascripts(**options) # rubocop:disable Metrics/AbcSize
-      return unless Proscenium::Current.loaded
-
-      out = []
-      paths = Proscenium::Current.loaded[:js]
-
-      if Rails.application.config.proscenium.code_splitting && paths.size > 1
-        public_path = Rails.public_path.to_s
-        paths_to_build = []
-        paths.delete_if { |x| paths_to_build << x.delete_prefix('/') }
-
-        result = Proscenium::Builder.build(paths_to_build.join(';'), base_url: request.base_url)
-        result.split(';').each do |x|
-          next if x.include?('public/assets/_asset_chunks/') || x.end_with?('.map')
-
-          out << javascript_include_tag(x.delete_prefix(public_path), extname: false, **options)
-        end
-      else
-        paths.delete_if do |x|
-          out << javascript_include_tag(x, extname: false, **options)
-        end
-      end
-
-      out.join("\n").html_safe
-    end
-  end
-end