Class: Believe::Internal::SkipLimitPage

Inherits:
Object
  • Object
show all
Includes:
Type::BasePage
Defined in:
lib/believe/internal/skip_limit_page.rb

Overview

Examples:

if skip_limit_page.has_next?
  skip_limit_page = skip_limit_page.next_page
end
skip_limit_page.auto_paging_each do |character|
  puts(character)
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

#initialize(client:, req:, headers:, page_data:) ⇒ SkipLimitPage

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of SkipLimitPage.

Parameters:



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/believe/internal/skip_limit_page.rb', line 68

def initialize(client:, req:, headers:, page_data:)
  super

  case page_data
  in {data: Array => data}
    @data = data.map { ::Believe::Internal::Type::Converter.coerce(@model, _1) }
  else
  end
  @total = page_data[:total]
  @skip = page_data[:skip]
end

Instance Attribute Details

#data ⇒ Array<generic<Elem>>?

Returns:

  • (Array<generic<Elem>>, nil) 


20
21
22
 
# File 'lib/believe/internal/skip_limit_page.rb', line 20

def data
  @data
end

#skip ⇒ Integer

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/believe/internal/skip_limit_page.rb', line 26

def skip
  @skip
end

#total ⇒ Integer

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/believe/internal/skip_limit_page.rb', line 23

def total
  @total
end

Instance Method Details

#auto_paging_each(&blk) {|| ... } ⇒ Object

Parameters:

  • blk (Proc)

Yield Parameters:

  • (generic<Elem>) 


48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/believe/internal/skip_limit_page.rb', line 48

def auto_paging_each(&blk)
  unless block_given?
    raise ArgumentError.new("A block must be given to ##{__method__}")
  end

  page = self
  loop do
    page.data&.each(&blk)

    break unless page.next_page?
    page = page.next_page
  end
end

#inspect ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 


83
84
85
86
87
 
# File 'lib/believe/internal/skip_limit_page.rb', line 83

def inspect
  model = ::Believe::Internal::Type::Converter.inspect(@model, depth: 1)

  "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} total=#{total.inspect} skip=#{skip.inspect}>"
end

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (::Believe::HTTP::Error) 


35
36
37
38
39
40
41
42
43
 
# File 'lib/believe/internal/skip_limit_page.rb', line 35

def next_page
  unless next_page?
    message = "No more pages available. Please check #next_page? before calling ##{__method__}"
    raise RuntimeError.new(message)
  end

  req = ::Believe::Internal::Util.deep_merge(@req, {query: {skip: skip.to_i + data.to_a.size}})
  @client.request(req)
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/believe/internal/skip_limit_page.rb', line 29

def next_page?
  !data.to_a.empty? && (skip.to_i + data.to_a.size < total.to_i)
end