view_component 2.66.0 → 2.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 426a776552c0355ba0fb4ccc066c05a218b9998acb39489485375624b347c170
-  data.tar.gz: d17d69cb6e1c08fe31545eb5cf878579dd4aaf11e803790130c83ec7b4c178d2
+  metadata.gz: 89e52bd1cf26dcf9a118635445255a0b6fe11d6d66947246af1df1df8b0ae867
+  data.tar.gz: eade5ea1be098f111d221bd3028764df7749f71d7639c49ef6ac99c43276119f
 SHA512:
-  metadata.gz: 4b001cf58f8586b3e83cf8129c23d0bb5a499182189db4a99dfd747d6767f529a631eb2bf439a32f8a91dbb5861eb16ef637b514bffccacd476d577e2c5c27aa
-  data.tar.gz: 24d147cfbb226ff11114631721507bfed5a73fe25e1963186fe106a9c0f485596b65349457685967e7df0edea4d78841646f36683764244673e4281ff56741fd
+  metadata.gz: 00ab6fe377ab39bf01db8942d36b131bd04d084bc0ab594f751728f47c501eb366caff3ff108aa1acdc17380cc581131d204907b1b0f59a33b0558f043a98ab1
+  data.tar.gz: f7d7923bbad729d18d4c53c348beb60afea0375cd95fd99ba82de0be993af2153d29742533e066a2fca49fb39b836992dd437a78de8aa59789b6c751d9a8d226

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

@@ -43,12 +43,12 @@ module ViewComponent
 
     # :doc:
     def default_preview_layout
-      Rails.application.config.view_component.default_preview_layout
+      ViewComponent::Base.config.default_preview_layout
     end
 
     # :doc:
     def show_previews?
-      Rails.application.config.view_component.show_previews
+      ViewComponent::Base.config.show_previews
     end
 
     # :doc:

data/app/helpers/preview_helper.rb

@@ -22,7 +22,7 @@ module PreviewHelper
       # Fetch template source via finding it through preview paths
       # to accomodate source view when exclusively using templates
       # for previews for Rails < 6.1.
-      all_template_paths = Rails.application.config.view_component.preview_paths.map do |preview_path|
+      all_template_paths = ViewComponent::Base.config.preview_paths.map do |preview_path|
         Dir.glob("#{preview_path}/**/*")
       end.flatten
 

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

@@ -1,5 +1,5 @@
 <% if @render_args[:component] %>
-  <% if Rails.application.config.view_component.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if ViewComponent::Base.config.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
     <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
   <% else %>
     <%= render_component(@render_args[:component], &@render_args[:block]) %>
@@ -8,6 +8,6 @@
   <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
-<% if Rails.application.config.view_component.show_previews_source %>
+<% if ViewComponent::Base.config.show_previews_source %>
   <%= preview_source %>
 <% end %>

data/docs/CHANGELOG.md

@@ -9,6 +9,24 @@ title: Changelog
 
 ## main
 
+## 2.67.0
+
+* Use ViewComponent::Base.config as the internal endpoint for config.
+
+    *Simon Fish*
+
+* Fix bug where `#with_request_url`, when used with query string, set the incorrect `request.path` and `request.fullpath`.
+
+    *Franz Liedke*
+
+* Add link to [ViewComponentAttributes](https://github.com/amba-Health/view_component_attributes) in Resources section of docs.
+
+    *Romaric Pascal*
+
+* `render_preview` test helper is available by default. It is no longer necessary to include `ViewComponent::RenderPreviewHelper`.
+
+    *Joel Hawksley*
+
 ## 2.66.0
 
 * Add missing `generate.sidecar`, `generate.stimulus_controller`, `generate.locale`, `generate.distinct_locale_files`, `generate.preview` config options to `config.view_component`.

data/lib/rails/generators/abstract_generator.rb

@@ -29,7 +29,7 @@ module ViewComponent
     end
 
     def component_path
-      Rails.application.config.view_component.view_component_path
+      ViewComponent::Base.config.view_component_path
     end
 
     def stimulus_controller
@@ -42,7 +42,7 @@ module ViewComponent
     end
 
     def sidecar?
-      options["sidecar"] || Rails.application.config.view_component.generate.sidecar
+      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
     end
   end
 end

data/lib/rails/generators/component/component_generator.rb

@@ -13,12 +13,12 @@ module Rails
       check_class_collision suffix: "Component"
 
       class_option :inline, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: Rails.application.config.view_component.generate.locale
+      class_option :locale, type: :boolean, default: ViewComponent::Base.config.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: Rails.application.config.view_component.generate.preview
+      class_option :preview, type: :boolean, default: ViewComponent::Base.config.generate.preview
       class_option :sidecar, type: :boolean, default: false
       class_option :stimulus, type: :boolean,
-        default: Rails.application.config.view_component.generate.stimulus_controller
+        default: ViewComponent::Base.config.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -41,7 +41,7 @@ module Rails
       def parent_class
         return options[:parent] if options[:parent]
 
-        Rails.application.config.view_component.component_parent_class || default_parent_class
+        ViewComponent::Base.config.component_parent_class || default_parent_class
       end
 
       def initialize_signature

data/lib/rails/generators/locale/component_generator.rb

@@ -12,7 +12,7 @@ module Locale
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if Rails.application.config.view_component.generate.distinct_locale_files
+        if ViewComponent::Base.config.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

data/lib/rails/generators/preview/component_generator.rb

@@ -9,7 +9,7 @@ module Preview
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        preview_paths = Rails.application.config.view_component.preview_paths
+        preview_paths = ViewComponent::Base.config.preview_paths
         return if preview_paths.count > 1
 
         path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"

data/lib/view_component/base.rb

@@ -18,7 +18,7 @@ module ViewComponent
       delegate(*ViewComponent::Config.defaults.keys, to: :config)
 
       def config
-        Rails.application.config.view_component
+        @config ||= ViewComponent::Config.defaults
       end
     end
 
@@ -496,7 +496,7 @@ module ViewComponent
 
         # Removes the first part of the path and the extension.
         child.virtual_path = child.source_location.gsub(
-          /(.*#{Regexp.quote(Rails.application.config.view_component.view_component_path)})|(\.rb)/, ""
+          /(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
         )
 
         # Set collection parameter to the extended component

data/lib/view_component/engine.rb

@@ -5,7 +5,7 @@ require "view_component/base"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.view_component = ViewComponent::Config.default
+    config.view_component = ViewComponent::Base.config
 
     rake_tasks do
       load "view_component/rails/tasks/view_component.rake"

data/lib/view_component/test_helpers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "view_component/render_preview_helper"
-
 module ViewComponent
   module TestHelpers
     begin
@@ -67,6 +65,47 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_content)
     end
 
+    # Render a preview inline. Internally sets `page` to be a `Capybara::Node::Simple`,
+    # allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_preview(:default)
+    # assert_text("Hello, World!")
+    # ```
+    #
+    # Note: `#rendered_preview` expects a preview to be defined with the same class
+    # name as the calling test, but with `Test` replaced with `Preview`:
+    #
+    # MyComponentTest -> MyComponentPreview etc.
+    #
+    # In RSpec, `Preview` is appended to `described_class`.
+    #
+    # @param preview [String] The name of the preview to be rendered.
+    # @return [Nokogiri::HTML]
+    def render_preview(name)
+      begin
+        preview_klass = if respond_to?(:described_class)
+          raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
+
+          "#{described_class}Preview"
+        else
+          self.class.name.gsub("Test", "Preview")
+        end
+        preview_klass = preview_klass.constantize
+      rescue NameError
+        raise NameError, "`render_preview` expected to find #{preview_klass}, but it does not exist."
+      end
+
+      previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
+      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
+      previews_controller.response = ActionDispatch::Response.new
+      result = previews_controller.previews
+
+      @rendered_content = result
+
+      Nokogiri::HTML.fragment(@rendered_content)
+    end
+
     # Execute the given block in the view context. Internally sets `page` to be a
     # `Capybara::Node::Simple`, allowing for Capybara assertions to be used:
     #
@@ -151,10 +190,11 @@ module ViewComponent
       old_request_query_string = request.query_string
       old_controller = defined?(@controller) && @controller
 
+      path, query = path.split("?", 2)
       request.path_info = path
       request.path_parameters = Rails.application.routes.recognize_path(path)
-      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(path.split("?")[1]))
-      request.set_header(Rack::QUERY_STRING, path.split("?")[1])
+      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
+      request.set_header(Rack::QUERY_STRING, query)
       yield
     ensure
       request.path_info = old_request_path_info

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.66.0
+  version: 2.67.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -371,7 +371,6 @@ files:
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb
-- lib/view_component/render_preview_helper.rb
 - lib/view_component/render_to_string_monkey_patch.rb
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb

data/lib/view_component/render_preview_helper.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module RenderPreviewHelper
-    # Render a preview inline. Internally sets `page` to be a `Capybara::Node::Simple`,
-    # allowing for Capybara assertions to be used:
-    #
-    # ```ruby
-    # render_preview(:default)
-    # assert_text("Hello, World!")
-    # ```
-    #
-    # Note: `#rendered_preview` expects a preview to be defined with the same class
-    # name as the calling test, but with `Test` replaced with `Preview`:
-    #
-    # MyComponentTest -> MyComponentPreview etc.
-    #
-    # In RSpec, `Preview` is appended to `described_class`.
-    #
-    # @param preview [String] The name of the preview to be rendered.
-    # @return [Nokogiri::HTML]
-    def render_preview(name)
-      begin
-        preview_klass = if respond_to?(:described_class)
-          raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
-
-          "#{described_class}Preview"
-        else
-          self.class.name.gsub("Test", "Preview")
-        end
-        preview_klass = preview_klass.constantize
-      rescue NameError
-        raise NameError, "`render_preview` expected to find #{preview_klass}, but it does not exist."
-      end
-
-      previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
-      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
-      previews_controller.response = ActionDispatch::Response.new
-      result = previews_controller.previews
-
-      @rendered_content = result
-
-      Nokogiri::HTML.fragment(@rendered_content)
-    end
-  end
-end