primer_view_components 0.0.50 → 0.0.54

data/lib/rubocop/cop/primer/system_argument_instead_of_class.rb

@@ -3,7 +3,9 @@
 require "rubocop"
 require "primer/classify/utilities"
 require "primer/view_components/statuses"
+require_relative "../../../../app/lib/primer/view_helper"
 
+# :nocov:
 module RuboCop
   module Cop
     module Primer
@@ -20,8 +22,7 @@ module RuboCop
         STR
 
         def on_send(node)
-          return unless node.method_name == :new
-          return unless ::Primer::ViewComponents::STATUSES.key?(node.receiver.const_name)
+          return unless valid_node?(node)
           return unless node.arguments?
 
           # we are looking for hash arguments and they are always last
@@ -48,26 +49,21 @@ module RuboCop
 
         def autocorrect(node)
           lambda do |corrector|
-            system_arguments = ::Primer::Classify::Utilities.classes_to_hash(node.value.value)
-            corrector.replace(node.loc.expression, arguments_as_string(system_arguments))
+            args = ::Primer::Classify::Utilities.classes_to_args(node.value.value)
+            corrector.replace(node.loc.expression, args)
           end
         end
 
         private
 
-        def arguments_as_string(system_arguments)
-          system_arguments.map do |key, value|
-            val = case value
-                  when Symbol
-                    ":#{value}"
-                  when String
-                    value.to_json
-                  else
-                    value
-                  end
+        # We only verify SystemArguments if it's a `.new` call on a component or
+        # a ViewHleper call.
+        def valid_node?(node)
+          view_helpers.include?(node.method_name) || (node.method_name == :new && ::Primer::ViewComponents::STATUSES.key?(node.receiver.const_name))
+        end
 
-            "#{key}: #{val}"
-          end.join(", ")
+        def view_helpers
+          ::Primer::ViewHelper::HELPERS.keys.map { |key| "primer_#{key}".to_sym }
         end
       end
     end

data/lib/rubocop/cop/primer.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require "rubocop/cop/primer/no_tag_memoize"
-require "rubocop/cop/primer/system_argument_instead_of_class"
+Dir[File.join(__dir__, "primer", "*.rb")].sort.each { |file| require file }

data/lib/tasks/coverage.rake

@@ -9,6 +9,10 @@ namespace :coverage do
 
     SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"], "rails" do
       formatter SimpleCov::Formatter::Console
+
+      add_group "Ignored Code" do |src_file|
+        File.readlines(src_file.filename).grep(/:nocov:/).any?
+      end
     end
   end
 end

data/lib/tasks/docs.rake

@@ -40,7 +40,7 @@ namespace :docs do
       Primer::BlankslateComponent,
       Primer::BorderBoxComponent,
       Primer::BoxComponent,
-      Primer::BreadcrumbComponent,
+      Primer::Beta::Breadcrumbs,
       Primer::ButtonComponent,
       Primer::ButtonGroup,
       Primer::Alpha::ButtonMarketing,
@@ -74,7 +74,9 @@ namespace :docs do
       Primer::TimelineItemComponent,
       Primer::Tooltip,
       Primer::Truncate,
-      Primer::UnderlineNavComponent
+      Primer::Beta::Truncate,
+      Primer::Alpha::UnderlineNav,
+      Primer::Alpha::UnderlinePanels
     ]
 
     js_components = [
@@ -86,7 +88,7 @@ namespace :docs do
       Primer::TabContainerComponent,
       Primer::TabNavComponent,
       Primer::TimeAgoComponent,
-      Primer::UnderlineNavComponent
+      Primer::Alpha::UnderlinePanels
     ]
 
     all_components = Primer::Component.descendants - [Primer::BaseComponent]
@@ -238,7 +240,7 @@ namespace :docs do
           f.puts
           html = view_context.render(inline: code)
           html.scan(/class="([^"]*)"/) do |classnames|
-            classes_found_in_examples.concat(classnames[0].split(" ").reject { |c| c.starts_with?("octicon", "js", "my-") }.map { ".#{_1}"})
+            classes_found_in_examples.concat(classnames[0].split.reject { |c| c.starts_with?("octicon", "js", "my-") }.map { ".#{_1}" })
           end
           f.puts("<Example src=\"#{html.tr('"', "\'").delete("\n")}\" />")
           f.puts
@@ -382,7 +384,7 @@ namespace :docs do
   end
 
   def pretty_default_value(tag, component)
-    params = tag.object.parameters.find { |param| [tag.name.to_s, tag.name.to_s + ":"].include?(param[0]) }
+    params = tag.object.parameters.find { |param| [tag.name.to_s, "#{tag.name}:"].include?(param[0]) }
     default = tag.defaults&.first || params&.second
 
     return "N/A" unless default

data/lib/tasks/utilities.rake

@@ -8,6 +8,7 @@ namespace :utilities do
     require "primer/classify/utilities"
 
     # Keys that are looked for to be included in the utilities.yml file
+    # rubocop:disable Lint/ConstantDefinitionInBlock
     SUPPORTED_KEYS = %i[
       anim
       d
@@ -23,6 +24,7 @@ namespace :utilities do
     ].freeze
 
     BREAKPOINTS = [nil, "sm", "md", "lg", "xl"].freeze
+    # rubocop:enable Lint/ConstantDefinitionInBlock
 
     css_data =
       JSON.parse(
@@ -38,7 +40,7 @@ namespace :utilities do
     css_data.each do |selector|
       selector.sub!(/^./, "")
       # Next if selector has ancestors or sibling selectors
-      next if selector.match?(/[:><~\[\.]/)
+      next if selector.match?(/[:><~\[.]/)
       next unless SUPPORTED_KEYS.any? { |key| selector.start_with?("#{key}-") }
 
       # Dupe so we still have the selector at the end of slicing it up
@@ -50,7 +52,7 @@ namespace :utilities do
         next unless classname.match?(Regexp.new(k))
 
         key = v
-        classname.sub!(Regexp.new(k + "-"), "")
+        classname.sub!(Regexp.new("#{k}-"), "")
       end
 
       # If we didn't find a replacement, grab the first text before hyphen
@@ -66,7 +68,7 @@ namespace :utilities do
       end
 
       # Change the rest from hypens to underscores
-      classname.sub!(/\-/, "_")
+      classname.sub!(/-/, "_")
 
       # convert padding/margin negative values ie n7 to -7
       classname.sub!(/^n/, "-") if classname.match?(/^n[0-9]/)

data/lib/yard/docs_helper.rb

@@ -1,13 +1,16 @@
 # 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
-        compare = ->(a, b) { a.class == b.class ? a <=> b : a.class.to_s <=> b.class.to_s }
-        enumerable = enumerable.sort { |a, b| compare.call(a, b) }
+        enumerable = enumerable.sort do |a, b|
+          a.instance_of?(b.class) ? a <=> b : a.class.to_s <=> b.class.to_s
+        end
       end
 
       values =
@@ -58,7 +61,7 @@ module YARD
     def status_module_and_short_name(component)
       name_with_status = component.name.gsub(/Primer::|Component/, "")
 
-      m = name_with_status.match(/(?<status>Beta|Alpha|Deprecated)?(::)?(?<name>.*)/)
+      m = name_with_status.match(/(?<status>Beta|Alpha|Deprecated)?(?<_colons>::)?(?<name>.*)/)
       [m[:status]&.downcase, m[:name].gsub("::", "")]
     end
 

data/static/arguments.yml

@@ -22,6 +22,54 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: UnderlineNav
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb
+  parameters:
+  - name: tag
+    type: Symbol
+    default: "`:nav`"
+    description: One of `:div` and `:nav`.
+  - 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: align
+    type: Symbol
+    default: "`:left`"
+    description: One of `:left` and `:right`. - Defaults to left
+  - name: body_arguments
+    type: Hash
+    default: "`{}`"
+    description: "[System arguments](/system-arguments) for the body wrapper."
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
+- component: UnderlinePanels
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb
+  parameters:
+  - name: label
+    type: String
+    default: N/A
+    description: Sets an `aria-label` that helps assistive technology users understand
+      the purpose of the tabs.
+  - name: align
+    type: Symbol
+    default: "`:left`"
+    description: One of `:left` and `:right`. - Defaults to left
+  - name: body_arguments
+    type: Hash
+    default: "`{}`"
+    description: "[System arguments](/system-arguments) for the body wrapper."
+  - name: wrapper_arguments
+    type: Hash
+    default: "`{}`"
+    description: "[System arguments](/system-arguments) for the `TabContainer` wrapper."
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: BaseButton
   source: https://github.com/primer/view_components/tree/main/app/components/primer/base_button.rb
   parameters:
@@ -132,6 +180,13 @@
     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:
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: Text
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb
   parameters:
@@ -143,6 +198,13 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: Truncate
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb
+  parameters:
+  - name: system_arguments
+    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:
@@ -228,13 +290,6 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
-- component: Breadcrumb
-  source: https://github.com/primer/view_components/tree/main/app/components/primer/breadcrumb_component.rb
-  parameters:
-  - name: system_arguments
-    type: Hash
-    default: N/A
-    description: "[System arguments](/system-arguments)"
 - component: Button
   source: https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb
   parameters:
@@ -941,33 +996,3 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
-- component: UnderlineNav
-  source: https://github.com/primer/view_components/tree/main/app/components/primer/underline_nav_component.rb
-  parameters:
-  - name: label
-    type: String
-    default: N/A
-    description: The `aria-label` on top level `<nav>` element.
-  - name: with_panel
-    type: Boolean
-    default: "`false`"
-    description: Whether the `UnderlineNav` should navigate through pages or panels.
-      When true, [TabContainer](/components/tabcontainer) is rendered along with JavaScript
-      behavior.
-  - name: align
-    type: Symbol
-    default: "`:left`"
-    description: One of `:left` and `:right`. - Defaults to left
-  - name: body_arguments
-    type: Hash
-    default: "`{ tag: BODY_TAG_DEFAULT }`"
-    description: "[System arguments](/system-arguments) for the body wrapper."
-  - name: wrapper_arguments
-    type: Hash
-    default: "`{}`"
-    description: "[System arguments](/system-arguments) for the `TabContainer` wrapper.
-      Only applies if `with_panel` is `true`."
-  - name: system_arguments
-    type: Hash
-    default: N/A
-    description: "[System arguments](/system-arguments)"

data/static/classes.yml

@@ -10,6 +10,9 @@
 - ".Box-footer"
 - ".Box-header"
 - ".Box-row"
+- ".Box-row--blue"
+- ".Box-row--gray"
+- ".Box-row--yellow"
 - ".BtnGroup"
 - ".BtnGroup-item"
 - ".Counter"
@@ -49,6 +52,10 @@
 - ".TimelineItem-avatar"
 - ".TimelineItem-badge"
 - ".TimelineItem-body"
+- ".Truncate"
+- ".Truncate-text"
+- ".Truncate-text--expandable"
+- ".Truncate-text--primary"
 - ".UnderlineNav"
 - ".UnderlineNav--right"
 - ".UnderlineNav-actions"
@@ -107,6 +114,7 @@
 - ".custom-class"
 - ".d-flex"
 - ".d-inline-block"
+- ".d-inline-flex"
 - ".details-overlay"
 - ".details-reset"
 - ".dropdown"
@@ -168,6 +176,7 @@
 - ".tabnav-tabs"
 - ".text-bold"
 - ".text-left"
+- ".text-normal"
 - ".tooltipped"
 - ".tooltipped-n"
 - ".tooltipped-no-delay"

data/static/constants.json

@@ -33,6 +33,26 @@
       "large"
     ]
   },
+  "Primer::Alpha::UnderlineNav": {
+    "ACTIONS_TAG_DEFAULT": "div",
+    "ACTIONS_TAG_OPTIONS": [
+      "div",
+      "span"
+    ],
+    "ALIGN_DEFAULT": "left",
+    "ALIGN_OPTIONS": [
+      "left",
+      "right"
+    ],
+    "BODY_TAG_DEFAULT": "ul",
+    "TAG_DEFAULT": "nav",
+    "TAG_OPTIONS": [
+      "nav",
+      "div"
+    ]
+  },
+  "Primer::Alpha::UnderlinePanels": {
+  },
   "Primer::BaseButton": {
     "DEFAULT_TAG": "button",
     "DEFAULT_TYPE": "button",
@@ -82,27 +102,39 @@
       "span"
     ]
   },
+  "Primer::Beta::Breadcrumbs": {
+    "Item": "Primer::Beta::Breadcrumbs::Item"
+  },
+  "Primer::Beta::Breadcrumbs::Item": {
+  },
   "Primer::Beta::Text": {
     "DEFAULT_TAG": "span"
   },
+  "Primer::Beta::Truncate": {
+    "TruncateText": "Primer::Beta::Truncate::TruncateText"
+  },
+  "Primer::Beta::Truncate::TruncateText": {
+  },
   "Primer::BlankslateComponent": {
   },
   "Primer::BorderBoxComponent": {
     "DEFAULT_PADDING": "default",
+    "DEFAULT_ROW_SCHEME": "default",
     "PADDING_MAPPINGS": {
       "default": "",
       "condensed": "Box--condensed",
       "spacious": "Box--spacious"
     },
-    "PADDING_SUGGESTION": "Perhaps you could consider using :padding options of default, condensed, and spacious?"
+    "PADDING_SUGGESTION": "Perhaps you could consider using :padding options of default, condensed, and spacious?",
+    "ROW_SCHEME_MAPPINGS": {
+      "default": "",
+      "neutral": "Box-row--gray",
+      "info": "Box-row--blue",
+      "warning": "Box-row--yellow"
+    }
   },
   "Primer::BoxComponent": {
   },
-  "Primer::BreadcrumbComponent": {
-    "ItemComponent": "Primer::BreadcrumbComponent::ItemComponent"
-  },
-  "Primer::BreadcrumbComponent::ItemComponent": {
-  },
   "Primer::ButtonComponent": {
     "DEFAULT_SCHEME": "default",
     "DEFAULT_VARIANT": "medium",
@@ -607,22 +639,5 @@
       "p",
       "strong"
     ]
-  },
-  "Primer::UnderlineNavComponent": {
-    "ACTIONS_TAG_DEFAULT": "div",
-    "ACTIONS_TAG_OPTIONS": [
-      "div",
-      "span"
-    ],
-    "ALIGN_DEFAULT": "left",
-    "ALIGN_OPTIONS": [
-      "left",
-      "right"
-    ],
-    "BODY_TAG_DEFAULT": "div",
-    "BODY_TAG_OPTIONS": [
-      "div",
-      "ul"
-    ]
   }
 }