proscenium-view_component 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a456f5347c34b3cc3493a5fad3ebe4d040c94a38aab761b1a66a7f69d4ee69e2
+  data.tar.gz: 9b78f7e2ab948e3045c38390551e6b1e971e9671536613ac034b92ae2a1af988
+SHA512:
+  metadata.gz: e936e9332f9d83e13247564744e834b792386a24d1cfacfda735b749186f0aa5044d2734416872b202418a188216570e2ea98dead25ea4a20fc444f98e270543
+  data.tar.gz: f3b61b88680a7f4591a568c5f3b25f71bb823472993c8a1a2a79f0775ce689d4ad3d9d8ae3843c62668d6afc7246ed53344cd52633bbb2bc096bb2b309169bdd

data/.rubocop.yml

@@ -0,0 +1,47 @@
+plugins:
+  - rubocop-rails
+  - rubocop-minitest
+  - rubocop-disable_syntax
+  - rubocop-capybara
+  - rubocop-packaging
+  - rubocop-rake
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "gemfiles/**/*"
+
+Layout/LineLength:
+  Max: 100
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "test/**/*"
+
+Metrics:
+  Enabled: false
+
+Style/DisableSyntax:
+  DisableSyntax:
+    - unless
+    - and_or_not
+    - numbered_parameters
+
+Style/CaseEquality:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/NegatedIf:
+  Enabled: false
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false
+Minitest/MultipleAssertions:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Joel Moss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Proscenium::ViewComponent
+
+Enhances [ViewComponent](https://viewcomponent.org/) by integrating it with the [Proscenium](https://proscenium.rocks/) framework. It supports automatic side-loading of assets, and CSS Modules for scoped styling.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add proscenium-view_component
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install proscenium-view_component
+```
+
+## Usage
+
+Simply write your ViewComponent classes and inherit from `Proscenium::ViewComponent::Base`.
+
+```ruby
+class MyView < Proscenium::ViewComponent::Base
+  def call
+    tag.h1 'Hello World'
+  end
+end
+```
+
+### Side-loading
+
+Any ViewComponent class that inherits `Proscenium::ViewComponent::Base` will automatically be [side-loaded](https://github.com/joelmoss/proscenium?tab=readme-ov-file#side-loading).
+
+### CSS Modules
+
+[CSS Modules](https://github.com/joelmoss/proscenium?tab=readme-ov-file#css-modules) are fully supported in ViewComponent classes, with access to the [`css_module` helper](https://github.com/joelmoss/proscenium?tab=readme-ov-file#in-your-views) if you need it.
+
+```ruby
+# /app/components/user_component.rb
+class UserComponent < Proscenium::ViewComponent::Base
+  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>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/proscenium-view_component.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/lib/proscenium/view_component/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Proscenium::ViewComponent
+  class Base < ::ViewComponent::Base
+    include Proscenium::SourcePath
+    include CssModules
+
+    class_attribute :sideload_assets_options
+
+    class << self
+      attr_accessor :abstract_class
+
+      def inherited(child)
+        child.prepend Sideload
+
+        super
+      end
+
+      def sideload_assets(value)
+        self.sideload_assets_options = value
+      end
+    end
+  end
+end

data/lib/proscenium/view_component/css_modules.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Proscenium
+  module ViewComponent::CssModules
+    include Proscenium::CssModule
+
+    def self.included(base)
+      base.extend Proscenium::CssModule::Path
+    end
+  end
+end

data/lib/proscenium/view_component/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Proscenium
+  module ViewComponent
+    class Engine < ::Rails::Engine
+      isolate_namespace Proscenium::ViewComponent
+    end
+  end
+end

data/lib/proscenium/view_component/react_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Proscenium::ViewComponent
+  # Renders a <div> for use with React components, with data attributes specifying the component
+  # path and props.
+  #
+  # If a content block is given, that content will be rendered inside the component, allowing for a
+  # "loading" UI. If no block is given, then a "loading..." text will be rendered. It is intended
+  # that the component is mounted to this div, and the loading UI will then be replaced with the
+  # component's rendered output.
+  class ReactComponent < Base
+    self.abstract_class = true
+
+    include Proscenium::ReactComponentable
+
+    def call
+      tag.send root_tag, data: data_attributes do
+        tag.div content || 'loading...'
+      end
+    end
+  end
+end

data/lib/proscenium/view_component/sideload.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Proscenium::ViewComponent
+  module Sideload
+    def before_render
+      Proscenium::SideLoad.sideload_inheritance_chain self, controller.sideload_assets_options
+
+      super
+    end
+  end
+end

data/lib/proscenium/view_component/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Proscenium
+  module ViewComponent
+    VERSION = '0.1.0.beta1'
+  end
+end

data/lib/proscenium/view_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'proscenium'
+require 'view_component'
+
+module Proscenium
+  module ViewComponent
+    class Error < StandardError; end
+
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Sideload
+    autoload :ReactComponent
+    autoload :CssModules
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: proscenium-view_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- Joel Moss
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: proscenium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0.beta17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0.beta17
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.22.0
+description: Proscenium integration for ViewComponent
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/proscenium/view_component.rb
+- lib/proscenium/view_component/base.rb
+- lib/proscenium/view_component/css_modules.rb
+- lib/proscenium/view_component/engine.rb
+- lib/proscenium/view_component/react_component.rb
+- lib/proscenium/view_component/sideload.rb
+- lib/proscenium/view_component/version.rb
+homepage: https://github.com/joelmoss/proscenium-view_component
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joelmoss/proscenium-view_component
+  source_code_uri: https://github.com/joelmoss/proscenium-view_component
+  changelog_uri: https://github.com/joelmoss/proscenium-view_component/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Proscenium integration for ViewComponent
+test_files: []