Add process names, refocus scope, rework API

.github/workflows/test.yml

@@ -14,8 +14,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: erlef/setup-beam@v1
         with:
-          otp-version: "26.2"
+          otp-version: "27.0"
           rebar3-version: "3"
-          gleam-version: "1.5.1"
+          gleam-version: "1.10.0"
       - run: gleam test
       - run: gleam format --check src test

CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## v1.0.0-rc1 - Unreleased
+
+- In the `gleam/erlang/process` module:
+  - The `Name` type has been introduced. This type is used to give processes
+    names, making it easier to pass references around your application, and to
+    have a new process take over a role from a previous one that has crashed.
+  - The `new_name` function has been added for creating new names.
+  - The `named_subject` function has been added for creating a subject for a
+    given name.
+  - The `register` function now takes a name rather than an atom.
+  - The `unregister` function now takes a name rather than an atom.
+  - The `named` function now takes a name rather than an atom.
+  - The `try_call` and `try_call_forever` functions have been removed in favour
+    of `call` and `call_forever`.
+  - The `CallError` type has been removed.
+  - The `start` function has been replaced by the `spawn` and `spawn_unlinked`
+    functions. These functions use the Erlang `proc_lib` spawn functions and so
+    benefit from the functionality described in the
+    [`proc_lib` documentation](https://www.erlang.org/doc/apps/stdlib/proc_lib.html).
+  - The `subject_owner` function now returns a result as a named subject may not
+    have any process registered for that name.
+  - The `selecting_*` functions have been replaced by the
+    `select_*` functions.
+  - The `select*` functions have been replaced by the
+    `selector_receive*` functions.
+  - The `ProcessDown` type has been removed.
+  - The `Down` type has been added.
+  - The `selecting_monitors` function has been added.
+  - The `selecting_specific_monitor` function has been added.
+  - The `deselecting_specific_monitor` function has been added.
+  - The `selecting_process_down` function has been removed.
+  - The `deselecting_process_down` function has been removed.
+  - The `Abnormal` variant of the `ExitReason` type now holds a `Dynamic`.
+  - The argument ordering and labels of `call` have changed.
+- In the `gleam/erlang/node` module:
+  - The `to_atom` function has been removed.
+  - The `send` function has been removed.
+- The `gleam/erlang/reference` module has been created with:
+  - The `Reference` type.
+  - The `new` function.
+- The `gleam/erlang/application` module was created with:
+  - The `priv_directory` function, formerly of the `gleam/erlang` module.
+  - The `StartType` type.
+- In the `gleam/erlang/atom` module:
+  - The `AtomNotLoaded` type has been removed.
+  - The error type of `from_string` is now `Nil`.
+  - The `from_string` function has been renamed to `get`.
+  - The `create_from_string` function has been renamed to `create`.
+- The `gleam/erlang` module has been removed.
+- The `gleam/erlang/os` module has been removed. The [input](https://github.com/bcpeinhardt/input)
+  and [envoy](https://github.com/lpil/envoy) packages may be a suitable
+  replacement.
+
 ## v0.34.0 - 2025-02-02
 
 - Fixed deprecation warnings with the Gleam standard library v0.53.0 or later.

README.md

@@ -2,34 +2,17 @@
 
 A library for making use of Erlang specific code!
 
-## Features
-
-- Typed Erlang processes and message sending.
-- Erlang binary format (de)serialisation.
-- Functions for working with Erlang's charlists.
-- Basic distributed Erlang support and working with nodes.
-- Reading and writing of environment variables.
-- Functions for working with atoms.
-
-## Usage
-
-Add this library to your Gleam project
-
 ```shell
-gleam add gleam_erlang
+gleam add gleam_erlang@1
 ```
-
-And then use it in your code
-
 ```gleam
 import gleam/io
 import gleam/erlang/process
 
 pub fn main() {
-  let fun = fn() { 
+  process.spawn(fn() { 
     io.println("Hello from another process running concurrently!")
-  }
-  process.start(fun, True)
+  })
 }
 ```
 

gleam.toml

@@ -1,6 +1,6 @@
 name = "gleam_erlang"
 
-version = "0.34.0"
+version = "1.0.0-rc1"
 licences = ["Apache-2.0"]
 description = "A Gleam library for working with Erlang"
 
@@ -9,7 +9,7 @@ links = [
   { title = "Website", href = "https://gleam.run" },
   { title = "Sponsor", href = "https://github.com/sponsors/lpil" },
 ]
-gleam = ">= 0.32.0"
+gleam = ">= 1.7.0"
 
 [dependencies]
 gleam_stdlib = ">= 0.53.0 and < 2.0.0"

manifest.toml

@@ -2,7 +2,7 @@
 # You typically do not need to edit this file
 
 packages = [
-  { name = "gleam_stdlib", version = "0.53.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "53F3E1E56F692C20FA3E0A23650AC46592464E40D8EF3EC7F364FB328E73CDF5" },
+  { name = "gleam_stdlib", version = "0.58.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "091F2D2C4A3A4E2047986C47E2C2C9D728A4E068ABB31FDA17B0D347E6248467" },
   { name = "gleeunit", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "0E6C83834BA65EDCAAF4FE4FB94AC697D9262D83E6F58A750D63C9F6C8A9D9FF" },
 ]
 

src/gleam/erlang/application.gleam

@@ -0,0 +1,37 @@
+//// An Erlang application is a collection of code that can be loaded into the
+//// Erlang virtual machine and even started and stopped if they define a
+//// start module and supervision tree. Each Gleam package is an Erlang
+//// application.
+
+import gleam/erlang/node.{type Node}
+
+/// The Erlang/OTP application `start` callback takes a start-type as an
+/// argument, indicating the context in which the application is being started.
+pub type StartType {
+  /// A normal application start.
+  Normal
+  /// The application is distributed and started at the current node because of
+  /// a takeover from Node, either because Erlang's `application:takeover/2`
+  /// function has been called, or because the current node has higher priority
+  /// than the previous node.
+  Takeover(previous: Node)
+  /// The application is distributed and started at the current node because of
+  /// a failover from the previous node.
+  Failover(previous: Node)
+}
+
+/// Returns the path of an application's `priv` directory, where extra non-Gleam
+/// or Erlang files are typically kept. Each Gleam package is an Erlang
+/// application.
+///
+/// Returns an error if no application was found with the given name.
+///
+/// # Example
+///
+/// ```gleam
+/// application.priv_directory("my_app")
+/// // -> Ok("/some/location/my_app/priv")
+/// ```
+///
+@external(erlang, "gleam_erlang_ffi", "priv_directory")
+pub fn priv_directory(name: String) -> Result(String, Nil)