ariadne_view_components 0.0.12 → 0.0.13

data/app/components/ariadne/tab_container_component.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Ariadne
+  # A container for a row of tags. Keyboard support is provided.
+  # @accessibility This component requires you to pass in a `sr_label`
+  # attribute, which will be used to label the tabs for screen readers.
+  class TabContainerComponent < Ariadne::Component
+    DEFAULT_TAG = :"tab-container"
+
+    DEFAULT_CLASSES = ""
+
+    # Tabs and panels to be rendered.
+    #
+    # @param id [String] The unique ID of the tab.
+    # @param selected [Boolean] Whether the tab is selected.
+    # @param classes [String] <%= link_to_classes_docs %>
+    # @param attributes [Hash] <%= link_to_attributes_docs %>
+    renders_many :tabs, lambda { |id:, selected: false, href: "", classes: "", attributes: {}|
+      actual_classes = class_names(selected ? DEFAULT_SELECTED_CLASSES : DEFAULT_UNSELECTED_CLASSES, classes)
+      Ariadne::TabComponent.new(
+        id: id,
+        selected: selected,
+        href: href,
+        with_panel: true,
+
+        classes: actual_classes,
+        attributes: attributes,
+      )
+    }
+
+    # @example Default
+    #
+    #   <%= render(Ariadne::TabContainerComponent.new(sr_label: "Comments")) do |tab_container| %>
+    #     <%= render(Ariadne::TabComponent.new(id: "pub-comment")) do |tab| %>
+    #       <% tab.text { "Tab 1" } %>
+    #       <% tab.panel { "Panel 1" } %>
+    #     <% end %>
+    #     <%= render(Ariadne::TabComponent.new(id: "pub-comment")) do |tab| %>
+    #       <% tab.text { "Tab 2" } %>
+    #       <% tab.panel { "Panel 2" } %>
+    #     <% end %>
+    #   <% end %>
+    #
+    # %>
+    #
+    # @param sr_label [String] Sets an `aria-label` that helps assistive technology users understand the purpose of the tabs.
+    # @param classes [String] <%= link_to_classes_docs %>
+    # @param attributes [Hash] <%= link_to_attributes_docs %>
+    def initialize(sr_label:, classes: "", attributes: {})
+      @tag = DEFAULT_TAG
+      @classes = class_names(
+        DEFAULT_CLASSES,
+        classes,
+      )
+
+      @attributes = attributes
+      @attributes[:"aria-label"] = sr_label
+      @attributes[:role] = :presentation
+    end
+  end
+end

data/app/components/ariadne/tab_nav_component.html.erb

@@ -0,0 +1,7 @@
+<%= render Ariadne::BaseComponent.new(tag: @tag, classes: @classes, attributes: @attributes) do |component| %>
+  <ul class="ariadne-list-none">
+    <% tabs.each do |tab| %>
+      <li class="inline-flex"><%= tab %></li>
+    <% end %>
+  </ul>
+<% end %>

data/app/components/ariadne/tab_nav_component.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Ariadne
+  # Use `TabNavComponent` to style navigation links, typically placed at the top
+  # of the page.
+  #
+  # For panel navigation, use <%= link_to_component(Ariadne::TabContainerComponent) %> instead.
+  #
+  # @accessibility
+  #   - By default, `TabNavComponent` renders links within a `<nav>` element. `<nav>` has an
+  #     implicit landmark role of `navigation` which should be reserved for main links.
+  #     For all other set of links, set tag to `:div`.
+  #   - See <%= link_to_component(Ariadne::TabComponent) %> for additional
+  #     accessibility considerations.
+  class TabNavComponent < Ariadne::Component
+    DEFAULT_TAG = :nav
+    TAG_OPTIONS = [DEFAULT_TAG, :div].freeze
+
+    BODY_TAG_DEFAULT = :ul
+
+    # keep this consistent with tab-container-component.ts
+    SELECTED_CLASSES = "ariadne-border-indigo-500 ariadne-text-indigo-600"
+    UNSELECTED_CLASSES = "ariadne-text-gray-500 hover:ariadne-text-gray-700 hover:ariadne-border-gray-300"
+
+    DEFAULT_CLASSES = ""
+
+    # Tabs to be rendered. Use the tabs to list page links.
+    #
+    # @param selected [Boolean] Whether the tab is selected.
+    # @param classes [String] <%= link_to_classes_docs %>
+    # @param attributes [Hash] <%= link_to_attributes_docs %>
+    renders_many :tabs, lambda { |selected: false, href: "", classes: "", attributes: {}|
+      attributes[:href] = href
+      attributes[:"data-tab-nav-component-target"] = "tab"
+      attributes[:"data-action"] = "click->tab-nav-component#toggle"
+
+      actual_classes = class_names(selected ? SELECTED_CLASSES : UNSELECTED_CLASSES, classes)
+      Ariadne::TabComponent.new(
+        selected: selected,
+
+        classes: actual_classes,
+        attributes: attributes,
+      )
+    }
+
+    # @example Default with `<nav>`
+    #   @description
+    #     `<nav>` is a landmark and should be reserved for main navigation links. See <%= link_to_accessibility %>.
+    #   @code
+    #     <%= render(Ariadne::TabNavComponent.new(label: "Nav")) do |c| %>
+    #       <% c.tab(selected: true, href: "#") { "Tab 1" } %>
+    #       <% c.tab(href: "#") { "Tab 2" } %>
+    #       <% c.tab(href: "#") { "Tab 3" } %>
+    #     <% end %>
+    #
+    # @param label [String] Sets an `aria-label` that helps assistive technology users understand the purpose of the links, and distinguish it from similar elements.
+    # @param tag [Symbol, String] The rendered tag name.
+    # @param classes [String] <%= link_to_classes_docs %>
+    # @param attributes [Hash] <%= link_to_attributes_docs %>
+    def initialize(label:, tag: DEFAULT_TAG, classes: "", attributes: {})
+      @tag = check_incoming_tag(DEFAULT_TAG, tag)
+      @classes = class_names(
+        DEFAULT_CLASSES,
+        classes,
+      )
+
+      @attributes = attributes
+      @attributes[:"aria-label"] = label
+      @attributes[:"data-controller"] = "tab-nav-component"
+    end
+  end
+end

data/app/components/ariadne/table_component.html.erb

@@ -0,0 +1,17 @@
+<div class="ariadne-inline-block ariadne-min-w-full ariadne-py-2 ariadne-align-middle md:ariadne-px-6 lg:ariadne-px-8">
+  <div class="ariadne-overflow-hidden ariadne-shadow ariadne-ring-1 ariadne-ring-black ariadne-ring-opacity-5 md:ariadne-rounded-lg">
+    <%= render Ariadne::BaseComponent.new(tag: @tag, classes: @classes, attributes: @attributes) do |component| %>
+      <% if has_header_row? %>
+        <%= header_row %>
+      <% end %>
+      <ul class="ariadne-divide-y ariadne-divide-gray-200 ariadne-bg-white">
+        <% rows.each do |row| %>
+          <%= row %>
+        <% end %>
+      </ul>
+    <% end %>
+  </div>
+  <% if has_footer? %>
+    <%= footer %>
+  <% end %>
+</div>

data/app/components/ariadne/table_component.rb

@@ -0,0 +1,281 @@
+# frozen_string_literal: true
+
+module Ariadne
+  # Add a general description of component here
+  # Add additional usage considerations or best practices that may aid the user to use the component correctly.
+  # @accessibility Add any accessibility considerations
+  class TableComponent < Ariadne::Component
+    DEFAULT_CLASSES = "ariadne-min-w-full ariadne-divide-y ariadne-divide-gray-300 flex flex-col"
+
+    renders_one :header_row, "HeaderRowItem"
+
+    renders_many :rows, "RowItem"
+
+    renders_one :footer, "FooterItem"
+
+    # @example Default
+    #
+    # <%= render(Ariadne::TableComponent.new) do |table| %>
+    #   <%= table.header_row do |header_row| %>
+    #     <% header_row.cell do %>
+    #       State
+    #     <% end %>
+    #   <% end %>
+    #   <%= table.row do |row| %>
+    #     <% row.cell do %>
+    #       "California"
+    #     <% end %>
+    #   <% end %>
+    #   <%= table.row do |row| %>
+    #     <% row.cell do %>
+    #       "New York"
+    #     <% end %>
+    #   <% end %>
+    #   <%= table.row do |row| %>
+    #     <% row.cell do %>
+    #       "Texas"
+    #     <% end %>
+    #   <% end %>
+    # <% end %>
+    # @param classes [String] <%= link_to_classes_docs %>
+    # @param attributes [Hash] <%= link_to_attributes_docs %>
+    def initialize(classes: "", attributes: {})
+      @tag = :div
+      @classes = class_names(
+        DEFAULT_CLASSES,
+        classes,
+      )
+
+      @attributes = attributes
+    end
+
+    def has_header_row?
+      header_row.present?
+    end
+
+    def has_footer?
+      footer.present?
+    end
+
+    # This component is part of `TableComponent` and should not be
+    # used as a standalone component.
+    class RowItem < Ariadne::Component
+      DEFAULT_ROW_CLASSES = "ariadne-whitespace-nowrap ariadne-py-4 ariadne-pl-4 ariadne-pr-3 ariadne-text-sm sm:ariadne-pl-6 flex flex-row"
+
+      renders_many :cells, lambda { |classes: "", attributes: {}|
+        if @header
+          Ariadne::TableComponent::RowItem::HeaderCellItem.new(classes: classes, attributes: attributes)
+        else
+          Ariadne::TableComponent::RowItem::CellItem.new(classes: classes, attributes: attributes)
+        end
+      }
+
+      # @param link [Hash] #TODO: link attributes
+      def initialize(link: "", classes: "", attributes: {})
+        @header = false
+        @link = link
+
+        @classes = if @link.present?
+          class_names(
+            DEFAULT_ROW_CLASSES,
+            "ariadne-cursor-pointer",
+            classes,
+          )
+        else
+          class_names(
+            DEFAULT_ROW_CLASSES,
+            classes,
+          )
+        end
+
+        @attributes = attributes
+      end
+
+      def call
+        render(Ariadne::BaseComponent.new(tag: :li, classes: @classes, attributes: @attributes)) do
+          if linked?
+            render(Ariadne::LinkComponent.new(href: @link[:href], classes: @link[:classes], attributes: @link[:attributes])) do
+              cells.each do |cell|
+                concat(cell)
+              end
+            end
+          else
+            cells.each do |cell|
+              concat(cell)
+            end
+          end
+        end
+      end
+
+      private def linked?
+        @link.present?
+      end
+
+      # This component is part of `TableComponent` and should not be
+      # used as a standalone component.
+      class HeaderCellItem < Ariadne::TableComponent::RowItem
+        DEFAULT_HEADER_CELL_CLASSES = "ariadne-py-3.5 ariadne-pl-4 pr-3 ariadne-text-left ariadne-text-sm ariadne-font-semibold ariadne-text-gray-900 ariadne-sm:pl-6"
+
+        def initialize(classes: "", attributes: {})
+          @classes = class_names(
+            DEFAULT_HEADER_CELL_CLASSES,
+            classes,
+          )
+
+          @attributes = attributes
+        end
+
+        def call
+          render(Ariadne::BaseComponent.new(tag: :span, classes: @classes, attributes: @attributes)) { content }
+        end
+      end
+
+      # This component is part of `TableComponent` and should not be
+      # used as a standalone component.
+      class CellItem < Ariadne::TableComponent::RowItem
+        DEFAULT_CELL_CLASSES = ""
+
+        def initialize(classes: "", attributes: {})
+          @classes = class_names(
+            DEFAULT_CELL_CLASSES,
+            classes,
+          )
+
+          @attributes = attributes
+        end
+
+        def call
+          render(Ariadne::BaseComponent.new(tag: :span, classes: @classes, attributes: @attributes)) { content }
+        end
+      end
+    end
+
+    # This component is part of `TableComponent` and should not be
+    # used as a standalone component.
+    class HeaderRowItem < Ariadne::TableComponent::RowItem
+      DEFAULT_HEADER_CLASSES = "ariadne-bg-gray-50 flex flex-row"
+
+      def initialize(classes: "", attributes: {})
+        @header = true
+
+        @classes = class_names(
+          DEFAULT_HEADER_CLASSES,
+          classes,
+        )
+
+        @attributes = attributes
+      end
+
+      def call
+        render(Ariadne::BaseComponent.new(tag: :div, classes: @classes, attributes: @attributes)) do
+          cells.each do |cell|
+            concat(cell)
+          end
+        end
+      end
+    end
+
+    # This component is part of `TableComponent` and should not be
+    # used as a standalone component.
+    class FooterItem < Ariadne::Component
+      DEFAULT_CLASSES = "ariadne-border-none ariadne-flex ariadne-items-center ariadne-justify-between ariadne-px-4 ariadne-py-3 sm:ariadne-px-6"
+
+      DEFAULT_RESULT_CLASSES = "ariadne-text-sm ariadne-text-gray-700"
+      renders_one :records_info, lambda { |classes: "", attributes: {}|
+        actual_classes = class_names(DEFAULT_RESULT_CLASSES, classes)
+        Ariadne::BaseComponent.new(tag: :p, classes: actual_classes, attributes: attributes)
+      }
+
+      renders_one :pagination_bar, "Ariadne::TableComponent::PaginationBarItem"
+
+      def initialize(classes: "", attributes: {})
+        @classes = class_names(
+          DEFAULT_CLASSES,
+          classes,
+        )
+
+        @attributes = attributes
+      end
+
+      def call
+        render(Ariadne::BaseComponent.new(tag: :div, classes: @classes, attributes: @attributes)) do
+          records_info.to_s + pagination_bar.to_s
+        end
+      end
+    end
+
+    # This component is part of `TableComponent` and should not be
+    # used as a standalone component.
+    class PaginationBarItem < Ariadne::Component
+      DEFAULT_PREV_PAGE_CLASSES = "ariadne-relative ariadne-inline-flex ariadne-items-center ariadne-rounded-l-md ariadne-border ariadne-border-gray-300 ariadne-bg-white ariadne-px-2 ariadne-py-2 ariadne-text-sm ariadne-font-medium ariadne-text-gray-500 focus:ariadne-z-20"
+      renders_one :prev_page, lambda { |disabled: false, href:, classes: "", attributes: {}|
+        if disabled
+          actual_classes = class_names(DEFAULT_PREV_PAGE_CLASSES, classes)
+
+          render(Ariadne::BaseComponent.new(tag: :span, classes: actual_classes, attributes: attributes)) do
+            render(Ariadne::HeroiconComponent.new(icon: "chevron-left", size: :sm, variant: :mini, text_attributes: { "aria-hidden": true }, text_classes: "ariadne-sr-only"))
+          end
+        else
+          actual_classes = class_names(DEFAULT_PREV_PAGE_CLASSES, "hover:ariadne-bg-gray-50", classes)
+          attributes[:"aria-label"] = "previous"
+
+          render(Ariadne::LinkComponent.new(href: href, classes: actual_classes, attributes: attributes)) do
+            render(Ariadne::HeroiconComponent.new(icon: "chevron-left", size: :sm, variant: :mini, text_attributes: { "aria-hidden": true }, text_classes: "ariadne-sr-only"))
+          end
+        end
+      }
+
+      renders_one :page_list, lambda { |disabled: false, href:, classes: "", attributes: {}|
+        if disabled
+          actual_classes = class_names(DEFAULT_NEXT_PAGE_CLASSES, classes)
+
+          render(Ariadne::BaseComponent.new(tag: :span, classes: actual_classes, attributes: attributes)) do
+            render(Ariadne::HeroiconComponent.new(icon: "chevron-left", size: :sm, variant: :mini, text_attributes: { "aria-hidden": true }, text_classes: "ariadne-sr-only"))
+          end
+        else
+          actual_classes = class_names(DEFAULT_NEXT_PAGE_CLASSES, "hover:ariadne-bg-gray-50", classes)
+          attributes[:"aria-label"] = "next"
+
+          render(Ariadne::LinkComponent.new(href: href, classes: actual_classes, attributes: attributes)) do
+            render(Ariadne::HeroiconComponent.new(icon: "chevron-right", size: :sm, variant: :mini, text_attributes: { "aria-hidden": true }, text_classes: "ariadne-sr-only"))
+          end
+        end
+      }
+
+      DEFAULT_NEXT_PAGE_CLASSES = " ariadne-relative ariadne-inline-flex ariadne-items-center ariadne-rounded-r-md ariadne-border ariadne-border-gray-300 ariadne-bg-white ariadne-px-2 ariadne-py-2 ariadne-text-sm ariadne-font-medium ariadne-text-gray-500 focus:ariadne-z-20"
+      renders_one :next_page, lambda { |disabled: false, href:, classes: "", attributes: {}|
+        if disabled
+          actual_classes = class_names(DEFAULT_NEXT_PAGE_CLASSES, classes)
+
+          render(Ariadne::BaseComponent.new(tag: :span, classes: actual_classes, attributes: attributes)) do
+            render(Ariadne::HeroiconComponent.new(icon: "chevron-left", size: :sm, variant: :mini, text_attributes: { "aria-hidden": true }, text_classes: "ariadne-sr-only"))
+          end
+        else
+          actual_classes = class_names(DEFAULT_NEXT_PAGE_CLASSES, "hover:ariadne-bg-gray-50", classes)
+          attributes[:"aria-label"] = "next"
+
+          render(Ariadne::LinkComponent.new(href: href, classes: actual_classes, attributes: attributes)) do
+            render(Ariadne::HeroiconComponent.new(icon: "chevron-right", size: :sm, variant: :mini, text_attributes: { "aria-hidden": true }, text_classes: "ariadne-sr-only"))
+          end
+        end
+      }
+
+      DEFAULT_PAGINATOR_CLASSES = "ariadne-flex ariadne-items-center ariadne-justify-between ariadne-m-10"
+      def initialize(classes: "", attributes: {})
+        @classes = class_names(
+          DEFAULT_PAGINATOR_CLASSES,
+          classes,
+        )
+
+        @attributes = attributes
+        @attributes[:"aria-label"] ||= "paginator"
+      end
+
+      def call
+        render(Ariadne::BaseComponent.new(tag: :nav, classes: @classes, attributes: @attributes)) do
+          prev_page.to_s + next_page.to_s
+        end
+      end
+    end
+  end
+end

data/app/components/ariadne/time_ago_component.rb

@@ -21,7 +21,7 @@ module Ariadne
       @tag = check_incoming_tag(DEFAULT_TAG, tag)
       @classes = class_names(
         DEFAULT_CLASSES,
-        classes
+        classes,
       )
 
       @time = time

data/app/components/ariadne/timeline_component.rb

@@ -25,7 +25,7 @@ module Ariadne
       @tag = check_incoming_tag(DEFAULT_TAG, tag)
       @classes = class_names(
         DEFAULT_CLASSES,
-        classes
+        classes,
       )
 
       @attributes = attributes

data/app/lib/ariadne/fetch_or_fallback_helper.rb

@@ -22,14 +22,17 @@ module Ariadne
 
     InvalidValueError = Class.new(StandardError)
 
-    TRUE_OR_FALSE = [true, false].freeze
+    TRUE_OR_FALSE = Set.new([true, false]).freeze
 
-    def fetch_or_raise(allowed_values, given_value)
+    INTEGER_TYPES = Set.new(["Integer"]).freeze
+
+    def fetch_or_raise(allowed_values, given_value, against: nil)
       if !allowed_values.is_a?(Array) && !allowed_values.is_a?(Set)
         raise ArgumentError, "allowed_values must be an array or a set; it was #{allowed_values.class}"
       end
 
-      if allowed_values.include?(given_value)
+      check_against_given_value = against || given_value
+      if allowed_values.include?(check_against_given_value)
         given_value
       else
         raise InvalidValueError, <<~MSG
@@ -41,10 +44,15 @@ module Ariadne
       end
     end
 
+    # TODO: use these two more
     def fetch_or_raise_boolean(given_value)
       fetch_or_raise(TRUE_OR_FALSE, given_value)
     end
 
+    def fetch_or_raise_integer(given_value)
+      fetch_or_raise(INTEGER_TYPES, given_value, against: given_value.class.name)
+    end
+
     # TODO: test this
     def check_incoming_tag(preferred_tag, given_tag)
       return preferred_tag if given_tag.blank? || preferred_tag == given_tag

data/app/lib/ariadne/icon_helper.rb

@@ -1,18 +1,11 @@
 # frozen_string_literal: true
 
-# Ariadne::FetchOrFallbackHelper
-# A little helper to enable graceful fallbacks
+# Ariadne::IconHelper
+# A helper that insists on certain values when
+# checking herocions and their varients.
 #
-# Use this helper to quietly ensure a value is
-# one that you expect:
-#
-# allowed_values    - allowed options for *value*
-# given_value       - input being coerced
-# fallback          - returned if *given_value* is not included in *allowed_values*
-#
-# fetch_or_raise([1,2,3], 5) => 2
-# fetch_or_raise([1,2,3], 1) => 1
-# fetch_or_raise([1,2,3], nil) => 2
+# Use this helper to loudly ensure a value is
+# one that you expect.
 module Ariadne
   # :nodoc:
   module IconHelper
@@ -23,11 +16,22 @@ module Ariadne
 
       icon_presence!(icon, variant)
       variant_presence!(icon, variant)
-      fetch_or_raise(HeroiconsHelper::Icon::VALID_VARIANTS, variant)
+      ensure_valid_variant(variant)
 
       true
     end
 
+    def ensure_valid_variant(variant)
+      check_variant = if variant.blank? || !variant.respond_to?(:to_s)
+        ""
+      else
+        variant.to_s
+      end
+
+      fetch_or_raise(HeroiconsHelper::Icon::VALID_VARIANTS, check_variant)
+    end
+    module_function :ensure_valid_variant
+
     def has_partial_icon?(icon, variant)
       icon.present? || variant.present?
     end

data/lib/ariadne/view_components/constants.rb

@@ -8,8 +8,8 @@ module Ariadne
     class Constants
       CONSTANTS = JSON.parse(
         File.read(
-          File.join(File.dirname(__FILE__), "../../../static/constants.json")
-        )
+          File.join(File.dirname(__FILE__), "../../../static/constants.json"),
+        ),
       ).freeze
 
       class << self

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.13"
   end
 end

data/lib/rubocop/config/default.yml

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