primer_view_components 0.0.112 → 0.0.113

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 = 113
 
       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

data/lib/tasks/docs.rake

@@ -29,6 +29,7 @@ namespace :docs do
     # Rails controller for rendering arbitrary ERB
     view_context = ApplicationController.new.tap { |c| c.request = ActionDispatch::TestRequest.create }.view_context
     components = [
+      Primer::Beta::RelativeTime,
       Primer::Beta::IconButton,
       Primer::Beta::Button,
       Primer::Alpha::SegmentedControl,
@@ -53,7 +54,7 @@ namespace :docs do
       Primer::ButtonComponent,
       Primer::Beta::ButtonGroup,
       Primer::Alpha::ButtonMarketing,
-      Primer::ClipboardCopy,
+      Primer::Beta::ClipboardCopy,
       Primer::Beta::CloseButton,
       Primer::Beta::Counter,
       Primer::Beta::Details,
@@ -104,7 +105,7 @@ namespace :docs do
       Primer::Alpha::ImageCrop,
       Primer::Beta::AutoComplete,
       Primer::Alpha::Banner,
-      Primer::ClipboardCopy,
+      Primer::Beta::ClipboardCopy,
       Primer::TabContainerComponent,
       Primer::TimeAgoComponent,
       Primer::Alpha::UnderlinePanels,

data/previews/primer/alpha/auto_complete_preview.rb

@@ -11,7 +11,9 @@ module Primer
       # @param with_icon toggle
       # @param is_clearable toggle
       def playground(label_text: "Select a fruit", is_label_visible: true, is_label_inline: false, with_icon: false, is_clearable: false)
+        # rubocop:disable Primer/ComponentNameMigration
         render(Primer::Alpha::AutoComplete.new(label_text: label_text, input_id: "input-id", list_id: "test-id", src: "/auto_complete?version=alpha", is_label_visible: is_label_visible, is_label_inline: is_label_inline, with_icon: with_icon, is_clearable: is_clearable))
+        # rubocop:enable Primer/ComponentNameMigration
       end
 
       # @label Default Options
@@ -21,29 +23,39 @@ module Primer
       # @param with_icon toggle
       # @param is_clearable toggle
       def default(label_text: "Select a fruit", is_label_visible: true, is_label_inline: false, with_icon: false, is_clearable: false)
+        # rubocop:disable Primer/ComponentNameMigration
         render(Primer::Alpha::AutoComplete.new(label_text: label_text, input_id: "input-id", list_id: "test-id", src: "/auto_complete?version=alpha", is_label_visible: is_label_visible, is_label_inline: is_label_inline, with_icon: with_icon, is_clearable: is_clearable))
+        # rubocop:enable Primer/ComponentNameMigration
       end
 
       # @!group More examples
 
       # @label AutoComplete with non-visible label
       def with_non_visible_label
+        # rubocop:disable Primer/ComponentNameMigration
         render(Primer::Alpha::AutoComplete.new(label_text: "Select a fruit", input_id: "input-id-1", list_id: "test-id-1", src: "/auto_complete?version=alpha", is_label_visible: false))
+        # rubocop:enable Primer/ComponentNameMigration
       end
 
       # @label AutoComplete with inline label
       def with_inline_label
+        # rubocop:disable Primer/ComponentNameMigration
         render(Primer::Alpha::AutoComplete.new(label_text: "Select a fruit", input_id: "input-id-2", list_id: "test-id-2", src: "/auto_complete?version=alpha", is_label_inline: true))
+        # rubocop:enable Primer/ComponentNameMigration
       end
 
       # @label AutoComplete with search icon
       def with_icon
+        # rubocop:disable Primer/ComponentNameMigration
         render(Primer::Alpha::AutoComplete.new(label_text: "Select a fruit", input_id: "input-id-3", list_id: "test-id-3", src: "/auto_complete?version=alpha", with_icon: true))
+        # rubocop:enable Primer/ComponentNameMigration
       end
 
       # @label AutoComplete with clear button
       def with_clear_button
+        # rubocop:disable Primer/ComponentNameMigration
         render(Primer::Alpha::AutoComplete.new(label_text: "Select a fruit", input_id: "input-id-4", list_id: "test-id-4", src: "/auto_complete?version=alpha", is_clearable: true))
+        # rubocop:enable Primer/ComponentNameMigration
       end
 
       # @!endgroup

data/previews/primer/alpha/segmented_control_preview.rb

@@ -34,8 +34,9 @@ module Primer
 
       # @!group Full width
       # @label Size small
-      def full_width_small(hide_labels: false, size: :small)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, size: :small)) do |c|
+      # @param hide_labels [Boolean] toggle
+      def full_width_small(hide_labels: false)
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: hide_labels, full_width: true, size: :small)) do |c|
           c.with_item(label: "Preview", selected: true)
           c.with_item(label: "Raw")
           c.with_item(label: "Blame")
@@ -43,8 +44,9 @@ module Primer
       end
 
       # @label Size medium
-      def full_width_medium(hide_labels: false, size: :medium)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, size: :medium)) do |c|
+      # @param hide_labels [Boolean] toggle
+      def full_width_medium(hide_labels: false)
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: hide_labels, full_width: true, size: :medium)) do |c|
           c.with_item(label: "Preview", selected: true)
           c.with_item(label: "Raw")
           c.with_item(label: "Blame")
@@ -52,8 +54,9 @@ module Primer
       end
 
       # @label Size large
-      def full_width_large(hide_labels: false, size: :large)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, size: :large)) do |c|
+      # @param hide_labels [Boolean] toggle
+      def full_width_large(hide_labels: false)
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: hide_labels, full_width: true, size: :large)) do |c|
           c.with_item(label: "Preview", selected: true)
           c.with_item(label: "Raw")
           c.with_item(label: "Blame")

data/previews/primer/alpha/text_field_preview.rb

@@ -63,62 +63,87 @@ module Primer
       end
 
       # @label Default
+      def default
+        render(Primer::Alpha::TextField.new(name: "my-text-field", label: "My text field"))
+      end
+
+      # @!group Sizes
       #
-      # @param name text
-      # @param id text
-      # @param label text
-      # @param visually_hide_label toggle
-      # @param size [Symbol] select [small, medium, large]
-      # @param show_clear_button toggle
-      # @param clear_button_id text
-      # @param full_width toggle
-      # @param disabled toggle
-      # @param invalid toggle
-      # @param placeholder text
-      # @param inset toggle
-      # @param monospace toggle
-      # @param leading_visual_icon text
-      def default(
-        name: "my-text-field",
-        id: "my-text-field",
-        label: "My text field",
-        visually_hide_label: false,
-        size: Primer::Forms::Dsl::Input::DEFAULT_SIZE.to_s,
-        show_clear_button: false,
-        clear_button_id: "my-text-field-clear-button",
-        full_width: false,
-        disabled: false,
-        invalid: false,
-        placeholder: nil,
-        inset: false,
-        monospace: false,
-        leading_visual_icon: nil
-      )
-        system_arguments = {
-          name: name,
-          id: id,
-          label: label,
-          visually_hide_label: visually_hide_label,
-          size: size,
-          show_clear_button: show_clear_button,
-          clear_button_id: clear_button_id,
-          full_width: full_width,
-          disabled: disabled,
-          invalid: invalid,
-          placeholder: placeholder,
-          inset: inset,
-          monospace: monospace
-        }
+      # @label Small
+      def size_small
+        render(Primer::Alpha::TextField.new(size: :small, visually_hide_label: true, name: "my-text-field", label: "My text field"))
+      end
 
-        if leading_visual_icon
-          system_arguments[:leading_visual] = {
-            icon: leading_visual_icon,
-            size: :small
-          }
-        end
+      # @label Medium
+      def size_medium
+        render(Primer::Alpha::TextField.new(size: :medium, visually_hide_label: true, name: "my-text-field", label: "My text field"))
+      end
 
-        render(Primer::Alpha::TextField.new(**system_arguments))
+      # @label Large
+      def size_large
+        render(Primer::Alpha::TextField.new(size: :large, visually_hide_label: true, name: "my-text-field", label: "My text field"))
+      end
+      #
+      # @!endgroup
+
+      # @!group Options
+      #
+      # @label With caption
+      def with_caption
+        render(Primer::Alpha::TextField.new(caption: "With a caption", name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Visually hidden label
+      def visually_hide_label
+        render(Primer::Alpha::TextField.new(visually_hide_label: true, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Show clear button
+      def show_clear_button
+        render(Primer::Alpha::TextField.new(show_clear_button: true, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Full width
+      def full_width
+        render(Primer::Alpha::TextField.new(full_width: true, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Disabled
+      def disabled
+        render(Primer::Alpha::TextField.new(disabled: true, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Invalid
+      def invalid
+        render(Primer::Alpha::TextField.new(invalid: true, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label With placeholder
+      def with_placeholder
+        render(Primer::Alpha::TextField.new(placeholder: "with a placeholder", name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Inset
+      def inset
+        render(Primer::Alpha::TextField.new(inset: true, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label Monospace
+      def monospace
+        render(Primer::Alpha::TextField.new(monospace: true, name: "my-text-field", label: "My text field"))
       end
+
+      # @label With leading visual
+      def with_leading_visual
+        render(Primer::Alpha::TextField.new(leading_visual: { icon: :search }, name: "my-text-field", label: "My text field"))
+      end
+
+      # @label With validation message
+      def with_validation_message
+        render(Primer::Alpha::TextField.new(validation_message: "An error occurred!", name: "my-text-field", label: "My text field"))
+      end
+      #
+      # @!endgroup
     end
   end
 end

data/previews/primer/beta/clipboard_copy_preview/element.html.erb

@@ -0,0 +1,2 @@
+<%= render(Primer::Beta::ClipboardCopy.new(for: "blob-path", "aria-label": aria_label)) %>
+<div id="blob-path">src/index.js</div>

data/previews/primer/beta/clipboard_copy_preview.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Primer
+  module Beta
+    # @label ClipboardCopy
+    class ClipboardCopyPreview < ViewComponent::Preview
+      # @label Playground
+      #
+      # @param aria_label [String]
+      # @param value [String]
+      def playground(value: "Text to copy", aria_label: "Copy text to the system clipboard")
+        render(Primer::Beta::ClipboardCopy.new(value: value, "aria-label": aria_label))
+      end
+
+      # @label Default Options
+      #
+      # @param aria_label [String]
+      # @param value [String]
+      def default(value: "Text to copy", aria_label: "Copy text to the system clipboard")
+        render(Primer::Beta::ClipboardCopy.new(value: value, "aria-label": aria_label))
+      end
+
+      # @label With text instead of icons
+      #
+      # @param aria_label [String]
+      # @param value [String]
+      def text(value: "Text to copy", aria_label: "Copy text to the system clipboard")
+        render(Primer::Beta::ClipboardCopy.new(value: value, "aria-label": aria_label)) { "Click to copy!" }
+      end
+
+      # @label Copying from an element
+      #
+      # @param aria_label [String]
+      def element(aria_label: "Copy text to the system clipboard")
+        render_with_template(locals: { aria_label: aria_label })
+      end
+    end
+  end
+end