cache_store 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06d887fb2a9be3c965f80c4abcf44b20880ec695
-  data.tar.gz: b28e631bb46f71a12585691c737993392d7e9dd9
+  metadata.gz: 5dc239d2d8d6b832f63b25854dc9009af6ed78d1
+  data.tar.gz: d6a52f7295ca4c87f8df7c087970d41aa4e89365
 SHA512:
-  metadata.gz: 0c22390d96e6d7fedd435ef3dadd7fefa9e7c1c5f78a0690a9ce97f28aa7cc0e31ca881fbcfe517eb35b1096606842b7532c1a1f4b5bba7e12316c789b34aa2a
-  data.tar.gz: 81a277cb0784b3e17b39d88f43dcd22ece0cfab5b48bd679bf9bc98c42c3663c02185f33fa4deff1fc54d6a5a22f385ecff2e95e61e45a4a1b0b78162f74fbfd
+  metadata.gz: 911a9b82aeaabced69dff80b7413f2b2d491f6928db7e4930b9a4c5e06c4505dc5aeb27fe9dce6c3d27f3591bb037e11bc7bc6f440409f2bd0e3ed5d03034c58
+  data.tar.gz: cf5487f8bb0e3e92b5129ef9061365c882f7a03aaa72581b3084b4da754a08a7bdcf72334680ded5e5f88e1f3203d87bde8f269eb41643e94cbd7f9e00dd8b1f

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cache_store.gemspec
 gemspec
-
-gem 'pry'

data/lib/cache_store/version.rb

@@ -1,3 +1,3 @@
 module CacheStore
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/cache_store.rb

@@ -1,6 +1,5 @@
 require "cache_store/version"
 require 'date'
-require 'pry'
 #This class is used to define the contract that CacheStore implementations must adhere to.
 class CacheStoreContract
 
@@ -53,9 +52,9 @@ class LocalCacheStore
 
   #This method is called to set a value within this cache store by it's 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.
+  # @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.
   def set(key, value, expires_in = 0)
     remove(build_key(key))
     expires = nil
@@ -68,9 +67,10 @@ class LocalCacheStore
 
   #This method is called to get a value from this cache store by it's 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.
+  # @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.
+  # @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
@@ -103,14 +103,15 @@ class LocalCacheStore
 
   # This method is called to remove a value from this cache store by it's unique key.
   #
-  # @param [String] This is the unique key to reference the value to remove from this cache store.
+  # @param key [String] This is the unique key to reference the value to remove from this cache store.
   def remove(key)
     @store.delete_if { |i| i[:key] == build_key(key) }
   end
 
   # This method is called to check 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.
+  # @param key [String] This is 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler