Change option to

A  should behave as the elixir guard check, which returns a boolean. In the case of , it was returning to the next state so that a  should be a better word for its purpose

Author: norbajunior

README.md

@@ -17,7 +17,7 @@ You can install `machinist` by adding it  to your list of dependencies in `mix.e
 ```elixir
 def deps do
   [
-    {:machinist, "~> 1.0.0"}
+    {:machinist, "~> 2.0.0"}
   ]
 end
 ```
@@ -84,20 +84,20 @@ iex> Door.transit(door_opened, event: "lock")
 {:error, :not_allowed}
 ```
 
-## Guard conditions
+## Conditions
 
 We could also implement a state machine for an electronic door which should validate a passcode to unlock it. In this scenario, the `machinist` allows us to provide a function to evaluate a condition and return the new state.
 
 Check out the diagram below representing it:
 
 ![state-machine-diagram](./assets/check-passcode.png)
 
-And to have this condition for the `unlock` event, use the `event` macro passing the `guard` option with a one-arity function:
+And to have this condition for the `unlock` event, use the `event` macro passing the `cond` option with a one-arity function:
 
 ```elixir
 # ..
 transitions do
-  event "unlock", guard: &check_passcode/1 do
+  event "unlock", cond: &check_passcode/1 do
     from :locked, to: :unlocked
     from :locked, to: :locked
   end
@@ -108,7 +108,7 @@ defp check_passcode(door) do
 end
 ```
 
-So when we call `Door.transit(%Door{state: :locked}, event: "unlock")` the guard function `check_passcode/1` will be called with the struct door as the first parameter and returns the new state to be set.
+So when we call `Door.transit(%Door{state: :locked}, event: "unlock")` the function `check_passcode/1` will be called with the struct door as the first parameter and returns the new state to be set.
 
 ### Setting a different attribute name that holds the state
 
@@ -170,7 +170,7 @@ defmodule SelectionProcess.V1 do
     from :new,           to: :registered,    event: "register"
     from :registered,    to: :started_test,  event: "start_test"
 
-    event "send_test", guard: &check_score/1 do
+    event "send_test", cond: &check_score/1 do
       from :started_test, to: :approved
       from :started_test, to: :reproved
     end

lib/machinist.ex

@@ -118,9 +118,9 @@ defmodule Machinist do
 
   @doc """
   Defines an `event` block grouping a same-event `from` -> `to` transitions
-  with a guard function that should evaluates a condition and returns a new state.
+  with a cond option that should receive a function that returns a new state.
 
-      event "update_score"", guard: &check_score/1 do
+      event "update_score"", cond: &check_score/1 do
         from :test, to: :approved
         from :test, to: :reproved
       end
@@ -129,7 +129,7 @@ defmodule Machinist do
         if score >= 70, do: :approved, else: :reproved
       end
   """
-  defmacro event(event, [guard: func], do: {:__block__, line, content}) do
+  defmacro event(event, [cond: func], do: {:__block__, line, content}) do
     content = prepare_transitions(event, func, content)
 
     quote bind_quoted: [content: content, line: line] do
@@ -195,16 +195,16 @@ defmodule Machinist do
     [prepare_transition(event, head) | prepare_transitions(event, tail)]
   end
 
-  defp prepare_transitions(event, guard_func, [head | _]) do
-    prepare_transition(event, guard_func, head)
+  defp prepare_transitions(event, cond_func, [head | _]) do
+    prepare_transition(event, cond_func, head)
   end
 
   defp prepare_transition(event, {:from, _line, [from, to]}) do
     define_transition(from, to ++ [event: event])
   end
 
-  defp prepare_transition(event, guard_func, {:from, _line, [from, _to]}) do
-    define_transition(from, to: guard_func, event: event)
+  defp prepare_transition(event, cond_func, {:from, _line, [from, _to]}) do
+    define_transition(from, to: cond_func, event: event)
   end
 
   defp define_transitions(_state, []), do: []
@@ -283,7 +283,7 @@ defmodule Machinist.NoLongerSupportedSyntaxError do
   @impl true
   def exception(state: state, to: new_state_func, event: event) do
     new_dsl = ~s"""
-    event "#{event}", guard: #{Macro.to_string(new_state_func)} do
+    event "#{event}", cond: #{Macro.to_string(new_state_func)} do
       from :#{state}, to: :your_new_state
     end
     """
@@ -292,7 +292,7 @@ defmodule Machinist.NoLongerSupportedSyntaxError do
 
     #{IO.ANSI.reset()}`from` macro does not accept a function as a value to `:to` anymore
 
-    Instead use the `event` macro passing the function as a guard option:
+    Instead, use the `event` macro passing the function as a `:cond` option:
 
     #{new_dsl}
     """

mix.exs

@@ -1,7 +1,7 @@
 defmodule Machinist.MixProject do
   use Mix.Project
 
-  @version "1.0.0"
+  @version "2.0.0"
   @repo_url "https://github.com/norbajunior/machinist"
 
   def project do

test/machinist_test.exs

@@ -195,7 +195,7 @@ defmodule MachinistTest do
           from :form2, to: :tests_in_progress
         end
 
-        event "update_test_score", guard: &check_status/1 do
+        event "update_test_score", cond: &check_status/1 do
           from :tests_in_progress, to: :tests_in_progress
           from :tests_in_progress, to: :tests_reproved
           from :tests_in_progress, to: :tests_approved
@@ -273,7 +273,7 @@ defmodule MachinistTest do
           use Machinist
 
           transitions do
-            event "start_interview", guard: &which_interview/1 do
+            event "start_interview", cond: &which_interview/1 do
               from :tests_approved do
                 to :interview_1
                 to :interview_2
@@ -294,9 +294,9 @@ defmodule MachinistTest do
 
     \e[0m`from` macro does not accept a function as a value to `:to` anymore
 
-    Instead use the `event` macro passing the function as a guard option:
+    Instead, use the `event` macro passing the function as a `:cond` option:
 
-    event "start_interview", guard: &which_interview/1 do
+    event "start_interview", cond: &which_interview/1 do
       from :score_updated, to: :your_new_state
     end
 
@@ -326,9 +326,9 @@ defmodule MachinistTest do
 
     \e[0m`from` macro does not accept a function as a value to `:to` anymore
 
-    Instead use the `event` macro passing the function as a guard option:
+    Instead, use the `event` macro passing the function as a `:cond` option:
 
-    event "start_interview", guard: &which_interview/1 do
+    event "start_interview", cond: &which_interview/1 do
       from :score_updated, to: :your_new_state
     end