actionview-component 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '085434585e1e3fa1493bbc7bd90439b1645015acd66a713a33545c0eb4677dc4'
-  data.tar.gz: 34ec8d8f390471689fbd1085c94885b74c4f9a1b0b7d9b78650dae506520dd13
+  metadata.gz: ab99ff30cf5a1d5fad5d3f670936b813d8923b9e4e5a3db566c0c08fa8cb7550
+  data.tar.gz: 7432ee39d40af863647a1cdf220b7775592bfef12c84bbc8a6175d741b88c2ff
 SHA512:
-  metadata.gz: 89e3c7d8b6c1d67a29f2ad67a032e424c42f57dd719d5b8cbde01b167385d9d2aeb5feb8fd77fcd9284e0a33da828b935edeebbb758c7cd68951178eea2d3b14
-  data.tar.gz: bc76f28233c72f7d5ff3a818429e8c763649db3ec46e406b554070cd456b73ae923905ecb94d3b37949ca5c6b0960890594a341e72a9755343462cf4c5c24cff
+  metadata.gz: 53a8dc19f3caa79baf1c2fc754ee0b715885b83eaae13a7a3b6f2f25fb574dd6a0b109cd61328444abaf93ef55ded12413d59a5343fc707c544baba766c14ae7
+  data.tar.gz: a73449076c9d073052c97ad8cc0d58a88d40f8973a576221a41d7b9e7ed15aeecd0d3704694e4f78bf918fbe6f4d875df0f389f71381b81ad0fed7f8fb4720d3

data/.github/ISSUE_TEMPLATE

@@ -6,17 +6,12 @@
 ### Motivation
 
 <!-- What would you like to do with this feature? Can you provide
-context or references to similar behavior in other libraries. -->
+context or references to similar behavior in other libraries? -->
 
-
-
-
-
-<!-- **** Filing a Bug Report? Include these sections. **** -->
+<!-- **** Filing a Bug Report? Include these sections: **** -->
 
 ### Steps to reproduce
-<!-- Provide an series of steps or, better yet, a link to a repo to
-demonstrate the bug you've identified. -->
+<!-- Provide a series of steps or, better yet, a link to a repo to demonstrate the bug you've identified. -->
 
 ### Expected behavior
 <!-- Tell us what should happen -->

data/.github/PULL_REQUEST_TEMPLATE

@@ -1,4 +1,4 @@
-<!-- https://github.com/github/actionview-component/blob/master/CONTRIBUTING.md#submitting-a-pull-request  -->
+<!-- See https://github.com/github/actionview-component/blob/master/CONTRIBUTING.md#submitting-a-pull-request  -->
 
 ### Summary
 
@@ -14,6 +14,4 @@ request, mention that information here. This could include
 benchmarks, or other information.
 
 If you are updating any of the CHANGELOG files or are asked to update the
-CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
-
-Thanks for contributing to actionview-component! -->
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file. -->

data/.gitignore

@@ -11,6 +11,7 @@
 /tmp/
 /test/log/*
 /test/app/tmp/*
+/test/tmp/*
 
 # Used by dotenv library to load environment variables.
 # .env

data/.rubocop.yml

@@ -2,3 +2,7 @@ inherit_gem:
   rubocop-github:
     - config/default.yml
     - config/rails.yml
+
+AllCops:
+  Exclude:
+    - "test/tmp/**/*"

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+# v1.8.0
+
+* Remove the unneeded ComponentExamplesController and simplify preview rendering.
+
+    *Jon Palmer*
+
+* Add `#render?` hook to easily allow components to be no-ops.
+
+    *Kyle Fox*
+
+* Don't assume ApplicationController exists.
+
+    *Jon Palmer*
+
+* Allow some additional checks to overrided render?
+
+    *Sergey Malykh*
+
+* Fix generator placing namespaced components in the root directory.
+
+    *Asger Behncke Jacobsen*
+
+* Fix cache test.
+
+    *Sergey Malykh*
+
 # v1.7.0
 
 * Simplify validation of templates and compilation.

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Contributing
+# Contributing
 
 [fork]: https://github.com/github/actionview-component/fork
 [pr]: https://github.com/github/actionview-component/compare
@@ -15,9 +15,11 @@ Please note that this project is released with a [Contributor Code of Conduct][c
 
 0. [Fork][fork] and clone the repository
 0. Configure and install the dependencies: `bundle`
-0. Make sure the tests pass on your machine: `rake`
+0. Make sure the tests pass on your machine: `bundle exec rake`
 0. Create a new branch: `git checkout -b my-branch-name`
 0. Make your change, add tests, and make sure the tests still pass
+0. Add an entry to the top of `CHANGELOG.md` for your changes
+0. If it's your first time contributing, add yourself to the contributors at the bottom of `README.md`
 0. Push to your fork and [submit a pull request][pr]
 0. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
@@ -36,20 +38,9 @@ If you are the current maintainer of this gem:
 1. Add version heading/entries to `CHANGELOG.md`.
 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`
-1. Test the test 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. Make a PR to github/actionview-component.
 1. Build a local gem: `gem build actionview-component.gemspec`
 1. Merge github/actionview-component PR
 1. Tag and push: `git tag vx.xx.xx; git push --tags`
 1. Create a GitHub release with the pushed tag (https://github.com/github/actionview-component/releases/new) and populate it with a list of the commits from `git log --pretty=format:"- %s" --reverse refs/tags/[OLD TAG]...refs/tags/[NEW TAG]`
 1. Push to rubygems.org -- `gem push actionview-component-VERSION.gem`
-
-## Resources
-
-- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
-- [GitHub Help](https://help.github.com)

data/Gemfile.lock

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

data/README.md

@@ -201,7 +201,6 @@ An error will be raised:
 
 #### Content Areas
 
-
 A component can declare additional content areas to be rendered in the component. For example:
 
 `app/components/modal_component.rb`:
@@ -304,7 +303,7 @@ end
 ```erb
 <%= render(ModalComponent) do |component| %>
   <% component.with(:header) do %>
-    <span class="help_icon">Hello</span> 
+    <span class="help_icon">Hello</span>
   <% end %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
@@ -350,7 +349,7 @@ end
 ```erb
 <%= render(ModalComponent) do |component| %>
   <% component.with(:header) do %>
-    <span class="help_icon">Hello</span> 
+    <span class="help_icon">Hello</span>
   <% end %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
@@ -367,6 +366,57 @@ end
 <% end %>
 ```
 
+### Conditional Rendering
+
+Components can implement a `#render?` method which indicates if they should be rendered, or not at all.
+
+For example, you might have a component that displays a "Please confirm your email address" banner to users who haven't confirmed their email address. The logic for rendering the banner would need to go in either the component template:
+
+```
+<!-- app/components/confirm_email_component.html.erb -->
+<% if user.requires_confirmation? %>
+  <div class="alert">
+    Please confirm your email address.
+  </div>
+<% end %>
+```
+
+or the view that renders the component:
+
+```erb
+<!-- app/views/_banners.html.erb -->
+<% if current_user.requires_confirmation? %>
+  <%= render(ConfirmEmailComponent, user: current_user) %>
+<% end %>
+```
+
+The `#render?` hook allows you to move this logic into the Ruby class, leaving your views more readable and declarative in style:
+
+```ruby
+# app/components/confirm_email_component.rb
+class ConfirmEmailComponent < ApplicationComponent
+  def initialize(user:)
+    @user = user
+  end
+
+  def render?
+    @user.requires_confirmation?
+  end
+end
+```
+
+```
+<!-- app/components/confirm_email_component.html.erb -->
+<div class="banner">
+  Please confirm your email address.
+</div>
+```
+
+```erb
+<!-- app/views/_banners.html.erb -->
+<%= render(ConfirmEmailComponent, user: current_user) %>
+```
+
 ### Testing
 
 Components are unit tested directly. The `render_inline` test helper wraps the result in `Nokogiri.HTML`, allowing us to test the component above as:
@@ -444,6 +494,16 @@ For example, if you want to use `lib/component_previews`, set the following in `
 config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
 ```
 
+#### Configuring TestController
+
+By default components tests and previews expect your Rails project to contain an `ApplicationController` class from which Controller classes inherit.
+This can be configured using the `test_controller` option.
+For example, if your controllers inherit from `BaseController`, set the following in `config/application.rb`:
+
+```ruby
+config.action_view_component.test_controller = "BaseController"
+```
+
 ### Setting up RSpec
 
 If you're using RSpec, you can configure component specs to have access to test helpers. Add the following to
@@ -499,6 +559,35 @@ Inline templates have been removed (for now) due to concerns raised by [@soutaro
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/github/actionview-component. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./CONTRIBUTING.md) as well.
 
+## Contributors
+
+`actionview-component` is built by:
+
+|<img src="https://avatars.githubusercontent.com/joelhawksley?s=256" alt="joelhawksley" width="128" />|<img src="https://avatars.githubusercontent.com/tenderlove?s=256" alt="tenderlove" width="128" />|<img src="https://avatars.githubusercontent.com/jonspalmer?s=256" alt="jonspalmer" width="128" />|<img src="https://avatars.githubusercontent.com/juanmanuelramallo?s=256" alt="juanmanuelramallo" width="128" />|<img src="https://avatars.githubusercontent.com/vinistock?s=256" alt="vinistock" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@joelhawksley|@tenderlove|@jonspalmer|@juanmanuelramallo|@vinistock|
+|Denver|Seattle|Boston||Toronto|
+
+|<img src="https://avatars.githubusercontent.com/metade?s=256" alt="metade" width="128" />|<img src="https://avatars.githubusercontent.com/asgerb?s=256" alt="asgerb" width="128" />|<img src="https://avatars.githubusercontent.com/xronos-i-am?s=256" alt="xronos-i-am" width="128" />|<img src="https://avatars.githubusercontent.com/dylnclrk?s=256" alt="dylnclrk" width="128" />|<img src="https://avatars.githubusercontent.com/kaspermeyer?s=256" alt="kaspermeyer" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@metade|@asgerb|@xronos-i-am|@dylnclrk|@kaspermeyer|
+|London|Copenhagen|Russia, Kirov|Berkeley, CA|Denmark|
+
+|<img src="https://avatars.githubusercontent.com/rdavid1099?s=256" alt="rdavid1099" width="128" />|<img src="https://avatars.githubusercontent.com/kylefox?s=256" alt="kylefox" width="128" />|<img src="https://avatars.githubusercontent.com/traels?s=256" alt="traels" width="128" />|<img src="https://avatars.githubusercontent.com/rainerborene?s=256" alt="rainerborene" width="128" />|<img src="https://avatars.githubusercontent.com/jcoyne?s=256" alt="jcoyne" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@rdavid1099|@kylefox|@traels|@rainerborene|@jcoyne|
+|Los Angeles|Edmonton|Odense, Denmark|Brazil|Minneapolis|
+
+|<img src="https://avatars.githubusercontent.com/elia?s=256" alt="elia" width="128" />|<img src="https://avatars.githubusercontent.com/cesariouy?s=256" alt="cesariouy" width="128" />|<img src="https://avatars.githubusercontent.com/spdawson?s=256" alt="spdawson" width="128" />|<img src="https://avatars.githubusercontent.com/rmacklin?s=256" alt="rmacklin" width="128" />|<img src="https://avatars.githubusercontent.com/michaelem?s=256" alt="michaelem" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@elia|@cesariouy|@spdawson|@rmacklin|@michaelem|
+|Milan||United Kingdom||Berlin|
+
+|<img src="https://avatars.githubusercontent.com/mellowfish?s=256" alt="mellowfish" width="128" />|<img src="https://avatars.githubusercontent.com/horacio?s=256" alt="horacio" width="128" />|<img src="https://avatars.githubusercontent.com/dukex?s=256" alt="dukex" width="128" />|<img src="https://avatars.githubusercontent.com/dark-panda?s=256" alt="dark-panda" width="128" />|
+|:---:|:---:|:---:|:---:|
+|@mellowfish|@horacio|@dukex|@dark-panda|
+|Spring Hill, TN|Buenos Aires|São Paulo||
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/action_view/component/base.rb

@@ -47,6 +47,9 @@ module ActionView
         @view_flow ||= view_context.view_flow
         @virtual_path ||= virtual_path
         @variant = @lookup_context.variants.first
+
+        return "" unless render?
+
         old_current_template = @current_template
         @current_template = self
 
@@ -59,6 +62,10 @@ module ActionView
         @current_template = old_current_template
       end
 
+      def render?
+        true
+      end
+
       def initialize(*); end
 
       def render(options = {}, args = {}, &block)
@@ -112,6 +119,12 @@ module ActionView
 
       attr_reader :content, :view_context
 
+      # The controller used for testing components.
+      # Defaults to ApplicationController. This should be set early
+      # in the initialization process and should be set to a string.
+      mattr_accessor :test_controller
+      @@test_controller = "ApplicationController"
+
       class << self
         def inherited(child)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -199,7 +212,7 @@ module ActionView
 
         def matching_views_in_source_location
           return [] unless source_location
-          (Dir["#{source_location.sub(/#{File.extname(source_location)}$/, '')}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
+          (Dir["#{source_location.chomp(File.extname(source_location))}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
         end
 
         def templates

data/lib/action_view/component/preview.rb

@@ -6,10 +6,9 @@ module ActionView
   module Component # :nodoc:
     class Preview
       extend ActiveSupport::DescendantsTracker
-      include ActionView::Component::TestHelpers
 
-      def render(component, *locals, &block)
-        render_inline(component, *locals, &block)
+      def render(component, **args, &block)
+        { component: component, args: args, block: block }
       end
 
       class << self
@@ -19,21 +18,14 @@ module ActionView
           descendants
         end
 
-        # Returns the html of the component in its layout
-        def call(example, layout: nil)
-          example_html = new.public_send(example)
-          if layout.nil?
-            layout = @layout.nil? ? "layouts/application" : @layout
-          end
-
-          Rails::ComponentExamplesController.render(template: "examples/show",
-                                                    layout: layout,
-                                                    assigns: { example: example_html })
+        # Returns the arguments for rendering of the component in its layout
+        def render_args(example)
+          new.public_send(example).merge(layout: @layout)
         end
 
         # Returns the component object class associated to the preview.
         def component
-          self.name.sub(%r{Preview$}, "").constantize
+          name.chomp("Preview").constantize
         end
 
         # Returns all of the available examples for the component preview.
@@ -58,7 +50,7 @@ module ActionView
 
         # Returns the underscored name of the component preview without the suffix.
         def preview_name
-          name.sub(/Preview$/, "").underscore
+          name.chomp("Preview").underscore
         end
 
         # Setter for layout name.

data/lib/action_view/component/railtie.rb

@@ -24,7 +24,6 @@ module ActionView
 
       initializer "action_view_component.set_autoload_paths" do |app|
         require "railties/lib/rails/components_controller"
-        require "railties/lib/rails/component_examples_controller"
 
         options = app.config.action_view_component
 

data/lib/action_view/component/test_helpers.rb

@@ -8,7 +8,7 @@ module ActionView
       end
 
       def controller
-        @controller ||= ApplicationController.new.tap { |c| c.request = request }
+        @controller ||= Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
       end
 
       def request

data/lib/action_view/component/version.rb

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

data/lib/rails/generators/component/component_generator.rb

@@ -10,11 +10,11 @@ module Rails
       check_class_collision suffix: "Component"
 
       def create_component_file
-        template "component.rb", File.join("app/components",  "#{file_name}_component.rb")
+        template "component.rb", File.join("app/components", class_path, "#{file_name}_component.rb")
       end
 
       def create_template_file
-        template "component.html.erb", File.join("app/components",  "#{file_name}_component.html.erb")
+        template "component.html.erb", File.join("app/components", class_path, "#{file_name}_component.html.erb")
       end
 
       private

data/lib/rails/generators/rspec/component_generator.rb

@@ -6,7 +6,7 @@ module Rspec
       source_root File.expand_path("templates", __dir__)
 
       def create_test_file
-        template "component_spec.rb", File.join("spec/components", "#{file_name}_component_spec.rb")
+        template "component_spec.rb", File.join("spec/components", class_path, "#{file_name}_component_spec.rb")
       end
 
       private

data/lib/rails/generators/test_unit/component_generator.rb

@@ -7,7 +7,7 @@ module TestUnit
       check_class_collision suffix: "ComponentTest"
 
       def create_test_file
-        template "component_test.rb", File.join("test/components", "#{file_name}_component_test.rb")
+        template "component_test.rb", File.join("test/components", class_path, "#{file_name}_component_test.rb")
       end
 
       private

data/lib/railties/lib/rails.rb

@@ -2,5 +2,4 @@
 
 module Rails
   autoload :ComponentsController
-  autoload :ComponentExamplesController
 end

data/lib/railties/lib/rails/components_controller.rb

@@ -4,6 +4,7 @@ require "rails/application_controller"
 
 class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
   prepend_view_path File.expand_path("templates/rails", __dir__)
+  prepend_view_path "#{Rails.root}/app/views/" if defined?(Rails.root)
 
   around_action :set_locale, only: :previews
   before_action :find_preview, only: :previews
@@ -25,7 +26,10 @@ class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
       render template: "components/previews"
     else
       @example_name = File.basename(params[:path])
-      render template: "components/preview", layout: false
+      @render_args = @preview.render_args(@example_name)
+      layout = @render_args[:layout]
+      opts = layout.nil? ? {} : { layout: layout }
+      render template: "components/preview", **opts
     end
   end
 

data/lib/railties/lib/rails/templates/rails/components/preview.html.erb

@@ -1 +1 @@
-<%= raw @preview.call(@example_name) %>
+<%= render(@render_args[:component], **@render_args[:args], &@render_args[:block])%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,12 +163,10 @@ 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/component_examples_controller.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
-- lib/railties/lib/rails/templates/rails/examples/show.html.erb
 - script/bootstrap
 - script/console
 - script/install

data/lib/railties/lib/rails/component_examples_controller.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/application_controller"
-load "config/application.rb" unless Rails.root
-
-class Rails::ComponentExamplesController < ActionController::Base # :nodoc:
-  prepend_view_path File.expand_path("templates/rails", __dir__)
-  append_view_path Rails.root.join("app/views")
-end

data/lib/railties/lib/rails/templates/rails/examples/show.html.erb

@@ -1 +0,0 @@
-<%= raw @example %>