ariadne_view_components 0.0.59 → 0.0.65

data/lib/ariadne/yard/registry.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+require "view_component/test_helpers"
+
+module Ariadne
+  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,
+            class_name: 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 do |mtd|
+          mtd.tag(:private) || mtd.name == :initialize
+        end
+      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 manifest_entry
+        @manifest_entry ||= ComponentManifest.ref_for(component)
+      end
+    end
+
+    # Wrapper around an instance of YARD::Registry that provides easy access to component
+    # documentation.
+    class Registry
+      class << self
+        include ViewComponent::TestHelpers
+        include Ariadne::ViewHelper
+        include Ariadne::Yard::DocsHelper
+
+        def make
+          registry = ::YARD::RegistryStore.new
+          registry.load!(File.expand_path(File.join("..", "..", "..", ".yardoc"), __dir__))
+
+          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/ariadne/yard/renders_many_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Ariadne
+  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/ariadne/yard/renders_one_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Ariadne
+  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/ariadne/yard.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "yard"
+
+module Ariadne
+  # :nodoc:
+  module Yard
+    autoload :Backend,            "primer/yard/backend"
+    autoload :ComponentManifest,  "primer/yard/component_manifest"
+    autoload :ComponentRef,       "primer/yard/component_ref"
+    autoload :DocsHelper,         "primer/yard/docs_helper"
+    autoload :InfoArchDocsHelper, "primer/yard/info_arch_docs_helper"
+    autoload :Registry,           "primer/yard/registry"
+    autoload :RendersManyHandler, "primer/yard/renders_many_handler"
+    autoload :RendersOneHandler,  "primer/yard/renders_one_handler"
+
+    ::YARD::Tags::Library.define_tag("Snapshot preview", :snapshot)
+  end
+end

data/static/arguments.yml

@@ -99,6 +99,33 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
+- component: BreadcrumbsComponent
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/breadcrumbs_component.rb
+  parameters:
+  - name: tag
+    type: Symbol, String
+    default: "`:nav`"
+    description: The rendered tag name.
+  - name: items
+    type: Array<Hash>
+    default: "`[]`"
+    description: The items to display in the breadcrumb.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: item_classes
+    type: String
+    default: '`""`'
+    description: List of additional classes to apply to each item.
+  - name: active_item_classes
+    type: String
+    default: '`""`'
+    description: List of additional classes to apply to the active item.
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
 - component: ButtonComponent
   source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/button_component.rb
   parameters:
@@ -131,6 +158,33 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
+- component: CheckboxComponent
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/checkbox_component.rb
+  parameters:
+  - name: tag
+    type: Symbol, String
+    default: "`:label`"
+    description: The rendered tag name.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: input_classes
+    type: String
+    default: '`""`'
+    description: List of additional classes to apply to the input.
+  - name: initial_value
+    type: Boolean
+    default: "`false`"
+    description: The initial value of the checkbox.
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: input_attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
 - component: ClipboardCopyComponent
   source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/clipboard_copy_component.rb
   parameters:
@@ -159,29 +213,44 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
-- component: CommentComponent
-  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/comment_component.rb
+- component: CloseButtonComponent
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/close_button_component.rb
   parameters:
-  - name: url
-    type: String
-    default: N/A
-    description: The URL to take action against.
-  - name: method
-    type: String
-    default: "`:post`"
-    description: The method to use when submitting the form.
-  - name: sr_label
-    type: String
-    default: N/A
-    description: A label to introduce these tabs for screen readers.
-  - name: hidden_fields
-    type: "[String]"
-    default: "`[]`"
-    description: An array of arrays of additional (hidden) fields to add to the form.
+  - name: tag
+    type: Symbol, String
+    default: "`:button`"
+    description: The rendered tag name.
   - name: classes
     type: String
     default: '`""`'
     description: "[Classes and attributes](/classes-attributes)"
+  - name: icon_classes
+    type: String
+    default: '`""`'
+    description: Classes to apply to the icon.
+  - name: size
+    type: Symbol
+    default: "`:xs`"
+    description: One of `:xs` (`16`), `:sm` (`20`), `:md` (`24`), or `:lg` (`128`).
+  - name: aria_label
+    type: String
+    default: "`nil`"
+    description: A label for the button that describes what it will close.
+  - name: scheme
+    type: Symbol
+    default: "`:none`"
+    description: One of `:link` (`ariadne-cursor-pointer ariadne-font-semibold ariadne-underline
+      ariadne-decoration-double`), `:none` (``), `:default` (`ariadne-text-slate-800
+      ariadne-bg-slate-50 hover:ariadne-bg-slate-100 ariadne-border-slate-300 focus:ariadne-ring-offset-slate-50
+      focus:ariadne-ring-slate-600`), `:info` (`ariadne-text-slate-800 ariadne-bg-slate-50
+      hover:ariadne-bg-slate-100 ariadne-border-slate-300 focus:ariadne-ring-offset-blue-50
+      focus:ariadne-ring-slate-600`), `:success` (`ariadne-text-green-800 ariadne-bg-green-50
+      hover:ariadne-bg-green-100 ariadne-border-green-300 focus:ariadne-ring-offset-green-50
+      focus:ariadne-ring-green-600`), `:warning` (`ariadne-text-yellow-800 ariadne-bg-yellow-50
+      hover:ariadne-bg-yellow-100 ariadne-border-yellow-300 focus:ariadne-ring-offset-yellow-50
+      focus:ariadne-ring-yellow-600`), or `:danger` (`ariadne-text-red-800 ariadne-bg-red-50
+      hover:ariadne-bg-red-100 ariadne-border-red-300 focus:ariadne-ring-offset-red-50
+      focus:ariadne-ring-red-600`).
   - name: attributes
     type: Hash
     default: "`{}`"
@@ -240,13 +309,17 @@
   - name: overlay
     type: Symbol
     default: "`:none`"
-    description: Dictates the type of overlay to render with. One of `:default` and
-      `:none`.
+    description: Dictates the type of overlay to render with. One of `:dark`, `:default`,
+      or `:none`.
   - name: reset
     type: Boolean
     default: "`true`"
     description: If set to true, it will remove the default caret and remove style
       from the summary element
+  - name: disabled
+    type: Boolean
+    default: "`false`"
+    description: Whether or not to disable the summary button.
   - name: classes
     type: String
     default: '`""`'
@@ -261,7 +334,7 @@
   - name: overlay
     type: Symbol
     default: "`:default`"
-    description: One of `:default` and `:none`.
+    description: One of `:dark`, `:default`, or `:none`.
   - name: with_caret
     type: Boolean
     default: "`false`"
@@ -524,25 +597,60 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
-- component: RichTextAreaComponent
-  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/rich_text_area_component.rb
+- component: ProgressBarComponent
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/progress_bar_component.rb
   parameters:
-  - name: name
+  - name: tag
+    type: Symbol, String
+    default: "`DEFAULT_TAGS[:wrapper]`"
+    description: The rendered tag name.
+  - name: min
+    type: Integer
+    default: "`0`"
+    description: The minimum value of the progress bar.
+  - name: max
+    type: Integer
+    default: "`100`"
+    description: The maximum value of the progress bar.
+  - name: size
     type: Symbol
-    default: N/A
-    description: Identifies the form/param name for this rich text area.
-  - name: sr_label
+    default: "`:md`"
+    description: One of `:sm` (`ariadne-h-2`), `:md` (`ariadne-h-3`), or `:lg` (`ariadne-h-4`).
+  - name: classes
     type: String
-    default: N/A
-    description: A label to introduce these tabs for screen readers.
-  - name: has_form
-    type: Boolean
-    default: "`true`"
-    description: Indicates whether this component is wrapped in a form.
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
+- component: RelativeTimeComponent
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/relative_time_component.rb
+  parameters:
+  - name: tag
+    type: Symbol, String
+    default: "`:span`"
+    description: The rendered tag name.
   - name: classes
     type: String
     default: '`""`'
     description: "[Classes and attributes](/classes-attributes)"
+  - name: time
+    type: Time
+    default: "`nil`"
+    description: The time to display.
+  - name: format
+    type: String
+    default: "`%b %-d, %Y`"
+    description: The format to display the time in.
+  - name: date_format_switch
+    type: Integer
+    default: "`2592000`"
+    description: The number of seconds after which to switch to the date format.
+  - name: force_relative
+    type: Boolean
+    default: "`false`"
+    description: Force the time to be displayed in relative format.
   - name: attributes
     type: Hash
     default: "`{}`"
@@ -574,21 +682,6 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
-- component: SubheaderComponent
-  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/subheader_component.rb
-  parameters:
-  - name: tag
-    type: Symbol, String
-    default: "`:p`"
-    description: The rendered tag name.
-  - name: classes
-    type: String
-    default: '`""`'
-    description: "[Classes and attributes](/classes-attributes)"
-  - name: attributes
-    type: Hash
-    default: "`{}`"
-    description: "[Classes and attributes](/classes-attributes)"
 - component: TabComponent
   source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_component.rb
   parameters:

data/static/audited_at.json

@@ -1,19 +1,15 @@
 {
-  "Ariadne::ActionCardComponent": "",
   "Ariadne::AvatarComponent": "",
   "Ariadne::AvatarStackComponent": "",
   "Ariadne::BaseButton": "",
   "Ariadne::BaseComponent": "",
   "Ariadne::BlankslateComponent": "",
   "Ariadne::BodyComponent": "",
-  "Ariadne::BottomTabComponent": "",
-  "Ariadne::BottomTabNavComponent": "",
   "Ariadne::BreadcrumbsComponent": "",
   "Ariadne::ButtonComponent": "",
   "Ariadne::CheckboxComponent": "",
   "Ariadne::ClipboardCopyComponent": "",
   "Ariadne::CloseButtonComponent": "",
-  "Ariadne::ComboboxComponent": "",
   "Ariadne::ContainerComponent": "",
   "Ariadne::Content": "",
   "Ariadne::CounterComponent": "",
@@ -31,22 +27,17 @@
   "Ariadne::HeroiconComponent": "",
   "Ariadne::ImageComponent": "",
   "Ariadne::InlineFlexComponent": "",
-  "Ariadne::LayoutComponent": "",
   "Ariadne::LinkComponent": "",
   "Ariadne::ListComponent": "",
   "Ariadne::ListComponent::ListItem": "",
-  "Ariadne::ModalComponent": "",
   "Ariadne::NarrowContainerComponent": "",
   "Ariadne::PanelBarComponent": "",
   "Ariadne::PanelBarComponent::PanelItem": "",
   "Ariadne::PillComponent": "",
-  "Ariadne::PopoverComponent": "",
   "Ariadne::ProgressBarComponent": "",
   "Ariadne::RelativeTimeComponent": "",
-  "Ariadne::ShowMoreButtonComponent": "",
   "Ariadne::SlideoverComponent": "",
   "Ariadne::SpinnerComponent": "",
-  "Ariadne::SubheaderComponent": "",
   "Ariadne::TabComponent": "",
   "Ariadne::TabContainerComponent": "",
   "Ariadne::TabNavComponent": "",