primer_view_components 0.0.43 → 0.0.44

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Error when converting arguments.
+      class ConversionError < StandardError; end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "conversion_error"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Maps element attributes to system arguments.
+      class SystemArguments
+        STRING_PARAETERS = %w[aria- data-].freeze
+        TEST_SELECTOR_REGEX = /test_selector\((?<selector>.+)\)$/.freeze
+
+        attr_reader :attribute
+        def initialize(attribute)
+          @attribute = attribute
+        end
+
+        def to_args
+          if attribute.erb?
+            _, _, code_node = *attribute.node
+
+            raise ConversionError, "Cannot convert erb block" if code_node.nil?
+
+            code = code_node.loc.source.strip
+            m = code.match(TEST_SELECTOR_REGEX)
+
+            raise ConversionError, "Cannot convert erb block" if m.blank?
+
+            { test_selector: m[:selector].tr("'", '"') }
+          elsif attr_name == "data-test-selector"
+            { test_selector: attribute.value.to_json }
+          elsif attr_name.start_with?(*STRING_PARAETERS)
+            # if attribute has no value_node, it means it is a boolean attribute.
+            { "\"#{attr_name}\"" => attribute.value_node ? attribute.value.to_json : true }
+          else
+            raise ConversionError, "Cannot convert attribute \"#{attr_name}\""
+          end
+        end
+
+        def attr_name
+          attribute.name
+        end
+      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 "argument_mappers/button"
 
 module ERBLint
   module Linters
@@ -9,8 +10,26 @@ module ERBLint
       include Helpers
 
       TAGS = %w[button summary a].freeze
-      CLASS = "btn"
+      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 message(tag)
+        args = map_arguments(tag)
+
+        return MESSAGE if args.nil?
+
+        msg = "#{MESSAGE}\n\nTry using:\n\n<%= render Primer::ButtonComponent.new"
+        msg += "(#{args})" if args.present?
+        "#{msg} %>\n\nInstead of:\n"
+      end
     end
   end
 end

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

@@ -9,7 +9,7 @@ module ERBLint
       include Helpers
 
       TAGS = %w[div].freeze
-      CLASS = "flash"
+      CLASSES = %w[flash].freeze
       MESSAGE = "We are migrating flashes to use [Primer::FlashComponent](https://primer.style/view-components/components/flash), please try to use that instead of raw HTML."
     end
   end

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

@@ -8,7 +8,7 @@ module ERBLint
     # Helper methods for linting ERB.
     module Helpers
       def self.included(base)
-        base.include(LinterRegistry)
+        base.include(ERBLint::LinterRegistry)
 
         define_method "run" do |processed_source|
           tags(processed_source).each do |tag|
@@ -17,9 +17,9 @@ module ERBLint
 
             classes = tag.attributes["class"]&.value&.split(" ")
 
-            next unless !self.class::CLASS || classes&.include?(self.class::CLASS)
+            next if self.class::CLASSES.any? && (classes & self.class::CLASSES).blank?
 
-            generate_offense(self.class, processed_source, tag, self.class::MESSAGE)
+            generate_offense(self.class, processed_source, tag, message(tag))
           end
 
           counter_correct?(processed_source)
@@ -42,6 +42,10 @@ module ERBLint
 
       private
 
+      def message(_tag)
+        self.class::MESSAGE
+      end
+
       def tags(processed_source)
         processed_source.parser.nodes_with_type(:tag).map { |tag_node| BetterHtml::Tree::Tag.from_node(tag_node) }
       end

data/lib/primer/view_components/version.rb

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

data/lib/tasks/docs.rake

@@ -43,12 +43,12 @@ namespace :docs do
       Primer::BreadcrumbComponent,
       Primer::ButtonComponent,
       Primer::ButtonGroup,
-      Primer::ButtonMarketingComponent,
+      Primer::Alpha::ButtonMarketing,
       Primer::ClipboardCopy,
       Primer::CloseButton,
       Primer::CounterComponent,
       Primer::DetailsComponent,
-      Primer::DropdownComponent,
+      Primer::Dropdown,
       Primer::DropdownMenuComponent,
       Primer::FlashComponent,
       Primer::FlexComponent,
@@ -69,7 +69,7 @@ namespace :docs do
       Primer::SubheadComponent,
       Primer::TabContainerComponent,
       Primer::TabNavComponent,
-      Primer::TextComponent,
+      Primer::Beta::Text,
       Primer::TimeAgoComponent,
       Primer::TimelineItemComponent,
       Primer::Tooltip,
@@ -78,6 +78,7 @@ namespace :docs do
     ]
 
     js_components = [
+      Primer::Dropdown,
       Primer::LocalTime,
       Primer::ImageCrop,
       Primer::AutoComplete,
@@ -91,10 +92,11 @@ namespace :docs do
     all_components = Primer::Component.descendants - [Primer::BaseComponent]
     components_needing_docs = all_components - components
 
-    components_without_examples = []
     args_for_components = []
     classes_found_in_examples = []
 
+    errors = []
+
     components.each do |component|
       documentation = registry.get(component.name)
 
@@ -113,6 +115,8 @@ namespace :docs do
         f.puts
         f.puts("import Example from '../../src/@primer/gatsby-theme-doctocat/components/example'")
 
+        initialize_method = documentation.meths.find(&:constructor?)
+
         if js_components.include?(component)
           f.puts("import RequiresJSFlash from '../../src/@primer/gatsby-theme-doctocat/components/requires-js-flash'")
           f.puts
@@ -124,108 +128,68 @@ namespace :docs do
         f.puts
         f.puts(view_context.render(inline: documentation.base_docstring))
 
-        if documentation.tags(:accessibility).any?
+        if documentation.tags(:deprecated).any?
           f.puts
-          f.puts("## Accessibility")
-          documentation.tags(:accessibility).each do |tag|
+          f.puts("## Deprecation")
+          documentation.tags(:deprecated).each do |tag|
             f.puts
             f.puts view_context.render(inline: tag.text)
           end
         end
 
-        if documentation.tags(:deprecated).any?
+        if documentation.tags(:accessibility).any?
           f.puts
-          f.puts("## Deprecation")
-          documentation.tags(:deprecated).each do |tag|
+          f.puts("## Accessibility")
+          documentation.tags(:accessibility).each do |tag|
             f.puts
             f.puts view_context.render(inline: tag.text)
           end
         end
 
-        initialize_method = documentation.meths.find(&:constructor?)
+        params = initialize_method.tags(:param)
 
-        if initialize_method.tags(:example).any?
-          f.puts
-          f.puts("## Examples")
-        else
-          components_without_examples << component
-        end
+        errors << { component.name => { arguments: "No argument documentation found" } } unless params.any?
 
-        initialize_method.tags(:example).each do |tag|
-          name = tag.name
-          description = nil
-          code = nil
+        f.puts
+        f.puts("## Arguments")
+        f.puts
+        f.puts("| Name | Type | Default | Description |")
+        f.puts("| :- | :- | :- | :- |")
 
-          if tag.text.include?("@description")
-            splitted = tag.text.split(/@description|@code/)
-            description = splitted.second.gsub(/^[ \t]{2}/, "").strip
-            code = splitted.last.gsub(/^[ \t]{2}/, "").strip
-          else
-            code = tag.text
-          end
+        docummented_params = params.map(&:name)
+        component_params = component.instance_method(:initialize).parameters.map { |p| p.last.to_s }
 
-          f.puts
-          f.puts("### #{name}")
-          if description
-            f.puts
-            f.puts(description)
+        if (docummented_params & component_params).size != component_params.size
+          err = { arguments: {} }
+          (component_params - docummented_params).each do |arg|
+            err[:arguments][arg] = "Not documented"
           end
-          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}"})
-          end
-          f.puts("<Example src=\"#{html.tr('"', "\'").delete("\n")}\" />")
-          f.puts
-          f.puts("```erb")
-          f.puts(code.to_s)
-          f.puts("```")
+
+          errors << { component.name => err }
         end
 
-        params = initialize_method.tags(:param)
-        if params.any?
-          f.puts
-          f.puts("## Arguments")
-          f.puts
-          f.puts("| Name | Type | Default | Description |")
-          f.puts("| :- | :- | :- | :- |")
-
-          args = []
-          params.each do |tag|
-            params = tag.object.parameters.find { |param| [tag.name.to_s, tag.name.to_s + ":"].include?(param[0]) }
-
-            default =
-              if params && params[1]
-                constant_name = "#{component.name}::#{params[1]}"
-                constant_value = constant_name.safe_constantize
-                if constant_value.nil?
-                  pretty_value(params[1])
-                else
-                  pretty_value(constant_value)
-                end
-              else
-                "N/A"
-              end
-
-            args << {
-              "name" => tag.name,
-              "type" => tag.types.join(", "),
-              "default" => default,
-              "description" => view_context.render(inline: tag.text)
-            }
-
-            f.puts("| `#{tag.name}` | `#{tag.types.join(', ')}` | #{default} | #{view_context.render(inline: tag.text)} |")
-          end
+        args = []
+        params.each do |tag|
+          default_value = pretty_default_value(tag, component)
 
-          component_args = {
-            "component" => short_name,
-            "source" => "https://github.com/primer/view_components/tree/main/app/components/primer/#{component.to_s.demodulize.underscore}.rb",
-            "parameters" => args
+          args << {
+            "name" => tag.name,
+            "type" => tag.types.join(", "),
+            "default" => default_value,
+            "description" => view_context.render(inline: tag.text)
           }
 
-          args_for_components << component_args
+          f.puts("| `#{tag.name}` | `#{tag.types.join(', ')}` | #{default_value} | #{view_context.render(inline: tag.text)} |")
         end
 
+        component_args = {
+          "component" => short_name,
+          "source" => "https://github.com/primer/view_components/tree/main/app/components/primer/#{component.to_s.demodulize.underscore}.rb",
+          "parameters" => args
+        }
+
+        args_for_components << component_args
+
         # Slots V2 docs
         slot_v2_methods = documentation.meths.select { |x| x[:renders_one] || x[:renders_many] }
 
@@ -250,22 +214,61 @@ namespace :docs do
             end
 
             param_tags.each do |tag|
-              params = tag.object.parameters.find { |param| [tag.name.to_s, tag.name.to_s + ":"].include?(param[0]) }
+              f.puts("| `#{tag.name}` | `#{tag.types.join(', ')}` | #{pretty_default_value(tag, component)} | #{view_context.render(inline: tag.text)} |")
+            end
+          end
+        end
 
-              default =
-                if params && params[1]
-                  "`#{params[1]}`"
-                else
-                  "N/A"
-                end
+        errors << { component.name => { example: "No examples found" } } unless initialize_method.tags(:example).any?
 
-              f.puts("| `#{tag.name}` | `#{tag.types.join(', ')}` | #{default} | #{view_context.render(inline: tag.text)} |")
-            end
+        f.puts
+        f.puts("## Examples")
+
+        initialize_method.tags(:example).each do |tag|
+          name = tag.name
+          description = nil
+          code = nil
+
+          if tag.text.include?("@description")
+            splitted = tag.text.split(/@description|@code/)
+            description = splitted.second.gsub(/^[ \t]{2}/, "").strip
+            code = splitted.last.gsub(/^[ \t]{2}/, "").strip
+          else
+            code = tag.text
+          end
+
+          f.puts
+          f.puts("### #{name}")
+          if description
+            f.puts
+            f.puts(description)
+          end
+          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}"})
           end
+          f.puts("<Example src=\"#{html.tr('"', "\'").delete("\n")}\" />")
+          f.puts
+          f.puts("```erb")
+          f.puts(code.to_s)
+          f.puts("```")
         end
       end
     end
 
+    unless errors.empty?
+      puts "==============================================="
+      puts "===================== ERRORS =================="
+      puts "===============================================\n\n"
+      puts JSON.pretty_generate(errors)
+      puts "\n\n==============================================="
+      puts "==============================================="
+      puts "==============================================="
+
+      raise
+    end
+
     File.open("static/classes.yml", "w") do |f|
       f.puts YAML.dump(classes_found_in_examples.sort.uniq)
     end
@@ -293,11 +296,6 @@ namespace :docs do
 
     puts "Markdown compiled."
 
-    if components_without_examples.any?
-      puts
-      puts "The following components have no examples defined: #{components_without_examples.map(&:name).join(', ')}. Consider adding an example?"
-    end
-
     if components_needing_docs.any?
       puts
       puts "The following components needs docs. Care to contribute them? #{components_needing_docs.map(&:name).join(', ')}"
@@ -307,6 +305,8 @@ namespace :docs do
   task :preview do
     registry = generate_yard_registry
 
+    FileUtils.rm_rf("demo/test/components/previews/primer/docs/")
+
     components = Primer::Component.descendants
 
     # Generate previews from documentation examples
@@ -361,6 +361,7 @@ namespace :docs do
     # Custom tags for yard
     YARD::Tags::Library.define_tag("Accessibility", :accessibility)
     YARD::Tags::Library.define_tag("Deprecation", :deprecation)
+    YARD::Tags::Library.define_tag("Parameter", :param, :with_types_name_and_default)
 
     puts "Building YARD documentation."
     Rake::Task["yard"].execute
@@ -369,4 +370,18 @@ namespace :docs do
     registry.load!(".yardoc")
     registry
   end
+
+  def pretty_default_value(tag, component)
+    params = tag.object.parameters.find { |param| [tag.name.to_s, tag.name.to_s + ":"].include?(param[0]) }
+    default = tag.defaults&.first || params&.second
+
+    return "N/A" unless default
+
+    constant_name = "#{component.name}::#{default}"
+    constant_value = default.safe_constantize || constant_name.safe_constantize
+
+    return pretty_value(default) if constant_value.nil?
+
+    pretty_value(constant_value)
+  end
 end