with_timed_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db6c5fa7ef0d80a8b7f22c41b4866bfc72ddfb11
+  data.tar.gz: 7a48bf47391b62f553ea51111247128380e5801c
+SHA512:
+  metadata.gz: 0234405ce5740080331826bb34fdd213f9be4d93d092204cc82e8c348a9346ae524778ede7d5ec73e993ec4da11ae9eb128e2be819323e949f8f978f43691acb
+  data.tar.gz: 9534829271c2aeb0c0f8fb67db6eee415a5067a2561d59c054cace9e846f238accc98ac1dc8d197d51854a8214bcaa11e9a16d97f27a7b3c2204c139fb073e5b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in with_timed_cache.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jordan Stephens
+
+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/README.md

@@ -0,0 +1,30 @@
+# WithTimedCache
+
+A simple, time-based cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'with_timed_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install with_timed_cache
+
+## Usage
+
+    with_timed_cache(key, max_age: 1.hour) do
+      # some operation you would like cached for a certain amount of time
+    end
+
+**Options**
+
+* `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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/with_timed_cache/cache.rb

@@ -0,0 +1,47 @@
+require "active_support/core_ext/numeric/time"
+
+module WithTimedCache
+  class Cache
+
+    attr_reader :key, :location, :max_age
+
+    def initialize(key, opts = {})
+      @key = key
+      @max_age = opts[:max_age] || 1.hour
+      @location = opts[:location] || File.join("tmp", filename)
+      @location = File.join(@location, filename) if File.directory?(@location)
+      self
+    end
+
+    def stale?
+      File.mtime(@location) < @max_age.ago
+    end
+
+    def exists?
+      File.exists? @location
+    end
+
+    def read
+      Marshal.load(File.read(@location))
+    end
+
+    def write(data)
+      File.open(@location, 'w') { |f| f.write Marshal.dump(data) }
+    end
+
+    def filename
+      extension = self.class.file_extension
+      filename = "#{@key}_cache"
+      filename += ".#{extension}" unless extension.empty?
+      filename
+    end
+
+    def self.file_extension
+      @file_extension ||= self.local_class_name.sub(/Cache$/, "").downcase
+    end
+
+    def self.local_class_name
+      @local_class_name ||= self.to_s.split("::").last rescue self.to_s
+    end
+  end
+end

data/lib/with_timed_cache/caches.rb

@@ -0,0 +1,38 @@
+
+require "with_timed_cache/json_cache"
+require "with_timed_cache/yaml_cache"
+
+module WithTimedCache
+  class InvalidCacheFormatException < Exception; end
+
+  class Caches
+
+    @caches = []
+
+    class << self
+      def find_or_create(key, opts = {})
+        cache = find(key) || create(key, opts)
+        @caches << cache
+        cache
+      end
+
+      def find(key)
+        @caches.select { |c| c.key == key }.first
+      end
+
+      def create(key, opts = {})
+        cache_class(opts[:format]).new(key, opts)
+      end
+
+      def cache_class(format = "")
+        format = format.to_s.upcase
+        begin
+          Object.const_get("WithTimedCache::#{format}Cache")
+        rescue
+          raise WithTimedCache::InvalidCacheFormatException
+        end
+      end
+    end
+  end
+end
+

data/lib/with_timed_cache/json_cache.rb

@@ -0,0 +1,21 @@
+require "with_timed_cache/cache"
+require "json"
+
+module WithTimedCache
+  class JSONCache < Cache
+    def initialize(key, opts = {})
+      super
+      @location = opts[:location] || File.join("tmp", filename)
+      @location = File.join(@location, filename) if File.directory?(@location)
+    end
+
+    def read
+      JSON.parse(File.read(@location), symbolize_names: true)
+    end
+
+    def write(data)
+      File.open(@location, 'w') { |f| f.write data.to_json }
+    end
+  end
+end
+

data/lib/with_timed_cache/version.rb

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

data/lib/with_timed_cache/yaml_cache.rb

@@ -0,0 +1,29 @@
+require "with_timed_cache/cache"
+require "yaml"
+
+module WithTimedCache
+  class YAMLCache < Cache
+
+    @file_extension = "yml"
+
+    def initialize(key, opts = {})
+      super
+      filename = "#{key}_cache.yml"
+      @location = opts[:location] || "tmp/#{filename}"
+      @location = File.join(@location, "#{filename}") if File.directory?(@location)
+    end
+
+    def read
+      YAML.load @location
+    end
+
+    def write(data)
+      File.open(@location, 'w') { |f| f.write data.to_yaml }
+    end
+
+    def self.file_extension
+      "yml"
+    end
+  end
+end
+

data/lib/with_timed_cache.rb

@@ -0,0 +1,21 @@
+require "with_timed_cache/version"
+require "with_timed_cache/caches"
+
+module WithTimedCache
+  def with_timed_cache(key, opts)
+    cache = Caches.find_or_create(key, opts)
+
+    if cache.exists? && !cache.stale?
+      data = cache.read
+    else
+      begin
+        data = yield
+        cache.write(data)
+      rescue Exception => e
+        data = cache.read rescue nil
+      end
+    end
+    data
+  end
+end
+

data/spec/lib/with_timed_cache/cache_spec.rb

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

data/spec/lib/with_timed_cache/caches_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe WithTimedCache::Caches do
+  describe ".find_or_create" do
+    it "will not create a cache twice, but will retrieve a cache by it's key if it exists" 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
+    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
+    end
+
+    it "will return the constant of the cache class for the given format" do
+      expect {
+        WithTimedCache::Caches.cache_class(:foobar).should == WithTimedCache::JSONCache
+      }.to raise_error WithTimedCache::InvalidCacheFormatException
+    end
+  end
+end
+

data/spec/lib/with_timed_cache/json_cache_spec.rb

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

data/spec/lib/with_timed_cache/yaml_cache_spec.rb

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

data/spec/lib/with_timed_cache_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe WithTimedCache do
+  include_context :with_timed_cache
+
+  before(:all) do
+    @cache_directory = "spec/data/tmp"
+    clean_cache_directory
+  end
+
+  after(:all) do
+    clean_cache_directory
+  end
+
+  it "caches data for a defined max_age" do
+    original_val = "original value"
+    updated_val = "updated value"
+    2.times do |i|
+      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
+    end
+  end
+
+  it "updates the cache after a defined max_age" do
+    original_val = "original value"
+    updated_val = "updated value"
+    data = nil
+    2.times do |i|
+      data = with_timed_cache(:max_age_2, location: @cache_directory, max_age: 1.second) do
+        i == 0 ? original_val : updated_val
+      end
+      if i == 0
+        data.should == original_val
+        sleep 1.5 # sleep longer than max_age
+      end
+    end
+    data.should == updated_val
+  end
+
+  it "caches marshaled data to a file" do
+    key = :foo
+    filename = "#{key}_cache"
+    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
+
+    raw_cache_data = File.read(File.join(@cache_directory, filename))
+    Marshal.load(raw_cache_data).should == data
+  end
+
+  it "lets you store cache data as json" do
+    key = :json
+    filename = "#{key}_cache.json"
+    filepath = File.join(@cache_directory, filename)
+    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
+
+    raw_cache_data = File.read(filepath)
+    JSON.parse(raw_cache_data, symbolize_names: true).should == data
+  end
+
+  it "lets you store cache data as yaml" do
+    key = :yaml
+    filename = "#{key}_cache.yml"
+    filepath = File.join(@cache_directory, filename)
+    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
+
+    raw_cache_data = File.read(filepath)
+    YAML.load_file(filepath).should == data
+  end
+
+  it "returns last cached data if present when an exception is raised" do
+    string = "lorem ipsum dolor sit amet"
+    data = nil
+    2.times do |i|
+      data = with_timed_cache(:exception, location: @cache_directory, max_age: 1.second) do
+        if i == 0
+          string
+        else
+          raise Exception
+        end
+      end
+      sleep 1.5 if i == 0
+    end
+    data.should == 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
+  end
+
+  def clean_cache_directory
+    FileUtils.rm_f(Dir.glob(File.join(@cache_directory, "*")))
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec"
+require "with_timed_cache"
+
+shared_context :with_timed_cache do
+  include WithTimedCache
+end
+

data/with_timed_cache.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'with_timed_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "with_timed_cache"
+  spec.version       = WithTimedCache::VERSION
+  spec.authors       = ["Jordan Stephens"]
+  spec.email         = ["iam@jordanstephens.net"]
+  spec.description   = %q{A simple time based cache}
+  spec.summary       = %q{Cache data to a local file for a defined amount of time}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^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"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: with_timed_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: guard-rspec
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple time based cache
+email:
+- iam@jordanstephens.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/with_timed_cache.rb
+- lib/with_timed_cache/cache.rb
+- lib/with_timed_cache/caches.rb
+- 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
+- with_timed_cache.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+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
+has_rdoc: