view_component 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8661a26312dc3649e30ee17fbc94f6fd73be410067f8a7fac8b6aaefc4338d11
-  data.tar.gz: 1024034624c49bb65bfe1fc3466886ffa60cd9699a58c7427ea6dbedb9baa03b
+  metadata.gz: 3950532a26d2d6d1ddcf412383bfd9cde269c1f69c3d6f7f03dd4e51e7d638e2
+  data.tar.gz: ee2524ef62b335376287f30709e62f2d39a71e43c0f5ec9853db8142b6c8fb3c
 SHA512:
-  metadata.gz: 24ddc5373c2fbb7cd81ef4f4077ea66a30ea797fbb9d4c444135d3d8590b5151596fddc18f5bc5e1f18fec65ca87572858513409385489524c11c1929cff3567
-  data.tar.gz: cf63eb464e88e02310cb55f9c6c779c31622174777dbd1f39a24d0e9ac40407c555ac51012c5ea8c06bdeccac7aab880475c02c678c3fbff9ef22f5ca6cf797e
+  metadata.gz: c4cc6925445d3486e4c9a6ef915254cf3f28d973ad6a2876fca4fe3435b19ac273f18e89432622eaa38c8bba22ab9e9cafa07e417299dab8537848742175d1c8
+  data.tar.gz: 66d2a44a74a07e78f694adc4790218ee7a9d729e8cd8bb9546d154669a79d5abaa20e7d0bffa0801dfc276ef539b93d5a13dd2b4d3d3093cd8d806972d2dac81

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # master
 
+# 2.13.0
+
+* Add the ability to disable the render monkey patch with `config.view_component.render_monkey_patch_enabled`. In versions of Rails < 6.1, add `render_component` and `render_component_to_string` methods which can be used for rendering components instead of `render`.
+
+    *Johannes Engl*
+
 # 2.12.0
 
 * Implement Slots as potential successor to Content Areas.

data/README.md

@@ -711,6 +711,18 @@ To use component previews:
 config.view_component.preview_path = "#{Rails.root}/spec/components/previews"
 ```
 
+### Disabling the render monkey patch (Rails < 6.1)
+
+In order to [avoid conflicts](https://github.com/github/view_component/issues/288) between ViewComponent and other gems that also monkey patch the `render` method, it is possible to configure ViewComponent to not include the render monkey patch:
+
+`config.view_component.render_monkey_patch_enabled = false # defaults to true`
+
+With the monkey patch disabled, use `render_component` (or  `render_component_to_string`) instead:
+
+```
+<%= render_component Component.new(message: "bar") %>
+```
+
 ### Sidecar assets (experimental)
 
 It’s possible to include Javascript and CSS alongside components, sometimes called "sidecar" assets or files.
@@ -917,6 +929,11 @@ ViewComponent is built by:
 |@maxbeizer|@franco|@tbroad-ramsey|@jensljungblad|@bbugh|
 |Nashville, TN|Switzerland|Spring Hill, TN|New York, NY|Austin, TX|
 
+|<img src="https://avatars.githubusercontent.com/johannesengl?s=256" alt="johannesengl" width="128" />|
+|:---:|
+|@johannesengl|
+|Berlin, Germany|
+
 ## License
 
 ViewComponent is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/view_component/base.rb

@@ -162,6 +162,9 @@ module ViewComponent
     mattr_accessor :test_controller
     @@test_controller = "ApplicationController"
 
+    # Configure if render monkey patches should be included or not in Rails <6.1.
+    mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
+
     class << self
       attr_accessor :source_location
 

data/lib/view_component/engine.rb

@@ -10,6 +10,7 @@ module ViewComponent
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
+      options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
       options.show_previews = Rails.env.development? if options.show_previews.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
 
@@ -42,21 +43,35 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.monkey_patch_render" do
+    initializer "view_component.monkey_patch_render" do |app|
+      next if Rails.version.to_f >= 6.1 || !app.config.view_component.render_monkey_patch_enabled
+
       ActiveSupport.on_load(:action_view) do
-        if Rails.version.to_f < 6.1
-          require "view_component/render_monkey_patch"
-          ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
-        end
+        require "view_component/render_monkey_patch"
+        ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
       end
 
       ActiveSupport.on_load(:action_controller) do
-        if Rails.version.to_f < 6.1
-          require "view_component/rendering_monkey_patch"
-          require "view_component/render_to_string_monkey_patch"
-          ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
-          ActionController::Base.prepend ViewComponent::RenderToStringMonkeyPatch
-        end
+        require "view_component/rendering_monkey_patch"
+        require "view_component/render_to_string_monkey_patch"
+        ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
+        ActionController::Base.prepend ViewComponent::RenderToStringMonkeyPatch
+      end
+    end
+
+    initializer "view_component.include_render_component" do |app|
+      next if Rails.version.to_f >= 6.1
+
+      ActiveSupport.on_load(:action_view) do
+        require "view_component/render_component_helper"
+        ActionView::Base.include ViewComponent::RenderComponentHelper
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        require "view_component/rendering_component_helper"
+        require "view_component/render_component_to_string_helper"
+        ActionController::Base.include ViewComponent::RenderingComponentHelper
+        ActionController::Base.include ViewComponent::RenderComponentToStringHelper
       end
     end
 

data/lib/view_component/render_component_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderComponentHelper # :nodoc:
+    def render_component(component, &block)
+      component.render_in(self, &block)
+    end
+  end
+end

data/lib/view_component/render_component_to_string_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderComponentToStringHelper # :nodoc:
+    def render_component_to_string(component)
+      component.render_in(self.view_context)
+    end
+  end
+end

data/lib/view_component/rendering_component_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderingComponentHelper # :nodoc:
+    def render_component(component)
+      self.response_body = component.render_in(self.view_context)
+    end
+  end
+end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 12
+    MINOR = 13
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -204,8 +204,11 @@ files:
 - lib/view_component/engine.rb
 - lib/view_component/preview.rb
 - lib/view_component/previewable.rb
+- lib/view_component/render_component_helper.rb
+- lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb
 - lib/view_component/render_to_string_monkey_patch.rb
+- lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb
 - lib/view_component/slot.rb
 - lib/view_component/slotable.rb