ca_ching 0.1.0 → 0.1.1

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@ca_ching"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.5 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -3,14 +3,14 @@ source "http://rubygems.org"
 gemspec
 
 # Development gems
-gem 'ruby-debug19'
+gem 'debugger'
 gem 'rake'
 
-gem 'sqlite3'
+gem 'sqlite3', '1.3.5'
 
 # Testing
 gem 'rspec'
 gem 'machinist'
 gem 'faker'
 gem 'guard-rspec'
-gem 'growl_notify'
+gem 'growl'

data/README.md

@@ -6,7 +6,10 @@ That means that when you read from the database, your results are stored in the
 the database, whatever is written to the database is also written to the cache (write-through). If the results are already
 in the cache, great, they're read straight from there on a read, and updated on a write. 
 
-Take a look at `SPEC.md` for what's planned for v1.
+This is definitely still alpha-level software. It's just something I thought should exist; I'm not using it in production
+anywhere. It could blow up in totally unexpected, but nevertheless exciting, ways. If it does fall over, [let me know](http://github.com/ahlatimer/ca_ching/issues).
+
+Take a look at `SPEC.md` for what's planned for v1. 
 
 ## Getting started
 
@@ -50,9 +53,9 @@ miss and pull the data into the cache.
 
 ## Queries supported
 
-Generally anything `eqality` is supported by CaChing. Currently, only single fields can be found (e.g., `Person.where(:name => 'Andrew')` will be cached,
+Generally anything involving equality is supported by CaChing. Currently, only single fields can be found (e.g., `Person.where(:name => 'Andrew')` will be cached,
 `Person.where(:name => 'Andrew', :age => 22)` is not). There is some plumbing for adding support for the latter, and support will be
-introduced as soon as possible. 
+introduced as soon as possible. I also have plans to add limited support for comparators (i.e., <, <=, >, >=).
 
 Anything including joins, includes, `OR`, and inequality (!=) are not supported, nor do I have any plans for adding support. 
 
@@ -75,7 +78,7 @@ These queries are not:
 
 ### Order
 
-Order is not currently supported, although there will be some order semantics in the next version. 
+Order is not currently supported, although there will be some order functionality in the next version. 
 
 ### Composite keys and queries against multiple fields
 
@@ -89,6 +92,12 @@ composite key *is* specified, CaChing will keep the resulting set.
 While there is support for this in the Redis adapter, there isn't any support in the ActiveRecord ties as I haven't
 decided how, exactly, I'd like to add this. 
 
+### Thar be dragons
+
+While I've tried to outline the issues here (and write failing specs for them), realize that this is
+still very much alpha software. There are probably a number of unknown unknowns that I just haven't
+uncovered yet. If you find them, please be sure to [let me know](http://github.com/ahlatimer/ca_ching/issues)!
+
 ## Ruby/Rails versions supported
 
 Ruby 1.9.2 and Rails 3.1+ are officially supported. I try to stick to Ruby 1.8.7 syntax, so it may be supported, 

data/ca_ching.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
   
   s.add_dependency 'hiredis'
   s.add_dependency 'redis', '2.2.2'
-  s.add_dependency 'activesupport', '>= 3.1.0'
-  s.add_dependency 'activerecord', '>= 3.1.0'
+  s.add_dependency 'activesupport', '>= 3.2.0'
+  s.add_dependency 'activerecord', '>= 3.2.0'
 end

data/lib/ca_ching/index.rb

@@ -19,10 +19,8 @@ module CaChing
       end
     end
     
-    module InstanceMethods
-      def indexed_fields
-        self.class.indexed_fields
-      end
+    def indexed_fields
+      self.class.indexed_fields
     end
   end
-end
+end

data/lib/ca_ching/read_through.rb

@@ -9,50 +9,49 @@ module CaChing
     module ClassMethods
     end
     
-    module InstanceMethods
-      # All queries, be they find(id), dynamic finders (find_by_foo, find_all_by_foo, etc.),
-      # where(:foo => :bar), order('foo DESC'), etc. go through to_a before being returned.
-      # Hook into that point to check the cache. 
-      def to_a_with_cache
-        @_query = CaChing::Query::Select.new(self)
-        
-        return to_a_without_cache if CaChing.cache.nil? || CaChing.disabled? || !cacheable?
-        
-        result = CaChing.cache.find(@_query)
-        @from_cache = true
-        
-        if result.nil?
-          result = to_a_without_cache
-          CaChing.cache.insert(result, :for => @_query)
-          @from_cache = false
-        end
-        
-        result.from_cache = self.from_cache?
-        result.each { |item| item.from_cache = self.from_cache? }
-        
-        return result
-      end 
+    # All queries, be they find(id), dynamic finders (find_by_foo, find_all_by_foo, etc.),
+    # where(:foo => :bar), order('foo DESC'), etc. go through to_a before being returned.
+    # Hook into that point to check the cache. 
+    def to_a_with_cache
+      @_query = CaChing::Query::Select.new(self)
       
-      def from_cache?
-        @from_cache ||= false
-      end
+      return to_a_without_cache if CaChing.cache.nil? || CaChing.disabled? || !cacheable?
       
-      def cacheable?
-        unsupported_methods = [:from_value,
-                               :group_values,
-                               :having_values,
-                               :includes_values,
-                               :joined_includes_values,
-                               :joins_values,
-                               :lock_value,
-                               :select_values]
-        !where_values.empty? && find_on_indexed_fields? && unsupported_methods.inject(true) { |flag, method| self.send(method).send(method.to_s =~ /values/ ? :empty? : :nil?) && flag }
-      end
+      result = CaChing.cache.find(@_query)
+      @from_cache = true
       
-      private
-      def find_on_indexed_fields?
-        (@_query.where.keys - indexed_fields.keys).empty?
+      if result.nil?
+        result = to_a_without_cache
+        CaChing.cache.insert(result, :for => @_query)
+        @from_cache = false
       end
+      
+      result.from_cache = self.from_cache?
+      result.each { |item| item.from_cache = self.from_cache? }
+      
+      return result
+    end 
+    
+    def from_cache?
+      @from_cache ||= false
+    end
+    
+    def cacheable?
+      unsupported_methods = [:from_value,
+                             :group_values,
+                             :having_values,
+                             :includes_values,
+                             :joined_includes_values,
+                             :joins_values,
+                             :lock_value,
+                             :select_values,
+                             :order_values]
+      !where_values.empty? && find_on_indexed_fields? && unsupported_methods.inject(true) { |flag, method| self.send(method).send(method.to_s =~ /values/ ? :empty? : :nil?) && flag }
+    end
+    
+    private
+    def find_on_indexed_fields?
+      (@_query.where.keys - indexed_fields.keys).empty?
     end
     
     included do |base|
@@ -61,4 +60,4 @@ module CaChing
       end
     end
   end
-end
+end

data/lib/ca_ching/version.rb

@@ -2,7 +2,7 @@ module CaChing
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
     PRE   = nil
 
 

data/lib/ca_ching/write_through.rb

@@ -5,19 +5,33 @@ module CaChing
     module ClassMethods
     end
     
-    module InstanceMethods
-      def save_with_cache(*)
-        return save_without_cache if CaChing.cache.nil? || CaChing.disabled?
-        
-        CaChing.cache.update(self)
-        save_without_cache
-      end
+    def save_with_cache(*)
+      return save_without_cache if CaChing.cache.nil? || CaChing.disabled?
+      
+      CaChing.cache.update(self)
+      save_without_cache
+    end
+    
+    def save_with_cache!
+      return save_without_cache! if CaChing.cache.nil? || CaChing.disabled?
+      
+      CaChing.cache.update(self)
+      save_without_cache!
     end
     
+    def destroy_with_cache(*)
+      return destroy_without_cache if CaChing.cache.nil? || CaChing.disabled?
+      
+      CaChing.cache.destroy(self)
+      destroy_without_cache
+    end
+  
     included do |base|
       base.class_eval do
         alias_method_chain :save, :cache
+        alias_method_chain :save!, :cache
+        alias_method_chain :destroy, :cache
       end
     end
   end
-end
+end

data/spec/ca_ching/query/abstract_spec.rb

@@ -99,7 +99,7 @@ module CaChing
             it 'handles multiple clauses' do
               ar = Person.where(:name => 'Andrew', :age => 22)
               query = Abstract.new(ar)
-              query.where.should == { :name => ['=', 'Andrew'], :age => ['=', 22] }
+              query.where.should == { :name => ['=', 'Andrew'], :age => ['=', '22'] }
             end
           end
         end
@@ -192,4 +192,4 @@ module CaChing
       end
     end
   end
-end
+end

data/spec/ca_ching/write_through_spec.rb

@@ -11,15 +11,41 @@ module CaChing
       @cache.clear!
     end
     
-    it 'updates the cache for a cached object' do
+    it 'updates the cache for a cached object with AR#save' do
       ar = Person.where(:id => 1)
       query = CaChing::Query::Abstract.new(ar)
       @cache.insert(ar.to_a_without_cache, :for => query)
       
-      @person.name = @person.name.reverse
+      name = @person.name.reverse
+      
+      @person.name = name
       @person.save
       
-      @cache.find(CaChing::Query::Abstract.new(ar)).first.name.should == @person.name
+      @cache.find(CaChing::Query::Abstract.new(ar)).first.name.should == name
+    end
+
+    it 'updates the cache for a cached object with AR#save!' do
+      ar = Person.where(:id => 1)
+      query = CaChing::Query::Abstract.new(ar)
+      @cache.insert(ar.to_a_without_cache, :for => query)
+      
+      name = @person.name.reverse
+      
+      @person.name = name
+      @person.save!
+      
+      @cache.find(CaChing::Query::Abstract.new(ar)).first.name.should == name
+    end
+    
+    it 'updates the cache for a cached object with AR#update_attributes' do
+      ar = Person.where(:id => 1)
+      query = CaChing::Query::Abstract.new(ar)
+      @cache.insert(ar.to_a_without_cache, :for => query)
+
+      name = @person.name.reverse
+      @person.update_attributes(:name => name)
+      
+      @cache.find(CaChing::Query::Abstract.new(ar)).first.name.should == name
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ca_ching
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis
-  requirement: &2155697920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,40 +21,60 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2155697920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2155697420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2155697420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2155696920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155696920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2155696440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155696440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: Write-through ActiveRecord model caching that's right on the money
 email:
 - andrew@elpasoera.com
@@ -63,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -70,6 +91,7 @@ files:
 - Rakefile
 - SPEC.md
 - ca_ching.gemspec
+- dump.rdb
 - lib/ca_ching.rb
 - lib/ca_ching/adapters/active_record.rb
 - lib/ca_ching/adapters/redis.rb
@@ -114,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -832901543252096864
+      hash: 3771213621582903175
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,10 +145,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -832901543252096864
+      hash: 3771213621582903175
 requirements: []
 rubyforge_project: ca_ching
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Write-through ActiveRecord model caching that's right on the money