view_component 2.78.0 → 2.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fbd11387f1d91c630d91d12ce292fe85f3ac95063d32cb5fef898012f098dc8
-  data.tar.gz: a54372810de68fdfe4d863437ace9a4ab9f930e4255c16d1b696053ecaae2c96
+  metadata.gz: 816041da43cddd9b2b791c005c7122781da97d7b38c068d3d587b8b66665759e
+  data.tar.gz: 4afc380c903978336d80842509d1c9082709686cb4e1361674ce1793220e7db9
 SHA512:
-  metadata.gz: a702c2c57c6763340ae79be1eb454c4d451601eb8c7007257318bfe87bd88710e53c5875e7308440008c9c32b55038d6691d58217f6f1c5390e4b643b0c91f11
-  data.tar.gz: 0d38198fe331e12a2d2b250888980d09d059dc6f1d5a392e5646ee3c834f71fb856cfd8cd4b9eaf02ce6facec836aa849fcb18af95f6239a0dc1396c96d7faf4
+  metadata.gz: 818a443353202ce4d3c63cdf3cb67ad2e1b35065f1961dac48dc5de0095331492a5ab886845f908fa7c5ca89d4ee8e02382c35973166086d3177a081720aa3c7
+  data.tar.gz: eeae1fb4978a03e2cc2da23af48bd035b43a6dc6b9408c3b5b318f45ff2a2f3b4c9f6f83386e62d8fdad802693c6a6d42b9c222c7e3974ba58a498b75cd6e78a

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

@@ -39,6 +39,12 @@ module ViewComponent
       end
     end
 
+    if Rails.env.test?
+      def system_test_entrypoint
+        render file: "./tmp/view_components/#{params.permit(:file)[:file]}"
+      end
+    end
+
     private
 
     # :doc:

data/docs/CHANGELOG.md

@@ -10,6 +10,20 @@ nav_order: 5
 
 ## main
 
+## 2.79.0
+
+* Add ability to pass explicit `preview_path` to preview generator.
+
+    *Erinna Chen*
+
+* Add `with_rendered_component_path` helper for writing component system tests.
+
+    *Edwin Mak*
+
+* Include gem name and deprecation horizon in every deprecation message.
+
+    *Jan Klimo*
+
 ## 2.78.0
 
 * Support variants with dots in their names.

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

@@ -4,15 +4,22 @@ module Preview
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
+      class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::Base.config.generate.preview_path
 
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
         preview_paths = ViewComponent::Base.config.preview_paths
-        return if preview_paths.count > 1
+        optional_path = options[:preview_path]
+        return if preview_paths.count > 1 && optional_path.blank?
+
+        path_prefix = if optional_path.present?
+          optional_path
+        else
+          preview_paths.one? ? preview_paths.first : "test/components/previews"
+        end
 
-        path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"
         template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_component_preview.rb")
       end
 

data/lib/view_component/compiler.rb

@@ -31,7 +31,7 @@ module ViewComponent
       return if component_class == ViewComponent::Base
 
       if RUBY_VERSION < "2.7.0"
-        ViewComponent::Deprecation.warn("Support for Ruby versions < 2.7.0 will be removed in v3.0.0.")
+        ViewComponent::Deprecation.deprecation_warning("Support for Ruby versions < 2.7.0")
       end
 
       component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
@@ -51,9 +51,8 @@ module ViewComponent
       end
 
       if subclass_instance_methods.include?(:before_render_check)
-        ViewComponent::Deprecation.warn(
-          "`#before_render_check` will be removed in v3.0.0.\n\n" \
-          "To fix this issue, use `#before_render` instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`before_render_check`", :"`before_render`"
         )
       end
 

data/lib/view_component/config.rb

@@ -12,7 +12,7 @@ module ViewComponent
 
       def defaults
         ActiveSupport::OrderedOptions.new.merge!({
-          generate: ActiveSupport::OrderedOptions.new(false),
+          generate: default_generate_options,
           preview_controller: "ViewComponentsController",
           preview_route: "/rails/view_components",
           show_previews_source: false,
@@ -66,6 +66,17 @@ module ViewComponent
       # Always generate a preview alongside the component:
       #
       #      config.view_component.generate.preview = true
+      #
+      # #### #preview_path
+      #
+      # Path to generate preview:
+      #
+      #      config.view_component.generate.preview_path = "test/components/previews"
+      #
+      # Required when there is more than one path defined in preview_paths.
+      # Defaults to `""`. If this is blank, the generator will use
+      # `ViewComponent.config.preview_paths` if defined,
+      # `"test/components/previews"` otherwise
 
       # @!attribute preview_controller
       # @return [String]
@@ -135,6 +146,12 @@ module ViewComponent
 
         ["#{Rails.root}/test/components/previews"]
       end
+
+      def default_generate_options
+        options = ActiveSupport::OrderedOptions.new(false)
+        options.preview_path = ""
+        options
+      end
     end
 
     def initialize
@@ -146,7 +163,7 @@ module ViewComponent
     end
 
     def preview_path=(new_value)
-      ViewComponent::Deprecation.warn("`preview_path` will be removed in v3.0.0. Use `preview_paths` instead.")
+      ViewComponent::Deprecation.deprecation_warning("`preview_path`", :"`preview_paths`")
       self.preview_paths = Array.wrap(new_value)
     end
 

data/lib/view_component/content_areas.rb

@@ -31,9 +31,8 @@ module ViewComponent
 
     class_methods do
       def with_content_areas(*areas)
-        ViewComponent::Deprecation.warn(
-          "`with_content_areas` is deprecated and will be removed in ViewComponent v3.0.0.\n\n" \
-          "Use slots (https://viewcomponent.org/guide/slots.html) instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`with_content_areas`", "use slots (https://viewcomponent.org/guide/slots.html) instead"
         )
 
         if areas.include?(:content)

data/lib/view_component/deprecation.rb

@@ -3,6 +3,6 @@
 require "active_support/deprecation"
 
 module ViewComponent
-  DEPRECATION_HORIZON = 3
-  Deprecation = ActiveSupport::Deprecation.new(DEPRECATION_HORIZON.to_s, "ViewComponent")
+  DEPRECATION_HORIZON = "3.0.0"
+  Deprecation = ActiveSupport::Deprecation.new(DEPRECATION_HORIZON, "ViewComponent")
 end

data/lib/view_component/engine.rb

@@ -121,6 +121,10 @@ module ViewComponent
             internal: true
           )
 
+          if Rails.env.test?
+            get("_system_test_entrypoint", to: "#{preview_controller}#system_test_entrypoint")
+          end
+
           get(
             "#{options.preview_route}/*path",
             to: "#{preview_controller}#previews",
@@ -141,9 +145,9 @@ end
 unless defined?(ViewComponent::Base)
   require "view_component/deprecation"
 
-  ViewComponent::Deprecation.warn(
-    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
-    'Remove `require "view_component/engine"`.'
+  ViewComponent::Deprecation.deprecation_warning(
+    "Manually loading the engine",
+    "remove `require \"view_component/engine\"`"
   )
 
   require "view_component"

data/lib/view_component/polymorphic_slots.rb

@@ -62,9 +62,9 @@ module ViewComponent
 
           define_method(setter_name) do |*args, &block|
             if _warn_on_deprecated_slot_setter
-              ViewComponent::Deprecation.warn(
-                "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in " \
-                "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
+              ViewComponent::Deprecation.deprecation_warning(
+                "Using polymorphic slot setters like `#{setter_name}`",
+                :"`with_#{setter_name}`"
               )
             end
 

data/lib/view_component/slotable.rb

@@ -23,9 +23,8 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
-        ViewComponent::Deprecation.warn(
-          "`with_slot` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
-          "Use the new slots API (https://viewcomponent.org/guide/slots.html) instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`with_slot`", "use the new slots API (https://viewcomponent.org/guide/slots.html) instead"
         )
 
         slot_names.each do |slot_name|

data/lib/view_component/slotable_v2.rb

@@ -93,10 +93,12 @@ module ViewComponent
           else
             if _warn_on_deprecated_slot_setter
               stack = caller_locations(3)
-              msg = "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
-                "Use `#with_#{slot_name}` to set the slot instead."
 
-              ViewComponent::Deprecation.warn(msg, stack)
+              ViewComponent::Deprecation.deprecation_warning(
+                "Setting a slot with `##{slot_name}`",
+                "use `#with_#{slot_name}` to set the slot instead",
+                stack
+              )
             end
 
             set_slot(slot_name, nil, *args, &block)
@@ -159,9 +161,9 @@ module ViewComponent
 
         define_method singular_name do |*args, &block|
           if _warn_on_deprecated_slot_setter
-            ViewComponent::Deprecation.warn(
-              "Setting a slot with `##{singular_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
-              "Use `#with_#{singular_name}` to set the slot instead."
+            ViewComponent::Deprecation.deprecation_warning(
+              "Setting a slot with `##{singular_name}`",
+              "use `#with_#{singular_name}` to set the slot instead"
             )
           end
 
@@ -187,9 +189,9 @@ module ViewComponent
             get_slot(slot_name)
           else
             if _warn_on_deprecated_slot_setter
-              ViewComponent::Deprecation.warn(
-                "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
-                "Use `#with_#{slot_name}` to set the slot instead."
+              ViewComponent::Deprecation.deprecation_warning(
+                "Setting a slot with `##{slot_name}`",
+                "use `#with_#{slot_name}` to set the slot instead"
               )
             end
 

data/lib/view_component/system_test_case.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ViewComponent
+  class SystemTestCase < ActionDispatch::SystemTestCase
+    include ViewComponent::SystemTestHelpers
+
+    def page
+      Capybara.current_session
+    end
+  end
+end

data/lib/view_component/system_test_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module SystemTestHelpers
+    include TestHelpers
+
+    #
+    # Returns a block that can be used to visit the path of the inline rendered component.
+    # @param fragment [Nokogiri::Fragment] The fragment returned from `render_inline`.
+    # @param layout [String] The (optional) layout to use.
+    # @return [Proc] A block that can be used to visit the path of the inline rendered component.
+    def with_rendered_component_path(fragment, layout: false, &block)
+      # Add './tmp/view_components/' directory if it doesn't exist to store the rendered component HTML
+      FileUtils.mkdir_p("./tmp/view_components/") unless Dir.exist?("./tmp/view_components/")
+
+      file = Tempfile.new(["rendered_#{fragment.class.name}", ".html"], "tmp/view_components/")
+      begin
+        file.write(controller.render_to_string(html: fragment.to_html.html_safe, layout: layout))
+        file.rewind
+
+        block.call("/_system_test_entrypoint?file=#{file.path.split("/").last}")
+      ensure
+        file.unlink
+      end
+    end
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -35,10 +35,7 @@ module ViewComponent
     #
     # @return [String]
     def rendered_component
-      ViewComponent::Deprecation.warn(
-        "`rendered_component` is deprecated and will be removed in v3.0.0. " \
-        "Use `page` instead."
-      )
+      ViewComponent::Deprecation.deprecation_warning("`rendered_component`", :"`page`")
 
       rendered_content
     end

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -16,16 +16,18 @@ module ViewComponent
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers
+  autoload :SystemTestHelpers
   autoload :TestCase
+  autoload :SystemTestCase
   autoload :TemplateError
   autoload :Translatable
 end
 
 # :nocov:
 if defined?(ViewComponent::Engine)
-  ViewComponent::Deprecation.warn(
-    "Manually loading the engine is deprecated and will be removed in v3.0.0. " \
-    "Remove `require \"view_component/engine\"`."
+  ViewComponent::Deprecation.deprecation_warning(
+    "Manually loading the engine",
+    "remove `require \"view_component/engine\"`"
   )
 elsif defined?(Rails::Engine)
   require "view_component/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.78.0
+  version: 2.79.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -377,6 +377,8 @@ files:
 - lib/view_component/slot_v2.rb
 - lib/view_component/slotable.rb
 - lib/view_component/slotable_v2.rb
+- lib/view_component/system_test_case.rb
+- lib/view_component/system_test_helpers.rb
 - lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb