/
collection.rb
79 lines (66 loc) · 2.55 KB
/
collection.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# frozen_string_literal: true
module Restforce
class Collection
include Enumerable
# Given a hash and client, will create an Enumerator that will lazily
# request Salesforce for the next page of results.
def initialize(hash, client)
@client = client
@raw_page = hash
end
# Yield each value on each page.
def each(&block)
@raw_page['records'].each { |record| yield Restforce::Mash.build(record, @client) }
np = next_page
while np
np.current_page.each(&block)
np = np.next_page
end
end
# Return the size of each page in the collection
def page_size
@raw_page['records'].size
end
# Return the number of items in the Collection without making any additional
# requests and going through all of the pages of results, one by one. Instead,
# we can rely on the total count of results which Salesforce returns.
#
# Most of the Salesforce API returns this in the `totalSize` attribute. For
# some reason, the [List View Results](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_listviewresults.htm)
# endpoint (and maybe others?!) uses the `size` attribute.
def size
@raw_page['totalSize'] || @raw_page['size']
end
alias length size
def count(*args)
# By default, `Enumerable`'s `#count` uses `#each`, which means going through all
# of the pages of results, one by one. Instead, we can use `#size` which we have
# already overridden to work in a smarter, more efficient way. This only works for
# the simple version of `#count` with no arguments. When called with an argument or
# a block, you need to know what the items in the collection actually are, so we
# call `super` and end up iterating through each item in the collection.
return size unless block_given? || !args.empty?
super
end
# Returns true if the size of the Collection is zero.
def empty?
size.zero?
end
# Return array of the elements on the current page
def current_page
first(@raw_page['records'].size)
end
# Return the current and all of the following pages.
def pages
[self] + (has_next_page? ? next_page.pages : [])
end
# Returns true if there is a pointer to the next page.
def has_next_page?
!@raw_page['nextRecordsUrl'].nil?
end
# Returns the next page as a Restforce::Collection if it's available, nil otherwise.
def next_page
@client.get(@raw_page['nextRecordsUrl']).body if has_next_page?
end
end
end