Removing the deprecated Primer::TimeAgoComponent (#1792)

primer · Feb 2, 2023 · 730b0a8 · 730b0a8
1 parent 0282faf
commit 730b0a8
Show file tree

Hide file tree

Showing 17 changed files with 6 additions and 202 deletions.
diff --git a/.changeset/strong-kangaroos-speak.md b/.changeset/strong-kangaroos-speak.md
@@ -0,0 +1,5 @@
+---
+"@primer/view-components": patch
+---
+
+Removing the deprecated Primer::TimeAgoComponent
diff --git a/app/components/primer/time_ago_component.ts → app/components/primer/beta/relative_time.ts b/app/components/primer/time_ago_component.ts → app/components/primer/beta/relative_time.ts
diff --git a/app/components/primer/primer.ts b/app/components/primer/primer.ts
@@ -8,8 +8,8 @@ import './alpha/tool_tip'
 import './alpha/x_banner'
 import './beta/auto_complete/auto_complete'
 import './beta/clipboard_copy'
+import './beta/relative_time'
 import './alpha/tab_container'
-import './time_ago_component'
 import '../../../lib/primer/forms/primer_multi_input'
 import '../../../lib/primer/forms/primer_text_field'
 import '../../../lib/primer/forms/toggle_switch_input'
diff --git a/app/components/primer/time_ago_component.rb b/app/components/primer/time_ago_component.rb
diff --git a/app/lib/primer/view_helper.rb b/app/lib/primer/view_helper.rb
@@ -9,7 +9,6 @@ class ViewHelperNotFound < StandardError; end
     HELPERS = {
       octicon: "Primer::Beta::Octicon",
       heading: "Primer::Beta::Heading",
-      time_ago: "Primer::TimeAgoComponent",
       image: "Primer::Alpha::Image"
     }.freeze
 

diff --git a/docs/src/@primer/gatsby-theme-doctocat/nav.yml b/docs/src/@primer/gatsby-theme-doctocat/nav.yml
@@ -123,8 +123,6 @@
     url: "/components/button"
   - title: IconButton
     url: "/components/iconbutton"
-  - title: TimeAgo
-    url: "/components/timeago"
   - title: Tooltip
     url: "/components/tooltip"
 - title: Architecture decisions

diff --git a/lib/primer/deprecations.yml b/lib/primer/deprecations.yml
@@ -26,11 +26,6 @@ deprecations:
     autocorrect: true
     replacement: "Primer::Beta::IconButton"
 
-  - component: "Primer::TimeAgoComponent"
-    autocorrect: false
-    replacement: "Primer::Beta::RelativeTime"
-    guide: "https://primer.style/view-components/guides/primer_time_ago"
-
   - component: "Primer::Tooltip"
     autocorrect: true
     replacement: "Primer::Alpha::Tooltip"
diff --git a/lib/primer/yard/component_manifest.rb b/lib/primer/yard/component_manifest.rb
@@ -53,7 +53,6 @@ class ComponentManifest
         Primer::Beta::Subhead => {},
         Primer::Alpha::TabContainer => { js: true },
         Primer::Beta::Text => {},
-        Primer::TimeAgoComponent => { js: true },
         Primer::Beta::TimelineItem => {},
         Primer::Tooltip => {},
         Primer::Truncate => {},

diff --git a/previews/primer/time_ago_component_preview.rb b/previews/primer/time_ago_component_preview.rb
diff --git a/static/arguments.json b/static/arguments.json
@@ -2381,32 +2381,6 @@
       }
     ]
   },
-  {
-    "component": "TimeAgo",
-    "status": "deprecated",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/time_ago_component.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago/default/",
-    "parameters": [
-      {
-        "name": "time",
-        "type": "Time",
-        "default": "N/A",
-        "description": "The time to be formatted"
-      },
-      {
-        "name": "micro",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "If true then the text will be formatted in \"micro\" mode, using as few characters as possible"
-      },
-      {
-        "name": "system_arguments",
-        "type": "Hash",
-        "default": "N/A",
-        "description": "[System arguments](/system-arguments)"
-      }
-    ]
-  },
   {
     "component": "Tooltip",
     "status": "deprecated",

diff --git a/static/audited_at.json b/static/audited_at.json
@@ -79,7 +79,6 @@
   "Primer::IconButton": "",
   "Primer::LayoutComponent": "",
   "Primer::Navigation::TabComponent": "",
-  "Primer::TimeAgoComponent": "",
   "Primer::Tooltip": "",
   "Primer::Truncate": ""
 }
diff --git a/static/constants.json b/static/constants.json
@@ -1073,8 +1073,6 @@
     ],
     "DEFAULT_ARIA_CURRENT_FOR_ANCHOR": "page"
   },
-  "Primer::TimeAgoComponent": {
-  },
   "Primer::Tooltip": {
     "ALIGN_DEFAULT": "default",
     "ALIGN_MAPPING": {

diff --git a/static/statuses.json b/static/statuses.json
@@ -79,7 +79,6 @@
   "Primer::IconButton": "deprecated",
   "Primer::LayoutComponent": "alpha",
   "Primer::Navigation::TabComponent": "alpha",
-  "Primer::TimeAgoComponent": "deprecated",
   "Primer::Tooltip": "deprecated",
   "Primer::Truncate": "beta"
 }
diff --git a/test/components/component_test.rb b/test/components/component_test.rb
@@ -98,7 +98,6 @@ class PrimerComponentTest < Minitest::Test
     [Primer::Beta::Text, {}],
     [Primer::Truncate, {}],
     [Primer::Beta::Truncate, {}, proc { |component| component.with_item { "Foo" } }],
-    [Primer::TimeAgoComponent, { time: Time.zone.now }],
     [Primer::Beta::TimelineItem, {}, proc { |component| component.with_body { "Foo" } }],
     [Primer::Tooltip, { label: "More" }],
     [Primer::Alpha::UnderlineNav, { label: "aria label" }, proc { |component| component.with_tab(selected: true) { "Foo" } }],

diff --git a/test/components/time_ago_component_test.rb b/test/components/time_ago_component_test.rb
diff --git a/test/lib/primer/view_helper_test.rb b/test/lib/primer/view_helper_test.rb
@@ -16,12 +16,6 @@ def test_renders_heading_using_shorthand
     assert_selector("h2", text: "My Heading")
   end
 
-  def test_renders_time_ago_using_shorthand
-    primer_time_ago(time: Time.at(1_615_490_863).utc)
-
-    assert_selector("relative-time", text: "Mar 11, 2021")
-  end
-
   def test_renders_octicon_using_shorthand
     primer_octicon icon: :star
 

diff --git a/test/system/time_ago_component_test.rb b/test/system/time_ago_component_test.rb