mongoid_cacheable 0.0.3 → 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@mongoid_cacheable

data/README.md

@@ -3,6 +3,9 @@ mongoid_cacheable
 
 Cache Methods in any Mongoid Document.
 
+[![Build Status](https://secure.travis-ci.org/noazark/mongoid_cacheable.png?branch=master)](http://travis-ci.org/noazark/mongoid_cacheable)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/noazark/mongoid_cacheable)
+
 ## Getting Started
 
 ```ruby
@@ -21,14 +24,15 @@ class User
   cache :name_length, type: Integer
 end
 
-user = User.new(name: 'John')
-
-user.attributes['_name_length']
-  #=> nil
-
-user.name_length
+user = User.new
+user.name = 'John'
+user.cached_name_length                   # calling the cached method for the first time
   #=> 4
-
-user.attributes['_name_length']
+user.name = 'Ron Jon'
+user.cached_name_length                   # the previous result is still cached
+  #=> 4
+user.name_length                          # access the original method
+  #=> 7
+user.read_attribute :_name_length         # the raw cached field is unchanged
   #=> 4
 ```

data/Rakefile

@@ -11,4 +11,9 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -Ilib -rmongoid_cacheable"
+end
+
 task :default => [:spec]

data/lib/mongoid_cacheable.rb

@@ -9,23 +9,32 @@ module Mongoid
     module ClassMethods
       def cache( name, *options )
         field_name = "_#{name}"
-        uncached_name = "uncached_#{name}"
         cached_name = "cached_#{name}"
+        clear_cached_name = "clear_cached_#{name}"
 
         field field_name, *options
 
-        alias_method uncached_name, name
-        alias_method cached_name, field_name
-
-        define_method(name) do
-          unless attributes[field_name]
-            # cache quitely with atomic set
-            set field_name, send(uncached_name)
-          end
+        define_method(cached_name) do
+          cache_field(field_name, &method(name))
+        end
 
-          attributes[field_name]
+        define_method(clear_cached_name) do
+          clear_cache_field(field_name)
         end
       end
     end
+
+    def cache_field(field_name, &block)
+      unless read_attribute(field_name)
+        # cache quitely with atomic set
+        set field_name, yield
+      end
+
+      read_attribute(field_name)
+    end
+
+    def clear_cache_field(field_name)
+      unset field_name
+    end
   end
 end

data/lib/mongoid_cacheable/version.rb

@@ -1,3 +1,3 @@
 module MongoidCacheable
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/mongoid_cacheable_spec.rb

@@ -1,47 +1,60 @@
 require 'spec_helper'
 
-describe Mongoid::Cacheable do
+class Book
+  include Mongoid::Document
+  include Mongoid::Cacheable
 
-  let(:book) do
-    Book.new(title: 'Life')
+  def say
+    true
   end
+end
 
-  let(:fields) do
-    Book.fields
-  end
+describe Mongoid::Cacheable do
 
-  it "does not persist prematurely" do
-    book.title_length
-    book.new_record?.should be_true
+  let(:book) { Book.new }
+
+  before :each do
+    book.cache_field(:_abc) { true }
   end
 
-  it "adds a cached field to the document" do
-    fields['_title_length'].should_not be_nil
+  it "caches a method's result" do
+    book.read_attribute(:_abc).should_not be_nil
   end
 
-  context "when uncached" do
+  it "clears a cache result" do
+    book.clear_cache_field(:_abc)
+    book.read_attribute(:_abc).should be_nil
+  end
 
-    it "caches method result" do
-      book.title_length
-      book.cached_title_length.should eq 4
-    end
+  it "caches wihtout saving the parent" do
+    book.new_record?.should be_true
+  end
 
+  it "cache is persistant" do
+    book.save
+    book.reload.cache_field(:_abc).should_not be_nil
   end
 
-  context "when previously cached" do
+  context "when a method is cached" do
 
-    before do
-      book._title_length = 17
+    before :each do
+      book.class.cache :say
+      book.cache_field(:_say) { 'message' }
     end
-
-    it 'returns directly from cache' do
-      book.title_length.should eq 17
+  
+    it "creates a cached method alias" do
+      book.cached_say.should eq 'message'
     end
 
-    it 'returns the uncached result' do
-      book.uncached_title_length.should eq 4
+    it "original method remains uncached" do
+      book.say.should eq true
     end
-
+  
+    it "creates a clear cached method alias" do
+      book.clear_cached_say
+      book.cached_say.should eq true
+    end
+    
   end
 
 end

data/spec/spec_helper.rb

@@ -10,8 +10,6 @@ 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!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_cacheable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-16 00:00:00.000000000 Z
+date: 2012-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -83,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - .travis.yml
 - Gemfile
 - LICENSE
@@ -91,7 +92,6 @@ files:
 - 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
@@ -119,6 +119,5 @@ 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

data/spec/models/book.rb

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