Superview

Build Rails applications, from the ground up, using Phlex components, like this.

class PostsController < ApplicationController
  include Superview::Actions

  before_action :load_post

  class Show < ApplicationComponent
    attr_accessor :post

    def template(&)
      h1 { @post.title }
      div(class: "prose") { @post.body }
    end
  end

  private
    def load_post
      @post = Post.find(params[:id])
    end
end

Read more about it at:

• Component driven development on Rails with Phlex
• Hacking Rails Implicit Rendering for View Components & Fun

Install the gem and add to the application's Gemfile by executing:

$ bundle add superview

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install superview

Install phlex-rails in your Rails application.

$ bin/rails generate phlex:install

Then add include Superview::Actions to any controllers you'd like to render Phlex components.

class PostsController < ApplicationController
  include Superview::Actions

  before_action :load_post

  class Show < ApplicationComponent
    attr_accessor :post

    def template(&)
      h1 { @post.title }
      div(class: "prose") { @post.body }
    end
  end

  private
    def load_post
      @post = Post.find(params[:id])
    end
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:

class PostsController < ApplicationController
  include Superview::Actions

  before_action :load_post

  class Show < ApplicationComponent
    attr_accessor :post

    def template(&)
      h1 { @post.title }
      div(class: "prose") { @post.body }
    end
  end

  def show
    respond_to do |format|
      format.html { render Show.new.tap { _1.post = @post } }
      format.json { render json: @post }
    end
  end

  private
    def load_post
      @post = Post.find(params[:id])
    end
end

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.

First let's extract the Show class into ./app/views/posts/show.rb

# ./app/views/posts/show.rb
module Posts
  class Show < ApplicationComponent
    attr_accessor :post

    def template(&)
      h1 { @post.title }
      div(class: "prose") { @post.body }
    end
  end
end

Then include the Posts module in the controllers you'd like to use the views:

class PostsController < ApplicationController
  include Superview::Actions
  include Posts # Add this to your controller 🚨

  before_action :load_post

  def show
    respond_to do |format|
      format.html { render Show.new.tap { _1.post = @post } }
      format.json { render json: @post }
    end
  end

  private
    def load_post
      @post = Post.find(params[:id])
    end
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.

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.

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/rubymonolith/superview. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Superview project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.