proscenium 0.6.0-x86_64-linux → 0.8.2-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24989d48e852d009d61ca3407eb5c0eca0f56f9cbcd8411379deb9d3388158a7
-  data.tar.gz: 79f44652dda8cf067b5f1df01cb3a7abb408a84f340b6910b15f933109fa6658
+  metadata.gz: 0befa74ca37e255e40d47294992f4dde37fd92636b7de4d6bcbd3e7078d26585
+  data.tar.gz: 3ee198704c19fb58cd64ef2b3dfe9ccd76d0b4359507c5d66dfbd9973e0f16f4
 SHA512:
-  metadata.gz: 765d537f7c14394e7aed909394161669fc3a3880b6285f5a0a7b3c42c5554b2835522a159cea97d9d241eea509035e334345547ae0c942df92cd9f15d56659d0
-  data.tar.gz: 3d12dd75c35affe07c46ad369360fd66104799dce799ee4075931179347f7073d29c34ef3adaa3e616f75c3b14b6df5d756ef9a796fa1159936cd2cf7ec15e99
+  metadata.gz: b4e97ebe2e7bcd9a85112f3ab3d043472e26a2f8378605c65342cd2c411ec47225955f4b87c8732c749e3a82e400feeb9160cb4ae7cdf41fe8f0d2abc2d2bf63
+  data.tar.gz: 0bacb942fb31e630a47a2a7e5ef6991d05c31a624b53ce4d1aa9ef7027cb94c04241897cfd96e78f0e32ddd17d391a929c482133b216dc437c187837aeae0c0b

data/README.md

@@ -1,91 +1,83 @@
 # Proscenium - Modern Client-Side Tooling for Rails
 
 Proscenium treats your client-side code as first class citizens of your Rails app, and assumes a
-"fast by default" internet. It compiles your JS, JSX and CSS in real time, and on demand, with no
-configuration at all!
+"fast by default" internet. It bundles your JS, JSX and CSS in real time, on demand, and with zero
+configuration.
 
 - Zero configuration.
-- NO JavaScript rumtime needed - just the browser!
-- Real-time compilation.
+- Fast real-time bundling, tree-shaking and minification.
+- NO JavaScript runtime - just the browser!
+- Deep integration with Rails.
 - No additional process or server - Just run Rails!
-- Serve assets from anywhere within your Rails root (/app, /config, /lib).
+- Serve assets from anywhere within your Rails root (/app, /config, /lib, etc.).
 - Automatically side load JS/CSS for your layouts and views.
-- Import JS(X) and CSS from node_modules, URL, local (relative, absolute).
-- Optional bundling of JS(X) and CSS.
-- Import Map support for JS and CSS.
+- Import JS(X), TS(X) and CSS from NPM, URL, and locally.
+- Support for JSX.
+- Server-side import map support.
 - CSS Modules.
-- CSS Custom Media Queries.
 - CSS mixins.
-- Minification.
-- Auto reload after changes (development only).
-
-## !! EXPERIMENTAL SOFTWARE !!
-
-While my goal is to use Proscenium in production, I strongly recommended that you **DO NOT** use
-this in production apps! Right now, this is a play thing, and should only be used for
-development/testing.
+- Source maps.
+- Phlex and ViewComponent integration.
 
 ## Installation
 
-Add this line to your application's Gemfile, and you're good to go:
+Add this line to your Rails application's Gemfile, and you're good to go:
 
 ```ruby
 gem 'proscenium'
 ```
 
-## Frontend Code Anywhere!
+Please note that Proscenium is designed solely for use with Rails, so will not work - at least out of the box - anywhere else.
+
+## 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 throwing all
-your JS and CSS into a "app/assets" directory, put them wherever you want!
+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!
 
-For example, if you have JS that is used by your `UsersController#index`, then put it in
-`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`. Maybe you have a few JS utility functions, so put them in
-`lib/utils.js`.
+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 create your JS(X) and CSS anywhere you want, and they will be served by your Rails app.
+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.
 
 Using the examples above...
 
 - `app/views/users/index.js` => `https://yourapp.com/app/views/users/index.js`
 - `app/views/layouts/application.css` => `https://yourapp.com/app/views/layouts/application.css`
 - `lib/utils.js` => `https://yourapp.com/lib/utils.js`
+- `app/components/menu_component.jsx` => `https://yourapp.com/app/components/menu_component.jsx`
 - `config/properties.css` => `https://yourapp.com/config/properties.css`
 
 ## Importing
 
-Proscenium supports importing JS and CSS from `node_modules`, URL, and local (relative, absolute).
+Proscenium supports importing JS, JSX, TS and CSS from NPM, by URL, your local app, and even from Ruby Gems.
 
-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.
+Imported files are bundled together in real time. So no build step or pre-compilation is needed.
+
+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.
 
 ### URL Imports
 
-Any import beginning with `http://` or `https://` will be fetched from the URL provided:
+Any import beginning with `http://` or `https://` will be fetched from the URL provided. For example:
 
 ```js
-import React from 'https://esm.sh/react`
+import React from 'https://esm.sh/react'
 ```
 
 ```css
 @import 'https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/css/bootstrap.min.css';
 ```
 
+URL imports are cached, so that each import is only fetched once per server restart.
+
 ### Import from NPM (`node_modules`)
 
-Bare imports (imports not beginning with `./`, `/`, `https://`, `http://`) are fully supported, and
-will use your package manager of choice (eg, NPM, Yarn, pnpm):
+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:
 
 ```js
-import React from 'react`
+import React from 'react'
 ```
 
 ### Local Imports
 
-And of course you can import your own code, using relative or absolute paths (file extension is
-optional):
+And of course you can import your own code, using relative or absolute paths (file extension is optional):
 
 ```js /app/views/layouts/application.js
 import utils from '/lib/utils'
@@ -95,32 +87,11 @@ import utils from '/lib/utils'
 import constants from './constants'
 ```
 
-## Bundling
-
-Proscenium does not do any bundling, as we believe that **the web is now fast by default**. So we
-let you decide if and when to bundle your code using query parameters in your JS and CSS imports.
-
-```js
-import doStuff from 'stuff?bundle'
-doStuff()
-```
-
-Bundling a URL import is not supported, as the URL itself may also support query parameters,
-resulting in conflicts. For example, esm.sh also supports a `?bundle` param, bundling a module's
-dependencies into a single file. Instead, you should install the module locally using your favourite
-package manager.
+## Import Map [WIP]
 
-Note that `?bundle` will only bundle that exact path. It will not bundle any descendant imports. You
-can bundle all imports within a file by using the `?bundle-all` query string. Use this with caution,
-as you could end up swallowing everything, resulting in a very large file.
+[Import map](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) for both JS and CSS is supported out of the box, and works with no regard to the browser being used. This is because the import map is parsed and resolved by Proscenium on the server. If you are not familiar with import maps, think of it as a way to define aliases.
 
-## Import Map
-
-Import map for both JS and CSS is supported out of the box, and works with no regard to the browser
-version being used. This is because the import map is parsed and resolved by Proscenium on the
-server.
-
-Just create `config/import_map.json`:
+Just create `config/import_map.json` and specify the imports you want to use. For example:
 
 ```json
 {
@@ -148,9 +119,7 @@ and for CSS...
 @import '@radix-ui/colors/blue.css';
 ```
 
-You can instead write your import map in Javascript instead of JSON. So instead of
-`config/import_map.json`, create `config/import_map.js`, and define an anonymous function. This
-function accepts a single `environment` argument.
+You can also write your import map in Javascript instead of JSON. So instead of `config/import_map.json`, create `config/import_map.js`, and define an anonymous function. This function accepts a single `environment` argument.
 
 ```js
 env => ({
@@ -160,18 +129,6 @@ env => ({
 })
 ```
 
-### Aliasing
-
-You can also use the import map to define aliases:
-
-```json
-{
-  "imports": {
-    "react": "preact/compact",
-  }
-}
-```
-
 ## Side Loading
 
 Proscenium has built in support for automatically side loading JS and CSS with your views and
@@ -203,6 +160,8 @@ to `false`.
 
 ## CSS Modules
 
+Proscenium implements a subset of [CSS Modules](https://github.com/css-modules/css-modules). It supports the `:local` and `:global` keywords, but not the `composes` property. It is recommended that you use mixins instead of `composes`, as they work everywhere.
+
 Give any CSS file a `.module.css` extension, and Proscenium will load it as a CSS Module...
 
 ```css
@@ -211,7 +170,7 @@ Give any CSS file a `.module.css` extension, and Proscenium will load it as a CS
 }
 ```
 
-The above produces:
+The above input produces:
 
 ```css
 .header5564cdbb {
@@ -219,63 +178,104 @@ The above produces:
 }
 ```
 
-Importing a CSS file from JS will automatically append the stylesheet to the document's head. The
-results of the import will be an object of CSS modules.
+Importing a CSS file from JS will automatically append the stylesheet to the document's head. And the results of the import will be an object of CSS class to module names.
 
 ```js
 import styles from './styles.module.css'
+// styles == { header: 'header5564cdbb' }
 ```
 
-## Auto Reload
+It is important to note that the exported object of CSS module names is actually a Proxy object. So destructuring the object will not work. Instead, you must access the properties directly.
 
-To aid fast development, Proscenium comes with an auto reload feature that will automatically reload
-the page when any files changes. It is enabled by default in development, and requires that you
-mount the Proscenium Railtie into your `config/routes.rb` file:
+Also, importing a CSS module from another CSS module will result in the same digest string for all classes.
 
-```ruby
-mount Proscenium::Railtie, at: '/proscenium' if Rails.env.development?
-```
+## CSS Mixins
 
-Changes to CSS/JS(X) files in your `app` and `lib` directories will cause the page to reload.
+Proscenium provides functionality for including or "mixing in" onr or more CSS classes into another. This is similar to the `composes` property of CSS Modules, but works everywhere, and is not limited to CSS Modules.
 
-NOTE: that this is hot module reloading (HMR) - a full page reload is triggered.
+CSS mixins are supported using the `@define-mixin` and `@mixin` at-rules.
 
-You can disable auto reload by setting the `config.proscenium.auto_reload` config option to false.
+A mixin is defined using the `@define-mixin` at-rule. Pass it a name, which should adhere to class name semantics, and declare your rules:
 
-## CSS Custom Media Queries
+```css
+// /lib/mixins.css
+@define-mixin bigText {
+  font-size: 50px;
+}
+```
 
-Proscenium supports [custom media queries](https://css-tricks.com/can-we-have-custom-media-queries-please/) as per the [spec](https://www.w3.org/TR/mediaqueries-5/#custom-mq). However, because of the way they are parsed, they cannot be imported using `@import`. So if you define your custom media queries in `/config/custom_media_queries.css`, Proscenium will automatically inject them into your CSS, so you can use them anywhere.
+Use a mixin using the `@mixin` at-rule. Pass it the name of the mixin you want to use, and the url where the mixin is declared. The url is used to resolve the mixin, and can be relative, absolute, a URL, or even from an NPM packacge.
 
-## CSS Mixins
+```css
+// /app/views/layouts/application.css
+p {
+  @mixin bigText from url('/lib/mixins.css');
+  color: red;
+}
+```
 
-CSS mixins are supported using the `@mixin` at-rule. Simply define your mixins in any number of files ending in `.mixin.css`, and using the `@define-mixin` at-rule...
+The above produce this output:
 
 ```css
-// /lib/text.mixin.css
-@define-mixin bigText {
+p {
   font-size: 50px;
+  color: red;
 }
 ```
 
+Mixins can be declared in any CSS file. They do not need to be declared in the same file as where they are used. however, if you declare and use a mixin in the same file, you don't need to specify the URL of where the mixin is declared.
+
 ```css
-// /app/views/layouts/application.css
+@define-mixin bigText {
+  font-size: 50px;
+}
+
 p {
   @mixin bigText;
   color: red;
 }
 ```
 
-## Cache Busting
+CSS modules and Mixins works perfectly together. You can include a mixin in a CSS module.
+
+## Importing SVG from JS(X)
 
-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.
+Importing SVG from JS(X) will bundle the SVG source code. Additionally, if importing from JSX, the SVG source code will be rendered as a JSX component.
+
+## Environment Variables
+
+Import any environment variables into your JS(X) code.
+
+```js
+import RAILS_ENV from '@proscenium/env/RAILS_ENV'
+```
+
+You can only access environment variables that are explicitly named. It will export `undefined` if the env variable does not exist.
+
+## Importing i18n
+
+Basic 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.*
+```
+
+## Phlex Support
+
+*docs needed*
+
+## ViewComponent Support
+
+*docs needed*
+
+## 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`.
 
-It is assumed that the `REVISION` env var will be unique between deploys. If it isn't, then assets
-will continue to be cached as the same version between deploys. I recommend you assign a version
-number or to use the Git commit hash of the deploy. Just make sure it is unique for each deploy.
+It is assumed that the `REVISION` env var will be unique between deploys. If it isn't, then assets will continue to be cached as the same version between deploys. I recommend you assign a version number or to use the Git commit hash of the deploy. Just make sure it is unique for each deploy.
 
 You can set the `cache_query_string` config option directly to define any query string you wish:
 
@@ -283,18 +283,29 @@ You can set the `cache_query_string` config option directly to define any query
 Rails.application.config.proscenium.cache_query_string = 'my-cache-busting-version-string'
 ```
 
-The cache is set with a `max-age` of 30 days. You can customise this with the `cache_max_age` config
-option:
+The cache is set with a `max-age` of 30 days. You can customise this with the `cache_max_age` config option:
 
 ```ruby
 Rails.application.config.proscenium.cache_max_age = 12.months.to_i
 ```
 
-## How It Works
+## Include Paths
+
+By default, Proscenium will serve files ending with any of these extension: `js,mjs,css,jsx`, and only from `config`, `app/views`, `lib` and `node_modules` directories.
+
+However, you can customise these paths with the `include_path` config option...
+
+```ruby
+Rails.application.config.proscenium.include_paths << 'app/components'
+```
+
+## rjs is back!
 
-Proscenium provides a Rails middleware that proxies requests for your frontend code. By default, it will simply search for a file of the same name in your Rails root. For example, a request for '/app/views/layouts/application.js' or '/lib/hooks.js' will return that exact file relative to your Rails root.
+Proscenium brings back RJS! Any path ending in .rjs will be served from your Rails app. This allows you to import server rendered javascript.
 
-This allows your frontend code to become first class citizens of you Rails application.
+## Serving from Ruby Gem
+
+*docs needed*
 
 ## Development
 
@@ -302,6 +313,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Running Go benchmarks
+
+```bash
+go test ./internal/builder -bench=. -run="^$" -count=10 -benchmem
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/proscenium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/proscenium/blob/master/CODE_OF_CONDUCT.md).

data/lib/proscenium/css_module/class_names_resolver.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Proscenium
+  class CssModule::ClassNamesResolver
+    def initialize(class_names, phlex_path)
+      @class_names = class_names.split
+      @stylesheets = {}
+      @phlex_path = phlex_path.sub_ext('.module.css')
+
+      resolve_class_names
+    end
+
+    def class_names
+      @class_names.join(' ')
+    end
+
+    def stylesheets
+      @stylesheets.map { |_, values| values[:resolved_path] }
+    end
+
+    private
+
+    def resolve_class_names
+      @class_names.map! do |class_name|
+        if class_name.include?('/')
+          if class_name.starts_with?('@')
+            # Scoped bare specifier (eg. "@scoped/package/lib/button@default").
+            _, path, name = class_name.split('@')
+            path = "@#{path}"
+          elsif class_name.starts_with?('/')
+            # Local path with leading slash.
+            path, name = class_name[1..].split('@')
+          else
+            # Bare specifier (eg. "mypackage/lib/button@default").
+            path, name = class_name.split('@')
+          end
+
+          path += '.module.css'
+
+          Utils.css_modularise_class_name name, digest: add_stylesheet(path)[:digest]
+        elsif class_name.starts_with?('@')
+          Utils.css_modularise_class_name class_name[1..],
+                                          digest: add_stylesheet(@phlex_path)[:digest]
+        else
+          class_name
+        end
+      end
+    end
+
+    def add_stylesheet(path)
+      return @stylesheets[path] if @stylesheets.key?(path)
+
+      resolved_path = Utils.resolve_path(path.to_s)
+
+      unless Rails.root.join(resolved_path[1..]).exist?
+        raise CssModule::StylesheetNotFound, resolved_path
+      end
+
+      # Note that the digest is based on the resolved (URL) path, not the original path.
+      @stylesheets[path] = {
+        resolved_path: resolved_path,
+        digest: Utils.digest(resolved_path)
+      }
+    end
+  end
+end

data/lib/proscenium/css_module/resolver.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Proscenium
+  class CssModule::Resolver
+    attr_reader :side_loaded_paths
+
+    # @param path [Pathname] Absolute file system path to the Ruby file that will be side loaded.
+    def initialize(path, side_load: true, hash: nil)
+      raise ArgumentError, "'#{path}' must be a `Pathname`" unless path.is_a?(Pathname)
+
+      @path = path
+      @hash = hash
+      @css_module_path = path.sub_ext('.module.css')
+      @side_load = side_load
+      @side_loaded_paths = nil
+    end
+
+    # Parses the given `content` for CSS modules names ('class' attributes beginning with '@'), and
+    # returns the content with said CSS Modules replaced with the compiled class names.
+    #
+    # Example:
+    #   <div class="@my_css_module_name"></div>
+    def compile_class_names(content)
+      doc = Nokogiri::HTML::DocumentFragment.parse(content)
+
+      return content if (modules = doc.css('[class*="@"]')).empty?
+
+      modules.each do |ele|
+        classes = ele.classes.map { |cls| cls.starts_with?('@') ? class_names!(cls[1..]) : cls }
+        ele['class'] = classes.join(' ')
+      end
+
+      doc.to_html.html_safe
+    end
+
+    # Resolves the given CSS class names to CSS modules. This will also side load the stylesheet if
+    # it exists.
+    #
+    # @param names [String, Array]
+    # @returns [Array] of class names generated from the given CSS module `names`.
+    def class_names(*names)
+      side_load_css_module
+      Utils.css_modularise_class_names names, digest: @hash
+    end
+
+    # Like #class_names, but requires that the stylesheet exists.
+    #
+    # @param names [String, Array]
+    # @raises Proscenium::CssModule::NotFound if stylesheet does not exists.
+    # @see #class_names
+    def class_names!(...)
+      raise CssModule::StylesheetNotFound, @css_module_path unless @css_module_path.exist?
+
+      class_names(...)
+    end
+
+    def side_loaded?
+      @side_loaded_paths.present?
+    end
+
+    private
+
+    def side_load_css_module
+      return if !@side_load || !Rails.application.config.proscenium.side_load
+
+      paths = SideLoad.append @path, { '.module.css' => :css }
+
+      @side_loaded_paths = if paths.empty?
+                             nil
+                           else
+                             @hash = Utils.digest(paths[0])
+                             paths
+                           end
+    end
+  end
+end

data/lib/proscenium/css_module.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-class Proscenium::CssModule
-  class NotFound < StandardError
+module Proscenium::CssModule
+  extend ActiveSupport::Autoload
+
+  class StylesheetNotFound < StandardError
     def initialize(pathname)
       @pathname = pathname
       super
@@ -12,53 +14,30 @@ class Proscenium::CssModule
     end
   end
 
-  def initialize(path)
-    @path = path
-    @css_module_path = "#{path}.module.css"
-  end
+  autoload :ClassNamesResolver
+  autoload :Resolver # deprecated
 
-  # Parses the given `content` for CSS modules names ('class' attributes beginning with '@'), and
-  # returns the content with said CSS Modules replaced with the compiled class names.
+  # Like `css_modules`, but will raise if the stylesheet cannot be found.
   #
-  # Example:
-  #   <div class="@my_css_module_name"></div>
-  def compile_class_names(content)
-    doc = Nokogiri::HTML::DocumentFragment.parse(content)
-
-    return content if (modules = doc.css('[class*="@"]')).empty?
-
-    modules.each do |ele|
-      classes = ele.classes.map { |cls| cls.starts_with?('@') ? class_names!(cls[1..]) : cls }
-      ele['class'] = classes.join(' ')
-    end
-
-    doc.to_html.html_safe
-  end
-
-  # @returns [Array] of class names generated from the given CSS module `names`.
-  def class_names(*names)
-    side_load_css_module
-    names.flatten.compact.map { |name| "#{name.to_s.camelize(:lower)}#{hash}" }
+  # @param name [Array, String]
+  def css_module!(names)
+    cssm.class_names!(names).join ' '
   end
 
-  # Like #class_names, but requires that the stylesheet exists.
+  # Accepts one or more CSS class names, and transforms them into CSS module names.
   #
-  # @raises Proscenium::CssModule::NotFound if stylesheet does not exists.
-  def class_names!(...)
-    raise NotFound, @css_module_path unless Rails.root.join(@css_module_path).exist?
-
-    class_names(...)
+  # @param name [Array, String]
+  def css_module(names)
+    cssm.class_names(names).join ' '
   end
 
   private
 
-  def hash
-    @hash ||= Digest::SHA1.hexdigest("/#{@css_module_path}")[..7]
+  def path
+    self.class.path
   end
 
-  def side_load_css_module
-    return unless Rails.application.config.proscenium.side_load
-
-    Proscenium::SideLoad.append "#{@path}.module", :css
+  def cssm
+    @cssm ||= Resolver.new(path)
   end
 end