proscenium 0.11.0-x86_64-linux → 0.13.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6d0b7bc727c5204adc7752cea2888dab566c2831b547069101706c0385969c1
-  data.tar.gz: dd6c21954e8ab827c65e215db2dfc6d095672b28442db5b0ff54296cddd1d421
+  metadata.gz: 8b06b3f27b0e88ebb7099a1808384cddb0571d3076ad837639da2a35961c1d54
+  data.tar.gz: 70f56abacaed489a8811632e80cd7e8c35a79299f3a2a92b7f2a37bf317f46dd
 SHA512:
-  metadata.gz: 127ef4f1d15c73aca068cd303c3a59685f9ed762e9e56bc2624800fa8cfac890ee2d7ab9b3420029eb3f15049e02ad015954f06cf5c5bb72343461a438e14fb1
-  data.tar.gz: 6e9875c9cbe9b26310fd2373b875c9c87c36b12c06790f6b7a150b84b6ea74c2d5e2e401b643e2447b5a2f8092704543e6861470f608768b8fcc2af670f8c23d
+  metadata.gz: 8f6752edbf44f243a3b81f852f5d825ea206140fbf2b2d595834ed9af7b8780284370cd4ab643f44f4ed030996a9d0a3afc2ebe71affc70557f3b6e156531f17
+  data.tar.gz: 46751b69cdbfc67faf5964f360e8b66a1fbb34958368a1fbb48bdc67c93a63b177c8c5daedd86f39101dd2e2f269a878277b3b8a979f1b8e121efe0c5bac9af3

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]**
@@ -525,6 +552,13 @@ css_module 'mypackage/button@big_button'
 # => "big_button"
 ```
 
+`css_module` also accepts a `path` keyword argument, which allows you to specify the path to the CSS
+file. Note that this will use the given path for all class names passed to that instance of `css_module`.
+
+```ruby
+css_module :my_module_name, path: Rails.root.join('app/components/button.css')
+```
+
 #### In your JavaScript
 
 Importing a CSS module from JS will automatically append the stylesheet to the document's head. And the result of the import will be an object of CSS class to module names.
@@ -644,6 +678,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,8 +18,20 @@ module Proscenium::CssModule
   # Accepts one or more CSS class names, and transforms them into CSS module names.
   #
   # @param name [String,Symbol,Array<String,Symbol>]
-  def css_module(*names)
-    cssm.class_names(*names, require_prefix: false).map { |name, _| name }.join(' ')
+  # @param path [Pathname] the path to the CSS module file to use for the transformation.
+  # @return [String] the transformed CSS module names concatenated as a string.
+  def css_module(*names, path: nil)
+    transformer = path.nil? ? cssm : Transformer.new(path)
+    transformer.class_names(*names, require_prefix: false).map { |name, _| name }.join(' ')
+  end
+
+  # @param name [String,Symbol,Array<String,Symbol>]
+  # @param path [Pathname] the path to the CSS file to use for the transformation.
+  # @return [String] the transformed CSS module names concatenated as a string.
+  def class_names(*names, path: nil)
+    names = names.flatten.compact
+    transformer = path.nil? ? cssm : Transformer.new(path)
+    transformer.class_names(*names).map { |name, _| name }.join(' ') unless names.empty?
   end
 
   private

data/lib/proscenium/helper.rb

@@ -20,11 +20,24 @@ module Proscenium
     #
     # @see CssModule::Transformer#class_names
     # @param name [String,Symbol,Array<String,Symbol>]
-    def css_module(*names)
-      path = Pathname.new(@lookup_context.find(@virtual_path).identifier).sub_ext('')
-      CssModule::Transformer.new(path).class_names(*names, require_prefix: false).map do |name, _|
-        name
-      end.join(' ')
+    # @param path [Pathname] the path to the CSS module file to use for the transformation.
+    # @return [String] the transformed CSS module names concatenated as a string.
+    def css_module(*names, path: nil)
+      path ||= Pathname.new(@lookup_context.find(@virtual_path).identifier).sub_ext('')
+      CssModule::Transformer.new(path).class_names(*names, require_prefix: false)
+                            .map { |name, _| name }.join(' ')
+    end
+
+    # @param name [String,Symbol,Array<String,Symbol>]
+    # @param path [Pathname] the path to the CSS file to use for the transformation.
+    # @return [String] the transformed CSS module names concatenated as a string.
+    def class_names(*names, path: nil)
+      names = names.flatten.compact
+
+      return if names.empty?
+
+      path ||= Pathname.new(@lookup_context.find(@virtual_path).identifier).sub_ext('')
+      CssModule::Transformer.new(path).class_names(*names).map { |name, _| name }.join(' ')
     end
 
     def include_stylesheets(**options)

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.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: x86_64-linux
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2023-11-17 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.22
 signing_key:
 specification_version: 4
 summary: The engine powering your Rails frontend