actionview-component 1.7.0 → 1.17.0

data/actionview-component.gemspec

@@ -3,17 +3,16 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "action_view/component/version"
+require "view_component/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "actionview-component"
-  spec.version       = ActionView::Component::VERSION::STRING
+  spec.version       = ViewComponent::VERSION::STRING
   spec.authors       = ["GitHub Open Source"]
-  spec.email         = ["opensource+actionview-component@github.com"]
+  spec.email         = ["opensource+view_component@github.com"]
 
-  spec.summary       = %q{View components for Rails}
-  spec.description   = %q{View components for Rails, intended for upstreaming in Rails 6.1}
-  spec.homepage      = "https://github.com/github/actionview-component"
+  spec.summary       = %q{MOVED to view_component.}
+  spec.homepage      = "https://github.com/github/view_component"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -34,12 +33,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_development_dependency "bundler", ">= 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency     "capybara", "~> 3"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "= 5.1.0"
   spec.add_development_dependency "haml", "~> 5"
   spec.add_development_dependency "slim", "~> 4.0"
   spec.add_development_dependency "better_html", "~> 1"
   spec.add_development_dependency "rubocop", "= 0.74"
   spec.add_development_dependency "rubocop-github", "~> 0.13.0"
+
+  spec.post_install_message = "WARNING: actionview-component has been renamed to view_component, and will no longer be published in this namespace. Please update your Gemfile to use view_component."
 end

data/{lib/railties/lib → app/controllers}/rails/components_controller.rb

@@ -3,7 +3,8 @@
 require "rails/application_controller"
 
 class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
-  prepend_view_path File.expand_path("templates/rails", __dir__)
+  prepend_view_path File.expand_path("../../../lib/railties/lib/rails/templates/rails", __dir__)
+  prepend_view_path "#{Rails.root}/app/views/" if defined?(Rails.root)
 
   around_action :set_locale, only: :previews
   before_action :find_preview, only: :previews
@@ -14,34 +15,43 @@ class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
   end
 
   def index
-    @previews = ActionView::Component::Preview.all
+    @previews = ViewComponent::Preview.all
     @page_title = "Component Previews"
-    render template: "components/index"
+    # rubocop:disable GitHub/RailsControllerRenderPathsExist
+    render "components/index"
+    # rubocop:enable GitHub/RailsControllerRenderPathsExist
   end
 
   def previews
     if params[:path] == @preview.preview_name
       @page_title = "Component Previews for #{@preview.preview_name}"
-      render template: "components/previews"
+      # rubocop:disable GitHub/RailsControllerRenderPathsExist
+      render "components/previews"
+      # rubocop:enable GitHub/RailsControllerRenderPathsExist
     else
       @example_name = File.basename(params[:path])
-      render template: "components/preview", layout: false
+      @render_args = @preview.render_args(@example_name)
+      layout = @render_args[:layout]
+      opts = layout.nil? ? {} : { layout: layout }
+      # rubocop:disable GitHub/RailsControllerRenderPathsExist
+      render "components/preview", **opts
+      # rubocop:enable GitHub/RailsControllerRenderPathsExist
     end
   end
 
   private
 
   def show_previews? # :doc:
-    ActionView::Component::Base.show_previews
+    ViewComponent::Base.show_previews
   end
 
   def find_preview # :doc:
     candidates = []
     params[:path].to_s.scan(%r{/|$}) { candidates << $` }
-    preview = candidates.detect { |candidate| ActionView::Component::Preview.exists?(candidate) }
+    preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
 
     if preview
-      @preview = ActionView::Component::Preview.find(preview)
+      @preview = ViewComponent::Preview.find(preview)
     else
       raise AbstractController::ActionNotFound, "Component preview '#{params[:path]}' not found"
     end

data/docs/case-studies/jellyswitch.md

@@ -0,0 +1,76 @@
+Name: Dave Paola
+
+Github Handle: [@dpaola2](https://github.com/dpaola2)
+
+[Jellyswitch](https://www.jellyswitch.com) is a coworking space management platform
+
+In response to [this tweet](https://twitter.com/joelhawksley/status/1232674647327547394):
+
+I recently began refactoring many of my partials into components. Along the way I discovered an interesting use case, which was to componentize the various bootstrap components I was already using.
+
+Some examples:
+
+- I've componentized the specific layout that I've designed using the grid system. I have defined a `FullWidthLayout` component that wraps its contents in the correct classes to give my layout a good design on both mobile and desktop. (On desktop, there is a sidebar, and on mobile, the sidebar floats on top in a collapsed fashion.)
+- [Modals](https://getbootstrap.com/docs/4.4/components/modal/) are now componentized and accept arguments. I had them as partials before, but having ruby classes is an upgrade.
+- [Breadcrumbs](https://getbootstrap.com/docs/4.4/components/breadcrumb/) same as above.
+
+Here's one that I use a LOT: `OnOffSwitch`:
+
+```ruby
+class OnOffSwitch < ApplicationComponent
+  def initialize(predicate:, path:, disabled: false, label: nil)
+    @predicate = predicate
+    @path = path
+    @disabled = disabled
+    @label = label
+  end
+
+  private
+
+  attr_reader :predicate, :path, :disabled, :label
+  
+  def icon_class
+    if predicate
+      "fas fa-toggle-on"
+    else
+      "fas fa-toggle-off"
+    end
+  end
+end
+```
+
+```erb
+<div class="d-flex align-items-center">
+  <% if !disabled %>
+    <%= link_to path, class: "text-body", remote: true do %>
+      <span style="font-size: 20pt">
+        <% if predicate %>
+          <span class="text-success">
+            <i class="<%= icon_class %>"></i>
+          </span>
+        <% else %>
+          <span class="text-danger">
+            <i class="<%= icon_class %>"></i>
+          </span>
+        <% end %>
+      </span>
+    <% end %>
+  <% else %>
+    <span style="font-size: 20pt">
+      <span class="text-muted">
+        <i class="<%= icon_class %>"></i>
+      </span>
+    </span>
+  <% end %>
+  &nbsp;
+  <%= content %>
+</div>
+```
+
+Here is an example of how this looks:
+
+<img width="653" alt="Screenshot 2020-02-26 08 34 07" src="https://user-images.githubusercontent.com/150509/75365920-cbfb9500-5872-11ea-8234-f1343629a462.png">
+
+I have found that refactoring complex views is made easier and faster by first putting them into a component, extracting the conditionals and other logic into private methods and proceeding from there. And I wind up with a very nice set of well-factored components and sub-components, with argument lists and validations and so on. I think the rails community is really going to benefit from this library, and I'm hugely appreciative of y'all's efforts on it!
+
+I plan to release an early version of the bootstrap components we've developed at some point in the near future. I would love to collaborate and learn the most appropriate way to structure that contribution.

data/lib/action_view/component.rb

@@ -1,23 +1,4 @@
 # frozen_string_literal: true
 
 require "active_model"
-require "action_view"
-require "active_support/dependencies/autoload"
-require "action_view/component/railtie"
-
-module ActionView
-  module Component
-    extend ActiveSupport::Autoload
-
-    autoload :Base
-    autoload :Conversion
-    autoload :Preview
-    autoload :Previewable
-    autoload :TestHelpers
-    autoload :TestCase
-    autoload :RenderMonkeyPatch
-    autoload :TemplateError
-  end
-end
-
-ActiveModel::Conversion.include ActionView::Component::Conversion
+require "view_component"

data/lib/action_view/component/base.rb

@@ -1,257 +1,13 @@
 # frozen_string_literal: true
 
-require "active_support/configurable"
-
 module ActionView
   module Component
-    class Base < ActionView::Base
+    class Base < ViewComponent::Base
       include ActiveModel::Validations
-      include ActiveSupport::Configurable
-      include ActionView::Component::Previewable
-
-      delegate :form_authenticity_token, :protect_against_forgery?, to: :helpers
-
-      class_attribute :content_areas, default: []
-      self.content_areas = [] # default doesn't work until Rails 5.2
-
-      # Entrypoint for rendering components. Called by ActionView::Base#render.
-      #
-      # view_context: ActionView context from calling view
-      # args(hash): params to be passed to component being rendered
-      # block: optional block to be captured within the view context
-      #
-      # returns HTML that has been escaped by the respective template handler
-      #
-      # Example subclass:
-      #
-      # app/components/my_component.rb:
-      # class MyComponent < ActionView::Component::Base
-      #   def initialize(title:)
-      #     @title = title
-      #   end
-      # end
-      #
-      # app/components/my_component.html.erb
-      # <span title="<%= @title %>">Hello, <%= content %>!</span>
-      #
-      # In use:
-      # <%= render MyComponent, title: "greeting" do %>world<% end %>
-      # returns:
-      # <span title="greeting">Hello, world!</span>
-      #
-      def render_in(view_context, *args, &block)
-        self.class.compile!
-        @view_context = view_context
-        @view_renderer ||= view_context.view_renderer
-        @lookup_context ||= view_context.lookup_context
-        @view_flow ||= view_context.view_flow
-        @virtual_path ||= virtual_path
-        @variant = @lookup_context.variants.first
-        old_current_template = @current_template
-        @current_template = self
-
-        @content = view_context.capture(self, &block) if block_given?
 
+      def before_render_check
         validate!
-
-        send(self.class.call_method_name(@variant))
-      ensure
-        @current_template = old_current_template
-      end
-
-      def initialize(*); end
-
-      def render(options = {}, args = {}, &block)
-        if options.is_a?(String) || (options.is_a?(Hash) && options.has_key?(:partial))
-          view_context.render(options, args, &block)
-        else
-          super
-        end
-      end
-
-      def controller
-        @controller ||= view_context.controller
       end
-
-      # Provides a proxy to access helper methods through
-      def helpers
-        @helpers ||= view_context
-      end
-
-      # Removes the first part of the path and the extension.
-      def virtual_path
-        self.class.source_location.gsub(%r{(.*app/components)|(\.rb)}, "")
-      end
-
-      def view_cache_dependencies
-        []
-      end
-
-      def format # :nodoc:
-        @variant
-      end
-
-      def with(area, content = nil, &block)
-        unless content_areas.include?(area)
-          raise ArgumentError.new "Unknown content_area '#{area}' - expected one of '#{content_areas}'"
-        end
-
-        if block_given?
-          content = view_context.capture(&block)
-        end
-
-        instance_variable_set("@#{area}".to_sym, content)
-        nil
-      end
-
-      private
-
-      def request
-        @request ||= controller.request
-      end
-
-      attr_reader :content, :view_context
-
-      class << self
-        def inherited(child)
-          child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
-
-          super
-        end
-
-        def call_method_name(variant)
-          if variant.present? && variants.include?(variant)
-            "call_#{variant}"
-          else
-            "call"
-          end
-        end
-
-        def source_location
-          @source_location ||=
-              begin
-                # Require #initialize to be defined so that we can use
-                # method#source_location to look up the file name
-                # of the component.
-                #
-                # If we were able to only support Ruby 2.7+,
-                # We could just use Module#const_source_location,
-                # rendering this unnecessary.
-                #
-                initialize_method = instance_method(:initialize)
-                initialize_method.source_location[0] if initialize_method.owner == self
-              end
-        end
-
-        def compiled?
-          @compiled && ActionView::Base.cache_template_loading
-        end
-
-        def compile!
-          compile(validate: true)
-        end
-
-        # Compile templates to instance methods, assuming they haven't been compiled already.
-        # We could in theory do this on app boot, at least in production environments.
-        # Right now this just compiles the first time the component is rendered.
-        def compile(validate: false)
-          return if compiled?
-
-          if template_errors.present?
-            raise ActionView::Component::TemplateError.new(template_errors) if validate
-            return false
-          end
-
-          templates.each do |template|
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{call_method_name(template[:variant])}
-                @output_buffer = ActionView::OutputBuffer.new
-                #{compiled_template(template[:path])}
-              end
-            RUBY
-          end
-
-          @compiled = true
-        end
-
-        def variants
-          templates.map { |template| template[:variant] }
-        end
-
-        # we'll eventually want to update this to support other types
-        def type
-          "text/html"
-        end
-
-        def identifier
-          source_location
-        end
-
-        def with_content_areas(*areas)
-          if areas.include?(:content)
-            raise ArgumentError.new ":content is a reserved content area name. Please use another name, such as ':body'"
-          end
-          attr_reader *areas
-          self.content_areas = areas
-        end
-
-        private
-
-        def matching_views_in_source_location
-          return [] unless source_location
-          (Dir["#{source_location.sub(/#{File.extname(source_location)}$/, '')}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
-        end
-
-        def templates
-          @templates ||=
-            matching_views_in_source_location.each_with_object([]) do |path, memo|
-              pieces = File.basename(path).split(".")
-
-              memo << {
-                path: path,
-                variant: pieces.second.split("+").second&.to_sym,
-                handler: pieces.last
-              }
-            end
-        end
-
-        def template_errors
-          @template_errors ||=
-            begin
-              errors = []
-              errors << "#{self} must implement #initialize." if source_location.nil?
-              errors << "Could not find a template file for #{self}." if templates.empty?
-
-              if templates.count { |template| template[:variant].nil? } > 1
-                errors << "More than one template found for #{self}. There can only be one default template file per component."
-              end
-
-              invalid_variants = templates
-                                   .group_by { |template| template[:variant] }
-                                   .map { |variant, grouped| variant if grouped.length > 1 }
-                                   .compact
-                                   .sort
-
-              unless invalid_variants.empty?
-                errors << "More than one template found for #{'variant'.pluralize(invalid_variants.count)} #{invalid_variants.map { |v| "'#{v}'" }.to_sentence} in #{self}. There can only be one template file per variant."
-              end
-              errors
-            end
-        end
-
-        def compiled_template(file_path)
-          handler = ActionView::Template.handler_for_extension(File.extname(file_path).gsub(".", ""))
-          template = File.read(file_path)
-
-          if handler.method(:call).parameters.length > 1
-            handler.call(self, template)
-          else # remove before upstreaming into Rails
-            handler.call(OpenStruct.new(source: template, identifier: identifier, type: type))
-          end
-        end
-      end
-
-      ActiveSupport.run_load_hooks(:action_view_component, self)
     end
   end
 end