ariadne_view_components 0.0.12-x86_64-darwin → 0.0.14-x86_64-darwin

data/lib/ariadne/view_components/statuses.rb

@@ -7,8 +7,8 @@ module Ariadne
   module ViewComponents
     STATUSES = JSON.parse(
       File.read(
-        File.join(File.dirname(__FILE__), "../../../static/statuses.json")
-      )
+        File.join(File.dirname(__FILE__), "../../../static/statuses.json"),
+      ),
     ).freeze
   end
 end

data/lib/ariadne/view_components/version.rb

@@ -2,6 +2,6 @@
 
 module Ariadne
   module ViewComponents
-    VERSION = "0.0.12"
+    VERSION = "0.0.14"
   end
 end

data/lib/rubocop/config/default.yml

@@ -5,4 +5,4 @@ AllCops:
   DisabledByDefault: true
 
 Ariadne/NoTagMemoize:
-  Enabled: true
+  Enabled: false

data/lib/tasks/docs.rake

@@ -47,7 +47,8 @@ namespace :docs do
     # Rails controller for rendering arbitrary ERB
     view_context = ApplicationController.new.tap { |c| c.request = ActionDispatch::TestRequest.create }.view_context
     components = [
-      Ariadne::RichTextAreaComponent,
+      Ariadne::AvatarComponent,
+      Ariadne::AvatarStackComponent,
       Ariadne::CommentComponent,
       Ariadne::BodyComponent,
       Ariadne::BlankslateComponent,
@@ -56,6 +57,8 @@ namespace :docs do
       Ariadne::ContainerComponent,
       Ariadne::ClipboardCopyComponent,
       Ariadne::CounterComponent,
+      Ariadne::DetailsComponent,
+      Ariadne::DropdownComponent,
       Ariadne::GridComponent,
       Ariadne::FlashComponent,
       Ariadne::FlexComponent,
@@ -71,9 +74,12 @@ namespace :docs do
       Ariadne::NarrowContainerComponent,
       Ariadne::PanelBarComponent,
       Ariadne::PillComponent,
+      Ariadne::RichTextAreaComponent,
       Ariadne::SlideoverComponent,
       Ariadne::TabComponent,
-      Ariadne::TabBarComponent,
+      Ariadne::TabContainerComponent,
+      Ariadne::TableNavComponent,
+      Ariadne::TabNavComponent,
       Ariadne::Text,
       Ariadne::TimeAgoComponent,
       Ariadne::TimelineComponent,
@@ -258,115 +264,34 @@ namespace :docs do
       raise
     end
 
-    additional_classes = []
-
-    tailwind_utility_prefixes = ["bg-", "border-", "fill-", "stroke-", "text-"]
-
-    additional_color_classes = [
-      "billy-purple",
-      "state-closed",
-      "state-open",
-    ]
-
-    additional_color_classes.each do |color_class|
-      tailwind_utility_prefixes.each do |prefix|
-        additional_classes.concat([".#{prefix}#{color_class}"])
-      end
-    end
-
-    Dir.glob("./app/components/**/*.rb") do |rb_filename|
-      content = File.read(rb_filename)
-      matches = content.scan(CLASS_REGEX)
-
-      if matches.present?
-        result = matches.flatten.compact.map { |c| c.split(" ") }.flatten.select { |r| r =~ /\A[0-9a-z:\-]+\z/ }.uniq
-        additional_classes.concat(result.map { |r| ".#{r}" }) if result.present?
+    File.open("static/classes.yml", "w") do |f|
+      non_ariadne_classes = classes_found_in_examples.reject { |c| c =~ /(?:ariadne|tiptap)/ }.uniq
+      unless non_ariadne_classes.length.zero?
+        puts "==============================================="
+        puts "===================== ERRORS =================="
+        puts "===============================================\n\n"
+        puts "The following non-Ariadne classes were found: #{non_ariadne_classes.join(", ")}"
+        puts "\n\n==============================================="
+        puts "==============================================="
+        puts "==============================================="
+
+        raise
       end
-    end
 
-    final_list_of_classes = classes_found_in_examples.concat(additional_classes).uniq.sort
-    File.open("static/classes.yml", "w") do |f|
-      f.puts YAML.dump(final_list_of_classes)
+      f.puts YAML.dump(classes_found_in_examples.uniq)
     end
 
     File.open("static/arguments.yml", "w") do |f|
       f.puts YAML.dump(args_for_components)
     end
 
-    # Build system arguments docs from BaseComponent
-    documentation = registry.get(Ariadne::BaseComponent.name)
-    File.open("docs/content/system-arguments.md", "w") do |f|
-      f.puts("---")
-      f.puts("title: System arguments")
-      f.puts("---")
-      f.puts
-      f.puts("<!-- Warning: AUTO-GENERATED file, do not edit. Add code comments to your Ruby instead <3 -->")
-      f.puts
-      f.puts(documentation.base_docstring)
-      f.puts
-
-      initialize_method = documentation.meths.find(&:constructor?)
-
-      f.puts(view_context.render(inline: initialize_method.base_docstring))
-    end
-
-    # Copy over ADR docs and insert them into the nav
-    # puts "Copying ADRs..."
-    # Rake::Task["docs:build_adrs"].invoke
-
     puts "Markdown compiled."
 
     if components_needing_docs.any?
-      puts
-      puts "The following components needs docs. Care to contribute them? #{components_needing_docs.map(&:name).join(", ")}"
+      puts "\nThe following components need documentation. Can you add them? #{components_needing_docs.map(&:name).join(", ")}"
     end
   end
 
-  # task :build_adrs do
-  #   adr_content_dir = File.join("docs", "content", "adr")
-
-  #   FileUtils.rm_rf(File.join(adr_content_dir))
-  #   FileUtils.mkdir(adr_content_dir)
-
-  #   nav_entries = Dir[File.join("adr", "*.md")].sort.map do |orig_path|
-  #     orig_file_name = File.basename(orig_path)
-  #     url_name = orig_file_name.chomp(".md")
-
-  #     file_contents = File.read(orig_path)
-  #     file_contents = <<~CONTENTS.sub(/\n+\z/, "\n")
-  #       <!-- Warning: AUTO-GENERATED file, do not edit. Make changes to the files in the adr/ directory instead. -->
-  #       #{file_contents}
-  #     CONTENTS
-
-  #     title_match = /^# (.+)/.match(file_contents)
-  #     title = title_match[1]
-
-  #     # Don't include initial ADR for recording ADRs
-  #     next nil if title == "Record architecture decisions"
-
-  #     File.write(File.join(adr_content_dir, orig_file_name), file_contents)
-  #     puts "Copied #{orig_path}"
-
-  #     { "title" => title, "url" => "/adr/#{url_name}" }
-  #   end
-
-  #   nav_yaml_file = File.join("docs", "src", "@primer", "gatsby-theme-doctocat", "nav.yml")
-  #   nav_yaml = YAML.load_file(nav_yaml_file)
-  #   adr_entry = {
-  #     "title" => "Architecture decisions",
-  #     "children" => nav_entries.compact,
-  #   }
-
-  #   existing_index = nav_yaml.index { |entry| entry["title"] == "Architecture decisions" }
-  #   if existing_index
-  #     nav_yaml[existing_index] = adr_entry
-  #   else
-  #     nav_yaml << adr_entry
-  #   end
-
-  #   File.write(nav_yaml_file, YAML.dump(nav_yaml))
-  # end
-
   desc "Generate previews from documentation examples"
   task :preview do
     registry = generate_yard_registry

data/static/arguments.yml

@@ -1,4 +1,55 @@
 ---
+- component: Avatar
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/avatar_component.rb
+  parameters:
+  - name: src
+    type: String
+    default: N/A
+    description: The source url of the avatar image.
+  - name: alt
+    type: String
+    default: N/A
+    description: Passed through to alt on img tag.
+  - name: size
+    type: Integer
+    default: "`20`"
+    description: One of `16`, `20`, `24`, `32`, `40`, `48`, or `80`.
+  - name: shape
+    type: Symbol
+    default: "`:circle`"
+    description: Shape of the avatar. One of `:circle` and `:square`.
+  - name: href
+    type: String
+    default: "`nil`"
+    description: The URL to link to. If used, component will be wrapped by an `<a>`
+      tag.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
+- component: AvatarStack
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/avatar_stack_component.rb
+  parameters:
+  - name: tag
+    type: Symbol
+    default: "`:div`"
+    description: One of `:div` and `:span`.
+  - name: align
+    type: Symbol
+    default: "`:left`"
+    description: One of `:left` and `:right`.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
 - component: BaseButton
   source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/base_button.rb
   parameters:
@@ -62,15 +113,16 @@
   - name: scheme
     type: Symbol
     default: "`:default`"
-    description: One of `:danger`, `:default`, `:info`, `:none`, `:success`, or `:warning`.
+    description: One of `:danger`, `:default`, `:info`, `:link`, `:none`, `:success`,
+      or `:warning`.
   - name: size
     type: Symbol
     default: "`BaseButton::DEFAULT_SIZE`"
     description: One of `:lg`, `:md`, `:sm`, `:xl`, or `:xs`.
-  - name: type
-    type: Symbol
-    default: "`:button`"
-    description: One of `:button`, `:reset`, or `:submit`.
+  - name: dropdown
+    type: Boolean
+    default: "`false`"
+    description: Whether or not to render a dropdown caret.
   - name: classes
     type: String
     default: '`""`'
@@ -178,6 +230,46 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
+- component: Details
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/details_component.rb
+  parameters:
+  - name: overlay
+    type: Symbol
+    default: "`:none`"
+    description: Dictates the type of overlay to render with. One of `:default` and
+      `:none`.
+  - name: reset
+    type: Boolean
+    default: "`false`"
+    description: If set to true, it will remove the default caret and remove style
+      from the summary element
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
+- component: Dropdown
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/dropdown_component.rb
+  parameters:
+  - name: overlay
+    type: Symbol
+    default: "`:default`"
+    description: One of `:default` and `:none`.
+  - name: with_caret
+    type: Boolean
+    default: "`false`"
+    description: Whether or not a caret should be rendered in the button.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
 - component: Flash
   source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/flash_component.rb
   parameters:
@@ -293,8 +385,8 @@
     description: One of `outline`, `solid`, or `mini`.
   - name: size
     type: Symbol
-    default: "`:sm`"
-    description: One of `:sm` (`16`), `:md` (`24`), or `:lg` (`128`).
+    default: "`:md`"
+    description: One of `:mu` (`16`), `:sm` (`20`), `:md` (`24`), or `:lg` (`128`).
   - name: attributes
     type: Hash
     default: "`{}`"
@@ -430,7 +522,7 @@
   - name: color
     type: String
     default: N/A
-    description: The hex color of the pill.
+    description: The rgba color of the pill.
   - name: classes
     type: String
     default: '`""`'
@@ -476,7 +568,7 @@
   - name: form_id
     type: String
     default: "`nil`"
-    description: The ID of any <form> tag to submit when the button is clicked.
+    description: The ID of any `form` tag to submit when the button is clicked.
   - name: open_text
     type: String
     default: '`"Open"`'
@@ -493,17 +585,41 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
-- component: TabBar
-  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_bar_component.rb
+- component: Tab
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_component.rb
+  parameters:
+  - name: id
+    type: String
+    default: "`nil`"
+    description: The unique ID of the tab.
+  - name: selected
+    type: Boolean
+    default: "`false`"
+    description: Whether the tab is selected or not.
+  - name: with_panel
+    type: Boolean
+    default: "`false`"
+    description: Whether the Tab has an associated panel.
+  - name: href
+    type: String
+    default: "`nil`"
+    description: The link to navigate to when the tab is clicked.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
+- component: TabContainer
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_container_component.rb
   parameters:
-  - name: tag
-    type: Symbol, String
-    default: "`:nav`"
-    description: The rendered tag name.
   - name: sr_label
     type: String
     default: N/A
-    description: A label to introduce these tabs for screen readers.
+    description: Sets an `aria-label` that helps assistive technology users understand
+      the purpose of the tabs.
   - name: classes
     type: String
     default: '`""`'
@@ -512,17 +628,29 @@
     type: Hash
     default: "`{}`"
     description: "[Classes and attributes](/classes-attributes)"
-- component: Tab
-  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_component.rb
+- component: TabNav
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_nav_component.rb
   parameters:
+  - name: label
+    type: String
+    default: N/A
+    description: Sets an `aria-label` that helps assistive technology users understand
+      the purpose of the links, and distinguish it from similar elements.
   - name: tag
     type: Symbol, String
-    default: "`:button`"
+    default: "`:nav`"
     description: The rendered tag name.
-  - name: selected
-    type: Boolean
-    default: "`false`"
-    description: Whether the tab is selected or not.
+  - name: classes
+    type: String
+    default: '`""`'
+    description: "[Classes and attributes](/classes-attributes)"
+  - name: attributes
+    type: Hash
+    default: "`{}`"
+    description: "[Classes and attributes](/classes-attributes)"
+- component: TableNav
+  source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/table_nav_component.rb
+  parameters:
   - name: classes
     type: String
     default: '`""`'

data/static/audited_at.json

@@ -1,4 +1,6 @@
 {
+  "Ariadne::AvatarComponent": "",
+  "Ariadne::AvatarStackComponent": "",
   "Ariadne::BaseButton": "",
   "Ariadne::BaseComponent": "",
   "Ariadne::BlankslateComponent": "",
@@ -9,6 +11,10 @@
   "Ariadne::ContainerComponent": "",
   "Ariadne::Content": "",
   "Ariadne::CounterComponent": "",
+  "Ariadne::DetailsComponent": "",
+  "Ariadne::Dropdown::MenuComponent": "",
+  "Ariadne::Dropdown::MenuComponent::Item": "",
+  "Ariadne::DropdownComponent": "",
   "Ariadne::FlashComponent": "",
   "Ariadne::FlexComponent": "",
   "Ariadne::FooterComponent": "",
@@ -29,8 +35,18 @@
   "Ariadne::PillComponent": "",
   "Ariadne::RichTextAreaComponent": "",
   "Ariadne::SlideoverComponent": "",
-  "Ariadne::TabBarComponent": "",
   "Ariadne::TabComponent": "",
+  "Ariadne::TabContainerComponent": "",
+  "Ariadne::TabNavComponent": "",
+  "Ariadne::TableNavComponent": "",
+  "Ariadne::TableNavComponent::BaseCellItem": "",
+  "Ariadne::TableNavComponent::BaseCellItem::CellItem": "",
+  "Ariadne::TableNavComponent::BaseCellItem::HeaderCellItem": "",
+  "Ariadne::TableNavComponent::BaseRowItem": "",
+  "Ariadne::TableNavComponent::BaseRowItem::HeaderRowItem": "",
+  "Ariadne::TableNavComponent::BaseRowItem::RowItem": "",
+  "Ariadne::TableNavComponent::FooterItem": "",
+  "Ariadne::TableNavComponent::PaginationBarItem": "",
   "Ariadne::Text": "",
   "Ariadne::TimeAgoComponent": "",
   "Ariadne::TimelineComponent": "",