view_component 3.22.0 → 3.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6afc3fe994c0954654d58d797e36d274013494e6caec61ef1b5535a4a5a4267
-  data.tar.gz: ae921110a568f5e212b0c2d60cf31bf4ac7628b961a65cde871577f13fddee60
+  metadata.gz: 16a94da266921e0bd3ed59abdba704b4edf68873959d74c0d3caad66d3aac082
+  data.tar.gz: 0520dc669a3c0d1bda117d7a2f1932f6f2b31726a55e44be87062c49c004cd64
 SHA512:
-  metadata.gz: 240679c690a13c69669173be5c076271e1a2f0f02dfabfc2bdbfa49c0b03cbd7456e88204c84be3e7b85c703c606270b3c794f47f845d3062c6a9f620fda9da2
-  data.tar.gz: da6b4298a67311608e1641c5ace24e321e6270fb67921f2bb6f70cce9dedb7f53b2ea8006acb193775ce4d4f6a963338f310d754bc95aac6c793a9b52abddf62
+  metadata.gz: 63ebe85255f6d35c49108590e6d939c1ea21971bfaa8bd476f5f5854073916692d602173e5f607db3aefbbc46cee3ef467232efb4c0231ca85a8c691b1a27ea5
+  data.tar.gz: 6e4cbef0047c2d3daf22f06b024bca4af0b12fdea8146f9bc1217bc27fa3d318049681b99f5e6030bf42017922fdb82ca0a1255b4aa367f43d793f9d4a0a8528

data/docs/CHANGELOG.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Changelog
-nav_order: 5
+nav_order: 6
 ---
 
 <!-- Add unreleased changes under the "main" heading. -->
@@ -10,6 +10,42 @@ nav_order: 5
 
 ## main
 
+## 3.23.1
+
+* Restore Rake tasks in published gem.
+
+    *Franz Liedke*
+
+## 3.23.0
+
+* Add docs about Slack channel in Ruby Central workspace. (Join us! #oss-view-component). Email joelhawksley@github.com for an invite.
+
+    *Joel Hawksley
+
+* Do not include internal `DocsBuilderComponent` or `YARD::MattrAccessorHandler` in published gem.
+
+    *Joel Hawksley*
+
+* Only lock to `concurrent-ruby` `1.3.4` for Rails 6.1.
+
+    *Joel Hawksley*
+
+* Fix generation of ViewComponent documentation that was broken due to HTML safety issues.
+
+    *Simon Fish*
+
+* Add documentation on how ViewComponent works.
+
+    *Joel Hawksley*
+
+* Clarify that `config.use_deprecated_instrumentation_name` will be removed in v4.
+
+    *Joel Hawksley*
+
+* Run RSpec tests in CI.
+
+    *Joel Hawksley*
+
 ## 3.22.0
 
 * Rewrite `ViewComponents at GitHub` documentation as more general `Best practices`.

data/lib/view_component/base.rb

@@ -25,9 +25,10 @@ module ViewComponent
       #
       # @return [ActiveSupport::OrderedOptions]
       def config
-        module_parents.each do |m|
-          config = m.try(:config).try(:view_component)
-          return config if config
+        module_parents.each do |module_parent|
+          next unless module_parent.respond_to?(:config)
+          module_parent_config = module_parent.config.try(:view_component)
+          return module_parent_config if module_parent_config
         end
         ViewComponent::Config.current
       end
@@ -195,6 +196,8 @@ module ViewComponent
       true
     end
 
+    # Override the ActionView::Base initializer so that components
+    # do not need to define their own initializers.
     # @private
     def initialize(*)
     end
@@ -251,7 +254,7 @@ module ViewComponent
         raise e, <<~MESSAGE.chomp if view_context && e.is_a?(NameError) && helpers.respond_to?(method_name)
           #{e.message}
 
-          You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}'?
+          You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}`?
         MESSAGE
 
         raise

data/lib/view_component/config.rb

@@ -123,7 +123,7 @@ module ViewComponent
       # @return [Boolean]
       # Whether ActiveSupport Notifications use the private name `"!render.view_component"`
       # or are made more publicly available via `"render.view_component"`.
-      # Will default to `false` in next major version.
+      # Will be removed in next major version.
       # Defaults to `true`.
 
       # @!attribute render_monkey_patch_enabled

data/lib/view_component/slotable.rb

@@ -333,7 +333,6 @@ module ViewComponent
 
       def raise_if_slot_registered(slot_name)
         if registered_slots.key?(slot_name)
-          # TODO remove? This breaks overriding slots when slots are inherited
           raise RedefinedSlotError.new(name, slot_name)
         end
       end
@@ -432,7 +431,7 @@ module ViewComponent
     def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
       slot_definition = self.class.registered_slots[slot_name]
 
-      if !slot_definition[:collection] && (defined?(@__vc_set_slots) && @__vc_set_slots[slot_name])
+      if !slot_definition[:collection] && defined?(@__vc_set_slots) && @__vc_set_slots[slot_name]
         raise ContentAlreadySetForPolymorphicSlotError.new(slot_name)
       end
 

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 22
-    PATCH = 0
+    MINOR = 23
+    PATCH = 1
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.22.0
+  version: 3.23.1
 platform: ruby
 authors:
 - ViewComponent Team
 bindir: bin
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -47,16 +47,16 @@ dependencies:
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: allocation_stats
   requirement: !ruby/object:Gem::Requirement
@@ -580,27 +580,16 @@ files:
 - app/views/view_components/previews.html.erb
 - docs/CHANGELOG.md
 - lib/rails/generators/abstract_generator.rb
-- lib/rails/generators/component/USAGE
 - lib/rails/generators/component/component_generator.rb
-- lib/rails/generators/component/templates/component.rb.tt
 - lib/rails/generators/erb/component_generator.rb
-- 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/locale/component_generator.rb
 - 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
-- 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/stimulus/templates/component_controller.ts.tt
 - lib/rails/generators/tailwindcss/component_generator.rb
-- lib/rails/generators/tailwindcss/templates/component.html.erb.tt
 - lib/rails/generators/test_unit/component_generator.rb
-- lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
 - lib/view_component/base.rb
 - lib/view_component/capture_compatibility.rb
@@ -611,8 +600,6 @@ files:
 - lib/view_component/config.rb
 - lib/view_component/configurable.rb
 - lib/view_component/deprecation.rb
-- lib/view_component/docs_builder_component.html.erb
-- lib/view_component/docs_builder_component.rb
 - lib/view_component/engine.rb
 - lib/view_component/errors.rb
 - lib/view_component/inline_template.rb
@@ -637,7 +624,6 @@ files:
 - lib/view_component/use_helpers.rb
 - lib/view_component/version.rb
 - lib/view_component/with_content_helper.rb
-- lib/yard/mattr_accessor_handler.rb
 homepage: https://viewcomponent.org
 licenses:
 - MIT
@@ -659,7 +645,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.

data/lib/rails/generators/component/USAGE

@@ -1,13 +0,0 @@
-Description:
-============
-    Creates a new component and test.
-    Pass the component name, either CamelCased or under_scored, and an optional list of attributes as arguments.
-
-Example:
-========
-    bin/rails generate component Profile name age
-
-    creates a Profile component and test:
-        Component:    app/components/profile_component.rb
-        Template:     app/components/profile_component.html.erb
-        Test:         test/components/profile_component_test.rb

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-<% module_namespacing do -%>
-class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
-<%- if initialize_signature -%>
-  def initialize(<%= initialize_signature %>)
-    <%= initialize_body %>
-  end
-<%- end -%>
-<%- if initialize_call_method_for_inline? -%>
-  def call
-    content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
-  end
-<%- end -%>
-end
-<% end -%>

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

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

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

@@ -1 +0,0 @@
-%div Add <%= class_name %> template here

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-<% module_namespacing do -%>
-class <%= class_name %>ComponentPreview < ViewComponent::Preview
-  def default
-    render(<%= class_name %>Component.new<%= "(#{render_signature})" if render_signature %>)
-  end
-end
-<% end -%>

data/lib/rails/generators/rspec/templates/component_spec.rb.tt

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "rails_helper"
-
-RSpec.describe <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>Component, type: :component do
-  pending "add some examples to (or delete) #{__FILE__}"
-
-  # it "renders something useful" do
-  #   expect(
-  #     render_inline(described_class.new(attr: "value")) { "Hello, components!" }.css("p").to_html
-  #   ).to include(
-  #     "Hello, components!"
-  #   )
-  # end
-end

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

@@ -1 +0,0 @@
-div Add <%= class_name %> template here

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

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

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

@@ -1,9 +0,0 @@
-import { Controller } from "<%= stimulus_module %>";
-
-export default class extends Controller {
-  declare element: HTMLElement;
-
-  connect() {
-    console.log("Hello, Stimulus!", this.element);
-  }
-}

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

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

data/lib/rails/generators/test_unit/templates/component_test.rb.tt

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>ComponentTest < ViewComponent::TestCase
-  def test_component_renders_something_useful
-    # assert_equal(
-    #   %(<span>Hello, components!</span>),
-    #   render_inline(<%= class_name %>Component.new(message: "Hello, components!")).css("span").to_html
-    # )
-  end
-end

data/lib/view_component/docs_builder_component.html.erb

@@ -1,22 +0,0 @@
----
-layout: default
-title: API reference
-nav_order: 3
----
-
-<!-- Warning: AUTO-GENERATED file, don't edit. Add code comments to your Ruby instead <3 -->
-
-# API
-
-<% @sections.each do |section| %>
-## <%= section.heading %>
-
-<% section.methods.each do |method| %>
-### <%== render ViewComponent::DocsBuilderComponent::MethodDoc.new(method, section.show_types) %>
-
-<% end %>
-<% section.error_klasses.each do |error_klass| %>
-### <%== render ViewComponent::DocsBuilderComponent::ErrorKlassDoc.new(error_klass, section.show_types) %>
-
-<% end %>
-<% end %>

data/lib/view_component/docs_builder_component.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  class DocsBuilderComponent < Base
-    class Section < Struct.new(:heading, :methods, :error_klasses, :show_types, keyword_init: true)
-      def initialize(heading: nil, methods: [], error_klasses: [], show_types: true)
-        methods.sort_by! { |method| method[:name] }
-        error_klasses.sort!
-        super
-      end
-    end
-
-    class ErrorKlassDoc < ViewComponent::Base
-      def initialize(error_klass, _show_types)
-        @error_klass = error_klass
-      end
-
-      def klass_name
-        @error_klass.gsub("ViewComponent::", "").gsub("::MESSAGE", "")
-      end
-
-      def error_message
-        ViewComponent.const_get(@error_klass)
-      end
-
-      def call
-        <<~DOCS.chomp
-          `#{klass_name}`
-
-          #{error_message}
-        DOCS
-      end
-    end
-
-    class MethodDoc < ViewComponent::Base
-      def initialize(method, show_types = true)
-        @method = method
-        @show_types = show_types
-      end
-
-      def deprecated?
-        @method.tag(:deprecated).present?
-      end
-
-      def suffix
-        " (Deprecated)" if deprecated?
-      end
-
-      def types
-        " → [#{@method.tag(:return).types.join(",")}]" if @method.tag(:return)&.types && @show_types
-      end
-
-      def signature_or_name
-        @method.signature ? @method.signature.gsub("def ", "") : @method.name
-      end
-
-      def separator
-        @method.sep
-      end
-
-      def docstring
-        @method.docstring
-      end
-
-      def deprecation_text
-        @method.tag(:deprecated)&.text
-      end
-
-      def docstring_and_deprecation_text
-        <<~DOCS.strip
-          #{docstring}
-
-          #{"_#{deprecation_text}_" if deprecated?}
-        DOCS
-      end
-
-      def call
-        <<~DOCS.chomp
-          `#{separator}#{signature_or_name}`#{types}#{suffix}
-
-          #{docstring_and_deprecation_text}
-        DOCS
-      end
-    end
-
-    # { heading: String, public_only: Boolean, show_types: Boolean}
-    def initialize(sections: [])
-      @sections = sections
-    end
-
-    # deprecation
-    # return
-    # only public methods
-    # sig with types or name
-  end
-end

data/lib/yard/mattr_accessor_handler.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module YARD
-  # YARD Handler to parse `mattr_accessor` calls.
-  class MattrAccessorHandler < YARD::Handlers::Ruby::Base
-    handles method_call(:mattr_accessor)
-    namespace_only
-
-    process do
-      name = statement.parameters.first.jump(:tstring_content, :ident).source
-      object = YARD::CodeObjects::MethodObject.new(namespace, name)
-      register(object)
-      parse_block(statement.last, owner: object)
-
-      object.dynamic = true
-      object[:mattr_accessor] = true
-    end
-  end
-end