Hard deprecate LivePatch, LiveRedirect, Link, Context and Example

surface-ui · Sep 17, 2024 · ce7af7a · ce7af7a
1 parent 0eace5c
commit ce7af7a
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 7 deletions.
diff --git a/lib/surface/catalogue/example.ex b/lib/surface/catalogue/example.ex
@@ -1,5 +1,9 @@
 defmodule Surface.Catalogue.Example do
   @moduledoc """
+  > #### Deprecation warning {: .warning}
+  >
+  > This component has been deprecated in favor of `Surface.Catalogue.Examples`.
+
   A generic LiveView to create a single example for catalogue tools.
 
   ## Options
@@ -32,7 +36,16 @@ defmodule Surface.Catalogue.Example do
 
   """
 
+  @moduledoc deprecated: "Use `Surface.Catalogue.Examples` instead"
+
   defmacro __using__(opts) do
+    if Mix.env() != :test do
+      IO.warn(
+        "`Surface.Catalogue.Example` is deprecated. Use `Surface.Catalogue.Examples` instead",
+        Macro.Env.stacktrace(__CALLER__)
+      )
+    end
+
     subject = Surface.Catalogue.fetch_subject!(opts, __MODULE__, __CALLER__)
 
     quote do

diff --git a/lib/surface/components/context.ex b/lib/surface/components/context.ex
@@ -1,13 +1,14 @@
 defmodule Surface.Components.Context do
   @moduledoc """
-  > #### Soft deprecation warning {: .warning}
+  > #### Deprecation warning {: .warning}
   >
   > Using this module as a component with `<Context>` has been deprecated. Support for
   > scope-aware context will be removed in `v0.13` due to the lack of built-in support for
   > the feature in Liveview itself, which leads to inefficient diff-tracking when using it.
   >
-  > Global context related functions like `Context.put/3` and `Context.get/3`, as well as the `:from_context`
-  > option, will be kept and recommended as their usage don't affect diff-tracking negatively.
+  > Global context related functions like `Context.put/3` and `Context.get/3`, as well as data/prop's
+  > option `:from_context`, will be kept and recommended as their usage don't affect diff-tracking
+  > negatively.
 
   A built-in module and component that allows users to set and retrieve values
   to/from the context.
@@ -116,6 +117,10 @@ defmodule Surface.Components.Context do
     update_let_for_slot_entry(node, :default, let)
   end
 
+  if Mix.env() != :test do
+    @deprecated "Use `Context.put/3`, `Context.get/3` or the data/prop's option `:from_context` instead"
+  end
+
   @doc false
   def render(assigns) do
     ~F"""

diff --git a/lib/surface/components/link.ex b/lib/surface/components/link.ex
@@ -1,6 +1,6 @@
 defmodule Surface.Components.Link do
   @moduledoc """
-  > #### Soft deprecation warning {: .warning}
+  > #### Deprecation warning {: .warning}
   >
   > This component has been deprecated in favor of liveview's built-in `<.link>`
   > and will be removed in `v0.13`. See https://hexdocs.pm/phoenix_live_view/live-navigation.html for
@@ -67,6 +67,10 @@ defmodule Surface.Components.Link do
   """
   slot default
 
+  if Mix.env() != :test do
+    @deprecated "Use liveview's built-in `<.link>` instead"
+  end
+
   def render(assigns) do
     unless assigns[:default] || assigns[:label] || Keyword.get(assigns.opts, :label) do
       raise ArgumentError, "<Link /> requires a label prop or contents in the default slot"

diff --git a/lib/surface/components/live_patch.ex b/lib/surface/components/live_patch.ex
@@ -1,6 +1,6 @@
 defmodule Surface.Components.LivePatch do
   @moduledoc """
-  > #### Soft deprecation warning {: .warning}
+  > #### Deprecation warning {: .warning}
   >
   > This component has been deprecated in favor of liveview's built-in `<.link>`
   > and will be removed in `v0.13`. See https://hexdocs.pm/phoenix_live_view/live-navigation.html for
@@ -18,7 +18,7 @@ defmodule Surface.Components.LivePatch do
   `<LiveRedirect>` instead.
   """
 
-  @moduledoc deprecated: "Use liveview's built-in `<.link>` instead"
+  @moduledoc deprecated: "Use Liveview's built-in `<.link>` instead"
 
   use Surface.Component
 
@@ -47,6 +47,10 @@ defmodule Surface.Components.LivePatch do
   """
   slot default
 
+  if Mix.env() != :test do
+    @deprecated "Use liveview's built-in `<.link>` instead"
+  end
+
   def render(assigns) do
     ~F"""
     <a

diff --git a/lib/surface/components/live_redirect.ex b/lib/surface/components/live_redirect.ex
@@ -1,6 +1,6 @@
 defmodule Surface.Components.LiveRedirect do
   @moduledoc """
-  > #### Soft deprecation warning {: .warning}
+  > #### Deprecation warning {: .warning}
   >
   > This component has been deprecated in favor of liveview's built-in `<.link>`
   > and will be removed in `v0.13`. See https://hexdocs.pm/phoenix_live_view/live-navigation.html for
@@ -47,6 +47,10 @@ defmodule Surface.Components.LiveRedirect do
   """
   slot default
 
+  if Mix.env() != :test do
+    @deprecated "Use liveview's built-in `<.link>` instead"
+  end
+
   def render(assigns) do
     ~F"""
     <a