superview 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 185e73cab73c23d8de233721cde393cb453868e1cf3a6f5ef8b322b9b613ff32
-  data.tar.gz: 6bca9e94731ecd625cf20f904f0cac42fe969ac63ac72913de75f6a176f18a1e
+  metadata.gz: 95b73938446d68225ef15422d94071e4cdf77856aedb64f9f9b96aca8dd75217
+  data.tar.gz: 27e686bdfacf05a9d265ba919cf5a2ad2d87a074975ccc33871f2f20498555df
 SHA512:
-  metadata.gz: a4dfdc42e1697576ac22f8af14c0d6f75be71b198b19a5c6e3097c895db0eb114401af25cf30c39e3615999f4bb41907bde50bc70e22aa6520c1c9805a8eb230
-  data.tar.gz: d00f990562345a341b69ac4c86ef72bf0deef57defbe4dcdfdfa0b9759079f8e43f57005d59c8058cec368fefa886090814517de823efc2dd7b94b84601dd896
+  metadata.gz: 6e7ddd62b1cbb25eb2e5a3f45f1b161c2973bb8ba33af94469141d2bad9f27f6925d2f3d6af3e777f338e1b9943111277e8250ff56ad7a7ee255ed8ad416ca95
+  data.tar.gz: 14549c8278d4d55f0f497c27ef26a7b5208d83e7b3c9e4d3cb98a175856986713109d3f630ba8feada62ea6da269f4bc9b006a58c0ac00b62329f49feeb11974

data/Gemfile

@@ -7,6 +7,4 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "rspec", "~> 3.0"
-
-gem "rails", "~> 7.0"
+gem "rspec-rails", "~> 7.0"

data/Gemfile.lock

@@ -1,189 +1,138 @@
 PATH
   remote: .
   specs:
-    superview (0.1.2)
-      phlex-rails (~> 1.0)
+    superview (0.1.3)
+      phlex-rails (>= 1.0, < 3.0)
       zeitwerk (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.7)
-      actionpack (= 7.0.7)
-      activesupport (= 7.0.7)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.7)
-      actionpack (= 7.0.7)
-      activejob (= 7.0.7)
-      activerecord (= 7.0.7)
-      activestorage (= 7.0.7)
-      activesupport (= 7.0.7)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.7)
-      actionpack (= 7.0.7)
-      actionview (= 7.0.7)
-      activejob (= 7.0.7)
-      activesupport (= 7.0.7)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.7)
-      actionview (= 7.0.7)
-      activesupport (= 7.0.7)
-      rack (~> 2.0, >= 2.2.4)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.7)
-      actionpack (= 7.0.7)
-      activerecord (= 7.0.7)
-      activestorage (= 7.0.7)
-      activesupport (= 7.0.7)
-      globalid (>= 0.6.0)
+    actionpack (8.0.1)
+      actionview (= 8.0.1)
+      activesupport (= 8.0.1)
       nokogiri (>= 1.8.5)
-    actionview (7.0.7)
-      activesupport (= 7.0.7)
+      rack (>= 2.2.4)
+      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)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.7)
-      activesupport (= 7.0.7)
-      globalid (>= 0.3.6)
-    activemodel (7.0.7)
-      activesupport (= 7.0.7)
-    activerecord (7.0.7)
-      activemodel (= 7.0.7)
-      activesupport (= 7.0.7)
-    activestorage (7.0.7)
-      actionpack (= 7.0.7)
-      activejob (= 7.0.7)
-      activerecord (= 7.0.7)
-      activesupport (= 7.0.7)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    builder (3.2.4)
-    cgi (0.3.6)
-    concurrent-ruby (1.2.2)
+      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)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
     crass (1.0.6)
-    date (3.3.3)
-    diff-lcs (1.5.0)
-    erb (4.0.2)
-      cgi (>= 0.3.3)
-    erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
-    i18n (1.14.1)
+    date (3.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    erubi (1.13.0)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    loofah (2.21.3)
+    io-console (0.8.0)
+    irb (1.14.2)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    logger (1.6.3)
+    loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.5)
-    mini_portile2 (2.8.5)
-    minitest (5.19.0)
-    net-imap (0.3.7)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.1)
-      timeout
-    net-smtp (0.3.3)
-      net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.15.4)
-      mini_portile2 (~> 2.8.2)
+    minitest (5.25.4)
+    nokogiri (1.17.2-arm64-darwin)
       racc (~> 1.4)
-    phlex (1.8.1)
-      concurrent-ruby (~> 1.2)
-      erb (>= 4)
-      zeitwerk (~> 2.6)
-    phlex-rails (1.0.0)
-      phlex (~> 1.7)
-      rails (>= 6.1, < 8)
-      zeitwerk (~> 2.6)
-    racc (1.7.1)
-    rack (2.2.8)
+    nokogiri (1.17.2-x86_64-linux)
+      racc (~> 1.4)
+    phlex (1.11.0)
+    phlex-rails (1.2.2)
+      phlex (>= 1.10, < 2)
+      railties (>= 6.1, < 9)
+    psych (5.2.1)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.7)
-      actioncable (= 7.0.7)
-      actionmailbox (= 7.0.7)
-      actionmailer (= 7.0.7)
-      actionpack (= 7.0.7)
-      actiontext (= 7.0.7)
-      actionview (= 7.0.7)
-      activejob (= 7.0.7)
-      activemodel (= 7.0.7)
-      activerecord (= 7.0.7)
-      activestorage (= 7.0.7)
-      activesupport (= 7.0.7)
-      bundler (>= 1.15.0)
-      railties (= 7.0.7)
+    rackup (2.2.1)
+      rack (>= 3)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
+    rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.0.7)
-      actionpack (= 7.0.7)
-      activesupport (= 7.0.7)
-      method_source
+      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)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rake (13.0.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.2.1)
+    rdoc (6.9.0)
+      psych (>= 4.0.0)
+    reline (0.5.12)
+      io-console (~> 0.5)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    thor (1.2.2)
-    timeout (0.4.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (7.1.0)
+      actionpack (>= 7.0)
+      activesupport (>= 7.0)
+      railties (>= 7.0)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    securerandom (0.4.0)
+    stringio (3.1.2)
+    thor (1.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.6)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.11)
+    uri (1.0.2)
+    useragent (0.16.11)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-linux
 
 DEPENDENCIES
-  rails (~> 7.0)
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec-rails (~> 7.0)
   superview!
 
 BUNDLED WITH

data/README.md

@@ -11,7 +11,7 @@ class PostsController < ApplicationController
   class Show < ApplicationComponent
     attr_accessor :post
 
-    def template(&)
+    def view_template(&)
       h1 { @post.title }
       div(class: "prose") { @post.body }
     end
@@ -56,7 +56,7 @@ class PostsController < ApplicationController
   class Show < ApplicationComponent
     attr_accessor :post
 
-    def template(&)
+    def view_template(&)
       h1 { @post.title }
       div(class: "prose") { @post.body }
     end
@@ -80,7 +80,7 @@ class PostsController < ApplicationController
   class Show < ApplicationComponent
     attr_accessor :post
 
-    def template(&)
+    def view_template(&)
       h1 { @post.title }
       div(class: "prose") { @post.body }
     end
@@ -88,7 +88,12 @@ class PostsController < ApplicationController
 
   def show
     respond_to do |format|
-      format.html { render Show.new.tap { _1.post = @post } }
+      format.html { render phlex }
+      # 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.json { render json: @post }
     end
   end
@@ -100,6 +105,37 @@ class PostsController < ApplicationController
 end
 ```
 
+### Rendering other Phlex actions 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.
+
+```ruby
+class PostsController < ApplicationController
+  include Superview::Actions
+
+  def create
+    @post = Post.new(post_params)
+
+    if @post.save
+      redirect_to @post
+    else
+      render phlex New
+      # These would also work...
+      # render New.new.tap { _1.post = @post }
+      # render phlex New.new
+      # render phlex New
+      # render phlex :new
+    end
+  end
+
+  private
+    def load_post
+      @post = Post.find(params[:id])
+    end
+end
+
+```
+
 ### Extracting inline views into the `./app/views` folder
 
 Inline views are an amazingly productive way of prototyping apps, but as it matures you might be inclined to extract these views into the `./app/views` folders for organizational purposes or so you can share them between controllers.
@@ -112,7 +148,7 @@ module Posts
   class Show < ApplicationComponent
     attr_accessor :post
 
-    def template(&)
+    def view_template(&)
       h1 { @post.title }
       div(class: "prose") { @post.body }
     end

data/lib/superview/actions.rb

@@ -16,7 +16,7 @@ module Superview
   #   class Show < ApplicationComponent
   #     attr_accessor :post
   #
-  #     def template(&)
+  #     def view_template(&)
   #       h1 { @post.title }
   #       div(class: "prose") { @post.body }
   #     end
@@ -49,8 +49,8 @@ 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(phlex_view)
-      phlex_view.tap do |view|
+    def assign_phlex_accessors(view)
+      view.tap do |view|
         view_assigns.each do |variable, value|
           attr_writer_name = "#{variable}="
           view.send attr_writer_name, value if view.respond_to? attr_writer_name
@@ -58,24 +58,40 @@ module Superview
       end
     end
 
-    # Initializers a Phlex view based on the action name, then assigns `view_assigns`
-    # to the view.
+    # Initializers a Phlex view based on the action name and assigns accessors
     def phlex_action(action)
-      assign_phlex_accessors self.class.phlex_action_class(action: action).new
+      phlex_view self.class.phlex_action_class(action: action)
+    end
+
+    # Initializes a phlex view class and assigns accessors.
+    def phlex_view(view_class)
+      assign_phlex_accessors view_class.new
     end
 
     # Phlex action for the current action.
-    def phlex
-      phlex_action(action_name)
+    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
+      end
     end
 
-    # Try rendering with the regular Rails rendering methods; if those don't work
-    # then try finding the Phlex class that corresponds with the action_name. If that's
-    # found then tell Rails to call `default_phlex_render`.
+    # 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?
+    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 self.class.phlex_action_class action: action_name
-                          "default_phlex_render"
-      end
+      super || if phlex_action_exists? action_name
+                 "default_phlex_render"
+               end
     end
 
     # Renders a Phlex view for the given action, if it's present.
@@ -83,4 +99,4 @@ module Superview
       render phlex
     end
   end
-end
+end

data/lib/superview/assignable.rb

@@ -53,9 +53,9 @@ module Superview
       class_attribute :model, :parent_model, :context_method_name
 
       before_action :assign_parent_collection, if: :has_parent_model?
-      before_action :assign_parent_member, if: :has_parent_model?
-      before_action :assign_collection
-      before_action :assign_member
+      before_action :assign_parent_member, if: :has_parent_model_instance?
+      before_action :assign_collection, if: :has_model?
+      before_action :assign_member, if: :has_model?
     end
 
     protected
@@ -68,19 +68,31 @@ module Superview
       instance_variable_set "@#{parent_model.model_name.plural}", parent_model_scope
     end
 
-    def model_scope
-      if has_parent_model?
+    def model_association
+      if has_parent_model_instance?
         parent_model_instance.association(model.model_name.collection)
       elsif has_assignable_context?
-        assignable_context.association(model.model_name.collection).scope
+        assignable_context.association(model.model_name.collection)
+      end
+    end
+
+    def model_scope
+      if association = model_association
+        association.scope
       else
         model.scope_for_association
       end
     end
 
-    def parent_model_scope
+    def parent_model_association
       if has_assignable_context?
         assignable_context.association(parent_model.model_name.collection)
+      end
+    end
+
+    def parent_model_scope
+      if association = parent_model_association
+        association.scope
       else
         parent_model.scope_for_association
       end
@@ -98,6 +110,14 @@ module Superview
       parent_model.present?
     end
 
+    def has_parent_model_instance?
+      has_parent_model? && params.key?(parent_model_param_key)
+    end
+
+    def has_model?
+      model.present?
+    end
+
     def assign_member
       instance_variable_set "@#{model.model_name.singular}", model_instance
     end

data/lib/superview/components/table_component.rb

@@ -3,7 +3,7 @@ module Superview::Components
   # collection of the table.
   #
   # ```ruby
-  # render TableComponent.new(items: @posts) do |table|
+  # render TableComponent.new(@posts) do |table|
   #   # This is how you'd usually render a table.
   #   table.column("Title") { show(_1, :title) }
   #
@@ -19,8 +19,18 @@ module Superview::Components
   #   end
   # end
   # ```
+
   class TableComponent < ApplicationComponent
-    include Phlex::DeferredRender
+    if Phlex.const_defined?(:DeferredRender)
+      # Phlex 1.0
+      include Phlex::DeferredRender
+    else
+      # Phlex 2.0
+      def before_template(&)
+        vanish(&)
+        super
+      end
+    end
 
     class Column
       attr_accessor :title_template, :item_template
@@ -41,13 +51,14 @@ module Superview::Components
       end
     end
 
-    def initialize(items: [])
+    def initialize(items = [], **attributes)
       @items = items
+      @attributes = attributes
       @columns = []
     end
 
-    def template(&)
-      table do
+    def view_template(&)
+      table(**@attributes) do
         thead do
           tr do
             @columns.each do |column|
@@ -75,4 +86,4 @@ module Superview::Components
       end
     end
   end
-end
+end

data/lib/superview/helpers/turbo/meta_tags.rb

@@ -20,7 +20,7 @@ module Superview
           @page_requires_reload = page_requires_reload
         end
 
-        def template
+        def view_template
           meta(name: "turbo-refresh-method", content: @method)
           meta(name: "turbo-refresh-scroll", content: @scroll)
           meta(name: "turbo-cache-control", content: "no-cache") if @exempts_page_from_cache
@@ -45,4 +45,4 @@ module Superview
       end
     end
   end
-end
+end

data/lib/superview/helpers/turbo.rb

@@ -7,17 +7,6 @@ module Superview
         register_element :turbo_cable_stream_source
       end
 
-      class_methods do
-        def turbo(*args, **kwargs, &block)
-          @turbo_meta_tags = MetaTags.new(*args, **kwargs)
-          define_method(:turbo, &block) if block
-        end
-
-        def turbo_meta_tags
-          @turbo_meta_tags ||= MetaTags.new
-        end
-      end
-
       def turbo_stream_from(*streamables, **attributes)
         attributes[:channel] = attributes[:channel]&.to_s || "Turbo::StreamsChannel"
         attributes[:"signed-stream-name"] = ::Turbo::StreamsChannel.signed_stream_name(streamables)

data/lib/superview/version.rb

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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: superview
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !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: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Build Rails applications entirely out of Phlex components.