ariadne_view_components 0.0.10-x86_64-linux

data/lib/yard/docs_helper.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+module YARD
+  # Helper methods to use for yard documentation
+  module DocsHelper
+    def one_of(enumerable, lower: false, sort: true)
+      # Sort the array if requested
+      if sort
+        enumerable = enumerable.sort do |a, b|
+          a.instance_of?(b.class) ? a <=> b : a.class.to_s <=> b.class.to_s
+        end
+      end
+
+      values =
+        case enumerable
+        when Hash
+          enumerable.map do |key, value|
+            "#{pretty_value(key)} (#{pretty_value(value)})"
+          end
+        else
+          enumerable.map do |key|
+            pretty_value(key)
+          end
+        end
+
+      prefix = "One of"
+      prefix = prefix.downcase if lower
+
+      "#{prefix} #{values.to_sentence(last_word_connector: ", or ")}."
+    end
+
+    def link_to_accessibility
+      "[Accessibility](#accessibility)"
+    end
+
+    def link_to_classes_docs
+      "[Classes and attributes](/classes-attributes)"
+    end
+
+    def link_to_attributes_docs
+      "[Classes and attributes](/classes-attributes)"
+    end
+
+    def link_to_typography_docs
+      "[Typography](/system-arguments#typography)"
+    end
+
+    def link_to_component(component)
+      (status_module, short_name) = status_module_and_short_name(component)
+      status_path = status_module.nil? ? "" : "/"
+
+      "[#{short_name}](/components/#{status_path}#{short_name.downcase})"
+    end
+
+    def link_to_heroicons
+      "[Heroicon](https://ariadne.style/heroicons/)"
+    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("::", "")]
+    end
+
+    def pretty_value(val)
+      case val
+      when nil
+        "`nil`"
+      when Symbol
+        "`:#{val}`"
+      else
+        "`#{val}`"
+      end
+    end
+  end
+end

data/lib/yard/renders_many_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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

data/lib/yard/renders_one_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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