actionview-component 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d62ba2c307963de0523a13f554d1e78b9e76990ace76c36b7d982ec83ef2cb
-  data.tar.gz: 66682a57cd5504b054c7c21227bbfb6cdc2c14f0ac151f2d6bb136a1f2e7a6cb
+  metadata.gz: c20b9ae371123eb58c62aa3c093baafdf7d5745bf8311ff2fb975c70282e6dfd
+  data.tar.gz: caaad9f6e645602efe2faea055ff08dd1f548efe08b503a3048d83eebc824997
 SHA512:
-  metadata.gz: 0f5b33cb1dfff517ae58afb9167a5f0370f40902eef1ecfef1d6ee0e9f589a255826b92cbccf3bec5fd0a91d487601ec273f6238ddc029a3daade14aa5cd8a5a
-  data.tar.gz: f2f58364fba2269e40bf5bd1040872f826365f67e09679996c79999a0755a1ffdbe06f89bb661f80e7a23a2b4791dff6618b28da9a9cf062b1ca41f65ee69dfa
+  metadata.gz: 52aec02cba11b482df4c4e4f160ad7602dadca664eb75a4fad579fb5802c9f4efb6a7e07f1082ab634e99c9ed8efad82861daf1fdc9c5108cdf63e3f2b0f80d1
+  data.tar.gz: 4d5fb555f12740dfa62a64b4c9b095879e4ea182a3930f9a725482525c6d5bbeae08d9914dff847e8521a7107f31b13b919f5b9d5cc69d83cbaf53c08422503c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v1.10.0
+
+* Deprecate all `render` syntaxes except for `render(MyComponent.new(foo: :bar))`
+
 # v1.9.0
 
 * Remove initializer requirement for Ruby 2.7+

data/Gemfile.lock

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

data/README.md

@@ -144,7 +144,7 @@ end
 We can render it in a view as:
 
 ```erb
-<%= render(TestComponent, title: "my title") do %>
+<%= render(TestComponent.new(title: "my title")) do %>
   Hello, World!
 <% end %>
 ```
@@ -155,42 +155,12 @@ 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 })`
-
-**Rendering components through models**
-
-Passing model instances will cause `render` to look for its respective component class.
-
-The component is instantiated with the rendered model instance.
-
-Example for a `Post` model:
-
-`render(@post)`
-
-```ruby
-class PostComponent < ActionView::Component::Base
-  def initialize(post)
-    @post = post
-  end
-end
-```
-
-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, title: "") do %>
+<%= render(TestComponent.new(title: "")) do %>
   Hello, World!
 <% end %>
 ```
@@ -227,7 +197,7 @@ end
 We can render it in a view as:
 
 ```erb
-<%= render(ModalComponent, user: {name: 'Jane'}) do |component| %>
+<%= render(ModalComponent.new(user: {name: 'Jane'})) do |component| %>
   <% component.with(:header) do %>
       Hello <%= user[:name] %>
     <% end %>
@@ -265,7 +235,7 @@ end
 ```
 
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
   <% help_enabled? && component.with(:header) do %>
     <span class="help_icon"><%= component.header %></span>
   <% end %>
@@ -292,7 +262,7 @@ end
 
 `app/views/render_arg.html.erb`:
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
   <% end %>
@@ -338,7 +308,7 @@ end
 
 `app/views/render_arg.html.erb`:
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
   <% end %>
@@ -347,7 +317,7 @@ end
 
 `app/views/with_block.html.erb`:
 ```erb
-<%= render(ModalComponent) do |component| %>
+<%= render(ModalComponent.new) do |component| %>
   <% component.with(:header) do %>
     <span class="help_icon">Hello</span>
   <% end %>
@@ -359,7 +329,7 @@ end
 
 `app/views/no_header.html.erb`:
 ```erb
-<%= render(ModalComponent) do |component| %>
+<%= render(ModalComponent.new) do |component| %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
   <% end %>
@@ -386,7 +356,7 @@ or the view that renders the component:
 ```erb
 <!-- app/views/_banners.html.erb -->
 <% if current_user.requires_confirmation? %>
-  <%= render(ConfirmEmailComponent, user: current_user) %>
+  <%= render(ConfirmEmailComponent.new(user: current_user)) %>
 <% end %>
 ```
 
@@ -414,7 +384,7 @@ end
 
 ```erb
 <!-- app/views/_banners.html.erb -->
-<%= render(ConfirmEmailComponent, user: current_user) %>
+<%= render(ConfirmEmailComponent.new(user: current_user)) %>
 ```
 
 ### Testing
@@ -428,7 +398,7 @@ class MyComponentTest < ActionView::Component::TestCase
   test "render component" do
     assert_equal(
       %(<span title="my title">Hello, World!</span>),
-      render_inline(TestComponent, title: "my title") { "Hello, World!" }.to_html
+      render_inline(TestComponent.new(title: "my title")) { "Hello, World!" }.to_html
     )
   end
 end
@@ -445,7 +415,7 @@ test "render component for tablet" do
   with_variant :tablet do
     assert_equal(
       %(<span title="my title">Hello, tablets!</span>),
-      render_inline(TestComponent, title: "my title") { "Hello, tablets!" }.css("span").to_html
+      render_inline(TestComponent.new(title: "my title")) { "Hello, tablets!" }.css("span").to_html
     )
   end
 end
@@ -462,11 +432,11 @@ You can define as many examples as you want:
 
 class TestComponentPreview < ActionView::Component::Preview
   def with_default_title
-    render(TestComponent, title: "Test component default")
+    render(TestComponent.new(title: "Test component default"))
   end
 
   def with_long_title
-    render(TestComponent, title: "This is a really long title to see how the component renders this")
+    render(TestComponent.new(title: "This is a really long title to see how the component renders this"))
   end
 end
 ```

data/lib/action_view/component/render_monkey_patch.rb

@@ -1,24 +1,29 @@
 # frozen_string_literal: true
 
 # Monkey patch ActionView::Base#render to support ActionView::Component
-#
-# 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.
 module ActionView
   module Component
     module RenderMonkeyPatch # :nodoc:
       def render(options = {}, args = {}, &block)
         if options.respond_to?(:render_in)
+          options.render_in(self, &block)
+        elsif options.is_a?(Class) && options < ActionView::Component::Base
           ActiveSupport::Deprecation.warn(
-            "passing component instances (`render MyComponent.new(foo: :bar)`) has been deprecated and will be removed in v2.0.0. Use `render MyComponent, foo: :bar` instead."
+            "`render MyComponent, foo: :bar` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(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)
+          ActiveSupport::Deprecation.warn(
+            "`render component: MyComponent, locals: { foo: :bar }` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+          )
+
           options[:component].new(options[:locals]).render_in(self, &block)
         elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil?
+          ActiveSupport::Deprecation.warn(
+            "rendering objects that respond_to `to_component_class` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+          )
+
           options.to_component_class.new(options).render_in(self, &block)
         else
           super

data/lib/action_view/component/version.rb

@@ -4,7 +4,7 @@ module ActionView
   module Component
     module VERSION
       MAJOR = 1
-      MINOR = 9
+      MINOR = 10
       PATCH = 0
 
       STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - GitHub Open Source