honkster-bin 0.6.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Nunemaker
+
+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,20 @@
+= Bin
+
+ActiveSupport MongoDB Cache store.
+
+== Supports
+
+* Ruby 1.8.7 and Ruby 1.9.1.
+* ActiveSupport 2 and 3
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+require File.expand_path('../lib/bin/version', __FILE__)
+
+namespace :spec do
+  Spec::Rake::SpecTask.new(:all) do |t|
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  task :as2 do
+    sh 'ACTIVE_SUPPORT_VERSION="<= 2.3.8" rake spec:all'
+  end
+
+  task :as3 do
+    sh 'ACTIVE_SUPPORT_VERSION=">= 3.0.0.beta3" rake spec:all'
+  end
+end
+
+desc 'Runs all specs against Active Support 2 and 3'
+task :spec do
+  Rake::Task['spec:as2'].invoke
+  Rake::Task['spec:as3'].invoke
+end
+
+task :default => :spec
+
+desc 'Builds the gem'
+task :build do
+  sh "gem build bin.gemspec"
+end
+
+desc 'Builds and installs the gem'
+task :install => :build do
+  sh "gem install bin-#{Bin::Version}"
+end
+
+desc 'Tags version, pushes to remote, and pushes gem'
+task :release => :build do
+  sh "git tag v#{Bin::Version}"
+  sh "git push origin master"
+  sh "git push origin v#{Bin::Version}"
+  sh "gem push bin-#{Bin::Version}.gem"
+end

data/lib/bin/compatibility.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+module Bin
+  class Compatibility < ActiveSupport::Cache::Store
+    def increment(key, amount=1)
+      yield
+    end
+
+    def decrement(key, amount=1)
+      yield
+    end
+  end
+
+  if ActiveSupport::VERSION::STRING < '3'
+    class Compatibility
+      def write(key, value, options=nil, &block)
+        super(key, value, options)
+        yield
+      end
+
+      def read(key, options=nil, &block)
+        super
+        yield
+      end
+
+      def delete(key, options=nil, &block)
+        super
+        yield
+      end
+
+      def delete_matched(matcher, options=nil, &block)
+        super
+        yield
+      end
+
+      def exist?(key, options=nil, &block)
+        super
+        yield
+      end
+    end
+  end
+end

data/lib/bin/store.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+module Bin
+  class Store < Compatibility
+    attr_reader :collection, :options
+
+    def initialize(collection, options={})
+      @collection, @options = collection, options
+    end
+
+    def expires_in
+      @expires_in ||= options[:expires_in] || 1.year
+    end
+
+    def write(key, value, options={})
+      key = key.to_s
+      super do
+        expires = Time.now.utc + ((options && options[:expires_in]) || expires_in)
+        raw     = !!options[:raw]
+        value   = raw ? value : BSON::Binary.new(Marshal.dump(value))
+        doc     = {:_id => key, :value => value, :expires_at => expires, :raw => raw}
+        collection.save(doc)
+      end
+    end
+
+    def read(key, options=nil)
+      super do
+        if doc = collection.find_one(:_id => key.to_s, :expires_at => {'$gt' => Time.now.utc})
+          doc['raw'] ? doc['value'] : Marshal.load(doc['value'].to_s)
+        end
+      end
+    end
+
+    def delete(key, options=nil)
+      super do
+        collection.remove(:_id => key.to_s)
+      end
+    end
+
+    def delete_matched(matcher, options=nil)
+      super do
+        collection.remove(:_id => matcher)
+      end
+    end
+
+    def exist?(key, options=nil)
+      super do
+        !read(key, options).nil?
+      end
+    end
+
+    def increment(key, amount=1)
+      super do
+        counter_key_upsert(key, amount)
+      end
+    end
+
+    def decrement(key, amount=1)
+      super do
+        counter_key_upsert(key, -amount.abs)
+      end
+    end
+
+    def clear
+      collection.remove
+    end
+
+    def stats
+      collection.stats
+    end
+
+    private
+      def counter_key_upsert(key, amount)
+        key = key.to_s
+        collection.update(
+          {:_id => key}, {
+            '$inc' => {:value => amount},
+            '$set' => {
+              :expires_at => Time.now.utc + 1.year,
+              :raw        => true
+            },
+          }, :upsert => true)
+      end
+  end
+end

data/lib/bin/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+module Bin
+  Version = '0.6.3'
+end

data/lib/bin.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+require 'active_support/all'
+require 'active_support/version'
+require 'mongo'
+
+module Bin
+  autoload :Compatibility, 'bin/compatibility'
+  autoload :Store,         'bin/store'
+  autoload :Version,       'bin/version'
+end

data/spec/bin/store_spec.rb

@@ -0,0 +1,210 @@
+require 'helper'
+
+describe Bin::Store do
+  before(:each) do
+    DB.collections.each do |collection|
+      collection.remove
+      collection.drop_indexes
+    end
+  end
+
+  let(:collection)  { DB['bin_cache'] }
+  let(:store)       { Bin::Store.new(collection) }
+
+  it "has a collection" do
+    store.collection.should == collection
+  end
+
+  it "defaults expires_in to 1.year" do
+    store.expires_in.should == 1.year
+  end
+
+  it "can set default expires_in" do
+    Bin::Store.new(collection, :expires_in => 5.minutes).expires_in.should == 5.minutes
+  end
+
+  describe "#write" do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+    let(:document) { collection.find_one(:_id => 'foo') }
+
+    it "sets _id to key" do
+      document['_id'].should == 'foo'
+    end
+
+    it "sets value key to value" do
+      store.read('foo').should == 'bar'
+    end
+
+    it "should marshal value by default" do
+      document['value'].to_s.should == BSON::Binary.new(Marshal.dump('bar')).to_s
+      document['raw'].should be_false
+    end
+
+    it "should be able to store in raw format" do
+      store.write('foo', 'bar', :raw => true)
+      document['value'].should == 'bar'
+      document['raw'].should be_true
+    end
+
+    it "sets expires in to default if not provided" do
+      document['expires_at'].to_i.should == (Time.now.utc + 1.year).to_i
+    end
+
+    it "sets expires_at if expires_in provided" do
+      store.write('foo', 'bar', :expires_in => 5.seconds)
+      document['expires_at'].to_i.should == (Time.now.utc + 5.seconds).to_i
+    end
+
+    it "always sets key as string" do
+      store.write(:baz, 'wick')
+      doc = collection.find_one(:_id => 'baz')
+      doc.should_not be_nil
+      doc['_id'].should be_instance_of(String)
+    end
+  end
+
+  describe "#read" do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+    let(:document) { collection.find_one(:_id => 'foo') }
+
+    it "returns nil for key not found" do
+      store.read('non:existent:key').should be_nil
+    end
+
+    it "returns unmarshalled value key value for key found" do
+      store.read('foo').should == 'bar'
+    end
+
+    it "returns raw value if document raw key is true" do
+      store.write('foo', 'bar', :raw => true)
+      store.read('foo').should == 'bar'
+    end
+
+    it "returns nil for existing but expired key" do
+      collection.save(:_id => 'foo', :value => 'bar', :expires_at => 5.seconds.ago)
+      store.read('foo').should be_nil
+    end
+
+    it "return value for existing and not expired key" do
+      store.write('foo', 'bar', :expires_in => 20.seconds)
+      store.read('foo').should == 'bar'
+    end
+
+    it "works with symbol" do
+      store.read(:foo).should == 'bar'
+    end
+  end
+
+  describe "#delete" do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+
+    it "delete key from cache" do
+      store.read('foo').should_not be_nil
+      store.delete('foo')
+      store.read('foo').should be_nil
+    end
+
+    it "works with symbol" do
+      store.read(:foo).should_not be_nil
+      store.delete(:foo)
+      store.read(:foo).should be_nil
+    end
+  end
+
+  describe "#delete_matched" do
+    before(:each) do
+      store.write('foo1', 'bar')
+      store.write('foo2', 'bar')
+      store.write('baz', 'wick')
+    end
+
+    it "deletes matching keys" do
+      store.read('foo1').should_not be_nil
+      store.read('foo2').should_not be_nil
+      store.delete_matched(/foo/)
+      store.read('foo1').should be_nil
+      store.read('foo2').should be_nil
+    end
+
+    it "does not delete unmatching keys" do
+      store.delete_matched('foo')
+      store.read('baz').should_not be_nil
+    end
+  end
+
+  describe "#exist?" do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+
+    it "returns true if key found" do
+      store.exist?('foo').should be_true
+    end
+
+    it "returns false if key not found" do
+      store.exist?('not:found:key').should be_false
+    end
+
+    it "works with symbol" do
+      store.exist?(:foo).should be_true
+      store.exist?(:notfoundkey).should be_false
+    end
+  end
+
+  describe "#clear" do
+    before(:each) do
+      store.write('foo', 'bar')
+      store.write('baz', 'wick')
+    end
+
+    it "clear all keys" do
+      collection.count.should == 2
+      store.clear
+      collection.count.should == 0
+    end
+  end
+
+  describe "#increment" do
+    it "increment key by amount" do
+      store.increment('views', 1)
+      store.read('views').should == 1
+      store.increment('views', 2)
+      store.read('views').should == 3
+    end
+
+    it "works with symbol" do
+      store.increment(:views, 2)
+      store.read(:views).should == 2
+    end
+  end
+
+  describe "#decrement" do
+    it "decrement key by amount" do
+      store.increment('views', 5)
+      store.decrement('views', 2)
+      store.read('views').should == 3
+      store.decrement('views', 2)
+      store.read('views').should == 1
+    end
+
+    it "works with symbol" do
+      store.increment(:views, 2)
+      store.decrement(:views, 1)
+      store.read(:views).should == 1
+    end
+  end
+
+  describe "#stats" do
+    it "returns stats" do
+      %w[ns count size].each do |key|
+        store.stats.should have_key(key)
+      end
+    end
+  end
+end

data/spec/bin_spec.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+describe Bin do
+  it "autoloads Store" do
+    lambda { Bin::Store }.should_not raise_error(NameError)
+  end
+
+  it "autoloads Compatibility" do
+    lambda { Bin::Compatibility }.should_not raise_error(NameError)
+  end
+
+  it "autoloads Version" do
+    lambda { Bin::Version }.should_not raise_error(NameError)
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,11 @@
+gem 'activesupport', ENV['ACTIVE_SUPPORT_VERSION']
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'bin'
+require 'spec'
+
+connection = Mongo::Connection.new
+DB = connection.db('bin-store-test')
+
+puts "\n--- Active Support Version: #{ActiveSupport::VERSION::STRING} ---\n"

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--timeout
+20
+--diff

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: honkster-bin
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 3
+  version: 0.6.3
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bin/compatibility.rb
+- lib/bin/version.rb
+- lib/bin/store.rb
+- lib/bin.rb
+- spec/helper.rb
+- spec/bin_spec.rb
+- spec/spec.opts
+- spec/bin/store_spec.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jnunemaker/bin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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: ActiveSupport MongoDB Cache store.
+test_files: []
+