actionview-component 1.3.6 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e23869593e0482d71b3ea0b082ad050fe3c9a5e1ad4b5e05e5cac866c7f31d
-  data.tar.gz: 9ce7d1453f35246746f90153959c9848baa221042eec5a6376aae59c1433d3f7
+  metadata.gz: 30f9a7b6c2e7f0549743bf979ce3db726539f9c1f9391cb4f2f34e6d955b8689
+  data.tar.gz: 6db7efd3c77edbdacfa376d78729c8092848fc48176378a0677b50e6cd110433
 SHA512:
-  metadata.gz: 11bacc8bde616fb29d27bf8fc7b56d5cea3d42c645fd425e56ea638427755ebb89c6b6575702b37f18cf33e56026a7fdbe11582be0bdd610deaea236043ba736
-  data.tar.gz: 59a4a1e938c98e5c942581181e11f4af00d1ac36e49dace1ad42dfc1b10ca8da6cb589d68b07a7adcd3f6a80facab0621cd5be03e1e2eaf082dd18bf0daaf305
+  metadata.gz: bd86da9ed9d6be7b8397711cde1da635d657630b1864da03e297e87596395476d84bbafb4c84447b4518207ead5cbe2f905b6b7fc95f10b96cfe0b2bd5e9fcc5
+  data.tar.gz: d42213b009dfbd75489be053daab29fa0c74614f8657d308a08254c72ba31327933d0683d5c4ad6df43d1cdf63b86236ef3cda9e6b23b9b883ba987c1692b719

data/.github/workflows/ruby_on_rails.yml

@@ -8,22 +8,18 @@ jobs:
     strategy:
       matrix:
         rails_version: [5.0.0, 5.2.3, 6.0.0, master]
-        ruby_version: [2.3.x, 2.4.x, 2.5.x, 2.6.x]
+        ruby_version: [2.4.x, 2.5.x, 2.6.x]
         exclude:
           - rails_version: master
             ruby_version: 2.4.x
-          - rails_version: master
-            ruby_version: 2.3.x
           - rails_version: 6.0.0
             ruby_version: 2.4.x
-          - rails_version: 6.0.0
-            ruby_version: 2.3.x
     steps:
     - uses: actions/checkout@master
     - name: Setup Ruby
       uses: actions/setup-ruby@v1
       with:
-        version: ${{ matrix.ruby_version }}
+        ruby-version: ${{ matrix.ruby_version }}
     - name: Build and test with Rake
       run: |
         gem install bundler:1.14.0

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# v1.4.0
+
+* Fix bug where components broke in application paths with periods.
+
+    *Anton, Joel Hawksley*
+
+* Add support for `cache_if` in component templates.
+
+    *Aaron Patterson, Joel Hawksley*
+
+* Add support for variants.
+
+    *Juan Manuel Ramallo*
+
+* Fix bug in virtual path lookup.
+
+    *Juan Manuel Ramallo*
+
+* Preselect the rendered component in render_inline.
+
+    *Elia Schito*
+
 # v1.3.6
 
 * Allow template file names without format.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.3.6)
+    actionview-component (1.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -168,7 +168,7 @@ DEPENDENCIES
   minitest (= 5.1.0)
   rails (= 6.0.0)
   rake (~> 10.0)
-  rubocop (~> 0.59)
+  rubocop (= 0.74)
   rubocop-github (~> 0.13.0)
   slim (~> 4.0)
 

data/README.md

@@ -15,7 +15,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.3`/`2.4`/`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.4`/`2.5`/`2.6` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -178,7 +178,7 @@ class MyComponentTest < Minitest::Test
   def test_render_component
     assert_equal(
       %(<span title="my title">Hello, World!</span>),
-      render_inline(TestComponent, title: "my title") { "Hello, World!" }.css("span").to_html
+      render_inline(TestComponent, title: "my title") { "Hello, World!" }.to_html
     )
   end
 end
@@ -186,6 +186,21 @@ end
 
 In general, we’ve found it makes the most sense to test components based on their rendered HTML.
 
+#### Action Pack Variants
+
+To test a specific variant you can wrap your test with the `with_variant` helper method as:
+
+```ruby
+def test_render_component_for_tablet
+  with_variant :tablet do
+    assert_equal(
+      %(<span title="my title">Hello, tablets!</span>),
+      render_inline(TestComponent, title: "my title") { "Hello, tablets!" }.css("span").to_html
+    )
+  end
+end
+```
+
 ## Frequently Asked Questions
 
 ### Can I use other templating languages besides ERB?

data/actionview-component.gemspec

@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "= 5.1.0"
   spec.add_development_dependency "haml", "~> 5"
   spec.add_development_dependency "slim", "~> 4.0"
-  spec.add_development_dependency "rubocop", "~> 0.59"
+  spec.add_development_dependency "rubocop", "= 0.74"
   spec.add_development_dependency "rubocop-github", "~> 0.13.0"
 end

data/lib/action_view/component/base.rb

@@ -9,7 +9,7 @@ class ActionView::Base
     def render(options = {}, args = {}, &block)
       if options.respond_to?(:render_in)
         ActiveSupport::Deprecation.warn(
-          "passing component instances to `render` has been deprecated and will be removed in v2.0.0. Use `render MyComponent, foo: :bar` instead."
+          "passing component instances (`render MyComponent.new(foo: :bar)`) has been deprecated and will be removed in v2.0.0. Use `render MyComponent, foo: :bar` instead."
         )
 
         options.render_in(self, &block)
@@ -33,6 +33,8 @@ module ActionView
       include ActiveSupport::Configurable
       include ActionController::RequestForgeryProtection
 
+      validate :variant_exists
+
       # Entrypoint for rendering components. Called by ActionView::Base#render.
       #
       # view_context: ActionView context from calling view
@@ -65,10 +67,16 @@ module ActionView
         @lookup_context ||= view_context.lookup_context
         @view_flow ||= view_context.view_flow
         @virtual_path ||= virtual_path
+        @variant = @lookup_context.variants.first
+        old_current_template = @current_template
+        @current_template = self
 
         @content = view_context.capture(&block) if block_given?
         validate!
-        call
+
+        send(self.class.call_method_name(@variant))
+      ensure
+        @current_template = old_current_template
       end
 
       def initialize(*); end
@@ -88,9 +96,31 @@ module ActionView
       # Looks for the source file path of the initialize method of the instance's class.
       # Removes the first part of the path and the extension.
       def virtual_path
-        self.class.source_location.gsub(%r{(.*app/)|(.rb)}, "")
+        self.class.source_location.gsub(%r{(.*app/)|(\.rb)}, "")
+      end
+
+      def view_cache_dependencies
+        []
+      end
+
+      def format # :nodoc:
+        @variant
+      end
+
+      private
+
+      def variant_exists
+        return if self.class.variants.include?(@variant) || @variant.nil?
+
+        errors.add(:variant, "'#{@variant}' has no template defined")
       end
 
+      def request
+        @request ||= controller.request
+      end
+
+      attr_reader :content, :view_context
+
       class << self
         def inherited(child)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -98,64 +128,90 @@ module ActionView
           super
         end
 
+        def call_method_name(variant)
+          if variant.present?
+            "call_#{variant}"
+          else
+            "call"
+          end
+        end
+
         def source_location
+          # Require #initialize to be defined so that we can use
+          # method#source_location to look up the file name
+          # of the component.
+          #
+          # If we were able to only support Ruby 2.7+,
+          # We could just use Module#const_source_location,
+          # rendering this unnecessary.
+          raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
+
           instance_method(:initialize).source_location[0]
         end
 
-        # Compile template to #call instance method, assuming it hasn't been compiled already.
+        # Compile templates to instance methods, assuming they haven'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.
+        # Right now this just compiles the first time the component is rendered.
         def compile
           return if @compiled && ActionView::Base.cache_template_loading
-          ensure_initializer_defined
 
-          class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def call
-              @output_buffer = ActionView::OutputBuffer.new
-              #{compiled_template}
-            end
-          RUBY
+          validate_templates
+
+          templates.each do |template|
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{call_method_name(template[:variant])}
+                @output_buffer = ActionView::OutputBuffer.new
+                #{compiled_template(template[:path])}
+              end
+            RUBY
+          end
 
           @compiled = true
         end
 
+        def variants
+          templates.map { |template| template[:variant] }
+        end
+
         private
 
-        # Require #initialize to be defined so that we can use
-        # method#source_location to look up the file name
-        # of the component.
-        #
-        # If we were able to only support Ruby 2.7+,
-        # We could just use Module#const_source_location,
-        # rendering this unnecessary.
-        def ensure_initializer_defined
-          raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
+        def templates
+          @templates ||=
+            (Dir["#{source_location.sub(/#{File.extname(source_location)}$/, '')}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location]).each_with_object([]) do |path, memo|
+              memo << {
+                path: path,
+                variant: path.split(".").second.split("+")[1]&.to_sym,
+                handler: path.split(".").last
+              }
+            end
         end
 
-        def compiled_template
-          handler = ActionView::Template.handler_for_extension(File.extname(template_file_path).gsub(".", ""))
-          template = File.read(template_file_path)
+        def validate_templates
+          if templates.empty?
+            raise NotImplementedError.new("Could not find a template file for #{self}.")
+          end
 
-          if handler.method(:call).parameters.length > 1
-            handler.call(DummyTemplate.new, template)
-          else
-            handler.call(DummyTemplate.new(template))
+          if templates.select { |template| template[:variant].nil? }.length > 1
+            raise StandardError.new("More than one template found for #{self}. There can only be one default template file per component.")
           end
-        end
 
-        def template_file_path
-          sibling_template_files =
-            Dir["#{source_location.split(".")[0]}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location]
+          variants.each_with_object(Hash.new(0)) { |variant, counts| counts[variant] += 1 }.each do |variant, count|
+            next unless count > 1
 
-          if sibling_template_files.length > 1
-            raise StandardError.new("More than one template found for #{self}. There can only be one sidecar template file per component.")
+            raise StandardError.new("More than one template found for variant '#{variant}' in #{self}. There can only be one template file per variant.")
           end
+        end
 
-          if sibling_template_files.length == 0
-            raise NotImplementedError.new("Could not find a template file for #{self}.")
-          end
+        def compiled_template(file_path)
+          handler = ActionView::Template.handler_for_extension(File.extname(file_path).gsub(".", ""))
+          template = File.read(file_path)
 
-          sibling_template_files[0]
+          # This can be removed once this code is merged into Rails
+          if handler.method(:call).parameters.length > 1
+            handler.call(DummyTemplate.new, template)
+          else
+            handler.call(DummyTemplate.new(template))
+          end
         end
       end
 
@@ -175,14 +231,6 @@ module ActionView
           "text/html"
         end
       end
-
-      private
-
-      def request
-        @request ||= controller.request
-      end
-
-      attr_reader :content, :view_context
     end
   end
 end

data/lib/action_view/component/test_helpers.rb

@@ -4,7 +4,7 @@ module ActionView
   module Component
     module TestHelpers
       def render_inline(component, **args, &block)
-        Nokogiri::HTML(controller.view_context.render(component, args, &block))
+        Nokogiri::HTML(controller.view_context.render(component, args, &block)).css("body > *")
       end
 
       def controller
@@ -22,6 +22,14 @@ module ActionView
 
         render_inline(component, args, &block)
       end
+
+      def with_variant(variant)
+        old_variants = controller.view_context.lookup_context.variants
+
+        controller.view_context.lookup_context.variants = variant
+        yield
+        controller.view_context.lookup_context.variants = old_variants
+      end
     end
   end
 end

data/lib/action_view/component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.4.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.74'
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement