view_component 4.0.0.rc3 → 4.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9389db3857fccdd96788494eb6992ceca37f1934f9587317b806a992f53a599
-  data.tar.gz: 675ca1e487f5724cc5ac33e397fb9b1f2027347c6ca569223e4e5e772150ad05
+  metadata.gz: 2022f4dafcbde4a0b374fc19399e58a9a7ff97ba64b3567de75ec24c9bb9e8eb
+  data.tar.gz: 2936979e68ecbe66cc0cc0b8a9ab77064265cb4d0763974daa6eb22c4b2a4e5d
 SHA512:
-  metadata.gz: 4810cd0a918e52322ef4f0b36b830cbb79cd80b2fce6d9cc680b9b43f5b490e76b412d8504aee3cc577bf6892053ac5ed789fdb14c8c2d71fce582b0011efc95
-  data.tar.gz: b8821ec370dbf668ad03c19b832ccbd8754d0da6a23b131d77f6c4898088214d2d51cb3e0c404ad919a75bf63ea387324f95decf03a497df30f8396650c2cd35
+  metadata.gz: c124cc7b4de10d07896f5c1fd80a2533a606f29de5406836b6d63968261e1de54e1cbe682879a2e20fe66e3173f1178111ce5047177b9130ac359cbdb7b759d0
+  data.tar.gz: 228eee5270b9d0b6d2ac0395151255759fb73faea87365a79fc42b301b7d5ddac0f6d260f040a5801981a067f84f02735624236af86937ed5eee7a2080aad2c9

data/docs/CHANGELOG.md

@@ -10,6 +10,26 @@ nav_order: 6
 
 ## main
 
+## 4.0.0.rc5
+
+* Revert change setting `#format`. In GitHub's codebase, the change led to hard-to-detect failures. For example, components rendered from controllers included layouts when they didn't before. In other cases, the response `content_type` changed, breaking downstream consumers. For cases where a specific content type is needed, use:
+
+```ruby
+respond_to do |f|
+  f.html_fragment do
+    render(MyComponent.new)
+  end
+end
+```
+
+    *Joel Hawksley*
+
+## 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.

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

@@ -71,8 +71,6 @@ module ViewComponent
     # Config option that strips trailing whitespace in templates before compiling them.
     class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false, default: false
 
-    class_attribute :__vc_response_format, instance_accessor: false, instance_predicate: false, default: nil
-
     attr_accessor :__vc_original_view_context
     attr_reader :current_template
 
@@ -356,10 +354,6 @@ module ViewComponent
       __vc_render_in_block_provided? || __vc_content_set_by_with_content_defined?
     end
 
-    def format
-      self.class.__vc_response_format
-    end
-
     # @private
     def with_original_virtual_path
       @view_context.instance_variable_set(:@virtual_path, @old_virtual_path)

data/lib/view_component/compiler.rb

@@ -48,15 +48,6 @@ module ViewComponent
 
         define_render_template_for
 
-        # Set the format if the component only responds to a single format.
-        # Unfortunately we cannot determine which format a multi-format
-        # component will respond to until render time, so those components
-        # will not set the response format.
-        #
-        # TODO: Investigate upstream changes necessary to support multi-format renderables
-        unique_formats = templates.map(&:format).uniq
-        @component.__vc_response_format = unique_formats.last if unique_formats.one?
-
         @component.__vc_register_default_slots
         @component.__vc_build_i18n_backend
 
@@ -118,7 +109,6 @@ module ViewComponent
         errors << "Couldn't find a template file or inline render method for #{@component}." if @templates.empty?
 
         @templates
-          .reject { |template| template.inline_call? && !template.defined_on_self? }
           .map { |template| [template.variant, template.format] }
           .tally
           .select { |_, count| count > 1 }

data/lib/view_component/template.rb

@@ -43,7 +43,7 @@ module ViewComponent
       attr_reader :source
 
       def initialize(component:, inline_template:)
-        details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, DEFAULT_FORMAT, nil)
+        details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, nil, nil)
 
         super(
           component: component,
@@ -63,7 +63,7 @@ module ViewComponent
     class InlineCall < Template
       def initialize(component:, method_name:, defined_on_self:)
         variant = method_name.to_s.include?("call_") ? method_name.to_s.sub("call_", "").to_sym : nil
-        details = ActionView::TemplateDetails.new(nil, nil, DEFAULT_FORMAT, variant)
+        details = ActionView::TemplateDetails.new(nil, nil, nil, variant)
 
         super(component: component, details: details)
 

data/lib/view_component/version.rb

@@ -5,7 +5,7 @@ module ViewComponent
     MAJOR = 4
     MINOR = 0
     PATCH = 0
-    PRE = "rc3"
+    PRE = "rc5"
 
     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.rc3
+  version: 4.0.0.rc5
 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