view_component 2.44.0 → 2.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2542c18f4fbd3071c18fb27d8edb563021ad201fa5cc4d0c02fb8190918b6920
-  data.tar.gz: 7c7fb2ef2a79ed3816655cd8f27a52248fe0181957487a9b0297968914034c9f
+  metadata.gz: a209f06f513d226dba5ddcfefe8c08d16f84da6d8664fd9a4f2f70fe1ef48d96
+  data.tar.gz: cc11c7e358b6fa3b07474a257202be93b0283c7c6189ce8d939770a805a28ef6
 SHA512:
-  metadata.gz: 4e43d3b7398bd838b25e87a566ce82229e82343f64a9f70230b90d4eb2b0afdc8e0ffda355acd032877d0751082e3e4342ecd53955011de89ea1ce341c6b7a80
-  data.tar.gz: 3d90591c1d4d3cbff9d8e4c7dd1f94015ddce95e62f8284586dda63da99311609c3558fd353f0cf3c6b8c58f4c9a0b18f0fa91e60aa2275e57284cb2e10bff4a
+  metadata.gz: 2420eadefc54d1045c432b7b53010281bd923b556b72d4ed924b49a0a88b1841800d6e04f25bb043913f5c648693d19ad56117e441c838e7eb09e0ab5cf21315
+  data.tar.gz: 4deb4c925810fcc2e3918e8735dd957003536e5533289d48caf69100dcb5ed58af6bb7af88fdc0cdf3c73e9905bb0222de18d9fd6cba65ca05e6bc3ed1f9964f

data/docs/CHANGELOG.md

@@ -7,6 +7,44 @@ title: Changelog
 
 ## main
 
+## 2.45.0
+
+* Remove internal APIs from API documentation, fix link to license.
+
+    *Joel Hawksley*
+
+* Add @yhirano55 to triage team.
+
+    *Joel Hawksley*
+
+* Correct a typo in the sample slots code.
+
+    *Simon Fish*
+
+* Add note about `allowed_queries`.
+
+    *Joel Hawksley*
+
+* Add `vale` content linter.
+
+    *Joel Hawksley*
+
+* Remove `require "rails/generators/test_case"` in generator tests.
+
+    *Yoshiyuki Hirano*
+
+* Suppress zeitwerk warning about circular require.
+
+    *Yoshiyuki Hirano*
+
+* Move `test_unit_generator_test.rb` from `test/view_component/` to `test/generators/`.
+
+    *Yoshiyuki Hirano*
+
+* Unify test code of `TestUnitGeneratorTest` with the other generators tests.
+
+    *Yoshiyuki Hirano*
+
 ## 2.44.0
 
 * Rename internal accessor to use private naming.
@@ -142,7 +180,7 @@ title: Changelog
 
     *Matthew Rider*
 
-* Fix bug where `with_collection_parameter` did not inherit from parent component.
+* Fix bug where `with_collection_parameter` didn't inherit from parent component.
 
     *Will Drexler*, *Christian Campoli*
 
@@ -346,7 +384,7 @@ title: Changelog
 
     *Hans Lemuet*
 
-* Fix bug where ViewComponents did not work in ActionMailers.
+* Fix bug where ViewComponents didn't work in ActionMailers.
 
     *dark-panda*
 
@@ -394,7 +432,7 @@ title: Changelog
 
 ## 2.31.0
 
-_Note: This release includes an underlying change to Slots that may affect incorrect usage of the API, where Slots were set on a line prefixed by `<%=`. The result of setting a Slot should not be returned. (`<%`)_
+_Note: This release includes an underlying change to Slots that may affect incorrect usage of the API, where Slots were set on a line prefixed by `<%=`. The result of setting a Slot shouldn't be returned. (`<%`)_
 
 * Add `#with_content` to allow setting content without a block.
 
@@ -405,7 +443,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
     *Mario Schüttel*
 
 * Improve feature parity with Rails translations
-  * Don't create a translation backend if the component has no translation file
+  * Don't create a translation back end if the component has no translation file
   * Mark translation keys ending with `html` as HTML-safe
   * Always convert keys to String
   * Support multiple keys
@@ -447,7 +485,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Alex Robbin, Blake Williams*
 
-* Experimental: call `._sidecar_files` to fetch the sidecar files for a given list of extensions, e.g. passing `["yml", "yaml"]`.
+* Experimental: call `._sidecar_files` to fetch the sidecar files for a given list of extensions, for example passing `["yml", "yaml"]`.
 
     *Elia Schito*
 
@@ -487,11 +525,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.26.0
 
-* Lazily evaluate component `content` in `render?`, preventing the `content` block from being evaluated when `render?` returns false.
+* Delay evaluating component `content` in `render?`, preventing the `content` block from being evaluated when `render?` returns false.
 
     *Blake Williams*
 
-* Do not generate template when using `--inline` flag.
+* Don't generate template when using `--inline` flag.
 
     *Hans Lemuet*
 
@@ -552,7 +590,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
   * `with_slot collection: true` becomes `renders_many`.
   * Slot definitions now accept either a component class, component class name, or a lambda instead of a `class_name:` keyword argument.
   * Slots now support positional arguments.
-  * Slots no longer use the `content` attribute to render content, instead relying on `to_s`. e.g. `<%= my_slot %>`.
+  * Slots no longer use the `content` attribute to render content, instead relying on `to_s`. for example `<%= my_slot %>`.
   * Slot values are no longer set via the `slot` method, and instead use the name of the slot.
 
     *Blake Williams*
@@ -615,7 +653,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.18.2
 
-* Raise an error if controller or view context is accessed during initialize as they are only available in render.
+* Raise an error if controller or view context is accessed during initialize as they're only available in render.
 
     *Julian Nadeau*
 
@@ -631,7 +669,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.18.0
 
-* Fix auto-loading of previews (changes no longer require a server restart)
+* Fix auto loading of previews (changes no longer require a server restart)
 
     *Matt Brictson*
 
@@ -724,7 +762,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.10.0
 
-* Raise an `ArgumentError` with a helpful message when Ruby cannot parse a component class.
+* Raise an `ArgumentError` with a helpful message when Ruby can't parse a component class.
 
     *Max Beizer*
 
@@ -816,7 +854,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## v2.2.1
 
-* Fix bug where template could not be found if `inherited` was redefined.
+* Fix bug where template couldn't be found if `inherited` was redefined.
 
     *Joel Hawksley*
 
@@ -832,7 +870,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## v2.1.0
 
-* Support rendering collections (e.g., `render(MyComponent.with_collection(@items))`).
+* Support rendering collections (for example, `render(MyComponent.with_collection(@items))`).
 
     *Tim Clem*
 
@@ -854,7 +892,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Andrew Mason*
 
-* ViewComponent generators do not not prompt for content requirement.
+* ViewComponent generators don't not prompt for content requirement.
 
     *Joel Hawksley*
 
@@ -976,7 +1014,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Jon Palmer*
 
-* Add `#render?` hook to easily allow components to be no-ops.
+* Add `#render?` hook to allow components to be no-ops.
 
     *Kyle Fox*
 
@@ -1044,7 +1082,9 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Fix edge case issue with extracting variants from less conventional source_locations.
 
+<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman*
+<!-- vale proselint.GenderBias = YES -->
 
 ## v1.6.0
 
@@ -1080,7 +1120,9 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Add support for RSpec to generators.
 
+<!-- vale proselint.GenderBias = NO -->
     *Dylan Clark, Ryan Workman*
+<!-- vale proselint.GenderBias = YES -->
 
 * Require controllers as part of setting autoload paths.
 
@@ -1104,7 +1146,9 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
 * Fix issue with generating component method signatures.
 
+<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman, Dylan Clark*
+<!-- vale proselint.GenderBias = YES -->
 
 * Create component generator.
 
@@ -1176,7 +1220,7 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
 ## v1.3.3
 
-* Do not raise error when sidecar files that are not templates exist.
+* Don't raise error when sidecar files that aren't templates exist.
 
     *Joel Hawksley*
 

data/lib/view_component/base.rb

@@ -152,7 +152,7 @@ module ViewComponent
       if view_context.nil?
         raise(
           ViewContextCalledBeforeRenderError,
-          "`#controller` cannot be used during initialization, as it depends " \
+          "`#controller` can't be used during initialization, 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 " \
@@ -171,7 +171,7 @@ module ViewComponent
       if view_context.nil?
         raise(
           ViewContextCalledBeforeRenderError,
-          "`#helpers` cannot be used during initialization, as it depends " \
+          "`#helpers` can't be used during initialization, 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 " \
@@ -206,7 +206,7 @@ module ViewComponent
     #
     # @private
     def format
-      # Ruby 2.6 throws a warning without checking `defined?`, 2.7 does not
+      # Ruby 2.6 throws a warning without checking `defined?`, 2.7 doesn't
       if defined?(@__vc_variant)
         @__vc_variant
       end
@@ -283,7 +283,7 @@ module ViewComponent
     #
     #     config.view_component.view_component_path = "app/my_components"
     #
-    # Defaults to "app/components".
+    # Defaults to `app/components`.
     mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
     # Parent class for generated components
@@ -318,7 +318,7 @@ module ViewComponent
 
         # Add support for nested components defined in the same file.
         #
-        # e.g.
+        # for example
         #
         # class MyComponent < ViewComponent::Base
         #   class MyOtherComponent < ViewComponent::Base
@@ -431,7 +431,7 @@ module ViewComponent
       end
 
       # Ensure the component initializer accepts the
-      # collection parameter. By default, we do not
+      # collection parameter. By default, we don't
       # validate that the default parameter name
       # is accepted, as support for collection
       # rendering is optional.
@@ -442,7 +442,7 @@ module ViewComponent
         return unless parameter
         return if initialize_parameter_names.include?(parameter)
 
-        # If Ruby cannot parse the component class, then the initalize
+        # If Ruby can't parse the component class, then the initalize
         # parameters will be empty and ViewComponent will not be able to render
         # the component.
         if initialize_parameters.empty?
@@ -455,14 +455,14 @@ module ViewComponent
         end
 
         raise ArgumentError.new(
-          "The initializer for #{self} does not accept the parameter `#{parameter}`, " \
+          "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
           "which is required in order to render it as a collection.\n\n" \
           "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
           "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
         )
       end
 
-      # Ensure the component initializer does not define
+      # Ensure the component initializer doesn't define
       # invalid parameters that could override the framework's
       # methods.
       # @private TODO: add documentation
@@ -470,7 +470,7 @@ module ViewComponent
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
         raise ViewComponent::ComponentError.new(
-          "#{self} initializer cannot accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
+          "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
           "public ViewComponent method. To fix this issue, rename the parameter."
         )
       end

data/lib/view_component/compile_cache.rb

@@ -2,7 +2,7 @@
 
 module ViewComponent
   # Keeps track of which templates have already been compiled
-  # This is not part of the public API
+  # This isn't part of the public API
   module CompileCache
     mattr_accessor :cache, instance_reader: false, instance_accessor: false do
       Set.new

data/lib/view_component/compiler.rb

@@ -95,7 +95,7 @@ module ViewComponent
           errors = []
 
           if (templates + inline_calls).empty?
-            errors << "Could not find a template file or inline render method for #{component_class}."
+            errors << "Couldn't find a template file or inline render method for #{component_class}."
           end
 
           if templates.count { |template| template[:variant].nil? } > 1

data/lib/view_component/engine.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails"
-require "view_component"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
@@ -145,3 +144,7 @@ module ViewComponent
     end
   end
 end
+
+# In the case of automatic loading, "view_component" is loaded first,
+# so there is no need to load it.
+require "view_component" unless defined?(ViewComponent::Base)

data/lib/view_component/preview.rb

@@ -80,7 +80,7 @@ module ViewComponent # :nodoc:
         if preview_path.nil?
           raise(
             PreviewTemplateError,
-            "A preview template for example #{example} does not exist.\n\n" \
+            "A preview template for example #{example} doesn't exist.\n\n" \
             "To fix this issue, create a template for the example."
           )
         end

data/lib/view_component/slot_v2.rb

@@ -20,7 +20,7 @@ module ViewComponent
     # component, or a function that returns a component, we render that
     # component instance, returning the string.
     #
-    # If the slot renderable is a function and returns a string, it is
+    # If the slot renderable is a function and returns a string, it's
     # set as `@__vc_content` and is returned directly.
     #
     # If there is no slot renderable, we evaluate the block passed to
@@ -69,7 +69,7 @@ module ViewComponent
 
     # Allow access to public component methods via the wrapper
     #
-    # e.g.
+    # for example
     #
     # calling `header.name` (where `header` is a slot) will call `name`
     # on the `HeaderComponent` instance.

data/lib/view_component/slotable.rb

@@ -29,12 +29,12 @@ module ViewComponent
         )
 
         slot_names.each do |slot_name|
-          # Ensure slot_name is not already declared
+          # Ensure slot_name isn't already declared
           if self.slots.key?(slot_name)
             raise ArgumentError.new("#{slot_name} slot declared multiple times")
           end
 
-          # Ensure slot name is not :content
+          # Ensure slot name isn't :content
           if slot_name == :content
             raise ArgumentError.new ":content is a reserved slot name. Please use another name, such as ':body'"
           end
@@ -105,7 +105,7 @@ module ViewComponent
     # <% end %>
     #
     def slot(slot_name, **args, &block)
-      # Raise ArgumentError if `slot` does not exist
+      # Raise ArgumentError if `slot` doesn't exist
       unless slots.keys.include?(slot_name)
         raise ArgumentError.new "Unknown slot '#{slot_name}' - expected one of '#{slots.keys}'"
       end
@@ -140,7 +140,7 @@ module ViewComponent
         instance_variable_set(slot[:instance_variable_name], slot_instance)
       end
 
-      # Return nil, as this method should not output anything to the view itself.
+      # Return nil, as this method shouldn't output anything to the view itself.
       nil
     end
   end

data/lib/view_component/slotable_v2.rb

@@ -121,7 +121,7 @@ module ViewComponent
         singular_name = ActiveSupport::Inflector.singularize(slot_name)
 
         # Define setter for singular names
-        # e.g. `renders_many :items` allows fetching all tabs with
+        # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
         define_method singular_name do |*args, &block|
           set_slot(slot_name, nil, *args, &block)
@@ -181,7 +181,7 @@ module ViewComponent
           # If callable is a string, we assume it's referencing an internal class
           slot[:renderable_class_name] = callable
         elsif callable.respond_to?(:call)
-          # If slot does not respond to `render_in`, we assume it's a proc,
+          # If slot doesn't respond to `render_in`, we assume it's a proc,
           # define a method, and save a reference to it to call when setting
           method_name = :"_call_#{slot_name}"
           define_method method_name, &callable
@@ -256,7 +256,7 @@ module ViewComponent
       # 1. If this is a `content_area` style sub-component, we will render the
       # block via the `slot`
       #
-      # 2. Since we have to pass block content to components when calling
+      # 2. Since we've to pass block content to components when calling
       # `render`, evaluating the block here would require us to call
       # `view_context.capture` twice, which is slower
       slot.__vc_content_block = block if block_given?

data/lib/view_component/test_helpers.rb

@@ -103,7 +103,7 @@ module ViewComponent
       @controller = old_controller
     end
 
-    # Set the URL for the current request (such as when using request-dependent path helpers):
+    # Set the URL of the current request (such as when using request-dependent path helpers):
     #
     # ```ruby
     # with_request_url("/users/42") do

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 44
+    MINOR = 45
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

data/lib/view_component.rb

@@ -19,4 +19,6 @@ module ViewComponent
   autoload :Translatable
 end
 
-require "view_component/engine" if defined?(Rails::Engine)
+# In the case of manually loading, "view_component/engine" is loaded first,
+# so there is no need to load it.
+require "view_component/engine" if defined?(Rails::Engine) && !defined?(ViewComponent::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.44.0
+  version: 2.45.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport