primer_view_components 0.0.59 → 0.0.60

data/lib/tasks/helpers/ast_traverser.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "primer/view_components/statuses"
+require_relative "../../../app/lib/primer/view_helper"
+
+# :nodoc:
+class AstTraverser
+  include RuboCop::AST::Traversal
+
+  attr_reader :stats
+
+  def initialize
+    @stats = {}
+  end
+
+  def on_send(node)
+    return super(node) unless component_node?(node)
+
+    name = component_name(node)
+    args = extract_arguments(node, name)
+
+    @stats[name] = { path: node.loc.expression.source_buffer.name }
+    @stats[name][:arguments] = args unless args.empty?
+
+    super(node) # recursively iterate over children
+  end
+
+  def view_helpers
+    @view_helpers ||= ::Primer::ViewHelper::HELPERS.keys.map { |key| "primer_#{key}".to_sym }
+  end
+
+  def component_node?(node)
+    view_helpers.include?(node.method_name) || (node.method_name == :new && !node.receiver.nil? && ::Primer::ViewComponents::STATUSES.key?(node.receiver.const_name))
+  end
+
+  def component_name(node)
+    return node.receiver.const_name if node.method_name == :new
+
+    helper_key = node.method_name.to_s.gsub("primer_", "").to_sym
+    Primer::ViewHelper::HELPERS[helper_key]
+  end
+
+  def extract_arguments(node, name)
+    args = node.arguments
+    res = {}
+
+    return res if args.empty?
+
+    kwargs = args.last
+    if kwargs.respond_to?(:pairs)
+      res = kwargs.pairs.each_with_object({}) do |pair, h|
+        h.merge!(extract_values(pair))
+      end
+    end
+
+    # Octicon is the only component that accepts positional arguments.
+    res[:icon] = args.first.source if name == "Primer::OcticonComponent" && args.size > 1
+
+    res
+  end
+
+  def extract_values(pair)
+    return { pair.key.value => pair.value.source } unless pair.value.type == :hash
+
+    flatten_pairs(pair, prefix: "#{pair.key.value}-")
+  end
+
+  def flatten_pairs(pair, prefix: "")
+    pair.value.pairs.each_with_object({}) do |value_pair, h|
+      if value_pair.value.type == :hash
+        h.merge!(flatten_pairs(value_pair, prefix: "#{prefix}#{value_pair.key.value}-"))
+      else
+        h.merge!("#{prefix}#{value_pair.key.value}" => value_pair.value.source)
+      end
+    end
+  end
+end

data/lib/tasks/primer_view_components.rake

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+ERB_GLOB = "**/*.html{+*,}.erb"
+RB_GLOB = "**/*.rb"
+BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/.freeze # copied from Rails: action_view/template/handlers/erb/erubi.rb
+
+namespace :primer_view_components do
+  desc "Report arguments used in each component"
+  task :report, [:paths] do |_, args|
+    require "rubocop"
+    require "better_html"
+    require "better_html/parser"
+    require "erb_lint/processed_source"
+    require_relative "helpers/ast_processor"
+
+    paths = args[:paths].split
+    stats = {}
+
+    rb_files = paths.reduce([]) { |mem, path| mem + Dir[File.join(path, RB_GLOB)] }
+
+    rb_files.each do |f|
+      ast = RuboCop::AST::ProcessedSource.from_file(f, RUBY_VERSION.to_f).ast
+      AstProcessor.process_ast(ast, stats)
+    end
+
+    erb_files = paths.reduce([]) { |mem, path| mem + Dir[File.join(path, ERB_GLOB)] }
+
+    erb_files.each do |f|
+      erb_ast = ERBLint::ProcessedSource.new(f, File.read(f)).ast
+
+      erb_ast.descendants(:erb).each do |erb_node|
+        indicator, _, code_node, = *erb_node
+
+        next if indicator&.children&.first == "#" # don't analyze comments
+
+        trimmed_source = code_node.loc.source.sub(BLOCK_EXPR, "").strip
+        ast = RuboCop::AST::ProcessedSource.new(trimmed_source, RUBY_VERSION.to_f).ast
+        AstProcessor.process_ast(ast, stats)
+      end
+    end
+
+    File.open(".primer-view-components-report.json", "w") do |f|
+      f.write(JSON.pretty_generate(stats))
+      f.write($INPUT_RECORD_SEPARATOR)
+    end
+  end
+end

data/lib/tasks/{constants.rake → static.rake}

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-namespace :constants do
+namespace :static do
   task :dump do
+    ENV["SKIP_STORYBOOK_PRELOAD"] = "1"
     require File.expand_path("./../../demo/config/environment.rb", __dir__)
     require "primer/view_components"
     # Loads all components for `.descendants` to work properly
     Dir["./app/components/primer/**/*.rb"].sort.each { |file| require file }
 
-    Primer::ViewComponents.dump_constants
+    Primer::ViewComponents.dump(:statuses)
+    Primer::ViewComponents.dump(:constants)
+    Primer::ViewComponents.dump(:audited_at)
   end
 end

data/lib/tasks/utilities.rake

@@ -9,43 +9,56 @@ namespace :utilities do
 
     # Keys that are looked for to be included in the utilities.yml file
     # rubocop:disable Lint/ConstantDefinitionInBlock
-    SUPPORTED_KEYS = %i[
-      anim
-      color-bg
-      color-border
-      color-icon
-      color-text
-      d
-      float
-      height
-      hide
-      m mt mr mb ml mx my
-      p pt pr pb pl px py
-      position
-      wb
-      width
-      v
+    SUPPORTED_KEYS = [
+      /^anim\b/,
+      /^color-bg\b/,
+      /^color-border\b/,
+      /^color-icon\b/,
+      /^color-text\b/,
+      /^color-fg\b/,
+      /^col\b/,
+      /^container\b/,
+      /^clearfix\b/,
+      /^d\b/,
+      /^float\b/,
+      /^height\b/,
+      /^hide\b/,
+      /^m[trblxy]?\b/,
+      /^p[trblxy]?\b/,
+      /^position\b/,
+      /^wb\b/,
+      /^width\b/,
+      /^v\b/
     ].freeze
 
     BREAKPOINTS = [nil, "sm", "md", "lg", "xl"].freeze
     # rubocop:enable Lint/ConstantDefinitionInBlock
 
-    css_data =
+    utility_data =
       JSON.parse(
         File.read(
-          File.join(
-            __FILE__.split("lib/tasks/utilities.rake")[0], "/node_modules/@primer/css/dist/stats/utilities.json"
-          )
+          File.expand_path(File.join(*%w[.. .. node_modules @primer css dist stats utilities.json]), __dir__)
         )
       )["selectors"]["values"]
 
+    layout_data =
+      JSON.parse(
+        File.read(
+          File.expand_path(File.join(*%w[.. .. node_modules @primer css dist stats layout.json]), __dir__)
+        )
+      )["selectors"]["values"]
+
+    css_data = utility_data + layout_data
+
     output = {}
 
     css_data.each do |selector|
       selector.sub!(/^./, "")
+      selector.sub!(/:[^\s]*$/, "")
+
       # Next if selector has ancestors or sibling selectors
       next if selector.match?(/[:><~\[.]/)
-      next unless SUPPORTED_KEYS.any? { |key| selector.start_with?("#{key}-") }
+      next unless SUPPORTED_KEYS.any? { |key| selector =~ key }
 
       # Dupe so we still have the selector at the end of slicing it up
       classname = selector.dup
@@ -77,13 +90,14 @@ namespace :utilities do
       # convert padding/margin negative values ie n7 to -7
       classname.sub!(/^n/, "-") if classname.match?(/^n[0-9]/)
 
+      # If key and classname are equal, then classname is boolean
+      classname = true if key == classname
+
       key = key.to_sym
 
-      classname = if classname.match?(/\A[-+]?[0-9]+\z/)
-                    classname.to_i
-                  else
-                    classname.to_sym
-                  end
+      if classname.is_a?(String)
+        classname = classname.match?(/\A[-+]?[0-9]+\z/) ? classname.to_i : classname.to_sym
+      end
 
       if output[key].nil?
         output[key] = { classname => Array.new(5, nil) }

data/static/arguments.yml

@@ -1,4 +1,11 @@
 ---
+- component: BorderBoxHeader
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/border_box/header.rb
+  parameters:
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: ButtonMarketing
   source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb
   parameters:
@@ -90,6 +97,30 @@
     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:
@@ -161,11 +192,11 @@
   - name: size
     type: Integer
     default: "`20`"
-    description: Adds the avatar-small class if less than 24.
-  - name: square
-    type: Boolean
-    default: "`false`"
-    description: Used to create a square avatar.
+    description: One of `16`, `20`, `24`, `32`, `40`, `48`, or `80`.
+  - name: shape
+    type: Symbol
+    default: "`:circle`"
+    description: Shape of the avatar. One of `:circle` and `:square`.
   - name: href
     type: String
     default: "`nil`"

data/static/audited_at.json

@@ -0,0 +1,61 @@
+{
+  "Primer::Alpha::BorderBox::Header": "",
+  "Primer::Alpha::ButtonMarketing": "",
+  "Primer::Alpha::TabNav": "",
+  "Primer::Alpha::TabPanels": "",
+  "Primer::Alpha::UnderlineNav": "",
+  "Primer::Alpha::UnderlinePanels": "",
+  "Primer::BaseButton": "",
+  "Primer::BaseComponent": "",
+  "Primer::Beta::AutoComplete": "",
+  "Primer::Beta::AutoComplete::Input": "",
+  "Primer::Beta::AutoComplete::Item": "",
+  "Primer::Beta::Avatar": "",
+  "Primer::Beta::AvatarStack": "",
+  "Primer::Beta::Breadcrumbs": "",
+  "Primer::Beta::Breadcrumbs::Item": "",
+  "Primer::Beta::Text": "",
+  "Primer::Beta::Truncate": "",
+  "Primer::Beta::Truncate::TruncateText": "",
+  "Primer::BlankslateComponent": "",
+  "Primer::BorderBoxComponent": "",
+  "Primer::BoxComponent": "",
+  "Primer::ButtonComponent": "",
+  "Primer::ButtonGroup": "",
+  "Primer::ClipboardCopy": "",
+  "Primer::CloseButton": "",
+  "Primer::CounterComponent": "",
+  "Primer::DetailsComponent": "",
+  "Primer::Dropdown": "",
+  "Primer::Dropdown::Menu": "",
+  "Primer::Dropdown::Menu::Item": "",
+  "Primer::DropdownMenuComponent": "",
+  "Primer::FlashComponent": "",
+  "Primer::FlexComponent": "",
+  "Primer::FlexItemComponent": "",
+  "Primer::HeadingComponent": "",
+  "Primer::HiddenTextExpander": "",
+  "Primer::IconButton": "",
+  "Primer::Image": "",
+  "Primer::ImageCrop": "",
+  "Primer::LabelComponent": "",
+  "Primer::LayoutComponent": "",
+  "Primer::LinkComponent": "",
+  "Primer::LocalTime": "",
+  "Primer::Markdown": "",
+  "Primer::MenuComponent": "",
+  "Primer::Navigation::TabComponent": "",
+  "Primer::OcticonComponent": "",
+  "Primer::OcticonSymbolsComponent": "",
+  "Primer::PopoverComponent": "",
+  "Primer::ProgressBarComponent": "",
+  "Primer::SpinnerComponent": "",
+  "Primer::StateComponent": "",
+  "Primer::SubheadComponent": "",
+  "Primer::TabContainerComponent": "",
+  "Primer::TimeAgoComponent": "",
+  "Primer::TimelineItemComponent": "",
+  "Primer::TimelineItemComponent::BadgeComponent": "",
+  "Primer::Tooltip": "",
+  "Primer::Truncate": ""
+}

data/static/classes.yml

@@ -13,6 +13,7 @@
 - ".Box-row--blue"
 - ".Box-row--gray"
 - ".Box-row--yellow"
+- ".Box-title"
 - ".BtnGroup"
 - ".BtnGroup-item"
 - ".Counter"
@@ -105,6 +106,7 @@
 - ".color-bg-success-inverse"
 - ".color-bg-tertiary"
 - ".color-border-info"
+- ".color-fg-success"
 - ".color-icon-success"
 - ".color-shadow-large"
 - ".color-text-danger"
@@ -172,6 +174,7 @@
 - ".pr-2"
 - ".pt-5"
 - ".right-0"
+- ".sr-only"
 - ".tabnav"
 - ".tabnav-tab"
 - ".tabnav-tabs"

data/static/constants.json

@@ -1,4 +1,15 @@
 {
+  "Primer::Alpha::BorderBox::Header": {
+    "TITLE_TAG_FALLBACK": "h2",
+    "TITLE_TAG_OPTIONS": [
+      "h1",
+      "h2",
+      "h3",
+      "h4",
+      "h5",
+      "h6"
+    ]
+  },
   "Primer::Alpha::ButtonMarketing": {
     "DEFAULT_SCHEME": "default",
     "DEFAULT_TAG": "button",
@@ -89,6 +100,21 @@
   "Primer::Beta::AutoComplete::Item": {
   },
   "Primer::Beta::Avatar": {
+    "DEFAULT_SHAPE": "circle",
+    "DEFAULT_SIZE": 20,
+    "SHAPE_OPTIONS": [
+      "circle",
+      "square"
+    ],
+    "SIZE_OPTIONS": [
+      16,
+      20,
+      24,
+      32,
+      40,
+      48,
+      80
+    ],
     "SMALL_THRESHOLD": 24
   },
   "Primer::Beta::AvatarStack": {

data/static/statuses.json

@@ -1,4 +1,5 @@
 {
+  "Primer::Alpha::BorderBox::Header": "alpha",
   "Primer::Alpha::ButtonMarketing": "alpha",
   "Primer::Alpha::TabNav": "alpha",
   "Primer::Alpha::TabPanels": "alpha",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.59
+  version: 0.0.60
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -378,6 +378,8 @@ files:
 - README.md
 - app/assets/javascripts/primer_view_components.js
 - app/assets/javascripts/primer_view_components.js.map
+- 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/tab_nav.html.erb
 - app/components/primer/alpha/tab_nav.rb
@@ -492,6 +494,7 @@ files:
 - app/components/primer/timeline_item_component.rb
 - app/components/primer/tooltip.rb
 - app/components/primer/truncate.rb
+- app/lib/primer/audited/dsl.rb
 - app/lib/primer/class_name_helper.rb
 - app/lib/primer/fetch_or_fallback_helper.rb
 - app/lib/primer/join_style_arguments_helper.rb
@@ -505,7 +508,6 @@ files:
 - lib/primer/classify.rb
 - lib/primer/classify/cache.rb
 - lib/primer/classify/flex.rb
-- lib/primer/classify/grid.rb
 - lib/primer/classify/utilities.rb
 - lib/primer/classify/utilities.yml
 - lib/primer/classify/validation.rb
@@ -524,12 +526,14 @@ 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_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/label_component_migration_counter.rb
+- lib/primer/view_components/linters/subhead_component_migration_counter.rb
 - lib/primer/view_components/statuses.rb
 - lib/primer/view_components/version.rb
 - lib/rubocop/config/default.yml
@@ -539,16 +543,19 @@ files:
 - lib/rubocop/cop/primer/no_tag_memoize.rb
 - lib/rubocop/cop/primer/primer_octicon.rb
 - lib/rubocop/cop/primer/system_argument_instead_of_class.rb
-- lib/tasks/constants.rake
 - lib/tasks/coverage.rake
 - lib/tasks/docs.rake
-- lib/tasks/statuses.rake
+- lib/tasks/helpers/ast_processor.rb
+- lib/tasks/helpers/ast_traverser.rb
+- lib/tasks/primer_view_components.rake
+- lib/tasks/static.rake
 - lib/tasks/utilities.rake
 - lib/yard/docs_helper.rb
 - lib/yard/renders_many_handler.rb
 - lib/yard/renders_one_handler.rb
 - static/arguments.yml
 - static/assets/view-components.svg
+- static/audited_at.json
 - static/classes.yml
 - static/constants.json
 - static/statuses.json

data/lib/primer/classify/grid.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Primer
-  class Classify
-    # Handler for PrimerCSS grid classes.
-    class Grid
-      extend Primer::FetchOrFallbackHelper
-
-      CONTAINER_KEY = :container
-      CONTAINER_VALUES = [:xl, :lg, :md, :sm].freeze
-
-      CLEARFIX_KEY = :clearfix
-      CLEARFIX_VALUES = [true, false].freeze
-
-      COL_KEY = :col
-      COL_VALUES = (1..12).to_a.freeze
-
-      KEYS = [CONTAINER_KEY, CLEARFIX_KEY, COL_KEY].freeze
-
-      class << self
-        def classes(key, value, breakpoint)
-          send(key, value, breakpoint)
-        end
-
-        private
-
-        def container(value, _breakpoint)
-          val = fetch_or_fallback(CONTAINER_VALUES, value)
-
-          "container-#{val}"
-        end
-
-        def clearfix(value, _breakpoint)
-          "clearfix" if fetch_or_fallback(CLEARFIX_VALUES, value)
-        end
-
-        def col(value, breakpoint)
-          val = fetch_or_fallback(COL_VALUES, value.to_i)
-
-          "col#{breakpoint}-#{val}"
-        end
-      end
-    end
-  end
-end

data/lib/tasks/statuses.rake

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-namespace :statuses do
-  task :dump do
-    require File.expand_path("./../../demo/config/environment.rb", __dir__)
-    require "primer/view_components"
-    # Loads all components for `.descendants` to work properly
-    Dir["./app/components/primer/**/*.rb"].sort.each { |file| require file }
-
-    Primer::ViewComponents.dump_statuses
-  end
-end