Merge pull request #1199 from alco/1148-match-tilde-op

Reimplement =~ to use Regex.match? or String.contains?

Author: José Valim

lib/elixir/lib/kernel.ex

@@ -2813,21 +2813,51 @@ defmodule Kernel do
   defmacro left in right
 
   @doc """
-  Matches the term on the left against the regular expression
-  on the right. It returns nil if not match happened or the
-  first match otherwise.
+  Matches the term on the left against the regular expression or string on the
+  right. Returns true if `left` matches `right` (if it's a regular expression)
+  or contains `right` (if it's a string).
 
   ## Examples
 
       iex> "abcd" =~ %r/c(d)/
-      2
+      true
+
       iex> "abcd" =~ %r/e/
-      nil
+      false
+
+      iex> "abcd" =~ "bc"
+      true
+
+      iex> "abcd" =~ "ad"
+      false
 
   """
+  # fast path for literal binaries
+  defmacro left =~ right when is_binary(right) do
+    quote do
+      String.contains?(unquote(left), unquote(right))
+    end
+  end
+
+  # fast path for literal binaries
+  defmacro left =~ ({:<<>>, _, [_bin]} = right) do
+    quote do
+      String.contains?(unquote(left), unquote(right))
+    end
+  end
+
+  # slow path for everything else
   defmacro left =~ right do
     quote do
-      Regex.index(unquote(right), unquote(left))
+      str = unquote(left)
+      case unquote(right) do
+        bin when is_binary(bin) ->
+          String.contains?(str, bin)
+        re when is_regex(re) ->
+          Regex.match?(re, str)
+        other ->
+          raise ArgumentError, message: "bad argument on the right side of =~: #{inspect other}"
+      end
     end
   end
 

lib/elixir/test/elixir/exception_test.exs

@@ -34,8 +34,8 @@ defmodule Kernel.ExceptionTest do
   end
 
   test :format_stacktrace_entry_with_fun do
-    assert Exception.format_stacktrace_entry({fn(x) -> x end, [1], []}) =~ %r"\(1\)"
-    assert Exception.format_stacktrace_entry({fn(x, y) -> { x, y } end, 2, []}) =~ %r"/2"
+    assert Exception.format_stacktrace_entry({fn(x) -> x end, [1], []}) =~ %r/#Function<.+>\(1\)/
+    assert Exception.format_stacktrace_entry({fn(x, y) -> { x, y } end, 2, []}) =~ %r"#Function<.+>/2"
   end
 
   test :format_module_function_arity do

lib/elixir/test/elixir/hash_dict_test.exs

@@ -165,7 +165,7 @@ defmodule HashDictTest do
   end
 
   test :inspect do
-    assert inspect(filled_dict(8)) =~ %r"#HashDict<"
+    assert inspect(filled_dict(8)) =~ "#HashDict<"
   end
 
   test :small_range_merge do

lib/elixir/test/elixir/kernel/warning_test.exs

@@ -12,7 +12,7 @@ defmodule Kernel.WarningTest do
         def hello(arg), do: nil
       end
       """
-    end) =~ %r"variable arg is unused"
+    end) =~ "variable arg is unused"
   after
     purge Sample
   end
@@ -24,7 +24,7 @@ defmodule Kernel.WarningTest do
         defp hello, do: nil
       end
       """
-    end) =~ %r"function hello/0 is unused"
+    end) =~ "function hello/0 is unused"
 
     assert capture_io(fn ->
       Code.eval_string """
@@ -33,7 +33,7 @@ defmodule Kernel.WarningTest do
         defp hello(1), do: :ok
       end
       """
-    end) =~ %r"function hello/1 is unused"
+    end) =~ "function hello/1 is unused"
 
     assert capture_io(fn ->
       Code.eval_string """
@@ -44,7 +44,7 @@ defmodule Kernel.WarningTest do
         defp d(x), do: x
       end
       """
-    end) =~ %r"function c/2 is unused"
+    end) =~ "function c/2 is unused"
 
   after
     purge [Sample1, Sample2, Sample3]
@@ -58,7 +58,7 @@ defmodule Kernel.WarningTest do
         defp b, do: a
       end
       """
-    end) =~ %r"function a/0 is unused"
+    end) =~ "function a/0 is unused"
   after
     purge Sample
   end
@@ -70,7 +70,7 @@ defmodule Kernel.WarningTest do
         defmacrop hello, do: nil
       end
       """
-    end) =~ %r"macro hello/0 is unused"
+    end) =~ "macro hello/0 is unused"
   after
     purge Sample
   end
@@ -83,7 +83,7 @@ defmodule Kernel.WarningTest do
         defp b(arg1 // 1, arg2 // 2, arg3 // 3), do: [arg1, arg2, arg3]
       end
       """
-    end) =~ %r"default arguments in b/3 are never used"
+    end) =~ "default arguments in b/3 are never used"
 
     assert capture_io(fn ->
       Code.eval_string """
@@ -92,7 +92,7 @@ defmodule Kernel.WarningTest do
         defp b(arg1 // 1, arg2 // 2, arg3 // 3), do: [arg1, arg2, arg3]
       end
       """
-    end) =~ %r"the first 2 default arguments in b/3 are never used"
+    end) =~ "the first 2 default arguments in b/3 are never used"
 
     assert capture_io(fn ->
       Code.eval_string """
@@ -101,7 +101,7 @@ defmodule Kernel.WarningTest do
         defp b(arg1 // 1, arg2 // 2, arg3 // 3), do: [arg1, arg2, arg3]
       end
       """
-    end) =~ %r"the first default argument in b/3 is never used"
+    end) =~ "the first default argument in b/3 is never used"
 
     assert capture_io(fn ->
       Code.eval_string """
@@ -127,7 +127,7 @@ defmodule Kernel.WarningTest do
         def a, do: nil
       end
       """
-    end) =~ %r"unused import Sample1"
+    end) =~ "unused import Sample1"
   after
     purge [Sample1, Sample2]
   end
@@ -140,7 +140,7 @@ defmodule Kernel.WarningTest do
         def hello, do: nil
       end
       """
-    end) =~ %r"this clause cannot match because a previous clause at line 2 always matches"
+    end) =~ "this clause cannot match because a previous clause at line 2 always matches"
   after
     purge Sample
   end
@@ -153,7 +153,7 @@ defmodule Kernel.WarningTest do
         def hello(arg // 0), do: nil
       end
       """
-    end) =~ %r"clause with defaults should be the first clause in def hello/1"
+    end) =~ "clause with defaults should be the first clause in def hello/1"
   after
     purge Sample
   end
@@ -166,7 +166,7 @@ defmodule Kernel.WarningTest do
         def hello(arg // 1), do: nil
       end
       """
-    end) =~ %r"def hello/1 has default values and multiple clauses, use a separate clause for declaring defaults"
+    end) =~ "def hello/1 has default values and multiple clauses, use a separate clause for declaring defaults"
   after
     purge Sample
   end
@@ -181,7 +181,7 @@ defmodule Kernel.WarningTest do
         def hello, do: :ok
       end
       """
-    end) =~ %r"function world/0 is unused"
+    end) =~ "function world/0 is unused"
   after
     purge Sample
   end

lib/elixir/test/elixir/kernel_test.exs

@@ -4,8 +4,24 @@ defmodule KernelTest do
   use ExUnit.Case, async: true
 
   test :match do
-    assert "abcd" =~ %r/c(d)/
-    refute "abcd" =~ %r/e/
+    assert ("abcd" =~ %r/c(d)/) == true
+    assert ("abcd" =~ %r/e/) == false
+
+    string = "^ab+cd*$"
+    assert (string =~ "ab+") == true
+    assert (string =~ "bb") == false
+
+    assert_raise ArgumentError, "bad argument on the right side of =~: [\"^a\",\"*$\"]", fn ->
+      string =~ ["^a", "*$"]
+    end
+
+    assert_raise ArgumentError, "argument error", fn ->
+      1234 =~ "hello"
+    end
+
+    assert_raise ArgumentError, "argument error", fn ->
+      1234 =~ %r"hello"
+    end
   end
 
   test :nil? do

lib/elixir/test/elixir/regex_test.exs

@@ -40,7 +40,7 @@ defmodule Regex.BinaryTest do
   end
 
   test :unicode do
-    assert ("josé" =~ %r"\p{Latin}$"u) == 3
+    assert ("josé" =~ %r"\p{Latin}$"u)
   end
 
   test :groups do

lib/ex_unit/test/ex_unit/cli_formatter_test.exs

@@ -25,8 +25,8 @@ defmodule ExUnit.CLIFormatterTest do
     """
 
     out_put = exec_test("raising_test.exs")
-    assert out_put =~ %r/stacktrace:/
-    refute out_put =~ %r/ExUnit\.Runner/
+    assert out_put =~ "stacktrace:"
+    refute out_put =~ "ExUnit.Runner"
   after
     File.rm("raising_test.exs")
   end
@@ -44,7 +44,7 @@ defmodule ExUnit.CLIFormatterTest do
     """
 
     out_put = exec_test("failure_test.exs")
-    assert out_put =~ %r/at failure_test.exs:6/
+    assert out_put =~ "at failure_test.exs:6"
   after
     File.rm("failure_test.exs")
   end

lib/mix/test/mix/cli_test.exs

@@ -6,15 +6,15 @@ defmodule Mix.CLITest do
   test "env" do
     in_fixture "custom_mixfile", fn ->
       env = System.cmd %b(MIX_ENV=prod #{elixir_executable} #{mix_executable} run "IO.puts Mix.env")
-      assert env =~ %r"prod"
+      assert env =~ "prod"
     end
   end
 
   test "default task" do
     in_fixture "custom_mixfile", fn ->
       output = mix ""
       assert File.regular?("ebin/Elixir.A.beam")
-      assert output =~ %r"Compiled lib/a.ex"
+      assert output =~ "Compiled lib/a.ex"
     end
   end
 
@@ -32,86 +32,86 @@ defmodule Mix.CLITest do
       assert File.regular?("ebin/Elixir.B.beam")
       assert File.regular?("ebin/Elixir.C.beam")
 
-      assert output =~ %r"Compiled lib/a\.ex"
+      assert output =~ "Compiled lib/a.ex"
     end
   end
 
   test "test smoke test" do
     in_fixture "custom_mixfile", fn ->
       output = mix "test"
       assert File.regular?("ebin/Elixir.A.beam")
-      assert output =~ %r"1 tests, 0 failures"
+      assert output =~ "1 tests, 0 failures"
 
       output = mix "test test/hidden.ex --cover cover"
-      assert output =~ %r"1 tests, 1 failures"
-      assert output =~ %r"Generating cover results ... ok"
+      assert output =~ "1 tests, 1 failures"
+      assert output =~ "Generating cover results ... ok"
       assert File.regular?("cover/Elixir.A.html")
     end
   end
 
   test "help smoke test" do
     in_fixture "only_mixfile", fn ->
       output = mix "help"
-      assert output =~ %r"mix compile\s+# Compile source files"
-      assert output =~ %r"mix hello\s+# Hello"
-      refute output =~ %r"mix invalid"
+      assert output =~ %r/mix compile\s+# Compile source files/
+      assert output =~ %r/mix hello\s+# Hello/
+      refute output =~ "mix invalid"
     end
   end
 
   test "--help smoke test" do
     in_fixture "only_mixfile", fn ->
       output = mix "--help"
-      assert output =~ %r"mix compile\s+# Compile source files"
-      refute output =~ %r"mix invalid"
+      assert output =~ %r/mix compile\s+# Compile source files/
+      refute output =~ "mix invalid"
     end
   end
 
   test "--version smoke test" do
     in_fixture "only_mixfile", fn ->
       output = mix "--version"
-      assert output =~ %r"Elixir [0-9\.a-z]+"
-      refute output =~ %r"Something silly"
+      assert output =~ %r/Elixir [0-9\.a-z]+/
+      refute output =~ "Something silly"
     end
   end
 
   test "help TASK smoke test" do
     in_fixture "only_mixfile", fn ->
       output = mix "help compile"
-      assert output =~ %r"# mix help compile"
-      assert output =~ %r"## Command line options"
-      assert output =~ %r"^Location:"m
+      assert output =~ "# mix help compile"
+      assert output =~ "## Command line options"
+      assert output =~ %r/^Location:/m
     end
   end
 
   test "do smoke test" do
     in_fixture "only_mixfile", fn ->
       output = mix "do compile --list, help compile"
-      assert output =~ %r"# mix help compile"
-      assert output =~ %r"mix compile.elixir #"
+      assert output =~ "# mix help compile"
+      assert output =~ "mix compile.elixir #"
     end
   end
 
   test "new with tests smoke test" do
     in_tmp "new_with_tests", fn ->
       output = mix "new ."
-      assert output =~ %r(\* creating lib/new_with_tests.ex)
+      assert output =~ "* creating lib/new_with_tests.ex"
 
       output = mix "test"
       assert File.regular?("ebin/Elixir.NewWithTests.beam")
-      assert output =~ %r"1 tests, 0 failures"
+      assert output =~ "1 tests, 0 failures"
     end
   end
 
   test "new --sup with tests smoke test" do
     in_tmp "new_with_tests", fn ->
       output = mix "new . --sup"
-      assert output =~ %r(\* creating lib/new_with_tests.ex)
-      assert output =~ %r(\* creating lib/new_with_tests/supervisor.ex)
+      assert output =~ "* creating lib/new_with_tests.ex"
+      assert output =~ "* creating lib/new_with_tests/supervisor.ex"
 
       output = mix "test"
       assert File.regular?("ebin/Elixir.NewWithTests.beam")
-      assert output =~ %r"1 tests, 0 failures"
+      assert output =~ "1 tests, 0 failures"
     end
   end
 
-end
+end