view_component 2.46.0 → 2.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9b1ca38d53b64e55ff434c43f11839cf122d82d17768c2f064e2622ef88dc88
-  data.tar.gz: 7bc10806de04abbe6c7458305592d09ea6f4dfe9d86aff5d0cf0b9b9cfa9a620
+  metadata.gz: 2c94e6fdeccccb7180494d100eef8c78a8dc8e3e9bc30e5647017b440788c6eb
+  data.tar.gz: c3836df9c15e8039ba673895ad5a9544aebe55325f9fbd418b96f4bb4238b8d6
 SHA512:
-  metadata.gz: 5c100fe77483f4b5f7227a47188f63428cbde65ebddf75cd0accf881d2140536150ea1d52f5c68b66126dd5087d9ac7fd7725f4c829a82d58c5cf86ef8abff2e
-  data.tar.gz: 19e3230c2b894651462dd6dbae44b4579267cc662c962e2bf9208e28cea299e01286427ae3c949d5622e8302cad4ba2b8f5e58a6aa6dabd3e872de367affb8bb
+  metadata.gz: 644f964985c8418371fdcac45e1e7b1771d89ee65ed8a692ec51c50cbed8a578937ba1bb7b9bf1d3b3e3729bd418df5fb2e9d1aee3bbb8215bfbed4504457074
+  data.tar.gz: c4df9e14be4dc20e529beb794c96baf424087f7e36423b301402325e1b1ce0ae8ab575fe1b69334b3e27b5fa9e2fee227e9bd20e0e99fe5f384f2f535b43f80c

data/app/controllers/view_components_controller.rb

@@ -29,12 +29,11 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
       @example_name = File.basename(params[:path])
       @render_args = @preview.render_args(@example_name, params: params.permit!)
       layout = determine_layout(@render_args[:layout], prepend_views: false)[:layout]
-      template = @render_args[:template]
       locals = @render_args[:locals]
       opts = {}
       opts[:layout] = layout if layout.present? || layout == false
       opts[:locals] = locals if locals.present?
-      render template, opts # rubocop:disable GitHub/RailsControllerRenderLiteral
+      render "view_components/preview", opts # rubocop:disable GitHub/RailsControllerRenderLiteral
     end
   end
 

data/app/helpers/preview_helper.rb

@@ -4,16 +4,64 @@ module PreviewHelper
   AVAILABLE_PRISM_LANGUAGES = ["ruby", "erb", "haml"]
   FALLBACK_LANGUAGE = "ruby"
 
-  def prism_language_name(template:)
+  def preview_source
+    return if @render_args.nil?
+
+    render "preview_source" # rubocop:disable GitHub/RailsViewRenderPathsExist
+  end
+
+  def find_template_data(lookup_context:, template_identifier:)
+    template = lookup_context.find_template(template_identifier)
+
+    if Rails.version.to_f >= 6.1 || template.source.present?
+      return {
+        source: template.source,
+        prism_language_name: prism_language_name_by_template(template: template)
+      }
+    else
+      # Fetch template source via finding it through preview paths
+      # to accomodate source view when exclusively using templates
+      # for previews for Rails < 6.1.
+      all_template_paths = ViewComponent::Base.preview_paths.map do |preview_path|
+        Dir.glob("#{preview_path}/**/*")
+      end.flatten
+
+      # Search for templates the contain `html`.
+      matching_templates = all_template_paths.find_all do |template|
+        template =~ /#{template_identifier}*.(html)/
+      end
+
+      # In-case of a conflict due to multiple template files with
+      # the same name
+      raise "found 0 matches for templates for #{template_identifier}." if matching_templates.empty?
+      raise "found multiple templates for #{template_identifier}." if matching_templates.size > 1
+
+      template_file_path = matching_templates.first
+      template_source = File.read(template_file_path)
+      prism_language_name = prism_language_name_by_template_path(template_file_path: template_file_path)
+
+      return {
+        source: template_source,
+        prism_language_name: prism_language_name
+      }
+    end
+  end
+
+  private
+
+  def prism_language_name_by_template(template:)
     language = template.identifier.split(".").last
+
     return FALLBACK_LANGUAGE unless AVAILABLE_PRISM_LANGUAGES.include? language
 
     language
   end
 
-  def preview_source
-    return if @render_args.nil?
+  def prism_language_name_by_template_path(template_file_path:)
+    language = template_file_path.gsub(".html", "").split(".").last
 
-    render "preview_source" # rubocop:disable GitHub/RailsViewRenderPathsExist
+    return FALLBACK_LANGUAGE unless AVAILABLE_PRISM_LANGUAGES.include? language
+
+    language
   end
 end

data/app/views/view_components/_preview_source.html.erb

@@ -7,9 +7,9 @@
         <%= h @preview.preview_source(@example_name) %>
       </code>
     <% else %>
-      <% template = @view_renderer.lookup_context.find_template(@render_args[:template]) %>
-      <code class="language-<%= prism_language_name(template: template) %>">
-        <%= h template.source %>
+      <% template_data = find_template_data(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
+      <code class="language-<%= template_data[:prism_language_name] %>">
+        <%= h template_data[:source] %>
       </code>
     <% end %>
   </pre>

data/app/views/view_components/preview.html.erb

@@ -1,7 +1,11 @@
-<% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
-  <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
+<% if @render_args[:component] %>
+  <% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+    <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
+  <% else %>
+    <%= render_component(@render_args[:component], &@render_args[:block]) %>
+  <% end %>
 <% else %>
-  <%= render_component(@render_args[:component], &@render_args[:block]) %>
+  <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
 <% if ViewComponent::Base.show_previews_source %>

data/docs/CHANGELOG.md

@@ -7,6 +7,78 @@ title: Changelog
 
 ## main
 
+## 2.47.0
+
+* Display preview source on previews that exclusively use templates.
+
+    *Edwin Mak*
+
+* Add a test to ensure trailing newlines are stripped when rendering with `#render_in`.
+
+    *Simon Fish*
+
+* Add WEBrick as a depenency to the docs application.
+
+    *Connor McQuillan*
+
+* Update Ruby version in `.tool-versions`.
+
+    *Connor McQuillan*
+
+* Add a test to ensure blocks can be passed into lambda slots without the need for any other arguments.
+
+    *Simon Fish*
+
+* Add linters for file consistency.
+
+    *Simon Fish*
+
+* Add @boardfish to docs/index.md and sort contributors.
+
+    *Simon Fish*
+
+* Set up Codespaces for bug replication.
+
+    *Simon Fish*
+
+* Add instructions for replicating bugs and failures.
+
+    *Simon Fish*
+
+* Make @boardfish a committer.
+
+    *Joel Hawksley*
+
+* Validate collection parameter with Active Model attribute names.
+
+    *Simon Fish*
+
+* Fix `helpers` not working with component slots when rendered more than 2 component levels deep.
+
+    *Blake Williams*
+
+* Update ruby to the latest versions
+
+    *Pedro Paiva*
+
+* Fix `vale` linter config options.
+
+    *Hans Lemuet*
+
+* Improve Contributing docs to include how to run tests for a specific version on Rails.
+
+    *Hans Lemuet*
+
+* Add failing test for default form builder and documentation around known issue.
+
+    *Simon Fish*
+
+* Add `--locale` flag to the component generator. Generates as many locale files as defined in `I18n.available_locales`, alongside the component.
+* Add config option `config.view_component.generate_locale` to enable project-wide locale generation.
+* Add config option `config.view_component.generate_distinct_locale_files` to enable project-wide per-locale translations file generation.
+
+    *Bob Maerten*
+
 ## 2.46.0
 
 * Add thread safety to the compiler.
@@ -25,6 +97,17 @@ title: Changelog
 
     *Simon Fish*
 
+* Deprecate loading `view_component/engine` directly.
+
+  **Upgrade notice**: You should update your `Gemfile` like this:
+
+  ```diff
+  - gem "view_component", require: "view_component/engine"`
+  + gem "view_component"
+  ```
+
+    *Yoshiyuki Hirano*
+
 ## 2.45.0
 
 * Remove internal APIs from API documentation, fix link to license.
@@ -63,10 +146,6 @@ title: Changelog
 
     *Yoshiyuki Hirano*
 
-* Deprecate engine loading manually.
-
-    *Yoshiyuki Hirano*
-
 ## 2.44.0
 
 * Rename internal accessor to use private naming.

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

@@ -15,6 +15,7 @@ module Rails
       class_option :parent, type: :string, desc: "The parent class for the generated component"
       class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate_stimulus_controller
       class_option :sidecar, type: :boolean, default: false
+      class_option :locale, type: :boolean, default: ViewComponent::Base.generate_locale
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -26,6 +27,8 @@ module Rails
 
       hook_for :stimulus, type: :boolean
 
+      hook_for :locale, type: :boolean
+
       hook_for :template_engine do |instance, template_engine|
         instance.invoke template_engine, [instance.name]
       end

data/lib/rails/generators/component/templates/component.rb.tt

@@ -6,7 +6,7 @@ class <%= class_name %>Component < <%= parent_class %>
     <%= initialize_body %>
   end
 <%- end -%>
-<%- if initialize_call_method_for_inline? -%>  
+<%- if initialize_call_method_for_inline? -%>
   def call
     content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
   end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "rails/generators/abstract_generator"
+
+module Locale
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      class_option :sidecar, type: :boolean, default: false
+
+      def create_locale_file
+        if ViewComponent::Base.generate_distinct_locale_files
+          I18n.available_locales.each do |locale|
+            create_file destination(locale), translations_hash([locale]).to_yaml
+          end
+        else
+          create_file destination, translations_hash(I18n.available_locales).to_yaml
+        end
+      end
+
+      private
+
+      def translations_hash(locales = [:en])
+        locales.map { |locale| [locale.to_s, translation_keys] }.to_h
+      end
+
+      def translation_keys
+        keys = attributes.map(&:name)
+        keys = %w[hello] if keys.empty?
+        keys.map { |name| [name, name.capitalize] }.to_h
+      end
+
+      def destination(locale = nil)
+        extention = ".#{locale}" if locale
+        if options["sidecar"]
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extention}.yml")
+        else
+          File.join(component_path, class_path, "#{file_name}_component#{extention}.yml")
+        end
+      end
+    end
+  end
+end

data/lib/view_component/base.rb

@@ -279,6 +279,25 @@ module ViewComponent
     #
     mattr_accessor :generate_stimulus_controller, instance_writer: false, default: false
 
+    # Always generate translations file alongside the component:
+    #
+    #     config.view_component.generate_locale = true
+    #
+    # Defaults to `false`.
+    #
+    mattr_accessor :generate_locale, instance_writer: false, default: false
+
+    # Always generate as many translations files as available locales:
+    #
+    #     config.view_component.generate_distinct_locale_files = true
+    #
+    # Defaults to `false`.
+    #
+    # One file will be generated for each configured `I18n.available_locales`.
+    # Fallback on `[:en]` when no available_locales is defined.
+    #
+    mattr_accessor :generate_distinct_locale_files, instance_writer: false, default: false
+
     # Path for component files
     #
     #     config.view_component.view_component_path = "app/my_components"
@@ -507,6 +526,10 @@ module ViewComponent
       private
 
       def initialize_parameter_names
+        return attribute_names.map(&:to_sym) if respond_to?(:attribute_names)
+
+        return attribute_types.keys.map(&:to_sym) if Rails::VERSION::MAJOR <= 5 && respond_to?(:attribute_types)
+
         initialize_parameters.map(&:last)
       end
 

data/lib/view_component/slot_v2.rb

@@ -40,6 +40,8 @@ module ViewComponent
 
       @content =
         if defined?(@__vc_component_instance)
+          @__vc_component_instance.__vc_original_view_context = @parent.__vc_original_view_context
+
           if defined?(@__vc_content_set_by_with_content)
             @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
 

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.46.0
+  version: 2.47.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -295,6 +295,7 @@ files:
 - lib/rails/generators/erb/templates/component.html.erb.tt
 - lib/rails/generators/haml/component_generator.rb
 - lib/rails/generators/haml/templates/component.html.haml.tt
+- lib/rails/generators/locale/component_generator.rb
 - lib/rails/generators/preview/component_generator.rb
 - lib/rails/generators/preview/templates/component_preview.rb.tt
 - lib/rails/generators/rspec/component_generator.rb