proscenium 0.15.0.beta.7-x86_64-linux → 0.18.0-x86_64-linux

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ee3f15d3e012c29b9ccaf4407e4cc2c5cdc44b20a2e880bf1f42a7486f917a84
4
- data.tar.gz: 622933b2d4cd21bd1f27b64e1a6659609007c3b2f2dcdab6c7d16f18576925a0
3
+ metadata.gz: 6190645fb5344eca0b9321ee2393bfc99662393d3a399d73bdbd23e7bf828bc1
4
+ data.tar.gz: b197c14ec086c7244c8e1de9fe80896fc5c5d0773724ad05b57557bc3aa47d83
5
5
  SHA512:
6
- metadata.gz: 64c5a1f1f38d0f0611fd7a30eafbbecfa79c490daedde990af76aea49491df15d862ee42dc43039d4f6530804acf1f87fb5ad793c77b4ee61926be58688abbc7
7
- data.tar.gz: d2a61a850cd492f141a77685d3d2fe6ad4d085daf9f417ce333c74257fb8675f158d5026627111e906a585f1752c7f646e27186b29fec57195afe1f6e15b328e
6
+ metadata.gz: 98e3d77dc06b077c11c10f789177fefcca64df572e4862746fde9359abdb18a1bcd810348cb3e667d0fe374a37f4f0d5ec259a0a7354e9e12fac04a839593fa2
7
+ data.tar.gz: b952ede6bccaf5de3eda67b745ab224264552edb11eb5e714eb11bcb37d3c3101ecc3a93890874546189a3ec8ecc201033cc2b809d4d2d833f312efcfc9b318a
data/README.md CHANGED
@@ -1,13 +1,20 @@
1
- # Proscenium - Modern client-side development for Rails
1
+ # Proscenium - Integrated Frontend Development for Rails
2
2
 
3
- Proscenium treats your client-side code as first class citizens of your Rails app, and assumes a "fast by default" internet. It bundles your JavaScript and CSS in real time, on demand, and with zero configuration.
3
+ > 🗣️ prow · see · nee · uhm
4
+ >
5
+ > _noun_: **proscenium**
6
+ >
7
+ > - _the part of a theatre stage in front of the curtain._
8
+
9
+ **_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.
4
10
 
5
11
  **The highlights:**
6
12
 
7
- - Fast real-time bundling, tree-shaking, code-splitting and minification of Javascript (.js,.jsx), Typescript (.ts,.tsx) and CSS (.css).
8
- - NO JavaScript runtime needed - just the browser!
13
+ - Fast, real-time bundling, tree-shaking, code-splitting and minification of Javascript (.js,.jsx), Typescript (.ts,.tsx) and CSS (.css).
14
+ - NO JavaScript runtime needed (eg. Node) - just the browser!
9
15
  - NO build step or pre-compilation.
10
- - NO additional process or server - Just run Rails!
16
+ - NO additional process or server - Just run `rails s`!
17
+ - Transforms newer JavaScript and CSS syntax to older syntax for older browsers.
11
18
  - Deep integration with Rails.
12
19
  - Automatically side-load your layouts, views, and partials.
13
20
  - Import from NPM, URL's, and locally.
@@ -22,7 +29,6 @@ Proscenium treats your client-side code as first class citizens of your Rails ap
22
29
  - [Client-Side Code Anywhere](#client-side-code-anywhere)
23
30
  - [Side Loading](#side-loading)
24
31
  - [Importing](#importing-assets)
25
- - [URL Imports](#url-imports)
26
32
  - [Local Imports](#local-imports)
27
33
  - [Import Maps](#import-maps)
28
34
  - [Source Maps](#source-maps)
@@ -70,7 +76,9 @@ Add this line to your Rails application's Gemfile, and you're good to go:
70
76
  gem 'proscenium'
71
77
  ```
72
78
 
73
- Please note that Proscenium is designed solely for use with Rails, so will not work - at least out of the box - anywhere else.
79
+ Please note that Proscenium is designed solely for use with Rails.
80
+
81
+ 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.
74
82
 
75
83
  ## Client-Side Code Anywhere
76
84
 
@@ -82,23 +90,21 @@ Simply put your JS(X) and CSS anywhere you want, and they will be served by your
82
90
 
83
91
  Using the examples above...
84
92
 
85
- - `app/views/users/index.js` => `https://yourapp.com/app/views/users/index.js`
86
- - `app/views/layouts/application.css` => `https://yourapp.com/app/views/layouts/application.css`
87
- - `lib/utils.js` => `https://yourapp.com/lib/utils.js`
88
- - `app/components/menu_component.jsx` => `https://yourapp.com/app/components/menu_component.jsx`
89
- - `config/properties.css` => `https://yourapp.com/config/properties.css`
93
+ - `app/views/users/index.js` => `https://localhost:3000/app/views/users/index.js`
94
+ - `app/views/layouts/application.css` => `https://localhost:3000/app/views/layouts/application.css`
95
+ - `lib/utils.js` => `https://localhost:3000/lib/utils.js`
96
+ - `app/components/menu_component.jsx` => `https://localhost:3000/app/components/menu_component.jsx`
97
+ - `config/properties.css` => `https://localhost:3000/config/properties.css`
90
98
 
91
99
  ## Side Loading
92
100
 
93
- > Prior to **0.10.0**, only assets with the extension `.js`, `.ts` and `.css` were side loaded. From 0.10.0, all assets are side loaded, including `.jsx`, `.tsx`, and `.module.css`. Also partials were not side loaded prior to 0.10.0.
94
-
95
- Proscenium is best experienced when you side load your assets.
101
+ Proscenium is best experienced when your assets are automtically side loaded.
96
102
 
97
103
  ### The Problem
98
104
 
99
105
  With Rails you would typically declaratively load your JavaScript and CSS assets using the `javascript_include_tag` and `stylesheet_link_tag` helpers.
100
106
 
101
- For example, you may have top-level "application" CSS located in a file at `/app/assets/application.css`. Likewise, you may have some global JavaScript located in a file at `/app/assets/application.js`.
107
+ 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`.
102
108
 
103
109
  You would manually and declaratively include those two files in your application layout, something like this:
104
110
 
@@ -177,45 +183,55 @@ Now, in your layout and view, replace the `javascript_include_tag` and `styleshe
177
183
  </html>
178
184
  ```
179
185
 
180
- On each page request, Proscenium will check if any of your views, layouts and partials have a
181
- JS/TS/CSS file of the same name, and then include them wherever your placed the `include_assets`
182
- helper.
186
+ On each page request, Proscenium will check if any of your views, layouts and partials have a JS/TS/CSS file of the same name, and then include them wherever your placed the `include_assets` helper.
187
+
188
+ Now you never have to remember to include your assets again. Just create them alongside your views, partials and layouts, and Proscenium will take care of the rest.
189
+
190
+ Side loading is enabled by default, but you can disable it by setting `config.proscenium.side_load` to `false` in your `/config/application.rb`.
191
+
192
+ There are also `include_stylesheets` and `include_javascripts` helpers to allow you to control where the CSS and JS assets are included in the HTML. These helpers should be used instead of `include_assets` if you want to control exactly where the assets are included.
183
193
 
184
- Now you never have to remember to include your assets again. Just create them alongside your views,
185
- partials and layouts, and Proscenium will take care of the rest.
194
+ ## Bundling
186
195
 
187
- Side loading is enabled by default, but you can disable it by setting `config.proscenium.side_load`
188
- to `false` in your `/config/application.rb`.
196
+ To bundle a file means to inline any imported dependencies into the file itself. This process is recursive so dependencies of dependencies (and so on) will also be inlined.
189
197
 
190
- There are also `include_stylesheets` and `include_javascripts` helpers to allow you to control where
191
- the CSS and JS assets are included in the HTML. These helpers should be used instead of
192
- `include_assets` if you want to control exactly where the assets are included.
198
+ Proscenium will bundle by default, and in real time. So there is no separate build step or pre-compilation.
193
199
 
194
- ## Importing Assets
200
+ Proscenium supports importing JS, JSX, TS, TSX, CSS and SVG from NPM, by URL, your local app, and even from other Ruby Gems.
195
201
 
196
- Proscenium supports importing JS, JSX, TS, TSX, CSS and SVG from NPM, by URL, your local app, and even from Ruby Gems.
202
+ Both static ([`import`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)) and dynamic ([`import()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import)) imports are supported for JavaScript and TypeScript, and can be used to import JS, TS, JSX, TSX, JSON, CSS and SVG files.
197
203
 
198
- Imported files are bundled together in real time. So no build step or pre-compilation is needed.
204
+ The [`@import`](https://developer.mozilla.org/en-US/docs/Web/CSS/@import) CSS at-rule is supported for CSS.
199
205
 
200
- Imports are assumed to be JS files, so there is no need to specify the file extesnion in such cases. But you can if you like. All other file types must be specified using their full file name and extension.
206
+ ### Non-analyzable imports
201
207
 
202
- ### URL Imports
208
+ Import paths are currently only bundled if they are a string literal or a glob pattern. Other forms of import paths are not bundled, and are instead preserved verbatim in the generated output. This is because bundling is a compile-time operation and Proscenium doesn't support all forms of run-time path resolution.
203
209
 
204
- Any import beginning with `http://` or `https://` will be fetched from the URL provided. For example:
210
+ Here are some examples:
205
211
 
206
212
  ```js
207
- import React from "https://esm.sh/react";
208
- ```
213
+ // Analyzable imports (will be bundled)
214
+ import "pkg";
215
+ import("pkg");
216
+ import(`./locale-${foo}.json`);
209
217
 
210
- ```css
211
- @import "https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/css/bootstrap.min.css";
218
+ // Non-analyzable imports (will not be bundled)
219
+ import(`pkg/${foo}`);
212
220
  ```
213
221
 
214
- URL imports are cached, so that each import is only fetched once per server restart.
222
+ The way to work around non-analyzable imports is to mark the package containing this problematic code as [unbundled](#Unbundling) so that it's not included in the bundle. You will then need to ensure that a copy of the external package is available to your bundled code at run-time.
215
223
 
216
224
  ### Import from NPM (`node_modules`)
217
225
 
218
- Bare imports (imports not beginning with `./`, `/`, `https://`, `http://`) are fully supported, and will use your package manager of choice (eg, NPM, Yarn, pnpm) via the `package.json` file:
226
+ Bare imports (imports not beginning with `./`, `/`, `https://`, `http://`) are fully supported, and will use your package manager of choice (eg, NPM, Yarn, pnpm) via the `package.json` file located at the root of your Rails app.
227
+
228
+ Install the package you want to import using your package manager of choice...
229
+
230
+ ```
231
+ npm install react
232
+ ```
233
+
234
+ ...and then import it as you would any other package.
219
235
 
220
236
  ```js
221
237
  import React from "react";
@@ -223,26 +239,18 @@ import React from "react";
223
239
 
224
240
  ### Local Imports
225
241
 
226
- And of course you can import your own code, using relative or absolute paths (file extension is optional):
242
+ And of course you can import your own code, using relative or absolute paths (file extension is optional, and absolute paths use your Rails root as the base):
227
243
 
228
- ```js /app/views/layouts/application.js
244
+ ```js
229
245
  import utils from "/lib/utils";
230
- ```
231
-
232
- ```js /lib/utils.js
233
246
  import constants from "./constants";
247
+ import Header from "/app/components/header";
234
248
  ```
235
249
 
236
- ```css /app/views/layouts/application.css
250
+ ```css
237
251
  @import "/lib/reset";
238
252
  ```
239
253
 
240
- ```css /lib/reset.css
241
- body {
242
- /* some styles... */
243
- }
244
- ```
245
-
246
254
  ### Unbundling
247
255
 
248
256
  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
@@ -253,7 +261,7 @@ import React from "unbundle:react";
253
261
 
254
262
  This only works any bare and local imports.
255
263
 
256
- You can also use the `unbundle` prefix in your import map, which ensures that all imports of a particular path is always unbundled:
264
+ You can also use the `unbundle` prefix in your [import map](#import-maps), which ensures that all imports of a particular path is always unbundled:
257
265
 
258
266
  ```json
259
267
  {
@@ -411,11 +419,11 @@ import translations from "@proscenium/i18n";
411
419
 
412
420
  ## Javascript
413
421
 
414
- By default, Proscenium's output will take advantage of all modern JS features. 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.
422
+ 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.
415
423
 
416
424
  ### Tree Shaking
417
425
 
418
- Tree shaking is the term the JavaScript community uses for dead code elimination, a common compiler optimization that automatically removes unreachable code. Tree shaking is enabled by default in Proascenium.
426
+ Tree shaking is the term the JavaScript community uses for dead code elimination, a common compiler optimization that automatically removes unreachable code. Tree shaking is enabled by default in Proscenium.
419
427
 
420
428
  ```javascript
421
429
  function one() {
@@ -491,6 +499,8 @@ Note that by default, Proscenium's output will take advantage of all modern CSS
491
499
 
492
500
  The new CSS nesting syntax is supported, and transformed into non-nested CSS for older browsers.
493
501
 
502
+ Proscenium will also automatically insert vendor prefixes so that your CSS will work in older browsers.
503
+
494
504
  ### Importing CSS from JavaScript
495
505
 
496
506
  You can also import CSS from JavaScript. When you do this, Proscenium will automatically append each stylesheet to the document's head as a `<link>` element.
@@ -835,7 +845,7 @@ Proscenium brings back RJS! Any path ending in .rjs will be served from your Rai
835
845
 
836
846
  Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx` from the following directories, and their sub-directories of your Rails application's root: `/app`, `/lib`, `/config`, `/node_modules`, `/vendor`.
837
847
 
838
- So a file at `/app/views/users/index.js` will be served from `https://yourapp.com/app/views/users/index.js`.
848
+ So a file at `/app/views/users/index.js` will be served from `https://localhost:3000/app/views/users/index.js`.
839
849
 
840
850
  You can continue to access any file in the `/public` directory as you normally would. Proscenium will not process files in the `/public` directory.
841
851
 
@@ -880,7 +890,7 @@ bundle exec rake compile:local
880
890
  We have tests for both Ruby and Go. To run the Ruby tests:
881
891
 
882
892
  ```bash
883
- bundle exec sus
893
+ bin/test
884
894
  ```
885
895
 
886
896
  To run the Go tests:
@@ -84,15 +84,15 @@ module Proscenium
84
84
  end
85
85
 
86
86
  def self.build_to_path(path, root: nil, base_url: nil)
87
- new(root: root, base_url: base_url).build_to_path(path)
87
+ new(root:, base_url:).build_to_path(path)
88
88
  end
89
89
 
90
90
  def self.build_to_string(path, root: nil, base_url: nil)
91
- new(root: root, base_url: base_url).build_to_string(path)
91
+ new(root:, base_url:).build_to_string(path)
92
92
  end
93
93
 
94
94
  def self.resolve(path, root: nil)
95
- new(root: root).resolve(path)
95
+ new(root:).resolve(path)
96
96
  end
97
97
 
98
98
  def initialize(root: nil, base_url: nil)
Binary file
@@ -15,8 +15,14 @@ module Proscenium
15
15
  # building with Proscenium. It's important to note that `include_assets` will not call this, as
16
16
  # those asset paths all begin with a slash, which the Rails asset helpers do not pass through to
17
17
  # here.
18
+ #
19
+ # If the given `path` is a bare path (does not start with `/` or `./` or `../`), then we use
20
+ # Rails default conventions, and serve CSS from /app/assets/stylesheets and JS from
21
+ # /app/javascript.
18
22
  def compute_asset_path(path, options = {})
19
23
  if %i[javascript stylesheet].include?(options[:type])
24
+ path.prepend DEFAULT_RAILS_ASSET_PATHS[options[:type]] unless path.start_with?('./', '../')
25
+
20
26
  result = Proscenium::Builder.build_to_path(path, base_url: request.base_url)
21
27
  return result.split('::').last.delete_prefix 'public'
22
28
  end
@@ -53,7 +59,7 @@ module Proscenium
53
59
  end
54
60
 
55
61
  def include_stylesheets
56
- '<!-- [PROSCENIUM_STYLESHEETS] -->'.html_safe
62
+ SideLoad::CSS_COMMENT.html_safe
57
63
  end
58
64
  alias side_load_stylesheets include_stylesheets
59
65
  deprecate side_load_stylesheets: 'Use `include_stylesheets` instead', deprecator: Deprecator.new
@@ -62,7 +68,7 @@ module Proscenium
62
68
  #
63
69
  # @return [String] the HTML tags for the javascripts.
64
70
  def include_javascripts
65
- '<!-- [PROSCENIUM_LAZY_SCRIPTS] --><!-- [PROSCENIUM_JAVASCRIPTS] -->'.html_safe
71
+ (SideLoad::LAZY_COMMENT + SideLoad::JS_COMMENT).html_safe
66
72
  end
67
73
  alias side_load_javascripts include_javascripts
68
74
  deprecate side_load_javascripts: 'Use `include_javascripts` instead', deprecator: Deprecator.new
@@ -25,7 +25,7 @@ module Proscenium
25
25
  # Should be the actual asset file, eg. app.css, some/component.js.
26
26
  # @param resolve [String] description of the file to resolve and import.
27
27
  # @return [String] the digest of the imported file path if a css module (*.module.css).
28
- def import(filepath = nil, resolve: nil, **options)
28
+ def import(filepath = nil, resolve: nil, **)
29
29
  self.imported ||= {}
30
30
 
31
31
  filepath = Resolver.resolve(resolve) if !filepath && resolve
@@ -34,7 +34,7 @@ module Proscenium
34
34
  unless self.imported.key?(filepath)
35
35
  # ActiveSupport::Notifications.instrument('sideload.proscenium', identifier: value)
36
36
 
37
- self.imported[filepath] = { **options }
37
+ self.imported[filepath] = { ** }
38
38
  self.imported[filepath][:digest] = Utils.digest(filepath) if css_module
39
39
  end
40
40
 
@@ -16,7 +16,7 @@ module Proscenium
16
16
  path = CGI.unescape(path) if path.start_with?(/https?%3A%2F%2F/)
17
17
 
18
18
  info do
19
- message = +" #{color('[Proscenium]', nil, bold: true)} Building (to path) #{path}"
19
+ message = " #{color('[Proscenium]', nil, bold: true)} Building (to path) #{path}"
20
20
  message << " (Duration: #{event.duration.round(1)}ms | " \
21
21
  "Allocations: #{event.allocations}#{cached})"
22
22
  end
@@ -27,7 +27,7 @@ module Proscenium
27
27
  path = CGI.unescape(path) if path.start_with?(/https?%3A%2F%2F/)
28
28
 
29
29
  info do
30
- message = +" #{color('[Proscenium]', nil, bold: true)} Building #{path}"
30
+ message = " #{color('[Proscenium]', nil, bold: true)} Building #{path}"
31
31
  message << " (Duration: #{event.duration.round(1)}ms | Allocations: #{event.allocations})"
32
32
  end
33
33
  end
@@ -15,7 +15,7 @@ module Proscenium
15
15
  detail[:text]
16
16
  end
17
17
 
18
- super(args)
18
+ super
19
19
  end
20
20
  end
21
21
 
@@ -11,14 +11,13 @@ module Proscenium
11
11
  autoload :Esbuild
12
12
  autoload :Engines
13
13
  autoload :Runtime
14
- autoload :Url
15
14
 
16
15
  def initialize(app)
17
16
  @app = app
18
17
 
19
18
  chunks_path = Rails.public_path.join('assets').to_s
20
19
  headers = Rails.application.config.public_file_server.headers || {}
21
- @chunk_handler = ::ActionDispatch::FileHandler.new(chunks_path, headers: headers)
20
+ @chunk_handler = ::ActionDispatch::FileHandler.new(chunks_path, headers:)
22
21
  end
23
22
 
24
23
  def call(env)
@@ -41,7 +40,6 @@ module Proscenium
41
40
  end
42
41
 
43
42
  def find_type(request)
44
- return Url if request.path.match?(%r{^/https?%3A%2F%2F})
45
43
  return Runtime if request.path.match?(%r{^/@proscenium/})
46
44
  return Esbuild if Pathname.new(request.path).fnmatch?(app_path_glob, File::FNM_EXTGLOB)
47
45
 
@@ -25,8 +25,8 @@ module Proscenium
25
25
  # end
26
26
  #
27
27
  # @yield the given block to a `div` within the top level component div.
28
- def view_template(**attributes, &block)
29
- send root_tag, **{ data: data_attributes }.deep_merge(attributes), &block
28
+ def view_template(**attributes, &)
29
+ send(root_tag, **{ data: data_attributes }.deep_merge(attributes), &)
30
30
  end
31
31
  end
32
32
  end
@@ -88,7 +88,7 @@ module Proscenium
88
88
  index = app.config.public_file_server.index_name || 'index'
89
89
 
90
90
  app.middleware.insert_after(ActionDispatch::Static, ActionDispatch::Static,
91
- root.join('public').to_s, index: index, headers: headers)
91
+ root.join('public').to_s, index:, headers:)
92
92
  end
93
93
  end
94
94
  end
@@ -2,6 +2,10 @@
2
2
 
3
3
  module Proscenium
4
4
  class SideLoad
5
+ JS_COMMENT = '<!-- [PROSCENIUM_JAVASCRIPTS] -->'
6
+ CSS_COMMENT = '<!-- [PROSCENIUM_STYLESHEETS] -->'
7
+ LAZY_COMMENT = '<!-- [PROSCENIUM_LAZY_SCRIPTS] -->'
8
+
5
9
  module Controller
6
10
  def self.included(child)
7
11
  child.class_eval do
@@ -23,7 +27,13 @@ module Proscenium
23
27
  def capture_and_replace_proscenium_stylesheets
24
28
  return if response_body.nil?
25
29
  return if response_body.first.blank? || !Proscenium::Importer.css_imported?
26
- return unless response_body.first.include? '<!-- [PROSCENIUM_STYLESHEETS] -->'
30
+
31
+ included_comment = response_body.first.include?(CSS_COMMENT)
32
+ fragments = if (fragment_header = request.headers['X-Fragment'])
33
+ fragment_header.split
34
+ end
35
+
36
+ return if !fragments && !included_comment
27
37
 
28
38
  imports = Proscenium::Importer.imported.dup
29
39
  paths_to_build = []
@@ -44,12 +54,17 @@ module Proscenium
44
54
 
45
55
  import = imports[inpath]
46
56
  opts = import[:css].is_a?(Hash) ? import[:css] : {}
57
+ opts[:preload_links_header] = false if fragments
47
58
  opts[:data] ||= {}
48
59
  opts[:data][:original_href] = inpath
49
60
  out << helpers.stylesheet_link_tag(outpath, extname: false, **opts)
50
61
  end
51
62
 
52
- response_body.first.gsub! '<!-- [PROSCENIUM_STYLESHEETS] -->', out.join.html_safe
63
+ if fragments
64
+ response_body.first.prepend out.join.html_safe
65
+ elsif included_comment
66
+ response_body.first.gsub! CSS_COMMENT, out.join.html_safe
67
+ end
53
68
  end
54
69
 
55
70
  def capture_and_replace_proscenium_javascripts
@@ -65,7 +80,13 @@ module Proscenium
65
80
  result = Proscenium::Builder.build_to_path(paths_to_build.join(';'),
66
81
  base_url: helpers.request.base_url)
67
82
 
68
- if response_body.first.include? '<!-- [PROSCENIUM_JAVASCRIPTS] -->'
83
+ included_js_comment = response_body.first.include?(JS_COMMENT)
84
+ included_lazy_comment = response_body.first.include?(LAZY_COMMENT)
85
+ fragments = if (fragment_header = request.headers['X-Fragment'])
86
+ fragment_header.split
87
+ end
88
+
89
+ if fragments || included_js_comment
69
90
  out = []
70
91
  scripts = {}
71
92
  result.split(';').each do |x|
@@ -76,17 +97,22 @@ module Proscenium
76
97
  next unless imports.key?(inpath)
77
98
 
78
99
  if (import = imports[inpath]).delete(:lazy)
79
- scripts[inpath] = import.merge(outpath: outpath)
100
+ scripts[inpath] = import.merge(outpath:)
80
101
  else
81
102
  opts = import[:js].is_a?(Hash) ? import[:js] : {}
103
+ opts[:preload_links_header] = false if fragments
82
104
  out << helpers.javascript_include_tag(outpath, extname: false, **opts)
83
105
  end
84
106
  end
85
107
 
86
- response_body.first.gsub! '<!-- [PROSCENIUM_JAVASCRIPTS] -->', out.join.html_safe
108
+ if fragments
109
+ response_body.first.prepend out.join.html_safe
110
+ elsif included_js_comment
111
+ response_body.first.gsub! JS_COMMENT, out.join.html_safe
112
+ end
87
113
  end
88
114
 
89
- return unless response_body.first.include? '<!-- [PROSCENIUM_LAZY_SCRIPTS] -->'
115
+ return if !fragments && !included_lazy_comment
90
116
 
91
117
  lazy_script = ''
92
118
  if scripts.present?
@@ -96,7 +122,11 @@ module Proscenium
96
122
  end
97
123
  end
98
124
 
99
- response_body.first.gsub! '<!-- [PROSCENIUM_LAZY_SCRIPTS] -->', lazy_script
125
+ if fragments
126
+ response_body.first.prepend lazy_script
127
+ elsif included_lazy_comment
128
+ response_body.first.gsub! LAZY_COMMENT, lazy_script
129
+ end
100
130
  end
101
131
  end
102
132
 
@@ -1,6 +1,6 @@
1
1
  @layer proscenium-ui-component {
2
2
  /*
3
- * Custom properties:
3
+ * Properties:
4
4
  *
5
5
  * --puiBreadcrumbs--link-color: LinkText;
6
6
  * --puiBreadcrumbs--link-hover-color: HighlightText;
@@ -1,28 +1,22 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require 'literal'
4
+
3
5
  module Proscenium::UI
4
6
  class Breadcrumbs::Component < Component
7
+ extend Literal::Properties
5
8
  include Phlex::Rails::Helpers::URLFor
6
9
 
7
10
  # The path (route) to use as the HREF for the home segment. Defaults to `:root`.
8
- option :home_path, Types::String | Types::Symbol, default: -> { :root }
11
+ prop :home_path, _Union(String, Symbol), default: -> { :root }
9
12
 
10
13
  # Assign false to hide the home segment.
11
- option :with_home, Types::Bool, default: -> { true }
12
-
13
- # One or more class name(s) for the base div element which will be appended to the default.
14
- option :class, Types::Coercible::String | Types::Array.of(Types::Coercible::String),
15
- as: :class_name, default: -> { [] }
16
-
17
- # One or more class name(s) for the base div element which will replace the default. If both
18
- # `class` and `class!` are provided, all values will be merged. Defaults to `:@base`.
19
- option :class!, Types::Coercible::String | Types::Array.of(Types::Coercible::String),
20
- as: :class_name_override, default: -> { :@base }
14
+ prop :with_home, _Boolean, default: -> { true }
21
15
 
22
16
  def view_template
23
- div class: [*class_name_override, *class_name] do
17
+ div class: :@base do
24
18
  ol do
25
- if with_home
19
+ if @with_home
26
20
  li do
27
21
  home_template
28
22
  end
@@ -48,7 +42,7 @@ module Proscenium::UI
48
42
  # super { 'hello' }
49
43
  # end
50
44
  def home_template(&block)
51
- a(href: url_for(home_path)) do
45
+ a(href: url_for(@home_path)) do
52
46
  if block
53
47
  yield
54
48
  else
@@ -1,11 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'dry-initializer'
4
-
5
3
  module Proscenium::UI
6
4
  class Component < Proscenium::Phlex
7
5
  self.abstract_class = true
8
-
9
- extend Dry::Initializer
10
6
  end
11
7
  end
data/lib/proscenium/ui.rb CHANGED
@@ -1,14 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'dry-types'
4
-
5
3
  module Proscenium::UI
6
4
  extend ActiveSupport::Autoload
7
5
 
8
6
  autoload :Component
9
7
  autoload :Breadcrumbs
10
-
11
- module Types
12
- include Dry.Types()
13
- end
14
8
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Proscenium
4
- VERSION = '0.15.0.beta.7'
4
+ VERSION = '0.18.0'
5
5
  end
data/lib/proscenium.rb CHANGED
@@ -8,6 +8,13 @@ module Proscenium
8
8
  FILE_EXTENSIONS = ['js', 'mjs', 'ts', 'jsx', 'tsx', 'css', 'js.map', 'mjs.map', 'jsx.map',
9
9
  'ts.map', 'tsx.map', 'css.map'].freeze
10
10
 
11
+ # Default paths for Rails assets. Used by the `compute_asset_path` helper to maintain Rails
12
+ # default conventions of where JS and CSS files are located.
13
+ DEFAULT_RAILS_ASSET_PATHS = {
14
+ stylesheet: 'app/assets/stylesheets/',
15
+ javascript: 'app/javascript/'
16
+ }.freeze
17
+
11
18
  ALLOWED_DIRECTORIES = 'app,lib,config,vendor,node_modules'
12
19
 
13
20
  # Environment variables that should always be passed to the builder.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: proscenium
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.15.0.beta.7
4
+ version: 0.18.0
5
5
  platform: x86_64-linux
6
6
  authors:
7
7
  - Joel Moss
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-01 00:00:00.000000000 Z
11
+ date: 2024-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 6.1.0
19
+ version: 7.1.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: '8.0'
@@ -26,38 +26,10 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 6.1.0
29
+ version: 7.1.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: '8.0'
33
- - !ruby/object:Gem::Dependency
34
- name: dry-initializer
35
- requirement: !ruby/object:Gem::Requirement
36
- requirements:
37
- - - "~>"
38
- - !ruby/object:Gem::Version
39
- version: '3.1'
40
- type: :runtime
41
- prerelease: false
42
- version_requirements: !ruby/object:Gem::Requirement
43
- requirements:
44
- - - "~>"
45
- - !ruby/object:Gem::Version
46
- version: '3.1'
47
- - !ruby/object:Gem::Dependency
48
- name: dry-types
49
- requirement: !ruby/object:Gem::Requirement
50
- requirements:
51
- - - "~>"
52
- - !ruby/object:Gem::Version
53
- version: '1.7'
54
- type: :runtime
55
- prerelease: false
56
- version_requirements: !ruby/object:Gem::Requirement
57
- requirements:
58
- - - "~>"
59
- - !ruby/object:Gem::Version
60
- version: '1.7'
61
33
  - !ruby/object:Gem::Dependency
62
34
  name: ffi
63
35
  requirement: !ruby/object:Gem::Requirement
@@ -73,40 +45,40 @@ dependencies:
73
45
  - !ruby/object:Gem::Version
74
46
  version: 1.17.0
75
47
  - !ruby/object:Gem::Dependency
76
- name: oj
48
+ name: literal
77
49
  requirement: !ruby/object:Gem::Requirement
78
50
  requirements:
79
51
  - - "~>"
80
52
  - !ruby/object:Gem::Version
81
- version: '3.13'
53
+ version: '1.0'
82
54
  type: :runtime
83
55
  prerelease: false
84
56
  version_requirements: !ruby/object:Gem::Requirement
85
57
  requirements:
86
58
  - - "~>"
87
59
  - !ruby/object:Gem::Version
88
- version: '3.13'
60
+ version: '1.0'
89
61
  - !ruby/object:Gem::Dependency
90
- name: phlex-rails
62
+ name: oj
91
63
  requirement: !ruby/object:Gem::Requirement
92
64
  requirements:
93
65
  - - "~>"
94
66
  - !ruby/object:Gem::Version
95
- version: 1.2.1
67
+ version: '3.13'
96
68
  type: :runtime
97
69
  prerelease: false
98
70
  version_requirements: !ruby/object:Gem::Requirement
99
71
  requirements:
100
72
  - - "~>"
101
73
  - !ruby/object:Gem::Version
102
- version: 1.2.1
74
+ version: '3.13'
103
75
  - !ruby/object:Gem::Dependency
104
76
  name: railties
105
77
  requirement: !ruby/object:Gem::Requirement
106
78
  requirements:
107
79
  - - ">="
108
80
  - !ruby/object:Gem::Version
109
- version: 6.1.0
81
+ version: 7.1.0
110
82
  - - "<"
111
83
  - !ruby/object:Gem::Version
112
84
  version: '8.0'
@@ -116,7 +88,7 @@ dependencies:
116
88
  requirements:
117
89
  - - ">="
118
90
  - !ruby/object:Gem::Version
119
- version: 6.1.0
91
+ version: 7.1.0
120
92
  - - "<"
121
93
  - !ruby/object:Gem::Version
122
94
  version: '8.0'
@@ -171,7 +143,6 @@ files:
171
143
  - lib/proscenium/middleware/engines.rb
172
144
  - lib/proscenium/middleware/esbuild.rb
173
145
  - lib/proscenium/middleware/runtime.rb
174
- - lib/proscenium/middleware/url.rb
175
146
  - lib/proscenium/monkey.rb
176
147
  - lib/proscenium/phlex.rb
177
148
  - lib/proscenium/phlex/asset_inclusions.rb
@@ -214,14 +185,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
214
185
  requirements:
215
186
  - - ">="
216
187
  - !ruby/object:Gem::Version
217
- version: 2.7.0
188
+ version: 3.2.0
218
189
  required_rubygems_version: !ruby/object:Gem::Requirement
219
190
  requirements:
220
191
  - - ">="
221
192
  - !ruby/object:Gem::Version
222
193
  version: '0'
223
194
  requirements: []
224
- rubygems_version: 3.5.11
195
+ rubygems_version: 3.5.21
225
196
  signing_key:
226
197
  specification_version: 4
227
198
  summary: The engine powering your Rails frontend
@@ -1,16 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Proscenium
4
- class Middleware
5
- # Handles requests for URL encoded URL's.
6
- class Url < Esbuild
7
- private
8
-
9
- # @override [Esbuild] It's a URL, so always assume it is renderable (we won't actually know
10
- # until it's downloaded).
11
- def renderable?
12
- true
13
- end
14
- end
15
- end
16
- end