actionview-component 1.1.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f02a9bdd999da01d26a2f7a9c80d0ec6cd1cf96d0195f8d2aa983f504d9908
-  data.tar.gz: ea36b326f6c565cf64acc827449dc11372a2bf10c49a77b5e994d9597234e926
+  metadata.gz: 7670fc77a362e27fd4b9d666c20c2042bb077a3a7c3211bca3271074af4ea913
+  data.tar.gz: 7fbd76e8c88ea4e44386e329dd187573dfc7553e371088053e8ec2645c0bad3f
 SHA512:
-  metadata.gz: e87095b78618384e60884166c0a6eb9d024c94afe0f5e4d44b1295dd5fbdf8a84000e304d8c4b56e51e8c6112f6416718fe04667b9e13bca4b2a5283c6346b49
-  data.tar.gz: '08dc5a1408d730948c08239a90edea25cfde9cc144a7e4b24ecfd4ee6817f7a49c19df7acec9fdfd58b26545c8fe182080dc436f3ac9aa14b17479365a40166b'
+  metadata.gz: be88328b943bc8aa3d4d1a05e845b53c77e3a6737e8e863b94c349ec3049d47bf25c4610ebbc812e2f2ecb84568ec787eb2e86cae622d5c3a2d81a7bce000655
+  data.tar.gz: a489fc157813dc6ac67bc8bd047b487234768c4584449128bd9290582507da75d68fb429a5ed9bfd9e75b80b29e21549a793de76a00f784a07a63657f12f6ad5

data/.github/workflows/ruby_on_rails.yml

@@ -1,14 +1,23 @@
 name: Ruby on Rails
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rails_version: ["5.2.3", "6.0.0", "master"]
-        ruby_version: ["2.5.x", "2.6.x"]
+        rails_version: [5.0.0, 5.2.3, 6.0.0, master]
+        ruby_version: [2.3.x, 2.4.x, 2.5.x, 2.6.x]
+        exclude:
+          - rails_version: master
+            ruby_version: 2.4.x
+          - rails_version: master
+            ruby_version: 2.3.x
+          - rails_version: 6.0.0
+            ruby_version: 2.4.x
+          - rails_version: 6.0.0
+            ruby_version: 2.3.x
     steps:
     - uses: actions/checkout@master
     - name: Setup Ruby
@@ -17,7 +26,7 @@ jobs:
         version: ${{ matrix.ruby_version }}
     - name: Build and test with Rake
       run: |
-        gem install bundler
+        gem install bundler:1.14.0
         bundle update
         bundle install --jobs 4 --retry 3
         bundle exec rake

data/CHANGELOG.md

@@ -1,7 +1,49 @@
-*   Components now inherit from ActionView::Component::base
+# v1.3.2
+
+*   Support rendering views from inside component templates.
+
+    *Patrick Sinclair*
+
+# v1.3.1
+
+*   Fix bug where rendering nested content caused an error.
+
+    *Joel Hawksley, Aaron Patterson*
+
+# v1.3.0
+
+*   Components are rendered with enough controller context to support rendering of partials and forms.
+
+    *Patrick Sinclair, Joel Hawksley, Aaron Patterson*
+
+# v1.2.1
+
+*   `actionview-component` is now tested against Ruby 2.3/2.4 and Rails 5.0.0.
+
+# v1.2.0
+
+*   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/CONTRIBUTING.md

@@ -32,6 +32,7 @@ Here are a few things you can do that will increase the likelihood of your pull
 If you are the current maintainer of this gem:
 
 1. Create a branch for the release: `git checkout -b release-vxx.xx.xx`
+1. Bump gem version in `actionview-component.gemspec`.
 1. Make sure your local dependencies are up to date: `bundle`
 1. Ensure that tests are green: `bundle exec rake`
 1. Build a test gem `GEM_VERSION=$(git describe --tags 2>/dev/null | sed 's/-/./g' | sed 's/v//') gem build actionview-component.gemspec`
@@ -39,7 +40,6 @@ If you are the current maintainer of this gem:
    1. Bump the Gemfile and Gemfile.lock versions for an app which relies on this gem
    1. Install the new gem locally
    1. Test behavior locally, branch deploy, whatever needs to happen
-1. Bump gem version in `actionview-component.gemspec`.
 1. Make a PR to github/actionview-component.
 1. Build a local gem: `gem build actionview-component.gemspec`
 1. Merge github/actionview-component PR

data/Gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 gemspec
 
-rails_version = "#{ENV['RAILS_VERSION'] || '5.2.3'}"
+rails_version = "#{ENV['RAILS_VERSION'] || '6.0.0'}"
 
 gem "rails", rails_version == "master" ? { github: "rails/rails" } : rails_version

data/Gemfile.lock

@@ -1,53 +1,66 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.0.1)
+    actionview-component (1.3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.3)
-      actionpack (= 5.2.3)
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
       globalid (>= 0.3.6)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activestorage (5.2.3)
-      actionpack (= 5.2.3)
-      activerecord (= 5.2.3)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
       marcel (~> 0.3.1)
-    activesupport (5.2.3)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
+      zeitwerk (~> 2.1, >= 2.1.8)
     ast (2.4.0)
     builder (3.2.3)
     concurrent-ruby (1.1.5)
@@ -72,8 +85,8 @@ GEM
     mimemagic (0.3.3)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nio4r (2.4.0)
+    minitest (5.1.0)
+    nio4r (2.5.2)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
@@ -82,30 +95,32 @@ GEM
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.3)
-      actioncable (= 5.2.3)
-      actionmailer (= 5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      activemodel (= 5.2.3)
-      activerecord (= 5.2.3)
-      activestorage (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
       bundler (>= 1.3.0)
-      railties (= 5.2.3)
+      railties (= 6.0.0)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rubocop (0.74.0)
@@ -141,6 +156,7 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby
@@ -149,12 +165,12 @@ DEPENDENCIES
   actionview-component!
   bundler (>= 1.14)
   haml (~> 5)
-  minitest (~> 5.0)
-  rails (= 5.2.3)
+  minitest (= 5.1.0)
+  rails (= 6.0.0)
   rake (~> 10.0)
   rubocop (~> 0.59)
   rubocop-github (~> 0.13.0)
   slim (~> 4.0)
 
 BUNDLED WITH
-   2.0.2
+   1.17.3

data/README.md

@@ -9,9 +9,13 @@ This gem is meant to serve as a precursor to upstreaming the `ActionView::Compon
 
 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 `6.1`, this gem will then exist to serve as a backport.
 
+## 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).
+
 ## Compatibility
 
-`actionview-component` is tested for compatibility with all combinations of Ruby `2.5`/`2.6` and Rails `5.2.3`/`6.0.0`/`6.1.0.alpha`.
+`actionview-component` is tested for compatibility with combinations of Ruby `2.3`/`2.4`/`2.5`/`2.6` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -124,7 +128,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 +139,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 +167,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 +178,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.3.2"
   spec.authors       = ["GitHub Open Source"]
   spec.email         = ["opensource+actionview-component@github.com"]
 
@@ -31,11 +31,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency "bundler", ">= 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.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 "rubocop", "~> 0.59"

data/lib/action_view/component/base.rb

@@ -2,24 +2,36 @@
 
 # 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
   module Component
     class Base < ActionView::Base
       include ActiveModel::Validations
+      include ActiveSupport::Configurable
+      include ActionController::RequestForgeryProtection
 
       # Entrypoint for rendering components. Called by ActionView::Base#render.
       #
@@ -42,12 +54,18 @@ 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>
       #
       def render_in(view_context, *args, &block)
         self.class.compile
+        self.controller = view_context.controller
+        @view_context = view_context
+        @view_renderer ||= view_context.view_renderer
+        @lookup_context ||= view_context.lookup_context
+        @view_flow ||= view_context.view_flow
+
         @content = view_context.capture(&block) if block_given?
         validate!
         call
@@ -55,6 +73,14 @@ module ActionView
 
       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
+
       class << self
         def inherited(child)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -126,7 +152,7 @@ module ActionView
 
       private
 
-      attr_reader :content
+      attr_reader :content, :view_context
     end
   end
 end

data/lib/action_view/component/test_helpers.rb

@@ -3,8 +3,20 @@
 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(controller.view_context.render(component, args, &block))
+      end
+
+      def controller
+        @controller ||= ApplicationController.new.tap { |c| c.request = ActionDispatch::TestRequest.create }
+      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.3.2
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="