Merge pull request #3 from muhifauzan/struct-support

Add destructure structs feature

README.md

@@ -20,6 +20,15 @@ def full_name(d%{first_name, last_name}) do
 end
 ```
 
+Or with structs:
+```elixir
+import Destructure
+
+def full_name(d%Person{first_name, last_name}) do
+  "#{first_name} #{last_name}"
+end
+```
+
 It also works in case statements, like this:
 
 ```elixir

lib/destructure.ex

@@ -5,9 +5,10 @@ defmodule Destructure do
   """
 
   @doc """
-  Easy destructuring of maps and keyword lists, with atom keys only. String keys
-  are not supported because Elixir raises a `SyntaxError` on syntax like
-  `%{"name"}`.
+  Easy destructuring of maps, structs, and keyword lists, with atom keys only.
+  String keys are not supported because Elixir raises a `SyntaxError` on syntax
+  like `%{"name"}`. Optional key also need to be placed at the last for the same
+  reason with the string key.
 
   ## Examples
 
@@ -20,8 +21,7 @@ defmodule Destructure do
   Or in case/for/with statements.
 
       iex> case %{name: "Mike"} do
-      ...>   d%{name} ->
-      ...>     name
+      ...>   d%{name} -> name
       ...> end
       "Mike"
 
@@ -43,6 +43,24 @@ defmodule Destructure do
       ...> {first, last, mail}
       {"Daniel", "Berkompas", "[email protected]"}
 
+  For structs:
+
+      iex> d(%Person{name}) = %Person{name: "Daniel Berkompas"}
+      ...> name
+      "Daniel Berkompas"
+
+  With multiple keys:
+
+      iex> d(%Person{name, email}) = %Person{name: "Daniel Berkompas", email: "[email protected]"}
+      ...> {name, email}
+      {"Daniel Berkompas", "[email protected]"}
+
+  With multiple keys and custom variable naming:
+
+      iex> d(%Person{name, email: mail}) = %Person{name: "Daniel Berkompas", email: "[email protected]"}
+      ...> {name, mail}
+      {"Daniel Berkompas", "[email protected]"}
+
   For keyword lists:
 
       iex> d({name}) = [name: "Daniel"]
@@ -78,8 +96,16 @@ defmodule Destructure do
     {:%{}, context, Enum.map(args, &pattern/1)}
   end
 
+  # Handle structs, including ones with multiple keys
+  # {:%, [],
+  #  [{:__aliases__, [alias: false], [:Namespace]},
+  #   {:%{}, [], [{:first, [], Elixir}, {:second, [], Elixir}]}]}
+  defmacro d({:%, _, [{:__aliases__, _, _}, {:%{}, context, args}]}) do
+    {:%{}, context, Enum.map(args, &pattern/1)}
+  end
+
   # Handle 1 and 3+ element tuples
-  # {:{}, [], [{:variable_name, [], Elixir}]}
+  # {:{}, [], [{:first, [], Elixir}]}
   defmacro d({:{}, _, args}) do
     Enum.map(args, &pattern/1)
   end

mix.exs

@@ -3,7 +3,7 @@ defmodule Destructure.Mixfile do
 
   def project do
     [app: :destructure,
-     version: "0.1.1",
+     version: "0.2.0",
      elixir: "~> 1.3",
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,

test/destructure_test.exs

@@ -3,5 +3,11 @@ defmodule DestructureTest do
 
   import Destructure
 
+  defmodule Person do
+    defstruct [:name, :email]
+  end
+
+  alias __MODULE__.Person
+
   doctest Destructure
 end