Merge pull request #870 from devinus/words-with-modifiers

Add support for %w and %W (words) sigils with return type modifiers

Author: José Valim

lib/elixir/lib/kernel.ex

@@ -3427,6 +3427,55 @@ defmodule Kernel do
     Macro.escape(regex)
   end
 
+  @doc """
+  Handles the sigil %w. It returns a list of "words" split by whitespace.
+
+  ## Modifiers
+
+  - `b`: binaries (default)
+  - `a`: atoms
+  - `c`: char lists
+
+  ## Examples
+
+      iex> %w(foo \#{:bar} baz)
+      ["foo", "bar", "baz"]
+      iex> %w(--source test/enum_test.exs)
+      ["--source", "test/enum_test.exs"]
+      iex> %w(foo bar baz)a
+      [:foo, :bar, :baz]
+
+  """
+
+  defmacro __w__({ :<<>>, _line, [string] }, modifiers) when is_binary(string) do
+    split_words(Macro.unescape_binary(string), modifiers)
+  end
+
+  defmacro __w__({ :<<>>, line, pieces }, modifiers) do
+    binary = { :<<>>, line, Macro.unescape_tokens(pieces) }
+    split_words(binary, modifiers)
+  end
+
+  @doc """
+  Handles the sigil %W. It returns a list of "words" split by whitespace
+  without escaping nor interpreting interpolations.
+
+  ## Modifiers
+
+  - `b`: binaries (default)
+  - `a`: atoms
+  - `c`: char lists
+
+  ## Examples
+
+      iex> %W(foo \#{bar} baz)
+      ["foo", "\\\#{bar}", "baz"]
+
+  """
+  defmacro __W__({ :<<>>, _line, [string] }, modifiers) when is_binary(string) do
+    split_words(string, modifiers)
+  end
+
   ## Private functions
 
   # Extracts concatenations in order to optimize many
@@ -3472,4 +3521,22 @@ defmodule Kernel do
   end
 
   defp build_cond_clauses([], acc), do: acc
+
+  defp split_words(string, modifiers) do
+    quote do
+      mod = case unquote(modifiers) do
+        [] -> ?b
+        [mod] when mod in [?b, ?a, ?c] -> mod
+        _else -> raise ArgumentError, message: "modifier must be one of: b, a, c"
+      end
+
+      parts = String.split(unquote(string))
+
+      case mod do
+        ?b -> parts
+        ?a -> lc p inlist parts, do: binary_to_atom(p)
+        ?c -> lc p inlist parts, do: binary_to_list(p)
+      end
+    end
+  end
 end

lib/elixir/test/elixir/kernel/sigils_test.exs

@@ -48,4 +48,39 @@ defmodule Kernel.SigilsTest do
     assert %C(f#{o}o) == 'f\#{o}o'
     assert %C(f\no) == 'f\\no'
   end
-end
+
+  test :__w__ do
+    assert %w(foo bar baz) == ["foo", "bar", "baz"]
+    assert %w(foo #{:bar} baz) == ["foo", "bar", "baz"]
+
+    assert %w(
+      foo
+      bar
+      baz
+    ) == ["foo", "bar", "baz"]
+
+    assert %w(foo bar baz)b == ["foo", "bar", "baz"]
+    assert %w(foo bar baz)a == [:foo, :bar, :baz]
+    assert %w(foo bar baz)c == ['foo', 'bar', 'baz']
+
+    bad_modifier = quote do: %w(foo bar baz)x
+    assert ArgumentError[] = catch_error(Code.eval_quoted(bad_modifier))
+  end
+
+  test :__W__ do
+    assert %W(foo #{bar} baz) == ["foo", "\#{bar}", "baz"]
+
+    assert %W(
+      foo
+      bar
+      baz
+    ) == ["foo", "bar", "baz"]
+
+    assert %W(foo bar baz)b == ["foo", "bar", "baz"]
+    assert %W(foo bar baz)a == [:foo, :bar, :baz]
+    assert %W(foo bar baz)c == ['foo', 'bar', 'baz']
+
+    bad_modifier = quote do: %W(foo bar baz)x
+    assert ArgumentError[] = catch_error(Code.eval_quoted(bad_modifier))
+  end
+end