actionview-component 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c20b9ae371123eb58c62aa3c093baafdf7d5745bf8311ff2fb975c70282e6dfd
-  data.tar.gz: caaad9f6e645602efe2faea055ff08dd1f548efe08b503a3048d83eebc824997
+  metadata.gz: 2d2c0dab4ae3674f45f3f830257f49b108f51923e98a3de1182667f71a951cb2
+  data.tar.gz: 220a51f5dee367a6bf22e3a5306d17a2e302c5326cf4ad4a5f271c2ff0edb864
 SHA512:
-  metadata.gz: 52aec02cba11b482df4c4e4f160ad7602dadca664eb75a4fad579fb5802c9f4efb6a7e07f1082ab634e99c9ed8efad82861daf1fdc9c5108cdf63e3f2b0f80d1
-  data.tar.gz: 4d5fb555f12740dfa62a64b4c9b095879e4ea182a3930f9a725482525c6d5bbeae08d9914dff847e8521a7107f31b13b919f5b9d5cc69d83cbaf53c08422503c
+  metadata.gz: f9c79d7c62166ef2fb8f1cba5220d1599c8d6129252e09aec47917de3a7db1c3d9d6ef70da8231dc3389eac9e0136b2b533a972867a12ad975f8f5db9f49d5cc
+  data.tar.gz: efc71bebe0aeba60aeefdc00ae50d7485e2a28334c7b4764d359e84402e740f8aa0b66a36035be5223a2114c1e432c50c071d0924c2a3f90d8658f5e76a330d5

data/CHANGELOG.md

@@ -1,7 +1,19 @@
+# v1.11.0
+
+* Add support for Capybara matchers.
+
+    *Joel Hawksley*
+
+* Add erb, haml, & slim template generators
+
+    *Asger Behncke Jacobsen*
+
 # v1.10.0
 
 * Deprecate all `render` syntaxes except for `render(MyComponent.new(foo: :bar))`
 
+    *Joel Hawksley*
+
 # v1.9.0
 
 * Remove initializer requirement for Ruby 2.7+

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.10.0)
+    actionview-component (1.11.0)
+      capybara (>= 3.26)
 
 GEM
   remote: https://rubygems.org/
@@ -61,6 +62,8 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     better_html (1.0.14)
       actionview (>= 4.0)
@@ -71,6 +74,14 @@ GEM
       parser (>= 2.4)
       smart_properties
     builder (3.2.3)
+    capybara (3.31.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
     concurrent-ruby (1.1.5)
     crass (1.0.5)
     erubi (1.8.0)
@@ -101,6 +112,7 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
+    public_suffix (4.0.3)
     rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -132,6 +144,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    regexp_parser (1.6.0)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -166,6 +179,8 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
     zeitwerk (2.1.10)
 
 PLATFORMS

data/README.md

@@ -1,3 +1,5 @@
+_Note: This gem is in the process of a name / API change, see https://github.com/github/actionview-component/issues/206_
+
 # ActionView::Component
 `ActionView::Component` is a framework for building view components in Rails.
 
@@ -15,7 +17,7 @@ As the goal of this gem is to be upstreamed into Rails, it is designed to integr
 
 ## Compatibility
 
-`actionview-component` is tested for compatibility with combinations of Ruby `2.5`/`2.6` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
+`actionview-component` is tested for compatibility with combinations of Ruby `2.5`/`2.6`/`2.7` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -117,6 +119,18 @@ bin/rails generate component Example title content
       create  app/components/example_component.html.erb
 ```
 
+`ActionView::Component` includes template generators for the `erb`, `haml`, and `slim` template engines and will use the template engine specified in your Rails config (`config.generators.template_engine`) by default.
+
+If you want to override this behavior, you can pass the template engine as an option to the generator:
+
+```bash
+bin/rails generate component Example title content --template-engine slim
+      invoke test_unit
+      create  test/components/example_component_test.rb
+      create  app/components/example_component.rb
+      create  app/components/example_component.html.slim
+```
+
 #### Implementation
 
 An `ActionView::Component` is a Ruby file and corresponding template file (in any format supported by Rails) with the same base name:
@@ -389,17 +403,16 @@ end
 
 ### 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:
+Components are unit tested directly. The `render_inline` test helper is compatible with Capybara matchers, allowing us to test the component above as:
 
 ```ruby
 require "action_view/component/test_case"
 
 class MyComponentTest < ActionView::Component::TestCase
   test "render component" do
-    assert_equal(
-      %(<span title="my title">Hello, World!</span>),
-      render_inline(TestComponent.new(title: "my title")) { "Hello, World!" }.to_html
-    )
+    render_inline(TestComponent.new(title: "my title")) { "Hello, World!" }
+
+    assert_selector("span[title='my title']", "Hello, World!")
   end
 end
 ```
@@ -413,10 +426,9 @@ To test a specific variant you can wrap your test with the `with_variant` helper
 ```ruby
 test "render component for tablet" do
   with_variant :tablet do
-    assert_equal(
-      %(<span title="my title">Hello, tablets!</span>),
-      render_inline(TestComponent.new(title: "my title")) { "Hello, tablets!" }.css("span").to_html
-    )
+    render_inline(TestComponent.new(title: "my title")) { "Hello, tablets!" }
+
+    assert_selector("span[title='my title']", "Hello, tablets!")
   end
 end
 ```

data/actionview-component.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
+  spec.add_runtime_dependency     "capybara", ">= 3.26"
   spec.add_development_dependency "bundler", ">= 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "= 5.1.0"

data/lib/action_view/component/test_helpers.rb

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
+require "capybara/minitest"
+
 module ActionView
   module Component
     module TestHelpers
+      include Capybara::Minitest::Assertions
+
+      def page
+        Capybara::Node::Simple.new(@raw)
+      end
+
       def render_inline(component, **args, &block)
-        Nokogiri::HTML.fragment(controller.view_context.render(component, args, &block))
+        @raw = controller.view_context.render(component, args, &block)
+
+        Nokogiri::HTML.fragment(@raw)
       end
 
       def controller

data/lib/action_view/component/version.rb

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

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

@@ -6,15 +6,18 @@ module Rails
       source_root File.expand_path("templates", __dir__)
 
       argument :attributes, type: :array, default: [], banner: "attribute"
-      hook_for :test_framework
       check_class_collision suffix: "Component"
 
+      class_option :require_content, type: :boolean, default: false
+
       def create_component_file
         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", class_path, "#{file_name}_component.html.erb")
+      hook_for :test_framework
+
+      hook_for :template_engine do |instance, template_engine|
+        instance.invoke template_engine, [instance.name], require_content: instance.send(:requires_content?)
       end
 
       private
@@ -24,6 +27,7 @@ module Rails
       end
 
       def requires_content?
+        return if behavior == :revoke
         return @requires_content if @asked
 
         @asked = true

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb"
+
+module Erb
+  module Generators
+    class ComponentGenerator < Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :require_content, type: :boolean, default: false
+
+      def copy_view_file
+        template "component.html.erb", File.join("app/components", class_path, "#{file_name}_component.html.erb")
+      end
+
+      private
+
+      def requires_content?
+        options["require_content"]
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Haml
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :require_content, type: :boolean, default: false
+
+      def copy_view_file
+        template "component.html.haml", File.join("app/components", class_path, "#{file_name}_component.html.haml")
+      end
+
+      private
+
+      def requires_content?
+        options["require_content"]
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/rails/generators/haml/templates/component.html.haml.tt

@@ -0,0 +1,5 @@
+<%- if requires_content? -%>
+<%= "= content" %>
+<%- else -%>
+%div Add <%= class_name %> template here
+<%- end -%>

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Slim
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :require_content, type: :boolean, default: false
+
+      def copy_view_file
+        template "component.html.slim", File.join("app/components", class_path, "#{file_name}_component.html.slim")
+      end
+
+      private
+
+      def requires_content?
+        options["require_content"]
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/rails/generators/slim/templates/component.html.slim

@@ -0,0 +1,5 @@
+<%- if requires_content? -%>
+= content
+<%- else -%>
+div Add <%= class_name %> template here
+<%- end -%>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.26'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,10 +170,15 @@ files:
 - lib/action_view/component/version.rb
 - lib/rails/generators/component/USAGE
 - lib/rails/generators/component/component_generator.rb
-- lib/rails/generators/component/templates/component.html.erb.tt
 - lib/rails/generators/component/templates/component.rb.tt
+- lib/rails/generators/erb/component_generator.rb
+- lib/rails/generators/erb/templates/component.html.erb.tt
+- lib/rails/generators/haml/component_generator.rb
+- lib/rails/generators/haml/templates/component.html.haml.tt
 - lib/rails/generators/rspec/component_generator.rb
 - lib/rails/generators/rspec/templates/component_spec.rb.tt
+- lib/rails/generators/slim/component_generator.rb
+- lib/rails/generators/slim/templates/component.html.slim
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/railties/lib/rails.rb