primer_view_components 0.1.8 → 0.1.9

data/static/previews.json

@@ -1411,6 +1411,11 @@
         "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page",
         "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page",
         "name": "middle_of_page"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page_with_relative_container",
+        "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page_with_relative_container",
+        "name": "middle_of_page_with_relative_container"
       }
     ]
   },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -826,6 +826,8 @@ files:
 - lib/primer/forms/hidden_field.rb
 - lib/primer/forms/multi.html.erb
 - lib/primer/forms/multi.rb
+- lib/primer/forms/primer_base_component_wrapper.html.erb
+- lib/primer/forms/primer_base_component_wrapper.rb
 - lib/primer/forms/primer_multi_input.d.ts
 - lib/primer/forms/primer_multi_input.js
 - lib/primer/forms/primer_multi_input.ts
@@ -926,13 +928,6 @@ files:
 - lib/rubocop/cop/primer/system_argument_instead_of_class.rb
 - lib/rubocop/cop/primer/test_selector.rb
 - lib/tasks/custom_utilities.yml
-- lib/tasks/docs.rake
-- lib/tasks/helpers/ast_processor.rb
-- lib/tasks/helpers/ast_traverser.rb
-- lib/tasks/primer_view_components.rake
-- lib/tasks/static.rake
-- lib/tasks/test.rake
-- lib/tasks/utilities.rake
 - previews/pages/forms/01_introduction.md.erb
 - previews/pages/forms/02_getting_started.md.erb
 - previews/pages/forms/03_caption_templates.md.erb
@@ -981,6 +976,7 @@ files:
 - previews/primer/alpha/nav_list_preview/trailing_action.html.erb
 - previews/primer/alpha/overlay_preview.rb
 - previews/primer/alpha/overlay_preview/middle_of_page.html.erb
+- previews/primer/alpha/overlay_preview/middle_of_page_with_relative_container.html.erb
 - previews/primer/alpha/radio_button_group_preview.rb
 - previews/primer/alpha/radio_button_preview.rb
 - previews/primer/alpha/segmented_control_preview.rb

data/lib/tasks/docs.rake

@@ -1,185 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/inflector"
-
-task :init_pvc do
-  ENV["RAILS_ENV"] = "test"
-  ENV["VC_COMPAT_PATCH_ENABLED"] = "true"
-
-  require File.expand_path("./../../demo/config/environment.rb", __dir__)
-  Dir[File.expand_path("../../app/components/primer/**/*.rb", __dir__)].sort.each { |file| require file }
-end
-
-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: [:build_gatsby_pages, :build_gatsby_adrs, :build_lookbook_pages]
-
-  task build_gatsby_pages: :build_yard_registry do
-    require "primer/yard"
-
-    registry = Primer::Yard::Registry.make
-
-    require "primer/yard/legacy_gatsby_backend"
-    require "primer/yard/component_manifest"
-
-    puts "Converting YARD documentation to Markdown files."
-
-    # Deletes docs before regenerating them, guaranteeing that we don't keep stale docs.
-    components_content_glob = File.join(*%w[docs content components ** *.md])
-    FileUtils.rm_rf(components_content_glob)
-
-    manifest = Primer::Yard::ComponentManifest.where(published: true)
-    backend = Primer::Yard::LegacyGatsbyBackend.new(registry, manifest)
-    errors = backend.generate
-
-    unless errors.empty?
-      puts "==============================================="
-      puts "===================== ERRORS =================="
-      puts "===============================================\n\n"
-      puts JSON.pretty_generate(errors)
-      puts "\n\n==============================================="
-      puts "==============================================="
-      puts "==============================================="
-
-      raise
-    end
-
-    puts "Markdown compiled."
-
-    all_components = Primer::Component.descendants - [Primer::BaseComponent]
-    components_needing_docs = all_components - Primer::Yard::ComponentManifest::COMPONENTS.keys
-
-    if components_needing_docs.any?
-      puts
-      puts "The following components need docs. Care to contribute them? #{components_needing_docs.map(&:name).join(', ')}"
-    end
-  end
-
-  task build_lookbook_pages: :build_yard_registry do
-    require "primer/yard"
-
-    registry = Primer::Yard::Registry.make
-    manifest = Primer::Yard::ComponentManifest.where(form_component: true)
-    backend = Primer::Yard::LookbookPagesBackend.new(registry, manifest)
-    backend.generate
-  end
-
-  task :build_gatsby_adrs do
-    adr_content_dir = File.join(*%w[docs content adr])
-
-    FileUtils.rm_rf(File.join(adr_content_dir))
-    FileUtils.mkdir(adr_content_dir)
-
-    nav_entries = Dir[File.join(*%w[docs adr *.md])].sort.map do |orig_path|
-      orig_file_name = File.basename(orig_path)
-      url_name = orig_file_name.chomp(".md")
-
-      file_contents = File.read(orig_path)
-      file_contents = <<~CONTENTS.sub(/\n+\z/, "\n")
-        <!-- Warning: AUTO-GENERATED file, do not edit. Make changes to the files in the adr/ directory instead. -->
-        #{file_contents}
-      CONTENTS
-
-      title_match = /^# (.+)/.match(file_contents)
-      title = title_match[1]
-
-      # Don't include initial ADR for recording ADRs
-      next nil if title == "Record architecture decisions"
-
-      File.write(File.join(adr_content_dir, orig_file_name), file_contents)
-      puts "Copied #{orig_path}"
-
-      { "title" => title, "url" => "/adr/#{url_name}" }
-    end
-
-    nav_yaml_file = File.join(*%w[docs src @primer gatsby-theme-doctocat nav.yml])
-    nav_yaml = YAML.load_file(nav_yaml_file)
-    adr_entry = {
-      "title" => "Architecture decisions",
-      "children" => nav_entries.compact
-    }
-
-    existing_index = nav_yaml.index { |entry| entry["title"] == "Architecture decisions" }
-    if existing_index
-      nav_yaml[existing_index] = adr_entry
-    else
-      nav_yaml << adr_entry
-    end
-
-    File.write(nav_yaml_file, YAML.dump(nav_yaml))
-  end
-
-  task preview: :build_yard_registry do
-    require "primer/yard"
-
-    FileUtils.rm_rf("previews/primer/docs/")
-
-    registry = Primer::Yard::Registry.make
-
-    # Generate previews from documentation examples
-    Primer::Yard::ComponentManifest.all.each do |component_ref|
-      component = component_ref.klass
-      docs = registry.find(component)
-      next unless docs.constructor&.tags(:example)&.any?
-
-      yard_example_tags = docs.constructor.tags(:example)
-
-      path = Pathname.new("previews/docs/#{docs.short_name.underscore}_preview.rb")
-      path.dirname.mkdir unless path.dirname.exist?
-
-      File.open(path, "w") do |f|
-        f.puts("module Docs")
-        f.puts("  class #{docs.short_name}Preview < ViewComponent::Preview")
-
-        yard_example_tags.each_with_index do |tag, index|
-          name, _, code = Primer::Yard::LegacyGatsbyBackend.parse_example_tag(tag)
-          method_name = name.split("|").first.downcase.parameterize.underscore
-          f.puts("    def #{method_name}; end")
-          f.puts unless index == yard_example_tags.size - 1
-          path = Pathname.new("previews/docs/#{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(code.to_s)
-          end
-        end
-
-        f.puts("  end")
-        f.puts("end")
-      end
-    end
-  end
-
-  task build_yard_registry: :init_pvc do
-    require "primer/yard"
-
-    ::YARD::Rake::YardocTask.new do |task|
-      task.options << "--no-output"
-    end
-
-    # 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)
-    ::YARD::Tags::Library.define_tag("Form Usage", :form_usage)
-
-    puts "Building YARD documentation."
-    Rake::Task["yard"].execute
-  end
-end

data/lib/tasks/helpers/ast_processor.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "ast_traverser"
-
-# :nodoc:
-class AstProcessor
-  class << self
-    def increment(stats, component, arg_name, value)
-      stats[component][:arguments][arg_name][value] = 0 unless stats[component][:arguments][arg_name][value]
-      stats[component][:arguments][arg_name][value] += 1
-    end
-
-    def process_ast(ast, stats)
-      traverser = AstTraverser.new
-      traverser.walk(ast)
-
-      return if traverser.stats.empty?
-
-      traverser.stats.each do |component, component_info|
-        stats[component] ||= {
-          paths: []
-        }
-
-        stats[component][:paths] << component_info[:path]
-        stats[component][:paths].uniq!
-        stats[component][:arguments] ||= {}
-
-        component_info[:arguments]&.each do |arg, value|
-          arg_name = arg.to_s
-          stats[component][:arguments][arg_name] ||= {}
-
-          # we want to count each class separately
-          if arg_name == "classes"
-            value.split.each do |val|
-              increment(stats, component, arg_name, val)
-            end
-          else
-            increment(stats, component, arg_name, value)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/tasks/helpers/ast_traverser.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require "primer/view_components/statuses"
-require_relative "../../../app/lib/primer/view_helper"
-
-# :nodoc:
-class AstTraverser
-  include RuboCop::AST::Traversal
-
-  attr_reader :stats
-
-  def initialize
-    @stats = {}
-  end
-
-  def on_send(node)
-    return super(node) unless component_node?(node)
-
-    name = component_name(node)
-    args = extract_arguments(node, name)
-
-    @stats[name] = { path: node.loc.expression.source_buffer.name }
-    @stats[name][:arguments] = args unless args.empty?
-
-    super(node) # recursively iterate over children
-  end
-
-  def view_helpers
-    @view_helpers ||= ::Primer::ViewHelper::HELPERS.keys.map { |key| "primer_#{key}".to_sym }
-  end
-
-  def component_node?(node)
-    view_helpers.include?(node.method_name) || (node.method_name == :new && !node.receiver.nil? && ::Primer::ViewComponents::STATUSES.key?(node.receiver.const_name))
-  end
-
-  def component_name(node)
-    return node.receiver.const_name if node.method_name == :new
-
-    helper_key = node.method_name.to_s.gsub("primer_", "").to_sym
-    Primer::ViewHelper::HELPERS[helper_key]
-  end
-
-  def extract_arguments(node, name)
-    args = node.arguments
-    res = {}
-
-    return res if args.empty?
-
-    kwargs = args.last
-    if kwargs.respond_to?(:pairs)
-      res = kwargs.pairs.each_with_object({}) do |pair, h|
-        h.merge!(extract_values(pair))
-      end
-    end
-
-    # Octicon is the only component that accepts positional arguments.
-    res[:icon] = args.first.source if name == "Primer::Beta::Octicon" && args.size > 1
-
-    res
-  end
-
-  def extract_values(pair)
-    return { pair.key.value => pair.value.source } unless pair.value.type == :hash
-
-    flatten_pairs(pair, prefix: "#{pair.key.value}-")
-  end
-
-  def flatten_pairs(pair, prefix: "")
-    pair.value.pairs.each_with_object({}) do |value_pair, h|
-      if value_pair.value.type == :hash
-        h.merge!(flatten_pairs(value_pair, prefix: "#{prefix}#{value_pair.key.value}-"))
-      else
-        h.merge!("#{prefix}#{value_pair.key.value}" => value_pair.value.source)
-      end
-    end
-  end
-end

data/lib/tasks/primer_view_components.rake

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-ERB_GLOB = "**/*.html{+*,}.erb"
-RB_GLOB = "**/*.rb"
-BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/.freeze # copied from Rails: action_view/template/handlers/erb/erubi.rb
-
-namespace :primer_view_components do
-  desc "Report arguments used in each component"
-  task :report, [:paths] do |_, args|
-    require "rubocop"
-    require "better_html"
-    require "better_html/parser"
-    require "erb_lint/processed_source"
-    require_relative "helpers/ast_processor"
-
-    paths = args[:paths].split
-    stats = {}
-
-    rb_files = paths.reduce([]) { |mem, path| mem + Dir[File.join(path, RB_GLOB)] }
-
-    rb_files.each do |f|
-      ast = RuboCop::AST::ProcessedSource.from_file(f, RUBY_VERSION.to_f).ast
-      AstProcessor.process_ast(ast, stats)
-    end
-
-    erb_files = paths.reduce([]) { |mem, path| mem + Dir[File.join(path, ERB_GLOB)] }
-
-    erb_files.each do |f|
-      erb_ast = ERBLint::ProcessedSource.new(f, File.read(f)).ast
-
-      erb_ast.descendants(:erb).each do |erb_node|
-        indicator, _, code_node, = *erb_node
-
-        next if indicator&.children&.first == "#" # don't analyze comments
-
-        trimmed_source = code_node.loc.source.sub(BLOCK_EXPR, "").strip
-        ast = RuboCop::AST::ProcessedSource.new(trimmed_source, RUBY_VERSION.to_f).ast
-        AstProcessor.process_ast(ast, stats)
-      end
-    end
-
-    File.open(".primer-view-components-report.json", "w") do |f|
-      f.write(JSON.pretty_generate(stats))
-      f.write($INPUT_RECORD_SEPARATOR)
-    end
-  end
-end

data/lib/tasks/static.rake

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-namespace :static do
-  task dump: [:dump_statuses, :dump_constants, :dump_audited_at, :dump_previews, :dump_arguments, :dump_info_arch]
-
-  task dump_statuses: :init_pvc do
-    Primer::Static.dump(:statuses)
-  end
-
-  task dump_constants: :init_pvc do
-    Primer::Static.dump(:constants)
-  end
-
-  task dump_audited_at: :init_pvc do
-    Primer::Static.dump(:audited_at)
-  end
-
-  task dump_previews: :init_pvc do
-    Primer::Static.dump(:previews)
-  end
-
-  task dump_arguments: ["docs:build_yard_registry", :init_pvc] do
-    Primer::Static.dump(:arguments)
-  end
-
-  task dump_info_arch: ["docs:build_yard_registry", :dump_previews, :dump_arguments] do
-    Primer::Static.dump(:info_arch)
-  end
-end

data/lib/tasks/test.rake

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require "rake/testtask"
-
-namespace :test do
-  desc "Run all tests"
-  task all: [
-    :components,
-    :lib,
-    :system,
-    :accessibility,
-    :performance
-  ]
-
-  Rake::TestTask.new(:single) do |t|
-    t.warning = false
-    t.libs << "test"
-    t.libs << "lib"
-    t.test_files = FileList[ENV["TEST"]]
-  end
-
-  Rake::TestTask.new(:components) do |t|
-    t.warning = false
-    t.libs << "test"
-    t.test_files = FileList[
-      "test/components/**/*_test.rb"
-    ]
-  end
-
-  Rake::TestTask.new(:component_css) do |t|
-    t.warning = false
-    t.libs << "test"
-    t.test_files = FileList[
-      "test/css/**/*_test.rb"
-    ]
-  end
-
-  Rake::TestTask.new(:lib) do |t|
-    t.warning = false
-    t.libs << "test"
-    t.libs << "lib"
-    t.test_files = FileList[
-      "test/lib/**/*_test.rb"
-    ]
-  end
-
-  Rake::TestTask.new(:system) do |t|
-    t.warning = false
-    t.libs << "test"
-    t.test_files = FileList["test/system/**/*_test.rb"]
-  end
-
-  Rake::TestTask.new(:performance) do |t|
-    t.warning = false
-    t.verbose = true
-    t.libs << "test"
-    t.test_files = FileList[
-      "test/performance/**/*_test.rb",
-      "test/performance/**/bench_*.rb"
-    ]
-  end
-
-  Rake::TestTask.new(:accessibility) do |t|
-    t.warning = false
-    t.libs << "test"
-    t.test_files = FileList["test/accessibility_test.rb"]
-  end
-
-  task :coverage do
-    require "simplecov"
-
-    SimpleCov.minimum_coverage 100
-    SimpleCov.collate Dir["coverage/.resultset.json"], "rails"
-  end
-end
-
-task :test do
-  if ENV["TEST"]
-    Rake::Task["test:single"].invoke
-  else
-    Rake::Task["test:all"].invoke
-  end
-end

data/lib/tasks/utilities.rake

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-namespace :utilities do
-  task :build do
-    require "yaml"
-    require "json"
-    ENV["RAILS_ENV"] = "test"
-    require File.expand_path("./../../demo/config/environment.rb", __dir__)
-    require "primer/classify/utilities"
-
-    # Keys that are looked for to be included in the utilities.yml file
-    # rubocop:disable Lint/ConstantDefinitionInBlock
-    SUPPORTED_KEYS = [
-      /^anim\b/,
-      /^color-bg\b/,
-      /^color-border\b/,
-      /^color-fg\b/,
-      /^col\b/,
-      /^container\b/,
-      /^clearfix\b/,
-      /^d\b/,
-      /^float\b/,
-      /^height\b/,
-      /^hide\b/,
-      /^m[trblxy]?\b/,
-      /^p[trblxy]?\b/,
-      /^position\b/,
-      /^wb\b/,
-      /^width\b/,
-      /^v\b/
-    ].freeze
-
-    BREAKPOINTS = [nil, "sm", "md", "lg", "xl"].freeze
-    # rubocop:enable Lint/ConstantDefinitionInBlock
-
-    utility_data = JSON.parse(File.read("app/lib/primer/css/utilities.css.json"))["selectors"]
-    layout_data = JSON.parse(File.read("app/lib/primer/css/layout.css.json"))["selectors"]
-    css_data = utility_data + layout_data
-
-    output = {}
-
-    css_data.each do |selector|
-      selector.sub!(/^./, "")
-      selector.sub!(/:[^\s]*$/, "")
-
-      # Next if selector has ancestors or sibling selectors
-      next if selector.match?(/[:><~\[.]/)
-      next unless SUPPORTED_KEYS.any? { |key| selector =~ key }
-
-      # Dupe so we still have the selector at the end of slicing it up
-      classname = selector.dup
-      key = ""
-
-      # Look for a replacement key
-      Primer::Classify::Utilities::REPLACEMENT_KEYS.each do |k, v|
-        next unless classname.match?(Regexp.new(k))
-
-        key = v
-        classname.sub!(Regexp.new("#{k}-"), "")
-      end
-
-      # If we didn't find a replacement, grab the first text before hyphen
-      if classname == selector
-        key = classname.split("-").first
-        classname.sub!(/^[^-]+-/, "")
-      end
-
-      # Check if the next bit of the classname is a breakpoint
-      if classname.match?(/^(sm-|md-|lg-|xl-)/)
-        breakpoint = classname.split("-").first
-        classname.sub!(/^[^-]+-/, "")
-      end
-
-      # Change the rest from hyphens to underscores
-      classname.sub!(/-/, "_")
-
-      # convert padding/margin negative values ie n7 to -7
-      classname.sub!(/^n/, "-") if classname.match?(/^n[0-9]/)
-
-      # If key and classname are equal, then classname is boolean
-      classname = true if key == classname
-
-      key = key.to_sym
-
-      if classname.is_a?(String)
-        classname = classname.match?(/\A[-+]?[0-9]+\z/) ? classname.to_i : classname.to_sym
-      end
-
-      if output[key].nil?
-        output[key] = { classname => Array.new(5, nil) }
-      elsif output[key][classname].nil?
-        output[key][classname] = Array.new(5, nil)
-      end
-
-      output[key][classname][BREAKPOINTS.index(breakpoint)] = selector
-    end
-
-    output.transform_values! do |x|
-      x.transform_values { |y| y.reverse.drop_while(&:nil?).reverse }
-    end
-
-    custom_utility_data = YAML.load_file("lib/tasks/custom_utilities.yml")
-    output.merge!(custom_utility_data)
-
-    File.open("lib/primer/classify/utilities.yml", "w") do |f|
-      f.puts YAML.dump(output)
-    end
-  end
-end