actionview-component 1.5.3 → 1.8.0

data/actionview-component.gemspec

@@ -39,6 +39,7 @@ 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 "better_html", "~> 1"
   spec.add_development_dependency "rubocop", "= 0.74"
   spec.add_development_dependency "rubocop-github", "~> 0.13.0"
 end

data/lib/action_view/component.rb

@@ -1,5 +1,23 @@
 # frozen_string_literal: true
 
-require "action_view/component/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
+    autoload :TemplateError
+  end
+end
+
+ActiveModel::Conversion.include ActionView::Component::Conversion

data/lib/action_view/component/base.rb

@@ -1,20 +1,18 @@
 # 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
 
-      validate :variant_exists
+      class_attribute :content_areas, default: []
+      self.content_areas = [] # default doesn't work until Rails 5.2
 
       # Entrypoint for rendering components. Called by ActionView::Base#render.
       #
@@ -42,17 +40,21 @@ module ActionView
       # <span title="greeting">Hello, world!</span>
       #
       def render_in(view_context, *args, &block)
-        self.class.compile
+        self.class.compile!
         @view_context = view_context
         @view_renderer ||= view_context.view_renderer
         @lookup_context ||= view_context.lookup_context
         @view_flow ||= view_context.view_flow
         @virtual_path ||= virtual_path
         @variant = @lookup_context.variants.first
+
+        return "" unless render?
+
         old_current_template = @current_template
         @current_template = self
 
-        @content = view_context.capture(&block) if block_given?
+        @content = view_context.capture(self, &block) if block_given?
+
         validate!
 
         send(self.class.call_method_name(@variant))
@@ -60,6 +62,10 @@ module ActionView
         @current_template = old_current_template
       end
 
+      def render?
+        true
+      end
+
       def initialize(*); end
 
       def render(options = {}, args = {}, &block)
@@ -92,20 +98,33 @@ module ActionView
         @variant
       end
 
-      private
+      def with(area, content = nil, &block)
+        unless content_areas.include?(area)
+          raise ArgumentError.new "Unknown content_area '#{area}' - expected one of '#{content_areas}'"
+        end
 
-      def variant_exists
-        return if self.class.variants.include?(@variant) || @variant.nil?
+        if block_given?
+          content = view_context.capture(&block)
+        end
 
-        errors.add(:variant, "'#{@variant}' has no template defined")
+        instance_variable_set("@#{area}".to_sym, content)
+        nil
       end
 
+      private
+
       def request
         @request ||= controller.request
       end
 
       attr_reader :content, :view_context
 
+      # The controller used for testing components.
+      # Defaults to ApplicationController. This should be set early
+      # in the initialization process and should be set to a string.
+      mattr_accessor :test_controller
+      @@test_controller = "ApplicationController"
+
       class << self
         def inherited(child)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -114,7 +133,7 @@ module ActionView
         end
 
         def call_method_name(variant)
-          if variant.present?
+          if variant.present? && variants.include?(variant)
             "call_#{variant}"
           else
             "call"
@@ -122,25 +141,39 @@ module ActionView
         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
+          @source_location ||=
+              begin
+                # 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.
+                #
+                initialize_method = instance_method(:initialize)
+                initialize_method.source_location[0] if initialize_method.owner == self
+              end
+        end
+
+        def compiled?
+          @compiled && ActionView::Base.cache_template_loading
+        end
 
-          instance_method(:initialize).source_location[0]
+        def compile!
+          compile(validate: true)
         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
+        def compile(validate: false)
+          return if compiled?
 
-          validate_templates
+          if template_errors.present?
+            raise ActionView::Component::TemplateError.new(template_errors) if validate
+            return false
+          end
 
           templates.each do |template|
             class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -164,36 +197,59 @@ module ActionView
         end
 
         def identifier
-          ""
+          source_location
+        end
+
+        def with_content_areas(*areas)
+          if areas.include?(:content)
+            raise ArgumentError.new ":content is a reserved content area name. Please use another name, such as ':body'"
+          end
+          attr_reader *areas
+          self.content_areas = areas
         end
 
         private
 
+        def matching_views_in_source_location
+          return [] unless source_location
+          (Dir["#{source_location.chomp(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("+").second&.to_sym,
+                handler: pieces.last
               }
             end
         end
 
-        def validate_templates
-          if templates.empty?
-            raise NotImplementedError.new("Could not find a template file for #{self}.")
-          end
+        def template_errors
+          @template_errors ||=
+            begin
+              errors = []
+              errors << "#{self} must implement #initialize." if source_location.nil?
+              errors << "Could not find a template file for #{self}." if templates.empty?
 
-          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
+              if templates.count { |template| template[:variant].nil? } > 1
+                errors << "More than one template found for #{self}. There can only be one default template file per component."
+              end
 
-          variants.each_with_object(Hash.new(0)) { |variant, counts| counts[variant] += 1 }.each do |variant, count|
-            next unless count > 1
+              invalid_variants = templates
+                                   .group_by { |template| template[:variant] }
+                                   .map { |variant, grouped| variant if grouped.length > 1 }
+                                   .compact
+                                   .sort
 
-            raise StandardError.new("More than one template found for variant '#{variant}' in #{self}. There can only be one template file per variant.")
-          end
+              unless invalid_variants.empty?
+                errors << "More than one template found for #{'variant'.pluralize(invalid_variants.count)} #{invalid_variants.map { |v| "'#{v}'" }.to_sentence} in #{self}. There can only be one template file per variant."
+              end
+              errors
+            end
         end
 
         def compiled_template(file_path)

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,14 @@
 # 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, **args, &block)
+        { component: component, args: args, block: block }
       end
 
       class << self
@@ -41,18 +18,14 @@ module ActionView
           descendants
         end
 
-        # Returns the html of the component in its layout
-        def call(example)
-          example_html = new.public_send(example)
-
-          Rails::ComponentExamplesController.render(template: "examples/show",
-                                                    layout: @layout || "layouts/application",
-                                                    assigns: { example: example_html })
+        # Returns the arguments for rendering of the component in its layout
+        def render_args(example)
+          new.public_send(example).merge(layout: @layout)
         end
 
         # Returns the component object class associated to the preview.
         def component
-          self.name.sub(%r{Preview$}, "").constantize
+          name.chomp("Preview").constantize
         end
 
         # Returns all of the available examples for the component preview.
@@ -77,7 +50,7 @@ module ActionView
 
         # Returns the underscored name of the component preview without the suffix.
         def preview_name
-          name.sub(/Preview$/, "").underscore
+          name.chomp("Preview").underscore
         end
 
         # Setter for layout name.

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,8 @@
 # frozen_string_literal: true
 
+require "rails"
+require "action_view/component"
+
 module ActionView
   module Component
     class Railtie < Rails::Railtie # :nodoc:
@@ -21,7 +24,6 @@ module ActionView
 
       initializer "action_view_component.set_autoload_paths" do |app|
         require "railties/lib/rails/components_controller"
-        require "railties/lib/rails/component_examples_controller"
 
         options = app.config.action_view_component
 
@@ -30,12 +32,24 @@ module ActionView
         end
       end
 
+      initializer "action_view_component.eager_load_actions" do
+        ActiveSupport.on_load(:after_initialize) do
+          ActionView::Component::Base.descendants.each(&:compile)
+        end
+      end
+
       initializer "action_view_component.compile_config_methods" do
         ActiveSupport.on_load(:action_view_component) do
           config.compile_methods! if config.respond_to?(:compile_methods!)
         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