fscache 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6852a0a360322ada25a04284e5244b4d823481b0
+  data.tar.gz: 47aa94a3ea0271df8ec82e7329c5c5e22b04f01e
+SHA512:
+  metadata.gz: 4e5ba067ece566cfc159f32e0ce6beec1d11f3fe165adef27d8eb7112b60de779dc3174e3a25111596c3fc24987fae30f5ac2561e341208b45c33ab3d248c5ea
+  data.tar.gz: 8579434af0133d29174e90c2bfa575ffd64a8684e97ed353005e57b8c44d1b3e100c2de903d8eed3fc9bcf5733babb2ff5c27feecacf7928bc7be8563b970ea5

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    fscache (0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fscache!
+  rake (~> 10.x)
+  rspec (~> 3.x)

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    (1) Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer. 
+
+    (2) Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.  
+    
+    (3)The name of the author may not be used to
+    endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,19 @@
+#FsCache
+Simple FileCache with that uses similar API to Rails.cache
+
+#Installation
+    gem install fscache
+
+Or add the following to your Gemfile (do this for now):
+    
+    gem 'fscache', :git => 'git://github.com/eddietejeda/fscache.git'
+
+#Usage examples
+
+    require 'fscache'
+    filecache = FsCache.new
+    filecache.write("cache_name", "cache_contents")
+    contents = filecache.read("cache_name")
+    filecache.fetch("cache_name") do
+        "cache_contents"
+    end

data/fscache.gemspec

@@ -0,0 +1,25 @@
+#encoding: utf-8
+require File.expand_path('../lib/fscache.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'fscache'
+  gem.version     = FsCache::VERSION
+  gem.description = %q(A simple file cache library that serializes objects into temporary directory)
+  gem.summary     = gem.description
+  
+  gem.files       = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']  
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.homepage    = "https://github.com/eddietejeda/fscache"
+
+  gem.license     = 'BSD-3-Clause'
+  gem.authors     = ['Eddie A Tejeda']
+  gem.email       = ['eddie@codeforamerica.org']
+
+  gem.add_development_dependency 'rake','~> 10.x'
+  gem.add_development_dependency 'rspec','~> 3.x'
+
+end
+

data/lib/fscache.rb

@@ -0,0 +1,92 @@
+require 'digest'
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+  
+class FsCache
+
+  VERSION = "0.9.0"
+
+  def initialize(path = nil, expire = 7, debug = false)
+    @file_cache_expire = expire
+    @debug = debug
+    default_tmp = defined?(Rails).nil? ? Pathname.new("/tmp").join('file_cache') : Rails.root.join('tmp').join('file_cache')    
+    @file_cache_dir = path.nil? ? default_tmp : path     
+    FileUtils::mkdir_p @file_cache_dir if !File.directory?(@file_cache_dir)    
+  end
+
+
+
+  def exist?(cache_name)    
+    cache_name = cache_key( cache_name )
+    cache_path = @file_cache_dir.join(cache_name)    
+
+    cache_valid(cache_path)
+  end
+
+
+  def read(cache_name)    
+    cache_name = cache_key( cache_name )
+    cache_path = @file_cache_dir.join(cache_name)
+
+    if @debug
+      p exist?(cache_name) ? "#{cache_name}: cache hit" :  "#{cache_name}: cache miss"
+    end
+
+    if File.exist?(cache_path)
+      YAML.load(File.read(cache_path))
+    else
+      return false
+    end    
+  end
+
+
+  def write(cache_name, cache_value)    
+    cache_name = cache_key( cache_name )
+    cache_path = @file_cache_dir.join(cache_name)
+
+    File.open(cache_path, 'w') do |f| 
+      f.write(YAML.dump(cache_value)) 
+    end    
+  end
+
+
+  def fetch(cache_name)    
+    cache_name = cache_key( cache_name )
+
+    if(exist? (cache_name) )
+      read (cache_name)
+    else
+      value = yield
+      write(cache_name, value)  
+      read (cache_name)    
+    end    
+  end
+
+  def clear    
+    Dir["#{@file_cache_dir}/*"].each do |cache_name| 
+      # lets make sure we're only deleting files with md5 hashes as filenames.      
+      if cache_key( File.basename(cache_name) )
+        FileUtils.rm(cache_name)
+      end
+    end
+  end
+
+  # --------- private --------- 
+  private
+    def cache_valid(filename)      
+      if File.exist?(filename) 
+        ((Time.now - File.stat(filename).mtime).to_i / 86400.0).to_i < @file_cache_expire
+      else
+        return false
+      end
+    end
+
+    def cache_key(key)      
+      if(key.is_a?(String) && key.downcase.match(/^[a-f0-9]{32}$/) )
+        key
+      else
+        Digest::MD5.hexdigest(key.to_s).to_s        
+      end      
+    end
+end

data/spec/fscache_spec.rb

@@ -0,0 +1,59 @@
+# require 'spec_helper'
+require_relative '../lib/fscache'
+
+describe FsCache do
+
+  before do
+    @fscache = FsCache.new
+    @cache_name = ['spec', 'test']
+    @cached_contents = 'Hello World'
+    @file_cache_dir = @fscache.instance_variable_get(:@file_cache_dir)
+    
+  end
+
+  describe "test methods" do
+
+    it "FsCache#initilize should create a tmp directory" do      
+      expect(File.directory?(@file_cache_dir)).to be_truthy
+    end
+
+    it "FsCache#write should save serialized object to tmp" do
+      @fscache.write(@cache_name, @cached_contents)
+      expect(@fscache.exist?(@cache_name)).to be_truthy
+    end
+
+
+    it "FsCache#read should be able to read serialized objects" do
+      @fscache.read(@cache_name).eql?( @cached_contents)
+    end
+    
+
+    it "FsCache#fetch should be able to read serialized objects" do
+      
+      cache_name_fetch = "#{@cache_name}-fetch"
+      cache_contents_fetch = "Hello World Fetch"
+
+      response = @fscache.fetch( cache_name_fetch) do
+        cache_contents_fetch
+      end
+      
+      cache_name_fetch.eql?( response)
+      @fscache.read(cache_name_fetch).eql?( response)
+      
+    end
+
+
+    it "FsCache#clear should clear cache" do
+      @fscache.clear
+      expect(@fscache.exist?(@cache_name)).to be_falsey      
+    end
+
+    # it "FsCache#clear should clear cache" do
+    #
+    #   expect(@fscache.VERSION).to be_truthy
+    # end
+
+ 
+
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: fscache
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Eddie A Tejeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.x
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+description: A simple file cache library that serializes objects into temporary directory
+email:
+- eddie@codeforamerica.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- fscache.gemspec
+- lib/fscache.rb
+- spec/fscache_spec.rb
+homepage: https://github.com/eddietejeda/fscache
+licenses:
+- BSD-3-Clause
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple file cache library that serializes objects into temporary directory
+test_files:
+- spec/fscache_spec.rb