ngmoco-cache-money 0.2.10 → 0.2.13

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2009, Twitter Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README

@@ -180,6 +180,22 @@ For queries on multiple attributes, combination indexes are necessary. For examp
       index [:name, :age]
     end
 
+#### Optional: Selectively cache specific models
+
+There may be times where you only want to cache some of your models instead of everything.
+
+In that case, you can omit the following from your `config/initializers/cache_money.rb`
+
+	class ActiveRecord::Base
+	  is_cached :repository => $cache
+	end
+		
+After that is removed, you can simple put this at the top of your models you wish to cache:
+
+	is_cached :repository => $cache
+
+Just make sure that you put that line before any of your index directives.
+
 ## Version ##
 
 WARNING: This is currently a RELEASE CANDIDATE. A version of this code is in production use at Twitter but the extraction and refactoring process may have introduced bugs and/or performance problems. There are no known major defects at this point, but still.

data/README.markdown

@@ -0,0 +1,210 @@
+## What is Cache Money ##
+
+Cache Money is a write-through and read-through caching library for ActiveRecord.
+
+Read-Through: Queries like `User.find(:all, :conditions => ...)` will first look in Memcached and then look in the database for the results of that query. If there is a cache miss, it will populate the cache.
+
+Write-Through: As objects are created, updated, and deleted, all of the caches are *automatically* kept up-to-date and coherent.
+
+## Howto ##
+### What kinds of queries are supported? ###
+
+Many styles of ActiveRecord usage are supported:
+
+ * `User.find`
+ * `User.find_by_id`
+ * `User.find(:conditions => {:id => ...})`
+ * `User.find(:conditions => ['id = ?', ...])`
+ * `User.find(:conditions => 'id = ...')`
+ * `User.find(:conditions => 'users.id = ...')`
+
+As you can see, the `find_by_`, `find_all_by`, hash, array, and string forms are all supported.
+
+Queries with joins/includes are unsupported at this time. In general, any query involving just equality (=) and conjunction (AND) is supported by `Cache Money`. Disjunction (OR) and inequality (!=, <=, etc.) are not typically materialized in a hash table style index and are unsupported at this time.
+
+Queries with limits and offsets are supported. In general, however, if you are running queries with limits and offsets you are dealing with large datasets. It's more performant to place a limit on the size of the `Cache Money` index like so:
+
+    DirectMessage.index :user_id, :limit => 1000
+    
+In this example, only queries whose limit and offset are less than 1000 will use the cache.
+
+### Multiple indices are supported ###
+
+    class User < ActiveRecord::Base
+      index :screen_name
+      index :email
+    end
+
+#### `with_scope` support ####
+
+`with_scope` and the like (`named_scope`, `has_many`, `belongs_to`, etc.) are fully supported. For example, `user.devices.find(1)` will first look in the cache if there is an index like this:
+
+    class Device < ActiveRecord::Base
+     index [:user_id, :id]
+    end
+
+### Ordered indices ###
+
+    class Message < ActiveRecord::Base
+      index :sender_id, :order => :desc
+    end
+
+The order declaration will ensure that the index is kept in the correctly sorted order. Only queries with order clauses compatible with the ordering in the index will use the cache:
+
+ * `Message.find(:all, :conditions => {:sender_id => ...}, :order => 'id DESC')`.
+
+Order clauses can be specified in many formats ("`messages`.id DESC", "`messages`.`id` DESC", and so forth), but ordering MUST be on the primary key column. 
+
+    class Message < ActiveRecord::Base
+      index :sender_id, :order => :asc
+    end
+    
+will support queries like:
+
+ * `Message.find(:all, :conditions => {:sender_id => ...}, :order => 'id ASC')`
+ * `Message.find(:all, :conditions => {:sender_id => ...})`
+ 
+Note that ascending order is implicit in index declarations (i.e., not specifying an order is the same as ascending). This is also true of queries (order is not nondeterministic as in MySQL).
+
+### Window indices ###
+
+    class Message < ActiveRecord::Base
+      index :sender_id, :limit => 500, :buffer => 100
+    end
+
+With a limit attribute, indices will only store limit + buffer in the cache. As new objects are created the index will be truncated, and as objects are destroyed, the cache will be refreshed if it has fewer than the limit of items. The buffer is how many "extra" items to keep around in case of deletes.
+
+It is particularly in conjunction with window indices that the `:order` attribute is useful.
+
+### Calculations ###
+
+`Message.count(:all, :conditions => {:sender_id => ...})` will use the cache rather than the database. This happens for "free" -- no additional declarations are necessary.
+
+### Version Numbers ###
+
+    class User < ActiveRecord::Base
+      version 7
+      index ...
+    end
+    
+You can increment the version number as you migrate your schema. Be careful how you deploy changes like this as during deployment independent mongrels may be using different versions of your code. Indices can be corrupted if you do not plan accordingly.
+
+### Transactions ###
+
+Because of the parallel requests writing to the same indices, race conditions are possible. We have created a pessimistic "transactional" memcache client to handle the locking issues.
+
+The memcache client library has been enhanced to simulate transactions.
+
+    $cache.transaction do
+      $cache.set(key1, value1)
+      $cache.set(key2, value2)
+    end
+
+The writes to the cache are buffered until the transaction is committed. Reads within the transaction read from the buffer. The writes are performed as if atomically, by acquiring locks, performing writes, and finally releasing locks. Special attention has been paid to ensure that deadlocks cannot occur and that the critical region (the duration of lock ownership) is as small as possible.
+
+Writes are not truly atomic as reads do not pay attention to locks. Therefore, it is possible to peak inside a partially committed transaction. This is a performance compromise, since acquiring a lock for a read was deemed too expensive. Again, the critical region is as small as possible, reducing the frequency of such "peeks".
+
+#### Rollbacks ####
+
+    $cache.transaction do
+      $cache.set(k, v)
+      raise
+    end
+
+Because transactions buffer writes, an exception in a transaction ensures that the writes are cleanly rolled-back (i.e., never committed to memcache). Database transactions are wrapped in memcache transactions, ensuring a database rollback also rolls back cache transactions.
+
+Nested transactions are fully supported, with partial rollback and (apparent) partial commitment (this is simulated with nested buffers).
+
+### Mocks ###
+
+For your unit tests, it is faster to use a Memcached mock than the real deal. Just place this in your initializer for your test environment:
+
+    $memcache = Cash::Mock.new
+    
+### Locks ###
+
+In most cases locks are unnecessary; the transactional Memcached client will take care locks for you automatically and guarantees that no deadlocks can occur. But for very complex distributed transactions, shared locks are necessary.
+
+    $lock.synchronize('lock_name') do
+      $memcache.set("key", "value")
+    end
+    
+### Local Cache ###
+
+Sometimes your code will request the same cache key twice in one request. You can avoid a round trip to the Memcached server by using a local, per-request cache. Add this to your initializer:
+
+  $local = Cash::Local.new($memcache)
+  $cache = Cash::Transactional.new($local, $lock)
+
+## Installation ##
+
+#### Step 0: Install MemCached
+
+#### Step 1: Get the GEM ####
+
+    % gem sources -a http://gems.github.com
+    % sudo gem install ngmoco-cache-money
+    
+#### Step 2: Configure MemCached.
+
+Place a YAML file in `config/memcached.yml` with contents like:
+
+    test:
+      ttl: 604800
+      namespace: ...
+      sessions: false
+      debug: false
+      servers: localhost:11211
+      cache_money: true
+
+    development: 
+       ....
+
+#### Step 3: `config/environment.rb` ####
+ config.gem "ngmoco-cache-money",
+   :lib => "cache_money",
+   :source => 'http://gems.github.com',
+   :version => '0.2.9'
+
+#### Step 4: Add indices to your ActiveRecord models ####
+
+Queries like `User.find(1)` will use the cache automatically. For more complex queries you must add indices on the attributes that you will query on. For example, a query like `User.find(:all, :conditions => {:name => 'bob'})` will require an index like:
+
+    class User < ActiveRecord::Base
+      index :name
+    end
+    
+For queries on multiple attributes, combination indexes are necessary. For example, `User.find(:all, :conditions => {:name => 'bob', :age => 26})`
+
+    class User < ActiveRecord::Base
+      index [:name, :age]
+    end
+
+#### Optional: Selectively cache specific models
+
+There may be times where you only want to cache some of your models instead of everything.
+
+In that case, you can omit the following from your `config/initializers/cache_money.rb`
+
+	class ActiveRecord::Base
+	  is_cached :repository => $cache
+	end
+		
+After that is removed, you can simple put this at the top of your models you wish to cache:
+
+	is_cached :repository => $cache
+
+Just make sure that you put that line before any of your index directives.
+
+## Version ##
+
+WARNING: This is currently a RELEASE CANDIDATE. A version of this code is in production use at Twitter but the extraction and refactoring process may have introduced bugs and/or performance problems. There are no known major defects at this point, but still.
+
+## Acknowledgments ##
+
+Thanks to
+
+ * Twitter for commissioning the development of this library and supporting the effort to open-source it.
+ * Sam Luckenbill for pairing with me on most of the hard stuff.
+ * Matthew and Chris for pairing a few days, offering useful feedback on the readability of the code, and the initial implementation of the Memcached mock.
+ * Evan Weaver for helping to reason-through software and testing strategies to deal with replication lag, and the initial implementation of the Memcached lock.

data/config/environment.rb

@@ -1,6 +1,16 @@
-require 'activerecord'
+require 'rubygems'
+gem 'activesupport', '~> 2.3.0'
+gem 'activerecord', '~> 2.3.0'
+gem 'actionpack', '~> 2.3.0'
+gem 'rspec', '>= 1.3.0'
+gem 'jeweler', '~> 1.4.0'
+
+require 'action_controller'
+require 'active_record'
+require 'active_record/session_store'
+require 'jeweler'
 
 ActiveRecord::Base.establish_connection(
   :adapter => 'sqlite3',
-  :dbfile => ':memory:'
+  :database => ':memory:'
 )