primer_view_components 0.0.51 → 0.0.52

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

@@ -2,6 +2,7 @@
 
 require "rubocop"
 
+# :nocov:
 module RuboCop
   module Cop
     module Primer

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

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "primer/classify/utilities"
+require "primer/classify/validation"
+
+# :nocov:
+module RuboCop
+  module Cop
+    module Primer
+      # This cop ensures that components use System Arguments instead of CSS classes.
+      #
+      # bad
+      # octicon(:icon)
+      # octicon("icon")
+      # octicon("icon-with-daashes")
+      # octicon(@ivar)
+      # octicon(condition > "icon" : "other-icon")
+      #
+      # good
+      # primer_octicon(:icon)
+      # primer_octicon(:"icon-with-daashes")
+      # primer_octicon(@ivar)
+      # primer_octicon(condition > "icon" : "other-icon")
+      class PrimerOcticon < RuboCop::Cop::Cop
+        INVALID_MESSAGE = <<~STR
+          Replace the octicon helper with primer_octicon. See https://primer.style/view-components/components/octicon for details.
+        STR
+
+        SIZE_ATTRIBUTES = %w[height width size].freeze
+        STRING_ATTRIBUTES = %w[aria- data-].freeze
+        VALID_ATTRIBUTES = [*SIZE_ATTRIBUTES, *STRING_ATTRIBUTES, "class"].freeze
+
+        STRING_ATTRIBUTE_REGEX = Regexp.union(STRING_ATTRIBUTES).freeze
+        ATTRIBUTE_REGEX = Regexp.union(VALID_ATTRIBUTES).freeze
+        INVALID_ATTRIBUTE = -1
+
+        def on_send(node)
+          return unless node.method_name == :octicon
+          return unless node.arguments?
+
+          kwargs = kwargs(node)
+
+          return unless kwargs.type == :hash
+
+          attributes = kwargs.keys.map(&:value)
+
+          # Don't convert unknown attributes
+          return unless attributes.all? { |attribute| attribute.match?(ATTRIBUTE_REGEX) }
+          # Can't convert size
+          return if octicon_size_attributes(kwargs) == INVALID_ATTRIBUTE
+
+          # find class pair
+          classes = classes(kwargs)
+
+          return if classes == INVALID_ATTRIBUTE
+
+          # check if classes are convertible
+          if classes.present?
+            system_arguments = ::Primer::Classify::Utilities.classes_to_hash(classes)
+            invalid_classes = (system_arguments[:classes]&.split(" ") || []).select { |class_name| ::Primer::Classify::Validation.invalid?(class_name) }
+
+            # Uses system argument that can't be converted
+            return if invalid_classes.present?
+          end
+
+          add_offense(node, message: INVALID_MESSAGE)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            kwargs = kwargs(node)
+
+            # Converting arguments for the component
+            classes = classes(kwargs)
+            size_attributes = transform_sizes(kwargs)
+            args = arguments_as_string(node, size_attributes, classes)
+
+            corrector.replace(node.loc.expression, "primer_octicon(#{args})")
+          end
+        end
+
+        private
+
+        def transform_sizes(kwargs)
+          attributes = octicon_size_attributes(kwargs)
+
+          attributes.transform_values do |size|
+            if size.between?(10, 16)
+              ""
+            elsif size.between?(22, 26)
+              ":medium"
+            else
+              size
+            end
+          end
+        end
+
+        def octicon_size_attributes(kwargs)
+          kwargs.pairs.each_with_object({}) do |pair, h|
+            next unless SIZE_ATTRIBUTES.include?(pair.key.value.to_s)
+
+            # We only support string or int values.
+            case pair.value.type
+            when :int
+              h[pair.key.value] = pair.value.source.to_i
+            when :str
+              h[pair.key.value] = pair.value.value.to_i
+            else
+              return INVALID_ATTRIBUTE
+            end
+          end
+        end
+
+        def classes(kwargs)
+          # find class pair
+          class_arg = kwargs.pairs.find { |kwarg| kwarg.key.value == :class }
+
+          return if class_arg.blank?
+          return INVALID_ATTRIBUTE unless class_arg.value.type == :str
+
+          class_arg.value.value
+        end
+
+        def arguments_as_string(node, size_attributes, classes)
+          args = icon(node.arguments.first)
+          size_args = size_attributes_to_string(size_attributes)
+          string_args = string_args_to_string(node)
+
+          args = "#{args}, #{size_attributes_to_string(size_attributes)}" if size_args.present?
+          args = "#{args}, #{::Primer::Classify::Utilities.classes_to_args(classes)}" if classes.present?
+          args = "#{args}, #{string_args}" if string_args.present?
+
+          args
+        end
+
+        def size_attributes_to_string(size_attributes)
+          # No arguments if they map to the default size
+          return if size_attributes.blank? || size_attributes.values.all?(&:blank?)
+          # Return mapped argument to `size`
+          return "size: :medium" if size_attributes.values.any?(":medium")
+
+          size_attributes.map do |key, value|
+            "#{key}: #{value}"
+          end.join(", ")
+        end
+
+        def string_args_to_string(node)
+          kwargs = kwargs(node)
+
+          args = kwargs.pairs.each_with_object([]) do |pair, acc|
+            next unless pair.key.value.to_s.match?(STRING_ATTRIBUTE_REGEX)
+
+            key =  pair.key.value.to_s == "data-test-selector" ? "test_selector" : "\"#{pair.key.value}\""
+            acc << "#{key}: #{pair.value.source}"
+          end
+
+          args.join(",")
+        end
+
+        def kwargs(node)
+          return node.arguments.last if node.arguments.size > 1
+
+          OpenStruct.new(keys: [], pairs: [], type: :hash)
+        end
+
+        def icon(node)
+          return node.source unless node.type == :str
+          return ":#{node.value}" unless node.value.include?("-")
+
+          # If the icon contains `-` we need to cast the string as a symbole
+          # E.g: `arrow-down` becomes `:"arrow-down"`
+          ":#{node.source}"
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ require "primer/classify/utilities"
 require "primer/view_components/statuses"
 require_relative "../../../../app/lib/primer/view_helper"
 
+# :nocov:
 module RuboCop
   module Cop
     module Primer
@@ -48,8 +49,8 @@ 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
 
@@ -64,21 +65,6 @@ module RuboCop
         def view_helpers
           ::Primer::ViewHelper::HELPERS.keys.map { |key| "primer_#{key}".to_sym }
         end
-
-        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
-
-            "#{key}: #{val}"
-          end.join(", ")
-        end
       end
     end
   end

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

@@ -74,6 +74,7 @@ namespace :docs do
       Primer::TimelineItemComponent,
       Primer::Tooltip,
       Primer::Truncate,
+      Primer::Beta::Truncate,
       Primer::UnderlineNavComponent
     ]
 
@@ -238,7 +239,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 +383,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

@@ -6,8 +6,9 @@ module YARD
     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 +59,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

@@ -143,6 +143,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:

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"
@@ -168,6 +175,7 @@
 - ".tabnav-tabs"
 - ".text-bold"
 - ".text-left"
+- ".text-normal"
 - ".tooltipped"
 - ".tooltipped-n"
 - ".tooltipped-no-delay"

data/static/constants.json

@@ -85,16 +85,28 @@
   "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": {
   },

data/static/statuses.json

@@ -8,6 +8,8 @@
   "Primer::Beta::Avatar": "beta",
   "Primer::Beta::AvatarStack": "beta",
   "Primer::Beta::Text": "beta",
+  "Primer::Beta::Truncate": "beta",
+  "Primer::Beta::Truncate::TruncateText": "alpha",
   "Primer::BlankslateComponent": "beta",
   "Primer::BorderBoxComponent": "beta",
   "Primer::BoxComponent": "stable",
@@ -15,7 +17,7 @@
   "Primer::BreadcrumbComponent::ItemComponent": "alpha",
   "Primer::ButtonComponent": "beta",
   "Primer::ButtonGroup": "beta",
-  "Primer::ClipboardCopy": "alpha",
+  "Primer::ClipboardCopy": "beta",
   "Primer::CloseButton": "beta",
   "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.51
+  version: 0.0.52
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -218,14 +218,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
@@ -367,6 +367,8 @@ files:
 - app/components/primer/beta/avatar_stack.html.erb
 - app/components/primer/beta/avatar_stack.rb
 - app/components/primer/beta/text.rb
+- app/components/primer/beta/truncate.html.erb
+- app/components/primer/beta/truncate.rb
 - app/components/primer/blankslate_component.html.erb
 - app/components/primer/blankslate_component.rb
 - app/components/primer/border_box_component.html.erb
@@ -476,6 +478,7 @@ files:
 - lib/primer/classify/grid.rb
 - lib/primer/classify/utilities.rb
 - lib/primer/classify/utilities.yml
+- lib/primer/classify/validation.rb
 - lib/primer/view_components.rb
 - lib/primer/view_components/constants.rb
 - lib/primer/view_components/engine.rb
@@ -498,7 +501,9 @@ files:
 - lib/primer/view_components/version.rb
 - lib/rubocop/config/default.yml
 - lib/rubocop/cop/primer.rb
+- lib/rubocop/cop/primer/deprecated_arguments.rb
 - 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