Class: Spree::Preferences::StoreInstance

Inherits:
Object
  • Object
show all
Defined in:
app/models/spree/preferences/store.rb

Direct Known Subclasses

Store

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeStoreInstance

Returns a new instance of StoreInstance


14
15
16
17
# File 'app/models/spree/preferences/store.rb', line 14

def initialize
  @cache = Rails.cache
  @persistence = true
end

Instance Attribute Details

#persistenceObject

Returns the value of attribute persistence


12
13
14
# File 'app/models/spree/preferences/store.rb', line 12

def persistence
  @persistence
end

Instance Method Details

#clear_cacheObject


67
68
69
# File 'app/models/spree/preferences/store.rb', line 67

def clear_cache
  @cache.clear
end

#delete(key) ⇒ Object


62
63
64
65
# File 'app/models/spree/preferences/store.rb', line 62

def delete(key)
  @cache.delete(key)
  destroy(key)
end

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean)

25
26
27
28
# File 'app/models/spree/preferences/store.rb', line 25

def exist?(key)
  @cache.exist?(key) ||
  should_persist? && Spree::Preference.where(:key => key).exists?
end

#get(key) ⇒ Object Also known as: fetch


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
# File 'app/models/spree/preferences/store.rb', line 30

def get(key)
  # return the retrieved value, if it's in the cache
  # use unless nil? incase the value is actually boolean false
  #
  unless (val = @cache.read(key)).nil?
    return val
  end

  if should_persist?
    # If it's not in the cache, maybe it's in the database, but
    # has been cleared from the cache

    # does it exist in the database?
    if preference = Spree::Preference.find_by_key(key)
      # it does exist
      val = preference.value
    else
      # use the fallback value
      val = yield
    end

    # Cache either the value from the db or the fallback value.
    # This avoids hitting the db with subsequent queries.
    @cache.write(key, val)

    return val
  else
    yield
  end
end

#set(key, value) ⇒ Object Also known as: []=


19
20
21
22
# File 'app/models/spree/preferences/store.rb', line 19

def set(key, value)
  @cache.write(key, value)
  persist(key, value)
end