actionview-component 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f02a9bdd999da01d26a2f7a9c80d0ec6cd1cf96d0195f8d2aa983f504d9908
-  data.tar.gz: ea36b326f6c565cf64acc827449dc11372a2bf10c49a77b5e994d9597234e926
+  metadata.gz: ddf5bf315652aa562e2539e334b61b97504cc05d37dd8580929dc0427d4ef44a
+  data.tar.gz: 2c7310fec9eca98c28d6dc1b547959a8f4581026a59afe66f927df4c630b4ded
 SHA512:
-  metadata.gz: e87095b78618384e60884166c0a6eb9d024c94afe0f5e4d44b1295dd5fbdf8a84000e304d8c4b56e51e8c6112f6416718fe04667b9e13bca4b2a5283c6346b49
-  data.tar.gz: '08dc5a1408d730948c08239a90edea25cfde9cc144a7e4b24ecfd4ee6817f7a49c19df7acec9fdfd58b26545c8fe182080dc436f3ac9aa14b17479365a40166b'
+  metadata.gz: 38c43b346608924c4ee5977c99760acebbb055392acbb276b8dbe1f0ce92b2c020b6ff2a9c5c63ac9b9025e4d1cc9a24fd86bf428a5ba375f11fa7b12a8fc149
+  data.tar.gz: 7ed9efc6148a03dcaafcbec7a77467b17690e2c71e5afb133855a4924b91a771c0980cd7e0b4373f9deea8909be74e675a3a579e39eb78391cfbce8ab4db01af

data/CHANGELOG.md

@@ -1,7 +1,25 @@
-*   Components now inherit from ActionView::Component::base
+*   The `render_component` test helper has been renamed to `render_inline`. `render_component` has been deprecated and will be removed in v2.0.0.
 
     *Joel Hawksley*
 
+*   Components are now rendered with `render MyComponent, foo: :bar` syntax. The existing `render MyComponent.new(foo: :bar)` syntax has been deprecated and will be removed in v2.0.0.
+
+    *Joel Hawksley*
+
+# v1.1.0
+
+*   Components now inherit from ActionView::Component::Base
+
+    *Joel Hawksley*
+
+# v1.0.1
+
 *   Always recompile component templates outside production.
 
     *Joel Hawksley, John Hawthorn*
+
+# v1.0.0
+
+This release extracts the `ActionView::Component` library from the GitHub application.
+
+It will be published on RubyGems under the existing `actionview-component` gem name, as @chancancode has passed us ownership of the gem.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.0.1)
+    actionview-component (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -124,7 +124,7 @@ end
 We can render it in a view as:
 
 ```erb
-<%= render(TestComponent.new(title: "my title")) do %>
+<%= render(TestComponent, title: "my title") do %>
   Hello, World!
 <% end %>
 ```
@@ -135,12 +135,24 @@ Which returns:
 <span title="my title">Hello, World!</span>
 ```
 
+##### Supported `render` syntaxes
+
+Components can be rendered via:
+
+`render(TestComponent, foo: :bar)`
+
+`render(component: TestComponent, locals: { foo: :bar })`
+
+The following syntax has been deprecated and will be removed in v2.0.0:
+
+`render(TestComponent.new(foo: :bar)`
+
 #### Error case
 
 If the component is rendered with a blank title:
 
 ```erb
-<%= render(TestComponent.new(title: "")) do %>
+<%= render(TestComponent, title: "") do %>
   Hello, World!
 <% end %>
 ```
@@ -151,7 +163,7 @@ An error will be raised:
 
 ### Testing
 
-Components are unit tested directly. The `render_component` test helper renders a component and wraps the result in `Nokogiri.HTML`, allowing us to test the component above as:
+Components are unit tested directly. The `render_inline` test helper wraps the result in `Nokogiri.HTML`, allowing us to test the component above as:
 
 ```ruby
 require "action_view/component/test_helpers"
@@ -162,7 +174,7 @@ class MyComponentTest < Minitest::Test
   def test_render_component
     assert_equal(
       %(<span title="my title">Hello, World!</span>),
-      render_component(TestComponent.new(title: "my title")) { "Hello, World!" }.css("span").to_html
+      render_inline(TestComponent, title: "my title") { "Hello, World!" }.css("span").to_html
     )
   end
 end

data/actionview-component.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "actionview-component"
-  spec.version       = "1.1.0"
+  spec.version       = "1.2.0"
   spec.authors       = ["GitHub Open Source"]
   spec.email         = ["opensource+actionview-component@github.com"]
 

data/lib/action_view/component/base.rb

@@ -2,18 +2,28 @@
 
 # Monkey patch ActionView::Base#render to support ActionView::Component
 #
-# Upstreamed in https://github.com/rails/rails/pull/36388
-# Necessary for Rails versions < 6.1.0.alpha
+# A version of this monkey patch was upstreamed in https://github.com/rails/rails/pull/36388
+# We'll need to upstream an updated version of this eventually.
 class ActionView::Base
   module RenderMonkeyPatch
-    def render(component, _ = nil, &block)
-      return super unless component.respond_to?(:render_in)
-
-      component.render_in(self, &block)
+    def render(options = {}, args = {}, &block)
+      if options.respond_to?(:render_in)
+        ActiveSupport::Deprecation.warn(
+          "passing component instances to `render` has been deprecated and will be removed in v2.0.0. Use `render MyComponent, foo: :bar` instead."
+        )
+
+        options.render_in(self, &block)
+      elsif options.is_a?(Class) && options < ActionView::Component::Base
+        options.new(args).render_in(self, &block)
+      elsif options.is_a?(Hash) && options.has_key?(:component)
+        options[:component].new(options[:locals]).render_in(self, &block)
+      else
+        super
+      end
     end
   end
 
-  prepend RenderMonkeyPatch unless Rails::VERSION::MINOR > 0 && Rails::VERSION::MAJOR == 6
+  prepend RenderMonkeyPatch
 end
 
 module ActionView
@@ -42,7 +52,7 @@ module ActionView
       # <span title="<%= @title %>">Hello, <%= content %>!</span>
       #
       # In use:
-      # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
+      # <%= render MyComponent, title: "greeting" do %>world<% end %>
       # returns:
       # <span title="greeting">Hello, world!</span>
       #

data/lib/action_view/component/test_helpers.rb

@@ -3,8 +3,16 @@
 module ActionView
   module Component
     module TestHelpers
-      def render_component(component, &block)
-        Nokogiri::HTML(component.render_in(ApplicationController.new.view_context, &block))
+      def render_inline(component, **args, &block)
+        Nokogiri::HTML(ApplicationController.new.view_context.render(component, args, &block))
+      end
+
+      def render_component(component, **args, &block)
+        ActiveSupport::Deprecation.warn(
+          "`render_component` has been deprecated in favor of `render_inline`, and will be removed in v2.0.0."
+        )
+
+        render_inline(component, args, &block)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler