view_component 2.34.0 → 2.38.0

data/lib/view_component/slot_v2.rb

@@ -6,7 +6,7 @@ module ViewComponent
   class SlotV2
     include ViewComponent::WithContentHelper
 
-    attr_writer :_component_instance, :_content_block, :_content
+    attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content
 
     def initialize(parent)
       @parent = parent
@@ -21,7 +21,7 @@ module ViewComponent
     # component instance, returning the string.
     #
     # If the slot renderable is a function and returns a string, it is
-    # set as `@_content` and is returned directly.
+    # set as `@__vc_content` and is returned directly.
     #
     # If there is no slot renderable, we evaluate the block passed to
     # the slot and return it.
@@ -30,32 +30,39 @@ module ViewComponent
 
       view_context = @parent.send(:view_context)
 
-      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if defined?(@_content_block) && defined?(@_content_set_by_with_content)
+      if defined?(@__vc_content_block) && defined?(@__vc_content_set_by_with_content)
+        raise ArgumentError.new(
+          "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
+          "which means that ViewComponent doesn't know which content to use.\n\n" \
+          "To fix this issue, use either `with_content` or a block."
+        )
+      end
 
-      @content = if defined?(@_component_instance)
-        if defined?(@_content_set_by_with_content)
-          @_component_instance.with_content(@_content_set_by_with_content)
+      @content =
+        if defined?(@__vc_component_instance)
+          if defined?(@__vc_content_set_by_with_content)
+            @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
 
-          view_context.capture do
-            @_component_instance.render_in(view_context)
-          end
-        elsif defined?(@_content_block)
-          view_context.capture do
-            # render_in is faster than `parent.render`
-            @_component_instance.render_in(view_context, &@_content_block)
+            view_context.capture do
+              @__vc_component_instance.render_in(view_context)
+            end
+          elsif defined?(@__vc_content_block)
+            view_context.capture do
+              # render_in is faster than `parent.render`
+              @__vc_component_instance.render_in(view_context, &@__vc_content_block)
+            end
+          else
+            view_context.capture do
+              @__vc_component_instance.render_in(view_context)
+            end
           end
-        else
-          view_context.capture do
-            @_component_instance.render_in(view_context)
-          end
-        end
-      elsif defined?(@_content)
-        @_content
-      elsif defined?(@_content_block)
-        view_context.capture(&@_content_block)
-      elsif defined?(@_content_set_by_with_content)
-        @_content_set_by_with_content
-      end
+        elsif defined?(@__vc_content)
+          @__vc_content
+        elsif defined?(@__vc_content_block)
+          view_context.capture(&@__vc_content_block)
+        elsif defined?(@__vc_content_set_by_with_content)
+          @__vc_content_set_by_with_content
+             end
 
       @content
     end
@@ -80,7 +87,7 @@ module ViewComponent
     # end
     #
     def method_missing(symbol, *args, &block)
-      @_component_instance.public_send(symbol, *args, &block)
+      @__vc_component_instance.public_send(symbol, *args, &block)
     end
 
     def html_safe?
@@ -88,7 +95,7 @@ module ViewComponent
     end
 
     def respond_to_missing?(symbol, include_all = false)
-      defined?(@_component_instance) && @_component_instance.respond_to?(symbol, include_all)
+      defined?(@__vc_component_instance) && @__vc_component_instance.respond_to?(symbol, include_all)
     end
   end
 end

data/lib/view_component/slotable.rb

@@ -123,6 +123,7 @@ module ViewComponent
       slot_instance = args.present? ? slot_class.new(**args) : slot_class.new
 
       # Capture block and assign to slot_instance#content
+      # rubocop:disable Rails/OutputSafety
       slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block_given?
 
       if slot[:collection]
@@ -135,7 +136,7 @@ module ViewComponent
         # Append Slot instance to collection accessor Array
         instance_variable_get(slot[:instance_variable_name]) << slot_instance
       else
-         # Assign the Slot instance to the slot accessor
+        # Assign the Slot instance to the slot accessor
         instance_variable_set(slot[:instance_variable_name], slot_instance)
       end
 

data/lib/view_component/slotable_v2.rb

@@ -65,7 +65,7 @@ module ViewComponent
       #     <% end %>
       #   <% end %>
       def renders_one(slot_name, callable = nil)
-        validate_slot_name(slot_name)
+        validate_singular_slot_name(slot_name)
 
         define_method slot_name do |*args, **kwargs, &block|
           if args.empty? && kwargs.empty? && block.nil?
@@ -116,7 +116,7 @@ module ViewComponent
       #     <% end %>
       #   <% end %>
       def renders_many(slot_name, callable = nil)
-        validate_slot_name(slot_name)
+        validate_plural_slot_name(slot_name)
 
         singular_name = ActiveSupport::Inflector.singularize(slot_name)
 
@@ -133,7 +133,7 @@ module ViewComponent
           if collection_args.nil? && block.nil?
             get_slot(slot_name)
           else
-            collection_args.each do |args|
+            collection_args.map do |args|
               set_slot(slot_name, **args, &block)
             end
           end
@@ -142,6 +142,17 @@ module ViewComponent
         register_slot(slot_name, collection: true, callable: callable)
       end
 
+      def slot_type(slot_name)
+        registered_slot = registered_slots[slot_name]
+        if registered_slot
+          registered_slot[:collection] ? :collection : :single
+        else
+          plural_slot_name = ActiveSupport::Inflector.pluralize(slot_name).to_sym
+          plural_registered_slot = registered_slots[plural_slot_name]
+          plural_registered_slot&.fetch(:collection) ? :collection_item : nil
+        end
+      end
+
       # Clone slot configuration into child class
       # see #test_slots_pollution
       def inherited(child)
@@ -174,14 +185,35 @@ module ViewComponent
         self.registered_slots[slot_name] = slot
       end
 
-      def validate_slot_name(slot_name)
+      def validate_plural_slot_name(slot_name)
+        if slot_name.to_sym == :contents
+          raise ArgumentError.new(
+            "#{self} declares a slot named #{slot_name}, which is a reserved word in the ViewComponent framework.\n\n" \
+            "To fix this issue, choose a different name."
+          )
+        end
+
+        raise_if_slot_registered(slot_name)
+      end
+
+      def validate_singular_slot_name(slot_name)
         if slot_name.to_sym == :content
-          raise ArgumentError.new("#{slot_name} is not a valid slot name.")
+          raise ArgumentError.new(
+            "#{self} declares a slot named #{slot_name}, which is a reserved word in the ViewComponent framework.\n\n" \
+            "To fix this issue, choose a different name."
+          )
         end
 
+        raise_if_slot_registered(slot_name)
+      end
+
+      def raise_if_slot_registered(slot_name)
         if self.registered_slots.key?(slot_name)
           # TODO remove? This breaks overriding slots when slots are inherited
-          raise ArgumentError.new("#{slot_name} slot declared multiple times")
+          raise ArgumentError.new(
+            "#{self} declares the #{slot_name} slot multiple times.\n\n" \
+            "To fix this issue, choose a different slot name."
+          )
         end
       end
     end
@@ -190,10 +222,10 @@ module ViewComponent
       content unless content_evaluated? # ensure content is loaded so slots will be defined
 
       slot = self.class.registered_slots[slot_name]
-      @_set_slots ||= {}
+      @__vc_set_slots ||= {}
 
-      if @_set_slots[slot_name]
-        return @_set_slots[slot_name]
+      if @__vc_set_slots[slot_name]
+        return @__vc_set_slots[slot_name]
       end
 
       if slot[:collection]
@@ -217,42 +249,44 @@ module ViewComponent
       # 2. Since we have 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._content_block = block if block_given?
+      slot.__vc_content_block = block if block_given?
 
       # If class
       if slot_definition[:renderable]
-        slot._component_instance = slot_definition[:renderable].new(*args, **kwargs)
+        slot.__vc_component_instance = slot_definition[:renderable].new(*args, **kwargs)
       # If class name as a string
       elsif slot_definition[:renderable_class_name]
-        slot._component_instance = self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
+        slot.__vc_component_instance =
+          self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
       # If passed a lambda
       elsif slot_definition[:renderable_function]
         # Use `bind(self)` to ensure lambda is executed in the context of the
         # current component. This is necessary to allow the lambda to access helper
         # methods like `content_tag` as well as parent component state.
-        renderable_value = if block_given?
-          slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
-            view_context.capture(*args, **kwargs, &block)
+        renderable_value =
+          if block_given?
+            slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
+              view_context.capture(*args, **kwargs, &block)
+            end
+          else
+            slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
           end
-        else
-          slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
-        end
 
         # Function calls can return components, so if it's a component handle it specially
         if renderable_value.respond_to?(:render_in)
-          slot._component_instance = renderable_value
+          slot.__vc_component_instance = renderable_value
         else
-          slot._content = renderable_value
+          slot.__vc_content = renderable_value
         end
       end
 
-      @_set_slots ||= {}
+      @__vc_set_slots ||= {}
 
       if slot_definition[:collection]
-        @_set_slots[slot_name] ||= []
-        @_set_slots[slot_name].push(slot)
+        @__vc_set_slots[slot_name] ||= []
+        @__vc_set_slots[slot_name].push(slot)
       else
-        @_set_slots[slot_name] = slot
+        @__vc_set_slots[slot_name] = slot
       end
 
       slot

data/lib/view_component/test_helpers.rb

@@ -17,7 +17,13 @@ module ViewComponent
       # We don't have a test case for running an application without capybara installed.
       # It's probably fine to leave this without coverage.
       # :nocov:
-      warn "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` to your Gemfile to use Capybara assertions." if ENV["DEBUG"]
+      if ENV["DEBUG"]
+        warn(
+          "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` " \
+          "to your Gemfile to use Capybara assertions."
+        )
+      end
+
       # :nocov:
     end
 

data/lib/view_component/translatable.rb

@@ -52,7 +52,7 @@ module ViewComponent
 
       def scope_data(data)
         @i18n_scope.reverse_each do |part|
-          data = { part => data}
+          data = { part => data }
         end
         data
       end
@@ -70,9 +70,10 @@ module ViewComponent
       key = key&.to_s unless key.is_a?(String)
       key = "#{i18n_scope}#{key}" if key.start_with?(".")
 
-      translated = catch(:exception) do
-        i18n_backend.translate(locale, key, options)
-      end
+      translated =
+        catch(:exception) do
+          i18n_backend.translate(locale, key, options)
+        end
 
       # Fallback to the global translations
       if translated.is_a? ::I18n::MissingTranslation
@@ -80,7 +81,7 @@ module ViewComponent
       end
 
       if HTML_SAFE_TRANSLATION_KEY.match?(key)
-        translated = translated.html_safe
+        translated = translated.html_safe # rubocop:disable Rails/OutputSafety
       end
 
       translated

data/lib/view_component/version.rb

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

data/lib/view_component/with_content_helper.rb

@@ -4,9 +4,12 @@ module ViewComponent
   module WithContentHelper
     def with_content(value)
       if value.nil?
-        raise ArgumentError.new("No content provided.")
+        raise ArgumentError.new(
+          "No content provided to `#with_content` for #{self}.\n\n" \
+          "To fix this issue, pass a value."
+        )
       else
-        @_content_set_by_with_content = value
+        @__vc_content_set_by_with_content = value
       end
 
       self

data/lib/yard/mattr_accessor_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module YARD
+  # YARD Handler to parse `mattr_accessor` calls.
+  class MattrAccessorHandler < YARD::Handlers::Ruby::Base
+    handles method_call(:mattr_accessor)
+    namespace_only
+
+    process do
+      name = statement.parameters.first.jump(:tstring_content, :ident).source
+      object = YARD::CodeObjects::MethodObject.new(namespace, name)
+      register(object)
+      parse_block(statement.last, owner: object)
+
+      object.dynamic = true
+      object[:mattr_accessor] = true
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.34.0
+  version: 2.38.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,21 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  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: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -45,47 +59,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.8.2
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: better_html
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: erb_lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: 0.0.37
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: 0.0.37
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -101,75 +115,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: slim
+  name: jbuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: better_html
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 5.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 5.6.0
 - !ruby/object:Gem::Dependency
-  name: jbuilder
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -199,19 +213,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.2
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +240,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - opensource+view_component@github.com
@@ -233,14 +261,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.txt
 - README.md
+- app/assets/vendor/prism.css
+- app/assets/vendor/prism.min.js
 - app/controllers/view_components_controller.rb
+- app/helpers/preview_helper.rb
 - app/views/test_mailer/test_email.html.erb
+- app/views/view_components/_preview_source.html.erb
 - app/views/view_components/index.html.erb
 - app/views/view_components/preview.html.erb
 - app/views/view_components/previews.html.erb
+- docs/CHANGELOG.md
+- lib/rails/generators/abstract_generator.rb
 - lib/rails/generators/component/USAGE
 - lib/rails/generators/component/component_generator.rb
 - lib/rails/generators/component/templates/component.rb.tt
@@ -254,6 +287,8 @@ files:
 - lib/rails/generators/rspec/templates/component_spec.rb.tt
 - lib/rails/generators/slim/component_generator.rb
 - lib/rails/generators/slim/templates/component.html.slim.tt
+- lib/rails/generators/stimulus/component_generator.rb
+- lib/rails/generators/stimulus/templates/component_controller.js.tt
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
@@ -262,6 +297,7 @@ files:
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
+- lib/view_component/content_areas.rb
 - lib/view_component/engine.rb
 - lib/view_component/instrumentation.rb
 - lib/view_component/preview.rb
@@ -283,6 +319,7 @@ files:
 - lib/view_component/translatable.rb
 - 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
 licenses:
 - MIT
@@ -296,14 +333,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: View components for Rails