view_component 2.25.1 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c411f9f34b25054093f7abe23c5842c7523f083ecdb1ba586429545548eca423
-  data.tar.gz: 744c27c0907544dfb93eb37ecf47c74dd7df86855c0e2b91f9619a77bd8eefc8
+  metadata.gz: f8c387807061db7889dbc2e49ccb75a15a2cacd416048a6681b046eb321fb27b
+  data.tar.gz: fbddc58ff50b3ddaf615f773a681a7a8b7bef3972581dad8b87bf8425efff275
 SHA512:
-  metadata.gz: bee62ecbcfecbc53146b8a8e55207baf2d14769adda2bb2349494a82224acf12fa6584bfc32512e96474f28f011823f2c5712cbc021773d439c43fab8b090503
-  data.tar.gz: 3f519b85b066d89fdf75afb17563cb868bb4fb673caa21326661f0738b9b4398af068421064ca6f77abf08b7b46bdc549c132252b111b8fb3009809d430b9682
+  metadata.gz: 63a070fc0a5001b888dbd57a2a9fb0660b351a05b522d9a832efdd2a60f981d218eda2f500a50d01ca6a8c5ada4cccb61f2837e7b956215e89528d9454d3fd39
+  data.tar.gz: 8176f0427272a8305a520eeaa72ae58be2d9df42282a981f376eb69ac0543017f98d737ecb09f6fa6fc8cacf85adbbf82fbefe337da22432448ab361f35ae447

data/CHANGELOG.md

@@ -2,6 +2,75 @@
 
 ## main
 
+## 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.
+
+    *Alex Robbin*
+
+* Generate preview at overridden path if one exists when using `--preview` flag.
+
+    *Nishiki Liu*
+
+## 2.26.1
+
+* Fix bug that raises when trying to use a collection before the component has been compiled.
+
+    *Blake Williams*
+
+## 2.26.0
+
+* Lazily evaluate component `content` in `render?`, preventing the `content` block from being evaluated when `render?` returns false.
+
+    *Blake Williams*
+
+* Do not generate template when using `--inline` flag.
+
+    *Hans Lemuet*
+
+* Add `--inline` option to the Haml and Slim generators
+
+    *Hans Lemuet*
+
 ## 2.25.1
 
 * Experimental: call `._after_compile` class method after a component is compiled.

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/rails/generators/erb/component_generator.rb

@@ -10,18 +10,18 @@ module Erb
       class_option :inline, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.erb", destination
+        unless options["inline"]
+          template "component.html.erb", destination
+        end
       end
 
       private
 
       def destination
-        if !options["inline"]
-          if options["sidecar"]
-            File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.erb")
-          else
-            File.join("app/components", class_path, "#{file_name}_component.html.erb")
-          end
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.erb")
+        else
+          File.join("app/components", class_path, "#{file_name}_component.html.erb")
         end
       end
 

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

@@ -9,7 +9,9 @@ module Haml
       class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.haml", destination
+        if !options["inline"]
+          template "component.html.haml", destination
+        end
       end
 
       private

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

@@ -8,7 +8,11 @@ module Preview
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        template "component_preview.rb", File.join("test/components/previews", class_path, "#{file_name}_component_preview.rb")
+        preview_paths = Rails.application.config.view_component.preview_paths
+        return if preview_paths.count > 1
+
+        path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"
+        template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_component_preview.rb")
       end
 
       private

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

@@ -9,7 +9,9 @@ module Slim
       class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.slim", destination
+        if !options["inline"]
+          template "component.html.slim", destination
+        end
       end
 
       private

data/lib/view_component.rb

@@ -12,4 +12,5 @@ module ViewComponent
   autoload :TestHelpers
   autoload :TestCase
   autoload :TemplateError
+  autoload :Translatable
 end

data/lib/view_component/base.rb

@@ -12,6 +12,7 @@ module ViewComponent
   class Base < ActionView::Base
     include ActiveSupport::Configurable
     include ViewComponent::Previewable
+    include ViewComponent::SlotableV2
 
     ViewContextCalledBeforeRenderError = Class.new(StandardError)
 
@@ -78,8 +79,8 @@ module ViewComponent
       old_current_template = @current_template
       @current_template = self
 
-      # Assign captured content passed to component as a block to @content
-      @content = view_context.capture(self, &block) if block_given?
+      @_content_evaluated = false
+      @_render_in_block = block
 
       before_render
 
@@ -130,7 +131,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
@@ -177,11 +178,25 @@ module ViewComponent
       @request ||= controller.request
     end
 
-    attr_reader :content, :view_context
+    attr_reader :view_context
+
+    def content
+      return @_content if defined?(@_content)
+      @_content_evaluated = true
+
+      @_content = if @view_context && @_render_in_block
+        view_context.capture(self, &@_render_in_block)
+      end
+    end
+
+    def content_evaluated?
+      @_content_evaluated
+    end
 
     # The controller used for testing components.
-    # Defaults to ApplicationController. This should be set early
-    # in the initialization process and should be set to a string.
+    # Defaults to ApplicationController, but can be configured
+    # on a per-test basis using `with_controller_class`.
+    # This should be set early in the initialization process and should be a string.
     mattr_accessor :test_controller
     @@test_controller = "ApplicationController"
 
@@ -191,6 +206,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)
@@ -256,7 +312,14 @@ module ViewComponent
         if areas.include?(:content)
           raise ArgumentError.new ":content is a reserved content area name. Please use another name, such as ':body'"
         end
-        attr_reader(*areas)
+
+        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
 
@@ -304,6 +367,22 @@ module ViewComponent
         )
       end
 
+      def collection_parameter
+        if provided_collection_parameter
+          provided_collection_parameter
+        else
+          name && name.demodulize.underscore.chomp("_component").to_sym
+        end
+      end
+
+      def collection_counter_parameter
+        "#{collection_parameter}_counter".to_sym
+      end
+
+      def counter_argument_present?
+        instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
+      end
+
       private
 
       def initialize_parameter_names

data/lib/view_component/collection.rb

@@ -10,7 +10,6 @@ module ViewComponent
     def render_in(view_context, &block)
       iterator = ActionView::PartialIteration.new(@collection.size)
 
-      component.compile(raise_errors: true)
       component.validate_collection_parameter!(validate_default: true)
 
       @collection.map do |item|

data/lib/view_component/compiler.rb

@@ -24,28 +24,6 @@ module ViewComponent
         )
       end
 
-      # Remove any existing singleton methods,
-      # as Ruby warns when redefining a method.
-      component_class.remove_possible_singleton_method(:collection_parameter)
-      component_class.remove_possible_singleton_method(:collection_counter_parameter)
-      component_class.remove_possible_singleton_method(:counter_argument_present?)
-
-      component_class.define_singleton_method(:collection_parameter) do
-        if provided_collection_parameter
-          provided_collection_parameter
-        else
-          name.demodulize.underscore.chomp("_component").to_sym
-        end
-      end
-
-      component_class.define_singleton_method(:collection_counter_parameter) do
-        "#{collection_parameter}_counter".to_sym
-      end
-
-      component_class.define_singleton_method(:counter_argument_present?) do
-        instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
-      end
-
       if raise_errors
         component_class.validate_initialization_parameters!
         component_class.validate_collection_parameter!
@@ -83,7 +61,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
@@ -136,50 +114,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/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

@@ -25,15 +25,22 @@ 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`
-          @_component_instance.render_in(view_context, &@_content_block)
-        elsif defined?(@_content)
-          @_content
-        elsif defined?(@_content_block)
-          @_content_block.call
+
+      @content = if defined?(@_component_instance)
+        # render_in is faster than `parent.render`
+        if defined?(@_content_block)
+          view_context.capture do
+            @_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)
       end
 
       @content

data/lib/view_component/slotable.rb

@@ -49,13 +49,19 @@ 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
-            attr_reader accessor_name
+            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

data/lib/view_component/slotable_v2.rb

@@ -183,6 +183,8 @@ module ViewComponent
     end
 
     def get_slot(slot_name)
+      content unless content_evaluated? # ensure content is loaded so slots will be defined
+
       slot = self.class.registered_slots[slot_name]
       @_set_slots ||= {}
 
@@ -224,7 +226,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)

data/lib/view_component/test_helpers.rb

@@ -35,7 +35,7 @@ module ViewComponent
     end
 
     def controller
-      @controller ||= Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+      @controller ||= build_controller(Base.test_controller.constantize)
     end
 
     def request
@@ -47,7 +47,21 @@ module ViewComponent
 
       controller.view_context.lookup_context.variants = variant
       yield
+    ensure
       controller.view_context.lookup_context.variants = old_variants
     end
+
+    def with_controller_class(klass)
+      old_controller = defined?(@controller) && @controller
+
+      @controller = build_controller(klass)
+      yield
+    ensure
+      @controller = old_controller
+    end
+
+    def build_controller(klass)
+      klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+    end
   end
 end

data/lib/view_component/translatable.rb

@@ -0,0 +1,81 @@
+# 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
+
+    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
+
+        unless CompileCache.compiled? self
+          self.i18n_backend = I18nBackend.new(
+            i18n_scope: i18n_scope,
+            load_paths: _sidecar_files(%w[yml yaml]),
+          )
+        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, locale: nil, **options)
+      locale ||= ::I18n.locale
+
+      key = "#{i18n_scope}#{key}" if key.start_with?(".")
+
+      result = catch(:exception) do
+        i18n_backend.translate(locale, key, options)
+      end
+
+      # Fallback to the global translations
+      if result.is_a? ::I18n::MissingTranslation
+        result = helpers.t(key, locale: locale, **options)
+      end
+
+      result
+    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 = 25
-    PATCH = 1
+    MINOR = 29
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
 end
+
+puts ViewComponent::VERSION::STRING if __FILE__ == $PROGRAM_NAME

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.25.1
+  version: 2.29.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-04-02 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
@@ -249,6 +263,7 @@ 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
 homepage: https://github.com/github/view_component
 licenses:
@@ -270,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: View components for Rails