ariadne_view_components 0.0.93.1 → 0.0.94

data/lib/ariadne/yard/docs_helper.rb

@@ -6,7 +6,7 @@ module Ariadne
   module Yard
     # Helper methods to use for yard documentation
     module DocsHelper
-      def one_of(enumerable, lower: false, sort: true)
+      def one_of(enumerable, lower: false, sort: false)
         # Sort the array if requested
         if sort && !enumerable.nil?
           enumerable = enumerable.sort do |a, b|
@@ -36,8 +36,8 @@ module Ariadne
         "[Accessibility](#accessibility)"
       end
 
-      def link_to_system_arguments_docs
-        "[System arguments](/system-arguments)"
+      def link_to_html_attrs_docs
+        "[HTML attributes](/html-attrs)"
       end
 
       def link_to_typography_docs
@@ -45,32 +45,40 @@ module Ariadne
       end
 
       def link_to_component(component)
-        status_module, short_name, class_name = status_module_and_short_name(component)
-        status_path = status_module.nil? ? "" : "#{status_module}/"
+        class_name, short_name = component_and_short_name(component)
 
-        "[#{class_name}](/components/#{status_path}#{short_name.downcase})"
+        "[#{class_name}](/components/#{short_name.downcase})"
       end
 
-      def link_to_octicons
-        "[Octicon](https://primer.style/octicons/)"
+      def link_to_heroicons
+        "[Heroicon](https://heroicons.com/)"
       end
 
       def link_to_heading_practices
         "[Learn more about best heading practices (WAI Headings)](https://www.w3.org/WAI/tutorials/page-structure/headings/)"
       end
 
-      def status_module_and_short_name(component)
-        name_with_status = component.name.gsub(/Ariadne::|Component/, "")
-
-        m = name_with_status.match(/(?<status>Beta|Alpha|Deprecated)?(?<_colons>::)?(?<name>.*)/)
-        [m[:status]&.downcase, m[:name].gsub("::", ""), m[:name]]
+      def component_and_short_name(component)
+        name = component.name.sub("::Preview", "::Component")
+        m = name.match(/Ariadne::(?<name>.*)::Component/)
+        if m.nil? # e.g. `Ariadne::Behaviors::Caption`; three paths instad of four
+          m = name.match(/Ariadne::(?<name>.*)/)
+        end
+        [name, m[:name]]
       end
 
       def pretty_default_value(tag, component)
-        params = tag.object.parameters.find { |param| [tag.name.to_s, "#{tag.name}:"].include?(param[0]) }
-        default = tag.defaults&.first || params&.second
+        default = tag.respond_to?(:defaults) ? tag.defaults : nil
+
+        # For slots; eg.,
+        # `renders_one :title, lambda { |type: :subheading, **options|`;
+        # `type` has a default value of `:subheading`.
+        if default.nil?
+          results = /#{tag.name}:\s*([^,\s]+)/.match(tag.object.source)
+          default = results[1] if results
+        end
 
-        return "N/A" unless default
+        return "" unless default
 
         constant_name = "#{component.name}::#{default}"
         constant_value = default.safe_constantize || constant_name.safe_constantize

data/lib/ariadne/yard/dry_initializer/common_handler.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Yard
+    module DryInitializer
+      module CommonHandler
+        def process
+          return unless reader?
+
+          # Define reader method
+          object = YARD::CodeObjects::MethodObject.new(namespace, reader_name)
+          register(object)
+          object.visibility = reader_visibility
+          object.dynamic = true
+          doc = "Reader method for the +#{definition_name}+ initializer parameter."
+          object.docstring = [comment, doc].compact.join("\n\n")
+
+          # Register as attribute unless it is already registered
+          return if namespace.attributes[:instance].key?(reader_name.to_sym)
+
+          namespace.attributes[:instance][reader_name.to_sym] = { read: object }
+        end
+
+        protected
+
+        def constructor
+          return @constructor if defined?(@constructor)
+
+          existing = namespace.meths.find(&:constructor?)
+          unless existing
+            @constructor = create_constructor
+            return @constructor
+          end
+
+          @constructor = if existing.namespace == namespace
+            existing
+          else
+            copy_parent_constructor(existing)
+          end
+        end
+
+        def create_constructor
+          YARD::CodeObjects::MethodObject.new(namespace, :initialize)
+        end
+
+        def copy_parent_constructor(existing_constructor)
+          YARD::CodeObjects::MethodObject.new(namespace, :initialize) do |new_constructor|
+            existing_constructor.copy_to(new_constructor)
+
+            # To allow replace arguments independent of parent
+            new_constructor.parameters = existing_constructor.parameters.map(&:dup)
+            # new_constructor.add_tag(*existing_constructor.tags.map(&:dup))
+          end
+        end
+
+        def definition_name
+          statement.parameters.first.jump(:tstring_content, :ident).source.delete(":") # FIXME: sometimes this randomly returns a symbol
+        end
+
+        def options
+          raw_options = statement.parameters[2] || statement.parameters[1]
+          return {} unless raw_options
+
+          raw_options.map do |o|
+            [o.first.jump(:tstring_content, :ident).source, o[1]]
+          end.to_h
+        end
+
+        def reader?
+          return true unless options.key?("reader:")
+
+          options["reader:"].jump(:tstring_content, :ident).source != "false"
+        end
+
+        def reader_name
+          if options.key?("as:")
+            options["as:"].jump(:tstring_content, :ident).source
+          else
+            definition_name
+          end
+        end
+
+        def reader_visibility
+          return :public unless options.key?("reader:")
+
+          options["reader:"].jump(:tstring_content, :ident).source.to_sym
+        end
+
+        def comment
+          return unless options.key?("comment:")
+
+          options["comment:"].jump(:tstring_content, :ident).source
+        end
+
+        def default_string
+          return options["default:"][1].source if options.key?("default:")
+
+          "nil" if options.key?("optional:") && options["optional:"].jump(:tstring_content, :ident).source == "true"
+        end
+      end
+    end
+  end
+end

data/lib/ariadne/yard/dry_initializer/option_handler.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Yard
+    module DryInitializer
+      # :nodoc:
+      class OptionHandler < ::YARD::Handlers::Ruby::Base
+        include CommonHandler
+
+        handles method_call(:option)
+        namespace_only
+
+        def process
+          super
+
+          parsed_docstring = YARD::DocstringParser.new.parse(statement.docstring)
+          existing_tag = parsed_docstring.tags.find { |t| t.name == definition_name }
+
+          # missing documentation
+          if existing_tag.nil?
+
+          else
+            defaults = existing_tag.defaults
+            defaults = defaults.join if defaults
+
+            # only docstring has complete description past newlines
+            docstring = statement.docstring.tr("\n", " ")
+
+            # strip out everything except description
+            docstring = docstring[docstring.index(existing_tag.text)..]
+
+            constructor.add_tag(YARD::Tags::DefaultTag.new(:param, docstring, existing_tag.types, existing_tag.name, defaults))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ariadne/yard/dry_initializer/param_handler.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Yard
+    module DryInitializer
+      class ParamHandler < ::YARD::Handlers::Ruby::Base
+        include CommonHandler
+
+        handles method_call(:param)
+        namespace_only
+
+        def process
+          super
+
+          add_constructor_param
+          add_constructor_tag
+        end
+
+        protected
+
+        def add_constructor_param
+          existing_index = constructor.parameters.index do |name, _default|
+            name == definition_name
+          end
+          if existing_index
+            constructor.parameters[existing_index] = [definition_name, default_string]
+          else
+            constructor.parameters.insert(last_param_index, [definition_name, default_string])
+          end
+        end
+
+        def last_param_index
+          return -1 if constructor.parameters.empty?
+
+          constructor.parameters.last.first.start_with?("**") ? -2 : -1
+        end
+
+        def add_constructor_tag
+          if existing_tag
+            existing_tag.text = comment
+            existing_tag.instance_variable_set(:@defaults, default_string && [default_string])
+          else
+            param = YARD::Tags::DefaultTag.new(:param, comment, nil, definition_name, [default_string])
+            constructor.add_tag(param)
+          end
+        end
+
+        def existing_tag
+          @existing_tag ||=
+            constructor.tags.find do |tag|
+              tag.name == definition_name && tag.tag_name == "param"
+            end
+        end
+      end
+    end
+  end
+end

data/lib/ariadne/yard/registry.rb

@@ -22,16 +22,13 @@ module Ariadne
 
       def metadata
         @metadata ||= begin
-          status_module, short_name, class_name = status_module_and_short_name(component)
-          status = component.status.to_s
+          class_name, short_name = component_and_short_name(component)
           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,
           }
@@ -99,7 +96,7 @@ module Ariadne
     # documentation.
     class Registry
       class << self
-        include ViewComponent::TestHelpers
+        include ::ViewComponent::TestHelpers
         include Ariadne::ViewHelper
         include Ariadne::Yard::DocsHelper
 

data/lib/ariadne/yard/{info_arch_docs_helper.rb → structure_docs_helper.rb}

@@ -4,15 +4,15 @@
 module Ariadne
   module Yard
     # Helper methods to use for info arch yard documentation
-    module InfoArchDocsHelper
+    module StructureDocsHelper
       include DocsHelper
 
       def link_to_component(component)
         "{{#link_to_component}}#{component}{{/link_to_component}}"
       end
 
-      def link_to_system_arguments_docs
-        "{{link_to_system_arguments_docs}}"
+      def link_to_html_attrs_docs
+        "{{link_to_html_attrs_docs}}"
       end
 
       def link_to_typography_docs
@@ -23,8 +23,8 @@ module Ariadne
         "{{link_to_accessibility}}"
       end
 
-      def link_to_octicons
-        "{{link_to_octicons}}"
+      def link_to_heroicons
+        "{{link_to_heroicons}}"
       end
     end
   end

data/lib/ariadne/yard.rb

@@ -1,18 +1,30 @@
 # frozen_string_literal: true
 
+require "rails"
 require "yard"
+require "ariadne/yard/renders_one_handler"
+require "ariadne/yard/renders_many_handler"
+require "ariadne/yard/dry_initializer/common_handler"
+require "ariadne/yard/dry_initializer/param_handler"
+require "ariadne/yard/dry_initializer/option_handler"
+require "view_component-contrib"
 
 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"
+    autoload :Backend, "ariadne/yard/backend"
+    autoload :ComponentManifest,  "ariadne/yard/component_manifest"
+    autoload :ComponentRef,       "ariadne/yard/component_ref"
+    autoload :DocsHelper, "ariadne/yard/docs_helper"
+    autoload :StructureDocsHelper, "ariadne/yard/structure_docs_helper"
+    autoload :Registry,           "ariadne/yard/registry"
+    autoload :RendersManyHandler, "ariadne/yard/renders_many_handler"
+    autoload :RendersOneHandler,  "ariadne/yard/renders_one_handler"
+
+    # for dry-initializer
+    autoload :CommonHandler, "ariadne/yard/dry_initializer/common_handler"
+    autoload :OptionHandler, "ariadne/yard/dry_initializer/option_handler"
+    autoload :ParamHandler, "ariadne/yard/dry_initializer/param_handler"
 
     ::YARD::Tags::Library.define_tag("Snapshot preview", :snapshot)
   end

data/lib/rubocop/config/default.yml

@@ -3,6 +3,3 @@ require:
 
 AllCops:
   DisabledByDefault: true
-
-Ariadne/NoTagMemoize:
-  Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ariadne_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.93.1
+  version: 0.0.94
 platform: ruby
 authors:
 - Garen J. Torikian
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tailwind_merge
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-description: 
+description:
 email:
 - gjtorikian@yetto.app
 executables: []
@@ -127,7 +127,6 @@ files:
 - app/assets/stylesheets/ariadne_view_components.css.gz
 - app/components/ariadne/ariadne-form.ts
 - app/components/ariadne/base_component.rb
-- app/components/ariadne/behaviors/captionable.rb
 - app/components/ariadne/behaviors/tooltipable.rb
 - app/components/ariadne/conditional_wrapper.rb
 - app/components/ariadne/form/base_component.rb
@@ -182,10 +181,6 @@ files:
 - app/components/ariadne/layout/two_panel/component.rb
 - app/components/ariadne/layout/wide/component.html.erb
 - app/components/ariadne/layout/wide/component.rb
-- app/components/ariadne/turbo/frame/component.html.erb
-- app/components/ariadne/turbo/frame/component.rb
-- app/components/ariadne/turbo/stream_action/component.html.erb
-- app/components/ariadne/turbo/stream_action/component.rb
 - app/components/ariadne/ui/accordion/component.html.erb
 - app/components/ariadne/ui/accordion/component.rb
 - app/components/ariadne/ui/accordion/component.ts
@@ -195,6 +190,9 @@ files:
 - app/components/ariadne/ui/avatar/component.rb
 - app/components/ariadne/ui/badge/component.html.erb
 - app/components/ariadne/ui/badge/component.rb
+- app/components/ariadne/ui/banner/component.html.erb
+- app/components/ariadne/ui/banner/component.rb
+- app/components/ariadne/ui/banner/component.ts
 - app/components/ariadne/ui/blankslate/component.html.erb
 - app/components/ariadne/ui/blankslate/component.rb
 - app/components/ariadne/ui/button/component.html.erb
@@ -215,14 +213,13 @@ files:
 - app/components/ariadne/ui/combobox/component.html.erb
 - app/components/ariadne/ui/combobox/component.rb
 - app/components/ariadne/ui/combobox/component.ts
-- app/components/ariadne/ui/data_table/component.html.erb
-- app/components/ariadne/ui/data_table/component.rb
+- app/components/ariadne/ui/dialog/body/component.html.erb
+- app/components/ariadne/ui/dialog/body/component.rb
 - app/components/ariadne/ui/dialog/component.html.erb
 - app/components/ariadne/ui/dialog/component.rb
 - app/components/ariadne/ui/dialog/component.ts
-- app/components/ariadne/ui/flash/component.html.erb
-- app/components/ariadne/ui/flash/component.rb
-- app/components/ariadne/ui/flash/component.ts
+- app/components/ariadne/ui/dialog/footer/component.html.erb
+- app/components/ariadne/ui/dialog/footer/component.rb
 - app/components/ariadne/ui/heroicon/component.html.erb
 - app/components/ariadne/ui/heroicon/component.rb
 - app/components/ariadne/ui/image/component.rb
@@ -233,14 +230,15 @@ files:
 - app/components/ariadne/ui/list/component.ts
 - app/components/ariadne/ui/list/item/component.html.erb
 - app/components/ariadne/ui/list/item/component.rb
-- app/components/ariadne/ui/overlay/component.html.erb
-- app/components/ariadne/ui/overlay/component.rb
-- app/components/ariadne/ui/overlay/component.ts
 - app/components/ariadne/ui/pagination/component.html.erb
 - app/components/ariadne/ui/pagination/component.rb
 - app/components/ariadne/ui/popover/component.html.erb
 - app/components/ariadne/ui/popover/component.rb
 - app/components/ariadne/ui/popover/component.ts
+- app/components/ariadne/ui/relative_time/component.html.erb
+- app/components/ariadne/ui/relative_time/component.rb
+- app/components/ariadne/ui/relative_time/component.ts
+- app/components/ariadne/ui/relative_time/en.yml
 - app/components/ariadne/ui/shortcut/component.html.erb
 - app/components/ariadne/ui/shortcut/component.rb
 - app/components/ariadne/ui/shortcut/component.ts
@@ -260,10 +258,6 @@ files:
 - app/components/ariadne/ui/table/header/component.rb
 - app/components/ariadne/ui/table/row/component.html.erb
 - app/components/ariadne/ui/table/row/component.rb
-- app/components/ariadne/ui/time_ago/component.html.erb
-- app/components/ariadne/ui/time_ago/component.rb
-- app/components/ariadne/ui/time_ago/component.ts
-- app/components/ariadne/ui/time_ago/en.yml
 - app/components/ariadne/ui/typography/component.html.erb
 - app/components/ariadne/ui/typography/component.rb
 - app/frontend/ariadne/index.ts
@@ -275,9 +269,12 @@ files:
 - app/frontend/entrypoints/application.ts
 - app/frontend/stylesheets/ariadne_view_components.css
 - app/frontend/stylesheets/scrollbar.css
+- app/frontend/stylesheets/theme.css
 - app/frontend/utils/createController.ts
 - app/frontend/utils/isMac.ts
+- app/helpers/ariadne/color_helper.rb
 - app/helpers/ariadne/form_helper.rb
+- app/helpers/ariadne/size_helper.rb
 - app/lib/ariadne/attributes_helper.rb
 - app/lib/ariadne/class_name_helper.rb
 - app/lib/ariadne/fetch_or_fallback_helper.rb
@@ -287,6 +284,7 @@ files:
 - app/lib/ariadne/view_component/html_attrs.rb
 - app/lib/ariadne/view_component/style_variants.rb
 - app/lib/ariadne/view_helper.rb
+- lib/ariadne/accessibility.rb
 - lib/ariadne/forms/acts_as_component.rb
 - lib/ariadne/forms/base.html.erb
 - lib/ariadne/forms/base.rb
@@ -307,8 +305,14 @@ files:
 - lib/ariadne/forms/dsl/submit_button_input.rb
 - lib/ariadne/forms/dsl/text_field_input.rb
 - lib/ariadne/forms/utils.rb
+- lib/ariadne/static.rb
+- lib/ariadne/static/generate_arguments.rb
+- lib/ariadne/static/generate_audited_at.rb
+- lib/ariadne/static/generate_constants.rb
+- lib/ariadne/static/generate_previews.rb
+- lib/ariadne/static/generate_statuses.rb
+- lib/ariadne/static/generate_structure.rb
 - lib/ariadne/view_components.rb
-- lib/ariadne/view_components/commands.rb
 - lib/ariadne/view_components/constants.rb
 - lib/ariadne/view_components/engine.rb
 - lib/ariadne/view_components/linters.rb
@@ -316,35 +320,28 @@ files:
 - lib/ariadne/view_components/linters/autocorrectable.rb
 - lib/ariadne/view_components/linters/base_linter.rb
 - lib/ariadne/view_components/linters/tag_tree_helpers.rb
-- lib/ariadne/view_components/statuses.rb
-- lib/ariadne/view_components/upstream.rb
 - lib/ariadne/view_components/version.rb
 - lib/ariadne/yard.rb
 - lib/ariadne/yard/backend.rb
 - lib/ariadne/yard/component_manifest.rb
 - lib/ariadne/yard/component_ref.rb
 - lib/ariadne/yard/docs_helper.rb
-- lib/ariadne/yard/info_arch_docs_helper.rb
+- lib/ariadne/yard/dry_initializer/common_handler.rb
+- lib/ariadne/yard/dry_initializer/option_handler.rb
+- lib/ariadne/yard/dry_initializer/param_handler.rb
 - lib/ariadne/yard/lookbook_docs_helper.rb
-- lib/ariadne/yard/lookbook_pages_backend.rb
 - lib/ariadne/yard/registry.rb
 - lib/ariadne/yard/renders_many_handler.rb
 - lib/ariadne/yard/renders_one_handler.rb
+- lib/ariadne/yard/structure_docs_helper.rb
 - lib/rubocop/config/default.yml
 - lib/rubocop/cop/ariadne.rb
-- lib/rubocop/cop/ariadne/no_tag_memoize.rb
-- static/arguments.yml
-- static/assets/view-components.svg
-- static/classes.yml
-- static/constants.json
-- static/statuses.json
-- static/tailwindcss.yml
 homepage: https://github.com/yettoapp/ariadne
 licenses:
 - AGPL-3.0-or-later
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -360,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ViewComponents + TailwindCSS + Stimulus
 test_files: []

data/app/components/ariadne/behaviors/captionable.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Ariadne
-  module Behaviors
-    module Captionable
-      def with_caption(text, **options)
-        @caption_id = ::Ariadne::ViewHelper.generate_id
-
-        Ariadne::Behaviors::Caption.new(id: @caption_id, text: text, component: self, **options)
-      end
-    end
-
-    class Caption < Ariadne::BaseComponent
-      option :id
-      option :text
-      option :component
-      option :size, default: -> { :sm }
-
-      erb_template <<~ERB
-        <div data-controller="ariadne-tooltip",>
-          <%= render(component) { content } %>
-          <p class="<%= style(:text) %>"><%= text %></p>
-        </div>
-      ERB
-
-      style do
-        base do
-          [
-            "ariadne-text-gray-500",
-          ]
-        end
-
-        variants do
-          size do
-            # w-36
-            sm { "max-w-[min(144px,90vw)]" }
-            # w-52
-            md { "max-w-[min(208px,90vw)]" }
-            # w-96
-            lg { "max-w-[min(384px,90vw)]" }
-          end
-        end
-      end
-
-      style :text do
-        base do
-          [
-            "text-sm",
-            "ariadne-text-gray-500",
-          ]
-        end
-      end
-    end
-  end
-end

data/app/components/ariadne/turbo/frame/component.html.erb

@@ -1,3 +0,0 @@
-<turbo-frame class="contents" id="<%= target %>">
-  <%= render component %>
-</turbo-frame>

data/app/components/ariadne/turbo/frame/component.rb

@@ -1,16 +0,0 @@
-# typed: false
-# frozen_string_literal: true
-
-module Ariadne
-  module Turbo
-    module Frame
-      class Component < Ariadne::BaseComponent
-        option :component
-
-        def target
-          @target ||= component.component_id
-        end
-      end
-    end
-  end
-end

data/app/components/ariadne/turbo/stream_action/component.html.erb

@@ -1,4 +0,0 @@
-<%= helpers.turbo_stream_action_tag(
-  turbo_action,
-  target:, template: (empty? ? "" : render(component)),
-) %>