proscenium 0.11.0-x86_64-darwin → 0.12.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b812b42986598d6a15007e1e13d2adcb9d2cf0a1a0d21f6dcc31f55f09ca5442
-  data.tar.gz: 8ba3f9efcdb2755711ac5e4a25fccb75c154ad20438cf81d9c958d64ede7e0b2
+  metadata.gz: 76d85fd732a66d80f8104ef66fbf03a77e81b9e68e45ccad767d0b8d3f814c3f
+  data.tar.gz: a47fd7886d8dd72b2efa104e77419ab20dec6a5c218efbca80bb5dfed42cc5d2
 SHA512:
-  metadata.gz: 88fdbe402f861dba96f04e71a4fcf20cffd2ba2577f44596ee2957119f0861addb949d01e572c86ef8c46c4459d113e1e295b8e43cc53d0097b52f34c2731be0
-  data.tar.gz: 9df8ac121aba7bcb468c9ec1a51c27bb20d17d844e7c1af8cf263485f378aae29bec94a11ec169d580e4f641c623f2339b808bf6273bbdfe03b5a747636b29d9
+  metadata.gz: cdf1abe3a0fee2178852ae24b685fb5c92db0c269460884f92d0c40ae634c2fdc4e1a8b7f412d86f8fc2bf660709a2f8776e21c7d97c52335deea7a001a41797
+  data.tar.gz: 54520808bdc76b4e3efa6e696e7eefcdbfae9610564820adbdeef781972bf6b37dc4181642d3e696a781c22f114c046582b1a95389f3bfc391dc1f8a3c11b551

data/README.md

@@ -46,7 +46,8 @@ Proscenium treats your client-side code as first class citizens of your Rails ap
 - [ViewComponent Support](#viewcomponent-support)
 - [Cache Busting](#cache-busting)
 - [rjs is back!](#rjs-is-back)
-- [Included Paths](#included-paths)
+- [Resolution](#resolution)
+  - [Assets from Rails Engines](#assets-from-rails-engines)
 - [Thanks](#thanks)
 - [Development](#development)
 
@@ -237,6 +238,32 @@ body {
 }
 ```
 
+### Unbundling
+
+Sometimes you don't want to bundle an import. For example, you want to ensure that only one instance of React is loaded. In this cases, you can use the `unbundle` prefix
+
+```js
+import React from 'unbundle:react'
+```
+
+This only works any bare and local imports.
+
+You can also use the `unbundle` prefix in your import map, which ensures that all imports of a particular path is always unbundled:
+
+```json
+{
+  "imports": {
+    "react": "unbundle:react"
+  }
+}
+```
+
+Then just import as normal:
+
+```js
+import React from 'react'
+```
+
 ## Import Maps
 
 > **[WIP]**
@@ -644,6 +671,27 @@ class MyView < Proscenium::Phlex
 end
 ```
 
+In your layouts, include `Proscenium::Phlex::AssetInclusions`, and call the `include_assets` helper.
+
+```ruby
+class ApplicationLayout < Proscenium::Phlex
+  include Proscenium::Phlex::AssetInclusions
+
+  def template(&)
+    doctype
+    html do
+      head do
+        title { 'My Awesome App' }
+        include_assets
+      end
+      body(&)
+    end
+  end
+end
+```
+
+You can specifically include CCS and JS assets using the `include_stylesheets` and `include_javascripts` helpers, allowing you to control where they are included in the HTML.
+
 ### Side-loading
 
 Any Phlex class that inherits `Proscenium::Phlex` will automatically be [side-loaded](#side-loading).

data/lib/proscenium/css_module.rb

@@ -18,10 +18,18 @@ module Proscenium::CssModule
   # Accepts one or more CSS class names, and transforms them into CSS module names.
   #
   # @param name [String,Symbol,Array<String,Symbol>]
+  # @return [String] the transformed CSS module names concatenated as a string.
   def css_module(*names)
     cssm.class_names(*names, require_prefix: false).map { |name, _| name }.join(' ')
   end
 
+  # @param name [String,Symbol,Array<String,Symbol>]
+  # @return [String] the transformed CSS module names concatenated as a string.
+  def class_names(*names)
+    names = names.flatten.compact
+    cssm.class_names(*names).map { |name, _| name }.join(' ') unless names.empty?
+  end
+
   private
 
   def cssm

data/lib/proscenium/importer.rb

@@ -79,14 +79,25 @@ module Proscenium
       def each_stylesheet(delete: false)
         return if imported.blank?
 
-        blk = proc { |key, options| key.end_with?(*CSS_EXTENSIONS) && yield(key, options) }
+        blk = proc do |key, options|
+          if key.end_with?(*CSS_EXTENSIONS)
+            yield(key, options)
+            true
+          end
+        end
+
         delete ? imported.delete_if(&blk) : imported.each(&blk)
       end
 
       def each_javascript(delete: false)
         return if imported.blank?
 
-        blk = proc { |key, options| key.end_with?(*JS_EXTENSIONS) && yield(key, options) }
+        blk = proc do |key, options|
+          if key.end_with?(*JS_EXTENSIONS)
+            yield(key, options)
+            true
+          end
+        end
         delete ? imported.delete_if(&blk) : imported.each(&blk)
       end
 

data/lib/proscenium/phlex/asset_inclusions.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Proscenium::Phlex::AssetInclusions
+  include Phlex::Rails::Helpers::ContentFor
+  include Phlex::Rails::Helpers::StyleSheetPath
+  include Phlex::Rails::Helpers::JavaScriptPath
+
+  def include_stylesheets
+    comment { '[PROSCENIUM_STYLESHEETS]' }
+  end
+
+  def include_javascripts(defer_lazy_scripts: false)
+    comment { '[PROSCENIUM_JAVASCRIPTS]' }
+    !defer_lazy_scripts && include_lazy_javascripts
+  end
+
+  def include_lazy_javascripts
+    comment { '[PROSCENIUM_LAZY_SCRIPTS]' }
+  end
+
+  def include_assets(defer_lazy_scripts: false)
+    include_stylesheets
+    include_javascripts(defer_lazy_scripts: defer_lazy_scripts)
+  end
+
+  def after_template
+    super
+
+    @_buffer.gsub! '<!-- [PROSCENIUM_STYLESHEETS] -->', capture_stylesheets!
+    @_buffer.gsub! '<!-- [PROSCENIUM_JAVASCRIPTS] -->', capture_javascripts!
+
+    if content_for?(:proscenium_lazy_scripts)
+      flush
+      @_buffer.gsub!('<!-- [PROSCENIUM_LAZY_SCRIPTS] -->', capture do
+        content_for(:proscenium_lazy_scripts)
+      end)
+    else
+      @_buffer.gsub! '<!-- [PROSCENIUM_LAZY_SCRIPTS] -->', ''
+    end
+  end
+
+  private
+
+  def capture_stylesheets!
+    capture do
+      Proscenium::Importer.each_stylesheet(delete: true) do |path, _path_options|
+        link rel: 'stylesheet', href: stylesheet_path(path, extname: false)
+      end
+    end
+  end
+
+  def capture_javascripts! # rubocop:disable Metrics/*
+    unless Rails.application.config.proscenium.code_splitting &&
+           Proscenium::Importer.multiple_js_imported?
+      return capture do
+        Proscenium::Importer.each_javascript(delete: true) do |path, _|
+          script(src: javascript_path(path, extname: false), type: :module)
+        end
+      end
+    end
+
+    imports = Proscenium::Importer.imported.dup
+    paths_to_build = []
+    Proscenium::Importer.each_javascript(delete: true) do |x, _|
+      paths_to_build << x.delete_prefix('/')
+    end
+
+    result = Proscenium::Builder.build(paths_to_build.join(';'), base_url: helpers.request.base_url)
+
+    # Remove the react components from the results, so they are not side loaded. Instead they
+    # are lazy loaded by the component manager.
+
+    capture do
+      scripts = {}
+      result.split(';').each do |x|
+        inpath, outpath = x.split('::')
+        inpath.prepend '/'
+        outpath.delete_prefix! 'public'
+
+        next unless imports.key?(inpath)
+
+        if (import = imports[inpath]).delete(:lazy)
+          scripts[inpath] = import.merge(outpath: outpath)
+        else
+          script(src: javascript_path(outpath, extname: false), type: :module)
+        end
+      end
+
+      content_for :proscenium_lazy_scripts do
+        script type: 'application/json', id: 'prosceniumLazyScripts' do
+          unsafe_raw scripts.to_json
+        end
+      end
+    end
+  end
+end

data/lib/proscenium/phlex.rb

@@ -8,19 +8,11 @@ module Proscenium
 
     autoload :CssModules
     autoload :ReactComponent
+    autoload :AssetInclusions
 
-    extend ::Phlex::Rails::HelperMacros
-    include ::Phlex::Rails::Helpers::JavaScriptIncludeTag
-    include ::Phlex::Rails::Helpers::StyleSheetLinkTag
     include Proscenium::SourcePath
     include CssModules
 
-    define_output_helper :side_load_stylesheets # deprecated
-    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
         Proscenium::SideLoad.sideload_inheritance_chain self

data/lib/proscenium/railtie.rb

@@ -54,8 +54,8 @@ module Proscenium
 
     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_patches' do

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: x86_64-darwin
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2023-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,6 +111,7 @@ files:
 - lib/proscenium/middleware/url.rb
 - lib/proscenium/monkey.rb
 - lib/proscenium/phlex.rb
+- lib/proscenium/phlex/asset_inclusions.rb
 - lib/proscenium/phlex/css_modules.rb
 - lib/proscenium/phlex/react_component.rb
 - lib/proscenium/railtie.rb
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: The engine powering your Rails frontend