primer_view_components 0.0.45 → 0.0.49

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

@@ -32,8 +32,7 @@ module ERBLint
           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 }
 
-            # if attribute has no value_node, it means it is a boolean attribute.
-            { "\"#{attr_name}\"" => attribute.value_node ? attribute.value.to_json : true }
+            { "\"#{attr_name}\"" => attribute.value.to_json }
           else
             raise ConversionError, "Cannot convert attribute \"#{attr_name}\""
           end

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/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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "helpers"
+require_relative "autocorrectable"
+require_relative "argument_mappers/label"
+
+module ERBLint
+  module Linters
+    # Counts the number of times a HTML label is used instead of the component.
+    class LabelComponentMigrationCounter < Linter
+      include Helpers
+      include Autocorrectable
+
+      TAGS = Primer::ViewComponents::Constants.get(
+        component: "Primer::LabelComponent",
+        constant: "TAG_OPTIONS"
+      ).freeze
+
+      CLASSES = %w[Label].freeze
+      MESSAGE = "We are migrating labels to use [Primer::LabelComponent](https://primer.style/view-components/components/label), please try to use that instead of raw HTML."
+      ARGUMENT_MAPPER = ArgumentMappers::Label
+      COMPONENT = "Primer::LabelComponent"
+    end
+  end
+end

data/lib/primer/view_components/statuses.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Primer
+  # :nodoc:
+  module ViewComponents
+    STATUSES = JSON.parse(
+      File.read(
+        File.join(File.dirname(__FILE__), "../../../static/statuses.json")
+      )
+    ).freeze
+  end
+end

data/lib/primer/view_components/version.rb

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

data/lib/rubocop/config/default.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop/cop/primer
+
+AllCops:
+  DisabledByDefault: true
+
+Primer/SystemArgumentInsteadOfClass:
+  Enabled: true
+
+Primer/NoTagMemoize:
+  Enabled: false
+

data/lib/rubocop/cop/primer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "rubocop/cop/primer/no_tag_memoize"
+require "rubocop/cop/primer/system_argument_instead_of_class"

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Primer
+      # This cop ensures that tags are not set with ||=
+      #
+      # bad
+      # @system_arguments[:tag] ||= :h1
+      #
+      # good
+      # @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
+      #
+      # good
+      # @system_arguments[:tag] = :h2
+      class NoTagMemoize < RuboCop::Cop::Cop
+        INVALID_MESSAGE = <<~STR
+          Avoid `[:tag] ||=`. Instead, try one of the following:
+            - Don't allow consumers to update the tag by having a fixed tag (e.g. `system_arguments[:tag] = :div`)
+            - Use the `fetch_or_fallback` helper to only allow a tag from a restricted list.
+        STR
+
+        def_node_search :tag_memoized?, <<~PATTERN
+          (or-asgn
+            (send
+              _
+              _
+              (sym :tag)
+            )
+            _
+          )
+        PATTERN
+
+        def on_or_asgn(node)
+          add_offense(node, message: INVALID_MESSAGE) if tag_memoized?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "primer/classify/utilities"
+require "primer/view_components/statuses"
+
+module RuboCop
+  module Cop
+    module Primer
+      # This cop ensures that components use System Arguments instead of CSS classes.
+      #
+      # bad
+      # Component.new(classes: "mr-1")
+      #
+      # good
+      # Component.new(mr: 1)
+      class SystemArgumentInsteadOfClass < RuboCop::Cop::Cop
+        INVALID_MESSAGE = <<~STR
+          Avoid using CSS classes when you can use System Arguments: https://primer.style/view-components/system-arguments.
+        STR
+
+        def on_send(node)
+          return unless node.method_name == :new
+          return unless ::Primer::ViewComponents::STATUSES.key?(node.receiver.const_name)
+          return unless node.arguments?
+
+          # we are looking for hash arguments and they are always last
+          kwargs = node.arguments.last
+
+          return unless kwargs.type == :hash
+
+          # find classes pair
+          classes_arg = kwargs.pairs.find { |kwarg| kwarg.key.value == :classes }
+
+          return if classes_arg.nil?
+          return unless classes_arg.value.type == :str
+
+          # get actual classes
+          classes = classes_arg.value.value
+
+          system_arguments = ::Primer::Classify::Utilities.classes_to_hash(classes)
+
+          # no classes are fixable
+          return if system_arguments[:classes] == classes
+
+          add_offense(classes_arg, message: INVALID_MESSAGE)
+        end
+
+        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))
+          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
+
+            "#{key}: #{val}"
+          end.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/tasks/constants.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :constants 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_constants
+  end
+end