castache 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+services:
+ - redis-server

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.0.1 (Nov 30, 2012)
+
+_initial release!_
+
+Features:
+- marshals object to redis with `Catache.set`
+- returns re-hydrated ruby object from redis with `Castache.get`
+- returns re-hydrated ruby object with `Castache.fetch` and will set contents of
+  the block you pass in if the object does not exist in the cache

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 StyleSeek Engineering Team 
+
+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,44 @@
+# Castache
+
+Simple structured cache for ruby apps. Marshals objects to and from Redis
+quickly and painlessly. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'castache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install castache
+
+## Usage
+    
+````ruby
+require 'castache'
+Castache.redis = Redis.new # you can also pass it a redis:// URI string
+                            # or hash of options to pass to Redis.new
+@object = Castache.fetch 'cache:key' do 
+  {hello: 'world'} # some expensive operation goes here...
+end
+p @object
+````
+
+## Project Status
+
+- Build: [![Build Status](https://secure.travis-ci.org/styleseek/castache.png?branch=master)](https://travis-ci.org/styleseek/castache)
+- Code Quality: [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/styleseek/castache)
+- Dependencies: [![Dependency Status](https://gemnasium.com/styleseek/castache.png)](https://gemnasium.com/styleseek/castache)
+
+## 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,7 @@
+require "bundler/gem_tasks"
+
+desc "run the specs"
+task :spec do
+  puts `bundle exec turn -Ispec spec/*_spec.rb`
+end
+task :default => :spec

data/castache.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'castache/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "castache"
+  gem.version       = Castache::VERSION
+  gem.authors       = ["StyleSeek Engineering"]
+  gem.email         = ["engineering@styleseek.com"]
+  gem.description   = %q{Simple structured object cache for ruby apps. }
+  gem.summary       = %q{Simple structured object cache for ruby apps. Marshals objects to and from Redis quickly and painlessly. }
+  gem.homepage      = ""
+
+  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{^(spec)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('redis', '~> 3.0')
+  
+  gem.add_development_dependency('rake',        '~> 10')
+  gem.add_development_dependency('minitest',    '~> 4.2')
+  gem.add_development_dependency('ansi',        '~> 1.4')
+  gem.add_development_dependency('turn',        '~> 0.9')
+  gem.add_development_dependency('pry',         '~> 0.9')
+  gem.add_development_dependency('mocha',       '~> 0.13')
+  gem.add_development_dependency('gem-release', '~> 0.4')
+end

data/lib/castache.rb

@@ -0,0 +1,52 @@
+require 'redis'
+require 'castache/version'
+
+class Castache
+  class << self
+    attr_accessor :redis
+
+    def fetch (key, &block)
+      unless object = get(key)
+        object = set(key, block.call) if block_given?
+      end
+      object
+    end
+
+    def set(key, object)
+      object if @redis.set(key, Marshal.dump(object))
+    end
+
+    def get(key)
+      if value = @redis.get(key)
+        Marshal.load(value)
+      end
+    end
+    
+    # Pass it a connected Redis object, a redis:// uri string, or a hash of
+    # options for Redis.new
+    def redis=(connection)
+      if connection.is_a? Redis
+        Redis.current = connection
+      elsif connection.is_a? String
+        Redis.current = connect(connection) if URI(connection).scheme == 'redis'
+      elsif connection.is_a? Hash
+        Redis.current = Redis.new connection
+      end
+      @redis = Redis.current
+    end
+
+    def redis
+      @redis ||= Redis.current
+    end
+  end
+
+  private
+
+  def self.connect(redis_uri)
+    uri = URI(redis_uri)
+    Redis.new(:host => uri.host,
+              :port => uri.port,
+              :password => uri.password,
+              :thread_safe => true)
+  end
+end

data/lib/castache/version.rb

@@ -0,0 +1,3 @@
+class Castache
+  VERSION = "0.0.1"
+end

data/spec/castache_spec.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Castache do
+
+  let(:obj) { OpenStruct.new :string => 'Test',
+                             :integer => 42,
+                             :float => 1.0,
+                             :array => [:a,:b,:c],
+                             :hash => {'key'=>'value'},
+                             :date => DateTime.strptime('253555860','%s') }
+  before do
+    Castache.redis = Redis.current
+  end
+
+  after do
+    Castache.redis.flushall
+  end
+
+  describe "#redis" do
+    it "returns the current redis connection" do
+      Castache.redis.must_be_kind_of Redis
+    end
+  end
+
+  describe "#redis=" do
+    describe "can connect to redis" do
+      it "when given a Redis object" do
+        (Castache.redis = Redis.new)
+        Castache.redis.must_be_kind_of Redis
+      end
+
+      it "when given a uri string" do
+        Castache.redis = "redis:://localhost:6379"
+        Castache.redis.must_be_kind_of Redis
+      end
+
+      it "when given a hash" do
+        Castache.redis = { host: 'localhost', port: 6379, thread_safe: true }
+        Castache.redis.must_be_kind_of Redis
+      end
+    end
+  end
+
+  describe "#write" do
+    it "can write an object to the cache" do
+      Castache.set('write-test',obj).must_equal obj
+    end
+  end
+
+  describe "#read" do
+    it "can read an object from the cache" do
+      Castache.set('read-test',obj)
+      Castache.get('read-test').must_equal obj
+    end
+
+    it "returns nil if the key fails to retrieve an object" do
+      Castache.get('read-nil-test').must_be_nil
+    end
+  end
+
+  describe "#fetch" do
+    before do
+      @hash = {:test => 'data'}
+      Castache.set('fetch-test', @hash)
+    end
+
+    it "returns an object in the cache, if it already exits" do
+      result = Castache.fetch('fetch-test') { obj }
+      result.must_equal @hash
+    end
+
+    it "stores the block contents in the cache, if it does not exist" do
+      Castache.fetch('fetch-nil-test') { obj }.must_equal obj
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'castache'
+require 'ostruct'
+begin; require 'turn/autorun'; rescue LoadError; end
+Turn.config do |c|
+  c.natural = true
+  c.ansi = true
+  c.format = :pretty
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: castache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- StyleSeek Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-30 00:00:00.000000000 -06:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70340648244680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340648244680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70340652778580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: *70340652778580
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70340651333460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70340651333460
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: &70340651316260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: *70340651316260
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70340651552720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70340651552720
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70340646922760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70340646922760
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70340635446320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: *70340635446320
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: &70340640688120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: *70340640688120
+description: ! 'Simple structured object cache for ruby apps. '
+email:
+- engineering@styleseek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- castache.gemspec
+- lib/castache.rb
+- lib/castache/version.rb
+- spec/castache_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -3694376980599044599
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3694376980599044599
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.3.9.5
+signing_key: 
+specification_version: 3
+summary: Simple structured object cache for ruby apps. Marshals objects to and from
+  Redis quickly and painlessly.
+test_files:
+- spec/castache_spec.rb
+- spec/spec_helper.rb