primer_view_components 0.0.38 → 0.0.43

data/app/lib/primer/tabbed_component_helper.rb

@@ -20,10 +20,10 @@ module Primer
       with_panel ? :div : :nav
     end
 
-    def wrapper
+    def wrapper(**system_arguments)
       return yield unless @with_panel
 
-      render Primer::TabContainerComponent.new do
+      render Primer::TabContainerComponent.new(**system_arguments) do
         yield
       end
     end

data/app/lib/primer/view_helper.rb

@@ -8,7 +8,8 @@ module Primer
     HELPERS = {
       octicon: "Primer::OcticonComponent",
       heading: "Primer::HeadingComponent",
-      time_ago: "Primer::TimeAgoComponent"
+      time_ago: "Primer::TimeAgoComponent",
+      image: "Primer::Image"
     }.freeze
 
     HELPERS.each do |name, component|

data/lib/primer/view_components.rb

@@ -27,7 +27,7 @@ module Primer
       statuses = generate_statuses
 
       File.open(File.join(path, DEFAULT_STATUS_FILE_NAME), "w") do |f|
-        f.write(statuses.to_json)
+        f.write(JSON.pretty_generate(statuses))
         f.write($INPUT_RECORD_SEPARATOR)
       end
     end

data/lib/primer/view_components/engine.rb

@@ -13,7 +13,9 @@ module Primer
       ]
 
       config.primer_view_components = ActiveSupport::OrderedOptions.new
+
       config.primer_view_components.force_functional_colors = true
+      config.primer_view_components.force_system_arguments = false
       config.primer_view_components.silence_deprecations = false
 
       initializer "primer_view_components.assets" do |app|

data/lib/primer/view_components/linters.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "linters", "*.rb")].sort.each { |file| require file }

data/lib/primer/view_components/linters/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 button is used instead of the component.
+    class ButtonComponentMigrationCounter < Linter
+      include Helpers
+
+      TAGS = %w[button summary a].freeze
+      CLASS = "btn"
+      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."
+    end
+  end
+end

data/lib/primer/view_components/linters/flash_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 flash is used instead of the component.
+    class FlashComponentMigrationCounter < Linter
+      include Helpers
+
+      TAGS = %w[div].freeze
+      CLASS = "flash"
+      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
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "json"
+require "openssl"
+
+module ERBLint
+  module Linters
+    # Helper methods for linting ERB.
+    module Helpers
+      def self.included(base)
+        base.include(LinterRegistry)
+
+        define_method "run" do |processed_source|
+          tags(processed_source).each do |tag|
+            next if tag.closing?
+            next unless self.class::TAGS&.include?(tag.name)
+
+            classes = tag.attributes["class"]&.value&.split(" ")
+
+            next unless !self.class::CLASS || classes&.include?(self.class::CLASS)
+
+            generate_offense(self.class, processed_source, tag, self.class::MESSAGE)
+          end
+
+          counter_correct?(processed_source)
+        end
+
+        define_method "autocorrect" do |processed_source, offense|
+          return unless offense.context
+
+          lambda do |corrector|
+            if processed_source.file_content.include?("erblint:counter #{self.class.name.demodulize}")
+              # 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
+
+      private
+
+      def tags(processed_source)
+        processed_source.parser.nodes_with_type(:tag).map { |tag_node| BetterHtml::Tree::Tag.from_node(tag_node) }
+      end
+
+      def counter_correct?(processed_source)
+        comment_node = nil
+        expected_count = 0
+        rule_name = self.class.name.match(/:?:?(\w+)\Z/)[1]
+        offenses_count = @offenses.length
+
+        processed_source.parser.ast.descendants(:erb).each do |node|
+          indicator_node, _, code_node, = *node
+          indicator = indicator_node&.loc&.source
+          comment = code_node&.loc&.source&.strip
+
+          if indicator == "#" && comment.start_with?("erblint:count") && comment.match(rule_name)
+            comment_node = code_node
+            expected_count = comment.match(/\s(\d+)\s?$/)[1].to_i
+          end
+        end
+
+        if offenses_count.zero?
+          add_offense(processed_source.to_source_range(comment_node.loc), "Unused erblint:count comment for #{rule_name}") if comment_node
+          return
+        end
+
+        first_offense = @offenses[0]
+
+        if comment_node.nil?
+          add_offense(processed_source.to_source_range(first_offense.source_range), "#{rule_name}: If you must, add <%# erblint:counter #{rule_name} #{offenses_count} %> to bypass this check.", "<%# erblint:counter #{rule_name} #{offenses_count} %>")
+        else
+          clear_offenses
+          add_offense(processed_source.to_source_range(comment_node.loc), "Incorrect erblint:counter number for #{rule_name}. Expected: #{expected_count}, actual: #{offenses_count}.", " erblint:counter #{rule_name} #{offenses_count} ") if expected_count != offenses_count
+        end
+      end
+
+      def generate_offense(klass, processed_source, tag, message = nil, replacement = nil)
+        message ||= klass::MESSAGE
+        klass_name = klass.name.split("::")[-1]
+        offense = ["#{klass_name}:#{message}", tag.node.loc.source].join("\n")
+        add_offense(processed_source.to_source_range(tag.loc), offense, replacement)
+      end
+    end
+  end
+end

data/lib/primer/view_components/version.rb

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

data/lib/tasks/coverage.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+namespace :coverage do
+  task :report do
+    require "simplecov"
+    require "simplecov-console"
+
+    SimpleCov.minimum_coverage 100
+
+    SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"], "rails" do
+      formatter SimpleCov::Formatter::Console
+    end
+  end
+end

data/lib/tasks/docs.rake

@@ -0,0 +1,372 @@
+# frozen_string_literal: true
+
+namespace :docs do
+  task :livereload do
+    require "listen"
+
+    Rake::Task["docs:build"].execute
+
+    puts "Listening for changes to documentation..."
+
+    listener = Listen.to("app") do |modified, added, removed|
+      puts "modified absolute path: #{modified}"
+      puts "added absolute path: #{added}"
+      puts "removed absolute path: #{removed}"
+
+      Rake::Task["docs:build"].execute
+    end
+    listener.start # not blocking
+    sleep
+  end
+
+  task :build do
+    registry = generate_yard_registry
+
+    puts "Converting YARD documentation to Markdown files."
+
+    # Rails controller for rendering arbitrary ERB
+    view_context = ApplicationController.new.tap { |c| c.request = ActionDispatch::TestRequest.create }.view_context
+    components = [
+      Primer::Image,
+      Primer::LocalTime,
+      Primer::OcticonSymbolsComponent,
+      Primer::ImageCrop,
+      Primer::IconButton,
+      Primer::AutoComplete,
+      Primer::AutoComplete::Item,
+      Primer::AvatarComponent,
+      Primer::AvatarStackComponent,
+      Primer::BaseButton,
+      Primer::BlankslateComponent,
+      Primer::BorderBoxComponent,
+      Primer::BoxComponent,
+      Primer::BreadcrumbComponent,
+      Primer::ButtonComponent,
+      Primer::ButtonGroup,
+      Primer::ButtonMarketingComponent,
+      Primer::ClipboardCopy,
+      Primer::CloseButton,
+      Primer::CounterComponent,
+      Primer::DetailsComponent,
+      Primer::DropdownComponent,
+      Primer::DropdownMenuComponent,
+      Primer::FlashComponent,
+      Primer::FlexComponent,
+      Primer::FlexItemComponent,
+      Primer::HeadingComponent,
+      Primer::HiddenTextExpander,
+      Primer::LabelComponent,
+      Primer::LayoutComponent,
+      Primer::LinkComponent,
+      Primer::Markdown,
+      Primer::MenuComponent,
+      Primer::Navigation::TabComponent,
+      Primer::OcticonComponent,
+      Primer::PopoverComponent,
+      Primer::ProgressBarComponent,
+      Primer::StateComponent,
+      Primer::SpinnerComponent,
+      Primer::SubheadComponent,
+      Primer::TabContainerComponent,
+      Primer::TabNavComponent,
+      Primer::TextComponent,
+      Primer::TimeAgoComponent,
+      Primer::TimelineItemComponent,
+      Primer::Tooltip,
+      Primer::Truncate,
+      Primer::UnderlineNavComponent
+    ]
+
+    js_components = [
+      Primer::LocalTime,
+      Primer::ImageCrop,
+      Primer::AutoComplete,
+      Primer::ClipboardCopy,
+      Primer::TabContainerComponent,
+      Primer::TabNavComponent,
+      Primer::TimeAgoComponent,
+      Primer::UnderlineNavComponent
+    ]
+
+    all_components = Primer::Component.descendants - [Primer::BaseComponent]
+    components_needing_docs = all_components - components
+
+    components_without_examples = []
+    args_for_components = []
+    classes_found_in_examples = []
+
+    components.each do |component|
+      documentation = registry.get(component.name)
+
+      # Primer::AvatarComponent => Avatar
+      short_name = component.name.gsub(/Primer|::|Component/, "")
+
+      path = Pathname.new("docs/content/components/#{short_name.downcase}.md")
+      path.dirname.mkdir unless path.dirname.exist?
+      File.open(path, "w") do |f|
+        f.puts("---")
+        f.puts("title: #{short_name}")
+        f.puts("status: #{component.status.to_s.capitalize}")
+        f.puts("source: https://github.com/primer/view_components/tree/main/app/components/primer/#{component.to_s.demodulize.underscore}.rb")
+        f.puts("storybook: https://primer.style/view-components/stories/?path=/story/primer-#{short_name.underscore.dasherize}-component")
+        f.puts("---")
+        f.puts
+        f.puts("import Example from '../../src/@primer/gatsby-theme-doctocat/components/example'")
+
+        if js_components.include?(component)
+          f.puts("import RequiresJSFlash from '../../src/@primer/gatsby-theme-doctocat/components/requires-js-flash'")
+          f.puts
+          f.puts("<RequiresJSFlash />")
+        end
+
+        f.puts
+        f.puts("<!-- Warning: AUTO-GENERATED file, do not edit. Add code comments to your Ruby instead <3 -->")
+        f.puts
+        f.puts(view_context.render(inline: documentation.base_docstring))
+
+        if documentation.tags(:accessibility).any?
+          f.puts
+          f.puts("## Accessibility")
+          documentation.tags(:accessibility).each do |tag|
+            f.puts
+            f.puts view_context.render(inline: tag.text)
+          end
+        end
+
+        if documentation.tags(:deprecated).any?
+          f.puts
+          f.puts("## Deprecation")
+          documentation.tags(:deprecated).each do |tag|
+            f.puts
+            f.puts view_context.render(inline: tag.text)
+          end
+        end
+
+        initialize_method = documentation.meths.find(&:constructor?)
+
+        if initialize_method.tags(:example).any?
+          f.puts
+          f.puts("## Examples")
+        else
+          components_without_examples << component
+        end
+
+        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
+
+        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
+
+          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
+        end
+
+        # Slots V2 docs
+        slot_v2_methods = documentation.meths.select { |x| x[:renders_one] || x[:renders_many] }
+
+        if slot_v2_methods.any?
+          f.puts
+          f.puts("## Slots")
+
+          slot_v2_methods.each do |slot_documentation|
+            f.puts
+            f.puts("### `#{slot_documentation.name.to_s.capitalize}`")
+
+            if slot_documentation.base_docstring.present?
+              f.puts
+              f.puts(view_context.render(inline: slot_documentation.base_docstring))
+            end
+
+            param_tags = slot_documentation.tags(:param)
+            if param_tags.any?
+              f.puts
+              f.puts("| Name | Type | Default | Description |")
+              f.puts("| :- | :- | :- | :- |")
+            end
+
+            param_tags.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]
+                  "`#{params[1]}`"
+                else
+                  "N/A"
+                end
+
+              f.puts("| `#{tag.name}` | `#{tag.types.join(', ')}` | #{default} | #{view_context.render(inline: tag.text)} |")
+            end
+          end
+        end
+      end
+    end
+
+    File.open("static/classes.yml", "w") do |f|
+      f.puts YAML.dump(classes_found_in_examples.sort.uniq)
+    end
+
+    File.open("static/arguments.yml", "w") do |f|
+      f.puts YAML.dump(args_for_components)
+    end
+
+    # Build system arguments docs from BaseComponent
+    documentation = registry.get(Primer::BaseComponent.name)
+    File.open("docs/content/system-arguments.md", "w") do |f|
+      f.puts("---")
+      f.puts("title: System arguments")
+      f.puts("---")
+      f.puts
+      f.puts("<!-- Warning: AUTO-GENERATED file, do not edit. Add code comments to your Ruby instead <3 -->")
+      f.puts
+      f.puts(documentation.base_docstring)
+      f.puts
+
+      initialize_method = documentation.meths.find(&:constructor?)
+
+      f.puts(view_context.render(inline: initialize_method.base_docstring))
+    end
+
+    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(', ')}"
+    end
+  end
+
+  task :preview do
+    registry = generate_yard_registry
+
+    components = Primer::Component.descendants
+
+    # Generate previews from documentation examples
+    components.each do |component|
+      documentation = registry.get(component.name)
+      short_name = component.name.gsub(/Primer|::/, "")
+      initialize_method = documentation.meths.find(&:constructor?)
+
+      next unless initialize_method.tags(:example).any?
+
+      yard_example_tags = initialize_method.tags(:example)
+
+      path = Pathname.new("demo/test/components/previews/primer/docs/#{short_name.underscore}_preview.rb")
+      path.dirname.mkdir unless path.dirname.exist?
+
+      File.open(path, "w") do |f|
+        f.puts("module Primer")
+        f.puts("  module Docs")
+        f.puts("    class #{short_name}Preview < ViewComponent::Preview")
+
+        yard_example_tags.each_with_index do |tag, index|
+          method_name = tag.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.dirname.mkdir unless path.dirname.exist?
+          File.open(path, "w") do |view_file|
+            view_file.puts(tag.text.to_s)
+          end
+        end
+
+        f.puts("    end")
+        f.puts("  end")
+        f.puts("end")
+      end
+    end
+  end
+
+  def generate_yard_registry
+    require File.expand_path("./../../demo/config/environment.rb", __dir__)
+    require "primer/view_components"
+    require "yard/docs_helper"
+    require "view_component/test_helpers"
+    include ViewComponent::TestHelpers
+    include Primer::ViewHelper
+    include YARD::DocsHelper
+
+    Dir["./app/components/primer/**/*.rb"].sort.each { |file| require file }
+
+    YARD::Rake::YardocTask.new
+
+    # Custom tags for yard
+    YARD::Tags::Library.define_tag("Accessibility", :accessibility)
+    YARD::Tags::Library.define_tag("Deprecation", :deprecation)
+
+    puts "Building YARD documentation."
+    Rake::Task["yard"].execute
+
+    registry = YARD::RegistryStore.new
+    registry.load!(".yardoc")
+    registry
+  end
+end