primer_view_components 0.0.81 → 0.0.84

data/app/components/primer/conditional_wrapper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Primer
+  # Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition
+  # is true, a `Primer::BaseComponent` will render around the content. If the condition is false, only
+  # the content is rendered.
+  #
+  # @example True conditional
+  #   <%# condition is true, so content will be wrapped in a <span> tag
+  #   <%= render Primer::ConditionalWrapper.new(condition: true, tag: :span, class: "foobar")) do %>
+  #     <%# also rendered %>
+  #     <p class="bazboo">Some text</p>
+  #   <% end %>
+  #
+  # @example False conditional
+  #   <%# condition is false so no <span> tag will render around the content (i.e. the <p> tag)
+  #   <%= render(Primer::ConditionalWrapper.new(condition: false, tag: :span, class: "foobar")) do %>
+  #     <%# this content will be rendered %>
+  #     <p class="bazboo">Some text</p>
+  #   <% end %>
+  #
+  # @param condition [Boolean] Whether or not to wrap the content in a `Primer::BaseComponent`.
+  # @param base_component_arguments [Hash] The arguments to pass to `Primer::BaseComponent`.
+  class ConditionalWrapper < Primer::Component
+    def initialize(condition:, **base_component_arguments)
+      @condition = condition
+      @base_component_arguments = base_component_arguments
+    end
+
+    def call
+      return content unless @condition
+
+      BaseComponent.new(**@base_component_arguments).render_in(self) { content }
+    end
+  end
+end

data/app/components/primer/layout_component.html.erb

@@ -1,3 +1,4 @@
+<%# erblint:counter DeprecatedComponentsCounter 1 %>
 <%= render(Primer::FlexComponent.new(**@system_arguments)) do %>
   <% if @side == :left %>
     <%= sidebar %>

data/lib/primer/view_components/linters/deprecated_components_counter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "helpers/deprecated_components_helpers"
+require "erblint-github/linters/custom_helpers"
+
+module ERBLint
+  module Linters
+    # Lints against deprecated components
+    class DeprecatedComponentsCounter < Linter
+      include CustomHelpers
+      include ERBLint::LinterRegistry
+      include Helpers::DeprecatedComponentsHelpers
+
+      def run(processed_source)
+        processed_source.ast.descendants(:erb).each do |erb_node|
+          _, _, code_node = *erb_node
+          code = code_node.children.first.strip
+
+          next unless code.include?("Primer::")
+
+          deprecated_components.each do |component|
+            next unless code.include?(component)
+
+            add_offense(
+              erb_node.loc,
+              message(component)
+            )
+          end
+        end
+
+        counter_correct?(processed_source)
+      end
+
+      def autocorrect(processed_source, offense)
+        return unless offense.context
+
+        lambda do |corrector|
+          if processed_source.file_content.include?("erblint:counter #{self.class.name.gsub('ERBLint::Linters::', '')}")
+            # update the counter if exists
+            corrector.replace(offense.source_range, offense.context)
+          else
+            # add comment with counter if none
+            corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/linters/helpers/deprecated_components_helpers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    module Helpers
+      # Helpers to share between DeprecatedComponents ERB lint and Rubocop cop
+      module DeprecatedComponentsHelpers
+        # If there is no alternative to suggest, set the value to nil
+        COMPONENT_TO_USE_INSTEAD = {
+          "Primer::Alpha::AutoComplete::Item" => "Primer::Beta::AutoComplete::Item",
+          "Primer::Alpha::AutoComplete" => "Primer::Beta::AutoComplete",
+          "Primer::BlankslateComponent" => "Primer::Beta::Blankslate",
+          "Primer::DropdownMenuComponent" => nil,
+          "Primer::Tooltip" => "Primer::Alpha::Tooltip",
+          "Primer::FlexComponent" => nil,
+          "Primer::FlexItemComponent" => nil
+        }.freeze
+
+        def message(component)
+          message = "#{component} has been deprecated and should not be used."
+          message += " Try #{COMPONENT_TO_USE_INSTEAD[component]} instead." if COMPONENT_TO_USE_INSTEAD.fetch(component).present?
+          message
+        end
+
+        def statuses_json
+          JSON.parse(
+            File.read(
+              File.join(File.dirname(__FILE__), "../../../../../static/statuses.json")
+            )
+          ).freeze
+        end
+
+        def deprecated_components
+          @deprecated_components ||= statuses_json.select { |_, value| value == "deprecated" }.keys.tap do |deprecated_components|
+            deprecated_components.each do |deprecated|
+              unless COMPONENT_TO_USE_INSTEAD.key?(deprecated)
+                raise "Please provide a component that should be used in place of #{deprecated} in COMPONENT_TO_USE_INSTEAD. "\
+                      "If there is no alternative, set the value to nil."
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 0
-      PATCH = 81
+      PATCH = 84
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

data/lib/rubocop/config/default.yml

@@ -1,33 +1,9 @@
 require:
   - rubocop/cop/primer
-  - rubocop-rails
 
-####### RUBOCOP'S DEFAULTS #######
-# we don't want these in .erb files
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# lots of false-positives in .erb files
-Layout/InitialIndentation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-# lots of false-positives - this cop is meant for Ruby code, not .erb
-Layout/TrailingEmptyLines:
-  Enabled: false
-
-# it's often not desirable to add unnecessary newlines into .erb files, as
-# they will appear in the rendered HTML
-Layout/LineLength:
-  Enabled: false
-
-# calling .html_safe in templates is ok
-Rails/OutputSafety:
-  Enabled: false
+AllCops:
+  DisabledByDefault: true
 
-####### PRIMER COPS #######
 Primer/SystemArgumentInsteadOfClass:
   Enabled: true
 

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

@@ -33,6 +33,16 @@ module RuboCop
         # }
         #
         DEPRECATED = {
+          is_label_inline: nil,
+          with_icon: nil,
+          is_label_visible: {
+            false => "visually_hide_label: true",
+            true => "visually_hide_label: false"
+          },
+          is_clearable: {
+            false => "show_clear_button: false",
+            true => "show_clear_button: true"
+          },
           bg: {
             white: "bg: :primary",
             gray_light: "bg: :secondary",

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

@@ -3,6 +3,7 @@
 require "rubocop"
 require "json"
 require "parser/current"
+require_relative "./../../../primer/view_components/linters/helpers/deprecated_components_helpers"
 
 module RuboCop
   module Cop
@@ -21,14 +22,7 @@ module RuboCop
       # good
       # Primer::Alpha::Tooltip.new(:foo)
       class DeprecatedComponents < BaseCop
-        # If there is no alternative to suggest, set the value to nil.
-        COMPONENT_TO_USE_INSTEAD = {
-          "Primer::BlankslateComponent" => "Primer::Beta::Blankslate",
-          "Primer::DropdownMenuComponent" => nil,
-          "Primer::Tooltip" => "Primer::Alpha::Tooltip",
-          "Primer::FlexComponent" => nil,
-          "Primer::FlexItemComponent" => nil
-        }.freeze
+        include ERBLint::Linters::Helpers::DeprecatedComponentsHelpers
 
         def on_send(node)
           return unless node.source.include?("Primer::")
@@ -49,31 +43,6 @@ module RuboCop
                              .delete("\n")
                              .gsub("  ", " ")
         end
-
-        def message(component)
-          message = "#{component} has been deprecated and should not be used."
-          message += " Try #{COMPONENT_TO_USE_INSTEAD[component]} instead." if COMPONENT_TO_USE_INSTEAD.fetch(component).present?
-          message
-        end
-
-        def statuses_json
-          JSON.parse(
-            File.read(
-              File.join(File.dirname(__FILE__), "../../../../static/statuses.json")
-            )
-          ).freeze
-        end
-
-        def deprecated_components
-          @deprecated_components ||= statuses_json.select { |_, value| value == "deprecated" }.keys.tap do |deprecated_components|
-            deprecated_components.each do |deprecated|
-              unless COMPONENT_TO_USE_INSTEAD.key?(deprecated)
-                raise "Please provide a component that should be used in place of #{deprecated} in COMPONENT_TO_USE_INSTEAD. "\
-                      "If there is no alternative, set the value to nil."
-              end
-            end
-          end
-        end
       end
     end
   end

data/lib/tasks/docs.rake

@@ -359,7 +359,7 @@ namespace :docs do
   task :preview do
     registry = generate_yard_registry
 
-    FileUtils.rm_rf("demo/test/components/previews/primer/docs/")
+    FileUtils.rm_rf("test/previews/primer/docs/")
 
     components = Primer::Component.descendants
 
@@ -373,7 +373,7 @@ namespace :docs do
 
       yard_example_tags = initialize_method.tags(:example)
 
-      path = Pathname.new("demo/test/components/previews/primer/docs/#{short_name.underscore}_preview.rb")
+      path = Pathname.new("test/previews/primer/docs/#{short_name.underscore}_preview.rb")
       path.dirname.mkdir unless path.dirname.exist?
 
       File.open(path, "w") do |f|
@@ -386,7 +386,7 @@ namespace :docs do
           method_name = name.split("|").first.downcase.parameterize.underscore
           f.puts("      def #{method_name}; end")
           f.puts unless index == yard_example_tags.size - 1
-          path = Pathname.new("demo/test/components/previews/primer/docs/#{short_name.underscore}_preview/#{method_name}.html.erb")
+          path = Pathname.new("test/previews/primer/docs/#{short_name.underscore}_preview/#{method_name}.html.erb")
           path.dirname.mkdir unless path.dirname.exist?
           File.open(path, "w") do |view_file|
             view_file.puts(code.to_s)

data/static/arguments.yml

@@ -210,28 +210,47 @@
     type: String
     default: N/A
     description: Id of the list element.
-  - name: with_icon
+  - name: visually_hide_label
     type: Boolean
     default: "`false`"
-    description: Controls if a search icon is visible, defaults to `false`.
-  - name: is_label_visible
-    type: Boolean
-    default: "`true`"
-    description: Controls if the label is visible. If `false`, screen reader only
-      text will be added.
-  - name: is_clearable
+    description: Controls if the label is visible. If `true`, screen reader only text
+      will be added.
+  - name: show_clear_button
     type: Boolean
     default: "`false`"
     description: Adds optional clear button.
-  - name: is_label_inline
-    type: Boolean
-    default: "`false`"
-    description: Controls if the label is inline. On smaller screens, label will always
-      become stacked.
   - name: system_arguments
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+  - name: size
+    type: Hash
+    default: "`:medium`"
+    description: Input size can be small, medium (default), or large
+  - name: full_width
+    type: Boolean
+    default: "`false`"
+    description: Input can be full-width or fit to content
+  - name: disabled
+    type: Boolean
+    default: "`false`"
+    description: Disabled input
+  - name: invalid
+    type: Boolean
+    default: "`false`"
+    description: Invalid input
+  - name: placeholder
+    type: String
+    default: "`nil`"
+    description: The placeholder text displayed within the input
+  - name: inset
+    type: Boolean
+    default: "`false`"
+    description: subtle input background color
+  - name: monospace
+    type: Boolean
+    default: "`false`"
+    description: monospace input font family
 - component: AutoCompleteItem
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb
   parameters:
@@ -247,6 +266,14 @@
     type: Boolean
     default: "`false`"
     description: Whether the item is disabled.
+  - name: description_variant
+    type: Hash
+    default: "`:block`"
+    description: Changes the description style. Allowed values are :inline, :block
+  - name: description
+    type: String
+    default: N/A
+    description: Display description text below label
   - name: system_arguments
     type: Hash
     default: N/A

data/static/audited_at.json

@@ -1,4 +1,6 @@
 {
+  "Primer::Alpha::AutoComplete": "",
+  "Primer::Alpha::AutoComplete::Item": "",
   "Primer::Alpha::BorderBox::Header": "",
   "Primer::Alpha::ButtonMarketing": "",
   "Primer::Alpha::Layout": "",
@@ -29,6 +31,7 @@
   "Primer::ButtonGroup": "",
   "Primer::ClipboardCopy": "",
   "Primer::CloseButton": "",
+  "Primer::ConditionalWrapper": "",
   "Primer::Content": "",
   "Primer::CounterComponent": "",
   "Primer::DetailsComponent": "",

data/static/classes.yml

@@ -1,4 +1,8 @@
 ---
+- ".ActionList"
+- ".ActionList-content"
+- ".ActionList-item"
+- ".ActionList-item-label"
 - ".AvatarStack"
 - ".AvatarStack--right"
 - ".AvatarStack--three-plus"
@@ -19,6 +23,19 @@
 - ".Counter"
 - ".Counter--primary"
 - ".Counter--secondary"
+- ".FormControl"
+- ".FormControl--fullWidth"
+- ".FormControl-input"
+- ".FormControl-input-leadingVisual"
+- ".FormControl-input-leadingVisualWrap"
+- ".FormControl-input-trailingAction"
+- ".FormControl-input-wrap"
+- ".FormControl-input-wrap--leadingVisual"
+- ".FormControl-input-wrap--trailingAction"
+- ".FormControl-inset"
+- ".FormControl-label"
+- ".FormControl-medium"
+- ".FormControl-monospace"
 - ".Label"
 - ".Label--accent"
 - ".Label--attention"
@@ -49,6 +66,12 @@
 - ".Link--muted"
 - ".Link--primary"
 - ".Link--secondary"
+- ".Overlay"
+- ".Overlay--height-auto"
+- ".Overlay--width-auto"
+- ".Overlay-backdrop--anchor"
+- ".Overlay-body"
+- ".Overlay-body--paddingNone"
 - ".Popover"
 - ".Popover-message"
 - ".Popover-message--large"
@@ -82,12 +105,6 @@
 - ".UnderlineNav-item"
 - ".UnderlineNav-octicon"
 - ".anim-rotate"
-- ".autocomplete-body"
-- ".autocomplete-embedded-icon-wrap"
-- ".autocomplete-item"
-- ".autocomplete-label-inline"
-- ".autocomplete-label-stacked"
-- ".autocomplete-results"
 - ".avatar"
 - ".avatar-more"
 - ".avatar-small"
@@ -167,7 +184,6 @@
 - ".flex-justify-center"
 - ".flex-shrink-0"
 - ".float-right"
-- ".form-control"
 - ".gutter-condensed"
 - ".gutter-lg"
 - ".hidden-text-expander"

data/static/constants.json

@@ -1,4 +1,9 @@
 {
+  "Primer::Alpha::AutoComplete": {
+    "Item": "Primer::Alpha::AutoComplete::Item"
+  },
+  "Primer::Alpha::AutoComplete::Item": {
+  },
   "Primer::Alpha::BorderBox::Header": {
     "TITLE_TAG_FALLBACK": "h2",
     "TITLE_TAG_OPTIONS": [
@@ -199,9 +204,24 @@
     ]
   },
   "Primer::Beta::AutoComplete": {
-    "Item": "Primer::Beta::AutoComplete::Item"
+    "DEFAULT_SIZE": "medium",
+    "Item": "Primer::Beta::AutoComplete::Item",
+    "SIZE_MAPPINGS": {
+      "small": "FormControl-small",
+      "medium": "FormControl-medium",
+      "large": "FormControl-large"
+    },
+    "SIZE_OPTIONS": [
+      "small",
+      "medium",
+      "large"
+    ]
   },
   "Primer::Beta::AutoComplete::Item": {
+    "ALLOWED_DESCRIPTION_VARIANTS": [
+      "inline",
+      "block"
+    ]
   },
   "Primer::Beta::Avatar": {
     "DEFAULT_SHAPE": "circle",
@@ -336,6 +356,8 @@
       "submit"
     ]
   },
+  "Primer::ConditionalWrapper": {
+  },
   "Primer::Content": {
   },
   "Primer::CounterComponent": {

data/static/statuses.json

@@ -1,4 +1,6 @@
 {
+  "Primer::Alpha::AutoComplete": "alpha",
+  "Primer::Alpha::AutoComplete::Item": "alpha",
   "Primer::Alpha::BorderBox::Header": "alpha",
   "Primer::Alpha::ButtonMarketing": "alpha",
   "Primer::Alpha::Layout": "alpha",
@@ -29,6 +31,7 @@
   "Primer::ButtonGroup": "beta",
   "Primer::ClipboardCopy": "beta",
   "Primer::CloseButton": "beta",
+  "Primer::ConditionalWrapper": "alpha",
   "Primer::Content": "stable",
   "Primer::CounterComponent": "beta",
   "Primer::DetailsComponent": "beta",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.81
+  version: 0.0.84
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -170,6 +170,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: erblint-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +198,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -366,7 +394,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description:
+description: 
 email:
 - opensource+primer_view_components@github.com
 executables: []
@@ -378,6 +406,9 @@ files:
 - README.md
 - app/assets/javascripts/primer_view_components.js
 - app/assets/javascripts/primer_view_components.js.map
+- app/components/primer/alpha/auto_complete.rb
+- app/components/primer/alpha/auto_complete/auto_complete.html.erb
+- app/components/primer/alpha/auto_complete/item.rb
 - app/components/primer/alpha/border_box/header.html.erb
 - app/components/primer/alpha/border_box/header.rb
 - app/components/primer/alpha/button_marketing.rb
@@ -402,6 +433,7 @@ files:
 - app/components/primer/beta/auto_complete/auto_complete.html.erb
 - app/components/primer/beta/auto_complete/auto_complete.js
 - app/components/primer/beta/auto_complete/auto_complete.ts
+- app/components/primer/beta/auto_complete/item.html.erb
 - app/components/primer/beta/auto_complete/item.rb
 - app/components/primer/beta/avatar.rb
 - app/components/primer/beta/avatar_stack.html.erb
@@ -431,6 +463,7 @@ files:
 - app/components/primer/clipboard_copy_component.ts
 - app/components/primer/close_button.rb
 - app/components/primer/component.rb
+- app/components/primer/conditional_wrapper.rb
 - app/components/primer/content.rb
 - app/components/primer/counter_component.rb
 - app/components/primer/details_component.html.erb
@@ -536,8 +569,10 @@ files:
 - 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/deprecated_components_counter.rb
 - lib/primer/view_components/linters/disallow_action_list.rb
 - lib/primer/view_components/linters/flash_migration_counter.rb
+- lib/primer/view_components/linters/helpers/deprecated_components_helpers.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
@@ -580,7 +615,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -588,15 +623,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ViewComponents for the Primer Design System
 test_files: []