cache_local 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9274375b604185a3d1fede11b614ee6cd4feda28
+  data.tar.gz: 0c3436e9de8dc6391452d278e25454072286e758
+SHA512:
+  metadata.gz: 0b194d3f95f0f09c50dd506f94d9eeeb22001aa798ca678a463dfb82e25a159dc891afe1c68a61f864c77a5d55416ee630af0277fd27d769bfd564d4c2c963fe
+  data.tar.gz: 0ff5920d7a37b4da28542fb8a7300f76ec39cf029fccbbda4bc8199c1f440f0cd43bb0dd31574f9f08e3f480c12e64e5f852655a6b3a7ddfc3045c945d3c0ba3

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kei Tsuchiya
+
+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,48 @@
+# cache_local
+[![Gem Version](https://badge.fury.io/rb/cache_local.png)](http://badge.fury.io/rb/cache_local)  
+CacheLocal provides very simple cache function. There are two types of chache: file cache and process cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cache_local'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_local
+
+## Usage
+### File Cache
+```ruby
+require 'cache_local'
+
+file_cache = CacheLocal::File.new(path_to_cache_directory, namespace) 
+file_cache.set(key, value)
+file_cache.get(key
+file_cache.delete(key)
+file_cache.set(key, value, expiration_time) # enable to specify expiration time [sec]
+```
+
+### Process Cache
+```ruby
+require 'cache_local'
+
+process_cache = CacheLocal::Process.new(namespace)
+process_cache.set(key, value)
+process_cache.get(key)
+process_cache.delete(key)
+process_cache.set(key, value, expiration_time) # enable to specify expiration time [sec]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/cache_local.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_local'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cache_local'
+  spec.version       = CacheLocal::VERSION
+  spec.authors       = ['Kei Tsuchiya']
+  spec.email         = ['kei.tsuchiya86@gmail.com']
+  spec.description   = %q{Simple local cache}
+  spec.summary       = %q{Enable to cache using file or process}
+  spec.homepage      = 'https://github.com/kei500/cache_local'
+  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{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3'
+end

data/lib/cache_local.rb

@@ -0,0 +1,6 @@
+require 'cache_local/file'
+require 'cache_local/process'
+
+module CacheLocal
+  VERSION = '0.0.1'
+end

data/lib/cache_local/file.rb

@@ -0,0 +1,45 @@
+require 'fileutils'
+
+module CacheLocal
+  class File
+    def initialize(path, namespace = nil)
+      @path = path
+      @namespace = namespace
+      if namespace
+        FileUtils.mkdir_p(::File.join(path, namespace)) unless FileTest.exist?(::File.join(path, namespace))
+      end
+    end
+
+    def set(key, value, expiration_time = 0)
+      file = ::File.open(filename(key), 'w')
+      Marshal.dump({value: value, expiration_time: expiration_time}, file)
+      file.close
+    end
+
+    def get(key)
+      return nil unless ::File.exists?(filename(key))
+
+      file = ::File.open(filename(key), 'r')
+      cache = Marshal.load(file)
+      is_expired = cache[:expiration_time] != 0 && Time.now - file.mtime > cache[:expiration_time]
+      file.close
+
+      if is_expired
+        delete(key)
+        return nil
+      end
+
+      cache[:value]
+    end
+
+    def delete(key)
+      ::File.delete(filename(key)) if ::File.exists?(filename(key))
+    end
+
+    private
+
+    def filename(key)
+      @namespace ? ::File.join(@path, @namespace, key) : ::File.join(@path, key)
+    end
+  end
+end

data/lib/cache_local/process.rb

@@ -0,0 +1,34 @@
+module CacheLocal
+  class Process
+    def initialize(namespace = nil)
+      @namespace = namespace
+      @cache = {@namespace => {}}
+    end
+
+    def set(key, value, expiration_time = 0)
+      @cache[@namespace][key] = {value: value, expiration_time: expiration_time, set_time: Time.now}
+    end
+
+    def get(key)
+      return nil unless @cache[@namespace][key]
+
+      if expired?(key)
+        delete(key)
+        return nil
+      end
+
+      @cache[@namespace][key][:value]
+    end
+
+    def delete(key)
+      @cache[@namespace].delete(key)
+    end
+
+    private
+
+    def expired?(key)
+      return false if @cache[@namespace][key][:expiration_time] == 0
+      Time.now - @cache[@namespace][key][:set_time] > @cache[@namespace][key][:expiration_time]
+    end
+  end
+end

data/spec/cache_local/file_spec.rb

@@ -0,0 +1,48 @@
+$: << File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+require 'cache_local'
+
+describe CacheLocal::File do
+  before do
+    @cache = CacheLocal::File.new(File.join('', 'tmp'), 'cache_local')
+  end
+
+  describe '#get' do
+    describe "when expiration_time isn't set" do
+      before do
+        @cache.set('key', 'value')
+      end
+      it "returns 'value' when key exists" do
+        expect(@cache.get('key')).to eq('value')
+      end
+
+      it "returns nil when key dosen't exist" do
+        expect(@cache.get('hoge')).to eq(nil)
+      end
+    end
+
+    describe "when expiration_time is set" do
+      before do
+        @cache.set('key', 'value', 1)
+      end
+      it "returns 'value' when key isn't expired" do
+        expect(@cache.get('key')).to eq('value')
+      end
+
+      it "returns nil when key is expired" do
+        sleep(1)
+        expect(@cache.get('key')).to eq(nil)
+      end
+    end
+  end
+
+  describe '#delete' do
+    before do
+      @cache.set('key', 'value')
+    end
+
+    it 'returns nil when key is deleted' do
+      @cache.delete('key')
+      expect(@cache.get('hoge')).to eq(nil)
+    end
+  end
+end

data/spec/cache_local/process_spec.rb

@@ -0,0 +1,48 @@
+$: << File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+require 'cache_local'
+
+describe CacheLocal::Process do
+  before do
+    @cache = CacheLocal::Process.new('cache_local')
+  end
+
+  describe '#get' do
+    describe "when expiration_time isn't set" do
+      before do
+        @cache.set('key', 'value')
+      end
+      it "returns 'value' when key exists" do
+        expect(@cache.get('key')).to eq('value')
+      end
+
+      it "returns nil when key dosen't exist" do
+        expect(@cache.get('hoge')).to eq(nil)
+      end
+    end
+
+    describe "when expiration_time is set" do
+      before do
+        @cache.set('key', 'value', 1)
+      end
+      it "returns 'value' when key isn't expired" do
+        expect(@cache.get('key')).to eq('value')
+      end
+
+      it "returns nil when key is expired" do
+        sleep(1)
+        expect(@cache.get('key')).to eq(nil)
+      end
+    end
+  end
+
+  describe '#delete' do
+    before do
+      @cache.set('key', 'value')
+    end
+
+    it 'returns nil when key is deleted' do
+      @cache.delete('key')
+      expect(@cache.get('hoge')).to eq(nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: cache_local
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kei Tsuchiya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !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: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Simple local cache
+email:
+- kei.tsuchiya86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- cache_local.gemspec
+- lib/cache_local.rb
+- lib/cache_local/file.rb
+- lib/cache_local/process.rb
+- spec/cache_local/file_spec.rb
+- spec/cache_local/process_spec.rb
+homepage: https://github.com/kei500/cache_local
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Enable to cache using file or process
+test_files:
+- spec/cache_local/file_spec.rb
+- spec/cache_local/process_spec.rb