ash-project/ash
1
0
Fork 0
mirror of https://github.com/ash-project/ash.git synced 2024-09-20 05:23:03 +12:00
Code Issues Projects Releases Packages Wiki Activity

getting started documentation improvements (#144)

Browse source 
Co-authored-by: Zach Daniel <zachary.s.daniel@gmail.com>
This commit is contained in:
mario 2020-11-16 02:08:04 +01:00 committed by GitHub
parent ff7a42b8a0
commit abb2f8e05d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 266 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

307
documentation/introduction/getting_started.md
View file

@ -4,6 +4,22 @@
For information on creating a new Elixir application, see [this guide](https://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html)
```shell
mix new my_app
```
For the finished example, see [this example](https://github.com/mario-mazo/my_app)
### With Phoenix
If you intend to use AshJsonApi or AshGraphql, you will likely want to create a new phoenix application, as opposed to just an Elixir application. A Phoenix application is just an Elixir application with all of the dependencies and set up of Phoenix. Phoenix provides a lot of extra capabilities at very little cost, and can be a very useful escape hatch if you need to
add something to your application that isn't supported by Ash yet. See the [Phoenix documentation](https://hexdocs.pm/phoenix/installation.html) for creating
a new Phoenix application. Ultimately, instead of mix new my_application, you would use:
```shell
mix phx.new my_application
```
## Add Ash
Add `ash` to your dependencies in `mix.exs`. The latest version can be found by running `mix hex.info ash`.
@ -17,11 +33,33 @@ def deps() do
end
```
If you want to have a more idiomatic formatting (the one used in this documentation) of your Ash resource and APIs,
you need to add ash (and any other extensions you use) to your `.formatter.exs` otherwise the default Elixir formatter will wrap portions of the DSL in parenthesis.
```elixir
import_deps: [
:ash
]
```
Without that, instead of:
```elixir
attribute :id, :integer, allow_nil?: true
```
the Elixir formatter will change it to
```elixir
attribute(:id, :integer, allow_nil?: true)
```
## Create an Ash API
Create an API module. This will be your primary way to interact with your Ash resources. We recommend `lib/my_app/api.ex` for simple setups. For more information on organizing resources into contexts/domains, see the "Contexts and Domains" guide.
```elixir
# lib/my_app/api.ex
defmodule MyApp.Api do
use Ash.Api
@ -32,7 +70,7 @@ end
## Create a resource
A resource is the primary entity in Ash. Your Api module ties your resources together and gives them an interface, but the vast majority if your configuration will live in a resource. In your typical setup, you might have a resource per database table. For those already familiar with ecto, a resource and an ecto schema are very similar. In fact, all resources define an ecto schema under the hood. This can be leveraged when you need to do things that are not yet implemented or fall outside of the scope of Ash. The current recommendation for where to put your resources is in `lib/my_app/resources/<resource_name>.ex`. Here are a few examples:
A resource is the primary entity in Ash. Your Api module ties your resources together and gives them an interface, but the vast majority of your configuration will live in resources. In your typical setup, you might have a resource per database table. For those already familiar with Ecto, a resource and an Ecto schema are very similar. In fact, all resources define an Ecto schema under the hood. This can be leveraged when you need to do things that are not yet implemented or fall outside of the scope of Ash. The current recommendation for where to put your resources is in `lib/my_app/resources/<resource_name>.ex`. Here are a few examples:
```elixir
# in lib/my_app/resources/tweet.ex
@ -40,19 +78,11 @@ defmodule MyApp.Tweet do
use Ash.Resource
attributes do
attribute :id, :uuid do
# All ash resources currently require a primary key
# Eventually, we will add good defaults and/or allow
# for a global configuration of your default primary key
primary_key? true
allow_nil? false
writable? false
default &Ecto.UUID.generate/0
end
uuid_primary_key :id
attribute :body, :string do
allow_nil? false
constraints [max_length: 255]
constraints max_length: 255
end
# Alternatively, you can use the keyword list syntax
@ -60,16 +90,17 @@ defmodule MyApp.Tweet do
# argument function or an MFA
attribute :public, :boolean, allow_nil?: false, default: false
create_timestamp :created_at #This is set on create
update_timestamp :updated_at #This is updated on all updates
# This is set on create
create_timestamp :created_at
# This is updated on all updates
update_timestamp :updated_at
# `create_timestamp` above is just shorthand for:
attribute :created_at, :utc_datetime, writable?: false, default: &DateTime.utc_now/0
# attribute :created_at, :utc_datetime,
# writable?: false,
# default: &DateTime.utc_now/0
end
relationships do
belongs_to :user, MyApp.User
end
end
# in lib/my_app/resources/user.ex
@ -77,20 +108,21 @@ defmodule MyApp.User do
use Ash.Resource
attributes do
attribute :email, :string, allow_nil?: false, constraints: [
match: ~r/[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}/
]
end
attribute :email, :string,
allow_nil?: false,
constraints: [
match: ~r/^[\w.!#$%&’*+\-\/=?\^`{|}~]+@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*$/i
],
primary_key?: true
relationships do
has_many :tweets, MyApp.Tweet, destination_field: :user_id
attribute :id, :uuid, default: &Ecto.UUID.generate/0
end
end
```
## Add resources to your API
Alter your API like so:
Alter your API in `api.ex` like so:
```elixir
resources do
@ -99,32 +131,225 @@ resources do
end
```
## Add your data_layer
### Test the resources
Choose a data_layer, and see its documentation for configuring it:
- `Ash.DataLayer.Ets` - an [ets](https://erlang.org/doc/man/ets.html) data_layer only recommended for testing
- `Ash.DataLayer.Mnesia` - an [mnesia](https://erlang.org/doc/man/mnesia.html) data_layer, not optimized, but is backed by a file and works with distributed applications
- `AshPostgres.DataLayer` - a Postgres data_layer, currently the primary supported data layer
To add a data_layer, add it to the `use Ash.Resource` statement:
Now you should be able to create changesets for your resources
```elixir
use Ash.Resource,
data_layer: AshPostgres.DataLayer
iex(7)> change = Ash.Changeset.new(MyApp.User, %{email: "ash.man@enguento.com"})
#Ash.Changeset<
action_type: :create,
attributes: %{email: "ash.man@enguento.com"},
relationships: %{},
errors: [],
data: %MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: nil,
id: nil
},
valid?: true
>
```
If you try to use a invalid email (the email regex is for demonstration purposes only)
an error will be displayed as shown
```elixir
iex(6)> change = Ash.Changeset.new(MyApp.User, %{email: "@eng.com"})
#Ash.Changeset<
action_type: :create,
attributes: %{},
relationships: %{},
errors: [
%Ash.Error.Changes.InvalidAttribute{
class: :invalid,
field: :email,
message: {"must match the pattern %{regex}",
[
regex: "~r/^[\\w.!#$%&’*+\\-\\/=?\\^`{|}~]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$/i"
]},
path: [],
stacktrace: #Stacktrace<>
}
],
data: %MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: nil,
id: nil
},
valid?: false
>
```
## Add your data_layer
To be able to store and later on read your resources, a _data layer_ is required. See the documentation for the one you'd like to useThe current supported data layers are
You can choose a `data_layer`, and see its documentation for configuring it:
| Storage | Datalayer | Documentation | Storage Documentation |
|---|---| --- | --- |
| postgres | AshPostgres.DataLayer | [Documentation](https://hexdocs.pm/ash_postgres) | [Storage Documentation](https://www.postgresql.org/docs/)
| ets | Ash.DataLayer.Ets | [Documentation](https://hexdocs.pm/ash/Ash.DataLayer.Ets.html) | [Storage Documentation](https://erlang.org/doc/man/ets.html) |
| mnesia | Ash.DataLayer.Mnesia | [Documentation](https://hexdocs.pm/ash/Ash.DataLayer.Mnesia.html) | [Storage Documentation](https://erlang.org/doc/man/mnesia.html) |
| csv | AshCsv.DataLayer | [Documentation](https://hexdocs.pm/ash_csv) | [Storage Documentation](https://en.wikipedia.org/wiki/Comma-separated_values)
To add a `data_layer`, add it to the `use Ash.Resource` statement. In this case we are going to use `ETS` which is a in memory data layer good enough for testing purposes. Also we will make the ETS private so Read/Write limited
to owner process.
```elixir
# in both lib/my_app/resources/user.ex
# and lib/my_app/resources/tweet.ex
use Ash.Resource, data_layer: Ash.DataLayer.Ets
```
## Add actions to enable functionality
Currently, actions do not offer any customization, but eventually they will be the primary driver for adding specific interactions to your resource. For now, to enable all of them, add the following to your resource:
Actions are the primary driver for adding specific interactions to your resource.
You can read the [actions](https://hexdocs.pm/ash/Ash.Resource.Dsl.html#actions/1
) section to learn to to customize the functionality
for now we will enable all of them with a default implementations by adding
following to your resource:
```elixir
actions do
create :default
read :default
update :default
destroy :default
end
# in both lib/my_app/resources/user.ex
# and lib/my_app/resources/tweet.ex
actions do
create :default
read :default
update :default
destroy :default
end
```
### Test functionality
Now you should be able to use you API to do CRUD operations in your resources
#### Create resource
```elixir
iex(1)> user_changeset = Ash.Changeset.new(MyApp.User, %{email: "ash.man@enguento.co
m"})
#Ash.Changeset<
action_type: :create,
attributes: %{email: "ash.man@enguento.com"},
relationships: %{},
errors: [],
data: %MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: nil,
id: nil
},
valid?: true
>
iex(2)> MyApp.Api.create(user_changeset)
{:ok,
%MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: "ash.man@enguento.com",
id: "2642ca11-330b-4a07-83c7-b0e9ef391df6"
}}
```
##### List and Read a resource
```elixir
iex(3)> MyApp.Api.read MyApp.User
{:ok,
[
%MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: "ash.man@enguento.com",
id: "2642ca11-330b-4a07-83c7-b0e9ef391df6"
}
]}
iex(4)> MyApp.Api.get(MyApp.User, "ash.man@enguento.com")
{:ok,
%MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: "ash.man@enguento.com",
id: "2642ca11-330b-4a07-83c7-b0e9ef391df6"
}}
```
## Add relationships
Now with our resources stored in a data layer we can move on
to create a relationship between them. In this case we will
specify that a `User` can have many `Tweet` this implies that
a tweet belongs to a specific user.
```elixir
# in lib/my_app/resources/user.ex
relationships do
has_many :tweets, MyApp.Tweet, destination_field: :user_id
end
# in lib/my_app/resources/tweet.ex
relationships do
belongs_to :user, MyApp.User
end
```
### Test relationships
Now we can use the new relationships to create a tweet that belongs to a specific user:
```elixir
iex(8)> {:ok, user} = Ash.Changeset.new(MyApp.User, %{email: "ash.man@enguento.com"}) |> MyApp.Api.create()
{:ok,
%MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: "ash.man@enguento.com",
id: "0d7063f8-b07c-4d02-88b2-b671f1aa0ad9",
tweets: #Ash.NotLoaded<:relationship>
}}
iex(9)> MyApp.Tweet |> Ash.Changeset.new(%{body: "ashy slashy"}) |> Ash.Changeset.replace_relationship(:user, user) |> MyApp.Api.create()
{:ok,
%MyApp.Tweet{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
body: "ashy slashy",
calculations: %{},
created_at: ~U[2020-11-14 12:54:06Z],
id: "f0b0b9d5-832c-45c9-9313-5e3fb9f1af24",
public: false,
updated_at: ~U[2020-11-14 12:54:06Z],
user: %MyApp.User{
__meta__: #Ecto.Schema.Metadata<:built, "">,
__metadata__: %{},
aggregates: %{},
calculations: %{},
email: "ash.man@enguento.com",
id: "0d7063f8-b07c-4d02-88b2-b671f1aa0ad9",
tweets: #Ash.NotLoaded<:relationship>
},
user_id: "0d7063f8-b07c-4d02-88b2-b671f1aa0ad9"
}}
```
## Add front end extensions