Class: Hikki::Collection

Inherits:
Object
  • Object
show all
Defined in:
lib/hikki/collection.rb

Direct Known Subclasses

Adapters::MemoryCollection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection) ⇒ Collection

Returns a new instance of Collection.



7
8
9
 
# File 'lib/hikki/collection.rb', line 7

def initialize(collection)
  @collection = collection.to_s
end

Instance Attribute Details

#collection ⇒ Object (readonly)

Returns the value of attribute collection.



5
6
7
 
# File 'lib/hikki/collection.rb', line 5

def collection
  @collection
end

Instance Method Details

#all(options) ⇒ Object 



23
24
25
 
# File 'lib/hikki/collection.rb', line 23

def all(options)
  raise 'Implementation missing.'
end

#deep_copy(h) ⇒ Object 



43
44
45
 
# File 'lib/hikki/collection.rb', line 43

def deep_copy(h)
  JSON.parse(h.to_json)
end

#find(id) ⇒ Object 



19
20
21
 
# File 'lib/hikki/collection.rb', line 19

def find(id)
  raise 'Implementation missing.'
end

#find_by(field, value, options) ⇒ Object 



27
28
29
 
# File 'lib/hikki/collection.rb', line 27

def find_by(field, value, options)
  raise 'Implementation missing.'
end

#id_for(data) ⇒ Object 



47
48
49
 
# File 'lib/hikki/collection.rb', line 47

def id_for(data)
  data.fetch('id', 'undefined').to_s
end

#index(field) ⇒ Object 



11
12
13
 
# File 'lib/hikki/collection.rb', line 11

def index(field)
  raise 'Implementation missing.'
end

#normalize_data(data) ⇒ Object 



39
40
41
 
# File 'lib/hikki/collection.rb', line 39

def normalize_data(data)
  deep_copy(data).tap { |d| d.merge!('id' => id_for(d)) }
end

#normalize_options(options) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/hikki/collection.rb', line 51

def normalize_options(options)
  {
    limit: options[:limit] || options['limit'] || -1,
    offset: options[:offset] || options['offset'] || 0
  }
end

#page_range(options) ⇒ Object 



58
59
60
 
# File 'lib/hikki/collection.rb', line 58

def page_range(options)
  (options[:offset]..(options[:limit] == -1 ? -1 : options[:offset] + options[:limit] - 1))
end

#remove(id) ⇒ Object 



31
32
33
 
# File 'lib/hikki/collection.rb', line 31

def remove(id)
  raise 'Implementation missing.'
end

#remove_all ⇒ Object 



35
36
37
 
# File 'lib/hikki/collection.rb', line 35

def remove_all
  raise 'Implementation missing.'
end

#save(data) ⇒ Object 



15
16
17
 
# File 'lib/hikki/collection.rb', line 15

def save(data)
  raise 'Implementation missing.'
end