view_component 2.23.2 → 2.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae234d64ddfd0c5c6943d58cad1c5ae034c036cd3663680fdbfa01dbb7c0bb26
-  data.tar.gz: 66ee3f2c510d649be7f4b4bb1ce99d63daa546fd738c70bd19edabe011c5f237
+  metadata.gz: 071c4caebc8e0dd567d8850adff146e65f6c8c1fe600b866f072d9bfa94bbc46
+  data.tar.gz: 64df3c2eb8d27431da23a2c628de6c9c00d7988130494d37319f4a01d653fd9c
 SHA512:
-  metadata.gz: 60101dbc8eee7be6fdbedd45bd414a6788e1e3d734f5126a6f3afb6ebcffb11b131bd5d04aece9eb1d45f3dec99067d2038f7313894031e501773e995b5f77c6
-  data.tar.gz: b6351313799ac1e85b0668270669677e1646c7d410b0ac14c3fb807a21a8cc53538dfb71934da2cb8a4fe60ef3db1f8edbb06e1651600a8bea4adb66c4d0bfa1
+  metadata.gz: 69bc43697d70dfb9b96280f47b80c06d1020fd180c01cbc6ae8c8416c3e1b97ffc6587d00741fa81743ae482a316e653790db5af2584c16baf3839a58b809195
+  data.tar.gz: 636d5d91edb07cb90f44e3fc21e7ee63c3c115d1f5fbf7666619205b628761028c4963c65b30a181f27fbbd0bf9539cab0ec3271a48b4d747d7a705528218f11

data/CHANGELOG.md

@@ -1,6 +1,60 @@
 # CHANGELOG
 
-## master
+## main
+
+## 2.26.1
+
+* Fix bug that raises when trying to use a collection before the component has been compiled.
+
+    *Blake Williams*
+
+## 2.26.0
+
+* Lazily evaluate component `content` in `render?`, preventing the `content` block from being evaluated when `render?` returns false.
+
+    *Blake Williams*
+
+* Do not generate template when using `--inline` flag.
+
+    *Hans Lemuet*
+
+* Add `--inline` option to the Haml and Slim generators
+
+    *Hans Lemuet*
+
+## 2.25.1
+
+* Experimental: call `._after_compile` class method after a component is compiled.
+
+    *Joel Hawksley*
+
+* Fix bug where SlotV2 was rendered as an HTML string when using Slim.
+
+    *Manuel Puyol*
+
+## 2.25.0
+
+* Add `--preview` generator option to create an associated preview file.
+
+    *Bob Maerten*
+
+* Add argument validation to avoid `content` override.
+
+    *Manuel Puyol*
+
+## 2.24.0
+
+* Add `--inline` option to the erb generator. Prevents default erb template from being created and creates a component with a call method.
+
+    *Nachiket Pusalkar*
+
+* Add test case for checking presence of `content` in `#render?`.
+
+    *Joel Hawksley*
+
+* Rename `master` branch to `main`.
+
+    *Joel Hawksley*
 
 ## 2.23.2
 

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

@@ -7,6 +7,7 @@ module Rails
 
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "Component"
+      class_option :inline, type: :boolean, default: false
 
       def create_component_file
         template "component.rb", File.join("app/components", class_path, "#{file_name}_component.rb")
@@ -14,6 +15,8 @@ module Rails
 
       hook_for :test_framework
 
+      hook_for :preview, type: :boolean
+
       hook_for :template_engine do |instance, template_engine|
         instance.invoke template_engine, [instance.name]
       end
@@ -37,6 +40,10 @@ module Rails
       def initialize_body
         attributes.map { |attr| "@#{attr.name} = #{attr.name}" }.join("\n    ")
       end
+
+      def initialize_call_method_for_inline?
+        options["inline"]
+      end
     end
   end
 end

data/lib/rails/generators/component/templates/component.rb.tt

@@ -6,4 +6,10 @@ class <%= class_name %>Component < <%= parent_class %>
     <%= initialize_body %>
   end
 <%- end -%>
+<%- if initialize_call_method_for_inline? -%>  
+  def call
+    content_tag :h1, "Hello world!"
+  end
+<%- end -%>
+
 end

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

@@ -7,9 +7,12 @@ module Erb
     class ComponentGenerator < Base
       source_root File.expand_path("templates", __dir__)
       class_option :sidecar, type: :boolean, default: false
+      class_option :inline, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.erb", destination
+        unless options["inline"]
+          template "component.html.erb", destination
+        end
       end
 
       private

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

@@ -9,7 +9,9 @@ module Haml
       class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.haml", destination
+        if !options["inline"]
+          template "component.html.haml", destination
+        end
       end
 
       private

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Preview
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "ComponentPreview"
+
+      def create_preview_file
+        template "component_preview.rb", File.join("test/components/previews", class_path, "#{file_name}_component_preview.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/rails/generators/preview/templates/component_preview.rb.tt

@@ -0,0 +1,5 @@
+class <%= class_name %>ComponentPreview < ViewComponent::Preview
+  def default
+    render(<%= class_name %>Component.new)
+  end
+end

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

@@ -9,7 +9,9 @@ module Slim
       class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.slim", destination
+        if !options["inline"]
+          template "component.html.slim", destination
+        end
       end
 
       private

data/lib/view_component/base.rb

@@ -15,12 +15,22 @@ module ViewComponent
 
     ViewContextCalledBeforeRenderError = Class.new(StandardError)
 
+    RESERVED_PARAMETER = :content
+
     # For CSRF authenticity tokens in forms
     delegate :form_authenticity_token, :protect_against_forgery?, :config, to: :helpers
 
     class_attribute :content_areas
     self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
+    # EXPERIMENTAL: This API is experimental and may be removed at any time.
+    # Hook for allowing components to do work as part of the compilation process.
+    #
+    # For example, one might compile component-specific assets at this point.
+    def self._after_compile
+      # noop
+    end
+
     # Entrypoint for rendering components.
     #
     # view_context: ActionView context from calling view
@@ -68,8 +78,8 @@ module ViewComponent
       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?
+      @_content_evaluated = false
+      @_render_in_block = block
 
       before_render
 
@@ -167,7 +177,20 @@ module ViewComponent
       @request ||= controller.request
     end
 
-    attr_reader :content, :view_context
+    attr_reader :view_context
+
+    def content
+      return @_content if defined?(@_content)
+      @_content_evaluated = true
+
+      @_content = if @view_context && @_render_in_block
+        view_context.capture(self, &@_render_in_block)
+      end
+    end
+
+    def content_evaluated?
+      @_content_evaluated
+    end
 
     # The controller used for testing components.
     # Defaults to ApplicationController. This should be set early
@@ -246,7 +269,14 @@ 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)
+
+        areas.each do |area|
+          define_method area.to_sym do
+            content unless content_evaluated? # ensure content is loaded so content_areas will be defined
+            instance_variable_get(:"@#{area}") if instance_variable_defined?(:"@#{area}")
+          end
+        end
+
         self.content_areas = areas
       end
 
@@ -264,7 +294,7 @@ module ViewComponent
         parameter = validate_default ? collection_parameter : provided_collection_parameter
 
         return unless parameter
-        return if initialize_parameters.map(&:last).include?(parameter)
+        return if initialize_parameter_names.include?(parameter)
 
         # If Ruby cannot parse the component class, then the initalize
         # parameters will be empty and ViewComponent will not be able to render
@@ -281,8 +311,41 @@ module ViewComponent
         )
       end
 
+      # Ensure the component initializer does not define
+      # invalid parameters that could override the framework's
+      # methods.
+      def validate_initialization_parameters!
+        return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
+
+        raise ArgumentError.new(
+          "#{self} initializer cannot contain " \
+          "`#{RESERVED_PARAMETER}` since it will override a " \
+          "public ViewComponent method."
+        )
+      end
+
+      def collection_parameter
+        if provided_collection_parameter
+          provided_collection_parameter
+        else
+          name && name.demodulize.underscore.chomp("_component").to_sym
+        end
+      end
+
+      def collection_counter_parameter
+        "#{collection_parameter}_counter".to_sym
+      end
+
+      def counter_argument_present?
+        instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
+      end
+
       private
 
+      def initialize_parameter_names
+        initialize_parameters.map(&:last)
+      end
+
       def initialize_parameters
         instance_method(:initialize).parameters
       end

data/lib/view_component/collection.rb

@@ -10,7 +10,6 @@ module ViewComponent
     def render_in(view_context, &block)
       iterator = ActionView::PartialIteration.new(@collection.size)
 
-      component.compile(raise_errors: true)
       component.validate_collection_parameter!(validate_default: true)
 
       @collection.map do |item|

data/lib/view_component/compiler.rb

@@ -24,30 +24,11 @@ module ViewComponent
         )
       end
 
-      # Remove any existing singleton methods,
-      # as Ruby warns when redefining a method.
-      component_class.remove_possible_singleton_method(:collection_parameter)
-      component_class.remove_possible_singleton_method(:collection_counter_parameter)
-      component_class.remove_possible_singleton_method(:counter_argument_present?)
-
-      component_class.define_singleton_method(:collection_parameter) do
-        if provided_collection_parameter
-          provided_collection_parameter
-        else
-          name.demodulize.underscore.chomp("_component").to_sym
-        end
-      end
-
-      component_class.define_singleton_method(:collection_counter_parameter) do
-        "#{collection_parameter}_counter".to_sym
+      if raise_errors
+        component_class.validate_initialization_parameters!
+        component_class.validate_collection_parameter!
       end
 
-      component_class.define_singleton_method(:counter_argument_present?) do
-        instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
-      end
-
-      component_class.validate_collection_parameter! if raise_errors
-
       templates.each do |template|
         # Remove existing compiled template methods,
         # as Ruby warns when redefining a method.
@@ -64,6 +45,8 @@ module ViewComponent
 
       define_render_template_for
 
+      component_class._after_compile
+
       CompileCache.register(component_class)
     end
 
@@ -163,9 +146,8 @@ module ViewComponent
       # end
       #
       # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
-      nested_component_files = if component_class.name.include?("::")
-        nested_component_path = component_class.name.deconstantize.underscore
-        Dir["#{directory}/#{nested_component_path}/#{component_name}.*{#{extensions}}"]
+      nested_component_files = if component_class.name.include?("::") && component_name != filename
+        Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
       else
         []
       end
@@ -205,7 +187,6 @@ module ViewComponent
       end
     end
 
-    # :nocov:
     def compiled_template(file_path)
       handler = ActionView::Template.handler_for_extension(File.extname(file_path).gsub(".", ""))
       template = File.read(file_path)
@@ -216,7 +197,6 @@ module ViewComponent
         handler.call(OpenStruct.new(source: template, identifier: component_class.identifier, type: component_class.type))
       end
     end
-    # :nocov:
 
     def call_method_name(variant)
       if variant.present? && variants.include?(variant)

data/lib/view_component/slot_v2.rb

@@ -22,17 +22,25 @@ module ViewComponent
     # If there is no slot renderable, we evaluate the block passed to
     # the slot and return it.
     def to_s
+      return @content if defined?(@content)
+
       view_context = @parent.send(:view_context)
-      view_context.capture do
+      @content = view_context.capture do
         if defined?(@_component_instance)
           # render_in is faster than `parent.render`
-          @_component_instance.render_in(view_context, &@_content_block)
+          if defined?(@_content_block)
+            @_component_instance.render_in(view_context, &@_content_block)
+          else
+            @_component_instance.render_in(view_context)
+          end
         elsif defined?(@_content)
           @_content
         elsif defined?(@_content_block)
           @_content_block.call
         end
       end
+
+      @content
     end
 
     # Allow access to public component methods via the wrapper
@@ -58,6 +66,10 @@ module ViewComponent
       @_component_instance.public_send(symbol, *args, &block)
     end
 
+    def html_safe?
+      to_s.html_safe?
+    end
+
     def respond_to_missing?(symbol, include_all = false)
       defined?(@_component_instance) && @_component_instance.respond_to?(symbol, include_all)
     end

data/lib/view_component/slotable.rb

@@ -51,11 +51,17 @@ module ViewComponent
           if collection
             class_eval <<-RUBY
               def #{accessor_name}
+                content unless content_evaluated? # ensure content is loaded so slots will be defined
                 #{instance_variable_name} ||= []
               end
             RUBY
           else
-            attr_reader accessor_name
+            class_eval <<-RUBY
+              def #{accessor_name}
+                content unless content_evaluated? # ensure content is loaded so slots will be defined
+                #{instance_variable_name} if defined?(#{instance_variable_name})
+              end
+            RUBY
           end
 
           # Default class_name to ViewComponent::Slot

data/lib/view_component/slotable_v2.rb

@@ -183,6 +183,8 @@ module ViewComponent
     end
 
     def get_slot(slot_name)
+      content unless content_evaluated? # ensure content is loaded so slots will be defined
+
       slot = self.class.registered_slots[slot_name]
       @_set_slots ||= {}
 

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 23
-    PATCH = 2
+    MINOR = 26
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.23.2
+  version: 2.26.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -219,6 +219,8 @@ files:
 - 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/preview/component_generator.rb
+- lib/rails/generators/preview/templates/component_preview.rb.tt
 - lib/rails/generators/rspec/component_generator.rb
 - lib/rails/generators/rspec/templates/component_spec.rb.tt
 - lib/rails/generators/slim/component_generator.rb
@@ -268,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: View components for Rails