actionview-component 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c64114f4ba9a12fb68d0157a9f10a9fc423d09dbc181f0fd9f403671b61a047
-  data.tar.gz: 3c6306682e37e6f9f4d9ed66564130a225f122aaa71caffdd3ab063ad70524c3
+  metadata.gz: cfaa667b7c02706e492cb8f92221bcc2ec39137b525faccdaadbef76435c9880
+  data.tar.gz: b9bf382421e68d742e5427b67b5b84163cbca8c47fca9e6789391ceea4bc5f2e
 SHA512:
-  metadata.gz: b92ca951edd213245c3d0b473fe87650e0c87f4130a89bd4f628d7df0636fab794853943c172f57c10b648b43a98d7dfcca228be05d4c8120930b0ad5fb06683
-  data.tar.gz: 12bac559a2d557e72bbec729ae8402fcc08a8cc2f3c38d57eea332aa32391df4018447954c0b2e644076683573b55b70f7b02868524353645eca663abae5609c
+  metadata.gz: 8563f9ef8e370a5a0dfdc15813e72b2dd35c6f0b37de6fa81ba84a50b20427049d0e00fc5ecbb72ff4f15bb50e0793e5afcaf59ac85d3d5b78e4091b7080ca79
+  data.tar.gz: 5447df2d42fddbb35b90d05e328e3de3c78d7db2a44d92a29de49986630b9dbc2203012bc9fdc48812422b8a761e881f0d106e0d8abb55ed412b07687c00d0dd

data/.github/ISSUE_TEMPLATE

@@ -23,3 +23,5 @@ context or references to similar behavior in other libraries? -->
 **Rails version**:
 
 **Ruby version**:
+
+**Gem version**:

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# master
+
+# v1.12.0
+
+* Revert: Remove initializer requirement for Ruby 2.7+
+
+    *Joel Hawksley*
+
+* Restructure Railtie into Engine
+
+    *Sean Doyle*
+
+* Allow components to override before_render_check
+
+    *Joel Hawksley*
+
 # v1.11.1
 
 * Relax Capybara requirement.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.11.1)
+    actionview-component (1.12.0)
       capybara (>= 3)
 
 GEM
@@ -107,7 +107,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.1.0)
     nio4r (2.5.2)
-    nokogiri (1.10.5)
+    nokogiri (1.10.8)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
@@ -144,7 +144,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    regexp_parser (1.6.0)
+    regexp_parser (1.7.0)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)

data/README.md

@@ -1,5 +1,7 @@
 _Note: This gem is in the process of a name / API change, see https://github.com/github/actionview-component/issues/206_
 
+_You are viewing the README for the development version of ActionView::Component. If you are using the current release version you can find the README at https://github.com/github/actionview-component/blob/v1.11.1/README.md_
+
 # ActionView::Component
 `ActionView::Component` is a framework for building view components in Rails.
 
@@ -7,13 +9,13 @@ _Note: This gem is in the process of a name / API change, see https://github.com
 
 ## Roadmap
 
-This gem is meant to serve as a precursor to upstreaming the `ActionView::Component` class into Rails. It also serves to enable the usage of `ActionView::Component` in older versions of Rails.
+Support for third-party component frameworks was merged into Rails `6.1.0.alpha` in https://github.com/rails/rails/pull/36388 and https://github.com/rails/rails/pull/37919. Our goal with this project is to provide a first-class component framework for this new capability in Rails.
 
-Preliminary support for rendering components was merged into Rails `6.1.0.alpha` in https://github.com/rails/rails/pull/36388. Assuming `ActionView::Component` makes it into Rails, this gem will then exist to serve as a backport.
+This gem includes a backport of those changes for Rails `5.0.0` through `6.1.0.alpha`.
 
 ## Design philosophy
 
-As the goal of this gem is to be upstreamed into Rails, it is designed to integrate as seamlessly as possible, with the [least surprise](https://www.artima.com/intv/ruby4.html).
+This library is designed to integrate as seamlessly as possible with Rails, with the [least surprise](https://www.artima.com/intv/ruby4.html).
 
 ## Compatibility
 
@@ -77,24 +79,14 @@ Our views often fail even the most basic standards of code quality we expect out
 
 By clearly defining the context necessary to render a component, we’ve found them to be easier to reuse than partials.
 
-#### Performance
-
-In early benchmarks, we’ve seen performance improvements over the existing rendering pipeline. For a test page with nested renders 10 levels deep, we’re seeing around a 5x increase in speed over partials:
-
-```
-Comparison:
-           component:     6515.4 i/s
-             partial:     1251.2 i/s - 5.21x  slower
-```
-
-_Rails 6.1.0.alpha, [joelhawksley/actionview-component-demo](https://github.com/joelhawksley/actionview-component-demo), /benchmark route, via `RAILS_ENV=production rails s`, measured with [evanphx/benchmark-ips](https://github.com/evanphx/benchmark-ips)_
-
 ### When should I use components?
 
 Components are most effective in cases where view code is reused or needs to be tested directly.
 
 ### Building components
 
+#### Conventions
+
 Components are subclasses of `ActionView::Component::Base` and live in `app/components`. You may wish to create an `ApplicationComponent` that is a subclass of `ActionView::Component::Base` and inherit from that instead.
 
 Component class names end in -`Component`.
@@ -197,6 +189,8 @@ class ModalComponent < ActionView::Component::Base
   def initialize(user:)
     @user = user
   end
+
+  attr_reader :user
 end
 ```
 
@@ -204,7 +198,7 @@ end
 ```erb
 <div class="modal">
   <div class="header"><%= header %></div>
-  <div class="body"><%= body %>"></div>
+  <div class="body"><%= body %></div>
 </div>
 ```
 
@@ -213,7 +207,7 @@ We can render it in a view as:
 ```erb
 <%= render(ModalComponent.new(user: {name: 'Jane'})) do |component| %>
   <% component.with(:header) do %>
-      Hello <%= user[:name] %>
+      Hello <%= component.user[:name] %>
     <% end %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
@@ -250,7 +244,7 @@ end
 
 ```erb
 <%= render(ModalComponent.new(header: "Hi!")) do |component| %>
-  <% help_enabled? && component.with(:header) do %>
+  <% component.with(:header) do %>
     <span class="help_icon"><%= component.header %></span>
   <% end %>
   <% component.with(:body) do %>
@@ -316,7 +310,7 @@ end
   <% if header %>
     <div class="header"><%= header %></div>
   <% end %>
-  <div class="body"><%= body %>"></div>
+  <div class="body"><%= body %></div>
 </div>
 ```
 
@@ -378,7 +372,7 @@ The `#render?` hook allows you to move this logic into the Ruby class, leaving y
 
 ```ruby
 # app/components/confirm_email_component.rb
-class ConfirmEmailComponent < ApplicationComponent
+class ConfirmEmailComponent < ActionView::Component::Base
   def initialize(user:)
     @user = user
   end
@@ -386,6 +380,8 @@ class ConfirmEmailComponent < ApplicationComponent
   def render?
     @user.requires_confirmation?
   end
+
+  attr_reader :user
 end
 ```
 
@@ -512,8 +508,7 @@ config.action_view_component.preview_path = "#{Rails.root}/spec/components/previ
 
 ### Initializer requirement
 
-In Ruby 2.6.x and below, ActionView::Component requires the presence of an `initialize` method in each component. 
-However, `initialize` is no longer required for projects using 2.7.x and above.
+ActionView::Component requires the presence of an `initialize` method in each component.
 
 ## Frequently Asked Questions
 

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

@@ -3,7 +3,7 @@
 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
@@ -17,19 +17,25 @@ class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
   def index
     @previews = ActionView::Component::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_args = @preview.render_args(@example_name)
       layout = @render_args[:layout]
       opts = layout.nil? ? {} : { layout: layout }
-      render template: "components/preview", **opts
+      # rubocop:disable GitHub/RailsControllerRenderPathsExist
+      render "components/preview", **opts
+      # rubocop:enable GitHub/RailsControllerRenderPathsExist
     end
   end
 

data/lib/action_view/component.rb

@@ -3,7 +3,7 @@
 require "active_model"
 require "action_view"
 require "active_support/dependencies/autoload"
-require "action_view/component/railtie"
+require "action_view/component/engine"
 
 module ActionView
   module Component

data/lib/action_view/component/base.rb

@@ -14,10 +14,9 @@ module ActionView
       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.
+      # Entrypoint for rendering components.
       #
       # 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
@@ -35,11 +34,11 @@ module ActionView
       # <span title="<%= @title %>">Hello, <%= content %>!</span>
       #
       # In use:
-      # <%= render MyComponent, title: "greeting" do %>world<% end %>
+      # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
       # returns:
       # <span title="greeting">Hello, world!</span>
       #
-      def render_in(view_context, *args, &block)
+      def render_in(view_context, &block)
         self.class.compile!
         @view_context = view_context
         @view_renderer ||= view_context.view_renderer
@@ -53,15 +52,21 @@ module ActionView
 
         @content = view_context.capture(self, &block) if block_given?
 
-        validate!
-
-        return "" unless render?
+        before_render_check
 
-        send(self.class.call_method_name(@variant))
+        if render?
+          send(self.class.call_method_name(@variant))
+        else
+          ""
+        end
       ensure
         @current_template = old_current_template
       end
 
+      def before_render_check
+        validate!
+      end
+
       def render?
         true
       end
@@ -142,14 +147,12 @@ module ActionView
 
         def source_location
           @source_location ||=
-              if const_source_location_supported?
-                const_source_location(self.name)[0]
-              else
-                # Require `#initialize` to be defined so that we can use `method#source_location`
-                # to look up the filename of the component.
-                initialize_method = instance_method(:initialize)
-                initialize_method.source_location[0] if initialize_method.owner == self
-              end
+            begin
+              # Require `#initialize` to be defined so that we can use `method#source_location`
+              # to look up the filename of the component.
+              initialize_method = instance_method(:initialize)
+              initialize_method.source_location[0] if initialize_method.owner == self
+            end
         end
 
         def compiled?
@@ -206,10 +209,6 @@ module ActionView
 
         private
 
-        def const_source_location_supported?
-          respond_to? :const_source_location # introduced in Ruby 2.7
-        end
-
         def matching_views_in_source_location
           return [] unless source_location
           (Dir["#{source_location.chomp(File.extname(source_location))}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
@@ -232,7 +231,7 @@ module ActionView
           @template_errors ||=
             begin
               errors = []
-              if source_location.nil? && !const_source_location_supported?
+              if source_location.nil?
                 # Require `#initialize` to be defined so that we can use `method#source_location`
                 # to look up the filename of the component.
                 errors << "#{self} must implement #initialize."

data/lib/action_view/component/engine.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "rails"
+require "action_view/component"
+
+module ActionView
+  module Component
+    class Engine < Rails::Engine # :nodoc:
+      config.action_view_component = ActiveSupport::OrderedOptions.new
+
+      initializer "action_view_component.set_configs" do |app|
+        options = app.config.action_view_component
+
+        options.show_previews = Rails.env.development? if options.show_previews.nil?
+
+        if options.show_previews
+          options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
+        end
+
+        ActiveSupport.on_load(:action_view_component) do
+          options.each { |k, v| send("#{k}=", v) }
+        end
+      end
+
+      initializer "action_view_component.set_autoload_paths" do |app|
+        options = app.config.action_view_component
+
+        if options.show_previews && options.preview_path
+          ActiveSupport::Dependencies.autoload_paths << options.preview_path
+        end
+      end
+
+      initializer "action_view_component.eager_load_actions" do
+        ActiveSupport.on_load(:after_initialize) do
+          ActionView::Component::Base.descendants.each(&:compile)
+        end
+      end
+
+      initializer "action_view_component.compile_config_methods" do
+        ActiveSupport.on_load(:action_view_component) do
+          config.compile_methods! if config.respond_to?(:compile_methods!)
+        end
+      end
+
+      initializer "action_view_component.monkey_patch_render" do
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Base.prepend ActionView::Component::RenderMonkeyPatch
+        end
+      end
+
+      config.after_initialize do |app|
+        options = app.config.action_view_component
+
+        if options.show_previews
+          app.routes.prepend do
+            get "/rails/components"       => "rails/components#index", :internal => true
+            get "/rails/components/*path" => "rails/components#previews", :internal => true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_view/component/railtie.rb

@@ -1,65 +1,3 @@
 # frozen_string_literal: true
 
-require "rails"
-require "action_view/component"
-
-module ActionView
-  module Component
-    class Railtie < Rails::Railtie # :nodoc:
-      config.action_view_component = ActiveSupport::OrderedOptions.new
-
-      initializer "action_view_component.set_configs" do |app|
-        options = app.config.action_view_component
-
-        options.show_previews = Rails.env.development? if options.show_previews.nil?
-
-        if options.show_previews
-          options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
-        end
-
-        ActiveSupport.on_load(:action_view_component) do
-          options.each { |k, v| send("#{k}=", v) }
-        end
-      end
-
-      initializer "action_view_component.set_autoload_paths" do |app|
-        require "railties/lib/rails/components_controller"
-
-        options = app.config.action_view_component
-
-        if options.show_previews && options.preview_path
-          ActiveSupport::Dependencies.autoload_paths << options.preview_path
-        end
-      end
-
-      initializer "action_view_component.eager_load_actions" do
-        ActiveSupport.on_load(:after_initialize) do
-          ActionView::Component::Base.descendants.each(&:compile)
-        end
-      end
-
-      initializer "action_view_component.compile_config_methods" do
-        ActiveSupport.on_load(:action_view_component) do
-          config.compile_methods! if config.respond_to?(:compile_methods!)
-        end
-      end
-
-      initializer "action_view_component.monkey_patch_render" do
-        ActiveSupport.on_load(:action_view) do
-          ActionView::Base.prepend ActionView::Component::RenderMonkeyPatch
-        end
-      end
-
-      config.after_initialize do |app|
-        options = app.config.action_view_component
-
-        if options.show_previews
-          app.routes.prepend do
-            get "/rails/components"       => "rails/components#index", :internal => true
-            get "/rails/components/*path" => "rails/components#previews", :internal => true
-          end
-        end
-      end
-    end
-  end
-end
+require "action_view/component/engine"

data/lib/action_view/component/version.rb

@@ -4,8 +4,8 @@ module ActionView
   module Component
     module VERSION
       MAJOR = 1
-      MINOR = 11
-      PATCH = 1
+      MINOR = 12
+      PATCH = 0
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -157,9 +157,11 @@ files:
 - README.md
 - Rakefile
 - actionview-component.gemspec
+- app/controllers/rails/components_controller.rb
 - lib/action_view/component.rb
 - lib/action_view/component/base.rb
 - lib/action_view/component/conversion.rb
+- lib/action_view/component/engine.rb
 - lib/action_view/component/preview.rb
 - lib/action_view/component/previewable.rb
 - lib/action_view/component/railtie.rb
@@ -182,7 +184,6 @@ files:
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/railties/lib/rails.rb
-- lib/railties/lib/rails/components_controller.rb
 - lib/railties/lib/rails/templates/rails/components/index.html.erb
 - lib/railties/lib/rails/templates/rails/components/preview.html.erb
 - lib/railties/lib/rails/templates/rails/components/previews.html.erb