itrigga-file_cache 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Al Davidson
+
+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.rdoc

@@ -0,0 +1,41 @@
+= itrigga-file_cache
+
+A simple file-system-based cache wrapper.
+
+The main method is 'with_cache( :cache_key=>'something_unique', :timeout_seconds=>(an integer) ){ (...) }'
+If the given cache key exists and has not timed out, it will return the cached value
+If not, it will 
+* yield to the given block
+* store the result of the given block in the cache with the given key
+* return the result of the given block
+
+Required params:
+* :cache_key=>'some unique string that is valid in a filename'
+
+Optional params:
+* :timeout_seconds => (an integer - default 3600)
+* :cache_dir => (an absolute path - defaults to RAILS_ROOT/tmp/cache if RAILS_ROOT is defined, otherwise /tmp/cache )
+
+
+Example usage:
+
+ 
+@stats_json = Trigga::Cache::FileCache.with_cache(:cache_key=>'admin_stats.json', :timeout_seconds=>600){
+  /* some expensive remote API / slow IO call here /*
+}
+
+== Contributing to itrigga-file_cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Al Davidson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "itrigga-file_cache"
+  gem.homepage = "http://github.com/itrigga/itrigga-file_cache"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple file-system-based cache wrapper.}
+  gem.description = %Q{A simple file-system-based cache wrapper.
+
+The main method is 'with_cache( :cache_key=>'something_unique', :timeout_seconds=>(an integer) ){ (...) }'
+If the given cache key exists and has not timed out, it will return the cached value
+If not, it will 
+* yield to the given block
+* store the result of the given block in the cache with the given key
+* return the result of the given block
+
+Required params:
+* :cache_key=>'some unique string that is valid in a filename'
+
+Optional params:
+* :timeout_seconds => (an integer - default 3600)
+* :cache_dir => (an absolute path - defaults to RAILS_ROOT/tmp/cache if RAILS_ROOT is defined, otherwise /tmp/cache )
+
+
+Example usage:
+
+ 
+@stats_json = Trigga::Cache::FileCache.with_cache(:cache_key=>'admin_stats.json', :timeout_seconds=>600){
+  /* some expensive remote API / slow IO call here /*
+}}
+  gem.email = "aldavidson@trigga.com"
+  gem.authors = ["Al Davidson"]
+  # dependencies defined in Gemfile
+  gem.require_paths << "lib/itrigga"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "itrigga-file_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/itrigga/cache/itrigga-file_cache.rb

@@ -0,0 +1,74 @@
+#require 'active_support'
+
+module Trigga
+  module Cache
+    module FileCache
+      
+      module_function
+      
+      
+      @cache_dir =  "#{defined?(RAILS_ROOT) ? RAILS_ROOT : ''}/tmp/cache"
+      @timeout_seconds = 3600 # <- default timeout is 1hr
+      
+      def cache_dir
+        @cache_dir 
+      end
+      
+      def cache_dir=(dir)
+        @cache_dir=dir
+      end
+      
+      def timeout_seconds
+        @timeout_seconds
+      end
+      
+      def timeout_seconds=(secs)
+        @timeout_seconds = secs
+      end
+      
+      def with_cache( opts={}, &block )
+        begin
+          if is_in_cache?(opts) && !expired?(opts)
+            get(opts)
+          else
+            delete(opts)
+            result = block.call
+            put( opts, result )
+            result
+          end
+        end
+      end
+      
+      def get(opts)
+        File.open( file_path(opts), 'r' ){ |f| f.read }
+      end
+      
+      def put(opts, content)
+        File.open( file_path(opts), 'w' ){ |f| f.write(content) }
+      end
+      
+      def delete(opts)
+        File.delete(file_path(opts)) if is_in_cache?(opts)
+      end
+      
+      def is_in_cache?( opts={} )        
+        File.exists?( file_path(opts) )
+      end
+      
+      def expired?( opts={} )    
+        opts[:timeout_seconds] ||= self.timeout_seconds
+        Time.now - File.mtime(file_path(opts)) > opts[:timeout_seconds]
+      end
+      
+      def file_path( opts )
+        raise ArgumentError.new(":cache_key is required") unless opts[:cache_key]
+        
+        opts[:cache_dir] ||= self.cache_dir
+        
+        File.expand_path( File.join(opts[:cache_dir], opts[:cache_key]) )
+      end
+    end
+  end
+end
+
+    

data/lib/itrigga/file_cache.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'cache', 'itrigga-file_cache')

data/spec/file_cache_spec.rb

@@ -0,0 +1,250 @@
+require File.join( File.dirname(__FILE__),  'spec_helper' )
+
+describe Trigga::Cache::FileCache do
+
+  describe "file_path" do
+    before(:each) do
+      @opts = {:blart=>'flange', :cache_key=>'cache_key'}
+    end
+    
+    context "when not given a cache_key" do
+      it "should raise an ArgumentError" do
+        lambda{ Trigga::Cache::FileCache.file_path(:blart=>'flange') }.should raise_error(ArgumentError)
+      end
+    end
+    context "when given a cache_key" do
+      it "should not raise an ArgumentError" do
+        lambda{ Trigga::Cache::FileCache.file_path(@opts) }.should_not raise_error(ArgumentError)
+      end
+      
+      context "when not given a cache_dir" do      
+        it "should default cache_dir to the module's attribute" do
+          Trigga::Cache::FileCache.cache_dir = "/blart/flange/foo/bar/"
+          Trigga::Cache::FileCache.file_path(@opts)
+          @opts[:cache_dir].should == "/blart/flange/foo/bar/"
+        end
+      end
+      
+      it "should expand the cache_dir plus cache_key" do
+        File.should_receive(:expand_path).with( "/blart/flange/foo/bar/baz.cache" ).and_return("blart")
+        Trigga::Cache::FileCache.file_path( :cache_dir=> "/blart/flange/foo/bar", :cache_key => "baz.cache")
+      end
+      
+      it "should return the expanded path" do
+        File.stub!(:expand_path).and_return("blart")
+        Trigga::Cache::FileCache.file_path( :cache_dir=> "/blart/flange/foo/bar", :cache_key => "baz.cache").should == "blart"
+      end
+    end
+  end
+  
+  describe "expired?" do
+    before(:each) do
+      Trigga::Cache::FileCache.stub!(:file_path).and_return('/foo/bar/baz.txt')
+      File.stub!(:mtime).and_return(Time.now - 10)
+      @opts = {}
+    end
+    
+    context "when not given :timeout_seconds" do      
+      it "should default :timeout_seconds to the module's attribute" do
+        Trigga::Cache::FileCache.timeout_seconds = 345
+        Trigga::Cache::FileCache.expired?(@opts)
+        @opts[:timeout_seconds].should == 345
+      end
+    end
+    
+    it "should get the file_path for the given opts" do
+      Trigga::Cache::FileCache.should_receive(:file_path).with(hash_including( {:blart=>'flange'} )).and_return('/foo/bar/baz.txt')
+      Trigga::Cache::FileCache.expired?( :blart=>'flange' )
+    end
+    
+    it "should get the mtime of the file_path" do
+      File.should_receive(:mtime).with('/foo/bar/baz.txt').and_return(Time.now - 10)
+      Trigga::Cache::FileCache.expired?
+    end
+    
+    context "when the file is dated more than timeout_seconds ago" do
+      it "should return true" do
+        Trigga::Cache::FileCache.expired?(:timeout_seconds=>9).should == true
+      end
+    end
+    context "when the file is dated less than timeout_seconds ago" do
+      it "should return false" do
+        Trigga::Cache::FileCache.expired?(:timeout_seconds=>11).should == false
+      end
+    end
+  end
+  
+  describe "is_in_cache?" do
+    before(:each) do
+      Trigga::Cache::FileCache.stub!(:file_path).and_return('/foo/bar/baz.txt')
+    end
+    
+    it "should get the file_path for the given opts" do
+      Trigga::Cache::FileCache.should_receive(:file_path).with(hash_including( {:blart=>'flange'} )).and_return('/foo/bar/baz.txt')
+      Trigga::Cache::FileCache.is_in_cache?( :blart=>'flange' )
+    end
+    
+    context "when the file_path exists" do
+      before(:each) do
+        File.stub!(:exists?).with('/foo/bar/baz.txt').and_return(true)
+      end
+      
+      it "should return true" do
+        Trigga::Cache::FileCache.is_in_cache?.should == true
+      end
+    end
+    
+    context "when the file_path does not exist" do
+      before(:each) do
+        File.stub!(:exists?).with('/foo/bar/baz.txt').and_return(false)
+      end
+      
+      it "should return false" do
+        Trigga::Cache::FileCache.is_in_cache?.should == false
+      end
+    end
+  end
+  
+  describe "with_cache" do
+    context "when the entry is in cache" do
+      before(:each) do
+        Trigga::Cache::FileCache.stub!(:is_in_cache?).and_return(true)
+      end
+      
+      context "and has not expired" do
+        before(:each) do
+          Trigga::Cache::FileCache.stub!(:expired?).and_return(false)
+          Trigga::Cache::FileCache.stub!(:get).and_return('result')
+        end
+        
+        it "should get the entry" do
+          Trigga::Cache::FileCache.should_receive(:get).with( :blart=>'flange' ).and_return('result')
+          Trigga::Cache::FileCache.with_cache(:blart=>'flange')
+        end
+        
+        it "should return the results of the get call" do
+          Trigga::Cache::FileCache.with_cache.should == 'result'
+        end
+        
+        it "should not call the given block" do
+          @called = false
+          Trigga::Cache::FileCache.with_cache{ @called = true }
+          @called.should_not == true
+        end
+      end
+      context "but has expired" do
+        before(:each) do
+          Trigga::Cache::FileCache.stub!(:expired?).and_return(true)
+          Trigga::Cache::FileCache.stub!(:delete)
+          Trigga::Cache::FileCache.stub!(:put)
+        end
+        
+        it "should delete the existing entry" do
+          Trigga::Cache::FileCache.should_receive(:delete).with(:blart=>'flange')
+          Trigga::Cache::FileCache.with_cache(:blart=>'flange') {}
+        end
+        
+        it "should call the given block" do
+          @called = false
+          Trigga::Cache::FileCache.with_cache{ @called = true }
+          @called.should == true
+        end
+        
+        it "should return the result of the block call" do
+          Trigga::Cache::FileCache.with_cache{ 'donkeys' }.should == 'donkeys'
+        end
+        
+        it "should put the result to the cache" do
+          Trigga::Cache::FileCache.should_receive(:put).with( {:blart=>'flange'}, 'cheese' )
+          Trigga::Cache::FileCache.with_cache(:blart=>'flange'){ 'cheese' }
+        end
+      end
+    end
+  end
+  
+  describe "get" do
+    before(:each) do
+      Trigga::Cache::FileCache.stub!(:file_path).and_return('/foo/bar/baz.txt')
+      File.stub!(:open).and_yield(@mock_file = mock('file'))
+      @mock_file.stub!(:read).and_return("contents")
+    end
+    
+    it "should get the file_path for the given opts" do
+      Trigga::Cache::FileCache.should_receive(:file_path).with(hash_including( {:blart=>'flange'} )).and_return('/foo/bar/baz.txt')
+      Trigga::Cache::FileCache.get( :blart=>'flange' )
+    end
+    
+    it "should open the file in read-only mode" do
+      File.should_receive(:open).with('/foo/bar/baz.txt','r').and_return(@mock_file)
+      Trigga::Cache::FileCache.get( :blart=>'flange' )
+    end
+    
+    
+    it "should read the file" do
+      @mock_file.should_receive(:read).and_return("contents")
+      Trigga::Cache::FileCache.get( :blart=>'flange' )
+    end
+    
+    it "should return the file contents" do
+      Trigga::Cache::FileCache.get( :blart=>'flange' ).should == 'contents'
+    end
+  end
+  
+  describe "delete" do
+    before(:each) do
+      Trigga::Cache::FileCache.stub!(:file_path).and_return('/foo/bar/baz.txt')
+      Trigga::Cache::FileCache.stub!(:exists?).and_return(true)
+      File.stub!(:delete).and_return(@mock_file = mock('file'))
+    end
+    
+    it "should get the file_path for the given opts" do
+      Trigga::Cache::FileCache.should_receive(:file_path).with(hash_including( {:blart=>'flange'} )).and_return('/foo/bar/baz.txt')
+      Trigga::Cache::FileCache.delete( :blart=>'flange' )
+    end
+    
+    context "when the file is_in_cache" do
+      before(:each) do
+        Trigga::Cache::FileCache.stub!(:is_in_cache?).and_return(true)         
+      end
+      it "should delete the file" do
+        File.should_receive(:delete).with('/foo/bar/baz.txt')
+        Trigga::Cache::FileCache.delete( :blart=>'flange' )
+      end
+    end
+    
+    context "when the file is not in cache" do
+      before(:each) do
+        Trigga::Cache::FileCache.stub!(:is_in_cache?).and_return(false)         
+      end
+      it "should not delete the file" do
+        File.should_not_receive(:delete)
+        Trigga::Cache::FileCache.delete( :blart=>'flange' )
+      end
+    end
+  end
+  
+  describe "put" do
+    before(:each) do
+      Trigga::Cache::FileCache.stub!(:file_path).and_return('/foo/bar/baz.txt')
+      File.stub!(:open).and_yield( @mock_file = mock('file') )
+      @mock_file.stub!(:write)
+    end
+    
+    it "should get the file_path for the given opts" do
+      Trigga::Cache::FileCache.should_receive(:file_path).with(hash_including( {:blart=>'flange'} )).and_return('/foo/bar/baz.txt')
+      Trigga::Cache::FileCache.put( {:blart=>'flange'}, 'content' )
+    end
+    
+    it "should open the file for writing" do
+      File.should_receive(:open).with('/foo/bar/baz.txt', 'w')
+      Trigga::Cache::FileCache.put( {:blart=>'flange'}, 'content' )
+    end
+    
+    it "should write the given content to the file" do
+      @mock_file.should_receive(:write).with('content')
+      Trigga::Cache::FileCache.put( {:blart=>'flange'}, 'content' )
+    end
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'itrigga/file_cache'
+
+Dir.chdir(File.join(File.dirname(__FILE__), '..'))
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'itrigga-file_cache'
+
+class Test::Unit::TestCase
+end

data/test/test_itrigga-file_cache.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestItriggaFileCache < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: itrigga-file_cache
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Al Davidson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+description: |-
+  A simple file-system-based cache wrapper.
+  
+  The main method is 'with_cache( :cache_key=>'something_unique', :timeout_seconds=>(an integer) ){ (...) }'
+  If the given cache key exists and has not timed out, it will return the cached value
+  If not, it will 
+  * yield to the given block
+  * store the result of the given block in the cache with the given key
+  * return the result of the given block
+  
+  Required params:
+  * :cache_key=>'some unique string that is valid in a filename'
+  
+  Optional params:
+  * :timeout_seconds => (an integer - default 3600)
+  * :cache_dir => (an absolute path - defaults to RAILS_ROOT/tmp/cache if RAILS_ROOT is defined, otherwise /tmp/cache )
+  
+  
+  Example usage:
+  
+   
+  @stats_json = Trigga::Cache::FileCache.with_cache(:cache_key=>'admin_stats.json', :timeout_seconds=>600){
+    /* some expensive remote API / slow IO call here /*
+  }
+email: aldavidson@trigga.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/itrigga/cache/itrigga-file_cache.rb
+- lib/itrigga/file_cache.rb
+- spec/file_cache_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_itrigga-file_cache.rb
+has_rdoc: true
+homepage: http://github.com/itrigga/itrigga-file_cache
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib/itrigga
+- lib/itrigga
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple file-system-based cache wrapper.
+test_files: []
+