https://github.com/librity/ignite_dexlivery
Rocket Seat - Ignite - Elixir - A food delivery manager w/ Structs and Agents.
https://github.com/librity/ignite_dexlivery
demo-app elixir exlivery rocketseat-ignite
Last synced: 14 days ago
JSON representation
Rocket Seat - Ignite - Elixir - A food delivery manager w/ Structs and Agents.
- Host: GitHub
- URL: https://github.com/librity/ignite_dexlivery
- Owner: librity
- Created: 2021-03-15T17:18:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T12:07:06.000Z (over 4 years ago)
- Last Synced: 2025-02-25T17:46:13.424Z (over 1 year ago)
- Topics: demo-app, elixir, exlivery, rocketseat-ignite
- Language: Elixir
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dexlivery
## Table of Contents
- [About](#about)
- [Bash Commands](#bash_commands)
- [Elixir Commands](#elixir_commands)
- [Libs](#libs)
- [Docs](#docs)
- [Resources](#resources)
A demo Elixir program that uses `Structs` as `Data Transfer Objects`, and `Agents` to persist
state between precesses.
```bash
# Create new Elixir project
$ mix new project_name
# Intall dependencies
$ mix deps.get
# Generate linter config
$ mix credo gen.config
# Run linter
$ mix credo --strict
# Start your project as an Interactive Elixir session
$ iex -S mix
# Run console on test environment
$ MIX_ENV=test iex -S mix
# Run tests
$ mix test
```
Structs (named maps that belong to a module):
```elixir
> %Dexlivery.Users.User{}
%Dexlivery.Users.User{email: nil, name: nil, cpf: nil, age: nil}
> alias Dexlivery.Users.User
> %User{}
%Dexlivery.Users.User{email: nil, name: nil, cpf: nil, age: nil}
> huey = %User{email: "hueylewis@andthenews.com", name: "Huey Lewis"}
%Dexlivery.Users.User{
age: nil,
cpf: nil,
email: "hueylewis@andthenews.com",
name: "Huey Lewis"
}
> Map.put(huey, :age, 70)
%Dexlivery.Users.User{
age: 70,
cpf: nil,
email: "hueylewis@andthenews.com",
name: "Huey Lewis"
}
> %{huey | cpf: "1234567"}
%Dexlivery.Users.User{
age: nil,
cpf: "1234567",
email: "hueylewis@andthenews.com",
name: "Huey Lewis"
}
> %{huey | ssn: "1234567"}
** (KeyError) key :ssn not found in: %Dexlivery.Users.User{age: nil, cpf: nil, email: "hueylewis@andthenews.com", name: "Huey Lewis"}
> %User{name: username} = huey
> username
"Huey Lewis"
```
Decimal lib (to accurately deal with money):
```elixir
> Decimal.cast("42.42")
{:ok, #Decimal<42.42>}
> Decimal.cast(42.42)
{:ok, #Decimal<42.42>}
> Decimal.new("42.42")
#Decimal<42.42>
> Decimal.new(42.42)
** (FunctionClauseError) no function clause matching in Decimal.new/1
```
Creating an Order:
```elixir
> {:ok, item1} = Dexlivery.Orders.Item.build(40.42, 1, "Penne Arrabiata", :italian, "Spicy, good cold.")
> {:ok, item2} = Dexlivery.Orders.Item.build(22.3, 2, "Cheese Pizza", :pizza, "Tasty")
> {:ok, user} = Dexlivery.Users.User.build("Tony Soprano", "tony@jerseyoutfit.org", "14 Aspen Drive, North Caldwell", "123-45-6789", 34)
> Dexlivery.Orders.Order.build(user, [item1, item2])
{:ok,
%Dexlivery.Orders.Order{
delivery_address: "14 Aspen Drive, North Caldwell",
items: [
%Dexlivery.Orders.Item{
category: :italian,
description: "Spicy, good cold.",
name: "Penne Arrabiata",
quantity: 1,
unit_price: #Decimal<40.42>
},
%Dexlivery.Orders.Item{
category: :pizza,
description: "Tasty",
name: "Cheese Pizza",
quantity: 2,
unit_price: #Decimal<22.3>
}
],
total_price: #Decimal<85.02>,
user_cpf: "123-45-6789"
}}
> Dexlivery.Orders.Order.build("bad", [item1, item2])
{:error, "Invalid parameters."}
> Dexlivery.Orders.Order.build(user, "bad")
{:error, "Invalid parameters."}
```
ExMachina Lib (like Factory Bot):
```elixir
> ExMachina.sequence(:email, &"email-#{&1}@example.com")
"email-0@example.com"
> ExMachina.sequence(:role, ["admin", "user", "other"])
"admin"
```
Agents (processes that persist data):
```elixir
> {:ok, agent} = Agent.start_link(fn -> %{} end)
{:ok, #PID<0.215.0>}
> Process.alive?(agent)
true
> Agent.update(agent, fn previous_state -> Map.put(previous_state, :money, "Good") end)
:ok
> Agent.get(agent, fn previous_state -> previous_state end)
%{money: "Good"}
> Agent.update(agent, fn previous_state -> Map.put(previous_state, :foo, "BAR") end)
:ok
> Agent.get(agent, fn previous_state -> previous_state end)
%{foo: "BAR", money: "Good"}
```
User Agent:
```elixir
> Dexlivery.start_agents()
{:ok, #PID<0.264.0>}
> user_params = %{
name: "Tony Soprano",
email: "tony@jerseyoutfit.org",
address: "14 Aspen Drive, North Caldwell",
cpf: "123-45-6789",
age: 34
}
> Dexlivery.create_or_update_user(user_params)
:ok
> Dexlivery.create_or_update_user(%{})
** (FunctionClauseError) no function clause matching in Dexlivery.Users.CreateOrUpdate.call/1
> Dexlivery.get_users
%{
"123-45-6789" => %Dexlivery.Users.User{
address: "14 Aspen Drive, North Caldwell",
age: 34,
cpf: "123-45-6789",
email: "tony@jerseyoutfit.org",
name: "Tony Soprano"
}
}
```
Elixir UUID lib:
```elixir
> UUID.uuid4()
"dfe79f96-ddbf-4bdc-9ed9-e6b869e9d64e"
```
Orders Agent:
```elixir
> Dexlivery.start_agents()
> user_params = Dexlivery.Factory.build(:user)
> Dexlivery.create_or_update_user(user_params)
> item = %{
category: :italian,
description: "Spicy, good cold.",
name: "Penne Arrabiata",
quantity: 1,
unit_price: 40.42
}
> {:ok, order_id} = Dexlivery.create_order(%{user_cpf: "123-45-6789", items: [item]})
{:ok, "ae6b8960-a972-487b-9900-8f3c5b48a2f2"}
> Dexlivery.update_order(%{user_cpf: "123-45-6789", items: [item]}, order_id)
{:ok, "ae6b8960-a972-487b-9900-8f3c5b48a2f2"}
> Dexlivery.get_orders
%{
"ae6b8960-a972-487b-9900-8f3c5b48a2f2" => %Dexlivery.Orders.Order{
delivery_address: "14 Aspen Drive, North Caldwell",
items: [
%Dexlivery.Orders.Item{
category: :italian,
description: "Spicy, good cold.",
name: "Penne Arrabiata",
quantity: 1,
unit_price: #Decimal<40.42>
}
],
total_price: #Decimal<40.42>,
user_cpf: "123-45-6789"
}
}
```
Orders Report:
```elixir
> Dexlivery.start_agents()
> user_params = Dexlivery.Factory.build(:user)
> Dexlivery.create_or_update_user(user_params)
> item1 = Dexlivery.Factory.build(:italian_item_params)
> item2 = Dexlivery.Factory.build(:pizza_item_params)
> Dexlivery.create_order(%{user_cpf: "123-45-6789", items: [item1]})
> Dexlivery.create_order(%{user_cpf: "123-45-6789", items: [item2]})
> Dexlivery.create_order(%{user_cpf: "123-45-6789", items: [item1, item2]})
> Dexlivery.Orders.Report.generate()
["123-45-6789,pizza,2,22.3,44.6",
"123-45-6789,italian,1,40.42pizza,2,22.3,85.02",
"123-45-6789,italian,1,40.42,40.42"]
```
- https://github.com/rrrene/credo
- https://github.com/ericmj/decimal
- https://github.com/thoughtbot/ex_machina
- https://github.com/zyro/elixir-uuid
- https://elixir-lang.org/crash-course.html
- https://elixir-lang.org/getting-started/mix-otp/agent.html
- https://github.com/christopheradams/elixir_style_guide#modules
- https://hexdocs.pm/decimal/readme.html
- https://hexdocs.pm/ex_machina/readme.html
- https://marketplace.visualstudio.com/items?itemName=pantajoe.vscode-elixir-credo
- https://www.tutorialspoint.com/elixir/elixir_structs.htm
- https://www.tutorialspoint.com/elixir/elixir_lists_and_tuples.htm
- https://inquisitivedeveloper.com/lwm-elixir-25/
- https://stackoverflow.com/questions/36330010/elixir-how-to-deal-with-optional-default-parameters-in-functions-and-nil-valu
- https://stackoverflow.com/questions/36512627/elixir-convert-struct-to-map
- https://stackoverflow.com/questions/38778054/how-to-generate-a-random-number-in-elixir