populate/omit -> enforce_random/exclude (#1)

Author: jechol

README.md

@@ -37,8 +37,8 @@ Post.random_params!(:create, %{author: "James"})
 
 # With options
 Post.random_params!(:create, %{author: "James"}, %{
-  populate: [:content],   
-  omit: [:title],   
+  enforce_random: [:content],   
+  exclude: [:title],   
   include_defaults?: false
 })
 => %{author: "James", content: "content-38128"}
@@ -55,13 +55,13 @@ For accepts and arguments that match the `name` or `source_attribute` of a `belo
 - In other actions, they are not generated at all
 
 This behavior exists because:
-- In `create` actions, omitting a value is equivalent to setting it to `nil`
-- In `update` actions, omitting a value preserves the existing relationship, while explicitly setting it to `nil` removes the relationship
+- In `create` actions, excluding a value is equivalent to setting it to `nil`
+- In `update` actions, excluding a value preserves the existing relationship, while explicitly setting it to `nil` removes the relationship
 
 ### Options
 
-- `populate`: Forces generation of random values for specified accepts/arguments, overriding the default behavior
-- `omit`: Prevents generation of random values for specified accepts/arguments, overriding the default behavior
+- `enforce_random`: Forces generation of random values for specified accepts/arguments, overriding the default behavior
+- `exclude`: Prevents generation of random values for specified accepts/arguments, overriding the default behavior
 - `include_defaults?`: When set to `true`, includes default values for accepts/arguments that have either `allow_nil?: true` or a non-nil default value. Defaults to `true`. In the example above, this would add `%{content: nil, tag: "JS"}` to the generated params.
 
 ### Custom Random Generator
@@ -98,7 +98,7 @@ Add `ash_random_params` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:ash_random_params, "~> 0.1.0"}
+    {:ash_random_params, "~> 0.2.0"}
   ]
 end
 ```

lib/transformer.ex

@@ -13,14 +13,14 @@ defmodule AshRandomParams.Transformer do
   def add_random_params(dsl_state) do
     action = Builder.build_action_argument(:action, :atom, default: :create)
     init_params = Builder.build_action_argument(:init_params, :map, default: %{})
-    populate = Builder.build_action_argument(:populate, {:array, :atom}, default: [])
-    omit = Builder.build_action_argument(:omit, {:array, :atom}, default: [])
+    enforce_random = Builder.build_action_argument(:enforce_random, {:array, :atom}, default: [])
+    exclude = Builder.build_action_argument(:exclude, {:array, :atom}, default: [])
     include_defaults? = Builder.build_action_argument(:include_defaults?, :boolean, default: true)
 
     dsl_state
     |> Builder.add_action(:action, :random_params,
       returns: :map,
-      arguments: [action, init_params, omit, populate, include_defaults?],
+      arguments: [action, init_params, exclude, enforce_random, include_defaults?],
       run: &__MODULE__.do_random_params/2
     )
     |> Builder.add_interface(:random_params, args: [:action, {:optional, :init_params}])
@@ -44,8 +44,8 @@ defmodule AshRandomParams.Transformer do
           arguments: %{
             action: action,
             init_params: init_params,
-            omit: omit,
-            populate: populate,
+            exclude: exclude,
+            enforce_random: enforce_random,
             include_defaults?: include_defaults?
           }
         } =
@@ -86,7 +86,7 @@ defmodule AshRandomParams.Transformer do
             |> Enum.reject(&(&1.name in belongs_to_attrs))
           end
         end)
-        |> Enum.reject(&(&1.name in omit))
+        |> Enum.reject(&(&1.name in exclude))
         |> Enum.reject(&(&1.name in init_keys))
         |> Map.new(fn %{name: name, default: default} ->
           value =
@@ -109,16 +109,16 @@ defmodule AshRandomParams.Transformer do
         {random_mod, random_opts} =
           random = AshRandomParams.Info.random_params_random!(input.resource)
 
-        fields_by_omit =
+        fields_by_exclude =
           candidates
           |> Enum.reject(&(&1.name in rel_names))
           |> Enum.reject(&(&1.name in belongs_to_attrs))
-          |> Enum.reject(&(&1.name in omit))
+          |> Enum.reject(&(&1.name in exclude))
           |> Enum.reject(&(&1.allow_nil? || &1.default != nil))
 
-        fields_by_fill = candidates |> Enum.filter(&(&1.name in populate))
+        fields_by_fill = candidates |> Enum.filter(&(&1.name in enforce_random))
 
-        (fields_by_omit ++ fields_by_fill)
+        (fields_by_exclude ++ fields_by_fill)
         |> Enum.reject(&(&1.name in init_keys))
         |> Map.new(fn %{name: name, default: default} = attr_or_arg ->
           value =

mix.exs

@@ -4,7 +4,7 @@ defmodule AshRandomParams.MixProject do
   def project do
     [
       app: :ash_random_params,
-      version: "0.1.0",
+      version: "0.2.0",
       elixir: "~> 1.17",
       consolidate_protocols: Mix.env() not in [:dev, :test],
       start_permanent: Mix.env() == :prod,
@@ -34,8 +34,6 @@ defmodule AshRandomParams.MixProject do
       {:spark, ">= 0.0.0"},
       {:sourceror, ">= 0.0.0", only: [:dev, :test], optional: true},
       {:ex_doc, "~> 0.29", only: :dev, runtime: false}
-      # {:dep_from_hexpm, "~> 0.3.0"},
-      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
     ]
   end
 

test/ash_random_params_test.exs

@@ -148,7 +148,7 @@ defmodule AshRandomParamsTest do
                |> Ash.run_action!()
     end
 
-    test "with populate" do
+    test "with enforce_random" do
       assert %{
                author_id: nil,
                req_str: "req_str-" <> _,
@@ -161,13 +161,13 @@ defmodule AshRandomParamsTest do
                  :random_params,
                  %{
                    action: :create,
-                   populate: [:opt_str]
+                   enforce_random: [:opt_str]
                  }
                )
                |> Ash.run_action!()
     end
 
-    test "with omit" do
+    test "with exclude" do
       assert %{
                author_id: nil,
                opt_str: nil,
@@ -180,7 +180,7 @@ defmodule AshRandomParamsTest do
                  :random_params,
                  %{
                    action: :create,
-                   omit: [:req_str]
+                   exclude: [:req_str]
                  }
                )
                |> Ash.run_action!()
@@ -239,7 +239,7 @@ defmodule AshRandomParamsTest do
              Post.random_params!(
                :create,
                %{opt_int: 456},
-               %{populate: [:opt_int]}
+               %{enforce_random: [:opt_int]}
              )
   end
 end