Module: Sequel::Plugins::StaticCache::ClassMethods

Defined in:
lib/sequel/plugins/static_cache.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cache ⇒ Object (readonly)

A frozen ruby hash holding all of the model’s frozen instances, keyed by frozen primary key.



49
50
51
 
# File 'lib/sequel/plugins/static_cache.rb', line 49

def cache
  @cache
end

Instance Method Details

#all ⇒ Object

An array of all of the model’s frozen instances, without issuing a database query.



53
54
55
56
57
58
59
 
# File 'lib/sequel/plugins/static_cache.rb', line 53

def all
  if @static_cache_frozen
    @all.dup
  else
    map{|o| o}
  end
end

#cache_get_pk(pk) ⇒ Object

Return the frozen object with the given pk, or nil if no such object exists in the cache, without issuing a database query.



72
73
74
 
# File 'lib/sequel/plugins/static_cache.rb', line 72

def cache_get_pk(pk)
  static_cache_object(cache[pk])
end

#count(*a, &block) ⇒ Object

Get the number of records in the cache, without issuing a database query.



62
63
64
65
66
67
68
 
# File 'lib/sequel/plugins/static_cache.rb', line 62

def count(*a, &block)
  if a.empty? && !block
    @all.size
  else
    super
  end
end

#each(&block) ⇒ Object

Yield each of the model’s frozen instances to the block, without issuing a database query.



78
79
80
81
82
83
84
 
# File 'lib/sequel/plugins/static_cache.rb', line 78

def each(&block)
  if @static_cache_frozen
    @all.each(&block)
  else
    @all.each{|o| yield(static_cache_object(o))}
  end
end

#map(column = nil, &block) ⇒ Object

Use the cache instead of a query to get the results.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/sequel/plugins/static_cache.rb', line 87

def map(column=nil, &block)
  if column
    raise(Error, "Cannot provide both column and block to map") if block
    if column.is_a?(Array)
      @all.map{|r| r.values.values_at(*column)}
    else
      @all.map{|r| r[column]}
    end
  elsif @static_cache_frozen
    @all.map(&block)
  elsif block
    @all.map{|o| yield(static_cache_object(o))}
  else
    all.map
  end
end

#static_cache_allow_modifications? ⇒ Boolean

Ask whether modifications to this class are allowed.

Returns:

  • (Boolean) 


166
167
168
 
# File 'lib/sequel/plugins/static_cache.rb', line 166

def static_cache_allow_modifications?
  !@static_cache_frozen
end

#to_hash(key_column = nil, value_column = nil) ⇒ Object

Use the cache instead of a query to get the results.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/sequel/plugins/static_cache.rb', line 108

def to_hash(key_column = nil, value_column = nil)
if key_column.nil? && value_column.nil?
  if @static_cache_frozen
    return cache.dup
  else
    key_column = primary_key
  end
end

h = {}
if value_column
  if value_column.is_a?(Array)
    if key_column.is_a?(Array)
      @all.each{|r| h[r.values.values_at(*key_column)] = r.values.values_at(*value_column)}
    else
      @all.each{|r| h[r[key_column]] = r.values.values_at(*value_column)}
    end
  else
    if key_column.is_a?(Array)
      @all.each{|r| h[r.values.values_at(*key_column)] = r[value_column]}
    else
      @all.each{|r| h[r[key_column]] = r[value_column]}
    end
  end
elsif key_column.is_a?(Array)
  @all.each{|r| h[r.values.values_at(*key_column)] = static_cache_object(r)}
else
  @all.each{|r| h[r[key_column]] = static_cache_object(r)}
end
h
end

#to_hash_groups(key_column, value_column = nil) ⇒ Object

Use the cache instead of a query to get the results



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/sequel/plugins/static_cache.rb', line 141

def to_hash_groups(key_column, value_column = nil)
  h = {}
  if value_column
    if value_column.is_a?(Array)
      if key_column.is_a?(Array)
        @all.each{|r| (h[r.values.values_at(*key_column)] ||= []) << r.values.values_at(*value_column)}
      else
        @all.each{|r| (h[r[key_column]] ||= []) << r.values.values_at(*value_column)}
      end
    else
      if key_column.is_a?(Array)
        @all.each{|r| (h[r.values.values_at(*key_column)] ||= []) << r[value_column]}
      else
        @all.each{|r| (h[r[key_column]] ||= []) << r[value_column]}
      end
    end
  elsif key_column.is_a?(Array)
    @all.each{|r| (h[r.values.values_at(*key_column)] ||= []) << static_cache_object(r)}
  else
    @all.each{|r| (h[r[key_column]] ||= []) << static_cache_object(r)}
  end
  h
end