primer_view_components 0.0.60 → 0.0.61

data/lib/tasks/docs.rake

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/inflector"
+
 namespace :docs do
   task :livereload do
     require "listen"
@@ -27,6 +29,8 @@ namespace :docs do
     # Rails controller for rendering arbitrary ERB
     view_context = ApplicationController.new.tap { |c| c.request = ActionDispatch::TestRequest.create }.view_context
     components = [
+      Primer::Alpha::Layout,
+      Primer::HellipButton,
       Primer::Alpha::BorderBox::Header,
       Primer::Image,
       Primer::LocalTime,
@@ -38,7 +42,7 @@ namespace :docs do
       Primer::Beta::Avatar,
       Primer::Beta::AvatarStack,
       Primer::BaseButton,
-      Primer::BlankslateComponent,
+      Primer::Beta::Blankslate,
       Primer::BorderBoxComponent,
       Primer::BoxComponent,
       Primer::Beta::Breadcrumbs,
@@ -290,6 +294,10 @@ namespace :docs do
       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?
@@ -298,6 +306,47 @@ namespace :docs do
     end
   end
 
+  task :build_adrs do
+    adr_content_dir = File.join(*%w[docs content adr])
+
+    FileUtils.rm_rf(File.join(adr_content_dir))
+    FileUtils.mkdir(adr_content_dir)
+
+    nav_entries = Dir[File.join(*%w[adr *.md])].map do |orig_path|
+      orig_file_name = File.basename(orig_path)
+      url_name = orig_file_name.chomp(".md")
+      title = ActiveSupport::Inflector.titleize(url_name.sub(/\A\d+-/, ""))
+
+      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
+
+      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(*%w[docs src @primer gatsby-theme-doctocat nav.yml])
+    nav_yaml = YAML.load_file(nav_yaml_file)
+    adr_entry = {
+      "title" => "Architecture Decisions",
+      "url" => "/adr",
+      "children" => nav_entries
+    }
+
+    existing_index = nav_yaml.index { |entry| entry["url"] == "/adr" }
+    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
+
   task :preview do
     registry = generate_yard_registry
 

data/static/arguments.yml

@@ -29,6 +29,28 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: Layout
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb
+  parameters:
+  - name: stacking_breakpoint
+    type: Symbol
+    default: "`:md`"
+    description: When the `Layout` should change from rows into columns. One of `:lg`,
+      `:md`, or `:sm`.
+  - name: first_in_source
+    type: Symbol
+    default: "`:sidebar`"
+    description: Which element to render first in the HTML. This will change the keyboard
+      navigation order. One of `:main` and `:sidebar`.
+  - name: gutter
+    type: Symbol
+    default: "`:default`"
+    description: The amount of space between the main section and the sidebar. One
+      of `:condensed`, `:default`, `:none`, or `:spacious`.
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: TabNav
   source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb
   parameters:
@@ -231,6 +253,25 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: Blankslate
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb
+  parameters:
+  - name: narrow
+    type: Boolean
+    default: "`false`"
+    description: Adds a maximum width of `485px` to the Blankslate.
+  - name: spacious
+    type: Boolean
+    default: "`false`"
+    description: Increases the padding from `32px` to `80px 40px`.
+  - name: border
+    type: Boolean
+    default: "`false`"
+    description: Adds a border around the Blankslate.
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: Breadcrumbs
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb
   parameters:
@@ -256,73 +297,6 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
-- component: Blankslate
-  source: https://github.com/primer/view_components/tree/main/app/components/primer/blankslate_component.rb
-  parameters:
-  - name: title
-    type: String
-    default: '`""`'
-    description: Text that appears in a larger bold font.
-  - name: title_tag
-    type: Symbol
-    default: "`:h3`"
-    description: HTML tag to use for title.
-  - name: icon
-    type: Symbol
-    default: '`""`'
-    description: Octicon icon to use at top of component.
-  - name: icon_size
-    type: Symbol
-    default: "`:medium`"
-    description: One of `:small` (`16`) and `:medium` (`24`).
-  - name: image_src
-    type: String
-    default: '`""`'
-    description: Image to display.
-  - name: image_alt
-    type: String
-    default: '`" "`'
-    description: Alt text for image.
-  - name: description
-    type: String
-    default: '`""`'
-    description: Text that appears below the title. Typically a whole sentence.
-  - name: button_text
-    type: String
-    default: '`""`'
-    description: The text of the button.
-  - name: button_url
-    type: String
-    default: '`""`'
-    description: The URL where the user will be taken after clicking the button.
-  - name: button_classes
-    type: String
-    default: '`"btn-primary my-3"`'
-    description: Classes to apply to action button
-  - name: link_text
-    type: String
-    default: '`""`'
-    description: The text of the link.
-  - name: link_url
-    type: String
-    default: '`""`'
-    description: The URL where the user will be taken after clicking the link.
-  - name: narrow
-    type: Boolean
-    default: "`false`"
-    description: Adds a maximum width.
-  - name: large
-    type: Boolean
-    default: "`false`"
-    description: Increases the font size.
-  - name: spacious
-    type: Boolean
-    default: "`false`"
-    description: Adds extra padding.
-  - name: system_arguments
-    type: Hash
-    default: N/A
-    description: "[System arguments](/system-arguments)"
 - component: BorderBox
   source: https://github.com/primer/view_components/tree/main/app/components/primer/border_box_component.rb
   parameters:
@@ -584,6 +558,17 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: HellipButton
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/hellip_button.rb
+  parameters:
+  - name: inline
+    type: Boolean
+    default: "`false`"
+    description: Whether or not the button is inline.
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: HiddenTextExpander
   source: https://github.com/primer/view_components/tree/main/app/components/primer/hidden_text_expander.rb
   parameters:

data/static/audited_at.json

@@ -1,6 +1,9 @@
 {
   "Primer::Alpha::BorderBox::Header": "",
   "Primer::Alpha::ButtonMarketing": "",
+  "Primer::Alpha::Layout": "",
+  "Primer::Alpha::Layout::Main": "",
+  "Primer::Alpha::Layout::Sidebar": "",
   "Primer::Alpha::TabNav": "",
   "Primer::Alpha::TabPanels": "",
   "Primer::Alpha::UnderlineNav": "",
@@ -12,6 +15,7 @@
   "Primer::Beta::AutoComplete::Item": "",
   "Primer::Beta::Avatar": "",
   "Primer::Beta::AvatarStack": "",
+  "Primer::Beta::Blankslate": "",
   "Primer::Beta::Breadcrumbs": "",
   "Primer::Beta::Breadcrumbs::Item": "",
   "Primer::Beta::Text": "",
@@ -34,6 +38,7 @@
   "Primer::FlexComponent": "",
   "Primer::FlexItemComponent": "",
   "Primer::HeadingComponent": "",
+  "Primer::HellipButton": "",
   "Primer::HiddenTextExpander": "",
   "Primer::IconButton": "",
   "Primer::Image": "",

data/static/classes.yml

@@ -27,6 +27,21 @@
 - ".Label--secondary"
 - ".Label--success"
 - ".Label--warning"
+- ".Layout"
+- ".Layout--flowRow-until-lg"
+- ".Layout--flowRow-until-md"
+- ".Layout--sidebar-narrow"
+- ".Layout--sidebar-wide"
+- ".Layout--sidebarPosition-end"
+- ".Layout--sidebarPosition-flowRow-end"
+- ".Layout--sidebarPosition-flowRow-none"
+- ".Layout--sidebarPosition-flowRow-start"
+- ".Layout--sidebarPosition-start"
+- ".Layout-main"
+- ".Layout-main-centered-lg"
+- ".Layout-main-centered-md"
+- ".Layout-main-centered-xl"
+- ".Layout-sidebar"
 - ".Link"
 - ".Link--muted"
 - ".Link--primary"
@@ -71,7 +86,6 @@
 - ".avatar-small"
 - ".blankslate"
 - ".blankslate-icon"
-- ".blankslate-large"
 - ".blankslate-narrow"
 - ".blankslate-spacious"
 - ".border"
@@ -111,6 +125,9 @@
 - ".color-shadow-large"
 - ".color-text-danger"
 - ".color-text-white"
+- ".container-lg"
+- ".container-md"
+- ".container-xl"
 - ".css-truncate"
 - ".css-truncate-overflow"
 - ".css-truncate-target"
@@ -147,8 +164,8 @@
 - ".form-control"
 - ".gutter-condensed"
 - ".gutter-lg"
+- ".h2"
 - ".hidden-text-expander"
-- ".hx_Subhead--responsive"
 - ".inline"
 - ".left-0"
 - ".lh-0"
@@ -163,6 +180,7 @@
 - ".menu-item"
 - ".mr-2"
 - ".mt-2"
+- ".mt-5"
 - ".mx-auto"
 - ".no-underline"
 - ".no-wrap"

data/static/constants.json

@@ -44,6 +44,84 @@
       "large"
     ]
   },
+  "Primer::Alpha::Layout": {
+    "FIRST_IN_SOURCE_DEFAULT": "sidebar",
+    "FIRST_IN_SOURCE_OPTIONS": [
+      "sidebar",
+      "main"
+    ],
+    "GUTTER_DEFAULT": "default",
+    "GUTTER_MAPPINGS": {
+      "none": "Layout--gutter-none",
+      "condensed": "Layout--gutter-condensed",
+      "spacious": "Layout--gutter-spacious",
+      "default": ""
+    },
+    "GUTTER_OPTIONS": [
+      "none",
+      "condensed",
+      "spacious",
+      "default"
+    ],
+    "Main": "Primer::Alpha::Layout::Main",
+    "SIDEBAR_COL_PLACEMENT_DEFAULT": "start",
+    "SIDEBAR_COL_PLACEMENT_OPTIONS": [
+      "start",
+      "end"
+    ],
+    "SIDEBAR_ROW_PLACEMENT_DEFAULT": "start",
+    "SIDEBAR_ROW_PLACEMENT_OPTIONS": [
+      "start",
+      "end",
+      "none"
+    ],
+    "SIDEBAR_WIDTH_DEFAULT": "default",
+    "SIDEBAR_WIDTH_MAPPINGS": {
+      "default": "",
+      "narrow": "Layout--sidebar-narrow",
+      "wide": "Layout--sidebar-wide"
+    },
+    "SIDEBAR_WIDTH_OPTIONS": [
+      "default",
+      "narrow",
+      "wide"
+    ],
+    "STACKING_BREAKPOINT_DEFAULT": "md",
+    "STACKING_BREAKPOINT_MAPPINGS": {
+      "sm": "",
+      "md": "Layout--flowRow-until-md",
+      "lg": "Layout--flowRow-until-lg"
+    },
+    "STACKING_BREAKPOINT_OPTIONS": [
+      "sm",
+      "md",
+      "lg"
+    ],
+    "Sidebar": "Primer::Alpha::Layout::Sidebar"
+  },
+  "Primer::Alpha::Layout::Main": {
+    "TAG_DEFAULT": "div",
+    "TAG_OPTIONS": [
+      "div",
+      "main"
+    ],
+    "WIDTH_DEFAULT": "full",
+    "WIDTH_OPTIONS": [
+      "full",
+      "md",
+      "lg",
+      "xl"
+    ]
+  },
+  "Primer::Alpha::Layout::Sidebar": {
+    "TAG_DEFAULT": "div",
+    "TAG_OPTIONS": [
+      "div",
+      "aside",
+      "nav",
+      "section"
+    ]
+  },
   "Primer::Alpha::TabNav": {
     "BODY_TAG_DEFAULT": "ul",
     "TAG_DEFAULT": "nav",
@@ -85,6 +163,22 @@
     ]
   },
   "Primer::BaseComponent": {
+    "SELF_CLOSING_TAGS": [
+      "area",
+      "base",
+      "br",
+      "col",
+      "embed",
+      "hr",
+      "img",
+      "input",
+      "link",
+      "meta",
+      "param",
+      "source",
+      "track",
+      "wbr"
+    ]
   },
   "Primer::Beta::AutoComplete": {
     "Input": "Primer::Beta::AutoComplete::Input",
@@ -134,6 +228,13 @@
       "span"
     ]
   },
+  "Primer::Beta::Blankslate": {
+    "VISUAL_OPTIONS": [
+      "icon",
+      "spinner",
+      "image"
+    ]
+  },
   "Primer::Beta::Breadcrumbs": {
     "ARGS_DENYLIST": {
       "[:p, :pt, :pb, :pr, :pl, :px, :py]": "Padding system arguments are not allowed on Breadcrumbs. Consider using margins instead.",
@@ -385,6 +486,8 @@
       "h6"
     ]
   },
+  "Primer::HellipButton": {
+  },
   "Primer::HiddenTextExpander": {
   },
   "Primer::IconButton": {

data/static/statuses.json

@@ -1,6 +1,9 @@
 {
   "Primer::Alpha::BorderBox::Header": "alpha",
   "Primer::Alpha::ButtonMarketing": "alpha",
+  "Primer::Alpha::Layout": "alpha",
+  "Primer::Alpha::Layout::Main": "alpha",
+  "Primer::Alpha::Layout::Sidebar": "alpha",
   "Primer::Alpha::TabNav": "alpha",
   "Primer::Alpha::TabPanels": "alpha",
   "Primer::Alpha::UnderlineNav": "alpha",
@@ -12,12 +15,13 @@
   "Primer::Beta::AutoComplete::Item": "beta",
   "Primer::Beta::Avatar": "beta",
   "Primer::Beta::AvatarStack": "beta",
+  "Primer::Beta::Blankslate": "beta",
   "Primer::Beta::Breadcrumbs": "beta",
   "Primer::Beta::Breadcrumbs::Item": "alpha",
   "Primer::Beta::Text": "beta",
   "Primer::Beta::Truncate": "beta",
   "Primer::Beta::Truncate::TruncateText": "alpha",
-  "Primer::BlankslateComponent": "beta",
+  "Primer::BlankslateComponent": "deprecated",
   "Primer::BorderBoxComponent": "beta",
   "Primer::BoxComponent": "stable",
   "Primer::ButtonComponent": "beta",
@@ -34,6 +38,7 @@
   "Primer::FlexComponent": "deprecated",
   "Primer::FlexItemComponent": "deprecated",
   "Primer::HeadingComponent": "beta",
+  "Primer::HellipButton": "alpha",
   "Primer::HiddenTextExpander": "alpha",
   "Primer::IconButton": "beta",
   "Primer::Image": "alpha",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.60
+  version: 0.0.61
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -381,6 +381,8 @@ files:
 - app/components/primer/alpha/border_box/header.html.erb
 - app/components/primer/alpha/border_box/header.rb
 - app/components/primer/alpha/button_marketing.rb
+- app/components/primer/alpha/layout.html.erb
+- app/components/primer/alpha/layout.rb
 - app/components/primer/alpha/tab_nav.html.erb
 - app/components/primer/alpha/tab_nav.rb
 - app/components/primer/alpha/tab_panels.html.erb
@@ -404,6 +406,8 @@ files:
 - app/components/primer/beta/avatar.rb
 - app/components/primer/beta/avatar_stack.html.erb
 - app/components/primer/beta/avatar_stack.rb
+- app/components/primer/beta/blankslate.html.erb
+- app/components/primer/beta/blankslate.rb
 - app/components/primer/beta/breadcrumbs.html.erb
 - app/components/primer/beta/breadcrumbs.rb
 - app/components/primer/beta/text.rb
@@ -445,6 +449,7 @@ files:
 - app/components/primer/flex_component.rb
 - app/components/primer/flex_item_component.rb
 - app/components/primer/heading_component.rb
+- app/components/primer/hellip_button.rb
 - app/components/primer/hidden_text_expander.rb
 - app/components/primer/icon_button.rb
 - app/components/primer/image.rb
@@ -526,14 +531,18 @@ files:
 - lib/primer/view_components/linters/argument_mappers/system_arguments.rb
 - lib/primer/view_components/linters/autocorrectable.rb
 - lib/primer/view_components/linters/base_linter.rb
+- lib/primer/view_components/linters/blankslate_api_migration.rb
 - lib/primer/view_components/linters/blankslate_component_migration_counter.rb
 - lib/primer/view_components/linters/breadcrumbs_component_migration_counter.rb
 - lib/primer/view_components/linters/button_component_migration_counter.rb
 - lib/primer/view_components/linters/clipboard_copy_component_migration_counter.rb
 - lib/primer/view_components/linters/close_button_component_migration_counter.rb
 - lib/primer/view_components/linters/flash_component_migration_counter.rb
+- lib/primer/view_components/linters/helpers/rubocop_helpers.rb
 - lib/primer/view_components/linters/label_component_migration_counter.rb
 - lib/primer/view_components/linters/subhead_component_migration_counter.rb
+- lib/primer/view_components/linters/tag_tree_helpers.rb
+- lib/primer/view_components/linters/two_column_layout_migration_counter.rb
 - lib/primer/view_components/statuses.rb
 - lib/primer/view_components/version.rb
 - lib/rubocop/config/default.yml