with_timed_cache 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db6c5fa7ef0d80a8b7f22c41b4866bfc72ddfb11
-  data.tar.gz: 7a48bf47391b62f553ea51111247128380e5801c
+  metadata.gz: 91df75cc80b90ede26be4ea3cfdefeb8c98c9f65
+  data.tar.gz: 4096decd9e7e83c2fae61556bc218a6f8485fee2
 SHA512:
-  metadata.gz: 0234405ce5740080331826bb34fdd213f9be4d93d092204cc82e8c348a9346ae524778ede7d5ec73e993ec4da11ae9eb128e2be819323e949f8f978f43691acb
-  data.tar.gz: 9534829271c2aeb0c0f8fb67db6eee415a5067a2561d59c054cace9e846f238accc98ac1dc8d197d51854a8214bcaa11e9a16d97f27a7b3c2204c139fb073e5b
+  metadata.gz: bb833fe05804bd821e5e6df91fbdf23846bbc0107af1eed96850b8078b6598d630f1d7bfafaa50ca73e150b9303b07698399c12cc92dddcee0f01dfc76f97db9
+  data.tar.gz: ae6f3cd73562e6833128a60db01fe3758d5dec203ef8fcbaf2af8f1a6d8750a9e835864fe854594d85881cc2ce3f11de68d3262cace58533dd81162ea85214fc

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.2
+script: bundle exec rspec spec

data/README.md

@@ -1,5 +1,7 @@
 # WithTimedCache
 
+[![Build Status](https://travis-ci.org/jordanstephens/with_timed_cache.svg?branch=master)](https://travis-ci.org/jordanstephens/with_timed_cache)
+
 A simple, time-based cache.
 
 ## Installation
@@ -16,6 +18,8 @@ Or install it yourself as:
 
     $ gem install with_timed_cache
 
+**Note**: Ruby version 2.0 or later is required.
+
 ## Usage
 
     with_timed_cache(key, max_age: 1.hour) do
@@ -27,4 +31,3 @@ Or install it yourself as:
 * `max_age`: how long to use the cached data, ex: `30.minutes`
 * `location`: the directory path in which to store cache files
 * `format`: cache data may be persisted as `:json`, `:yaml`, or the default of marshaling objects to strings will be used.
-

data/lib/with_timed_cache.rb

@@ -2,7 +2,7 @@ require "with_timed_cache/version"
 require "with_timed_cache/caches"
 
 module WithTimedCache
-  def with_timed_cache(key, opts)
+  def with_timed_cache(key, opts = {})
     cache = Caches.find_or_create(key, opts)
 
     if cache.exists? && !cache.stale?

data/lib/with_timed_cache/caches.rb

@@ -27,6 +27,7 @@ module WithTimedCache
       def cache_class(format = "")
         format = format.to_s.upcase
         begin
+          # Ruby Version 1.9 and earlier will choke on this line
           Object.const_get("WithTimedCache::#{format}Cache")
         rescue
           raise WithTimedCache::InvalidCacheFormatException

data/lib/with_timed_cache/version.rb

@@ -1,3 +1,3 @@
 module WithTimedCache
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "rspec"
+require "pry-byebug"
 require "with_timed_cache"
 
 shared_context :with_timed_cache do

data/spec/{lib/with_timed_cache → with_timed_cache}/cache_spec.rb

@@ -2,16 +2,16 @@ require 'spec_helper'
 
 describe WithTimedCache::Cache do
   it "knows it's local class name" do
-    WithTimedCache::Cache.local_class_name.should == "Cache"
+    expect(WithTimedCache::Cache.local_class_name).to eql("Cache")
   end
 
   it "has an empty file extension" do
-    WithTimedCache::Cache.file_extension.should be_empty
+    expect(WithTimedCache::Cache.file_extension).to be_empty
   end
 
   it "should have a filename with no extension by default" do
     cache = WithTimedCache::Cache.new(:foo)
-    (cache.filename =~ /^.+\..+$/).should be_false
+    expect(!!(cache.filename =~ /^.+\..+$/)).to be false
   end
 end
 

data/spec/{lib/with_timed_cache → with_timed_cache}/caches_spec.rb

@@ -6,22 +6,22 @@ describe WithTimedCache::Caches do
       key = :find_or_create
       first_ref = WithTimedCache::Caches.find_or_create(key)
       second_ref = WithTimedCache::Caches.find_or_create(key)
-      first_ref.eql?(second_ref).should be_true
+      expect(first_ref.eql?(second_ref)).to be true
     end
   end
 
   describe ".cache_class" do
     it "will return the constant of the cache class for the given format" do
-      WithTimedCache::Caches.cache_class(:json).should == WithTimedCache::JSONCache
-      WithTimedCache::Caches.cache_class("json").should == WithTimedCache::JSONCache
-      WithTimedCache::Caches.cache_class(:yaml).should == WithTimedCache::YAMLCache
-      WithTimedCache::Caches.cache_class("").should == WithTimedCache::Cache
-      WithTimedCache::Caches.cache_class.should == WithTimedCache::Cache
+      expect(WithTimedCache::Caches.cache_class(:json)).to eql(WithTimedCache::JSONCache)
+      expect(WithTimedCache::Caches.cache_class("json")).to eql(WithTimedCache::JSONCache)
+      expect(WithTimedCache::Caches.cache_class(:yaml)).to eql(WithTimedCache::YAMLCache)
+      expect(WithTimedCache::Caches.cache_class("")).to eql(WithTimedCache::Cache)
+      expect(WithTimedCache::Caches.cache_class).to eql(WithTimedCache::Cache)
     end
 
     it "will return the constant of the cache class for the given format" do
       expect {
-        WithTimedCache::Caches.cache_class(:foobar).should == WithTimedCache::JSONCache
+        WithTimedCache::Caches.cache_class(:foobar)
       }.to raise_error WithTimedCache::InvalidCacheFormatException
     end
   end

data/spec/{lib/with_timed_cache → with_timed_cache}/json_cache_spec.rb

@@ -2,16 +2,16 @@ require 'spec_helper'
 
 describe WithTimedCache::JSONCache do
   it "knows it's local class name" do
-    WithTimedCache::JSONCache.local_class_name.should == "JSONCache"
+    expect(WithTimedCache::JSONCache.local_class_name).to eql("JSONCache")
   end
 
   it "has a file_extension" do
-    WithTimedCache::JSONCache.file_extension.should == "json"
+    expect(WithTimedCache::JSONCache.file_extension).to eql("json")
   end
 
   it "should have a filename with the '.json' extension" do
     cache = WithTimedCache::JSONCache.new(:foo)
-    (cache.filename =~ /^.+\.json$/).should be_true
+    expect(!!(cache.filename =~ /^.+\.json$/)).to be true
   end
 end
 

data/spec/{lib/with_timed_cache → with_timed_cache}/yaml_cache_spec.rb

@@ -2,16 +2,16 @@ require 'spec_helper'
 
 describe WithTimedCache::YAMLCache do
   it "knows it's local class name" do
-    WithTimedCache::YAMLCache.local_class_name.should == "YAMLCache"
+    expect(WithTimedCache::YAMLCache.local_class_name).to eql("YAMLCache")
   end
 
   it "has a file_extension" do
-    WithTimedCache::YAMLCache.file_extension.should == "yml"
+    expect(WithTimedCache::YAMLCache.file_extension).to eql("yml")
   end
 
   it "should have a filename with the '.yml' extension" do
     cache = WithTimedCache::YAMLCache.new(:foo)
-    (cache.filename =~ /^.+\.yml$/).should be_true
+    expect(!!(cache.filename =~ /^.+\.yml$/)).to be true
   end
 end
 

data/spec/{lib/with_timed_cache_spec.rb → with_timed_cache_spec.rb}

@@ -5,6 +5,7 @@ describe WithTimedCache do
 
   before(:all) do
     @cache_directory = "spec/data/tmp"
+    FileUtils.mkdir_p(@cache_directory)
     clean_cache_directory
   end
 
@@ -12,6 +13,13 @@ describe WithTimedCache do
     clean_cache_directory
   end
 
+  it "does not require opts to be passed" do
+    val = "NO OPTS"
+    FileUtils.mkdir_p("tmp")
+    data = with_timed_cache(:no_opts) { val }
+    expect(data).to eql(val)
+  end
+
   it "caches data for a defined max_age" do
     original_val = "original value"
     updated_val = "updated value"
@@ -19,7 +27,7 @@ describe WithTimedCache do
       data = with_timed_cache(:max_age_1, location: @cache_directory, max_age: 1.minute) do
         i == 0 ? original_val : updated_val
       end
-      data.should == original_val
+      expect(data).to eql(original_val)
     end
   end
 
@@ -32,11 +40,11 @@ describe WithTimedCache do
         i == 0 ? original_val : updated_val
       end
       if i == 0
-        data.should == original_val
+        expect(data).to eql(original_val)
         sleep 1.5 # sleep longer than max_age
       end
     end
-    data.should == updated_val
+    expect(data).to eql(updated_val)
   end
 
   it "caches marshaled data to a file" do
@@ -45,11 +53,11 @@ describe WithTimedCache do
     data = [1, 2, 3]
 
     cached_data = with_timed_cache(key, location: @cache_directory) { data }
-    cached_data.should == data
-    File.exists?(File.join(@cache_directory, filename)).should be_true
+    expect(cached_data).to eql(data)
+    expect(File.exists?(File.join(@cache_directory, filename))).to be true
 
     raw_cache_data = File.read(File.join(@cache_directory, filename))
-    Marshal.load(raw_cache_data).should == data
+    expect(Marshal.load(raw_cache_data)).to eql(data)
   end
 
   it "lets you store cache data as json" do
@@ -59,11 +67,11 @@ describe WithTimedCache do
     data = { foo: 'bar', baz: 'qux' }
 
     cached_data = with_timed_cache(key, location: @cache_directory, format: :json) { data }
-    cached_data.should == data
-    File.exists?(filepath).should be_true
+    expect(cached_data).to eql(data)
+    expect(File.exists?(filepath)).to be true
 
     raw_cache_data = File.read(filepath)
-    JSON.parse(raw_cache_data, symbolize_names: true).should == data
+    expect(JSON.parse(raw_cache_data, symbolize_names: true)).to eql(data)
   end
 
   it "lets you store cache data as yaml" do
@@ -73,11 +81,11 @@ describe WithTimedCache do
     data = { foo: 'bar', baz: 'qux' }
 
     cached_data = with_timed_cache(key, location: @cache_directory, format: :yaml) { data }
-    cached_data.should == data
-    File.exists?(filepath).should be_true
+    expect(cached_data).to eql(data)
+    expect(File.exists?(filepath)).to be true
 
     raw_cache_data = File.read(filepath)
-    YAML.load_file(filepath).should == data
+    expect(YAML.load_file(filepath)).to eql(data)
   end
 
   it "returns last cached data if present when an exception is raised" do
@@ -93,14 +101,14 @@ describe WithTimedCache do
       end
       sleep 1.5 if i == 0
     end
-    data.should == string
+    expect(data).to eql(string)
   end
 
   it "returns nil when an exception is raised if no previous cache is present" do
     data = with_timed_cache(:exception_nil, location: @cache_directory, max_age: 1.second) do
       raise Exception
     end
-    data.should be_nil
+    expect(data).to be nil
   end
 
   def clean_cache_directory

data/with_timed_cache.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "json"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.3"
+  spec.add_development_dependency "pry-byebug", "~> 2.0"
+  spec.add_dependency "activesupport", "~> 4.1"
+  spec.add_dependency "json", "~> 1.8"
 end

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: with_timed_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jordan Stephens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 description: A simple time based cache
 email:
 - iam@jordanstephens.net
@@ -101,7 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -113,12 +128,12 @@ files:
 - lib/with_timed_cache/json_cache.rb
 - lib/with_timed_cache/version.rb
 - lib/with_timed_cache/yaml_cache.rb
-- spec/lib/with_timed_cache/cache_spec.rb
-- spec/lib/with_timed_cache/caches_spec.rb
-- spec/lib/with_timed_cache/json_cache_spec.rb
-- spec/lib/with_timed_cache/yaml_cache_spec.rb
-- spec/lib/with_timed_cache_spec.rb
 - spec/spec_helper.rb
+- spec/with_timed_cache/cache_spec.rb
+- spec/with_timed_cache/caches_spec.rb
+- spec/with_timed_cache/json_cache_spec.rb
+- spec/with_timed_cache/yaml_cache_spec.rb
+- spec/with_timed_cache_spec.rb
 - with_timed_cache.gemspec
 homepage: ''
 licenses:
@@ -130,25 +145,25 @@ 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.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Cache data to a local file for a defined amount of time
 test_files:
-- spec/lib/with_timed_cache/cache_spec.rb
-- spec/lib/with_timed_cache/caches_spec.rb
-- spec/lib/with_timed_cache/json_cache_spec.rb
-- spec/lib/with_timed_cache/yaml_cache_spec.rb
-- spec/lib/with_timed_cache_spec.rb
 - spec/spec_helper.rb
+- spec/with_timed_cache/cache_spec.rb
+- spec/with_timed_cache/caches_spec.rb
+- spec/with_timed_cache/json_cache_spec.rb
+- spec/with_timed_cache/yaml_cache_spec.rb
+- spec/with_timed_cache_spec.rb
 has_rdoc: