view_component 3.12.1 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875f47469a83b3b70de2e4271cc4af72542d88c6e12c373c8f6912d3c8c6d13e
-  data.tar.gz: 161671b627c087f227706c10e6ca7f900dcdd3d2ea49232024543bf78a3be14b
+  metadata.gz: 7ef8c603bedd61511ed3eb2da02cd7aaccc5b890ad20badac0cfc9a3e7d4af1e
+  data.tar.gz: f756c5bd11f44e7e8984d6cb6b29ec409dc082d83864ee4bd82c50adc784310c
 SHA512:
-  metadata.gz: aaa215e2aba616eca2ea0e1bd1e4ab76df2f6f4f34d1f3f225a5802a943b8e6c8e920b3821fda06353e52979345a8d941c2d3d2eaa24b71a6928502846224acc
-  data.tar.gz: f7da13dfa835866ac685d567f41549857ca40682e6f2beee269bf07b4b9bfaf942af62d03dbcc019cb72ef349ed8c601be24c1598efd0cb38e26397decb4e09a
+  metadata.gz: 8815314944335c3b69196bf5ba8779e10ec78a3146e8cc51d4d278d5e444035c8bc50858315c45e5556337e925ab94f4afee6b3283839079db6892292bec3581
+  data.tar.gz: 42c9159369779c50a9904525239d5bf3daa62ed5373104cb11f80251b9481a8225290421d0d9a5663e9f7c7e0bd4d73c63a53bc44845dc4b5bc23a0419869301

data/docs/CHANGELOG.md

@@ -10,6 +10,62 @@ nav_order: 5
 
 ## main
 
+## 3.14.0
+
+* Defer to built-in caching for language environment setup, rather than manually using `actions/cache` in CI.
+
+    *Simon Fish*
+
+* Add test coverage for use of `turbo_stream` helpers in components when `capture_compatibility_patch_enabled` is `true`.
+
+  *Simon Fish*
+
+* Add experimental `SlotableDefault` module, allowing components to define a `default_SLOTNAME` method to provide a default value for slots.
+
+    *Joel Hawksley*
+
+* Add documentation on rendering ViewComponents outside of the view context.
+
+    *Joel Hawksley*
+
+* Look for preview files that end in `preview.rb` rather than `_preview.rb` to allow previews to exist in sidecar directory with test files.
+
+    *Seth Herr*
+
+* Add `assert_component_rendered` test helper.
+
+    *Reegan Viljoen*
+
+* Add `prefix:` option to `use_helpers`.
+
+    *Reegan Viljoen*
+
+* Add support for Rails 7.2.
+
+    *Reegan Viljoen*
+
+## 3.13.0
+
+* Add ruby head and YJIT to CI.
+
+    *Reegan Viljoen*
+
+* Fixed a bug where inline templates where unable to remove trailing whitespace without throwing an error.
+
+    *Reegan Viljoen*
+
+* Fixed CI for Rails main.
+
+    *Reegan Viljoen*
+
+* Add `from:` option to `use_helpers` to allow for more flexible helper inclusion from modules.
+
+    *Reegan Viljoen*
+
+* Fixed ruby head matcher issue.
+
+    *Reegan Viljoen*
+
 ## 3.12.1
 
 * Ensure content is rendered correctly for forwarded slots.
@@ -24,15 +80,15 @@ nav_order: 5
 
 * Fix templates not being correctly populated when caller location label has a prefix.
 
-On the upstream version of Ruby, method owners are now included in backtraces as prefixes. This caused the call stack filtering to not work as intended and thus `source_location` to be incorrect for child ViewComponents, consequently not populating templates correctly.
+  On the upstream version of Ruby, method owners are now included in backtraces as prefixes. This caused the call stack filtering to not work as intended and thus `source_location` to be incorrect for child ViewComponents, consequently not populating templates correctly.
 
     *Allan Pires, Jason Kim*
 
 * Use component path for generating RSpec files.
 
-When generating new RSpec files for components, the generator will use the `view_component_path` value in the config to decide where to put the new spec file. For instance, if the `view_component_path` option has been changed to `app/views/components`, the generator will put the spec file in `spec/views/components`. **If the `view_component_path` doesn't start with `app/`, then the generator will fall back to `spec/components/`.**
+  When generating new RSpec files for components, the generator will use the `view_component_path` value in the config to decide where to put the new spec file. For instance, if the `view_component_path` option has been changed to `app/views/components`, the generator will put the spec file in `spec/views/components`. **If the `view_component_path` doesn't start with `app/`, then the generator will fall back to `spec/components/`.**
 
-This feature is enabled via the `config.view_component.generate.use_component_path_for_rspec_tests` option, defaulting to `false`. The default will change to `true` in ViewComponent v4.
+  This feature is enabled via the `config.view_component.generate.use_component_path_for_rspec_tests` option, defaulting to `false`. The default will change to `true` in ViewComponent v4.
 
     *William Mathewson*
 
@@ -56,7 +112,7 @@ This feature is enabled via the `config.view_component.generate.use_component_pa
 
 * Include ViewComponent::UseHelpers by default.
 
-      *Reegan Viljoen*
+    *Reegan Viljoen*
 
 * Bump `puma` in Gemfile.lock.
 

data/lib/view_component/base.rb

@@ -10,6 +10,7 @@ require "view_component/errors"
 require "view_component/inline_template"
 require "view_component/preview"
 require "view_component/slotable"
+require "view_component/slotable_default"
 require "view_component/translatable"
 require "view_component/with_content_helper"
 require "view_component/use_helpers"

data/lib/view_component/compiler.rb

@@ -86,6 +86,12 @@ module ViewComponent
         define_render_template_for
       end
 
+      component_class.registered_slots.each do |slot_name, config|
+        config[:default_method] = component_class.instance_methods.find { |method_name| method_name == :"default_#{slot_name}" }
+
+        component_class.registered_slots[slot_name] = config
+      end
+
       component_class.build_i18n_backend
 
       CompileCache.register(component_class)
@@ -247,9 +253,9 @@ module ViewComponent
 
     def compiled_inline_template(template)
       handler = ActionView::Template.handler_for_extension(template.language)
-      template.rstrip! if component_class.strip_trailing_whitespace?
+      template = template.source.dup
 
-      compile_template(template.source, handler)
+      compile_template(template, handler)
     end
 
     def compiled_template(file_path)

data/lib/view_component/instrumentation.rb

@@ -16,7 +16,7 @@ module ViewComponent # :nodoc:
           identifier: self.class.identifier
         }
       ) do
-        super(view_context, &block)
+        super
       end
     end
 

data/lib/view_component/preview.rb

@@ -102,7 +102,7 @@ module ViewComponent # :nodoc:
 
       def load_previews
         Array(preview_paths).each do |preview_path|
-          Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
+          Dir["#{preview_path}/**/*preview.rb"].sort.each { |file| require_dependency file }
         end
       end
 

data/lib/view_component/slotable.rb

@@ -266,10 +266,7 @@ module ViewComponent
       end
 
       def define_slot(slot_name, collection:, callable:)
-        # Setup basic slot data
-        slot = {
-          collection: collection
-        }
+        slot = {collection: collection}
         return slot unless callable
 
         # If callable responds to `render_in`, we set it on the slot as a renderable

data/lib/view_component/slotable_default.rb

@@ -0,0 +1,20 @@
+module ViewComponent
+  module SlotableDefault
+    def get_slot(slot_name)
+      @__vc_set_slots ||= {}
+
+      return super unless !@__vc_set_slots[slot_name] && (default_method = registered_slots[slot_name][:default_method])
+
+      renderable_value = send(default_method)
+      slot = Slot.new(self)
+
+      if renderable_value.respond_to?(:render_in)
+        slot.__vc_component_instance = renderable_value
+      else
+        slot.__vc_content = renderable_value
+      end
+
+      slot
+    end
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -14,6 +14,10 @@ module ViewComponent
       def refute_component_rendered
         assert_no_selector("body")
       end
+
+      def assert_component_rendered
+        assert_selector("body")
+      end
     rescue LoadError
       # We don't have a test case for running an application without capybara installed.
       # It's probably fine to leave this without coverage.

data/lib/view_component/use_helpers.rb

@@ -4,17 +4,39 @@ module ViewComponent::UseHelpers
   extend ActiveSupport::Concern
 
   class_methods do
-    def use_helpers(*args)
-      args.each do |helper_method|
-        class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-          def #{helper_method}(*args, &block)
-            raise HelpersCalledBeforeRenderError if view_context.nil?
-            __vc_original_view_context.#{helper_method}(*args, &block)
-          end
-        RUBY
-
-        ruby2_keywords(helper_method) if respond_to?(:ruby2_keywords, true)
+    def use_helpers(*args, from: nil, prefix: false)
+      args.each { |helper_method| use_helper(helper_method, from: from, prefix: prefix) }
+    end
+
+    def use_helper(helper_method, from: nil, prefix: false)
+      helper_method_name = full_helper_method_name(helper_method, prefix: prefix, source: from)
+
+      class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        def #{helper_method_name}(*args, &block)
+          raise HelpersCalledBeforeRenderError if view_context.nil?
+
+          #{define_helper(helper_method: helper_method, source: from)}
+        end
+      RUBY
+      ruby2_keywords(helper_method_name) if respond_to?(:ruby2_keywords, true)
+    end
+
+    private
+
+    def full_helper_method_name(helper_method, prefix: false, source: nil)
+      return helper_method unless prefix.present?
+
+      if !!prefix == prefix
+        "#{source.to_s.underscore}_#{helper_method}"
+      else
+        "#{prefix}_#{helper_method}"
       end
     end
+
+    def define_helper(helper_method:, source:)
+      return "__vc_original_view_context.#{helper_method}(*args, &block)" unless source.present?
+
+      "#{source}.instance_method(:#{helper_method}).bind(self).call(*args, &block)"
+    end
   end
 end

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.12.1
+  version: 3.14.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -380,6 +380,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
@@ -530,6 +544,7 @@ files:
 - lib/view_component/rendering_monkey_patch.rb
 - lib/view_component/slot.rb
 - lib/view_component/slotable.rb
+- lib/view_component/slotable_default.rb
 - lib/view_component/system_test_case.rb
 - lib/view_component/system_test_helpers.rb
 - lib/view_component/test_case.rb
@@ -561,7 +576,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components