mongoid_cacheable 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rake_tasks~
+coverage
+Gemfile.lock
+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,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_cacheable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Noah H. Smith
+
+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,34 @@
+mongoid_cacheable
+=================
+
+Cache Methods in any Mongoid Document.
+
+## Getting Started
+
+```ruby
+require 'mongoid'
+require 'mongoid_cacheable'
+
+class User
+  include Mongoid::Document
+  include Mongoid::Cacheable
+
+  field :name
+  cache :characters_in_name, type: Integer
+
+  def characters_in_name
+    name.length
+  end
+end
+
+user = User.new(name: 'John')
+
+user.attributes[:characters_in_name]
+  #=> nil
+
+user.characters_in_name
+  #=> 4
+
+user.attributes[:characters_in_name]
+  #=> 4
+```

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:spec]

data/lib/mongoid_cacheable/version.rb

@@ -0,0 +1,3 @@
+module MongoidCacheable
+  VERSION = "0.0.1"
+end

data/lib/mongoid_cacheable.rb

@@ -0,0 +1,24 @@
+require "active_support"
+require "mongoid"
+require "mongoid_cacheable/version"
+
+module Mongoid
+  module Cacheable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def cache( name, *options )
+        field_name = "_#{name}"
+        uncached_name = "uncached_#{name}"
+        cached_name = "cached_#{name}"
+
+        field field_name, *options
+
+        alias_method uncached_name, name
+        alias_method cached_name, field_name
+
+        define_method(name) { |*args| attributes[field_name] ||= send(uncached_name) }
+      end
+    end
+  end
+end

data/mongoid_cacheable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid_cacheable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Noah H. Smith"]
+  gem.email         = ["nsmith@rendergardenmedia.com"]
+  gem.description   = %q{Cache Methods in any Mongoid Document}
+  gem.summary       = %q{Adds the ability to cache any instance method into a
+                         Mongoid Document}
+  gem.homepage      = "http://github.com/noazark/mongoid_cacheable"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongoid_cacheable"
+  gem.require_paths = ["lib"]
+  gem.version       = MongoidCacheable::VERSION
+  
+  gem.add_dependency("mongoid", ["~> 3.0.0"])
+  gem.add_dependency("activesupport", ["~> 3.2.0"])
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec")
+end

data/spec/models/book.rb

@@ -0,0 +1,11 @@
+class Book
+  include Mongoid::Document
+  include Mongoid::Cacheable
+
+  field :title
+
+  def title_length
+    title.length
+  end
+  cache :title_length, type: Integer
+end

data/spec/mongoid_cacheable_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Mongoid::Cacheable do
+
+  let(:book) { Book.new(title: 'Life') }
+
+  context "when uncached" do
+
+    it "caches method result" do
+      book.title_length
+      book.cached_title_length.should eq 4
+    end
+    
+    describe '#cached' do
+
+      it 'returns directly from cache' do
+        book.cached_title_length.should eq nil
+      end
+
+    end
+
+  end
+
+  context "when previously cached" do
+
+    before do
+      book._title_length = 17
+    end
+
+    it 'returns directly from cache' do
+      book.title_length.should eq 17
+    end
+  
+    describe '#cached' do
+
+      it 'returns directly from cache' do
+        book.cached_title_length.should eq 17
+      end
+
+    end
+  
+    describe '#uncached' do
+
+      it 'ignore cached value and return caclulated value' do
+        book.uncached_title_length.should eq 4
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+
+require File.expand_path '../../lib/mongoid_cacheable', __FILE__
+
+def database_id
+    ENV['CI'] ? "mongoid_cacheable_#{Process.pid}" : 'mongoid_cacheable_test'
+end
+
+Mongoid.configure do |config|
+  config.connect_to database_id
+end
+
+Dir['./spec/models/*.rb'].each { |f| require f }
+
+RSpec.configure do |c|
+  c.before(:each) do
+    Mongoid.purge!
+    Mongoid::IdentityMap.clear
+  end
+
+  c.after(:suite) do
+    Mongoid::Threaded.sessions[:default].drop if ENV['CI']
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_cacheable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Noah H. Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cache Methods in any Mongoid Document
+email:
+- nsmith@rendergardenmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid_cacheable.rb
+- lib/mongoid_cacheable/version.rb
+- mongoid_cacheable.gemspec
+- spec/models/book.rb
+- spec/mongoid_cacheable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/noazark/mongoid_cacheable
+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: Adds the ability to cache any instance method into a Mongoid Document
+test_files:
+- spec/models/book.rb
+- spec/mongoid_cacheable_spec.rb
+- spec/spec_helper.rb