view_component 2.5.1 → 2.10.0

data/app/controllers/{rails/view_components_controller.rb → view_components_controller.rb}

@@ -2,8 +2,8 @@
 
 require "rails/application_controller"
 
-class Rails::ViewComponentsController < Rails::ApplicationController # :nodoc:
-  prepend_view_path File.expand_path("../../../lib/railties/lib/rails/templates/rails", __dir__)
+class ViewComponentsController < Rails::ApplicationController # :nodoc:
+  prepend_view_path File.expand_path("../views", __dir__)
 
   around_action :set_locale, only: :previews
   before_action :find_preview, only: :previews
@@ -16,26 +16,19 @@ class Rails::ViewComponentsController < Rails::ApplicationController # :nodoc:
   def index
     @previews = ViewComponent::Preview.all
     @page_title = "Component Previews"
-    # rubocop:disable GitHub/RailsControllerRenderPathsExist
-    render "components/index"
-    # rubocop:enable GitHub/RailsControllerRenderPathsExist
   end
 
   def previews
     if params[:path] == @preview.preview_name
       @page_title = "Component Previews for #{@preview.preview_name}"
-      # rubocop:disable GitHub/RailsControllerRenderPathsExist
-      render "components/previews"
-      # rubocop:enable GitHub/RailsControllerRenderPathsExist
+      render "view_components/previews"
     else
       prepend_application_view_paths
       @example_name = File.basename(params[:path])
       @render_args = @preview.render_args(@example_name, params: params.permit!)
       layout = @render_args[:layout]
       opts = layout.nil? ? {} : { layout: layout }
-      # rubocop:disable GitHub/RailsControllerRenderPathsExist
-      render "components/preview", **opts
-      # rubocop:enable GitHub/RailsControllerRenderPathsExist
+      render "view_components/preview", opts
     end
   end
 

data/app/views/view_components/index.html.erb

@@ -0,0 +1,8 @@
+<% @previews.each do |preview| %>
+  <h3><%= link_to preview.preview_name.titleize, preview_view_component_path(preview.preview_name) %></h3>
+  <ul>
+    <% preview.examples.each do |preview_example| %>
+      <li><%= link_to preview_example, preview_view_component_path("#{preview.preview_name}/#{preview_example}") %></li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/view_components/preview.html.erb

@@ -0,0 +1 @@
+<%= render(@render_args[:component], @render_args[:args], &@render_args[:block])%>

data/{lib/railties/lib/rails/templates/rails/components → app/views/view_components}/previews.html.erb

@@ -1,6 +1,6 @@
 <h3><%= @preview.preview_name.titleize %></h3>
 <ul>
   <% @preview.examples.each do |example| %>
-    <li><%= link_to example, "/rails/view_components/#{@preview.preview_name}/#{example}" %></li>
+    <li><%= link_to example, preview_view_component_path("#{@preview.preview_name}/#{example}") %></li>
   <% end %>
 </ul>

data/lib/view_component/base.rb

@@ -3,6 +3,7 @@
 require "action_view"
 require "active_support/configurable"
 require "view_component/collection"
+require "view_component/compile_cache"
 require "view_component/previewable"
 
 module ViewComponent
@@ -10,15 +11,11 @@ module ViewComponent
     include ActiveSupport::Configurable
     include ViewComponent::Previewable
 
+    # For CSRF authenticity tokens in forms
     delegate :form_authenticity_token, :protect_against_forgery?, to: :helpers
 
-    class_attribute :content_areas, default: []
-    self.content_areas = [] # default doesn't work until Rails 5.2
-
-    # Render a component collection.
-    def self.with_collection(*args)
-      Collection.new(self, *args)
-    end
+    class_attribute :content_areas
+    self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
     # Entrypoint for rendering components.
     #
@@ -45,20 +42,32 @@ module ViewComponent
     # <span title="greeting">Hello, world!</span>
     #
     def render_in(view_context, &block)
-      self.class.compile!
+      self.class.compile(raise_errors: true)
+
       @view_context = view_context
-      @view_renderer ||= view_context.view_renderer
       @lookup_context ||= view_context.lookup_context
+
+      # required for path helpers in older Rails versions
+      @view_renderer ||= view_context.view_renderer
+
+      # For content_for
       @view_flow ||= view_context.view_flow
+
+      # For i18n
       @virtual_path ||= virtual_path
+
+      # For template variants (+phone, +desktop, etc.)
       @variant = @lookup_context.variants.first
 
+      # For caching, such as #cache_if
+      @current_template = nil unless defined?(@current_template)
       old_current_template = @current_template
       @current_template = self
 
+      # Assign captured content passed to component as a block to @content
       @content = view_context.capture(self, &block) if block_given?
 
-      before_render_check
+      before_render
 
       if render?
         send(self.class.call_method_name(@variant))
@@ -69,6 +78,10 @@ module ViewComponent
       @current_template = old_current_template
     end
 
+    def before_render
+      before_render_check
+    end
+
     def before_render_check
       # noop
     end
@@ -77,12 +90,10 @@ module ViewComponent
       true
     end
 
-    def self.short_identifier
-      @short_identifier ||= defined?(Rails.root) ? source_location.sub("#{Rails.root}/", "") : source_location
-    end
-
     def initialize(*); end
 
+    # If trying to render a partial or template inside a component,
+    # pass the render call to the parent view_context.
     def render(options = {}, args = {}, &block)
       if options.is_a?(String) || (options.is_a?(Hash) && options.has_key?(:partial))
         view_context.render(options, args, &block)
@@ -95,7 +106,7 @@ module ViewComponent
       @controller ||= view_context.controller
     end
 
-    # Provides a proxy to access helper methods through
+    # Provides a proxy to access helper methods
     def helpers
       @helpers ||= view_context
     end
@@ -105,14 +116,17 @@ module ViewComponent
       self.class.source_location.gsub(%r{(.*app/components)|(\.rb)}, "")
     end
 
+    # For caching, such as #cache_if
     def view_cache_dependencies
       []
     end
 
-    def format # :nodoc:
+    # For caching, such as #cache_if
+    def format
       @variant
     end
 
+    # Assign the provided content to the content area accessor
     def with(area, content = nil, &block)
       unless content_areas.include?(area)
         raise ArgumentError.new "Unknown content_area '#{area}' - expected one of '#{content_areas}'"
@@ -128,6 +142,9 @@ module ViewComponent
 
     private
 
+    # Exposes the current request to the component.
+    # Use sparingly as doing so introduces coupling
+    # that inhibits encapsulation & reuse.
     def request
       @request ||= controller.request
     end
@@ -143,7 +160,18 @@ module ViewComponent
     class << self
       attr_accessor :source_location
 
+      # Render a component collection.
+      def with_collection(*args)
+        Collection.new(self, *args)
+      end
+
+      # Provide identifier for ActionView template annotations
+      def short_identifier
+        @short_identifier ||= defined?(Rails.root) ? source_location.sub("#{Rails.root}/", "") : source_location
+      end
+
       def inherited(child)
+        # If we're in Rails, add application url_helpers to the component context
         if defined?(Rails)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
         end
@@ -165,58 +193,83 @@ module ViewComponent
       end
 
       def compiled?
-        @compiled && ActionView::Base.cache_template_loading
-      end
-
-      def compile!
-        compile(raise_template_errors: true)
+        CompileCache.compiled?(self)
       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(raise_template_errors: false)
+      #
+      # Do as much work as possible in this step, as doing so reduces the amount
+      # of work done each time a component is rendered.
+      def compile(raise_errors: false)
         return if compiled?
 
         if template_errors.present?
-          raise ViewComponent::TemplateError.new(template_errors) if raise_template_errors
+          raise ViewComponent::TemplateError.new(template_errors) if raise_errors
           return false
         end
 
+        if instance_methods(false).include?(:before_render_check)
+          ActiveSupport::Deprecation.warn(
+            "`before_render_check` will be removed in v3.0.0. Use `before_render` instead."
+          )
+        end
+
+        # Remove any existing singleton methods,
+        # as Ruby warns when redefining a method.
+        remove_possible_singleton_method(:variants)
+        remove_possible_singleton_method(:collection_parameter)
+        remove_possible_singleton_method(:collection_counter_parameter)
+        remove_possible_singleton_method(:counter_argument_present?)
+
         define_singleton_method(:variants) do
           templates.map { |template| template[:variant] } + variants_from_inline_calls(inline_calls)
         end
 
-        define_singleton_method(:collection_counter_parameter_name) do
-          "#{collection_parameter_name}_counter".to_sym
+        define_singleton_method(:collection_parameter) do
+          if provided_collection_parameter
+            provided_collection_parameter
+          else
+            name.demodulize.underscore.chomp("_component").to_sym
+          end
+        end
+
+        define_singleton_method(:collection_counter_parameter) do
+          "#{collection_parameter}_counter".to_sym
         end
 
         define_singleton_method(:counter_argument_present?) do
-          instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter_name)
+          instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
         end
 
+        validate_collection_parameter! if raise_errors
+
         # If template name annotations are turned on, a line is dynamically
         # added with a comment. In this case, we want to return a different
         # starting line number so errors that are raised will point to the
         # correct line in the component template.
         line_number =
-          if ActionView::Base.respond_to?(:annotate_template_file_names) &&
-            ActionView::Base.annotate_template_file_names
+          if ActionView::Base.respond_to?(:annotate_rendered_view_with_filenames) &&
+            ActionView::Base.annotate_rendered_view_with_filenames
             -2
           else
             -1
           end
 
         templates.each do |template|
+          # Remove existing compiled template methods,
+          # as Ruby warns when redefining a method.
+          method_name = call_method_name(template[:variant])
+          undef_method(method_name.to_sym) if instance_methods.include?(method_name.to_sym)
+
           class_eval <<-RUBY, template[:path], line_number
-            def #{call_method_name(template[:variant])}
+            def #{method_name}
               @output_buffer = ActionView::OutputBuffer.new
               #{compiled_template(template[:path])}
             end
           RUBY
         end
 
-        @compiled = true
+        CompileCache.register self
       end
 
       # we'll eventually want to update this to support other types
@@ -236,21 +289,51 @@ module ViewComponent
         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
+        attr_reader(*areas)
         self.content_areas = areas
       end
 
-      # Support overriding this component's collection parameter name
+      # Support overriding collection parameter name
       def with_collection_parameter(param)
-        @with_collection_parameter = param
+        @provided_collection_parameter = param
       end
 
-      def collection_parameter_name
-        (@with_collection_parameter || name.demodulize.underscore.chomp("_component")).to_sym
+      # Ensure the component initializer accepts the
+      # collection parameter. By default, we do not
+      # validate that the default parameter name
+      # is accepted, as support for collection
+      # rendering is optional.
+      def validate_collection_parameter!(validate_default: false)
+        parameter = validate_default ? collection_parameter : provided_collection_parameter
+
+        return unless parameter
+        return if initialize_parameters.map(&:last).include?(parameter)
+
+        # If Ruby cannot parse the component class, then the initalize
+        # parameters will be empty and ViewComponent will not be able to render
+        # the component.
+        if initialize_parameters.empty?
+          raise ArgumentError.new(
+            "#{self} initializer is empty or invalid."
+          )
+        end
+
+        raise ArgumentError.new(
+          "#{self} initializer must accept " \
+          "`#{parameter}` collection parameter."
+        )
       end
 
       private
 
+      def initialize_parameters
+        instance_method(:initialize).parameters
+      end
+
+      def provided_collection_parameter
+        @provided_collection_parameter ||= nil
+      end
+
       def compiled_template(file_path)
         handler = ActionView::Template.handler_for_extension(File.extname(file_path).gsub(".", ""))
         template = File.read(file_path)
@@ -280,7 +363,22 @@ module ViewComponent
 
       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])
+
+        location_without_extension = source_location.chomp(File.extname(source_location))
+
+        extenstions = ActionView::Template.template_handler_extensions.join(",")
+
+        # view files in the same directory as te component
+        sidecar_files = Dir["#{location_without_extension}.*{#{extenstions}}"]
+
+        # view files in a directory named like the component
+        directory = File.dirname(source_location)
+        filename = File.basename(source_location, ".rb")
+        component_name = name.demodulize.underscore
+
+        sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extenstions}}"]
+
+        (sidecar_files - [source_location] + sidecar_directory_files)
       end
 
       def templates

data/lib/view_component/collection.rb

@@ -5,7 +5,9 @@ module ViewComponent
     def render_in(view_context, &block)
       iterator = ActionView::PartialIteration.new(@collection.size)
 
-      @component.compile!
+      @component.compile(raise_errors: true)
+      @component.validate_collection_parameter!(validate_default: true)
+
       @collection.map do |item|
         content = @component.new(component_options(item, iterator)).render_in(view_context, &block)
         iterator.iterate!
@@ -30,8 +32,8 @@ module ViewComponent
     end
 
     def component_options(item, iterator)
-      item_options = { @component.collection_parameter_name => item }
-      item_options[@component.collection_counter_parameter_name] = iterator.index + 1 if @component.counter_argument_present?
+      item_options = { @component.collection_parameter => item }
+      item_options[@component.collection_counter_parameter] = iterator.index + 1 if @component.counter_argument_present?
 
       @options.merge(item_options)
     end

data/lib/view_component/compile_cache.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  # Keeps track of which templates have already been compiled
+  # This is not part of the public API
+  module CompileCache
+    mattr_accessor :cache, instance_reader: false, instance_accessor: false do
+      Set.new
+    end
+    module_function
+
+    def register(klass)
+      cache << klass
+    end
+
+    def compiled?(klass)
+      cache.include? klass
+    end
+
+    def invalidate!
+      cache.clear
+    end
+  end
+end

data/lib/view_component/engine.rb

@@ -11,6 +11,7 @@ module ViewComponent
       options = app.config.view_component
 
       options.show_previews = Rails.env.development? if options.show_previews.nil?
+      options.preview_route ||= ViewComponent::Base.preview_route
 
       if options.show_previews
         options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
@@ -64,10 +65,14 @@ module ViewComponent
 
       if options.show_previews
         app.routes.prepend do
-          get "/rails/view_components"       => "rails/view_components#index", :internal => true
-          get "/rails/view_components/*path" => "rails/view_components#previews", :internal => true
+          get options.preview_route, to: "view_components#index", as: :preview_view_components, internal: true
+          get "#{options.preview_route}/*path", to: "view_components#previews", as: :preview_view_component, internal: true
         end
       end
+
+      app.executor.to_run :before do
+        CompileCache.invalidate! unless ActionView::Base.cache_template_loading
+      end
     end
   end
 end