Merge branch 'release/0.1.1'

Author: ejpcmac

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.1.1
+
+* Do not make the type nullable when there is a default value
+
 ## v0.1.0
 
 * Initial version

README.md

@@ -31,7 +31,7 @@ defmodule Person do
   @type t() :: %__MODULE__{
           name: String.t(),
           age: non_neg_integer() | nil,
-          happy?: boolean() | nil,
+          happy?: boolean(),
           phone: String.t() | nil
         }
 end
@@ -41,7 +41,8 @@ In the example above you can notice several points:
 
 * the keys are present in both the `defstruct` and type definition,
 * enforced keys must also be written in `@enforce_keys`,
-* if a key is not enforced, the type should be nullable.
+* if a key has no default value and is not enforced, its type should be
+  nullable.
 
 If you want to add a field in the struct, you must therefore:
 
@@ -80,7 +81,7 @@ Thanks to TypedStruct, this is now possible :)
 To use TypedStruct in your project, add this to you Mix dependencies:
 
 ```elixir
-{:typed_struct, "~> 0.1.0", runtime: false}
+{:typed_struct, "~> 0.1.1", runtime: false}
 ```
 
 If you want to avoid `mix format` putting parentheses on field definitions,
@@ -168,7 +169,7 @@ iex(4)> Demo.__types__()
       [line: 5], []},
     nil
   ]},
-  with_default: {:|, [], [{:integer, [line: 6], []}, nil]}
+  with_default: {:integer, [line: 6], []}
 ]
 ```
 
@@ -234,32 +235,25 @@ field :name, String.t(), default: "John Smith"
 defstruct name: "John Smith"
 ```
 
-The type itself remains the same.
-
-The `enforce` option, when set to `true`, enforces the key. Therefore, the
-type is not nullable anymore:
+When set to `true`, the `enforce` option enforces the key by adding it to the
+`@enforce_keys` attribute.
 
 ```elixir
-defmodule Example do
-  use TypedStruct
+field :name, String.t(), enforce: true
 
-  typedstruct do
-    field :name, String.t(), enforce: true
-  end
-end
+# Becomes
+@enforce_keys [:name]
+defstruct name: nil
 ```
 
-becomes:
+In both cases, the type has no reason to be nullable anymore by default. In one
+case the field is filled with its default value and not `nil`, and in the other
+case it is enforced. Both options would generate the following type:
 
 ```elixir
-defmodule Example do
-  @enforce_keys [:name] # :name is enforced
-  defstruct name: nil
-
-  @type t() :: %__MODULE__{
-          name: String.t() # Not nullable
-        }
-end
+@type t() :: %__MODULE__{
+        name: String.t() # Not nullable
+      }
 ```
 
 ## [Contributing](CONTRIBUTING.md)

lib/typed_struct.ex

@@ -28,7 +28,7 @@ defmodule TypedStruct do
         @type t() :: %__MODULE__{
                 name: String.t(),
                 age: non_neg_integer() | nil,
-                happy?: boolean() | nil,
+                happy?: boolean(),
                 phone: String.t() | nil
               }
       end
@@ -37,7 +37,8 @@ defmodule TypedStruct do
 
     * the keys are present in both the `defstruct` and type definition,
     * enforced keys must also be written in `@enforce_keys`,
-    * if a key is not enforced, the type should be nullable.
+    * if a key has no default value and is not enforced, its type should be
+      nullable.
 
   If you want to add a field in the struct, you must therefore:
 
@@ -154,7 +155,7 @@ defmodule TypedStruct do
             [line: 5], []},
           nil
         ]},
-        with_default: {:|, [], [{:integer, [line: 6], []}, nil]}
+        with_default: {:integer, [line: 6], []}
       ]
 
   ## What do I get?
@@ -209,29 +210,22 @@ defmodule TypedStruct do
       # Becomes
       defstruct name: "John Smith"
 
-  The type itself remains the same.
+  When set to `true`, the `enforce` option enforces the key by adding it to the
+  `@enforce_keys` attribute.
 
-  The `enforce` option, when set to `true`, enforces the key. Therefore, the
-  type is not nullable anymore:
+      field :name, String.t(), enforce: true
 
-      defmodule Example do
-        use TypedStruct
-
-        typedstruct do
-          field :name, String.t(), enforce: true
-        end
-      end
-
-  becomes:
+      # Becomes
+      @enforce_keys [:name]
+      defstruct name: nil
 
-      defmodule Example do
-        @enforce_keys [:name] # :name is enforced
-        defstruct name: nil
+  In both cases, the type has no reason to be nullable anymore by default. In one
+  case the field is filled with its default value and not `nil`, and in the other
+  case it is enforced. Both options would generate the following type:
 
-        @type t() :: %__MODULE__{
-                name: String.t() # Not nullable
-              }
-      end
+      @type t() :: %__MODULE__{
+            name: String.t() # Not nullable
+          }
   """
 
   @doc false
@@ -304,9 +298,10 @@ defmodule TypedStruct do
 
     default = opts[:default]
     enforce? = !!opts[:enforce]
+    nullable? = !default && !enforce?
 
     Module.put_attribute(mod, :fields, {name, default})
-    Module.put_attribute(mod, :types, {name, type_for(type, enforce?)})
+    Module.put_attribute(mod, :types, {name, type_for(type, nullable?)})
     if enforce?, do: Module.put_attribute(mod, :keys_to_enforce, name)
   end
 
@@ -326,6 +321,6 @@ defmodule TypedStruct do
   ##
 
   # Makes the type nullable if the key is not enforced.
-  defp type_for(type, true), do: type
+  defp type_for(type, false), do: type
   defp type_for(type, _), do: quote(do: unquote(type) | nil)
 end

mix.exs

@@ -1,7 +1,7 @@
 defmodule TypedStruct.MixProject do
   use Mix.Project
 
-  @version "0.1.0"
+  @version "0.1.1"
   @repo_url "https://github.com/ejpcmac/typed_struct"
 
   def project do

test/typed_struct_test.exs

@@ -42,7 +42,7 @@ defmodule TypedStructTest do
         @type t() :: %__MODULE__{
                 int: integer() | nil,
                 string: String.t() | nil,
-                string_with_default: String.t() | nil,
+                string_with_default: String.t(),
                 mandatory_int: integer()
               }
       end
@@ -79,7 +79,7 @@ defmodule TypedStructTest do
         [
           int: integer() | nil,
           string: String.t() | nil,
-          string_with_default: String.t() | nil,
+          string_with_default: String.t(),
           mandatory_int: integer()
         ]
       end