view_component 2.36.0 → 2.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74a9bb65a4c364b86c92249805629eb7dc5d7dad010e6743a461cd668d6897f3
-  data.tar.gz: ab5bf1fa266b729faebf8bed8b8884300a8fca4462d4ab8a0c6a0dce32153a26
+  metadata.gz: a6b59c1dbd53f3cb893d36ca15cb6838e6b127a36c895d2e062f961929f03bb9
+  data.tar.gz: b32e3ecaa9f9734eded75141a75baeaa4396652e475827ff9db29dcf647e36c7
 SHA512:
-  metadata.gz: eae497c864c6005b6ec9cea9073d2659b5378e0f0ebde82397a7e8a09e834525293f6b1a25a615198a28ae9ccfc077505c0bdb35def7cbea69aeaa3472dba7a3
-  data.tar.gz: b11a86583fb7886828690d0d9d57ec9db3bf0f99b40f5cc0de5bb8fb6ca54ffd8e6fb65e150cdd2865c8cd71d46e13e9d7adbd3bd846d5ba5996a0a3c4ebf7d0
+  metadata.gz: e1e2312bb9dda96f1f52d6fa513514e461b2c3f9880ffa8321fcba69aabeaf1d87fc5199a7cf190c2596184051c0db30539b4600dbe2a15b5a560f76dc04240f
+  data.tar.gz: fc65722d4b20457c22de5d0603b80b171777c18bbae19c579f841b4aa092e6feb8e821da8832b6c2fb283d6a2fbca8929967f379b96d68d8ad94c8b171fa2293

data/docs/CHANGELOG.md

@@ -7,6 +7,83 @@ title: Changelog
 
 ## main
 
+## 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.
+
+    *Joel Hawksley*, *Blake Williams*
+
+* Fix error in documentation for `render_many` passthrough slots.
+
+    *Ollie Nye*
+
+* Add test case for conflict with internal `@variant` variable.
+
+   *David Backeus*
+
+* Document decision to not change naming convention recommendation to remove `-Component` suffix.
+
+    *Joel Hawksley*
+
+* Fix typo in documentation.
+
+    *Ryo.gift*
+
+* Add inline template example to benchmark script.
+
+    *Andrew Tait*
+
+* Fix benchmark scripts.
+
+    *Andrew Tait*
+
+* Run benchmarks in CI.
+
+    *Joel Hawksley*
+
 ## 2.36.0
 
 * Add `slot_type` helper method.

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,8 @@ module Rails
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "Component"
       class_option :inline, type: :boolean, default: false
+      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 +23,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

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

@@ -218,9 +218,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 +283,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"

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

@@ -64,7 +64,7 @@ module ViewComponent
           @__vc_content_set_by_with_content
              end
 
-      @content
+      @content = @content.to_s
     end
 
     # Allow access to public component methods via the wrapper

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,6 +103,15 @@ 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_controller = defined?(@controller) && @controller
@@ -82,6 +123,7 @@ module ViewComponent
       @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 = 36
+    MINOR = 40
     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.36.0
+  version: 2.40.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -287,6 +287,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 +303,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