Merge pull request #293 from BinaryNoggin/support-map-in-assign-new

Allows `assign_new/2` to take a map of values

Thank you Amos

Author: boydm

lib/scenic/driver.ex

@@ -344,11 +344,15 @@ defmodule Scenic.Driver do
   @doc """
   Convenience function to assign a list of values into a driver struct.
   """
-  @spec assign(driver :: Driver.t(), key_list :: Keyword.t()) :: Driver.t()
+  @spec assign(driver :: Driver.t(), key_list :: Keyword.t() | map) :: Driver.t()
   def assign(%Driver{} = driver, key_list) when is_list(key_list) do
     Enum.reduce(key_list, driver, fn {k, v}, acc -> assign(acc, k, v) end)
   end
 
+  def assign(%Driver{assigns: assigns} = driver, key_map) when is_map(key_map) do
+    %{driver | assigns: Map.merge(assigns, key_map)}
+  end
+
   @doc """
   Convenience function to assign a value into a driver struct.
   """
@@ -358,15 +362,19 @@ defmodule Scenic.Driver do
   end
 
   @doc """
-  Convenience function to assign a list of new values into a driver struct.
+  Convenience function to assign a list or map of new values into a driver struct.
 
   Only values that do not already exist will be assigned
   """
-  @spec assign_new(driver :: Driver.t(), key_list :: Keyword.t()) :: Driver.t()
+  @spec assign_new(driver :: Driver.t(), key_list :: Keyword.t() | map) :: Driver.t()
   def assign_new(%Driver{} = driver, key_list) when is_list(key_list) do
     Enum.reduce(key_list, driver, fn {k, v}, acc -> assign_new(acc, k, v) end)
   end
 
+  def assign_new(%Driver{assigns: assigns} = driver, key_map) when is_map(key_map) do
+    %{driver | assigns: Map.merge(key_map, assigns)}
+  end
+
   @doc """
   Convenience function to assign a new values into a driver struct.
 

lib/scenic/scene.ex

@@ -415,11 +415,15 @@ defmodule Scenic.Scene do
 
   Only values that do not already exist will be assigned
   """
-  @spec assign_new(scene :: Scene.t(), key_list :: Keyword.t()) :: Scene.t()
+  @spec assign_new(scene :: Scene.t(), key_list :: Keyword.t() | map) :: Scene.t()
   def assign_new(%Scene{} = scene, key_list) when is_list(key_list) do
     Enum.reduce(key_list, scene, fn {k, v}, acc -> assign_new(acc, k, v) end)
   end
 
+  def assign_new(%Scene{assigns: assigns} = scene, key_map) when is_map(key_map) do
+    %{scene | assigns: Map.merge(key_map, assigns)}
+  end
+
   @doc """
   Convenience function to assign a new values into a scene struct.
 

test/scenic/driver_test.exs

@@ -188,6 +188,25 @@ defmodule Scenic.DriverTest do
     assert Driver.fetch(driver, :def) == {:ok, 456}
   end
 
+  test "assign assigns map of values" do
+    driver =
+      %Driver{}
+      |> Driver.assign(%{abc: 123, def: 456})
+
+    assert Driver.fetch(driver, :abc) == {:ok, 123}
+    assert Driver.fetch(driver, :def) == {:ok, 456}
+  end
+
+  test "assign_new overrides existing values" do
+    driver =
+      %Driver{assigns: %{abc: 123, hij: :original}}
+      |> Driver.assign(abc: 789, def: 456)
+
+    assert Driver.fetch(driver, :abc) == {:ok, 789}
+    assert Driver.fetch(driver, :def) == {:ok, 456}
+    assert Driver.fetch(driver, :hij) == {:ok, :original}
+  end
+
   test "assign_new assigns single value" do
     driver =
       %Driver{}
@@ -214,6 +233,24 @@ defmodule Scenic.DriverTest do
     assert Driver.fetch(driver, :def) == {:ok, 456}
   end
 
+  test "assign_new assigns map of values" do
+    driver =
+      %Driver{}
+      |> Driver.assign_new(%{abc: 123, def: 456})
+
+    assert Driver.fetch(driver, :abc) == {:ok, 123}
+    assert Driver.fetch(driver, :def) == {:ok, 456}
+  end
+
+  test "assign_new with a map ignores existing values" do
+    driver =
+      %Driver{assigns: %{abc: 123}}
+      |> Driver.assign_new(%{abc: 789, def: 456})
+
+    assert Driver.fetch(driver, :abc) == {:ok, 123}
+    assert Driver.fetch(driver, :def) == {:ok, 456}
+  end
+
   test "set_busy sets the busy flag" do
     driver = %Driver{}
     assert Map.get(driver, :busy) == false

test/scenic/scene_test.exs

@@ -208,6 +208,36 @@ defmodule Scenic.SceneTest do
     assert scene.assigns == %{one: 1, two: 2, three: "three"}
   end
 
+  test "assign_new assigns list of values", %{scene: scene} do
+    scene = Scene.assign_new(scene, abc: 123, def: 456)
+
+    assert scene.assigns == %{abc: 123, def: 456}
+  end
+
+  test "assign_new ignores existing values", %{scene: scene} do
+    scene =
+      scene
+      |> Scene.assign(abc: :original)
+      |> Scene.assign_new(abc: 123, def: 456)
+
+    assert scene.assigns == %{abc: :original, def: 456}
+  end
+
+  test "assign_new assigns map of values", %{scene: scene} do
+    scene = Scene.assign_new(scene, %{abc: 123, def: 456})
+
+    assert scene.assigns == %{abc: 123, def: 456}
+  end
+
+  test "assign_new with a map ignores existing values", %{scene: scene} do
+    scene =
+      scene
+      |> Scene.assign(abc: :original)
+      |> Scene.assign_new(%{abc: 123, def: 456})
+
+    assert scene.assigns == %{abc: :original, def: 456}
+  end
+
   test "get gets a value from assigns - works like map", %{scene: scene} do
     scene =
       Scene.assign(scene,