proscenium 0.11.0.pre.5-aarch64-linux → 0.11.0.pre.7-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f479570196d4e7c1cb3c1ea4855581f3388a49853e59d491eb48acee127fcff7
-  data.tar.gz: 7f7146d3eb68f3621be0d349845b9f5117335c5cf28f3918b0449cf405d7f312
+  metadata.gz: e1ee6cce6b3894e20caf601ef5773c0590f1f45294caddbf3bb9c1a928e58442
+  data.tar.gz: b7632f5101baaf4b817549e6996e89cff43bfc5cbcb82231779c35103675e278
 SHA512:
-  metadata.gz: dd703b0fca83a1e6fe8e274b81c6452f626d8fcd615a1a5feb8b1f1701242c9f7db7848d9af5c8c82bbcf12d326fddb4ef4ec189134f11cca6583909ec948b4a
-  data.tar.gz: c1ff9a6b6ec73352ecd395bbfd49a6df13044109fa902fb48ca8aa2691e6406ead5c46c436581c668993f7663ec4261f4591426163f42ddb60448092e17bb363
+  metadata.gz: 13d5ee5faaf01aa581320381983e7b86f331afd9ab56c1298384ac36b804f541acd4e5cfe673ef26b505ec310237768a13b09bdbd57b8d547b9ae11310c1de73
+  data.tar.gz: 55b6b9c95b56f7f478272c4ea4d3bf450806a793af869d609250ca0032bf37307aaf0e0dd9dfc377d406b9c392c08174c712daa52f0d5a4c0579aa67223d3388

data/README.md

@@ -757,19 +757,18 @@ 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
-
-*docs needed*
 
 ## Included Paths
 
-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.
+Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx` from the following directories, and their sub-directories: `/app`, `/lib`, `/config`, `/node_modules`, `/vendor`.
 
-However, you can customise these paths with the `include_path` config option...
+So a file at `/app/views/users/index.js` will be served from `https://yourapp.com/app/views/users/index.js`.
 
-```ruby
-Rails.application.config.proscenium.include_paths << 'app/components'
-```
+You can continue to access any file in the `/public` directory as you normally would, but any file ending with a supported extension (`js,mjs,ts,css,jsx,tsx`) will be processed by Proscenium. For example, `/public/some/file.js` will be served from `https://yourapp.com/some/file.js`.
+
+## Serving from Ruby Gems and Rails Engines
+
+Proscenium can serve assets from Ruby Gems and Rails Engines.
 
 ## Thanks
 

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/libs/react-manager/index.jsx

@@ -31,27 +31,31 @@ function init() {
       "prosceniumComponentForwardChildren" in element.dataset &&
       element.innerHTML !== "";
 
-    Promise.all([react, Component]).then(([r, c]) => {
-      if (proscenium.env.RAILS_ENV === "development") {
-        console.groupCollapsed(
-          `[proscenium/react/manager] 🔥 %o mounted!`,
-          path
-        );
-        console.log("props: %o", props);
-        console.groupEnd();
-      }
+    Promise.all([react, Component])
+      .then(([r, c]) => {
+        if (proscenium.env.RAILS_ENV === "development") {
+          console.groupCollapsed(
+            `[proscenium/react/manager] 🔥 %o mounted!`,
+            path
+          );
+          console.log("props: %o", props);
+          console.groupEnd();
+        }
 
-      let component;
-      if (forwardChildren) {
-        component = r.createElement(c.default, props, element.innerHTML);
-      } else if (children) {
-        component = r.createElement(c.default, props, children);
-      } else {
-        component = r.createElement(c.default, props);
-      }
+        let component;
+        if (forwardChildren) {
+          component = r.createElement(c.default, props, element.innerHTML);
+        } else if (children) {
+          component = r.createElement(c.default, props, children);
+        } else {
+          component = r.createElement(c.default, props);
+        }
 
-      r.createRoot(element).render(component);
-    });
+        r.createRoot(element).render(component);
+      })
+      .catch((error) => {
+        console.error("[proscenium/react/manager] %o - %o", path, error);
+      });
   }
 
   Array.from(elements, (element) => {

data/lib/proscenium/middleware.rb

@@ -43,12 +43,11 @@ module Proscenium
       return Url if request.path.match?(%r{^/https?%3A%2F%2F})
       return Runtime if request.path.match?(%r{^/@proscenium/})
 
-      Esbuild if Pathname.new(request.path).fnmatch?(path_glob, File::FNM_EXTGLOB)
+      Esbuild if Pathname.new(request.path).fnmatch?(app_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.join(',')}}/**.{#{FILE_EXTENSIONS.join(',')}}"
     end
 
     # TODO: handle precompiled assets

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)
@@ -48,11 +47,6 @@ module Proscenium
     #   }
     config.proscenium.side_load_gems = {}
 
-    initializer 'proscenium.configuration' do |app|
-      options = app.config.proscenium
-      options.include_paths = Set.new(APPLICATION_INCLUDE_PATHS) if options.include_paths.blank?
-    end
-
     initializer 'proscenium.middleware' do |app|
       app.middleware.insert_after ActionDispatch::Static, Middleware
       app.middleware.insert_after ActionDispatch::Static, Rack::ETag, 'no-cache'

data/lib/proscenium/react_componentable.rb

@@ -38,13 +38,14 @@ module Proscenium
       class_attribute :lazy, default: false
 
       class_attribute :loader
+
+      # @return [String] the URL path to the component manager.
+      class_attribute :manager, default: '/@proscenium/react-manager/index.jsx'
     end
 
     class_methods do
-      # Import only the component manager. The component itself is side loaded in the initializer,
-      # so that it can be lazy loaded based on the value of the `lazy` instance variable.
       def sideload
-        Importer.import resolve: '@proscenium/react-manager/index.jsx'
+        Importer.import manager
         Importer.sideload source_path, lazy: true
       end
     end

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.11.0.pre.5'
+  VERSION = '0.11.0.pre.7'
 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 = %w[app lib config vendor node_modules].freeze
 
   # 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.5
+  version: 0.11.0.pre.7
 platform: aarch64-linux
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport