view_component 3.25.0 → 4.0.0.alpha1

data/app/helpers/preview_helper.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module PreviewHelper
-  # :nocov:
-  include ActionView::Helpers::AssetUrlHelper if Rails.version.to_f < 6.1
-  # :nocov:
-
-  AVAILABLE_PRISM_LANGUAGES = %w[ruby erb haml]
-  FALLBACK_LANGUAGE = "ruby"
-
-  def preview_source
-    return if @render_args.nil?
-
-    render "preview_source"
-  end
-
-  def prism_css_source_url
-    serve_static_preview_assets? ? asset_path("prism.css", skip_pipeline: true) : "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/themes/prism.min.css"
-  end
-
-  def prism_js_source_url
-    serve_static_preview_assets? ? asset_path("prism.min.js", skip_pipeline: true) : "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/prism.min.js"
-  end
-
-  def find_template_data_for_preview_source(lookup_context:, template_identifier:)
-    template = lookup_context.find_template(template_identifier)
-
-    if Rails.version.to_f >= 6.1 || template.source.present?
-      {
-        source: template.source,
-        prism_language_name: prism_language_name_by_template(template: template)
-      }
-    # :nocov:
-    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.config.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 |path|
-        path =~ /#{template_identifier}*.(html)/
-      end
-
-      raise ViewComponent::NoMatchingTemplatesForPreviewError.new(template_identifier) if matching_templates.empty?
-      raise ViewComponent::MultipleMatchingTemplatesForPreviewError.new(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)
-
-      {
-        source: template_source,
-        prism_language_name: prism_language_name
-      }
-    end
-    # :nocov:
-  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
-
-  # :nocov:
-  def prism_language_name_by_template_path(template_file_path:)
-    language = template_file_path.gsub(".html", "").split(".").last
-
-    return FALLBACK_LANGUAGE unless AVAILABLE_PRISM_LANGUAGES.include? language
-
-    language
-  end
-  # :nocov:
-
-  def serve_static_preview_assets?
-    ViewComponent::Base.config.show_previews && Rails.application.config.public_file_server.enabled
-  end
-end

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

@@ -1,17 +0,0 @@
-<link href="<%= prism_css_source_url %>" media="screen" rel="stylesheet" type="text/css">
-<div class="view-component-source-example">
-  <h2>Source:</h2>
-  <pre class="source">
-    <% if @render_args[:component] %>
-      <code class="language-ruby">
-        <%= h @preview.preview_source(@example_name) %>
-      </code>
-    <% else %>
-      <% template_data = find_template_data_for_preview_source(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>
-</div>
-<script type="text/javascript" src="<%= prism_js_source_url %>"></script>

data/lib/rails/generators/abstract_generator.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module AbstractGenerator
-    def copy_view_file
-      template "component.html.#{engine_name}", destination unless options["inline"]
-    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.view_component_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/rails/generators/component/component_generator.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/abstract_generator"
-
-module Rails
-  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 :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}#{"_component" unless options[:skip_suffix]}.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.component_parent_class || default_parent_class
-      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["inline"]
-      end
-
-      def default_parent_class
-        defined?(ApplicationComponent) ? ApplicationComponent : ViewComponent::Base
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-<% module_namespacing do -%>
-class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
-<%- 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/rails/generators/erb/component_generator.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/erb"
-require "rails/generators/abstract_generator"
-
-module Erb
-  module Generators
-    class ComponentGenerator < Base
-      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 :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/rails/generators/erb/templates/component.html.erb.tt

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

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/erb/component_generator"
-
-module Haml
-  module Generators
-    class ComponentGenerator < Erb::Generators::ComponentGenerator
-      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/rails/generators/haml/templates/component.html.haml.tt

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

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

@@ -1,46 +0,0 @@
-# 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.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/rails/generators/preview/component_generator.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Preview
-  module Generators
-    class ComponentGenerator < ::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.preview_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/rails/generators/preview/templates/component_preview.rb.tt

@@ -1,9 +0,0 @@
-# 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/rails/generators/rspec/component_generator.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/abstract_generator"
-
-module Rspec
-  module Generators
-    class ComponentGenerator < ::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/rails/generators/rspec/templates/component_spec.rb.tt

@@ -1,15 +0,0 @@
-# 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/rails/generators/slim/component_generator.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/erb/component_generator"
-
-module Slim
-  module Generators
-    class ComponentGenerator < Erb::Generators::ComponentGenerator
-      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/rails/generators/slim/templates/component.html.slim.tt

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

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/abstract_generator"
-
-module Stimulus
-  module Generators
-    class ComponentGenerator < ::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/rails/generators/stimulus/templates/component_controller.js.tt

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

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

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

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/erb/component_generator"
-
-module Tailwindcss
-  module Generators
-    class ComponentGenerator < Erb::Generators::ComponentGenerator
-      source_root File.expand_path("templates", __dir__)
-    end
-  end
-end

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

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

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module TestUnit
-  module Generators
-    class ComponentGenerator < ::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/rails/generators/test_unit/templates/component_test.rb.tt

@@ -1,12 +0,0 @@
-# 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/view_component/component_error.rb

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

data/lib/view_component/rails/tasks/view_component.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-task stats: "view_component:statsetup"
-
-namespace :view_component do
-  task :statsetup do
-    # :nocov:
-    require "rails/code_statistics"
-
-    if Rails.root.join(ViewComponent::Base.view_component_path).directory?
-      ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
-    end
-
-    if Rails.root.join("test/components").directory?
-      ::STATS_DIRECTORIES << ["ViewComponent tests", "test/components"]
-      CodeStatistics::TEST_TYPES << "ViewComponent tests"
-    end
-    # :nocov:
-  end
-end

data/lib/view_component/render_component_helper.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module RenderComponentHelper # :nodoc:
-    def render_component(component, &block)
-      component.set_original_view_context(__vc_original_view_context) if is_a?(ViewComponent::Base)
-      component.render_in(self, &block)
-    end
-  end
-end

data/lib/view_component/render_component_to_string_helper.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module RenderComponentToStringHelper # :nodoc:
-    def render_component_to_string(component)
-      component.render_in(view_context)
-    end
-  end
-end

data/lib/view_component/render_monkey_patch.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module RenderMonkeyPatch # :nodoc:
-    def render(options = {}, args = {}, &block)
-      if options.respond_to?(:render_in)
-        options.render_in(self, &block)
-      else
-        super
-      end
-    end
-  end
-end

data/lib/view_component/render_to_string_monkey_patch.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module RenderToStringMonkeyPatch # :nodoc:
-    def render_to_string(options = {}, args = {})
-      if options.respond_to?(:render_in)
-        options.render_in(view_context)
-      else
-        super
-      end
-    end
-  end
-end