view_component 3.21.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24be9824d2f5208831e8de57930415019c781a1245224659efb9258372dcafbc
-  data.tar.gz: 33182c814b14959c85370e274619a3da70ea19906dd40c8d0be0cd12c9f16a2b
+  metadata.gz: b6afc3fe994c0954654d58d797e36d274013494e6caec61ef1b5535a4a5a4267
+  data.tar.gz: ae921110a568f5e212b0c2d60cf31bf4ac7628b961a65cde871577f13fddee60
 SHA512:
-  metadata.gz: 0d856adb4c86acc808277c7fcc17291b41328b932b53991db003dccab6e23f2a02177e200065e78d3004f8233df98b0926202138b8b536f67c8f848f876231e2
-  data.tar.gz: a7c6b583fd6eaf4bdb20cdc9d7ca86ed0a5e818e90d1099c5fd799d2127122c058d5d58285251ea0713aeb73d719cabad8ab971e994e0f658767235089953dfd
+  metadata.gz: 240679c690a13c69669173be5c076271e1a2f0f02dfabfc2bdbfa49c0b03cbd7456e88204c84be3e7b85c703c606270b3c794f47f845d3062c6a9f620fda9da2
+  data.tar.gz: da6b4298a67311608e1641c5ace24e321e6270fb67921f2bb6f70cce9dedb7f53b2ea8006acb193775ce4d4f6a963338f310d754bc95aac6c793a9b52abddf62

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

@@ -10,6 +10,46 @@ nav_order: 5
 
 ## main
 
+## 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 +258,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,10 @@ module ViewComponent
       #
       # @return [ActiveSupport::OrderedOptions]
       def config
+        module_parents.each do |m|
+          config = m.try(:config).try(:view_component)
+          return config if config
+        end
         ViewComponent::Config.current
       end
     end

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/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 = 22
     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.22.0
 platform: ruby
 authors:
 - ViewComponent Team
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,16 +47,16 @@ dependencies:
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.3.4
 - !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: []
@@ -598,6 +609,7 @@ 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
@@ -633,7 +645,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 +659,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.2
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.