primer_view_components 0.0.112 → 0.0.114

data/lib/primer/deprecations.yml

@@ -0,0 +1,72 @@
+# PVC Component Deprecations
+# --------------------------
+#
+# All component deprecations for PVC must be listed here, and must have valid configurations.
+# See 'docs/contributors/deprecations.md' for information on configuration options.
+
+deprecations:
+  - component: "Primer::Alpha::AutoComplete"
+    autocorrect: true
+    replacement: "Primer::Beta::AutoComplete"
+
+  - component: "Primer::Alpha::AutoComplete::Item"
+    autocorrect: true
+    replacement: "Primer::Beta::AutoComplete::Item"
+
+  - component: "Primer::BlankslateComponent"
+    autocorrect: true
+    replacement: "Primer::Beta::Blankslate"
+
+  - component: "Primer::BoxComponent"
+    autocorrect: true
+    replacement: "Primer::Box"
+
+  - component: "Primer::ButtonComponent"
+    autocorrect: false
+    replacement: "Primer::Beta::Button"
+    guide: "https://primer.style/view-components/guides/primer_button_component"
+
+  - component: "Primer::ClipboardCopy"
+    autocorrect: true
+    replacement: "Primer::Beta::ClipboardCopy"
+
+  - component: "Primer::DropdownMenuComponent"
+    autocorrect: false
+    replacement: "Primer::Beta::Dropdown"
+    guide: "https://primer.style/view-components/guides/primer_dropdown_menu_component"
+
+  - component: "Primer::Dropdown"
+    autocorrect: true
+    replacement: "Primer::Alpha::Dropdown"
+
+  - component: "Primer::Dropdown::Menu"
+    autocorrect: true
+    replacement: "Primer::Alpha::Dropdown::Menu"
+
+  - component: "Primer::Dropdown::Menu::Item"
+    autocorrect: true
+    replacement: "Primer::Alpha::Dropdown::Menu::Item"
+
+  - component: "Primer::IconButton"
+    autocorrect: true
+    replacement: "Primer::Beta::IconButton"
+
+  - component: "Primer::LabelComponent"
+    autocorrect: true
+    replacement: "Primer::Beta::Label"
+
+  - component: "Primer::LinkComponent"
+    autocorrect: true
+    replacement: "Primer::Beta::Link"
+
+  - component: "Primer::Markdown"
+    autocorrect: true
+    replacement: "Primer::Beta::Markdown"
+
+  - component: "Primer::PopoverComponent"
+    autocorrect: true
+    replacement: "Primer::Beta::Popover"
+
+  - component: "Primer::Tooltip"
+    autocorrect: true
+    replacement: "Primer::Alpha::Tooltip"

data/lib/primer/forms/base.rb

@@ -29,7 +29,7 @@ module Primer
         end
 
         def inherited(base)
-          form_path = const_source_location(base.name)
+          form_path = Utils.const_source_location(base.name)
           return unless form_path
 
           base.template_root_path = File.join(File.dirname(form_path), base.name.demodulize.underscore)
@@ -54,25 +54,6 @@ module Primer
         def sanitize_field_name_for_template_path(field_name)
           field_name.to_s.delete_suffix("?").to_sym
         end
-
-        private
-
-        # Unfortunately this bug (https://github.com/ruby/ruby/pull/5646) prevents us from using
-        # Ruby's native Module.const_source_location. Instead we have to fudge it by searching
-        # for the file in the configured autoload paths. Doing so relies on Rails' autoloading
-        # conventions, so it should work ok. Zeitwerk also has this information but lacks a
-        # public API to map constants to source files.
-        def const_source_location(class_name)
-          # NOTE: underscore respects namespacing, i.e. will convert Foo::Bar to foo/bar.
-          class_path = "#{class_name.underscore}.rb"
-
-          ActiveSupport::Dependencies.autoload_paths.each do |autoload_path|
-            absolute_path = File.join(autoload_path, class_path)
-            return absolute_path if File.exist?(absolute_path)
-          end
-
-          nil
-        end
       end
 
       def inputs
@@ -124,12 +105,18 @@ module Primer
       end
 
       def perform_render(&_block)
+        return "" unless render?
+
         Base.compile!
         self.class.compile!
 
         render_base_form
       end
 
+      def render?
+        true
+      end
+
       private
 
       def form_object

data/lib/primer/forms/base_component.rb

@@ -10,12 +10,22 @@ module Primer
       extend ActsAsComponent
 
       def self.inherited(base)
-        base.renders_template File.join(__dir__, "#{base.name.demodulize.underscore}.html.erb"), :render_template
+        base_path = Utils.const_source_location(base.name)
+
+        unless base_path
+          warn "Could not identify the template for #{base}"
+          return
+        end
+
+        dir = File.dirname(base_path)
+        base.renders_template File.join(dir, "#{base.name.demodulize.underscore}.html.erb"), :render_template
       end
 
       delegate :required?, :disabled?, :hidden?, to: :@input
 
       def perform_render(&block)
+        return "" unless render?
+
         @__prf_content_block = block
         compile_and_render_template
       end
@@ -43,6 +53,10 @@ module Primer
         self
       end
 
+      def render?
+        true
+      end
+
       private
 
       def compile_and_render_template

data/lib/primer/forms/button.html.erb

@@ -0,0 +1,4 @@
+<%= render(Primer::Beta::Button.new(**input_arguments)) do |c| %>
+  <% @input.block.call(c) if @input.block %>
+  <%= @input.label %>
+<% end %>

data/lib/primer/forms/button.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Primer
+  module Forms
+    # :nodoc:
+    class Button < BaseComponent
+      # :nodoc:
+      module ButtonAttributeGenerator
+        extend ActionView::Helpers::FormTagHelper
+
+        class << self
+          alias submit_tag_attributes submit_tag
+          alias button_tag_attributes button_tag
+
+          private
+
+          # FormTagHelper#submit_tag ultimately calls the #tag method. We return the options hash here instead
+          # of returning a string so it can be merged into the hash of options we pass to the Primer::ButtonComponent.
+          def tag(_name, options)
+            options
+          end
+
+          # FormTagHelper#button_tag ultimately calls the #content_tag method. We return the options hash here instead
+          # of returning a string so it can be merged into the hash of options we pass to the Primer::ButtonComponent.
+          def content_tag(_name, _content, options)
+            options
+          end
+        end
+      end
+
+      delegate :builder, :form, to: :@input
+
+      def initialize(input:, type: :button)
+        @input = input
+        @type = type
+
+        @input.add_input_classes("FormField-input flex-self-start")
+        @input.merge_input_arguments!(tag_attributes.deep_symbolize_keys)
+
+        # rails uses a string for this, but PVC wants a symbol
+        @input.merge_input_arguments!(type: type.to_sym)
+
+        # Never disable buttons. This overrides the global
+        # ActionView::Base.automatically_disable_submit_tag setting.
+        # Disabling buttons is not accessible.
+        @input.remove_input_data(:disable_with)
+      end
+
+      def input_arguments
+        @input_arguments ||= @input.input_arguments.deep_dup.tap do |args|
+          # rails uses :class but PVC wants :classes
+          args[:classes] = args.delete(:class)
+        end
+      end
+
+      private
+
+      def tag_attributes
+        case @type
+        when :submit
+          ButtonAttributeGenerator.submit_tag_attributes(@input.label, name: @input.name)
+        else
+          ButtonAttributeGenerator.button_tag_attributes(@input.label, name: @input.name)
+        end
+      end
+    end
+  end
+end

data/lib/primer/forms/check_box.html.erb

@@ -1,4 +1,4 @@
-<div class="FormControl-checkbox-wrap">
+<%= content_tag(:div, class: "FormControl-checkbox-wrap", hidden: @input.hidden?) do %>
   <%= builder.check_box(@input.name, @input.input_arguments, checked_value, unchecked_value) %>
   <span class="FormControl-checkbox-labelWrap">
     <%= builder.label(@input.name, **@input.label_arguments) do %>
@@ -6,7 +6,7 @@
     <% end %>
     <%= render(Caption.new(input: @input)) %>
   </span>
-</div>
+<% end %>
 <% if @input.nested_form_block %>
   <%= content_tag(:div, nested_form_arguments) do %>
     <%= render(@input.nested_form_block.call(builder)) %>

data/lib/primer/forms/check_box.rb

@@ -20,7 +20,7 @@ module Primer
       def nested_form_arguments
         return @nested_form_arguments if defined?(@nested_form_arguments)
 
-        @nested_form_arguments = { **@input.nested_form_arguments }
+        @nested_form_arguments = { hidden: @input.hidden?, **@input.nested_form_arguments }
         @nested_form_arguments[:class] = class_names(
           @nested_form_arguments[:class],
           @nested_form_arguments.delete(:classes),

data/lib/primer/forms/check_box_group.html.erb

@@ -1,4 +1,4 @@
-<fieldset>
+<%= content_tag(:fieldset, hidden: @input.hidden?) do %>
   <% if @input.label %>
     <%= content_tag(:legend, **@input.label_arguments) do %>
       <%= @input.label %>
@@ -9,4 +9,4 @@
       <%= render(check_box.to_component) %>
     <% end %>
   <% end %>
-</fieldset>
+<% end %>

data/lib/primer/forms/dsl/button_input.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Primer
+  module Forms
+    module Dsl
+      # :nodoc:
+      class ButtonInput < Input
+        attr_reader :name, :label, :block
+
+        def initialize(name:, label:, **system_arguments, &block)
+          @name = name
+          @label = label
+          @block = block
+
+          super(**system_arguments)
+        end
+
+        def to_component
+          Button.new(input: self)
+        end
+
+        # :nocov:
+        def type
+          :button
+        end
+      end
+    end
+  end
+end

data/lib/primer/forms/dsl/input_methods.rb

@@ -17,8 +17,8 @@ module Primer
           add_input HiddenInput.new(builder: builder, form: form, **options)
         end
 
-        def check_box(**options)
-          add_input CheckBoxInput.new(builder: builder, form: form, **options)
+        def check_box(**options, &block)
+          add_input CheckBoxInput.new(builder: builder, form: form, **options, &block)
         end
 
         def radio_button_group(**options, &block)
@@ -63,6 +63,11 @@ module Primer
           add_input SubmitButtonInput.new(builder: builder, form: form, **options, &block)
         end
 
+        def button(**options, &block)
+          options = decorate_options(**options)
+          add_input ButtonInput.new(builder: builder, form: form, **options, &block)
+        end
+
         # END button input methods
 
         def inputs

data/lib/primer/forms/dsl/submit_button_input.rb

@@ -19,6 +19,7 @@ module Primer
           SubmitButton.new(input: self)
         end
 
+        # :nocov:
         def type
           :submit_button
         end

data/lib/primer/forms/dsl/text_field_input.rb

@@ -31,13 +31,6 @@ module Primer
 
           add_input_classes("FormControl-inset") if inset?
           add_input_classes("FormControl-monospace") if monospace?
-
-          @field_wrap_classes = class_names(
-            "FormControl-input-wrap",
-            Primer::Forms::Dsl::Input::SIZE_MAPPINGS[size],
-            "FormControl-input-wrap--trailingAction": show_clear_button?,
-            "FormControl-input-wrap--leadingVisual": leading_visual?
-          )
         end
 
         alias show_clear_button? show_clear_button

data/lib/primer/forms/radio_button.html.erb

@@ -1,4 +1,4 @@
-<div class="FormControl-radio-wrap">
+<%= content_tag(:div, class: "FormControl-radio-wrap", hidden: @input.hidden?) do %>
   <%= builder.radio_button(@input.name, @input.value, **@input.input_arguments) %>
   <span class="FormControl-radio-labelWrap">
     <%= builder.label(@input.name, value: @input.value, **@input.label_arguments) do %>
@@ -6,7 +6,7 @@
     <% end %>
     <%= render(Caption.new(input: @input)) %>
   </span>
-</div>
+<% end %>
 <% if @input.nested_form_block %>
   <%= content_tag(:div, nested_form_arguments) do %>
     <%= render(@input.nested_form_block.call(builder)) %>

data/lib/primer/forms/radio_button.rb

@@ -15,7 +15,7 @@ module Primer
       def nested_form_arguments
         return @nested_form_arguments if defined?(@nested_form_arguments)
 
-        @nested_form_arguments = { **@input.nested_form_arguments }
+        @nested_form_arguments = { hidden: @input.hidden?, **@input.nested_form_arguments }
         @nested_form_arguments[:class] = class_names(
           @nested_form_arguments[:class],
           @nested_form_arguments.delete(:classes),

data/lib/primer/forms/radio_button_group.html.erb

@@ -1,4 +1,4 @@
-<fieldset>
+<%= content_tag(:fieldset, hidden: @input.hidden?) do %>
   <% if @input.label %>
     <%= content_tag(:legend, **@input.label_arguments) do %>
       <%= @input.label %>
@@ -9,4 +9,4 @@
       <%= render(radio_button.to_component) %>
     <% end %>
   <% end %>
-</fieldset>
+<% end %>

data/lib/primer/forms/select_list.html.erb

@@ -1,5 +1,5 @@
 <%= render(FormControl.new(input: @input)) do %>
-  <%= content_tag(:div, class: @field_wrap_classes) do %>
+  <%= content_tag(:div, **@field_wrap_arguments) do %>
     <%= builder.select(@input.name, options, @input.select_arguments, **@input.input_arguments) %>
   <% end %>
 <% end %>

data/lib/primer/forms/select_list.rb

@@ -13,7 +13,10 @@ module Primer
           "FormControl--medium"
         )
 
-        @field_wrap_classes = class_names("FormControl-select-wrap")
+        @field_wrap_arguments = {
+          class: "FormControl-select-wrap",
+          hidden: @input.hidden?
+        }
       end
 
       def options

data/lib/primer/forms/submit_button.html.erb

@@ -1,4 +1 @@
-<%= render(Primer::ButtonComponent.new(**input_arguments)) do |c| %>
-  <% @input.block.call(c) if @input.block %>
-  <%= @input.label %>
-<% end %>
+<%= render(@button) %>

data/lib/primer/forms/submit_button.rb

@@ -4,46 +4,10 @@ module Primer
   module Forms
     # :nodoc:
     class SubmitButton < BaseComponent
-      # :nodoc:
-      module SubmitAttributeGenerator
-        extend ActionView::Helpers::FormTagHelper
-
-        class << self
-          alias submit_tag_attributes submit_tag
-
-          private
-
-          # FormTagHelper#submit_tag ultimately calls the #tag method. We return the options hash here instead
-          # of returning a string so it can be merged into the hash of options we pass to the Primer::ButtonComponent.
-          def tag(_name, options)
-            options
-          end
-        end
-      end
-
       delegate :builder, :form, to: :@input
 
       def initialize(input:)
-        @input = input
-        @input.add_input_classes("FormField-input flex-self-start")
-        @input.merge_input_arguments!(
-          SubmitAttributeGenerator.submit_tag_attributes(input.label, name: input.name).deep_symbolize_keys
-        )
-
-        # rails uses a string for this, but PVC wants a symbol
-        @input.merge_input_arguments!(type: :submit)
-
-        # Never disable submit buttons. This overrides the global
-        # ActionView::Base.automatically_disable_submit_tag setting.
-        # Disabling the submit button is not accessible.
-        @input.remove_input_data(:disable_with)
-      end
-
-      def input_arguments
-        @input_arguments ||= @input.input_arguments.deep_dup.tap do |args|
-          # rails uses :class but PVC wants :classes
-          args[:classes] = args.delete(:class)
-        end
+        @button = Button.new(input: input, type: :submit)
       end
     end
   end

data/lib/primer/forms/text_area.html.erb

@@ -1,5 +1,5 @@
 <%= render(FormControl.new(input: @input)) do %>
-  <%= content_tag(:div, class: @field_wrap_classes) do %>
+  <%= content_tag(:div, **@field_wrap_arguments) do %>
     <%= builder.text_area(@input.name, **@input.input_arguments) %>
   <% end %>
 <% end %>

data/lib/primer/forms/text_area.rb

@@ -9,7 +9,11 @@ module Primer
       def initialize(input:)
         @input = input
         @input.add_input_classes("FormControl-input", "FormControl--medium")
-        @field_wrap_classes = class_names("FormControl-input-wrap")
+
+        @field_wrap_arguments = {
+          class: class_names("FormControl-input-wrap"),
+          hidden: @input.hidden?
+        }
       end
     end
   end

data/lib/primer/forms/text_field.html.erb

@@ -1,6 +1,6 @@
 <%= render(FormControl.new(input: @input)) do %>
   <% if @input.leading_visual || @input.show_clear_button? %>
-    <%= content_tag(:div, class: @input.field_wrap_classes) do %>
+    <%= content_tag(:div, **@field_wrap_arguments) do %>
       <% if @input.leading_visual %>
         <span class="FormControl-input-leadingVisualWrap">
           <%= render(Primer::OcticonComponent.new(**@input.leading_visual)) %>

data/lib/primer/forms/text_field.rb

@@ -8,6 +8,17 @@ module Primer
 
       def initialize(input:)
         @input = input
+
+        @field_wrap_arguments = {
+          class: class_names(
+            "FormControl-input-wrap",
+            Primer::Forms::Dsl::Input::SIZE_MAPPINGS[@input.size],
+            "FormControl-input-wrap--trailingAction": @input.show_clear_button?,
+            "FormControl-input-wrap--leadingVisual": @input.leading_visual?
+          ),
+
+          hidden: @input.hidden?
+        }
       end
     end
   end

data/lib/primer/forms/utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Primer
+  # :nodoc:
+  module Forms
+    # :nodoc:
+    module Utils
+      # Unfortunately this bug (https://github.com/ruby/ruby/pull/5646) prevents us from using
+      # Ruby's native Module.const_source_location. Instead we have to fudge it by searching
+      # for the file in the configured autoload paths. Doing so relies on Rails' autoloading
+      # conventions, so it should work ok. Zeitwerk also has this information but lacks a
+      # public API to map constants to source files.
+      def const_source_location(class_name)
+        # NOTE: underscore respects namespacing, i.e. will convert Foo::Bar to foo/bar.
+        class_path = "#{class_name.underscore}.rb"
+
+        ActiveSupport::Dependencies.autoload_paths.each do |autoload_path|
+          absolute_path = File.join(autoload_path, class_path)
+          return absolute_path if File.exist?(absolute_path)
+        end
+
+        nil
+      end
+    end
+
+    Utils.extend(Utils)
+  end
+end

data/lib/primer/view_components/audited.rb

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

data/lib/primer/view_components/engine.rb

@@ -57,6 +57,7 @@ module Primer
           autoloader.ignore(Engine.root.join("lib", "primer", "view_components", "linters.rb"))
           autoloader.ignore(Engine.root.join("lib", "primer", "view_components", "linters", "**", "*.rb"))
           autoloader.ignore(Engine.root.join("lib", "primer", "view_components", "statuses.rb"))
+          autoloader.ignore(Engine.root.join("lib", "primer", "view_components", "audited.rb"))
         end
       end
 

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

@@ -12,9 +12,9 @@ module ERBLint
 
       TAGS = %w[clipboard-copy].freeze
       REQUIRED_ARGUMENTS = [/for|value/, "aria-label"].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."
+      MESSAGE = "We are migrating clipboard-copy to use [Primer::Beta::ClipboardCopy](https://primer.style/view-components/components/clipboardcopy), please try to use that instead of raw HTML."
       ARGUMENT_MAPPER = ArgumentMappers::ClipboardCopy
-      COMPONENT = "Primer::ClipboardCopy"
+      COMPONENT = "Primer::Beta::ClipboardCopy"
     end
   end
 end

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

@@ -7,27 +7,12 @@ module ERBLint
     module Helpers
       # Helpers to share between DeprecatedComponents ERB lint and Rubocop cop
       module DeprecatedComponentsHelpers
-        def message(component)
-          message = "#{component} has been deprecated and should not be used."
-
-          if Primer::Deprecations.correctable?(component)
-            suggested_component = Primer::Deprecations.suggested_component(component)
-            message += " Try #{suggested_component} instead."
-          end
-
-          message
-        end
-
-        def statuses_json
-          JSON.parse(
-            File.read(
-              File.join(File.dirname(__FILE__), "../../../../../static/statuses.json")
-            )
-          ).freeze
+        def message(component_name)
+          Primer::Deprecations.deprecation_message(component_name)
         end
 
         def deprecated_components
-          @deprecated_components ||= statuses_json.select { |_, value| value == "deprecated" }.keys
+          Primer::Deprecations.deprecated_components
         end
       end
     end

data/lib/primer/view_components/version.rb

@@ -6,7 +6,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 0
-      PATCH = 112
+      PATCH = 114
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

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

@@ -26,8 +26,8 @@ module RuboCop
             component_name = node.const_name
             return unless ::Primer::Deprecations.correctable?(component_name)
 
-            suggested_component = ::Primer::Deprecations.suggested_component(component_name)
-            corrector.replace(node, suggested_component) if suggested_component.present?
+            replacement = ::Primer::Deprecations.replacement(component_name)
+            corrector.replace(node, replacement) if replacement.present?
           end
         end
       end