primer_view_components 0.0.119 → 0.0.120

data/lib/primer/yard/registry.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+require "primer/view_components"
+require "primer/yard/docs_helper"
+require "view_component/test_helpers"
+
+module Primer
+  module YARD
+    # A wrapper around a YARD class reference that provides convenience methods
+    # for extracting component parameters, accessibility status, etc.
+    class RegistryEntry
+      include DocsHelper
+
+      attr_reader :component, :docs
+
+      delegate_missing_to :docs
+
+      def initialize(component, docs)
+        @component = component
+        @docs = docs
+      end
+
+      def metadata
+        @metadata ||= begin
+          status_module, short_name, class_name = status_module_and_short_name(component)
+          status = component.status.to_s
+          a11y_reviewed = component.audited_at.nil? ? "false" : "true"
+
+          {
+            title: class_name,
+            component_id: short_name.underscore,
+            status: status.capitalize,
+            status_module: status_module,
+            short_name: short_name,
+            a11y_reviewed: a11y_reviewed
+          }
+        end
+      end
+
+      def constructor
+        docs.meths.find(&:constructor?)
+      end
+
+      def params
+        constructor.tags(:param)
+      end
+
+      def slot_methods
+        public_methods.select { |mtd| slot_method?(mtd) }
+      end
+
+      def non_slot_methods
+        public_methods.reject { |mtd| slot_method?(mtd) }
+      end
+
+      def slot_method?(mtd)
+        mtd[:renders_one] || mtd[:renders_many]
+      end
+
+      def public_methods
+        # Returns: only public methods that belong to this class (i.e. no inherited methods)
+        # excluding the constructor
+        @public_methods ||=
+          docs.meths.reject { |mtd| mtd.tag(:private) || mtd.name == :initialize }
+      end
+
+      def title
+        metadata[:title]
+      end
+
+      def component_id
+        metadata[:component_id]
+      end
+
+      def status
+        metadata[:status]
+      end
+
+      def status_module
+        metadata[:status_module]
+      end
+
+      def short_name
+        metadata[:short_name]
+      end
+
+      def a11y_reviewed?
+        metadata[:a11y_reviewed]
+      end
+
+      def requires_js?
+        manifest.components_requiring_js.include?(component)
+      end
+
+      def includes_examples?
+        manifest.components_with_examples.include?(component)
+      end
+
+      private
+
+      def manifest
+        Primer::YARD::ComponentManifest
+      end
+    end
+
+    # Wrapper around an instance of YARD::Registry that provides easy access to component
+    # documentation.
+    class Registry
+      class << self
+        include ViewComponent::TestHelpers
+        include Primer::ViewHelper
+        include Primer::YARD::DocsHelper
+
+        def make
+          registry = ::YARD::RegistryStore.new
+          registry.load!(".yardoc")
+
+          new(registry)
+        end
+      end
+
+      attr_reader :yard_registry
+
+      def initialize(yard_registry)
+        @yard_registry = yard_registry
+      end
+
+      def find(component)
+        return entries[component] if entries.include?(component)
+
+        return unless (docs = yard_registry.get(component.name))
+
+        entries[component] = RegistryEntry.new(component, docs)
+      end
+
+      private
+
+      def entries
+        @entries ||= {}
+      end
+    end
+  end
+end
+# :nocov:

data/lib/primer/yard/renders_many_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Primer
+  module YARD
+    # YARD Handler to parse `renders_many` calls.
+    class RendersManyHandler < ::YARD::Handlers::Ruby::Base
+      handles method_call(:renders_many)
+      namespace_only
+
+      process do
+        name = statement.parameters.first.jump(:tstring_content, :ident).source
+        object = ::YARD::CodeObjects::MethodObject.new(namespace, name)
+        register(object)
+        parse_block(statement.last, owner: object)
+
+        object.dynamic = true
+        object[:renders_many] = true
+      end
+    end
+  end
+end
+# :nocov:

data/lib/primer/yard/renders_one_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Primer
+  module YARD
+    # YARD Handler to parse `renders_one` calls.
+    class RendersOneHandler < ::YARD::Handlers::Ruby::Base
+      handles method_call(:renders_one)
+      namespace_only
+
+      process do
+        name = statement.parameters.first.jump(:tstring_content, :ident).source
+        object = ::YARD::CodeObjects::MethodObject.new(namespace, name)
+        register(object)
+        parse_block(statement.last, owner: object)
+
+        object.dynamic = true
+        object[:renders_one] = true
+      end
+    end
+  end
+end
+# :nocov:

data/lib/rubocop/config/default.yml

@@ -15,3 +15,6 @@ Primer/DeprecatedArguments:
 
 Primer/DeprecatedComponents:
   Enabled: true
+
+Primer/TestSelector:
+  Enabled: true

data/lib/rubocop/cop/primer/test_selector.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+# :nocov:
+module RuboCop
+  module Cop
+    module Primer
+      # Prefer the `test_selector` argument over manually generating
+      # a `data-test-selector` attribute.
+      #
+      # Bad:
+      #
+      # Primer::BaseComponent.new(data: { "test-selector": "the-component" })
+      #
+      # Good:
+      #
+      # Primer::BaseComponent.new(test_selector: "the-component")
+      class TestSelector < BaseCop
+        INVALID_MESSAGE = <<~STR
+          Prefer the `test_selector` argument over manually generating a `data-test-selector` attribute: https://primer.style/view-components/system-arguments.
+        STR
+
+        def on_send(node)
+          return unless valid_node?(node)
+          return unless node.arguments?
+
+          kwargs = node.arguments.last
+          return unless kwargs.type == :hash
+
+          data_arg = kwargs.pairs.find { |kwarg| kwarg.key.value == :data }
+          return if data_arg.nil?
+          return unless data_arg.value.type == :hash
+
+          hash = data_arg.child_nodes.find { |arg| arg.type == :hash }
+          return unless hash
+
+          test_selector = hash.pairs.find do |pair|
+            pair.key.value == :"test-selector" || pair.key.value == "test-selector"
+          end
+          return unless test_selector
+
+          add_offense(data_arg, message: INVALID_MESSAGE)
+        end
+      end
+    end
+  end
+end