Deprecate Regex.captures and String.valid_codepoint?

Author: José Valim

lib/elixir/lib/regex.ex

@@ -156,21 +156,27 @@ defmodule Regex do
     end
   end
 
+  @doc false
+  def captures(regex, string, options // []) do
+    IO.write "Regex.captures/3 is deprecated, please use Regex.named_captures/3\n#{Exception.format_stacktrace}"
+    named_captures(regex, string, options)
+  end
+
   @doc """
   Returns the given captures as a keyword list or `nil` if no captures
   are found. Requires the regex to be compiled with the groups option.
 
   ## Examples
 
-      iex> Regex.captures(%r/c(?<foo>d)/g, "abcd")
+      iex> Regex.named_captures(%r/c(?<foo>d)/g, "abcd")
       [foo: "d"]
-      iex> Regex.captures(%r/a(?<foo>b)c(?<bar>d)/g, "abcd")
+      iex> Regex.named_captures(%r/a(?<foo>b)c(?<bar>d)/g, "abcd")
       [foo: "b", bar: "d"]
-      iex> Regex.captures(%r/a(?<foo>b)c(?<bar>d)/g, "efgh")
+      iex> Regex.named_captures(%r/a(?<foo>b)c(?<bar>d)/g, "efgh")
       nil
 
   """
-  def captures(regex(groups: groups) = regex, string, options // []) do
+  def named_captures(regex(groups: groups) = regex, string, options // []) do
     options = Keyword.put_new(options, :capture, :groups)
     results = run(regex, string, options)
     if results, do: Enum.zip(groups, results)

lib/elixir/lib/string.ex

@@ -661,27 +661,14 @@ defmodule String do
   def valid_character?(<<_ :: utf8>> = codepoint), do: valid?(codepoint)
   def valid_character?(_), do: false
 
-  @doc %S"""
-  Checks whether `str` is a valid codepoint.
-
-  Note that the empty string is considered invalid, as are
-  strings containing multiple codepoints.
-
-  ## Examples
-
-      iex> String.valid_codepoint?("a")
-      true
-      iex> String.valid_codepoint?("ø")
-      true
-      iex> String.valid_codepoint?(<<0xffff :: 16>>)
-      false
-      iex> String.valid_codepoint?("asdf")
-      false
+  @doc false
+  def valid_codepoint?(binary) do
+    IO.write "String.valid_codepoint?/1 is deprecated, please use match against << _ :: utf8 >> instead\n#{Exception.format_stacktrace}"
+    do_valid_codepoint?(binary)
+  end
 
-  """
-  @spec valid_codepoint?(codepoint) :: boolean
-  def valid_codepoint?(<<_ :: utf8>>), do: true
-  def valid_codepoint?(_), do: false
+  defp do_valid_codepoint?(<<_ :: utf8>>), do: true
+  defp do_valid_codepoint?(_), do: false
 
   @doc """
   Returns unicode graphemes in the string.

lib/elixir/test/elixir/regex_test.exs

@@ -68,13 +68,13 @@ defmodule Regex.BinaryTest do
     assert Regex.match?(%r/foo$/,  "afoo")
   end
 
-  test :captures do
-    assert Keyword.equal? Regex.captures(%r/(?<foo>c)(?<bar>d)/g, 'abcd'), [bar: 'd', foo: 'c']
-    assert Regex.captures(%r/c(?<foo>d)/g, 'abcd') == [foo: 'd']
-    assert Regex.captures(%r/c(?<foo>d)/g, 'no_match') == nil
-    assert Regex.captures(%r/c(?<foo>d|e)/g, 'abcd abce') == [foo: 'd']
-    assert Regex.captures(%r/c(?<foo>d)/g, 'abcd', return: :binary) == [foo: "d"]
-    assert Regex.captures(%r/c(.)/g, 'cat') == []
+  test :named_captures do
+    assert Keyword.equal? Regex.named_captures(%r/(?<foo>c)(?<bar>d)/g, 'abcd'), [bar: 'd', foo: 'c']
+    assert Regex.named_captures(%r/c(?<foo>d)/g, 'abcd') == [foo: 'd']
+    assert Regex.named_captures(%r/c(?<foo>d)/g, 'no_match') == nil
+    assert Regex.named_captures(%r/c(?<foo>d|e)/g, 'abcd abce') == [foo: 'd']
+    assert Regex.named_captures(%r/c(?<foo>d)/g, 'abcd', return: :binary) == [foo: "d"]
+    assert Regex.named_captures(%r/c(.)/g, 'cat') == []
   end
 
   test :sigil_R do

lib/elixir/test/elixir/string_test.exs

@@ -200,7 +200,8 @@ defmodule StringTest do
   end
 
   test :mixed_codepoints do
-    assert String.codepoints("ϖͲϥЫݎߟΈټϘለДШव׆ש؇؊صلټܗݎޥޘ߉ऌ૫ሏᶆ℆ℙℱ ⅚Ⅷ↠∈⌘①ffi") == ["ϖ", "Ͳ", "ϥ", "Ы", "ݎ", "ߟ", "Έ", "ټ", "Ϙ", "ለ", "Д", "Ш", "व", "׆", "ש", "؇", "؊", "ص", "ل", "ټ", "ܗ", "ݎ", "ޥ", "ޘ", "߉", "ऌ", "૫", "ሏ", "ᶆ", "℆", "ℙ", "ℱ", " ", "⅚", "Ⅷ", "↠", "∈", "⌘", "①", "ffi"]
+    assert String.codepoints("ϖͲϥЫݎߟΈټϘለДШव׆ש؇؊صلټܗݎޥޘ߉ऌ૫ሏᶆ℆ℙℱ ⅚Ⅷ↠∈⌘①ffi") ==
+           ["ϖ", "Ͳ", "ϥ", "Ы", "ݎ", "ߟ", "Έ", "ټ", "Ϙ", "ለ", "Д", "Ш", "व", "׆", "ש", "؇", "؊", "ص", "ل", "ټ", "ܗ", "ݎ", "ޥ", "ޘ", "߉", "ऌ", "૫", "ሏ", "ᶆ", "℆", "ℙ", "ℱ", " ", "⅚", "Ⅷ", "↠", "∈", "⌘", "①", "ffi"]
   end
 
   test :graphemes do
@@ -302,15 +303,6 @@ defmodule StringTest do
     refute String.valid_character?("ab")
   end
 
-  test :valid_codepoint? do
-    assert String.valid_codepoint?("a")
-    assert String.valid_codepoint?("ø")
-    assert String.valid_codepoint?("あ")
-
-    refute String.valid_codepoint?(<<0xffff :: 16>>)
-    refute String.valid_codepoint?("ab")
-  end
-
   test :to_integer do
     assert String.to_integer("12") === {12, ""}
     assert String.to_integer("-12") === {-12, ""}