Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 46 additions & 10 deletions lib/scrivener/paginater/ecto/query.ex
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
defimpl Scrivener.Paginater, for: Ecto.Query do
import Ecto.Query

alias Scrivener.{Config, Page}
alias Scrivener.{Config, Page, SimplePage}

@moduledoc false

@spec paginate(Ecto.Query.t(), Scrivener.Config.t()) :: Scrivener.Page.t()
@spec paginate(Ecto.Query.t(), Scrivener.Config.t()) ::
Scrivener.Page.t() | Scrivener.SimplePage.t()
def paginate(query, %Config{
page_size: page_size,
page_number: page_number,
page_type: :normal,
module: repo,
caller: caller,
page_number: page_number,
page_size: page_size,
options: options
}) do
total_entries =
Expand All @@ -26,25 +28,59 @@ defimpl Scrivener.Paginater, for: Ecto.Query do
page_number =
if allow_overflow_page_number, do: page_number, else: min(total_pages, page_number)

entries =
if page_number > total_pages,
do: [],
else: entries(query, repo, page_number, page_size, options)

%Page{
page_size: page_size,
page_number: page_number,
entries: entries(query, repo, page_number, total_pages, page_size, options),
entries: entries,
total_entries: total_entries,
total_pages: total_pages
}
end

defp entries(_query, _repo, page_number, total_pages, _page_size, _options)
when page_number > total_pages,
do: []
def paginate(query, %Config{
page_type: :simple,
module: repo,
page_number: page_number,
page_size: page_size,
options: options
}) do
entries_with_maybe_one_extra =
entries(query, repo, page_number, page_size, options, extra_entry_size: 1)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is the core logic where we fetch one more row than it should be.

If the total fetched entries are > page_size, we set has_more to true(and discard the last one from entries). Other, has_more is false


{entries, has_more} =
if length(entries_with_maybe_one_extra) > page_size do
entries =
entries_with_maybe_one_extra
|> Enum.reverse()
|> tl()
|> Enum.reverse()

{entries, true}
else
{entries_with_maybe_one_extra, false}
end

%SimplePage{
page_size: page_size,
page_number: page_number,
entries: entries,
has_more: has_more
}
end

defp entries(query, repo, page_number, _total_pages, page_size, options) do
defp entries(query, repo, page_number, page_size, options, opts \\ []) do
extra_entry_size = Keyword.get(opts, :extra_entry_size, 0)
offset = Keyword.get_lazy(options, :offset, fn -> page_size * (page_number - 1) end)
limit = page_size + extra_entry_size

query
|> offset(^offset)
|> limit(^page_size)
|> limit(^limit)
|> repo.all(options)
end

Expand Down
3 changes: 2 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ defmodule Scrivener.Ecto.Mixfile do

defp deps do
[
{:scrivener, "~> 2.4"},
{:scrivener,
github: "RiverFinancial/scrivener", ref: "e21e9e83b4e101d2e3b5e24acb29289708746dac"},
{:ecto, "~> 3.12"},
{:ecto_sql, "~> 3.12", only: :test},
{:dialyxir, "~> 1.0", only: :dev},
Expand Down
2 changes: 1 addition & 1 deletion mix.lock
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
"makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
"nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"},
"postgrex": {:hex, :postgrex, "0.19.1", "73b498508b69aded53907fe48a1fee811be34cc720e69ef4ccd568c8715495ea", [:mix], [{:db_connection, "~> 2.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "8bac7885a18f381e091ec6caf41bda7bb8c77912bb0e9285212829afe5d8a8f8"},
"scrivener": {:hex, :scrivener, "2.7.2", "1d913c965ec352650a7f864ad7fd8d80462f76a32f33d57d1e48bc5e9d40aba2", [:mix], [], "hexpm", "7866a0ec4d40274efbee1db8bead13a995ea4926ecd8203345af8f90d2b620d9"},
"scrivener": {:git, "https://github.com/RiverFinancial/scrivener.git", "e21e9e83b4e101d2e3b5e24acb29289708746dac", [ref: "e21e9e83b4e101d2e3b5e24acb29289708746dac"]},
"telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"},
}
Loading