mongoid-store 0.4.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDAwODkyODM3MGQ3MmM0OTNkZmZlMjE0MzY1YWUzM2YwMzJiYTE1ZQ==
+  data.tar.gz: !binary |-
+    MmVlNWVhYTk2NGRlOWFkYTdjMTk3NTYyY2M0OTI2MmJlZTU0YTg1Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTNjZDNiNTkxYjIzZTFiMzNmYjFiZjEyODhhMDkxODYzYjlkOTk5ZjdjNjgx
+    YzFiZDRiMTAwMzAyOTVkOTk3MmFlY2JkMTQxZDA0YzI3OTVhZDBiN2RlYzg4
+    OTBmYjc0ODBhN2MyMDYyMjdlOWY3NGY0OTBiZTEwYWQ5NjZhZjI=
+  data.tar.gz: !binary |-
+    ZTExM2Q5ZjhiY2NjOTUwY2UzMGZmMTA3NTUxMzc1OGM3NTA5Mjg4OGZlOTVm
+    ZmEzNDhiNmI3MjRhMjg3NGYxMWRlZjk4YTM1Y2NjMDM1MDI4N2MwOTNiZmQz
+    OTRlMzlkYTY3ZTg0MDRhMmE3ZjFhYjU5OGU3Zjk4ZTdjNjMyNWU=

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'mongoid', "~> 3.0"
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    mongoid-store (0.4.2)
+      activesupport (~> 3.2)
+      mongoid (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    mongoid (3.1.4)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.5.0)
+    multi_json (1.7.6)
+    origin (1.1.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.5)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mongoid (~> 3.0)
+  mongoid-store!
+  pry
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Andre Meij
+
+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,60 @@
+MongoidStore
+------------
+
+ActiveSupport Mongoid 3 Cache store, strongly  based on the 'mongoid_store'
+gem by Andre Meij (see his orginial LICENSE)
+
+unlike the the original gem this version works with both rails3 and rails4,
+and handles any object in any encoding (remember mongo is utf8 only)
+
+
+
+Supports
+--------
+
+* Mongoid 3+
+* Ruby 1.9.2+
+* ActiveSupport 3+
+
+
+Installation and Usage
+----------------------
+
+```bash
+  # cli
+
+  gem install mongoid-store
+```
+
+```ruby
+  # Gemfile
+
+  gem 'mongoid-store'
+```
+
+Direct usage
+
+```ruby
+  # direct usage
+
+  require 'mongoid-store'
+
+  store = ActiveSupport::Cache::MongoidStore.new
+  store.write('abc', 123)
+
+  store.read('abc')
+
+  store.read('def')
+  store.fetch('def'){ 456 }
+  store.read('def')
+```
+
+Using MongoidStore with rails is as easy as:
+
+```ruby
+  # rails usage
+
+  config.cache_store = :mongoid_store
+
+  Rails.cache.write(:key, :val)
+```

data/README.rdoc

@@ -0,0 +1,29 @@
+= MongoidStore
+
+  ActiveSupport Mongoid 3 Cache store, strongly  based on the 'mongoid_store' gem by Andre Meij
+
+
+
+== Supports
+
+* Mongoid 3+
+* Ruby 1.9.2+
+* ActiveSupport 3+
+
+== Installation and Usage
+
+  gem install mongoid-store
+
+  require 'mongoid-store'
+
+  store = ActiveSupport::Cache::MongoidStore.new
+  store.write('abc', 123)
+  pp store.read('abc')
+
+  pp store.read('def')
+  pp store.fetch('def'){ 456 }
+  pp store.read('def')
+
+Using MongoidStore with rails is as easy as:
+
+    config.cache_store = :mongoid_store

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/a.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+#
+require 'mongoid'
+
+string = Marshal.dump("\255")
+
+marshaled = Marshal.dump(string)
+
+binary = Moped::BSON::Binary.new(:generic, marshaled)
+
+unmarshaled = Marshal.load(binary.to_s)
+
+
+p(unmarshaled == string)
+p(unmarshaled.encoding)
+p(string.encoding)
+p('foobar'.encoding)

data/lib/active_support/cache/mongoid-store.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+#
+require 'mongoid'
+require 'active_support'
+
+module ActiveSupport
+  module Cache
+    class MongoidStore < Store
+      attr_reader :collection_name
+
+      def initialize(options = {})
+        @collection_name = options[:collection] || :rails_cache
+        options[:expires_in] ||= 1.hour
+        super(options)
+      end
+
+      def clear(options = nil)
+        collection.find.remove_all
+      end
+
+      def cleanup(options = nil)
+        options = merged_options(options)
+        collection.find(expires_at: {'$lt' => Time.now.utc.to_i}).remove_all
+      end
+
+      def delete_matched(matcher, options = nil)
+        options = merged_options(options)
+        collection.find(_id: key_matcher(matcher, options)).remove_all
+      end
+
+      def delete_entry(key, options = nil)
+        collection.find(_id: key).remove
+      end
+
+    protected
+
+      def write_entry(key, entry, options)
+        data = Entry.data_for(entry)
+        expires_at = entry.expires_at.to_i
+        created_at = Time.now.utc.to_i
+
+        collection.find(_id: key).upsert(_id: key, data: data, expires_at: expires_at, created_at: created_at)
+
+        entry
+      end
+
+      def read_entry(key, options = {})
+        expires_at = Time.now.utc.to_i
+        doc = collection.find(_id: key, expires_at: {'$gt' => expires_at}).first
+
+        Entry.for(doc) if doc
+      end
+
+    # this class exists to normalize between rails3 and rails4, but also to
+    # repair totally broken interfaces in rails - especially in rails3 - that
+    # result in lots of extra serialization/deserialzation in a class which is
+    # supposed to be FAST
+    #
+      class Entry < ::ActiveSupport::Cache::Entry
+        def Entry.is_rails3?
+          unless defined?(@is_rails3)
+            @is_rails3 = new(nil).instance_variable_defined?('@value')
+          end
+
+          @is_rails3
+        end
+
+      # extract marshaled data from a cache entry without doing unnecessary
+      # marshal round trips.  rails3 will have either a nil or pre-marshaled
+      # @value whereas rails4 will have either a marshaled or un-marshaled @v.
+      # in both cases we want to avoid calling the silly 'value' accessor
+      # since this will cause a potential Marshal.load call and require us to
+      # make a subsequent Marshal.dump call which is SLOOOWWW.
+      #
+        if is_rails3?
+
+          def Entry.data_for(entry)
+            value = entry.instance_variable_get('@value')
+            marshaled = value.nil? ? Marshal.dump(value) : value
+            Moped::BSON::Binary.new(:generic, marshaled)
+          end
+
+        else
+
+          def Entry.data_for(entry)
+            v = entry.instance_variable_get('@v')
+            marshaled = entry.send('compressed?') ? v : entry.send('compress', v)
+            Moped::BSON::Binary.new(:generic, marshaled)
+          end
+
+        end
+
+      # the intializer for rails' default Entry class will go ahead and
+      # perform and extraneous Marshal.dump on the data we just got from the
+      # db even though we don't need it here.  rails3 has a factory to avoid
+      # this but rails4 does not so we just build the object we want and
+      # ensure to avoid any unnecessary calls to Marshal.dump/load...  sigh.
+      #
+        if is_rails3?
+
+          def Entry.for(doc)
+            data = doc['data'].to_s
+            value = Marshal.load(data)
+            created_at = doc['created_at'].to_f
+
+            allocate.tap do |entry|
+              entry.instance_variable_set(:@value, value)
+              entry.instance_variable_set(:@compressed, false)
+              entry.instance_variable_set(:@created_at, created_at)
+            end
+          end
+
+        else
+
+          def Entry.for(doc)
+            data = doc['data'].to_s
+            value = Marshal.load(data)
+            created_at = doc['created_at'].to_f
+
+            allocate.tap do |entry|
+              entry.instance_variable_set(:@v, value)
+              entry.instance_variable_set(:@c, false)
+            end
+          end
+
+        end
+
+        def value
+          Entry.is_rails3? ? @value : @v
+        end
+
+        def raw_value
+          Entry.is_rails3? ? @value : @v
+        end
+      end
+
+    private
+
+      def collection
+        Mongoid.session(:default)[collection_name]
+      end
+    end
+  end
+end

data/lib/mongoid-store.rb

@@ -0,0 +1,3 @@
+require 'active_support/cache/mongoid-store'
+
+module MongoidStore; end

data/lib/mongoid-store/version.rb

@@ -0,0 +1,3 @@
+module MongoidStore
+  Version = '0.4.3'
+end

data/mongoid-store.gemspec

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+require File.expand_path('../lib/mongoid-store/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = "mongoid-store"
+  s.version      = MongoidStore::Version
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Ara Howard"]
+  s.email        = ["ara.t.howard@gmail.com"]
+  s.homepage     = "http://github.com/ahoward/mongoid-store"
+  s.description  = "Rails Mongoid 3 Cache store."
+  s.summary      = "Rails Mongoid 3 Cache store"
+  s.license      = "Same as Ruby's"
+
+  s.add_dependency 'mongoid',       '~> 3.0'
+  s.add_dependency 'activesupport', '~> 3.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/helper.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+#
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'bundler'
+require 'active_support/all'
+
+Bundler.require(:default)
+
+require 'mongoid-store'
+
+Mongoid.load!(File.expand_path("../mongoid.yml", __FILE__), :test)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Mongoid.session(:default).collections.each do |collection|
+      collection.find.remove_all
+    end
+  end
+end

data/spec/mongoid-store_spec.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+#
+require 'helper'
+
+describe ActiveSupport::Cache::MongoidStore do
+  let(:collection)  { Mongoid.session(:default)[:rails_cache] }
+  let(:store)       { ActiveSupport::Cache::MongoidStore.new }
+
+  describe "#write" do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+    let(:document) { collection.find(_id: 'foo').first }
+
+    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 "sets expires in to default if not provided" do
+      document['expires_at'].to_i.should == (Time.now.utc + 1.hour).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(_id: 'baz').first
+      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(_id: 'foo').first }
+
+    it "returns nil for key not found" do
+      store.read('non:existent:key').should be_nil
+    end
+
+    it "returns nil for existing but expired key" do
+      collection.find(_id: 'foo').upsert(_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 "encoding" do
+    before(:each) do
+      store.write('non_utf8', "\255")
+    end
+    let(:document) { collection.find(_id: 'non_utf8').first }
+
+    it "can write non-utf data" do
+      document.should_not be_nil
+      document['data'].should be_instance_of(Moped::BSON::Binary)
+    end
+
+    it "can read non-utf data" do
+      value = store.read('non_utf8')
+      value.should_not be_nil
+      value.should eq("\255")
+    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.find.count.should == 2
+      store.clear
+      collection.find.count.should == 0
+    end
+  end
+end

data/spec/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid-store
+      hosts:  
+        - localhost:27017

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--timeout
+20

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-store
+version: !ruby/object:Gem::Version
+  version: 0.4.3
+platform: ruby
+authors:
+- Ara Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rails Mongoid 3 Cache store.
+email:
+- ara.t.howard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- a.rb
+- lib/active_support/cache/mongoid-store.rb
+- lib/mongoid-store.rb
+- lib/mongoid-store/version.rb
+- mongoid-store.gemspec
+- pkg/mongoid-store-0.4.2.gem
+- spec/helper.rb
+- spec/mongoid-store_spec.rb
+- spec/mongoid.yml
+- spec/spec.opts
+homepage: http://github.com/ahoward/mongoid-store
+licenses:
+- Same as Ruby's
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rails Mongoid 3 Cache store
+test_files:
+- spec/helper.rb
+- spec/mongoid-store_spec.rb
+- spec/mongoid.yml
+- spec/spec.opts