view_component 2.50.0 → 2.69.0

data/lib/view_component/slotable_v2.rb

@@ -9,7 +9,7 @@ module ViewComponent
 
     RESERVED_NAMES = {
       singular: %i[content render].freeze,
-      plural: %i[contents renders].freeze,
+      plural: %i[contents renders].freeze
     }.freeze
 
     # Setup component slot state
@@ -17,9 +17,19 @@ module ViewComponent
       # Hash of registered Slots
       class_attribute :registered_slots
       self.registered_slots = {}
+
+      class_attribute :_warn_on_deprecated_slot_setter
+      self._warn_on_deprecated_slot_setter = false
     end
 
     class_methods do
+      ##
+      # Enables deprecations coming to the Slots API in ViewComponent v3
+      #
+      def warn_on_deprecated_slot_setter
+        self._warn_on_deprecated_slot_setter = true
+      end
+
       ##
       # Registers a sub-component
       #
@@ -61,20 +71,34 @@ module ViewComponent
       # = Setting sub-component content
       #
       # Consumers of the component can render a sub-component by calling a
-      # helper method with the same name as the slot.
+      # helper method with the same name as the slot prefixed with `with_`.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <% component.header(classes: "Foo") do %>
+      #     <% component.with_header(classes: "Foo") do %>
       #       <p>Bar</p>
       #     <% end %>
       #   <% end %>
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
+        validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
+
+        define_method :"with_#{slot_name}" do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
+        end
+        ruby2_keywords(:"with_#{slot_name}") if respond_to?(:ruby2_keywords, true)
 
         define_method slot_name do |*args, &block|
           if args.empty? && block.nil?
             get_slot(slot_name)
           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)
+            end
+
             set_slot(slot_name, nil, *args, &block)
           end
         end
@@ -92,11 +116,11 @@ module ViewComponent
       #
       # = Example
       #
-      #   render_many :items, -> (name:) { ItemComponent.new(name: name }
+      #   renders_many :items, -> (name:) { ItemComponent.new(name: name }
       #
       #   # OR
       #
-      #   render_many :items, ItemComponent
+      #   renders_many :items, ItemComponent
       #
       # = Rendering sub-components
       #
@@ -112,37 +136,63 @@ module ViewComponent
       # = Setting sub-component content
       #
       # Consumers of the component can set the content of a slot by calling a
-      # helper method with the same name as the slot. The method can be
-      # called multiple times to append to the slot.
+      # helper method with the same name as the slot prefixed with `with_`. The
+      # method can be called multiple times to append to the slot.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <% component.item(name: "Foo") do %>
+      #     <% component.with_item(name: "Foo") do %>
       #       <p>One</p>
       #     <% end %>
       #
-      #     <% component.item(name: "Bar") do %>
+      #     <% component.with_item(name: "Bar") do %>
       #       <p>two</p>
       #     <% end %>
       #   <% end %>
       def renders_many(slot_name, callable = nil)
-        validate_plural_slot_name(slot_name)
-
         singular_name = ActiveSupport::Inflector.singularize(slot_name)
+        validate_plural_slot_name(slot_name)
+        validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
 
         # Define setter for singular names
         # 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|
+          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."
+            )
+          end
+
           set_slot(slot_name, nil, *args, &block)
         end
         ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
+        define_method :"with_#{singular_name}" do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
+        end
+        ruby2_keywords(:"with_#{singular_name}") if respond_to?(:ruby2_keywords, true)
+
+        define_method :"with_#{slot_name}" do |collection_args = nil, &block|
+          collection_args.map do |args|
+            set_slot(slot_name, nil, **args, &block)
+          end
+        end
+
         # Instantiates and and adds multiple slots forwarding the first
         # argument to each slot constructor
         define_method slot_name do |collection_args = nil, &block|
           if collection_args.nil? && block.nil?
             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."
+              )
+            end
+
             collection_args.map do |args|
               set_slot(slot_name, nil, **args, &block)
             end
@@ -170,20 +220,20 @@ module ViewComponent
       # Clone slot configuration into child class
       # see #test_slots_pollution
       def inherited(child)
-        child.registered_slots = self.registered_slots.clone
+        child.registered_slots = registered_slots.clone
         super
       end
 
       private
 
       def register_slot(slot_name, **kwargs)
-        self.registered_slots[slot_name] = define_slot(slot_name, **kwargs)
+        registered_slots[slot_name] = define_slot(slot_name, **kwargs)
       end
 
       def define_slot(slot_name, collection:, callable:)
         # Setup basic slot data
         slot = {
-          collection: collection,
+          collection: collection
         }
         return slot unless callable
 
@@ -234,7 +284,7 @@ module ViewComponent
       end
 
       def raise_if_slot_registered(slot_name)
-        if self.registered_slots.key?(slot_name)
+        if registered_slots.key?(slot_name)
           # TODO remove? This breaks overriding slots when slots are inherited
           raise ArgumentError.new(
             "#{self} declares the #{slot_name} slot multiple times.\n\n" \
@@ -246,8 +296,8 @@ module ViewComponent
       def raise_if_slot_ends_with_question_mark(slot_name)
         if slot_name.to_s.ends_with?("?")
           raise ArgumentError.new(
-            "#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n"\
-            "This is not allowed because the ViewComponent framework already provides predicate "\
+            "#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n" \
+            "This is not allowed because the ViewComponent framework already provides predicate " \
             "methods ending in `?`.\n\n" \
             "To fix this issue, choose a different name."
           )
@@ -267,8 +317,6 @@ module ViewComponent
 
       if slot[:collection]
         []
-      else
-        nil
       end
     end
 
@@ -285,7 +333,7 @@ module ViewComponent
       # 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?
+      slot.__vc_content_block = block if block
 
       # If class
       if slot_definition[:renderable]
@@ -301,7 +349,7 @@ module ViewComponent
         # methods like `content_tag` as well as parent component state.
         renderable_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
-          if block_given?
+          if block
             renderable_function.call(*args) do |*rargs|
               view_context.capture(*rargs, &block)
             end

data/lib/view_component/test_helpers.rb

@@ -4,10 +4,11 @@ module ViewComponent
   module TestHelpers
     begin
       require "capybara/minitest"
+
       include Capybara::Minitest::Assertions
 
       def page
-        Capybara::Node::Simple.new(@rendered_component)
+        @page ||= Capybara::Node::Simple.new(rendered_content)
       end
 
       def refute_component_rendered
@@ -19,8 +20,8 @@ module ViewComponent
       # :nocov:
       if ENV["DEBUG"]
         warn(
-          "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` " \
-          "to your Gemfile to use Capybara assertions."
+          "WARNING in `ViewComponent::TestHelpers`: Add `capybara` " \
+          "to Gemfile to use Capybara assertions."
         )
       end
 
@@ -28,7 +29,19 @@ module ViewComponent
     end
 
     # @private
-    attr_reader :rendered_component
+    attr_reader :rendered_content
+
+    # Returns the result of a render_inline call.
+    #
+    # @return [String]
+    def rendered_component
+      ViewComponent::Deprecation.warn(
+        "`rendered_component` is deprecated and will be removed in v3.0.0. " \
+        "Use `page` instead."
+      )
+
+      rendered_content
+    end
 
     # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used:
@@ -41,14 +54,72 @@ module ViewComponent
     # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
     # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
-      @rendered_component =
+      @page = nil
+      @rendered_content =
         if Rails.version.to_f >= 6.1
           controller.view_context.render(component, args, &block)
         else
           controller.view_context.render_component(component, &block)
         end
 
-      Nokogiri::HTML.fragment(@rendered_component)
+      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:
+    #
+    # ```ruby
+    # render_in_view_context do
+    #   render(MyComponent.new)
+    # end
+    #
+    # assert_text("Hello, World!")
+    # ```
+    def render_in_view_context(&block)
+      @page = nil
+      @rendered_content = controller.view_context.instance_exec(&block)
+      Nokogiri::HTML.fragment(@rendered_content)
     end
 
     # @private
@@ -119,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_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/translatable.rb

@@ -3,14 +3,13 @@
 require "erb"
 require "set"
 require "i18n"
-require "action_view/helpers/translation_helper"
 require "active_support/concern"
 
 module ViewComponent
   module Translatable
     extend ActiveSupport::Concern
 
-    HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/.freeze
+    HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/
 
     included do
       class_attribute :i18n_backend, instance_writer: false, instance_predicate: false
@@ -21,19 +20,16 @@ module ViewComponent
         @i18n_scope ||= virtual_path.sub(%r{^/}, "").gsub(%r{/_?}, ".")
       end
 
-      def _after_compile
-        super
-
+      def build_i18n_backend
         return if CompileCache.compiled? self
 
-        if (translation_files = _sidecar_files(%w[yml yaml])).any?
-          self.i18n_backend = I18nBackend.new(
+        self.i18n_backend = if (translation_files = _sidecar_files(%w[yml yaml])).any?
+          # Returning nil cleans up if translations file has been removed since the last compilation
+
+          I18nBackend.new(
             i18n_scope: i18n_scope,
-            load_paths: translation_files,
+            load_paths: translation_files
           )
-        else
-          # Cleanup if translations file has been removed since the last compilation
-          self.i18n_backend = nil
         end
       end
     end
@@ -53,7 +49,7 @@ module ViewComponent
 
       def scope_data(data)
         @i18n_scope.reverse_each do |part|
-          data = { part => data }
+          data = {part => data}
         end
         data
       end
@@ -68,7 +64,10 @@ module ViewComponent
       return key.map { |k| translate(k, **options) } if key.is_a?(Array)
 
       locale = options.delete(:locale) || ::I18n.locale
+      scope = options.delete(:scope)
+      scope = scope.join(".") if scope.is_a? Array
       key = key&.to_s unless key.is_a?(String)
+      key = "#{scope}.#{key}" if scope
       key = "#{i18n_scope}#{key}" if key.start_with?(".")
 
       if HTML_SAFE_TRANSLATION_KEY.match?(key)
@@ -95,7 +94,7 @@ module ViewComponent
         super(key, locale: locale, **options)
       end
     end
-    alias :t :translate
+    alias_method :t, :translate
 
     # Exposes .i18n_scope as an instance method
     def i18n_scope
@@ -109,7 +108,7 @@ module ViewComponent
         # It's assumed here that objects loaded by the i18n backend will respond to `#html_safe?`.
         # It's reasonable that if we're in Rails, `active_support/core_ext/string/output_safety.rb`
         # will provide this to `Object`.
-        translation.html_safe # rubocop:disable Rails/OutputSafety
+        translation.html_safe
       end
     end
 

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -10,6 +10,7 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Config
   autoload :Deprecation
   autoload :Instrumentation
   autoload :Preview

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.50.0
+  version: 2.69.0
 platform: ruby
 authors:
-- GitHub Open Source
+- ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +104,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: m
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -185,19 +213,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-github
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -272,19 +300,18 @@ dependencies:
   name: yard-activesupport-concern
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 description:
 email:
-- opensource+view_component@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -293,6 +320,7 @@ files:
 - README.md
 - app/assets/vendor/prism.css
 - app/assets/vendor/prism.min.js
+- app/controllers/concerns/view_component/preview_actions.rb
 - app/controllers/view_components_controller.rb
 - app/helpers/preview_helper.rb
 - app/views/test_mailer/test_email.html.erb
@@ -328,6 +356,7 @@ files:
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
+- lib/view_component/config.rb
 - lib/view_component/content_areas.rb
 - lib/view_component/deprecation.rb
 - lib/view_component/docs_builder_component.html.erb
@@ -337,7 +366,6 @@ files:
 - lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
-- lib/view_component/previewable.rb
 - lib/view_component/rails/tasks/view_component.rake
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb
@@ -356,7 +384,7 @@ files:
 - lib/view_component/version.rb
 - lib/view_component/with_content_helper.rb
 - lib/yard/mattr_accessor_handler.rb
-homepage: https://github.com/github/view_component
+homepage: https://viewcomponent.org
 licenses:
 - MIT
 metadata:
@@ -379,5 +407,6 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: View components for Rails
+summary: A framework for building reusable, testable & encapsulated view components
+  in Ruby on Rails.
 test_files: []

data/lib/view_component/previewable.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module ViewComponent
-  module Previewable
-    extend ActiveSupport::Concern
-
-    included do
-      # Enable or disable component previews:
-      #
-      #     config.view_component.show_previews = true
-      #
-      # Defaults to `true` in development.
-      #
-      mattr_accessor :show_previews, instance_writer: false
-
-      # Enable or disable source code previews in component previews:
-      #
-      #     config.view_component.show_previews_source = true
-      #
-      # Defaults to `false`.
-      #
-      mattr_accessor :show_previews_source, instance_writer: false, default: false
-
-      # Set a custom default layout used for preview index and individual previews:
-      #
-      #     config.view_component.default_preview_layout = "component_preview"
-      #
-      mattr_accessor :default_preview_layout, instance_writer: false
-
-      # Set the location of component previews:
-      #
-      #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
-      #
-      mattr_accessor :preview_paths, instance_writer: false
-
-      # @deprecated Use `preview_paths` instead. Will be removed in v3.0.0.
-      mattr_accessor :preview_path, instance_writer: false
-
-      # Set the entry route for component previews:
-      #
-      #     config.view_component.preview_route = "/previews"
-      #
-      # Defaults to `/rails/view_components` when `show_previews` is enabled.
-      #
-      mattr_accessor :preview_route, instance_writer: false do
-        "/rails/view_components"
-      end
-
-      # Set the controller used for previewing components:
-      #
-      #     config.view_component.preview_controller = "MyPreviewController"
-      #
-      # Defaults to `ViewComponentsController`.
-      #
-      mattr_accessor :preview_controller, instance_writer: false do
-        "ViewComponentsController"
-      end
-    end
-  end
-end