proscenium 0.19.0.beta20-aarch64-linux → 0.20.1-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8800c8cdac40a504951a4f4c6991d695d84cc417c9e70a0fd7881c35c40b1e
-  data.tar.gz: ab7f98fd1e9babd944cae54ff4e025d24c2bb1ac1705a5b6ba3fec4cff1d1796
+  metadata.gz: 28ed5747f1236ed671362608d6b583222e16caa7470ea346b36022b5d5a39bb1
+  data.tar.gz: 46da7b18e904838d58c1b254fe682a241edc063ab42a03b104217f74fff43f29
 SHA512:
-  metadata.gz: 066161a3dddcb31dc76144124a6c96a5e169dae975aab3e7a100d9b5f067e1bff5b8dee35a9dd9df35369cb5fdb5e3ba2ed6ba96afbb8b39e3f82b4fd062878f
-  data.tar.gz: dca021c7c4849048db4cbd942ab18c072cce5a14a0bf0cf93daa9dd724620c874bfa25170410b742ff6aeec5a8b4f5f717f4b34431bfff68adce155a35e01b78
+  metadata.gz: 505967944874552217043231ae8995bd4fbff5268c3586ebc0b7b9cf61c2cd186e5bf9d467ed4b654e0e4eb2e0b4a44e61e85827dbbdc8064efbd5e26536ae21
+  data.tar.gz: af7dc7cff7cae2cd668c65399cd779f1d7c5e141749cd8ab66d0aff2e06212da36e5a7a3a4a8c5611d5e68c566f62f0c578e498b81c0ec84943789116de980ba

data/README.md

@@ -6,17 +6,17 @@
 >
 > - _the part of a theatre stage in front of the curtain._
 
-**_Proscenium_** treats your frontend and client-side code as first class citizens of your Rails app, and assumes a "fast by default" internet. It bundles and minifies JavaScript (+ JSX), TypeScript (+TSX) and CSS in real time, on demand, and with zero configuration.
+**_Proscenium_** treats your frontend and client-side code as first class citizens of your Rails app, and assumes a "fast by default" internet. It bundles and minifies JavaScript (+JSX), TypeScript (+TSX) and CSS in real time, on demand, and with zero configuration.
 
 **The highlights:**
 
 - Fast, real-time bundling, tree-shaking, code-splitting and minification of Javascript (.js,.jsx), Typescript (.ts,.tsx) and CSS (.css).
 - NO JavaScript runtime needed (eg. Node) - just the browser!
 - NO build step or pre-compilation.
-- NO additional process or server - Just run `rails s`!
+- NO additional process or server - Just run `rails server`!
 - Transforms newer JavaScript and CSS syntax to older syntax for older browsers.
 - Deep integration with Rails.
-- Automatically side-load your layouts, views, and partials.
+- Automatically side-load JS and CSS for your layouts, views, and partials.
 - Import from NPM, URL's, and locally.
 - Server-side import map support.
 - CSS Modules & mixins.
@@ -75,15 +75,15 @@ gem 'proscenium'
 
 Please note that Proscenium is designed solely for use with Rails.
 
-Now if you start your Rails app, you can open any front end code (JS, CSS, etc.). For example, a file at `app/assets/stylesheets/application.css` can be accessed at `https://localhost:3000/app/assets/stylesheets/application.css`, which will be bundled, transformed, and minified [in production] in real time.
+Now if you start your Rails app, you can open any front end code (JS, CSS, etc.). For example, a file at `app/assets/stylesheets/application.css` can be accessed at `https://localhost:3000/app/assets/stylesheets/application.css`, which will be transformed, bundled, and minified [in production] in real time.
 
 ## Client-Side Code Anywhere
 
-Proscenium believes that your frontend code is just as important as your backend code, and is not an afterthought - they should be first class citizens of your Rails app. So instead of having to throw all your JS and CSS into a "app/assets" directory, and then requiring a separate process to compile or bundle, just put them wherever you want within your app, and just run Rails!
+Proscenium believes that your frontend code is just as important as your backend code, and is not an afterthought - they should be first class citizens of your Rails app. So instead of having to throw all your JS and CSS into a "app/assets" directory, and then requiring a separate process to compile or bundle, you can simply put them wherever you want within your app, and just run Rails!
 
 For example, if you have some JS that is required by your `app/views/users/index.html.erb` view, just create a JS file alongside it at `app/views/users/index.js`. Or if you have some CSS that is used by your entire application, put it in `app/views/layouts/application.css` and load it alongside your layout. Maybe you have a few JS utility functions, so put them in `lib/utils.js`.
 
-Simply put your JS(X) and CSS anywhere you want, and they will be served by your Rails app from the location where you placed them.
+Simply put your JS(X) and CSS anywhere you want, and they will be served by your Rails app from the same location where you placed them.
 
 Using the examples above...
 
@@ -95,15 +95,15 @@ Using the examples above...
 
 ## Side Loading
 
-Proscenium is best experienced when your assets are automtically side loaded.
+Proscenium is best experienced when your assets are automatically side loaded.
 
 ### The Problem
 
-With Rails you would typically declaratively load your JavaScript and CSS assets using the `javascript_include_tag` and `stylesheet_link_tag` helpers.
+With Rails you would typically load your JavaScript and CSS assets declaratively using the `javascript_include_tag` and `stylesheet_link_tag` helpers.
 
-For example, you may have top-level "application" CSS located in a file at `/app/assets/stylesheets/application.css`. Likewise, you may have some global JavaScript located in a file at `/app/javascript/application.js`.
+For example, you may have top-level "application" styles located in a file at `/app/assets/stylesheets/application.css`. Likewise, you may have some global JavaScript located in a file at `/app/javascript/application.js`.
 
-You would manually and declaratively include those two files in your application layout, something like this:
+You would manually and declaratively include those two files in each of your layouts, something like this:
 
 ```erb
 <%# /app/views/layouts/application.html.erb %>
@@ -141,7 +141,9 @@ The main problem is that you have to keep track of all these assets, and make su
 
 When side loading your JavaScript, Typescript and CSS with Proscenium, they are automatically included alongside your views, partials, layouts, and components, and only when needed.
 
-Side loading works by looking for a JS/TS/CSS file with the same name as your view, partial, layout or component. For example, if you have a view at `app/views/users/index.html.erb`, then Proscenium will look for a JS/TS/CSS file at `app/views/users/index.js`, `app/views/users/index.ts` or `app/views/users/index.css`. If it finds one, it will include it in the HTML for that view.
+Side loading works by looking for a JS/TS/CSS file with the same name as your view, partial, layout or component. For example, if you have a view at `app/views/users/index.html.erb`, then Proscenium will look for a JS and CSS file at `app/views/users/index.js` (or TypeScript with a .ts extension) and `app/views/users/index.css`. If it finds one, it will automatically include it in the HTML for that view. And only for that view.
+
+This allows you to keep your assets organized alongside the views, partials, and components that use them, without having to manually track and include them. It also means only the assets that are needed are included.
 
 JSX is also supported for JavaScript and Typescript. Simply use the `.jsx` or `.tsx` extension instead of `.js` or `.ts`.
 
@@ -272,6 +274,14 @@ Then just import as normal:
 import React from "react";
 ```
 
+Or if you don't want any bundling at all, simply turn it off application-wide:
+
+```ruby
+config.proscenium.bundle = false
+```
+
+This will mean every asset and import will be loaded independently.
+
 ## Import Maps
 
 > **[WIP]**
@@ -405,13 +415,17 @@ if (typeof proscenium.env?.UNKNOWN !== "undefined") {
 
 ## i18n
 
-Basic support is provided for importing your Rails locale files from `config/locales/*.yml`, exporting them as JSON.
+Support is provided for importing your Rails locale files from `config/locales/*.yml`, exporting them as JSON.
 
 ```js
 import translations from "proscenium/i18n";
 // translations.en.*
 ```
 
+If you have multiple locale files, they will be merged together. into one json object.
+
+Note that because it is assumed that you will be consuming these translations in the browser, all keys are converted to camelCase, as per the JavaScript conventions.
+
 ## Javascript
 
 By default, Proscenium's output will take advantage of all modern JS features from the ES2022 spec and earlier. For example, `a !== void 0 && a !== null ? a : b` will become `a ?? b` when minifying (enabled by default in production), which makes use of syntax from the ES2020 version of JavaScript. Any syntax feature that is not supported by ES2020 will be transformed into older JavaScript syntax that is more widely supported.
@@ -441,8 +455,6 @@ one();
 
 ### Code Splitting
 
-> Available in `>=0.10.0`.
-
 [Side loaded](#side-loading) assets are automatically code split. This means that if you have a file that is imported and used imported several times, and by different files, it will be split off into a separate file.
 
 As an example:
@@ -682,8 +694,6 @@ console.log(version);
 
 ## Cache Busting
 
-> _COMING SOON_
-
 By default, all assets are not cached by the browser. But if in production, you populate the `REVISION` env variable, all CSS and JS URL's will be appended with its value as a query string, and the `Cache-Control` response header will be set to `public` and a max-age of 30 days.
 
 For example, if you set `REVISION=v1`, URL's will be appended with `?v1`: `/my/imported/file.js?v1`.

data/lib/proscenium/builder.rb

@@ -16,6 +16,7 @@ module Proscenium
 
     module Request
       extend FFI::Library
+
       ffi_lib Pathname.new(__dir__).join('ext/proscenium').to_s
 
       enum :environment, [:development, 1, :test, :production]

data/lib/proscenium/css_module/transformer.rb

@@ -70,7 +70,7 @@ module Proscenium
       digest = Importer.import(resolved_path)
 
       transformed_path = ''
-      transformed_path = "__#{resolved_path[1..].gsub(%r{[@/\.+]}, '-')}" if Rails.env.development?
+      transformed_path = "__#{resolved_path[1..].gsub(%r{[@/.+]}, '-')}" if Rails.env.development?
       transformed_name = name.to_s
       transformed_name = if transformed_name.start_with?('_')
                            "_#{transformed_name[1..]}-#{digest}#{transformed_path}"

data/lib/proscenium/helper.rb

@@ -40,18 +40,6 @@ module Proscenium
                             .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_assets
       include_stylesheets + include_javascripts
     end

data/lib/proscenium/importer.rb

@@ -98,7 +98,7 @@ module Proscenium
         end
 
         # Ensures extensions with more than one dot are handled correctly.
-        filepath = filepath.sub_ext('')
+        filepath = filepath.sub_ext('').sub_ext('')
 
         sideloaded = []
 

data/lib/proscenium/middleware.rb

@@ -13,10 +13,6 @@ module Proscenium
 
     def initialize(app)
       @app = app
-
-      chunks_path = Rails.public_path.join('assets').to_s
-      headers = Rails.application.config.public_file_server.headers || {}
-      @chunk_handler = ::ActionDispatch::FileHandler.new(chunks_path, headers:)
     end
 
     def call(env)
@@ -24,23 +20,19 @@ module Proscenium
 
       return @app.call(env) if !request.get? && !request.head?
 
+      # If this is a request for an asset chunk, we want to serve it with a very long
+      # cache lifetime, since these are content-hashed and will never change.
       if request.path.match?(%r{^/_asset_chunks/})
-        response = Rack::Response[*@chunk_handler.attempt(request.env)]
-        response.etag = request.path.match(/-\$([a-z0-9]+)\$/i)[1]
-
-        if Proscenium.config.cache_query_string && Proscenium.config.cache_max_age
-          response.cache! Proscenium.config.cache_max_age
-        end
-
-        if request.fresh?(response)
-          response.status = 304
-          response.body = []
-        end
-
-        return response.finish
+        ::ActionDispatch::FileHandler.new(
+          Rails.public_path.join('assets').to_s,
+          headers: {
+            'Cache-Control' => "public, max-age=#{100.years}, immutable",
+            'etag' => request.path.match(/-\$([a-z0-9]+)\$/i)[1]
+          }
+        ).attempt(env) || @app.call(env)
+      else
+        attempt(request) || @app.call(env)
       end
-
-      attempt(request) || @app.call(env)
     end
 
     private

data/lib/proscenium/monkey.rb

@@ -9,11 +9,11 @@ module Proscenium
         result = super
         return result if !view.controller || !Proscenium.config.side_load
 
-        to_sideload = if template.respond_to?(:virtual_path) &&
+        to_sideload = if template.respond_to?(:identifier) &&
                          template.respond_to?(:type) && template.type == :html
                         template
                       end
-        if to_sideload
+        if to_sideload && view.controller.respond_to?(:sideload_assets_options)
           options = view.controller.sideload_assets_options
           layout = find_layout(layout_name, locals.keys, [formats.first])
           sideload_template_assets layout, view.controller, options if layout
@@ -24,6 +24,8 @@ module Proscenium
       end
 
       def sideload_template_assets(tpl, controller, options)
+        return unless (tpl_path = Pathname.new(tpl.identifier)).file?
+
         options = {} if options.nil?
         options = { js: options, css: options } unless options.is_a?(Hash)
 
@@ -40,7 +42,7 @@ module Proscenium
           options[k] = controller.instance_eval(&options[k]) if options[k].is_a?(Proc)
         end
 
-        Importer.sideload Rails.root.join("app/views/#{tpl.virtual_path}"), **options
+        Importer.sideload tpl_path, **options
       end
     end
 
@@ -52,8 +54,9 @@ module Proscenium
 
         return result if !view.controller || !Proscenium.config.side_load
 
-        if template.respond_to?(:virtual_path) &&
-           template.respond_to?(:type) && template.type == :html
+        if template.respond_to?(:identifier) &&
+           template.respond_to?(:type) && template.type == :html &&
+           view.controller.respond_to?(:sideload_assets_options)
           options = view.controller.sideload_assets_options
           sideload_template_assets layout, options if layout
           sideload_template_assets template, options
@@ -63,6 +66,8 @@ module Proscenium
       end
 
       def sideload_template_assets(tpl, options)
+        return unless (tpl_path = Pathname.new(tpl.identifier)).file?
+
         options = {} if options.nil?
         options = { js: options, css: options } unless options.is_a?(Hash)
 
@@ -79,7 +84,7 @@ module Proscenium
           options[k] = controller.instance_eval(&options[k]) if options[k].is_a?(Proc)
         end
 
-        Importer.sideload Rails.root.join("app/views/#{tpl.virtual_path}"), **options
+        Importer.sideload tpl_path, **options
       end
     end
   end

data/lib/proscenium/side_load.rb

@@ -134,7 +134,7 @@ module Proscenium
         # in the ancestry is also sideloaded in addition to the regular CSS files. This is because
         # the CSS module digest will be different for each file, so we only sideload the first CSS
         # module.
-        css_imports.each do |it|
+        css_imports.each do |it| # rubocop:disable Style/ItAssignment
           break if Importer.sideload_css_module(it, **options).present?
         end
 
@@ -143,7 +143,7 @@ module Proscenium
         # The reason why we sideload CSS after JS is because the order of CSS is important.
         # Basically, the layout should be loaded before the view so that CSS cascading works in the
         # right direction.
-        css_imports.reverse_each do |it|
+        css_imports.reverse_each do |it| # rubocop:disable Style/ItAssignment
           Importer.sideload_css it, **options
         end
       end

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.19.0.beta20'
+  VERSION = '0.20.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.19.0.beta20
+  version: 0.20.1
 platform: aarch64-linux
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-22 00:00:00.000000000 Z
+date: 2025-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi