mongoid_cached_document 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matthew Gibbons <mhgibbons@me.com>
+
+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,17 @@
+= mongoid_cached_document
+
+Description goes here.
+
+== 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 Matthew Gibbons. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongoid_cached_document"
+    gem.summary = %Q{Document caching for Mongoid}
+    gem.description = %Q{Adds support for caching Mongoid documents as a field within other Mongoid documents, with complete control over which fields to cache.}
+    gem.email = "mhgibbons@me.com"
+    gem.homepage = "http://github.com/accuser/mongoid_cached_document"
+    gem.authors = [ "Matthew Gibbons" ]
+    gem.add_dependency "mongoid", ">= 2.0.0.beta2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongoid_cached_document #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid/cached_document.rb

@@ -0,0 +1,76 @@
+#--
+# Copyright (c) 2010 Matthew Gibbons <mhgibbons@me.com>
+#
+# 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.
+#++
+
+require 'rubygems'
+
+gem 'mongoid', '>= 2.0.0.beta2'
+
+require 'mongoid'
+
+module Mongoid
+  class CachedDocument
+    def initialize(attributes)
+      @cached_attributes = attributes
+    end
+
+    class << self
+      def set(value)
+        if value.respond_to? :cachable_attributes
+          value.cachable_attributes.merge({ '_type' => value.class.to_s, '_id' => value.id })
+        else
+          { '_type' => value.class.to_s, '_id' => value.id }
+        end
+      end
+  
+      def get(value)
+        self.new(value)
+      end
+    end
+
+    def ==(value)
+      _document == value
+    end
+
+    alias_method :eql?, :==
+    alias_method :equal?, :==
+
+    def method_missing(name, *args, &block)
+      if @document
+        _document.send name, *args, &block
+      elsif @cached_attributes.has_key? name.to_s
+        @cached_attributes[name.to_s]
+      else
+        if defined? Rails
+          Rails.logger.debug("#{@cached_attributes['_type']}[:#{name}] is not cached (called from #{caller(1).first})")
+        end
+        
+        _document.send name, *args, &block
+      end
+    end
+
+    private
+      def _document
+        @document ||= @cached_attributes['_type'].constantize.find(@cached_attributes['_id'])
+      end
+  end
+end

data/mongoid_cached_document.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_cached_document}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthew Gibbons"]
+  s.date = %q{2010-04-07}
+  s.description = %q{Adds support for caching Mongoid documents as a field within other Mongoid documents, with complete control over which fields to cache.}
+  s.email = %q{mhgibbons@me.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mongoid/cached_document.rb",
+     "mongoid_cached_document.gemspec",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/unit/mongoid/cached_document_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/accuser/mongoid_cached_document}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Document caching for Mongoid}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/unit/mongoid/cached_document_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0.beta2"])
+    else
+      s.add_dependency(%q<mongoid>, [">= 2.0.0.beta2"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, [">= 2.0.0.beta2"])
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongoid/cached_document'
+require 'spec'
+require 'spec/autorun'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('mongoid_cached_document_test')
+end
+
+Spec::Runner.configure do |config|
+  config.after :suite do
+    Mongoid.master.collections.each(&:drop)
+  end
+end

data/spec/unit/mongoid/cached_document_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Mongoid::CachedDocument do
+  class Document
+    include Mongoid::Document
+    
+    field :cachable_document, :type => Mongoid::CachedDocument
+  end
+
+  class CachableDocument
+    include Mongoid::Document
+    
+    field :title
+    field :body
+  end
+    
+  describe "#set" do
+    describe "with a document that supports caching" do
+      before :each do
+        @cachable_document = mock(CachableDocument)
+        
+        @cachable_document.stub(:id).and_return 42
+        @cachable_document.stub(:class).and_return CachableDocument
+        @cachable_document.stub(:cachable_attributes).and_return({ '_type' => 'CachableDocument', '_id' => 42, 'title' => 'Title' })
+      end
+
+      it "prepares a hash of cachable attributes" do
+        Mongoid::CachedDocument.set(@cachable_document).should == { '_type' => 'CachableDocument', '_id' => 42, 'title' => 'Title' }
+      end
+    end
+    
+    describe "with a document that doesn't support caching" do
+      before :each do
+        @cachable_document = mock(CachableDocument)
+        
+        @cachable_document.stub(:id).and_return 42
+        @cachable_document.stub(:class).and_return CachableDocument
+      end
+
+      it "prepares a hash of cachable attributes" do
+        Mongoid::CachedDocument.set(@cachable_document).should == { '_type' => 'CachableDocument', '_id' => 42 }
+      end
+    end
+  end
+  
+  describe "#get" do
+    before :each do
+      @cached_document = Mongoid::CachedDocument.get('_type' => 'CachableDocument', '_id' => 42, 'title' => 'Title')
+    end
+    
+    it "instantiates a new instance of CachedDocument from the supplied hash of attributes" do
+      @cached_document._type.should == 'CachableDocument'
+      @cached_document._id.should be 42
+      @cached_document.title == 'Title'
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_cached_document
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Gibbons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta2
+        version: 2.0.0.beta2
+  type: :runtime
+  version_requirements: *id001
+description: Adds support for caching Mongoid documents as a field within other Mongoid documents, with complete control over which fields to cache.
+email: mhgibbons@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongoid/cached_document.rb
+- mongoid_cached_document.gemspec
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/mongoid/cached_document_spec.rb
+has_rdoc: true
+homepage: http://github.com/accuser/mongoid_cached_document
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Document caching for Mongoid
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/mongoid/cached_document_spec.rb