proscenium 0.11.0.pre.6-arm64-darwin → 0.11.0.pre.8-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e16c640f7e3f07a1a29698ba0da0788bc05b7da96f77b2dcb052c79cae0c2f6
-  data.tar.gz: cb366a06cd0bed0d24eb846a882a320aca309b3cddf3829678e42b1e80d78f9a
+  metadata.gz: c1aeea10539d16ab58dac312b335df36e93a83d7c5a8295a10f219692a317126
+  data.tar.gz: 1d2e3e8a6dd355a16de09434b3cf73376d1573fe5166b902c33db798ed2443d3
 SHA512:
-  metadata.gz: 5fe0935ec4a1231e8bc85d2b5598b32f0276bd9bfe15fe027bc0481996eb1e43f3bff6915186f5b1af866562b037add10c671a871e0f3bc22e7bb389645473a6
-  data.tar.gz: dc36da2d9821fcd0590baa0c75e1ea2c0c24cf0c687581ab8f4e954e840f970310de303ce8edd0e2aa9848c0eb26ac9b61fbc73993bee2967cb1c1d48dfdac66
+  metadata.gz: 8a1b1653b22e4029f86b52bce05960ded6e824568c326a0e3d4fbf2aefe29d9b4538a38f18a13f88f8e16b5a35d7b271bccff4e26246bd2ce4f1cae60b77b41c
+  data.tar.gz: 10ac695efc7f02901ec81b06850f28ca9452d57e8fe1437a877314bfce58a830e14cb1dc0a477ea0f3b800d8ec2c6f2353c84ac9419c41576d556cfcf8a3a925

data/README.md

@@ -757,20 +757,36 @@ Rails.application.config.proscenium.cache_max_age = 12.months.to_i
 
 Proscenium brings back RJS! Any path ending in .rjs will be served from your Rails app. This allows you to import server rendered javascript.
 
-## Serving from Ruby Gem
+## Resolution
 
-*docs needed*
+Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx` from the following directories, and their sub-directories of your Rails application's root: `/app`, `/lib`, `/config`, `/node_modules`, `/vendor`.
 
-## Included Paths
+So a file at `/app/views/users/index.js` will be served from `https://yourapp.com/app/views/users/index.js`.
 
-By default, Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx`, and only from `app/assets`, `config`, `app/views`, `lib` and `node_modules` directories.
+You can continue to access any file in the `/public` directory as you normally would. Proscenium will not process files in the `/public` directory.
 
-However, you can customise these paths with the `include_path` config option...
+If requesting a file that exists in a root directory and the public directory, the file in the public directory will be served. For example, if you have a file at `/lib/foo.js` and `/public/lib/foo.js`, and you request `/lib/foo.js`, the file in the public directory (`/public/lib/foo.js`) will be served.
+
+### Assets from Rails Engines
+
+Proscenium can serve assets from Rails Engines that are installed in your Rails app.
+
+An engine that wants to expose its assets via Proscenium to the application must add Proscenium as a dependency, and add itself to the list of engines in the Proscenium config options `Proscenium.config.engines`.
+
+For example, we have a gem called `gem1` that has Proscenium as a dependency, and exposes a Rails engine. It has some assets that it wants to expose to the application. To do this, it adds itself to the list of engines in the Proscenium config `engines` option:
 
 ```ruby
-Rails.application.config.proscenium.include_paths << 'app/components'
+class Gem1::Engine < ::Rails::Engine
+  config.proscenium.engines << self
+end
 ```
 
+When this gem is installed in any Rails application, its assets will be available at the URL `/gem1/...`. For example, if the gem has a file `lib/styles.css`, it can be requested at `/gem1/lib/styles.css`.
+
+The same directories and file extensions are supported as for the application itself.
+
+It is important to note that the application takes precedence over the gem. So if the application has a file at `/public/gem1/lib/styles.css`, and the gem also has a file at `/lib/styles.css`, then the file in the application will be served. This is because both files would be accessible at the same URL: `/gem1/lib/styles.css`.
+
 ## Thanks
 
 HUGE thanks 🙏 go to [Evan Wallace](https://github.com/evanw) and his amazing [esbuild](https://esbuild.github.io/) project. Proscenium would not be possible without it, and it is esbuild that makes this so fast and efficient.

data/lib/proscenium/builder.rb

@@ -29,6 +29,7 @@ module Proscenium
         :string,      # Proscenium gem root
         :environment, # Rails environment as a Symbol
         :bool,        # code splitting enabled?
+        :string,      # engine names and paths as a JSON string
         :bool         # debugging enabled?
       ], Result.by_value
 
@@ -45,12 +46,17 @@ module Proscenium
     end
 
     class BuildError < StandardError
-      attr_reader :error, :path
+      attr_reader :error
 
-      def initialize(path, error)
-        error = Oj.load(error, mode: :strict).deep_transform_keys(&:underscore)
+      def initialize(error)
+        @error = Oj.load(error, mode: :strict).deep_transform_keys(&:underscore)
 
-        super "Failed to build '#{path}' -- #{error['text']}"
+        msg = @error['text']
+        if (location = @error['location'])
+          msg << " at #{location['file']}:#{location['line']}:#{location['column']}"
+        end
+
+        super msg
       end
     end
 
@@ -82,9 +88,10 @@ module Proscenium
                                Pathname.new(__dir__).join('..', '..').to_s,
                                Rails.env.to_sym,
                                Proscenium.config.code_splitting,
+                               engines.to_json,
                                Proscenium.config.debug)
 
-        raise BuildError.new(path, result[:response]) unless result[:success]
+        raise BuildError, result[:response] unless result[:success]
 
         result[:response]
       end
@@ -116,6 +123,10 @@ module Proscenium
       q ? "--cache-query-string #{q}" : nil
     end
 
+    def engines
+      Proscenium.config.engines.to_h { |e| [e.engine_name, e.root.to_s] }
+    end
+
     def import_map
       return unless (path = Rails.root&.join('config'))
 

data/lib/proscenium/ext/proscenium.h

@@ -97,7 +97,7 @@ extern "C" {
 //	- codeSpitting?
 //	- debug?
 //
-extern struct Result build(char* filepath, char* baseUrl, char* importMap, char* envVars, char* appRoot, char* gemPath, unsigned int env, GoUint8 codeSplitting, GoUint8 debug);
+extern struct Result build(char* filepath, char* baseUrl, char* importMap, char* envVars, char* appRoot, char* gemPath, unsigned int env, GoUint8 codeSplitting, char* engines, GoUint8 debug);
 
 // Resolve the given `path` relative to the `root`.
 //

data/lib/proscenium/helper.rb

@@ -35,7 +35,14 @@ module Proscenium
     alias side_load_stylesheets include_stylesheets
     deprecate side_load_stylesheets: 'Use `include_stylesheets` instead', deprecator: Deprecator.new
 
-    def include_javascripts(**options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # Includes all javascripts that have been imported and side loaded.
+    #
+    # @param extract_lazy_scripts [Boolean] if true, any lazy scripts will be extracted using
+    #   `content_for` to `:proscenium_lazy_scripts` for later use. Be sure to include this in your
+    #   page with the `declare_lazy_scripts` helper, or simply
+    #   `content_for :proscenium_lazy_scripts`.
+    # @return [String] the HTML tags for the javascripts.
+    def include_javascripts(extract_lazy_scripts: false, **options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       out = []
 
       if Rails.application.config.proscenium.code_splitting && Importer.multiple_js_imported?
@@ -66,9 +73,15 @@ module Proscenium
           end
         end
 
-        out << javascript_tag("window.prosceniumLazyScripts = #{scripts.to_json}")
+        if extract_lazy_scripts
+          content_for :proscenium_lazy_scripts do
+            javascript_tag "window.prosceniumLazyScripts = #{scripts.to_json}"
+          end
+        else
+          out << javascript_tag("window.prosceniumLazyScripts = #{scripts.to_json}")
+        end
       else
-        Importer.each_javascript(delete: true) do |path, _path_options|
+        Importer.each_javascript(delete: true) do |path, _|
           out << javascript_include_tag(path, extname: false, **options)
         end
       end
@@ -77,5 +90,9 @@ module Proscenium
     end
     alias side_load_javascripts include_javascripts
     deprecate side_load_javascripts: 'Use `include_javascripts` instead', deprecator: Deprecator.new
+
+    def declare_lazy_scripts
+      content_for :proscenium_lazy_scripts
+    end
   end
 end

data/lib/proscenium/importer.rb

@@ -21,7 +21,7 @@ module Proscenium
     class << self
       # Import the given `filepath`. This is idempotent - it will never include duplicates.
       #
-      # @param filepath [String] Absolute path (relative to Rails root) of the file to import.
+      # @param filepath [String] Absolute URL path (relative to Rails root) of the file to import.
       #   Should be the actual asset file, eg. app.css, some/component.js.
       # @param resolve [String] description of the file to resolve and import.
       # @return [String] the digest of the imported file path if a css module (*.module.css).

data/lib/proscenium/middleware/engines.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Proscenium
+  class Middleware
+    # This middleware handles requests for assets in Rails engines. An engine that wants to expose
+    # its assets via Proscenium to the application must add itself to the list of engines in the
+    # Proscenium config options `Proscenium.config.engines`.
+    #
+    # For example, we have a gem that exposes a Rails engine.
+    #
+    #   module Gem1
+    #     class Engine < ::Rails::Engine
+    #       config.proscenium.engines << self
+    #     end
+    #   end
+    #
+    # When this gem is installed in any Rails application, its assets will be available at the URL
+    # `/gem1/...`. For example, if the gem has a file `lib/styles.css`, it can be requested at
+    # `/gem1/lib/styles.css`.
+    #
+    class Engines < Esbuild
+      def real_path
+        @real_path ||= Pathname.new(@request.path.delete_prefix("/#{engine.engine_name}")).to_s
+      end
+
+      def root_for_readable
+        engine.root
+      end
+
+      def engine
+        @engine ||= Proscenium.config.engines.find do |engine|
+          @request.path.start_with?("/#{engine.engine_name}")
+        end
+      end
+    end
+  end
+end

data/lib/proscenium/middleware/esbuild.rb

@@ -20,9 +20,9 @@ module Proscenium
       end
 
       def attempt
-        render_response Proscenium::Builder.build(path_to_build, root: Rails.root.to_s,
-                                                                 base_url: @request.base_url)
-      rescue Proscenium::Builder::CompileError => e
+        render_response Builder.build(path_to_build, root: Rails.root.to_s,
+                                                     base_url: @request.base_url)
+      rescue Builder::CompileError => e
         raise self.class::CompileError, { file: @request.fullpath, detail: e.message }, caller
       end
     end

data/lib/proscenium/middleware.rb

@@ -9,6 +9,7 @@ module Proscenium
 
     autoload :Base
     autoload :Esbuild
+    autoload :Engines
     autoload :Runtime
     autoload :Url
 
@@ -42,13 +43,19 @@ module Proscenium
     def find_type(request)
       return Url if request.path.match?(%r{^/https?%3A%2F%2F})
       return Runtime if request.path.match?(%r{^/@proscenium/})
+      return Esbuild if Pathname.new(request.path).fnmatch?(app_path_glob, File::FNM_EXTGLOB)
 
-      Esbuild if Pathname.new(request.path).fnmatch?(path_glob, File::FNM_EXTGLOB)
+      Engines if Pathname.new(request.path).fnmatch?(engines_path_glob, File::FNM_EXTGLOB)
     end
 
-    def path_glob
-      paths = Rails.application.config.proscenium.include_paths.join(',')
-      "/{#{paths}}/**.{#{FILE_EXTENSIONS.join(',')}}"
+    def app_path_glob
+      "/{#{Proscenium::ALLOWED_DIRECTORIES}}/**.{#{FILE_EXTENSIONS.join(',')}}"
+    end
+
+    def engines_path_glob
+      names = Proscenium.config.engines.map(&:engine_name)
+
+      "/{#{names.join(',')}}/{#{Proscenium::ALLOWED_DIRECTORIES}}/**.{#{FILE_EXTENSIONS.join(',')}}"
     end
 
     # TODO: handle precompiled assets

data/lib/proscenium/monkey.rb

@@ -3,6 +3,14 @@
 module Proscenium
   # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   module Monkey
+    module DebugView
+      def initialize(assigns)
+        paths = [RESCUES_TEMPLATE_PATH, Rails.root.join('lib', 'templates').to_s]
+        lookup_context = ActionView::LookupContext.new(paths)
+        super(lookup_context, assigns, nil)
+      end
+    end
+
     module TemplateRenderer
       private
 

data/lib/proscenium/phlex.rb

@@ -20,6 +20,7 @@ module Proscenium
     define_output_helper :include_stylesheets
     define_output_helper :side_load_javascripts # deprecated
     define_output_helper :include_javascripts
+    define_output_helper :declare_lazy_scripts
 
     module Sideload
       def before_template

data/lib/proscenium/railtie.rb

@@ -19,7 +19,6 @@ module Proscenium
     config.proscenium.debug = false
     config.proscenium.side_load = true
     config.proscenium.code_splitting = true
-    config.proscenium.include_paths = Set.new(APPLICATION_INCLUDE_PATHS)
 
     # TODO: implement!
     config.proscenium.cache_query_string = Rails.env.production? && ENV.fetch('REVISION', nil)
@@ -30,36 +29,29 @@ module Proscenium
     # defined means a faster build, as esbuild will have less to do.
     config.proscenium.env_vars = Set.new
 
-    # A hash of gems that can be side loaded. Assets from gems listed here can be side loaded.
+    # Rails engines to expose and allow Proscenium to serve their assets.
     #
-    # Because side loading uses URL paths, any gem dependencies that side load assets will fail,
-    # because the URL path will be relative to the application's root, and not the gem's root. By
-    # specifying a list of gems that can be side loaded, Proscenium will be able to resolve the URL
-    # path to the gem's root, and side load the asset.
-    #
-    # Side loading gems rely on NPM and a package.json file in the gem root. This ensures that any
-    # dependencies are resolved correctly. This is required even if your gem has no package
-    # dependencies.
+    # A Rails engine that has assets, can add Proscenium as a gem dependency, and then add itself
+    # to this list. Proscenium will then serve the engine's assets at the URL path beginning with
+    # the engine name.
     #
     # Example:
-    #   config.proscenium.side_load_gems['mygem'] = {
-    #     root: gem_root,
-    #     package_name: 'mygem'
-    #   }
-    config.proscenium.side_load_gems = {}
+    #   class Gem1::Engine < ::Rails::Engine
+    #     config.proscenium.engines << self
+    #   end
+    config.proscenium.engines = Set.new
 
-    initializer 'proscenium.configuration' do |app|
-      options = app.config.proscenium
-      options.include_paths = Set.new(APPLICATION_INCLUDE_PATHS) if options.include_paths.blank?
-    end
+    config.action_dispatch.rescue_templates = {
+      'Proscenium::Builder::BuildError' => 'build_error'
+    }
 
     initializer 'proscenium.middleware' do |app|
       app.middleware.insert_after ActionDispatch::Static, Middleware
-      app.middleware.insert_after ActionDispatch::Static, Rack::ETag, 'no-cache'
-      app.middleware.insert_after ActionDispatch::Static, Rack::ConditionalGet
+      # app.middleware.insert_after ActionDispatch::Static, Rack::ETag, 'no-cache'
+      # app.middleware.insert_after ActionDispatch::Static, Rack::ConditionalGet
     end
 
-    initializer 'proscenium.monkey_views' do
+    initializer 'proscenium.monkey_patches' do
       ActiveSupport.on_load(:action_view) do
         ActionView::TemplateRenderer.prepend Monkey::TemplateRenderer
         ActionView::PartialRenderer.prepend Monkey::PartialRenderer
@@ -77,3 +69,13 @@ module Proscenium
     end
   end
 end
+
+# Monkey path ActionDispatch::DebugView to use our custom error template on BuildError exceptions.
+class ActionDispatch::DebugView
+  def initialize(assigns)
+    paths = [RESCUES_TEMPLATE_PATH,
+             Proscenium::Railtie.root.join('lib', 'proscenium', 'templates').to_s]
+    lookup_context = ActionView::LookupContext.new(paths)
+    super(lookup_context, assigns, nil)
+  end
+end

data/lib/proscenium/resolver.rb

@@ -11,7 +11,9 @@ module Proscenium
     #
     # @param path [String] Can be URL path, file system path, or bare specifier (ie. NPM package).
     # @return [String] URL path.
-    def self.resolve(path) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+    #
+    # rubocop:disable Metrics/*
+    def self.resolve(path)
       self.resolved ||= {}
 
       self.resolved[path] ||= begin
@@ -21,15 +23,8 @@ module Proscenium
 
         if path.start_with?('@proscenium/')
           "/#{path}"
-        elsif (gem = Proscenium.config.side_load_gems.find do |_, x|
-                 path.start_with? "#{x[:root]}/"
-               end)
-          unless (package_name = gem[1][:package_name] || gem[0])
-            # TODO: manually resolve the path without esbuild
-            raise PathResolutionFailed, path
-          end
-
-          Builder.resolve "#{package_name}/#{path.delete_prefix("#{gem[1][:root]}/")}"
+        elsif (engine = Proscenium.config.engines.find { |e| path.start_with? "#{e.root}/" })
+          path.sub(/^#{engine.root}/, "/#{engine.engine_name}")
         elsif path.start_with?("#{Rails.root}/")
           path.delete_prefix Rails.root.to_s
         else
@@ -37,5 +32,6 @@ module Proscenium
         end
       end
     end
+    # rubocop:enable Metrics/*
   end
 end

data/lib/proscenium/templates/rescues/build_error.html.erb

@@ -0,0 +1,27 @@
+<header>
+  <h1>
+    <%= @exception.class.to_s %>
+  </h1>
+</header>
+
+<main role="main" id="container">
+  <%= render "rescues/message_and_suggestions", exception: @exception %>
+
+  <% if @exception.error['location'] %>
+    <div class="source">
+      <div class="data">
+<pre>
+
+    <%= @exception.error['location']['file'] %>:<%= @exception.error['location']['line'] %>:<%= @exception.error['location']['column'] %>
+
+<%= @exception.error['location']['line'].to_s.rjust 5 %> │    <%= @exception.error['location']['line_text'] %>
+      │    <%= (@exception.error['location']['length'] > 1 ? "~" * @exception.error['location']['length'] : "^").rjust(@exception.error['location']['column'] + @exception.error['location']['length']) %>
+<%- if @exception.error['location']['suggestion'].present? -%>    + │    <%= @exception.error['location']['suggestion'].rjust(@exception.error['location']['column'] + 1) %>
+<% else %> <%- end -%>
+</pre>
+      </div>
+    </div>
+  <% end %>
+
+  <%= render template: "rescues/_request_and_response" %>
+</main>

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.11.0.pre.6'
+  VERSION = '0.11.0.pre.8'
 end

data/lib/proscenium.rb

@@ -8,8 +8,7 @@ module Proscenium
   FILE_EXTENSIONS = ['js', 'mjs', 'ts', 'jsx', 'tsx', 'css', 'js.map', 'mjs.map', 'jsx.map',
                      'ts.map', 'tsx.map', 'css.map'].freeze
 
-  APPLICATION_INCLUDE_PATHS = ['config', 'app/assets', 'app/views', 'app/components', 'lib',
-                               'node_modules'].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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.11.0.pre.6
+  version: 0.11.0.pre.8
 platform: arm64-darwin
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,6 +105,7 @@ files:
 - 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
@@ -118,6 +119,7 @@ files:
 - lib/proscenium/resolver.rb
 - lib/proscenium/side_load.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