proscenium 0.1.0.alpha1-x86_64-darwin

data/lib/proscenium/side_load.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Proscenium
+  module SideLoad
+    DEFAULT_EXTENSIONS = %i[js css].freeze
+    EXTENSIONS = %i[js css].freeze
+
+    class NotFound < StandardError
+      def initialize(pathname)
+        @pathname = pathname
+        super
+      end
+
+      def message
+        "#{@pathname} does not exist"
+      end
+    end
+
+    module_function
+
+    # Side load the given asset `path`, by appending it to `Proscenium::Current.loaded`, which is a
+    # Set of 'js' and 'css' asset paths. This is safe to call multiple times, as it uses Set's.
+    # Meaning that side loading will never include duplicates.
+    def append(path, *extensions)
+      Proscenium::Current.loaded ||= EXTENSIONS.to_h { |e| [e, Set[]] }
+
+      unless (unknown_extensions = extensions.difference(EXTENSIONS)).empty?
+        raise ArgumentError, "unsupported extension(s): #{unknown_extensions.join(',')}"
+      end
+
+      loaded_types = []
+
+      (extensions.empty? ? DEFAULT_EXTENSIONS : extensions).each do |ext|
+        path_with_ext = "#{path}.#{ext}"
+        ext = ext.to_sym
+
+        next if Proscenium::Current.loaded[ext].include?(path_with_ext)
+        next unless Rails.root.join(path_with_ext).exist?
+
+        Proscenium::Current.loaded[ext] << path_with_ext
+        loaded_types << ext
+      end
+
+      !loaded_types.empty? && Rails.logger.debug do
+        "[Proscenium] Side loaded /#{path}.(#{loaded_types.join(',')})"
+      end
+    end
+
+    # Like #append, but only accepts a single `path` argument, which must be a Pathname. Raises
+    # `NotFound` if path does not exist,
+    def append!(pathname)
+      Proscenium::Current.loaded ||= EXTENSIONS.to_h { |e| [e, Set[]] }
+
+      unless pathname.is_a?(Pathname)
+        raise ArgumentError, "Argument `pathname` (#{pathname}) must be a Pathname"
+      end
+
+      ext = pathname.extname.sub('.', '').to_sym
+      path = pathname.relative_path_from(Rails.root).to_s
+
+      raise ArgumentError, "unsupported extension: #{ext}" unless EXTENSIONS.include?(ext)
+
+      return if Proscenium::Current.loaded[ext].include?(path)
+
+      raise NotFound, path unless pathname.exist?
+
+      Proscenium::Current.loaded[ext] << path
+
+      Rails.logger.debug "[Proscenium] Side loaded /#{path}"
+    end
+
+    module Monkey
+      module TemplateRenderer
+        private
+
+        def render_template(view, template, layout_name, locals)
+          if template.respond_to?(:virtual_path) &&
+             template.respond_to?(:type) && template.type == :html
+            if (layout = layout_name && find_layout(layout_name, locals.keys, [formats.first]))
+              Proscenium::SideLoad.append "app/views/#{layout.virtual_path}" # layout
+            end
+
+            if template.respond_to?(:variant) && template.variant
+              Proscenium::SideLoad.append "app/views/#{template.virtual_path}+#{template.variant}"
+            end
+
+            # The variant template may not exist (above), so we try the regular non-variant path.
+            Proscenium::SideLoad.append "app/views/#{template.virtual_path}"
+          end
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/proscenium/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Proscenium
+  VERSION = '0.1.0.alpha1'
+end

data/lib/proscenium/view_component/tag_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Proscenium::ViewComponent::TagBuilder < ActionView::Helpers::TagHelper::TagBuilder
+  def tag_options(options, escape = true) # rubocop:disable Style/OptionalBooleanParameter
+    super(css_module_option(options), escape)
+  end
+
+  private
+
+  def css_module_option(options)
+    return options if options.blank?
+
+    unless (css_module = options.delete(:css_module) || options.delete('css_module'))
+      return options
+    end
+
+    css_module = @view_context.css_module(css_module)
+
+    options.tap do |x|
+      x[:class] = "#{css_module} #{options.delete(:class) || options.delete('class')}".strip
+    end
+  end
+end

data/lib/proscenium/view_component.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Proscenium::ViewComponent
+  extend ActiveSupport::Autoload
+
+  autoload :TagBuilder
+
+  def before_render
+    side_load_assets unless self.class < ReactComponent
+  end
+
+  def css_module(name)
+    cssm.class_names(name.to_s.camelize(:lower)).join ' '
+  end
+
+  private
+
+  # Side load any CSS/JS assets for the component. This will side load any `index.{css|js}` in
+  # the component directory.
+  def side_load_assets
+    Proscenium::SideLoad.append asset_path if Rails.application.config.proscenium.side_load
+  end
+
+  def asset_path
+    @asset_path ||= "app/components#{virtual_path}"
+  end
+
+  def cssm
+    @cssm ||= Proscenium::CssModule.new(asset_path)
+  end
+
+  # Overrides ActionView::Helpers::TagHelper::TagBuilder, allowing us to intercept the
+  # `css_module` option from the HTML options argument of the `tag` and `content_tag` helpers, and
+  # prepend it to the HTML `class` attribute.
+  def tag_builder
+    @tag_builder ||= Proscenium::ViewComponent::TagBuilder.new(self)
+  end
+end

data/lib/proscenium.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_support/dependencies/autoload'
+
+module Proscenium
+  extend ActiveSupport::Autoload
+
+  autoload :Current
+  autoload :Middleware
+  autoload :SideLoad
+  autoload :CssModule
+  autoload :ViewComponent
+  autoload :Helper
+  autoload :LinkToHelper
+  autoload :Precompile
+end
+
+require 'proscenium/railtie'

data/lib/tasks/assets.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+namespace :proscenium do
+  desc 'Compile all your assets with Proscenium'
+  task precompile: :environment do
+    puts 'Precompiling assets with Proscenium...'
+    Proscenium::Precompile.call
+    puts 'Proscenium successfully precompiled your assets 🎉'
+  end
+end
+
+if Rake::Task.task_defined?('assets:precompile')
+  Rake::Task['assets:precompile'].enhance do
+    Rake::Task['proscenium:precompile'].invoke
+  end
+else
+  Rake::Task.define_task('assets:precompile' => ['proscenium:precompile'])
+  Rake::Task.define_task('assets:clean') # null task just so Heroku builds don't fail
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: proscenium
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha1
+platform: x86_64-darwin
+authors:
+- Joel Moss
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description:
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- README.md
+- lib/proscenium.rb
+- lib/proscenium/cli/argument_error.js
+- lib/proscenium/cli/builders/index.js
+- lib/proscenium/cli/builders/javascript.js
+- lib/proscenium/cli/builders/react.js
+- lib/proscenium/cli/builders/solid.js
+- lib/proscenium/cli/esbuild/env_plugin.js
+- lib/proscenium/cli/esbuild/resolve_plugin.js
+- lib/proscenium/cli/esbuild/solidjs_plugin.js
+- lib/proscenium/cli/js_builder.js
+- lib/proscenium/cli/solid.js
+- lib/proscenium/cli/utils.js
+- lib/proscenium/compiler.js
+- lib/proscenium/compilers/esbuild.bench.js
+- lib/proscenium/compilers/esbuild.js
+- lib/proscenium/compilers/esbuild/argument_error.js
+- lib/proscenium/compilers/esbuild/env_plugin.js
+- lib/proscenium/compilers/esbuild/resolve_plugin.js
+- lib/proscenium/compilers/esbuild/setup_plugin.js
+- lib/proscenium/css_module.rb
+- lib/proscenium/current.rb
+- lib/proscenium/helper.rb
+- lib/proscenium/link_to_helper.rb
+- lib/proscenium/middleware.rb
+- lib/proscenium/middleware/base.rb
+- lib/proscenium/middleware/esbuild.rb
+- lib/proscenium/middleware/parcel_css.rb
+- lib/proscenium/middleware/runtime.rb
+- lib/proscenium/middleware/static.rb
+- lib/proscenium/precompile.rb
+- lib/proscenium/railtie.rb
+- lib/proscenium/runtime/auto_reload.js
+- lib/proscenium/runtime/component_manager/index.js
+- lib/proscenium/runtime/component_manager/render_component.js
+- lib/proscenium/runtime/import_css.js
+- lib/proscenium/runtime/react_shim/index.js
+- lib/proscenium/runtime/react_shim/package.json
+- lib/proscenium/side_load.rb
+- lib/proscenium/version.rb
+- lib/proscenium/view_component.rb
+- lib/proscenium/view_component/tag_builder.rb
+- lib/tasks/assets.rake
+homepage: https://github.com/joelmoss/proscenium
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joelmoss/proscenium
+  source_code_uri: https://github.com/joelmoss/proscenium
+  changelog_uri: https://github.com/joelmoss/proscenium/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: The engine powering your Rails frontend
+test_files: []