view_component 4.0.0.rc2 → 4.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfdffe5b162240d97c986ddbdee4f537e04bddebde4f622a573c691599a73bed
-  data.tar.gz: d98395c2fe7910511a22da7a42864fa9a3c7c47c3a865be52defd3e54ad0b7c7
+  metadata.gz: 3d836f60a33d5a66087281b9edbb578a118d706721160676173390a8eab5d361
+  data.tar.gz: 9c6129650fbc464da3e315244eba6a893d5722dc9e577673efb0f3b090279386
 SHA512:
-  metadata.gz: b8a6d36f48196994b26af63743dd1f9cbf9cf3bd71cd656e2de9b6f34a8fb69c5620e348dd9b791c1d59864627f6d0dc1fb7d56e50ad5e1a1376c611bd555864
-  data.tar.gz: ec1366449379c2817bc18e8c8fd565e0aee7a564c99a5c6c564d8da5ee2f60ae5582c1d46fbef25af532fc2e96a5c9b1de5d5e0907850c3af78b394ca49b772d
+  metadata.gz: 46da774d6dd963153254af7e11ce5d03891d69c302e48220b5e7f54795ebdb58ca93d09af9975c47076bb58a13f379df60fafff04b597b5236bd77c3e2d122c2
+  data.tar.gz: a4038c0360c90b2958ce31b31bd50260d6e10964e15733de9c2a7b57488ddaaa0773d583da2efdbe81c7aaae340ad1f8324f00283dac5bd3db69588befb1b76d

data/docs/CHANGELOG.md

@@ -10,6 +10,26 @@ nav_order: 6
 
 ## main
 
+## 4.0.0.rc4
+
+* Fix issue where generators were not included in published gem.
+
+    *Jean-Louis Giordano*
+
+## 4.0.0.rc3
+
+* Reformat the avatars section to arrange them in a grid.
+
+    *Josh Cohen*
+
+* Fix bug where relative paths in `translate` didn't work in blocks passed to ViewComponents.
+
+    *Joel Hawksley*
+
+* Add SerpApi to "Who uses ViewComponent" list.
+
+    *Andy from SerpApi*
+
 ## 4.0.0.rc2
 
 * Add `around_render` lifecyle method for wrapping component rendering in custom instrumentation, etc.

data/lib/generators/view_component/abstract_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module AbstractGenerator
+    def copy_view_file
+      template("component.html.#{engine_name}", destination) unless options["inline"] || options["call"]
+    end
+
+    private
+
+    def destination
+      File.join(destination_directory, "#{destination_file_name}.html.#{engine_name}")
+    end
+
+    def destination_directory
+      if sidecar?
+        File.join(component_path, class_path, destination_file_name)
+      else
+        File.join(component_path, class_path)
+      end
+    end
+
+    def destination_file_name
+      "#{file_name}_component"
+    end
+
+    def file_name
+      @_file_name ||= super.sub(/_component\z/i, "")
+    end
+
+    def component_path
+      ViewComponent::Base.config.generate.path
+    end
+
+    def stimulus_controller
+      if stimulus?
+        File.join(destination_directory, destination_file_name)
+          .sub("#{component_path}/", "")
+          .tr("_", "-")
+          .gsub("/", "--")
+      end
+    end
+
+    def sidecar?
+      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
+    end
+
+    def stimulus?
+      options["stimulus"] || ViewComponent::Base.config.generate.stimulus_controller
+    end
+
+    def typescript?
+      options["typescript"] || ViewComponent::Base.config.generate.typescript
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "generators/view_component/abstract_generator"
+
+module ViewComponent
+  module Generators
+    class ComponentGenerator < Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      check_class_collision suffix: "Component"
+
+      class_option :call, type: :boolean, default: false
+      class_option :inline, type: :boolean, default: false
+      class_option :locale, type: :boolean, default: ViewComponent::Base.config.generate.locale
+      class_option :parent, type: :string, desc: "The parent class for the generated component"
+      class_option :preview, type: :boolean, default: ViewComponent::Base.config.generate.preview
+      class_option :sidecar, type: :boolean, default: false
+      class_option :stimulus, type: :boolean,
+        default: ViewComponent::Base.config.generate.stimulus_controller
+      class_option :skip_suffix, type: :boolean, default: false
+
+      def create_component_file
+        template "component.rb", File.join(component_path, class_path, "#{file_name}#{options[:skip_suffix] ? "" : "_component"}.rb")
+      end
+
+      hook_for :test_framework
+
+      hook_for :preview, type: :boolean
+
+      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
+
+      private
+
+      def parent_class
+        return options[:parent] if options[:parent]
+
+        ViewComponent::Base.config.generate.parent_class || default_parent_class
+      end
+
+      def initialize_signature?
+        initialize_signature.present?
+      end
+
+      def initialize_signature
+        return if attributes.blank?
+
+        attributes.map { |attr| "#{attr.name}:" }.join(", ")
+      end
+
+      def initialize_body
+        attributes.map { |attr| "@#{attr.name} = #{attr.name}" }.join("\n    ")
+      end
+
+      def initialize_call_method_for_inline?
+        options["call"]
+      end
+
+      def inline_template?
+        options["inline"]
+      end
+
+      def template_engine
+        options["template_engine"]
+      end
+
+      def default_parent_class
+        defined?(ApplicationComponent) ? ApplicationComponent : ViewComponent::Base
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
+<%- if inline_template? -%>
+  <%= template_engine %>_template <<~<%= template_engine.upcase %>
+    <h1>Hello, World!</h1>
+  <%= template_engine.upcase %>
+<%- end -%>
+<%- if initialize_signature? -%>
+  def initialize(<%= initialize_signature %>)
+    <%= initialize_body %>
+  end
+<%- end -%>
+<%- if initialize_call_method_for_inline? -%>
+  def call
+    content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
+  end
+<%- end -%>
+end
+<% end -%>

data/lib/generators/view_component/erb/erb_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb"
+require "generators/view_component/abstract_generator"
+
+module ViewComponent
+  module Generators
+    class ErbGenerator < Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+      class_option :inline, type: :boolean, default: false
+      class_option :call, type: :boolean, default: false
+      class_option :stimulus, type: :boolean, default: false
+
+      def engine_name
+        "erb"
+      end
+
+      def copy_view_file
+        super
+      end
+
+      private
+
+      def data_attributes
+        if stimulus?
+          " data-controller=\"#{stimulus_controller}\""
+        end
+      end
+    end
+  end
+end

data/lib/generators/view_component/erb/templates/component.html.erb.tt

@@ -0,0 +1 @@
+<div<%= data_attributes %>>Add <%= class_name %> template here</div>

data/lib/generators/view_component/haml/haml_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "generators/view_component/erb/erb_generator"
+
+module ViewComponent
+  module Generators
+    class HamlGenerator < ViewComponent::Generators::ErbGenerator
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+
+      def engine_name
+        "haml"
+      end
+
+      def copy_view_file
+        super
+      end
+    end
+  end
+end

data/lib/generators/view_component/haml/templates/component.html.haml.tt

@@ -0,0 +1 @@
+%div Add <%= class_name %> template here

data/lib/generators/view_component/locale/locale_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "generators/view_component/abstract_generator"
+
+module ViewComponent
+  module Generators
+    class LocaleGenerator < ::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.config.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)
+        extension = ".#{locale}" if locale
+        if sidecar?
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extension}.yml")
+        else
+          File.join(component_path, class_path, "#{file_name}_component#{extension}.yml")
+        end
+      end
+    end
+  end
+end

data/lib/generators/view_component/preview/preview_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Generators
+    class PreviewGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::Base.config.generate.preview_path
+
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      check_class_collision suffix: "ComponentPreview"
+
+      def create_preview_file
+        preview_paths = ViewComponent::Base.config.previews.paths
+        optional_path = options[:preview_path]
+        return if preview_paths.count > 1 && optional_path.blank?
+
+        path_prefix = if optional_path.present?
+          optional_path
+        else
+          preview_paths.one? ? preview_paths.first : "test/components/previews"
+        end
+
+        template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_component_preview.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+
+      def render_signature
+        return if attributes.blank?
+
+        attributes.map { |attr| %(#{attr.name}: "#{attr.name}") }.join(", ")
+      end
+    end
+  end
+end

data/lib/generators/view_component/preview/templates/component_preview.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %>ComponentPreview < ViewComponent::Preview
+  def default
+    render(<%= class_name %>Component.new<%= "(#{render_signature})" if render_signature %>)
+  end
+end
+<% end -%>

data/lib/generators/view_component/rspec/rspec_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "generators/view_component/abstract_generator"
+
+module ViewComponent
+  module Generators
+    class RspecGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template "component_spec.rb", File.join(spec_component_path, class_path, "#{file_name}_component_spec.rb")
+      end
+
+      private
+
+      def spec_component_path
+        return "spec/components" unless ViewComponent::Base.config.generate.use_component_path_for_rspec_tests
+
+        configured_component_path = component_path
+        if configured_component_path.start_with?("app#{File::SEPARATOR}")
+          _app, *rest_of_path = Pathname.new(configured_component_path).each_filename.to_a
+          File.join("spec", *rest_of_path)
+        else
+          "spec/components"
+        end
+      end
+    end
+  end
+end

data/lib/generators/view_component/rspec/templates/component_spec.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>Component, type: :component do
+  pending "add some examples to (or delete) #{__FILE__}"
+
+  # it "renders something useful" do
+  #   expect(
+  #     render_inline(described_class.new(attr: "value")) { "Hello, components!" }.css("p").to_html
+  #   ).to include(
+  #     "Hello, components!"
+  #   )
+  # end
+end

data/lib/generators/view_component/slim/slim_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "generators/view_component/erb/erb_generator"
+
+module ViewComponent
+  module Generators
+    class SlimGenerator < ViewComponent::Generators::ErbGenerator
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+
+      def engine_name
+        "slim"
+      end
+
+      def copy_view_file
+        super
+      end
+    end
+  end
+end

data/lib/generators/view_component/slim/templates/component.html.slim.tt

@@ -0,0 +1 @@
+div Add <%= class_name %> template here

data/lib/generators/view_component/stimulus/stimulus_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "generators/view_component/abstract_generator"
+
+module ViewComponent
+  module Generators
+    class StimulusGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+      class_option :typescript, type: :boolean, default: false
+
+      def create_stimulus_controller
+        template "component_controller.#{filetype}", destination
+      end
+
+      def stimulus_module
+        return "stimulus" if legacy_stimulus?
+
+        "@hotwired/stimulus"
+      end
+
+      private
+
+      def filetype
+        typescript? ? "ts" : "js"
+      end
+
+      def destination
+        if sidecar?
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.#{filetype}")
+        else
+          File.join(component_path, class_path, "#{file_name}_component_controller.#{filetype}")
+        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/generators/view_component/stimulus/templates/component_controller.js.tt

@@ -0,0 +1,7 @@
+import { Controller } from "<%= stimulus_module %>";
+
+export default class extends Controller {
+  connect() {
+    console.log("Hello, Stimulus!", this.element);
+  }
+}

data/lib/generators/view_component/stimulus/templates/component_controller.ts.tt

@@ -0,0 +1,9 @@
+import { Controller } from "<%= stimulus_module %>";
+
+export default class extends Controller {
+  declare element: HTMLElement;
+
+  connect() {
+    console.log("Hello, Stimulus!", this.element);
+  }
+}

data/lib/generators/view_component/tailwindcss/tailwindcss_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "generators/view_component/erb/erb_generator"
+
+module ViewComponent
+  module Generators
+    class TailwindcssGenerator < ViewComponent::Generators::ErbGenerator
+      source_root File.expand_path("templates", __dir__)
+    end
+  end
+end

data/lib/generators/view_component/tailwindcss/templates/component.html.erb.tt

@@ -0,0 +1 @@
+<div<%= data_attributes %>>Add <%= class_name %> template here</div>

data/lib/generators/view_component/test_unit/templates/component_test.rb.tt

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>ComponentTest < ViewComponent::TestCase
+  def test_component_renders_something_useful
+    # assert_equal(
+    #   %(<span>Hello, components!</span>),
+    #   render_inline(<%= class_name %>Component.new(message: "Hello, components!")).css("span").to_html
+    # )
+  end
+end

data/lib/generators/view_component/test_unit/test_unit_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Generators
+    class TestUnitGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "ComponentTest"
+
+      def create_test_file
+        template "component_test.rb", File.join("test/components", class_path, "#{file_name}_component_test.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/view_component/base.rb

@@ -108,7 +108,7 @@ module ViewComponent
       self.class.__vc_compile(raise_errors: true)
 
       @view_context = view_context
-      old_virtual_path = view_context.instance_variable_get(:@virtual_path)
+      @old_virtual_path = view_context.instance_variable_get(:@virtual_path)
       self.__vc_original_view_context ||= view_context
 
       @output_buffer = view_context.output_buffer
@@ -166,7 +166,7 @@ module ViewComponent
         ""
       end
     ensure
-      view_context.instance_variable_set(:@virtual_path, old_virtual_path)
+      view_context.instance_variable_set(:@virtual_path, @old_virtual_path)
       @current_template = old_current_template
     end
 
@@ -341,7 +341,9 @@ module ViewComponent
 
       @__vc_content =
         if __vc_render_in_block_provided?
-          view_context.capture(self, &@__vc_render_in_block)
+          with_original_virtual_path do
+            view_context.capture(self, &@__vc_render_in_block)
+          end
         elsif __vc_content_set_by_with_content_defined?
           @__vc_content_set_by_with_content
         end
@@ -358,6 +360,14 @@ module ViewComponent
       self.class.__vc_response_format
     end
 
+    # @private
+    def with_original_virtual_path
+      @view_context.instance_variable_set(:@virtual_path, @old_virtual_path)
+      yield
+    ensure
+      @view_context.instance_variable_set(:@virtual_path, virtual_path)
+    end
+
     private
 
     attr_reader :view_context

data/lib/view_component/slot.rb

@@ -58,7 +58,9 @@ module ViewComponent
           if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context) do |*args|
-              @__vc_content_block.call(*args)
+              @parent.with_original_virtual_path do
+                @__vc_content_block.call(*args)
+              end
             end
           else
             @__vc_component_instance.render_in(view_context)
@@ -66,7 +68,9 @@ module ViewComponent
         elsif defined?(@__vc_content)
           @__vc_content
         elsif defined?(@__vc_content_block)
-          view_context.capture(&@__vc_content_block)
+          @parent.with_original_virtual_path do
+            view_context.capture(&@__vc_content_block)
+          end
         elsif defined?(@__vc_content_set_by_with_content)
           @__vc_content_set_by_with_content
         end

data/lib/view_component/version.rb

@@ -5,7 +5,7 @@ module ViewComponent
     MAJOR = 4
     MINOR = 0
     PATCH = 0
-    PRE = "rc2"
+    PRE = "rc4"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc2
+  version: 4.0.0.rc4
 platform: ruby
 authors:
 - ViewComponent Team
@@ -59,6 +59,27 @@ files:
 - app/views/view_components/preview.html.erb
 - app/views/view_components/previews.html.erb
 - docs/CHANGELOG.md
+- lib/generators/view_component/abstract_generator.rb
+- lib/generators/view_component/component/component_generator.rb
+- lib/generators/view_component/component/templates/component.rb.tt
+- lib/generators/view_component/erb/erb_generator.rb
+- lib/generators/view_component/erb/templates/component.html.erb.tt
+- lib/generators/view_component/haml/haml_generator.rb
+- lib/generators/view_component/haml/templates/component.html.haml.tt
+- lib/generators/view_component/locale/locale_generator.rb
+- lib/generators/view_component/preview/preview_generator.rb
+- lib/generators/view_component/preview/templates/component_preview.rb.tt
+- lib/generators/view_component/rspec/rspec_generator.rb
+- lib/generators/view_component/rspec/templates/component_spec.rb.tt
+- lib/generators/view_component/slim/slim_generator.rb
+- lib/generators/view_component/slim/templates/component.html.slim.tt
+- lib/generators/view_component/stimulus/stimulus_generator.rb
+- lib/generators/view_component/stimulus/templates/component_controller.js.tt
+- lib/generators/view_component/stimulus/templates/component_controller.ts.tt
+- lib/generators/view_component/tailwindcss/tailwindcss_generator.rb
+- lib/generators/view_component/tailwindcss/templates/component.html.erb.tt
+- lib/generators/view_component/test_unit/templates/component_test.rb.tt
+- lib/generators/view_component/test_unit/test_unit_generator.rb
 - lib/view_component.rb
 - lib/view_component/base.rb
 - lib/view_component/collection.rb