actionview-component 1.5.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a684cf9aea1c6f1a94dd0c980fd7d1889e2b17fb165006817063de69b6f721
-  data.tar.gz: 30766fd4333fb8d708369e48192b000ba4a5136898bd82e98273d5fc9445fb67
+  metadata.gz: ab99ff30cf5a1d5fad5d3f670936b813d8923b9e4e5a3db566c0c08fa8cb7550
+  data.tar.gz: 7432ee39d40af863647a1cdf220b7775592bfef12c84bbc8a6175d741b88c2ff
 SHA512:
-  metadata.gz: aeaf7ae830c1b2e099a974228c0c072c41481c9ddd0f000c488727066df837f872b9616f064962bc3e8adee2fd20d86e0894d97cbc1a6c049faa5b6eea4636b1
-  data.tar.gz: ef32ebd537e7d36ae192b29b7aa756a8bf2efca96ef19d87e751e0dea11369616e0fc6e8a5848c2ea45230eb7eb46fac18e6e6eb6778ee58749193f22d3f2a44
+  metadata.gz: 53a8dc19f3caa79baf1c2fc754ee0b715885b83eaae13a7a3b6f2f25fb574dd6a0b109cd61328444abaf93ef55ded12413d59a5343fc707c544baba766c14ae7
+  data.tar.gz: a73449076c9d073052c97ad8cc0d58a88d40f8973a576221a41d7b9e7ed15aeecd0d3704694e4f78bf918fbe6f4d875df0f389f71381b81ad0fed7f8fb4720d3

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,25 @@
+<!-- **** Filing a Feature Request? Include these sections. **** -->
+
+### Feature request
+<!-- Provide a summary of the behavior. -->
+
+### Motivation
+
+<!-- What would you like to do with this feature? Can you provide
+context or references to similar behavior in other libraries? -->
+
+<!-- **** Filing a Bug Report? Include these sections: **** -->
+
+### Steps to reproduce
+<!-- 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 -->
+
+### Actual behavior
+<!-- Tell us what happens instead -->
+
+### System configuration
+**Rails version**:
+
+**Ruby version**:

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,17 @@
+<!-- See https://github.com/github/actionview-component/blob/master/CONTRIBUTING.md#submitting-a-pull-request  -->
+
+### Summary
+
+<!-- Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together. -->
+
+### Other Information
+
+<!-- If there's anything else that's important and relevant to your pull
+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. -->

data/.gitignore

@@ -10,6 +10,8 @@
 /test/version_tmp/
 /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,109 @@
+# 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.
+
+    *Jon Palmer*
+
+* Add support for multiple content areas.
+
+    *Jon Palmer*
+
+# v1.6.2
+
+* Fix Uninitialized Constant error.
+
+    *Jon Palmer*
+
+* Add basic github issue and PR templates.
+
+    *Dylan Clark*
+
+* Update readme phrasing around previews.
+
+    *Justin Coyne*
+
+# v1.6.1
+
+* Allow Previews to have no layout.
+
+    *Jon Palmer*
+
+* Bump rack from 2.0.7 to 2.0.8.
+
+    *Dependabot*
+
+* Compile components on application boot when eager loading is enabled.
+
+    *Joel Hawksley*
+
+* Previews support content blocks.
+
+    *Cesario Uy*
+
+* Follow Rails conventions. (refactor)
+
+    *Rainer Borene*
+
+* Fix edge case issue with extracting variants from less conventional source_locations.
+
+    *Ryan Workman*
+
+# v1.6.0
+
+* Avoid dropping elements in the render_inline test helper.
+
+    *@dark-panda*
+
+* Add test for helpers.asset_url.
+
+    *Christopher Coleman*
+
+* Add rudimentary compatibility with better_html.
+
+    *Joel Hawksley*
+
+* Template-less variants fall back to default template.
+
+    *Asger Behncke Jacobsen*, *Cesario Uy*
+
+* Generated tests use new naming convention.
+
+    *Simon Træls Ravn*
+
+* Eliminate sqlite dependency.
+
+    *Simon Dawson*
+
+* Add support for rendering components via #to_component_class
+
+    *Vinicius Stock*
+
 # v1.5.3
 
 * Add support for RSpec to generators.

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.5.3)
+    actionview-component (1.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -62,6 +62,14 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.1, >= 2.1.8)
     ast (2.4.0)
+    better_html (1.0.14)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
     builder (3.2.3)
     concurrent-ruby (1.1.5)
     crass (1.0.5)
@@ -71,6 +79,7 @@ GEM
     haml (5.1.2)
       temple (>= 0.8.0)
       tilt
+    html_tokenizer (0.0.7)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
@@ -92,7 +101,7 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    rack (2.0.7)
+    rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.0)
@@ -139,6 +148,7 @@ GEM
     slim (4.0.1)
       temple (>= 0.7.6, < 0.9)
       tilt (>= 2.0.6, < 2.1)
+    smart_properties (1.15.0)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -163,6 +173,7 @@ PLATFORMS
 
 DEPENDENCIES
   actionview-component!
+  better_html (~> 1)
   bundler (>= 1.14)
   haml (~> 5)
   minitest (= 5.1.0)

data/README.md

@@ -7,7 +7,7 @@
 
 This gem is meant to serve as a precursor to upstreaming the `ActionView::Component` class into Rails. It also serves to enable the usage of `ActionView::Component` in older versions of Rails.
 
-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.
+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, this gem will then exist to serve as a backport.
 
 ## Design philosophy
 
@@ -32,7 +32,7 @@ $ bundle
 In `config/application.rb`, add:
 
 ```bash
-require "action_view/component"
+require "action_view/component/railtie"
 ```
 
 ## Guide
@@ -163,6 +163,24 @@ Components can be rendered via:
 
 `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))`
@@ -181,17 +199,233 @@ An error will be raised:
 
 `ActiveModel::ValidationError: Validation failed: Title can't be blank`
 
+#### Content Areas
+
+A component can declare additional content areas to be rendered in the component. For example:
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :user, :header, :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(user:)
+    @user = user
+  end
+end
+```
+
+`app/components/modal_component.html.erb`:
+```erb
+<div class="modal">
+  <div class="header"><%= header %></div>
+  <div class="body"><%= body %>"></div>
+</div>
+```
+
+We can render it in a view as:
+
+```erb
+<%= render(ModalComponent, user: {name: 'Jane'}) do |component| %>
+  <% component.with(:header) do %>
+      Hello <%= user[:name] %>
+    <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+Which returns:
+
+```html
+<div class="modal">
+  <div class="header">Hello Jane</div>
+  <div class="body"><p>Have a great day.</p></div>
+</div>
+```
+
+Content for content areas can be passed as arguments to the render method or as named blocks passed to the `with` method.
+This allows a few different combinations of ways to render the component:
+
+##### Required render argument optionally overridden or wrapped by a named block
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :header, :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(header:)
+    @header = header
+  end
+end
+```
+
+```erb
+<%= render(ModalComponent, header: "Hi!") do |component| %>
+  <% help_enabled? && component.with(:header) do %>
+    <span class="help_icon"><%= component.header %></span>
+  <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+##### Required argument passed by render argument or by named block
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :header, :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(header: nil)
+    @header = header
+  end
+end
+```
+
+`app/views/render_arg.html.erb`:
+```erb
+<%= render(ModalComponent, header: "Hi!") do |component| %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+`app/views/with_block.html.erb`:
+```erb
+<%= render(ModalComponent) do |component| %>
+  <% component.with(:header) do %>
+    <span class="help_icon">Hello</span>
+  <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+##### Optional argument passed by render argument, by named block, or neither
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(header: nil)
+    @header = header
+  end
+end
+```
+
+`app/components/modal_component.html.erb`:
+```erb
+<div class="modal">
+  <% if header %>
+    <div class="header"><%= header %></div>
+  <% end %>
+  <div class="body"><%= body %>"></div>
+</div>
+```
+
+`app/views/render_arg.html.erb`:
+```erb
+<%= render(ModalComponent, header: "Hi!") do |component| %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+`app/views/with_block.html.erb`:
+```erb
+<%= render(ModalComponent) do |component| %>
+  <% component.with(:header) do %>
+    <span class="help_icon">Hello</span>
+  <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+`app/views/no_header.html.erb`:
+```erb
+<%= render(ModalComponent) do |component| %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% 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:
 
 ```ruby
-require "action_view/component/test_helpers"
+require "action_view/component/test_case"
 
-class MyComponentTest < Minitest::Test
-  include ActionView::Component::TestHelpers
-
-  def test_render_component
+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
@@ -207,7 +441,7 @@ In general, we’ve found it makes the most sense to test components based on th
 To test a specific variant you can wrap your test with the `with_variant` helper method as:
 
 ```ruby
-def test_render_component_for_tablet
+test "render component for tablet" do
   with_variant :tablet do
     assert_equal(
       %(<span title="my title">Hello, tablets!</span>),
@@ -218,7 +452,7 @@ end
 ```
 
 ### Previewing Components
-`ActionView::Component::Preview`s provide a way to see how components look by visiting a special URL that renders them.
+`ActionView::Component::Preview` provides a way to see how components look by visiting a special URL that renders them.
 In the previous example, the preview class for `TestComponent` would be called `TestComponentPreview` and located in `test/components/previews/test_component_preview.rb`.
 To see the preview of the component with a given title, implement a method that renders the component.
 You can define as many examples as you want:
@@ -260,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
@@ -315,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).