actionview-component 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d1497b59c35721a9d9c48906ca5b1a64eb30f72e9bfd17d0da2437820e7e87
-  data.tar.gz: e703a27db8cac4a589f6d8f78e3ffc2bb7783af16d7c49c8986d06db7155bcd4
+  metadata.gz: 642717e715c2f33794d3647e8756af86226bf90a9ee40c28496109288fa63201
+  data.tar.gz: a2144dc99b735c2e0cd27b86e5f5b95f60031facc7b47af0e35f3ab0ff2562ba
 SHA512:
-  metadata.gz: 481e35fdf095d48a1c3a33795d8e1d8b0be6a6b6944b149e5a6320add88f8748f4ea8e19282cd90bb62f9858291cd07084e9b1221051fcfb89f70b7dd6471281
-  data.tar.gz: 45fd087cc394799a8f21044c58de91a3aeee93dc29c8fbd8ff8c4a1979977bb86bc47d38341f51a37bbe93038c81b77908ec8d634d4d41b064a11585a684ae44
+  metadata.gz: 34973a14a10b96e2905b2fadfa93828de4014c12f97239a367527aabea8218d13281cdc8dbad7808f9575afafb66172202612a65e51506db4f2e8be4a6055354
+  data.tar.gz: 893531f33aaf0982973df46acc708e42de316464a3860bda12a693e810283d12d7d5a3a5a743149fa406645ff7242f9ef04509f18a0c855379b867f6ef4f9117

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+# 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.6.0)
+    actionview-component (1.6.1)
 
 GEM
   remote: https://rubygems.org/
@@ -101,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)

data/README.md

@@ -32,7 +32,7 @@ $ bundle
 In `config/application.rb`, add:
 
 ```bash
-require "action_view/component"
+require "action_view/component/railtie"
 ```
 
 ## Guide
@@ -174,7 +174,7 @@ Example for a `Post` model:
 `render(@post)`
 
 ```ruby
-class PostComponent < ActionView::Component
+class PostComponent < ActionView::Component::Base
   def initialize(post)
     @post = post
   end
@@ -204,12 +204,10 @@ An error will be raised:
 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"
-
-class MyComponentTest < Minitest::Test
-  include ActionView::Component::TestHelpers
+require "action_view/component/test_case"
 
-  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
@@ -225,7 +223,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>),

data/lib/action_view/component.rb

@@ -1,6 +1,22 @@
 # frozen_string_literal: true
 
-require "action_view/component/monkey_patch"
-require "action_view/component/active_model_conversion_monkey_patch"
-require "action_view/component/base"
+require "active_model"
+require "action_view"
+require "active_support/dependencies/autoload"
 require "action_view/component/railtie"
+
+module ActionView
+  module Component
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Conversion
+    autoload :Preview
+    autoload :Previewable
+    autoload :TestHelpers
+    autoload :TestCase
+    autoload :RenderMonkeyPatch
+  end
+end
+
+ActiveModel::Conversion.include ActionView::Component::Conversion

data/lib/action_view/component/base.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
-require "active_model"
-require "action_view"
 require "active_support/configurable"
-require_relative "preview"
 
 module ActionView
   module Component
     class Base < ActionView::Base
       include ActiveModel::Validations
       include ActiveSupport::Configurable
-      include ActionView::Component::Previews
+      include ActionView::Component::Previewable
 
       delegate :form_authenticity_token, :protect_against_forgery?, to: :helpers
 
@@ -113,6 +110,10 @@ module ActionView
           end
         end
 
+        def has_initializer?
+          self.instance_method(:initialize).owner == self
+        end
+
         def source_location
           # Require #initialize to be defined so that we can use
           # method#source_location to look up the file name
@@ -121,16 +122,26 @@ module ActionView
           # 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
+          raise NotImplementedError.new("#{self} must implement #initialize.") unless has_initializer?
 
           instance_method(:initialize).source_location[0]
         end
 
+        def eager_load!
+          self.descendants.each do |descendant|
+            descendant.compile if descendant.has_initializer?
+          end
+        end
+
+        def compiled?
+          @compiled && ActionView::Base.cache_template_loading
+        end
+
         # 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 first time the component is rendered.
         def compile
-          return if @compiled && ActionView::Base.cache_template_loading
+          return if compiled?
 
           validate_templates
 
@@ -161,13 +172,19 @@ module ActionView
 
         private
 
+        def matching_views_in_source_location
+          (Dir["#{source_location.sub(/#{File.extname(source_location)}$/, '')}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
+        end
+
         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|
+            matching_views_in_source_location.each_with_object([]) do |path, memo|
+              pieces = File.basename(path).split(".")
+
               memo << {
                 path: path,
-                variant: path.split(".").second.split("+")[1]&.to_sym,
-                handler: path.split(".").last
+                variant: pieces.second.split("+")[1]&.to_sym,
+                handler: pieces.last
               }
             end
         end

data/lib/action_view/component/conversion.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Component # :nodoc:
+    module Conversion
+      def to_component_class
+        "#{self.class.name}Component".safe_constantize
+      end
+    end
+  end
+end

data/lib/action_view/component/preview.rb

@@ -1,37 +1,15 @@
 # frozen_string_literal: true
 
-require "active_support/concern"
 require "active_support/descendants_tracker"
-require_relative "test_helpers"
 
 module ActionView
-  module Component #:nodoc:
-    module Previews
-      extend ActiveSupport::Concern
-
-      included do
-        # Set the location of component previews through app configuration:
-        #
-        #     config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
-        #
-        mattr_accessor :preview_path, instance_writer: false
-
-        # Enable or disable component previews through app configuration:
-        #
-        #     config.action_view_component.show_previews = true
-        #
-        # Defaults to +true+ for development environment
-        #
-        mattr_accessor :show_previews, instance_writer: false
-      end
-    end
-
+  module Component # :nodoc:
     class Preview
       extend ActiveSupport::DescendantsTracker
       include ActionView::Component::TestHelpers
 
-      def render(component, *locals)
-        render_inline(component, *locals)
+      def render(component, *locals, &block)
+        render_inline(component, *locals, &block)
       end
 
       class << self
@@ -42,11 +20,14 @@ module ActionView
         end
 
         # Returns the html of the component in its layout
-        def call(example)
+        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 || "layouts/application",
+                                                    layout: layout,
                                                     assigns: { example: example_html })
         end
 

data/lib/action_view/component/previewable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActionView
+  module Component # :nodoc:
+    module Previewable
+      extend ActiveSupport::Concern
+
+      included do
+        # Set the location of component previews through app configuration:
+        #
+        #     config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
+        #
+        mattr_accessor :preview_path, instance_writer: false
+
+        # Enable or disable component previews through app configuration:
+        #
+        #     config.action_view_component.show_previews = true
+        #
+        # Defaults to +true+ for development environment
+        #
+        mattr_accessor :show_previews, instance_writer: false
+      end
+    end
+  end
+end

data/lib/action_view/component/railtie.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails"
+
 module ActionView
   module Component
     class Railtie < Rails::Railtie # :nodoc:
@@ -23,6 +25,7 @@ module ActionView
         require "railties/lib/rails/components_controller"
         require "railties/lib/rails/component_examples_controller"
 
+        app.config.eager_load_namespaces << ActionView::Component::Base
         options = app.config.action_view_component
 
         if options.show_previews && options.preview_path
@@ -36,6 +39,12 @@ module ActionView
         end
       end
 
+      initializer "action_view_component.monkey_patch_render" do
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Base.prepend ActionView::Component::RenderMonkeyPatch
+        end
+      end
+
       config.after_initialize do |app|
         options = app.config.action_view_component
 

data/lib/action_view/component/render_monkey_patch.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Monkey patch ActionView::Base#render to support ActionView::Component
+#
+# A version of this monkey patch was upstreamed in https://github.com/rails/rails/pull/36388
+# We'll need to upstream an updated version of this eventually.
+module ActionView
+  module Component
+    module RenderMonkeyPatch # :nodoc:
+      def render(options = {}, args = {}, &block)
+        if options.respond_to?(:render_in)
+          ActiveSupport::Deprecation.warn(
+            "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)
+        elsif options.is_a?(Class) && options < ActionView::Component::Base
+          options.new(args).render_in(self, &block)
+        elsif options.is_a?(Hash) && options.has_key?(:component)
+          options[:component].new(options[:locals]).render_in(self, &block)
+        elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil?
+          options.to_component_class.new(options).render_in(self, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/action_view/component/test_case.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ActionView
+  module Component
+    class TestCase < ActiveSupport::TestCase
+      include ActionView::Component::TestHelpers
+    end
+  end
+end

data/lib/action_view/component/version.rb

@@ -5,7 +5,7 @@ module ActionView
     module VERSION
       MAJOR = 1
       MINOR = 6
-      PATCH = 0
+      PATCH = 1
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

data/lib/rails/generators/test_unit/templates/component_test.rb.tt

@@ -1,8 +1,6 @@
 require "test_helper"
 
-class <%= class_name %>ComponentTest < ActiveSupport::TestCase
-  include ActionView::Component::TestHelpers
-
+class <%= class_name %>ComponentTest < ActionView::Component::TestCase
   test "component renders something useful" do
     # assert_equal(
     #   %(<span title="my title">Hello, components!</span>),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,11 +142,13 @@ files:
 - Rakefile
 - actionview-component.gemspec
 - lib/action_view/component.rb
-- lib/action_view/component/active_model_conversion_monkey_patch.rb
 - lib/action_view/component/base.rb
-- lib/action_view/component/monkey_patch.rb
+- lib/action_view/component/conversion.rb
 - lib/action_view/component/preview.rb
+- lib/action_view/component/previewable.rb
 - lib/action_view/component/railtie.rb
+- lib/action_view/component/render_monkey_patch.rb
+- lib/action_view/component/test_case.rb
 - lib/action_view/component/test_helpers.rb
 - lib/action_view/component/version.rb
 - lib/rails/generators/component/USAGE

data/lib/action_view/component/active_model_conversion_monkey_patch.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveModel
-  module Conversion
-    def to_component_class
-      "#{self.class.name}Component".safe_constantize
-    end
-  end
-end

data/lib/action_view/component/monkey_patch.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch ActionView::Base#render to support ActionView::Component
-#
-# A version of this monkey patch was upstreamed in https://github.com/rails/rails/pull/36388
-# We'll need to upstream an updated version of this eventually.
-class ActionView::Base
-  module RenderMonkeyPatch
-    def render(options = {}, args = {}, &block)
-      if options.respond_to?(:render_in)
-        ActiveSupport::Deprecation.warn(
-          "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)
-      elsif options.is_a?(Class) && options < ActionView::Component::Base
-        options.new(args).render_in(self, &block)
-      elsif options.is_a?(Hash) && options.has_key?(:component)
-        options[:component].new(options[:locals]).render_in(self, &block)
-      elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil?
-        options.to_component_class.new(options).render_in(self, &block)
-      else
-        super
-      end
-    end
-  end
-
-  prepend RenderMonkeyPatch
-end