proscenium 0.11.0.pre.6-x86_64-linux → 0.11.0.pre.7-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7c4c3587d91fca2d7f7300e1e9e459e23bd6994bc5a1b5fd26082cb587aaab5
-  data.tar.gz: cc88859e91b00f94d1971c2a73e8993f00a7979ce3bf2cf535d764d3a2ca4451
+  metadata.gz: 88c960e2cb342e9d27c84cfc7f14545e9c900876d64c7ae27db96e9c470d387f
+  data.tar.gz: 18c2090d81ccfb1d012d4c8c2a5a72ef66d76555eb3def406dddd17726264238
 SHA512:
-  metadata.gz: 5c574ba7c71e93edfcebf6ddde384d710e382be2c03330e56052c90b17c6d0f5ffea47c8c2f5aadda7639a5da694ec653dfb4df948a8f3fa2bde01d52b2b49cc
-  data.tar.gz: 53d44c13043cfd41b780cb360884188702af5a809acf8b9abc11631e128f425578b32c5febe1eacc719e3e361cf272a56af65020c1b2d3b4ff722c43772eb6ec
+  metadata.gz: 63ab8a8d80c739cbafaf8f2f5f3b51eb321a856fc5aed3e4aaf5d92b7574b8d0310ce8b476cf7faa09bc104a3365895c67789b70cb86ac8ea61a4cc542e8a644
+  data.tar.gz: e301f752d5a149daf30c11a4c0de268c37a1a5af69761cb92721c8d1850dd25aa43fa895c3fcda566bea2794c6ce9db0a7b353f63567272ab628498ace7df3ee

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/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/version.rb

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