First, use AbsintheClient, passing your schema and
-notifying Absinthe to operate in internal mode:
defmodule MyAppWeb.UserController do
+notifying Absinthe to operate in internal mode:defmodule MyAppWeb.UserController do
use MyAppWeb, :controller
- use AbsintheClient, schema: MyAppWeb.Schema, action: [mode: :internal]
+ use AbsintheClient, schema: MyAppWeb.Schema, action: [mode: :internal]
# ... actions
-end
For each action you want Absinthe to process, provide a GraphQL document using
+
endFor each action you want Absinthe to process, provide a GraphQL document using
the @graphql module attribute (before the action):
@graphql """
query ($filter: UserFilter) {
users(filter: $filter, limit: 10)
}
"""
-def index(conn_or_socket, %{data: data}) do
+def index(conn_or_socket, %{data: data}) do
render conn_or_socket, "index.html", data
-endThe params for the action will be intercepted by the +end
The params for the action will be intercepted by the
AbsintheClient.Action plug, and used as variables for
the GraphQL document you've specified.
For instance, given a definition for a :user_filter input object
-type like this:
input_object :user_filter do
+type like this:input_object :user_filter do
field :name_matches, :string
field :age_above, :integer
field :age_below, :integer
-end
And a query that looks like this (assuming you have the normal
-Plug.Parsers configuration for param parsing):
?filter[name_matches]=joe&filter[age_above]=42
Then Absinthe will receive variable definitions of:
%{"filter" => %{"name_matches" => "joe", "age_above" => 42}}
(For how the string "42" was converted into 42, see cast_param/3).
The params on the conn_or_socket will then be replaced by the result of the
+
endAnd a query that looks like this (assuming you have the normal
+Plug.Parsers configuration for param parsing):
?filter[name_matches]=joe&filter[age_above]=42Then Absinthe will receive variable definitions of:
%{"filter" => %{"name_matches" => "joe", "age_above" => 42}}(For how the string "42" was converted into 42, see cast_param/3).
The params on the conn_or_socket will then be replaced by the result of the
execution by Absinthe. The action function can then match against
that result to respond correctly to the user:
It's up to you to handle the three possible results:
:data but no :errors, everything went perfectly.:errors but no :data, a validation error occurred and the document could not be
executed.:data and :errors, partial data is available but some fields reported errors
@@ -200,9 +200,9 @@ The template can then use users as needed:
<ul>
- <%= for user <- @users do %>
- <li><%= link user.full_name, to: user_path(@conn_or_socket, :show, user) %></li>
- <% end %>
+ <%= for user <- @users do %>
+ <li><%= link user.full_name, to: user_path(@conn_or_socket, :show, user) %></li>
+ <% end %>
</ul>This is useful for Phoenix.HTML helper functions that expect
structs with specific fields (especially form_for).
One way to think of this change is that, for objects, no selection set is equivalent to a "splat" operator (except, of course, even diff --git a/ActivityPub.Actor.html b/ActivityPub.Actor.html index b2ef9fc50d..44684d9469 100644 --- a/ActivityPub.Actor.html +++ b/ActivityPub.Actor.html @@ -5,10 +5,10 @@ - + -
Perform a DELETE request.
See request/1 or request/2 for options definition.
delete("/users")
-delete("/users", query: [scope: "admin"])
-delete(client, "/users")
-delete(client, "/users", query: [scope: "admin"])
-delete(client, "/users", body: %{name: "Jon"})Perform a DELETE request.
See request/1 or request/2 for options definition.
delete("/users")
+delete("/users", query: [scope: "admin"])
+delete(client, "/users")
+delete(client, "/users", query: [scope: "admin"])
+delete(client, "/users", body: %{name: "Jon"})Perform a DELETE request.
See request!/1 or request!/2 for options definition.
delete!("/users")
-delete!("/users", query: [scope: "admin"])
-delete!(client, "/users")
-delete!(client, "/users", query: [scope: "admin"])
-delete!(client, "/users", body: %{name: "Jon"})Perform a DELETE request.
See request!/1 or request!/2 for options definition.
delete!("/users")
+delete!("/users", query: [scope: "admin"])
+delete!(client, "/users")
+delete!(client, "/users", query: [scope: "admin"])
+delete!(client, "/users", body: %{name: "Jon"})Perform a GET request.
See request/1 or request/2 for options definition.
get("/users")
-get("/users", query: [scope: "admin"])
-get(client, "/users")
-get(client, "/users", query: [scope: "admin"])
-get(client, "/users", body: %{name: "Jon"})Perform a GET request.
See request/1 or request/2 for options definition.
get("/users")
+get("/users", query: [scope: "admin"])
+get(client, "/users")
+get(client, "/users", query: [scope: "admin"])
+get(client, "/users", body: %{name: "Jon"})Perform a GET request.
See request!/1 or request!/2 for options definition.
get!("/users")
-get!("/users", query: [scope: "admin"])
-get!(client, "/users")
-get!(client, "/users", query: [scope: "admin"])
-get!(client, "/users", body: %{name: "Jon"})Perform a GET request.
See request!/1 or request!/2 for options definition.
get!("/users")
+get!("/users", query: [scope: "admin"])
+get!(client, "/users")
+get!(client, "/users", query: [scope: "admin"])
+get!(client, "/users", body: %{name: "Jon"})Perform a HEAD request.
See request/1 or request/2 for options definition.
head("/users")
-head("/users", query: [scope: "admin"])
-head(client, "/users")
-head(client, "/users", query: [scope: "admin"])
-head(client, "/users", body: %{name: "Jon"})Perform a HEAD request.
See request/1 or request/2 for options definition.
head("/users")
+head("/users", query: [scope: "admin"])
+head(client, "/users")
+head(client, "/users", query: [scope: "admin"])
+head(client, "/users", body: %{name: "Jon"})Perform a HEAD request.
See request!/1 or request!/2 for options definition.
head!("/users")
-head!("/users", query: [scope: "admin"])
-head!(client, "/users")
-head!(client, "/users", query: [scope: "admin"])
-head!(client, "/users", body: %{name: "Jon"})Perform a HEAD request.
See request!/1 or request!/2 for options definition.
head!("/users")
+head!("/users", query: [scope: "admin"])
+head!(client, "/users")
+head!(client, "/users", query: [scope: "admin"])
+head!(client, "/users", body: %{name: "Jon"})Perform a OPTIONS request.
See request/1 or request/2 for options definition.
options("/users")
-options("/users", query: [scope: "admin"])
-options(client, "/users")
-options(client, "/users", query: [scope: "admin"])
-options(client, "/users", body: %{name: "Jon"})Perform a OPTIONS request.
See request/1 or request/2 for options definition.
options("/users")
+options("/users", query: [scope: "admin"])
+options(client, "/users")
+options(client, "/users", query: [scope: "admin"])
+options(client, "/users", body: %{name: "Jon"})Perform a OPTIONS request.
See request!/1 or request!/2 for options definition.
options!("/users")
-options!("/users", query: [scope: "admin"])
-options!(client, "/users")
-options!(client, "/users", query: [scope: "admin"])
-options!(client, "/users", body: %{name: "Jon"})Perform a OPTIONS request.
See request!/1 or request!/2 for options definition.
options!("/users")
+options!("/users", query: [scope: "admin"])
+options!(client, "/users")
+options!(client, "/users", query: [scope: "admin"])
+options!(client, "/users", body: %{name: "Jon"})Perform a PATCH request.
See request/1 or request/2 for options definition.
patch("/users", %{name: "Jon"})
-patch("/users", %{name: "Jon"}, query: [scope: "admin"])
-patch(client, "/users", %{name: "Jon"})
-patch(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PATCH request.
See request/1 or request/2 for options definition.
patch("/users", %{name: "Jon"})
+patch("/users", %{name: "Jon"}, query: [scope: "admin"])
+patch(client, "/users", %{name: "Jon"})
+patch(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PATCH request.
See request!/1 or request!/2 for options definition.
patch!("/users", %{name: "Jon"})
-patch!("/users", %{name: "Jon"}, query: [scope: "admin"])
-patch!(client, "/users", %{name: "Jon"})
-patch!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PATCH request.
See request!/1 or request!/2 for options definition.
patch!("/users", %{name: "Jon"})
+patch!("/users", %{name: "Jon"}, query: [scope: "admin"])
+patch!(client, "/users", %{name: "Jon"})
+patch!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a POST request.
See request/1 or request/2 for options definition.
post("/users", %{name: "Jon"})
-post("/users", %{name: "Jon"}, query: [scope: "admin"])
-post(client, "/users", %{name: "Jon"})
-post(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a POST request.
See request/1 or request/2 for options definition.
post("/users", %{name: "Jon"})
+post("/users", %{name: "Jon"}, query: [scope: "admin"])
+post(client, "/users", %{name: "Jon"})
+post(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a POST request.
See request!/1 or request!/2 for options definition.
post!("/users", %{name: "Jon"})
-post!("/users", %{name: "Jon"}, query: [scope: "admin"])
-post!(client, "/users", %{name: "Jon"})
-post!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a POST request.
See request!/1 or request!/2 for options definition.
post!("/users", %{name: "Jon"})
+post!("/users", %{name: "Jon"}, query: [scope: "admin"])
+post!(client, "/users", %{name: "Jon"})
+post!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PUT request.
See request/1 or request/2 for options definition.
put("/users", %{name: "Jon"})
-put("/users", %{name: "Jon"}, query: [scope: "admin"])
-put(client, "/users", %{name: "Jon"})
-put(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PUT request.
See request/1 or request/2 for options definition.
put("/users", %{name: "Jon"})
+put("/users", %{name: "Jon"}, query: [scope: "admin"])
+put(client, "/users", %{name: "Jon"})
+put(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PUT request.
See request!/1 or request!/2 for options definition.
put!("/users", %{name: "Jon"})
-put!("/users", %{name: "Jon"}, query: [scope: "admin"])
-put!(client, "/users", %{name: "Jon"})
-put!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])Perform a PUT request.
See request!/1 or request!/2 for options definition.
put!("/users", %{name: "Jon"})
+put!("/users", %{name: "Jon"}, query: [scope: "admin"])
+put!(client, "/users", %{name: "Jon"})
+put!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])ExampleApi.request(method: :get, url: "/users/path")
+ExampleApi.request(method: :get, url: "/users/path")
# use shortcut methods
-ExampleApi.get("/users/1")
-ExampleApi.post(client, "/users", %{name: "Jon"})
+ExampleApi.get("/users/1")
+ExampleApi.post(client, "/users", %{name: "Jon"})Perform a TRACE request.
See request/1 or request/2 for options definition.
trace("/users")
-trace("/users", query: [scope: "admin"])
-trace(client, "/users")
-trace(client, "/users", query: [scope: "admin"])
-trace(client, "/users", body: %{name: "Jon"})Perform a TRACE request.
See request/1 or request/2 for options definition.
trace("/users")
+trace("/users", query: [scope: "admin"])
+trace(client, "/users")
+trace(client, "/users", query: [scope: "admin"])
+trace(client, "/users", body: %{name: "Jon"})Perform a TRACE request.
See request!/1 or request!/2 for options definition.
trace!("/users")
-trace!("/users", query: [scope: "admin"])
-trace!(client, "/users")
-trace!(client, "/users", query: [scope: "admin"])
-trace!(client, "/users", body: %{name: "Jon"})Perform a TRACE request.
See request!/1 or request!/2 for options definition.
trace!("/users")
+trace!("/users", query: [scope: "admin"])
+trace!(client, "/users")
+trace!(client, "/users", query: [scope: "admin"])
+trace!(client, "/users", body: %{name: "Jon"})Filter activities depending on their origin instance or other criteria.
SimplePolicy is capable of handling most common admin tasks.
To use SimplePolicy, you must enable it. Do so by adding the following to your :instance config object, so that it looks like this:
config :bonfire, :instance,
- [...]
+ [...]
rewrite_policy: ActivityPub.MRF.SimplePolicyOnce SimplePolicy is enabled, you can configure various groups in the :mrf_simple config object. These groups are:
media_removal: Servers in this group will have media stripped from incoming messages.media_nsfw: Servers in this group will have the #nsfw tag and sensitive setting injected into incoming messages which contain media.reject: Servers in this group will have their messages rejected.report_removal: Servers in this group will have their reports (flags) rejected.Servers should be configured as lists.
This example will enable SimplePolicy, block media from illegalporn.biz, mark media as NSFW from porn.biz and porn.business, reject messages from spam.com and block reports (flags) from troll.mob:
config :activity_pub, :instance,
- rewrite_policy: [ActivityPub.MRF.SimplePolicy]
+ rewrite_policy: [ActivityPub.MRF.SimplePolicy]
config :activity_pub, :mrf_simple,
- media_removal: ["illegalporn.biz"],
- media_nsfw: ["porn.biz", "porn.business"],
- reject: ["spam.com"],
- report_removal: ["troll.mob"]
+ media_removal: ["illegalporn.biz"],
+ media_nsfw: ["porn.biz", "porn.business"],
+ reject: ["spam.com"],
+ report_removal: ["troll.mob"]
As discussed above, the MRF system is a modular system that supports pluggable policies. This means that an admin may write a custom MRF policy in Elixir or any other language that runs on the Erlang VM, by specifying the module name in the rewrite_policy config setting.
For example, here is a sample policy module which rewrites all messages to "new message content":
# This is a sample MRF policy which rewrites all Notes to have "new message
# content."
-defmodule Site.RewritePolicy do
+defmodule Site.RewritePolicy do
@behavior ActivityPub.MRF
# Catch messages which contain Note objects with actual data to filter.
# Capture the object as `object`, the message content as `content` and the
# entire activity itself as `activity`.
@impl true
- def filter(%{"type" => "Create", "object" => %{"type" => "Note", "content" => content} = object} = message)
- when is_binary(content) do
+ def filter(%{"type" => "Create", "object" => %{"type" => "Note", "content" => content} = object} = message)
+ when is_binary(content) do
# Subject / CW is stored as summary instead of `name` like other AS2 objects
# because of Mastodon doing it that way.
- summary = object["summary"]
+ summary = object["summary"]
# edits go here.
content = "new message content"
@@ -171,21 +171,21 @@
# Assemble the mutated object.
object =
object
- |> Map.put("content", content)
- |> Map.put("summary", summary)
+ |> Map.put("content", content)
+ |> Map.put("summary", summary)
# Assemble the mutated activity.
- {:ok, Map.put(activity, "object", object)}
- end
+ {:ok, Map.put(activity, "object", object)}
+ end
# Let all other messages through without modifying them.
@impl true
- def filter(message), do: {:ok, message}
-endIf you save this file as lib/site/mrf/rewrite_policy.ex, it will be included when you next rebuild Bonfire. You can enable it in the configuration like so:
config :activity_pub, :instance,
- rewrite_policy: [
+ def filter(message), do: {:ok, message}
+endIf you save this file as lib/site/mrf/rewrite_policy.ex, it will be included when you next rebuild Bonfire. You can enable it in the configuration like so:
config :activity_pub, :instance,
+ rewrite_policy: [
ActivityPub.MRF.SimplePolicy,
Site.RewritePolicy
- ]mix.exsdefp deps do
- [...]
- {:activity_pub, git: "https://github.com/bonfire-networks/activity_pub.git", branch: "stable"} # branch can "stable", or "develop" for the bleeding edge
-endlib/my_app/adapter.ex might look likedefmodule MyApp.Adapter do
+- Add this library to your dependencies in
mix.exs
defp deps do
+ [...]
+ {:activity_pub, git: "https://github.com/bonfire-networks/activity_pub.git", branch: "stable"} # branch can "stable", or "develop" for the bleeding edge
+end
- Create an adapter module. To start, one created at
+
lib/my_app/adapter.ex might look like
defmodule MyApp.Adapter do
@moduledoc """
Adapter functions delegated from the `ActivityPub` Library
"""
@behaviour ActivityPub.Federator.Adapter
-end
Note that, due to the defined @behavior, Elixir will warn you that
+
endNote that, due to the defined @behavior, Elixir will warn you that
the required functions
base_url/0get_actor_by_id/1get_actor_by_username/1get_follower_local_ids/1get_following_local_ids/1get_redirect_url/1handle_activity/1maybe_create_remote_actor/1maybe_publish_object/2update_local_actor/2update_remote_actor/1have not yet been implemented though you will be able to start your
app. Defining these allows ActivityPub to handle ActivityPub HTTP
and database calls and operations. An example of an implemented
adaptor can be found
here.
Then set it in config
config :activity_pub, :adapter, MyApp.Adapterconfig :activity_pub, :repo, MyApp.RepoCreate a new ecto migration and call ActivityPub.Migration.up/0 from it
Inject AP routes to your router by adding use ActivityPub.Web.Router to your app's router module
Copy the default AP config to your app's confix.exs
config :activity_pub, :mrf_simple,
- media_removal: [],
- media_nsfw: [],
- report_removal: [],
- accept: [],
- avatar_removal: [],
- banner_removal: []
+ media_removal: [],
+ media_nsfw: [],
+ report_removal: [],
+ accept: [],
+ avatar_removal: [],
+ banner_removal: []
config :activity_pub, :instance,
hostname: "example.com",
- federation_publisher_modules: [ActivityPub.Federator.APPublisher],
+ federation_publisher_modules: [ActivityPub.Federator.APPublisher],
federation_reachability_timeout_days: 7,
federating: true,
- rewrite_policy: []
+ rewrite_policy: []
config :activity_pub, :http,
proxy_url: nil,
user_agent: "Your app name",
send_user_agent: true,
- adapter: [
- ssl_options: [
+ adapter: [
+ ssl_options: [
# Workaround for remote server certificate chain issues
partial_chain: &:hackney_connect.partial_chain/1,
# We don't support TLS v1.3 yet
- versions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
- ]
- ]Change the hostname value in the instance config block to your instance's hostname
If you don't already have Oban set up, follow the Oban installation intructions and add the AP queues:
config :my_app, Oban, queues: [federator_incoming: 50, federator_outgoing: 50, remote_fetcher: 20]Now you should be able to compile and run your app and move over to integration.
This module is the entrypoint to the ActivityPub API for processing incoming and outgoing federated objects (normalising, saving the the Object storage, passing them to the adapter, and queueing outgoing activities to be pushed out).
In general, the functions in this module take object-like map. + versions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"] + ] + ]
Change the hostname value in the instance config block to your instance's hostname
If you don't already have Oban set up, follow the Oban installation intructions and add the AP queues:
config :my_app, Oban, queues: [federator_incoming: 50, federator_outgoing: 50, remote_fetcher: 20]Now you should be able to compile and run your app and move over to integration.
This module is the entrypoint to the ActivityPub API for processing incoming and outgoing federated objects (normalising, saving the the Object storage, passing them to the adapter, and queueing outgoing activities to be pushed out).
In general, the functions in this module take object-like map.
That includes a struct as the input for actor parameters. Use the functions in the ActivityPub.Actor module (ActivityPub.Actor.get_cached/1 for example) to retrieve those.
The package can be installed by adding arrows to your list of dependencies in mix.exs:
def deps do
- [
- {:arrows, "~> 0.2.0"}
- ]
-endOr via git:
def deps do
- [
- {:arrows, git: "https://github.com/bonfire-networks/arrows", branch: "main"}
- ]
-endThe package can be installed by adding arrows to your list of dependencies in mix.exs:
def deps do
+ [
+ {:arrows, "~> 0.2.0"}
+ ]
+endOr via git:
def deps do
+ [
+ {:arrows, git: "https://github.com/bonfire-networks/arrows", branch: "main"}
+ ]
+endThe Elixir |> ("pipe") operator is one of the things that seems to get people excited about elixir. Probably in part because you then don't have to keep coming up with function names. Unfortunately it's kind of limiting. -The moment you need to pipe a parameter into a position that isn't the first one, it breaks down and you have to drop out of the pipeline format or write a secondary function to handle it.
Not any more! By simply inserting ... where you would like the value to be inserted, Arrows will override where it is placed. This allows you to keep on piping while accommodating that function with the annoying argument order. Arrows was inspired by an existing library.
Here is part of the test suite in lieu of examples:
defmodule ArrowsTest do
+The moment you need to pipe a parameter into a position that isn't the first one, it breaks down and you have to drop out of the pipeline format or write a secondary function to handle it.Not any more! By simply inserting ... where you would like the value to be inserted, Arrows will override where it is placed. This allows you to keep on piping while accommodating that function with the annoying argument order. Arrows was inspired by an existing library.
Here is part of the test suite in lieu of examples:
defmodule ArrowsTest do
use ExUnit.Case
use Arrows
- def double(x), do: x * 2
- def double_fst(x, _), do: x * 2
- def double_snd(_, x), do: x * 2
- def add_snd_thd(_, x, y), do: x + y
-
- test "|>" do
- assert 4 == (2 |> double)
- assert 4 == (2 |> double())
- assert 4 == (2 |> double(...))
- assert 8 == (2 |> double(double(...)))
- assert 4 == (2 |> double_fst(1))
- assert 4 == (2 |> double_fst(..., 1))
- assert 8 == (2 |> double_fst(double(...), 1))
- assert 4 == (2 |> double_snd(1, ...))
- assert 8 == (2 |> double_snd(1, double(...)))
- assert 3 == (2 |> add_snd_thd(1, ..., 1))
- assert 4 == (2 |> add_snd_thd(1, ..., ...))
- assert 6 == (2 |> add_snd_thd(1, ..., double(...)))
- for x <- [:yes, 2, nil, false] do
- assert {:ok, x} == (x |> {:ok, ...})
- end
- end
-end
A few little extra features you might notice here:
- You can move the parameter into a subexpression, as in
2 |> double_fst(double(...), 1) where
+
def double(x), do: x * 2
+ def double_fst(x, _), do: x * 2
+ def double_snd(_, x), do: x * 2
+ def add_snd_thd(_, x, y), do: x + y
+
+ test "|>" do
+ assert 4 == (2 |> double)
+ assert 4 == (2 |> double())
+ assert 4 == (2 |> double(...))
+ assert 8 == (2 |> double(double(...)))
+ assert 4 == (2 |> double_fst(1))
+ assert 4 == (2 |> double_fst(..., 1))
+ assert 8 == (2 |> double_fst(double(...), 1))
+ assert 4 == (2 |> double_snd(1, ...))
+ assert 8 == (2 |> double_snd(1, double(...)))
+ assert 3 == (2 |> add_snd_thd(1, ..., 1))
+ assert 4 == (2 |> add_snd_thd(1, ..., ...))
+ assert 6 == (2 |> add_snd_thd(1, ..., double(...)))
+ for x <- [:yes, 2, nil, false] do
+ assert {:ok, x} == (x |> {:ok, ...})
+ end
+ end
+endA few little extra features you might notice here:
2 |> double_fst(double(...), 1) where
double will be called before the parameter is passed to double_fst.... multiple times, substituting it in multiple places.....iex> document_for(:user, 2)
+iex> document_for(:user, 2)
```
name
age
-posts {
+posts {
title
subtitle
-}
-comments {
+}
+comments {
body
-}
+}
```
diff --git a/Bonfire.API.GraphQL.ResolveField.html b/Bonfire.API.GraphQL.ResolveField.html
index 0f105c6a8a..59ae451f2d 100644
--- a/Bonfire.API.GraphQL.ResolveField.html
+++ b/Bonfire.API.GraphQL.ResolveField.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.ResolveField — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.ResolveField — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.ResolveField
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.ResolveFields.html b/Bonfire.API.GraphQL.ResolveFields.html
index 32b2f88a9d..eef4bf79c7 100644
--- a/Bonfire.API.GraphQL.ResolveFields.html
+++ b/Bonfire.API.GraphQL.ResolveFields.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.ResolveFields — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.ResolveFields — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.ResolveFields
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.ResolvePage.html b/Bonfire.API.GraphQL.ResolvePage.html
index 156f288378..70990ab08b 100644
--- a/Bonfire.API.GraphQL.ResolvePage.html
+++ b/Bonfire.API.GraphQL.ResolvePage.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.ResolvePage — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.ResolvePage — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.ResolvePage
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.ResolvePages.html b/Bonfire.API.GraphQL.ResolvePages.html
index a32f1562c6..d656651e7f 100644
--- a/Bonfire.API.GraphQL.ResolvePages.html
+++ b/Bonfire.API.GraphQL.ResolvePages.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.ResolvePages — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.ResolvePages — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.ResolvePages
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.ResolveRootPage.html b/Bonfire.API.GraphQL.ResolveRootPage.html
index 9fab8ae46b..379eb673fe 100644
--- a/Bonfire.API.GraphQL.ResolveRootPage.html
+++ b/Bonfire.API.GraphQL.ResolveRootPage.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.ResolveRootPage — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.ResolveRootPage — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.ResolveRootPage
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.RestAdapter.EndpointConfig.html b/Bonfire.API.GraphQL.RestAdapter.EndpointConfig.html
index 0ee3773866..5174e1dbe4 100644
--- a/Bonfire.API.GraphQL.RestAdapter.EndpointConfig.html
+++ b/Bonfire.API.GraphQL.RestAdapter.EndpointConfig.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.RestAdapter.EndpointConfig — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.RestAdapter.EndpointConfig — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.RestAdapter.EndpointConfig
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.RestAdapter.html b/Bonfire.API.GraphQL.RestAdapter.html
index b8600ab7f7..00e1fe32df 100644
--- a/Bonfire.API.GraphQL.RestAdapter.html
+++ b/Bonfire.API.GraphQL.RestAdapter.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.RestAdapter — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.RestAdapter — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.RestAdapter
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.Router.html b/Bonfire.API.GraphQL.Router.html
index 06a9b4451b..633ebc747c 100644
--- a/Bonfire.API.GraphQL.Router.html
+++ b/Bonfire.API.GraphQL.Router.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.Router — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.Router — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.Router
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.SchemaPipelines.html b/Bonfire.API.GraphQL.SchemaPipelines.html
index 08044984d6..e648b6c4d5 100644
--- a/Bonfire.API.GraphQL.SchemaPipelines.html
+++ b/Bonfire.API.GraphQL.SchemaPipelines.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.SchemaPipelines — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.SchemaPipelines — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.SchemaPipelines
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.SchemaUtils.html b/Bonfire.API.GraphQL.SchemaUtils.html
index 7985831b74..ae5eade167 100644
--- a/Bonfire.API.GraphQL.SchemaUtils.html
+++ b/Bonfire.API.GraphQL.SchemaUtils.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.SchemaUtils — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.SchemaUtils — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.SchemaUtils
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.Test.GraphQLAssertions.html b/Bonfire.API.GraphQL.Test.GraphQLAssertions.html
index 8e44d52e14..edb5761833 100644
--- a/Bonfire.API.GraphQL.Test.GraphQLAssertions.html
+++ b/Bonfire.API.GraphQL.Test.GraphQLAssertions.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.Test.GraphQLAssertions — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.Test.GraphQLAssertions — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.Test.GraphQLAssertions
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.UserSocket.html b/Bonfire.API.GraphQL.UserSocket.html
index fc0fe49923..eaf954c4a4 100644
--- a/Bonfire.API.GraphQL.UserSocket.html
+++ b/Bonfire.API.GraphQL.UserSocket.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL.UserSocket — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL.UserSocket — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL.UserSocket
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.API.GraphQL.html b/Bonfire.API.GraphQL.html
index 432db9819d..9503002c83 100644
--- a/Bonfire.API.GraphQL.html
+++ b/Bonfire.API.GraphQL.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.API.GraphQL — Bonfire v0.9.10-classic-beta.160
+ Bonfire.API.GraphQL — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.API.GraphQL
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -154,10 +154,10 @@
}Let's break this apart:
query {} is how you retrieve information from GraphQL.greetings is a field within the query.greetings takes a limit argument, a positive integer.greetings has two fields, greeting and to.to has one field, name.This query is asking for a list of (up to) 10 greetings and the people
they are for. Notice that the result of both greetings and to are
map/object structures with their own fields and that if the type has
-multiple fields, we can select more than one field.
Here is some possible data we could get returned
%{greetings: [
- %{greeting: "hello", to: %{ name: "dear reader"}}, # english
- %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
- ]}Where is the magic? Typically an object type will reside in its own +multiple fields, we can select more than one field.
Here is some possible data we could get returned
%{greetings: [
+ %{greeting: "hello", to: %{ name: "dear reader"}}, # english
+ %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
+ ]}Where is the magic? Typically an object type will reside in its own table in the database, so this query is actually querying two tables in one go. In fact, given a supporting schema, you can nest queries arbitrarily and the backend will figure out how to run them.
The fact that you can represent arbitrarily complex queries puts quite @@ -169,59 +169,59 @@
Every field is filled by a resolver. Let's take our existing query
-and define a schema for it in Absinthe's query DSL:
defmodule MyApp.Schema do
+and define a schema for it in Absinthe's query DSL:defmodule MyApp.Schema do
# the schema macro language
use Absinthe.Schema.Notation
# where we will actually resolve the fields
alias MyApp.Resolver
# Our user object is pretty simple, just a name
- object :user do
- field :name, non_null(:string)
- end
+ object :user do
+ field :name, non_null(:string)
+ end
# This one is slightly more complicated, we have that nested `to`
- object :greeting do
+ object :greeting do
# the easy one
- field :greeting, non_null(:string)
+ field :greeting, non_null(:string)
# the hard one. `edge` is the term for when we cross an object boundary.
- field :to, non_null(:user), do: resolve(&Resolver.to_edge/3)
- end
+ field :to, non_null(:user), do: resolve(&Resolver.to_edge/3)
+ end
# something to put our top level queries in, because they're just fields too!
- object :queries do
- field :greetings, non_null(list_of(non_null(:string))) do
+ object :queries do
+ field :greetings, non_null(list_of(non_null(:string))) do
arg :limit, :integer # optional
resolve &Resolver.greetings/2 # we need to manually process this one
- end
- end
+ end
+ end
-end
There are a couple of interesting things about this:
- Sprinklings of
not_null to require that values be present (if you
+
endThere are a couple of interesting things about this:
not_null to require that values be present (if you
don't return them, absinthe will get upset).greeting.to_edge has a /3 resolver and queries.greetings a
/2 resolver.To understand the last one (and partially the middle one), we must understand how resolution works and what a parent is. The best way of -doing that is probably to look at the resolver code:
defmodule MyApp.Resolver do
+doing that is probably to look at the resolver code:defmodule MyApp.Resolver do
# For purposes of this, we will just fake the data out
- defp greetings_data() do
- [ %{greeting: "hello", to: %{ name: "dear reader"}}, # english
- %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
- ]
- end
+ defp greetings_data() do
+ [ %{greeting: "hello", to: %{ name: "dear reader"}}, # english
+ %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
+ ]
+ end
# the /2 resolver takes only arguments (which in this case is just limit)
# and an info (which we'll explain later)
- def greetings(%{limit: limit}, _info) when is_integer(limit) and limit > 0 do
- {:ok, Enum.take(greetings_data(), limit)} # absinthe expects an ok/error tuple
- end
- def greetings(_args, _info), do: {:ok, greetings_data()} # no limit
+ def greetings(%{limit: limit}, _info) when is_integer(limit) and limit > 0 do
+ {:ok, Enum.take(greetings_data(), limit)} # absinthe expects an ok/error tuple
+ end
+ def greetings(_args, _info), do: {:ok, greetings_data()} # no limit
# the /3 resolver takes an additional parent argument in first position.
# `parent` here will be the `greeting` we are resolving `to` for.
- def to_edge(parent, args, info), do: Map.get(parent, :to)
+ def to_edge(parent, args, info), do: Map.get(parent, :to)
-end
The keen-eyed amongst you may have noticed I said the default resolver
+
endThe keen-eyed amongst you may have noticed I said the default resolver
is a map lookup and our to_edge/3 is a map lookup too, so
technically we didn't need to write it. But then you wouldn't have an
example of a /3 resolver! In most of the app, these will be querying
diff --git a/Bonfire.API.Graphql.html b/Bonfire.API.Graphql.html
index 0e9b644481..1bfb342bb5 100644
--- a/Bonfire.API.Graphql.html
+++ b/Bonfire.API.Graphql.html
@@ -5,10 +5,10 @@
-
+
-
Let's break this apart:
query {} is how you retrieve information from GraphQL.greetings is a field within the query.greetings takes a limit argument, a positive integer.greetings has two fields, greeting and to.to has one field, name.This query is asking for a list of (up to) 10 greetings and the people
they are for. Notice that the result of both greetings and to are
map/object structures with their own fields and that if the type has
-multiple fields, we can select more than one field.
Here is some possible data we could get returned
%{greetings: [
- %{greeting: "hello", to: %{ name: "dear reader"}}, # english
- %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
- ]}Where is the magic? Typically an object type will reside in its own +multiple fields, we can select more than one field.
Here is some possible data we could get returned
%{greetings: [
+ %{greeting: "hello", to: %{ name: "dear reader"}}, # english
+ %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
+ ]}Where is the magic? Typically an object type will reside in its own table in the database, so this query is actually querying two tables in one go. In fact, given a supporting schema, you can nest queries arbitrarily and the backend will figure out how to run them.
The fact that you can represent arbitrarily complex queries puts quite @@ -166,59 +166,59 @@
Every field is filled by a resolver. Let's take our existing query
-and define a schema for it in Absinthe's query DSL:
defmodule MyApp.Schema do
+and define a schema for it in Absinthe's query DSL:defmodule MyApp.Schema do
# the schema macro language
use Absinthe.Schema.Notation
# where we will actually resolve the fields
alias MyApp.Resolver
# Our user object is pretty simple, just a name
- object :user do
- field :name, non_null(:string)
- end
+ object :user do
+ field :name, non_null(:string)
+ end
# This one is slightly more complicated, we have that nested `to`
- object :greeting do
+ object :greeting do
# the easy one
- field :greeting, non_null(:string)
+ field :greeting, non_null(:string)
# the hard one. `edge` is the term for when we cross an object boundary.
- field :to, non_null(:user), do: resolve(&Resolver.to_edge/3)
- end
+ field :to, non_null(:user), do: resolve(&Resolver.to_edge/3)
+ end
# something to put our top level queries in, because they're just fields too!
- object :queries do
- field :greetings, non_null(list_of(non_null(:string))) do
+ object :queries do
+ field :greetings, non_null(list_of(non_null(:string))) do
arg :limit, :integer # optional
resolve &Resolver.greetings/2 # we need to manually process this one
- end
- end
+ end
+ end
-end
There are a couple of interesting things about this:
- Sprinklings of
not_null to require that values be present (if you
+
endThere are a couple of interesting things about this:
not_null to require that values be present (if you
don't return them, absinthe will get upset).greeting.to_edge has a /3 resolver and queries.greetings a
/2 resolver.To understand the last one (and partially the middle one), we must understand how resolution works and what a parent is. The best way of -doing that is probably to look at the resolver code:
defmodule MyApp.Resolver do
+doing that is probably to look at the resolver code:defmodule MyApp.Resolver do
# For purposes of this, we will just fake the data out
- defp greetings_data() do
- [ %{greeting: "hello", to: %{ name: "dear reader"}}, # english
- %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
- ]
- end
+ defp greetings_data() do
+ [ %{greeting: "hello", to: %{ name: "dear reader"}}, # english
+ %{greeting: "hallo", to: %{ name: "beste lezer"}}, # dutch
+ ]
+ end
# the /2 resolver takes only arguments (which in this case is just limit)
# and an info (which we'll explain later)
- def greetings(%{limit: limit}, _info) when is_integer(limit) and limit > 0 do
- {:ok, Enum.take(greetings_data(), limit)} # absinthe expects an ok/error tuple
- end
- def greetings(_args, _info), do: {:ok, greetings_data()} # no limit
+ def greetings(%{limit: limit}, _info) when is_integer(limit) and limit > 0 do
+ {:ok, Enum.take(greetings_data(), limit)} # absinthe expects an ok/error tuple
+ end
+ def greetings(_args, _info), do: {:ok, greetings_data()} # no limit
# the /3 resolver takes an additional parent argument in first position.
# `parent` here will be the `greeting` we are resolving `to` for.
- def to_edge(parent, args, info), do: Map.get(parent, :to)
+ def to_edge(parent, args, info), do: Map.get(parent, :to)
-end
The keen-eyed amongst you may have noticed I said the default resolver
+
endThe keen-eyed amongst you may have noticed I said the default resolver
is a map lookup and our to_edge/3 is a map lookup too, so
technically we didn't need to write it. But then you wouldn't have an
example of a /3 resolver! In most of the app, these will be querying
diff --git a/Bonfire.Boundaries.Acls.html b/Bonfire.Boundaries.Acls.html
index 25207ba678..5a46b8c6a5 100644
--- a/Bonfire.Boundaries.Acls.html
+++ b/Bonfire.Boundaries.Acls.html
@@ -5,10 +5,10 @@
-
+
-
iex> Bonfire.Boundaries.Acls.built_in_ids()
-["BUILT_IN_ACL_ID1", "BUILT_IN_ACL_ID2"]iex> Bonfire.Boundaries.Acls.built_in_ids()
+["BUILT_IN_ACL_ID1", "BUILT_IN_ACL_ID2"]iex> Bonfire.Boundaries.Acls.cast(changeset, creator, [boundary: "local"])iex> Bonfire.Boundaries.Acls.cast(changeset, creator, [boundary: "local"])iex> Bonfire.Boundaries.Acls.create(%{named: %{name: "New ACL"}}, current_user: user)
-{:ok, %Acl{}}iex> Bonfire.Boundaries.Acls.create(%{named: %{name: "New ACL"}}, current_user: user)
+{:ok, %Acl{}}iex> Bonfire.Boundaries.Acls.default_exclude_ids()
-["2HEYS11ENCEDMES0CAN0TSEEME", "7HECVST0MAC1F0RAN0BJECTETC", "71MAYADM1N1STERMY0WNSTVFFS", "0H0STEDCANTSEE0RD0ANYTH1NG", "1S11ENCEDTHEMS0CAN0TP1NGME"]iex> Bonfire.Boundaries.Acls.default_exclude_ids()
+["2HEYS11ENCEDMES0CAN0TSEEME", "7HECVST0MAC1F0RAN0BJECTETC", "71MAYADM1N1STERMY0WNSTVFFS", "0H0STEDCANTSEE0RD0ANYTH1NG", "1S11ENCEDTHEMS0CAN0TP1NGME"]iex> Bonfire.Boundaries.Acls.edit(acl_id, user, %{name: "Updated ACL"})
+iex> Bonfire.Boundaries.Acls.edit(acl_id, user, %{name: "Updated ACL"})
-iex> Bonfire.Boundaries.Acls.edit(%Acl{}, user, %{name: "Updated ACL"})
+iex> Bonfire.Boundaries.Acls.edit(%Acl{}, user, %{name: "Updated ACL"})iex> Bonfire.Boundaries.Acls.exclude_stereotypes()
-["2HEYS11ENCEDMES0CAN0TSEEME", "7HECVST0MAC1F0RAN0BJECTETC"]
+iex> Bonfire.Boundaries.Acls.exclude_stereotypes()
+["2HEYS11ENCEDMES0CAN0TSEEME", "7HECVST0MAC1F0RAN0BJECTETC"]
-iex> Bonfire.Boundaries.Acls.exclude_stereotypes(false)
-["2HEYS11ENCEDMES0CAN0TSEEME"]
+iex> Bonfire.Boundaries.Acls.exclude_stereotypes(false)
+["2HEYS11ENCEDMES0CAN0TSEEME"]iex> Bonfire.Boundaries.Acls.get(:instance_care)
+iex> Bonfire.Boundaries.Acls.get(:instance_care)
-iex> Bonfire.Boundaries.Acls.get(:non_existent)
+iex> Bonfire.Boundaries.Acls.get(:non_existent)
nil
iex> Bonfire.Boundaries.Acls.get_for_caretaker("ACL_ID", user)
-{:ok, %Acl{}}iex> Bonfire.Boundaries.Acls.get_for_caretaker("ACL_ID", user)
+{:ok, %Acl{}}iex> Bonfire.Boundaries.Acls.get_id(:instance_care)
+iex> Bonfire.Boundaries.Acls.get_id(:instance_care)
"01SETT1NGSF0R10CA11NSTANCE"
-iex> Bonfire.Boundaries.Acls.get_id(:non_existent)
+iex> Bonfire.Boundaries.Acls.get_id(:non_existent)
nil
iex> Bonfire.Boundaries.Acls.is_built_in?("BUILT_IN_ACL_ID")
+iex> Bonfire.Boundaries.Acls.is_built_in?("BUILT_IN_ACL_ID")
true
-iex> Bonfire.Boundaries.Acls.is_built_in?("CUSTOM_ACL_ID")
+iex> Bonfire.Boundaries.Acls.is_built_in?("CUSTOM_ACL_ID")
false
@@ -1232,10 +1232,10 @@ is_object_custom?(acl)
Examples
-iex> Bonfire.Boundaries.Acls.is_object_custom?(%Acl{stereotyped: %{stereotype_id: "CUSTOM_ACL_ID"}})
+iex> Bonfire.Boundaries.Acls.is_object_custom?(%Acl{stereotyped: %{stereotype_id: "CUSTOM_ACL_ID"}})
true
-iex> Bonfire.Boundaries.Acls.is_object_custom?(%Acl{})
+iex> Bonfire.Boundaries.Acls.is_object_custom?(%Acl{})
false
@@ -1286,13 +1286,13 @@ is_stereotyped?(acl)
Examples
-iex> Bonfire.Boundaries.Acls.is_stereotyped?(%Acl{stereotyped: %{stereotype_id: "STEREOTYPE_ID"}})
+iex> Bonfire.Boundaries.Acls.is_stereotyped?(%Acl{stereotyped: %{stereotype_id: "STEREOTYPE_ID"}})
true
-iex> Bonfire.Boundaries.Acls.is_stereotyped?("STEREOTYPE_ID")
+iex> Bonfire.Boundaries.Acls.is_stereotyped?("STEREOTYPE_ID")
true
-iex> Bonfire.Boundaries.Acls.is_stereotyped?(%Acl{})
+iex> Bonfire.Boundaries.Acls.is_stereotyped?(%Acl{})
false
@@ -1323,8 +1323,8 @@ list(opts \\ [])
Examples
-iex> Bonfire.Boundaries.Acls.list(current_user: user)
-[%Acl{}, %Acl{}]
+iex> Bonfire.Boundaries.Acls.list(current_user: user)
+[%Acl{}, %Acl{}]
@@ -1354,8 +1354,8 @@ list_built_ins(opts \\ [])
Examples
-iex> Bonfire.Boundaries.Acls.list_built_ins()
-[%Acl{}, %Acl{}]
+iex> Bonfire.Boundaries.Acls.list_built_ins()
+[%Acl{}, %Acl{}]
@@ -1387,8 +1387,8 @@ list_my(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Acls.list_my(user)
-[%Acl{}, %Acl{}]
+iex> Bonfire.Boundaries.Acls.list_my(user)
+[%Acl{}, %Acl{}]
@@ -1442,8 +1442,8 @@ list_my_with_counts(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Acls.list_my_with_counts(user)
-[%{acl: %Acl{}, grants_count: 5}, %{acl: %Acl{}, grants_count: 2}]
+iex> Bonfire.Boundaries.Acls.list_my_with_counts(user)
+[%{acl: %Acl{}, grants_count: 5}, %{acl: %Acl{}, grants_count: 2}]
@@ -1539,8 +1539,8 @@ opts_for_dropdown()
Examples
-iex> Bonfire.Boundaries.Acls.opts_for_dropdown()
-[exclude_ids: [...], extra_ids_to_include: [...]]
+iex> Bonfire.Boundaries.Acls.opts_for_dropdown()
+[exclude_ids: [...], extra_ids_to_include: [...]]
@@ -1568,8 +1568,8 @@ opts_for_list()
Examples
-iex> Bonfire.Boundaries.Acls.opts_for_list()
-[exclude_ids: [...]]
+iex> Bonfire.Boundaries.Acls.opts_for_list()
+[exclude_ids: [...]]
@@ -1665,17 +1665,17 @@ preview(creator, opts)
Examples
-iex> Bonfire.Boundaries.Acls.preview(creator, [
+iex> Bonfire.Boundaries.Acls.preview(creator, [
preview_for_id: object_id,
boundary: "mentions",
to_circles: mentioned_users_or_custom_circles
-])
+])
-iex> Bonfire.Boundaries.Acls.preview(creator, [
+iex> Bonfire.Boundaries.Acls.preview(creator, [
preview_for_id: object_id,
boundary: "clone_context",
context_id: context_object_id
-])
+])
@@ -1703,8 +1703,8 @@ remote_public_acl_ids()
Examples
-iex> Bonfire.Boundaries.Acls.remote_public_acl_ids()
-["5REM0TEPE0P1E1NTERACTREACT", "5REM0TEPE0P1E1NTERACTREP1Y", "7REM0TEACT0RSCANC0NTR1BVTE"]
+iex> Bonfire.Boundaries.Acls.remote_public_acl_ids()
+["5REM0TEPE0P1E1NTERACTREACT", "5REM0TEPE0P1E1NTERACTREP1Y", "7REM0TEACT0RSCANC0NTR1BVTE"]
@@ -1732,8 +1732,8 @@ set(object, creator, opts)
Examples
-iex> Bonfire.Boundaries.Acls.set(%{}, creator, [boundary: "local"])
-{:ok, :granted}
+iex> Bonfire.Boundaries.Acls.set(%{}, creator, [boundary: "local"])
+{:ok, :granted}
@@ -1761,8 +1761,8 @@ simple_create(caretaker, name)
Examples
-iex> Bonfire.Boundaries.Acls.simple_create(user, "My ACL")
-{:ok, %Acl{}}
+iex> Bonfire.Boundaries.Acls.simple_create(user, "My ACL")
+{:ok, %Acl{}}
@@ -1812,8 +1812,8 @@ stereotype_ids()
Examples
-iex> Bonfire.Boundaries.Acls.stereotype_ids()
-["STEREOTYPE_ACL_ID1", "STEREOTYPE_ACL_ID2"]
+iex> Bonfire.Boundaries.Acls.stereotype_ids()
+["STEREOTYPE_ACL_ID1", "STEREOTYPE_ACL_ID2"]
diff --git a/Bonfire.Boundaries.Acts.SetBoundaries.html b/Bonfire.Boundaries.Acts.SetBoundaries.html
index f92ead2753..0d5372d1fa 100644
--- a/Bonfire.Boundaries.Acts.SetBoundaries.html
+++ b/Bonfire.Boundaries.Acts.SetBoundaries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Acts.SetBoundaries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Acts.SetBoundaries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Acts.SetBoundaries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Blocks.LiveHandler.html b/Bonfire.Boundaries.Blocks.LiveHandler.html
index 438edf9ce7..45bb1e097c 100644
--- a/Bonfire.Boundaries.Blocks.LiveHandler.html
+++ b/Bonfire.Boundaries.Blocks.LiveHandler.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Blocks.LiveHandler — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Blocks.LiveHandler — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Blocks.LiveHandler
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Blocks.html b/Bonfire.Boundaries.Blocks.html
index 9abbc4bbaf..b86075df86 100644
--- a/Bonfire.Boundaries.Blocks.html
+++ b/Bonfire.Boundaries.Blocks.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Blocks — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Blocks — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Blocks
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -311,7 +311,7 @@ ap_receive_activity(blocker, activity, bloc
Examples
-iex> Bonfire.Boundaries.Blocks.ap_receive_activity(blocker, activity, blocked)
+iex> Bonfire.Boundaries.Blocks.ap_receive_activity(blocker, activity, blocked)
@@ -341,43 +341,43 @@ block(user_or_instance_to_block, block_type
Block a user for current user
-iex> Bonfire.Boundaries.Blocks.block(user, current_user: blocker)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.block(user, current_user: blocker)
+{:ok, "Blocked"}
Block a user for everyone on the instance (as an admin/mod)
-iex> Bonfire.Boundaries.Blocks.block(user, :instance_wide)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.block(user, :instance_wide)
+{:ok, "Blocked"}
Silence a user for current user
-iex> Bonfire.Boundaries.Blocks.block(user, :silence, current_user: blocker)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.block(user, :silence, current_user: blocker)
+{:ok, "Blocked"}
Silence a user for everyone on the instance (as an admin/mod)
-iex> Bonfire.Boundaries.Blocks.block(user, :silence, :instance_wide)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.block(user, :silence, :instance_wide)
+{:ok, "Blocked"}
Ghost a user for current user
-iex> Bonfire.Boundaries.Blocks.block(user, :ghost, current_user: blocker)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.block(user, :ghost, current_user: blocker)
+{:ok, "Blocked"}
Ghost a user for everyone on the instance (as an admin/mod)
-iex> Bonfire.Boundaries.Blocks.block(user, :ghost, :instance_wide)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.block(user, :ghost, :instance_wide)
+{:ok, "Blocked"}
@@ -429,8 +429,8 @@ instance_wide_block(user_or_instance_to_blo
Examples
-iex> Bonfire.Boundaries.Blocks.instance_wide_block(user, :ghost)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.instance_wide_block(user, :ghost)
+{:ok, "Blocked"}
@@ -484,10 +484,10 @@ is_blocked?(user_or_instance, block_type \\
Examples
-iex> Bonfire.Boundaries.Blocks.is_blocked?(instance, :ghost, current_user: checker)
+iex> Bonfire.Boundaries.Blocks.is_blocked?(instance, :ghost, current_user: checker)
false
-iex> Bonfire.Boundaries.Blocks.is_blocked?(user, :silence, :instance_wide)
+iex> Bonfire.Boundaries.Blocks.is_blocked?(user, :silence, :instance_wide)
true
@@ -516,11 +516,11 @@ list(block_type, opts)
Examples
-iex> Bonfire.Boundaries.Blocks.list(:ghost, :instance_wide)
-[%{id: "123", type: :ghost}, %{id: "456", type: :ghost}]
+iex> Bonfire.Boundaries.Blocks.list(:ghost, :instance_wide)
+[%{id: "123", type: :ghost}, %{id: "456", type: :ghost}]
-iex> Bonfire.Boundaries.Blocks.list(:silence, current_user: user)
-[%{id: "789", type: :silence}]
+iex> Bonfire.Boundaries.Blocks.list(:silence, current_user: user)
+[%{id: "789", type: :silence}]
@@ -548,15 +548,15 @@ remote_instance_block(display_hostname, blo
Block for current user
-iex> Bonfire.Boundaries.Blocks.remote_instance_block("example.com", :silence, current_user)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.remote_instance_block("example.com", :silence, current_user)
+{:ok, "Blocked"}
Block for everyone on the instance (as an admin/mod)
-iex> Bonfire.Boundaries.Blocks.remote_instance_block("example.com", :silence, :instance_wide)
-{:ok, "Blocked"}
+iex> Bonfire.Boundaries.Blocks.remote_instance_block("example.com", :silence, :instance_wide)
+{:ok, "Blocked"}
@@ -584,14 +584,14 @@ types_blocked(types)
Examples
-iex> Bonfire.Boundaries.Blocks.types_blocked([:ghost, :silence])
-[:ghost_them, :silence_them]
+iex> Bonfire.Boundaries.Blocks.types_blocked([:ghost, :silence])
+[:ghost_them, :silence_them]
-iex> Bonfire.Boundaries.Blocks.types_blocked(:ghost)
-[:ghost_them]
+iex> Bonfire.Boundaries.Blocks.types_blocked(:ghost)
+[:ghost_them]
-iex> Bonfire.Boundaries.Blocks.types_blocked(nil)
-[:silence_them, :ghost_them]
+iex> Bonfire.Boundaries.Blocks.types_blocked(nil)
+[:silence_them, :ghost_them]
@@ -621,11 +621,11 @@ unblock(user_or_instance_to_unblock, block_
Examples
-iex> Bonfire.Boundaries.Blocks.unblock(user, :ghost, current_user: unblocker)
-{:ok, "Unblocked"}
+iex> Bonfire.Boundaries.Blocks.unblock(user, :ghost, current_user: unblocker)
+{:ok, "Unblocked"}
-iex> Bonfire.Boundaries.Blocks.unblock(user, :silence, :instance_wide)
-{:ok, "Unblocked"}
+iex> Bonfire.Boundaries.Blocks.unblock(user, :silence, :instance_wide)
+{:ok, "Unblocked"}
@@ -655,8 +655,8 @@ unblock_all(block_type \\ nil, scope)
Examples
-iex> Bonfire.Boundaries.Blocks.unblock_all(:ghost, :instance_wide)
-{:ok, "All unblocked"}
+iex> Bonfire.Boundaries.Blocks.unblock_all(:ghost, :instance_wide)
+{:ok, "All unblocked"}
diff --git a/Bonfire.Boundaries.Circles.html b/Bonfire.Boundaries.Circles.html
index 773546ce9a..ccffc39f98 100644
--- a/Bonfire.Boundaries.Circles.html
+++ b/Bonfire.Boundaries.Circles.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Circles — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Circles — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Circles
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -581,11 +581,11 @@ add_to_circles(subjects, circles)
Examples
-iex> Bonfire.Boundaries.Circles.add_to_circles(user, circle)
-{:ok, %Encircle{}}
+iex> Bonfire.Boundaries.Circles.add_to_circles(user, circle)
+{:ok, %Encircle{}}
-iex> Bonfire.Boundaries.Circles.add_to_circles([user1, user2], [circle1, circle2])
-[{{:ok, %Encircle{}}, {:ok, %Encircle{}}}, {{:ok, %Encircle{}}, {:ok, %Encircle{}}}]
+iex> Bonfire.Boundaries.Circles.add_to_circles([user1, user2], [circle1, circle2])
+[{{:ok, %Encircle{}}, {:ok, %Encircle{}}}, {{:ok, %Encircle{}}, {:ok, %Encircle{}}}]
@@ -681,10 +681,10 @@ circle_ids(subjects)
Examples
-iex> Bonfire.Boundaries.Circles.circle_ids([:guest, :local])
-["guest_circle_id", "local_circle_id"]
+iex> Bonfire.Boundaries.Circles.circle_ids([:guest, :local])
+["guest_circle_id", "local_circle_id"]
-iex> Bonfire.Boundaries.Circles.circle_ids(%{id: "user_id"})
+iex> Bonfire.Boundaries.Circles.circle_ids(%{id: "user_id"})
"user_id"
@@ -735,8 +735,8 @@ create(user, attrs)
Examples
-iex> Bonfire.Boundaries.Circles.create(user, %{named: %{name: "My Circle"}})
-{:ok, %Circle{id: "new_circle_id", name: "My Circle"}}
+iex> Bonfire.Boundaries.Circles.create(user, %{named: %{name: "My Circle"}})
+{:ok, %Circle{id: "new_circle_id", name: "My Circle"}}
@@ -764,9 +764,9 @@ delete(circle, opts)
Examples
-iex> Bonfire.Boundaries.Circles.delete(circle, [current_user: user])
+iex> Bonfire.Boundaries.Circles.delete(circle, [current_user: user])
-iex> Bonfire.Boundaries.Circles.delete("circle_id", [current_user: user])
+iex> Bonfire.Boundaries.Circles.delete("circle_id", [current_user: user])
@@ -794,8 +794,8 @@ edit(circle, user, params)
Examples
-iex> Bonfire.Boundaries.Circles.edit(circle, user, %{name: "Updated Circle"})
-{:ok, %Circle{id: "circle_id", name: "Updated Circle"}}
+iex> Bonfire.Boundaries.Circles.edit(circle, user, %{name: "Updated Circle"})
+{:ok, %Circle{id: "circle_id", name: "Updated Circle"}}
@@ -823,8 +823,8 @@ empty_circles(circles)
Examples
-iex> Bonfire.Boundaries.Circles.empty_circles([circle1, circle2])
-{10, nil}
+iex> Bonfire.Boundaries.Circles.empty_circles([circle1, circle2])
+{10, nil}
@@ -876,11 +876,11 @@ get(slug)
Examples
-iex> Bonfire.Boundaries.Circles.get(:guest)
-%{id: "guest_circle_id", name: "Guest"}
+iex> Bonfire.Boundaries.Circles.get(:guest)
+%{id: "guest_circle_id", name: "Guest"}
-iex> Bonfire.Boundaries.Circles.get("circle_id")
-%Circle{id: "circle_id", name: "Custom Circle"}
+iex> Bonfire.Boundaries.Circles.get("circle_id")
+%Circle{id: "circle_id", name: "Custom Circle"}
@@ -930,8 +930,8 @@ get_by_name(name, caretaker)
Examples
-iex> Bonfire.Boundaries.Circles.get_by_name("My Circle", user)
-{:ok, %Circle{id: "circle_id", name: "My Circle"}}
+iex> Bonfire.Boundaries.Circles.get_by_name("My Circle", user)
+{:ok, %Circle{id: "circle_id", name: "My Circle"}}
@@ -961,8 +961,8 @@ get_for_caretaker(id, caretaker, opts \\ []
Examples
-iex> Bonfire.Boundaries.Circles.get_for_caretaker("circle_id", user)
-{:ok, %Circle{id: "circle_id", name: "My Circle"}}
+iex> Bonfire.Boundaries.Circles.get_for_caretaker("circle_id", user)
+{:ok, %Circle{id: "circle_id", name: "My Circle"}}
@@ -990,10 +990,10 @@ get_id(slug)
Examples
-iex> Bonfire.Boundaries.Circles.get_id(:guest)
+iex> Bonfire.Boundaries.Circles.get_id(:guest)
"guest_circle_id"
-iex> Bonfire.Boundaries.Circles.get_id(:nonexistent)
+iex> Bonfire.Boundaries.Circles.get_id(:nonexistent)
nil
@@ -1046,8 +1046,8 @@ get_or_create(name, caretaker \\ nil)
Examples
-iex> Bonfire.Boundaries.Circles.get_or_create("New Circle", user)
-{:ok, %Circle{id: "new_circle_id", name: "New Circle"}}
+iex> Bonfire.Boundaries.Circles.get_or_create("New Circle", user)
+{:ok, %Circle{id: "new_circle_id", name: "New Circle"}}
@@ -1075,8 +1075,8 @@ get_stereotype_circles(subject, stereotypes
Examples
-iex> Bonfire.Boundaries.Circles.get_stereotype_circles(user, [:follow, :block])
-[%Circle{id: "follow_circle_id", name: "Follow"}, %Circle{id: "block_circle_id", name: "Block"}]
+iex> Bonfire.Boundaries.Circles.get_stereotype_circles(user, [:follow, :block])
+[%Circle{id: "follow_circle_id", name: "Follow"}, %Circle{id: "block_circle_id", name: "Block"}]
@@ -1104,11 +1104,11 @@ get_tuple(slug)
Examples
-iex> Bonfire.Boundaries.Circles.get_tuple(:guest)
-{"Guest", "guest_circle_id"}
+iex> Bonfire.Boundaries.Circles.get_tuple(:guest)
+{"Guest", "guest_circle_id"}
-iex> Bonfire.Boundaries.Circles.get_tuple("circle_id")
-{:my_circle, %{id: "circle_id", name: "My Circle"}}
+iex> Bonfire.Boundaries.Circles.get_tuple("circle_id")
+{:my_circle, %{id: "circle_id", name: "My Circle"}}
@@ -1158,10 +1158,10 @@ is_encircled_by?(subject, circle)
Examples
-iex> Bonfire.Boundaries.Circles.is_encircled_by?(user, circle)
+iex> Bonfire.Boundaries.Circles.is_encircled_by?(user, circle)
true
-iex> Bonfire.Boundaries.Circles.is_encircled_by?(user, [circle1, circle2])
+iex> Bonfire.Boundaries.Circles.is_encircled_by?(user, [circle1, circle2])
false
@@ -1190,10 +1190,10 @@ is_stereotype?(acl)
Examples
-iex> Bonfire.Boundaries.Circles.is_stereotype?("7DAPE0P1E1PERM1TT0F0110WME")
+iex> Bonfire.Boundaries.Circles.is_stereotype?("7DAPE0P1E1PERM1TT0F0110WME")
true
-iex> Bonfire.Boundaries.Circles.is_stereotype?("custom_circle_id")
+iex> Bonfire.Boundaries.Circles.is_stereotype?("custom_circle_id")
false
@@ -1222,8 +1222,8 @@ leave_all_circles(users)
Examples
-iex> Bonfire.Boundaries.Circles.empty_circles([circle1, circle2])
-{10, nil}
+iex> Bonfire.Boundaries.Circles.empty_circles([circle1, circle2])
+{10, nil}
@@ -1251,8 +1251,8 @@ list_built_ins()
Examples
-iex> Bonfire.Boundaries.Circles.list_built_ins()
-[%Circle{id: "guest_circle_id", name: "Guest"}, %Circle{id: "local_circle_id", name: "Local"}]
+iex> Bonfire.Boundaries.Circles.list_built_ins()
+[%Circle{id: "guest_circle_id", name: "Guest"}, %Circle{id: "local_circle_id", name: "Local"}]
@@ -1280,8 +1280,8 @@ list_by_ids(ids)
Examples
-iex> Bonfire.Boundaries.Circles.list_by_ids(["circle_id1", "circle_id2"])
-[%Circle{id: "circle_id1", name: "Circle 1"}, %Circle{id: "circle_id2", name: "Circle 2"}]
+iex> Bonfire.Boundaries.Circles.list_by_ids(["circle_id1", "circle_id2"])
+[%Circle{id: "circle_id1", name: "Circle 1"}, %Circle{id: "circle_id2", name: "Circle 2"}]
@@ -1313,8 +1313,8 @@ list_my(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.list_my(user)
-[%Circle{id: "circle_id1", name: "My Circle 1"}, %Circle{id: "circle_id2", name: "My Circle 2"}]
+iex> Bonfire.Boundaries.Circles.list_my(user)
+[%Circle{id: "circle_id1", name: "My Circle 1"}, %Circle{id: "circle_id2", name: "My Circle 2"}]
@@ -1344,8 +1344,8 @@ list_my_defaults(user \\ nil)
Examples
-iex> Bonfire.Boundaries.Circles.list_my_defaults()
-[{"Guest", "guest_circle_id"}, {"Local", "local_circle_id"}, {"ActivityPub", "activity_pub_circle_id"}]
+iex> Bonfire.Boundaries.Circles.list_my_defaults()
+[{"Guest", "guest_circle_id"}, {"Local", "local_circle_id"}, {"ActivityPub", "activity_pub_circle_id"}]
@@ -1375,8 +1375,8 @@ list_my_with_counts(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.list_my_with_counts(user)
-[%Circle{id: "circle_id1", name: "My Circle", encircles_count: 5}]
+iex> Bonfire.Boundaries.Circles.list_my_with_counts(user)
+[%Circle{id: "circle_id1", name: "My Circle", encircles_count: 5}]
@@ -1406,8 +1406,8 @@ list_my_with_global(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.list_my_with_global(user)
-[%Circle{id: "circle_id1", name: "My Circle"}, %Circle{id: "global_circle_id", name: "Global Circle"}]
+iex> Bonfire.Boundaries.Circles.list_my_with_global(user)
+[%Circle{id: "circle_id1", name: "My Circle"}, %Circle{id: "global_circle_id", name: "Global Circle"}]
@@ -1437,8 +1437,8 @@ list_visible(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.list_visible(user)
-[%Circle{id: "circle_id1", name: "Circle 1"}, %Circle{id: "circle_id2", name: "Circle 2"}]
+iex> Bonfire.Boundaries.Circles.list_visible(user)
+[%Circle{id: "circle_id1", name: "Circle 1"}, %Circle{id: "circle_id2", name: "Circle 2"}]
@@ -1492,7 +1492,7 @@ query(opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.query(exclude_built_ins: true)
+iex> Bonfire.Boundaries.Circles.query(exclude_built_ins: true)
@@ -1522,7 +1522,7 @@ query_my(caretaker, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.query_my(user)
+iex> Bonfire.Boundaries.Circles.query_my(user)
@@ -1552,7 +1552,7 @@ query_my_by_id(id, caretaker, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.query_my_by_id("circle_id", user)
+iex> Bonfire.Boundaries.Circles.query_my_by_id("circle_id", user)
@@ -1582,8 +1582,8 @@ query_visible(user, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Circles.query_visible(user)
-#Ecto.Query<...>
+iex> Bonfire.Boundaries.Circles.query_visible(user)
+#Ecto.Query<...>
@@ -1611,11 +1611,11 @@ remove_from_circles(subject, circles)
Examples
-iex> Bonfire.Boundaries.Circles.remove_from_circles(user, circle)
-{1, nil}
+iex> Bonfire.Boundaries.Circles.remove_from_circles(user, circle)
+{1, nil}
-iex> Bonfire.Boundaries.Circles.remove_from_circles(user, [circle1, circle2])
-{2, nil}
+iex> Bonfire.Boundaries.Circles.remove_from_circles(user, [circle1, circle2])
+{2, nil}
@@ -1665,9 +1665,9 @@ stereotypes(atom)
Examples
-iex> Bonfire.Boundaries.Circles.stereotypes(:follow)
+iex> Bonfire.Boundaries.Circles.stereotypes(:follow)
-iex> Bonfire.Boundaries.Circles.stereotypes(:block)
+iex> Bonfire.Boundaries.Circles.stereotypes(:block)
@@ -1695,8 +1695,8 @@ to_circle_ids(subjects)
Examples
-iex> Bonfire.Boundaries.Circles.to_circle_ids([:guest, :custom])
-["guest_circle_id", "custom_circle_id", "local_circle_id", "activity_pub_circle_id"]
+iex> Bonfire.Boundaries.Circles.to_circle_ids([:guest, :custom])
+["guest_circle_id", "custom_circle_id", "local_circle_id", "activity_pub_circle_id"]
diff --git a/Bonfire.Boundaries.Controlleds.html b/Bonfire.Boundaries.Controlleds.html
index 59a21d684c..10a5bc0626 100644
--- a/Bonfire.Boundaries.Controlleds.html
+++ b/Bonfire.Boundaries.Controlleds.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Controlleds — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Controlleds — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Controlleds
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -324,8 +324,8 @@ add_acls(object, acl)
Examples
-iex> add_acls(object, :acl)
-{:ok, %Controlled{}}
+iex> add_acls(object, :acl)
+{:ok, %Controlled{}}
@@ -355,8 +355,8 @@ changeset(c \\ %Controlled{}, attrs)
Examples
-iex> changeset(%Controlled{}, %{field: value})
-%Ecto.Changeset{}
+iex> changeset(%Controlled{}, %{field: value})
+%Ecto.Changeset{}
@@ -384,8 +384,8 @@ create(attrs)
Examples
-iex> create(%{field: value})
-{:ok, %Controlled{}}
+iex> create(%{field: value})
+{:ok, %Controlled{}}
@@ -413,8 +413,8 @@ get_preset_on_object(object)
Examples
-iex> get_preset_on_object(object)
-%ACL{}
+iex> get_preset_on_object(object)
+%ACL{}
@@ -444,8 +444,8 @@ grant_role(subject_id, object, role, opts \
Examples
-iex> grant_role(subject_id, object, :editor)
-{:ok, %Grant{}}
+iex> grant_role(subject_id, object, :editor)
+{:ok, %Grant{}}
@@ -476,8 +476,8 @@ list_acls_on_object(object, opts \\ [])
Examples
-iex> list_acls_on_object(object)
-[%Acl{}]
+iex> list_acls_on_object(object)
+[%Acl{}]
@@ -507,9 +507,9 @@ list_grants_by_verbs(objects, verbs, value
Examples
-iex> list_grants_by_verbs(objects, :read)
+iex> list_grants_by_verbs(objects, :read)
-iex> list_grants_by_verbs(objects, :edit, false)
+iex> list_grants_by_verbs(objects, :edit, false)
@@ -540,8 +540,8 @@ list_on_object(object, opts \\ [])
Examples
-iex> list_on_object(object)
-[%Boundary{}]
+iex> list_on_object(object)
+[%Boundary{}]
@@ -569,8 +569,8 @@ list_on_objects_by_subject(objects, current
Examples
-iex> list_on_objects_by_subject(objects, current_user)
-%{object1_id => [%Acl{}], object2_id => [%Acl{}]}
+iex> list_on_objects_by_subject(objects, current_user)
+%{object1_id => [%Acl{}], object2_id => [%Acl{}]}
@@ -598,8 +598,8 @@ list_presets_on_objects(objects)
Examples
-iex> list_presets_on_objects(objects)
-%{object_id => %Preset{}}
+iex> list_presets_on_objects(objects)
+%{object_id => %Preset{}}
@@ -653,9 +653,9 @@ list_subjects_by_verb(objects, verb, value
Examples
-iex> list_subjects_by_verb(objects, :read)
+iex> list_subjects_by_verb(objects, :read)
-iex> list_subjects_by_verb(objects, :edit, false)
+iex> list_subjects_by_verb(objects, :edit, false)
@@ -683,7 +683,7 @@ remove_acls(object, acls)
Examples
-iex> remove_acls(object, acls)
+iex> remove_acls(object, acls)
diff --git a/Bonfire.Boundaries.Debug.html b/Bonfire.Boundaries.Debug.html
index c11c62c8fd..1751c58fac 100644
--- a/Bonfire.Boundaries.Debug.html
+++ b/Bonfire.Boundaries.Debug.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Debug — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Debug — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Debug
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -253,13 +253,13 @@ debug_grants_on(things)
Examples
-iex> Bonfire.Boundaries.Debug.debug_grants_on(things)
+iex> Bonfire.Boundaries.Debug.debug_grants_on(things)
+------------+------------+---------+-------+
| subject_id | object_id | verbs | value |
+------------+------------+---------+-------+
-| user_1 | object_1 | [read] | true |
-| user_2 | object_2 | [reply] | true |
-| user_2 | object_2 | [edit] | false |
+| user_1 | object_1 | [read] | true |
+| user_2 | object_2 | [reply] | true |
+| user_2 | object_2 | [edit] | false |
+------------+------------+---------+-------+
@@ -288,12 +288,12 @@ debug_grants_on(things, verbs)
Examples
-iex> Bonfire.Boundaries.Debug.debug_grants_on(things, [:read, :edit])
+iex> Bonfire.Boundaries.Debug.debug_grants_on(things, [:read, :edit])
+------------+------------+---------+-------+
| subject_id | object_id | verbs | value |
+------------+------------+---------+-------+
-| user_1 | object_1 | [read] | true |
-| user_2 | object_2 | [edit] | false |
+| user_1 | object_1 | [read] | true |
+| user_2 | object_2 | [edit] | false |
+------------+------------+---------+-------+
@@ -322,12 +322,12 @@ debug_my_grants_on(users, things)
Examples
-iex> Bonfire.Boundaries.Debug.debug_my_grants_on(users, things)
+iex> Bonfire.Boundaries.Debug.debug_my_grants_on(users, things)
+------------+------------+---------+-------+
| subject_id | object_id | verbs | value |
+------------+------------+---------+-------+
-| user_1 | object_1 | [read] | true |
-| user_2 | object_2 | [write] | false |
+| user_1 | object_1 | [read] | true |
+| user_2 | object_2 | [write] | false |
+------------+------------+---------+-------+
@@ -356,7 +356,7 @@ debug_object_acls(thing)
Examples
-iex> Bonfire.Boundaries.Debug.debug_object_acls(object)
+iex> Bonfire.Boundaries.Debug.debug_object_acls(object)
Object: object_id
+--------+----------+-----------+------------+---------------+-----------+
| acl_id | acl_name | acl_stereo| grant_verb | grant_subject | grant_value |
@@ -393,7 +393,7 @@ debug_user_acls(user, label \\ ""
Examples
-iex> Bonfire.Boundaries.Debug.debug_user_acls(user)
+iex> Bonfire.Boundaries.Debug.debug_user_acls(user)
user ACLs: user_id
+--------+----------+-----------+------------+---------------+-----------+
| acl_id | acl_name | acl_stereo| grant_verb | grant_subject | grant_value |
@@ -402,7 +402,7 @@ debug_user_acls(user, label \\ ""
| acl_2 | Public | null | write | Everyone | false |
+--------+----------+-----------+------------+---------------+-----------+
-iex> Bonfire.Boundaries.Debug.debug_user_acls(user, "Custom label")
+iex> Bonfire.Boundaries.Debug.debug_user_acls(user, "Custom label")
Custom label user ACLs: user_id
...
@@ -432,7 +432,7 @@ debug_user_circles(user)
Examples
-iex> Bonfire.Boundaries.Debug.debug_user_circles(user)
+iex> Bonfire.Boundaries.Debug.debug_user_circles(user)
User: user_id
+------------+------------+
| circle_id | circle_name|
diff --git a/Bonfire.Boundaries.Grants.html b/Bonfire.Boundaries.Grants.html
index 6910fafd16..23173a476e 100644
--- a/Bonfire.Boundaries.Grants.html
+++ b/Bonfire.Boundaries.Grants.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Grants — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Grants — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Grants
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -375,8 +375,8 @@ change_role(subject, acl_id, role, opts \\
Examples
-iex> Bonfire.Boundaries.Grants.change_role("subject_123", "acl_456", :admin, [])
-{:ok, %Grant{}}
+iex> Bonfire.Boundaries.Grants.change_role("subject_123", "acl_456", :admin, [])
+{:ok, %Grant{}}
@@ -406,8 +406,8 @@ create(attrs, opts \\ [])
Examples
-iex> Bonfire.Boundaries.Grants.create(%{subject_id: "123", acl_id: "456", verb_id: "789", value: true}, [])
-{:ok, %Grant{}}
+iex> Bonfire.Boundaries.Grants.create(%{subject_id: "123", acl_id: "456", verb_id: "789", value: true}, [])
+{:ok, %Grant{}}
@@ -435,7 +435,7 @@ get(slug)
Examples
-iex> Bonfire.Boundaries.Grants.get(:guests_may_see_read)
+iex> Bonfire.Boundaries.Grants.get(:guests_may_see_read)
@@ -465,7 +465,7 @@ grant(subject_id, acl_id, verb, value, opts
Examples
-iex> Bonfire.Boundaries.Grants.grant("subject_123", "acl_456", :read, true)
+iex> Bonfire.Boundaries.Grants.grant("subject_123", "acl_456", :read, true)
@@ -495,8 +495,8 @@ grant_role(subject, acl_id, role, opts \\ [
Examples
-iex> Bonfire.Boundaries.Grants.grant_role("subject_123", "acl_456", :admin, [])
-{:ok, %Grant{}}
+iex> Bonfire.Boundaries.Grants.grant_role("subject_123", "acl_456", :admin, [])
+{:ok, %Grant{}}
@@ -524,8 +524,8 @@ grants()
Examples
-iex> Bonfire.Boundaries.Grants.grants()
-%{}
+iex> Bonfire.Boundaries.Grants.grants()
+%{}
@@ -553,8 +553,8 @@ grants_to_tuples(creator, grants)
Examples
-iex> Bonfire.Boundaries.Grants.grants_to_tuples(%User{}, %{grants: [%Grant{}]})
-[{%User{}, :some_role}]
+iex> Bonfire.Boundaries.Grants.grants_to_tuples(%User{}, %{grants: [%Grant{}]})
+[{%User{}, :some_role}]
@@ -674,8 +674,8 @@ remove_role(subject, acl_id, role, opts \\
Examples
-iex> Bonfire.Boundaries.Grants.remove_role("subject_123", "acl_456", :admin, [])
-{:ok, %Grant{}}
+iex> Bonfire.Boundaries.Grants.remove_role("subject_123", "acl_456", :admin, [])
+{:ok, %Grant{}}
@@ -703,8 +703,8 @@ remove_subject_from_acl(subject, acls)
Examples
-iex> Bonfire.Boundaries.Grants.remove_subject_from_acl("subject_123", ["acl_456", "acl_789"])
-{:ok, %{}}
+iex> Bonfire.Boundaries.Grants.remove_subject_from_acl("subject_123", ["acl_456", "acl_789"])
+{:ok, %{}}
@@ -754,8 +754,8 @@ subject_verb_grants(grants)
Examples
-iex> Bonfire.Boundaries.Grants.subject_verb_grants([%Grant{}])
-%{}
+iex> Bonfire.Boundaries.Grants.subject_verb_grants([%Grant{}])
+%{}
@@ -805,11 +805,11 @@ upsert_or_delete(attrs, arg2)
Examples
-iex> Bonfire.Boundaries.Grants.upsert_or_delete(%{acl_id: "456", subject_id: "123", verb_id: "789", value: true}, [])
-{:ok, %Grant{}}
+iex> Bonfire.Boundaries.Grants.upsert_or_delete(%{acl_id: "456", subject_id: "123", verb_id: "789", value: true}, [])
+{:ok, %Grant{}}
-iex> Bonfire.Boundaries.Grants.upsert_or_delete(%{acl_id: "456", subject_id: "123", verb_id: "789", value: nil}, [])
-{:ok, _deleted}
+iex> Bonfire.Boundaries.Grants.upsert_or_delete(%{acl_id: "456", subject_id: "123", verb_id: "789", value: nil}, [])
+{:ok, _deleted}
@@ -837,8 +837,8 @@ verb_subject_grant(grants)
Examples
-iex> Bonfire.Boundaries.Grants.verb_subject_grant([%Grant{}])
-%{}
+iex> Bonfire.Boundaries.Grants.verb_subject_grant([%Grant{}])
+%{}
diff --git a/Bonfire.Boundaries.Integration.html b/Bonfire.Boundaries.Integration.html
index 0b3a417818..0c8cbabfd0 100644
--- a/Bonfire.Boundaries.Integration.html
+++ b/Bonfire.Boundaries.Integration.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Integration — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Integration — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Integration
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.LiveHandler.html b/Bonfire.Boundaries.LiveHandler.html
index 366cedb290..d1ad23aa6d 100644
--- a/Bonfire.Boundaries.LiveHandler.html
+++ b/Bonfire.Boundaries.LiveHandler.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.LiveHandler — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.LiveHandler — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.LiveHandler
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Queries.html b/Bonfire.Boundaries.Queries.html
index 12a60a5d29..c733c97e09 100644
--- a/Bonfire.Boundaries.Queries.html
+++ b/Bonfire.Boundaries.Queries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Queries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Queries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Queries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -276,7 +276,7 @@ add_perms(l, r)
Examples
iex> import Bonfire.Boundaries.Queries
-iex> query = from(p in Summary, select: add_perms(p.read, p.write))
+
iex> query = from(p in Summary, select: add_perms(p.read, p.write))
@@ -307,7 +307,7 @@ agg_perms(p)
Examples
iex> import Bonfire.Boundaries.Queries
-iex> query = from(p in Summary, group_by: p.object_id, having: agg_perms(p.value))
+ iex> query = from(p in Summary, group_by: p.object_id, having: agg_perms(p.value))
@@ -338,11 +338,11 @@ boundarise(query, field_ref, opts)
Examples
iex> import Bonfire.Boundaries.Queries
-iex> query_visible_posts = from(p in Post)
- |> boundarise(p.id, current_user: user)
+iex> query_visible_posts = from(p in Post)
+ |> boundarise(p.id, current_user: user)
-iex> query_editable_posts = from(p in Post)
- |> boundarise(p.id, verbs: [:edit], current_user: user)
+ iex> query_editable_posts = from(p in Post)
+ |> boundarise(p.id, verbs: [:edit], current_user: user)
@@ -372,8 +372,8 @@ object_boundarised(q, opts \\ nil)
Examples
-iex> query = from(p in Post)
-iex> Bonfire.Boundaries.Queries.object_boundarised(query, current_user: user)
+iex> query = from(p in Post)
+iex> Bonfire.Boundaries.Queries.object_boundarised(query, current_user: user)
@@ -402,7 +402,7 @@ permitted(user)
Examples
iex> user_id = "user123"
-iex> Bonfire.Boundaries.Queries.permitted(user_id)
+
iex> Bonfire.Boundaries.Queries.permitted(user_id)
@@ -431,7 +431,7 @@ permitted(user, verbs)
Examples
iex> user_id = "user123"
-iex> Bonfire.Boundaries.Queries.permitted(user_id, [:read, :write])
+ iex> Bonfire.Boundaries.Queries.permitted(user_id, [:read, :write])
@@ -470,7 +470,7 @@ query_with_summary(user, verbs \\ [:see, :r
Examples
iex> user_id = "user123"
-iex> Bonfire.Boundaries.Queries.query_with_summary(user_id, [:read, :write])
+
iex> Bonfire.Boundaries.Queries.query_with_summary(user_id, [:read, :write])
@@ -500,13 +500,13 @@ skip_boundary_check?(opts, object \\ nil)
Examples
-iex> Bonfire.Boundaries.Queries.skip_boundary_check?([skip_boundary_check: true])
+iex> Bonfire.Boundaries.Queries.skip_boundary_check?([skip_boundary_check: true])
true
-iex> Bonfire.Boundaries.Queries.skip_boundary_check?([], %{id: "user123"})
+iex> Bonfire.Boundaries.Queries.skip_boundary_check?([], %{id: "user123"})
false
-iex> Bonfire.Boundaries.Queries.skip_boundary_check?([current_user: %{id: "user123"}], %{id: "user123"})
+iex> Bonfire.Boundaries.Queries.skip_boundary_check?([current_user: %{id: "user123"}], %{id: "user123"})
true
diff --git a/Bonfire.Boundaries.Roles.html b/Bonfire.Boundaries.Roles.html
index f37910d0cd..6fa1d264e7 100644
--- a/Bonfire.Boundaries.Roles.html
+++ b/Bonfire.Boundaries.Roles.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Roles — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Roles — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Roles
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -331,7 +331,7 @@ cannot_role_from_verb(verbs, verb_field \\
Examples
-iex> cannot_role_from_verb(verbs)
+iex> cannot_role_from_verb(verbs)
@@ -359,7 +359,7 @@ create(attrs, opts)
Examples
-iex> create(attrs, opts)
+iex> create(attrs, opts)
@@ -387,7 +387,7 @@ create(name, usage, opts)
Examples
-iex> create("Admin", :admin, opts)
+iex> create("Admin", :admin, opts)
# creates an admin role with the provided options
@@ -416,13 +416,13 @@ edit_verb_permission(role_name, verb, value
Examples
-iex> edit_verb_permission(:admin, :read, true, opts)
+iex> edit_verb_permission(:admin, :read, true, opts)
# updates the read permission for the admin role to true
-iex> edit_verb_permission(:admin, :read, false, opts)
+iex> edit_verb_permission(:admin, :read, false, opts)
# updates the read permission for the admin role to false
-iex> edit_verb_permission(:admin, :read, nil, opts)
+iex> edit_verb_permission(:admin, :read, nil, opts)
# resets the read permission for the admin role to default
@@ -453,7 +453,7 @@ get(role_name, opts \\ [])
Examples
-iex> get(:admin)
+iex> get(:admin)
# returns admin role details
@@ -482,9 +482,9 @@ preset_boundary_role_from_acl(summary)
Examples
-iex> preset_boundary_role_from_acl(%{verbs: verbs})
+iex> preset_boundary_role_from_acl(%{verbs: verbs})
-iex> preset_boundary_role_from_acl(verbs)
+iex> preset_boundary_role_from_acl(verbs)
@@ -534,7 +534,7 @@ role_from_grants(grants, opts)
Examples
-iex> role_from_grants(grants)
+iex> role_from_grants(grants)
@@ -570,7 +570,7 @@ role_from_verb(verbs, verb_field \\ :verb,
Examples
-iex> role_from_verb(verbs)
+iex> role_from_verb(verbs)
@@ -602,10 +602,10 @@ role_verbs(usage \\ :all, opts \\ [])
Examples
-iex> role_verbs(:all, scope: :instance)
+iex> role_verbs(:all, scope: :instance)
# returns all instance-level role verbs
-iex> role_verbs(nil, current_user: me)
+iex> role_verbs(nil, current_user: me)
# returns my role verbs
@@ -636,7 +636,7 @@ roles_for_dropdown(usage \\ nil, opts)
Examples
-iex> roles_for_dropdown(:ops, current_user: me)
+iex> roles_for_dropdown(:ops, current_user: me)
@@ -664,7 +664,7 @@ split_tuples_can_cannot(tuples)
Examples
-iex> split_tuples_can_cannot(tuples)
+iex> split_tuples_can_cannot(tuples)
# splits tuples into can and cannot categories
@@ -695,8 +695,8 @@ verbs_for_role(role, opts \\ [])
Examples
-iex> verbs_for_role(:admin)
-{:ok, positive_verbs, negative_verbs}
+iex> verbs_for_role(:admin)
+{:ok, positive_verbs, negative_verbs}
diff --git a/Bonfire.Boundaries.RuntimeConfig.html b/Bonfire.Boundaries.RuntimeConfig.html
index 8b0fea122f..f3dbf1ef7c 100644
--- a/Bonfire.Boundaries.RuntimeConfig.html
+++ b/Bonfire.Boundaries.RuntimeConfig.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.RuntimeConfig — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.RuntimeConfig — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.RuntimeConfig
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Scaffold.Instance.html b/Bonfire.Boundaries.Scaffold.Instance.html
index bb8a7e7651..5d916d0b37 100644
--- a/Bonfire.Boundaries.Scaffold.Instance.html
+++ b/Bonfire.Boundaries.Scaffold.Instance.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Scaffold.Instance — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Scaffold.Instance — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Scaffold.Instance
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Scaffold.Users.html b/Bonfire.Boundaries.Scaffold.Users.html
index a77ab65e10..c052b61ec4 100644
--- a/Bonfire.Boundaries.Scaffold.Users.html
+++ b/Bonfire.Boundaries.Scaffold.Users.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Scaffold.Users — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Scaffold.Users — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Scaffold.Users
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Scaffold.html b/Bonfire.Boundaries.Scaffold.html
index a5c98353d7..909ca8fdc3 100644
--- a/Bonfire.Boundaries.Scaffold.html
+++ b/Bonfire.Boundaries.Scaffold.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Scaffold — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Scaffold — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Scaffold
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Summary.html b/Bonfire.Boundaries.Summary.html
index 6bc5e7bdf9..72b1eec2d3 100644
--- a/Bonfire.Boundaries.Summary.html
+++ b/Bonfire.Boundaries.Summary.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Summary — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Summary — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Summary
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Users.PreparedBoundaries.html b/Bonfire.Boundaries.Users.PreparedBoundaries.html
index 249637e40f..e9c54df8c3 100644
--- a/Bonfire.Boundaries.Users.PreparedBoundaries.html
+++ b/Bonfire.Boundaries.Users.PreparedBoundaries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Users.PreparedBoundaries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Users.PreparedBoundaries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Users.PreparedBoundaries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Users.html b/Bonfire.Boundaries.Users.html
index 21d26cce63..5eca8889b1 100644
--- a/Bonfire.Boundaries.Users.html
+++ b/Bonfire.Boundaries.Users.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Users — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Users — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Users
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -221,7 +221,7 @@ create_default_boundaries(user, opts \\ [])
Examples
-> Bonfire.Boundaries.Users.create_default_boundaries(user)
+> Bonfire.Boundaries.Users.create_default_boundaries(user)
@@ -255,7 +255,7 @@ create_missing_boundaries(user)
Examples
-> Bonfire.Boundaries.Users.create_missing_boundaries(user)
+> Bonfire.Boundaries.Users.create_missing_boundaries(user)
diff --git a/Bonfire.Boundaries.Verbs.html b/Bonfire.Boundaries.Verbs.html
index 5b6fdc3906..b3e4a6e579 100644
--- a/Bonfire.Boundaries.Verbs.html
+++ b/Bonfire.Boundaries.Verbs.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Verbs — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Verbs — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Verbs
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -335,7 +335,7 @@ changeset(verb \\ %Verb{}, attrs)
Examples
-iex> Bonfire.Boundaries.Verbs.changeset(%{verb: :new_verb, description: "A new verb"})
+iex> Bonfire.Boundaries.Verbs.changeset(%{verb: :new_verb, description: "A new verb"})
@@ -394,13 +394,13 @@ get(slug, all_verbs \\ verbs())
Examples
-iex> Bonfire.Boundaries.Verbs.get(:read)
-%{id: "read_id", verb: :read}
+iex> Bonfire.Boundaries.Verbs.get(:read)
+%{id: "read_id", verb: :read}
-iex> Bonfire.Boundaries.Verbs.get("read_id")
-%{id: "read_id", verb: :read}
+iex> Bonfire.Boundaries.Verbs.get("read_id")
+%{id: "read_id", verb: :read}
-iex> Bonfire.Boundaries.Verbs.get("non_existent")
+iex> Bonfire.Boundaries.Verbs.get("non_existent")
nil
@@ -431,10 +431,10 @@ get!(id_or_name, all_verbs \\ verbs())
Examples
-iex> Bonfire.Boundaries.Verbs.get!("read")
-%{id: "some_id", verb: :read} # Example output
+iex> Bonfire.Boundaries.Verbs.get!("read")
+%{id: "some_id", verb: :read} # Example output
-iex> Bonfire.Boundaries.Verbs.get!("non_existent_id")
+iex> Bonfire.Boundaries.Verbs.get!("non_existent_id")
** (RuntimeError) Missing default verb: "non_existent_id"
@@ -465,13 +465,13 @@ get_id(slug, all_verbs \\ verbs())
Examples
-iex> Bonfire.Boundaries.Verbs.get_id(:read)
+iex> Bonfire.Boundaries.Verbs.get_id(:read)
"read_id"
-iex> Bonfire.Boundaries.Verbs.get_id("read")
+iex> Bonfire.Boundaries.Verbs.get_id("read")
"read_id"
-iex> Bonfire.Boundaries.Verbs.get_id("non_existent")
+iex> Bonfire.Boundaries.Verbs.get_id("non_existent")
nil
@@ -496,10 +496,10 @@ get_id!(slug, all_verbs \\ verbs())
-Retrieves a verb ID by its slug or ID, raising an error if not found.
iex> Bonfire.Boundaries.Verbs.get_id!(:read)
+Retrieves a verb ID by its slug or ID, raising an error if not found.
iex> Bonfire.Boundaries.Verbs.get_id!(:read)
"read_id"
-iex> Bonfire.Boundaries.Verbs.get_id!("non_existent")
+iex> Bonfire.Boundaries.Verbs.get_id!("non_existent")
** (RuntimeError) Missing default verb: "non_existent"
@@ -524,7 +524,7 @@ get_slug(id_or_name, all_verbs \\ verbs())<
-Retrieves a verb slug by its ID or name.
## Examples
iex> Bonfire.Boundaries.Verbs.get_slug("read_id")
+Retrieves a verb slug by its ID or name.
## Examples
iex> Bonfire.Boundaries.Verbs.get_slug("read_id")
:read
@@ -555,10 +555,10 @@ get_tuple(id_or_name, all_verbs \\ verbs())
Examples
-iex> Bonfire.Boundaries.Verbs.get_tuple("read_id")
-{:read, %{id: "read_id", verb: :read}}
+iex> Bonfire.Boundaries.Verbs.get_tuple("read_id")
+{:read, %{id: "read_id", verb: :read}}
-iex> Bonfire.Boundaries.Verbs.get_tuple("non_existent")
+iex> Bonfire.Boundaries.Verbs.get_tuple("non_existent")
nil
@@ -583,11 +583,11 @@ ids(verbs, all_verbs \\ verbs())
-Retrieves the IDs of the given verbs.
iex> Bonfire.Boundaries.Verbs.ids([:read, :write])
-["read_id", "write_id"]
+Retrieves the IDs of the given verbs.
iex> Bonfire.Boundaries.Verbs.ids([:read, :write])
+["read_id", "write_id"]
-iex> Bonfire.Boundaries.Verbs.ids(:read)
-["read_id"]
+iex> Bonfire.Boundaries.Verbs.ids(:read)
+["read_id"]
@@ -619,11 +619,11 @@ list(from \\ :db, key \\ :verb)
Examples
-iex> Bonfire.Boundaries.Verbs.list(:db, :verb)
-%{read: %Verb{id: "read_id", verb: :read}, write: %Verb{id: "write_id", verb: :write}}
+iex> Bonfire.Boundaries.Verbs.list(:db, :verb)
+%{read: %Verb{id: "read_id", verb: :read}, write: %Verb{id: "write_id", verb: :write}}
-iex> Bonfire.Boundaries.Verbs.list(:instance, :id)
-["read_id", "write_id"]
+iex> Bonfire.Boundaries.Verbs.list(:instance, :id)
+["read_id", "write_id"]
@@ -651,9 +651,9 @@ list_verbs_debug()
Examples
-> Bonfire.Boundaries.Verbs.list_verbs_debug()
+> Bonfire.Boundaries.Verbs.list_verbs_debug()
# Example output:
-[ok: :read, error: "Code and DB have differing IDs for the same verb", ...]
+[ok: :read, error: "Code and DB have differing IDs for the same verb", ...]
@@ -681,8 +681,8 @@ slugs()
Examples
-iex> Bonfire.Boundaries.Verbs.slugs()
-[:read, :write]
+iex> Bonfire.Boundaries.Verbs.slugs()
+[:read, :write]
diff --git a/Bonfire.Boundaries.Web.ExcludeBoundaries.html b/Bonfire.Boundaries.Web.ExcludeBoundaries.html
index b34489a7a2..01de04211c 100644
--- a/Bonfire.Boundaries.Web.ExcludeBoundaries.html
+++ b/Bonfire.Boundaries.Web.ExcludeBoundaries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Web.ExcludeBoundaries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Web.ExcludeBoundaries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Web.ExcludeBoundaries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.Web.Routes.html b/Bonfire.Boundaries.Web.Routes.html
index 358c3d450b..6e16bcbe8e 100644
--- a/Bonfire.Boundaries.Web.Routes.html
+++ b/Bonfire.Boundaries.Web.Routes.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries.Web.Routes — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries.Web.Routes — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries.Web.Routes
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Boundaries.html b/Bonfire.Boundaries.html
index ed7d07642c..989807c87c 100644
--- a/Bonfire.Boundaries.html
+++ b/Bonfire.Boundaries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Boundaries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Boundaries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Boundaries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -201,59 +201,59 @@
1. Setting up users
iex> import Bonfire.Me.Fake
-iex> organizer = fake_user!()
-iex> birthday_girl = fake_user!()
-iex> friends = [fake_user!(), fake_user!()]
-iex> family = [fake_user!(), fake_user!()]
+
iex> organizer = fake_user!()
+iex> birthday_girl = fake_user!()
+iex> friends = [fake_user!(), fake_user!()]
+iex> family = [fake_user!(), fake_user!()]
2. Define your Circles
Organize users into relevant circles (friends and family).
iex> alias Bonfire.Boundaries.Circles
-iex> {:ok, friends_circle} = Circles.create(organizer, %{named: %{name: "friends"}})
-iex> Circles.add_to_circles(friends, friends_circle)
-iex> Circles.is_encircled_by?(List.first(friends), friends_circle)
+iex> {:ok, friends_circle} = Circles.create(organizer, %{named: %{name: "friends"}})
+iex> Circles.add_to_circles(friends, friends_circle)
+iex> Circles.is_encircled_by?(List.first(friends), friends_circle)
true
-iex> {:ok, family_circle} = Circles.create(organizer, %{named: %{name: "family"}})
-iex> Circles.add_to_circles(family, family_circle)
+
iex> {:ok, family_circle} = Circles.create(organizer, %{named: %{name: "family"}})
+iex> Circles.add_to_circles(family, family_circle)
3. Create the ACL (boundary preset)
This boundary will control access to the surprise party plans.
iex> alias Bonfire.Boundaries.Acls
-iex> {:ok, boundary} = Acls.simple_create(organizer, "Surprise party")
+
iex> {:ok, boundary} = Acls.simple_create(organizer, "Surprise party")
4. Grant permissions
Allow friends to discover, read, and respond to party plans, while family members can also edit details and send invitations.
iex> alias Bonfire.Boundaries.Grants
-iex> Grants.grant(friends_circle.id, boundary.id, [:see, :read, :reply], true, current_user: organizer)
-iex> Grants.grant(family_circle.id, boundary.id, [:see, :read, :reply, :edit, :invite], true, current_user: organizer)
Prevent the birthday person from accessing any party information.
iex> Grants.grant(birthday_girl.id, boundary.id, [:see, :read], false, current_user: organizer)
+
iex> Grants.grant(friends_circle.id, boundary.id, [:see, :read, :reply], true, current_user: organizer)
+iex> Grants.grant(family_circle.id, boundary.id, [:see, :read, :reply, :edit, :invite], true, current_user: organizer)
Prevent the birthday person from accessing any party information.
iex> Grants.grant(birthday_girl.id, boundary.id, [:see, :read], false, current_user: organizer)
5. Post about the party
iex> alias Bonfire.Posts
-iex> {:ok, party_plan} = Posts.publish(
+iex> {:ok, party_plan} = Posts.publish(
current_user: organizer,
boundary: boundary.id,
- post_attrs: %{post_content: %{name: "Surprise party!"}})
+
post_attrs: %{post_content: %{name: "Surprise party!"}})
6. Double-check applied boundaries
-iex> Boundaries.can?(List.first(friends).id, :read, party_plan.id)
+iex> Boundaries.can?(List.first(friends).id, :read, party_plan.id)
true
-iex> Boundaries.can?(List.first(family).id, :invite, party_plan.id)
+iex> Boundaries.can?(List.first(family).id, :invite, party_plan.id)
true
-iex> Boundaries.can?(birthday_girl.id, :see, party_plan.id)
+iex> Boundaries.can?(birthday_girl.id, :see, party_plan.id)
false
-iex> Boundaries.load_pointer(party_plan.id, current_user: birthday_girl)
+iex> Boundaries.load_pointer(party_plan.id, current_user: birthday_girl)
nil
By following these steps, the organizer can effectively manage access to ensure the birthday girl cannot see the party plans, while friends and family can.
@@ -545,7 +545,7 @@ acls_from_preset_boundary_names(presets)
Examples
-iex> Bonfire.Boundaries.acls_from_preset_boundary_names(["public"])
+iex> Bonfire.Boundaries.acls_from_preset_boundary_names(["public"])
@@ -573,11 +573,11 @@ boundaries_normalise(text)
Examples
-iex> Bonfire.Boundaries.boundaries_normalise("local,public")
-["local", "public"]
+iex> Bonfire.Boundaries.boundaries_normalise("local,public")
+["local", "public"]
-iex> Bonfire.Boundaries.boundaries_normalise(["local", "public"])
-["local", "public"]
+iex> Bonfire.Boundaries.boundaries_normalise(["local", "public"])
+["local", "public"]
@@ -607,11 +607,11 @@ boundaries_or_default(to_boundaries, contex
Examples
-iex> Bonfire.Boundaries.boundaries_or_default(["local"])
-["local"]
+iex> Bonfire.Boundaries.boundaries_or_default(["local"])
+["local"]
-iex> Bonfire.Boundaries.boundaries_or_default(nil, current_user: me)
-[{"public", "Public"}]
+iex> Bonfire.Boundaries.boundaries_or_default(nil, current_user: me)
+[{"public", "Public"}]
@@ -641,7 +641,7 @@ can?(subject, verbs, object, opts \\ [])
Examples
-iex> Bonfire.Boundaries.can?(%User{id: 1}, [:see], %{id: 2})
+iex> Bonfire.Boundaries.can?(%User{id: 1}, [:see], %{id: 2})
false
@@ -672,11 +672,11 @@ default_boundaries(context \\ [])
Examples
-iex> Bonfire.Boundaries.default_boundaries()
-[{"public", "Public"}]
+iex> Bonfire.Boundaries.default_boundaries()
+[{"public", "Public"}]
-iex> Bonfire.Boundaries.default_boundaries(current_user: me)
-[{"local", "Local"}]
+iex> Bonfire.Boundaries.default_boundaries(current_user: me)
+[{"local", "Local"}]
@@ -728,8 +728,8 @@ find_caretaker_stereotypes(caretaker, stere
Examples
-iex> Bonfire.Boundaries.find_caretaker_stereotypes(%User{id: 1}, [%{id: 2}])
-[%Needle.Pointer{id: 1}]
+iex> Bonfire.Boundaries.find_caretaker_stereotypes(%User{id: 1}, [%{id: 2}])
+[%Needle.Pointer{id: 1}]
@@ -757,7 +757,7 @@ list_grants_on(things)
Examples
-iex> Bonfire.Boundaries.list_grants_on([1, 2, 3])
+iex> Bonfire.Boundaries.list_grants_on([1, 2, 3])
@@ -785,7 +785,7 @@ list_grants_on(things, verbs)
Examples
-iex> Bonfire.Boundaries.list_grants_on([1, 2, 3], [:see, :read])
+iex> Bonfire.Boundaries.list_grants_on([1, 2, 3], [:see, :read])
@@ -815,8 +815,8 @@ list_object_acls(object, opts \\ [])
Examples
-iex> Bonfire.Boundaries.list_object_acls(%{id: 1})
-[%Bonfire.Data.AccessControl.Acl{id: 42}]
+iex> Bonfire.Boundaries.list_object_acls(%{id: 1})
+[%Bonfire.Data.AccessControl.Acl{id: 42}]
@@ -840,8 +840,8 @@ list_object_boundaries(object, opts \\ [])<
-Lists boundaries (ACLs and grants) for a given object
iex> Bonfire.Boundaries.list_object_boundaries(%{id: 1})
-[%Bonfire.Data.AccessControl.Acl{id: 42, grants: [...]}]
+Lists boundaries (ACLs and grants) for a given object
iex> Bonfire.Boundaries.list_object_boundaries(%{id: 1})
+[%Bonfire.Data.AccessControl.Acl{id: 42, grants: [...]}]
@@ -869,8 +869,8 @@ load_pointer(item, opts)
Examples
-iex> Bonfire.Boundaries.load_pointer(%{id: 1}, verbs: [:read], current_user: %{id: 2})
-%Needle.Pointer{id: 1}
+iex> Bonfire.Boundaries.load_pointer(%{id: 1}, verbs: [:read], current_user: %{id: 2})
+%Needle.Pointer{id: 1}
@@ -898,8 +898,8 @@ load_pointers(items, opts)
Examples
-iex> Bonfire.Boundaries.load_pointers([%{id: 1}], verbs: [:read], current_user: %{id: 2})
-[%Needle.Pointer{id: 1}]
+iex> Bonfire.Boundaries.load_pointers([%{id: 1}], verbs: [:read], current_user: %{id: 2})
+[%Needle.Pointer{id: 1}]
@@ -949,7 +949,7 @@ pointer_permitted?(item, opts)
Examples
-iex> Bonfire.Boundaries.pointer_permitted?(%{id: 1}, verbs: [:edit], current_user: %{id: 2})
+iex> Bonfire.Boundaries.pointer_permitted?(%{id: 1}, verbs: [:edit], current_user: %{id: 2})
true
@@ -980,8 +980,8 @@ preset_boundary_from_acl(acl, object_type \
Examples
-iex> Bonfire.Boundaries.preset_boundary_from_acl(%Bonfire.Data.AccessControl.Acl{id: 1})
-{"public", "Public"}
+iex> Bonfire.Boundaries.preset_boundary_from_acl(%Bonfire.Data.AccessControl.Acl{id: 1})
+{"public", "Public"}
@@ -1011,11 +1011,11 @@ preset_boundary_tuple_from_acl(acl, object_
Examples
-iex> Bonfire.Boundaries.preset_boundary_tuple_from_acl(%Bonfire.Data.AccessControl.Acl{id: 1})
-{"public", "Public"}
+iex> Bonfire.Boundaries.preset_boundary_tuple_from_acl(%Bonfire.Data.AccessControl.Acl{id: 1})
+{"public", "Public"}
-iex> Bonfire.Boundaries.preset_boundary_tuple_from_acl(%Bonfire.Data.AccessControl.Acl{id: 1}, :group)
-{"open", "Open"}
+iex> Bonfire.Boundaries.preset_boundary_tuple_from_acl(%Bonfire.Data.AccessControl.Acl{id: 1}, :group)
+{"open", "Open"}
@@ -1045,10 +1045,10 @@ preset_name(boundaries, include_remote? \\
Examples
-iex> Bonfire.Boundaries.preset_name(["admins", "mentions"])
+iex> Bonfire.Boundaries.preset_name(["admins", "mentions"])
"admins"
-iex> Bonfire.Boundaries.preset_name("public_remote", true)
+iex> Bonfire.Boundaries.preset_name("public_remote", true)
"public_remote"
@@ -1077,15 +1077,15 @@ set_boundaries(creator, object, opts)
Set boundaries on a black object
-iex> Bonfire.Boundaries.set_boundaries(%User{id: 1}, %{id: 2}, [boundary: "public"])
-{:ok, :granted}
+iex> Bonfire.Boundaries.set_boundaries(%User{id: 1}, %{id: 2}, [boundary: "public"])
+{:ok, :granted}
Replace boundaries on an existing object that previously had a preset applied
-iex> Bonfire.Boundaries.set_boundaries(%User{id: 1}, %{id: 2}, [boundary: "local", remove_previous_preset: "public"])
-{:ok, :granted}
+iex> Bonfire.Boundaries.set_boundaries(%User{id: 1}, %{id: 2}, [boundary: "local", remove_previous_preset: "public"])
+{:ok, :granted}
@@ -1113,8 +1113,8 @@ take_care_of!(things, user)
Examples
-iex> Bonfire.Boundaries.take_care_of!([%{id: 1}], %{id: 2})
-[%{id: 1, caretaker: %{id: 1, caretaker_id: 2, caretaker: %{id: 2}}}]
+iex> Bonfire.Boundaries.take_care_of!([%{id: 1}], %{id: 2})
+[%{id: 1, caretaker: %{id: 1, caretaker_id: 2, caretaker: %{id: 2}}}]
@@ -1142,8 +1142,8 @@ user_default_boundaries()
Examples
-iex> Bonfire.Boundaries.user_default_boundaries()
-[{"public", "Public"}]
+iex> Bonfire.Boundaries.user_default_boundaries()
+[{"public", "Public"}]
@@ -1171,7 +1171,7 @@ users_grants_on(users, things)
Examples
-iex> Bonfire.Boundaries.users_grants_on([%{id: 1}], [%{id: 2}])
+iex> Bonfire.Boundaries.users_grants_on([%{id: 1}], [%{id: 2}])
@@ -1199,8 +1199,8 @@ users_grants_on(users, things, verbs)
Examples
-iex> Bonfire.Boundaries.users_grants_on([%{id: 1}], [%{id: 2}], [:see, :read])
-[%Bonfire.Boundaries.Summary{object_id: 2, subject_id: 1}]
+iex> Bonfire.Boundaries.users_grants_on([%{id: 1}], [%{id: 2}], [:see, :read])
+[%Bonfire.Boundaries.Summary{object_id: 2, subject_id: 1}]
diff --git a/Bonfire.Breadpub.IntentLive.GraphQL.html b/Bonfire.Breadpub.IntentLive.GraphQL.html
index 2932edadaf..c7e404ca7f 100644
--- a/Bonfire.Breadpub.IntentLive.GraphQL.html
+++ b/Bonfire.Breadpub.IntentLive.GraphQL.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Breadpub.IntentLive.GraphQL — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Breadpub.IntentLive.GraphQL — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Breadpub.IntentLive.GraphQL
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Breadpub.MapLive.GraphQL.html b/Bonfire.Breadpub.MapLive.GraphQL.html
index a2f56884f4..c9c4ff979c 100644
--- a/Bonfire.Breadpub.MapLive.GraphQL.html
+++ b/Bonfire.Breadpub.MapLive.GraphQL.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Breadpub.MapLive.GraphQL — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Breadpub.MapLive.GraphQL — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Breadpub.MapLive.GraphQL
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Breadpub.Web.HomeLive.GraphQL.html b/Bonfire.Breadpub.Web.HomeLive.GraphQL.html
index c3a8ecb599..53a8f17156 100644
--- a/Bonfire.Breadpub.Web.HomeLive.GraphQL.html
+++ b/Bonfire.Breadpub.Web.HomeLive.GraphQL.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Breadpub.Web.HomeLive.GraphQL — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Breadpub.Web.HomeLive.GraphQL — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Breadpub.Web.HomeLive.GraphQL
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Breadpub.Web.Routes.html b/Bonfire.Breadpub.Web.Routes.html
index 5714c05ccb..e2c2494521 100644
--- a/Bonfire.Breadpub.Web.Routes.html
+++ b/Bonfire.Breadpub.Web.Routes.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Breadpub.Web.Routes — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Breadpub.Web.Routes — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Breadpub.Web.Routes
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Breadpub.html b/Bonfire.Breadpub.html
index 8466fe7703..d0490767d0 100644
--- a/Bonfire.Breadpub.html
+++ b/Bonfire.Breadpub.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Breadpub — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Breadpub — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Breadpub
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.Categories.html b/Bonfire.Classify.Categories.html
index 5bd8967ca3..5b9b472771 100644
--- a/Bonfire.Classify.Categories.html
+++ b/Bonfire.Classify.Categories.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.Categories — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.Categories — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.Categories
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.Category.Queries.html b/Bonfire.Classify.Category.Queries.html
index 4635f59a61..3bc0245348 100644
--- a/Bonfire.Classify.Category.Queries.html
+++ b/Bonfire.Classify.Category.Queries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.Category.Queries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.Category.Queries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.Category.Queries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.Category.html b/Bonfire.Classify.Category.html
index a0a86bd615..f2bd9e6fa3 100644
--- a/Bonfire.Classify.Category.html
+++ b/Bonfire.Classify.Category.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.Category — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.Category — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.Category
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.LiveHandler.html b/Bonfire.Classify.LiveHandler.html
index 18d755e304..3d120abe3f 100644
--- a/Bonfire.Classify.LiveHandler.html
+++ b/Bonfire.Classify.LiveHandler.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.LiveHandler — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.LiveHandler — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.LiveHandler
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.RuntimeConfig.html b/Bonfire.Classify.RuntimeConfig.html
index 629dff1b8a..627f76e89a 100644
--- a/Bonfire.Classify.RuntimeConfig.html
+++ b/Bonfire.Classify.RuntimeConfig.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.RuntimeConfig — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.RuntimeConfig — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.RuntimeConfig
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.Simulate.html b/Bonfire.Classify.Simulate.html
index 2605823272..9a3886c2de 100644
--- a/Bonfire.Classify.Simulate.html
+++ b/Bonfire.Classify.Simulate.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.Simulate — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.Simulate — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.Simulate
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.Tree.html b/Bonfire.Classify.Tree.html
index b3f8aa9878..2047d53ab1 100644
--- a/Bonfire.Classify.Tree.html
+++ b/Bonfire.Classify.Tree.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify.Tree — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify.Tree — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify.Tree
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Classify.html b/Bonfire.Classify.html
index 756a355696..041ed3e6f2 100644
--- a/Bonfire.Classify.html
+++ b/Bonfire.Classify.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Classify — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Classify — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Classify
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.AntiSpam.Akismet.html b/Bonfire.Common.AntiSpam.Akismet.html
index 751b06f91c..7008382c23 100644
--- a/Bonfire.Common.AntiSpam.Akismet.html
+++ b/Bonfire.Common.AntiSpam.Akismet.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.AntiSpam.Akismet — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.AntiSpam.Akismet — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.AntiSpam.Akismet
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.AntiSpam.BumblebeeAdapter.html b/Bonfire.Common.AntiSpam.BumblebeeAdapter.html
index 6f6c0b92fb..1c0fc22ff9 100644
--- a/Bonfire.Common.AntiSpam.BumblebeeAdapter.html
+++ b/Bonfire.Common.AntiSpam.BumblebeeAdapter.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.AntiSpam.BumblebeeAdapter — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.AntiSpam.BumblebeeAdapter — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.AntiSpam.BumblebeeAdapter
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.AntiSpam.Mock.html b/Bonfire.Common.AntiSpam.Mock.html
index 8b62431391..064bd36c70 100644
--- a/Bonfire.Common.AntiSpam.Mock.html
+++ b/Bonfire.Common.AntiSpam.Mock.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.AntiSpam.Mock — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.AntiSpam.Mock — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.AntiSpam.Mock
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.AntiSpam.Provider.html b/Bonfire.Common.AntiSpam.Provider.html
index c471a65697..0c47547a3b 100644
--- a/Bonfire.Common.AntiSpam.Provider.html
+++ b/Bonfire.Common.AntiSpam.Provider.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.AntiSpam.Provider — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.AntiSpam.Provider — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.AntiSpam.Provider behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.AntiSpam.html b/Bonfire.Common.AntiSpam.html
index d852dc7294..9f079b5f99 100644
--- a/Bonfire.Common.AntiSpam.html
+++ b/Bonfire.Common.AntiSpam.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.AntiSpam — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.AntiSpam — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.AntiSpam
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Benchmark.html b/Bonfire.Common.Benchmark.html
index d663dd18c1..74d527a980 100644
--- a/Bonfire.Common.Benchmark.html
+++ b/Bonfire.Common.Benchmark.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Benchmark — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Benchmark — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Benchmark
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Cache.DiskCache.html b/Bonfire.Common.Cache.DiskCache.html
index bb0c0df353..cc800aaffc 100644
--- a/Bonfire.Common.Cache.DiskCache.html
+++ b/Bonfire.Common.Cache.DiskCache.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Cache.DiskCache — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Cache.DiskCache — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Cache.DiskCache
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Cache.html b/Bonfire.Common.Cache.html
index ce92cfb390..0ca1b8f7d7 100644
--- a/Bonfire.Common.Cache.html
+++ b/Bonfire.Common.Cache.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Cache — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Cache — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Cache
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Changelog.Github.DataGrabber.html b/Bonfire.Common.Changelog.Github.DataGrabber.html
index b2edae8e6c..5f823f2834 100644
--- a/Bonfire.Common.Changelog.Github.DataGrabber.html
+++ b/Bonfire.Common.Changelog.Github.DataGrabber.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Changelog.Github.DataGrabber — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Changelog.Github.DataGrabber — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Changelog.Github.DataGrabber
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Config.Error.html b/Bonfire.Common.Config.Error.html
index 54230ac980..eedf19d413 100644
--- a/Bonfire.Common.Config.Error.html
+++ b/Bonfire.Common.Config.Error.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Config.Error — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Config.Error — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Config.Error exception
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Config.LoadExtensionsConfig.html b/Bonfire.Common.Config.LoadExtensionsConfig.html
index ccca911167..73180fbd80 100644
--- a/Bonfire.Common.Config.LoadExtensionsConfig.html
+++ b/Bonfire.Common.Config.LoadExtensionsConfig.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Config.LoadExtensionsConfig — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Config.LoadExtensionsConfig — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Config.LoadExtensionsConfig
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Config.html b/Bonfire.Common.Config.html
index c28cba259b..0b3b77a39e 100644
--- a/Bonfire.Common.Config.html
+++ b/Bonfire.Common.Config.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Config — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Config — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Config
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -391,10 +391,10 @@ delete(key, otp_app \\ top_level_otp_app())
Examples
-iex> delete(:key)
+iex> delete(:key)
:ok
-iex> delete([:nested, :key], :my_app)
+iex> delete([:nested, :key], :my_app)
:ok
@@ -423,7 +423,7 @@ endpoint_module()
Examples
-iex> endpoint_module()
+iex> endpoint_module()
Bonfire.Web.Endpoint
@@ -452,7 +452,7 @@ env()
Examples
-iex> env()
+iex> env()
:test
@@ -485,13 +485,13 @@ get(key_or_keys, default \\ nil, otp_app \\
Examples
-iex> get(:test_key, "default")
+iex> get(:test_key, "default")
"test_value"
-iex> get([:nested, :key], "default", :bonfire)
+iex> get([:nested, :key], "default", :bonfire)
"default"
-iex> get(:missing_key, "default")
+iex> get(:missing_key, "default")
"default"
@@ -522,10 +522,10 @@ get!(key, otp_app \\ top_level_otp_app())
Examples
-iex> get!(:test_key)
+iex> get!(:test_key)
"test_value"
-iex> get!(:missing_key)
+iex> get!(:missing_key)
** (Bonfire.Common.Config.Error) Missing configuration value: [:bonfire, :missing_key]
@@ -554,11 +554,11 @@ get_ext(module_or_otp_app)
Examples
-> get_ext(:my_extension)
-[key1: "value1", key2: "value2"]
+> get_ext(:my_extension)
+[key1: "value1", key2: "value2"]
-> get_ext(:another_extension)
-[]
+> get_ext(:another_extension)
+[]
@@ -588,10 +588,10 @@ get_ext(module_or_otp_app, key, default \\
Examples
-iex> get_ext(:bonfire_common, :test_key, "default")
+iex> get_ext(:bonfire_common, :test_key, "default")
"test_value"
-iex> get_ext(:my_extension, :missing_key, "default")
+iex> get_ext(:my_extension, :missing_key, "default")
"default"
@@ -620,11 +620,11 @@ get_ext!(module_or_otp_app)
Examples
-iex> config = get_ext!(:bonfire_common)
-iex> is_list(config) and config !=[]
+iex> config = get_ext!(:bonfire_common)
+iex> is_list(config) and config !=[]
true
-iex> get_ext!(:non_existent_extension)
+iex> get_ext!(:non_existent_extension)
** (Bonfire.Common.Config.Error) Empty configuration for extension: non_existent_extension
@@ -653,10 +653,10 @@ get_ext!(module_or_otp_app, key)
Examples
-iex> get_ext!(:bonfire_common, :test_key)
+iex> get_ext!(:bonfire_common, :test_key)
"test_value"
-iex> get_ext!(:my_extension, :missing_key)
+iex> get_ext!(:my_extension, :missing_key)
** (Bonfire.Common.Config.Error) Missing configuration value: [:my_extension, :missing_key]
@@ -701,20 +701,20 @@ keys_tree(keys)
-Constructs a key path for configuration settings, which always starts with an app or extension name. It starts with the main OTP app or extension and includes additional keys as specified.
> keys_tree([:bonfire_me, Bonfire.Me.Users])
-[:bonfire_me, Bonfire.Me.Users]
+Constructs a key path for configuration settings, which always starts with an app or extension name. It starts with the main OTP app or extension and includes additional keys as specified.
> keys_tree([:bonfire_me, Bonfire.Me.Users])
+[:bonfire_me, Bonfire.Me.Users]
-> keys_tree(Bonfire.Me.Users)
-[:bonfire_me, Bonfire.Me.Users]
+> keys_tree(Bonfire.Me.Users)
+[:bonfire_me, Bonfire.Me.Users]
-> keys_tree(:bonfire_me)
-[:bonfire_me]
+> keys_tree(:bonfire_me)
+[:bonfire_me]
-iex> keys_tree(:random_atom)
-[:bonfire, :random_atom]
+iex> keys_tree(:random_atom)
+[:bonfire, :random_atom]
-iex>keys_tree([:random_atom, :sub_key])
-[:bonfire, :random_atom, :sub_key]
+iex>keys_tree([:random_atom, :sub_key])
+[:bonfire, :random_atom, :sub_key]
@@ -788,10 +788,10 @@ put(key, value, otp_app \\ nil)
Examples
-iex> put(:test_key, "test_value")
+iex> put(:test_key, "test_value")
:ok
-iex> put([:nested, :key], "test_value", :my_app)
+iex> put([:nested, :key], "test_value", :my_app)
:ok
@@ -820,7 +820,7 @@ repo()
Examples
-iex> repo()
+iex> repo()
Bonfire.Common.Repo
@@ -849,7 +849,7 @@ require_extension_config!(extension)
Examples
-iex> require_extension_config!(:some_extension)
+iex> require_extension_config!(:some_extension)
** (Bonfire.Common.Config.Error) You have not configured the `some_extension` Bonfire extension, please `cp ./deps/some_extension/config/some_extension.exs ./config/some_extension.exs` in your Bonfire app repository and then customise the copied config as necessary
diff --git a/Bonfire.Common.ConfigModule.html b/Bonfire.Common.ConfigModule.html
index d1b2e2632e..6c77409c5d 100644
--- a/Bonfire.Common.ConfigModule.html
+++ b/Bonfire.Common.ConfigModule.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.ConfigModule — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.ConfigModule — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.ConfigModule behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.ContextModule.html b/Bonfire.Common.ContextModule.html
index 25564526c2..36fabc76d7 100644
--- a/Bonfire.Common.ContextModule.html
+++ b/Bonfire.Common.ContextModule.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.ContextModule — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.ContextModule — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.ContextModule behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Crypto.html b/Bonfire.Common.Crypto.html
index 9a7f6c7dfa..f1bb454550 100644
--- a/Bonfire.Common.Crypto.html
+++ b/Bonfire.Common.Crypto.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Crypto — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Crypto — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Crypto
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.DatesTimes.html b/Bonfire.Common.DatesTimes.html
index 03bfd44fa1..a0dd5e4913 100644
--- a/Bonfire.Common.DatesTimes.html
+++ b/Bonfire.Common.DatesTimes.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.DatesTimes — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.DatesTimes — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.DatesTimes
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -347,8 +347,8 @@ available_format_keys(scope \\ DateTime, lo
Examples
-> available_format_keys()
-[:short, :medium, :long, :full] # Example output
+> available_format_keys()
+[:short, :medium, :long, :full] # Example output
@@ -380,8 +380,8 @@ available_formats(scope \\ DateTime, locale
Examples
-> available_formats()
-[short: "Short", medium: "Medium", long: "Long", full: "Full"] # Example output
+> available_formats()
+[short: "Short", medium: "Medium", long: "Long", full: "Full"] # Example output
@@ -411,10 +411,10 @@ date_from_now(ulid_or_date, opts \\ [])
Examples
-> date_from_now(%{id: "01FJ6G6V9E7Y3A6HZ5F2M3K4RY"})
+> date_from_now(%{id: "01FJ6G6V9E7Y3A6HZ5F2M3K4RY"})
"25 days ago" # Example output
-> date_from_now("01FJ6G6V9E7Y3A6HZ5F2M3K4RY")
+> date_from_now("01FJ6G6V9E7Y3A6HZ5F2M3K4RY")
"25 days ago" # Example output
@@ -443,8 +443,8 @@ date_from_pointer(object)
Examples
-> date_from_pointer("01FJ6G6V9E7Y3A6HZ5F2M3K4RY")
-%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
+> date_from_pointer("01FJ6G6V9E7Y3A6HZ5F2M3K4RY")
+%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
@@ -474,7 +474,7 @@ format(date, opts \\ [])
Examples
-> format(DateTime.now!("Etc/UTC"))
+> format(DateTime.now!("Etc/UTC"))
"Jul 25, 2024, 11:08:21 AM"
@@ -505,7 +505,7 @@ format_date(date, opts \\ [])
Examples
-> format(DateTime.now!("Etc/UTC"))
+> format(DateTime.now!("Etc/UTC"))
"Jul 25, 2024, 11:08:21 AM"
@@ -534,10 +534,10 @@ future?(dt)
Examples
-iex> future?(%Date{year: 3020, month: 7, day: 25})
+iex> future?(%Date{year: 3020, month: 7, day: 25})
true # Example output
-iex> future?(%Date{year: 2023, month: 7, day: 25})
+iex> future?(%Date{year: 2023, month: 7, day: 25})
false # Example output
@@ -566,10 +566,10 @@ maybe_generate_ulid(date_time_or_string)
Examples
-> maybe_generate_ulid(%Date{year: 2024, month: 7, day: 25})
+> maybe_generate_ulid(%Date{year: 2024, month: 7, day: 25})
"01J3KJZZ00X1EXD6TZYD3PPDR6" # Example output
-> maybe_generate_ulid("2024-07-25")
+> maybe_generate_ulid("2024-07-25")
"01J3KJZZ00X1EXD6TZYD3PPDR6" # Example output
@@ -598,8 +598,8 @@ now()
Examples
-> now()
-%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
+> now()
+%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
@@ -629,8 +629,8 @@ past(amount_to_remove, unit \\ :second)
Examples
-> past(10, :day)
-%DateTime{year: 2024, month: 7, day: 15, ...} # Example output
+> past(10, :day)
+%DateTime{year: 2024, month: 7, day: 15, ...} # Example output
@@ -658,10 +658,10 @@ past?(dt)
Examples
-iex> past?(%Date{year: 3020, month: 7, day: 25})
+iex> past?(%Date{year: 3020, month: 7, day: 25})
false # Example output
-iex> past?(%Date{year: 2023, month: 7, day: 24})
+iex> past?(%Date{year: 2023, month: 7, day: 24})
true # Example output
@@ -692,7 +692,7 @@ relative_date(date_time, opts \\ [])
Examples
-iex> relative_date(DateTime.now!("Etc/UTC"))
+iex> relative_date(DateTime.now!("Etc/UTC"))
"now" # Example output
@@ -723,8 +723,8 @@ remove(dt, amount_to_remove, unit \\ :secon
Examples
-> remove(%Date{year: 2024, month: 7, day: 25}, 10, :day)
-%DateTime{year: 2024, month: 7, day: 15, ...} # Example output
+> remove(%Date{year: 2024, month: 7, day: 25}, 10, :day)
+%DateTime{year: 2024, month: 7, day: 15, ...} # Example output
@@ -752,17 +752,17 @@ to_date(date)
Examples
-iex> to_date(%Date{year: 2024, month: 7, day: 25})
-%Date{year: 2024, month: 7, day: 25}
+iex> to_date(%Date{year: 2024, month: 7, day: 25})
+%Date{year: 2024, month: 7, day: 25}
-iex> to_date("2024-07-25")
-%Date{year: 2024, month: 7, day: 25}
+iex> to_date("2024-07-25")
+%Date{year: 2024, month: 7, day: 25}
-iex> to_date(1656115200000)
-%Date{year: 2022, month: 6, day: 25}
+iex> to_date(1656115200000)
+%Date{year: 2022, month: 6, day: 25}
-iex> to_date(%{"day" => 25, "month" => 7, "year" => 2024})
-%Date{year: 2024, month: 7, day: 25}
+iex> to_date(%{"day" => 25, "month" => 7, "year" => 2024})
+%Date{year: 2024, month: 7, day: 25}
@@ -790,17 +790,17 @@ to_date_time(date_time)
Examples
-> to_date_time(%Date{year: 2024, month: 7, day: 25})
-%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
+> to_date_time(%Date{year: 2024, month: 7, day: 25})
+%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
-> to_date_time("2024-07-25")
-%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
+> to_date_time("2024-07-25")
+%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
-> to_date_time(1656115200000)
-%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
+> to_date_time(1656115200000)
+%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
-> to_date_time(%{"day" => 25, "month" => 7, "year" => 2024})
-%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
+> to_date_time(%{"day" => 25, "month" => 7, "year" => 2024})
+%DateTime{year: 2024, month: 7, day: 25, ...} # Example output
diff --git a/Bonfire.Common.E.html b/Bonfire.Common.E.html
index bacaf69e12..c34a34bea2 100644
--- a/Bonfire.Common.E.html
+++ b/Bonfire.Common.E.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.E — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.E — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.E
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -342,46 +342,46 @@ e(object, key1, fallback)
Examples
-iex> e(%{key: "value"}, :key, "fallback")
+iex> e(%{key: "value"}, :key, "fallback")
"value"
-iex> e(%{key: nil}, :key, "fallback")
+iex> e(%{key: nil}, :key, "fallback")
"fallback"
-iex> e(%{key: "value"}, :missing_key, "fallback")
+iex> e(%{key: "value"}, :missing_key, "fallback")
"fallback"
-iex> e(%{key: %Ecto.Association.NotLoaded{}}, :key, "fallback")
+iex> e(%{key: %Ecto.Association.NotLoaded{}}, :key, "fallback")
"fallback"
-iex> e({:ok, %{key: "value"}}, :key, "fallback") # FIXME
+iex> e({:ok, %{key: "value"}}, :key, "fallback") # FIXME
"value"
-iex> e(%{__context__: %{key: "context_value"}}, :key, "fallback") # FIXME
+iex> e(%{__context__: %{key: "context_value"}}, :key, "fallback") # FIXME
"context_value"
-iex> e(%{a: %{b: "value"}}, :a, :b, "fallback")
+iex> e(%{a: %{b: "value"}}, :a, :b, "fallback")
"value"
-iex> e(%{a: %{b: %Ecto.Association.NotLoaded{}}}, :a, :b, "fallback")
+iex> e(%{a: %{b: %Ecto.Association.NotLoaded{}}}, :a, :b, "fallback")
"fallback"
-iex> e(%{a: %{b: nil}}, :a, :b, "fallback")
+iex> e(%{a: %{b: nil}}, :a, :b, "fallback")
"fallback"
-iex> e(%{a: %{b: %{c: "value"}}}, :a, :b, :c, "fallback")
+iex> e(%{a: %{b: %{c: "value"}}}, :a, :b, :c, "fallback")
"value"
-iex> e(%{a: %{b: %{c: "value"}}}, :a, :b, :c, :d, "fallback")
+iex> e(%{a: %{b: %{c: "value"}}}, :a, :b, :c, :d, "fallback")
"fallback"
-iex> e(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, "fallback")
+iex> e(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, "fallback")
"value"
-iex> e(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, :ed, "fallback")
+iex> e(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, :ed, "fallback")
"fallback"
-iex> e(%{a: %{b: %{c: %{d: %{e: "value"}}}}}, :a, :b, :c, :d, :e, "fallback")
+iex> e(%{a: %{b: %{c: %{d: %{e: "value"}}}}}, :a, :b, :c, :d, :e, "fallback")
"value"
@@ -532,13 +532,13 @@ ed(val, fallback \\ nil)
Examples
-iex> ed("non-empty value", "fallback")
+iex> ed("non-empty value", "fallback")
"non-empty value"
-iex> ed("", "fallback")
+iex> ed("", "fallback")
"fallback"
-iex> ed(nil, "fallback")
+iex> ed(nil, "fallback")
"fallback"
@@ -568,49 +568,49 @@ ed(map, key, fallback)
Examples
-iex> ed(%{key: "value"}, :key, "fallback")
+iex> ed(%{key: "value"}, :key, "fallback")
"value"
-iex> ed(%{key: nil}, :key, "fallback")
+iex> ed(%{key: nil}, :key, "fallback")
"fallback"
-iex> ed(%{key: "value"}, :missing_key, "fallback")
+iex> ed(%{key: "value"}, :missing_key, "fallback")
"fallback"
-iex> ed(%{key: %Ecto.Association.NotLoaded{}}, :key, "fallback")
+iex> ed(%{key: %Ecto.Association.NotLoaded{}}, :key, "fallback")
"fallback"
-iex> ed({:ok, %{key: "value"}}, :key, "fallback")
+iex> ed({:ok, %{key: "value"}}, :key, "fallback")
"value"
-iex> ed(%{__context__: %{key: "context_value"}}, :key, "fallback")
+iex> ed(%{__context__: %{key: "context_value"}}, :key, "fallback")
"context_value"
-iex> ed(%{a: %{b: "value"}}, :a, :b, "fallback")
+iex> ed(%{a: %{b: "value"}}, :a, :b, "fallback")
"value"
-iex> ed(%{a: %{b: %Ecto.Association.NotLoaded{}}}, :a, :b, "fallback")
+iex> ed(%{a: %{b: %Ecto.Association.NotLoaded{}}}, :a, :b, "fallback")
"fallback"
-iex> ed(%{a: %{b: "value"}}, [:a, :b], "fallback")
+iex> ed(%{a: %{b: "value"}}, [:a, :b], "fallback")
"value"
-iex> ed(%{a: %{b: nil}}, :a, :b, "fallback")
+iex> ed(%{a: %{b: nil}}, :a, :b, "fallback")
"fallback"
-iex> ed(%{a: %{b: %{c: "value"}}}, :a, :b, :c, "fallback")
+iex> ed(%{a: %{b: %{c: "value"}}}, :a, :b, :c, "fallback")
"value"
-iex> ed(%{a: %{b: %{c: "value"}}}, :a, :b, :c, :d, "fallback")
+iex> ed(%{a: %{b: %{c: "value"}}}, :a, :b, :c, :d, "fallback")
"fallback"
-iex> ed(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, "fallback")
+iex> ed(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, "fallback")
"value"
-iex> ed(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, :ed, "fallback")
+iex> ed(%{a: %{b: %{c: %{d: "value"}}}}, :a, :b, :c, :d, :ed, "fallback")
"fallback"
-iex> ed(%{a: %{b: %{c: %{d: %{e: "value"}}}}}, :a, :b, :c, :d, :e, "fallback")
+iex> ed(%{a: %{b: %{c: %{d: %{e: "value"}}}}}, :a, :b, :c, :d, :e, "fallback")
"value"
diff --git a/Bonfire.Common.Enums.html b/Bonfire.Common.Enums.html
index d8decd7db2..5ca434ad9a 100644
--- a/Bonfire.Common.Enums.html
+++ b/Bonfire.Common.Enums.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Enums — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Enums — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Enums
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -751,10 +751,10 @@ all_ok?(enum)
Examples
-iex> Bonfire.Common.Enums.all_ok?([{:ok, 1}, {:ok, 2}])
+iex> Bonfire.Common.Enums.all_ok?([{:ok, 1}, {:ok, 2}])
true
-iex> Bonfire.Common.Enums.all_ok?([{:ok, 1}, {:error, "failed"}])
+iex> Bonfire.Common.Enums.all_ok?([{:ok, 1}, {:error, "failed"}])
false
@@ -783,17 +783,17 @@ all_oks_or_error(enum)
Examples
-iex> Bonfire.Common.Enums.all_oks_or_error([{:ok, 1}, {:error, "failed"}])
-{:error, ["failed"]}
+iex> Bonfire.Common.Enums.all_oks_or_error([{:ok, 1}, {:error, "failed"}])
+{:error, ["failed"]}
-iex> Bonfire.Common.Enums.all_oks_or_error([{:ok, 2}, {:ok, 3}])
-{:ok, [2, 3]}
+iex> Bonfire.Common.Enums.all_oks_or_error([{:ok, 2}, {:ok, 3}])
+{:ok, [2, 3]}
-iex> Bonfire.Common.Enums.all_oks_or_error({:error, "failed"})
-{:error, ["failed"]}
+iex> Bonfire.Common.Enums.all_oks_or_error({:error, "failed"})
+{:error, ["failed"]}
-iex> Bonfire.Common.Enums.all_oks_or_error({:ok, 1})
-{:ok, [1]}
+iex> Bonfire.Common.Enums.all_oks_or_error({:ok, 1})
+{:ok, [1]}
@@ -845,10 +845,10 @@ count_where(collection, function \\ &is
Examples
-iex> Bonfire.Common.Enums.count_where([1, 2, 3, 4, 5], fn x -> rem(x, 2) == 0 end)
+iex> Bonfire.Common.Enums.count_where([1, 2, 3, 4, 5], fn x -> rem(x, 2) == 0 end)
2
-iex> Bonfire.Common.Enums.count_where([:ok, :error, :ok], &(&1 == :ok))
+iex> Bonfire.Common.Enums.count_where([:ok, :error, :ok], &(&1 == :ok))
2
@@ -1042,13 +1042,13 @@ fun(map, fun, args \\ [])
Examples
-> Bonfire.Common.Enums.fun(%{a: 1, b: 2}, :values)
-[2, 1]
+> Bonfire.Common.Enums.fun(%{a: 1, b: 2}, :values)
+[2, 1]
-iex> Bonfire.Common.Enums.fun([a: 1, b: 2], :values)
-[1, 2]
+iex> Bonfire.Common.Enums.fun([a: 1, b: 2], :values)
+[1, 2]
-iex> Bonfire.Common.Enums.fun([1, 2, 3], :first)
+iex> Bonfire.Common.Enums.fun([1, 2, 3], :first)
1
@@ -1121,10 +1121,10 @@ group(list, fun)
Examples
-iex> Bonfire.Common.Enums.group([1, 2, 3], fn x -> x end)
-%{1 => 1, 2 => 2, 3 => 3}
+iex> Bonfire.Common.Enums.group([1, 2, 3], fn x -> x end)
+%{1 => 1, 2 => 2, 3 => 3}
-> Bonfire.Common.Enums.group([:a, :b, :b, :c], fn x -> x end)
+> Bonfire.Common.Enums.group([:a, :b, :b, :c], fn x -> x end)
** (throw) "Expected a unique value"
@@ -1153,10 +1153,10 @@ group_map(list, fun)
Examples
-iex> Bonfire.Common.Enums.group_map([:a, :b, :c], fn x -> {x, to_string(x)} end)
-%{a: "a", b: "b", c: "c"}
+iex> Bonfire.Common.Enums.group_map([:a, :b, :c], fn x -> {x, to_string(x)} end)
+%{a: "a", b: "b", c: "c"}
-> Bonfire.Common.Enums.group_map([1, 2, 2, 3], fn x -> {x, x * 2} end)
+> Bonfire.Common.Enums.group_map([1, 2, 2, 3], fn x -> {x, x * 2} end)
** (throw) "Expected a unique value"
@@ -1209,10 +1209,10 @@ has_error?(enum)
Examples
-iex> Bonfire.Common.Enums.has_error?([{:ok, 1}, {:error, "failed"}])
+iex> Bonfire.Common.Enums.has_error?([{:ok, 1}, {:error, "failed"}])
true
-iex> Bonfire.Common.Enums.has_error?([{:ok, 1}])
+iex> Bonfire.Common.Enums.has_error?([{:ok, 1}])
false
@@ -1241,10 +1241,10 @@ has_ok?(enum)
Examples
-iex> Bonfire.Common.Enums.has_ok?([{:ok, 1}, {:error, "failed"}])
+iex> Bonfire.Common.Enums.has_ok?([{:ok, 1}, {:error, "failed"}])
true
-iex> Bonfire.Common.Enums.has_ok?([{:error, "failed"}])
+iex> Bonfire.Common.Enums.has_ok?([{:error, "failed"}])
false
@@ -1273,10 +1273,10 @@ has_tuple_key?(enum, key)
Examples
-iex> Bonfire.Common.Enums.has_tuple_key?([{:ok, 1}, {:error, "failed"}], :ok)
+iex> Bonfire.Common.Enums.has_tuple_key?([{:ok, 1}, {:error, "failed"}], :ok)
true
-iex> Bonfire.Common.Enums.has_tuple_key?([{:ok, 1}], :error)
+iex> Bonfire.Common.Enums.has_tuple_key?([{:ok, 1}], :error)
false
@@ -1321,11 +1321,11 @@ ids(objects)
-Extracts the IDs from a list of maps, changesets, or other data structures and returns a list of these IDs.
iex> ids([%{id: 1, name: "Alice"}, %{id: 2, name: "Bob"}])
- [1, 2]
+Extracts the IDs from a list of maps, changesets, or other data structures and returns a list of these IDs.
iex> ids([%{id: 1, name: "Alice"}, %{id: 2, name: "Bob"}])
+ [1, 2]
- iex> ids(%{id: 3})
- [3]
+ iex> ids(%{id: 3})
+ [3]
@@ -1377,16 +1377,16 @@ input_to_value(v, _, including_values, _, f
Examples
-iex> input_to_value("42", false, true, nil, true, nil, true)
+iex> input_to_value("42", false, true, nil, true, nil, true)
42
-iex> input_to_value("Bonfire.Common", false, true, nil, true, nil, false)
+iex> input_to_value("Bonfire.Common", false, true, nil, true, nil, false)
Bonfire.Common
-iex> input_to_value("bonfire_common", false, true, nil, true, nil, false)
+iex> input_to_value("bonfire_common", false, true, nil, true, nil, false)
:bonfire_common
-iex> input_to_value("unknown_example_string", false, true, nil, true, nil, false)
+iex> input_to_value("unknown_example_string", false, true, nil, true, nil, false)
"unknown_example_string"
@@ -1533,8 +1533,8 @@ map_put_in(root \\ %{}, keys, value)
Examples
-iex> map_put_in(%{}, [:a, :b, :c], 3)
-%{a: %{b: %{c: 3}}}
+iex> map_put_in(%{}, [:a, :b, :c], 3)
+%{a: %{b: %{c: 3}}}
@@ -2103,11 +2103,11 @@ unwrap_tuples(enum, key)
Examples
-iex> Bonfire.Common.Enums.unwrap_tuples([{:ok, 1}, {:error, "failed"}, {:ok, 2}], :ok)
-[1, 2]
+iex> Bonfire.Common.Enums.unwrap_tuples([{:ok, 1}, {:error, "failed"}, {:ok, 2}], :ok)
+[1, 2]
-iex> Bonfire.Common.Enums.unwrap_tuples([{:ok, 1}, {:error, "failed"}], :error)
-["failed"]
+iex> Bonfire.Common.Enums.unwrap_tuples([{:ok, 1}, {:error, "failed"}], :error)
+["failed"]
diff --git a/Bonfire.Common.Errors.html b/Bonfire.Common.Errors.html
index 020625aeba..c30359e078 100644
--- a/Bonfire.Common.Errors.html
+++ b/Bonfire.Common.Errors.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Errors — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Errors — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Errors
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -373,9 +373,9 @@ debug_exception(msg, exception \\ nil, stac
Examples
-iex> debug_exception("An error occurred", %RuntimeError{message: "error"}, nil, :error, [])
+iex> debug_exception("An error occurred", %RuntimeError{message: "error"}, nil, :error, [])
# Output: An error occurred: %RuntimeError{message: "error"}
-{:error, "An error occurred"}
+{:error, "An error occurred"}
@@ -411,10 +411,10 @@ debug_log(msg, exception \\ nil, stacktrace
Examples
-> debug_log("A debug message", %RuntimeError{message: "error"}, nil, :error)
+> debug_log("A debug message", %RuntimeError{message: "error"}, nil, :error)
# Output: A debug message: %RuntimeError{message: "error"}
-> debug_log("A debug message", nil, nil, :info)
+> debug_log("A debug message", nil, nil, :info)
# Output: A debug message: nil
@@ -443,13 +443,13 @@ error_msg(errors)
Examples
-iex> error_msg([{:error, "something went wrong"}])
-["something went wrong"]
+iex> error_msg([{:error, "something went wrong"}])
+["something went wrong"]
-iex> error_msg(%{message: "custom error"})
+iex> error_msg(%{message: "custom error"})
"custom error"
-iex> error_msg(:some_other_error)
+iex> error_msg(:some_other_error)
":some_other_error"
@@ -482,16 +482,16 @@ format_banner(kind, exception, stacktrace \
Examples
-iex> format_banner(:error, %RuntimeError{message: "error"})
+iex> format_banner(:error, %RuntimeError{message: "error"})
"** Elixir.RuntimeError: error"
-iex> format_banner(:throw, :some_reason)
+iex> format_banner(:throw, :some_reason)
"** (throw) :some_reason"
-iex> format_banner(:exit, :some_reason)
+iex> format_banner(:exit, :some_reason)
"** (exit) :some_reason"
-> format_banner({:EXIT, self()}, :some_reason)
+> format_banner({:EXIT, self()}, :some_reason)
"** (EXIT from #PID<0.780.0>) :some_reason"
@@ -542,13 +542,13 @@ format_mfa(module, fun, arity)
Examples
-iex> format_mfa(Foo, :bar, 1)
-{"Foo", "bar", "Foo.bar/1"}
+iex> format_mfa(Foo, :bar, 1)
+{"Foo", "bar", "Foo.bar/1"}
-iex> format_mfa(Foo, :bar, [])
-{"Foo", "bar", "Foo.bar()"}
+iex> format_mfa(Foo, :bar, [])
+{"Foo", "bar", "Foo.bar()"}
-iex> Exception.format_mfa(nil, :bar, [])
+iex> Exception.format_mfa(nil, :bar, [])
"nil.bar()"
@@ -581,10 +581,10 @@ format_stacktrace(trace \\ nil, opts \\ [])
Examples
-> format_stacktrace([{MyModule, :my_fun, 1, [file: 'my_file.ex', line: 42]}], [])
+> format_stacktrace([{MyModule, :my_fun, 1, [file: 'my_file.ex', line: 42]}], [])
"my_file.ex:42: MyModule.my_fun/1"
-> format_stacktrace(nil, [])
+> format_stacktrace(nil, [])
"stacktrace here..."
@@ -615,10 +615,10 @@ format_stacktrace_entry(entry, opts \\ [])<
Examples
-iex> format_stacktrace_entry({MyModule, :my_fun, 1, [file: 'my_file.ex', line: 42]}, [])
+iex> format_stacktrace_entry({MyModule, :my_fun, 1, [file: 'my_file.ex', line: 42]}, [])
"my_file.ex:42: MyModule.my_fun/1"
-> format_stacktrace_entry({fn -> :ok end, 0, [file: 'another_file.ex', line: 7]}, [])
+> format_stacktrace_entry({fn -> :ok end, 0, [file: 'another_file.ex', line: 7]}, [])
"another_file.ex:7: some_fun/2"
@@ -691,10 +691,10 @@ map_error(other, fun)
Examples
-iex> map_error({:error, :some_error}, &(&1 |> to_string()))
+iex> map_error({:error, :some_error}, &(&1 |> to_string()))
"some_error"
-iex> map_error(42, &(&1 * 2))
+iex> map_error(42, &(&1 * 2))
42
@@ -729,13 +729,13 @@ maybe_ok_error(other, change_fn)
Examples
-iex> maybe_ok_error({:ok, 42}, &(&1 * 2))
-{:ok, 84}
+iex> maybe_ok_error({:ok, 42}, &(&1 * 2))
+{:ok, 84}
-iex> maybe_ok_error({:error, :some_error}, &(&1 * 2))
-{:error, :some_error}
+iex> maybe_ok_error({:error, :some_error}, &(&1 * 2))
+{:error, :some_error}
-iex> maybe_ok_error(42, &(&1 * 2))
+iex> maybe_ok_error(42, &(&1 * 2))
42
@@ -812,10 +812,10 @@ replace_error(other, value)
Examples
-iex> replace_error({:error, :old_value}, :new_value)
-{:error, :new_value}
+iex> replace_error({:error, :old_value}, :new_value)
+{:error, :new_value}
-iex> replace_error(42, :new_value)
+iex> replace_error(42, :new_value)
42
diff --git a/Bonfire.Common.Extend.html b/Bonfire.Common.Extend.html
index 8382c50304..34297fd704 100644
--- a/Bonfire.Common.Extend.html
+++ b/Bonfire.Common.Extend.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Extend — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Extend — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Extend
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -673,10 +673,10 @@ application_for_module(module)
Examples
-iex> application_for_module(Bonfire.Common)
+iex> application_for_module(Bonfire.Common)
:bonfire_common
-iex> application_for_module(SomeUnknownModule)
+iex> application_for_module(SomeUnknownModule)
nil
@@ -705,7 +705,7 @@ beam_file_from_object_code(module)
Examples
-> beam_file_from_object_code(Bonfire.Common)
+> beam_file_from_object_code(Bonfire.Common)
"/path/ebin/Elixir.Bonfire.Common.beam"
@@ -780,13 +780,13 @@ disabled_value?(value)
Examples
-iex> disabled_value?(:disabled)
+iex> disabled_value?(:disabled)
true
-iex> disabled_value?(false)
+iex> disabled_value?(false)
false
-iex> disabled_value?(disabled: true)
+iex> disabled_value?(disabled: true)
true
@@ -848,16 +848,16 @@ extension_enabled?(module_or_otp_app, opts
Examples
-iex> extension_enabled?(Bonfire.Common)
+iex> extension_enabled?(Bonfire.Common)
true
-iex> extension_enabled?(:bonfire_common)
+iex> extension_enabled?(:bonfire_common)
true
-iex> extension_enabled?(SomeOtherModule)
+iex> extension_enabled?(SomeOtherModule)
false
-iex> extension_enabled?(:non_existent_extension)
+iex> extension_enabled?(:non_existent_extension)
false
@@ -914,7 +914,7 @@ fetch_docs_as_markdown(module)
Examples
-> fetch_docs_as_markdown(SomeModule)
+> fetch_docs_as_markdown(SomeModule)
"This is the moduledoc for SomeModule"
@@ -971,7 +971,7 @@ file_code(code_file)
Examples
-> file_code("mix.ex")
+> file_code("mix.ex")
"defmodule ... end"
@@ -1002,8 +1002,8 @@ function_ast(module, fun, opts \\ [])
Examples
-> function_ast(Bonfire.Common, :some_function)
-[{:def, [...], [...]}, ...]
+> function_ast(Bonfire.Common, :some_function)
+[{:def, [...], [...]}, ...]
@@ -1033,7 +1033,7 @@ function_code(module, fun, opts \\ [])
Examples
-> function_code(Bonfire.Common, :some_function)
+> function_code(Bonfire.Common, :some_function)
"def some_function do ... end"
@@ -1064,7 +1064,7 @@ function_line_number(module, fun, opts \\ [
Examples
-> function_line_number(Bonfire.Common, :some_function)
+> function_line_number(Bonfire.Common, :some_function)
10
@@ -1095,8 +1095,8 @@ function_line_numbers(module, fun, opts \\
Examples
-> function_line_numbers(Bonfire.Common, :some_function)
-{10, 20}
+> function_line_numbers(Bonfire.Common, :some_function)
+{10, 20}
@@ -1124,7 +1124,7 @@ generate_reverse_router!()
Examples
-iex> generate_reverse_router!()
+iex> generate_reverse_router!()
:ok
@@ -1181,11 +1181,11 @@ import_if_enabled(module, opts \\ [], fallb
Examples
-defmodule MyModule do
+defmodule MyModule do
import_if_enabled SomeExtension
# or
- import_if_enabled SomeExtension, [], FallbackModule
-end
+ import_if_enabled SomeExtension, [], FallbackModule
+end
@@ -1215,7 +1215,7 @@ inject_function(module, fun, target_module
Examples
-iex> inject_function(Common.TextExtended, :blank?)
+iex> inject_function(Common.TextExtended, :blank?)
@@ -1245,7 +1245,7 @@ loaded_applications_map(opts \\ [cache: fal
Examples
-iex> %{bonfire_common: {_version, _description} } = loaded_applications_map()
+iex> %{bonfire_common: {_version, _description} } = loaded_applications_map()
@@ -1275,7 +1275,7 @@ loaded_applications_names(opts \\ [cache: f
Examples
-iex> %{bonfire_common: true} = loaded_applications_names()
+iex> %{bonfire_common: true} = loaded_applications_names()
@@ -1303,7 +1303,7 @@ macro_inspect(fun)
Examples
-iex> macro_inspect(fn -> quote do: 1 + 1 end)
+iex> macro_inspect(fn -> quote do: 1 + 1 end)
"1 + 1"
@@ -1332,13 +1332,13 @@ maybe_extension_loaded(module_or_otp_app)
Examples
-iex> maybe_extension_loaded(Bonfire.Common)
+iex> maybe_extension_loaded(Bonfire.Common)
:bonfire_common
-iex> maybe_extension_loaded(:bonfire_common)
+iex> maybe_extension_loaded(:bonfire_common)
:bonfire_common
-iex> maybe_extension_loaded(:non_existent_app)
+iex> maybe_extension_loaded(:non_existent_app)
:non_existent_app
@@ -1367,10 +1367,10 @@ maybe_extension_loaded!(module_or_otp_app)<
Examples
-iex> maybe_extension_loaded!(Bonfire.Common)
+iex> maybe_extension_loaded!(Bonfire.Common)
:bonfire_common
-iex> maybe_extension_loaded!(:non_existent_app)
+iex> maybe_extension_loaded!(:non_existent_app)
nil
@@ -1401,18 +1401,18 @@ maybe_module(module, opts \\ [])
Examples
-iex> maybe_module(Bonfire.Common)
+iex> maybe_module(Bonfire.Common)
Bonfire.Common
-iex> Config.put(DisabledModule, modularity: :disabled)
-iex> maybe_module(DisabledModule)
+iex> Config.put(DisabledModule, modularity: :disabled)
+iex> maybe_module(DisabledModule)
nil
-iex> Config.put([Bonfire.Common.Text], modularity: Bonfire.Common.TextExtended)
-iex> maybe_module(Bonfire.Common.Text)
+iex> Config.put([Bonfire.Common.Text], modularity: Bonfire.Common.TextExtended)
+iex> maybe_module(Bonfire.Common.Text)
Bonfire.Common.TextExtended
-iex> Config.put([Bonfire.Common.Text], modularity: Bonfire.Common.Text)
-iex> maybe_module(Bonfire.Common.Text)
+iex> Config.put([Bonfire.Common.Text], modularity: Bonfire.Common.Text)
+iex> maybe_module(Bonfire.Common.Text)
Bonfire.Common.Text
@@ -1443,10 +1443,10 @@ maybe_module!(module, opts \\ [])
Examples
-iex> maybe_module!(Bonfire.Common)
+iex> maybe_module!(Bonfire.Common)
Bonfire.Common
-iex> maybe_module!(SomeDisabledModule)
+iex> maybe_module!(SomeDisabledModule)
** (RuntimeError) Module Elixir.SomeDisabledModule is disabled and no replacement was configured
@@ -1475,10 +1475,10 @@ maybe_module_loaded(module)
Examples
-iex> maybe_module_loaded(Bonfire.Common)
+iex> maybe_module_loaded(Bonfire.Common)
Bonfire.Common
-iex> maybe_module_loaded(NonExistentModule)
+iex> maybe_module_loaded(NonExistentModule)
nil
@@ -1507,10 +1507,10 @@ maybe_schema_or_pointer(schema_module)
Examples
-> maybe_schema_or_pointer(SomeSchema)
+> maybe_schema_or_pointer(SomeSchema)
SomeSchema
-iex> maybe_schema_or_pointer(NonExistentSchema)
+iex> maybe_schema_or_pointer(NonExistentSchema)
Needle.Pointer
@@ -1541,7 +1541,7 @@ module_ast_normalize(module, ast, target \\
Examples
-> module_ast_normalize(Bonfire.Common, ast)
+> module_ast_normalize(Bonfire.Common, ast)
@@ -1571,7 +1571,7 @@ module_beam_code(module, opts \\ [])
Examples
-iex> {:ok, _} = module_beam_code(Bonfire.Common)
+iex> {:ok, _} = module_beam_code(Bonfire.Common)
@@ -1599,7 +1599,7 @@ module_behaviour?(module, behaviour)
Examples
-> module_behaviour?(MyModule, SomeBehaviour)
+> module_behaviour?(MyModule, SomeBehaviour)
true
@@ -1628,8 +1628,8 @@ module_behaviours(module)
Examples
-> module_behaviours(MyModule)
-[SomeBehaviour, AnotherBehaviour]
+> module_behaviours(MyModule)
+[SomeBehaviour, AnotherBehaviour]
@@ -1659,7 +1659,7 @@ module_code(module, opts \\ [])
Examples
-> module_code(Bonfire.Common)
+> module_code(Bonfire.Common)
"defmodule Bonfire.Common do ... end"
@@ -1690,7 +1690,7 @@ module_code_from_ast(module, ast, target \\
Examples
-> module_code_from_ast(Bonfire.Common, ast)
+> module_code_from_ast(Bonfire.Common, ast)
"defmodule Bonfire.Common do ... end"
@@ -1719,7 +1719,7 @@ module_code_from_object_code(module)
Examples
-> module_code_from_object_code(Bonfire.Common)
+> module_code_from_object_code(Bonfire.Common)
"defmodule Bonfire.Common do ... end"
@@ -1750,10 +1750,10 @@ module_enabled?(module, opts \\ [])
Examples
-iex> module_enabled?(Bonfire.Common)
+iex> module_enabled?(Bonfire.Common)
true
-iex> module_enabled?(SomeDisabledModule)
+iex> module_enabled?(SomeDisabledModule)
false
@@ -1782,10 +1782,10 @@ module_exists?(module)
Examples
-iex> module_exists?(Bonfire.Common)
+iex> module_exists?(Bonfire.Common)
true
-iex> module_exists?(SomeOtherModule)
+iex> module_exists?(SomeOtherModule)
false
@@ -1814,7 +1814,7 @@ module_file(module)
Examples
-> module_file(Bonfire.Common)
+> module_file(Bonfire.Common)
"/path/lib/common.ex"
@@ -1845,7 +1845,7 @@ module_file_code(module, opts \\ [])
Examples
-> module_file_code(Bonfire.Common)
+> module_file_code(Bonfire.Common)
"defmodule Bonfire.Common do ... end"
@@ -1874,7 +1874,7 @@ module_file_from_object_code(module)
Examples
-> module_file_from_object_code(Bonfire.Common)
+> module_file_from_object_code(Bonfire.Common)
@@ -1902,8 +1902,8 @@ module_object_byte_code(module)
Examples
-> module_object_byte_code(Bonfire.Common)
-<<...>>
+> module_object_byte_code(Bonfire.Common)
+<<...>>
@@ -1931,7 +1931,7 @@ module_object_code_tuple(module)
Examples
-iex> {Bonfire.Common, _bytecode, _path} = module_object_code_tuple(Bonfire.Common)
+iex> {Bonfire.Common, _bytecode, _path} = module_object_code_tuple(Bonfire.Common)
@@ -2049,11 +2049,11 @@ require_if_enabled(module, opts \\ [], fall
Examples
-defmodule MyModule do
+defmodule MyModule do
require_if_enabled SomeExtension
# or
- require_if_enabled SomeExtension, [], FallbackModule
-end
+ require_if_enabled SomeExtension, [], FallbackModule
+end
@@ -2103,7 +2103,7 @@ tar_file_code(code_file)
Examples
-> tar_file_code("/mix.exs")
+> tar_file_code("/mix.exs")
"defmodule ... end"
@@ -2138,11 +2138,11 @@ use_if_enabled(module, opts \\ [], fallback
Examples
-defmodule MyModule do
+defmodule MyModule do
use_if_enabled SomeExtension
# or
- use_if_enabled SomeExtension, [], FallbackModule
-end
+ use_if_enabled SomeExtension, [], FallbackModule
+end
diff --git a/Bonfire.Common.ExtensionBehaviour.html b/Bonfire.Common.ExtensionBehaviour.html
index ac677fd2ea..4829c600f8 100644
--- a/Bonfire.Common.ExtensionBehaviour.html
+++ b/Bonfire.Common.ExtensionBehaviour.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.ExtensionBehaviour — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.ExtensionBehaviour — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.ExtensionBehaviour behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.ExtensionModule.html b/Bonfire.Common.ExtensionModule.html
index 98c831ecec..a2143f0e88 100644
--- a/Bonfire.Common.ExtensionModule.html
+++ b/Bonfire.Common.ExtensionModule.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.ExtensionModule — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.ExtensionModule — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.ExtensionModule behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Extensions.Diff.html b/Bonfire.Common.Extensions.Diff.html
index 6b98680b15..630e92160e 100644
--- a/Bonfire.Common.Extensions.Diff.html
+++ b/Bonfire.Common.Extensions.Diff.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Extensions.Diff — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Extensions.Diff — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Extensions.Diff
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -299,7 +299,7 @@ analyse_repo_latest_diff_stream(path_diff)<
Examples
-> {:ok, stream} = Bonfire.Common.Extensions.Diff.analyse_repo_latest_diff_stream("./path/to/diff.patch")
+> {:ok, stream} = Bonfire.Common.Extensions.Diff.analyse_repo_latest_diff_stream("./path/to/diff.patch")
@@ -333,11 +333,11 @@ generate_diff(ref_or_branch, repo_path)
Examples
-> Bonfire.Common.Extensions.Diff.generate_diff("main", "./")
-{:ok, "Diff generated successfully", "...diff content..."}
+> Bonfire.Common.Extensions.Diff.generate_diff("main", "./")
+{:ok, "Diff generated successfully", "...diff content..."}
-> Bonfire.Common.Extensions.Diff.generate_diff("test_fake_branch", "./")
-{:error, "Could not generate latest diff."}
+> Bonfire.Common.Extensions.Diff.generate_diff("test_fake_branch", "./")
+{:error, "Could not generate latest diff."}
@@ -377,7 +377,7 @@ git!(args, repo_path \\ ".", into
Examples
-> Bonfire.Common.Extensions.Diff.git!(["status"], "./")
+> Bonfire.Common.Extensions.Diff.git!(["status"], "./")
@@ -457,7 +457,7 @@ git_generate_diff(ref_or_branch, repo_path,
Examples
-iex> Bonfire.Common.Extensions.Diff.git_generate_diff("main", "./", "./data/test_output.patch")
+iex> Bonfire.Common.Extensions.Diff.git_generate_diff("main", "./", "./data/test_output.patch")
@@ -513,11 +513,11 @@ parse_repo_latest_diff(path_diff)
Examples
-> Bonfire.Common.Extensions.Diff.parse_repo_latest_diff("./path/to/diff.patch")
-{:ok, ...}
+> Bonfire.Common.Extensions.Diff.parse_repo_latest_diff("./path/to/diff.patch")
+{:ok, ...}
-> Bonfire.Common.Extensions.Diff.parse_repo_latest_diff("./path/to/empty.patch")
-{:error, :no_diff}
+> Bonfire.Common.Extensions.Diff.parse_repo_latest_diff("./path/to/empty.patch")
+{:error, :no_diff}
@@ -553,11 +553,11 @@ repo_latest_diff(ref_or_branch, repo_path,
Examples
-> Bonfire.Common.Extensions.Diff.repo_latest_diff("main", "./")
-{:ok, "Diff message", "...diff content..."}
+> Bonfire.Common.Extensions.Diff.repo_latest_diff("main", "./")
+{:ok, "Diff message", "...diff content..."}
-> Bonfire.Common.Extensions.Diff.repo_latest_diff("test_fake_branch", "./")
-{:error, :no_diff}
+> Bonfire.Common.Extensions.Diff.repo_latest_diff("test_fake_branch", "./")
+{:error, :no_diff}
diff --git a/Bonfire.Common.Extensions.html b/Bonfire.Common.Extensions.html
index 901d77e10f..5a9b8b860c 100644
--- a/Bonfire.Common.Extensions.html
+++ b/Bonfire.Common.Extensions.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Extensions — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Extensions — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Extensions
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -312,8 +312,8 @@ all_deps()
Examples
-> Bonfire.Common.Extensions.all_deps()
-[%Mix.Dep{...}, %Mix.Dep{...}]
+> Bonfire.Common.Extensions.all_deps()
+[%Mix.Dep{...}, %Mix.Dep{...}]
@@ -369,13 +369,13 @@ dep_name(dep)
Examples
-iex> Bonfire.Common.Extensions.dep_name(%Mix.Dep{app: :my_app})
+iex> Bonfire.Common.Extensions.dep_name(%Mix.Dep{app: :my_app})
:my_app
-iex> Bonfire.Common.Extensions.dep_name(:my_app)
+iex> Bonfire.Common.Extensions.dep_name(:my_app)
:my_app
-iex> Bonfire.Common.Extensions.dep_name("my_app")
+iex> Bonfire.Common.Extensions.dep_name("my_app")
"my_app"
@@ -410,10 +410,10 @@ get_branch(arg1)
Examples
-iex> Bonfire.Common.Extensions.get_branch(%{git: nil, branch: "main"})
+iex> Bonfire.Common.Extensions.get_branch(%{git: nil, branch: "main"})
"main"
-iex> Bonfire.Common.Extensions.get_branch(%{lock: {:git, nil, nil, [branch: "feature"]}})
+iex> Bonfire.Common.Extensions.get_branch(%{lock: {:git, nil, nil, [branch: "feature"]}})
"feature"
@@ -448,7 +448,7 @@ get_code_link(dep)
Examples
-iex> Bonfire.Common.Extensions.get_code_link(%{app: "my_app"})
+iex> Bonfire.Common.Extensions.get_code_link(%{app: "my_app"})
"/settings/extensions/code/my_app"
@@ -483,10 +483,10 @@ get_link(dep)
Examples
-iex> Bonfire.Common.Extensions.get_link(%{hex: "example_package"})
+iex> Bonfire.Common.Extensions.get_link(%{hex: "example_package"})
"https://hex.pm/packages/example_package"
-iex> Bonfire.Common.Extensions.get_link(%{git: "https://github.com/user/repo", branch: "main"})
+iex> Bonfire.Common.Extensions.get_link(%{git: "https://github.com/user/repo", branch: "main"})
"https://github.com/user/repo/tree/main"
@@ -521,10 +521,10 @@ get_version(dep)
Examples
-iex> Bonfire.Common.Extensions.get_version(%{status: {:ok, "1.0.0"}})
+iex> Bonfire.Common.Extensions.get_version(%{status: {:ok, "1.0.0"}})
"1.0.0"
-iex> Bonfire.Common.Extensions.get_version(%{requirement: ">= 1.0.0"})
+iex> Bonfire.Common.Extensions.get_version(%{requirement: ">= 1.0.0"})
">= 1.0.0"
@@ -559,10 +559,10 @@ get_version_link(dep)
Examples
-iex> Bonfire.Common.Extensions.get_version_link(%{app: "my_app", path: "file.ex"})
+iex> Bonfire.Common.Extensions.get_version_link(%{app: "my_app", path: "file.ex"})
"/settings/extensions/diff?app=my_app&local=file.ex"
-iex> Bonfire.Common.Extensions.get_version_link(%{lock: {:git, "https://github.com/user/repo", "abc123", [branch: "main"]}})
+iex> Bonfire.Common.Extensions.get_version_link(%{lock: {:git, "https://github.com/user/repo", "abc123", [branch: "main"]}})
"https://github.com/user/repo/compare/abc123...main"
@@ -597,7 +597,7 @@ global_disable(extension)
Examples
-> {:ok, %Bonfire.Data.Identity.Settings{json: %{bonfire: %{my_test_extension: %{modularity: :disabled}}}}} = Bonfire.Common.Extensions.global_disable(:my_test_extension)
+> {:ok, %Bonfire.Data.Identity.Settings{json: %{bonfire: %{my_test_extension: %{modularity: :disabled}}}}} = Bonfire.Common.Extensions.global_disable(:my_test_extension)
@@ -631,7 +631,7 @@ global_enable(extension)
Examples
-> {:ok, %Bonfire.Data.Identity.Settings{json: %{bonfire: %{my_test_extension: %{modularity: nil}}}}} = Bonfire.Common.Extensions.global_enable(:my_test_extension)
+> {:ok, %Bonfire.Data.Identity.Settings{json: %{bonfire: %{my_test_extension: %{modularity: nil}}}}} = Bonfire.Common.Extensions.global_enable(:my_test_extension)
@@ -667,11 +667,11 @@ loaded_deps(opts \\ [])
Examples
-> Bonfire.Common.Extensions.loaded_deps(:flat)
-[%Mix.Dep{}, %Mix.Dep{}, ...]
+> Bonfire.Common.Extensions.loaded_deps(:flat)
+[%Mix.Dep{}, %Mix.Dep{}, ...]
-> Bonfire.Common.Extensions.loaded_deps(:tree_flat)
-[%Mix.Dep{}, %Mix.Dep{}, ...]
+> Bonfire.Common.Extensions.loaded_deps(:tree_flat)
+[%Mix.Dep{}, %Mix.Dep{}, ...]
@@ -707,8 +707,8 @@ loaded_deps_names(opts \\ [])
Examples
-> Bonfire.Common.Extensions.loaded_deps_names()
-[:dep1, :dep2]
+> Bonfire.Common.Extensions.loaded_deps_names()
+[:dep1, :dep2]
diff --git a/Bonfire.Common.HTTP.Connection.html b/Bonfire.Common.HTTP.Connection.html
index 4c2dc8983d..6bd96f5db1 100644
--- a/Bonfire.Common.HTTP.Connection.html
+++ b/Bonfire.Common.HTTP.Connection.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.HTTP.Connection — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.HTTP.Connection — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.HTTP.Connection
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.HTTP.RequestBuilder.html b/Bonfire.Common.HTTP.RequestBuilder.html
index a409a3026e..e6ba4e5349 100644
--- a/Bonfire.Common.HTTP.RequestBuilder.html
+++ b/Bonfire.Common.HTTP.RequestBuilder.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.HTTP.RequestBuilder — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.HTTP.RequestBuilder — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.HTTP.RequestBuilder
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.HTTP.html b/Bonfire.Common.HTTP.html
index bdadd29b76..50741c3214 100644
--- a/Bonfire.Common.HTTP.html
+++ b/Bonfire.Common.HTTP.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.HTTP — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.HTTP — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.HTTP
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Localise.Cldr.AcceptLanguage.html b/Bonfire.Common.Localise.Cldr.AcceptLanguage.html
index ad02b4b86e..37370066d6 100644
--- a/Bonfire.Common.Localise.Cldr.AcceptLanguage.html
+++ b/Bonfire.Common.Localise.Cldr.AcceptLanguage.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.AcceptLanguage — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.AcceptLanguage — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.AcceptLanguage
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -143,7 +143,7 @@
the set of natural languages that are preferred as a response to the request.
Language tags function are provided in Cldr.LanguageTag.
The format of an Accept-Language header is as follows in ABNF format:
Accept-Language = "Accept-Language" ":"
1#( language-range [ ";" "q" "=" qvalue ] )
- language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )
Each language-range MAY be given an associated quality value which represents an
+
language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )
Each language-range MAY be given an associated quality value which represents an
estimate of the user's preference for the languages specified by that range. The
quality value defaults to "q=1". For example,
Accept-Language: da, en-gb;q=0.8, en;q=0.7
would mean: "I prefer Danish, but will accept British English and other types of English."
@@ -257,54 +257,54 @@ best_match(accept_language)
Examples
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("da;q=0.1,zh-TW;q=0.3", TestBackend.Cldr)
-{:ok,
- %Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("da;q=0.1,zh-TW;q=0.3", TestBackend.Cldr)
+{:ok,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "zh-TW",
cldr_locale_name: :"zh-Hant",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "zh",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :"zh-Hant",
requested_locale_name: "zh-TW",
script: :Hant,
territory: :TW,
- transform: %{},
- language_variants: []
- }}
+ transform: %{},
+ language_variants: []
+ }}
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("da;q=0.1,zh-TW;q=0.3", TestBackend.Cldr)
-{:ok,
- %Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("da;q=0.1,zh-TW;q=0.3", TestBackend.Cldr)
+{:ok,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "zh-TW",
cldr_locale_name: :"zh-Hant",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "zh",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :"zh-Hant",
requested_locale_name: "zh-TW",
script: :Hant,
territory: :TW,
- transform: %{},
- language_variants: []
- }}
-
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("xx,yy;q=0.3")
-{:error,
- {Cldr.NoMatchingLocale,
- "No configured locale could be matched to \"xx,yy;q=0.3\""}}
-
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("invalid_tag")
-{:error, {Cldr.LanguageTag.ParseError,
- "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
+ transform: %{},
+ language_variants: []
+ }}
+
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("xx,yy;q=0.3")
+{:error,
+ {Cldr.NoMatchingLocale,
+ "No configured locale could be matched to \"xx,yy;q=0.3\""}}
+
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.best_match("invalid_tag")
+{:error, {Cldr.LanguageTag.ParseError,
+ "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
@@ -365,95 +365,95 @@ parse(tokens_or_string)
Example
-iex> Cldr.AcceptLanguage.parse("da,zh-TW;q=0.3", TestBackend.Cldr)
-{:ok,
- [
- {1.0,
- %Cldr.LanguageTag{
+iex> Cldr.AcceptLanguage.parse("da,zh-TW;q=0.3", TestBackend.Cldr)
+{:ok,
+ [
+ {1.0,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "da",
cldr_locale_name: :da,
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "da",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :da,
requested_locale_name: "da",
script: :Latn,
territory: :DK,
- transform: %{},
- language_variants: []
- }},
- {0.3,
- %Cldr.LanguageTag{
+ transform: %{},
+ language_variants: []
+ }},
+ {0.3,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "zh-TW",
cldr_locale_name: :"zh-Hant",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "zh",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :"zh-Hant",
requested_locale_name: "zh-TW",
script: :Hant,
territory: :TW,
- transform: %{},
- language_variants: []
- }}
- ]}
-
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse("invalid_tag")
-{:error,
- {Cldr.LanguageTag.ParseError,
- "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
-
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse("da,zh-TW;q=0.3,invalid_tag")
-{:ok,
- [
- {1.0,
- %Cldr.LanguageTag{
+ transform: %{},
+ language_variants: []
+ }}
+ ]}
+
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse("invalid_tag")
+{:error,
+ {Cldr.LanguageTag.ParseError,
+ "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
+
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse("da,zh-TW;q=0.3,invalid_tag")
+{:ok,
+ [
+ {1.0,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "da",
cldr_locale_name: :da,
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "da",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :da,
requested_locale_name: "da",
script: :Latn,
territory: :DK,
- transform: %{},
- language_variants: []
- }},
- {0.3,
- %Cldr.LanguageTag{
+ transform: %{},
+ language_variants: []
+ }},
+ {0.3,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "zh-TW",
cldr_locale_name: :"zh-Hant",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "zh",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :"zh-Hant",
requested_locale_name: "zh-TW",
script: :Hant,
territory: :TW,
- transform: %{},
- language_variants: []
- }},
- {:error,
- {Cldr.LanguageTag.ParseError,
- "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
- ]}
+ transform: %{},
+ language_variants: []
+ }},
+ {:error,
+ {Cldr.LanguageTag.ParseError,
+ "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
+ ]}
@@ -498,92 +498,92 @@ parse!(accept_language)
Example
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse!("da,zh-TW;q=0.3")
-[
- {1.0,
- %Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse!("da,zh-TW;q=0.3")
+[
+ {1.0,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "da",
cldr_locale_name: :da,
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "da",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :da,
requested_locale_name: "da",
script: :Latn,
territory: :DK,
- transform: %{},
- language_variants: []
- }},
- {0.3,
- %Cldr.LanguageTag{
+ transform: %{},
+ language_variants: []
+ }},
+ {0.3,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "zh-TW",
cldr_locale_name: :"zh-Hant",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "zh",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :"zh-Hant",
requested_locale_name: "zh-TW",
script: :Hant,
territory: :TW,
- transform: %{},
- language_variants: []
- }}
-]
+ transform: %{},
+ language_variants: []
+ }}
+]
Bonfire.Common.Localise.Cldr.AcceptLanguage.parse! "invalid_tag"
** (Cldr.AcceptLanguageError) "Expected a BCP47 language tag. Could not parse the remaining "g" starting at position 11
(ex_cldr) lib/cldr/accept_language.ex:304: Cldr.AcceptLanguage.parse!/1
-iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse!("da,zh-TW;q=0.3,invalid_tag")
-[
- {1.0,
- %Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.AcceptLanguage.parse!("da,zh-TW;q=0.3,invalid_tag")
+[
+ {1.0,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "da",
cldr_locale_name: :da,
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "da",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :da,
requested_locale_name: "da",
script: :Latn,
territory: :DK,
- transform: %{},
- language_variants: []
- }},
- {0.3,
- %Cldr.LanguageTag{
+ transform: %{},
+ language_variants: []
+ }},
+ {0.3,
+ %Cldr.LanguageTag{
backend: TestBackend.Cldr,
canonical_locale_name: "zh-TW",
cldr_locale_name: :"zh-Hant",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: nil,
language: "zh",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :"zh-Hant",
requested_locale_name: "zh-TW",
script: :Hant,
territory: :TW,
- transform: %{},
- language_variants: []
- }},
- {:error,
- {Cldr.LanguageTag.ParseError,
- "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
-]
+ transform: %{},
+ language_variants: []
+ }},
+ {:error,
+ {Cldr.LanguageTag.ParseError,
+ "Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11"}}
+]
diff --git a/Bonfire.Common.Localise.Cldr.Calendar.html b/Bonfire.Common.Localise.Cldr.Calendar.html
index ee1930cde9..aa2ef72aee 100644
--- a/Bonfire.Common.Localise.Cldr.Calendar.html
+++ b/Bonfire.Common.Localise.Cldr.Calendar.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Calendar — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Calendar — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Calendar
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -331,16 +331,16 @@ calendar_from_locale(locale)
Examples
iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_locale "en-GB"
-{:ok, Cldr.Calendar.GB}
+{:ok, Cldr.Calendar.GB}
iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_locale "en-GB-u-ca-gregory"
-{:ok, Cldr.Calendar.Gregorian}
+{:ok, Cldr.Calendar.Gregorian}
iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_locale "en"
-{:ok, Cldr.Calendar.US}
+{:ok, Cldr.Calendar.US}
iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_locale "fa-IR"
-{:ok, Cldr.Calendar.Persian}
+{:ok, Cldr.Calendar.Persian}
@@ -382,11 +382,11 @@ calendar_from_territory(territory)
Examples
-iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_territory(:US)
-{:ok, Cldr.Calendar.US}
+iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_territory(:US)
+{:ok, Cldr.Calendar.US}
iex> Bonfire.Common.Localise.Cldr.Calendar.calendar_from_territory :XX
-{:error, {Cldr.UnknownTerritoryError, "The territory :XX is unknown"}}
+
{:error, {Cldr.UnknownTerritoryError, "The territory :XX is unknown"}}
@@ -570,7 +570,7 @@ localize(date)
Examples
iex> Bonfire.Common.Localise.Cldr.Calendar.localize ~D[2022-06-09], locale: "fr"
-{:ok, %Date{year: 2022, month: 6, day: 9, calendar: Cldr.Calendar.FR}}
+
{:ok, %Date{year: 2022, month: 6, day: 9, calendar: Cldr.Calendar.FR}}
@@ -689,7 +689,7 @@ localize(datetime, part, options \\ [])
"Mon"
iex> Bonfire.Common.Localise.Cldr.Calendar.localize ~D[2019-01-01], :days_of_week
-[{1, "Mon"}, {2, "Tue"}, {3, "Wed"}, {4, "Thu"}, {5, "Fri"}, {6, "Sat"}, {7, "Sun"}]
+[{1, "Mon"}, {2, "Tue"}, {3, "Wed"}, {4, "Thu"}, {5, "Fri"}, {6, "Sat"}, {7, "Sun"}]
iex> Bonfire.Common.Localise.Cldr.Calendar.localize ~D[2019-06-01], :era
"AD"
@@ -838,20 +838,20 @@ strftime_options!(locale \\ Bonfire.Common.
Example
-iex: MyApp.Cldr.Calendar.strftime_options!()
-[
- am_pm_names: #Function<0.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
- month_names: #Function<1.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
- abbreviated_month_names: #Function<2.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
- day_of_week_names: #Function<3.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
- abbreviated_day_of_week_names: #Function<4.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>
-]
+iex: MyApp.Cldr.Calendar.strftime_options!()
+[
+ am_pm_names: #Function<0.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
+ month_names: #Function<1.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
+ abbreviated_month_names: #Function<2.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
+ day_of_week_names: #Function<3.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>,
+ abbreviated_day_of_week_names: #Function<4.32021692/1 in MyApp.Cldr.Calendar.strftime_options/2>
+]
Typical usage
-iex: NimbleStrftime.format(Date.utc_today(), MyApp.Cldr.Calendar.strftime_options!())
+iex: NimbleStrftime.format(Date.utc_today(), MyApp.Cldr.Calendar.strftime_options!())
diff --git a/Bonfire.Common.Localise.Cldr.Currency.html b/Bonfire.Common.Localise.Cldr.Currency.html
index c3634ccdd0..85838946d2 100644
--- a/Bonfire.Common.Localise.Cldr.Currency.html
+++ b/Bonfire.Common.Localise.Cldr.Currency.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Currency — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Currency — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Currency
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -409,11 +409,11 @@ currencies_for_locale(locale, only \\ :all,
MyApp.Cldr.Currency.currencies_for_locale("en")
=> {:ok,
- %{
FJD: %Cldr.Currency{
+ %{ FJD: %Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "FJD",
- count: %{one: "Fijian dollar", other: "Fijian dollars"},
+ count: %{one: "Fijian dollar", other: "Fijian dollars"},
digits: 2,
from: nil,
iso_digits: 2,
@@ -423,12 +423,12 @@ currencies_for_locale(locale, only \\ :all,
symbol: "FJD",
tender: true,
to: nil
- },
- SUR: %Cldr.Currency{
+ },
+ SUR: %Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "SUR",
- count: %{one: "Soviet rouble", other: "Soviet roubles"},
+ count: %{one: "Soviet rouble", other: "Soviet roubles"},
digits: 2,
from: nil,
iso_digits: nil,
@@ -438,7 +438,7 @@ currencies_for_locale(locale, only \\ :all,
symbol: "SUR",
tender: true,
to: nil
- },
+ },
...
}}
@@ -499,11 +499,11 @@ currencies_for_locale!(locale, only \\ :all
Example
MyApp.Cldr.Currency.currencies_for_locale!("en")
- => %{
FJD: %Cldr.Currency{
+ => %{FJD: %Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "FJD",
- count: %{one: "Fijian dollar", other: "Fijian dollars"},
+ count: %{one: "Fijian dollar", other: "Fijian dollars"},
digits: 2,
from: nil,
iso_digits: 2,
@@ -513,12 +513,12 @@ currencies_for_locale!(locale, only \\ :all
symbol: "FJD",
tender: true,
to: nil
-},
-SUR: %Cldr.Currency{
+},
+SUR: %Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "SUR",
- count: %{one: "Soviet rouble", other: "Soviet roubles"},
+ count: %{one: "Soviet rouble", other: "Soviet roubles"},
digits: 2,
from: nil,
iso_digits: nil,
@@ -528,7 +528,7 @@ currencies_for_locale!(locale, only \\ :all
symbol: "SUR",
tender: true,
to: nil
-},
+},
...
}
@@ -586,13 +586,13 @@ currency_for_code(currency_or_currency_code
Examples
-iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code("AUD")
-{:ok,
- %Cldr.Currency{
+iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code("AUD")
+{:ok,
+ %Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "AUD",
- count: %{one: "Australian dollar", other: "Australian dollars"},
+ count: %{one: "Australian dollar", other: "Australian dollars"},
digits: 2,
iso_digits: 2,
name: "Australian Dollar",
@@ -600,15 +600,15 @@ currency_for_code(currency_or_currency_code
rounding: 0,
symbol: "A$",
tender: true
-}}
+}}
-iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code("THB")
-{:ok,
- %Cldr.Currency{
+iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code("THB")
+{:ok,
+ %Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "THB",
- count: %{one: "Thai baht", other: "Thai baht"},
+ count: %{one: "Thai baht", other: "Thai baht"},
digits: 2,
iso_digits: 2,
name: "Thai Baht",
@@ -616,7 +616,7 @@ currency_for_code(currency_or_currency_code
rounding: 0,
symbol: "THB",
tender: true
-}}
+}}
@@ -675,12 +675,12 @@ currency_for_code!(currency_or_currency_cod
Examples
-iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code!("AUD")
-%Cldr.Currency{
+iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code!("AUD")
+%Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "AUD",
- count: %{one: "Australian dollar", other: "Australian dollars"},
+ count: %{one: "Australian dollar", other: "Australian dollars"},
digits: 2,
iso_digits: 2,
name: "Australian Dollar",
@@ -688,14 +688,14 @@ currency_for_code!(currency_or_currency_cod
rounding: 0,
symbol: "A$",
tender: true
-}
+}
-iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code!("THB")
-%Cldr.Currency{
+iex> Bonfire.Common.Localise.Cldr.Currency.currency_for_code!("THB")
+%Cldr.Currency{
cash_digits: 2,
cash_rounding: 0,
code: "THB",
- count: %{one: "Thai baht", other: "Thai baht"},
+ count: %{one: "Thai baht", other: "Thai baht"},
digits: 2,
iso_digits: 2,
name: "Thai Baht",
@@ -703,7 +703,7 @@ currency_for_code!(currency_or_currency_cod
rounding: 0,
symbol: "THB",
tender: true
-}
+}
@@ -744,15 +744,15 @@ currency_from_locale(locale)
Examples
-iex> {:ok, locale} = Bonfire.Common.Localise.Cldr.validate_locale("en")
+iex> {:ok, locale} = Bonfire.Common.Localise.Cldr.validate_locale("en")
iex> Bonfire.Common.Localise.Cldr.Currency.currency_from_locale locale
:USD
-iex> {:ok, locale} = Bonfire.Common.Localise.Cldr.validate_locale("en-AU")
+iex> {:ok, locale} = Bonfire.Common.Localise.Cldr.validate_locale("en-AU")
iex> Bonfire.Common.Localise.Cldr.Currency.currency_from_locale locale
:AUD
-iex> Bonfire.Common.Localise.Cldr.Currency.currency_from_locale("en-GB")
+iex> Bonfire.Common.Localise.Cldr.Currency.currency_from_locale("en-GB")
:GBP
@@ -796,14 +796,14 @@ currency_history_for_locale(language_tag)
Example
-iex> MyApp.Cldr.Currency.currency_history_for_locale("en")
-{:ok,
- %{
- USD: %{from: ~D[1792-01-01], to: nil},
- USN: %{tender: false},
- USS: %{from: nil, tender: false, to: ~D[2014-03-01]}
- }
-}
+iex> MyApp.Cldr.Currency.currency_history_for_locale("en")
+{:ok,
+ %{
+ USD: %{from: ~D[1792-01-01], to: nil},
+ USN: %{tender: false},
+ USS: %{from: nil, tender: false, to: ~D[2014-03-01]}
+ }
+}
@@ -862,9 +862,9 @@ currency_strings(locale, only \\ :all, exce
Example
-MyApp.Cldr.Currency.currency_strings("en")
-=> {:ok,
- %{
+MyApp.Cldr.Currency.currency_strings("en")
+=> {:ok,
+ %{
"mexican silver pesos" => :MXP,
"sudanese dinar" => :SDD,
"bad" => :BAD,
@@ -874,7 +874,7 @@ currency_strings(locale, only \\ :all, exce
"guyanaese dollars" => :GYD,
"equatorial guinean ekwele" => :GQE,
...
- }}
+ }}
@@ -933,8 +933,8 @@ currency_strings!(locale_name, only \\ :all
Example
-MyApp.Cldr.Currency.currency_strings!("en")
-=> %{
+MyApp.Cldr.Currency.currency_strings!("en")
+=> %{
"mexican silver pesos" => :MXP,
"sudanese dinar" => :SDD,
"bad" => :BAD,
@@ -944,7 +944,7 @@ currency_strings!(locale_name, only \\ :all
"guyanaese dollars" => :GYD,
"equatorial guinean ekwele" => :GQE,
...
- }
+ }
@@ -982,10 +982,10 @@ current_currency_from_locale(locale)
Example
-iex> MyApp.Cldr.Currency.current_currency_from_locale("en")
+iex> MyApp.Cldr.Currency.current_currency_from_locale("en")
:USD
-iex> MyApp.Cldr.Currency.current_currency_from_locale("en-AU")
+iex> MyApp.Cldr.Currency.current_currency_from_locale("en-AU")
:AUD
@@ -1033,7 +1033,7 @@ current_territory_currencies()
Example
-iex> Bonfire.Common.Localise.Cldr.Currency.current_territory_currencies()
+iex> Bonfire.Common.Localise.Cldr.Currency.current_territory_currencies()
@@ -1125,11 +1125,11 @@ known_currency_code(currency_code)
Examples
-iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code("AUD")
-{:ok, :AUD}
+iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code("AUD")
+{:ok, :AUD}
-iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code("GGG")
-{:error, {Cldr.UnknownCurrencyError, "The currency \"GGG\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code("GGG")
+{:error, {Cldr.UnknownCurrencyError, "The currency \"GGG\" is invalid"}}
@@ -1176,13 +1176,13 @@ known_currency_code?(currency_code)
Examples
-iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code?("AUD")
+iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code?("AUD")
true
-iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code?("GGG")
+iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code?("GGG")
false
-iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code?(:XCV)
+iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_code?(:XCV)
false
@@ -1217,7 +1217,7 @@ known_currency_codes()
Example
-iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_codes()
+iex> Bonfire.Common.Localise.Cldr.Currency.known_currency_codes()
@@ -1276,14 +1276,14 @@ new(currency, options \\ [])
Example
-iex> Bonfire.Common.Localise.Cldr.Currency.new(:XAE, name: "Custom Name", digits: 0)
-{:ok,
- %Cldr.Currency{
+iex> Bonfire.Common.Localise.Cldr.Currency.new(:XAE, name: "Custom Name", digits: 0)
+{:ok,
+ %Cldr.Currency{
alt_code: :XAE,
cash_digits: 0,
cash_rounding: nil,
code: :XAE,
- count: %{other: "Custom Name"},
+ count: %{other: "Custom Name"},
digits: 0,
from: nil,
iso_digits: 0,
@@ -1293,11 +1293,11 @@ new(currency, options \\ [])
symbol: "XAE",
tender: false,
to: nil
- }}
-iex> MyApp.Cldr.Currency.new(:XAH, name: "Custom Name")
-{:error, "Required options are missing. Required options are [:name, :digits]"}
-iex> Bonfire.Common.Localise.Cldr.Currency.new(:XAE, name: "XAE", digits: 0)
-{:error, {Cldr.CurrencyAlreadyDefined, "Currency :XAE is already defined."}}
+ }}
+iex> MyApp.Cldr.Currency.new(:XAH, name: "Custom Name")
+{:error, "Required options are missing. Required options are [:name, :digits]"}
+iex> Bonfire.Common.Localise.Cldr.Currency.new(:XAE, name: "XAE", digits: 0)
+{:error, {Cldr.CurrencyAlreadyDefined, "Currency :XAE is already defined."}}
@@ -1355,20 +1355,20 @@ pluralize(number, currency, options \\ [])<
Examples
-iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(1, :USD)
-{:ok, "US dollar"}
+iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(1, :USD)
+{:ok, "US dollar"}
-iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(3, :USD)
-{:ok, "US dollars"}
+iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(3, :USD)
+{:ok, "US dollars"}
-iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(12, :USD, locale: "zh")
-{:ok, "美元"}
+iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(12, :USD, locale: "zh")
+{:ok, "美元"}
-iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(12, :USD, locale: "fr")
-{:ok, "dollars des États-Unis"}
+iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(12, :USD, locale: "fr")
+{:ok, "dollars des États-Unis"}
-iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(1, :USD, locale: "fr")
-{:ok, "dollar des États-Unis"}
+iex> Bonfire.Common.Localise.Cldr.Currency.pluralize(1, :USD, locale: "fr")
+{:ok, "dollar des États-Unis"}
@@ -1410,9 +1410,9 @@ strings_for_currency(currency, locale)
Example
-iex> MyApp.Cldr.Currency.strings_for_currency(:AUD, "en")
-...> |> Enum.sort()
-["a$", "aud", "australian dollar", "australian dollars"]
+iex> MyApp.Cldr.Currency.strings_for_currency(:AUD, "en")
+...> |> Enum.sort()
+["a$", "aud", "australian dollar", "australian dollars"]
diff --git a/Bonfire.Common.Localise.Cldr.Date.Interval.html b/Bonfire.Common.Localise.Cldr.Date.Interval.html
index 264d28ef2e..ac0dc45710 100644
--- a/Bonfire.Common.Localise.Cldr.Date.Interval.html
+++ b/Bonfire.Common.Localise.Cldr.Date.Interval.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Date.Interval — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Date.Interval — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Date.Interval
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -298,30 +298,30 @@ to_string(from, to, options)
Examples
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-12-31]
-{:ok, "Jan 1 – Dec 31, 2020"}
+{:ok, "Jan 1 – Dec 31, 2020"}
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12]
-{:ok, "Jan 1 – 12, 2020"}
+{:ok, "Jan 1 – 12, 2020"}
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :long
-{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
+{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-12-01],
...> format: :long, style: :year_and_month
-{:ok, "January – December 2020"}
+{:ok, "January – December 2020"}
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :short
-{:ok, "1/1/2020 – 1/12/2020"}
+{:ok, "1/1/2020 – 1/12/2020"}
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :long, locale: "fr"
-{:ok, "mer. 1 – dim. 12 janv. 2020"}
+{:ok, "mer. 1 – dim. 12 janv. 2020"}
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :long, locale: "th", number_system: :thai
-{:ok, "พ. ๑ ม.ค. – อา. ๑๒ ม.ค. ๒๐๒๐"}
+
{:ok, "พ. ๑ ม.ค. – อา. ๑๒ ม.ค. ๒๐๒๐"}
@@ -398,17 +398,17 @@ to_string!(from, to, options)
Examples
-iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-12-31])
+iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-12-31])
"Jan 1 – Dec 31, 2020"
-iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12])
+iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12])
"Jan 1 – 12, 2020"
-iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12]),
+iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12]),
...> format: :long
"Wed, Jan 1 – Sun, Jan 12, 2020"
-iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-12-01]),
+iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-12-01]),
...> format: :long, style: :year_and_month
"January – December 2020"
@@ -416,11 +416,11 @@ to_string!(from, to, options)
iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! ~I"2020-01/12"
"Jan 1 – Dec 31, 2020"
-iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12]),
+iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12]),
...> format: :short
"1/1/2020 – 1/12/2020"
-iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12]),
+iex> Bonfire.Common.Localise.Cldr.Date.Interval.to_string! Date.range(~D[2020-01-01], ~D[2020-01-12]),
...> format: :long, locale: "fr"
"mer. 1 – dim. 12 janv. 2020"
diff --git a/Bonfire.Common.Localise.Cldr.Date.html b/Bonfire.Common.Localise.Cldr.Date.html
index b6397f45a6..1b7c4ca2f1 100644
--- a/Bonfire.Common.Localise.Cldr.Date.html
+++ b/Bonfire.Common.Localise.Cldr.Date.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Date — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Date — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Date
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -257,34 +257,34 @@ to_string(date, options \\ [])
Examples
# Full dates have the default format `:medium`
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], locale: :en)
-{:ok, "Jul 10, 2017"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], locale: :en)
+{:ok, "Jul 10, 2017"}
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :medium, locale: :en)
-{:ok, "Jul 10, 2017"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :medium, locale: :en)
+{:ok, "Jul 10, 2017"}
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :full, locale: :en)
-{:ok, "Monday, July 10, 2017"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :full, locale: :en)
+{:ok, "Monday, July 10, 2017"}
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :short, locale: :en)
-{:ok, "7/10/17"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :short, locale: :en)
+{:ok, "7/10/17"}
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :short, locale: "fr")
-{:ok, "10/07/2017"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(~D[2017-07-10], format: :short, locale: "fr")
+{:ok, "10/07/2017"}
# A partial date with a derived "best match" format
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(%{year: 2024, month: 6}, locale: "fr")
-{:ok, "06/2024"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(%{year: 2024, month: 6}, locale: "fr")
+{:ok, "06/2024"}
# A partial date with a best match CLDR-defined format
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(%{year: 2024, month: 6}, format: :yMMM, locale: "fr")
-{:ok, "juin 2024"}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(%{year: 2024, month: 6}, format: :yMMM, locale: "fr")
+{:ok, "juin 2024"}
# Sometimes the available date fields can't be mapped to an available
# CLDR defined format.
-iex> Bonfire.Common.Localise.Cldr.Date.to_string(%{year: 2024, day: 3}, locale: "fr")
-{:error,
- {Cldr.DateTime.UnresolvedFormat, "No available format resolved for :dy"}}
+iex> Bonfire.Common.Localise.Cldr.Date.to_string(%{year: 2024, day: 3}, locale: "fr")
+{:error,
+ {Cldr.DateTime.UnresolvedFormat, "No available format resolved for :dy"}}
@@ -357,27 +357,27 @@ to_string!(date, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], locale: :en)
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], locale: :en)
"Jul 10, 2017"
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :medium, locale: :en)
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :medium, locale: :en)
"Jul 10, 2017"
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :full, locale: :en)
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :full, locale: :en)
"Monday, July 10, 2017"
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :short, locale: :en)
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :short, locale: :en)
"7/10/17"
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :short, locale: "fr")
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(~D[2017-07-10], format: :short, locale: "fr")
"10/07/2017"
# A partial date with a derived "best match" format
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(%{year: 2024, month: 6}, locale: "fr")
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(%{year: 2024, month: 6}, locale: "fr")
"06/2024"
# A partial date with a best match CLDR-defined format
-iex> Bonfire.Common.Localise.Cldr.Date.to_string!(%{year: 2024, month: 6}, format: :yMMM, locale: "fr")
+iex> Bonfire.Common.Localise.Cldr.Date.to_string!(%{year: 2024, month: 6}, format: :yMMM, locale: "fr")
"juin 2024"
diff --git a/Bonfire.Common.Localise.Cldr.DateTime.Format.html b/Bonfire.Common.Localise.Cldr.DateTime.Format.html
index 3094e94934..a2bbc45137 100644
--- a/Bonfire.Common.Localise.Cldr.DateTime.Format.html
+++ b/Bonfire.Common.Localise.Cldr.DateTime.Format.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.DateTime.Format — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.DateTime.Format — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.DateTime.Format
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -475,10 +475,10 @@ calendars_for(locale \\ Bonfire.Common.Loca
Example
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.calendars_for(:en)
-{:ok, [:buddhist, :chinese, :coptic, :dangi, :ethiopic, :ethiopic_amete_alem,
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.calendars_for(:en)
+{:ok, [:buddhist, :chinese, :coptic, :dangi, :ethiopic, :ethiopic_amete_alem,
:generic, :gregorian, :hebrew, :indian, :islamic, :islamic_civil,
- :islamic_rgsa, :islamic_tbla, :islamic_umalqura, :japanese, :persian, :roc]}
+ :islamic_rgsa, :islamic_tbla, :islamic_umalqura, :japanese, :persian, :roc]}
@@ -514,11 +514,11 @@ common_date_time_format_names()
Example:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.common_date_time_format_names()
-[:Bh, :Bhm, :Bhms, :E, :EBhm, :EBhms, :EHm, :EHms, :Ed, :Ehm, :Ehms, :Gy,
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.common_date_time_format_names()
+[:Bh, :Bhm, :Bhms, :E, :EBhm, :EBhms, :EHm, :EHms, :Ed, :Ehm, :Ehms, :Gy,
:GyMMM, :GyMMMEd, :GyMMMd, :GyMd, :H, :Hm, :Hms, :Hmsv, :Hmv, :M, :MEd, :MMM,
:MMMEd, :MMMMW, :MMMMd, :MMMd, :Md, :d, :h, :hm, :hms, :hmsv, :hmv, :ms, :y,
- :yM, :yMEd, :yMMM, :yMMMEd, :yMMMM, :yMMMd, :yMd, :yQQQ, :yQQQQ, :yw]
+ :yM, :yMEd, :yMMM, :yMMMEd, :yMMMM, :yMMMd, :yMd, :yQQQ, :yQQQQ, :yw]
@@ -613,21 +613,21 @@ date_formats(locale \\ Bonfire.Common.Local
Examples:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_formats(:en)
-{:ok, %Cldr.Date.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_formats(:en)
+{:ok, %Cldr.Date.Formats{
full: "EEEE, MMMM d, y",
long: "MMMM d, y",
medium: "MMM d, y",
short: "M/d/yy"
-}}
+}}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_formats(:en, :buddhist)
-{:ok, %Cldr.Date.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_formats(:en, :buddhist)
+{:ok, %Cldr.Date.Formats{
full: "EEEE, MMMM d, y G",
long: "MMMM d, y G",
medium: "MMM d, y G",
short: "M/d/y GGGGG"
-}}
+}}
@@ -677,21 +677,21 @@ date_time_at_formats(locale \\ Bonfire.Comm
Examples:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_at_formats(:en)
-{:ok, %Cldr.DateTime.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_at_formats(:en)
+{:ok, %Cldr.DateTime.Formats{
full: "{1} 'at' {0}",
long: "{1} 'at' {0}",
medium: "{1}, {0}",
- short: "{1}, {0}"}
-}
+ short: "{1}, {0}"}
+}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_at_formats(:en, :buddhist)
-{:ok, %Cldr.DateTime.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_at_formats(:en, :buddhist)
+{:ok, %Cldr.DateTime.Formats{
full: "{1} 'at' {0}",
long: "{1} 'at' {0}",
medium: "{1}, {0}",
- short: "{1}, {0}"}
-}
+ short: "{1}, {0}"}
+}
@@ -740,27 +740,27 @@ date_time_available_formats(locale \\ Bonfi
Examples:
iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_available_formats "en"
-{:ok,
- %{
- yw: %{
+{:ok,
+ %{
+ yw: %{
other: "'week' w 'of' Y",
one: "'week' w 'of' Y",
pluralize: :week_of_year
- },
+ },
GyMMMEd: "E, MMM d, y G",
Hms: "HH:mm:ss",
- MMMMW: %{
+ MMMMW: %{
other: "'week' W 'of' MMMM",
one: "'week' W 'of' MMMM",
pluralize: :week_of_month
- },
+ },
E: "ccc",
MMMd: "MMM d",
yMEd: "E, M/d/y",
yQQQ: "QQQ y",
- Ehm: %{unicode: "E h:mm a", ascii: "E h:mm a"},
+ Ehm: %{unicode: "E h:mm a", ascii: "E h:mm a"},
M: "L",
- hm: %{unicode: "h:mm a", ascii: "h:mm a"},
+ hm: %{unicode: "h:mm a", ascii: "h:mm a"},
yM: "M/y",
GyMMMd: "MMM d, y G",
GyMd: "M/d/y G",
@@ -768,15 +768,15 @@ date_time_available_formats(locale \\ Bonfi
Hm: "HH:mm",
EBhms: "E h:mm:ss B",
d: "d",
- hms: %{unicode: "h:mm:ss a", ascii: "h:mm:ss a"},
+ hms: %{unicode: "h:mm:ss a", ascii: "h:mm:ss a"},
Ed: "d E",
- Ehms: %{unicode: "E h:mm:ss a", ascii: "E h:mm:ss a"},
+ Ehms: %{unicode: "E h:mm:ss a", ascii: "E h:mm:ss a"},
EHms: "E HH:mm:ss",
Bh: "h B",
- h: %{unicode: "h a", ascii: "h a"},
+ h: %{unicode: "h a", ascii: "h a"},
Bhms: "h:mm:ss B",
Hmv: "HH:mm v",
- hmv: %{unicode: "h:mm a v", ascii: "h:mm a v"},
+ hmv: %{unicode: "h:mm a v", ascii: "h:mm a v"},
yMd: "M/d/y",
ms: "mm:ss",
MMM: "LLL",
@@ -792,12 +792,12 @@ date_time_available_formats(locale \\ Bonfi
MEd: "E, M/d",
EHm: "E HH:mm",
GyMMM: "MMM y G",
- hmsv: %{unicode: "h:mm:ss a v", ascii: "h:mm:ss a v"},
+ hmsv: %{unicode: "h:mm:ss a v", ascii: "h:mm:ss a v"},
H: "HH",
Md: "M/d",
MMMEd: "E, MMM d",
MMMMd: "MMMM d"
- }}
+
}}
@@ -844,21 +844,21 @@ date_time_formats(locale \\ Bonfire.Common.
Examples:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_formats(:en)
-{:ok, %Cldr.DateTime.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_formats(:en)
+{:ok, %Cldr.DateTime.Formats{
full: "{1}, {0}",
long: "{1}, {0}",
medium: "{1}, {0}",
short: "{1}, {0}"
-}}
+}}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_formats(:en, :buddhist)
-{:ok, %Cldr.DateTime.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_formats(:en, :buddhist)
+{:ok, %Cldr.DateTime.Formats{
full: "{1}, {0}",
long: "{1}, {0}",
medium: "{1}, {0}",
short: "{1}, {0}"
-}}
+}}
@@ -906,8 +906,8 @@ date_time_interval_fallback(locale \\ Bonfi
Examples:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_interval_fallback(:en, :gregorian)
-[0, " – ", 1]
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_interval_fallback(:en, :gregorian)
+[0, " – ", 1]
@@ -955,101 +955,101 @@ date_time_interval_formats(locale \\ Bonfir
Examples:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_interval_formats(:en, :gregorian)
-{:ok,
- %{
- h: %{a: ["h a – ", "h a"], h: ["h – ", "h a"]},
- d: %{d: ["d – ", "d"]},
- y: %{y: ["y – ", "y"]},
- M: %{M: ["M – ", "M"]},
- Bh: %{h: ["h – ", "h B"], B: ["h B – ", "h B"]},
- Bhm: %{
- m: ["h:mm – ", "h:mm B"],
- h: ["h:mm – ", "h:mm B"],
- B: ["h:mm B – ", "h:mm B"]
- },
- Gy: %{y: ["y – ", "y G"], G: ["y G – ", "y G"]},
- GyMMM: %{
- y: ["MMM y – ", "MMM y G"],
- M: ["MMM – ", "MMM y G"],
- G: ["MMM y G – ", "MMM y G"]
- },
- GyMMMEd: %{
- d: ["E, MMM d – ", "E, MMM d, y G"],
- y: ["E, MMM d, y – ", "E, MMM d, y G"],
- M: ["E, MMM d – ", "E, MMM d, y G"],
- G: ["E, MMM d, y G – ", "E, MMM d, y G"]
- },
- GyMMMd: %{
- d: ["MMM d – ", "d, y G"],
- y: ["MMM d, y – ", "MMM d, y G"],
- M: ["MMM d – ", "MMM d, y G"],
- G: ["MMM d, y G – ", "MMM d, y G"]
- },
- GyMd: %{
- d: ["M/d/y – ", "M/d/y G"],
- y: ["M/d/y – ", "M/d/y G"],
- M: ["M/d/y – ", "M/d/y G"],
- G: ["M/d/y G – ", "M/d/y G"]
- },
- H: %{H: ["HH – ", "HH"]},
- Hm: %{m: ["HH:mm – ", "HH:mm"], H: ["HH:mm – ", "HH:mm"]},
- Hmv: %{m: ["HH:mm – ", "HH:mm v"], H: ["HH:mm – ", "HH:mm v"]},
- MEd: %{d: ["E, M/d – ", "E, M/d"], M: ["E, M/d – ", "E, M/d"]},
- MMM: %{M: ["MMM – ", "MMM"]},
- MMMEd: %{
- d: ["E, MMM d – ", "E, MMM d"],
- M: ["E, MMM d – ", "E, MMM d"]
- },
- MMMd: %{d: ["MMM d – ", "d"], M: ["MMM d – ", "MMM d"]},
- Md: %{d: ["M/d – ", "M/d"], M: ["M/d – ", "M/d"]},
- hm: %{
- m: ["h:mm – ", "h:mm a"],
- a: ["h:mm a – ", "h:mm a"],
- h: ["h:mm – ", "h:mm a"]
- },
- hmv: %{
- m: ["h:mm – ", "h:mm a v"],
- a: ["h:mm a – ", "h:mm a v"],
- h: ["h:mm – ", "h:mm a v"]
- },
- yM: %{y: ["M/y – ", "M/y"], M: ["M/y – ", "M/y"]},
- yMEd: %{
- d: ["E, M/d/y – ", "E, M/d/y"],
- y: ["E, M/d/y – ", "E, M/d/y"],
- M: ["E, M/d/y – ", "E, M/d/y"]
- },
- yMMM: %{y: ["MMM y – ", "MMM y"], M: ["MMM – ", "MMM y"]},
- yMMMEd: %{
- d: ["E, MMM d – ", "E, MMM d, y"],
- y: ["E, MMM d, y – ", "E, MMM d, y"],
- M: ["E, MMM d – ", "E, MMM d, y"]
- },
- yMMMM: %{y: ["MMMM y – ", "MMMM y"], M: ["MMMM – ", "MMMM y"]},
- yMMMd: %{
- d: ["MMM d – ", "d, y"],
- y: ["MMM d, y – ", "MMM d, y"],
- M: ["MMM d – ", "MMM d, y"]
- },
- yMd: %{
- d: ["M/d/y – ", "M/d/y"],
- y: ["M/d/y – ", "M/d/y"],
- M: ["M/d/y – ", "M/d/y"]
- },
- GyM: %{
- y: ["M/y – ", "M/y G"],
- M: ["M/y – ", "M/y G"],
- G: ["M/y G – ", "M/y G"]
- },
- GyMEd: %{
- d: ["E, M/d/y – ", "E, M/d/y G"],
- y: ["E, M/d/y – ", "E, M/d/y G"],
- M: ["E, M/d/y – ", "E, M/d/y G"],
- G: ["E, M/d/y G – ", "E, M/d/y G"]
- },
- Hv: %{H: ["HH – ", "HH v"]},
- hv: %{a: ["h a – ", "h a v"], h: ["h – ", "h a v"]}
- }}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.date_time_interval_formats(:en, :gregorian)
+{:ok,
+ %{
+ h: %{a: ["h a – ", "h a"], h: ["h – ", "h a"]},
+ d: %{d: ["d – ", "d"]},
+ y: %{y: ["y – ", "y"]},
+ M: %{M: ["M – ", "M"]},
+ Bh: %{h: ["h – ", "h B"], B: ["h B – ", "h B"]},
+ Bhm: %{
+ m: ["h:mm – ", "h:mm B"],
+ h: ["h:mm – ", "h:mm B"],
+ B: ["h:mm B – ", "h:mm B"]
+ },
+ Gy: %{y: ["y – ", "y G"], G: ["y G – ", "y G"]},
+ GyMMM: %{
+ y: ["MMM y – ", "MMM y G"],
+ M: ["MMM – ", "MMM y G"],
+ G: ["MMM y G – ", "MMM y G"]
+ },
+ GyMMMEd: %{
+ d: ["E, MMM d – ", "E, MMM d, y G"],
+ y: ["E, MMM d, y – ", "E, MMM d, y G"],
+ M: ["E, MMM d – ", "E, MMM d, y G"],
+ G: ["E, MMM d, y G – ", "E, MMM d, y G"]
+ },
+ GyMMMd: %{
+ d: ["MMM d – ", "d, y G"],
+ y: ["MMM d, y – ", "MMM d, y G"],
+ M: ["MMM d – ", "MMM d, y G"],
+ G: ["MMM d, y G – ", "MMM d, y G"]
+ },
+ GyMd: %{
+ d: ["M/d/y – ", "M/d/y G"],
+ y: ["M/d/y – ", "M/d/y G"],
+ M: ["M/d/y – ", "M/d/y G"],
+ G: ["M/d/y G – ", "M/d/y G"]
+ },
+ H: %{H: ["HH – ", "HH"]},
+ Hm: %{m: ["HH:mm – ", "HH:mm"], H: ["HH:mm – ", "HH:mm"]},
+ Hmv: %{m: ["HH:mm – ", "HH:mm v"], H: ["HH:mm – ", "HH:mm v"]},
+ MEd: %{d: ["E, M/d – ", "E, M/d"], M: ["E, M/d – ", "E, M/d"]},
+ MMM: %{M: ["MMM – ", "MMM"]},
+ MMMEd: %{
+ d: ["E, MMM d – ", "E, MMM d"],
+ M: ["E, MMM d – ", "E, MMM d"]
+ },
+ MMMd: %{d: ["MMM d – ", "d"], M: ["MMM d – ", "MMM d"]},
+ Md: %{d: ["M/d – ", "M/d"], M: ["M/d – ", "M/d"]},
+ hm: %{
+ m: ["h:mm – ", "h:mm a"],
+ a: ["h:mm a – ", "h:mm a"],
+ h: ["h:mm – ", "h:mm a"]
+ },
+ hmv: %{
+ m: ["h:mm – ", "h:mm a v"],
+ a: ["h:mm a – ", "h:mm a v"],
+ h: ["h:mm – ", "h:mm a v"]
+ },
+ yM: %{y: ["M/y – ", "M/y"], M: ["M/y – ", "M/y"]},
+ yMEd: %{
+ d: ["E, M/d/y – ", "E, M/d/y"],
+ y: ["E, M/d/y – ", "E, M/d/y"],
+ M: ["E, M/d/y – ", "E, M/d/y"]
+ },
+ yMMM: %{y: ["MMM y – ", "MMM y"], M: ["MMM – ", "MMM y"]},
+ yMMMEd: %{
+ d: ["E, MMM d – ", "E, MMM d, y"],
+ y: ["E, MMM d, y – ", "E, MMM d, y"],
+ M: ["E, MMM d – ", "E, MMM d, y"]
+ },
+ yMMMM: %{y: ["MMMM y – ", "MMMM y"], M: ["MMMM – ", "MMMM y"]},
+ yMMMd: %{
+ d: ["MMM d – ", "d, y"],
+ y: ["MMM d, y – ", "MMM d, y"],
+ M: ["MMM d – ", "MMM d, y"]
+ },
+ yMd: %{
+ d: ["M/d/y – ", "M/d/y"],
+ y: ["M/d/y – ", "M/d/y"],
+ M: ["M/d/y – ", "M/d/y"]
+ },
+ GyM: %{
+ y: ["M/y – ", "M/y G"],
+ M: ["M/y – ", "M/y G"],
+ G: ["M/y G – ", "M/y G"]
+ },
+ GyMEd: %{
+ d: ["E, M/d/y – ", "E, M/d/y G"],
+ y: ["E, M/d/y – ", "E, M/d/y G"],
+ M: ["E, M/d/y – ", "E, M/d/y G"],
+ G: ["E, M/d/y G – ", "E, M/d/y G"]
+ },
+ Hv: %{H: ["HH – ", "HH v"]},
+ hv: %{a: ["h a – ", "h a v"], h: ["h – ", "h a v"]}
+ }}
@@ -1154,8 +1154,8 @@ gmt_format(locale \\ Bonfire.Common.Localis
Example
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.gmt_format(:en)
-{:ok, ["GMT", 0]}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.gmt_format(:en)
+{:ok, ["GMT", 0]}
@@ -1201,11 +1201,11 @@ gmt_zero_format(locale \\ Bonfire.Common.Lo
Example
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.gmt_zero_format(:en)
-{:ok, "GMT"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.gmt_zero_format(:en)
+{:ok, "GMT"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.gmt_zero_format(:fr)
-{:ok, "UTC"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.gmt_zero_format(:fr)
+{:ok, "UTC"}
@@ -1250,8 +1250,8 @@ hour_format(locale \\ Bonfire.Common.Locali
Example
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.hour_format("en")
-{:ok, {"+HH:mm", "-HH:mm"}}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.hour_format("en")
+{:ok, {"+HH:mm", "-HH:mm"}}
@@ -1400,21 +1400,21 @@ time_formats(locale \\ Bonfire.Common.Local
Examples:
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.time_formats(:en)
-{:ok, %Cldr.Time.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.time_formats(:en)
+{:ok, %Cldr.Time.Formats{
full: "h:mm:ss a zzzz",
long: "h:mm:ss a z",
medium: "h:mm:ss a",
short: "h:mm a"
-}}
+}}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Format.time_formats(:en, :buddhist)
-{:ok, %Cldr.Time.Formats{
+iex> Bonfire.Common.Localise.Cldr.DateTime.Format.time_formats(:en, :buddhist)
+{:ok, %Cldr.Time.Formats{
full: "h:mm:ss a zzzz",
long: "h:mm:ss a z",
medium: "h:mm:ss a",
short: "h:mm a"
-}}
+}}
diff --git a/Bonfire.Common.Localise.Cldr.DateTime.Formatter.html b/Bonfire.Common.Localise.Cldr.DateTime.Formatter.html
index 068b553fc5..5b5330c657 100644
--- a/Bonfire.Common.Localise.Cldr.DateTime.Formatter.html
+++ b/Bonfire.Common.Localise.Cldr.DateTime.Formatter.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.DateTime.Formatter — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.DateTime.Formatter — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.DateTime.Formatter
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -250,7 +250,7 @@ format(date, format, locale \\ Cldr.get_loc
Examples
iex> Bonfire.Common.Localise.Cldr.DateTime.Formatter.format ~U[2017-09-03 10:23:00.0Z], "yy/MM/dd hh:MM", "en"
-{:ok, "17/09/03 10:09"}
+
{:ok, "17/09/03 10:09"}
diff --git a/Bonfire.Common.Localise.Cldr.DateTime.Interval.html b/Bonfire.Common.Localise.Cldr.DateTime.Interval.html
index a40f52716d..c2836febc4 100644
--- a/Bonfire.Common.Localise.Cldr.DateTime.Interval.html
+++ b/Bonfire.Common.Localise.Cldr.DateTime.Interval.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.DateTime.Interval — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.DateTime.Interval — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.DateTime.Interval
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -336,10 +336,10 @@ to_string(from, to, options \\ [])
iex> Bonfire.Common.Localise.Cldr.DateTime.Interval.to_string ~U[2020-01-01 00:00:00.0Z],
...> ~U[2020-12-31 10:00:00.0Z]
-{:ok, "Jan 1, 2020, 12:00:00 AM – Dec 31, 2020, 10:00:00 AM"}
+{:ok, "Jan 1, 2020, 12:00:00 AM – Dec 31, 2020, 10:00:00 AM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.Interval.to_string ~U[2020-01-01 00:00:00.0Z], nil
-{:ok, "Jan 1, 2020, 12:00:00 AM –"}
+
{:ok, "Jan 1, 2020, 12:00:00 AM –"}
diff --git a/Bonfire.Common.Localise.Cldr.DateTime.Relative.html b/Bonfire.Common.Localise.Cldr.DateTime.Relative.html
index b17e3f5e8a..3db5efa99c 100644
--- a/Bonfire.Common.Localise.Cldr.DateTime.Relative.html
+++ b/Bonfire.Common.Localise.Cldr.DateTime.Relative.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.DateTime.Relative — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.DateTime.Relative — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.DateTime.Relative
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -244,60 +244,60 @@ to_string(time, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(-1)
-{:ok, "1 second ago"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(-1)
+{:ok, "1 second ago"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1)
-{:ok, "in 1 second"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1)
+{:ok, "in 1 second"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1, unit: :day)
-{:ok, "tomorrow"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1, unit: :day)
+{:ok, "tomorrow"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1, unit: :day, locale: "fr")
-{:ok, "demain"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1, unit: :day, locale: "fr")
+{:ok, "demain"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1, unit: :day, format: :narrow)
-{:ok, "tomorrow"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1, unit: :day, format: :narrow)
+{:ok, "tomorrow"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1234, unit: :year)
-{:ok, "in 1,234 years"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1234, unit: :year)
+{:ok, "in 1,234 years"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1234, unit: :year, locale: "fr")
-{:ok, "dans 1 234 ans"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(1234, unit: :year, locale: "fr")
+{:ok, "dans 1 234 ans"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(31)
-{:ok, "in 31 seconds"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(31)
+{:ok, "in 31 seconds"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(~D[2017-04-29], relative_to: ~D[2017-04-26])
-{:ok, "in 3 days"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(~D[2017-04-29], relative_to: ~D[2017-04-26])
+{:ok, "in 3 days"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(310, format: :short, locale: "fr")
-{:ok, "dans 5 min"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(310, format: :short, locale: "fr")
+{:ok, "dans 5 min"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(310, format: :narrow, locale: "fr")
-{:ok, "+5 min"}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(310, format: :narrow, locale: "fr")
+{:ok, "+5 min"}
iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string 2, unit: :wed, format: :short, locale: "en"
-{:ok, "in 2 Wed."}
+{:ok, "in 2 Wed."}
iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string 1, unit: :wed, format: :short
-{:ok, "next Wed."}
+{:ok, "next Wed."}
iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string -1, unit: :wed, format: :short
-{:ok, "last Wed."}
+{:ok, "last Wed."}
iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string -1, unit: :wed
-{:ok, "last Wednesday"}
+{:ok, "last Wednesday"}
iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string -1, unit: :quarter
-{:ok, "last quarter"}
+{:ok, "last quarter"}
iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string -1, unit: :mon, locale: "fr"
-{:ok, "lundi dernier"}
+{:ok, "lundi dernier"}
-iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(~D[2017-04-29], unit: :ziggeraut)
-{:error, {Cldr.DateTime.UnknownTimeUnit,
- "Unknown time unit :ziggeraut. Valid time units are [:day, :fri, :hour, :minute, :mon, :month, :quarter, :sat, :second, :sun, :thu, :tue, :wed, :week, :year]"}}
+iex> Bonfire.Common.Localise.Cldr.DateTime.Relative.to_string(~D[2017-04-29], unit: :ziggeraut)
+{:error, {Cldr.DateTime.UnknownTimeUnit,
+ "Unknown time unit :ziggeraut. Valid time units are [:day, :fri, :hour, :minute, :mon, :month, :quarter, :sat, :second, :sun, :thu, :tue, :wed, :week, :year]"}}
diff --git a/Bonfire.Common.Localise.Cldr.DateTime.html b/Bonfire.Common.Localise.Cldr.DateTime.html
index 758a5f660b..ce8f75935f 100644
--- a/Bonfire.Common.Localise.Cldr.DateTime.html
+++ b/Bonfire.Common.Localise.Cldr.DateTime.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.DateTime — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.DateTime — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.DateTime
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -266,19 +266,19 @@ to_string(date_time, options \\ [])
Examples
-iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
+iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime
-{:ok, "Jan 1, 2000, 11:59:59 PM"}
+{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, locale: "en"
-{:ok, "Jan 1, 2000, 11:59:59 PM"}
+{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :long, locale: "en"
-{:ok, "January 1, 2000, 11:59:59 PM UTC"}
+{:ok, "January 1, 2000, 11:59:59 PM UTC"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :hms, locale: "en"
-{:ok, "11:59:59 PM"}
+{:ok, "11:59:59 PM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :full, locale: "en"
-{:ok, "Saturday, January 1, 2000, 11:59:59 PM GMT"}
+{:ok, "Saturday, January 1, 2000, 11:59:59 PM GMT"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :full, locale: "fr"
-{:ok, "samedi 1 janvier 2000, 23:59:59 UTC"}
+{:ok, "samedi 1 janvier 2000, 23:59:59 UTC"}
@@ -361,14 +361,14 @@ to_string!(date_time, options \\ [])
Examples
-iex> {:ok, date_time} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
-iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, locale: :en)
+iex> {:ok, date_time} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
+iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, locale: :en)
"Jan 1, 2000, 11:59:59 PM"
-iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :long, locale: :en)
+iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :long, locale: :en)
"January 1, 2000, 11:59:59 PM UTC"
-iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :full, locale: :en)
+iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :full, locale: :en)
"Saturday, January 1, 2000, 11:59:59 PM GMT"
-iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :full, locale: :fr)
+iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :full, locale: :fr)
"samedi 1 janvier 2000, 23:59:59 UTC"
diff --git a/Bonfire.Common.Localise.Cldr.Interval.html b/Bonfire.Common.Localise.Cldr.Interval.html
index 17ca5e4372..51d6a98348 100644
--- a/Bonfire.Common.Localise.Cldr.Interval.html
+++ b/Bonfire.Common.Localise.Cldr.Interval.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Interval — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Interval — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Interval
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -308,11 +308,11 @@ to_string(interval, options)
iex> use CalendarInterval
iex> Bonfire.Common.Localise.Cldr.Interval.to_string ~I"2020-01-01/12",
...> format: :long
-{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
+{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-12-31]),
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-12-31]),
...> format: :long
-{:ok, "Wed, Jan 1 – Thu, Dec 31, 2020"}
+{:ok, "Wed, Jan 1 – Thu, Dec 31, 2020"}
@@ -402,32 +402,32 @@ to_string(from, to, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-12-31])
-{:ok, "Jan 1 – Dec 31, 2020"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-12-31])
+{:ok, "Jan 1 – Dec 31, 2020"}
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-01-12])
-{:ok, "Jan 1 – 12, 2020"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-01-12])
+{:ok, "Jan 1 – 12, 2020"}
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-01-12],
-...> format: :long)
-{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-01-12],
+...> format: :long)
+{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-12-01],
-...> format: :long, style: :year_and_month)
-{:ok, "January – December 2020"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~D[2020-01-01], ~D[2020-12-01],
+...> format: :long, style: :year_and_month)
+{:ok, "January – December 2020"}
iex> use CalendarInterval
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~I"2020-01-01/12",
-...> format: :long)
-{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~I"2020-01-01/12",
+...> format: :long)
+{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~U[2020-01-01 00:00:00.0Z], ~U[2020-12-01 10:05:00.0Z],
-...> format: :long)
-{:ok, "January 1, 2020, 12:00:00 AM UTC – December 1, 2020, 10:05:00 AM UTC"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~U[2020-01-01 00:00:00.0Z], ~U[2020-12-01 10:05:00.0Z],
+...> format: :long)
+{:ok, "January 1, 2020, 12:00:00 AM UTC – December 1, 2020, 10:05:00 AM UTC"}
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~U[2020-01-01 00:00:00.0Z], ~U[2020-01-01 10:05:00.0Z],
-...> format: :long)
-{:ok, "January 1, 2020, 12:00:00 AM UTC – 10:05:00 AM UTC"}
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string(~U[2020-01-01 00:00:00.0Z], ~U[2020-01-01 10:05:00.0Z],
+...> format: :long)
+{:ok, "January 1, 2020, 12:00:00 AM UTC – 10:05:00 AM UTC"}
@@ -515,12 +515,12 @@ to_string!(interval, options)
Examples
iex> use CalendarInterval
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~I"2020-01-01/12",
-...> format: :long)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~I"2020-01-01/12",
+...> format: :long)
"Wed, Jan 1 – Sun, Jan 12, 2020"
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(Date.range(~D[2020-01-01], ~D[2020-12-31]),
-...> format: :long)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(Date.range(~D[2020-01-01], ~D[2020-12-31]),
+...> format: :long)
"Wed, Jan 1 – Thu, Dec 31, 2020"
@@ -612,31 +612,31 @@ to_string!(from, to, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-12-31])
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-12-31])
"Jan 1 – Dec 31, 2020"
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-01-12])
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-01-12])
"Jan 1 – 12, 2020"
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-01-12],
-...> format: :long)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-01-12],
+...> format: :long)
"Wed, Jan 1 – Sun, Jan 12, 2020"
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-12-01],
-...> format: :long, style: :year_and_month)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~D[2020-01-01], ~D[2020-12-01],
+...> format: :long, style: :year_and_month)
"January – December 2020"
iex> use CalendarInterval
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~I"2020-01-01/12",
-...> format: :long)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~I"2020-01-01/12",
+...> format: :long)
"Wed, Jan 1 – Sun, Jan 12, 2020"
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~U[2020-01-01 00:00:00.0Z], ~U[2020-12-01 10:05:00.0Z],
-...> format: :long)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~U[2020-01-01 00:00:00.0Z], ~U[2020-12-01 10:05:00.0Z],
+...> format: :long)
"January 1, 2020, 12:00:00 AM UTC – December 1, 2020, 10:05:00 AM UTC"
-iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~U[2020-01-01 00:00:00.0Z], ~U[2020-01-01 10:05:00.0Z],
-...> format: :long)
+iex> Bonfire.Common.Localise.Cldr.Interval.to_string!(~U[2020-01-01 00:00:00.0Z], ~U[2020-01-01 10:05:00.0Z],
+...> format: :long)
"January 1, 2020, 12:00:00 AM UTC – 10:05:00 AM UTC"
diff --git a/Bonfire.Common.Localise.Cldr.Language.html b/Bonfire.Common.Localise.Cldr.Language.html
index 3c7e908b2f..3f52a791f1 100644
--- a/Bonfire.Common.Localise.Cldr.Language.html
+++ b/Bonfire.Common.Localise.Cldr.Language.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Language — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Language — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Language
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -286,12 +286,12 @@ available_languages(locale \\ get_locale())
Example
-> Bonfire.Common.Localise.Cldr.Language.Language.available_languages(:en)
-["aa", "ab", "ace", "ach", "ada", "ady", "ae", "aeb", "af", "afh", "agq", "ain",
+> Bonfire.Common.Localise.Cldr.Language.Language.available_languages(:en)
+["aa", "ab", "ace", "ach", "ada", "ady", "ae", "aeb", "af", "afh", "agq", "ain",
"ak", "akk", "akz", "ale", "aln", "alt", "am", "an", "ang", "anp", "ar",
"ar-001", "arc", "arn", "aro", "arp", "arq", "ars", "arw", "ary", "arz", "as",
"asa", "ase", "ast", "av", "avk", "awa", "ay", "az", "ba", "bal", "ban", "bar",
-"bas", "bax", "bbc", "bbj", ...]
+"bas", "bax", "bbc", "bbj", ...]
@@ -331,33 +331,33 @@ known_languages(locale \\ get_locale())
Example
-> Bonfire.Common.Localise.Cldr.Language.Language.known_languages(:en)
-%{"bez" => %{standard: "Bena"}, "lo" => %{standard: "Lao"},
-"kha" => %{standard: "Khasi"}, "eo" => %{standard: "Esperanto"},
-"rm" => %{standard: "Romansh"}, "ja" => %{standard: "Japanese"},
-"sw-CD" => %{standard: "Congo Swahili"},
-"pdc" => %{standard: "Pennsylvania German"}, "om" => %{standard: "Oromo"},
-"jut" => %{standard: "Jutish"}, "lij" => %{standard: "Ligurian"},
-"kut" => %{standard: "Kutenai"}, "vep" => %{standard: "Veps"},
-"yao" => %{standard: "Yao"}, "gez" => %{standard: "Geez"},
-"cr" => %{standard: "Cree"}, "ne" => %{standard: "Nepali"},
-"zbl" => %{standard: "Blissymbols"}, "ae" => %{standard: "Avestan"},
-"rof" => %{standard: "Rombo"}, "tkl" => %{standard: "Tokelau"},
-"rgn" => %{standard: "Romagnol"}, "el" => %{standard: "Greek"},
-"myv" => %{standard: "Erzya"}, "smj" => %{standard: "Lule Sami"},
-"fo" => %{standard: "Faroese"}, "ii" => %{standard: "Sichuan Yi"},
-"bum" => %{standard: "Bulu"}, "za" => %{standard: "Zhuang"},
-"raj" => %{standard: "Rajasthani"}, "mrj" => %{standard: "Western Mari"},
-"stq" => %{standard: "Saterland Frisian"}, "hu" => %{standard: "Hungarian"},
-"mga" => %{standard: "Middle Irish"}, "bej" => %{standard: "Beja"},
-"yue" => %{standard: "Cantonese"}, "xog" => %{standard: "Soga"},
-"ttt" => %{standard: "Muslim Tat"}, "uga" => %{standard: "Ugaritic"},
-"rup" => %{standard: "Aromanian"},
-"crs" => %{standard: "Seselwa Creole French"}, "oc" => %{standard: "Occitan"},
-"chp" => %{standard: "Chipewyan"}, "zen" => %{standard: "Zenaga"},
-"kmb" => %{standard: "Kimbundu"}, "nr" => %{standard: "South Ndebele"},
-"tiv" => %{standard: "Tiv"}, "aln" => %{standard: "Gheg Albanian"},
-"sh" => %{standard: "Serbo-Croatian"}, "fil" => %{...}, ...}
+> Bonfire.Common.Localise.Cldr.Language.Language.known_languages(:en)
+%{"bez" => %{standard: "Bena"}, "lo" => %{standard: "Lao"},
+"kha" => %{standard: "Khasi"}, "eo" => %{standard: "Esperanto"},
+"rm" => %{standard: "Romansh"}, "ja" => %{standard: "Japanese"},
+"sw-CD" => %{standard: "Congo Swahili"},
+"pdc" => %{standard: "Pennsylvania German"}, "om" => %{standard: "Oromo"},
+"jut" => %{standard: "Jutish"}, "lij" => %{standard: "Ligurian"},
+"kut" => %{standard: "Kutenai"}, "vep" => %{standard: "Veps"},
+"yao" => %{standard: "Yao"}, "gez" => %{standard: "Geez"},
+"cr" => %{standard: "Cree"}, "ne" => %{standard: "Nepali"},
+"zbl" => %{standard: "Blissymbols"}, "ae" => %{standard: "Avestan"},
+"rof" => %{standard: "Rombo"}, "tkl" => %{standard: "Tokelau"},
+"rgn" => %{standard: "Romagnol"}, "el" => %{standard: "Greek"},
+"myv" => %{standard: "Erzya"}, "smj" => %{standard: "Lule Sami"},
+"fo" => %{standard: "Faroese"}, "ii" => %{standard: "Sichuan Yi"},
+"bum" => %{standard: "Bulu"}, "za" => %{standard: "Zhuang"},
+"raj" => %{standard: "Rajasthani"}, "mrj" => %{standard: "Western Mari"},
+"stq" => %{standard: "Saterland Frisian"}, "hu" => %{standard: "Hungarian"},
+"mga" => %{standard: "Middle Irish"}, "bej" => %{standard: "Beja"},
+"yue" => %{standard: "Cantonese"}, "xog" => %{standard: "Soga"},
+"ttt" => %{standard: "Muslim Tat"}, "uga" => %{standard: "Ugaritic"},
+"rup" => %{standard: "Aromanian"},
+"crs" => %{standard: "Seselwa Creole French"}, "oc" => %{standard: "Occitan"},
+"chp" => %{standard: "Chipewyan"}, "zen" => %{standard: "Zenaga"},
+"kmb" => %{standard: "Kimbundu"}, "nr" => %{standard: "South Ndebele"},
+"tiv" => %{standard: "Tiv"}, "aln" => %{standard: "Gheg Albanian"},
+"sh" => %{standard: "Serbo-Croatian"}, "fil" => %{...}, ...}
@@ -394,8 +394,8 @@ to_string(key, options \\ [])
Example
-iex> Bonfire.Common.Localise.Cldr.Language.Language.to_string("eo")
-{:ok, "Esperanto"}
+iex> Bonfire.Common.Localise.Cldr.Language.Language.to_string("eo")
+{:ok, "Esperanto"}
diff --git a/Bonfire.Common.Localise.Cldr.List.html b/Bonfire.Common.Localise.Cldr.List.html
index cb22549716..a6d44d7f8a 100644
--- a/Bonfire.Common.Localise.Cldr.List.html
+++ b/Bonfire.Common.Localise.Cldr.List.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.List — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.List — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,15 +132,15 @@
Bonfire.Common.Localise.Cldr.List
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
Cldr backend module that formats lists.
If we have a list of days like ["Monday", "Tuesday", "Wednesday"]
-then we can format that list for a given locale by:
iex> Bonfire.Common.Localise.Cldr.List.to_string(["Monday", "Tuesday", "Wednesday"], locale: "en")
-{:ok, "Monday, Tuesday, and Wednesday"}
+then we can format that list for a given locale by:iex> Bonfire.Common.Localise.Cldr.List.to_string(["Monday", "Tuesday", "Wednesday"], locale: "en")
+{:ok, "Monday, Tuesday, and Wednesday"}
@@ -292,23 +292,23 @@ intersperse(list, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a", "b", "c"], locale: "en")
-{:ok, ["a", ", ", "b", ", and ", "c"]}
+iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a", "b", "c"], locale: "en")
+{:ok, ["a", ", ", "b", ", and ", "c"]}
-iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a", "b", "c"], locale: "en", format: :unit_narrow)
-{:ok, ["a", " ", "b", " ", "c"]}
+iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a", "b", "c"], locale: "en", format: :unit_narrow)
+{:ok, ["a", " ", "b", " ", "c"]}
-iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a", "b", "c"], locale: "fr")
-{:ok, ["a", ", ", "b", " et ", "c"]}
+iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a", "b", "c"], locale: "fr")
+{:ok, ["a", ", ", "b", " et ", "c"]}
-iex> Bonfire.Common.Localise.Cldr.List.intersperse([1,2,3,4,5,6])
-{:ok, [1, ", ", 2, ", ", 3, ", ", 4, ", ", 5, ", and ", 6]}
+iex> Bonfire.Common.Localise.Cldr.List.intersperse([1,2,3,4,5,6])
+{:ok, [1, ", ", 2, ", ", 3, ", ", 4, ", ", 5, ", and ", 6]}
-iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a"])
-{:ok, ["a"]}
+iex> Bonfire.Common.Localise.Cldr.List.intersperse(["a"])
+{:ok, ["a"]}
-iex> Bonfire.Common.Localise.Cldr.List.intersperse([1,2])
-{:ok, [1, " and ", 2]}
+iex> Bonfire.Common.Localise.Cldr.List.intersperse([1,2])
+{:ok, [1, " and ", 2]}
@@ -367,11 +367,11 @@ intersperse!(list, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.List.intersperse!(["a", "b", "c"], locale: "en")
-["a", ", ", "b", ", and ", "c"]
+iex> Bonfire.Common.Localise.Cldr.List.intersperse!(["a", "b", "c"], locale: "en")
+["a", ", ", "b", ", and ", "c"]
-iex> Bonfire.Common.Localise.Cldr.List.intersperse!(["a", "b", "c"], locale: "en", format: :unit_narrow)
-["a", " ", "b", " ", "c"]
+iex> Bonfire.Common.Localise.Cldr.List.intersperse!(["a", "b", "c"], locale: "en", format: :unit_narrow)
+["a", " ", "b", " ", "c"]
@@ -407,9 +407,9 @@ list_formats_for(locale_name)
Example
-iex> Bonfire.Common.Localise.Cldr.List.list_formats_for(:en)
-[:or, :or_narrow, :or_short, :standard, :standard_narrow, :standard_short,
- :unit, :unit_narrow, :unit_short]
+iex> Bonfire.Common.Localise.Cldr.List.list_formats_for(:en)
+[:or, :or_narrow, :or_short, :standard, :standard_narrow, :standard_short,
+ :unit, :unit_narrow, :unit_short]
@@ -445,63 +445,63 @@ list_patterns_for(locale_name)
Example
-iex> Bonfire.Common.Localise.Cldr.List.list_patterns_for(:en)
-%{
- or: %Cldr.List.Pattern{
- two: [0, " or ", 1],
- end: [0, ", or ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- or_narrow: %Cldr.List.Pattern{
- two: [0, " or ", 1],
- end: [0, ", or ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- or_short: %Cldr.List.Pattern{
- two: [0, " or ", 1],
- end: [0, ", or ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- standard: %Cldr.List.Pattern{
- two: [0, " and ", 1],
- end: [0, ", and ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- standard_narrow: %Cldr.List.Pattern{
- two: [0, ", ", 1],
- end: [0, ", ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- standard_short: %Cldr.List.Pattern{
- two: [0, " & ", 1],
- end: [0, ", & ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- unit: %Cldr.List.Pattern{
- two: [0, ", ", 1],
- end: [0, ", ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- },
- unit_narrow: %Cldr.List.Pattern{
- two: [0, " ", 1],
- end: [0, " ", 1],
- middle: [0, " ", 1],
- start: [0, " ", 1]
- },
- unit_short: %Cldr.List.Pattern{
- two: [0, ", ", 1],
- end: [0, ", ", 1],
- middle: [0, ", ", 1],
- start: [0, ", ", 1]
- }
-}
+iex> Bonfire.Common.Localise.Cldr.List.list_patterns_for(:en)
+%{
+ or: %Cldr.List.Pattern{
+ two: [0, " or ", 1],
+ end: [0, ", or ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ or_narrow: %Cldr.List.Pattern{
+ two: [0, " or ", 1],
+ end: [0, ", or ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ or_short: %Cldr.List.Pattern{
+ two: [0, " or ", 1],
+ end: [0, ", or ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ standard: %Cldr.List.Pattern{
+ two: [0, " and ", 1],
+ end: [0, ", and ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ standard_narrow: %Cldr.List.Pattern{
+ two: [0, ", ", 1],
+ end: [0, ", ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ standard_short: %Cldr.List.Pattern{
+ two: [0, " & ", 1],
+ end: [0, ", & ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ unit: %Cldr.List.Pattern{
+ two: [0, ", ", 1],
+ end: [0, ", ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ },
+ unit_narrow: %Cldr.List.Pattern{
+ two: [0, " ", 1],
+ end: [0, " ", 1],
+ middle: [0, " ", 1],
+ start: [0, " ", 1]
+ },
+ unit_short: %Cldr.List.Pattern{
+ two: [0, ", ", 1],
+ end: [0, ", ", 1],
+ middle: [0, ", ", 1],
+ start: [0, ", ", 1]
+ }
+}
@@ -553,23 +553,23 @@ to_string(list, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.List.to_string(["a", "b", "c"], locale: "en")
-{:ok, "a, b, and c"}
+iex> Bonfire.Common.Localise.Cldr.List.to_string(["a", "b", "c"], locale: "en")
+{:ok, "a, b, and c"}
-iex> Bonfire.Common.Localise.Cldr.List.to_string(["a", "b", "c"], locale: "en", format: :unit_narrow)
-{:ok, "a b c"}
+iex> Bonfire.Common.Localise.Cldr.List.to_string(["a", "b", "c"], locale: "en", format: :unit_narrow)
+{:ok, "a b c"}
-iex> Bonfire.Common.Localise.Cldr.List.to_string(["a", "b", "c"], locale: "fr")
-{:ok, "a, b et c"}
+iex> Bonfire.Common.Localise.Cldr.List.to_string(["a", "b", "c"], locale: "fr")
+{:ok, "a, b et c"}
-iex> Bonfire.Common.Localise.Cldr.List.to_string([1,2,3,4,5,6])
-{:ok, "1, 2, 3, 4, 5, and 6"}
+iex> Bonfire.Common.Localise.Cldr.List.to_string([1,2,3,4,5,6])
+{:ok, "1, 2, 3, 4, 5, and 6"}
-iex> Bonfire.Common.Localise.Cldr.List.to_string(["a"])
-{:ok, "a"}
+iex> Bonfire.Common.Localise.Cldr.List.to_string(["a"])
+{:ok, "a"}
-iex> Bonfire.Common.Localise.Cldr.List.to_string([1,2])
-{:ok, "1 and 2"}
+iex> Bonfire.Common.Localise.Cldr.List.to_string([1,2])
+{:ok, "1 and 2"}
@@ -606,10 +606,10 @@ to_string!(list, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.List.to_string!(["a", "b", "c"], locale: "en")
+iex> Bonfire.Common.Localise.Cldr.List.to_string!(["a", "b", "c"], locale: "en")
"a, b, and c"
-iex> Bonfire.Common.Localise.Cldr.List.to_string!(["a", "b", "c"], locale: "en", format: :unit_narrow)
+iex> Bonfire.Common.Localise.Cldr.List.to_string!(["a", "b", "c"], locale: "en", format: :unit_narrow)
"a b c"
diff --git a/Bonfire.Common.Localise.Cldr.Locale.html b/Bonfire.Common.Localise.Cldr.Locale.html
index 52a863a63f..53f878df6e 100644
--- a/Bonfire.Common.Localise.Cldr.Locale.html
+++ b/Bonfire.Common.Localise.Cldr.Locale.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Locale — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Locale — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Locale
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -322,16 +322,16 @@ fallback_locale_names(locale)
Examples
-iex> Bonfire.Common.Localise.Cldr.Locale.fallback_locale_names(:"fr-CA")
-{:ok, [:"fr-CA", :fr, :und]}
+iex> Bonfire.Common.Localise.Cldr.Locale.fallback_locale_names(:"fr-CA")
+{:ok, [:"fr-CA", :fr, :und]}
# Fallbacks are typically formed by progressively
# stripping variant, territory and script from the
# given locale name. But not always - there are
# certain fallbacks that take a different path.
-iex> Bonfire.Common.Localise.Cldr.Locale.fallback_locale_names(:nb)
-{:ok, [:nb, :no, :und]}
+iex> Bonfire.Common.Localise.Cldr.Locale.fallback_locale_names(:nb)
+{:ok, [:nb, :no, :und]}
@@ -385,20 +385,20 @@ fallback_locales(locale)
Examples
-Bonfire.Common.Localise.Cldr.Locale.fallback_locales(:"fr-CA")
-=> {:ok,
- [#Cldr.LanguageTag<fr-CA [validated]>, #Cldr.LanguageTag<fr [validated]>,
- #Cldr.LanguageTag<und [validated]>]}
+Bonfire.Common.Localise.Cldr.Locale.fallback_locales(:"fr-CA")
+=> {:ok,
+ [#Cldr.LanguageTag<fr-CA [validated]>, #Cldr.LanguageTag<fr [validated]>,
+ #Cldr.LanguageTag<und [validated]>]}
# Fallbacks are typically formed by progressively
# stripping variant, territory and script from the
# given locale name. But not always - there are
# certain fallbacks that take a different path.
-Bonfire.Common.Localise.Cldr.Locale.fallback_locales(:nb))
-=> {:ok,
- [#Cldr.LanguageTag<nb [validated]>, #Cldr.LanguageTag<no [validated]>,
- #Cldr.LanguageTag<und [validated]>]}
+Bonfire.Common.Localise.Cldr.Locale.fallback_locales(:nb))
+=> {:ok,
+ [#Cldr.LanguageTag<nb [validated]>, #Cldr.LanguageTag<no [validated]>,
+ #Cldr.LanguageTag<und [validated]>]}
@@ -529,15 +529,15 @@ locale_from_host(host, options \\ [])
Examples
iex> Bonfire.Common.Localise.Cldr.Locale.locale_from_host "a.b.com.au"
-Elixir.Bonfire.Common.Localise.Cldr.validate_locale(:"en-AU")
+Elixir.Bonfire.Common.Localise.Cldr.validate_locale(:"en-AU")
-iex> Bonfire.Common.Localise.Cldr.Locale.locale_from_host("a.b.com.tv")
-{:error,
- {Cldr.UnknownLocaleError, "No locale was identified for territory \"tv\""}}
+iex> Bonfire.Common.Localise.Cldr.Locale.locale_from_host("a.b.com.tv")
+{:error,
+ {Cldr.UnknownLocaleError, "No locale was identified for territory \"tv\""}}
-iex> Bonfire.Common.Localise.Cldr.Locale.locale_from_host("a.b.com")
-{:error,
- {Cldr.UnknownLocaleError, "No locale was identified for territory \"com\""}}
+
iex> Bonfire.Common.Localise.Cldr.Locale.locale_from_host("a.b.com")
+{:error,
+ {Cldr.UnknownLocaleError, "No locale was identified for territory \"com\""}}
@@ -679,12 +679,12 @@ territory_from_host(host)
Examples
-iex> Cldr.Locale.territory_from_host("a.b.com.au")
-{:ok, :AU}
+iex> Cldr.Locale.territory_from_host("a.b.com.au")
+{:ok, :AU}
-iex> Cldr.Locale.territory_from_host("a.b.com")
-{:error,
- {Cldr.UnknownLocaleError, "No locale was identified for territory \"com\""}}
+iex> Cldr.Locale.territory_from_host("a.b.com")
+{:error,
+ {Cldr.UnknownLocaleError, "No locale was identified for territory \"com\""}}
diff --git a/Bonfire.Common.Localise.Cldr.LocaleDisplay.html b/Bonfire.Common.Localise.Cldr.LocaleDisplay.html
index 51e6eac355..e1575d7f3a 100644
--- a/Bonfire.Common.Localise.Cldr.LocaleDisplay.html
+++ b/Bonfire.Common.Localise.Cldr.LocaleDisplay.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.LocaleDisplay — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.LocaleDisplay — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.LocaleDisplay
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -286,25 +286,25 @@ display_name(language_tag, options \\ [])Examples
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "en"
-{:ok, "English"}
+{:ok, "English"}
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "en-US"
-{:ok, "American English"}
+{:ok, "American English"}
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "en-US", compound_locale: false
-{:ok, "English (United States)"}
+{:ok, "English (United States)"}
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "en-US-u-ca-gregory-cu-aud"
-{:ok, "American English (Gregorian Calendar, Currency: A$)"}
+{:ok, "American English (Gregorian Calendar, Currency: A$)"}
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "en-US-u-ca-gregory-cu-aud", locale: "fr"
-{:ok, "anglais américain (calendrier grégorien, devise : A$)"}
+{:ok, "anglais américain (calendrier grégorien, devise : A$)"}
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "nl-BE"
-{:ok, "Flemish"}
+{:ok, "Flemish"}
iex> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_name "nl-BE", compound_locale: false
-{:ok, "Dutch (Belgium)"}
+
{:ok, "Dutch (Belgium)"}
@@ -445,7 +445,7 @@ display_names(locale)
Examples
-=> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_names("en")
+=> Bonfire.Common.Localise.Cldr.LocaleDisplay.display_names("en")
@@ -498,7 +498,7 @@ time_zone_names(locale)
Examples
-=> Bonfire.Common.Localise.Cldr.LocaleDisplay.time_zone_names("en")
+=> Bonfire.Common.Localise.Cldr.LocaleDisplay.time_zone_names("en")
diff --git a/Bonfire.Common.Localise.Cldr.Number.Cardinal.html b/Bonfire.Common.Localise.Cldr.Number.Cardinal.html
index d475598c82..9695fe26d5 100644
--- a/Bonfire.Common.Localise.Cldr.Number.Cardinal.html
+++ b/Bonfire.Common.Localise.Cldr.Number.Cardinal.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.Cardinal — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.Cardinal — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.Cardinal
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -457,31 +457,31 @@ pluralize(number, locale_name, substitution
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 1, "en", %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 1, "en", %{one: "one"}
"one"
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 2, "en", %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 2, "en", %{one: "one"}
nil
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 2, "en", %{one: "one", two: "two", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 2, "en", %{one: "one", two: "two", other: "other"}
"other"
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 22, "en", %{one: "one", two: "two", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 22, "en", %{one: "one", two: "two", other: "other"}
"other"
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize Decimal.new(1), "en", %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize Decimal.new(1), "en", %{one: "one"}
"one"
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize Decimal.new(2), "en", %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize Decimal.new(2), "en", %{one: "one"}
nil
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize Decimal.new(2), "en", %{one: "one", two: "two"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize Decimal.new(2), "en", %{one: "one", two: "two"}
nil
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 1..10, "ar", %{one: "one", few: "few", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 1..10, "ar", %{one: "one", few: "few", other: "other"}
"few"
-iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 1..10, "en", %{one: "one", few: "few", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Cardinal.pluralize 1..10, "en", %{one: "one", few: "few", other: "other"}
"other"
diff --git a/Bonfire.Common.Localise.Cldr.Number.Format.html b/Bonfire.Common.Localise.Cldr.Number.Format.html
index 4d546086f4..aac7ed8bd6 100644
--- a/Bonfire.Common.Localise.Cldr.Number.Format.html
+++ b/Bonfire.Common.Localise.Cldr.Number.Format.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.Format — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.Format — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.Format
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -465,7 +465,7 @@ decimal_format_list()
Example
#=> Bonfire.Common.Localise.Cldr.Number.Format.Format.decimal_format_list
-["#", "#,##,##0%",
+["#", "#,##,##0%",
"#,##,##0.###", "#,##,##0.00¤", "#,##,##0.00¤;(#,##,##0.00¤)",
"#,##,##0 %", "#,##0%", "#,##0.###", "#,##0.00 ¤",
"#,##0.00 ¤;(#,##0.00 ¤)", "#,##0.00¤", "#,##0.00¤;(#,##0.00¤)",
@@ -475,7 +475,7 @@ decimal_format_list()
"000 B ¤", "000 E ¤", "000 K ¤", "000 MRD ¤", "000 Md ¤", "000 Mio'.' ¤",
"000 Mio ¤", "000 Mld ¤", "000 Mln ¤", "000 Mn ¤", "000 Mrd'.' ¤",
"000 Mrd ¤", "000 Mr ¤", "000 M ¤", "000 NT ¤", "000 N ¤", "000 Tn ¤",
-"000 Tr ¤", ...]
+"000 Tr ¤", ...]
@@ -523,8 +523,8 @@ decimal_format_list_for(locale \\ Bonfire.C
Example
-iex> Bonfire.Common.Localise.Cldr.Number.Format.decimal_format_list_for(:en)
-{:ok, ["#,##0%", "#,##0.###", "#,##0.00", "#,##0.00;(#,##0.00)","#E0",
+iex> Bonfire.Common.Localise.Cldr.Number.Format.decimal_format_list_for(:en)
+{:ok, ["#,##0%", "#,##0.###", "#,##0.00", "#,##0.00;(#,##0.00)","#E0",
"0 billion", "0 million", "0 thousand",
"0 trillion", "00 billion", "00 million", "00 thousand", "00 trillion",
"000 billion", "000 million", "000 thousand", "000 trillion", "000B", "000K",
@@ -532,7 +532,7 @@ decimal_format_list_for(locale \\ Bonfire.C
"¤#,##0.00", "¤#,##0.00;(¤#,##0.00)", "¤000B", "¤000K", "¤000M",
"¤000T", "¤00B", "¤00K", "¤00M", "¤00T", "¤0B", "¤0K", "¤0M", "¤0T",
"¤ #,##0.00", "¤ #,##0.00;(¤ #,##0.00)", "¤ 000B", "¤ 000K", "¤ 000M",
- "¤ 000T", "¤ 00B", "¤ 00K", "¤ 00M", "¤ 00T", "¤ 0B", "¤ 0K", "¤ 0M", "¤ 0T"]}
+ "¤ 000T", "¤ 00B", "¤ 00K", "¤ 00M", "¤ 00T", "¤ 0B", "¤ 0K", "¤ 0M", "¤ 0T"]}
@@ -585,8 +585,8 @@ default_grouping_for(locale \\ Bonfire.Comm
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Format.default_grouping_for(:en)
-{:ok, %{fraction: %{first: 0, rest: 0}, integer: %{first: 3, rest: 3}}}
+iex> Bonfire.Common.Localise.Cldr.Number.Format.default_grouping_for(:en)
+{:ok, %{fraction: %{first: 0, rest: 0}, integer: %{first: 3, rest: 3}}}
@@ -642,8 +642,8 @@ default_grouping_for!(locale)
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Format.default_grouping_for!(:en)
-%{fraction: %{first: 0, rest: 0}, integer: %{first: 3, rest: 3}}
+iex> Bonfire.Common.Localise.Cldr.Number.Format.default_grouping_for!(:en)
+%{fraction: %{first: 0, rest: 0}, integer: %{first: 3, rest: 3}}
@@ -700,18 +700,18 @@ formats_for(locale \\ Bonfire.Common.Locali
percent: "#,##0 %",
scientific: "#E0",
standard: "#,##0.###"
- currency_short: [{"1000", [one: "0 k ¤", other: "0 k ¤"]},
- {"10000", [one: "00 k ¤", other: "00 k ¤"]},
- {"100000", [one: "000 k ¤", other: "000 k ¤"]},
- {"1000000", [one: "0 M ¤", other: "0 M ¤"]},
- {"10000000", [one: "00 M ¤", other: "00 M ¤"]},
- {"100000000", [one: "000 M ¤", other: "000 M ¤"]},
- {"1000000000", [one: "0 Md ¤", other: "0 Md ¤"]},
- {"10000000000", [one: "00 Md ¤", other: "00 Md ¤"]},
- {"100000000000", [one: "000 Md ¤", other: "000 Md ¤"]},
- {"1000000000000", [one: "0 Bn ¤", other: "0 Bn ¤"]},
- {"10000000000000", [one: "00 Bn ¤", other: "00 Bn ¤"]},
- {"100000000000000", [one: "000 Bn ¤", other: "000 Bn ¤"]}],
+ currency_short: [{"1000", [one: "0 k ¤", other: "0 k ¤"]},
+ {"10000", [one: "00 k ¤", other: "00 k ¤"]},
+ {"100000", [one: "000 k ¤", other: "000 k ¤"]},
+ {"1000000", [one: "0 M ¤", other: "0 M ¤"]},
+ {"10000000", [one: "00 M ¤", other: "00 M ¤"]},
+ {"100000000", [one: "000 M ¤", other: "000 M ¤"]},
+ {"1000000000", [one: "0 Md ¤", other: "0 Md ¤"]},
+ {"10000000000", [one: "00 Md ¤", other: "00 Md ¤"]},
+ {"100000000000", [one: "000 Md ¤", other: "000 Md ¤"]},
+ {"1000000000000", [one: "0 Bn ¤", other: "0 Bn ¤"]},
+ {"10000000000000", [one: "00 Bn ¤", other: "00 Bn ¤"]},
+ {"100000000000000", [one: "000 Bn ¤", other: "000 Bn ¤"]}],
...
}
@@ -802,8 +802,8 @@ minimum_grouping_digits_for(locale \\ Bonfi
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Format.minimum_grouping_digits_for("en")
-{:ok, 1}
+iex> Bonfire.Common.Localise.Cldr.Number.Format.minimum_grouping_digits_for("en")
+{:ok, 1}
@@ -855,7 +855,7 @@ minimum_grouping_digits_for!(locale)
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Format.minimum_grouping_digits_for!("en")
+iex> Bonfire.Common.Localise.Cldr.Number.Format.minimum_grouping_digits_for!("en")
1
diff --git a/Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal.html b/Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal.html
index 94252e6fe5..71031f3991 100644
--- a/Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal.html
+++ b/Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.Formatter.Decimal
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Localise.Cldr.Number.Ordinal.html b/Bonfire.Common.Localise.Cldr.Number.Ordinal.html
index a82735e892..1179afe53b 100644
--- a/Bonfire.Common.Localise.Cldr.Number.Ordinal.html
+++ b/Bonfire.Common.Localise.Cldr.Number.Ordinal.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.Ordinal — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.Ordinal — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.Ordinal
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -460,31 +460,31 @@ pluralize(number, locale_name, substitution
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 1, :en, %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 1, :en, %{one: "one"}
"one"
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 2, :en, %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 2, :en, %{one: "one"}
nil
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 2, :en, %{one: "one", two: "two"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 2, :en, %{one: "one", two: "two"}
"two"
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 22, :en, %{one: "one", two: "two", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 22, :en, %{one: "one", two: "two", other: "other"}
"two"
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize Decimal.new(1), :en, %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize Decimal.new(1), :en, %{one: "one"}
"one"
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize Decimal.new(2), :en, %{one: "one"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize Decimal.new(2), :en, %{one: "one"}
nil
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize Decimal.new(2), :en, %{one: "one", two: "two"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize Decimal.new(2), :en, %{one: "one", two: "two"}
"two"
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 1..10, "ar", %{one: "one", few: "few", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 1..10, "ar", %{one: "one", few: "few", other: "other"}
"other"
-iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 1..10, "en", %{one: "one", few: "few", other: "other"}
+iex> Bonfire.Common.Localise.Cldr.Number.Ordinal.pluralize 1..10, "en", %{one: "one", few: "few", other: "other"}
"other"
diff --git a/Bonfire.Common.Localise.Cldr.Number.PluralRule.Range.html b/Bonfire.Common.Localise.Cldr.Number.PluralRule.Range.html
index 596ff0230f..f84ec1e20a 100644
--- a/Bonfire.Common.Localise.Cldr.Number.PluralRule.Range.html
+++ b/Bonfire.Common.Localise.Cldr.Number.PluralRule.Range.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.PluralRule.Range — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.PluralRule.Range — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.PluralRule.Range
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Localise.Cldr.Number.Symbol.html b/Bonfire.Common.Localise.Cldr.Number.Symbol.html
index 9462aefd5d..07e30cb478 100644
--- a/Bonfire.Common.Localise.Cldr.Number.Symbol.html
+++ b/Bonfire.Common.Localise.Cldr.Number.Symbol.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.Symbol — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.Symbol — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.Symbol
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -374,9 +374,9 @@ number_symbols_for(locale \\ Bonfire.Common
Example:
-iex> Bonfire.Common.Localise.Cldr.Number.Symbol.number_symbols_for(:th)
-{:ok, %{
- latn: %Cldr.Number.Symbol{
+iex> Bonfire.Common.Localise.Cldr.Number.Symbol.number_symbols_for(:th)
+{:ok, %{
+ latn: %Cldr.Number.Symbol{
decimal: ".",
exponential: "E",
group: ",",
@@ -389,8 +389,8 @@ number_symbols_for(locale \\ Bonfire.Common
plus_sign: "+",
superscripting_exponent: "×",
time_separator: ":"
- },
- thai: %Cldr.Number.Symbol{
+ },
+ thai: %Cldr.Number.Symbol{
decimal: ".",
exponential: "E",
group: ",",
@@ -403,8 +403,8 @@ number_symbols_for(locale \\ Bonfire.Common
plus_sign: "+",
superscripting_exponent: "×",
time_separator: ":"
- }
- }}
+ }
+ }}
diff --git a/Bonfire.Common.Localise.Cldr.Number.System.html b/Bonfire.Common.Localise.Cldr.Number.System.html
index 195b5fe146..6e2d8e4e13 100644
--- a/Bonfire.Common.Localise.Cldr.Number.System.html
+++ b/Bonfire.Common.Localise.Cldr.Number.System.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.System — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.System — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.System
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -313,23 +313,23 @@ number_system_for(locale, system_name)
Examples
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_for "th", :latn
-{:ok, %{digits: "0123456789", type: :numeric}}
+{:ok, %{digits: "0123456789", type: :numeric}}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_for "en", :default
-{:ok, %{digits: "0123456789", type: :numeric}}
+{:ok, %{digits: "0123456789", type: :numeric}}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_for "he", :traditional
-{:ok, %{rules: "hebrew", type: :algorithmic}}
+{:ok, %{rules: "hebrew", type: :algorithmic}}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_for "en", :native
-{:ok, %{digits: "0123456789", type: :numeric}}
+{:ok, %{digits: "0123456789", type: :numeric}}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_for "en", :finance
-{
+{
:error,
- {Cldr.UnknownNumberSystemError,
- "The number system :finance is unknown for the locale named :en. Valid number systems are %{default: :latn, native: :latn}"}
-}
+
{Cldr.UnknownNumberSystemError,
+ "The number system :finance is unknown for the locale named :en. Valid number systems are %{default: :latn, native: :latn}"}
+}
@@ -420,10 +420,10 @@ number_system_names_for(locale)
Examples
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_names_for "en"
-{:ok, [:latn]}
+{:ok, [:latn]}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_system_names_for "zz"
-{:error, {Cldr.InvalidLanguageError, "The language \"zz\" is invalid"}}
+
{:error, {Cldr.InvalidLanguageError, "The language \"zz\" is invalid"}}
@@ -505,13 +505,13 @@ number_systems_for(locale)
Examples
iex> Bonfire.Common.Localise.Cldr.Number.System.number_systems_for "en"
-{:ok, %{default: :latn, native: :latn}}
+{:ok, %{default: :latn, native: :latn}}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_systems_for "th"
-{:ok, %{default: :latn, native: :thai}}
+{:ok, %{default: :latn, native: :thai}}
iex> Bonfire.Common.Localise.Cldr.Number.System.number_systems_for "zz"
-{:error, {Cldr.InvalidLanguageError, "The language \"zz\" is invalid"}}
+
{:error, {Cldr.InvalidLanguageError, "The language \"zz\" is invalid"}}
@@ -610,20 +610,20 @@ system_name_from(system_name, locale)
Examples
-ex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from(:default, "en")
-{:ok, :latn}
+ex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from(:default, "en")
+{:ok, :latn}
-iex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from("latn", "en")
-{:ok, :latn}
+iex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from("latn", "en")
+{:ok, :latn}
-iex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from(:native, "en")
-{:ok, :latn}
+iex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from(:native, "en")
+{:ok, :latn}
-iex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from(:nope, "en")
-{
+iex> Bonfire.Common.Localise.Cldr.Number.System.system_name_from(:nope, "en")
+{
:error,
- {Cldr.UnknownNumberSystemError, "The number system :nope is unknown"}
-}
Note that return value is not guaranteed to be a valid
+
{Cldr.UnknownNumberSystemError, "The number system :nope is unknown"}
+}
Note that return value is not guaranteed to be a valid
number system for the given locale as demonstrated in the third example.
@@ -670,16 +670,16 @@ to_system(number, system)
Examples
iex> Bonfire.Common.Localise.Cldr.Number.System.to_system 123456, :hebr
-{:ok, "קכ״ג׳תנ״ו"}
+{:ok, "קכ״ג׳תנ״ו"}
iex> Bonfire.Common.Localise.Cldr.Number.System.to_system 123, :hans
-{:ok, "一百二十三"}
+{:ok, "一百二十三"}
iex> Bonfire.Common.Localise.Cldr.Number.System.to_system 123, :hant
-{:ok, "一百二十三"}
+{:ok, "一百二十三"}
iex> Bonfire.Common.Localise.Cldr.Number.System.to_system 123, :hansfin
-{:ok, "壹佰贰拾叁"}
+{:ok, "壹佰贰拾叁"}
diff --git a/Bonfire.Common.Localise.Cldr.Number.Transliterate.html b/Bonfire.Common.Localise.Cldr.Number.Transliterate.html
index 68b10bd1bf..180e130f57 100644
--- a/Bonfire.Common.Localise.Cldr.Number.Transliterate.html
+++ b/Bonfire.Common.Localise.Cldr.Number.Transliterate.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number.Transliterate — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number.Transliterate — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number.Transliterate
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -157,12 +157,12 @@
transliteration map is slow, pairs of transliterations can be configured so that the
transliteration map is created at compile time and therefore speeding up transliteration at
run time.
To configure these transliteration pairs, add the to the use Cldr configuration
-in a backend module:
defmodule MyApp.Cldr do
+in a backend module:defmodule MyApp.Cldr do
use Cldr,
- locale: ["en", "fr", "th"],
+ locale: ["en", "fr", "th"],
default_locale: "en",
- precompile_transliterations: [{:latn, :thai}, {:arab, :thai}]
-end
Where each tuple in the list configures one transliteration map. In this example, two maps are
+
precompile_transliterations: [{:latn, :thai}, {:arab, :thai}]
+end
Where each tuple in the list configures one transliteration map. In this example, two maps are
configured: from :latn to :thai and from :arab to :thai.
A list of configurable number systems is returned by Cldr.Number.System.numeric_systems/0.
If a transliteration is requested between two number pairs that have not been configured for
precompilation, a warning is logged.
@@ -277,22 +277,22 @@ transliterate(sequence, locale \\ Bonfire.C
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556")
+iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556")
"123556"
-iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123,556.000", "fr", :default)
+iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123,556.000", "fr", :default)
"123 556,000"
-iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556", "th", :default)
+iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556", "th", :default)
"123556"
-iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556", "th", "thai")
+iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556", "th", "thai")
"๑๒๓๕๕๖"
-iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556", "th", :native)
+iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("123556", "th", :native)
"๑๒๓๕๕๖"
-iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("Some number is: 123556", "th", "thai")
+iex> Bonfire.Common.Localise.Cldr.Number.Transliterate.transliterate("Some number is: 123556", "th", "thai")
"Some number is: ๑๒๓๕๕๖"
diff --git a/Bonfire.Common.Localise.Cldr.Number.html b/Bonfire.Common.Localise.Cldr.Number.html
index 6254263c6a..83f359ecba 100644
--- a/Bonfire.Common.Localise.Cldr.Number.html
+++ b/Bonfire.Common.Localise.Cldr.Number.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Number — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Number — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Number
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -437,19 +437,19 @@ parse(string, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.parse("＋1.000,34", locale: "de")
-{:ok, 1000.34}
+iex> Bonfire.Common.Localise.Cldr.Number.parse("＋1.000,34", locale: "de")
+{:ok, 1000.34}
-iex> Bonfire.Common.Localise.Cldr.Number.parse("-1_000_000.34")
-{:ok, -1000000.34}
+iex> Bonfire.Common.Localise.Cldr.Number.parse("-1_000_000.34")
+{:ok, -1000000.34}
-iex> Bonfire.Common.Localise.Cldr.Number.parse("1.000", locale: "de", number: :integer)
-{:ok, 1000}
+iex> Bonfire.Common.Localise.Cldr.Number.parse("1.000", locale: "de", number: :integer)
+{:ok, 1000}
-iex> Bonfire.Common.Localise.Cldr.Number.parse("＋1.000,34", locale: "de", number: :integer)
-{:error,
- {Cldr.Number.ParseError,
- "The string \"＋1.000,34\" could not be parsed as a number"}}
+iex> Bonfire.Common.Localise.Cldr.Number.parse("＋1.000,34", locale: "de", number: :integer)
+{:error,
+ {Cldr.Number.ParseError,
+ "The string \"＋1.000,34\" could not be parsed as a number"}}
@@ -521,17 +521,17 @@ resolve_currencies(list, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.scan("100 US dollars")
+iex> Bonfire.Common.Localise.Cldr.Number.scan("100 US dollars")
...> |> Bonfire.Common.Localise.Cldr.Number.resolve_currencies
-[100, :USD]
+[100, :USD]
-iex> Bonfire.Common.Localise.Cldr.Number.scan("100 eurosports")
-...> |> Bonfire.Common.Localise.Cldr.Number.resolve_currencies(fuzzy: 0.75)
-[100, :EUR]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("100 eurosports")
+...> |> Bonfire.Common.Localise.Cldr.Number.resolve_currencies(fuzzy: 0.75)
+[100, :EUR]
-iex> Bonfire.Common.Localise.Cldr.Number.scan("100 dollars des États-Unis")
-...> |> Bonfire.Common.Localise.Cldr.Number.resolve_currencies(locale: "fr")
-[100, :USD]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("100 dollars des États-Unis")
+...> |> Bonfire.Common.Localise.Cldr.Number.resolve_currencies(locale: "fr")
+[100, :USD]
@@ -608,19 +608,19 @@ resolve_currency(string, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("US dollars")
-[:USD]
+iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("US dollars")
+[:USD]
-iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("100 eurosports", fuzzy: 0.75)
-[:EUR]
+iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("100 eurosports", fuzzy: 0.75)
+[:EUR]
-iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("dollars des États-Unis", locale: "fr")
-[:USD]
+iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("dollars des États-Unis", locale: "fr")
+[:USD]
-iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("not a known currency", locale: "fr")
-{:error,
- {Cldr.UnknownCurrencyError,
- "The currency \"not a known currency\" is unknown or not supported"}}
+iex> Bonfire.Common.Localise.Cldr.Number.resolve_currency("not a known currency", locale: "fr")
+{:error,
+ {Cldr.UnknownCurrencyError,
+ "The currency \"not a known currency\" is unknown or not supported"}}
@@ -684,13 +684,13 @@ resolve_per(string, options \\ [])
Examples
iex> Bonfire.Common.Localise.Cldr.Number.resolve_per "11%"
-["11", :percent]
+["11", :percent]
iex> Bonfire.Common.Localise.Cldr.Number.resolve_per "% of linguists"
-[:percent, " of linguists"]
+[:percent, " of linguists"]
iex> Bonfire.Common.Localise.Cldr.Number.resolve_per "% of linguists %"
-[:percent, " of linguists ", :percent]
+ [:percent, " of linguists ", :percent]
@@ -747,9 +747,9 @@ resolve_pers(list, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.scan("100%")
-...> |> Bonfire.Common.Localise.Cldr.Number.resolve_pers()
-[100, :percent]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("100%")
+...> |> Bonfire.Common.Localise.Cldr.Number.resolve_pers()
+[100, :percent]
@@ -809,20 +809,20 @@ scan(string, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Number.scan("£1_000_000.34")
-["£", 1000000.34]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("£1_000_000.34")
+["£", 1000000.34]
-iex> Bonfire.Common.Localise.Cldr.Number.scan("I want £1_000_000 dollars")
-["I want £", 1000000, " dollars"]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("I want £1_000_000 dollars")
+["I want £", 1000000, " dollars"]
-iex> Bonfire.Common.Localise.Cldr.Number.scan("The prize is 23")
-["The prize is ", 23]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("The prize is 23")
+["The prize is ", 23]
-iex> Bonfire.Common.Localise.Cldr.Number.scan("The lottery number is 23 for the next draw")
-["The lottery number is ", 23, " for the next draw"]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("The lottery number is 23 for the next draw")
+["The lottery number is ", 23, " for the next draw"]
-iex> Bonfire.Common.Localise.Cldr.Number.scan("The loss is -1.000 euros", locale: "de", number: :integer)
-["The loss is ", -1000, " euros"]
+iex> Bonfire.Common.Localise.Cldr.Number.scan("The loss is -1.000 euros", locale: "de", number: :integer)
+["The loss is ", -1000, " euros"]
@@ -869,7 +869,7 @@ to_approx_string(number, options \\ [])
Example
iex> Bonfire.Common.Localise.Cldr.Number.to_approx_string 1234
-{:ok, "~1,234"}
+
{:ok, "~1,234"}
@@ -916,7 +916,7 @@ to_at_least_string(number, options \\ [])Example
iex> Bonfire.Common.Localise.Cldr.Number.to_at_least_string 1234
-{:ok, "1,234+"}
+
{:ok, "1,234+"}
@@ -963,7 +963,7 @@ to_at_most_string(number, options \\ [])Example
iex> Bonfire.Common.Localise.Cldr.Number.to_at_most_string 1234
-{:ok, "≤1,234"}
+
{:ok, "≤1,234"}
@@ -1010,7 +1010,7 @@ to_range_string(range, options \\ [])
Example
iex> Bonfire.Common.Localise.Cldr.Number.to_range_string 1234..5678
-{:ok, "1,234–5,678"}
+ {:ok, "1,234–5,678"}
@@ -1129,21 +1129,21 @@ to_string(number, options \\ default_option
Wrapping elements is particularly useful when formatting a number with a
currency symbol and the requirement is to have different HTML formatting
-applied to the symbol than the number. For example:
iex> Cldr.Number.to_string(100, format: :currency, currency: :USD, wrapper: fn
+applied to the symbol than the number. For example:iex> Cldr.Number.to_string(100, format: :currency, currency: :USD, wrapper: fn
...> string, :currency_symbol -> "<span class=\"symbol\">" <> string <> "</span>"
...> string, :number -> "<span class=\"number\">" <> string <> "</span>"
...> string, :currency_space -> "<span>" <> string <> "</span>"
...> string, _other -> string
-...> end)
-{:ok, "<span class=\"symbol\">$</span><span class=\"number\">100.00</span>"}
It is also possible and recommended to use the Phoenix.HTML.Tag.content_tag/3
+
...> end)
+{:ok, "<span class=\"symbol\">$</span><span class=\"number\">100.00</span>"}
It is also possible and recommended to use the Phoenix.HTML.Tag.content_tag/3
function if wrapping HTML tags since these will ensure HTML entities are
-correctly encoded. For example:
iex> Cldr.Number.to_string(100, format: :currency, currency: :USD, wrapper: fn
-...> string, :currency_symbol -> Phoenix.HTML.Tag.content_tag(:span, string, class: "symbol")
-...> string, :number -> Phoenix.HTML.Tag.content_tag(:span, string, class: "number")
-...> string, :currency_space -> Phoenix.HTML.Tag.content_tag(:span, string)
+correctly encoded. For example:iex> Cldr.Number.to_string(100, format: :currency, currency: :USD, wrapper: fn
+...> string, :currency_symbol -> Phoenix.HTML.Tag.content_tag(:span, string, class: "symbol")
+...> string, :number -> Phoenix.HTML.Tag.content_tag(:span, string, class: "number")
+...> string, :currency_space -> Phoenix.HTML.Tag.content_tag(:span, string)
...> string, _other -> string
-...> end)
-{:ok, "<span class=\"symbol\">$</span><span class=\"number\">100.00</span>"}
When formatting a number the format is parsed into format elements that might include
+
...> end)
+{:ok, "<span class=\"symbol\">$</span><span class=\"number\">100.00</span>"}
When formatting a number the format is parsed into format elements that might include
a currency symbol, a literal string, inserted text between a currency symbol and the
currency amount, a percent sign, the number itself and several other elements. In
some cases it is helpful to be apply specific formatting to each element.
@@ -1164,80 +1164,80 @@
to_string(number, options \\ default_option
Examples
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345
-{:ok, "12,345"}
+{:ok, "12,345"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345, locale: "fr"
-{:ok, "12 345"}
+{:ok, "12 345"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1345.32, currency: :EUR, locale: "es", minimum_grouping_digits: 1
-{:ok, "1.345,32 €"}
+{:ok, "1.345,32 €"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1345.32, currency: :EUR, locale: "es"
-{:ok, "1345,32 €"}
+{:ok, "1345,32 €"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345, locale: "fr", currency: "USD"
-{:ok, "12 345,00 $US"}
+{:ok, "12 345,00 $US"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345, format: "#E0"
-{:ok, "1.2345E4"}
+{:ok, "1.2345E4"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345, format: :accounting, currency: "THB"
-{:ok, "THB 12,345.00"}
+{:ok, "THB 12,345.00"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string -12345, format: :accounting, currency: "THB"
-{:ok, "(THB 12,345.00)"}
+{:ok, "(THB 12,345.00)"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345, format: :accounting, currency: "THB",
...> locale: "th"
-{:ok, "฿12,345.00"}
+{:ok, "฿12,345.00"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 12345, format: :accounting, currency: "THB",
...> locale: "th", number_system: :native
-{:ok, "฿๑๒,๓๔๕.๐๐"}
+{:ok, "฿๑๒,๓๔๕.๐๐"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1244.30, format: :long
-{:ok, "1 thousand"}
+{:ok, "1 thousand"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1244.30, format: :long, currency: "USD"
-{:ok, "1,244 US dollars"}
+{:ok, "1,244 US dollars"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1244.30, format: :short
-{:ok, "1K"}
+{:ok, "1K"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1244.30, format: :short, currency: "EUR"
-{:ok, "€1K"}
+{:ok, "€1K"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1234, format: :spellout
-{:ok, "one thousand two hundred thirty-four"}
+{:ok, "one thousand two hundred thirty-four"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1234, format: :spellout_verbose
-{:ok, "one thousand two hundred and thirty-four"}
+{:ok, "one thousand two hundred and thirty-four"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 1989, format: :spellout_year
-{:ok, "nineteen eighty-nine"}
+{:ok, "nineteen eighty-nine"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 123, format: :ordinal
-{:ok, "123rd"}
+{:ok, "123rd"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 123, format: :roman
-{:ok, "CXXIII"}
+{:ok, "CXXIII"}
iex> Bonfire.Common.Localise.Cldr.Number.to_string 123, locale: "th-u-nu-thai"
-{:ok, "๑๒๓"}
+
{:ok, "๑๒๓"}
Errors
An error tuple {:error, reason} will be returned if an error is detected.
-The two most likely causes of an error return are:
- A format cannot be compiled. In this case the error tuple will look like:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(12345, format: "0#")
- {:error, {Cldr.FormatCompileError,
- "Decimal format compiler: syntax error before: \"#\""}}
- The format style requested is not defined for the
locale and
+The two most likely causes of an error return are:- A format cannot be compiled. In this case the error tuple will look like:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(12345, format: "0#")
+ {:error, {Cldr.FormatCompileError,
+ "Decimal format compiler: syntax error before: \"#\""}}
- The format style requested is not defined for the
locale and
number_system. This happens typically when the number system is
:algorithmic rather than the more common :numeric. In this case the error
-return looks like:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(1234, locale: "he", number_system: "hebr", format: :percent)
- {:error, {Cldr.UnknownFormatError,
- "The locale :he with number system :hebr does not define a format :percent"}}
+return looks like:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(1234, locale: "he", number_system: "hebr", format: :percent)
+ {:error, {Cldr.UnknownFormatError,
+ "The locale :he with number system :hebr does not define a format :percent"}}
@@ -1342,17 +1342,17 @@ validate_number_system(locale, number_syste
Examples
iex> Bonfire.Common.Localise.Cldr.Number.validate_number_system "en", :latn
-{:ok, :latn}
+{:ok, :latn}
iex> Bonfire.Common.Localise.Cldr.Number.validate_number_system "en", :default
-{:ok, :latn}
+{:ok, :latn}
iex> Bonfire.Common.Localise.Cldr.Number.validate_number_system "en", :unknown
-{:error,
- {Cldr.UnknownNumberSystemError, "The number system :unknown is unknown"}}
+{:error,
+ {Cldr.UnknownNumberSystemError, "The number system :unknown is unknown"}}
iex> Bonfire.Common.Localise.Cldr.Number.validate_number_system "zz", :default
-{:error, {Cldr.InvalidLanguageError, "The language \"zz\" is invalid"}}
+
{:error, {Cldr.InvalidLanguageError, "The language \"zz\" is invalid"}}
diff --git a/Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.html b/Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.html
index a0f05eab3f..8e5a8eef06 100644
--- a/Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.html
+++ b/Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -140,9 +140,9 @@
Functions to implement the number system rule-based-number-format rules of CLDR.
These rules are defined only on the "und" locale and represent specialised
number formatting.
The standard public API for RBNF is via the Cldr.Number.to_string/2 function.
The functions on this module are defined at compile time based upon the RBNF rules
-defined in the Unicode CLDR data repository. Available rules are identified by:
iex> Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.rule_sets(:und)
-...> |> Enum.sort()
-[
+defined in the Unicode CLDR data repository. Available rules are identified by:iex> Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.rule_sets(:und)
+...> |> Enum.sort()
+[
:armenian_lower,
:armenian_upper,
:cyrillic_lower,
@@ -156,9 +156,9 @@
:roman_upper,
:tamil,
:zz_default
-]
A rule can then be invoked on an available rule_set. For example
iex> Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.roman_upper(123, :und)
-"CXXIII"
This particular call is equivalent to the call through the public API of:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(123, format: :roman)
-{:ok, "CXXIII"}
+]
A rule can then be invoked on an available rule_set. For example
iex> Bonfire.Common.Localise.Cldr.Rbnf.NumberSystem.roman_upper(123, :und)
+"CXXIII"
This particular call is equivalent to the call through the public API of:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(123, format: :roman)
+{:ok, "CXXIII"}
diff --git a/Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.html b/Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.html
index 3088031c1b..e447102396 100644
--- a/Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.html
+++ b/Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Rbnf.Ordinal — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Rbnf.Ordinal — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Rbnf.Ordinal
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -140,20 +140,20 @@
Functions to implement the ordinal rule-based-number-format rules of CLDR.
As CLDR notes, the data is incomplete or non-existent for many languages. It
is considered complete for English however.
The standard public API for RBNF is via the Cldr.Number.to_string/2 function.
The functions on this module are defined at compile time based upon the RBNF rules
-defined in the Unicode CLDR data repository. Available rules are identified by:
iex> Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.rule_sets(:en)
-[:digits_ordinal]
+defined in the Unicode CLDR data repository. Available rules are identified by:iex> Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.rule_sets(:en)
+[:digits_ordinal]
-iex> Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.rule_sets("fr")
-...> |> Enum.sort()
-[
+iex> Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.rule_sets("fr")
+...> |> Enum.sort()
+[
:digits_ordinal,
:digits_ordinal_feminine,
:digits_ordinal_feminine_plural,
:digits_ordinal_masculine,
:digits_ordinal_masculine_plural
-]
A rule can then be invoked on an available rule_set. For example
iex> Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.digits_ordinal(123, :en)
-"123rd"
This call is equivalent to the call through the public API of:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(123, format: :ordinal)
-{:ok, "123rd"}
+]
A rule can then be invoked on an available rule_set. For example
iex> Bonfire.Common.Localise.Cldr.Rbnf.Ordinal.digits_ordinal(123, :en)
+"123rd"
This call is equivalent to the call through the public API of:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(123, format: :ordinal)
+{:ok, "123rd"}
diff --git a/Bonfire.Common.Localise.Cldr.Rbnf.Spellout.html b/Bonfire.Common.Localise.Cldr.Rbnf.Spellout.html
index ee52b295d5..bd8c9c7e96 100644
--- a/Bonfire.Common.Localise.Cldr.Rbnf.Spellout.html
+++ b/Bonfire.Common.Localise.Cldr.Rbnf.Spellout.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Rbnf.Spellout — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Rbnf.Spellout — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Rbnf.Spellout
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -140,9 +140,9 @@
Functions to implement the spellout rule-based-number-format rules of CLDR.
As CLDR notes, the data is incomplete or non-existent for many languages. It
is considered complete for English however.
The standard public API for RBNF is via the Cldr.Number.to_string/2 function.
The functions on this module are defined at compile time based upon the RBNF rules
-defined in the Unicode CLDR data repository. Available rules are identified by:
iex> Bonfire.Common.Localise.Cldr.Rbnf.Spellout.rule_sets("en")
-...> |> Enum.sort()
-[
+defined in the Unicode CLDR data repository. Available rules are identified by:iex> Bonfire.Common.Localise.Cldr.Rbnf.Spellout.rule_sets("en")
+...> |> Enum.sort()
+[
:spellout_cardinal,
:spellout_cardinal_verbose,
:spellout_numbering,
@@ -150,9 +150,9 @@
:spellout_numbering_year,
:spellout_ordinal,
:spellout_ordinal_verbose
-]
A rule can then be invoked on an available rule_set. For example:
iex> Bonfire.Common.Localise.Cldr.Rbnf.Spellout.spellout_ordinal(123, "en")
-"one hundred twenty-third"
This call is equivalent to the call through the public API of:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(123, format: :spellout)
-{:ok, "one hundred twenty-three"}
+]
A rule can then be invoked on an available rule_set. For example:
iex> Bonfire.Common.Localise.Cldr.Rbnf.Spellout.spellout_ordinal(123, "en")
+"one hundred twenty-third"
This call is equivalent to the call through the public API of:
iex> Bonfire.Common.Localise.Cldr.Number.to_string(123, format: :spellout)
+{:ok, "one hundred twenty-three"}
diff --git a/Bonfire.Common.Localise.Cldr.Territory.html b/Bonfire.Common.Localise.Cldr.Territory.html
index ec695c3451..985b40c915 100644
--- a/Bonfire.Common.Localise.Cldr.Territory.html
+++ b/Bonfire.Common.Localise.Cldr.Territory.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Territory — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Territory — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Territory
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -557,8 +557,8 @@ available_styles()
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.available_styles()
-[:short, :standard, :variant]
+iex> Bonfire.Common.Localise.Cldr.Territory.available_styles()
+[:short, :standard, :variant]
@@ -598,14 +598,14 @@ available_subdivisions(locale \\ Cldr.get_l
Example
-=> Bonfire.Common.Localise.Cldr.Territory.available_subdivisions("en")
-[:ad02, :ad03, :ad04, :ad05, :ad06, :ad07, :ad08, ...]
+=> Bonfire.Common.Localise.Cldr.Territory.available_subdivisions("en")
+[:ad02, :ad03, :ad04, :ad05, :ad06, :ad07, :ad08, ...]
-iex> Bonfire.Common.Localise.Cldr.Territory.available_subdivisions()
-[]
+iex> Bonfire.Common.Localise.Cldr.Territory.available_subdivisions()
+[]
-iex> Bonfire.Common.Localise.Cldr.Territory.available_subdivisions("zzz")
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.available_subdivisions("zzz")
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -645,15 +645,15 @@ available_territories(locale \\ Cldr.get_lo
Example
-=> Bonfire.Common.Localise.Cldr.Territory.available_territories()
-[:"001", :"002", :"003", :"005", :"009", :"011", :"013", :"014", :"015", :"017",
+=> Bonfire.Common.Localise.Cldr.Territory.available_territories()
+[:"001", :"002", :"003", :"005", :"009", :"011", :"013", :"014", :"015", :"017",
:"018", :"019", :"021", :"029", :"030", :"034", :"035", :"039", :"053", :"054",
:"057", :"061", :"142", :"143", :"145", :"150", :"151", :"154", :"155", :"202",
:"419", :AC, :AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :AQ, :AR, :AS, :AT, :AU,
-:AW, :AX, :AZ, :BA, :BB, ...]
+:AW, :AX, :AZ, :BA, :BB, ...]
-iex> Bonfire.Common.Localise.Cldr.Territory.available_territories("zzz")
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.available_territories("zzz")
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -693,16 +693,16 @@ children(territory_code, options \\ [as: :a
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.children(:EU)
-{:ok,
-[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GR, :HR, :HU, :IE,
- :IT, :LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]}
+iex> Bonfire.Common.Localise.Cldr.Territory.children(:EU)
+{:ok,
+[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GR, :HR, :HU, :IE,
+ :IT, :LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]}
-iex> Bonfire.Common.Localise.Cldr.Territory.children(:ZZZ)
-{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.children(:ZZZ)
+{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.children(:GB)
-{:error, {Cldr.UnknownParentError, "The territory :GB has no children"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.children(:GB)
+{:error, {Cldr.UnknownParentError, "The territory :GB has no children"}}
@@ -742,9 +742,9 @@ children!(territory_code, options \\ [as: :
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.children!(:EU)
-[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GR, :HR, :HU, :IE, :IT,
-:LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]
+iex> Bonfire.Common.Localise.Cldr.Territory.children!(:EU)
+[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GR, :HR, :HU, :IE, :IT,
+:LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]
@@ -782,10 +782,10 @@ contains?(parent, child)
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.contains?(:EU, :DK)
+iex> Bonfire.Common.Localise.Cldr.Territory.contains?(:EU, :DK)
true
-iex> Bonfire.Common.Localise.Cldr.Territory.contains?(:DK, :EU)
+iex> Bonfire.Common.Localise.Cldr.Territory.contains?(:DK, :EU)
false
@@ -824,11 +824,11 @@ country_codes(options \\ [as: :atom])
Example
-=> Bonfire.Common.Localise.Cldr.Territory.country_codes()
-[:AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :AR, :AS, :AT, :AU, :AW,
+=> Bonfire.Common.Localise.Cldr.Territory.country_codes()
+[:AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :AR, :AS, :AT, :AU, :AW,
:AX, :AZ, :BA, :BB, :BD, :BE, :BF, :BG, :BH, :BI, :BJ, :BL, :BM,
:BN, :BO, :BQ, :BR, :BS, :BT, :BV, :BW, :BY, :BZ, :CA, :CC, :CD,
-:CF, :CG, :CH, :CI, :CK, :CL, :CM, :CN, :CO, :CR, :CU, ...]
+:CF, :CG, :CH, :CI, :CK, :CL, :CM, :CN, :CO, :CR, :CU, ...]
@@ -870,17 +870,17 @@ from_language_tag(language_tag, options \\
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale())
-{:ok, "world"}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale())
+{:ok, "world"}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: :short])
-{:error, {Cldr.UnknownStyleError, "The style :short is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: :short])
+{:error, {Cldr.UnknownStyleError, "The style :short is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: :ZZZ])
-{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: :ZZZ])
+{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: "ZZZ"])
-{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: "ZZZ"])
+{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
@@ -918,7 +918,7 @@ from_language_tag!(language_tag, options \\
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag!(Cldr.get_locale())
+iex> Bonfire.Common.Localise.Cldr.Territory.from_language_tag!(Cldr.get_locale())
"world"
@@ -962,23 +962,23 @@ from_subdivision_code(subdivision_code, opt
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", locale: "en")
-{:ok, "Cumbria"}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", locale: "en")
+{:ok, "Cumbria"}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", locale: "pl")
-{:ok, "Kumbria"}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", locale: "pl")
+{:ok, "Kumbria"}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", locale: "bs")
-{:error, {Cldr.UnknownSubdivisionError, "No subdivision translation for :gbcma could be found in locale :bs"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", locale: "bs")
+{:error, {Cldr.UnknownSubdivisionError, "No subdivision translation for :gbcma could be found in locale :bs"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("invalid", locale: "en")
-{:error, {Cldr.UnknownTerritoryError, "The territory \"invalid\" is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("invalid", locale: "en")
+{:error, {Cldr.UnknownTerritoryError, "The territory \"invalid\" is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", [locale: :zzz])
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", [locale: :zzz])
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", [locale: "zzz"])
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code("gbcma", [locale: "zzz"])
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -1017,10 +1017,10 @@ from_subdivision_code!(subdivision_code, op
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code!("gbcma", locale: "en")
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code!("gbcma", locale: "en")
"Cumbria"
-iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code!("gbcma", locale: "pl")
+iex> Bonfire.Common.Localise.Cldr.Territory.from_subdivision_code!("gbcma", locale: "pl")
"Kumbria"
@@ -1064,26 +1064,26 @@ from_territory_code(territory_code, options
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB)
-{:ok, "United Kingdom"}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB)
+{:ok, "United Kingdom"}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [style: :short])
-{:ok, "UK"}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [style: :short])
+{:ok, "UK"}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [style: :ZZZ])
-{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [style: :ZZZ])
+{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [style: "ZZZ"])
-{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [style: "ZZZ"])
+{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [locale: "pt"])
-{:ok, "Reino Unido"}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [locale: "pt"])
+{:ok, "Reino Unido"}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [locale: :zzz])
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [locale: :zzz])
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [locale: "zzz"])
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code(:GB, [locale: "zzz"])
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -1122,13 +1122,13 @@ from_territory_code!(territory_code, option
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code!(:GB)
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code!(:GB)
"United Kingdom"
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code!(:GB, [style: :short])
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code!(:GB, [style: :short])
"UK"
-iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code!(:GB, [locale: "pt"])
+iex> Bonfire.Common.Localise.Cldr.Territory.from_territory_code!(:GB, [locale: "pt"])
"Reino Unido"
@@ -1167,48 +1167,48 @@ info(territory_code)
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.info(:GB)
-{:ok,
- %{
- currency: [GBP: %{from: ~D[1694-07-27]}],
+iex> Bonfire.Common.Localise.Cldr.Territory.info(:GB)
+{:ok,
+ %{
+ currency: [GBP: %{from: ~D[1694-07-27]}],
gdp: 2925000000000,
- language_population: %{
- "ar" => %{population_percent: 0.3},
- "bn" => %{population_percent: 0.4},
- "cy" => %{official_status: "official_regional", population_percent: 1.3},
- "de" => %{population_percent: 9},
- "en" => %{official_status: "official", population_percent: 98},
- "es" => %{population_percent: 8},
- "fr" => %{population_percent: 23},
- "ga" => %{official_status: "official_regional", population_percent: 0.15},
- "gd" => %{
+ language_population: %{
+ "ar" => %{population_percent: 0.3},
+ "bn" => %{population_percent: 0.4},
+ "cy" => %{official_status: "official_regional", population_percent: 1.3},
+ "de" => %{population_percent: 9},
+ "en" => %{official_status: "official", population_percent: 98},
+ "es" => %{population_percent: 8},
+ "fr" => %{population_percent: 23},
+ "ga" => %{official_status: "official_regional", population_percent: 0.15},
+ "gd" => %{
official_status: "official_regional",
population_percent: 0.11,
writing_percent: 5
- },
- "gu" => %{population_percent: 2.9},
- "it" => %{population_percent: 0.2},
- "kw" => %{population_percent: 0.003},
- "lt" => %{population_percent: 0.2},
- "pa" => %{population_percent: 3.6},
- "pl" => %{population_percent: 4},
- "pt" => %{population_percent: 0.2},
- "sco" => %{population_percent: 2.5, writing_percent: 5},
- "so" => %{population_percent: 0.2},
- "ta" => %{population_percent: 3.2},
- "tr" => %{population_percent: 0.2},
- "ur" => %{population_percent: 3.5},
- "zh-Hant" => %{population_percent: 0.3},
- "en-Shaw" => %{population_percent: 0}
- },
+ },
+ "gu" => %{population_percent: 2.9},
+ "it" => %{population_percent: 0.2},
+ "kw" => %{population_percent: 0.003},
+ "lt" => %{population_percent: 0.2},
+ "pa" => %{population_percent: 3.6},
+ "pl" => %{population_percent: 4},
+ "pt" => %{population_percent: 0.2},
+ "sco" => %{population_percent: 2.5, writing_percent: 5},
+ "so" => %{population_percent: 0.2},
+ "ta" => %{population_percent: 3.2},
+ "tr" => %{population_percent: 0.2},
+ "ur" => %{population_percent: 3.5},
+ "zh-Hant" => %{population_percent: 0.3},
+ "en-Shaw" => %{population_percent: 0}
+ },
literacy_percent: 99,
- measurement_system: %{
+ measurement_system: %{
default: :uksystem,
paper_size: :a4,
temperature: :uksystem
- },
+ },
population: 65761100
- }}
+ }}
@@ -1244,47 +1244,47 @@ info!(territory_code)
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.info!(:GB)
-%{
- currency: [GBP: %{from: ~D[1694-07-27]}],
+iex> Bonfire.Common.Localise.Cldr.Territory.info!(:GB)
+%{
+ currency: [GBP: %{from: ~D[1694-07-27]}],
gdp: 2925000000000,
- language_population: %{
- "ar" => %{population_percent: 0.3},
- "bn" => %{population_percent: 0.4},
- "cy" => %{official_status: "official_regional", population_percent: 1.3},
- "de" => %{population_percent: 9},
- "en" => %{official_status: "official", population_percent: 98},
- "es" => %{population_percent: 8},
- "fr" => %{population_percent: 23},
- "ga" => %{official_status: "official_regional", population_percent: 0.15},
- "gd" => %{
+ language_population: %{
+ "ar" => %{population_percent: 0.3},
+ "bn" => %{population_percent: 0.4},
+ "cy" => %{official_status: "official_regional", population_percent: 1.3},
+ "de" => %{population_percent: 9},
+ "en" => %{official_status: "official", population_percent: 98},
+ "es" => %{population_percent: 8},
+ "fr" => %{population_percent: 23},
+ "ga" => %{official_status: "official_regional", population_percent: 0.15},
+ "gd" => %{
official_status: "official_regional",
population_percent: 0.11,
writing_percent: 5
- },
- "gu" => %{population_percent: 2.9},
- "it" => %{population_percent: 0.2},
- "kw" => %{population_percent: 0.003},
- "lt" => %{population_percent: 0.2},
- "pa" => %{population_percent: 3.6},
- "pl" => %{population_percent: 4},
- "pt" => %{population_percent: 0.2},
- "sco" => %{population_percent: 2.5, writing_percent: 5},
- "so" => %{population_percent: 0.2},
- "ta" => %{population_percent: 3.2},
- "tr" => %{population_percent: 0.2},
- "ur" => %{population_percent: 3.5},
- "zh-Hant" => %{population_percent: 0.3},
- "en-Shaw" => %{population_percent: 0}
- },
+ },
+ "gu" => %{population_percent: 2.9},
+ "it" => %{population_percent: 0.2},
+ "kw" => %{population_percent: 0.003},
+ "lt" => %{population_percent: 0.2},
+ "pa" => %{population_percent: 3.6},
+ "pl" => %{population_percent: 4},
+ "pt" => %{population_percent: 0.2},
+ "sco" => %{population_percent: 2.5, writing_percent: 5},
+ "so" => %{population_percent: 0.2},
+ "ta" => %{population_percent: 3.2},
+ "tr" => %{population_percent: 0.2},
+ "ur" => %{population_percent: 3.5},
+ "zh-Hant" => %{population_percent: 0.3},
+ "en-Shaw" => %{population_percent: 0}
+ },
literacy_percent: 99,
- measurement_system: %{
+ measurement_system: %{
default: :uksystem,
paper_size: :a4,
temperature: :uksystem
- },
+ },
population: 65761100
-}
+}
@@ -1368,8 +1368,8 @@ known_subdivisions(locale \\ Cldr.get_local
Example
-=> Bonfire.Common.Localise.Cldr.Territory.known_subdivisions("en")
-%{
+=> Bonfire.Common.Localise.Cldr.Territory.known_subdivisions("en")
+%{
"ad02" => "Canillo",
"ad03" => "Encamp",
"ad04" => "La Massana",
@@ -1378,11 +1378,11 @@ known_subdivisions(locale \\ Cldr.get_local
"ad07" => "Andorra la Vella",
...
-iex> Bonfire.Common.Localise.Cldr.Territory.known_subdivisions()
-%{}
+iex> Bonfire.Common.Localise.Cldr.Territory.known_subdivisions()
+%{}
-iex> Bonfire.Common.Localise.Cldr.Territory.known_subdivisions("zzz")
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.known_subdivisions("zzz")
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -1422,36 +1422,36 @@ known_territories(locale \\ Cldr.get_locale
Example
-=> Bonfire.Common.Localise.Cldr.Territory.known_territories()
-%{SN: %{standard: "Senegal"}, "061": %{standard: "Polynesia"},
-BH: %{standard: "Bahrain"}, TM: %{standard: "Turkmenistan"},
-"009": %{standard: "Oceania"}, CW: %{standard: "Curaçao"},
-FR: %{standard: "France"}, TN: %{standard: "Tunisia"},
-FI: %{standard: "Finland"}, BF: %{standard: "Burkina Faso"},
-"155": %{standard: "Western Europe"}, GL: %{standard: "Greenland"},
-VI: %{standard: "U.S. Virgin Islands"}, ZW: %{standard: "Zimbabwe"},
-AR: %{standard: "Argentina"}, SG: %{standard: "Singapore"},
-SZ: %{standard: "Swaziland"}, ID: %{standard: "Indonesia"},
-NR: %{standard: "Nauru"}, RW: %{standard: "Rwanda"},
-TR: %{standard: "Turkey"}, IS: %{standard: "Iceland"},
-ME: %{standard: "Montenegro"}, AW: %{standard: "Aruba"},
-PY: %{standard: "Paraguay"}, "145": %{standard: "Western Asia"},
-CG: %{standard: "Congo - Brazzaville", variant: "Congo (Republic)"},
-LT: %{standard: "Lithuania"}, SA: %{standard: "Saudi Arabia"},
-MZ: %{standard: "Mozambique"}, NU: %{standard: "Niue"},
-NG: %{standard: "Nigeria"}, CK: %{standard: "Cook Islands"},
-ZM: %{standard: "Zambia"}, LK: %{standard: "Sri Lanka"},
-UY: %{standard: "Uruguay"}, YE: %{standard: "Yemen"},
-"011": %{standard: "Western Africa"},
-CC: %{standard: "Cocos (Keeling) Islands"}, BY: %{standard: "Belarus"},
-IL: %{standard: "Israel"}, KY: %{standard: "Cayman Islands"},
-GN: %{standard: "Guinea"}, VN: %{standard: "Vietnam"},
-PE: %{standard: "Peru"}, HU: %{standard: "Hungary"},
-HN: %{standard: "Honduras"}, GI: %{standard: "Gibraltar"},
-"142": %{standard: "Asia"}, "029": %{...}, ...}
-
-=> Bonfire.Common.Localise.Cldr.Territory.known_territories("zzz")
-{:error, {Cldr.InvalidLanguageError, "The language "zzz" is invalid"}}
+=> Bonfire.Common.Localise.Cldr.Territory.known_territories()
+%{SN: %{standard: "Senegal"}, "061": %{standard: "Polynesia"},
+BH: %{standard: "Bahrain"}, TM: %{standard: "Turkmenistan"},
+"009": %{standard: "Oceania"}, CW: %{standard: "Curaçao"},
+FR: %{standard: "France"}, TN: %{standard: "Tunisia"},
+FI: %{standard: "Finland"}, BF: %{standard: "Burkina Faso"},
+"155": %{standard: "Western Europe"}, GL: %{standard: "Greenland"},
+VI: %{standard: "U.S. Virgin Islands"}, ZW: %{standard: "Zimbabwe"},
+AR: %{standard: "Argentina"}, SG: %{standard: "Singapore"},
+SZ: %{standard: "Swaziland"}, ID: %{standard: "Indonesia"},
+NR: %{standard: "Nauru"}, RW: %{standard: "Rwanda"},
+TR: %{standard: "Turkey"}, IS: %{standard: "Iceland"},
+ME: %{standard: "Montenegro"}, AW: %{standard: "Aruba"},
+PY: %{standard: "Paraguay"}, "145": %{standard: "Western Asia"},
+CG: %{standard: "Congo - Brazzaville", variant: "Congo (Republic)"},
+LT: %{standard: "Lithuania"}, SA: %{standard: "Saudi Arabia"},
+MZ: %{standard: "Mozambique"}, NU: %{standard: "Niue"},
+NG: %{standard: "Nigeria"}, CK: %{standard: "Cook Islands"},
+ZM: %{standard: "Zambia"}, LK: %{standard: "Sri Lanka"},
+UY: %{standard: "Uruguay"}, YE: %{standard: "Yemen"},
+"011": %{standard: "Western Africa"},
+CC: %{standard: "Cocos (Keeling) Islands"}, BY: %{standard: "Belarus"},
+IL: %{standard: "Israel"}, KY: %{standard: "Cayman Islands"},
+GN: %{standard: "Guinea"}, VN: %{standard: "Vietnam"},
+PE: %{standard: "Peru"}, HU: %{standard: "Hungary"},
+HN: %{standard: "Honduras"}, GI: %{standard: "Gibraltar"},
+"142": %{standard: "Asia"}, "029": %{...}, ...}
+
+=> Bonfire.Common.Localise.Cldr.Territory.known_territories("zzz")
+{:error, {Cldr.InvalidLanguageError, "The language "zzz" is invalid"}}
@@ -1488,20 +1488,20 @@ known_territory_subdivisions(territory_code
Example
-=> Bonfire.Common.Localise.Cldr.Territory.known_territory_subdivisions(:GB)
-{:ok, ["gbabc", "gbabd", "gbabe", "gbagb", "gbagy", "gband", "gbann",
+=> Bonfire.Common.Localise.Cldr.Territory.known_territory_subdivisions(:GB)
+{:ok, ["gbabc", "gbabd", "gbabe", "gbagb", "gbagy", "gband", "gbann",
"gbans", "gbbas", "gbbbd", "gbbdf", "gbbdg", "gbben", "gbbex", "gbbfs",
"gbbge", "gbbgw", "gbbir", "gbbkm", "gbbmh", "gbbne", "gbbnh", "gbbns",
"gbbol", "gbbpl", "gbbrc", "gbbrd", "gbbry", "gbbst", "gbbur", "gbcam",
"gbcay", "gbcbf", "gbccg", "gbcgn", "gbche", "gbchw", "gbcld", "gbclk",
"gbcma", "gbcmd", "gbcmn", "gbcon", "gbcov", "gbcrf", "gbcry", "gbcwy",
-"gbdal", "gbdby", "gbden", ...]}
+"gbdal", "gbdby", "gbden", ...]}
-=> Bonfire.Common.Localise.Cldr.Territory.known_territory_subdivisions(:AI)
-{:ok, nil}
+=> Bonfire.Common.Localise.Cldr.Territory.known_territory_subdivisions(:AI)
+{:ok, nil}
-iex> Bonfire.Common.Localise.Cldr.Territory.known_territory_subdivisions(:ZZZ)
-{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.known_territory_subdivisions(:ZZZ)
+{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
@@ -1541,14 +1541,14 @@ parent(territory_code, options \\ [as: :ato
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.parent(:GB)
-{:ok, [:"154", :UN]}
+iex> Bonfire.Common.Localise.Cldr.Territory.parent(:GB)
+{:ok, [:"154", :UN]}
-iex> Bonfire.Common.Localise.Cldr.Territory.parent(:ZZZ)
-{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.parent(:ZZZ)
+{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.parent(Cldr.get_locale())
-{:error, {Cldr.UnknownChildrenError, "The territory :\"001\" has no parent(s)"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.parent(Cldr.get_locale())
+{:error, {Cldr.UnknownChildrenError, "The territory :\"001\" has no parent(s)"}}
@@ -1588,8 +1588,8 @@ parent!(territory_code, options \\ [as: :at
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.parent!(:GB)
-[:"154", :UN]
+iex> Bonfire.Common.Localise.Cldr.Territory.parent!(:GB)
+[:"154", :UN]
@@ -1626,7 +1626,7 @@ subdivision_aliases()
Example
iex#> Bonfire.Common.Localise.Cldr.Territory.subdivision_aliases()
-%{:uspr => :PR}
+
%{:uspr => :PR}
@@ -1667,11 +1667,11 @@ to_currency_code(territory_code, options \\
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code(:US)
-{:ok, :USD}
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code(:US)
+{:ok, :USD}
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code("cu")
-{:ok, :CUP}
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code("cu")
+{:ok, :CUP}
@@ -1710,16 +1710,16 @@ to_currency_code!(territory_code, options \
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!(:US)
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!(:US)
:USD
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!(:US, as: :charlist)
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!(:US, as: :charlist)
~c"USD"
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!("PS")
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!("PS")
:ILS
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!("PS", as: :binary)
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_code!("PS", as: :binary)
"ILS"
@@ -1760,11 +1760,11 @@ to_currency_codes(territory_code, options \
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes(:US)
-{:ok, [:USD]}
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes(:US)
+{:ok, [:USD]}
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes("ht")
-{:ok, [:USD, :HTG]}
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes("ht")
+{:ok, [:USD, :HTG]}
@@ -1804,17 +1804,17 @@ to_currency_codes!(territory_code, options
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!(:US)
-[:USD]
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!(:US)
+[:USD]
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!(:US, as: :charlist)
-[~c"USD"]
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!(:US, as: :charlist)
+[~c"USD"]
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!("PS")
-[:ILS, :JOD]
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!("PS")
+[:ILS, :JOD]
-iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!("PS", as: :binary)
-["ILS", "JOD"]
+iex> Bonfire.Common.Localise.Cldr.Territory.to_currency_codes!("PS", as: :binary)
+["ILS", "JOD"]
@@ -1852,11 +1852,11 @@ to_unicode_flag(territory_code)
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.to_unicode_flag(:US)
-{:ok, "🇺🇸"}
+iex> Bonfire.Common.Localise.Cldr.Territory.to_unicode_flag(:US)
+{:ok, "🇺🇸"}
-iex> Bonfire.Common.Localise.Cldr.Territory.to_unicode_flag(:EZ)
-{:error, {Cldr.UnknownFlagError, "The territory :EZ has no flag"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.to_unicode_flag(:EZ)
+{:error, {Cldr.UnknownFlagError, "The territory :EZ has no flag"}}
@@ -1892,7 +1892,7 @@ to_unicode_flag!(territory_code)
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.to_unicode_flag!(:US)
+iex> Bonfire.Common.Localise.Cldr.Territory.to_unicode_flag!(:US)
"🇺🇸"
@@ -1936,11 +1936,11 @@ translate_language_tag(tag, options \\ [])<
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag(Cldr.get_locale())
-{:ok, "world"}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag(Cldr.get_locale())
+{:ok, "world"}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag(Cldr.get_locale(), [locale: Cldr.Locale.new!("pt", TestBackend.Cldr)])
-{:ok, "Mundo"}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag(Cldr.get_locale(), [locale: Cldr.Locale.new!("pt", TestBackend.Cldr)])
+{:ok, "Mundo"}
@@ -1978,10 +1978,10 @@ translate_language_tag!(locale_from, option
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag!(Cldr.get_locale())
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag!(Cldr.get_locale())
"world"
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag!(Cldr.get_locale(), [locale: Cldr.Locale.new!("pt", TestBackend.Cldr)])
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_language_tag!(Cldr.get_locale(), [locale: Cldr.Locale.new!("pt", TestBackend.Cldr)])
"Mundo"
@@ -2027,17 +2027,17 @@ translate_subdivision(localized_string, fro
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", "en", "pl")
-{:ok, "Kumbria"}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", "en", "pl")
+{:ok, "Kumbria"}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", "en", "bs")
-{:error, {Cldr.UnknownSubdivisionError, "No subdivision translation for :gbcma could be found in locale :bs"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", "en", "bs")
+{:error, {Cldr.UnknownSubdivisionError, "No subdivision translation for :gbcma could be found in locale :bs"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", :zzz)
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", :zzz)
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", "en", "zzz")
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision("Cumbria", "en", "zzz")
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -2080,10 +2080,10 @@ translate_subdivision!(localized_string, fr
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision!("Cumbria", "en", "pl")
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision!("Cumbria", "en", "pl")
"Kumbria"
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision!("Kumbria", "pl", "en")
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_subdivision!("Kumbria", "pl", "en")
"Cumbria"
@@ -2131,20 +2131,20 @@ translate_territory(localized_string, from_
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("Reino Unido", "pt")
-{:ok, "United Kingdom"}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("Reino Unido", "pt")
+{:ok, "United Kingdom"}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("United Kingdom", "en", "pt")
-{:ok, "Reino Unido"}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("United Kingdom", "en", "pt")
+{:ok, "Reino Unido"}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("Reino Unido", :zzz)
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("Reino Unido", :zzz)
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("United Kingdom", "en", "zzz")
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("United Kingdom", "en", "zzz")
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("Westworld", "en", "pt")
-{:error, {Cldr.UnknownTerritoryError, "No territory translation for \"Westworld\" could be found in locale :en"}}
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory("Westworld", "en", "pt")
+{:error, {Cldr.UnknownTerritoryError, "No territory translation for \"Westworld\" could be found in locale :en"}}
@@ -2189,10 +2189,10 @@ translate_territory!(localized_string, loca
Example
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory!("Reino Unido", "pt")
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory!("Reino Unido", "pt")
"United Kingdom"
-iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory!("United Kingdom", "en", "pt")
+iex> Bonfire.Common.Localise.Cldr.Territory.translate_territory!("United Kingdom", "en", "pt")
"Reino Unido"
#=> Bonfire.Common.Localise.Cldr.Territory.translate_territory!("Westworld", "en", "pt")
diff --git a/Bonfire.Common.Localise.Cldr.Time.Interval.html b/Bonfire.Common.Localise.Cldr.Time.Interval.html
index d370f8d5ac..41210ff07b 100644
--- a/Bonfire.Common.Localise.Cldr.Time.Interval.html
+++ b/Bonfire.Common.Localise.Cldr.Time.Interval.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Time.Interval — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Time.Interval — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Time.Interval
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -331,32 +331,32 @@ to_string(from, to, options \\ [])
Examples
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~T[10:00:00], ~T[10:03:00], format: :short
-{:ok, "10 – 10 AM"}
+{:ok, "10 – 10 AM"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~T[10:00:00], ~T[10:03:00], format: :medium
-{:ok, "10:00 – 10:03 AM"}
+{:ok, "10:00 – 10:03 AM"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~T[10:00:00], ~T[10:03:00], format: :long
-{:ok, "10:00 – 10:03 AM"}
+{:ok, "10:00 – 10:03 AM"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~T[10:00:00], ~T[10:03:00],
...> format: :long, style: :flex
-{:ok, "10:00 – 10:03 in the morning"}
+{:ok, "10:00 – 10:03 in the morning"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~U[2020-01-01 00:00:00.0Z], ~U[2020-01-01 10:00:00.0Z],
...> format: :long, style: :flex
-{:ok, "12:00 – 10:00 in the morning"}
+{:ok, "12:00 – 10:00 in the morning"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~U[2020-01-01 00:00:00.0Z], ~U[2020-01-01 10:00:00.0Z],
...> format: :long, style: :zone
-{:ok, "12:00 – 10:00 AM Etc/UTC"}
+{:ok, "12:00 – 10:00 AM Etc/UTC"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~T[10:00:00], ~T[10:03:00],
...> format: :long, style: :flex, locale: "th"
-{:ok, "10:00 – 10:03 ในตอนเช้า"}
+{:ok, "10:00 – 10:03 ในตอนเช้า"}
iex> Bonfire.Common.Localise.Cldr.Time.Interval.to_string ~T[10:00:00], nil
-{:ok, "10:00:00 AM –"}
+{:ok, "10:00:00 AM –"}
diff --git a/Bonfire.Common.Localise.Cldr.Time.html b/Bonfire.Common.Localise.Cldr.Time.html
index 57dc331428..489b383926 100644
--- a/Bonfire.Common.Localise.Cldr.Time.html
+++ b/Bonfire.Common.Localise.Cldr.Time.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Time — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Time — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Time
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Localise.Cldr.Unit.html b/Bonfire.Common.Localise.Cldr.Unit.html
index a99fa9bb29..010377ccbf 100644
--- a/Bonfire.Common.Localise.Cldr.Unit.html
+++ b/Bonfire.Common.Localise.Cldr.Unit.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr.Unit — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr.Unit — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr.Unit
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -1193,12 +1193,12 @@ localize(unit, options \\ [])
Examples
-iex> unit = Cldr.Unit.new!(1.83, :meter)
-iex> Bonfire.Common.Localise.Cldr.Unit.localize(unit, usage: :person_height, territory: :US)
-[
- Cldr.Unit.new!(:foot, 6, usage: :person_height),
- Cldr.Unit.new!(:inch, "0.04724409448818897637795275598", usage: :person_height)
-]
+iex> unit = Cldr.Unit.new!(1.83, :meter)
+iex> Bonfire.Common.Localise.Cldr.Unit.localize(unit, usage: :person_height, territory: :US)
+[
+ Cldr.Unit.new!(:foot, 6, usage: :person_height),
+ Cldr.Unit.new!(:inch, "0.04724409448818897637795275598", usage: :person_height)
+]
@@ -1553,16 +1553,16 @@ parse(unit_string, options \\ [])
Examples
iex> Bonfire.Common.Localise.Cldr.Unit.parse "1kg"
-Cldr.Unit.new(1, :kilogram)
+Cldr.Unit.new(1, :kilogram)
iex> Bonfire.Common.Localise.Cldr.Unit.parse "1 tages", locale: "de"
-Cldr.Unit.new(1, :day)
+Cldr.Unit.new(1, :day)
iex> Bonfire.Common.Localise.Cldr.Unit.parse "1 tag", locale: "de"
-Cldr.Unit.new(1, :day)
+Cldr.Unit.new(1, :day)
-iex> Bonfire.Common.Localise.Cldr.Unit.parse("42 millispangels")
-{:error, {Cldr.UnknownUnitError, "Unknown unit was detected at \"spangels\""}}
+
iex> Bonfire.Common.Localise.Cldr.Unit.parse("42 millispangels")
+{:error, {Cldr.UnknownUnitError, "Unknown unit was detected at \"spangels\""}}
@@ -1624,15 +1624,15 @@ parse!(unit_string, options \\ [])
Examples
iex> Bonfire.Common.Localise.Cldr.Unit.parse! "1kg"
-Cldr.Unit.new!(1, :kilogram)
+Cldr.Unit.new!(1, :kilogram)
iex> Bonfire.Common.Localise.Cldr.Unit.parse! "1 tages", locale: "de"
-Cldr.Unit.new!(1, :day)
+Cldr.Unit.new!(1, :day)
-iex> Bonfire.Common.Localise.Cldr.Unit.parse!("42 candela per lux")
-Cldr.Unit.new!(42, "candela per lux")
+iex> Bonfire.Common.Localise.Cldr.Unit.parse!("42 candela per lux")
+Cldr.Unit.new!(42, "candela per lux")
-iex> Bonfire.Common.Localise.Cldr.Unit.parse!("42 millispangels")
+iex> Bonfire.Common.Localise.Cldr.Unit.parse!("42 millispangels")
** (Cldr.UnknownUnitError) Unknown unit was detected at "spangels"
@@ -1712,25 +1712,25 @@ parse_unit_name(unit_name_string, options \
Examples
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "kg"
-{:ok, :kilogram}
+{:ok, :kilogram}
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "w"
-{:ok, :watt}
+{:ok, :watt}
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "w", only: :duration
-{:ok, :week}
+{:ok, :week}
-iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "m", only: [:year, :month, :day]
-{:ok, :month}
+iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "m", only: [:year, :month, :day]
+{:ok, :month}
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "tages", locale: "de"
-{:ok, :day}
+{:ok, :day}
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name "tag", locale: "de"
-{:ok, :day}
+{:ok, :day}
-iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name("millispangels")
-{:error, {Cldr.UnknownUnitError, "Unknown unit was detected at \"spangels\""}}
+
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name("millispangels")
+{:error, {Cldr.UnknownUnitError, "Unknown unit was detected at \"spangels\""}}
@@ -1810,7 +1810,7 @@ parse_unit_name!(unit_name_string, options
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name! "w", only: :duration
:week
-iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name! "m", only: [:year, :month, :day]
+iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name! "m", only: [:year, :month, :day]
:month
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name! "tages", locale: "de"
@@ -1819,7 +1819,7 @@ parse_unit_name!(unit_name_string, options
iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name! "tag", locale: "de"
:day
-iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name!("millispangels")
+iex> Bonfire.Common.Localise.Cldr.Unit.parse_unit_name!("millispangels")
** (Cldr.UnknownUnitError) Unknown unit was detected at "spangels"
@@ -1900,17 +1900,17 @@ preferred_units(unit, options \\ [])
Examples
-iex> meter = Cldr.Unit.new!(:meter, 1)
+iex> meter = Cldr.Unit.new!(:meter, 1)
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units meter, locale: "en-US", usage: :person_height
-{:ok, [:foot, :inch], []}
+{:ok, [:foot, :inch], []}
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units meter, locale: "en-US", usage: :person
-{:ok, [:inch], []}
+{:ok, [:inch], []}
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units meter, locale: "en-AU", usage: :person
-{:ok, [:centimeter], []}
+{:ok, [:centimeter], []}
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units meter, locale: "en-US", usage: :road
-{:ok, [:foot], [round_nearest: 1]}
+{:ok, [:foot], [round_nearest: 1]}
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units meter, locale: "en-AU", usage: :road
-{:ok, [:meter], [round_nearest: 1]}
+{:ok, [:meter], [round_nearest: 1]}
@@ -1971,15 +1971,15 @@ preferred_units!(unit, options \\ [])
Examples
-iex> meter = Cldr.Unit.new!(:meter, 2)
+iex> meter = Cldr.Unit.new!(:meter, 2)
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units! meter, locale: "en-US", usage: :person_height
-[:foot, :inch]
+[:foot, :inch]
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units! meter, locale: "en-AU", usage: :person
-[:centimeter]
+[:centimeter]
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units! meter, locale: "en-US", usage: :road
-[:foot]
+[:foot]
iex> Bonfire.Common.Localise.Cldr.Unit.preferred_units! meter, locale: "en-AU", usage: :road
-[:meter]
+[:meter]
@@ -2183,8 +2183,8 @@ to_iolist(number, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Unit.to_iolist Cldr.Unit.new!(:gallon, 123)
-{:ok, ["123", " gallons"]}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_iolist Cldr.Unit.new!(:gallon, 123)
+{:ok, ["123", " gallons"]}
@@ -2260,7 +2260,7 @@ to_iolist!(number, options \\ [])
Examples
iex> Bonfire.Common.Localise.Cldr.Unit.to_iolist! 123, unit: :gallon
-["123", " gallons"]
+ ["123", " gallons"]
@@ -2331,35 +2331,35 @@ to_string(number, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 123)
-{:ok, "123 gallons"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 123)
+{:ok, "123 gallons"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1)
-{:ok, "1 gallon"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1)
+{:ok, "1 gallon"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1), locale: "af"
-{:ok, "1 gelling"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1), locale: "af"
+{:ok, "1 gelling"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1), locale: "af-NA"
-{:ok, "1 gelling"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1), locale: "af-NA"
+{:ok, "1 gelling"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1), locale: "bs"
-{:ok, "1 galon"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1), locale: "bs"
+{:ok, "1 galon"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1234), format: :long
-{:ok, "1 thousand gallons"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1234), format: :long
+{:ok, "1 thousand gallons"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1234), format: :short
-{:ok, "1K gallons"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:gallon, 1234), format: :short
+{:ok, "1K gallons"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:megahertz, 1234)
-{:ok, "1,234 megahertz"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:megahertz, 1234)
+{:ok, "1,234 megahertz"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:megahertz, 1234), style: :narrow
-{:ok, "1,234Mhz"}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:megahertz, 1234), style: :narrow
+{:ok, "1,234Mhz"}
-iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:megabyte, 1234), locale: "en", style: :unknown
-{:error, {Cldr.UnknownFormatError, "The unit style :unknown is not known."}}
+iex> Bonfire.Common.Localise.Cldr.Unit.to_string Cldr.Unit.new!(:megabyte, 1234), locale: "en", style: :unknown
+{:error, {Cldr.UnknownFormatError, "The unit style :unknown is not known."}}
diff --git a/Bonfire.Common.Localise.Cldr.html b/Bonfire.Common.Localise.Cldr.html
index 0be548145e..602f96db54 100644
--- a/Bonfire.Common.Localise.Cldr.html
+++ b/Bonfire.Common.Localise.Cldr.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Cldr — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Cldr — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Cldr
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -554,24 +554,24 @@ default_locale()
Example
-iex> Bonfire.Common.Localise.Cldr.default_locale()
-%Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.default_locale()
+%Cldr.LanguageTag{
backend: Bonfire.Common.Localise.Cldr,
canonical_locale_name: "en-001",
cldr_locale_name: :"en-001",
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: "en",
language: "en",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :en,
requested_locale_name: "en-001",
script: :Latn,
territory: :"001",
- transform: %{},
- language_variants: []
-}
+ transform: %{},
+ language_variants: []
+}
@@ -607,7 +607,7 @@ default_territory()
Example
-iex> Bonfire.Common.Localise.Cldr.default_territory()
+iex> Bonfire.Common.Localise.Cldr.default_territory()
:"001"
@@ -668,16 +668,16 @@ ellipsis(string, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.ellipsis("And furthermore")
+iex> Bonfire.Common.Localise.Cldr.ellipsis("And furthermore")
"And furthermore…"
-iex> Bonfire.Common.Localise.Cldr.ellipsis(["And furthermore", "there is much to be done"], locale: :ja)
+iex> Bonfire.Common.Localise.Cldr.ellipsis(["And furthermore", "there is much to be done"], locale: :ja)
"And furthermore…there is much to be done"
-iex> Bonfire.Common.Localise.Cldr.ellipsis("And furthermore", format: :word)
+iex> Bonfire.Common.Localise.Cldr.ellipsis("And furthermore", format: :word)
"And furthermore …"
-iex> Bonfire.Common.Localise.Cldr.ellipsis(["And furthermore", "there is much to be done"], locale: :ja, format: :word)
+iex> Bonfire.Common.Localise.Cldr.ellipsis(["And furthermore", "there is much to be done"], locale: :ja, format: :word)
"And furthermore … there is much to be done"
@@ -713,23 +713,23 @@ get_locale()
Example
-iex> Bonfire.Common.Localise.Cldr.put_locale("pl")
-iex> Bonfire.Common.Localise.Cldr.get_locale()
-%Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.put_locale("pl")
+iex> Bonfire.Common.Localise.Cldr.get_locale()
+%Cldr.LanguageTag{
backend: Elixir.Bonfire.Common.Localise.Cldr,
canonical_locale_name: "pl",
cldr_locale_name: :pl,
- extensions: %{},
+ extensions: %{},
language: "pl",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :pl,
territory: :PL,
requested_locale_name: "pl",
script: :Latn,
- transform: %{},
- language_variants: []
- }
+ transform: %{},
+ language_variants: []
+ }
@@ -816,10 +816,10 @@ known_gettext_locale_name(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name("en")
+iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name("en")
"en"
-iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name("en-SA")
+iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name("en-SA")
false
@@ -862,10 +862,10 @@ known_gettext_locale_name?(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name?("en")
+iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name?("en")
true
-iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name?("!!")
+iex> Bonfire.Common.Localise.Cldr.known_gettext_locale_name?("!!")
false
@@ -939,10 +939,10 @@ known_locale_name(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.known_locale_name(:"en-AU")
+iex> Bonfire.Common.Localise.Cldr.known_locale_name(:"en-AU")
:"en-AU"
-iex> Bonfire.Common.Localise.Cldr.known_locale_name(:"en-SA")
+iex> Bonfire.Common.Localise.Cldr.known_locale_name(:"en-SA")
false
@@ -984,10 +984,10 @@ known_locale_name?(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.known_locale_name?(:en)
+iex> Bonfire.Common.Localise.Cldr.known_locale_name?(:en)
true
-iex> Bonfire.Common.Localise.Cldr.known_locale_name?(:"!!")
+iex> Bonfire.Common.Localise.Cldr.known_locale_name?(:"!!")
false
@@ -1041,8 +1041,8 @@ known_number_system_types()
Example
-iex> Bonfire.Common.Localise.Cldr.known_number_system_types()
-[:default, :finance, :native, :traditional]
+iex> Bonfire.Common.Localise.Cldr.known_number_system_types()
+[:default, :finance, :native, :traditional]
@@ -1107,10 +1107,10 @@ known_rbnf_locale_name(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name(:en)
+iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name(:en)
:en
-iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name(:"en-SA")
+iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name(:"en-SA")
false
@@ -1153,10 +1153,10 @@ known_rbnf_locale_name?(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name?(:en)
+iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name?(:en)
true
-iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name?(:"!!")
+iex> Bonfire.Common.Localise.Cldr.known_rbnf_locale_name?(:"!!")
false
@@ -1292,18 +1292,18 @@ put_gettext_locale(locale)
Examples
iex> import Cldr.LanguageTag.Sigil
-iex> Bonfire.Common.Localise.Cldr.put_gettext_locale(~l"en")
-{:ok, "en"}
+iex> Bonfire.Common.Localise.Cldr.put_gettext_locale(~l"en")
+{:ok, "en"}
iex> import Cldr.LanguageTag.Sigil
-iex> Bonfire.Common.Localise.Cldr.put_gettext_locale(~l"de")
-{
+iex> Bonfire.Common.Localise.Cldr.put_gettext_locale(~l"de")
+{
:error,
- {
+ {
Cldr.UnknownLocaleError,
"Locale TestBackend.Cldr.Locale.new!(\"de-DE\") does not map to a known gettext locale name"
- }
-}
+ }
+}
@@ -1347,29 +1347,29 @@ put_locale(locale_name)
Examples
-iex> Bonfire.Common.Localise.Cldr.put_locale("en")
-{:ok,
- %Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.put_locale("en")
+{:ok,
+ %Cldr.LanguageTag{
backend: Bonfire.Common.Localise.Cldr,
canonical_locale_name: "en",
cldr_locale_name: :en,
- language_subtags: [],
- extensions: %{},
+ language_subtags: [],
+ extensions: %{},
gettext_locale_name: "en",
language: "en",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :en,
requested_locale_name: "en",
script: :Latn,
territory: :US,
- transform: %{},
- language_variants: []
- }}
+ transform: %{},
+ language_variants: []
+ }}
-iex> Bonfire.Common.Localise.Cldr.put_locale("invalid-locale!")
-{:error, {Cldr.LanguageTag.ParseError,
- "Expected a BCP47 language tag. Could not parse the remaining \"!\" starting at position 15"}}
+iex> Bonfire.Common.Localise.Cldr.put_locale("invalid-locale!")
+{:error, {Cldr.LanguageTag.ParseError,
+ "Expected a BCP47 language tag. Could not parse the remaining \"!\" starting at position 15"}}
@@ -1418,10 +1418,10 @@ quote(string, options \\ [])
Examples
-iex> Bonfire.Common.Localise.Cldr.quote("Quoted String")
+iex> Bonfire.Common.Localise.Cldr.quote("Quoted String")
"“Quoted String”"
-iex> Bonfire.Common.Localise.Cldr.quote("Quoted String", locale: :ja)
+iex> Bonfire.Common.Localise.Cldr.quote("Quoted String", locale: :ja)
"「Quoted String」"
@@ -1552,47 +1552,47 @@ validate_locale(locale)
Examples
-iex> Bonfire.Common.Localise.Cldr.validate_locale(:en)
-{:ok,
-%Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.validate_locale(:en)
+{:ok,
+%Cldr.LanguageTag{
backend: Bonfire.Common.Localise.Cldr,
canonical_locale_name: "en",
cldr_locale_name: :en,
- extensions: %{},
+ extensions: %{},
gettext_locale_name: "en",
language: "en",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :en,
requested_locale_name: "en",
script: :Latn,
territory: :US,
- transform: %{},
- language_variants: []
-}}
+ transform: %{},
+ language_variants: []
+}}
-iex> Bonfire.Common.Localise.Cldr.validate_locale Bonfire.Common.Localise.Cldr.default_locale()
-{:ok,
-%Cldr.LanguageTag{
+iex> Bonfire.Common.Localise.Cldr.validate_locale Bonfire.Common.Localise.Cldr.default_locale()
+{:ok,
+%Cldr.LanguageTag{
backend: Bonfire.Common.Localise.Cldr,
canonical_locale_name: "en-001",
cldr_locale_name: :"en-001",
- extensions: %{},
+ extensions: %{},
gettext_locale_name: "en",
language: "en",
- locale: %{},
- private_use: [],
+ locale: %{},
+ private_use: [],
rbnf_locale_name: :en,
requested_locale_name: "en-001",
script: :Latn,
territory: :"001",
- transform: %{},
- language_variants: []
-}}
+ transform: %{},
+ language_variants: []
+}}
-iex> Bonfire.Common.Localise.Cldr.validate_locale("zzz")
-{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
+iex> Bonfire.Common.Localise.Cldr.validate_locale("zzz")
+{:error, {Cldr.InvalidLanguageError, "The language \"zzz\" is invalid"}}
@@ -1662,23 +1662,23 @@ validate_number_system_type(number_system_t
Examples
-iex> Bonfire.Common.Localise.Cldr.validate_number_system_type(:default)
-{:ok, :default}
+iex> Bonfire.Common.Localise.Cldr.validate_number_system_type(:default)
+{:ok, :default}
-iex> Bonfire.Common.Localise.Cldr.validate_number_system_type(:traditional)
-{:ok, :traditional}
+iex> Bonfire.Common.Localise.Cldr.validate_number_system_type(:traditional)
+{:ok, :traditional}
-iex> Bonfire.Common.Localise.Cldr.validate_number_system_type(:latn)
-{
+iex> Bonfire.Common.Localise.Cldr.validate_number_system_type(:latn)
+{
:error,
- {Cldr.UnknownNumberSystemTypeError, "The number system type :latn is unknown"}
-}
+ {Cldr.UnknownNumberSystemTypeError, "The number system type :latn is unknown"}
+}
-iex> Bonfire.Common.Localise.Cldr.validate_number_system_type("bork")
-{
+iex> Bonfire.Common.Localise.Cldr.validate_number_system_type("bork")
+{
:error,
- {Cldr.UnknownNumberSystemTypeError, "The number system type \"bork\" is invalid"}
-}
+ {Cldr.UnknownNumberSystemTypeError, "The number system type \"bork\" is invalid"}
+}
diff --git a/Bonfire.Common.Localise.Gettext.Helpers.html b/Bonfire.Common.Localise.Gettext.Helpers.html
index 0885b31b91..9fbf80d75c 100644
--- a/Bonfire.Common.Localise.Gettext.Helpers.html
+++ b/Bonfire.Common.Localise.Gettext.Helpers.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Gettext.Helpers — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Gettext.Helpers — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,21 +132,21 @@
Bonfire.Common.Localise.Gettext.Helpers
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
A module providing Internationalization with a gettext-based API.
By using Gettext,
-your module gains a set of macros for translations, for example:
Simple translation
iex> l("Hello")
+your module gains a set of macros for translations, for example:Simple translation
iex> l("Hello")
"Hello"
-iex> l("Hello %{name}", name: "Bookchin")
+iex> l("Hello %{name}", name: "Bookchin")
"Hello Bookchin"
-iex> l("Hi", [], "test context")
-"Hi"
Plural translation
iex> lp("Hi friend", "Hi friends", 2)
+iex> l("Hi", [], "test context")
+"Hi"
Plural translation
iex> lp("Hi friend", "Hi friends", 2)
"Hi friends"
-iex> lp("Hiya %{user_or_users}", "Hiyas %{user_or_users}", 1, [user_or_users: "Bookchin"], "test context")
+iex> lp("Hiya %{user_or_users}", "Hiyas %{user_or_users}", 1, [user_or_users: "Bookchin"], "test context")
"Hiya Bookchin"
See the Gettext Docs for details.
@@ -250,11 +250,11 @@ l(original_text_or_id, bindings \\ [], cont
Examples
-iex> l("Hello")
+iex> l("Hello")
"Hello"
-iex> l("Hello %{name}", name: "Bookchin")
+iex> l("Hello %{name}", name: "Bookchin")
"Hello Bookchin"
-iex> l("Hi", [], "test context")
+iex> l("Hi", [], "test context")
"Hi"
@@ -291,9 +291,9 @@ localise_dynamic(msgid, caller_module \\ ni
Examples
-iex> localise_dynamic("some_message_id")
+iex> localise_dynamic("some_message_id")
"some_message_id"
-iex> localise_dynamic("some_message_id", MyApp.MyModule)
+iex> localise_dynamic("some_message_id", MyApp.MyModule)
"some_message_id"
@@ -332,10 +332,10 @@ localise_strings(strings, caller_module \\
Examples
-iex> localise_strings(["hello", "world"])
-["hello", "world"]
-iex> localise_strings(["hello", "world"], MyApp.MyModule)
-["hello", "world"]
+iex> localise_strings(["hello", "world"])
+["hello", "world"]
+iex> localise_strings(["hello", "world"], MyApp.MyModule)
+["hello", "world"]
@@ -377,9 +377,9 @@ lp(original_text_or_id, msgid_plural, n, bi
Examples
-iex> lp("Hi friend", "Hi friends", 2)
+iex> lp("Hi friend", "Hi friends", 2)
"Hi friends"
-iex> lp("Hiya %{user_or_users}", "Hiyas %{user_or_users}", 1, [user_or_users: "Bookchin"], "test context")
+iex> lp("Hiya %{user_or_users}", "Hiyas %{user_or_users}", 1, [user_or_users: "Bookchin"], "test context")
"Hiya Bookchin"
diff --git a/Bonfire.Common.Localise.Gettext.Plural.html b/Bonfire.Common.Localise.Gettext.Plural.html
index f799534269..2c21caaeef 100644
--- a/Bonfire.Common.Localise.Gettext.Plural.html
+++ b/Bonfire.Common.Localise.Gettext.Plural.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Gettext.Plural — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Gettext.Plural — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Gettext.Plural
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -223,10 +223,10 @@ nplurals(locale_name)
Examples
-iex> Bonfire.Common.Localise.Gettext.Plural.nplurals("pl")
+iex> Bonfire.Common.Localise.Gettext.Plural.nplurals("pl")
4
-iex> Bonfire.Common.Localise.Gettext.Plural.nplurals("en")
+iex> Bonfire.Common.Localise.Gettext.Plural.nplurals("en")
2
@@ -264,28 +264,28 @@ plural(locale, n)
Examples
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 1)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 1)
0
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 2)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 2)
1
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 5)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 5)
2
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 112)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("pl", 112)
2
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("en", 1)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("en", 1)
0
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("en", 2)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("en", 2)
1
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("en", 112)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("en", 112)
1
-iex> Bonfire.Common.Localise.Gettext.Plural.plural("en_GB", 112)
+iex> Bonfire.Common.Localise.Gettext.Plural.plural("en_GB", 112)
1
diff --git a/Bonfire.Common.Localise.Gettext.html b/Bonfire.Common.Localise.Gettext.html
index 809357ea2a..68a3d8185c 100644
--- a/Bonfire.Common.Localise.Gettext.html
+++ b/Bonfire.Common.Localise.Gettext.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise.Gettext — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise.Gettext — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise.Gettext
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Localise.html b/Bonfire.Common.Localise.html
index 7ea58184d1..bf414454d0 100644
--- a/Bonfire.Common.Localise.html
+++ b/Bonfire.Common.Localise.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Localise — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Localise — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Localise
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -263,7 +263,7 @@ default_locale()
Examples
-iex> default_locale()
+iex> default_locale()
"en"
@@ -292,8 +292,8 @@ get_locale()
Examples
-iex> get_locale()
-Bonfire.Common.Localise.Cldr.Locale.new!("en")
+iex> get_locale()
+Bonfire.Common.Localise.Cldr.Locale.new!("en")
@@ -321,7 +321,7 @@ get_locale_id()
Examples
-iex> get_locale_id()
+iex> get_locale_id()
:en
@@ -350,8 +350,8 @@ known_locales()
Examples
-> known_locales()
-[:en, :es, :fr]
+> known_locales()
+[:en, :es, :fr]
@@ -379,9 +379,9 @@ locale_name(locale)
Examples
-iex> locale_name(:en)
+iex> locale_name(:en)
"English"
-iex> locale_name("fr")
+iex> locale_name("fr")
"French"
@@ -410,7 +410,7 @@ put_locale(locale)
Examples
-iex> put_locale("es")
+iex> put_locale("es")
nil
diff --git a/Bonfire.Common.Media.html b/Bonfire.Common.Media.html
index 9dfeb9b816..8fdc9fa53c 100644
--- a/Bonfire.Common.Media.html
+++ b/Bonfire.Common.Media.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Media — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Media — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Media
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -323,16 +323,16 @@ avatar_media(maybe_media)
Examples
-iex> avatar_media(%{profile: %{icon: "http://example.com/avatar.png"}})
-%Media{...}
+iex> avatar_media(%{profile: %{icon: "http://example.com/avatar.png"}})
+%Media{...}
-iex> avatar_media(%{icon: "http://example.com/icon.png"})
-%Media{...}
+iex> avatar_media(%{icon: "http://example.com/icon.png"})
+%Media{...}
-iex> avatar_media(%{profile: %{icon: %{path: "http://example.com/path.png"}}})
-%Media{...}
+iex> avatar_media(%{profile: %{icon: %{path: "http://example.com/path.png"}}})
+%Media{...}
-iex> avatar_media(%{nonexistent_key: "value"})
+iex> avatar_media(%{nonexistent_key: "value"})
nil
@@ -361,34 +361,34 @@ avatar_url(media)
Examples
-iex> avatar_url(%{profile: %{icon: %{url: "http://example.com/avatar.png"}}})
+iex> avatar_url(%{profile: %{icon: %{url: "http://example.com/avatar.png"}}})
"http://example.com/avatar.png"
-iex> avatar_url(%{icon: %{path: "http://example.com/path.png"}})
+iex> avatar_url(%{icon: %{path: "http://example.com/path.png"}})
"http://example.com/path.png"
-iex> avatar_url(%{icon_id: "icon123"})
+iex> avatar_url(%{icon_id: "icon123"})
# Assume Bonfire.Files.IconUploader.remote_url/1 returns "http://example.com/icon123.png"
"http://example.com/icon123.png"
-iex> avatar_url(%{path: "image.jpg"})
+iex> avatar_url(%{path: "image.jpg"})
# Assume Bonfire.Files.IconUploader.remote_url/1 returns "http://example.com/image.jpg"
"http://example.com/image.jpg"
-iex> avatar_url(%{icon: "http://example.com/icon.png"})
+iex> avatar_url(%{icon: "http://example.com/icon.png"})
"http://example.com/icon.png"
-iex> avatar_url(%{image: "http://example.com/image.png"})
+iex> avatar_url(%{image: "http://example.com/image.png"})
"http://example.com/image.png"
-iex> avatar_url(%{id: "user123", shared_user: nil})
+iex> avatar_url(%{id: "user123", shared_user: nil})
# Assume avatar_fallback/1 returns "/images/avatar.png"
"/images/avatar.png"
-iex> avatar_url(%{id: "user456", shared_user: %{id: "shared123"}})
+iex> avatar_url(%{id: "user456", shared_user: %{id: "shared123"}})
"https://picsum.photos/seed/user456/128/128?blur"
-iex> avatar_url(%{id: "user789"})
+iex> avatar_url(%{id: "user789"})
# Assume avatar_fallback/1 returns "/images/avatar.png"
"/images/avatar.png"
@@ -440,31 +440,31 @@ banner_url(media)
Examples
-iex> banner_url(%{profile: %{image: %{id: "banner123"}}})
+iex> banner_url(%{profile: %{image: %{id: "banner123"}}})
# Assume Bonfire.Files.BannerUploader.remote_url/1 returns "http://example.com/banner123.png"
"http://example.com/banner123.png"
-iex> banner_url(%{image: %{url: "http://example.com/banner.png"}})
+iex> banner_url(%{image: %{url: "http://example.com/banner.png"}})
"http://example.com/banner.png"
-iex> banner_url(%{image: %{path: "http://example.com/banner.png"}})
+iex> banner_url(%{image: %{path: "http://example.com/banner.png"}})
"http://example.com/banner.png"
-iex> banner_url(%{path: "http://example.com/banner.png"})
+iex> banner_url(%{path: "http://example.com/banner.png"})
"http://example.com/banner.png"
-iex> banner_url(%{image_id: "banner456"})
+iex> banner_url(%{image_id: "banner456"})
# Assume Bonfire.Files.BannerUploader.remote_url/1 returns "http://example.com/banner456.png"
"http://example.com/banner456.png"
-iex> banner_url(%{image: "http://example.com/banner.png"})
+iex> banner_url(%{image: "http://example.com/banner.png"})
"http://example.com/banner.png"
-iex> banner_url(%{profile: %{image: %{id: "banner789"}}})
+iex> banner_url(%{profile: %{image: %{id: "banner789"}}})
# Assume Bonfire.Files.BannerUploader.remote_url/1 returns "http://example.com/banner789.png"
"http://example.com/banner789.png"
-iex> banner_url(%{nonexistent_key: "value"})
+iex> banner_url(%{nonexistent_key: "value"})
# Assume banner_fallback/0 returns "/images/bonfires.png"
"/images/bonfires.png"
@@ -496,14 +496,14 @@ extract_tar(archive, opts \\ [:compressed,
Examples
-iex> extract_tar("path/to/archive.tar.gz")
-%{"file1.txt" => <<...>> , "file2.txt" => <<...>>}
+iex> extract_tar("path/to/archive.tar.gz")
+%{"file1.txt" => <<...>> , "file2.txt" => <<...>>}
-iex> extract_tar("path/to/archive.tar", [:memory])
-%{"file1.txt" => <<...>> , "file2.txt" => <<...>>}
+iex> extract_tar("path/to/archive.tar", [:memory])
+%{"file1.txt" => <<...>> , "file2.txt" => <<...>>}
-iex> extract_tar("path/to/archive.tar", [:compressed, :memory])
-%{"file1.txt" => <<...>> , "file2.txt" => <<...>>}
+iex> extract_tar("path/to/archive.tar", [:compressed, :memory])
+%{"file1.txt" => <<...>> , "file2.txt" => <<...>>}
@@ -531,35 +531,35 @@ image_url(url)
Examples
-iex> image_url("http://example.com/image.png")
+iex> image_url("http://example.com/image.png")
"http://example.com/image.png"
-iex> image_url(%{media_type: "text/plain"})
+iex> image_url(%{media_type: "text/plain"})
nil
-iex> image_url(%{profile: %{image: %{url: "http://example.com/image.png"}}})
+iex> image_url(%{profile: %{image: %{url: "http://example.com/image.png"}}})
"http://example.com/image.png"
-iex> image_url(%{image: %{url: "http://example.com/image.png"}})
+iex> image_url(%{image: %{url: "http://example.com/image.png"}})
"http://example.com/image.png"
-iex> image_url(%{icon: %{path: "http://example.com/image.png"}})
+iex> image_url(%{icon: %{path: "http://example.com/image.png"}})
"http://example.com/image.png"
-iex> image_url(%{path: "http://example.com/image.png"})
+iex> image_url(%{path: "http://example.com/image.png"})
"http://example.com/image.png"
-iex> image_url(%{image_id: "image123"})
+iex> image_url(%{image_id: "image123"})
# Assume Bonfire.Files.ImageUploader.remote_url/1 returns "http://example.com/image123.png"
"http://example.com/image123.png"
-iex> image_url(%{image: "http://example.com/image.png"})
+iex> image_url(%{image: "http://example.com/image.png"})
"http://example.com/image.png"
-iex> image_url(%{profile: %{image: "http://example.com/profile_image.png"}})
+iex> image_url(%{profile: %{image: "http://example.com/profile_image.png"}})
"http://example.com/profile_image.png"
-iex> image_url(%{nonexistent_key: "value"})
+iex> image_url(%{nonexistent_key: "value"})
nil
@@ -594,16 +594,16 @@ maybe_dominant_color(user, avatar_url \\ ni
Examples
-iex> maybe_dominant_color(%{profile: %{icon: "http://example.com/avatar.png"}})
+iex> maybe_dominant_color(%{profile: %{icon: "http://example.com/avatar.png"}})
"#AA4203" # Example dominant color
-iex> maybe_dominant_color(%{profile: %{icon: "http://example.com/avatar.png"}}, nil, "http://example.com/banner.png")
+iex> maybe_dominant_color(%{profile: %{icon: "http://example.com/avatar.png"}}, nil, "http://example.com/banner.png")
"#AA4203" # Example dominant color
-iex> maybe_dominant_color(%{profile: %{icon: "http://example.com/avatar.png"}}, nil, nil, "/images/bonfires.png")
+iex> maybe_dominant_color(%{profile: %{icon: "http://example.com/avatar.png"}}, nil, nil, "/images/bonfires.png")
"#AA4203" # Example dominant color
-iex> maybe_dominant_color(%{profile: %{icon: nil}}, "http://example.com/banner.png")
+iex> maybe_dominant_color(%{profile: %{icon: nil}}, "http://example.com/banner.png")
nil
@@ -632,29 +632,29 @@ media_url(media)
Examples
-iex> media_url(%{path: "http://example.com/image.jpg"})
+iex> media_url(%{path: "http://example.com/image.jpg"})
"http://example.com/image.jpg"
-iex> media_url(%{path: "remote.jpg", metadata: %{"module" => "MyModule"}})
+iex> media_url(%{path: "remote.jpg", metadata: %{"module" => "MyModule"}})
# Assume MyModule.remote_url/1 is defined and returns "http://example.com/remote.jpg"
"http://example.com/remote.jpg"
-iex> media_url(%{media_type: "image/jpeg", path: "image.jpg"})
+iex> media_url(%{media_type: "image/jpeg", path: "image.jpg"})
"http://image.jpg"
-iex> media_url(%{media_type: "text/plain", path: "document.txt"})
+iex> media_url(%{media_type: "text/plain", path: "document.txt"})
"http://document.txt"
-iex> media_url(%{changes: %{path: "http://changed.example.com/image.jpg"}})
+iex> media_url(%{changes: %{path: "http://changed.example.com/image.jpg"}})
"http://changed.example.com/image.jpg"
-iex> media_url(%{path: "image.jpg"})
+iex> media_url(%{path: "image.jpg"})
"http://image.jpg"
-iex> media_url(%{media: %{path: "http://nested.example.com/image.jpg"}})
+iex> media_url(%{media: %{path: "http://nested.example.com/image.jpg"}})
"http://nested.example.com/image.jpg"
-iex> media_url(%{nonexistent_key: "value"})
+iex> media_url(%{nonexistent_key: "value"})
nil
@@ -685,17 +685,17 @@ read_tar_files(archive, file_or_files, opts
Examples
-iex> read_tar_files("path/to/archive.tar", "file1.txt")
-{:ok, "file1 contents"}
+iex> read_tar_files("path/to/archive.tar", "file1.txt")
+{:ok, "file1 contents"}
-iex> read_tar_files("path/to/archive.tar", ["file1.txt", "file2.txt"])
-{:ok, ["file1 contents", "file2 contents"]}
+iex> read_tar_files("path/to/archive.tar", ["file1.txt", "file2.txt"])
+{:ok, ["file1 contents", "file2 contents"]}
-iex> read_tar_files("path/to/nonexistent.tar", "file1.txt")
-{:error, "File not found"}
+iex> read_tar_files("path/to/nonexistent.tar", "file1.txt")
+{:error, "File not found"}
-iex> read_tar_files("path/to/archive.tar", "nonexistent_file.txt")
-{:error, "File not found"}
+iex> read_tar_files("path/to/archive.tar", "nonexistent_file.txt")
+{:error, "File not found"}
@@ -723,22 +723,22 @@ thumbnail_url(media)
Examples
-iex> thumbnail_url(%{path: "thumbnail.jpg", metadata: %{"module" => "MyModule"}})
+iex> thumbnail_url(%{path: "thumbnail.jpg", metadata: %{"module" => "MyModule"}})
# Assume MyModule.remote_url/2 with :thumbnail returns "http://example.com/thumbnail.jpg"
"http://example.com/thumbnail.jpg"
-iex> thumbnail_url(%{media_type: "image/jpeg", path: "thumbnail.jpg"})
+iex> thumbnail_url(%{media_type: "image/jpeg", path: "thumbnail.jpg"})
"http://thumbnail.jpg"
-iex> thumbnail_url(%{media_type: "video/mp4", path: "video.mpeg"})
+iex> thumbnail_url(%{media_type: "video/mp4", path: "video.mpeg"})
# Assume Bonfire.Files.VideoUploader.remote_url/2 with :thumbnail returns "http://video-thumbnail.jpg"
"http://video-thumbnail.jpg"
-iex> thumbnail_url(%{path: "document.pdf", media_type: "document"})
+iex> thumbnail_url(%{path: "document.pdf", media_type: "document"})
# Assume Bonfire.Files.DocumentUploader.remote_url/2 with :thumbnail returns "http://document-thumbnail.jpg"
"http://document-thumbnail.jpg"
-iex> thumbnail_url(%{nonexistent_key: "value"})
+iex> thumbnail_url(%{nonexistent_key: "value"})
nil
diff --git a/Bonfire.Common.MemoryMonitor.html b/Bonfire.Common.MemoryMonitor.html
index 98891f4e02..ca89e5eeba 100644
--- a/Bonfire.Common.MemoryMonitor.html
+++ b/Bonfire.Common.MemoryMonitor.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.MemoryMonitor — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.MemoryMonitor — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.MemoryMonitor
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Modularity.DeclareHelpers.html b/Bonfire.Common.Modularity.DeclareHelpers.html
index 03d3bd71ce..bfcac0bd0a 100644
--- a/Bonfire.Common.Modularity.DeclareHelpers.html
+++ b/Bonfire.Common.Modularity.DeclareHelpers.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Modularity.DeclareHelpers — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Modularity.DeclareHelpers — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Modularity.DeclareHelpers
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -249,10 +249,10 @@ declare_extension(name, opts \\ [])
Examples
-iex> defmodule MyExtension do
+iex> defmodule MyExtension do
...> import Bonfire.Common.Modularity.DeclareHelpers
-...> declare_extension("My Extension", readme: "MY_README.md")
-...> end
+...> declare_extension("My Extension", readme: "MY_README.md")
+...> end
@@ -280,14 +280,14 @@ generate_link(name, module, opts)
Examples
-iex> Bonfire.Common.Modularity.DeclareHelpers.generate_link(:bonfire_common, Bonfire.Common, href: "/my_extension")
-%{
+iex> Bonfire.Common.Modularity.DeclareHelpers.generate_link(:bonfire_common, Bonfire.Common, href: "/my_extension")
+%{
name: :bonfire_common,
module: Bonfire.Common,
app: :bonfire_common,
href: "/my_extension",
type: :link
-}
+}
diff --git a/Bonfire.Common.Module.Override.html b/Bonfire.Common.Module.Override.html
index c2cd70631b..2ba9bfcdc0 100644
--- a/Bonfire.Common.Module.Override.html
+++ b/Bonfire.Common.Module.Override.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Module.Override — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Module.Override — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Module.Override
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Needles.Pointers.Queries.html b/Bonfire.Common.Needles.Pointers.Queries.html
index cb794f1939..81100f8a44 100644
--- a/Bonfire.Common.Needles.Pointers.Queries.html
+++ b/Bonfire.Common.Needles.Pointers.Queries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Needles.Pointers.Queries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Needles.Pointers.Queries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Needles.Pointers.Queries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Needles.Preload.html b/Bonfire.Common.Needles.Preload.html
index d109e3cf15..59ae72d4fc 100644
--- a/Bonfire.Common.Needles.Preload.html
+++ b/Bonfire.Common.Needles.Preload.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Needles.Preload — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Needles.Preload — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Needles.Preload
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -245,7 +245,7 @@ access_key(key, default_val \\ nil)
Examples
-iex> Bonfire.Common.Needles.Preload.access_key(:key)
+iex> Bonfire.Common.Needles.Preload.access_key(:key)
@@ -277,8 +277,8 @@ custom_access_key_fun(key, fun \\ &prel
Examples
-iex> Bonfire.Common.Needles.Preload.custom_access_key_fun(:key)
-#Function<...>
+iex> Bonfire.Common.Needles.Preload.custom_access_key_fun(:key)
+#Function<...>
@@ -314,14 +314,14 @@ maybe_preload_nested_pointers(object, keys,
Examples
-iex> Bonfire.Common.Needles.Preload.maybe_preload_nested_pointers(%{key: %{nested_key: %Ecto.AssociationNotLoaded{}}}, [key: [:nested_key]], [])
-%{key: %{nested_key: %LoadedObject{}}}
+iex> Bonfire.Common.Needles.Preload.maybe_preload_nested_pointers(%{key: %{nested_key: %Ecto.AssociationNotLoaded{}}}, [key: [:nested_key]], [])
+%{key: %{nested_key: %LoadedObject{}}}
-iex> Bonfire.Common.Needles.Preload.maybe_preload_nested_pointers(%{edges: []}, [:key], [])
-%{edges: []}
+iex> Bonfire.Common.Needles.Preload.maybe_preload_nested_pointers(%{edges: []}, [:key], [])
+%{edges: []}
-iex> Bonfire.Common.Needles.Preload.maybe_preload_nested_pointers([%{key: %Ecto.AssociationNotLoaded{}}], [:key], [])
-[%{key: %LoadedObject{}}]
+iex> Bonfire.Common.Needles.Preload.maybe_preload_nested_pointers([%{key: %Ecto.AssociationNotLoaded{}}], [:key], [])
+[%{key: %LoadedObject{}}]
@@ -351,10 +351,10 @@ maybe_preload_pointer(pointer, opts \\ [])<
Examples
-iex> Bonfire.Common.Needles.Preload.maybe_preload_pointer(%Needle.Pointer{...}, [])
-%LoadedObject{}
+iex> Bonfire.Common.Needles.Preload.maybe_preload_pointer(%Needle.Pointer{...}, [])
+%LoadedObject{}
-iex> Bonfire.Common.Needles.Preload.maybe_preload_pointer("not_a_pointer", [])
+iex> Bonfire.Common.Needles.Preload.maybe_preload_pointer("not_a_pointer", [])
"not_a_pointer"
@@ -391,14 +391,14 @@ maybe_preload_pointers(object, keys, opts \
Examples
-iex> Bonfire.Common.Needles.Preload.maybe_preload_pointers(%{edges: [...]}, [:key], [])
-%{edges: [...]}
+iex> Bonfire.Common.Needles.Preload.maybe_preload_pointers(%{edges: [...]}, [:key], [])
+%{edges: [...]}
-iex> Bonfire.Common.Needles.Preload.maybe_preload_pointers(%{key: %Ecto.AssociationNotLoaded{}}, [:key], [])
-%{key: %LoadedObject{}}
+iex> Bonfire.Common.Needles.Preload.maybe_preload_pointers(%{key: %Ecto.AssociationNotLoaded{}}, [:key], [])
+%{key: %LoadedObject{}}
-iex> Bonfire.Common.Needles.Preload.maybe_preload_pointers(%{key: %{nested_key: %Ecto.AssociationNotLoaded{}}}, [:key, :nested_key], [])
-%{key: %{nested_key: %LoadedObject{}}}
+iex> Bonfire.Common.Needles.Preload.maybe_preload_pointers(%{key: %{nested_key: %Ecto.AssociationNotLoaded{}}}, [:key, :nested_key], [])
+%{key: %{nested_key: %LoadedObject{}}}
diff --git a/Bonfire.Common.Needles.Tables.Queries.html b/Bonfire.Common.Needles.Tables.Queries.html
index 174166f25a..5e345a98b4 100644
--- a/Bonfire.Common.Needles.Tables.Queries.html
+++ b/Bonfire.Common.Needles.Tables.Queries.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Needles.Tables.Queries — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Needles.Tables.Queries — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Needles.Tables.Queries
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Needles.Tables.html b/Bonfire.Common.Needles.Tables.html
index 32d5bfea6d..6d66843759 100644
--- a/Bonfire.Common.Needles.Tables.html
+++ b/Bonfire.Common.Needles.Tables.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Needles.Tables — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Needles.Tables — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Needles.Tables
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -303,8 +303,8 @@ list_ids()
Examples
-iex> Bonfire.Common.Needles.Tables.list_ids()
-["id1", "id2"]
+iex> Bonfire.Common.Needles.Tables.list_ids()
+["id1", "id2"]
@@ -332,8 +332,8 @@ list_schemas()
Examples
-iex> Bonfire.Common.Needles.Tables.list_schemas()
-[:schema1, :schema2]
+iex> Bonfire.Common.Needles.Tables.list_schemas()
+[:schema1, :schema2]
@@ -363,11 +363,11 @@ list_tables(source \\ :code)
Examples
-iex> Bonfire.Common.Needles.Tables.list_tables()
-[%Table{}]
+iex> Bonfire.Common.Needles.Tables.list_tables()
+[%Table{}]
-iex> Bonfire.Common.Needles.Tables.list_tables(:db)
-%{"table_name" => %Table{}}
+iex> Bonfire.Common.Needles.Tables.list_tables(:db)
+%{"table_name" => %Table{}}
@@ -395,8 +395,8 @@ list_tables_debug()
Examples
-iex> Bonfire.Common.Needles.Tables.list_tables_debug()
-[{:ok, "table1"}, {:error, "Code and DB have differing IDs for the same table", "table2", "id2a", "id2b"}, {:error, "Table present in DB but not in code", "table3"}]
+iex> Bonfire.Common.Needles.Tables.list_tables_debug()
+[{:ok, "table1"}, {:error, "Code and DB have differing IDs for the same table", "table2", "id2a", "id2b"}, {:error, "Table present in DB but not in code", "table3"}]
@@ -426,8 +426,8 @@ many(filters \\ [])
Examples
-iex> Bonfire.Common.Needles.Tables.many(%{field: "value"})
-{:ok, [%Table{}]}
+iex> Bonfire.Common.Needles.Tables.many(%{field: "value"})
+{:ok, [%Table{}]}
@@ -455,11 +455,11 @@ one(id)
Examples
-iex> Bonfire.Common.Needles.Tables.one("valid_ulid")
-{:ok, %Table{}}
+iex> Bonfire.Common.Needles.Tables.one("valid_ulid")
+{:ok, %Table{}}
-iex> Bonfire.Common.Needles.Tables.one(%{field: "value"})
-%Table{}
+iex> Bonfire.Common.Needles.Tables.one(%{field: "value"})
+%Table{}
@@ -487,8 +487,8 @@ one!(filters)
Examples
-iex> Bonfire.Common.Needles.Tables.one!(%{field: "value"})
-%Table{}
+iex> Bonfire.Common.Needles.Tables.one!(%{field: "value"})
+%Table{}
@@ -516,10 +516,10 @@ schema_or_table!(schema_or_tablename_or_id)
Examples
-iex> Bonfire.Common.Needles.Tables.schema_or_table!("valid_id")
+iex> Bonfire.Common.Needles.Tables.schema_or_table!("valid_id")
MySchema
-iex> Bonfire.Common.Needles.Tables.schema_or_table!("table_name")
+iex> Bonfire.Common.Needles.Tables.schema_or_table!("table_name")
MySchema
@@ -554,13 +554,13 @@ table!(schema_or_tablename_or_id)
Examples
-iex> Bonfire.Common.Needles.Tables.table!(%Pointer{table_id: "valid_id"})
-%Table{}
+iex> Bonfire.Common.Needles.Tables.table!(%Pointer{table_id: "valid_id"})
+%Table{}
-iex> Bonfire.Common.Needles.Tables.table!("valid_id")
-%Table{}
+iex> Bonfire.Common.Needles.Tables.table!("valid_id")
+%Table{}
-iex> Bonfire.Common.Needles.Tables.table!("invalid_id")
+iex> Bonfire.Common.Needles.Tables.table!("invalid_id")
# throws error
@@ -589,11 +589,11 @@ table_fields(schema)
Examples
-iex> Bonfire.Common.Needles.Tables.table_fields(MySchema)
-[:field1, :field2]
+iex> Bonfire.Common.Needles.Tables.table_fields(MySchema)
+[:field1, :field2]
-iex> Bonfire.Common.Needles.Tables.table_fields("table_name")
-[:field1, :field2]
+iex> Bonfire.Common.Needles.Tables.table_fields("table_name")
+[:field1, :field2]
@@ -621,11 +621,11 @@ table_fields_meta(schema)
Examples
-iex> Bonfire.Common.Needles.Tables.table_fields_meta(MySchema)
-[%{column_name: "field1", data_type: "type", column_default: nil, is_nullable: "NO"}]
+iex> Bonfire.Common.Needles.Tables.table_fields_meta(MySchema)
+[%{column_name: "field1", data_type: "type", column_default: nil, is_nullable: "NO"}]
-iex> Bonfire.Common.Needles.Tables.table_fields_meta("table_name")
-[%{column_name: "field1", data_type: "type", column_default: nil, is_nullable: "NO"}]
+iex> Bonfire.Common.Needles.Tables.table_fields_meta("table_name")
+[%{column_name: "field1", data_type: "type", column_default: nil, is_nullable: "NO"}]
diff --git a/Bonfire.Common.Needles.html b/Bonfire.Common.Needles.html
index be9ab30451..a476f278d7 100644
--- a/Bonfire.Common.Needles.html
+++ b/Bonfire.Common.Needles.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Needles — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Needles — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Needles
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -451,8 +451,8 @@ dataloader(context)
Examples
-iex> Bonfire.Common.Needles.dataloader(context)
-%Dataloader{...}
+iex> Bonfire.Common.Needles.dataloader(context)
+%Dataloader{...}
@@ -482,10 +482,10 @@ exists?(filters, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.exists?("some_id")
+iex> Bonfire.Common.Needles.exists?("some_id")
true
-iex> Bonfire.Common.Needles.exists?("non_existent_id")
+iex> Bonfire.Common.Needles.exists?("non_existent_id")
false
@@ -514,8 +514,8 @@ filter_one(filters)
Examples
-iex> Bonfire.Common.Needles.filter_one("http://url")
-[canonical_uri: "http://url"]
+iex> Bonfire.Common.Needles.filter_one("http://url")
+[canonical_uri: "http://url"]
@@ -545,8 +545,8 @@ filters(schema, id_filters, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.filters(query, filters)
-%Ecto.Query{...}
+iex> Bonfire.Common.Needles.filters(query, filters)
+%Ecto.Query{...}
@@ -576,11 +576,11 @@ follow!(pointer_or_pointers, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.follow!(%Pointer{id: "some_id"})
-%SomeRecord{}
+iex> Bonfire.Common.Needles.follow!(%Pointer{id: "some_id"})
+%SomeRecord{}
-iex> Bonfire.Common.Needles.follow!([%Pointer{id: "some_id"}])
-[%SomeRecord{}]
+iex> Bonfire.Common.Needles.follow!([%Pointer{id: "some_id"}])
+[%SomeRecord{}]
@@ -685,8 +685,8 @@ forge!(pointed)
Examples
-iex> Bonfire.Common.Needles.forge!(%{__struct__: MySchema, id: "some_id"})
-%Pointer{id: "some_id", ...}
+iex> Bonfire.Common.Needles.forge!(%{__struct__: MySchema, id: "some_id"})
+%Pointer{id: "some_id", ...}
@@ -770,8 +770,8 @@ forge!(table_id, id)
Examples
-iex> Bonfire.Common.Needles.forge!(:my_table, "some_id")
-%Pointer{id: "some_id", ...}
+iex> Bonfire.Common.Needles.forge!(:my_table, "some_id")
+%Pointer{id: "some_id", ...}
@@ -801,11 +801,11 @@ get(id, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.get("existing_id")
-{:ok, %Pointer{id: "existing_id", ...}}
+iex> Bonfire.Common.Needles.get("existing_id")
+{:ok, %Pointer{id: "existing_id", ...}}
-iex> Bonfire.Common.Needles.get("non_existent_id")
-{:error, :not_found}
+iex> Bonfire.Common.Needles.get("non_existent_id")
+{:error, :not_found}
@@ -835,10 +835,10 @@ get!(id, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.get!("existing_id")
-%Pointer{id: "existing_id", ...}
+iex> Bonfire.Common.Needles.get!("existing_id")
+%Pointer{id: "existing_id", ...}
-iex> Bonfire.Common.Needles.get!("non_existent_id")
+iex> Bonfire.Common.Needles.get!("non_existent_id")
** (Needle.NotFound) ...
@@ -867,7 +867,7 @@ id_binary(id)
Examples
-iex> Bonfire.Common.Needles.id_binary(id: "some_id")
+iex> Bonfire.Common.Needles.id_binary(id: "some_id")
@@ -895,7 +895,7 @@ id_filter(query, id)
Examples
-iex> Bonfire.Common.Needles.id_filter(query, id: "some_id")
+iex> Bonfire.Common.Needles.id_filter(query, id: "some_id")
@@ -925,11 +925,11 @@ list!(pointers, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.list!(["id1", "id2"])
-[%Pointer{id: "id1", ...}, %Pointer{id: "id2", ...}]
+iex> Bonfire.Common.Needles.list!(["id1", "id2"])
+[%Pointer{id: "id1", ...}, %Pointer{id: "id2", ...}]
-iex> Bonfire.Common.Needles.list!([%Pointer{id: "id1"}, %Pointer{id: "id2"}])
-[%Pointer{id: "id1", ...}, %Pointer{id: "id2", ...}]
+iex> Bonfire.Common.Needles.list!([%Pointer{id: "id1"}, %Pointer{id: "id2"}])
+[%Pointer{id: "id1", ...}, %Pointer{id: "id2", ...}]
@@ -961,8 +961,8 @@ list_by_type!(table_id_or_schema, filters \
Examples
-iex> Bonfire.Common.Needles.list_by_type!(:my_table, [filter: value])
-[%Pointer{...}, %Pointer{...}]
+iex> Bonfire.Common.Needles.list_by_type!(:my_table, [filter: value])
+[%Pointer{...}, %Pointer{...}]
@@ -990,8 +990,8 @@ list_ids()
Examples
-iex> Bonfire.Common.Needles.list_ids()
-["id1", "id2"]
+iex> Bonfire.Common.Needles.list_ids()
+["id1", "id2"]
@@ -1023,11 +1023,11 @@ many(filters \\ [], opts \\ [])
Examples
-iex> Bonfire.Common.Needles.many([id: "some_id"])
-{:ok, [%Pointer{id: "some_id", ...}]}
+iex> Bonfire.Common.Needles.many([id: "some_id"])
+{:ok, [%Pointer{id: "some_id", ...}]}
-iex> Bonfire.Common.Needles.many([id: "non_existing_id"])
-{:ok, []}
+iex> Bonfire.Common.Needles.many([id: "non_existing_id"])
+{:ok, []}
@@ -1053,8 +1053,8 @@ many!(filters \\ [], opts \\ [])
-Retrieves many objects based on the provided filters
iex> Bonfire.Common.Needles.many!([id: "some_id"])
-[%Pointer{id: "some_id", ...}]
+Retrieves many objects based on the provided filters
iex> Bonfire.Common.Needles.many!([id: "some_id"])
+[%Pointer{id: "some_id", ...}]
@@ -1082,13 +1082,13 @@ maybe_forge(thing)
Examples
-iex> Bonfire.Common.Needles.maybe_forge(%Pointer{id: "existing_id"})
-%Pointer{id: "existing_id"}
+iex> Bonfire.Common.Needles.maybe_forge(%Pointer{id: "existing_id"})
+%Pointer{id: "existing_id"}
-iex> Bonfire.Common.Needles.maybe_forge(%{pointer_id: "existing_id"})
-%Pointer{id: "existing_id"}
+iex> Bonfire.Common.Needles.maybe_forge(%{pointer_id: "existing_id"})
+%Pointer{id: "existing_id"}
-iex> Bonfire.Common.Needles.maybe_forge(%{id: "existing_id"})
+iex> Bonfire.Common.Needles.maybe_forge(%{id: "existing_id"})
nil
@@ -1111,13 +1111,13 @@ maybe_forge!(thing)
-Turns a thing into a pointer if it is not already. Errors if it cannot be performed.
iex> Bonfire.Common.Needles.maybe_forge!(%Pointer{id: "existing_id"})
-%Pointer{id: "existing_id"}
+Turns a thing into a pointer if it is not already. Errors if it cannot be performed.
iex> Bonfire.Common.Needles.maybe_forge!(%Pointer{id: "existing_id"})
+%Pointer{id: "existing_id"}
-iex> Bonfire.Common.Needles.maybe_forge!(%{pointer_id: "existing_id"})
-%Pointer{id: "existing_id"}
+iex> Bonfire.Common.Needles.maybe_forge!(%{pointer_id: "existing_id"})
+%Pointer{id: "existing_id"}
-iex> Bonfire.Common.Needles.maybe_forge!(%{id: "non_existing_id"})
+iex> Bonfire.Common.Needles.maybe_forge!(%{id: "non_existing_id"})
** (RuntimeError) ...
@@ -1146,8 +1146,8 @@ maybe_resolve(parent, field, args, context)
Examples
-iex> Bonfire.Common.Needles.maybe_resolve(parent, field, args, context)
-{:ok, resolved_data}
+iex> Bonfire.Common.Needles.maybe_resolve(parent, field, args, context)
+{:ok, resolved_data}
@@ -1177,11 +1177,11 @@ one(id, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.get("some_id")
-{:ok, %Pointer{id: "some_id", ...}}
+iex> Bonfire.Common.Needles.get("some_id")
+{:ok, %Pointer{id: "some_id", ...}}
-iex> Bonfire.Common.Needles.get([id: "some_id"])
-{:ok, %Pointer{id: "existing_id", ...}}
+iex> Bonfire.Common.Needles.get([id: "some_id"])
+{:ok, %Pointer{id: "existing_id", ...}}
@@ -1205,11 +1205,11 @@ one!(filters, opts \\ [])
-Retrieves a single object based on the provided filters with bang.
iex> Bonfire.Common.Needles.one!("some_id")
-%Pointer{id: "some_id", ...}
+Retrieves a single object based on the provided filters with bang.
iex> Bonfire.Common.Needles.one!("some_id")
+%Pointer{id: "some_id", ...}
-iex> Bonfire.Common.Needles.one!([id: "some_id"])
-%Pointer{id: "some_id", ...}
+iex> Bonfire.Common.Needles.one!([id: "some_id"])
+%Pointer{id: "some_id", ...}
@@ -1237,11 +1237,11 @@ pointer_preloads(query, preloads)
Examples
-iex> Bonfire.Common.Needles.pointer_preloads(query, :with_creator)
-%Ecto.Query{...}
+iex> Bonfire.Common.Needles.pointer_preloads(query, :with_creator)
+%Ecto.Query{...}
-iex> Bonfire.Common.Needles.pointer_preloads(query, :tags)
-%Ecto.Query{...}
+iex> Bonfire.Common.Needles.pointer_preloads(query, :tags)
+%Ecto.Query{...}
@@ -1269,11 +1269,11 @@ pointer_query(q, opts)
Examples
-iex> Bonfire.Common.Needles.pointer_query(query, opts)
-%Ecto.Query{...}
+iex> Bonfire.Common.Needles.pointer_query(query, opts)
+%Ecto.Query{...}
-iex> Bonfire.Common.Needles.pointer_query([id: "some_id"], opts)
-%Ecto.Query{...}
+iex> Bonfire.Common.Needles.pointer_query([id: "some_id"], opts)
+%Ecto.Query{...}
@@ -1304,11 +1304,11 @@ preload!(pointer_or_pointers, opts \\ [])
-
Follows one or more pointers and adds the pointed records to the pointed attrs.
iex> Bonfire.Common.Needles.preload!(%Pointer{id: "some_id"})
-%Pointer{id: "some_id", pointed: %SomeRecord{}}
+Follows one or more pointers and adds the pointed records to the pointed attrs.
iex> Bonfire.Common.Needles.preload!(%Pointer{id: "some_id"})
+%Pointer{id: "some_id", pointed: %SomeRecord{}}
-iex> Bonfire.Common.Needles.preload!([%Pointer{id: "some_id"}])
-[%Pointer{id: "some_id", pointed: %SomeRecord{}}]
+iex> Bonfire.Common.Needles.preload!([%Pointer{id: "some_id"}])
+[%Pointer{id: "some_id", pointed: %SomeRecord{}}]
@@ -1338,8 +1338,8 @@ query(schema, filters, opts \\ [])
Examples
-iex> Bonfire.Common.Needles.query(filters)
-%Ecto.Query{...}
+iex> Bonfire.Common.Needles.query(filters)
+%Ecto.Query{...}
diff --git a/Bonfire.Common.Opts.html b/Bonfire.Common.Opts.html
index 018ceff2b6..f88645fe98 100644
--- a/Bonfire.Common.Opts.html
+++ b/Bonfire.Common.Opts.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Opts — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Opts — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Opts
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -215,28 +215,28 @@ maybe_from_opts(opts, key, fallback \\ nil)
Examples
-iex> maybe_from_opts([key: "value"], :key, "default")
+iex> maybe_from_opts([key: "value"], :key, "default")
"value"
-iex> maybe_from_opts([key: nil], :key, "default")
+iex> maybe_from_opts([key: nil], :key, "default")
"default"
-iex> maybe_from_opts(%{key: "value"}, :key, "default")
+iex> maybe_from_opts(%{key: "value"}, :key, "default")
"value"
-iex> maybe_from_opts(%{missing_key: "value"}, :key, "default")
+iex> maybe_from_opts(%{missing_key: "value"}, :key, "default")
"default"
-iex> maybe_from_opts([context: %{key: "value"}], :key, "default")
+iex> maybe_from_opts([context: %{key: "value"}], :key, "default")
"value"
-iex> maybe_from_opts([context: %{key: "value"}], :key, "default")
+iex> maybe_from_opts([context: %{key: "value"}], :key, "default")
"value"
-iex> maybe_from_opts(%{context: %{key: "value"}}, :key, "default")
+iex> maybe_from_opts(%{context: %{key: "value"}}, :key, "default")
"value"
-iex> maybe_from_opts(%{context: %{key: "value"}}, :key, "default")
+iex> maybe_from_opts(%{context: %{key: "value"}}, :key, "default")
"value"
@@ -265,26 +265,26 @@ to_options(user_or_socket_or_opts)
Examples
-iex> to_options(%{assigns: %{user: "user_data"}})
-[user: "user_data"]
+iex> to_options(%{assigns: %{user: "user_data"}})
+[user: "user_data"]
-iex> to_options(%Bonfire.Data.Identity.User{})
-[current_user: %Bonfire.Data.Identity.User{}]
+iex> to_options(%Bonfire.Data.Identity.User{})
+[current_user: %Bonfire.Data.Identity.User{}]
-iex> to_options(%{key: "value"})
-[key: "value"]
+iex> to_options(%{key: "value"})
+[key: "value"]
-iex> to_options({:key, "value"})
-[key: "value"]
+iex> to_options({:key, "value"})
+[key: "value"]
-iex> to_options([{:key, "value"}])
-[{:key, "value"}]
+iex> to_options([{:key, "value"}])
+[{:key, "value"}]
-iex> to_options(%{other: "data"})
-[other: "data"]
+iex> to_options(%{other: "data"})
+[other: "data"]
-iex> to_options(%{"non_existing_other"=> "data"})
-[__item_discarded__: true]
+iex> to_options(%{"non_existing_other"=> "data"})
+[__item_discarded__: true]
diff --git a/Bonfire.Common.PubSub.Event.html b/Bonfire.Common.PubSub.Event.html
index 1adfa2a40f..f60ad2e29b 100644
--- a/Bonfire.Common.PubSub.Event.html
+++ b/Bonfire.Common.PubSub.Event.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.PubSub.Event — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.PubSub.Event — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.PubSub.Event
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.PubSub.html b/Bonfire.Common.PubSub.html
index 7731075476..9413e7b7da 100644
--- a/Bonfire.Common.PubSub.html
+++ b/Bonfire.Common.PubSub.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.PubSub — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.PubSub — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.PubSub
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.QueryModule.html b/Bonfire.Common.QueryModule.html
index 1c63d0c45d..49e54be65b 100644
--- a/Bonfire.Common.QueryModule.html
+++ b/Bonfire.Common.QueryModule.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.QueryModule — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.QueryModule — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.QueryModule behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Repo.Delete.html b/Bonfire.Common.Repo.Delete.html
index 287ef316e8..3679b536aa 100644
--- a/Bonfire.Common.Repo.Delete.html
+++ b/Bonfire.Common.Repo.Delete.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Repo.Delete — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Repo.Delete — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Repo.Delete
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -335,11 +335,11 @@ hard_delete(it)
Examples
-iex> hard_delete(some_entry)
-{:ok, some_entry}
+iex> hard_delete(some_entry)
+{:ok, some_entry}
-iex> hard_delete(non_existent_entry)
-{:error, :deletion_error}
+iex> hard_delete(non_existent_entry)
+{:error, :deletion_error}
@@ -373,10 +373,10 @@ hard_delete!(it)
Examples
-iex> hard_delete!(some_entry)
+iex> hard_delete!(some_entry)
some_entry
-iex> hard_delete!(non_existent_entry)
+iex> hard_delete!(non_existent_entry)
** (RuntimeError) :deletion_error
@@ -455,11 +455,11 @@ soft_delete(it)
Examples
-iex> soft_delete(some_entry)
-{:ok, some_entry}
+iex> soft_delete(some_entry)
+{:ok, some_entry}
-iex> soft_delete(non_existent_entry)
-{:error, :deletion_error}
+iex> soft_delete(non_existent_entry)
+{:error, :deletion_error}
@@ -493,10 +493,10 @@ soft_delete!(it)
Examples
-iex> soft_delete!(some_entry)
+iex> soft_delete!(some_entry)
some_entry
-iex> soft_delete!(non_existent_entry)
+iex> soft_delete!(non_existent_entry)
** (RuntimeError) :deletion_error
@@ -531,11 +531,11 @@ soft_delete_changeset(it, column \\ :delete
Examples
-iex> soft_delete_changeset(some_entry)
-%Ecto.Changeset{...}
+iex> soft_delete_changeset(some_entry)
+%Ecto.Changeset{...}
-iex> soft_delete_changeset({SomeSchema, some_entry}, :deleted_at, nil, "was already deleted")
-%Ecto.Changeset{...}
+iex> soft_delete_changeset({SomeSchema, some_entry}, :deleted_at, nil, "was already deleted")
+%Ecto.Changeset{...}
@@ -563,11 +563,11 @@ undelete(it)
Examples
-iex> undelete(some_entry)
-{:ok, some_entry}
+iex> undelete(some_entry)
+{:ok, some_entry}
-iex> undelete(non_existent_entry)
-{:error, :deletion_error}
+iex> undelete(non_existent_entry)
+{:error, :deletion_error}
diff --git a/Bonfire.Common.Repo.Filter.html b/Bonfire.Common.Repo.Filter.html
index 38d8ecd71d..9e1a872864 100644
--- a/Bonfire.Common.Repo.Filter.html
+++ b/Bonfire.Common.Repo.Filter.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Repo.Filter — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Repo.Filter — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,20 +132,20 @@
Bonfire.Common.Repo.Filter
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
-query_filter brings convenience and shortens the boilterplate of ecto queries
Common filters available include:
preload - Preloads fields onto the query resultsstart_date - Query for items inserted after this dateend_date - Query for items inserted before this datebefore - Get items with IDs before this valueafter - Get items with IDs after this valueids - Get items with a list of idsfirst - Gets the first n itemslast - Gets the last n itemslimit - Gets the first n itemsoffset - Offsets limit by n itemssearch - Warning: This requires schemas using this to have a &by_search(query, val) function
You are also able to filter on any natural field of a model, as well as use
- gte/gt
- lte/lt
- like/ilike
- is_nil/not(is_nil)
query_filter(User, %{name: %{ilike: "steve"}})
-query_filter(User, %{name: %{ilike: "steve"}}, :last_name, :asc)
-query_filter(User, %{name: %{age: %{gte: 18, lte: 30}}})
-query_filter(User, %{name: %{is_banned: %{!=: nil}}})
-query_filter(User, %{name: %{is_banned: %{==: nil}}})
-
-my_query = query_filter(User, %{name: "Billy"})
-query_filter(my_query, %{last_name: "Joe"})
+query_filter brings convenience and shortens the boilterplate of ecto queries
Common filters available include:
preload - Preloads fields onto the query resultsstart_date - Query for items inserted after this dateend_date - Query for items inserted before this datebefore - Get items with IDs before this valueafter - Get items with IDs after this valueids - Get items with a list of idsfirst - Gets the first n itemslast - Gets the last n itemslimit - Gets the first n itemsoffset - Offsets limit by n itemssearch - Warning: This requires schemas using this to have a &by_search(query, val) function
You are also able to filter on any natural field of a model, as well as use
- gte/gt
- lte/lt
- like/ilike
- is_nil/not(is_nil)
query_filter(User, %{name: %{ilike: "steve"}})
+query_filter(User, %{name: %{ilike: "steve"}}, :last_name, :asc)
+query_filter(User, %{name: %{age: %{gte: 18, lte: 30}}})
+query_filter(User, %{name: %{is_banned: %{!=: nil}}})
+query_filter(User, %{name: %{is_banned: %{==: nil}}})
+
+my_query = query_filter(User, %{name: "Billy"})
+query_filter(my_query, %{last_name: "Joe"})
diff --git a/Bonfire.Common.Repo.Preload.html b/Bonfire.Common.Repo.Preload.html
index 4dcb632c17..21193df353 100644
--- a/Bonfire.Common.Repo.Preload.html
+++ b/Bonfire.Common.Repo.Preload.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Repo.Preload — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Repo.Preload — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Repo.Preload
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -255,11 +255,11 @@ maybe_preload(obj, preloads, opts \\ [])
Examples
-iex> maybe_preload(some_struct, [:assoc1, :assoc2])
-%{...}
+iex> maybe_preload(some_struct, [:assoc1, :assoc2])
+%{...}
-iex> maybe_preload({:ok, some_struct}, [:assoc1, :assoc2])
-{:ok, %{...}}
+iex> maybe_preload({:ok, some_struct}, [:assoc1, :assoc2])
+{:ok, %{...}}
@@ -289,8 +289,8 @@ maybe_preloads_per_nested_schema(objects, p
Examples
-iex> maybe_preloads_per_nested_schema(objects, path, preloads)
-[%{...}, %{...}]
+iex> maybe_preloads_per_nested_schema(objects, path, preloads)
+[%{...}, %{...}]
@@ -320,9 +320,9 @@ maybe_preloads_per_schema(object, schema_pr
Examples
-iex> maybe_preloads_per_schema(some_struct, {Schema, [:assoc1, :assoc2]})
+iex> maybe_preloads_per_schema(some_struct, {Schema, [:assoc1, :assoc2]})
-iex> maybe_preloads_per_schema(pointer_struct, {PointerSchema, [:assoc1, :assoc2]})
+iex> maybe_preloads_per_schema(pointer_struct, {PointerSchema, [:assoc1, :assoc2]})
@@ -352,7 +352,7 @@ preload_all(structure, opts \\ [])
Examples
-iex> preload_all(some_struct)
+iex> preload_all(some_struct)
@@ -382,7 +382,7 @@ preload_mixins(structure, opts \\ [])
Examples
-iex> preload_mixins(some_struct)
+iex> preload_mixins(some_struct)
@@ -410,8 +410,8 @@ schema_mixins(structure)
Examples
-iex> schema_mixins(some_struct)
-[:assoc1, :assoc2]
+iex> schema_mixins(some_struct)
+[:assoc1, :assoc2]
diff --git a/Bonfire.Common.Repo.Utils.html b/Bonfire.Common.Repo.Utils.html
index 6525f639d2..3f7555047c 100644
--- a/Bonfire.Common.Repo.Utils.html
+++ b/Bonfire.Common.Repo.Utils.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Repo.Utils — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Repo.Utils — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Repo.Utils
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Repo.html b/Bonfire.Common.Repo.html
index 6e2ffbdfd6..3dcf16e419 100644
--- a/Bonfire.Common.Repo.html
+++ b/Bonfire.Common.Repo.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Repo — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Repo — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Repo
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -1214,8 +1214,8 @@ delete_many(query)
Examples
-iex> delete_many(from u in User, where: u.id < 100)
-{:ok, _count}
+iex> delete_many(from u in User, where: u.id < 100)
+{:ok, _count}
@@ -1323,11 +1323,11 @@ fetch(queryable, id)
Examples
-iex> fetch(User, 1)
-{:ok, %User{}}
+iex> fetch(User, 1)
+{:ok, %User{}}
-iex> fetch(User, 999)
-{:error, :not_found}
+iex> fetch(User, 999)
+{:error, :not_found}
@@ -1355,11 +1355,11 @@ fetch_all(queryable, id_or_ids)
Examples
-iex> fetch_all(User, [1, 2, 3])
-[%User{}, %User{}, %User{}]
+iex> fetch_all(User, [1, 2, 3])
+[%User{}, %User{}, %User{}]
-iex> fetch_all(User, 999)
-[]
+iex> fetch_all(User, 999)
+[]
@@ -1387,11 +1387,11 @@ fetch_by(queryable, term)
Examples
-iex> fetch_by(User, name: "Alice")
-{:ok, %User{}}
+iex> fetch_by(User, name: "Alice")
+{:ok, %User{}}
-iex> fetch_by(User, name: "Nonexistent")
-{:error, :not_found}
+iex> fetch_by(User, name: "Nonexistent")
+{:error, :not_found}
@@ -1421,13 +1421,13 @@ find(q, changeset, field \\ :form)
Examples
-iex> changeset = %Ecto.Changeset{}
-iex> find(from u in User, where: u.id == 1, changeset)
-{:ok, %User{}}
+iex> changeset = %Ecto.Changeset{}
+iex> find(from u in User, where: u.id == 1, changeset)
+{:ok, %User{}}
-iex> changeset = %Ecto.Changeset{}
-iex> find(from u in User, where: u.id == 999, changeset)
-{:error, %Ecto.Changeset{}}
+iex> changeset = %Ecto.Changeset{}
+iex> find(from u in User, where: u.id == 999, changeset)
+{:error, %Ecto.Changeset{}}
@@ -1667,8 +1667,8 @@ insert_all_or_ignore(schema, data)
Examples
-iex> insert_all_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
-{:ok, _result}
+iex> insert_all_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
+{:ok, _result}
@@ -1696,11 +1696,11 @@ insert_or_ignore(cs_or_struct)
Examples
-iex> insert_or_ignore(%Ecto.Changeset{})
-{:ok, _result}
+iex> insert_or_ignore(%Ecto.Changeset{})
+{:ok, _result}
-iex> insert_or_ignore(%MySchema{field: "value"})
-{:ok, _result}
+iex> insert_or_ignore(%MySchema{field: "value"})
+{:ok, _result}
@@ -1728,11 +1728,11 @@ insert_or_ignore(schema, object)
Examples
-iex> insert_or_ignore(MySchema, %{field: "value"})
-[{:ok, _result}]
+iex> insert_or_ignore(MySchema, %{field: "value"})
+[{:ok, _result}]
-iex> insert_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
-[{:ok, _result}]
+iex> insert_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
+[{:ok, _result}]
@@ -1854,11 +1854,11 @@ many(query, opts \\ [])
Examples
-iex> many(from u in User)
-[%User{}, %User{}]
+iex> many(from u in User)
+[%User{}, %User{}]
-iex> many(from u in User, return: :query)
-#Ecto.Query<...>
+iex> many(from u in User, return: :query)
+#Ecto.Query<...>
@@ -1891,8 +1891,8 @@ many_paginated(queryable, opts \\ [], repo_
Examples
-iex> many_paginated(User, [limit: 10])
-%Paginator.Page{}
+iex> many_paginated(User, [limit: 10])
+%Paginator.Page{}
@@ -1922,10 +1922,10 @@ maybe_one(q, fallback \\ nil)
Examples
-iex> maybe_one(from u in User, where: u.id == 1)
-%User{}
+iex> maybe_one(from u in User, where: u.id == 1)
+%User{}
-iex> maybe_one(from u in User, where: u.id == 999, "fallback")
+iex> maybe_one(from u in User, where: u.id == 999, "fallback")
"fallback"
@@ -1982,10 +1982,10 @@ maybe_where_ilike(query, field, user_query,
Examples
-iex> maybe_where_ilike(Needle.Pointer, :id, "Alice")
-#Ecto.Query<...>
+iex> maybe_where_ilike(Needle.Pointer, :id, "Alice")
+#Ecto.Query<...>
-iex> maybe_where_ilike(Needle.Pointer, :id, "Al%ice")
+iex> maybe_where_ilike(Needle.Pointer, :id, "Al%ice")
Needle.Pointer
# ^ unchanged due to unsafe query
@@ -2087,8 +2087,8 @@ paginate(pageable, options \\ [])
Examples
-iex> paginate(User, page: 1, page_size: 10)
-%Scrivener.Page{}
+iex> paginate(User, page: 1, page_size: 10)
+%Scrivener.Page{}
@@ -2118,11 +2118,11 @@ pluck(query, fields, opts \\ [])
Examples
-> pluck(:id)
-[id1, id2]
+> pluck(:id)
+[id1, id2]
-> pluck([:id, :inserted_at])
-[%{id: id1, inserted_at: _}, %{id: id2, inserted_at: _}]
+> pluck([:id, :inserted_at])
+[%{id: id1, inserted_at: _}, %{id: id2, inserted_at: _}]
@@ -2245,9 +2245,9 @@ put(changeset)
Examples
-iex> changeset = %Ecto.Changeset{valid?: false}
-iex> put(changeset)
-{:error, %Ecto.Changeset{}}
+iex> changeset = %Ecto.Changeset{valid?: false}
+iex> put(changeset)
+{:error, %Ecto.Changeset{}}
@@ -2297,13 +2297,13 @@ put_many(things)
Examples
-iex> changesets = [%{valid?: true}, %{valid?: false}]
-iex> put_many(changesets)
-{:error, [%{valid?: false}]}
+iex> changesets = [%{valid?: true}, %{valid?: false}]
+iex> put_many(changesets)
+{:error, [%{valid?: false}]}
-iex> changesets = [%{valid?: true}, %{valid?: true}]
-iex> put_many(changesets)
-{:ok, _result}
+iex> changesets = [%{valid?: true}, %{valid?: true}]
+iex> put_many(changesets)
+{:ok, _result}
@@ -2511,11 +2511,11 @@ single(q)
Examples
-iex> single(from u in User, where: u.id == 1)
-{:ok, %User{}}
+iex> single(from u in User, where: u.id == 1)
+{:ok, %User{}}
-iex> single(from u in User, where: u.id == 999)
-{:error, :not_found}
+iex> single(from u in User, where: u.id == 999)
+{:error, :not_found}
@@ -2547,7 +2547,7 @@ sql(raw_sql, data \\ [], opts \\ [])
Examples
-> YourModule.sql("SELECT * FROM pointers")
+> YourModule.sql("SELECT * FROM pointers")
@@ -2669,8 +2669,8 @@ trace(fun)
Examples
-iex> trace(fn -> Repo.all(User) end)
-[%User{}, %User{}]
+iex> trace(fn -> Repo.all(User) end)
+[%User{}, %User{}]
@@ -2723,10 +2723,10 @@ transact_with(fun, opts \\ [])
Examples
-iex> transact_with(fn -> {:ok, "success"} end)
+iex> transact_with(fn -> {:ok, "success"} end)
"success"
-iex> transact_with(fn -> {:error, "failure"} end)
+iex> transact_with(fn -> {:error, "failure"} end)
** (Ecto.RollbackError) Rolling back the DB transaction, error reason: failure
@@ -2855,11 +2855,11 @@ upsert(cs, keys_or_attrs_to_update \\ nil,
Examples
-iex> upsert(%Ecto.Changeset{}, [:field1, :field2])
-{:ok, _result}
+iex> upsert(%Ecto.Changeset{}, [:field1, :field2])
+{:ok, _result}
-iex> upsert(%Ecto.Changeset{}, %{field1: "value"})
-{:ok, _result}
+iex> upsert(%Ecto.Changeset{}, %{field1: "value"})
+{:ok, _result}
@@ -2889,11 +2889,11 @@ upsert_all(schema, data, conflict_target \\
Examples
-iex> upsert_all(User, [%{id: 1, name: "Alice"}, %{id: 2, name: "Bob"}])
-{:ok, _result}
+iex> upsert_all(User, [%{id: 1, name: "Alice"}, %{id: 2, name: "Bob"}])
+{:ok, _result}
-iex> upsert_all(User, [%{id: 1, name: "Alice Updated"}], [:id])
-{:ok, _result}
+iex> upsert_all(User, [%{id: 1, name: "Alice Updated"}], [:id])
+{:ok, _result}
diff --git a/Bonfire.Common.RepoTemplate.html b/Bonfire.Common.RepoTemplate.html
index 8de9fc5aa7..1be3be9fd4 100644
--- a/Bonfire.Common.RepoTemplate.html
+++ b/Bonfire.Common.RepoTemplate.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.RepoTemplate — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.RepoTemplate — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.RepoTemplate
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.RuntimeConfig.html b/Bonfire.Common.RuntimeConfig.html
index 6b1f978eda..edfe74158a 100644
--- a/Bonfire.Common.RuntimeConfig.html
+++ b/Bonfire.Common.RuntimeConfig.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.RuntimeConfig — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.RuntimeConfig — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.RuntimeConfig
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.SchemaModule.html b/Bonfire.Common.SchemaModule.html
index d792a7bf4c..de444e24a9 100644
--- a/Bonfire.Common.SchemaModule.html
+++ b/Bonfire.Common.SchemaModule.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.SchemaModule — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.SchemaModule — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.SchemaModule behaviour
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Settings.LiveHandler.html b/Bonfire.Common.Settings.LiveHandler.html
index 92ba4dff32..bbfffc3aea 100644
--- a/Bonfire.Common.Settings.LiveHandler.html
+++ b/Bonfire.Common.Settings.LiveHandler.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Settings.LiveHandler — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Settings.LiveHandler — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Settings.LiveHandler
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Settings.LoadInstanceConfig.html b/Bonfire.Common.Settings.LoadInstanceConfig.html
index e056dc923c..3646b6bdf6 100644
--- a/Bonfire.Common.Settings.LoadInstanceConfig.html
+++ b/Bonfire.Common.Settings.LoadInstanceConfig.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Settings.LoadInstanceConfig — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Settings.LoadInstanceConfig — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Settings.LoadInstanceConfig
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Settings.html b/Bonfire.Common.Settings.html
index 4bc73177f7..3ebf1897b1 100644
--- a/Bonfire.Common.Settings.html
+++ b/Bonfire.Common.Settings.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Settings — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Settings — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Settings
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -316,28 +316,28 @@ get(key, default \\ nil, opts \\ [])
Examples
-iex> get(:test_key)
+iex> get(:test_key)
"test_value"
-iex> get([:non_existing_extension, :sub_key])
+iex> get([:non_existing_extension, :sub_key])
nil
-iex> get(:non_existing_key, "default")
+iex> get(:non_existing_key, "default")
"default"
-iex> get(:otp_app)
+iex> get(:otp_app)
:bonfire
-iex> get([:bonfire_common, :otp_app])
+iex> get([:bonfire_common, :otp_app])
:bonfire
-iex> get([:bonfire_common, :otp_app])
+iex> get([:bonfire_common, :otp_app])
:bonfire
-iex> get([Bonfire.Common.Localise.Cldr, :gettext])
+iex> get([Bonfire.Common.Localise.Cldr, :gettext])
Bonfire.Common.Localise.Gettext
-iex> get([:bonfire_common, Bonfire.Common.Localise.Cldr, :gettext])
+iex> get([:bonfire_common, Bonfire.Common.Localise.Cldr, :gettext])
Bonfire.Common.Localise.Gettext
@@ -374,10 +374,10 @@ get!(key, opts \\ [])
Examples
-iex> get!(:test_key)
+iex> get!(:test_key)
"test_value"
-iex> get!(:non_existing_key)
+iex> get!(:non_existing_key)
** (RuntimeError) Missing setting or configuration value: :non_existing_key
@@ -475,16 +475,16 @@ put(keys, value, opts \\ [])
Examples
# when no scope or current_user are passed in opts:
-> put(:some_key, "new_value")
-{:error, "You need to be authenticated to change settings."}
+> put(:some_key, "new_value")
+{:error, "You need to be authenticated to change settings."}
# when the scope is :instance but an admin isn't passed as current_user in opts:
-> put(:some_key, "new_value", scope: :instance)
+> put(:some_key, "new_value", scope: :instance)
** (Bonfire.Fail) You do not have permission to change instance settings. Please contact an admin.
-> {:ok, %Bonfire.Data.Identity.Settings{}} = put(:some_key, "new_value", skip_boundary_check: true, scope: :instance)
+> {:ok, %Bonfire.Data.Identity.Settings{}} = put(:some_key, "new_value", skip_boundary_check: true, scope: :instance)
-> {:ok, %Bonfire.Data.Identity.Settings{}} = put([:top_key, :sub_key], "new_value", skip_boundary_check: true, scope: "instance")
+
> {:ok, %Bonfire.Data.Identity.Settings{}} = put([:top_key, :sub_key], "new_value", skip_boundary_check: true, scope: "instance")
@@ -518,8 +518,8 @@ reset_all()
Examples
-> reset_all()
-{:ok, %{}}
+> reset_all()
+{:ok, %{}}
@@ -547,8 +547,8 @@ reset_instance()
Examples
-> reset_instance()
-{:ok, %Bonfire.Data.Identity.Settings{id: "some_id"}}
+> reset_instance()
+{:ok, %Bonfire.Data.Identity.Settings{id: "some_id"}}
@@ -578,9 +578,9 @@ set(attrs, opts \\ [])
Examples
-> {:ok, %Bonfire.Data.Identity.Settings{}} = set(%{some_key: "value", another_key: "another_value"}, skip_boundary_check: true, scope: :instance)
+> {:ok, %Bonfire.Data.Identity.Settings{}} = set(%{some_key: "value", another_key: "another_value"}, skip_boundary_check: true, scope: :instance)
-> {:ok, %Bonfire.Data.Identity.Settings{}} = set([some_key: "value", another_key: "another_value"], skip_boundary_check: true, scope: "instance")
+
> {:ok, %Bonfire.Data.Identity.Settings{}} = set([some_key: "value", another_key: "another_value"], skip_boundary_check: true, scope: "instance")
diff --git a/Bonfire.Common.Simulation.html b/Bonfire.Common.Simulation.html
index ca7e9926b2..154fcef802 100644
--- a/Bonfire.Common.Simulation.html
+++ b/Bonfire.Common.Simulation.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Simulation — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Simulation — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Simulation
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.StartupTimer.html b/Bonfire.Common.StartupTimer.html
index de31aaa8e3..5dbbb0e4a6 100644
--- a/Bonfire.Common.StartupTimer.html
+++ b/Bonfire.Common.StartupTimer.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.StartupTimer — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.StartupTimer — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.StartupTimer
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Test.Interactive.Helpers.html b/Bonfire.Common.Test.Interactive.Helpers.html
index 08bfd5df77..97ecdad8a5 100644
--- a/Bonfire.Common.Test.Interactive.Helpers.html
+++ b/Bonfire.Common.Test.Interactive.Helpers.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Test.Interactive.Helpers — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Test.Interactive.Helpers — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Test.Interactive.Helpers
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Test.Interactive.Observer.html b/Bonfire.Common.Test.Interactive.Observer.html
index 4e1f07f92d..9a21484d59 100644
--- a/Bonfire.Common.Test.Interactive.Observer.html
+++ b/Bonfire.Common.Test.Interactive.Observer.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Test.Interactive.Observer — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Test.Interactive.Observer — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Test.Interactive.Observer
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
diff --git a/Bonfire.Common.Test.Interactive.html b/Bonfire.Common.Test.Interactive.html
index 1dbbbefffa..913d6fdd17 100644
--- a/Bonfire.Common.Test.Interactive.html
+++ b/Bonfire.Common.Test.Interactive.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Test.Interactive — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Test.Interactive — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Test.Interactive
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -142,11 +142,11 @@
fcwatch | mix test --stale --listen-on-stdin to watch for
code changes and run stale tests, but with more control and
without the starting time penalty.
Note that watching requires fswatch on your system.
-Eg on Mac run brew install fswatch.
To use it, in your project's .iex file add:
unless GenServer.whereis(Bonfire.Common.Test.Interactive) do
- {:ok, pid} = Bonfire.Common.Test.Interactive.start_link()
+Eg on Mac run brew install fswatch.To use it, in your project's .iex file add:
unless GenServer.whereis(Bonfire.Common.Test.Interactive) do
+ {:ok, pid} = Bonfire.Common.Test.Interactive.start_link()
# Process will not exit when the iex goes out
- Process.unlink(pid)
-end
+ Process.unlink(pid)
+end
import Bonfire.Common.Test.Interactive.Helpers
Then to call iex and run tests just do:
MIX_ENV=test iex -S mix
The Bonfire.Common.Test.Interactive.Helpers allows to call f and s and a
to run failed, stale and all tests respectively.
You can call w to watch tests and uw to unwatch.
diff --git a/Bonfire.Common.TestInstanceRepo.html b/Bonfire.Common.TestInstanceRepo.html
index ba720f8039..a89be3c6b7 100644
--- a/Bonfire.Common.TestInstanceRepo.html
+++ b/Bonfire.Common.TestInstanceRepo.html
@@ -5,10 +5,10 @@
-
+
-
Bonfire.Common.TestInstanceRepo — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.TestInstanceRepo — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.TestInstanceRepo
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -1312,8 +1312,8 @@ delete_many(query)
Examples
-iex> delete_many(from u in User, where: u.id < 100)
-{:ok, _count}
+iex> delete_many(from u in User, where: u.id < 100)
+{:ok, _count}
@@ -1421,11 +1421,11 @@ fetch(queryable, id)
Examples
-iex> fetch(User, 1)
-{:ok, %User{}}
+iex> fetch(User, 1)
+{:ok, %User{}}
-iex> fetch(User, 999)
-{:error, :not_found}
+iex> fetch(User, 999)
+{:error, :not_found}
@@ -1453,11 +1453,11 @@ fetch_all(queryable, id_or_ids)
Examples
-iex> fetch_all(User, [1, 2, 3])
-[%User{}, %User{}, %User{}]
+iex> fetch_all(User, [1, 2, 3])
+[%User{}, %User{}, %User{}]
-iex> fetch_all(User, 999)
-[]
+iex> fetch_all(User, 999)
+[]
@@ -1485,11 +1485,11 @@ fetch_by(queryable, term)
Examples
-iex> fetch_by(User, name: "Alice")
-{:ok, %User{}}
+iex> fetch_by(User, name: "Alice")
+{:ok, %User{}}
-iex> fetch_by(User, name: "Nonexistent")
-{:error, :not_found}
+iex> fetch_by(User, name: "Nonexistent")
+{:error, :not_found}
@@ -1519,13 +1519,13 @@ find(q, changeset, field \\ :form)
Examples
-iex> changeset = %Ecto.Changeset{}
-iex> find(from u in User, where: u.id == 1, changeset)
-{:ok, %User{}}
+iex> changeset = %Ecto.Changeset{}
+iex> find(from u in User, where: u.id == 1, changeset)
+{:ok, %User{}}
-iex> changeset = %Ecto.Changeset{}
-iex> find(from u in User, where: u.id == 999, changeset)
-{:error, %Ecto.Changeset{}}
+iex> changeset = %Ecto.Changeset{}
+iex> find(from u in User, where: u.id == 999, changeset)
+{:error, %Ecto.Changeset{}}
@@ -1765,8 +1765,8 @@ insert_all_or_ignore(schema, data)
Examples
-iex> insert_all_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
-{:ok, _result}
+iex> insert_all_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
+{:ok, _result}
@@ -1794,11 +1794,11 @@ insert_or_ignore(cs_or_struct)
Examples
-iex> insert_or_ignore(%Ecto.Changeset{})
-{:ok, _result}
+iex> insert_or_ignore(%Ecto.Changeset{})
+{:ok, _result}
-iex> insert_or_ignore(%MySchema{field: "value"})
-{:ok, _result}
+iex> insert_or_ignore(%MySchema{field: "value"})
+{:ok, _result}
@@ -1826,11 +1826,11 @@ insert_or_ignore(schema, object)
Examples
-iex> insert_or_ignore(MySchema, %{field: "value"})
-[{:ok, _result}]
+iex> insert_or_ignore(MySchema, %{field: "value"})
+[{:ok, _result}]
-iex> insert_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
-[{:ok, _result}]
+iex> insert_or_ignore(MySchema, [%{field: "value1"}, %{field: "value2"}])
+[{:ok, _result}]
@@ -1952,11 +1952,11 @@ many(query, opts \\ [])
Examples
-iex> many(from u in User)
-[%User{}, %User{}]
+iex> many(from u in User)
+[%User{}, %User{}]
-iex> many(from u in User, return: :query)
-#Ecto.Query<...>
+iex> many(from u in User, return: :query)
+#Ecto.Query<...>
@@ -1989,8 +1989,8 @@ many_paginated(queryable, opts \\ [], repo_
Examples
-iex> many_paginated(User, [limit: 10])
-%Paginator.Page{}
+iex> many_paginated(User, [limit: 10])
+%Paginator.Page{}
@@ -2042,10 +2042,10 @@ maybe_one(q, fallback \\ nil)
Examples
-iex> maybe_one(from u in User, where: u.id == 1)
-%User{}
+iex> maybe_one(from u in User, where: u.id == 1)
+%User{}
-iex> maybe_one(from u in User, where: u.id == 999, "fallback")
+iex> maybe_one(from u in User, where: u.id == 999, "fallback")
"fallback"
@@ -2102,10 +2102,10 @@ maybe_where_ilike(query, field, user_query,
Examples
-iex> maybe_where_ilike(Needle.Pointer, :id, "Alice")
-#Ecto.Query<...>
+iex> maybe_where_ilike(Needle.Pointer, :id, "Alice")
+#Ecto.Query<...>
-iex> maybe_where_ilike(Needle.Pointer, :id, "Al%ice")
+iex> maybe_where_ilike(Needle.Pointer, :id, "Al%ice")
Needle.Pointer
# ^ unchanged due to unsafe query
@@ -2185,8 +2185,8 @@ paginate(pageable, options \\ [])
Examples
-iex> paginate(User, page: 1, page_size: 10)
-%Scrivener.Page{}
+iex> paginate(User, page: 1, page_size: 10)
+%Scrivener.Page{}
@@ -2216,11 +2216,11 @@ pluck(query, fields, opts \\ [])
Examples
-> pluck(:id)
-[id1, id2]
+> pluck(:id)
+[id1, id2]
-> pluck([:id, :inserted_at])
-[%{id: id1, inserted_at: _}, %{id: id2, inserted_at: _}]
+> pluck([:id, :inserted_at])
+[%{id: id1, inserted_at: _}, %{id: id2, inserted_at: _}]
@@ -2365,9 +2365,9 @@ put(changeset)
Examples
-iex> changeset = %Ecto.Changeset{valid?: false}
-iex> put(changeset)
-{:error, %Ecto.Changeset{}}
+iex> changeset = %Ecto.Changeset{valid?: false}
+iex> put(changeset)
+{:error, %Ecto.Changeset{}}
@@ -2417,13 +2417,13 @@ put_many(things)
Examples
-iex> changesets = [%{valid?: true}, %{valid?: false}]
-iex> put_many(changesets)
-{:error, [%{valid?: false}]}
+iex> changesets = [%{valid?: true}, %{valid?: false}]
+iex> put_many(changesets)
+{:error, [%{valid?: false}]}
-iex> changesets = [%{valid?: true}, %{valid?: true}]
-iex> put_many(changesets)
-{:ok, _result}
+iex> changesets = [%{valid?: true}, %{valid?: true}]
+iex> put_many(changesets)
+{:ok, _result}
@@ -2631,11 +2631,11 @@ single(q)
Examples
-iex> single(from u in User, where: u.id == 1)
-{:ok, %User{}}
+iex> single(from u in User, where: u.id == 1)
+{:ok, %User{}}
-iex> single(from u in User, where: u.id == 999)
-{:error, :not_found}
+iex> single(from u in User, where: u.id == 999)
+{:error, :not_found}
@@ -2667,7 +2667,7 @@ sql(raw_sql, data \\ [], opts \\ [])
Examples
-> YourModule.sql("SELECT * FROM pointers")
+> YourModule.sql("SELECT * FROM pointers")
@@ -2789,8 +2789,8 @@ trace(fun)
Examples
-iex> trace(fn -> Repo.all(User) end)
-[%User{}, %User{}]
+iex> trace(fn -> Repo.all(User) end)
+[%User{}, %User{}]
@@ -2843,10 +2843,10 @@ transact_with(fun, opts \\ [])
Examples
-iex> transact_with(fn -> {:ok, "success"} end)
+iex> transact_with(fn -> {:ok, "success"} end)
"success"
-iex> transact_with(fn -> {:error, "failure"} end)
+iex> transact_with(fn -> {:error, "failure"} end)
** (Ecto.RollbackError) Rolling back the DB transaction, error reason: failure
@@ -2975,11 +2975,11 @@ upsert(cs, keys_or_attrs_to_update \\ nil,
Examples
-iex> upsert(%Ecto.Changeset{}, [:field1, :field2])
-{:ok, _result}
+iex> upsert(%Ecto.Changeset{}, [:field1, :field2])
+{:ok, _result}
-iex> upsert(%Ecto.Changeset{}, %{field1: "value"})
-{:ok, _result}
+iex> upsert(%Ecto.Changeset{}, %{field1: "value"})
+{:ok, _result}
@@ -3009,11 +3009,11 @@ upsert_all(schema, data, conflict_target \\
Examples
-iex> upsert_all(User, [%{id: 1, name: "Alice"}, %{id: 2, name: "Bob"}])
-{:ok, _result}
+iex> upsert_all(User, [%{id: 1, name: "Alice"}, %{id: 2, name: "Bob"}])
+{:ok, _result}
-iex> upsert_all(User, [%{id: 1, name: "Alice Updated"}], [:id])
-{:ok, _result}
+iex> upsert_all(User, [%{id: 1, name: "Alice Updated"}], [:id])
+{:ok, _result}
diff --git a/Bonfire.Common.Text.html b/Bonfire.Common.Text.html
index 8908dca7d5..75550467b0 100644
--- a/Bonfire.Common.Text.html
+++ b/Bonfire.Common.Text.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Text — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Text — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Text
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -492,13 +492,13 @@ blank?(str_or_nil)
Examples
-iex> blank?(nil)
+iex> blank?(nil)
true
-iex> blank?(" ")
+iex> blank?(" ")
true
-iex> blank?("not blank")
+iex> blank?("not blank")
false
@@ -527,7 +527,7 @@ camelise(str)
Examples
-iex> camelise("hello world")
+iex> camelise("hello world")
"HelloWorld"
@@ -556,7 +556,7 @@ code_syntax(text, filename)
Examples
-> code_syntax("defmodule Test {}", "test.ex")
+> code_syntax("defmodule Test {}", "test.ex")
#=> "<pre><code class="highlight">defmodule Test {}</code></pre>"
@@ -585,10 +585,10 @@ contains?(string, substring)
Examples
-iex> contains?("hello world", "world")
+iex> contains?("hello world", "world")
true
-iex> contains?("hello world", "foo")
+iex> contains?("hello world", "foo")
false
@@ -617,10 +617,10 @@ contains_html?(string)
Examples
-iex> contains_html?("<div>Test</div>")
+iex> contains_html?("<div>Test</div>")
true
-iex> contains_html?("Just text")
+iex> contains_html?("Just text")
false
@@ -651,10 +651,10 @@ hash(seed, opts \\ [])
Examples
-iex> hash("data", algorithm: :sha256)
+iex> hash("data", algorithm: :sha256)
"Om6weQ85rIfJTzhWst0sXREOaBFgImGpqSPTuyOtyLc"
-iex> hash("data")
+iex> hash("data")
"jXd_OF09_siBXSD3SWAm3A"
@@ -683,7 +683,7 @@ list_checkboxes(text)
Examples
-> list_checkboxes("* [ ] task
- [x] done")
+
> list_checkboxes("* [ ] task
- [x] done")
[[" ", "task"], [" ", "done"]]
@@ -712,8 +712,8 @@ list_checked_boxes(text)
Examples
-> list_checked_boxes("* [x] done")
-[["done"]]
+> list_checked_boxes("* [x] done")
+[["done"]]
@@ -741,8 +741,8 @@ list_unchecked_boxes(text)
Examples
-> list_unchecked_boxes("* [ ] task")
-[["task"]]
+> list_unchecked_boxes("* [ ] task")
+[["task"]]
@@ -770,7 +770,7 @@ make_local_links_live(content)
Examples
-> make_local_links_live("<a href="/path">Link</a>")
+> make_local_links_live("<a href="/path">Link</a>")
"<a href="/path" data-phx-link="redirect" data-phx-link-state="push">Link</a>"
@@ -799,7 +799,7 @@ markdown_checkboxes(text)
Examples
-> markdown_checkboxes("* [ ] task
- [x] done")
+
> markdown_checkboxes("* [ ] task
- [x] done")
"<ul><li><input type='checkbox'> task</li><li><input type='checkbox' checked='checked'> done</li></ul>"
@@ -832,7 +832,7 @@ maybe_emote(content, user \\ nil, custom_em
Examples
-iex> maybe_emote(":smile:", nil, [])
+iex> maybe_emote(":smile:", nil, [])
"😄"
@@ -858,13 +858,13 @@ maybe_markdown_to_html(nothing, opts \\ [])
Converts the input content from markdown to HTML if the markdown library is enabled.
-If the content starts with an HTML tag or if the markdown library is not enabled, it skips conversion.
> Bonfire.Common.Text.maybe_markdown_to_html("*Hello World*", [])
+If the content starts with an HTML tag or if the markdown library is not enabled, it skips conversion.> Bonfire.Common.Text.maybe_markdown_to_html("*Hello World*", [])
"<p><em>Hello World</em></p>"
-iex> Bonfire.Common.Text.maybe_markdown_to_html("<p>Hello</p>", [])
+iex> Bonfire.Common.Text.maybe_markdown_to_html("<p>Hello</p>", [])
"<p>Hello</p>"
-> Bonfire.Common.Text.maybe_markdown_to_html("Not markdown", [])
+> Bonfire.Common.Text.maybe_markdown_to_html("Not markdown", [])
"<p>Not markdown</p>"
@@ -893,10 +893,10 @@ maybe_normalize_html(html_string)
Examples
-iex> maybe_normalize_html("<p>Test</p>")
+iex> maybe_normalize_html("<p>Test</p>")
"Test"
-iex> maybe_normalize_html("<p><br/></p>")
+iex> maybe_normalize_html("<p><br/></p>")
""
@@ -947,7 +947,7 @@ maybe_render_templated(templated_content, d
Examples
-> maybe_render_templated("Hello {{name}}", %{name: "World"})
+> maybe_render_templated("Hello {{name}}", %{name: "World"})
"Hello World"
@@ -976,7 +976,7 @@ maybe_sane_html(content)
Examples
-> maybe_sane_html("<script>alert('XSS')</script>")
+> maybe_sane_html("<script>alert('XSS')</script>")
#=> "alert('XSS')" (if HtmlSanitizeEx is enabled)
@@ -1005,7 +1005,7 @@ maybe_to_snake(string)
Examples
-iex> maybe_to_snake("CamelCase")
+iex> maybe_to_snake("CamelCase")
"camel_case"
@@ -1036,7 +1036,7 @@ normalise_links(content, format \\ :markdow
Examples
-> normalise_links("<a href="/pub/actors/foo">Actor</a>", :markdown)
+> normalise_links("<a href="/pub/actors/foo">Actor</a>", :markdown)
"<a href="/character/foo">Actor</a>"
@@ -1067,10 +1067,10 @@ random_string(length \\ 10)
Examples
-iex> random_string(5) |> String.length()
+iex> random_string(5) |> String.length()
5
-> random_string()
+> random_string()
#=> a string of length 10
@@ -1125,10 +1125,10 @@ sentence_truncate(input, length \\ 250, add
Examples
-iex> sentence_truncate("Hello world. This is a test.", 12)
+iex> sentence_truncate("Hello world. This is a test.", 12)
"Hello world."
-iex> sentence_truncate("Hello world. This is a test.", 12, "...")
+iex> sentence_truncate("Hello world. This is a test.", 12, "...")
"Hello world...."
@@ -1152,13 +1152,13 @@ slug(text)
Generates a URL-friendly slug from the given text.
-The text is downcased, trimmed, spaces are replaced with dashes, and it is URI-encoded.
iex> Bonfire.Common.Text.slug("Hello World!")
+The text is downcased, trimmed, spaces are replaced with dashes, and it is URI-encoded.iex> Bonfire.Common.Text.slug("Hello World!")
"hello-world!"
-iex> Bonfire.Common.Text.slug("Elixir Programming")
+iex> Bonfire.Common.Text.slug("Elixir Programming")
"elixir-programming"
-iex> Bonfire.Common.Text.slug("Special & Characters")
+iex> Bonfire.Common.Text.slug("Special & Characters")
"special-&-characters"
@@ -1187,8 +1187,8 @@ split_lines(string)
Examples
-iex> split_lines("line1\nline2\r\nline3\rline4")
-["line1", "line2", "line3", "line4"]
+iex> split_lines("line1\nline2\r\nline3\rline4")
+["line1", "line2", "line3", "line4"]
@@ -1216,22 +1216,22 @@ strlen(x)
Examples
-iex> strlen("hello")
+iex> strlen("hello")
5
-iex> strlen([1, 2, 3])
+iex> strlen([1, 2, 3])
3
-iex> strlen(%{})
+iex> strlen(%{})
0
-iex> strlen(nil)
+iex> strlen(nil)
0
-iex> strlen(0)
+iex> strlen(0)
0
-iex> strlen(123)
+iex> strlen(123)
1
@@ -1260,10 +1260,10 @@ text_only(content)
Examples
-iex> text_only("<div>Text</div>")
+iex> text_only("<div>Text</div>")
"Text"
-iex> text_only({:safe, "<div>Safe Text</div>"})
+iex> text_only({:safe, "<div>Safe Text</div>"})
"Safe Text"
@@ -1296,13 +1296,13 @@ truncate(text, max_length \\ 250, add_to_en
Examples
-iex> truncate("Hello world", 5)
+iex> truncate("Hello world", 5)
"Hello"
-iex> truncate("Hello world", 5, "...")
+iex> truncate("Hello world", 5, "...")
"He..."
-iex> truncate("Hello world", 7, "...")
+iex> truncate("Hello world", 7, "...")
"Hell..."
@@ -1328,16 +1328,16 @@ underscore_truncate(input, length \\ 250)
Truncates the input string at the last underscore (_) if its length exceeds the given length.
-If the input string is shorter than or equal to the given length, it returns the string as is.
iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 4)
+If the input string is shorter than or equal to the given length, it returns the string as is.iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 4)
"abc"
-iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 10)
+iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 10)
"abc_def"
-iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 5)
+iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 5)
"abc"
-iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 0)
+iex> Bonfire.Common.Text.underscore_truncate("abc_def_ghi", 0)
@@ -1365,7 +1365,7 @@ upcase_first(arg)
Examples
-iex> upcase_first("hello")
+iex> upcase_first("hello")
"Hello"
@@ -1394,7 +1394,7 @@ verb_infinitive(verb_conjugated)
Examples
-> verb_infinitive("running")
+> verb_infinitive("running")
"run"
diff --git a/Bonfire.Common.TextExtended.html b/Bonfire.Common.TextExtended.html
index b3035509f6..acbcf50123 100644
--- a/Bonfire.Common.TextExtended.html
+++ b/Bonfire.Common.TextExtended.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.TextExtended — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.TextExtended — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.TextExtended
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -601,22 +601,22 @@ blank?(xA)
Examples
-iex> strlen("hello")
+iex> strlen("hello")
5
-iex> strlen([1, 2, 3])
+iex> strlen([1, 2, 3])
3
-iex> strlen(%{})
+iex> strlen(%{})
0
-iex> strlen(nil)
+iex> strlen(nil)
0
-iex> strlen(0)
+iex> strlen(0)
0
-iex> strlen(123)
+iex> strlen(123)
1
diff --git a/Bonfire.Common.Types.html b/Bonfire.Common.Types.html
index ae057f6869..3d5357e9dd 100644
--- a/Bonfire.Common.Types.html
+++ b/Bonfire.Common.Types.html
@@ -5,10 +5,10 @@
-
+
- Bonfire.Common.Types — Bonfire v0.9.10-classic-beta.160
+ Bonfire.Common.Types — Bonfire v0.9.10-classic-beta.161
@@ -54,7 +54,7 @@
Bonfire
@@ -132,7 +132,7 @@
Bonfire.Common.Types
- (Bonfire v0.9.10-classic-beta.160)
+ (Bonfire v0.9.10-classic-beta.161)
@@ -453,8 +453,8 @@ all_object_type_names()
-Outputs the names of all object types for the purpose of adding to the localisation strings (as long as the output is piped through to Bonfire.Common.Localise.Gettext.localise_strings/1 at compile time)
> all_object_type_names()
-["User", "Delete this User", "Post", "Delete this Post", ...]
+Outputs the names of all object types for the purpose of adding to the localisation strings (as long as the output is piped through to Bonfire.Common.Localise.Gettext.localise_strings/1 at compile time)
> all_object_type_names()
+["User", "Delete this User", "Post", "Delete this Post", ...]
@@ -482,13 +482,13 @@ defines_struct?(module)
Examples
-iex> defines_struct?(Needle.Pointer)
+iex> defines_struct?(Needle.Pointer)
true
-iex> defines_struct?(%{__struct__: Bonfire.Common})
+iex> defines_struct?(%{__struct__: Bonfire.Common})
true
-iex> defines_struct?(%{some_key: "some_value"})
+iex> defines_struct?(%{some_key: "some_value"})
false
@@ -517,13 +517,13 @@ is_numeric(num)
Examples
-iex> is_numeric(123)
+iex> is_numeric(123)
true
-iex> is_numeric("123.45")
+iex> is_numeric("123.45")
true
-iex> is_numeric("abc")
+iex> is_numeric("abc")
false
@@ -554,13 +554,13 @@ is_uid?(str, params \\ nil)
Examples
-iex> is_uid?("01J3MQ2Q4RVB1WTE3KT1D8ZNX1")
+