actionview-component 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e2a46384747c4c68bc6fe698a1b98c54a9bcbf6
-  data.tar.gz: c0aafbee37e5a442b0fd9e2b2fc0fecb11dcfb8a
+SHA256:
+  metadata.gz: 59fec154eafa7bbeab9aa226860751bf57f00d454335865f5c746b562969be03
+  data.tar.gz: 92a23a067a1c5d03a85935a137f8d1916132a6b6dcc01b86642e12c242a43bf7
 SHA512:
-  metadata.gz: 2c0d364a6e93420fb2a25fdf7f0effcc772db775111ae2b1635fd53bb6f082802c1e331b2135de879c65ec4e463f65fb1b24372858a25a4ce7e7a83d152200a2
-  data.tar.gz: 88f836465727a04b2980d786547b3d95e0e2c656fcb8c7dc408f7a185ec02da51f99aa24a27dd8b2ca2b147d9de71bf9d739bc156ee4ada81c4a329d751e5221
+  metadata.gz: 7c2fde6da24f0685ee606278f714bfadeceacdfe4f95e0696840b8c35da32d7e5ebb1fd8b1bdf510fa6b0cbe6eabbd16adef418eb095faf90d6a1b6923cae97a
+  data.tar.gz: 8afae7c9c555d7c358d039c98160e9b5cc3c882c776936d4a3d8ae5ca15a7bfa66975a86871cb0a1dd1ed538eee321ed3f26a2b9e978b8d391d3a45c18210c8d

data/.github/workflows/ruby_on_rails.yml

@@ -0,0 +1,26 @@
+name: Ruby on Rails
+
+on: [push]
+
+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"]
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        version: ${{ matrix.ruby_version }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle update
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+        bundle exec rubocop
+      env:
+        RAILS_VERSION: ${{ matrix.rails_version }}

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/test/log/*
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+    - config/rails.yml

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+## Contributing
+
+[fork]: https://github.com/github/actionview-component/fork
+[pr]: https://github.com/github/actionview-component/compare
+[style]: https://github.com/styleguide/ruby
+[code-of-conduct]: CODE_OF_CONDUCT.md
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt).
+
+Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
+
+## Submitting a pull request
+
+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. Create a new branch: `git checkout -b my-branch-name`
+0. Make your change, add tests, and make sure the tests still pass
+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.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Releasing
+
+If you are the current maintainer of this gem:
+
+1. Create a branch for the release: `git checkout -b release-vxx.xx.xx`
+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. Bump gem version in `action_view/component`.
+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.pkg.github.com -- `gem push --key github --host https://rubygems.pkg.github.com/github actionview-component-VERSION.gem`. See [Configuring RubyGems for use with GitHub Package Registry][gpr] for more details.
+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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+rails_version = "#{ENV['RAILS_VERSION'] || '5.2.3'}"
+
+gem "rails", rails_version == "master" ? { github: "rails/rails" } : rails_version

data/Gemfile.lock

@@ -0,0 +1,160 @@
+PATH
+  remote: .
+  specs:
+    actionview-component (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      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)
+      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)
+      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)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    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)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      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)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-github (0.13.0)
+      rubocop (~> 0.70)
+      rubocop-performance (~> 1.3.0)
+    rubocop-performance (1.3.0)
+      rubocop (>= 0.68.0)
+    ruby-progressbar (1.10.1)
+    slim (4.0.1)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    temple (0.8.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.9)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview-component!
+  bundler (>= 1.14)
+  haml (~> 5)
+  minitest (~> 5.0)
+  rails (= 5.2.3)
+  rake (~> 10.0)
+  rubocop (~> 0.59)
+  rubocop-github (~> 0.13.0)
+  slim (~> 4.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 GitHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,14 +1,23 @@
 # ActionView::Component
-Short description and motivation.
+`ActionView::Component` is a framework for building view components in Rails.
 
-## Usage
-How to use my plugin.
+**Current Status**: Used in production at GitHub. Because of this, all changes will be thoroughly vetted, which could slow down the process of contributing. We will do our best to actively communicate status of pull requests with any contributors. If you have any substantial changes that you would like to make, it would be great to first [open an issue](http://github.com/github/actionview-component/issues/new) to discuss them with us.
+
+## Roadmap
+
+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.
+
+## 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`.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'actionview-component'
+gem "actionview-component"
 ```
 
 And then execute:
@@ -16,13 +25,180 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+In `config/application.rb`, add:
+
 ```bash
-$ gem install actionview-component
+require "action_view/component"
+```
+
+## Guide
+
+### What are components?
+
+`ActionView::Component`s are Ruby classes that are used to render views. They take data as input and return output-safe HTML. Think of them as an evolution of the presenter/decorator/view model pattern, inspired by [React Components](https://reactjs.org/docs/react-component.html).
+
+### Why components?
+
+In working on views in the Rails monolith at GitHub (which has over 3700 templates), we have run into several key pain points:
+
+#### Testing
+
+Currently, Rails encourages testing views via integration or system tests. This discourages us from testing our views thoroughly, due to the costly overhead of exercising the routing/controller layer, instead of just the view. It also often leads to partials being tested for each view they are included in, cheapening the benefit of DRYing up our views.
+
+#### Code Coverage
+
+Many common Ruby code coverage tools cannot properly handle coverage of views, making it difficult to audit how thorough our tests are and leading to gaps in our test suite.
+
+#### Data Flow
+
+Unlike a method declaration on an object, views do not declare the values they are expected to receive, making it hard to figure out what context is necessary to render them. This often leads to subtle bugs when we reuse a view across different contexts.
+
+#### Standards
+
+Our views often fail even the most basic standards of code quality we expect out of our Ruby classes: long methods, deep conditional nesting, and mystery guests abound.
+
+### What are the benefits?
+
+#### Testing
+
+`ActionView::Component` allows views to be unit-tested. In the main GitHub codebase, our unit tests run in around 25ms/test, vs. ~6s/test for integration tests.
+
+#### Code Coverage
+
+`ActionView::Component` is at least partially compatible with code coverage tools. We’ve seen some success with SimpleCov.
+
+#### Data flow
+
+By clearly defining the context necessary to render a component, we’ve found them to be easier to reuse than partials.
+
+#### Performance
+
+In early benchmarks, we’ve seen performance improvements over the existing rendering pipeline. For a test page with nested renders 10 levels deep, we’re seeing around a 5x increase in speed over partials:
+
+```
+Comparison:
+           component:     6515.4 i/s
+             partial:     1251.2 i/s - 5.21x  slower
+```
+
+_Rails 6.1.0.alpha, [joelhawksley/actionview-component-demo](https://github.com/joelhawksley/actionview-component-demo), /benchmark route, via `RAILS_ENV=production rails s`, measured with [evanphx/benchmark-ips](https://github.com/evanphx/benchmark-ips)_
+
+### When should I use components?
+
+Components are most effective in cases where view code is reused or needs to be tested directly.
+
+### Building components
+
+Components are subclasses of `ActionView::Component` and live in `app/components`. You may wish to create an `ApplicationComponent` that is a subclass of `ActionView::Component` and inherit from that instead.
+
+Components support ActiveModel validations. Components are validated after initialization, but before rendering.
+
+Content passed to an `ActionView::Component` as a block is captured and assigned to the `content` accessor.
+
+#### Implementation
+
+An `ActionView::Component` is a Ruby file and corresponding template file (in any format supported by Rails) with the same base name:
+
+`app/components/test_component.rb`:
+```ruby
+class TestComponent < ActionView::Component
+  validates :content, :title, presence: true
+
+  def initialize(title:)
+    @title = title
+  end
+
+  private
+
+  attr_reader :title
+end
+```
+
+`app/components/test_component.html.erb`:
+```erb
+<span title="<%= title %>"><%= content %></span>
+```
+
+We can render it in a view as:
+
+```erb
+<%= render(TestComponent.new(title: "my title")) do %>
+  Hello, World!
+<% end %>
+```
+
+Which returns:
+
+```html
+<span title="my title">Hello, World!</span>
+```
+
+#### Error case
+
+If the component is rendered with a blank title:
+
+```erb
+<%= render(TestComponent.new(title: "")) do %>
+  Hello, World!
+<% end %>
+```
+
+An error will be raised:
+
+`ActiveModel::ValidationError: Validation failed: Title can't be blank`
+
+### 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:
+
+```ruby
+require "action_view/component_test_helpers"
+
+class MyComponentTest < Minitest::Test
+  include ActionView::ComponentTestHelpers
+
+  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
+    )
+  end
+end
 ```
 
+In general, we’ve found it makes the most sense to test components based on their rendered HTML.
+
+## Frequently Asked Questions
+
+### Can I use other templating languages besides ERB?
+
+Yes. This gem is tested against ERB, Haml, and Slim, but it should support most Rails template handlers.
+
+### What happened to inline templates?
+
+Inline templates have been removed (for now) due to concerns raised by [@soutaro](https://github.com/soutaro) regarding compatibility with the type systems being developed for Ruby 3.
+
+### Isn't this just like X library?
+
+`ActionView::Component` is far from a novel idea! Popular implementations of view components in Ruby include, but are not limited to:
+
+- [trailblazer/cells](https://github.com/trailblazer/cells)
+- [dry-rb/dry-view](https://github.com/dry-rb/dry-view)
+- [komposable/komponent](https://github.com/komposable/komponent)
+- [activeadmin/arbre](https://github.com/activeadmin/arbre)
+
+## Resources
+
+- [Rethinking the View Layer with Components, RailsConf 2019](https://www.youtube.com/watch?v=y5Z5a6QdA-M)
+- [Introducing ActionView::Component with Joel Hawksley, Ruby on Rails Podcast](http://5by5.tv/rubyonrails/276)
+- [Rails to Introduce View Components, Dev.to](https://dev.to/andy/rails-to-introduce-view-components-3ome)
+- [ActionView::Components in Rails 6.1, Drifting Ruby](https://www.driftingruby.com/episodes/actionview-components-in-rails-6-1)
+- [Demo repository, actionview-component-demo](https://github.com/joelhawksley/actionview-component-demo)
+
 ## Contributing
-Contribution directions go here.
+
+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.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,34 +1,12 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ActionView::Component'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
+# frozen_string_literal: true
 
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-
 task default: :test

data/actionview-component.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "actionview-component"
+  spec.version       = "1.0.0"
+  spec.authors       = ["GitHub Open Source"]
+  spec.email         = ["opensource+actionview-component@github.com"]
+
+  spec.summary       = %q{View components for Rails}
+  spec.description   = %q{View components for Rails, intended for upstreaming in Rails 6.1}
+  spec.homepage      = "https://github.com/github/actionview-component"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.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 "haml", "~> 5"
+  spec.add_development_dependency "slim", "~> 4.0"
+  spec.add_development_dependency "rubocop", "~> 0.59"
+  spec.add_development_dependency "rubocop-github", "~> 0.13.0"
+end

data/lib/action_view/component.rb

@@ -1,23 +1,132 @@
-module ActionView
-  class Component < Base
+# frozen_string_literal: true
+
+# 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
+class ActionView::Base
+  module RenderMonkeyPatch
+    def render(component, _ = nil, &block)
+      return super unless component.respond_to?(:render_in)
+
+      component.render_in(self, &block)
+    end
   end
 
-  class TemplateRenderer
-    module ComponentTemplates
-      def render(context, options)
-        if options.key?(:component)
-          name    = options[:component]
-          klass   = "#{name}_component".classify.constantize
-          args    = options.except(:component)
-          context = args.empty? ? klass.new : klass.new(args)
+  prepend RenderMonkeyPatch unless Rails::VERSION::MINOR > 0 && Rails::VERSION::MAJOR == 6
+end
+
+module ActionView
+  class Component < ActionView::Base
+    VERSION = "1.0.0"
+
+    include ActiveModel::Validations
+
+    # Entrypoint for rendering components. Called by ActionView::Base#render.
+    #
+    # view_context: ActionView context from calling view
+    # args(hash): params to be passed to component being rendered
+    # block: optional block to be captured within the view context
+    #
+    # returns HTML that has been escaped by the respective template handler
+    #
+    # Example subclass:
+    #
+    # app/components/my_component.rb:
+    # class MyComponent < ActionView::Component
+    #   def initialize(title:)
+    #     @title = title
+    #   end
+    # end
+    #
+    # app/components/my_component.html.erb
+    # <span title="<%= @title %>">Hello, <%= content %>!</span>
+    #
+    # In use:
+    # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
+    # returns:
+    # <span title="greeting">Hello, world!</span>
+    #
+    def render_in(view_context, *args, &block)
+      self.class.compile
+      @content = view_context.capture(&block) if block_given?
+      validate!
+      call
+    end
+
+    def initialize(*); end
+
+    class << self
+      def inherited(child)
+        child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
+
+        super
+      end
+
+      # Compile template to #call instance method, assuming it hasn't been compiled already.
+      # We could in theory do this on app boot, at least in production environments.
+      # Right now this just compiles the template the first time the component is rendered.
+      def compile
+        return if @compiled
+
+        class_eval("def call; @output_buffer = ActionView::OutputBuffer.new; #{compiled_template}; end")
+
+        @compiled = true
+      end
+
+      private
 
-          super context, template: "components/#{name}"
+      def compiled_template
+        handler = ActionView::Template.handler_for_extension(File.extname(template_file_path).gsub(".", ""))
+        template = File.read(template_file_path)
+
+        if handler.method(:call).parameters.length > 1
+          handler.call(DummyTemplate.new, template)
         else
-          super
+          handler.call(DummyTemplate.new(template))
         end
       end
+
+      def template_file_path
+        raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
+
+        filename = self.instance_method(:initialize).source_location[0]
+        filename_without_extension = filename[0..-(File.extname(filename).length + 1)]
+        sibling_files = Dir["#{filename_without_extension}.*"] - [filename]
+
+        if sibling_files.length > 1
+          raise StandardError.new("More than one template found for #{self}. There can only be one sidecar template file per component.")
+        end
+
+        if sibling_files.length == 0
+          raise NotImplementedError.new(
+            "Could not find a template for #{self}. Either define a .template method or add a sidecar template file."
+          )
+        end
+
+        sibling_files[0]
+      end
     end
 
-    prepend ComponentTemplates
+    class DummyTemplate
+      attr_reader :source
+
+      def initialize(source = nil)
+        @source = source
+      end
+
+      def identifier
+        ""
+      end
+
+      # we'll eventually want to update this to support other types
+      def type
+        "text/html"
+      end
+    end
+
+    private
+
+    attr_reader :content
   end
 end

data/lib/action_view/component_test_helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActionView
+  module ComponentTestHelpers
+    def render_component(component, &block)
+      Nokogiri::HTML(component.render_in(ApplicationController.new.view_context, &block))
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "action_view/component"
+
+require "irb"
+IRB.start(__FILE__)

data/script/install

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rake install

data/script/release

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rake release

data/script/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rake

metadata

@@ -1,87 +1,143 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Godfrey Chan
+- GitHub Open Source
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionview
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
-  type: :runtime
+        version: '10.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 0.13.0
+description: View components for Rails, intended for upstreaming in Rails 6.1
 email:
-- godfreykfc@gmail.com
+- opensource+actionview-component@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".github/workflows/ruby_on_rails.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- actionview-component.gemspec
 - lib/action_view/component.rb
-- lib/actionview/component.rb
-homepage: http://github.com/chancancode/actionview-component
+- lib/action_view/component_test_helpers.rb
+- script/bootstrap
+- script/console
+- script/install
+- script/release
+- script/test
+homepage: https://github.com/github/actionview-component
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,17 +146,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: ActionView::Component
+summary: View components for Rails
 test_files: []
-has_rdoc: 

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2017 Godfrey Chan
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/actionview/component.rb

@@ -1,5 +0,0 @@
-module ActionView
-  eager_autoload do
-    autoload :Component
-  end
-end