superview 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95b73938446d68225ef15422d94071e4cdf77856aedb64f9f9b96aca8dd75217
-  data.tar.gz: 27e686bdfacf05a9d265ba919cf5a2ad2d87a074975ccc33871f2f20498555df
+  metadata.gz: 76c8014ae40d2045b7ad8f93e8005aa7f3af1cfc7568579e2dea783c16c94840
+  data.tar.gz: db2d98cf482c7c8055a58758b3c409f6f48694fd6b114fe5045803cbac53cf96
 SHA512:
-  metadata.gz: 6e7ddd62b1cbb25eb2e5a3f45f1b161c2973bb8ba33af94469141d2bad9f27f6925d2f3d6af3e777f338e1b9943111277e8250ff56ad7a7ee255ed8ad416ca95
-  data.tar.gz: 14549c8278d4d55f0f497c27ef26a7b5208d83e7b3c9e4d3cb98a175856986713109d3f630ba8feada62ea6da269f4bc9b006a58c0ac00b62329f49feeb11974
+  metadata.gz: 92697e127638e7ca678b97ca776131a9e4ca1ccae741b62bab41deea80e6e6d268fb7d37abff2dc0dbae9004e0a6973ff56c51fa1bbb6a7a40d1cd1f7c82d4ba
+  data.tar.gz: a806923fbf0f9048b9deafe38a8eb1f5f2ed933acb0095c38c222f17c01e0378c6518931018ece0d41b41d70659e519dae641d467f6f6d04bebc041c0ea23bcf

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    superview (0.1.3)
-      phlex-rails (>= 1.0, < 3.0)
+    superview (1.0.0)
       zeitwerk (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (8.0.1)
-      actionview (= 8.0.1)
-      activesupport (= 8.0.1)
+    actionpack (7.2.2.1)
+      actionview (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
       nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
+      racc
+      rack (>= 2.2.4, < 3.2)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actionview (8.0.1)
-      activesupport (= 8.0.1)
+    actionview (7.2.2.1)
+      activesupport (= 7.2.2.1)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (8.0.1)
+    activesupport (7.2.2.1)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -36,7 +36,6 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
     base64 (0.2.0)
     benchmark (0.4.0)
     bigdecimal (3.1.8)
@@ -58,10 +57,11 @@ GEM
     loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
+    method_source (1.1.0)
     minitest (5.25.4)
-    nokogiri (1.17.2-arm64-darwin)
+    nokogiri (1.18.0-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.17.2-x86_64-linux)
+    nokogiri (1.18.0-x86_64-linux-gnu)
       racc (~> 1.4)
     phlex (1.11.0)
     phlex-rails (1.2.2)
@@ -85,9 +85,9 @@ GEM
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.1)
-      actionpack (= 8.0.1)
-      activesupport (= 8.0.1)
+    railties (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -120,8 +120,11 @@ GEM
     thor (1.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    uri (1.0.2)
     useragent (0.16.11)
+    view_component (3.0.0)
+      activesupport (>= 5.2.0, < 8.0)
+      concurrent-ruby (~> 1.0)
+      method_source (~> 1.0)
     zeitwerk (2.7.1)
 
 PLATFORMS
@@ -131,9 +134,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  phlex-rails (>= 1.0, < 3.0)
   rake (~> 13.0)
   rspec-rails (~> 7.0)
   superview!
+  view_component (~> 3.0.0)
 
 BUNDLED WITH
    2.4.8

data/README.md

@@ -1,8 +1,9 @@
 # Superview
 
-Build Rails applications, from the ground up, using [Phlex](https://www.phlex.fun/) components, like this.
+Build Rails applications, from the ground up, using [Phlex](https://www.phlex.fun/) or [ViewComponent](https://viewcomponent.org/) components, like this.
 
 ```ruby
+# ./app/controllers/posts_controller.rb
 class PostsController < ApplicationController
   include Superview::Actions
 
@@ -17,6 +18,21 @@ class PostsController < ApplicationController
     end
   end
 
+  class Edit < ViewComponent::Base
+    attr_accessor :post
+
+    def call
+      <<~HTML
+        <h1>Edit #{@post.title}</h1>
+        <form action="<%= post_path(@post) %>" method="post">
+          <input type="text" name="title" value="<%= @post.title %>">
+          <textarea name="body"><%= @post.body %></textarea>
+          <button type="submit">Save</button>
+        </form>
+      HTML
+    end
+  end
+
   private
     def load_post
       @post = Post.find(params[:id])
@@ -41,13 +57,22 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Install `phlex-rails` in your Rails application.
+Add `include Superview::Actions` to any controllers you'd like to render components as controller actions.
 
-    $ bin/rails generate phlex:install
+```ruby
+# ./app/controllers/posts_controller.rb
+class PostsController < ApplicationController
+   # 🚨 Add this 👇 to your controller 🚨
+  include Superview::Actions
 
-Then add `include Superview::Actions` to any controllers you'd like to render Phlex components.
+  # Your code...
+end
+```
+
+Then add classes to your controller that map to the actions you'd like to render. The `Show` class will render when the `PostsController#show` action is called and the `Edit` class will render when the `PostsController#edit` action is called.
 
 ```ruby
+# ./app/controllers/posts_controller.rb
 class PostsController < ApplicationController
   include Superview::Actions
 
@@ -62,6 +87,21 @@ class PostsController < ApplicationController
     end
   end
 
+  class Edit < ViewComponent::Base
+    attr_accessor :post
+
+    def call
+      <<~HTML
+        <h1>Edit #{@post.title}</h1>
+        <form action="<%= post_path(@post) %>" method="post">
+          <input type="text" name="title" value="<%= @post.title %>">
+          <textarea name="body"><%= @post.body %></textarea>
+          <button type="submit">Save</button>
+        </form>
+      HTML
+    end
+  end
+
   private
     def load_post
       @post = Post.find(params[:id])
@@ -69,13 +109,16 @@ class PostsController < ApplicationController
 end
 ```
 
-The `Show` class will render when the `PostsController#show` action is called. To use along side other formats or render manually, you can define the `PostsController#show` as you'd expect:
+### Explicit rendering
+
+You can explicitly render a component in a controller action method. In this example, we needed to render a the `Show` component in the `html` format and a JSON response in the `json` format.
 
 ```ruby
+# ./app/controllers/posts_controller.rb
 class PostsController < ApplicationController
   include Superview::Actions
 
-  before_action :load_post
+  # Your code...
 
   class Show < ApplicationComponent
     attr_accessor :post
@@ -88,28 +131,28 @@ class PostsController < ApplicationController
 
   def show
     respond_to do |format|
-      format.html { render phlex }
-      # These would also work...
+      # 👋 Renders the Show component
+      format.html { render component }
+
+      # 👉 These would also work...
       # format.html { render Show.new.tap { _1.post = @post } }
-      # format.html { render phlex Show.new }
-      # format.html { render phlex Show }
-      # format.html { render phlex :show }
+      # format.html { render component Show.new }
+      # format.html { render component Show }
+      # format.html { render component :show }
       format.json { render json: @post }
     end
   end
 
-  private
-    def load_post
-      @post = Post.find(params[:id])
-    end
+  # Your code...
 end
 ```
 
-### Rendering other Phlex actions from different actions
+### Rendering other classes from different actions
 
-It's common to have to render form actions from other actions when forms are saved. In this example the `create` method renders the `phlex New` view when the form is invalid.
+It's common to have to render form actions from other actions when forms are saved. In this example the `create` method renders the `component New` view when the form is invalid.
 
 ```ruby
+# ./app/controllers/posts_controller.rb
 class PostsController < ApplicationController
   include Superview::Actions
 
@@ -119,21 +162,19 @@ class PostsController < ApplicationController
     if @post.save
       redirect_to @post
     else
-      render phlex New
-      # These would also work...
+      # 👋 Renders the New component from the create action.
+      render component New
+
+      # 👉 These would also work...
       # render New.new.tap { _1.post = @post }
-      # render phlex New.new
-      # render phlex New
-      # render phlex :new
+      # render component New.new
+      # render component New
+      # render component :new
     end
   end
 
-  private
-    def load_post
-      @post = Post.find(params[:id])
-    end
+  # Your code...
 end
-
 ```
 
 ### Extracting inline views into the `./app/views` folder
@@ -159,9 +200,11 @@ end
 Then include the `Posts` module in the controllers you'd like to use the views:
 
 ```ruby
+# ./app/controllers/posts_controller.rb
 class PostsController < ApplicationController
   include Superview::Actions
-  include Posts # Add this to your controller 🚨
+  # 🚨 Add this 👇 to your controller 🚨
+  include Posts
 
   before_action :load_post
 
@@ -181,6 +224,24 @@ end
 
 That's it! Ruby includes all the classes in the `Posts` module, which Superview picks up and renders in the controller. If you have an `Index`, `Edit`, `New`, etc. class in the `Posts` namespace, those would be implicitly rendered for their respective action.
 
+### View path class mappings
+
+Not all component libraries are integrated into Rails views, so you might have to manually configure the view paths in your Rails application. This instructs the Rails code reloader, Zeitwerk, to load the components.
+
+```ruby
+# ./config/application.rb
+module MyApp
+  class Application < Rails::Application
+    config.autoload_paths << "#{root}/app/views"
+    config.autoload_paths << "#{root}/app/views/layouts"
+    config.autoload_paths << "#{root}/app/views/components"
+    # Your code
+  end
+end
+```
+
+For example, the `Show` component in the `Posts` module would be loaded from `./app/views/posts/show.rb` and the `Layout` component in the `Layouts` module would be loaded from `./app/views/layouts/layout.rb`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/superview/actions.rb

@@ -37,7 +37,7 @@ module Superview
       # Finds a class on the controller with the same name as the action. For example,
       # `def index` would find the `Index` constant on the controller class to render
       # for the action `index`.
-      def phlex_action_class(action:)
+      def component_action_class(action:)
         action_class = action.to_s.camelcase
         const_get action_class if const_defined? action_class
       end
@@ -49,7 +49,7 @@ module Superview
     # on Phlex. For example, if a controller defines @users and a Phlex class has
     # `attr_writer :users`, `attr_accessor :user`, or `def users=`, it will be automatically
     # set by this method.
-    def assign_phlex_accessors(view)
+    def assign_component_accessors(view)
       view.tap do |view|
         view_assigns.each do |variable, value|
           attr_writer_name = "#{variable}="
@@ -59,44 +59,45 @@ module Superview
     end
 
     # Initializers a Phlex view based on the action name and assigns accessors
-    def phlex_action(action)
-      phlex_view self.class.phlex_action_class(action: action)
+    def component_action(action)
+      component_view self.class.component_action_class(action: action)
     end
 
-    # Initializes a phlex view class and assigns accessors.
-    def phlex_view(view_class)
-      assign_phlex_accessors view_class.new
+    # Initializes a component view class and assigns accessors.
+    def component_view(view_class)
+      assign_component_accessors view_class.new
     end
 
     # Phlex action for the current action.
-    def phlex(target = action_name)
-      case target
-      when Phlex::HTML
-        assign_phlex_accessors target
-      when Symbol, String
-        phlex_action target
-      when Class
-        phlex_view target
+    def component(target = action_name)
+      if target.is_a? Class
+        component_view target
+      elsif target.respond_to? :render_in
+        assign_component_accessors target
+      else
+        component_action target
       end
     end
 
+    alias :phlex :component
+
     # Checks if a Phlex class name is present for a controller action name
-    def phlex_action_exists?(action)
-      self.class.phlex_action_class(action: action).present?
+    def component_action_exists?(action)
+      self.class.component_action_class(action: action).present?
     end
 
     # This is a built-in Rails method resolves the method to call for an action.
     # If it resolves a Phlex class in the controller, it will render that. If it's
     # not found it continues with Rails method of resolving action names.
     def method_for_action(action_name)
-      super || if phlex_action_exists? action_name
-                 "default_phlex_render"
+      super || if component_action_exists? action_name
+                 "default_component_render"
                end
     end
 
     # Renders a Phlex view for the given action, if it's present.
-    def default_phlex_render
-      render phlex
+    def default_component_render
+      render component
     end
   end
 end

data/lib/superview/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superview
-  VERSION = "0.1.3"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,50 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: superview
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-14 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: phlex-rails
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: 3.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-description: Build Rails applications entirely out of Phlex components.
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: phlex-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Build Rails applications entirely from Phlex, ViewComponents, or any
+  object that responds to `#render_in`
 email:
 - bradgessler@gmail.com
 executables: []
@@ -91,8 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Build Rails applications entirely out of Phlex components.
+summary: Build Rails applications entirely from Phlex, ViewComponents, or any object
+  that responds to `#render_in`
 test_files: []