view_component 3.21.0 → 3.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24be9824d2f5208831e8de57930415019c781a1245224659efb9258372dcafbc
-  data.tar.gz: 33182c814b14959c85370e274619a3da70ea19906dd40c8d0be0cd12c9f16a2b
+  metadata.gz: 6d542616afad25462cb50efaacaaf191bfc59fdff6aa54132536fc5f9baaa13f
+  data.tar.gz: 8f229412d38d65593a377a215923828772a2c2a75e3f2786dcac35ba9d778932
 SHA512:
-  metadata.gz: 0d856adb4c86acc808277c7fcc17291b41328b932b53991db003dccab6e23f2a02177e200065e78d3004f8233df98b0926202138b8b536f67c8f848f876231e2
-  data.tar.gz: a7c6b583fd6eaf4bdb20cdc9d7ca86ed0a5e818e90d1099c5fd799d2127122c058d5d58285251ea0713aeb73d719cabad8ab971e994e0f658767235089953dfd
+  metadata.gz: '082d994fdaf93ec868207edc94d51bd36f873f8601da1ee9ee9aeaf28dc40cfa17da79625d60c15caeb4bc86079e22aa791e16c8db052cb5e5ce4a81df7e5594'
+  data.tar.gz: 8ddf8b136dc0b14492493609fb6a0f0206865eeca43149eaceb4255c3adf85dd5e6cfd4f75ab4393d0f8e233bd7c06a455ae7c28644a5f9870b76a04c29ef03b

data/app/controllers/concerns/view_component/preview_actions.rb

@@ -14,7 +14,14 @@ module ViewComponent
 
       # Including helpers here ensures that we're loading the
       # latest version of helpers if code-reloading is enabled
-      helper :all if include_all_helpers
+      if include_all_helpers
+        helper :all
+      else
+        # :nocov:
+        # Always provide the #view_source helper
+        helper PreviewHelper
+        # :nocov:
+      end
     end
 
     def index

data/app/helpers/preview_helper.rb

@@ -22,7 +22,7 @@ module PreviewHelper
     serve_static_preview_assets? ? asset_path("prism.min.js", skip_pipeline: true) : "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/prism.min.js"
   end
 
-  def find_template_data(lookup_context:, template_identifier:)
+  def find_template_data_for_preview_source(lookup_context:, template_identifier:)
     template = lookup_context.find_template(template_identifier)
 
     if Rails.version.to_f >= 6.1 || template.source.present?

data/app/views/view_components/_preview_source.html.erb

@@ -7,7 +7,7 @@
         <%= h @preview.preview_source(@example_name) %>
       </code>
     <% else %>
-      <% template_data = find_template_data(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
+      <% template_data = find_template_data_for_preview_source(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
       <code class="language-<%= template_data[:prism_language_name] %>">
         <%= h template_data[:source] %>
       </code>

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,76 @@ nav_order: 5
 
 ## main
 
+## 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`.
+
+    *Phil Schalm*, *Joel Hawksley*
+
+* Add unused mechanism for inheriting config from parent modules to enable future engine-local configuration.
+
+    *Simon Fish*
+
+* Improve handling of malformed component edge case when mocking components in tests.
+
+    *Martin Meyerhoff*, *Joel Hawksley*
+
+* Add Content Harmony & Learn To Be to list of companies using ViewComponent.
+
+    *Kane Jamison*
+
+* Clarify error message about render-dependent logic.
+
+  Error messages about render-dependent logic were sometimes inaccurate, saying `during initialization` despite also being raised after a component had been initialized but before it was rendered.
+
+    *Joel Hawksley*
+
+* Remove JS and CSS docs as they proved difficult to maintain and lacked consensus.
+
+    *Joel Hawksley*
+
+* Do not prefix release tags with `v`, per recommendation from @bkuhlmann.
+
+    *Joel Hawksley*
+
+* Add ruby 3.4 support to CI.
+
+    *Reegan Viljoen*
+
+* Add HomeStyler AI to list of companies using ViewComponent.
+
+    *JP Balarini*
+
 ## 3.21.0
 
 * Updates testing docs to include an example of how to use with RSpec.
@@ -218,6 +288,10 @@ nav_order: 5
 
     *Reegan Viljoen*
 
+* Fix a bug where component previews would crash with "undefined local variable or method `preview_source`."
+
+    *Henning Koch*
+
 ## 3.12.1
 
 * Ensure content is rendered correctly for forwarded slots.

data/lib/view_component/base.rb

@@ -25,6 +25,11 @@ module ViewComponent
       #
       # @return [ActiveSupport::OrderedOptions]
       def 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
     end
@@ -191,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
@@ -247,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/configurable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Configurable
+    extend ActiveSupport::Concern
+
+    included do
+      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:test_controller)
+
+      include ActiveSupport::Configurable
+
+      configure do |config|
+        config.view_component ||= ActiveSupport::InheritableOptions.new
+      end
+    end
+  end
+end

data/lib/view_component/errors.rb

@@ -177,7 +177,7 @@ module ViewComponent
 
   class TranslateCalledBeforeRenderError < BaseError
     MESSAGE =
-      "`#translate` can't be used during initialization as it depends " \
+      "`#translate` can't be used before rendering as it depends " \
       "on the view context that only exists once a ViewComponent is passed to " \
       "the Rails render pipeline.\n\n" \
       "It's sometimes possible to fix this issue by moving code dependent on " \
@@ -186,7 +186,7 @@ module ViewComponent
 
   class HelpersCalledBeforeRenderError < BaseError
     MESSAGE =
-      "`#helpers` can't be used during initialization as it depends " \
+      "`#helpers` can't be used before rendering as it depends " \
       "on the view context that only exists once a ViewComponent is passed to " \
       "the Rails render pipeline.\n\n" \
       "It's sometimes possible to fix this issue by moving code dependent on " \
@@ -195,7 +195,7 @@ module ViewComponent
 
   class ControllerCalledBeforeRenderError < BaseError
     MESSAGE =
-      "`#controller` can't be used during initialization, as it depends " \
+      "`#controller` can't be used before rendering, as it depends " \
       "on the view context that only exists once a ViewComponent is passed to " \
       "the Rails render pipeline.\n\n" \
       "It's sometimes possible to fix this issue by moving code dependent on " \

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/template.rb

@@ -63,8 +63,8 @@ module ViewComponent
       return safe_method_name unless inline_call?
 
       "maybe_escape_html(#{safe_method_name}) " \
-      "{ Kernel.warn('WARNING: The #{@component} component rendered HTML-unsafe output. " \
-      "The output will be automatically escaped, but you may want to investigate.') } "
+      "{ Kernel.warn(\"WARNING: The #{@component} component rendered HTML-unsafe output. " \
+      "The output will be automatically escaped, but you may want to investigate.\") } "
     end
 
     def requires_compiled_superclass?

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 21
+    MINOR = 23
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.21.0
+  version: 3.23.0
 platform: ruby
 authors:
 - ViewComponent Team
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,14 +49,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: allocation_stats
   requirement: !ruby/object:Gem::Requirement
@@ -548,8 +547,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -569,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
@@ -598,15 +598,13 @@ files:
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
 - 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
 - lib/view_component/instrumentation.rb
 - lib/view_component/preview.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
@@ -625,7 +623,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
@@ -633,7 +630,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://github.com/viewcomponent/view_component
   changelog_uri: https://github.com/ViewComponent/view_component/blob/main/docs/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -648,8 +644,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+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/view_component/rails/tasks/view_component.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-task stats: "view_component:statsetup"
-
-namespace :view_component do
-  task :statsetup do
-    # :nocov:
-    require "rails/code_statistics"
-
-    if Rails.root.join(ViewComponent::Base.view_component_path).directory?
-      ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
-    end
-
-    if Rails.root.join("test/components").directory?
-      ::STATS_DIRECTORIES << ["ViewComponent tests", "test/components"]
-      CodeStatistics::TEST_TYPES << "ViewComponent tests"
-    end
-    # :nocov:
-  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