view_component 2.24.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b088083cd9a83d90264715da7105bbc83e4c37e81785db5ca11c8192c6ccf6
-  data.tar.gz: d6ebc8a6a830e7bcf2490457d471017b9d123705e55ec9f6e0b1d2745e6a99c4
+  metadata.gz: ed1ee878b4b1519adcb75b06689a3341367cca5aa8ae4dd087cb2fba0c06a355
+  data.tar.gz: 70459f53b555b8edf6675346a42c1be87bb36267bce23ffb9cc4a639731c1b77
 SHA512:
-  metadata.gz: 9061290b38e66429e6f66327082d17f2fb8d26ef1022557a049a642335d4af79e6dcf05797a6af9ba95eb074315d3d1272c4c6902e87aa87728fc01fd694fe62
-  data.tar.gz: 5bcf720d202c0fbbeea76d9dbd044239dfb777be51ba47d39965aef104f84af5372aecf3d99bf203f973773bce3b311e41716b3e7715e8bd4b9175b3c305740a
+  metadata.gz: 2ac2189345c278608e8dc96ec1c7f90472991aefc86da43968489f3ea3cff4c9306ef8280553b2dad6a7a35b24e74eabd2269b3efcba4026b00b642dcac0dcf4
+  data.tar.gz: 6a393762db37291a6f6eaa2e19575aa035f103cc6c0fe71c96648fb827ed0e140c0e9d9f297901f699f7abd3e4946ca8e048bf53b1dbe62e47663e2bb591918e

data/CHANGELOG.md

@@ -2,8 +2,22 @@
 
 ## main
 
+## 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*

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,6 +15,8 @@ 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
 
@@ -264,7 +266,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 +283,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/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,
@@ -163,9 +166,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 +207,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 +217,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/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 24
+    MINOR = 25
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.25.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-01-25 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