refactor!: remove accessible plugin, add it to guides

Author: fahchen

lib/typed_structor/plugins/accessible.ex guides/plugins/accessible.md

@@ -1,4 +1,21 @@
-defmodule TypedStructor.Plugins.Accessible do
+# Implement `Access` behavior
+
+Sometimes, you may want to use the `get_in/2` and `update_in/3` functions
+with your structs. This guide demonstrates how to effortlessly implement
+the `Access` behavior for your structs using a plugin.
+
+## Implementation
+
+> #### Destructive operations  {: .warning}
+> These operations are not allowed for the struct:
+> * update `:__struct__` key
+> * pop a key
+>
+> The functions will raise an `ArgumentError` if called.
+> To enable these functionalities, override the `get_and_update/3` and `pop/2` functions.
+
+```elixir
+defmodule Guides.Plugins.Accessible do
   @moduledoc """
   This plugin implements the `Access` behavior for the struct
   by delegating the `fetch/2`, `get_and_update/3`, and `pop/2`
@@ -14,13 +31,11 @@ defmodule TypedStructor.Plugins.Accessible do
 
   ## Usage
 
-  ```elixir
-    typed_structor do
-      plugin TypedStructor.Plugins.Accessible
+      typed_structor do
+        plugin TypedStructor.Plugins.Accessible
 
-      # fields
-    end
-  ```
+        # fields
+      end
   """
 
   use TypedStructor.Plugin
@@ -53,3 +68,27 @@ defmodule TypedStructor.Plugins.Accessible do
     end
   end
 end
+```
+
+## Usage
+```elixir
+defmodule User do
+  use TypedStructor
+
+  typed_structor do
+    plugin Guides.Plugins.Accessible
+
+    field :name, String.t()
+    field :age, integer()
+  end
+end
+```
+
+```elixir
+iex> user = %User{name: "Phil", age: 20}
+%User{name: "Phil", age: 20}
+iex> get_in(user, [:name])
+"Phil"
+iex> put_in(user, [:name], "phil")
+%User{name: "phil", age: 20}
+```

guides/plugins/introduction.md

@@ -12,7 +12,7 @@ We provide some example plugins that you can use as a reference, or copy-paste.
 
 **Plugin examples:**
 - [Registering plugins globally](./registering_plugins_globally.md)
-- `TypedStructor.Plugins.Accessible`
+- [Implement `Access` behavior](./accessible.md)
 - [Type Only on Ecto Schema](./type_only_on_ecto_schema.md)
 - [Add primary key and timestamps types to your Ecto schema](./primary_key_and_timestamps.md)
 - [Derives the `Jason.Encoder` for `struct`](./derive_jason.md)

mix.exs

@@ -34,6 +34,7 @@ defmodule TypedStructor.MixProject do
           # plugins
           {"guides/plugins/introduction.md", [title: "Introduction"]},
           "guides/plugins/registering_plugins_globally.md",
+          "guides/plugins/accessible.md",
           "guides/plugins/type_only_on_ecto_schema.md",
           "guides/plugins/primary_key_and_timestamps.md",
           "guides/plugins/derive_jason.md",

test/guides/plugins/accessible_test.exs

@@ -0,0 +1,30 @@
+defmodule Guides.Plugins.AccessibleTest do
+  use TypedStructor.GuideCase,
+    async: true,
+    guide: "accessible.md"
+
+  test "implements Access" do
+    user = %User{name: "Phil", age: 20}
+
+    assert "Phil" === get_in(user, [:name])
+    assert %User{name: "phil", age: 20} === put_in(user, [:name], "phil")
+
+    assert_raise ArgumentError, ~r/Cannot update `:__struct__` key/, fn ->
+      put_in(user, [:__struct__], "phil")
+    end
+
+    assert %{name: "phil"} = update_in(user, [:name], fn "Phil" -> "phil" end)
+
+    assert_raise ArgumentError, ~r/Cannot update `:__struct__` key/, fn ->
+      update_in(user, [:__struct__], fn _ -> nil end)
+    end
+
+    assert_raise ArgumentError, ~r/Cannot pop `:__struct__` key/, fn ->
+      pop_in(user, [:__struct__])
+    end
+
+    assert_raise ArgumentError, ~r/Cannot pop `:name` key/, fn ->
+      pop_in(user, [:name])
+    end
+  end
+end