Allow passing Ecto query and preloads as list_... function args

.formatter.exs

@@ -1,4 +1,5 @@
 # Used by "mix format"
 [
-  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
+  import_deps: [:ecto]
 ]

.github/workflows/ci.yml

@@ -29,6 +29,13 @@ jobs:
         elixir-version: ${{ env.elixir_version }}
         otp-version: ${{ env.otp_version }}
 
+    - name: Set up Postgres
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y postgresql
+        sudo service postgresql start
+        sudo -u postgres psql -c "ALTER USER postgres WITH PASSWORD 'postgres';"
+
     - name: Restore dependencies and _build cache
       uses: actions/cache@v2
       with:
@@ -48,6 +55,11 @@ jobs:
     - name: Check formatting
       run: mix format --check-formatted
 
+    - name: Create test database
+      run: mix do ecto.create, ecto.migrate
+      env:
+        MIX_ENV: test
+
     - name: Run tests
       run: mix test
 

.tool-versions

@@ -1,2 +1,2 @@
-elixir 1.14.4
-erlang 25.3
+elixir 1.18.2
+erlang 27.2.1

README.md

@@ -215,7 +215,8 @@ Read more about `Contexted.Delegator` and its options in [docs](https://hexdocs.
 
 ### Don't repeat yourself with CRUD operations
 
-In most web apps CRUD operations are very common. Most of these, have the same pattern. Why not autogenerate them?
+In most web apps CRUD operations are very common. Most of these, have the same pattern. Most of the time, they are used with preloading associated resources as well as filtering based on conditions such as search, pagination, etc.
+Why not autogenerate them?
 
 Here is how you can generate common CRUD operations for `App.Account.Users`:
 
@@ -242,14 +243,60 @@ iex> App.Accounts.Users.__info__(:functions)
   delete_user!: 1,
   get_user: 1,
   get_user!: 1,
+  get_user_by: 1,
+  get_user_by!: 1,
+  get_user_by: 2,
+  get_user_by!: 2,
   list_users: 0,
+  list_users: 1,
+  list_users: 2,
   update_user: 1,
   update_user: 2,
   update_user!: 1,
   update_user!: 2
 ]
 ```
 
+Generated creation and updating functions default to the corresponding schema's `changeset/1` and `changeset/2` functions, respectively, whereas list and get functions provide a means to manipulate the result by:
+
+* filtering conditions (via plain exact match condition lists or by passing an Ecto.Query)
+* preloads
+* orderings
+* limits
+* offsets
+
+Examples:
+
+```elixir
+# List all users with posts preloaded
+iex> App.Accounts.Users.list_users(preload: [:posts])
+
+# Use an Ecto.Query to filter users, and a keyword list of options to manipulate the result
+iex> App.Accounts.Users.list_users(
+  App.Accounts.User |> where([u], u.status == "active"),
+  preload: [:posts],
+  order_by: [desc: :inserted_at],
+  limit: 10,
+  offset: 0
+)
+
+# Use a keyword list of exact match conditions and manipulation options
+iex> App.Accounts.Users.list_users(
+  status: "active",
+  subscription: [plan: "free"],
+  order_by: [desc: :inserted_at]
+)
+
+# Get a user by ID with subscription preloaded
+iex> App.Accounts.Users.get_user!(10, preload: [:subscription])
+
+# Get a user by profile email with profile and subscription preloaded
+iex> App.Accounts.Users.get_user_by!(profile: [email: "user@example.com"], preload: [:profile, :subscription])
+
+# Use an Ecto.Query to get a specific user
+iex> App.Accounts.Users.get_user_by!(App.Accounts.User |> where([u], u.id == 10), preload: [:profile, :subscription])
+```
+
 Read more about `Contexted.CRUD` and its options in [docs](https://hexdocs.pm/contexted/Contexted.CRUD.html).
 
 <br/>

config/config.exs

@@ -0,0 +1,3 @@
+import Config
+
+import_config "#{Mix.env()}.exs"

config/dev.exs

@@ -0,0 +1,3 @@
+import Config
+
+# no-op: we don't need to configure anything for the dev environment

config/test.exs

@@ -0,0 +1,13 @@
+import Config
+
+config :contexted, ecto_repos: [Contexted.TestApp.Repo]
+
+config :contexted, Contexted.TestApp.Repo,
+  database: "contexted_test",
+  username: "postgres",
+  password: "postgres",
+  hostname: "localhost",
+  pool: Ecto.Adapters.SQL.Sandbox,
+  show_sensitive_data_on_connection_error: true,
+  pool_size: 10,
+  log: false