jashmenn-dalli 1.0.3

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'simplecov'
+end

data/History.md

@@ -0,0 +1,169 @@
+Dalli Changelog
+=====================
+
+1.0.3
+=======
+
+- Better handling of application marshalling errors
+- Work around jruby IO#sysread compatibility issue
+
+
+1.0.2
+=======
+
+ - Allow browser session cookies (blindsey)
+ - Compatibility fixes (mwynholds)
+ - Add backwards compatibility module for memcache-client, require 'dalli/memcache-client'.  It makes
+   Dalli more compatible with memcache-client and prints out a warning any time you do something that 
+   is no longer supported so you can fix your code.
+
+1.0.1
+=======
+
+ - Explicitly handle application marshalling bugs, GH-56
+ - Add support for username/password as options, to allow multiple bucket access
+   from the same Ruby process, GH-52
+ - Add support for >1MB values with :value_max_bytes option, GH-54 (r-stu31)
+ - Add support for default TTL, :expires_in, in Rails 2.3. (Steven Novotny)
+   config.cache_store = :dalli_store, 'localhost:11211', {:expires_in => 4.hours}
+
+
+1.0.0
+=======
+
+Welcome gucki as a Dalli committer!
+
+ - Fix network and namespace issues in get_multi (gucki)
+ - Better handling of unmarshalling errors (mperham)
+
+0.11.2
+=======
+
+ - Major reworking of socket error and failover handling (gucki)
+ - Add basic JRuby support (mperham)
+
+0.11.1
+======
+
+ - Minor fixes, doc updates.
+ - Add optional support for kgio sockets, gives a 10-15% performance boost.
+
+0.11.0
+======
+
+Warning: this release changes how Dalli marshals data.  I do not guarantee compatibility until 1.0 but I will increment the minor version every time a release breaks compatibility until 1.0.
+
+IT IS HIGHLY RECOMMENDED YOU FLUSH YOUR CACHE BEFORE UPGRADING.
+
+ - multi() now works reentrantly.
+ - Added new Dalli::Client option for default TTLs, :expires_in, defaults to 0 (aka forever).
+ - Added new Dalli::Client option, :compression, to enable auto-compression of values.
+ - Refactor how Dalli stores data on the server.  Values are now tagged
+   as "marshalled" or "compressed" so they can be automatically deserialized
+   without the client having to know how they were stored.
+
+0.10.1
+======
+
+ - Prefer server config from environment, fixes Heroku session store issues (thanks JoshMcKin)
+ - Better handling of non-ASCII values (size -> bytesize)
+ - Assert that keys are ASCII only
+
+0.10.0
+======
+
+Warning: this release changed how Rails marshals data with Dalli.  Unfortunately previous versions double marshalled values.  It is possible that data stored with previous versions of Dalli will not work with this version.
+
+IT IS HIGHLY RECOMMENDED YOU FLUSH YOUR CACHE BEFORE UPGRADING.
+
+ - Rework how the Rails cache store does value marshalling.
+ - Rework old server version detection to avoid a socket read hang.
+ - Refactor the Rails 2.3 :dalli\_store to be closer to :mem\_cache\_store.
+ - Better documentation for session store config (plukevdh)
+
+0.9.10
+----
+
+ - Better server retry logic (next2you)
+ - Rails 3.1 compatibility (gucki)
+
+
+0.9.9
+----
+
+ - Add support for *_multi operations for add, set, replace and delete.  This implements
+   pipelined network operations; Dalli disables network replies so we're not limited by
+   latency, allowing for much higher throughput.
+
+    dc = Dalli::Client.new
+    dc.multi do
+      dc.set 'a', 1
+      dc.set 'b', 2
+      dc.set 'c', 3
+      dc.delete 'd'
+    end
+ - Minor fix to set the continuum sorted by value (kangster)
+ - Implement session store with Rails 2.3.  Update docs.
+
+0.9.8
+-----
+
+ - Implement namespace support
+ - Misc fixes
+
+
+0.9.7
+-----
+
+ - Small fix for NewRelic integration.
+ - Detect and fail on older memcached servers (pre-1.4).
+
+0.9.6
+-----
+
+ - Patches for Rails 3.0.1 integration.
+
+0.9.5
+-----
+
+ - Major design change - raw support is back to maximize compatibility with Rails
+ and the increment/decrement operations.  You can now pass :raw => true to most methods
+ to bypass (un)marshalling.
+ - Support symbols as keys (ddollar)
+ - Rails 2.3 bug fixes
+
+
+0.9.4
+-----
+
+ - Dalli support now in rack-bug (http://github.com/brynary/rack-bug), give it a try!
+ - Namespace support for Rails 2.3 (bpardee)
+ - Bug fixes
+
+
+0.9.3
+-----
+
+ - Rails 2.3 support (beanieboi)
+ - Rails SessionStore support
+ - Passenger integration
+ - memcache-client upgrade docs, see Upgrade.md
+
+
+0.9.2
+----
+
+ - Verify proper operation in Heroku.
+
+
+0.9.1
+----
+
+ - Add fetch and cas operations (mperham)
+ - Add incr and decr operations (mperham)
+ - Initial support for SASL authentication via the MEMCACHE_{USERNAME,PASSWORD} environment variables, needed for Heroku (mperham)
+
+0.9.0
+-----
+
+ - Initial gem release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mike Perham
+
+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/Performance.md

@@ -0,0 +1,77 @@
+Performance
+====================
+
+Caching is all about performance, so I carefully track Dalli performance to ensure no regressions.
+Times are from a Unibody MBP 2.4Ghz Core i5 running Snow Leopard.
+
+You can optionally use kgio to give Dalli a small, 10-20% performance boost: gem install kgio.
+
+*memcache-client*:
+
+	Testing 1.8.5 with ruby 1.9.2p136 (2010-12-25 revision 30365) [x86_64-darwin10.6.0]
+	                                     user     system      total        real
+	set:plain:memcache               2.070000   0.340000   2.410000 (  2.611709)
+	set:ruby:memcache                1.990000   0.330000   2.320000 (  2.869653)
+	get:plain:memcache               2.290000   0.360000   2.650000 (  2.926425)
+	get:ruby:memcache                2.360000   0.350000   2.710000 (  2.951604)
+	multiget:ruby:memcache           1.050000   0.120000   1.170000 (  1.285787)
+	missing:ruby:memcache            1.990000   0.330000   2.320000 (  2.567641)
+	mixed:ruby:memcache              4.390000   0.670000   5.060000 (  5.721000)
+	incr:ruby:memcache               0.700000   0.120000   0.820000 (  0.842896)
+
+*libmemcached*:
+
+	Testing 1.1.2 with ruby 1.9.2p136 (2010-12-25 revision 30365) [x86_64-darwin10.6.0]
+	                                     user     system      total        real
+	set:plain:libm                   0.120000   0.220000   0.340000 (  0.847521)
+	setq:plain:libm                  0.030000   0.000000   0.030000 (  0.126944)
+	set:ruby:libm                    0.220000   0.250000   0.470000 (  1.102789)
+	get:plain:libm                   0.140000   0.230000   0.370000 (  0.813998)
+	get:ruby:libm                    0.210000   0.240000   0.450000 (  1.025994)
+	multiget:ruby:libm               0.100000   0.080000   0.180000 (  0.322217)
+	missing:ruby:libm                0.250000   0.240000   0.490000 (  1.049972)
+	mixed:ruby:libm                  0.400000   0.410000   0.810000 (  2.172349)
+	mixedq:ruby:libm                 0.410000   0.360000   0.770000 (  1.516718)
+	incr:ruby:libm                   0.080000   0.340000   0.420000 (  1.685931)
+
+*dalli*:
+
+	Using kgio socket IO
+	Testing 1.0.2 with ruby 1.9.2p136 (2010-12-25 revision 30365) [x86_64-darwin10.6.0]
+	                                     user     system      total        real
+	set:plain:dalli                  0.850000   0.320000   1.170000 (  1.691393)
+	setq:plain:dalli                 0.500000   0.130000   0.630000 (  0.651227)
+	set:ruby:dalli                   0.900000   0.330000   1.230000 (  1.865228)
+	get:plain:dalli                  0.990000   0.390000   1.380000 (  1.929994)
+	get:ruby:dalli                   0.950000   0.370000   1.320000 (  1.844251)
+	multiget:ruby:dalli              0.790000   0.300000   1.090000 (  1.227073)
+	missing:ruby:dalli               0.810000   0.370000   1.180000 (  1.627039)
+	mixed:ruby:dalli                 1.850000   0.710000   2.560000 (  3.555032)
+	mixedq:ruby:dalli                1.840000   0.610000   2.450000 (  2.945982)
+	incr:ruby:dalli                  0.310000   0.120000   0.430000 (  0.616465)
+
+Testing 1.0.2 with rubinius 1.3.0dev (1.8.7 382e813f xxxx-xx-xx JI) [x86_64-apple-darwin10.6.0]
+	                                     user     system      total        real
+	set:plain:dalli                  2.800581   0.329360   3.129941 (  5.186546)
+	setq:plain:dalli                 1.064253   0.138044   1.202297 (  1.280355)
+	set:ruby:dalli                   2.220885   0.262619   2.483504 (  2.778118)
+	get:plain:dalli                  2.291344   0.280490   2.571834 (  2.948004)
+	get:ruby:dalli                   2.148900   0.274477   2.423377 (  2.425808)
+	multiget:ruby:dalli              1.724193   0.249145   1.973338 (  2.158673)
+	missing:ruby:dalli               1.881502   0.272610   2.154112 (  2.208384)
+	mixed:ruby:dalli                 4.292620   0.533768   4.826388 (  4.830238)
+	mixedq:ruby:dalli                4.076032   0.501442   4.577474 (  4.583800)
+	incr:ruby:dalli                  0.691467   0.091475   0.782942 (  0.931674)
+
+Testing 1.0.2 with rubinius 1.2.0 (1.8.7 release 2010-12-21 JI) [x86_64-apple-darwin10.6.0]
+	                                     user     system      total        real
+	set:plain:dalli                  6.586927   0.331545   6.918472 (  4.628652)
+	setq:plain:dalli                 0.930905   0.129008   1.059913 (  1.016105)
+	set:ruby:dalli                   2.702486   0.283004   2.985490 (  2.690442)
+	get:plain:dalli                  2.740202   0.291353   3.031555 (  2.722746)
+	get:ruby:dalli                   1.979379   0.282986   2.262365 (  2.264118)
+	multiget:ruby:dalli              1.887086   0.249799   2.136885 (  1.803230)
+	missing:ruby:dalli               1.882662   0.278019   2.160681 (  2.113429)
+	mixed:ruby:dalli                 3.969242   0.553361   4.522603 (  4.524504)
+	mixedq:ruby:dalli                3.520755   0.475669   3.996424 (  3.997405)
+	incr:ruby:dalli                  0.849998   0.094012   0.944010 (  0.884001)

data/README.md

@@ -0,0 +1,177 @@
+Dalli
+=========
+
+Dalli is a high performance pure Ruby client for accessing memcached servers.  It works with memcached 1.4+ only as it uses the newer binary protocol.  It should be considered a replacement for the memcache-client gem.  The API tries to be mostly compatible with memcache-client with the goal being to make it a drop-in replacement for Rails.
+
+The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
+
+![Persistence of Memory](http://www.virtualdali.com/assets/paintings/31PersistenceOfMemory.jpg)
+
+Dalli's development is sponsored by [Membase](http://www.membase.com/).  Many thanks to them!
+
+
+Design
+------------
+
+I decided to write Dalli after maintaining memcache-client for the last two years for a few specific reasons:
+
+ 0. The code is mostly old and gross.  The bulk of the code is a single 1000 line .rb file.
+ 1. It has a lot of options that are infrequently used which complicate the codebase.
+ 2. The implementation has no single point to attach monitoring hooks.
+ 3. Uses the old text protocol, which hurts raw performance.
+
+So a few notes.  Dalli:
+
+ 0. uses the exact same algorithm to choose a server so existing memcached clusters with TBs of data will work identically to memcache-client.
+ 1. is approximately 20% faster than memcache-client (which itself was heavily optimized) in Ruby 1.9.2.
+ 2. contains explicit "chokepoint" methods which handle all requests; these can be hooked into by monitoring tools (NewRelic, Rack::Bug, etc) to track memcached usage.
+ 3. comes with hooks to replace memcache-client in Rails.
+ 4. is approx 700 lines of Ruby.  memcache-client is approx 1250 lines.
+ 5. supports SASL for use in managed environments, e.g. Heroku.
+ 6. provides proper failover with recovery and adjustable timeouts
+ 7. has a backwards-compatibility mode for people migrating from memcache-client (see Upgrade.md).
+
+
+Installation and Usage
+------------------------
+
+Remember, Dalli **requires** memcached 1.4+.  You can check the version with `memcached -h`.
+
+    gem install dalli
+
+    require 'dalli'
+    dc = Dalli::Client.new('localhost:11211')
+    dc.set('abc', 123)
+    value = dc.get('abc')
+
+The test suite requires memcached 1.4.3+ with SASL enabled (brew install memcached --enable-sasl ; mv /usr/bin/memcache /usr/bin/memcached.old).  Currently only supports the PLAIN mechanism.
+
+Dalli has no runtime dependencies and never will.  You can optionally install the 'kgio' gem to
+give Dalli a 10-20% performance boost.
+
+
+Usage with Rails 3.0
+---------------------------
+
+In your Gemfile:
+
+    gem 'dalli'
+
+In `config/environments/production.rb`:
+
+    config.cache_store = :dalli_store
+
+A more comprehensive example (note that we are setting a reasonable default for maximum cache entry lifetime (one day), enabling compression for large values, and namespacing all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values):
+
+    config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
+        { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true, :compress_threshold => 64*1024 }
+
+To use Dalli for Rails session storage, in `config/initializers/session_store.rb`:
+
+    require 'action_dispatch/middleware/session/dalli_store'
+    Rails.application.config.session_store :dalli_store, :memcache_server => ['host1', 'host2'], :namespace => 'sessions', :key => '_foundation_session', :expire_after => 30.minutes
+
+
+Usage with Rails 2.3.x
+----------------------------
+
+In `config/environment.rb`:
+
+    config.gem 'dalli'
+
+In `config/environments/production.rb`:
+
+    # Object cache
+    require 'active_support/cache/dalli_store23'
+    config.cache_store = :dalli_store
+
+In `config/initializers/session_store.rb`:
+
+    # Session cache
+    ActionController::Base.session = {
+      :namespace   => 'sessions',
+      :expire_after => 20.minutes.to_i,
+      :memcache_server => ['server-1:11211', 'server-2:11211'],
+      :key         => ...,
+      :secret      => ...
+    }
+    
+    require 'action_controller/session/dalli_store'
+    ActionController::Base.session_store = :dalli_store
+
+
+Usage with Passenger
+------------------------
+
+Put this at the bottom of `config/environment.rb`:
+
+    if defined?(PhusionPassenger)
+      PhusionPassenger.on_event(:starting_worker_process) do |forked|
+        # Only works with DalliStore
+        Rails.cache.reset if forked
+      end
+    end
+
+
+Configuration
+------------------------
+Dalli::Client accepts the following options. All times are in seconds.
+
+**expires_in**: Global default for key TTL.  No default.
+
+**failover**: Boolean, if true Dalli will failover to another server if the main server for a key is down.
+
+**compression**: Boolean, if true Dalli will gzip-compress values larger than 1K.
+
+**socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 0.5.
+
+**socket_max_failures**: When a socket operation fails after socket_timeout, the same operation is retried. This is to not immediately mark a server down when there's a very slight network problem. Default is 2.
+
+**socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.01.  Set to nil for no delay.
+
+**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value to low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 1 second.
+
+**value_max_bytes**: The maximum size of a value in memcached.  Defaults to 1MB, this can be increased with memcached's -I parameter.  You must also configure Dalli to allow the larger size here.
+
+**username**: The username to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
+
+**password**: The password to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
+
+Features and Changes
+------------------------
+
+Dalli is **NOT** 100% API compatible with memcache-client.  If you have code which uses the MemCache API directly, it will likely need small tweaks.  Method parameters and return values changed slightly.  See Upgrade.md for more detail.
+
+By default, Dalli is thread-safe.  Disable thread-safety at your own peril.
+
+Note that Dalli does not require ActiveSupport or Rails.  You can safely use it in your own Ruby projects.
+
+
+Helping Out
+-------------
+
+If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update History.md with a one sentence description of your fix so you get credit as a contributor.
+
+
+Thanks
+------------
+
+Eric Wong - for help using his [kgio](http://unicorn.bogomips.org/kgio/index.html) library.
+
+Brian Mitchell - for his remix-stash project which was helpful when implementing and testing the binary protocol support.
+
+[Membase](http://membase.com) - for their project sponsorship
+
+[Bootspring](http://bootspring.com) is my Ruby and Rails consulting company.  We specialize in Ruby infrastructure, performance and scalability tuning for Rails applications.  If you need help, please [contact us](mailto:info@bootspring.com) today.
+
+
+Author
+----------
+
+Mike Perham, mperham@gmail.com, [mikeperham.com](http://mikeperham.com), [@mperham](http://twitter.com/mperham)  If you like and use this project, please give me a recommendation at [WWR](http://workingwithrails.com/person/10797-mike-perham).  Happy caching!
+
+
+Copyright
+-----------
+
+Copyright (c) 2010 Mike Perham. See LICENSE for details.