view_component 2.23.0 → 2.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcba3738e1cef136c14cd82cc3dd8301596f576b8891bd668e5216ff0dca9bc6
-  data.tar.gz: 7bd2112814c640f4b524f557799d1484fcaf88240505e7e09753cdacf7af87bd
+  metadata.gz: c411f9f34b25054093f7abe23c5842c7523f083ecdb1ba586429545548eca423
+  data.tar.gz: 744c27c0907544dfb93eb37ecf47c74dd7df86855c0e2b91f9619a77bd8eefc8
 SHA512:
-  metadata.gz: e97c8b9fe11d78da84c129f99bfa19c8e76596064d76adc78f28127410f7f5b31a856c31a4a1e8444c707d7d228b1ffe4c01d9b70ffcc54a3ef9bd7edba7a61b
-  data.tar.gz: 6856e490404554040459f57bfab1ae523a00808498230078bc914f97f1bcaf19d1f4a50c5ba66c5d31b0250d2d3185df0f4a93b6761bd875349e0b3a7f643466
+  metadata.gz: bee62ecbcfecbc53146b8a8e55207baf2d14769adda2bb2349494a82224acf12fa6584bfc32512e96474f28f011823f2c5712cbc021773d439c43fab8b090503
+  data.tar.gz: 3f519b85b066d89fdf75afb17563cb868bb4fb673caa21326661f0738b9b4398af068421064ca6f77abf08b7b46bdc549c132252b111b8fb3009809d430b9682

data/CHANGELOG.md

@@ -1,6 +1,52 @@
 # CHANGELOG
 
-## master
+## main
+
+## 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
+
+* Fix bug where rendering a component `with_collection` from a controller raised an error.
+
+    *Joel Hawksley*
+
+## 2.23.1
+
+* Fixed out-of-order rendering bug in `ActionView::SlotableV2`
+
+    *Blake Williams*
 
 ## 2.23.0
 

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,6 +7,7 @@ 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
@@ -15,10 +16,12 @@ module Erb
       private
 
       def destination
-        if options["sidecar"]
-          File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.erb")
-        else
-          File.join("app/components", class_path, "#{file_name}_component.html.erb")
+        if !options["inline"]
+          if options["sidecar"]
+            File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.erb")
+          else
+            File.join("app/components", class_path, "#{file_name}_component.html.erb")
+          end
         end
       end
 

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/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
@@ -264,7 +274,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 +291,25 @@ 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
+
       private
 
+      def initialize_parameter_names
+        initialize_parameters.map(&:last)
+      end
+
       def initialize_parameters
         instance_method(:initialize).parameters
       end

data/lib/view_component/collection.rb

@@ -4,14 +4,17 @@ require "action_view/renderer/collection_renderer" if Rails.version.to_f >= 6.1
 
 module ViewComponent
   class Collection
+    attr_reader :component
+    delegate :format, to: :component
+
     def render_in(view_context, &block)
       iterator = ActionView::PartialIteration.new(@collection.size)
 
-      @component.compile(raise_errors: true)
-      @component.validate_collection_parameter!(validate_default: true)
+      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)
+        content = component.new(**component_options(item, iterator)).render_in(view_context, &block)
         iterator.iterate!
         content
       end.join.html_safe
@@ -34,8 +37,8 @@ module ViewComponent
     end
 
     def component_options(item, iterator)
-      item_options = { @component.collection_parameter => item }
-      item_options[@component.collection_counter_parameter] = 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/compiler.rb

@@ -46,7 +46,10 @@ module ViewComponent
         instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
       end
 
-      component_class.validate_collection_parameter! if raise_errors
+      if raise_errors
+        component_class.validate_initialization_parameters!
+        component_class.validate_collection_parameter!
+      end
 
       templates.each do |template|
         # Remove existing compiled template methods,
@@ -64,6 +67,8 @@ module ViewComponent
 
       define_render_template_for
 
+      component_class._after_compile
+
       CompileCache.register(component_class)
     end
 
@@ -163,9 +168,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 +209,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 +219,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,21 @@ module ViewComponent
     # If there is no slot renderable, we evaluate the block passed to
     # the slot and return it.
     def to_s
-      if defined?(@_component_instance)
-        # render_in is faster than `parent.render`
-        @_component_instance.render_in(
-          @parent.send(:view_context),
-          &@_content_block
-        )
-      elsif defined?(@_content)
-        @_content
-      elsif defined?(@_content_block)
-        @_content_block.call
+      return @content if defined?(@content)
+
+      view_context = @parent.send(:view_context)
+      @content = view_context.capture do
+        if defined?(@_component_instance)
+          # render_in is faster than `parent.render`
+          @_component_instance.render_in(view_context, &@_content_block)
+        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,8 +62,12 @@ 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)
-      @_component_instance.respond_to?(symbol, include_all)
+      defined?(@_component_instance) && @_component_instance.respond_to?(symbol, include_all)
     end
   end
 end

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 23
-    PATCH = 0
+    MINOR = 25
+    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.0
+  version: 2.25.1
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,7 +198,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-description:
+description: 
 email:
 - opensource+view_component@github.com
 executables: []
@@ -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
@@ -253,7 +255,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -268,8 +270,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: View components for Rails
 test_files: []