cache_store 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60903e1a173dbf748fc9ab48999c40efbe1853e1
-  data.tar.gz: 868aab69ff4a3756ab914af8235ed5402dd99e57
+  metadata.gz: 93720eeece64e0348cdd1429dd754b61e585b149
+  data.tar.gz: a8e5be29d169ab8f6c591c74b318f7792edcb2cc
 SHA512:
-  metadata.gz: 280b41390880517b20acf39e6430c6cb1d55aa0425d23fe9978ab20e6593c076f47da3155e3f297a770a11d368c8aa65a32c8895f5acdc75c47abfe7671f9f9e
-  data.tar.gz: 506de091b4e66fb91ca7e16356029d68831890307061010471c4ad833295d72f26c3f2360b764bb7cdf11680717c6b0b640c1e112dbafd00e8f990a5a58425f4
+  metadata.gz: 85e5d98a7b73fd8f70b376d70b37975b7394e98dc9eee1130021a3e09be8bdb85edf44022f519fe34da7253e931300159f29492b766e14c51b46e70a807d8d77
+  data.tar.gz: 45cb0f6d93159bea98aac9b1b9abbc0771b4778c78de191cd9697f4836ab75faff34836bdfb6ba0c1eaba1517216026e4b356b2271d9df24f5d02251f8a4be46

data/lib/cache_store.rb

@@ -1,130 +1,100 @@
-require "cache_store/version"
+# frozen_string_literal: true
+
+require 'cache_store/version'
 require 'date'
 require 'time'
-#This class is used to define the contract that CacheStore implementations must adhere to.
-class CacheStoreContract
 
+# Defines the contract that CacheStore implementations must adhere to.
+class CacheStoreContract
   def initialize(namespace = '')
-    @namespace = namespace
   end
 
-  #This method is called to set a value within this cache store by it's key.
+  # Sets a value within this cache store by its key.
   #
   # @param [String] This is the unique key to reference the value being set within this cache store.
   # @param [Object] This is the value to set within this cache store.
   # @param [Integer] This is the number of seconds from the current time that this value should expire.
   def set(key, value, expires_in = 0)
-
   end
 
-  #This method is called to get a value from this cache store by it's unique key.
+  # Gets a value from this cache store by its unique key.
   #
   # @param [String] This is the unique key to reference the value to fetch from within this cache store.
   # @param [Integer] This is the number of seconds from the current time that this value should expire. (This is used in conjunction with the block to hydrate the cache key if it is empty.)
   # @param [Block] This block is provided to hydrate this cache store with the value for the request key when it is not found.
   def get(key, expires_in = 0, &block)
-
   end
 
-  # This method is called to remove a value from this cache store by it's unique key.
+  # Removes a value from this cache store by its unique key.
   #
   # @param [String] This is the unique key to reference the value to remove from this cache store.
   def remove(key)
-
   end
 
-  # This method is called to check if a value exists within this cache store for a specific key.
+  # Checks if a value exists within this cache store for a specific key.
   #
   # @param [String] This is the unique key to reference the value to check for within this cache store.
   def exist?(key)
-
   end
 end
 
-#This class is used to implement a local in memory cache store.
+# Implements a local in-memory cache store.
 class LocalCacheStore
-
-  attr_accessor :store
-
-  def initialize(namespace = nil)
-    @store = Array.new
-    @namespace = namespace
+  def initialize(_namespace = nil)
+    @store = {}
   end
 
-  #This method is called to set a value within this cache store by it's key.
+  # Stores a value in this cache store by its key.
   #
-  # @param key [String] This is the unique key to reference the value being set within this cache store.
-  # @param value [Object] This is the value to set within this cache store.
-  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
+  # @param key [String] The unique key to reference the value being set.
+  # @param value [Object] The value to store.
+  # @param expires_in [Integer] The number of seconds from the current time that this value should expire.
   def set(key, value, expires_in = 0)
-    remove(key)
-    expires = nil
     if expires_in > 0
-      expires = Time.now.utc + expires_in
+      expires = Time.now + expires_in
     end
-    @store.push({ key: build_key(key), value: value, expires: expires})
+    @store.store(key, {value: value, expires: expires})
   end
 
-  #This method is called to get a value from this cache store by it's unique key.
+  # Gets a value from this cache store by its unique key.
   #
-  # @param key [String] This is the unique key to reference the value to fetch from within this cache store.
-  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire. (This is used in conjunction with the block to hydrate the cache key if it is empty.)
-  # @param &block [Block] This block is provided to hydrate this cache store with the value for the request key when it is not found.
+  # @param key [String] Unique key to reference the value to fetch from within this cache store.
+  # @param &block [Block] This block is provided to populate this cache store with the value for the request key when it is not found.
   # @return [Object] The value for the specified unique key within the cache store.
-  def get(key, expires_in = 0, &block)
-
-    #look for the cache item in the store
-    items = @store.select { |i| i[:key] == build_key(key) }
-    item = if !items.empty? then items[0] else nil end
-    #check if a valid item was found in the store
-    if item == nil || (item[:expires] != nil && item[:expires] <= Time.now.utc)
-      #a valid item wasn't found so check if a hydration block was specified.
-      if block_given?
-        #create the item from the block
-        value = yield
-        #put the item in the store
-        set(build_key(key), value, expires_in)
-        return value
-      else
-        #no hydration block was specified
-
-        #check if an expired item was found
-        if item != nil
-          #remove the expired item from the store
-          remove(build_key(key))
+  def get(key, expires_in = 0)
+    item = @store[key]
+    if item
+      if item[:expires] && item[:expires] < Time.now # An expired entry has been found
+        if block_given?
+          value = yield
+          set(key, value, expires_in)
+          return value
+        else
+          remove(key)
+          return nil
         end
-        return nil
+      else # An item was found which has not expired
+        return item[:value]
       end
+    elsif block_given?
+      value = yield
+      set(key, value, expires_in)
+      return value
     end
-
-    #return the item
-    return item[:value]
   end
 
-  # This method is called to remove a value from this cache store by it's unique key.
+  # Removes a value from this cache store by its unique key.
   #
-  # @param key [String] This is the unique key to reference the value to remove from this cache store.
+  # @param key [String] The unique key to remove from this cache store.
   def remove(key)
-    @store.delete_if { |i| i[:key] == build_key(key) }
+    @store.delete key
   end
 
-  # This method is called to check if a value exists within this cache store for a specific key.
+  # Checks if a value exists within this cache store for a specific key.
   #
-  # @param key [String] This is the unique key to reference the value to check for within this cache store.
+  # @param key [String] The unique key to reference the value to check for within this cache store.
   # @return [Boolean] True or False to specify if the key exists in the cache store.
   def exist?(key)
-    !@store.select { |i| i[:key] == build_key(key) }.empty?
-  end
-
-  private
-
-  def build_key(key)
-    k = ''
-    if @namespace != nil
-      k = @namespace + ':' + key.to_s
-    elsif
-      k = key.to_s
-    end
-    k
+    @store.key? key
   end
 end

data/lib/cache_store/version.rb

@@ -1,3 +1,3 @@
 module CacheStore
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_store
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,4 +99,3 @@ summary: This is the base for a cache framework that includes a basic in memory
   store, along with a dependency contract for additional provider implementations
   plugins.
 test_files: []
-has_rdoc: