view_component 2.27.0 → 2.31.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47f112ee86431b25865a4793374e8838a1e80966d91150d4b182b38c598a9631
-  data.tar.gz: 97673827cb5a971d8c769b9566c87055d28af37fa04b06b6e90c5098b64c9388
+  metadata.gz: f29c10730d8ec00ec04c0a7236b5f0eefb56235012c866b9af8566f2b4d25a1b
+  data.tar.gz: e1ebe3cab15bb375740e012474aef4d31a4d44dbf5cfc302ad2248567b704009
 SHA512:
-  metadata.gz: 538a828cd9096fd400cd3b3bc8fa4f63666003221161b22f59a008f62fa5f8d8b311d7152498ff5519004bd960c61d058912fc7241e537d129d9873a4b6c0b63
-  data.tar.gz: 99de0a2aadb9eb873854b284e0be4f1aa2d20aa8262c5350b3473d536d6e40891d819dff74c73188b1106454a98299511b79e7c406ddebbe05dfdf8ebf69804b
+  metadata.gz: 479fc618baf4e945087b0738d0dcf0c621060a8f81f0916149c9f93be0cd7dc2f715fd1f5e45c2ecf365ed5db44bfa4c1e34c406bdfab443556f08c1aaabf2cb
+  data.tar.gz: '099ee8077b1d6c866710dc16abe53c9e9159c2966f9505bdf1492a370f411a4f242191feba37d0fb9e74d158b3f87b41e1cb2f812fb0da012ae7a93caccf4818'

data/CHANGELOG.md

@@ -2,6 +2,87 @@
 
 ## main
 
+## 2.31.1
+
+* Fix `DEPRECATION WARNING: before_render_check` when compiling `ViewComponent::Base`
+
+    *Dave Kroondyk*
+
+## 2.31.0
+
+* Add `#with_content` to allow setting content without a block.
+
+    *Jordan Raine, Manuel Puyol*
+
+* Add `with_request_url` test helper.
+
+    *Mario Schüttel*
+
+* Improve feature parity with Rails translations
+  * Don't create a translation backend if the component has no translation file
+  * Mark translation keys ending with `html` as HTML-safe
+  * Always convert keys to String
+  * Support multiple keys
+
+    *Elia Schito*
+
+* Fix errors on `asset_url` helpers when `asset_host` has no protocol.
+
+    *Elia Schito*
+
+* Prevent slots from overriding the `#content` method when registering a slot with that name.
+
+    *Blake Williams*
+
+* Deprecate `with_slot` in favor of the new [slots API](https://viewcomponent.org/guide/slots.html).
+
+    *Manuel Puyol*
+
+## 2.30.0
+
+* Deprecate `with_content_areas` in favor of [slots](https://viewcomponent.org/guide/slots.html).
+
+    *Joel Hawksley*
+
+## 2.29.0
+
+* Allow Slot lambdas to share data from the parent component and allow chaining on the returned component.
+
+    *Sjors Baltus, Blake Williams*
+
+* Experimental: Add `ViewComponent::Translatable`
+  * `t` and `translate` now will look first into the sidecar YAML translations file.
+  * `helpers.t` and `I18n.t` still reference the global Rails translation files.
+  * `l` and `localize` will still reference the global Rails translation files.
+
+    *Elia Schito*
+
+* Fix rendering output of pass through slots when using HAML.
+
+    *Alex Robbin, Blake Williams*
+
+* Experimental: call `._sidecar_files` to fetch the sidecar files for a given list of extensions, e.g. passing `["yml", "yaml"]`.
+
+    *Elia Schito*
+
+* Fix bug where a single `jbuilder` template matched multiple template handlers.
+
+    *Niels Slot*
+
+## 2.28.0
+
+* Include SlotableV2 by default in Base. **Note:** It's no longer necessary to include `ViewComponent::SlotableV2` to use Slots.
+
+    *Joel Hawksley*
+
+* Prepend Preview routes instead of appending, accounting for cases where host application has catchall route.
+
+    *Joel Hawksley*
+
+* Fix bug where blocks passed to lambda slots will render incorrectly in certain situations.
+
+    *Blake Williams*
+
 ## 2.27.0
 
 * Allow customization of the controller used in component tests.

data/README.md

@@ -6,14 +6,6 @@ A framework for building reusable, testable & encapsulated view components in Ru
 
 See [viewcomponent.org](https://viewcomponent.org/) for documentation.
 
-## Installation
-
-In `Gemfile`, add:
-
-```ruby
-gem "view_component", require: "view_component/engine"
-```
-
 ## Contributing
 
 This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./CONTRIBUTING.md) as well.

data/lib/view_component.rb

@@ -7,9 +7,11 @@ module ViewComponent
 
   autoload :Base
   autoload :Compiler
+  autoload :ComponentError
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers
   autoload :TestCase
   autoload :TemplateError
+  autoload :Translatable
 end

data/lib/view_component/base.rb

@@ -7,11 +7,14 @@ require "view_component/compile_cache"
 require "view_component/previewable"
 require "view_component/slotable"
 require "view_component/slotable_v2"
+require "view_component/with_content_helper"
 
 module ViewComponent
   class Base < ActionView::Base
     include ActiveSupport::Configurable
     include ViewComponent::Previewable
+    include ViewComponent::SlotableV2
+    include ViewComponent::WithContentHelper
 
     ViewContextCalledBeforeRenderError = Class.new(StandardError)
 
@@ -78,6 +81,8 @@ module ViewComponent
       old_current_template = @current_template
       @current_template = self
 
+      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if block && defined?(@_content_set_by_with_content)
+
       @_content_evaluated = false
       @_render_in_block = block
 
@@ -130,7 +135,7 @@ module ViewComponent
       @helpers ||= controller.view_context
     end
 
-    # Exposes .virutal_path as an instance method
+    # Exposes .virtual_path as an instance method
     def virtual_path
       self.class.virtual_path
     end
@@ -168,8 +173,6 @@ module ViewComponent
       self
     end
 
-    private
-
     # Exposes the current request to the component.
     # Use sparingly as doing so introduces coupling
     # that inhibits encapsulation & reuse.
@@ -177,6 +180,8 @@ module ViewComponent
       @request ||= controller.request
     end
 
+    private
+
     attr_reader :view_context
 
     def content
@@ -185,6 +190,8 @@ module ViewComponent
 
       @_content = if @view_context && @_render_in_block
         view_context.capture(self, &@_render_in_block)
+      elsif defined?(@_content_set_by_with_content)
+        @_content_set_by_with_content
       end
     end
 
@@ -205,6 +212,47 @@ module ViewComponent
     class << self
       attr_accessor :source_location, :virtual_path
 
+      # EXPERIMENTAL: This API is experimental and may be removed at any time.
+      # Find sidecar files for the given extensions.
+      #
+      # The provided array of extensions is expected to contain
+      # strings starting without the "dot", example: `["erb", "haml"]`.
+      #
+      # For example, one might collect sidecar CSS files that need to be compiled.
+      def _sidecar_files(extensions)
+        return [] unless source_location
+
+        extensions = extensions.join(",")
+
+        # view files in a directory named like the component
+        directory = File.dirname(source_location)
+        filename = File.basename(source_location, ".rb")
+        component_name = name.demodulize.underscore
+
+        # Add support for nested components defined in the same file.
+        #
+        # e.g.
+        #
+        # class MyComponent < ViewComponent::Base
+        #   class MyOtherComponent < ViewComponent::Base
+        #   end
+        # end
+        #
+        # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
+        nested_component_files = if name.include?("::") && component_name != filename
+          Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
+        else
+          []
+        end
+
+        # view files in the same directory as the component
+        sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
+
+        sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
+
+        (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files).uniq
+      end
+
       # Render a component collection.
       def with_collection(collection, **args)
         Collection.new(self, collection, **args)
@@ -238,7 +286,7 @@ module ViewComponent
       end
 
       def compiled?
-        template_compiler.compiled?
+        compiler.compiled?
       end
 
       # Compile templates to instance methods, assuming they haven't been compiled already.
@@ -246,11 +294,11 @@ module ViewComponent
       # Do as much work as possible in this step, as doing so reduces the amount
       # of work done each time a component is rendered.
       def compile(raise_errors: false)
-        template_compiler.compile(raise_errors: raise_errors)
+        compiler.compile(raise_errors: raise_errors)
       end
 
-      def template_compiler
-        @_template_compiler ||= Compiler.new(self)
+      def compiler
+        @_compiler ||= Compiler.new(self)
       end
 
       # we'll eventually want to update this to support other types
@@ -267,6 +315,11 @@ module ViewComponent
       end
 
       def with_content_areas(*areas)
+        ActiveSupport::Deprecation.warn(
+          "`with_content_areas` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
+          "Use slots (https://viewcomponent.org/guide/slots.html) instead."
+        )
+
         if areas.include?(:content)
           raise ArgumentError.new ":content is a reserved content area name. Please use another name, such as ':body'"
         end
@@ -318,7 +371,7 @@ module ViewComponent
       def validate_initialization_parameters!
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
-        raise ArgumentError.new(
+        raise ViewComponent::ComponentError.new(
           "#{self} initializer cannot contain " \
           "`#{RESERVED_PARAMETER}` since it will override a " \
           "public ViewComponent method."
@@ -338,7 +391,7 @@ module ViewComponent
       end
 
       def counter_argument_present?
-        instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
+        initialize_parameter_names.include?(collection_counter_parameter)
       end
 
       private

data/lib/view_component/compiler.rb

@@ -13,12 +13,18 @@ module ViewComponent
     def compile(raise_errors: false)
       return if compiled?
 
+      subclass_instance_methods = component_class.instance_methods(false)
+
+      if subclass_instance_methods.include?(:with_content) && raise_errors
+        raise ViewComponent::ComponentError.new("#{component_class} implements a reserved method, `with_content`.")
+      end
+
       if template_errors.present?
         raise ViewComponent::TemplateError.new(template_errors) if raise_errors
         return false
       end
 
-      if component_class.instance_methods(false).include?(:before_render_check)
+      if subclass_instance_methods.include?(:before_render_check)
         ActiveSupport::Deprecation.warn(
           "`before_render_check` will be removed in v3.0.0. Use `before_render` instead."
         )
@@ -61,7 +67,7 @@ module ViewComponent
         "elsif variant.to_sym == :#{variant}\n    #{call_method_name(variant)}"
       end.join("\n")
 
-      component_class.class_eval <<-RUBY
+      component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def render_template_for(variant = nil)
           if variant.nil?
             call
@@ -114,50 +120,18 @@ module ViewComponent
     end
 
     def templates
-      @templates ||= matching_views_in_source_location.each_with_object([]) do |path, memo|
-        pieces = File.basename(path).split(".")
-
-        memo << {
-          path: path,
-          variant: pieces.second.split("+").second&.to_sym,
-          handler: pieces.last
-        }
-      end
-    end
-
-    def matching_views_in_source_location
-      source_location = component_class.source_location
-      return [] unless source_location
-
-      extensions = ActionView::Template.template_handler_extensions.join(",")
-
-      # view files in a directory named like the component
-      directory = File.dirname(source_location)
-      filename = File.basename(source_location, ".rb")
-      component_name = component_class.name.demodulize.underscore
-
-      # Add support for nested components defined in the same file.
-      #
-      # e.g.
-      #
-      # class MyComponent < ViewComponent::Base
-      #   class MyOtherComponent < ViewComponent::Base
-      #   end
-      # end
-      #
-      # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
-      nested_component_files = if component_class.name.include?("::") && component_name != filename
-        Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
-      else
-        []
+      @templates ||= begin
+        extensions = ActionView::Template.template_handler_extensions
+
+        component_class._sidecar_files(extensions).each_with_object([]) do |path, memo|
+          pieces = File.basename(path).split(".")
+          memo << {
+            path: path,
+            variant: pieces.second.split("+").second&.to_sym,
+            handler: pieces.last
+          }
+        end
       end
-
-      # view files in the same directory as the component
-      sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
-
-      sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
-
-      (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files)
     end
 
     def inline_calls

data/lib/view_component/component_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class ComponentError < StandardError
+  end
+end

data/lib/view_component/engine.rb

@@ -90,7 +90,7 @@ module ViewComponent
       options = app.config.view_component
 
       if options.show_previews
-        app.routes.append do
+        app.routes.prepend do
           preview_controller = options.preview_controller.sub(/Controller$/, "").underscore
 
           get options.preview_route, to: "#{preview_controller}#index", as: :preview_view_components, internal: true

data/lib/view_component/slot_v2.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require "view_component/with_content_helper"
+
 module ViewComponent
   class SlotV2
+    include ViewComponent::WithContentHelper
+
     attr_writer :_component_instance, :_content_block, :_content
 
     def initialize(parent)
@@ -25,19 +29,32 @@ module ViewComponent
       return @content if defined?(@content)
 
       view_context = @parent.send(:view_context)
-      @content = view_context.capture do
-        if defined?(@_component_instance)
-          # render_in is faster than `parent.render`
-          if defined?(@_content_block)
-            @_component_instance.render_in(view_context, &@_content_block)
-          else
+
+      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if defined?(@_content_block) && defined?(@_content_set_by_with_content)
+
+      @content = if defined?(@_component_instance)
+        if defined?(@_content_set_by_with_content)
+          @_component_instance.with_content(@_content_set_by_with_content)
+
+          view_context.capture do
             @_component_instance.render_in(view_context)
           end
-        elsif defined?(@_content)
-          @_content
         elsif defined?(@_content_block)
-          @_content_block.call
+          view_context.capture do
+            # render_in is faster than `parent.render`
+            @_component_instance.render_in(view_context, &@_content_block)
+          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
 
       @content

data/lib/view_component/slotable.rb

@@ -23,6 +23,11 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
+        ActiveSupport::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."
+        )
+
         slot_names.each do |slot_name|
           # Ensure slot_name is not already declared
           if self.slots.key?(slot_name)
@@ -49,14 +54,14 @@ module ViewComponent
 
           # If the slot is a collection, define an accesor that defaults to an empty array
           if collection
-            class_eval <<-RUBY
+            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
+            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})

data/lib/view_component/slotable_v2.rb

@@ -175,6 +175,10 @@ module ViewComponent
       end
 
       def validate_slot_name(slot_name)
+        if slot_name.to_sym == :content
+          raise ArgumentError.new("#{slot_name} is not a valid slot name.")
+        end
+
         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")
@@ -226,7 +230,13 @@ module ViewComponent
         # 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 = slot_definition[:renderable_function].bind(self).call(*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
 
         # Function calls can return components, so if it's a component handle it specially
         if renderable_value.respond_to?(:render_in)
@@ -245,7 +255,7 @@ module ViewComponent
         @_set_slots[slot_name] = slot
       end
 
-      nil
+      slot
     end
   end
 end

data/lib/view_component/test_helpers.rb

@@ -60,6 +60,17 @@ module ViewComponent
       @controller = old_controller
     end
 
+    def with_request_url(path)
+      old_request_path_parameters = request.path_parameters
+      old_controller = defined?(@controller) && @controller
+
+      request.path_parameters = Rails.application.routes.recognize_path(path)
+      yield
+    ensure
+      request.path_parameters = old_request_path_parameters
+      @controller = old_controller
+    end
+
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end

data/lib/view_component/translatable.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+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
+
+    included do
+      class_attribute :i18n_backend, instance_writer: false, instance_predicate: false
+    end
+
+    class_methods do
+      def i18n_scope
+        @i18n_scope ||= virtual_path.sub(%r{^/}, "").gsub(%r{/_?}, ".")
+      end
+
+      def _after_compile
+        super
+
+        return if CompileCache.compiled? self
+
+        if (translation_files = _sidecar_files(%w[yml yaml])).any?
+          self.i18n_backend = I18nBackend.new(
+            i18n_scope: i18n_scope,
+            load_paths: translation_files,
+          )
+        else
+          # Cleanup if translations file has been removed since the last compilation
+          self.i18n_backend = nil
+        end
+      end
+    end
+
+    class I18nBackend < ::I18n::Backend::Simple
+      EMPTY_HASH = {}.freeze
+
+      def initialize(i18n_scope:, load_paths:)
+        @i18n_scope = i18n_scope.split(".")
+        @load_paths = load_paths
+      end
+
+      # Ensure the Simple backend won't load paths from ::I18n.load_path
+      def load_translations
+        super(@load_paths)
+      end
+
+      def scope_data(data)
+        @i18n_scope.reverse_each do |part|
+          data = { part => data}
+        end
+        data
+      end
+
+      def store_translations(locale, data, options = EMPTY_HASH)
+        super(locale, scope_data(data), options)
+      end
+    end
+
+    def translate(key = nil, **options)
+      return super unless i18n_backend
+      return key.map { |k| translate(k, **options) } if key.is_a?(Array)
+
+      locale = options.delete(:locale) || ::I18n.locale
+      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
+
+      # Fallback to the global translations
+      if translated.is_a? ::I18n::MissingTranslation
+        return super(key, locale: locale, **options)
+      end
+
+      if HTML_SAFE_TRANSLATION_KEY.match?(key)
+        translated = translated.html_safe
+      end
+
+      translated
+    end
+    alias :t :translate
+
+    # Exposes .i18n_scope as an instance method
+    def i18n_scope
+      self.class.i18n_scope
+    end
+  end
+end

data/lib/view_component/version.rb

@@ -3,9 +3,11 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 27
-    PATCH = 0
+    MINOR = 31
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
 end
+
+puts ViewComponent::VERSION::STRING if __FILE__ == $PROGRAM_NAME

data/lib/view_component/with_content_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module WithContentHelper
+    def with_content(value)
+      if value.nil?
+        raise ArgumentError.new("No content provided.")
+      else
+        @_content_set_by_with_content = value
+      end
+
+      self
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.27.0
+  version: 2.31.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +246,7 @@ files:
 - lib/view_component/collection.rb
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
+- lib/view_component/component_error.rb
 - lib/view_component/engine.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
@@ -249,7 +264,9 @@ files:
 - lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb
+- lib/view_component/translatable.rb
 - lib/view_component/version.rb
+- lib/view_component/with_content_helper.rb
 homepage: https://github.com/github/view_component
 licenses:
 - MIT