Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Simplify pagination using Enumerator::Lazy #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NARKOZ merged 2 commits into from
Jun 25, 2020
Merged

Simplify pagination using Enumerator::Lazy #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0bfe4c
Simplify pagination using Enumerator::Lazy
javanthropus Jun 19, 2020
59bf7eb
Satisfy Rubocop requirement on method parameter name length
javanthropus Jun 22, 2020
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
45 changes: 14 additions & 31 deletions lib/gitlab/paginated_response.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,37 +42,20 @@ def each_page
end
end

def auto_paginate
response = block_given? ? nil : []
each_page do |page|
if block_given?
page.each do |item|
yield item
end
else
response += page
end
end
response
end

def paginate_with_limit(limit)
response = block_given? ? nil : []
count = 0
each_page do |page|
if block_given?
page.each do |item|
yield item
count += 1
break if count >= limit
end
else
response += page[0, limit - count]
count = response.length
end
break if count >= limit
end
response
def lazy_paginate
to_enum(:each_page).lazy.flat_map(&:to_ary)
end

def auto_paginate(&block)
return lazy_paginate.to_a unless block_given?

lazy_paginate.each(&block)
end

def paginate_with_limit(limit, &block)
return lazy_paginate.take(limit).to_a unless block_given?

lazy_paginate.take(limit).each(&block)
end

def last_page?
Expand Down
23 changes: 21 additions & 2 deletions spec/gitlab/paginated_response_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,25 @@
end
end

describe '.lazy_paginate' do
it 'returns a lazy enumerator' do
expect(@paginated_response.lazy_paginate).to be_an(Enumerator::Lazy)
end

it 'only requests needed pages' do
next_page = double('next_page')
allow(@paginated_response).to receive(:has_next_page?).and_return(true)
allow(@paginated_response).to receive(:next_page).and_return(next_page)
allow(next_page).to receive(:has_next_page?).and_return(true)
# NOTE:
# Do not define :next_page on the next_page double to prove that it is NOT
# called even though :has_next_page? has been defined to claim another
# page is available.
allow(next_page).to receive(:to_ary).and_return([5, 6, 7, 8])
expect(@paginated_response.lazy_paginate.take(8)).to contain_exactly(1, 2, 3, 4, 5, 6, 7, 8)
end
end

describe '.auto_paginate' do
it 'returns an array if block is not given' do
next_page = double('next_page')
Expand Down Expand Up @@ -104,7 +123,7 @@
allow(@paginated_response).to receive(:has_next_page?).and_return(true)
allow(@paginated_response).to receive(:next_page).and_return(next_page)
allow(next_page).to receive(:has_next_page?).and_return(false)
allow(next_page).to receive(:[]).with(0, 1).and_return([5])
allow(next_page).to receive(:to_ary).and_return([5])
expect(@paginated_response.paginate_with_limit(5)).to contain_exactly(1, 2, 3, 4, 5)
end
end
Expand All @@ -115,7 +134,7 @@
allow(@paginated_response).to receive(:has_next_page?).and_return(true)
allow(@paginated_response).to receive(:next_page).and_return(next_page)
allow(next_page).to receive(:has_next_page?).and_return(false)
allow(next_page).to receive(:each).and_yield(5).and_yield(6).and_yield(7).and_yield(8)
allow(next_page).to receive(:to_ary).and_return([5, 6, 7, 8])
end
end

Expand Down