Patch 1

.github/workflows/test.yml

@@ -1,27 +1,46 @@
-name: test
-
+name: CI
 on:
   - push
   - pull_request
-
 jobs:
   test:
-    runs-on: ubuntu-latest
-
+    runs-on: ubuntu-20.04
     services:
       postgres:
         image: "postgres:13"
         ports:
           - 5432:5432
         env:
           POSTGRES_HOST_AUTH_METHOD: trust
-
+    name: OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
+    env:
+      MIX_ENV: test
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - elixir: '1.11.4'
+          otp: '23.3'
+        - elixir: '1.14.5'
+          otp: '24.3'
+#         - elixir: '1.15.0'
+#           otp: '26.0.1'
     steps:
       - uses: actions/checkout@v2
       - uses: erlef/setup-elixir@v1
         with:
-          otp-version: '23.2.6'
-          elixir-version: '1.11.3'
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
+          version-type: strict
+      - name: Install Dependencies
+        run: mix deps.get --only test
+      - run: mix format --check-formatted
+        if: ${{ matrix.lint }}
+      - run: mix deps.get && mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
+      - run: mix deps.compile
+      - run: mix compile --warnings-as-errors
+        if: ${{ matrix.lint }}
       - run: mix local.rebar --force
       - run: mix local.hex --force
       - run: mix deps.get

README.md

@@ -66,6 +66,35 @@ page =
   |> MyApp.Repo.paginate(page: 2, page_size: 5)
 ```
 
+## Supported Options
+
+There are several options that can be supplied in a dedicated `options` keyword list arg. Here is an example of using `options`...
+
+```elixir
+defmodule MyApp.Repo do
+  use Ecto.Repo, otp_app: :my_app, adapter: Ecto.Adapters.Postgres
+  use Scrivener, options: [allow_overflow_page_number: true]
+end
+```
+
+Here is an explanation of the supported options...
+
+* `:allow_overflow_page_number` - If set to true then when you supply a page greater than the total pages, it will return an empty list for entries. If set to false then it will (silently) treat any supplied `page` arg as if it was equal to the total pages. Default is false.
+
+## Other Configuration
+
+The behaviour of Ecto Scrivener can also be optionally configured by passing things directly to the `use Scrivener` statement rather than via the `options` keyword list arg. For example...
+
+```elixir
+defmodule MyApp.Module do
+  use Scrivener, page_size: 5, max_page_size: 100
+end
+```
+
+Here is an explanation of the directly configurable keys...
+
+* `:max_page_size` - This (silently) enforces a hard ceiling for the page size, even if you allow users of your application to specify page_size via query parameters. If not provided, there will be no limit to page size.
+
 ## Installation
 
 Add `scrivener_ecto` to your `mix.exs` `deps`.