primer_view_components 0.0.112 → 0.0.114

data/app/components/primer/clipboard_copy.rb

@@ -1,48 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use `ClipboardCopy` to copy element text content or input values to the clipboard.
-  #
-  # @accessibility
-  #   Always set an accessible label to help the user interact with the component.
-  class ClipboardCopy < Primer::Component
-    status :beta
-
-    # @example Default
-    #   <%= render(Primer::ClipboardCopy.new(value: "Text to copy", "aria-label": "Copy text to the system clipboard")) %>
-    #
-    # @example With text instead of icons
-    #   <%= render(Primer::ClipboardCopy.new(value: "Text to copy")) do %>
-    #     Click to copy!
-    #   <% end %>
-    #
-    # @example Copying from an element
-    #   <%= render(Primer::ClipboardCopy.new(for: "blob-path", "aria-label": "Copy text to the system clipboard")) %>
-    #   <div id="blob-path">src/index.js</div>
-    #
-    # @param aria-label [String] String that will be read to screenreaders when the component is focused
-    # @param value [String] Text to copy into the users clipboard when they click the component.
-    # @param for [String] Element id from where to get the copied value.
-    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    def initialize(value: nil, **system_arguments)
-      @system_arguments = deny_tag_argument(**system_arguments)
-      @value = value
-
-      validate!
-
-      @system_arguments[:tag] = "clipboard-copy"
-      @system_arguments[:value] = value if value.present?
-    end
-
-    # :nodoc:
-    def before_render
-      validate_aria_label if content.blank?
-    end
-
-    private
-
-    def validate!
-      raise ArgumentError, "Must provide either `value` or `for`" if @value.nil? && @system_arguments[:for].nil?
-    end
+  class ClipboardCopy < Primer::Beta::ClipboardCopy
+    status :deprecated
   end
 end

data/app/components/primer/component.rb

@@ -18,6 +18,10 @@ module Primer
 
     INVALID_ARIA_LABEL_TAGS = [:div, :span, :p].freeze
 
+    def self.deprecated?
+      status == :deprecated
+    end
+
     private
 
     def raise_on_invalid_options?

data/app/components/primer/local_time.d.ts

@@ -1 +1 @@
-import '@github/time-elements';
+import '@github/relative-time-element';

data/app/components/primer/local_time.js

@@ -1 +1 @@
-import '@github/time-elements';
+import '@github/relative-time-element';

data/app/components/primer/local_time.rb

@@ -37,7 +37,9 @@ module Primer
 
       @datetime = datetime
 
-      @system_arguments[:tag] = "local-time"
+      @system_arguments[:tag] = "relative-time"
+      @system_arguments[:threshold] = "PT0S"
+      @system_arguments[:prefix] = ""
       @system_arguments[:datetime] = datetime
 
       @initial_text = initial_text

data/app/components/primer/local_time.ts

@@ -1 +1 @@
-import '@github/time-elements'
+import '@github/relative-time-element'

data/app/components/primer/markdown.rb

@@ -1,288 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use `Markdown` to wrap markdown content.
-  class Markdown < Primer::Component
-    status :beta
-
-    DEFAULT_TAG = :div
-    TAG_OPTIONS = [DEFAULT_TAG, :article, :td].freeze
-    # @example Default
-    #   <%= render(Primer::Markdown.new) do %>
-    #     <p>Text can be <b>bold</b>, <i>italic</i>, or <s>strikethrough</s>. <a href="https://github.com">Links </a> should be blue with no underlines (unless hovered over).</p>
-    #
-    #     <p>There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.</p>
-    #
-    #     <p>There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.</p>
-    #
-    #     <blockquote>
-    #       <p>There should be no margin above this first sentence.</p>
-    #       <p>Blockquotes should be a lighter gray with a gray border along the left side.</p>
-    #       <p>There should be no margin below this final sentence.</p>
-    #     </blockquote>
-    #
-    #     <h1>Header 1</h1>
-    #
-    #     <p>This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.</p>
-    #
-    #     <h2>Header 2</h2>
-    #
-    #     <blockquote>This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.</blockquote>
-    #
-    #     <h3>Header 3</h3>
-    #
-    #     <pre><code>This is a code block following a header.</code></pre>
-    #
-    #     <h4>Header 4</h4>
-    #
-    #     <ul>
-    #       <li>This is an unordered list following a header.</li>
-    #       <li>This is an unordered list following a header.</li>
-    #       <li>This is an unordered list following a header.</li>
-    #     </ul>
-    #
-    #     <h5>Header 5</h5>
-    #
-    #     <ol>
-    #       <li>This is an ordered list following a header.</li>
-    #       <li>This is an ordered list following a header.</li>
-    #       <li>This is an ordered list following a header.</li>
-    #     </ol>
-    #
-    #     <h6>Header 6</h6>
-    #
-    #     <table>
-    #       <thead>
-    #         <tr>
-    #           <th>What</th>
-    #           <th>Follows</th>
-    #         </tr>
-    #       </thead>
-    #       <tbody>
-    #         <tr>
-    #           <td>A table</td>
-    #           <td>A header</td>
-    #         </tr>
-    #         <tr>
-    #           <td>A table</td>
-    #           <td>A header</td>
-    #         </tr>
-    #         <tr>
-    #           <td>A table</td>
-    #           <td>A header</td>
-    #         </tr>
-    #       </tbody>
-    #     </table>
-    #
-    #     <hr />
-    #
-    #     <p>There's a horizontal rule above and below this.</p>
-    #
-    #     <hr />
-    #
-    #     <p>Here is an unordered list:</p>
-    #
-    #     <ul>
-    #       <li>Salt-n-Pepa</li>
-    #       <li>Bel Biv DeVoe</li>
-    #       <li>Kid 'N Play</li>
-    #     </ul>
-    #
-    #     <p>And an ordered list:</p>
-    #
-    #     <ol>
-    #       <li>Michael Jackson</li>
-    #       <li>Michael Bolton</li>
-    #       <li>Michael Bublé</li>
-    #     </ol>
-    #
-    #     <p>And an unordered task list:</p>
-    #
-    #     <ul>
-    #       <li><input type="checkbox" id="create-markdown" checked /><label for="create-markdown">Create a sample markdown document</label><br></li>
-    #       <li><input type="checkbox" id="tasks-list" checked /><label for="tasks-list">Add tasks list to it</label><br></li>
-    #       <li><input type="checkbox" id="take-vacation" checked /><label for="take-vacation">Take a vacation</label><br></li>
-    #     </ul>
-    #
-    #     <p>And a "mixed" task list:</p>
-    #
-    #     <ul>
-    #       <li><input type="checkbox"id="steal-underpants"/><label for="steal-underpants">Steal underpants</label></li>
-    #       <li>?</li>
-    #       <li><input type="checkbox"id="profit"/><label for="profit">Profit!</label></li>
-    #     </ul>
-    #
-    #     And a nested list:
-    #
-    #     <ul>
-    #       <li>Jackson 5
-    #         <ul>
-    #           <li>Michael</li>
-    #           <li>Tito</li>
-    #           <li>Jackie</li>
-    #           <li>Marlon</li>
-    #           <li>Jermaine</li>
-    #         </ul>
-    #       </li>
-    #       <li>TMNT
-    #         <ul>
-    #           <li>Leonardo</li>
-    #           <li>Michelangelo</li>
-    #           <li>Donatello</li>
-    #           <li>Raphael</li>
-    #         </ul>
-    #       </li>
-    #     </ul>
-    #
-    #     <p>Definition lists can be used with HTML syntax. Definition terms are bold and italic.</p>
-    #
-    #     <dl>
-    #         <dt>Name</dt>
-    #         <dd>Godzilla</dd>
-    #         <dt>Born</dt>
-    #         <dd>1952</dd>
-    #         <dt>Birthplace</dt>
-    #         <dd>Japan</dd>
-    #         <dt>Color</dt>
-    #         <dd>Green</dd>
-    #     </dl>
-    #
-    #     <hr />
-    #
-    #     <p>Tables should have bold headings and alternating shaded rows.</p>
-    #
-    #     <table>
-    #       <thead>
-    #         <tr>
-    #           <th>Artist</th>
-    #           <th>Album</th>
-    #           <th>Year</th>
-    #         </tr>
-    #       </thead>
-    #       <tbody>
-    #         <tr>
-    #           <td>David Bowie</td>
-    #           <td>Scary Monsters</td>
-    #           <td>1980</td>
-    #         </tr>
-    #         <tr>
-    #           <td>Prince</td>
-    #           <td>Purple Rain</td>
-    #           <td>1982</td>
-    #         </tr>
-    #         <tr>
-    #           <td>Beastie Boys</td>
-    #           <td>License to Ill</td>
-    #           <td>1986</td>
-    #         </tr>
-    #         <tr>
-    #           <td>Janet Jackson</td>
-    #           <td>Rhythm Nation 1814</td>
-    #           <td>1989</td>
-    #         </tr>
-    #       </tbody>
-    #     </table>
-    #
-    #     <p>If a table is too wide, it should condense down and/or scroll horizontally.</p>
-    #
-    #     <table>
-    #       <thead>
-    #         <tr>
-    #           <th>Artist</th>
-    #           <th>Album</th>
-    #           <th>Year</th>
-    #           <th>Label</th>
-    #           <th>Songs</th>
-    #         </tr>
-    #       </thead>
-    #       <tbody>
-    #         <tr>
-    #           <td>David Bowie</td>
-    #           <td>Scary Monsters</td>
-    #           <td>1980</td>
-    #           <td>RCA Records</td>
-    #           <td>It's No Game (No. 1), Up the Hill Backwards, Scary Monsters (And Super Creeps), Ashes to Ashes, Fashion, Teenage Wildlife, Scream Like a Baby, Kingdom Come, Because You're Young, It's No Game (No. 2)</td>
-    #         </tr>
-    #         <tr>
-    #           <td>Prince</td>
-    #           <td>Purple Rain</td>
-    #           <td>1982</td>
-    #           <td>Warner Brothers Records</td>
-    #           <td>Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain</td>
-    #         </tr>
-    #         <tr>
-    #           <td>Beastie Boys</td>
-    #           <td>License to Ill</td>
-    #           <td>1986</td>
-    #           <td>Def Jam</td>
-    #           <td>Rhymin &amp; Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, Fight for Your Right, No Sleep till Brooklyn, Paul Revere, "Hold It Now, Hit It", Brass Monkey, Slow and Low, Time to Get Ill</td>
-    #         </tr>
-    #         <tr>
-    #           <td>Janet Jackson</td>
-    #           <td>Rhythm Nation 1814</td>
-    #           <td>1989</td>
-    #           <td>A&amp;M</td>
-    #           <td>Interlude: Pledge, Rhythm Nation, Interlude: T.V., State of the World, Interlude: Race, The Knowledge, Interlude: Let's Dance, Miss You Much, Interlude: Come Back, Love Will Never Do (Without You), Livin' in a World (They Didn't Make), Alright, Interlude: Hey Baby, Escapade, Interlude: No Acid, Black Cat, Lonely, Come Back to Me, Someday Is Tonight, Interlude: Livin'...In Complete Darkness</td>
-    #         </tr>
-    #       </tbody>
-    #     </table>
-    #
-    #     <hr />
-    #
-    #     <p>Code snippets like <code>var foo = "bar";</code> can be shown inline.</p>
-    #
-    #     <p>Also, <code>this should vertically align</code> <s><code>with this</code></s> <s>and this</s>.</p>
-    #
-    #     <p>Code can also be shown in a block element.</p>
-    #
-    #     <pre><code>var foo = "bar";</code></pre>
-    #
-    #     <p>Code can also use syntax highlighting.</p>
-    #
-    #     <pre><code>var foo = "bar";</code></pre>
-    #
-    #     <pre tabindex="0"><code>Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.</code></pre>
-    #
-    #     <pre tabindex="0"><code>var foo = "The same thing is true for code with syntax highlighting. A single line of code should horizontally scroll if it is really long.";</code></pre>
-    #
-    #     <p>Inline code inside table cells should still be distinguishable.</p>
-    #
-    #     <table>
-    #       <thead>
-    #         <tr>
-    #           <th>Language</th>
-    #           <th>Code</th>
-    #         </tr>
-    #       </thead>
-    #       <tbody>
-    #         <tr>
-    #           <td>JavasScript</td>
-    #           <td><code>var foo = "bar";</code></td>
-    #         </tr>
-    #         <tr>
-    #           <td>Ruby</td>
-    #           <td><code>foo = "bar"</code></td>
-    #         </tr>
-    #       </tbody>
-    #     </table>
-    #
-    #     <pre><code>This is the final element on the page and there should be no margin below this.</code></pre>
-    #   <% end %>
-    #
-    # @param tag [Symbol] <%= one_of(Primer::Markdown::TAG_OPTIONS) %>
-    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    def initialize(tag: DEFAULT_TAG, **system_arguments)
-      @system_arguments = system_arguments
-      @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
-
-      @system_arguments[:classes] = class_names(
-        "markdown-body",
-        system_arguments[:classes]
-      )
-    end
-
-    def call
-      render(Primer::BaseComponent.new(**@system_arguments)) { content }
-    end
+  class Markdown < Primer::Beta::Markdown
+    status :deprecated
   end
 end

data/app/components/primer/primer.d.ts

@@ -7,7 +7,7 @@ import './alpha/toggle_switch';
 import './alpha/tool_tip';
 import './alpha/x_banner';
 import './beta/auto_complete/auto_complete';
-import './clipboard_copy';
+import './beta/clipboard_copy';
 import './local_time';
 import './tab_container_component';
 import './time_ago_component';

data/app/components/primer/primer.js

@@ -7,7 +7,7 @@ import './alpha/toggle_switch';
 import './alpha/tool_tip';
 import './alpha/x_banner';
 import './beta/auto_complete/auto_complete';
-import './clipboard_copy';
+import './beta/clipboard_copy';
 import './local_time';
 import './tab_container_component';
 import './time_ago_component';

data/app/components/primer/primer.pcss

@@ -1,13 +1,19 @@
 /* CSS component styles here */
+
+/* alpha */
 @import "./alpha/action_list.pcss";
 @import "./alpha/auto_complete.pcss";
 @import "./alpha/banner.pcss";
+@import "./alpha/dialog.pcss";
 @import "./alpha/dropdown.pcss";
 @import "./alpha/tab_nav.pcss";
+@import "./alpha/text_field.pcss";
 @import "./alpha/button_marketing.pcss";
 @import "./alpha/toggle_switch.pcss";
 @import "./alpha/underline_nav.pcss";
 @import "./alpha/segmented_control.pcss";
+
+/* beta */
 @import "./beta/avatar.pcss";
 @import "./beta/avatar_stack.pcss";
 @import "./beta/border_box.pcss";
@@ -21,6 +27,8 @@
 @import "./beta/popover.pcss";
 @import "./beta/progress_bar.pcss";
 @import "./beta/truncate.pcss";
+
+/* to be renamed */
 @import "./menu_component.pcss";
 @import "./state_component.pcss";
 @import "./subhead_component.pcss";

data/app/components/primer/primer.ts

@@ -7,7 +7,7 @@ import './alpha/toggle_switch'
 import './alpha/tool_tip'
 import './alpha/x_banner'
 import './beta/auto_complete/auto_complete'
-import './clipboard_copy'
+import './beta/clipboard_copy'
 import './local_time'
 import './tab_container_component'
 import './time_ago_component'

data/app/components/primer/time_ago_component.d.ts

@@ -1 +1 @@
-import '@github/time-elements';
+import '@github/relative-time-element';

data/app/components/primer/time_ago_component.js

@@ -1 +1 @@
-import '@github/time-elements';
+import '@github/relative-time-element';

data/app/components/primer/time_ago_component.rb

@@ -15,7 +15,8 @@ module Primer
       @system_arguments = deny_tag_argument(**system_arguments)
       @system_arguments[:datetime] = time.utc.iso8601
       @system_arguments[:classes] = class_names("no-wrap", @system_arguments[:classes])
-      @system_arguments[:tag] = "time-ago"
+      @system_arguments[:tag] = "relative-time"
+      @system_arguments[:tense] = "past"
       @system_arguments[:format] = "micro" if micro
       @time = time
       @micro = micro

data/app/components/primer/time_ago_component.ts

@@ -1 +1 @@
-import '@github/time-elements'
+import '@github/relative-time-element'

data/app/forms/submit_button_form.rb

@@ -13,8 +13,14 @@ class SubmitButtonForm < ApplicationForm
       color: :success
     )
 
-    my_form.submit(name: :submit, label: "Submit", scheme: :primary, mr: 3) do |c|
-      c.with_leading_visual_icon(icon: :"check-circle")
+    my_form.group(layout: :horizontal) do |button_group|
+      button_group.submit(name: :submit, label: "Submit", scheme: :primary, mb: 3) do |c|
+        c.with_leading_visual_icon(icon: :"check-circle")
+      end
+
+      button_group.button(name: :button, label: "Click me", mb: 3) do |c|
+        c.with_leading_visual_icon(icon: :alert)
+      end
     end
   end
 end

data/app/helpers/primer/form_helper.rb

@@ -7,5 +7,17 @@ module Primer
     def primer_form_with(**kwargs, &block)
       form_with(**kwargs, skip_default_ids: false, builder: Primer::Forms::Builder, &block)
     end
+
+    def primer_fields_for(record_name, record_object = nil, options = {}, &block)
+      fields_for(
+        record_name,
+        record_object,
+        options.merge(
+          skip_default_ids: false,
+          builder: Primer::Forms::Builder
+        ),
+        &block
+      )
+    end
   end
 end

data/lib/postcss_mixins/clearfix.pcss

@@ -0,0 +1,12 @@
+@define-mixin clearfix {
+  &::before {
+    display: table;
+    content: '';
+  }
+
+  &::after {
+    display: table;
+    clear: both;
+    content: '';
+  }
+}

data/lib/primer/deprecations.rb

@@ -1,35 +1,105 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module Primer
   # :nodoc:
-  module Deprecations
-    # If there is no alternative to suggest, set the value to nil
-    DEPRECATED_COMPONENTS = {
-      "Primer::LabelComponent" => "Primer::Beta::Label",
-      "Primer::LinkComponent" => "Primer::Beta::Link",
-      "Primer::Alpha::AutoComplete" => "Primer::Beta::AutoComplete",
-      "Primer::Alpha::AutoComplete::Item" => "Primer::Beta::AutoComplete::Item",
-      "Primer::BlankslateComponent" => "Primer::Beta::Blankslate",
-      "Primer::BoxComponent" => "Primer::Box",
-      "Primer::DropdownMenuComponent" => nil,
-      "Primer::Dropdown" => "Primer::Alpha::Dropdown",
-      "Primer::Dropdown::Menu" => "Primer::Alpha::Dropdown::Menu",
-      "Primer::Dropdown::Menu::Item" => "Primer::Alpha::Dropdown::Menu::Item",
-      "Primer::IconButton" => "Primer::Beta::IconButton",
-      "Primer::Tooltip" => "Primer::Alpha::Tooltip",
-      "Primer::PopoverComponent" => "Primer::Beta::Popover"
-    }.freeze
-
-    def self.deprecated?(name)
-      DEPRECATED_COMPONENTS.key?(name)
-    end
+  class Deprecations
+    class << self
+      def register(file_path)
+        data = YAML.load_file(file_path)
+        data["deprecations"].each do |dep|
+          register_deprecation(dep["component"], {
+                                 autocorrect: dep["autocorrect"],
+                                 guide: dep["guide"],
+                                 replacement: dep["replacement"]
+                               })
+        end
+      end
 
-    def self.suggested_component(name)
-      DEPRECATED_COMPONENTS[name]
-    end
+      def register_deprecation(component, options)
+        registered_deprecations[component] = {
+          autocorrect: options[:autocorrect],
+          guide: options[:guide],
+          replacement: options[:replacement]
+        }
+      end
+
+      def deprecated_components
+        registered_deprecations.keys.sort
+      end
+
+      def deprecated?(component_name)
+        # if the component is registered, it is deprecated
+        registered_deprecations.key?(component_name)
+      end
+
+      def replacement?(component_name)
+        !replacement(component_name).nil?
+      end
+
+      def replacement(component_name)
+        dep = registered_deprecations[component_name]
+        return nil if dep.nil?
+
+        dep[:replacement]
+      end
+
+      def correctable?(component_name)
+        dep = registered_deprecations[component_name]
+        return false if dep.nil?
+
+        dep[:autocorrect]
+      end
 
-    def self.correctable?(name)
-      !suggested_component(name).nil?
+      def guide?(component_name)
+        !guide(component_name).nil?
+      end
+
+      def guide(component_name)
+        dep = registered_deprecations[component_name]
+        return nil if dep.nil?
+
+        dep[:guide]
+      end
+
+      def deprecation_message(component_name)
+        return nil unless deprecated?(component_name)
+
+        msg = ["'#{component_name}' has been deprecated."]
+
+        # this nested structure is complex, because it has to
+        # match all of the valid scenarios for a component being
+        # replaceable, auto-correctable, and having a guide. for
+        # more information on what is and is not valid, see the
+        # documentation here: docs/contributors/deprecations.md
+
+        if replacement?(component_name) # has replacement
+          if correctable?(component_name) # is autocorrectable
+            msg << "Please update your code to use '#{replacement(component_name)}'"
+            msg << "or use rubocop's auto-correct option to do it for you."
+            msg << "See #{guide(component_name)} for more information." if guide?(component_name) # has a guide
+          elsif guide?(component_name) # not autocorrectable
+            msg << "See #{guide(component_name)} for information on replacing this component in your code." # has a guide
+          end
+        elsif !correctable?(component_name) # no replacement
+          if guide?(component_name) # has a guide
+            msg << "Unfortunately, there is no direct replacement."
+            msg << "See #{guide(component_name)} for available options to update your code."
+            end
+        end
+
+        msg.join(" ")
+      end
+
+      private
+
+      def registered_deprecations
+        @registered_deprecations ||= {}
+      end
     end
+
+    # auto-load PVC's deprecations
+    register(File.expand_path("deprecations.yml", __dir__))
   end
 end