Updated docs. Added JS.update/2

bryanjos · bryanjos · commit cfdae14adaf2 · 2016-02-26T12:58:38.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,10 @@
   
 * Bugfixes
   * Fixed optional parameter implementation
+  
+* Breaking
+  * `JS.update(object, property, value)` has been removed and replaced with `JS.update(object, map)`
+    This allows you to update multiple values on a javascript object at once.
 
 # v0.15.2
 * Enhancements
diff --git a/lib/elixir_script/prelude/js.ex b/lib/elixir_script/prelude/js.ex
@@ -20,9 +20,9 @@ defmodule ElixirScript.JS do
   Updates an existing JavaScript object.
 
   ex:
-    JS.update elem, "width", 100
+    JS.update elem, %{"width" => 100}
   """
-  defmacro update(object, property, value) do
+  defmacro update(object, map) do
   end
 
 
diff --git a/lib/elixir_script/prelude/kernel.ex b/lib/elixir_script/prelude/kernel.ex
@@ -193,6 +193,13 @@ defmodule ElixirScript.Kernel do
     end
   end
 
+  @doc """
+  Provides a convenient way to create a string-based map.
+
+  Elixirscript, by default turns the following, `%{a: "b"}` into `{[Symbol.for("a")]: "b"}` in JavaScript. In order to get string keys,
+  one would have to do `%{"a" => "b"}` which turns into `{a: "b"}` in JavaScript. With `Kernel.object`, you can create string keyed maps
+  conveniently, `object(a: "b")` which turns into `{a: "b"}`
+  """
   defmacro object(args) do
     args = Enum.map(args, fn
       { k, v } when Kernel.is_atom(k) ->
diff --git a/lib/elixir_script/translator/js.ex b/lib/elixir_script/translator/js.ex
@@ -46,16 +46,12 @@ defmodule ElixirScript.Translator.JS do
     )
   end
 
-  defp do_translate({:update, _, [object, property, value]}, env) do
-    Builder.assignment_expression(
-      :=,
-      Builder.member_expression(
-        Translator.translate!(object, env),
-        Translator.translate!(property, env),
-        true
-      ),
-      Translator.translate!(value, env)
-    )
+  defp do_translate({:update, _, [object, map]}, env) do
+    quoted = quote do
+      Object.assign(unquote(object), unquote(map))
+    end
+
+    Translator.translate!(quoted, env)
   end
 
   defp do_translate({:import, _, [module_names, from]}, env) when is_list(module_names) do
diff --git a/test/prelude/js_test.exs b/test/prelude/js_test.exs
@@ -26,11 +26,13 @@ defmodule ElixirScript.Lib.JS.Test do
 
   test "translate update" do
     ex_ast = quote do
-      JS.update A, "b", [1, 2, 3]
+      JS.update A, %{"b" => [1, 2, 3]}
     end
 
     js_code = """
-      A['b'] = Object.freeze([1, 2, 3])
+    Object.assign(A, Object.freeze({
+      b: Object.freeze([1, 2, 3])
+    }))
     """
 
     assert_translation(ex_ast, js_code)
