proscenium 0.19.0.beta16-x86_64-linux → 0.19.0.test1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5918439e20e4d5d6369efe0024039308ed3883fbb62a9d9c8592ce5fbeffe739
-  data.tar.gz: 9d6c0eb5da2a7ac7ca64116f9276b09378d2efbcc148ac7306eaf29ae9e6f6d8
+  metadata.gz: 6008df04f1f7b06748556e9d54761d2e39fa28ed3583e343086a6549d8efce09
+  data.tar.gz: b3e7ed15208d7923f94d3208a8d7d4968fd3438256f1868bdf67b08cb9060a00
 SHA512:
-  metadata.gz: 29ab69f3f678c96c7a33613573d111058e70b8280c609c6267da2285af31b7edb9a2ed920bea08a61541d518e835db42da7a3d9f9d9d3c7d0775607dbfffae2a
-  data.tar.gz: 97459db33bf3cd2534ce10839dbf33c0bd6b7f210e4140e9669345c0afb0fc308a6126e9149c747119374550511660147d841cf3d0bd19d4405c9dc70f8bf1fd
+  metadata.gz: 0c9b49b3fb6379c29873e5c128993053fa143dbfd9586d3ceab02ad40450922809051d1f390be8b9154f12629763d36a09116604976e79a1711f477a57b5b281
+  data.tar.gz: 32da1d543ae84ec296cc8045b4d018c825e4910df0b1c002d45ee3e1b18a3e39d82ace95ff872eabbec88d39009c0573249e28bebb90acf795776b8e1ceda444

data/README.md

@@ -49,6 +49,7 @@
 - [JSX](#jsx)
 - [JSON](#json)
 - [Phlex Support](#phlex-support)
+- [ViewComponent Support](#viewcomponent-support)
 - [Cache Busting](#cache-busting)
 - [rjs is back!](#rjs-is-back)
 - [Resolution](#resolution)
@@ -768,6 +769,49 @@ end
 <h1 class="user_name-ABCD1234 title">Joel Moss</h1>
 ```
 
+## ViewComponent Support
+
+[ViewComponent](https://viewcomponent.org/) iA framework for creating reusable, testable & encapsulated view components, built to integrate seamlessly with Ruby on Rails. Proscenium works perfectly with ViewComponent, with support for side-loading, CSS modules, and more. Simply write your ViewComponent classes and inherit from `Proscenium::ViewComponent`.
+
+```ruby
+class MyView < Proscenium::ViewComponent
+  def call
+    tag.h1 'Hello World'
+  end
+end
+```
+
+### Side-loading
+
+Any ViewComponent class that inherits `Proscenium::ViewComponent` will automatically be [side-loaded](#side-loading).
+
+### CSS Modules
+
+[CSS Modules](#css-modules) are fully supported in ViewComponent classes, with access to the [`css_module` helper](#in-your-views) if you need it.
+
+```ruby
+# /app/components/user_component.rb
+class UserComponent < Proscenium::ViewComponent
+  def view_template
+    div.h1 @user.name, class: css_module(:user_name)
+  end
+end
+```
+
+```css
+/* # /app/components/user_component.module.css */
+.userName {
+  color: red;
+  font-size: 50px;
+}
+```
+
+The view above will be rendered something like this:
+
+```html
+<h1 class="user_name-ABCD1234">Joel Moss</h1>
+```
+
 ## Cache Busting
 
 > _COMING SOON_

data/lib/proscenium/builder.rb

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

data/lib/proscenium/bundled_gems.rb

@@ -13,7 +13,7 @@ module Proscenium
         bundle = {}
         specs.each do |s|
           bundle[s.name] = if s.name == 'proscenium'
-                             Pathname(s.full_gem_path).join('lib/proscenium').to_s
+                             Pathname(s.full_gem_path).join('lib/proscenium/ui').to_s
                            else
                              s.full_gem_path
                            end

data/lib/proscenium/css_module.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module Proscenium::CssModule
+  extend ActiveSupport::Autoload
+
+  autoload :Path
+  autoload :Transformer
+
   class TransformError < StandardError
     def initialize(name, additional_msg = nil)
       msg = "Failed to transform CSS module `#{name}`"

data/lib/proscenium/middleware.rb

@@ -2,9 +2,15 @@
 
 module Proscenium
   class Middleware
+    extend ActiveSupport::Autoload
+
     # Error when the build command fails.
     class BuildError < StandardError; end
 
+    autoload :Base
+    autoload :Esbuild
+    autoload :RubyGems
+
     def initialize(app)
       @app = app
 

data/lib/proscenium/monkey.rb

@@ -9,8 +9,15 @@ module Proscenium
         result = super
         return result if !view.controller || !Proscenium.config.side_load
 
-        to_sideload = if template.respond_to?(:virtual_path) &&
-                         template.respond_to?(:type) && template.type == :html
+        renderable = template.instance_variable_get(:@renderable)
+
+        to_sideload = if Object.const_defined?(:ViewComponent) &&
+                         template.is_a?(ActionView::Template::Renderable) &&
+                         renderable.class < ::ViewComponent::Base &&
+                         renderable.class.format == :html
+                        renderable
+                      elsif template.respond_to?(:virtual_path) &&
+                            template.respond_to?(:type) && template.type == :html
                         template
                       end
         if to_sideload

data/lib/proscenium/phlex.rb

@@ -4,6 +4,12 @@ require 'phlex-rails'
 
 module Proscenium
   class Phlex < ::Phlex::HTML
+    extend ActiveSupport::Autoload
+
+    autoload :CssModules
+    autoload :ReactComponent
+    autoload :AssetInclusions
+
     include Proscenium::SourcePath
     include CssModules
     include AssetInclusions

data/lib/proscenium/railtie.rb

@@ -14,7 +14,9 @@ module Proscenium
     config.proscenium.bundle = true
     config.proscenium.side_load = true
     config.proscenium.code_splitting = true
+
     config.proscenium.ensure_loaded = :raise
+
     config.proscenium.cache_query_string = Rails.env.production? && ENV.fetch('REVISION', nil)
     config.proscenium.cache_max_age = 2_592_000 # 30 days
 
@@ -33,9 +35,17 @@ module Proscenium
       end
     end
 
+    initializer 'proscenium.ui' do
+      ActiveSupport::Inflector.inflections(:en) do |inflect|
+        inflect.acronym 'UI'
+      end
+    end
+
     initializer 'proscenium.debugging' do
-      tpl_path = root.join('lib', 'proscenium', 'templates').to_s
-      ActionDispatch::DebugView::RESCUES_TEMPLATE_PATHS << tpl_path
+      if Rails.gem_version >= Gem::Version.new('7.1.0')
+        tpl_path = root.join('lib', 'proscenium', 'templates').to_s
+        ActionDispatch::DebugView::RESCUES_TEMPLATE_PATHS << tpl_path
+      end
     end
 
     initializer 'proscenium.middleware' do |app|
@@ -55,5 +65,15 @@ module Proscenium
         ActionView::PartialRenderer.prepend Monkey::PartialRenderer
       end
     end
+
+    initializer 'proscenium.public_path' do |app|
+      if app.config.public_file_server.enabled
+        headers = app.config.public_file_server.headers || {}
+        index = app.config.public_file_server.index_name || 'index'
+
+        app.middleware.insert_after(ActionDispatch::Static, ActionDispatch::Static,
+                                    root.join('public').to_s, index:, headers:)
+      end
+    end
   end
 end

data/lib/proscenium/react_componentable.rb

@@ -11,7 +11,7 @@ module Proscenium
       # The HTML tag to use as the wrapping element for the component. You can reassign this in your
       # component class to use a different tag:
       #
-      #   class MyComponent < Proscenium::Phlex::ReactComponent
+      #   class MyComponent < Proscenium::ViewComponent::ReactComponent
       #     self.root_tag = :span
       #   end
       #

data/lib/proscenium/registry/bundled_package.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rubygems/package'
+
+class Proscenium::Registry
+  class BundledPackage < Package
+    def version = @version ||= spec.version.to_s
+
+    private
+
+    def package_json
+      @package_json ||= begin
+        unless (gem_path = Proscenium::BundledGems.pathname_for(gem_name))
+          raise PackageNotInstalledError, name
+        end
+
+        if (package_path = gem_path.join('package.json')).exist?
+          JSON.parse(package_path.read)
+        else
+          default_package_json
+        end
+      end
+    end
+
+    def spec
+      @spec ||= Bundler.load.specs[gem_name].first
+    end
+  end
+end

data/lib/proscenium/registry/package.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class Proscenium::Registry
+  # 1. Fetch the gem metadata from RubyGems API.
+  # 2. Extract any package.json from the gem, and populate the response with it.
+  # 3. Create a tarball containing the fetched package.json. This will be downloaded by the npm
+  #    client, and unpacked into node_modules. Proscenium ignores this, as it will pull contents
+  #    directly from location of the installed gem.
+  # 4. Return a valid npm response listing package details, tarball location, and its dependencies.
+  #
+  # See https://wiki.commonjs.org/wiki/Packages/Registry
+  class Package
+    extend Literal::Properties
+
+    prop :name, String, :positional, reader: :private
+    prop :version, _String?
+    prop :host, String
+
+    def as_json
+      {
+        name:,
+        'dist-tags': {
+          latest: version
+        },
+        versions: {
+          version => {
+            name:,
+            version:,
+            dependencies: package_json['dependencies'] || {},
+            dist: {
+              tarball:,
+              integrity:,
+              shasum:
+            }
+          }
+        }
+      }
+    end
+
+    def validate!
+      return self if name.start_with?('@rubygems/')
+
+      raise PackageUnsupportedError, name
+    end
+
+    def gem_name = @gem_name ||= name.gsub('@rubygems/', '')
+    def version = @version # rubocop:disable Style/TrivialAccessors
+    def shasum = Digest::SHA1.file(tarball_path).hexdigest
+    def integrity = "sha512-#{Digest::SHA512.file(tarball_path).base64digest}"
+
+    private
+
+    def tarball
+      create_tarball unless tarball_path.exist?
+
+      "#{@host}/#{tarball_path.relative_path_from(Rails.public_path)}"
+    end
+
+    def tarball_name
+      @tarball_name ||= "#{gem_name}-#{version}"
+    end
+
+    def tarball_path
+      @tarball_path ||= Rails.public_path.join('proscenium_registry_tarballs')
+                             .join("@rubygems/#{gem_name}/#{tarball_name}.tgz")
+    end
+
+    def create_tarball
+      FileUtils.mkdir_p(File.dirname(tarball_path))
+
+      File.open(tarball_path, 'wb') do |file|
+        Zlib::GzipWriter.wrap(file) do |gz|
+          Gem::Package::TarWriter.new(gz) do |tar|
+            contents = package_json.to_json
+            tar.add_file_simple('package/package.json', 0o444, contents.length) do |io|
+              io.write contents
+            end
+          end
+        end
+      end
+    end
+
+    def package_json
+      @package_json ||= default_package_json
+    end
+
+    def default_package_json
+      {
+        name:,
+        version:,
+        dependencies: {}
+      }
+    end
+  end
+end

data/lib/proscenium/registry/ruby_gem_package.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'gems'
+
+class Proscenium::Registry
+  class RubyGemPackage < Package
+    def version = spec['version']
+
+    private
+
+    def package_json
+      @package_json ||= begin
+        package_path = Proscenium::RubyGems.path_for(gem_name, version).join('package.json')
+        if package_path.exist?
+          JSON.parse path.read
+        else
+          default_package_json
+        end
+      end
+    end
+
+    def spec
+      @spec ||= if @version.present?
+                  Gems::V2.info gem_name, @version
+                else
+                  Gems.info(gem_name)
+                end
+    end
+  end
+end

data/lib/proscenium/registry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Proscenium::Registry
+  extend ActiveSupport::Autoload
+
+  autoload :Package
+  autoload :BundledPackage
+  autoload :RubyGemPackage
+
+  class PackageUnsupportedError < StandardError
+    def initialize(name)
+      super("Package `#{name}` is not valid; only Ruby gems are supported via the @rubygems scope.")
+    end
+  end
+
+  class PackageNotInstalledError < StandardError
+    def initialize(name)
+      super("Package `#{name}` is not found in your bundle; have you installed the Ruby gem?")
+    end
+  end
+
+  def self.bundled_package(name, host:)
+    BundledPackage.new(name, host:).validate!
+  end
+
+  def self.ruby_gem_package(name, version, host:)
+    RubyGemPackage.new(name, version:, host:).validate!
+  end
+end

data/lib/proscenium/resolver.rb

@@ -19,7 +19,16 @@ module Proscenium
       end
 
       self.resolved[path] ||= if (gem = BundledGems.paths.find { |_, v| path.start_with? "#{v}/" })
+                                # If the path is a rubygem, and it is installed with npm via the
+                                # @rubygems scope, then resolve the path to the symlinked location
+                                # in node_modules.
+                                # npm_path = Rails.root.join("node_modules/@rubygems/#{gem.first}")
+                                # if npm_path.symlink?
+                                #   npm_path.realpath.join(path.sub(/^#{gem.last}/, '.')).to_s
+                                #           .delete_prefix(Rails.root.to_s)
+                                # else
                                 path.sub(/^#{gem.last}/, "/node_modules/@rubygems/#{gem.first}")
+                                # end
                               elsif path.start_with?("#{Rails.root}/")
                                 path.delete_prefix Rails.root.to_s
                               else

data/lib/proscenium/ruby_gems.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'rubygems/package'
+require 'rubygems/remote_fetcher'
+
+module Proscenium
+  class RubyGems
+    def self.path_for(name, version = nil)
+      Pathname new(name, version).path
+    end
+
+    def initialize(name, version = nil)
+      @name = name
+      @version = version
+    end
+
+    def path
+      dependency = Gem::Dependency.new @name, @version
+      path = gem_path dependency
+
+      raise "Gem '#{@name}' not installed nor fetchable." unless path
+
+      basename = File.basename path, '.gem'
+      target_dir = File.expand_path basename, Rails.root.join('tmp', 'unpacked_gems')
+
+      Gem::Package.new(path).extract_files target_dir
+
+      target_dir
+    end
+
+    # Find cached filename in Gem.path. Returns nil if the file cannot be found.
+    def find_in_cache(filename)
+      Gem.path.each do |path|
+        this_path = File.join(path, 'cache', filename)
+        return this_path if File.exist? this_path
+      end
+
+      nil
+    end
+
+    # Return the full path to the cached gem file matching the given
+    # name and version requirement.  Returns 'nil' if no match.
+    #
+    # Example:
+    #
+    #   get_path 'rake', '> 0.4' # "/usr/lib/ruby/gems/1.8/cache/rake-0.4.2.gem"
+    #   get_path 'rake', '< 0.1' # nil
+    #   get_path 'rak'           # nil (exact name required)
+    def gem_path(dependency)
+      return dependency.name if /\.gem$/i.match?(dependency.name)
+
+      specs = dependency.matching_specs
+      selected = specs.max_by(&:version)
+
+      return Gem::RemoteFetcher.fetcher.download_to_cache(dependency) unless selected
+      return unless /^#{selected.name}$/i.match?(dependency.name)
+
+      # We expect to find (basename).gem in the 'cache' directory. Furthermore,
+      # the name match must be exact (ignoring case).
+      path = find_in_cache File.basename selected.cache_file
+
+      return Gem::RemoteFetcher.fetcher.download_to_cache(dependency) unless path
+
+      path
+    end
+  end
+end

data/lib/proscenium/ui/breadcrumbs/component.module.css

@@ -0,0 +1,14 @@
+@layer proscenium-ui-component {
+  /*
+   * Properties:
+   *
+   *   --puiBreadcrumbs--link-color: LinkText;
+   *   --puiBreadcrumbs--link-hover-color: HighlightText;
+   *   --puiBreadcrumbs--separator-color: GrayText;
+   *   --puiBreadcrumbs--separator: url("/proscenium/icons/angle-right-regular.svg");
+   */
+
+  .base {
+    @mixin breadcrumbs from url("./mixins.css");
+  }
+}

data/lib/proscenium/ui/breadcrumbs/component.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Proscenium::UI
+  class Breadcrumbs::Component < Component
+    extend Literal::Properties
+    include Phlex::Rails::Helpers::URLFor
+
+    # The path (route) to use as the HREF for the home segment. Defaults to `:root`.
+    prop :home_path, _Union(String, Symbol), default: -> { :root }
+
+    # Assign false to hide the home segment.
+    prop :with_home, _Boolean, default: -> { true }
+
+    def view_template
+      div class: :@base do
+        ol do
+          if @with_home
+            li do
+              home_template
+            end
+          end
+
+          breadcrumbs.each do |ce|
+            li do
+              path = ce.path
+              path.nil? ? ce.name : a(href: url_for(path)) { ce.name }
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    # Override this to customise the home breadcrumb. You can call super with a block to use the
+    # default template, but with custom content.
+    #
+    # @example
+    #  def home_template
+    #    super { 'hello' }
+    #  end
+    def home_template(&block)
+      a(href: url_for(@home_path)) do
+        if block
+          yield
+        else
+          svg role: 'img', xmlns: 'http://www.w3.org/2000/svg', viewBox: '0 0 576 512' do |s|
+            s.path fill: 'currentColor',
+                   d: 'M488 312.7V456c0 13.3-10.7 24-24 24H348c-6.6 0-12-5.4-12-12V356c0-6.6-5.4-' \
+                      '12-12-12h-72c-6.6 0-12 5.4-12 12v112c0 6.6-5.4 12-12 12H112c-13.3 0-24-10.' \
+                      '7-24-24V312.7c0-3.6 1.6-7 4.4-9.3l188-154.8c4.4-3.6 10.8-3.6 15.3 0l188 15' \
+                      '4.8c2.7 2.3 4.3 5.7 4.3 9.3zm83.6-60.9L488 182.9V44.4c0-6.6-5.4-12-12-12h-' \
+                      '56c-6.6 0-12 5.4-12 12V117l-89.5-73.7c-17.7-14.6-43.3-14.6-61 0L4.4 251.8c' \
+                      '-5.1 4.2-5.8 11.8-1.6 16.9l25.5 31c4.2 5.1 11.8 5.8 16.9 1.6l235.2-193.7c4' \
+                      '.4-3.6 10.8-3.6 15.3 0l235.2 193.7c5.1 4.2 12.7 3.5 16.9-1.6l25.5-31c4.2-5' \
+                      '.2 3.4-12.7-1.7-16.9z'
+          end
+        end
+      end
+    end
+
+    # Don't render if @hide_breadcrumbs is true.
+    def render?
+      helpers.assigns['hide_breadcrumbs'] != true
+    end
+
+    def breadcrumbs
+      helpers.controller.breadcrumbs.map { |e| Breadcrumbs::ComputedElement.new e, helpers }
+    end
+  end
+end

data/lib/proscenium/ui/breadcrumbs/computed_element.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Proscenium::UI::Breadcrumbs
+  class ComputedElement
+    def initialize(element, context)
+      @element = element
+      @context = context
+    end
+
+    # If name is a Symbol of a controller method, that method is called.
+    # If name is a Symbol of a controller instance variable, that variable is returned.
+    # If name is a Proc, it is executed in the context of the controller instance.
+    #
+    # @return [String] the content of the breadcrumb element.
+    def name
+      @name ||= case name = @element.name
+                when Symbol
+                  if name.to_s.starts_with?('@')
+                    name = get_instance_variable(name)
+                    name.respond_to?(:for_breadcrumb) ? name.for_breadcrumb : name.to_s
+                  else
+                    res = @context.controller.send(name)
+                    res.try(:for_breadcrumb) || res.to_s
+                  end
+                when Proc
+                  @context.controller.instance_exec(&name)
+                else
+                  name.respond_to?(:for_breadcrumb) ? name.for_breadcrumb : name.to_s
+                end
+    end
+
+    # If path is a Symbol of a controller method, that method is called.
+    # If path is a Symbol of a controller instance variable, that variable is returned.
+    # If path is an Array, each element is processed as above.
+    # If path is a Proc, it is executed in the context of the controller instance.
+    #
+    # No matter what, the result is always passed to `url_for` before being returned.
+    #
+    # @return [String] the URL for the element
+    def path
+      @path ||= unless @element.path.nil?
+                  case path = @element.path
+                  when Array
+                    path.map! { |x| x.to_s.starts_with?('@') ? get_instance_variable(x) : x }
+                  when Symbol
+                    if path.to_s.starts_with?('@')
+                      path = get_instance_variable(path)
+                    elsif @context.controller.respond_to?(path, true)
+                      path = @context.controller.send(path)
+                    end
+                  when Proc
+                    path = @context.controller.instance_exec(&path)
+                  end
+
+                  @context.url_for path
+                end
+    end
+
+    private
+
+    def get_instance_variable(element)
+      unless @context.instance_variable_defined?(element)
+        raise NameError, "undefined instance variable `#{element}' for breadcrumb", caller
+      end
+
+      @context.instance_variable_get element
+    end
+  end
+end