proscenium 0.2.0-x86_64-darwin → 0.3.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e3fd0fe04d0ad74e9c8a799d0f5e7a211f36754e502ae2dead2d87d84153594
-  data.tar.gz: 777c4b1a144554766f1397f72492182ec307c386e7ed0f1fadac5b0891a58907
+  metadata.gz: 41451bb7fb99e0c3a26cc8e9e76e9db9da134f027c6178b504eb6241066e4617
+  data.tar.gz: 7ed47753820edebfc0f38a95030af31d02ce5b8290cbf5e48febe289a5db71f5
 SHA512:
-  metadata.gz: aa754d0f16d6e20158b9ed6d9140f87c6212f81c3fb9a4ab6b075cf33e2ba4dcdd5e5f984eb4dc0cd2506aa1dcfdf6b89c701a9258b3932bc6abe78c63619c33
-  data.tar.gz: b549656184b70c8c5a0b783f39425b1213f14efe24e2e0132dd10d63ad591b843c39b233497f7ba019348992158594112f4bebfbbcdda7ef27c32730406cac87
+  metadata.gz: cc0b1bda992c1b2e0e740d7089e0c229bccf65c34b8254a8603cf040337d4ce1353856397c9fef2487fbed7daee5b08d459bed835d20fdc7f469dc9d026e7209
+  data.tar.gz: 14024fd83e150ddcd6352a607c7f8696de46595d4db00a5a27928cc2cd4c0a2ce16804fb2ea0e06ada793c3fa42ff7771def88becd9777d2d8a00df76a44f6c3

data/README.md

@@ -110,6 +110,10 @@ resulting in conflicts. For example, esm.sh also supports a `?bundle` param, bun
 dependencies into a single file. Instead, you should install the module locally using your favourite
 package manager.
 
+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
 
 Import map for both JS and CSS is supported out of the box, and works with no regard to the browser
@@ -246,6 +250,31 @@ p {
 }
 ```
 
+## Cache Busting
+
+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.
+
+You can set the `cache_query_string` config option directly to define any query string you wish:
+
+```ruby
+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:
+
+```ruby
+Rails.application.config.proscenium.cache_max_age = 12.months.to_i
+```
+
 ## How It Works
 
 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.
@@ -258,10 +287,6 @@ 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).
 
-### Compile the compilers
-
-`deno compile --no-config -o bin/compilers/esbuild --import-map import_map.json -A lib/proscenium/compilers/esbuild.js`
-
 ## 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/compilers/esbuild/resolve_plugin.js

@@ -24,6 +24,8 @@ export default setup('resolve', (build, options) => {
           args.path = path
           args.suffix = `?${query}`
           args.queryParams = new URLSearchParams(query)
+        } else if (options.cacheQueryString && options.cacheQueryString !== '') {
+          args.suffix = `?${options.cacheQueryString}`
         }
 
         // Mark remote modules as external.
@@ -133,6 +135,10 @@ export default setup('resolve', (build, options) => {
       result.external = true
     }
 
+    if (result.suffix && result.suffix !== '') {
+      result.path = `${result.path}${result.suffix}`
+    }
+
     return result
   }
 })

data/lib/proscenium/compilers/esbuild.bench.js

@@ -3,11 +3,12 @@ import { join } from 'std/path/mod.ts'
 import compile from './esbuild.js'
 
 const root = join(Deno.cwd(), 'test', 'internal')
+const lightningcssBin = join(Deno.cwd(), 'bin', 'lightningcss')
 
 Deno.bench('esbuild js', async () => {
-  await compile(['lib/foo.js'], { root })
+  await compile(['lib/foo.js'], { root, lightningcssBin })
 })
 
 Deno.bench('esbuild css', async () => {
-  await compile(['lib/foo.css'], { root })
+  await compile(['lib/foo.css'], { root, lightningcssBin })
 })

data/lib/proscenium/compilers/esbuild.js

@@ -26,15 +26,17 @@ import throwCompileError from './esbuild/compile_error.js'
  *   <PATHS_ARG>... One or more file paths or globs to compile.
  *
  * OPTIONS:
- *   --root
+ *   --root <PATH>
  *       Relative or absolute path to the root or current working directory when compilation will
  *       take place.
- *   --import-map
+ *   --import-map <PATH>
  *       Path to an import map, relative to the <root>.
- *   --lightningcss-bin
+ *   --lightningcss-bin <PATH>
  *       Path to the lightningcss CLI binary.
  *   --write
  *       Write output to the filesystem according to esbuild logic.
+ *   --cache-query-string <STRING>
+ *       Query string to append to all imports as a cache buster. Example: `v1`.
  *   --debug
  *       Debug output,
  */
@@ -42,10 +44,11 @@ if (import.meta.main) {
   !Deno.env.get('RAILS_ENV') && Deno.env.set('RAILS_ENV', 'development')
 
   const { _: paths, ...options } = parseArgs(Deno.args, {
-    string: ['root', 'import-map', 'lightningcss-bin'],
+    string: ['root', 'import-map', 'lightningcss-bin', 'cache-query-string'],
     boolean: ['write', 'debug'],
     alias: {
       'import-map': 'importMap',
+      'cache-query-string': 'cacheQueryString',
       'lightningcss-bin': 'lightningcssBin'
     }
   })
@@ -127,7 +130,7 @@ async function main(paths = [], options = {}) {
     bundle: true,
     plugins: [
       envPlugin(),
-      resolvePlugin({ runtimeDir, importMap, debug }),
+      resolvePlugin({ runtimeDir, importMap, debug, cacheQueryString: options.cacheQueryString }),
       cssPlugin({ lightningcssBin: options.lightningcssBin, debug })
     ],
     metafile: write,

data/lib/proscenium/middleware/base.rb

@@ -60,8 +60,8 @@ module Proscenium
         response.content_type = content_type
         response['X-Proscenium-Middleware'] = name
 
-        if Proscenium.config.cache_query_string
-          response['Cache-Control'] = "public, max-age=#{2.days.to_i}"
+        if Proscenium.config.cache_query_string && Proscenium.config.cache_max_age
+          response['Cache-Control'] = "public, max-age=#{Proscenium.config.cache_max_age}"
         end
 
         yield response if block_given?

data/lib/proscenium/middleware/esbuild.rb

@@ -15,9 +15,11 @@ module Proscenium
 
       def attempt
         benchmark :esbuild do
-          render_response build(
-            "#{cli} --root #{root} --lightningcss-bin #{lightningcss_cli} #{path}"
-          )
+          render_response build([
+            "#{cli} --root #{root}",
+            cache_query_string,
+            "--lightningcss-bin #{lightningcss_cli} #{path}"
+          ].compact.join(' '))
         end
       rescue CompileError => e
         render_response "export default #{e.detail.to_json}" do |response|
@@ -33,9 +35,7 @@ module Proscenium
 
       def cli
         if ENV['PROSCENIUM_TEST']
-          [
-            'deno run -q --import-map import_map.json -A', 'lib/proscenium/compilers/esbuild.js'
-          ].join(' ')
+          'deno run -q --import-map import_map.json -A lib/proscenium/compilers/esbuild.js'
         else
           Gem.bin_path 'proscenium', 'esbuild'
         end
@@ -48,6 +48,11 @@ module Proscenium
           Gem.bin_path 'proscenium', 'lightningcss'
         end
       end
+
+      def cache_query_string
+        q = Proscenium.config.cache_query_string
+        q ? "--cache-query-string #{q}" : nil
+      end
     end
   end
 end

data/lib/proscenium/phlex/component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Proscenium::Phlex::Component < Proscenium::Phlex
+  private
+
+  def virtual_path
+    "/#{self.class.name.underscore}"
+  end
+end

data/lib/proscenium/phlex/react_component.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Renders a div for use with component-manager.
+#
+class Proscenium::Phlex::ReactComponent < Proscenium::Phlex::Component
+  attr_accessor :props, :lazy
+
+  # @param props: [Hash]
+  # @param lazy: [Boolean] Lazy load the component using IntersectionObserver. Default: true.
+  def initialize(props: {}, lazy: true) # rubocop:disable Lint/MissingSuper
+    @props = props
+    @lazy = lazy
+  end
+
+  # @yield the given block to a `div` within the top level component div. If not given,
+  #   `<div>loading...</div>` will be rendered. Use this to display a loading UI while the component
+  #   is loading and rendered.
+  def template(&block)
+    div class: ['componentManagedByProscenium', '@component'],
+        data: { component: { path: virtual_path, props: props, lazy: lazy }.to_json } do
+      block ? div(&block) : div { 'loading...' }
+    end
+  end
+end

data/lib/proscenium/phlex.rb

@@ -1,7 +1,30 @@
 # frozen_string_literal: true
 
+require 'phlex'
+
 module Proscenium
   class Phlex < ::Phlex::View
+    extend ActiveSupport::Autoload
+
+    autoload :Component
+    autoload :ReactComponent
+
+    module Helpers
+      def side_load_javascripts(...)
+        if (output = @_view_context.side_load_javascripts(...))
+          @_target << output
+        end
+      end
+
+      %i[side_load_stylesheets proscenium_dev].each do |name|
+        define_method name do
+          if (output = @_view_context.send(name))
+            @_target << output
+          end
+        end
+      end
+    end
+
     module Sideload
       def template(...)
         Proscenium::SideLoad.append self.class.path if Rails.application.config.proscenium.side_load
@@ -18,6 +41,7 @@ module Proscenium
         child.path = path.delete_prefix(::Rails.root.to_s).delete_suffix('.rb')[1..]
 
         child.prepend Sideload
+        child.include Helpers
 
         super
       end

data/lib/proscenium/railtie.rb

@@ -29,6 +29,7 @@ module Proscenium
     config.proscenium = ActiveSupport::OrderedOptions.new
     config.proscenium.side_load = true
     config.proscenium.cache_query_string = Rails.env.production? && ENV.fetch('REVISION', nil)
+    config.proscenium.cache_max_age = 2_592_000 # 30 days
     config.proscenium.auto_reload = Rails.env.development?
     config.proscenium.auto_reload_paths ||= %w[lib app config]
     config.proscenium.auto_reload_extensions ||= /\.(css|jsx?)$/

data/lib/proscenium/runtime/auto_reload.js

@@ -1,5 +1,4 @@
-import { createConsumer } from 'https://esm.sh/@rails/actioncable@6.0.5'
-import debounce from 'https://esm.sh/debounce@1.2.1'
+import { createConsumer } from 'https://esm.sh/v96/@rails/actioncable@7.0.4/es2022/actioncable.js'
 
 export default socketPath => {
   const uid = (Date.now() + ((Math.random() * 100) | 0)).toString()
@@ -9,7 +8,7 @@ export default socketPath => {
     received: debounce(() => {
       console.log('[Proscenium] Files changed; reloading...')
       location.reload()
-    }, 200),
+    }, 200, true),
 
     connected() {
       console.log('[Proscenium] Auto-reload websocket connected')
@@ -20,3 +19,22 @@ export default socketPath => {
     }
   })
 }
+
+function debounce(func, wait, immediate) {
+  let timeout
+
+  return function () {
+    const args = arguments
+
+    const later = () => {
+      timeout = null
+      !immediate && func.apply(this, args)
+    }
+
+    const callNow = immediate && !timeout
+    clearTimeout(timeout)
+    timeout = setTimeout(later, wait)
+
+    callNow && func.apply(this, args)
+  }
+}

data/lib/proscenium/version.rb

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

data/{app/components → lib/proscenium/view_component}/react_component.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ReactComponent < ApplicationComponent
+class Proscenium::ViewComponent::ReactComponent < Proscenium::ViewComponent
   attr_accessor :props, :lazy
 
   # @param props: [Hash]
@@ -15,7 +15,7 @@ class ReactComponent < ApplicationComponent
   def call
     tag.div class: ['componentManagedByProscenium', css_module(:component)],
             data: { component: { path: virtual_path, props: props, lazy: lazy } } do
-      tag.div content
+      tag.div content || 'loading...'
     end
   end
 end

data/lib/proscenium/view_component.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-module Proscenium::ViewComponent
+require 'view_component'
+
+class Proscenium::ViewComponent < ViewComponent::Base
   extend ActiveSupport::Autoload
 
   autoload :TagBuilder
+  autoload :ReactComponent
 
   def render_in(...)
-    cssm.compile_class_names(super)
+    cssm.compile_class_names(super(...))
   end
 
   def before_render

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: x86_64-darwin
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -92,6 +92,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: phlex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -140,8 +154,6 @@ files:
 - README.md
 - app/channels/proscenium/connection.rb
 - app/channels/proscenium/reload_channel.rb
-- app/components/application_component.rb
-- app/components/react_component.rb
 - bin/esbuild
 - bin/lightningcss
 - config/routes.rb
@@ -171,6 +183,8 @@ files:
 - lib/proscenium/middleware/runtime.rb
 - lib/proscenium/middleware/static.rb
 - lib/proscenium/phlex.rb
+- lib/proscenium/phlex/component.rb
+- lib/proscenium/phlex/react_component.rb
 - lib/proscenium/precompile.rb
 - lib/proscenium/railtie.rb
 - lib/proscenium/runtime/auto_reload.js
@@ -180,6 +194,7 @@ files:
 - lib/proscenium/utils.js
 - lib/proscenium/version.rb
 - lib/proscenium/view_component.rb
+- lib/proscenium/view_component/react_component.rb
 - lib/proscenium/view_component/tag_builder.rb
 - lib/tasks/assets.rake
 homepage: https://github.com/joelmoss/proscenium

data/app/components/application_component.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'view_component'
-
-class ApplicationComponent < ViewComponent::Base
-  include Proscenium::ViewComponent
-end