sir_cachealot 0.4.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.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 sir_cachealot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+.

data/README.md

@@ -0,0 +1,79 @@
+# SirCachealot
+![Sir Cachealot graphic](https://github.com/lyjia/sircachealot/blob/master/sircachealot.png?raw=true "Sir Cachealot graphic")
+
+SirCachealot is a very simple memcache-like keystore, licensed under LGPLv3. It is built to be modular and present a consistent API.
+
+Future plans for 1.0:
+* Rails cache, Redis, and memcache storage modes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'SirCachealot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install SirCachealot
+
+## Usage
+
+SirCachealot creates a new globally-accessible class named `Sir`.
+
+**You can use SirCachealot immediately, using either:**
+
+    Sir.put(keyname, value)
+    Sir.put(keyname, value, expiry) # expiry can be relative or absolute time expressed in seconds (Fixnum) or a Time object.
+
+`put()` will return the object you gave it. This is useful if you wish to use `get()`'s `yield` functionality.
+
+**You can retreive the value later, if it hasn't expired, with:**
+
+    my_var = Sir.get(keyname)
+
+or
+
+	# put() returns the object you give it
+	my_var = Sir.get(keyname) do 
+		Sir.put(keyname, User.find_by_id(id))
+	end
+
+If the key does not exist, or if it has expired:
+* `get()` returns `nil` if not given a block to execute.
+* `get()` yields to code block, if one is supplied.
+
+**If you want to clear the cache, you can:**
+
+    Sir.clear
+
+**If you want to sweep and purge all expired entries, you can:**
+
+    Sir.clean
+
+**There are a few configuration options available. You can configure SirCachealot with:**
+
+    Sir.configure do |config|
+        config[:default_expiry] = 3600 # default expiration timeout in seconds
+        config[:mode]           = :ram_cache # cache storage mode. Currently only :ram_cache is supported. Others may be added at a later date.
+        config[:debug]          = true|false # show some debug messages
+        config[:annoy]          = true|false # show even more debug messages
+    end
+    
+*Note: Config keynames are always `.downcase.to_sym`!*
+
+## 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
+
+## License
+
+Use of SirCachealot is permitted under the terms of [LGPLv3](http://www.gnu.org/licenses/lgpl-3.0.txt).
+For more information see LICENSE.txt.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => [:spec]
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r sir_cachealot.rb"
+end

data/lib/sir_cachealot/version.rb

@@ -0,0 +1,3 @@
+module SirCachealot
+  VERSION = "0.4.0"
+end

data/lib/sir_cachealot.rb

@@ -0,0 +1,194 @@
+require "sir_cachealot/version"
+
+module Sir
+
+  RAM = :ram_cache
+
+  @@ram_cache = { }
+
+  @@configuration = {
+    mode:           RAM,
+    debug:          false,
+    annoy:          false, #super annoying debug messages
+    default_expiry: 3600, #Integer(1.hour),
+
+  }
+
+  #Configuration parameters
+  # configure() yields a block, as per convention
+  # configure(key) returns the value of key, or nil
+  # configure(key, value) sets key to value
+  def self.configure(key = nil, value = nil)
+
+    key = key.downcase.to_sym unless key.nil?
+
+    if !key.nil? && !value.nil?
+      @@configuration[key] = value
+      return value
+
+    elsif !key.nil? && value.nil?
+      return @@configuration[key]
+
+    elsif key.nil? && value.nil?
+      yield(@@configuration)
+
+      #normalize keynames
+      @@configuration.keys.each do |k|
+
+        knew = k.downcase.to_sym
+
+        unless knew == k
+          @@configuration[knew] = @@configuration[k]
+          @@configuration.delete(k)
+        end
+
+      end
+
+    end
+
+  end
+
+  class << self
+    alias :config :configure
+  end
+
+
+  # Gets value for supplied key
+  # Returns nil if empty or expired
+  def self.get(key)
+
+    case config(:mode)
+    when RAM
+
+      if x = @@ram_cache[key]
+
+        if x[:expiry] > Time.now
+          return x[:value]
+        else
+          # cache entry is stale
+          puts ("          SirCachealot: Cache entry <#{key}> expired at #{x[:expiry]}. Deleting...") if config(:debug)
+          @@ram_cache.delete(key)
+          if block_given?
+            yield
+          else
+            nil
+          end
+        end
+
+      else
+
+        if block_given?
+          yield
+        else
+          return nil
+        end
+      end
+
+    else
+      puke
+    end
+
+  end
+
+  # Puts value in cache, key is param key
+  # Param expiry is optional, it can be a relative or absolute Fixnum or Time object
+  # Returns expiry time in absolute form (e.g. 3:56pm instead of 3 hours from now)
+  def self.put(key, value, expiry = config(:default_expiry))
+
+    case expiry.class.name
+    when "Fixnum"
+      true
+    when "Time"
+      expiry = Integer(expiry)
+    else
+      raise ArgumentError, "Expiry must be a Fixnum or Time object"
+    end
+
+
+    unless (expiry > Integer(Time.now))
+      expiry = Time.now + expiry
+    end
+
+    puts "          SirCachealot: Will expire <#{key}> at #{expiry}" if config(:annoy) == true
+
+    case config(:mode)
+    when RAM
+
+      @@ram_cache[key]          ||= { }
+      @@ram_cache[key][:value]  = value
+      @@ram_cache[key][:expiry] = expiry
+      return value
+
+    else
+      puke
+    end
+
+
+  end
+
+  # Gets the qty of keys in the cache
+  def self.size?
+
+    case config(:mode)
+    when RAM
+      return @@ram_cache.count
+    else
+      puke
+    end
+
+  end
+
+  # Dumps list of cache keys to console, with their value's class.name and expiry
+  def self.dump
+
+    case config(:mode)
+    when RAM
+      @@ram_cache.each do |k, v|
+        puts("%-20s %-20s %20s" % [k, v[:value].class, v[:expiry]])
+      end
+    else
+      puke
+    end
+
+
+    return nil
+
+  end
+
+  # Clears the cache, erases all cache entries
+  def self.clear
+
+    case config(:mode)
+    when RAM
+      @@ram_cache = { }
+    else
+      puke
+    end
+
+  end
+
+  # Sweeps the cache for expired keys and purges them. NOT THREAD-SAFE!
+  def self.clean
+
+    case config(:mode)
+
+    when RAM
+      @@ram_cache.each_key do |k|
+        if @@ram_cache[k][:expiry] < Time.now
+          puts("          SirCachealot: Cleaned #{k}") if config(:debug)
+          @@ram_cache.delete(k)
+        end
+      end
+    else
+      puke
+    end
+
+  end
+
+  private
+
+  def self.puke
+    raise TypeError, "Invalid config(:mode). Check the inputs sent to Sir.configure()"
+  end
+
+end

data/sir_cachealot.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sir_cachealot/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sir_cachealot"
+  gem.version       = SirCachealot::VERSION
+  gem.authors       = ["Lyjia"]
+  gem.email         = ["tom@tomcorelis.com"]
+  gem.description   = %q{A dead simple RAM keystore}
+  gem.summary       = %q{SirCachealot is a drop-in memcache-like RAM cache for Ruby. Cache entries are saved and recalled by a key string, and their values can be whatever a Ruby hash can hold. Values can also expire, however expiration is only checked when the key is called, or a manual sweeper is run. }
+  gem.homepage      = "http://www.lyjia.us"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.5'
+
+end

data/spec/sir_cachealot_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+TEST = "test"
+DEFAULT_EXPIRY = 600
+
+describe SirCachealot do
+
+  it 'should be configurable' do
+
+    Sir.configure do |config|
+      config[:default_expiry] = DEFAULT_EXPIRY
+      config["MODE"]          = :ram_cache
+      config[:debug]          = true
+    end
+
+    (Sir.config(:default_expiry) == DEFAULT_EXPIRY && Sir.config("MODE") == :ram_cache).should == true
+
+  end
+
+  it 'should return the key that is put into it' do
+    Sir.put(:test, TEST).should == TEST
+  end
+
+  it 'should return an arbitrary key' do
+
+    (Sir.get(:test) == TEST).should == true
+
+  end
+
+  it 'should yield when given a block and a key that does not exist' do
+    (Sir.get(:asdoiajdoaijdaodijaodiajdoaidjaodijaodij) { 5 }).should == 5
+  end
+
+  it 'should return nil when not given a block and a key that does not exist' do
+        (Sir.get(:asdoiajdoaijdaodijaodiajdoaidjaodijaodij)).should == nil
+  end
+
+  it 'should immediately expire a 0-expiry key' do
+    Sir.put(:expire, TEST, 0)
+    sleep(1)
+
+    Sir.get(:expire).should == nil
+  end
+
+  it 'should report its size correctly' do
+
+    Sir.size?.should == 1
+
+  end
+
+  it 'should clean() correctly' do
+
+    Sir.clear
+
+    Sir.put(:clean, TEST, 0)
+    Sir.clean
+
+    Sir.size?.should == 0
+
+
+  end
+
+  it 'should dump() correctly' do
+    Sir.put(:dump, TEST)
+    Sir.dump
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'sir_cachealot'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: sir_cachealot
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Lyjia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: A dead simple RAM keystore
+email:
+- tom@tomcorelis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sir_cachealot.rb
+- lib/sir_cachealot/version.rb
+- sir_cachealot.gemspec
+- sircachealot.png
+- spec/sir_cachealot_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.lyjia.us
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SirCachealot is a drop-in memcache-like RAM cache for Ruby. Cache entries
+  are saved and recalled by a key string, and their values can be whatever a Ruby
+  hash can hold. Values can also expire, however expiration is only checked when the
+  key is called, or a manual sweeper is run.
+test_files:
+- spec/sir_cachealot_spec.rb
+- spec/spec_helper.rb