view_component 2.83.0 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27bcac094fd171c4eb5c5ef2319372747f0efd62ca643fefdc2b544fd6efbd73
-  data.tar.gz: 49d93b90f2cf504ded99a6cfe0db780ec178131800a35eff210488da62aae673
+  metadata.gz: 18fc4d884af4512c13d7b1f4184c59e57859a8d797451ec0b2063ff425a7d357
+  data.tar.gz: 8da2e96b470f354b1d09f1b461506e64cca4345522f2b9ddfa4143ee5bf0627c
 SHA512:
-  metadata.gz: 89a7f4702ccfc60f9128a99a3ff0ab5b35237fc0aaba860c01e705754330d557b3c380de369cd63db430f3d42d2cb2370a0677eee07ae73a61118921ec715994
-  data.tar.gz: 99c1af02c38bba37dc3f44b70818eadae73e307c4d05dd321585fb8cbdfed667367e34255fbbae11b9197fca731704e53a76b38abcfac93e45378c48a798cb43
+  metadata.gz: 9750449d8d23a150a099e8c3fa6620eb7ba03adecfeefaa9e4f0c3ce463353d9918f1212971ae214557675eae367232ccd96308e89f11831259efa1000b8fa22
+  data.tar.gz: 7b1a6852d060bea82ab51e69f3328d95dd6491d11fb2f88b84fa8b235fb17a83670a05764c8df116127017332fd3a6f9d76d9205fd5bcc31d925ec9e39a573b8

data/docs/CHANGELOG.md

@@ -10,11 +10,59 @@ nav_order: 5
 
 ## main
 
-## 2.83.0
+## 3.0.0.rc1
 
-* Ensure HTML output safety.
+1,000+ days and 100+ releases later, the 200+ contributors to ViewComponent are proud to ship v3.0.0!
 
-    *Cameron Dutro*
+We're so grateful for all of the work of community members to get us to this release. Whether it’s filing bug reports, designing APIs in long-winded discussion threads, or writing code itself, ViewComponent is built by the community, for the community. We couldn’t be more proud of what we’re building together :heart:
+
+This release makes the following breaking changes, many of which have long been deprecated:
+
+* BREAKING: Remove deprecated slots setter methods. Use `with_SLOT_NAME` instead.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated SlotsV1 in favor of current SlotsV2.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated `content_areas` feature. Use Slots instead.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated support for loading ViewComponent engine manually. Make sure `require "view_component/engine"` is removed from `Gemfile`.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated `generate_*` methods. Use `generate.*` instead.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated `with_variant` method.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated `rendered_component` in favor of `rendered_content`.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated `config.preview_path` in favor of `config.preview_paths`.
+
+    *Joel Hawksley*
+
+* BREAKING: Support Ruby 2.7+ instead of 2.4+
+
+    *Joel Hawksley*
+
+* BREAKING: Remove deprecated `before_render_check`.
+
+    *Joel Hawksley*
+
+* BREAKING: Change counter variable to start iterating from `0` instead of `1`.
+
+    *Frank S*
+
+Run into an issue with this release? [Let us know](https://github.com/ViewComponent/view_component/issues/1629).
 
 ## 2.82.0
 

data/lib/view_component/base.rb

@@ -6,10 +6,8 @@ require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/compiler"
 require "view_component/config"
-require "view_component/content_areas"
 require "view_component/polymorphic_slots"
 require "view_component/preview"
-require "view_component/slotable"
 require "view_component/slotable_v2"
 require "view_component/translatable"
 require "view_component/with_content_helper"
@@ -31,7 +29,6 @@ module ViewComponent
       attr_writer :config
     end
 
-    include ViewComponent::ContentAreas
     include ViewComponent::PolymorphicSlots
     include ViewComponent::SlotableV2
     include ViewComponent::Translatable
@@ -44,9 +41,6 @@ module ViewComponent
     # For CSRF authenticity tokens in forms
     delegate :form_authenticity_token, :protect_against_forgery?, :config, to: :helpers
 
-    class_attribute :content_areas
-    self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
-
     # Config option that strips trailing whitespace in templates before compiling them.
     class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false
     self.__vc_strip_trailing_whitespace = false # class_attribute:default doesn't work until Rails 5.2
@@ -66,23 +60,6 @@ module ViewComponent
       self.__vc_original_view_context = view_context
     end
 
-    # @!macro [attach] deprecated_generate_mattr_accessor
-    #   @method generate_$1
-    #   @deprecated Use `#generate.$1` instead. Will be removed in v3.0.0.
-    def self._deprecated_generate_mattr_accessor(name)
-      define_singleton_method("generate_#{name}".to_sym) do
-        generate.public_send(name)
-      end
-      define_singleton_method("generate_#{name}=".to_sym) do |value|
-        generate.public_send("#{name}=".to_sym, value)
-      end
-    end
-
-    _deprecated_generate_mattr_accessor :distinct_locale_files
-    _deprecated_generate_mattr_accessor :locale
-    _deprecated_generate_mattr_accessor :sidecar
-    _deprecated_generate_mattr_accessor :stimulus_controller
-
     # Entrypoint for rendering components.
     #
     # - `view_context`: ActionView context from calling view
@@ -130,12 +107,7 @@ module ViewComponent
       before_render
 
       if render?
-        # Avoid allocating new string when output_postamble is blank
-        if output_postamble.blank?
-          safe_render_template_for(@__vc_variant).to_s
-        else
-          safe_render_template_for(@__vc_variant).to_s + safe_output_postamble
-        end
+        render_template_for(@__vc_variant).to_s + output_postamble
       else
         ""
       end
@@ -162,7 +134,7 @@ module ViewComponent
     #
     # @return [String]
     def output_postamble
-      @@default_output_postamble ||= "".html_safe
+      ""
     end
 
     # Called before rendering the component. Override to perform operations that
@@ -170,14 +142,6 @@ module ViewComponent
     #
     # @return [void]
     def before_render
-      before_render_check
-    end
-
-    # Called after rendering the component.
-    #
-    # @deprecated Use `#before_render` instead. Will be removed in v3.0.0.
-    # @return [void]
-    def before_render_check
       # noop
     end
 
@@ -270,22 +234,9 @@ module ViewComponent
     #
     # @private
     def format
-      # Ruby 2.6 throws a warning without checking `defined?`, 2.7 doesn't
       @__vc_variant if defined?(@__vc_variant)
     end
 
-    # Use the provided variant instead of the one determined by the current request.
-    #
-    # @deprecated Will be removed in v3.0.0.
-    # @param variant [Symbol] The variant to be used by the component.
-    # @return [self]
-    def with_variant(variant)
-      @__vc_variant = variant
-
-      self
-    end
-    deprecate :with_variant, deprecator: ViewComponent::Deprecation
-
     # The current request. Use sparingly as doing so introduces coupling that
     # inhibits encapsulation & reuse, often making testing difficult.
     #
@@ -314,38 +265,6 @@ module ViewComponent
       @__vc_content_evaluated
     end
 
-    def maybe_escape_html(text)
-      return text if request && !request.format.html?
-      return text if text.blank?
-
-      if text.html_safe?
-        text
-      else
-        yield
-        html_escape(text)
-      end
-    end
-
-    def safe_render_template_for(variant)
-      if compiler.renders_template_for_variant?(variant)
-        render_template_for(variant)
-      else
-        maybe_escape_html(render_template_for(variant)) do
-          Kernel.warn("WARNING: The #{self.class} component rendered HTML-unsafe output. The output will be automatically escaped, but you may want to investigate.")
-        end
-      end
-    end
-
-    def safe_output_postamble
-      maybe_escape_html(output_postamble) do
-        Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe postamble. The postamble will be automatically escaped, but you may want to investigate.")
-      end
-    end
-
-    def compiler
-      @compiler ||= self.class.compiler
-    end
-
     # Set the controller used for testing components:
     #
     # ```ruby

data/lib/view_component/collection.rb

@@ -62,7 +62,7 @@ module ViewComponent
 
     def component_options(item, iterator)
       item_options = {component.collection_parameter => item}
-      item_options[component.collection_counter_parameter] = iterator.index + 1 if component.counter_argument_present?
+      item_options[component.collection_counter_parameter] = iterator.index if component.counter_argument_present?
       item_options[component.collection_iteration_parameter] = iterator.dup if component.iteration_argument_present?
 
       @options.merge(item_options)

data/lib/view_component/compiler.rb

@@ -16,7 +16,6 @@ module ViewComponent
     def initialize(component_class)
       @component_class = component_class
       @redefinition_lock = Mutex.new
-      @variants_rendering_templates = Set.new
     end
 
     def compiled?
@@ -47,12 +46,6 @@ module ViewComponent
         return false
       end
 
-      if subclass_instance_methods.include?(:before_render_check)
-        ViewComponent::Deprecation.deprecation_warning(
-          "`before_render_check`", :"`before_render`"
-        )
-      end
-
       if raise_errors
         component_class.validate_initialization_parameters!
         component_class.validate_collection_parameter!
@@ -62,7 +55,6 @@ module ViewComponent
         # Remove existing compiled template methods,
         # as Ruby warns when redefining a method.
         method_name = call_method_name(template[:variant])
-        @variants_rendering_templates << template[:variant]
 
         redefinition_lock.synchronize do
           component_class.silence_redefinition_of_method(method_name)
@@ -83,10 +75,6 @@ module ViewComponent
       CompileCache.register(component_class)
     end
 
-    def renders_template_for_variant?(variant)
-      @variants_rendering_templates.include?(variant)
-    end
-
     private
 
     attr_reader :component_class, :redefinition_lock

data/lib/view_component/config.rb

@@ -126,9 +126,6 @@ module ViewComponent
       # The locations in which component previews will be looked up.
       # Defaults to `['test/component/previews']` relative to your Rails root.
 
-      # @!attribute preview_path
-      # @deprecated Use #preview_paths instead. Will be removed in v3.0.0.
-
       # @!attribute test_controller
       # @return [String]
       # The controller used for testing components.
@@ -158,15 +155,6 @@ module ViewComponent
       @config = self.class.defaults
     end
 
-    def preview_path
-      preview_paths
-    end
-
-    def preview_path=(new_value)
-      ViewComponent::Deprecation.deprecation_warning("`preview_path`", :"`preview_paths`")
-      self.preview_paths = Array.wrap(new_value)
-    end
-
     delegate_missing_to :config
 
     private

data/lib/view_component/deprecation.rb

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

data/lib/view_component/engine.rb

@@ -143,20 +143,3 @@ module ViewComponent
     end
   end
 end
-
-if RUBY_VERSION < "2.7.0"
-  ViewComponent::Deprecation.deprecation_warning("Support for Ruby versions < 2.7.0")
-end
-
-# :nocov:
-unless defined?(ViewComponent::Base)
-  require "view_component/deprecation"
-
-  ViewComponent::Deprecation.deprecation_warning(
-    "Manually loading the engine",
-    "remove `require \"view_component/engine\"`"
-  )
-
-  require "view_component"
-end
-# :nocov:

data/lib/view_component/polymorphic_slots.rb

@@ -60,18 +60,6 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
-          define_method(setter_name) do |*args, &block|
-            if _warn_on_deprecated_slot_setter
-              ViewComponent::Deprecation.deprecation_warning(
-                "Using polymorphic slot setters like `#{setter_name}`",
-                :"`with_#{setter_name}`"
-              )
-            end
-
-            set_polymorphic_slot(slot_name, poly_type, *args, &block)
-          end
-          ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
-
           define_method("with_#{setter_name}") do |*args, &block|
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end

data/lib/view_component/slotable.rb

@@ -15,71 +15,6 @@ module ViewComponent
     end
 
     class_methods do
-      # support initializing slots as:
-      #
-      # with_slot(
-      #   :header,
-      #   collection: true|false,
-      #   class_name: "Header" # class name string, used to instantiate Slot
-      # )
-      def with_slot(*slot_names, collection: false, class_name: nil)
-        ViewComponent::Deprecation.deprecation_warning(
-          "`with_slot`", "use the new slots API (https://viewcomponent.org/guide/slots.html) instead"
-        )
-
-        slot_names.each do |slot_name|
-          # Ensure slot_name isn't already declared
-          if slots.key?(slot_name)
-            raise ArgumentError.new("#{slot_name} slot declared multiple times")
-          end
-
-          # 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
-
-          # Set the name of the method used to access the Slot(s)
-          accessor_name =
-            if collection
-              # If Slot is a collection, set the accessor
-              # name to the pluralized form of the slot name
-              # For example: :tab => :tabs
-              ActiveSupport::Inflector.pluralize(slot_name)
-            else
-              slot_name
-            end
-
-          instance_variable_name = "@#{accessor_name}"
-
-          # If the slot is a collection, define an accesor that defaults to an empty array
-          if collection
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{accessor_name}
-                content unless content_evaluated? # ensure content is loaded so slots will be defined
-                #{instance_variable_name} ||= []
-              end
-            RUBY
-          else
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{accessor_name}
-                content unless content_evaluated? # ensure content is loaded so slots will be defined
-                #{instance_variable_name} if defined?(#{instance_variable_name})
-              end
-            RUBY
-          end
-
-          # Default class_name to ViewComponent::Slot
-          class_name = "ViewComponent::Slot" unless class_name.present?
-
-          # Register the slot on the component
-          slots[slot_name] = {
-            class_name: class_name,
-            instance_variable_name: instance_variable_name,
-            collection: collection
-          }
-        end
-      end
-
       def inherited(child)
         # Clone slot configuration into child class
         # see #test_slots_pollution

data/lib/view_component/slotable_v2.rb

@@ -17,19 +17,9 @@ 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
       #
@@ -88,21 +78,7 @@ module ViewComponent
         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)
-
-              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)
-          end
+          get_slot(slot_name)
         end
         ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
@@ -155,22 +131,6 @@ module ViewComponent
         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.deprecation_warning(
-              "Setting a slot with `##{singular_name}`",
-              "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
@@ -182,23 +142,8 @@ module ViewComponent
           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.deprecation_warning(
-                "Setting a slot with `##{slot_name}`",
-                "use `#with_#{slot_name}` to set the slot instead"
-              )
-            end
-
-            collection_args.map do |args|
-              set_slot(slot_name, nil, **args, &block)
-            end
-          end
+          get_slot(slot_name)
         end
 
         define_method "#{slot_name}?" do

data/lib/view_component/test_helpers.rb

@@ -31,15 +31,6 @@ module ViewComponent
     # @private
     attr_reader :rendered_content
 
-    # Returns the result of a render_inline call.
-    #
-    # @return [String]
-    def rendered_component
-      ViewComponent::Deprecation.deprecation_warning("`rendered_component`", :"`page`")
-
-      rendered_content
-    end
-
     # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used:
     #

data/lib/view_component/version.rb

@@ -2,11 +2,12 @@
 
 module ViewComponent
   module VERSION
-    MAJOR = 2
-    MINOR = 83
+    MAJOR = 3
+    MINOR = 0
     PATCH = 0
+    PRE = "rc1"
 
-    STRING = [MAJOR, MINOR, PATCH].join(".")
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end
 end
 

data/lib/view_component.rb

@@ -23,13 +23,4 @@ module ViewComponent
   autoload :Translatable
 end
 
-# :nocov:
-if defined?(ViewComponent::Engine)
-  ViewComponent::Deprecation.deprecation_warning(
-    "Manually loading the engine",
-    "remove `require \"view_component/engine\"`"
-  )
-elsif defined?(Rails::Engine)
-  require "view_component/engine"
-end
-# :nocov:
+require "view_component/engine" if defined?(Rails::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.83.0
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -358,7 +358,6 @@ files:
 - 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
 - lib/view_component/docs_builder_component.rb
@@ -374,7 +373,6 @@ files:
 - lib/view_component/render_to_string_monkey_patch.rb
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb
-- lib/view_component/slot.rb
 - lib/view_component/slot_v2.rb
 - lib/view_component/slotable.rb
 - lib/view_component/slotable_v2.rb
@@ -402,14 +400,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components

data/lib/view_component/content_areas.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-require "view_component/slot"
-
-# DEPRECATED - ContentAreas is deprecated and will be removed in v3.0.0
-module ViewComponent
-  module ContentAreas
-    extend ActiveSupport::Concern
-
-    # Assign the provided content to the content area accessor
-    #
-    # @private
-    def with(area, content = nil, &block)
-      unless content_areas.include?(area)
-        raise ArgumentError.new(
-          "Unknown content_area '#{area}' for #{self} - expected one of '#{content_areas}'.\n\n" \
-          "To fix this issue, add `with_content_area :#{area}` to #{self} or reference " \
-          "a valid content area."
-        )
-      end
-
-      if block
-        content = view_context.capture(&block)
-      end
-
-      instance_variable_set("@#{area}".to_sym, content)
-      nil
-    end
-
-    class_methods do
-      def with_content_areas(*areas)
-        ViewComponent::Deprecation.deprecation_warning(
-          "`with_content_areas`", "use slots (https://viewcomponent.org/guide/slots.html) instead"
-        )
-
-        if areas.include?(:content)
-          raise ArgumentError.new(
-            "#{self} defines a content area called :content, which is a reserved name. \n\n" \
-            "To fix this issue, use another name, such as `:body`."
-          )
-        end
-
-        areas.each do |area|
-          define_method area.to_sym do
-            content unless content_evaluated? # ensure content is loaded so content_areas will be defined
-            instance_variable_get(:"@#{area}") if instance_variable_defined?(:"@#{area}")
-          end
-        end
-
-        self.content_areas = areas
-      end
-    end
-  end
-end

data/lib/view_component/slot.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  class Slot
-    attr_accessor :content
-  end
-end