mini_cache 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d667eb0ee357eea898da78996e2641164ee66c6c
-  data.tar.gz: 5d8daab29c61434ccc298f59e2c313507be4d181
+  metadata.gz: a985472b71d6f27c56bbc2f4eb78e9a6587d3a46
+  data.tar.gz: dbf5cc0c90cf4d555cb315c526dbf12d67d8e177
 SHA512:
-  metadata.gz: 2de1d028b8ea353425e84e971e2fb572f69dc95748d8a7fafde1513d5d5b37d67afbb454fa0fe1074c4551fbf820c1dec06382d8df70c5a360ebf6eeee457f1e
-  data.tar.gz: 0d932bf0b9ff36e6252ea4e452da53ea56d6fc844066e024880b548e06cae39e16f1061742d2c0a3ddbfa9fb821460fdba11a1e139d194b64489c983ebd1c616
+  metadata.gz: a6940e77b4988ca034d6c031c564613ed79e0ffe2d140d06b70a2b59ef6ae7dcdb10e19b75f91a08c9bd872a942a391e583529ee948c1911089a8ad9373b7af2
+  data.tar.gz: e7e1687c3b0c58b7d189ac43f0d5bd8fa06a3224650393faf415e660239694fa9cf1ea6e4e836a3dfe5e8108ebb10bf34b96956d11b8973d87ffff9978c2854c

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-04-22 10:39:26 -0500 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 68
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 227
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/mini_cache/data.rb'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.0

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mini_cache.gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Derrick Reimer
+Copyright (c) 2017 Derrick Reimer
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,16 +1,15 @@
 # MiniCache
 
-MiniCache is a lightweight in-memory key-value store for Ruby objects.
-This gem has no external dependencies and has been tested in MRI 1.9.x and
-JRuby 1.9 mode.
+[![Build Status](https://travis-ci.org/djreimer/mini_cache.svg?branch=master)](https://travis-ci.org/djreimer/mini_cache)
 
-Extracted from [Leadscreener](http://www.leadscreener.com/).
+MiniCache is a lightweight in-memory key-value store for Ruby objects.
+This gem requires Ruby version 2.3.0 or higher.
 
 ## Motivation
 
-It is common practice to cache certain values on an object that are 
-computationally expensive to obtain, such as a property that requires a 
-database query. 
+It is common practice to cache certain values on an object that are
+computationally expensive to obtain, such as a property that requires a
+database query.
 
 The simplest way to do this is by storing the value in an instance variable:
 
@@ -19,14 +18,14 @@ class Account
   def calculate_balance
     # Do something expensive.
   end
-  
+
   def balance
     @balance ||= self.calculate_balance
   end
 end
 ```
 
-While this method works in many scenarios, it fails when the value you 
+While this method works in many scenarios, it fails when the value you
 need to cache is:
 
 - Either `nil` or `false`
@@ -39,7 +38,7 @@ class Account
   def lookup_role(user)
     # Execute a database query to find the user's role.
   end
-  
+
   def role(user)
     # Perform the lookup once and cache the value. We can't use
     #
@@ -53,14 +52,14 @@ class Account
       self.lookup_role(user)
     end
   end
-  
+
   def cache
     @cache ||= MiniCache::Store.new
   end
 end
 ```
 
-The `#get_or_set` method works similarly to the `||=` operator, except it 
+The `#get_or_set` method works similarly to the `||=` operator, except it
 knows how to handle `false` and `nil` values and it's keyed off of a unique string ID.
 Problem solved!
 
@@ -86,29 +85,77 @@ To create a new MiniCache store object, just initialize it:
 store = MiniCache::Store.new
 
 # Optionally pass in a Hash of data
-store = MiniCache::Store.new(:name => "Derrick", :occupation => "Developer")
+store = MiniCache::Store.new(name: 'Derrick', occupation: 'Developer')
 ```
 
 Set and retrieve data using `#get` and `#set`:
 
 ```ruby
 # Pass in the value as an argument or block
-store.set("age", 24)
-store.set("birth_year") { 1988 }
+store.set('age', 24)
+store.set('birth_year') { 1988 }
+
+store.get('age')
+# => 24
+
+store.get('birth_year')
+# => 1988
+
+# Sets an expiration time to cache (in seconds)
+store.set('age', 24, expires_in: 60)
+store.set('day', expires_in: 60) { 12 }
+store.set('birth_year') { MiniCache::Data.new(1988, 60) }
+
+store.get('age')
+# => 24
+
+store.get('day')
+# => 12
+
+store.get('birth_year')
+# => 1988
+
+sleep(60)
+
+store.get('age')
+# => nil
+
+store.get('day')
+# => nil
 
-store.get("birth_year")
-=> 1988
+store.get('birth_year')
+#=> nil
 ```
 
 Use the `#get_or_set` method to either set the value if it hasn't already been
 set, or get the value that was already set.
 
 ```ruby
-store.set("birth_year") { 1988 }
-=> 1988
+store.set('birth_year') { 1988 }
+#=> 1988
 
-store.get_or_set("birth_year") { 1964 }
-=> 1988  # Did not overwrite previously set value
+store.get_or_set('birth_year') { 1964 }
+#=> 1988  # Did not overwrite previously set value
+
+# You may also set an expiration time (in seconds):
+
+store.get_or_set('age', expires_in: 60) { 24 }
+#=> 24
+
+store.get_or_set('birth_year') do
+  MiniCache::Data.new(1988, expires_in: 60)
+end
+#=> 1988
+
+sleep(60)
+
+store.get_or_set('age', expires_in: 60) { 28 }
+#=> 28
+
+store.get_or_set('birth_year') do
+  MiniCache::Data.new(1964, expires_in: 60)
+end
+#=> 1964
 ```
 
 Other convenience methods:
@@ -125,28 +172,3 @@ Other convenience methods:
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-## License
-
-Copyright © 2012 Derrick Reimer
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,12 +1,20 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new do |t|
-  t.libs << "lib"
-  t.pattern = "test/**/*_test.rb"
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc "Run tests"
-task :default => :test
+RuboCop::RakeTask.new
+
+desc 'Run tests'
+task :default do
+  Rake::Task['rubocop'].invoke
+  Rake::Task['test'].invoke
+end

data/lib/mini_cache.rb

@@ -1,2 +1,5 @@
-require "mini_cache/version"
-require "mini_cache/store"
+# frozen_string_literal: true
+
+require 'mini_cache/version'
+require 'mini_cache/data'
+require 'mini_cache/store'

data/lib/mini_cache/data.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MiniCache
+  class Data
+    attr_reader :value
+    attr_reader :expires_in
+
+    def initialize(value, expires_in: nil)
+      @value = value
+      @expires_in = expires_in.nil? ? nil : Time.now + expires_in
+    end
+
+    def expired?
+      !@expires_in.nil? && Time.now > @expires_in
+    end
+
+    def ==(other)
+      other.is_a?(MiniCache::Data) && @value == other.value
+    end
+  end
+end

data/lib/mini_cache/store.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module MiniCache
-  class Store
+  class Store # :nodoc:
     include Enumerable
 
     # Public: Returns the hash of key-value pairs.
@@ -8,11 +10,12 @@ module MiniCache
     # Public: Initializes a new MiniCache object.
     #
     # data - A Hash of key-value pairs (optional).
+    #        The values can be String or MiniCache::Data.
     #
     # Returns nothing.
     def initialize(data = {})
       @data = {}
-      self.load(data)
+      load(data)
     end
 
     # Public: Retrieves the value for a given key.
@@ -23,7 +26,8 @@ module MiniCache
     #   set, returns nil.
     def get(key)
       check_key!(key)
-      @data[key.to_s]
+      expires!(key)
+      @data[key.to_s]&.value
     end
 
     # Public: Sets a value for a given key either as
@@ -31,22 +35,37 @@ module MiniCache
     #
     # key   - A String or Symbol representing the key.
     # value - Any object that represents the value (optional).
+    #         The value can be a MiniCache::Data.
     #         Not used if a block is given.
-    # block - A block of code that returns the value to set
-    #         (optional).
+    # block - A block of code that returns the value to set (optional).
+    #         Can be set a MiniCache::Data in the block.
+    # expires_in - Time, in seconds, to expire the cache (optional).
+    #              If not set, the cache never expires.
     #
     # Examples
     #
     #   cache.set("name", "Derrick")
     #   => "Derrick"
     #
+    #   cache.set("name", "Derrick", expires_in: 60)
+    #   => "Derrick"
+    #
     #   cache.set("name") { "Joe" }
     #   => "Joe"
     #
+    #   cache.set("name") { MiniCache::Data.new("Joe", 60) }
+    #   => "Joe"
+    #
     # Returns the value given.
-    def set(key, value = nil)
+    def set(key, value = nil, expires_in: nil)
       check_key!(key)
-      @data[key.to_s] = block_given? ? yield : value
+      data = block_given? ? yield : value
+      @data[key.to_s] = if data.is_a?(MiniCache::Data)
+                          data
+                        else
+                          MiniCache::Data.new(data, expires_in: expires_in)
+                        end
+      get(key)
     end
 
     # Public: Determines whether a value has been set for
@@ -57,6 +76,7 @@ module MiniCache
     # Returns a Boolean.
     def set?(key)
       check_key!(key)
+      expires!(key)
       @data.keys.include?(key.to_s)
     end
 
@@ -66,9 +86,12 @@ module MiniCache
     #
     # key   - A String or Symbol representing the key.
     # value - Any object that represents the value (optional).
+    #         The value can be a MiniCache::Data.
     #         Not used if a block is given.
-    # block - A block of code that returns the value to set
-    #         (optional).
+    # block - A block of code that returns the value to set (optional).
+    #         Can be set a MiniCache::Data in the block.
+    # expires_in - Time, in seconds, to expire the cache (optional).
+    #              If not set, the cache never expires.
     #
     # Examples
     #
@@ -85,9 +108,9 @@ module MiniCache
     #   => "Engineer"
     #
     # Returns the value.
-    def get_or_set(key, value = nil)
+    def get_or_set(key, value = nil, expires_in: nil)
       return get(key) if set?(key)
-      set(key, block_given? ? yield : value)
+      set(key, block_given? ? yield : value, expires_in: expires_in)
     end
 
     # Public: Removes the key-value pair from the cache
@@ -114,7 +137,7 @@ module MiniCache
     #         and value of each pair.
     #
     # Yields the String key and value.
-    def each(&block)
+    def each
       @data.each { |k, v| yield(k, v) }
     end
 
@@ -126,20 +149,24 @@ module MiniCache
     def load(data)
       data.each do |key, value|
         check_key!(key)
-        @data[key.to_s] = value
+        set(key, value)
       end
     end
 
     private
 
-      # Internal: Raises an error if the key is not a String
-      # or a Symbol.
-      #
-      # key - A key provided by the user.
-      def check_key!(key)
-        unless key.is_a?(String) || key.is_a?(Symbol)
-          raise TypeError, "key must be a String or Symbol"
-        end
-      end
+    # Internal: Raises an error if the key is not a String
+    # or a Symbol.
+    #
+    # key - A key provided by the user.
+    def check_key!(key)
+      return if key.is_a?(String) || key.is_a?(Symbol)
+      raise TypeError, 'key must be a String or Symbol'
+    end
+
+    # Internal: Verifies if data is expired and unset it
+    def expires!(key)
+      unset(key) if @data[key.to_s]&.expired?
+    end
   end
 end

data/lib/mini_cache/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiniCache
-  VERSION = "1.0.1"
+  VERSION = '1.1.0'
 end

data/mini_cache.gemspec

@@ -1,19 +1,26 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 require File.expand_path('../lib/mini_cache/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Derrick Reimer"]
-  gem.email         = ["derrickreimer@gmail.com"]
-  gem.description   = %q{A lightweight, in-memory cache for Ruby objects}
-  gem.summary       = %q{MiniCache is a lightweight, in-memory key-value store for Ruby objects}
-  gem.homepage      = "https://github.com/djreimer/mini_cache"
+  gem.authors       = ['Derrick Reimer']
+  gem.email         = ['derrickreimer@gmail.com']
+  gem.description   = 'A lightweight, in-memory cache for Ruby objects'
+  gem.summary       = 'MiniCache is a lightweight, in-memory key-value store' \
+    'for Ruby objects'
+  gem.homepage      = 'https://github.com/djreimer/mini_cache'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "mini_cache"
-  gem.require_paths = ["lib"]
+  gem.name          = 'mini_cache'
+  gem.require_paths = ['lib']
   gem.version       = MiniCache::VERSION
-  
-  gem.add_development_dependency "shoulda-context"
+
+  gem.add_development_dependency 'shoulda-context'
+  gem.add_development_dependency 'timecop', '~> 0.8'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rubocop', '~> 0.48'
 end

data/test/mini_cache/data_test.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../test_helper.rb', __FILE__)
+
+module MiniCache
+  class DataTest < MiniTest::Test
+    context 'initialize' do
+      should 'return initialized value' do
+        data = MiniCache::Data.new('Gunter')
+        assert_equal('Gunter', data.value)
+      end
+
+      should 'return a nil expires_in as default' do
+        data = MiniCache::Data.new('Gunter')
+        assert_nil(data.expires_in)
+      end
+
+      should 'return initialized expires_in' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          data = MiniCache::Data.new('Gunter', expires_in: 60)
+          assert_equal(Time.now + 60, data.expires_in)
+        end
+      end
+    end
+
+    context '#equals' do
+      should 'be compared only by value and be the same' do
+        data1 = MiniCache::Data.new('Finn', expires_in: 10)
+        data2 = MiniCache::Data.new('Finn', expires_in: 30)
+        assert_equal(data1, data2)
+      end
+
+      should 'be compared only by value and not be the same' do
+        data1 = MiniCache::Data.new('Finn', expires_in: 10)
+        data2 = MiniCache::Data.new('Grass Finn', expires_in: 10)
+        refute_equal(data1, data2)
+      end
+    end
+
+    context '#expired?' do
+      should 'be expired' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          data = MiniCache::Data.new('Gunter', expires_in: 60)
+          Timecop.travel(data.expires_in) do
+            assert_equal(true, data.expired?)
+          end
+        end
+      end
+
+      should 'not be expired' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          data = MiniCache::Data.new('Gunter', expires_in: 60)
+          Timecop.travel(data.expires_in - 1) do
+            assert_equal(false, data.expired?)
+          end
+        end
+      end
+
+      should 'not be expired because expires_in is nil' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          data = MiniCache::Data.new('Gunter')
+          assert_equal(false, data.expired?)
+        end
+      end
+    end
+  end
+end

data/test/mini_cache/store_test.rb

@@ -1,138 +1,272 @@
-require File.dirname(__FILE__) + '/../test_helper.rb'
+# frozen_string_literal: true
 
-class MiniCache::StoreTest < Test::Unit::TestCase
-  def setup
-    @store = MiniCache::Store.new
-  end
-  
-  context "initialize" do
-    should "default to empty data" do
-      store = MiniCache::Store.new
-      assert_equal Hash.new, store.data
-    end
-    
-    should "load seed data" do
-      data = { "name" => "Derrick" }
-      store = MiniCache::Store.new(data)
-      assert_equal data, store.data
-    end
-  end
-  
-  context "#get" do
-    should "return a value if set" do
-      @store.set("name", "Derrick")
-      assert_equal "Derrick", @store.get("name")
-    end
-    
-    should "return nil if not set" do
-      assert_nil @store.get("name")
-    end
-    
-    should "raise a TypeError if key is not valid" do
-      assert_raises(TypeError) { @store.get([1, 2]) }
-    end
-  end
-  
-  context "#set" do
-    should "accept the value as an argument" do
-      @store.set("name", "Derrick")
-      assert_equal "Derrick", @store.get("name")
-    end
-    
-    should "accept the value as a block" do
-      @store.set("name") { "Derrick" }
-      assert_equal "Derrick", @store.get("name")
-    end
-    
-    should "raise a TypeError if key is not valid" do
-      assert_raises(TypeError) { @store.set([1, 2], "foo") }
-    end
-  end
-  
-  context "#set?" do
-    should "be true if key has been set" do
-      @store.set("name", "Derrick")
-      assert_equal true, @store.set?("name")
-    end
-    
-    should "be false if key has not been set" do
-      assert_equal false, @store.set?("foobar")
-    end
-    
-    should "raise a TypeError if key is not valid" do
-      assert_raises(TypeError) { @store.set?([1, 2]) }
-    end
-  end
-  
-  context "#get_or_set" do
-    should "set the value if it hasn't already been set" do
-      @store.get_or_set("name", "Derrick")
-      assert_equal "Derrick", @store.get("name")
-    end
-    
-    should "not set the value if it has already been set" do
-      @store.set("name", "Derrick")
-      @store.get_or_set("name", "Joe")
-      assert_equal "Derrick", @store.get("name")
-    end
-    
-    should "return the value if not already set" do
-      assert_equal "Derrick", @store.get_or_set("name", "Derrick")
+require File.expand_path('../../test_helper.rb', __FILE__)
+
+module MiniCache
+  class StoreTest < MiniTest::Test
+    def setup
+      @store = MiniCache::Store.new
     end
-    
-    should "return the value if already set" do
-      @store.set("name", "Derrick")
-      assert_equal "Derrick", @store.get_or_set("name", "Joe")
+
+    context 'initialize' do
+      should 'default to empty data' do
+        store = MiniCache::Store.new
+        assert_equal({}, store.data)
+      end
+
+      should 'load seed data' do
+        data = { 'name' => 'Derrick' }
+        store = MiniCache::Store.new(data)
+        assert_equal(
+          { data.keys.first => MiniCache::Data.new(data.values.first) },
+          store.data
+        )
+      end
+
+      should 'load seed data using MiniCache::Data' do
+        data = { 'name' => MiniCache::Data.new('Derrick', expires_in: 60) }
+        store = MiniCache::Store.new(data)
+        assert_equal(
+          data,
+          store.data
+        )
+      end
     end
-    
-    should "accept the value as a block" do
-      @store.get_or_set("name") { "Joe" }
-      assert_equal "Joe", @store.get("name")
+
+    context '#get' do
+      should 'return a value if set' do
+        @store.set('name', 'Derrick')
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'return nil if not set' do
+        assert_nil @store.get('name')
+      end
+
+      should 'raise a TypeError if key is not valid' do
+        assert_raises(TypeError) { @store.get([1, 2]) }
+      end
+
+      should 'return an not expired value' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.set('name', 'Derrick', expires_in: 60)
+          Timecop.travel(Time.now + 59) do
+            assert_equal('Derrick', @store.get('name'))
+          end
+        end
+      end
+
+      should 'not return an expired value' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.set('name', 'Derrick', expires_in: 60)
+          Timecop.travel(Time.now + 60) do
+            assert_nil @store.get('name')
+          end
+        end
+      end
     end
-    
-    should "raise a TypeError if key is not valid" do
-      assert_raises(TypeError) { @store.get_or_set([1, 2], "foo") }
+
+    context '#set' do
+      should 'accept the value as an argument' do
+        @store.set('name', 'Derrick')
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'accept the value as a block' do
+        @store.set('name') { 'Derrick' }
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'accept the value as a MiniCache::Data argument' do
+        @store.set('name', MiniCache::Data.new('Derrick'))
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'accept the value as a block with MiniCache::Data' do
+        @store.set('name') { MiniCache::Data.new('Derrick') }
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'raise a TypeError if key is not valid' do
+        assert_raises(TypeError) { @store.set([1, 2], 'foo') }
+      end
+
+      should 'returns cached value' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.set('name', 'Derrick', expires_in: 60)
+          Timecop.travel(Time.now + 59) do
+            assert_equal('Derrick', @store.get('name'))
+          end
+        end
+      end
+
+      should 'returns nil, because cache was expired' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.set('name', 'Derrick', expires_in: 60)
+          Timecop.travel(Time.now + 60) do
+            assert_nil(@store.get('name'))
+          end
+        end
+      end
+
+      should 'returns cached value. Using block' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.get_or_set('name', expires_in: 60) do
+            'Derrick'
+          end
+          Timecop.travel(Time.now + 59) do
+            assert_equal('Derrick', @store.get('name'))
+          end
+        end
+      end
+
+      should 'returns nil, because cache was expired. Using block' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.get_or_set('name', expires_in: 60) do
+            'Derrick'
+          end
+          Timecop.travel(Time.now + 60) do
+            assert_nil(@store.get('name'))
+          end
+        end
+      end
     end
-  end
-  
-  context "#unset" do
-    should "remove the key-value pair" do
-      @store.set("name", "Derrick")
-      @store.unset("name")
-      assert !@store.data.keys.include?("name")
+
+    context '#set?' do
+      should 'be true if key has been set' do
+        @store.set('name', 'Derrick')
+        assert_equal true, @store.set?('name')
+      end
+
+      should 'be false if key has not been set' do
+        assert_equal false, @store.set?('foobar')
+      end
+
+      should 'raise a TypeError if key is not valid' do
+        assert_raises(TypeError) { @store.set?([1, 2]) }
+      end
     end
-  end
-  
-  context "#reset" do
-    should "remove all data" do
-      @store.set("name", "Derrick")
-      @store.reset
-      assert_equal Hash.new, @store.data
+
+    context '#get_or_set' do
+      should "set the value if it hasn't already been set" do
+        @store.get_or_set('name', 'Derrick')
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'not set the value if it has already been set' do
+        @store.set('name', 'Derrick')
+        @store.get_or_set('name', 'Joe')
+        assert_equal 'Derrick', @store.get('name')
+      end
+
+      should 'return the value if not already set' do
+        assert_equal('Derrick',
+                     @store.get_or_set('name', 'Derrick'))
+      end
+
+      should 'return the value if already set' do
+        @store.set('name', 'Derrick')
+        assert_equal 'Derrick', @store.get_or_set('name', 'Joe')
+      end
+
+      should 'accept the value as a block' do
+        @store.get_or_set('name') { 'Joe' }
+        assert_equal 'Joe', @store.get('name')
+      end
+
+      should 'raise a TypeError if key is not valid' do
+        assert_raises(TypeError) { @store.get_or_set([1, 2], 'foo') }
+      end
+
+      should 'returns first set value' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.set('name', 'Derrick', expires_in: 60)
+          Timecop.travel(Time.now + 59) do
+            @store.get_or_set('name', 'Gunter', expires_in: 60)
+            assert_equal('Derrick', @store.get('name'))
+          end
+        end
+      end
+
+      should 'returns next set value' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.set('name', 'Derrick', expires_in: 60)
+          Timecop.travel(Time.now + 60) do
+            @store.get_or_set('name', 'Gunter', expires_in: 60)
+            assert_equal('Gunter', @store.get('name'))
+          end
+        end
+      end
+
+      should 'returns first set value. Using block' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.get_or_set('name', expires_in: 60) do
+            'Derrick'
+          end
+          Timecop.travel(Time.now + 59) do
+            @store.get_or_set('name', expires_in: 60) do
+              'Gunter'
+            end
+            assert_equal('Derrick', @store.get('name'))
+          end
+        end
+      end
+
+      should 'returns next set value. Using block' do
+        Timecop.freeze(Time.local(2010, 4, 5, 12, 0, 0)) do
+          @store.get_or_set('name', expires_in: 60) do
+            'Derrick'
+          end
+          Timecop.travel(Time.now + 60) do
+            @store.get_or_set('name', expires_in: 60) do
+              'Derrick'
+            end
+            assert_equal('Derrick', @store.get('name'))
+          end
+        end
+      end
     end
-  end
-  
-  context "#load" do
-    should "append the data to the cache" do
-      @store.set("title", "Mr.")
-      
-      data = { "name" => "Derrick", "occupation" => "Developer" }
-      @store.load(data)
-      
-      all_data = { "title" => "Mr.", 
-        "name" => "Derrick", "occupation" => "Developer" }
-      assert_equal all_data, @store.data
+
+    context '#unset' do
+      should 'remove the key-value pair' do
+        @store.set('name', 'Derrick')
+        @store.unset('name')
+        assert !@store.data.keys.include?('name')
+      end
     end
-    
-    should "stringify the keys" do
-      data = { :name => "Derrick" }
-      @store.load(data)
-      stringified_data = { "name" => "Derrick" }
-      assert_equal stringified_data, @store.data
+
+    context '#reset' do
+      should 'remove all data' do
+        @store.set('name', 'Derrick')
+        @store.reset
+        assert_equal({}, @store.data)
+      end
     end
-    
-    should "raise a TypeError if an invalid key is encountered" do
-      data = { [1, 2] => "Derrick" }
-      assert_raises(TypeError) { @store.load(data) }
+
+    context '#load' do
+      should 'append the data to the cache' do
+        @store.set('title', 'Mr.')
+
+        data = { 'name' => 'Derrick', 'occupation' => 'Developer' }
+        @store.load(data)
+
+        all_data = { 'title' => MiniCache::Data.new('Mr.'),
+                     'name' => MiniCache::Data.new('Derrick'),
+                     'occupation' => MiniCache::Data.new('Developer') }
+        assert_equal all_data, @store.data
+      end
+
+      should 'stringify the keys' do
+        data = { name: 'Derrick' }
+        @store.load(data)
+        stringified_data = { 'name' => MiniCache::Data.new('Derrick') }
+        assert_equal stringified_data, @store.data
+      end
+
+      should 'raise a TypeError if an invalid key is encountered' do
+        data = { [1, 2] => 'Derrick' }
+        assert_raises(TypeError) { @store.load(data) }
+      end
     end
   end
-end
+end

data/test/test_helper.rb

@@ -1,4 +1,8 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
 require 'mini_cache'
 require 'minitest/autorun'
-require 'shoulda-context'
+require 'shoulda-context'
+require 'timecop'

metadata

@@ -1,29 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: mini_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2017-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
 description: A lightweight, in-memory cache for Ruby objects
 email:
 - derrickreimer@gmail.com
@@ -31,15 +87,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/mini_cache.rb
+- lib/mini_cache/data.rb
 - lib/mini_cache/store.rb
 - lib/mini_cache/version.rb
 - mini_cache.gemspec
+- test/mini_cache/data_test.rb
 - test/mini_cache/store_test.rb
 - test/test_helper.rb
 homepage: https://github.com/djreimer/mini_cache
@@ -51,21 +112,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: MiniCache is a lightweight, in-memory key-value store for Ruby objects
+summary: MiniCache is a lightweight, in-memory key-value storefor Ruby objects
 test_files:
+- test/mini_cache/data_test.rb
 - test/mini_cache/store_test.rb
 - test/test_helper.rb
-has_rdoc: