view_component 2.41.0 → 2.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec24d635f8ce5341c3735ab855b9099fe2ea9179bb21a8fe79ba0f14f374ec44
-  data.tar.gz: fbc578b4554de38f01a4e92bbcf6ddfaf146ac04fb75e871f8d2378f8a19c053
+  metadata.gz: 2542c18f4fbd3071c18fb27d8edb563021ad201fa5cc4d0c02fb8190918b6920
+  data.tar.gz: 7c7fb2ef2a79ed3816655cd8f27a52248fe0181957487a9b0297968914034c9f
 SHA512:
-  metadata.gz: 9ed08e30f614fc25aeb1c1826d159b312fba175a95a71966112069a27bc1da3255948b1c9504b06f55b6c476fda4418f13b3e42050664dc3146def0ff1ba0636
-  data.tar.gz: b02c7784cc31a3e5cfe5d6ec55879bbe832446557810a3884034e871effece891164424f4d4bf34664c3d8a239683405ea31d92b7351321ce0fc8c33c802f3a5
+  metadata.gz: 4e43d3b7398bd838b25e87a566ce82229e82343f64a9f70230b90d4eb2b0afdc8e0ffda355acd032877d0751082e3e4342ecd53955011de89ea1ce341c6b7a80
+  data.tar.gz: 3d90591c1d4d3cbff9d8e4c7dd1f94015ddce95e62f8284586dda63da99311609c3558fd353f0cf3c6b8c58f4c9a0b18f0fa91e60aa2275e57284cb2e10bff4a

data/README.md

@@ -1,4 +1,4 @@
-# ViewComponent
+<img src="/docs/logo/github-readme-logo.svg" alt="ViewComponent logo" width="400">
 
 A framework for building reusable, testable & encapsulated view components in Ruby on Rails.
 

data/docs/CHANGELOG.md

@@ -7,6 +7,122 @@ title: Changelog
 
 ## main
 
+## 2.44.0
+
+* Rename internal accessor to use private naming.
+
+    *Joel Hawksley*, *Blake Williams*, *Cameron Dutro*
+
+* Add Github repo link to docs website header.
+
+    *Hans Lemuet*
+
+* Change logo in README for dark theme readability.
+
+    *Dylan Smith*
+
+* Add Litmus to users list.
+
+    *Dylan Smith*
+
+* Add @dylanatsmith as codeowner of the ViewComponent logo and member of committers team.
+
+    *Joel Hawksley*
+
+* Autoload `CompileCache`, which is optionally called in `engine.rb`.
+
+    *Gregory Igelmund*
+
+* Move frequently asked questions to other pages, add History page.
+
+    *Joel Hawksley*
+
+* Fix typo.
+
+    *James Hart*
+
+* Add `require "method_source"` if it options.show_previews_source is enabled.
+
+    *Yoshiyuki Hirano*
+
+* Move show_previews_source definition to Previewable.
+
+    *Yoshiyuki Hirano*
+
+* Clear cache in MethodSource to apply the change odf preview code without app server restart.
+
+    *Yoshiyuki Hirano*
+
+## 2.43.1
+
+* Remove unnecessary call to `ruby2_keywords` for polymorphic slot getters.
+
+    *Cameron Dutro*
+
+## 2.43.0
+
+* Add note about tests and instance methods.
+
+    *Joel Hawksley*
+
+* Flesh out `ViewComponents in practice`.
+
+    *Joel Hawksley*
+
+* Add CODEOWNERS entries for feature areas owned by community committers.
+
+    *Joel Hawksley*
+
+* Separate lint and CI workflows.
+
+    *Blake Williams*
+
+* Add support for `image_path` helper in previews.
+
+    *Tobias Ahlin*, *Joel Hawksley*
+
+* Add section to docs listing users of ViewComponent. Please submit a PR to add your team to the list!
+
+    *Joel Hawksley*
+
+* Fix loading issue with Stimulus generator and add specs for Stimulus generator.
+
+    *Peter Sumskas*
+
+* Remove dependency on `ActionDispatch::Static` in Rails middleware stack when enabling statics assets for source code preview.
+
+    *Gregory Igelmund*
+
+* Require `view_component/engine` automatically.
+
+    *Cameron Dutro*
+
+## 2.42.0
+
+* Add logo files and page to docs.
+
+    *Dylan Smith*
+
+* Add `ViewComponents in practice` documentation.
+
+    *Joel Hawksley*
+
+* Fix bug where calling lambda slots without arguments would break in Ruby < 2.7.
+
+    *Manuel Puyol*
+
+* Improve Stimulus controller template to import from `stimulus` or `@hotwired/stimulus`.
+
+    *Mario Schüttel*
+
+* Fix bug where `helpers` would instantiate and use a new `view_context` in each component.
+
+    *Blake Williams*, *Ian C. Anderson*
+
+* Implement polymorphic slots as experimental feature. See the Slots documentation to learn more.
+
+    *Cameron Dutro*
+
 ## 2.41.0
 
 * Add `sprockets-rails` development dependency to fix test suite failures when using rails@main.
@@ -42,7 +158,7 @@ title: Changelog
 
     *Hans Lemuet*
 
-* Forward keyword arguments from slot wrapper to component instance.
+* Forward keyword arguments from slot wrapper to component instance using ruby2_keywords.
 
     *Cameron Dutro*
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/generators/abstract_generator"
+
 module Stimulus
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
@@ -12,6 +14,12 @@ module Stimulus
         template "component_controller.js", destination
       end
 
+      def stimulus_module
+        return "stimulus" if legacy_stimulus?
+
+        "@hotwired/stimulus"
+      end
+
       private
 
       def destination
@@ -21,6 +29,11 @@ module Stimulus
           File.join(component_path, class_path, "#{file_name}_component_controller.js")
         end
       end
+
+      def legacy_stimulus?
+        package_json_pathname = Rails.root.join("package.json")
+        package_json_pathname.exist? && JSON.parse(package_json_pathname.read).dig("dependencies", "stimulus").present?
+      end
     end
   end
 end

data/lib/rails/generators/stimulus/templates/component_controller.js.tt

@@ -1,4 +1,4 @@
-import { Controller } from "stimulus";
+import { Controller } from "<%= stimulus_module %>";
 
 export default class extends Controller {
   connect() {

data/lib/view_component/base.rb

@@ -5,6 +5,7 @@ require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/content_areas"
+require "view_component/polymorphic_slots"
 require "view_component/previewable"
 require "view_component/slotable"
 require "view_component/slotable_v2"
@@ -28,6 +29,8 @@ module ViewComponent
     class_attribute :content_areas
     self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
+    attr_accessor :__vc_original_view_context
+
     # EXPERIMENTAL: This API is experimental and may be removed at any time.
     # Hook for allowing components to do work as part of the compilation process.
     #
@@ -49,6 +52,8 @@ module ViewComponent
       self.class.compile(raise_errors: true)
 
       @view_context = view_context
+      self.__vc_original_view_context ||= view_context
+
       @lookup_context ||= view_context.lookup_context
 
       # required for path helpers in older Rails versions
@@ -132,9 +137,10 @@ module ViewComponent
     # @private
     def render(options = {}, args = {}, &block)
       if options.is_a? ViewComponent::Base
+        options.__vc_original_view_context = __vc_original_view_context
         super
       else
-        view_context.render(options, args, &block)
+        __vc_original_view_context.render(options, args, &block)
       end
     end
 
@@ -173,7 +179,14 @@ module ViewComponent
         )
       end
 
-      @__vc_helpers ||= controller.view_context
+      # Attempt to re-use the original view_context passed to the first
+      # component rendered in the rendering pipeline. This prevents the
+      # instantiation of a new view_context via `controller.view_context` which
+      # always returns a new instance of the view context class.
+      #
+      # This allows ivars to remain persisted when using the same helper via
+      # `helpers` across multiple components and partials.
+      @__vc_helpers ||= __vc_original_view_context || controller.view_context
     end
 
     # Exposes .virtual_path as an instance method
@@ -258,14 +271,6 @@ module ViewComponent
     #
     mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
-    # 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
-
     # Always generate a Stimulus controller alongside the component:
     #
     #     config.view_component.generate_stimulus_controller = true

data/lib/view_component/engine.rb

@@ -17,6 +17,7 @@ module ViewComponent
 
       options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
       options.show_previews = Rails.env.development? || Rails.env.test? if options.show_previews.nil?
+      options.show_previews_source ||= ViewComponent::Base.show_previews_source
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
@@ -32,6 +33,14 @@ module ViewComponent
           )
           options.preview_paths << options.preview_path
         end
+
+        if options.show_previews_source
+          require "method_source"
+
+          app.config.to_prepare do
+            MethodSource.instance_variable_set(:@lines_for_file, {})
+          end
+        end
       end
 
       ActiveSupport.on_load(:view_component) do
@@ -103,7 +112,7 @@ module ViewComponent
 
     initializer "static assets" do |app|
       if app.config.view_component.show_previews
-        app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/app/assets/vendor")
+        app.middleware.use(::ActionDispatch::Static, "#{root}/app/assets/vendor")
       end
     end
 

data/lib/view_component/polymorphic_slots.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module PolymorphicSlots
+    # In older rails versions, using a concern isn't a good idea here because they appear to not work with
+    # Module#prepend and class methods.
+    def self.included(base)
+      base.singleton_class.prepend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+
+    module ClassMethods
+      def renders_one(slot_name, callable = nil)
+        return super unless callable.is_a?(Hash) && callable.key?(:types)
+
+        validate_singular_slot_name(slot_name)
+        register_polymorphic_slot(slot_name, callable[:types], collection: false)
+      end
+
+      def renders_many(slot_name, callable = nil)
+        return super unless callable.is_a?(Hash) && callable.key?(:types)
+
+        validate_plural_slot_name(slot_name)
+        register_polymorphic_slot(slot_name, callable[:types], collection: true)
+      end
+
+      def register_polymorphic_slot(slot_name, types, collection:)
+        renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
+          memo[poly_type] = define_slot(
+            "#{slot_name}_#{poly_type}", collection: collection, callable: poly_callable
+          )
+
+          getter_name = slot_name
+          setter_name =
+            if collection
+              "#{ActiveSupport::Inflector.singularize(slot_name)}_#{poly_type}"
+            else
+              "#{slot_name}_#{poly_type}"
+            end
+
+          define_method(getter_name) do
+            get_slot(slot_name)
+          end
+
+          define_method(setter_name) do |*args, &block|
+            set_polymorphic_slot(slot_name, poly_type, *args, &block)
+          end
+          ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
+        end
+
+        self.registered_slots[slot_name] = {
+          collection: collection,
+          renderable_hash: renderable_hash
+        }
+      end
+    end
+
+    module InstanceMethods
+      def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
+        slot_definition = self.class.registered_slots[slot_name]
+
+        if !slot_definition[:collection] && get_slot(slot_name)
+          raise ArgumentError, "content for slot '#{slot_name}' has already been provided"
+        end
+
+        poly_def = slot_definition[:renderable_hash][poly_type]
+
+        set_slot(slot_name, poly_def, *args, &block)
+      end
+      ruby2_keywords(:set_polymorphic_slot) if respond_to?(:ruby2_keywords, true)
+    end
+  end
+end

data/lib/view_component/preview.rb

@@ -5,6 +5,7 @@ require "active_support/descendants_tracker"
 module ViewComponent # :nodoc:
   class Preview
     include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::AssetTagHelper
     extend ActiveSupport::DescendantsTracker
 
     def render(component, **args, &block)

data/lib/view_component/previewable.rb

@@ -15,6 +15,14 @@ module ViewComponent
       #
       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"

data/lib/view_component/slot_v2.rb

@@ -86,15 +86,10 @@ module ViewComponent
     #   end
     # end
     #
-    if RUBY_VERSION >= "2.7.0"
-      def method_missing(symbol, *args, **kwargs, &block)
-        @__vc_component_instance.public_send(symbol, *args, **kwargs, &block)
-      end
-    else
-      def method_missing(symbol, *args, &block)
-        @__vc_component_instance.public_send(symbol, *args, &block)
-      end
+    def method_missing(symbol, *args, &block)
+      @__vc_component_instance.public_send(symbol, *args, &block)
     end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
     def html_safe?
       to_s.html_safe?

data/lib/view_component/slotable_v2.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
-
 require "view_component/slot_v2"
 
 module ViewComponent
@@ -67,13 +66,14 @@ module ViewComponent
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
 
-        define_method slot_name do |*args, **kwargs, &block|
-          if args.empty? && kwargs.empty? && block.nil?
+        define_method slot_name do |*args, &block|
+          if args.empty? && block.nil?
             get_slot(slot_name)
           else
-            set_slot(slot_name, *args, **kwargs, &block)
+            set_slot(slot_name, nil, *args, &block)
           end
         end
+        ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
         register_slot(slot_name, collection: false, callable: callable)
       end
@@ -123,9 +123,10 @@ module ViewComponent
         # Define setter for singular names
         # e.g. `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
-        define_method singular_name do |*args, **kwargs, &block|
-          set_slot(slot_name, *args, **kwargs, &block)
+        define_method singular_name do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
         end
+        ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
         # Instantiates and and adds multiple slots forwarding the first
         # argument to each slot constructor
@@ -134,7 +135,7 @@ module ViewComponent
             get_slot(slot_name)
           else
             collection_args.map do |args|
-              set_slot(slot_name, **args, &block)
+              set_slot(slot_name, nil, **args, &block)
             end
           end
         end
@@ -162,27 +163,37 @@ module ViewComponent
 
       private
 
-      def register_slot(slot_name, collection:, callable:)
+      def register_slot(slot_name, **kwargs)
+        self.registered_slots[slot_name] = define_slot(slot_name, **kwargs)
+      end
+
+      def define_slot(slot_name, collection:, callable:)
         # Setup basic slot data
         slot = {
           collection: collection,
         }
+        return slot unless callable
+
         # If callable responds to `render_in`, we set it on the slot as a renderable
-        if callable && callable.respond_to?(:method_defined?) && callable.method_defined?(:render_in)
+        if callable.respond_to?(:method_defined?) && callable.method_defined?(:render_in)
           slot[:renderable] = callable
         elsif callable.is_a?(String)
           # If callable is a string, we assume it's referencing an internal class
           slot[:renderable_class_name] = callable
-        elsif callable
+        elsif callable.respond_to?(:call)
           # If slot does not respond to `render_in`, we assume it's a proc,
           # define a method, and save a reference to it to call when setting
           method_name = :"_call_#{slot_name}"
           define_method method_name, &callable
           slot[:renderable_function] = instance_method(method_name)
+        else
+          raise(
+            ArgumentError,
+            "invalid slot definition. Please pass a class, string, or callable (i.e. proc, lambda, etc)"
+          )
         end
 
-        # Register the slot on the component
-        self.registered_slots[slot_name] = slot
+        slot
       end
 
       def validate_plural_slot_name(slot_name)
@@ -235,9 +246,8 @@ module ViewComponent
       end
     end
 
-    def set_slot(slot_name, *args, **kwargs, &block)
-      slot_definition = self.class.registered_slots[slot_name]
-
+    def set_slot(slot_name, slot_definition = nil, *args, &block)
+      slot_definition ||= self.class.registered_slots[slot_name]
       slot = SlotV2.new(self)
 
       # Passing the block to the sub-component wrapper like this has two
@@ -253,23 +263,24 @@ module ViewComponent
 
       # If class
       if slot_definition[:renderable]
-        slot.__vc_component_instance = slot_definition[:renderable].new(*args, **kwargs)
+        slot.__vc_component_instance = slot_definition[:renderable].new(*args)
       # If class name as a string
       elsif slot_definition[:renderable_class_name]
         slot.__vc_component_instance =
-          self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
+          self.class.const_get(slot_definition[:renderable_class_name]).new(*args)
       # 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_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
           if block_given?
-            slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
-              view_context.capture(*args, **kwargs, &block)
+            renderable_function.call(*args) do |*args|
+              view_context.capture(*args, &block)
             end
           else
-            slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
+            renderable_function.call(*args)
           end
 
         # Function calls can return components, so if it's a component handle it specially
@@ -291,5 +302,6 @@ module ViewComponent
 
       slot
     end
+    ruby2_keywords(:set_slot) if respond_to?(:ruby2_keywords, true)
   end
 end

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -8,6 +8,7 @@ module ViewComponent
 
   autoload :Base
   autoload :Compiler
+  autoload :CompileCache
   autoload :ComponentError
   autoload :Instrumentation
   autoload :Preview
@@ -17,3 +18,5 @@ module ViewComponent
   autoload :TemplateError
   autoload :Translatable
 end
+
+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.41.0
+  version: 2.44.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,16 +76,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
@@ -268,7 +268,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - opensource+view_component@github.com
 executables: []
@@ -314,6 +314,7 @@ files:
 - lib/view_component/content_areas.rb
 - lib/view_component/engine.rb
 - lib/view_component/instrumentation.rb
+- lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
 - lib/view_component/previewable.rb
@@ -340,7 +341,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -355,8 +356,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: View components for Rails
 test_files: []