primer_view_components 0.0.46 → 0.0.50

data/lib/primer/view_components/linters/argument_mappers/button.rb

@@ -1,66 +1,54 @@
 # frozen_string_literal: true
 
-require_relative "conversion_error"
-require_relative "system_arguments"
+require_relative "base"
 
 module ERBLint
   module Linters
     module ArgumentMappers
       # Maps classes in a button element to arguments for the Button component.
-      class Button
-        SCHEME_MAPPINGS = {
-          "btn-primary" => ":primary",
-          "btn-danger" => ":danger",
-          "btn-outline" => ":outline",
-          "btn-invisible" => ":invisible",
-          "btn-link" => ":link"
-        }.freeze
+      class Button < Base
+        require "pry"
 
-        VARIANT_MAPPINGS = {
-          "btn-sm" => ":small",
-          "btn-large" => ":large"
-        }.freeze
+        SCHEME_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::ButtonComponent",
+          constant: "SCHEME_MAPPINGS",
+          symbolize: true
+        ).freeze
 
-        TYPE_OPTIONS = %w[button reset submit].freeze
+        VARIANT_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::ButtonComponent",
+          constant: "VARIANT_MAPPINGS",
+          symbolize: true
+        ).freeze
 
-        def initialize(tag)
-          @tag = tag
-        end
-
-        def to_s
-          to_args.map { |k, v| "#{k}: #{v}" }.join(", ")
-        end
-
-        def to_args
-          args = {}
+        TYPE_OPTIONS = Primer::ViewComponents::Constants.get(
+          component: "Primer::BaseButton",
+          constant: "TYPE_OPTIONS"
+        ).freeze
+        DEFAULT_TAG = Primer::ViewComponents::Constants.get(
+          component: "Primer::BaseButton",
+          constant: "DEFAULT_TAG"
+        ).freeze
 
-          args[:tag] = ":#{@tag.name}" unless @tag.name == "button"
+        ATTRIBUTES = %w[disabled type].freeze
 
-          @tag.attributes.each do |attribute|
-            attr_name = attribute.name
+        def attribute_to_args(attribute)
+          attr_name = attribute.name
 
-            if attr_name == "class"
-              args = args.merge(classes_to_args(attribute))
-            elsif attr_name == "disabled"
-              args[:disabled] = true
-            elsif attr_name == "type"
-              # button is the default type, so we don't need to do anything.
-              next if attribute.value == "button"
+          if attr_name == "disabled"
+            { disabled: true }
+          elsif attr_name == "type"
+            # button is the default type, so we don't need to do anything.
+            return {} if attribute.value == "button"
 
-              raise ConversionError, "Button component does not support type \"#{attribute.value}\"" unless TYPE_OPTIONS.include?(attribute.value)
+            raise ConversionError, "Button component does not support type \"#{attribute.value}\"" unless TYPE_OPTIONS.include?(attribute.value)
 
-              args[:type] = ":#{attribute.value}"
-            else
-              # Assume the attribute is a system argument.
-              args.merge!(SystemArguments.new(attribute).to_args)
-            end
+            { type: ":#{attribute.value}" }
           end
-
-          args
         end
 
         def classes_to_args(classes)
-          classes.value.split(" ").each_with_object({}) do |class_name, acc|
+          classes.split(" ").each_with_object({}) do |class_name, acc|
             next if class_name == "btn"
 
             if SCHEME_MAPPINGS[class_name] && acc[:scheme].nil?

data/lib/primer/view_components/linters/argument_mappers/clipboard_copy.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Maps attributes in the clipboard-copy element to arguments for the ClipboardCopy component.
+      class ClipboardCopy < Base
+        DEFAULT_TAG = "clipboard-copy"
+        ATTRIBUTES = %w[value].freeze
+
+        def attribute_to_args(attribute)
+          Helpers::ErbBlock.raise_if_erb_block(attribute)
+          { value: attribute.value.to_json }
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/linters/argument_mappers/helpers/erb_block.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../conversion_error"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      module Helpers
+        # provides helpers to identify and deal with ERB blocks.
+        class ErbBlock
+          class << self
+            def raise_if_erb_block(attribute)
+              raise ERBLint::Linters::ArgumentMappers::ConversionError, "Cannot convert attribute \"#{attribute.name}\" because its value contains an erb block" if any?(attribute)
+            end
+
+            def any?(attribute)
+              attribute.value_node&.children&.any? { |n| n.try(:type) == :erb }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/linters/argument_mappers/label.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Maps classes in a label element to arguments for the Label component.
+      class Label < Base
+        SCHEME_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::LabelComponent",
+          constant: "SCHEME_MAPPINGS",
+          symbolize: true
+        ).freeze
+
+        VARIANT_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::LabelComponent",
+          constant: "VARIANT_MAPPINGS",
+          symbolize: true
+        ).freeze
+
+        DEFAULT_TAG = Primer::ViewComponents::Constants.get(
+          component: "Primer::LabelComponent",
+          constant: "DEFAULT_TAG"
+        ).freeze
+
+        ATTRIBUTES = %w[title].freeze
+
+        def attribute_to_args(attribute)
+          Helpers::ErbBlock.raise_if_erb_block(attribute)
+          { title: attribute.value.to_json }
+        end
+
+        def classes_to_args(classes)
+          classes.split(" ").each_with_object({}) do |class_name, acc|
+            next if class_name == "Label"
+
+            if SCHEME_MAPPINGS[class_name] && acc[:scheme].nil?
+              acc[:scheme] = SCHEME_MAPPINGS[class_name]
+            elsif VARIANT_MAPPINGS[class_name] && acc[:variant].nil?
+              acc[:variant] = VARIANT_MAPPINGS[class_name]
+            else
+              raise ConversionError, "Cannot convert class \"#{class_name}\""
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/linters/argument_mappers/system_arguments.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "conversion_error"
+require_relative "helpers/erb_block"
 
 module ERBLint
   module Linters
@@ -28,9 +29,11 @@ module ERBLint
 
             { test_selector: m[:selector].tr("'", '"') }
           elsif attr_name == "data-test-selector"
+            Helpers::ErbBlock.raise_if_erb_block(attribute)
+
             { test_selector: attribute.value.to_json }
           elsif attr_name.start_with?(*STRING_PARAMETERS)
-            raise ConversionError, "Cannot convert attribute \"#{attr_name}\" because its value contains an erb block" if attribute.value_node&.children&.any? { |n| n.try(:type) == :erb }
+            Helpers::ErbBlock.raise_if_erb_block(attribute)
 
             { "\"#{attr_name}\"" => attribute.value.to_json }
           else

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "argument_mappers/conversion_error"
+
+module ERBLint
+  module Linters
+    # Helper methods for autocorrectable ERB linters.
+    module Autocorrectable
+      def map_arguments(tag)
+        self.class::ARGUMENT_MAPPER.new(tag).to_s
+      rescue ArgumentMappers::ConversionError
+        nil
+      end
+
+      def correction(args)
+        return nil if args.nil?
+
+        correction = "<%= render #{self.class::COMPONENT}.new"
+        correction += "(#{args})" if args.present?
+        "#{correction} do %>"
+      end
+
+      def message(args)
+        return self.class::MESSAGE if args.nil?
+
+        "#{self.class::MESSAGE}\n\nTry using:\n\n#{correction(args)}\n\nInstead of:\n"
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "helpers"
+require_relative "autocorrectable"
 require_relative "argument_mappers/button"
 
 module ERBLint
@@ -8,32 +9,17 @@ module ERBLint
     # Counts the number of times a HTML button is used instead of the component.
     class ButtonComponentMigrationCounter < Linter
       include Helpers
+      include Autocorrectable
+
+      TAGS = Primer::ViewComponents::Constants.get(
+        component: "Primer::BaseButton",
+        constant: "TAG_OPTIONS"
+      ).freeze
 
-      TAGS = %w[button summary a].freeze
       CLASSES = %w[btn btn-link].freeze
       MESSAGE = "We are migrating buttons to use [Primer::ButtonComponent](https://primer.style/view-components/components/button), please try to use that instead of raw HTML."
-
-      private
-
-      def map_arguments(tag)
-        ArgumentMappers::Button.new(tag).to_s
-      rescue ArgumentMappers::ConversionError
-        nil
-      end
-
-      def correction(args)
-        return nil if args.nil?
-
-        correction = "<%= render Primer::ButtonComponent.new"
-        correction += "(#{args})" if args.present?
-        "#{correction} do %>"
-      end
-
-      def message(args)
-        return MESSAGE if args.nil?
-
-        "#{MESSAGE}\n\nTry using:\n\n#{correction(args)}\n\nInstead of:\n"
-      end
+      ARGUMENT_MAPPER = ArgumentMappers::Button
+      COMPONENT = "Primer::ButtonComponent"
     end
   end
 end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "helpers"
+require_relative "autocorrectable"
+require_relative "argument_mappers/clipboard_copy"
+
+module ERBLint
+  module Linters
+    # Counts the number of times a HTML clipboard-copy is used instead of the component.
+    class ClipboardCopyComponentMigrationCounter < Linter
+      include Helpers
+      include Autocorrectable
+
+      TAGS = %w[clipboard-copy].freeze
+      CLASSES = %w[].freeze
+      MESSAGE = "We are migrating clipboard-copy to use [Primer::ClipboardCopy](https://primer.style/view-components/components/clipboardcopy), please try to use that instead of raw HTML."
+      ARGUMENT_MAPPER = ArgumentMappers::ClipboardCopy
+      COMPONENT = "Primer::ClipboardCopy"
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "helpers"
+
+module ERBLint
+  module Linters
+    # Counts the number of times a HTML clipboard-copy is used instead of the component.
+    class CloseButtonComponentMigrationCounter < Linter
+      include Helpers
+
+      TAGS = %w[button].freeze
+      CLASSES = %w[close-button].freeze
+      MESSAGE = "We are migrating close-button to use [Primer::CloseButton](https://primer.style/view-components/components/closebutton), please try to use that instead of raw HTML."
+    end
+  end
+end

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

@@ -2,6 +2,7 @@
 
 require "json"
 require "openssl"
+require "primer/view_components/constants"
 
 module ERBLint
   module Linters
@@ -13,58 +14,64 @@ module ERBLint
         link menuitem meta param source track wbr img
       ].freeze
 
+      DUMP_FILE = ".erblint-counter-ignore.json"
+
       def self.included(base)
         base.include(ERBLint::LinterRegistry)
+      end
 
-        define_method "run" do |processed_source|
-          @offenses_not_corrected = 0
-          tags = tags(processed_source)
-          tag_tree = build_tag_tree(tags)
-
-          tags.each do |tag|
-            next if tag.closing?
-            next unless self.class::TAGS&.include?(tag.name)
+      def run(processed_source)
+        @total_offenses = 0
+        @offenses_not_corrected = 0
+        tags = tags(processed_source)
+        tag_tree = build_tag_tree(tags)
 
-            classes = tag.attributes["class"]&.value&.split(" ") || []
+        tags.each do |tag|
+          next if tag.closing?
+          next unless self.class::TAGS&.include?(tag.name)
 
-            tag_tree[tag][:offense] = false
+          classes = tag.attributes["class"]&.value&.split(" ") || []
 
-            next unless self.class::CLASSES.blank? || (classes & self.class::CLASSES).any?
+          tag_tree[tag][:offense] = false
 
-            args = map_arguments(tag)
-            correction = correction(args)
+          next unless self.class::CLASSES.blank? || (classes & self.class::CLASSES).any?
 
-            tag_tree[tag][:offense] = true
-            tag_tree[tag][:correctable] = !correction.nil?
-            tag_tree[tag][:message] = message(args)
-            tag_tree[tag][:correction] = correction
-          end
+          args = map_arguments(tag)
+          correction = correction(args)
 
-          tag_tree.each do |tag, h|
-            next unless h[:offense]
+          tag_tree[tag][:offense] = true
+          tag_tree[tag][:correctable] = !correction.nil?
+          tag_tree[tag][:message] = message(args)
+          tag_tree[tag][:correction] = correction
+        end
 
-            # We always fix the offenses using blocks. The closing tag corresponds to `<% end %>`.
-            if h[:correctable]
-              add_offense(tag.loc, h[:message], h[:correction])
-              add_offense(h[:closing].loc, h[:message], "<% end %>")
-            else
-              @offenses_not_corrected += 1
-              generate_offense(self.class, processed_source, tag, h[:message])
-            end
+        tag_tree.each do |tag, h|
+          next unless h[:offense]
+
+          @total_offenses += 1
+          # We always fix the offenses using blocks. The closing tag corresponds to `<% end %>`.
+          if h[:correctable]
+            add_offense(tag.loc, h[:message], h[:correction])
+            add_offense(h[:closing].loc, h[:message], "<% end %>")
+          else
+            @offenses_not_corrected += 1
+            generate_offense(self.class, processed_source, tag, h[:message])
           end
-
-          counter_correct?(processed_source)
         end
 
-        define_method "autocorrect" do |processed_source, offense|
-          return unless offense.context
+        counter_correct?(processed_source)
 
-          lambda do |corrector|
-            if offense.context.include?(counter_disable)
-              correct_counter(corrector, processed_source, offense)
-            else
-              corrector.replace(offense.source_range, offense.context)
-            end
+        dump_data(processed_source) if ENV["DUMP_LINT_DATA"] == "1"
+      end
+
+      def autocorrect(processed_source, offense)
+        return unless offense.context
+
+        lambda do |corrector|
+          if offense.context.include?(counter_disable)
+            correct_counter(corrector, processed_source, offense)
+          else
+            corrector.replace(offense.source_range, offense.context)
           end
         end
       end
@@ -186,6 +193,17 @@ module ERBLint
         offense = ["#{klass_name}:#{message}", tag.node.loc.source].join("\n")
         add_offense(processed_source.to_source_range(tag.loc), offense, replacement)
       end
+
+      def dump_data(processed_source)
+        return if @total_offenses.zero?
+
+        data = File.exist?(DUMP_FILE) ? JSON.parse(File.read(DUMP_FILE)) : {}
+
+        data[processed_source.filename] ||= {}
+        data[processed_source.filename][self.class.name.demodulize] = @total_offenses
+
+        File.write(DUMP_FILE, JSON.pretty_generate(data))
+      end
     end
   end
 end