primer_view_components 0.1.3 → 0.1.5

data/lib/primer/view_components.rb

@@ -7,54 +7,6 @@ require "primer/view_components/engine"
 module Primer
   # :nodoc:
   module ViewComponents
-    DEFAULT_STATIC_PATH = File.expand_path("static")
-    FILE_NAMES = {
-      statuses: "statuses.json",
-      constants: "constants.json",
-      audited_at: "audited_at.json"
-    }.freeze
-
-    # generate_statuses returns a hash mapping component name to
-    # the component's status sorted alphabetically by the component name.
-    def self.generate_statuses
-      Primer::Component.descendants.sort_by(&:name).each_with_object({}) do |component, mem|
-        mem[component.to_s] = component.status.to_s
-      end
-    end
-
-    # generate_audited_at returns a hash mapping component name to
-    # the day the component has passed an accessibility audit.
-    def self.generate_audited_at
-      Primer::Component.descendants.sort_by(&:name).each_with_object({}) do |component, mem|
-        mem[component.to_s] = component.audited_at.to_s
-      end
-    end
-
-    # generate_constants returns a hash mapping component name to
-    # all of its constants.
-    def self.generate_constants
-      Primer::Component.descendants.sort_by(&:name).each_with_object({}) do |component, mem|
-        mem[component.to_s] = component.constants(false).sort.each_with_object({}) do |constant, h|
-          h[constant] = component.const_get(constant)
-        end
-      end
-    end
-
-    # dump generates the requested stat hash and outputs it to a file.
-    def self.dump(stats)
-      require "json"
-
-      File.open(File.join(DEFAULT_STATIC_PATH, FILE_NAMES[stats]), "w") do |f|
-        f.write(JSON.pretty_generate(send("generate_#{stats}")))
-        f.write($INPUT_RECORD_SEPARATOR)
-      end
-    end
-
-    # read returns a JSON string matching the output of the corresponding stat.
-    def self.read(stats)
-      File.read(File.join(DEFAULT_STATIC_PATH, FILE_NAMES[stats]))
-    end
-
     # primer/view_components root directory.
     def self.root
       Pathname(File.expand_path(File.join("..", ".."), __dir__))

data/lib/primer/yard/component_manifest.rb

@@ -65,6 +65,7 @@ module Primer
         Primer::Alpha::Tooltip => { js: true },
         Primer::Alpha::ToggleSwitch => { js: true },
         Primer::Alpha::Overlay => { js: true },
+        Primer::Alpha::ActionMenu => { js: true },
 
         # Examples can be seen in the NavList docs
         Primer::Alpha::NavList => { js: true },

data/lib/primer/yard/component_ref.rb

@@ -34,6 +34,20 @@ module Primer
       def form_component?
         @attrs.fetch(:form_component, ATTR_DEFAULTS[:form_component])
       end
+
+      def source_url
+        @source_url ||= begin
+          path = klass.name.split("::").map(&:underscore).join("/")
+          "https://github.com/primer/view_components/tree/main/app/components/#{path}.rb"
+        end
+      end
+
+      def lookbook_url
+        @lookbook_url ||= begin
+          path = klass.name.underscore.gsub("_component", "")
+          "https://primer.style/view-components/lookbook/inspect/#{path}/default/"
+        end
+      end
     end
   end
 end

data/lib/primer/yard/docs_helper.rb

@@ -2,6 +2,7 @@
 
 # :nocov:
 module Primer
+  # :nodoc:
   module Yard
     # Helper methods to use for yard documentation
     module DocsHelper
@@ -90,6 +91,8 @@ module Primer
         end
       end
     end
+
+    DocsHelper.extend(DocsHelper)
   end
 end
 # :nocov:

data/lib/primer/yard/info_arch_docs_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Primer
+  module Yard
+    # Helper methods to use for info arch yard documentation
+    module InfoArchDocsHelper
+      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}}"
+      end
+
+      def link_to_typography_docs
+        "{{link_to_typography_docs}}"
+      end
+
+      def link_to_accessibility
+        "{{link_to_accessibility}}"
+      end
+
+      def link_to_octicons
+        "{{link_to_octicons}}"
+      end
+    end
+  end
+end

data/lib/primer/yard/legacy_gatsby_backend.rb

@@ -33,7 +33,6 @@ module Primer
       end
 
       def generate
-        args_for_components = []
         errors = []
 
         each_component do |component_ref|
@@ -42,8 +41,8 @@ module Primer
           status_path = docs.status_module.nil? ? "" : "#{docs.status_module}/"
 
           metadata = docs.metadata.merge(
-            source: source_url(component),
-            lookbook: lookbook_url(component),
+            source: component_ref.source_url,
+            lookbook: component_ref.lookbook_url,
             path: "docs/content/components/#{status_path}#{docs.short_name.downcase}.md",
             example_path: example_path(component),
             require_js_path: require_js_path(component)
@@ -113,30 +112,11 @@ module Primer
               errors << { component.name => err }
             end
 
-            args = []
             docs.params.each do |tag|
               default_value = pretty_default_value(tag, component)
-
-              args << {
-                "name" => tag.name,
-                "type" => tag.types.join(", "),
-                "default" => default_value,
-                "description" => view_context.render(inline: tag.text.squish)
-              }
-
               f.puts("| `#{tag.name}` | `#{tag.types.join(', ')}` | #{default_value} | #{view_context.render(inline: tag.text.squish)} |")
             end
 
-            component_args = {
-              "component" => metadata[:title],
-              "status" => component.status.to_s,
-              "source" => metadata[:source],
-              "lookbook" => metadata[:lookbook],
-              "parameters" => args
-            }
-
-            args_for_components << component_args
-
             if docs.slot_methods.any?
               f.puts
               f.puts("## Slots")
@@ -190,7 +170,7 @@ module Primer
           f.puts(view_context.render(inline: system_args_docs.constructor.base_docstring))
         end
 
-        [args_for_components, errors]
+        errors
       end
 
       private
@@ -220,18 +200,6 @@ module Primer
         manifest.each(&block)
       end
 
-      def source_url(component)
-        path = component.name.split("::").map(&:underscore).join("/")
-
-        "https://github.com/primer/view_components/tree/main/app/components/#{path}.rb"
-      end
-
-      def lookbook_url(component)
-        path = component.name.underscore.gsub("_component", "")
-
-        "https://primer.style/view-components/lookbook/inspect/#{path}/default/"
-      end
-
       def example_path(component)
         example_path = "../../src/@primer/gatsby-theme-doctocat/components/example"
         example_path = "../#{example_path}" if status_module?(component)

data/lib/primer/yard/registry.rb

@@ -28,6 +28,7 @@ module Primer
 
           {
             title: class_name,
+            class_name: class_name,
             component_id: short_name.underscore,
             status: status.capitalize,
             status_module: status_module,
@@ -42,7 +43,7 @@ module Primer
       end
 
       def params
-        constructor.tags(:param)
+        constructor&.tags(:param) || []
       end
 
       def slot_methods

data/lib/primer/yard.rb

@@ -6,6 +6,7 @@ module Primer
     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 :LegacyGatsbyBackend,  "primer/yard/legacy_gatsby_backend"
     autoload :Registry,             "primer/yard/registry"
     autoload :RendersManyHandler,   "primer/yard/renders_many_handler"

data/lib/tasks/custom_utilities.yml

@@ -99,45 +99,105 @@
 :border:
   :left:
   - border-left
+  - border-sm-left
+  - border-md-left
+  - border-lg-left
+  - border-xl-left
   :top:
   - border-top
+  - border-sm-top
+  - border-md-top
+  - border-lg-top
+  - border-xl-top
   :bottom:
   - border-bottom
+  - border-sm-bottom
+  - border-md-bottom
+  - border-lg-bottom
+  - border-xl-bottom
   :right:
   - border-right
+  - border-sm-right
+  - border-md-right
+  - border-lg-right
+  - border-xl-right
   :y:
   - border-y
   :x:
   - border-x
   true:
   - border
+  - border-sm
+  - border-md
+  - border-lg
+  - border-xl
   0:
   - border-0
+  - border-sm-0
+  - border-md-0
+  - border-lg-0
+  - border-xl-0
   false:
   - border-0
+  - border-sm-0
+  - border-md-0
+  - border-lg-0
+  - border-xl-0
   :dashed:
   - border-dashed
 :border_top:
   0:
   - border-top-0
+  - border-sm-top-0
+  - border-md-top-0
+  - border-lg-top-0
+  - border-xl-top-0
 :border_bottom:
   0:
   - border-bottom-0
+  - border-sm-bottom-0
+  - border-md-bottom-0
+  - border-lg-bottom-0
+  - border-xl-bottom-0
 :border_left:
   0:
   - border-left-0
+  - border-sm-left-0
+  - border-md-left-0
+  - border-lg-left-0
+  - border-xl-left-0
 :border_right:
   0:
   - border-right-0
+  - border-sm-right-0
+  - border-md-right-0
+  - border-lg-right-0
+  - border-xl-right-0
 :border_radius:
   0:
   - rounded-0
+  - rounded-sm-0
+  - rounded-md-0
+  - rounded-lg-0
+  - rounded-xl-0
   1:
   - rounded-1
+  - rounded-sm-1
+  - rounded-md-1
+  - rounded-lg-1
+  - rounded-xl-1
   2:
   - rounded-2
+  - rounded-sm-2
+  - rounded-md-2
+  - rounded-lg-2
+  - rounded-xl-2
   3:
   - rounded-3
+  - rounded-sm-3
+  - rounded-md-3
+  - rounded-lg-3
+  - rounded-xl-3
 :justify_content:
   :flex_start:
   - flex-justify-start

data/lib/tasks/docs.rake

@@ -2,6 +2,14 @@
 
 require "active_support/inflector"
 
+task :init_pvc do
+  ENV["RAILS_ENV"] = "test"
+  ENV["VC_COMPAT_PATCH_ENABLED"] = "true"
+
+  require File.expand_path("./../../demo/config/environment.rb", __dir__)
+  Dir[File.expand_path("../../app/components/primer/**/*.rb", __dir__)].sort.each { |file| require file }
+end
+
 namespace :docs do
   task :livereload do
     require "listen"
@@ -39,7 +47,7 @@ namespace :docs do
 
     manifest = Primer::Yard::ComponentManifest.where(published: true)
     backend = Primer::Yard::LegacyGatsbyBackend.new(registry, manifest)
-    args_for_components, errors = backend.generate
+    errors = backend.generate
 
     unless errors.empty?
       puts "==============================================="
@@ -50,11 +58,7 @@ namespace :docs do
       puts "==============================================="
       puts "==============================================="
 
-    raise
-    end
-
-    File.open("static/arguments.json", "w") do |f|
-      f.puts JSON.pretty_generate(args_for_components)
+      raise
     end
 
     puts "Markdown compiled."
@@ -162,12 +166,6 @@ namespace :docs do
     end
   end
 
-  task :init_pvc do
-    ENV["RAILS_ENV"] = "test"
-    require File.expand_path("./../../demo/config/environment.rb", __dir__)
-    Dir[File.expand_path("../../app/components/primer/**/*.rb", __dir__)].sort.each { |file| require file }
-  end
-
   task build_yard_registry: :init_pvc do
     require "primer/yard"
 

data/lib/tasks/static.rake

@@ -1,37 +1,29 @@
 # frozen_string_literal: true
 
 namespace :static do
-  task :dump do
-    ENV["RAILS_ENV"] = "test"
-    require File.expand_path("./../../demo/config/environment.rb", __dir__)
-    require "primer/view_components"
-    require "lookbook"
-    # Loads all components for `.descendants` to work properly
-    Dir["./app/components/primer/**/*.rb"].sort.each { |file| require file }
+  task dump: [:dump_statuses, :dump_constants, :dump_audited_at, :dump_previews, :dump_arguments, :dump_info_arch]
 
-    Primer::ViewComponents.dump(:statuses)
-    Primer::ViewComponents.dump(:constants)
-    Primer::ViewComponents.dump(:audited_at)
+  task dump_statuses: :init_pvc do
+    Primer::Static.dump(:statuses)
+  end
+
+  task dump_constants: :init_pvc do
+    Primer::Static.dump(:constants)
+  end
 
-    previews = Lookbook.previews.map do |preview|
-      {
-        name: preview.name,
-        lookup_path: preview.lookup_path,
-        examples: preview.examples.map { |example|
-          {
-            inspect_path: example.url_path,
-            preview_path: example.url_path.sub("/inspect/", "/preview/"),
-            name: example.name
-          }
-        }
-      }
-    end
+  task dump_audited_at: :init_pvc do
+    Primer::Static.dump(:audited_at)
+  end
 
-    require "json"
+  task dump_previews: :init_pvc do
+    Primer::Static.dump(:previews)
+  end
+
+  task dump_arguments: ["docs:build_yard_registry", :init_pvc] do
+    Primer::Static.dump(:arguments)
+  end
 
-    File.open(File.join(Primer::ViewComponents::DEFAULT_STATIC_PATH, "previews.json"), "w") do |f|
-      f.write(JSON.pretty_generate(previews))
-      f.write($INPUT_RECORD_SEPARATOR)
-    end
+  task dump_info_arch: ["docs:build_yard_registry", :dump_previews, :dump_arguments] do
+    Primer::Static.dump(:info_arch)
   end
 end

data/previews/primer/alpha/action_list_preview.rb

@@ -344,7 +344,10 @@ module Primer
         render(Primer::Alpha::ActionList.new(
                  aria: { label: "List heading" }
                )) do |component|
-          component.with_item(label: "Disabled item", href: "/", disabled: true)
+          component.with_item(label: "Disabled item", href: "/", disabled: true) do |item|
+            item.with_description { "Item description" }
+            item.with_leading_visual_icon(icon: :gear)
+          end
         end
       end
 

data/previews/primer/alpha/action_menu_preview/align_end.html.erb

@@ -0,0 +1,6 @@
+<div style="display: grid; place-content: center;">
+<%= render(Primer::Alpha::ActionMenu.new(anchor_align: :end)) do |component| %>
+  <% component.with_show_button { "Menu" } %>
+  <% component.with_item(label: "Item", tag: :button, value: "") %>
+<% end %>
+</div>

data/previews/primer/alpha/action_menu_preview/opens_dialog.html.erb

@@ -0,0 +1,21 @@
+<%= render(Primer::Alpha::ActionMenu.new) do |component| %>
+  <% component.with_show_button { "Menu" } %>
+  <% component.with_item(label: "Item", tag: :button, value: "") %>
+  <% component.with_item(
+    label: "Show dialog",
+    tag: :button,
+    content_arguments: { "data-show-dialog-id": "my-dialog" },
+    value: "",
+    scheme: :danger
+  ) %>
+<% end %>
+
+<%= render(Primer::Alpha::Dialog.new(id: "my-dialog", title: "Confirm deletion")) do |d| %>
+  <%= render(Primer::Alpha::Dialog::Body.new()) do %>
+    Are you sure you want to delete this?
+  <% end %>
+  <%= render(Primer::Alpha::Dialog::Footer.new()) do %>
+    <%= render(Primer::Beta::Button.new(data: { "close-dialog-id": "my-dialog" })) { "Cancel" } %>
+    <%= render(Primer::Beta::Button.new(scheme: :danger)) { "Delete" } %>
+  <% end %>
+<% end %>