fix: don't set a false value param to nil on new/1 (#4)

* fix: don't set a `false`-value param to `nil` on `new/1`

* chore: bump version to 0.4.1

Author: hpopp

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.4.1
+
+- Set `false` parameter correctly when given a Map of params. Was previously
+  evaluating to `nil`.
+
 ## v0.4.0
 
 - Default typespecs and documentation for modules using Commandex.

README.md

@@ -16,7 +16,7 @@ Add commandex as a `mix.exs` dependency:
 ```elixir
 def deps do
   [
-    {:commandex, "~> 0.4.0"}
+    {:commandex, "~> 0.4.1"}
   ]
 end
 ```

lib/commandex.ex

@@ -363,7 +363,7 @@ defmodule Commandex do
   end
 
   def parse_params(%{params: p} = struct, %{} = params) do
-    params = for {key, _} <- p, into: %{}, do: {key, get_param(params, key) || p[key]}
+    params = for {key, _} <- p, into: %{}, do: {key, get_param(params, key, p[key])}
     %{struct | params: params}
   end
 
@@ -413,10 +413,13 @@ defmodule Commandex do
     Module.put_attribute(mod, :pipelines, name)
   end
 
-  defp get_param(params, key) do
+  defp get_param(params, key, default) do
     case Map.get(params, key) do
-      nil -> Map.get(params, to_string(key))
-      val -> val
+      nil ->
+        Map.get(params, to_string(key), default)
+
+      val ->
+        val
     end
   end
 end

mix.exs

@@ -1,7 +1,7 @@
 defmodule Commandex.MixProject do
   use Mix.Project
 
-  @version "0.4.0"
+  @version "0.4.1"
 
   def project do
     [

test/commandex_test.exs

@@ -3,9 +3,13 @@ defmodule CommandexTest do
   doctest Commandex
   alias Commandex.RegisterUser
 
+  @email "example@example.com"
+  @password "test1234"
+  @agree_tos false
+
   describe "struct assembly" do
     test "sets :params map" do
-      for key <- [:email, :password] do
+      for key <- [:email, :password, :agree_tos] do
         assert Map.has_key?(%RegisterUser{}.params, key)
       end
     end
@@ -19,5 +23,45 @@ defmodule CommandexTest do
         assert Map.has_key?(%RegisterUser{}.data, key)
       end
     end
+
+    test "handles atom-key map params correctly" do
+      params = %{
+        email: @email,
+        password: @password,
+        agree_tos: @agree_tos
+      }
+
+      command = RegisterUser.new(params)
+      assert_params(command)
+    end
+
+    test "handles string-key map params correctly" do
+      params = %{
+        email: @email,
+        password: @password,
+        agree_tos: @agree_tos
+      }
+
+      command = RegisterUser.new(params)
+      assert_params(command)
+    end
+
+    test "handles keyword list params correctly" do
+      params = [
+        email: @email,
+        password: @password,
+        agree_tos: @agree_tos
+      ]
+
+      command = RegisterUser.new(params)
+      assert_params(command)
+    end
+  end
+
+  defp assert_params(command) do
+    assert command.params.email == @email
+    assert command.params.password == @password
+    # Don't use refute here because nil fails the test.
+    assert command.params.agree_tos == @agree_tos
   end
 end

test/support/register_user.ex

@@ -8,15 +8,27 @@ defmodule Commandex.RegisterUser do
   command do
     param :email, default: "test@test.com"
     param :password
+    param :agree_tos
 
     data :user
     data :auth
 
+    pipeline :verify_tos
     pipeline :create_user
     pipeline :record_auth_attempt
     pipeline &IO.inspect/1
   end
 
+  def verify_tos(command, %{agree_tos: true} = _params, _data) do
+    command
+  end
+
+  def verify_tos(command, %{agree_tos: false} = _params, _data) do
+    command
+    |> put_error(:tos, :not_accepted)
+    |> halt()
+  end
+
   def create_user(command, %{password: nil} = _params, _data) do
     command
     |> put_error(:password, :not_given)