view_component 2.37.0 → 2.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f97acb8cd2ac4c3c706207aa030cfb62af6d9066b9d05ed32b0946851132367
-  data.tar.gz: aeceea89a252646b358b5a67883fc926bffd56d321e0e3237fbc1471970c6745
+  metadata.gz: ec24d635f8ce5341c3735ab855b9099fe2ea9179bb21a8fe79ba0f14f374ec44
+  data.tar.gz: fbc578b4554de38f01a4e92bbcf6ddfaf146ac04fb75e871f8d2378f8a19c053
 SHA512:
-  metadata.gz: 8bc5f98ac1fc8ca620d2add5b59d5c0505489229cd0d8a7dcc9858774399c4e82e3dae419b5016b23a1228bec1e9e2e5a3e9d6980376439e5fb0cf02153ac8f9
-  data.tar.gz: 4d7b0037a063825a777a94ca03e32e89abcadc04bb0c5ec2265f5eb8a1b62f7abb1e807ace75726365ab8baebdd774dd5fc757da2b0cd6ce51a5670b03309ff2
+  metadata.gz: 9ed08e30f614fc25aeb1c1826d159b312fba175a95a71966112069a27bc1da3255948b1c9504b06f55b6c476fda4418f13b3e42050664dc3146def0ff1ba0636
+  data.tar.gz: b02c7784cc31a3e5cfe5d6ec55879bbe832446557810a3884034e871effece891164424f4d4bf34664c3d8a239683405ea31d92b7351321ce0fc8c33c802f3a5

data/docs/CHANGELOG.md

@@ -7,6 +7,88 @@ title: Changelog
 
 ## main
 
+## 2.41.0
+
+* Add `sprockets-rails` development dependency to fix test suite failures when using rails@main.
+
+    *Blake Williams*
+
+* Fix Ruby indentation warning.
+
+    *Blake Williams*
+
+* Add `--parent` generator option to specify the parent class.
+* Add config option `config.view_component.component_parent_class` to change it project-wide.
+
+    *Hans Lemuet*
+
+* Update docs to add example for using Devise helpers in tests.
+
+    *Matthew Rider*
+
+* Fix bug where `with_collection_parameter` did not inherit from parent component.
+
+    *Will Drexler*, *Christian Campoli*
+
+* Allow query parameters in `with_request_url` test helper.
+
+    *Javi Martín*
+
+* Add "how to render a component to a string" to FAQ.
+
+    *Hans Lemuet*
+
+* Add `#render_in` to API docs.
+
+    *Hans Lemuet*
+
+* Forward keyword arguments from slot wrapper to component instance.
+
+    *Cameron Dutro*
+
+## 2.40.0
+
+* Replace antipatterns section in the documentation with best practices.
+
+    *Blake Williams*
+
+* Add components to `rails stats` task.
+
+    *Nicolas Brousse*
+
+* Fix bug when using Slim and writing a slot whose block evaluates to `nil`.
+
+    *Yousuf Jukaku*
+
+* Add documentation for test helpers.
+
+    *Joel Hawksley*
+
+## 2.39.0
+
+* Clarify documentation of `with_variant` as an override of Action Pack.
+
+    *Blake Williams*, *Cameron Dutro*, *Joel Hawksley*
+
+* Update docs page to be called Javascript and CSS, rename Building ViewComponents to Guide.
+
+    *Joel Hawksley*
+
+* Deprecate `Base#with_variant`.
+
+    *Cameron Dutro*
+
+* Error out in the CI if docs/api.md has to be regenerated.
+
+    *Dany Marcoux*
+
+## 2.38.0
+
+* Add `--stimulus` flag to the component generator. Generates a Stimulus controller alongside the component.
+* Add config option `config.view_component.generate_stimulus_controller` to always generate a Stimulus controller.
+
+    *Sebastien Auriault*
+
 ## 2.37.0
 
 * Clarify slots example in docs to reduce naming confusion.
@@ -19,7 +101,7 @@ title: Changelog
 
 * Add test case for conflict with internal `@variant` variable.
 
-   *David Backeus*
+    *David Backeus*
 
 * Document decision to not change naming convention recommendation to remove `-Component` suffix.
 
@@ -83,7 +165,7 @@ title: Changelog
 
 * Ensure consistent indentation with Rubocop.
 
-    *Joel Hawksley
+    *Joel Hawksley*
 
 * Bump `activesupport` upper bound from `< 7.0` to `< 8.0`.
 

data/lib/rails/generators/abstract_generator.rb

@@ -11,13 +11,21 @@ module ViewComponent
     private
 
     def destination
+      File.join(destination_directory, "#{destination_file_name}.html.#{engine_name}")
+    end
+
+    def destination_directory
       if options["sidecar"]
-        File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component.html.#{engine_name}")
+        File.join(component_path, class_path, destination_file_name)
       else
-        File.join(component_path, class_path, "#{file_name}_component.html.#{engine_name}")
+        File.join(component_path, class_path)
       end
     end
 
+    def destination_file_name
+      "#{file_name}_component"
+    end
+
     def file_name
       @_file_name ||= super.sub(/_component\z/i, "")
     end
@@ -25,5 +33,14 @@ module ViewComponent
     def component_path
       ViewComponent::Base.view_component_path
     end
+
+    def stimulus_controller
+      if options["stimulus"]
+        File.join(destination_directory, destination_file_name).
+          sub("#{component_path}/", "").
+          gsub("_", "-").
+          gsub("/", "--")
+      end
+    end
   end
 end

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

@@ -12,6 +12,9 @@ module Rails
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "Component"
       class_option :inline, type: :boolean, default: false
+      class_option :parent, type: :string, desc: "The parent class for the generated component"
+      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate_stimulus_controller
+      class_option :sidecar, type: :boolean, default: false
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -21,6 +24,8 @@ module Rails
 
       hook_for :preview, type: :boolean
 
+      hook_for :stimulus, type: :boolean
+
       hook_for :template_engine do |instance, template_engine|
         instance.invoke template_engine, [instance.name]
       end
@@ -28,7 +33,9 @@ module Rails
       private
 
       def parent_class
-        defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base"
+        return options[:parent] if options[:parent]
+
+        ViewComponent::Base.component_parent_class || default_parent_class
       end
 
       def initialize_signature
@@ -44,6 +51,10 @@ module Rails
       def initialize_call_method_for_inline?
         options["inline"]
       end
+
+      def default_parent_class
+        defined?(ApplicationComponent) ? ApplicationComponent : ViewComponent::Base
+      end
     end
   end
 end

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

@@ -8,7 +8,7 @@ class <%= class_name %>Component < <%= parent_class %>
 <%- end -%>
 <%- if initialize_call_method_for_inline? -%>  
   def call
-    content_tag :h1, "Hello world!"
+    content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
   end
 <%- end -%>
 

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

@@ -11,6 +11,7 @@ module Erb
       source_root File.expand_path("templates", __dir__)
       class_option :sidecar, type: :boolean, default: false
       class_option :inline, type: :boolean, default: false
+      class_option :stimulus, type: :boolean, default: false
 
       def engine_name
         "erb"
@@ -19,6 +20,14 @@ module Erb
       def copy_view_file
         super
       end
+
+      private
+
+      def data_attributes
+        if options["stimulus"]
+          " data-controller=\"#{stimulus_controller}\""
+        end
+      end
     end
   end
 end

data/lib/rails/generators/erb/templates/component.html.erb.tt

@@ -1 +1 @@
-<div>Add <%= class_name %> template here</div>
+<div<%= data_attributes %>>Add <%= class_name %> template here</div>

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Stimulus
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+
+      def create_stimulus_controller
+        template "component_controller.js", destination
+      end
+
+      private
+
+      def destination
+        if options["sidecar"]
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.js")
+        else
+          File.join(component_path, class_path, "#{file_name}_component_controller.js")
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/stimulus/templates/component_controller.js.tt

@@ -0,0 +1,7 @@
+import { Controller } from "stimulus";
+
+export default class extends Controller {
+  connect() {
+    console.log("Hello, Stimulus!", this.element);
+  }
+}

data/lib/view_component/base.rb

@@ -39,29 +39,12 @@ module ViewComponent
 
     # Entrypoint for rendering components.
     #
-    # view_context: ActionView context from calling view
-    # block: optional block to be captured within the view context
+    # - `view_context`: ActionView context from calling view
+    # - `block`: optional block to be captured within the view context
     #
-    # returns HTML that has been escaped by the respective template handler
+    # Returns HTML that has been escaped by the respective template handler.
     #
-    # Example subclass:
-    #
-    # app/components/my_component.rb:
-    # class MyComponent < ViewComponent::Base
-    #   def initialize(title:)
-    #     @title = title
-    #   end
-    # end
-    #
-    # app/components/my_component.html.erb
-    # <span title="<%= @title %>">Hello, <%= content %>!</span>
-    #
-    # In use:
-    # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
-    # returns:
-    # <span title="greeting">Hello, world!</span>
-    #
-    # @private
+    # @return [String]
     def render_in(view_context, &block)
       self.class.compile(raise_errors: true)
 
@@ -218,9 +201,14 @@ module ViewComponent
 
     # Use the provided variant instead of the one determined by the current request.
     #
+    # @deprecated Will be removed in v3.0.0.
     # @param variant [Symbol] The variant to be used by the component.
     # @return [self]
     def with_variant(variant)
+      ActiveSupport::Deprecation.warn(
+        "`with_variant` is deprecated and will be removed in ViewComponent v3.0.0."
+      )
+
       @__vc_variant = variant
 
       self
@@ -278,6 +266,14 @@ module ViewComponent
     #
     mattr_accessor :show_previews_source, instance_writer: false, default: false
 
+    # Always generate a Stimulus controller alongside the component:
+    #
+    #     config.view_component.generate_stimulus_controller = true
+    #
+    # Defaults to `false`.
+    #
+    mattr_accessor :generate_stimulus_controller, instance_writer: false, default: false
+
     # Path for component files
     #
     #     config.view_component.view_component_path = "app/my_components"
@@ -285,6 +281,14 @@ module ViewComponent
     # Defaults to "app/components".
     mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
+    # Parent class for generated components
+    #
+    #     config.view_component.component_parent_class = "MyBaseComponent"
+    #
+    # Defaults to "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
+    mattr_accessor :component_parent_class,
+                   instance_writer: false
+
     class << self
       # @private
       attr_accessor :source_location, :virtual_path
@@ -371,6 +375,9 @@ module ViewComponent
           %r{(.*#{Regexp.quote(ViewComponent::Base.view_component_path)})|(\.rb)}, ""
         )
 
+        # Set collection parameter to the extended component
+        child.with_collection_parameter provided_collection_parameter
+
         super
       end
 

data/lib/view_component/engine.rb

@@ -8,6 +8,10 @@ module ViewComponent
     config.view_component = ActiveSupport::OrderedOptions.new
     config.view_component.preview_paths ||= []
 
+    rake_tasks do
+      load "view_component/rails/tasks/view_component.rake"
+    end
+
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 

data/lib/view_component/rails/tasks/view_component.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+task stats: "view_component:statsetup"
+
+namespace :view_component do
+  task statsetup: :environment do
+    require "rails/code_statistics"
+
+    ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+  end
+end

data/lib/view_component/slot_v2.rb

@@ -62,9 +62,9 @@ module ViewComponent
           view_context.capture(&@__vc_content_block)
         elsif defined?(@__vc_content_set_by_with_content)
           @__vc_content_set_by_with_content
-             end
+        end
 
-      @content
+      @content = @content.to_s
     end
 
     # Allow access to public component methods via the wrapper
@@ -86,8 +86,14 @@ module ViewComponent
     #   end
     # end
     #
-    def method_missing(symbol, *args, &block)
-      @__vc_component_instance.public_send(symbol, *args, &block)
+    if RUBY_VERSION >= "2.7.0"
+      def method_missing(symbol, *args, **kwargs, &block)
+        @__vc_component_instance.public_send(symbol, *args, **kwargs, &block)
+      end
+    else
+      def method_missing(symbol, *args, &block)
+        @__vc_component_instance.public_send(symbol, *args, &block)
+      end
     end
 
     def html_safe?

data/lib/view_component/test_helpers.rb

@@ -27,8 +27,19 @@ module ViewComponent
       # :nocov:
     end
 
+    # @private
     attr_reader :rendered_component
 
+    # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
+    # allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_inline(MyComponent.new)
+    # assert_text("Hello, World!")
+    # ```
+    #
+    # @param component [ViewComponent::Base] The instance of the component to be rendered.
+    # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
       @rendered_component =
         if Rails.version.to_f >= 6.1
@@ -40,10 +51,12 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_component)
     end
 
+    # @private
     def controller
       @controller ||= build_controller(Base.test_controller.constantize)
     end
 
+    # @private
     def request
       @request ||=
         begin
@@ -53,6 +66,15 @@ module ViewComponent
         end
     end
 
+    # Set the Action Pack request variant for the given block:
+    #
+    # ```ruby
+    # with_variant(:phone) do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param variant [Symbol] The variant to be set for the provided block.
     def with_variant(variant)
       old_variants = controller.view_context.lookup_context.variants
 
@@ -62,6 +84,16 @@ module ViewComponent
       controller.view_context.lookup_context.variants = old_variants
     end
 
+    # Set the controller to be used while executing the given block,
+    # allowing access to controller-specific methods:
+    #
+    # ```ruby
+    # with_controller_class(UsersController) do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param klass [ActionController::Base] The controller to be used.
     def with_controller_class(klass)
       old_controller = defined?(@controller) && @controller
 
@@ -71,17 +103,30 @@ module ViewComponent
       @controller = old_controller
     end
 
+    # Set the URL for the current request (such as when using request-dependent path helpers):
+    #
+    # ```ruby
+    # with_request_url("/users/42") do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param path [String] The path to set for the current request.
     def with_request_url(path)
       old_request_path_parameters = request.path_parameters
+      old_request_query_parameters = request.query_parameters
       old_controller = defined?(@controller) && @controller
 
       request.path_parameters = Rails.application.routes.recognize_path(path)
+      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_query(path.split("?")[1]))
       yield
     ensure
       request.path_parameters = old_request_path_parameters
+      request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
       @controller = old_controller
     end
 
+    # @private
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 37
+    MINOR = 41
     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.37.0
+  version: 2.41.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -226,6 +226,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -287,6 +301,8 @@ files:
 - lib/rails/generators/rspec/templates/component_spec.rb.tt
 - lib/rails/generators/slim/component_generator.rb
 - lib/rails/generators/slim/templates/component.html.slim.tt
+- lib/rails/generators/stimulus/component_generator.rb
+- lib/rails/generators/stimulus/templates/component_controller.js.tt
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
@@ -301,6 +317,7 @@ files:
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
 - lib/view_component/previewable.rb
+- lib/view_component/rails/tasks/view_component.rake
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb