lock_and_cache 0.1.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58a808fd3a27573b09b72e166416c7c83f18c87c
-  data.tar.gz: 935f944078a81f0801fe6efa9ab62f19e931ae75
+  metadata.gz: 9845e5a7f52feea98d5f059df539cd79258ba24d
+  data.tar.gz: 58865bd7f3a4a94516bc16e7eed6b4d26b53fba3
 SHA512:
-  metadata.gz: b055a2757a283e0ec4eaf5529cc9eb86a5dbfad18e1ec335a0fbb475066b502d555cad457b5a596c41cb1179727b97675fb5a8fa1b5676d8632c728c7de06877
-  data.tar.gz: ed3e65b4378637c92749d2dbf4bfa835026d52425e923aab2db898d1cb86c69487e3233334e254a6cc02125b0930e3a6dffdf8610133bccb1b3203c59104465f
+  metadata.gz: 57db24888a5da3addfc922b470a5cd7e1da892f5c227326413669165277d3f6aa017ab1812ca3514439fa4965c81c6627b7ecd324edb752ff0cd6b0949e78b46
+  data.tar.gz: 8cafb78639eb731bf7c439bfb101d65a8ec5633a2cecf68af33445e1a1224428302d1d64b2f304c13f74accc4c42e48c88e1f29975f38fb429597cfe3a3c9bbc

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
   - 2.1.2
+services:
+  - redis-server

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--readme README.md

data/CHANGELOG

@@ -1,3 +1,20 @@
+1.0.1 / 2015-08-06
+
+* Bug fixes
+
+  * Return value properly if lock was acquired but cached value immediately found
+
+* Enhancements
+
+  * Documentation
+
+1.0.0 / 2015-08-05
+
+* Enhancements
+
+  * Use Redis redlock http://redis.io/topics/distlock instead of Postgres advisory locks
+  * No more dependency on ActiveRecord or Postgres!
+
 0.1.2 / 2015-06-24
 
 * Enhancements

data/README.md

@@ -1,31 +1,73 @@
 # LockAndCache
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/seamusabshere/lock_and_cache.svg?branch=master)](https://travis-ci.org/seamusabshere/lock_and_cache)
+[![Code Climate](https://codeclimate.com/github/seamusabshere/lock_and_cache/badges/gpa.svg)](https://codeclimate.com/github/seamusabshere/lock_and_cache)
+[![Dependency Status](https://gemnasium.com/seamusabshere/lock_and_cache.svg)](https://gemnasium.com/seamusabshere/lock_and_cache)
+[![Gem Version](https://badge.fury.io/rb/redlock.svg)](http://badge.fury.io/rb/redlock)
+[![security](https://hakiri.io/github/seamusabshere/lock_and_cache/master.svg)](https://hakiri.io/github/seamusabshere/lock_and_cache/master)
+[![Inline docs](http://inch-ci.org/github/seamusabshere/lock_and_cache.svg?branch=master)](http://inch-ci.org/github/seamusabshere/lock_and_cache)
 
-## Wishlist
+Lock and cache using redis!
 
-* no dep on activerecord
-* no dep on redis
+## Redlock locking
 
-## Installation
+Based on [antirez's Redlock algorithm](http://redis.io/topics/distlock).
 
-Add this line to your application's Gemfile:
+```ruby
+LockAndCache.storage = Redis.new
+```
+
+It will use this redis for both locking and storing cached values.
+
+## Convenient caching
+
+(be sure to set up storage as above)
+
+You put a block inside of a method:
+
+```ruby
+class Blog
+  def click(arg1, arg2)
+    lock_and_cache(arg1, arg2, expires: 5) do
+      # do the work
+    end
+  end
+end
+```
+
+The key will be `{ Blog, :click, $id, $arg1, $arg2 }`. In other words, it auto-detects the class, method, object id ... and you add other args if you want.
+
+You can change the object id easily:
 
 ```ruby
-gem 'lock_and_cache'
+class Blog
+  # [...]
+  # if you don't define this, it will try to call #id
+  def lock_and_cache_key
+    [author, title]
+  end
+end
 ```
 
-And then execute:
+## Tunables
 
-    $ bundle
+* `LockAndCache.storage=[redis]`
+* `LockAndCache.lock_expires=[seconds]` default is 3 days
+* `LockAndCache.lock_spin=[seconds]` (how long to wait before retrying lock) default is 0.1 seconds
+* `ENV['LOCK_AND_CACHE_DEBUG']='true'` if you want some debugging output on `$stderr`
 
-Or install it yourself as:
+## Few dependencies
 
-    $ gem install lock_and_cache
+* [activesupport](https://rubygems.org/gems/activesupport) (come on, it's the bomb)
+* [redis](https://github.com/redis/redis-rb)
+* [redlock](https://github.com/leandromoreira/redlock-rb)
+* [hash_digest](https://github.com/seamusabshere/hash_digest) (which requires [murmurhash3](https://github.com/funny-falcon/murmurhash3-ruby))
 
-## Usage
+## Real-world usage
 
-TODO: Write usage instructions here
+<p><a href="http://faraday.io"><img src="https://s3.amazonaws.com/photos.angel.co/startups/i/175701-a63ebd1b56a401e905963c64958204d4-medium_jpg.jpg" alt="Faraday logo"/></a></p>
+
+We use [`lock_and_cache`](https://rubygems.org/gems/lock_and_cache) for [big data-driven marketing at Faraday](http://angel.co/faraday).
 
 ## Contributing
 
@@ -34,3 +76,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+# Copyright 
+
+Copyright 2015 Seamus Abshere

data/Rakefile

@@ -5,3 +5,5 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/lock_and_cache/version.rb

@@ -1,3 +1,3 @@
 module LockAndCache
-  VERSION = '0.1.2'
+  VERSION = '1.0.1'
 end

data/lib/lock_and_cache.rb

@@ -1,23 +1,57 @@
 require 'lock_and_cache/version'
-
+require 'redis'
+require 'redlock'
 require 'hash_digest'
-require 'active_record'
-require 'with_advisory_lock'
+require 'active_support'
+require 'active_support/core_ext'
 
 module LockAndCache
-  def LockAndCache.storage=(v)
-    raise "only redis for now" unless v.class.to_s == 'Redis'
-    @storage = v
+  DEFAULT_LOCK_EXPIRES = 60 * 60 * 24 * 3 * 1000 # 3 days in milliseconds
+  DEFAULT_LOCK_SPIN = 0.1
+
+  # @param redis_connection [Redis] A redis connection to be used for lock and cached value storage
+  def LockAndCache.storage=(redis_connection)
+    raise "only redis for now" unless redis_connection.class.to_s == 'Redis'
+    @storage = redis_connection
+    @lock_manager = Redlock::Client.new [redis_connection]
   end
 
+  # @return [Redis] The redis connection used for lock and cached value storage
   def LockAndCache.storage
     @storage
   end
 
-  def LockAndCache.flush
-    storage.flushdb
+  # @param seconds [Numeric] Lock expiry in seconds.
+  #
+  # @note Can be overridden by putting `expires:` in your call to `#lock_and_cache`
+  def LockAndCache.lock_expires=(seconds)
+    @lock_expires = seconds.to_f * 1000
+  end
+
+  # @return [Numeric] Lock expiry in milliseconds.
+  # @private
+  def LockAndCache.lock_expires
+    @lock_expires || DEFAULT_LOCK_EXPIRES
+  end
+
+  # @param seconds [Numeric] How long to wait before trying a lock again, in seconds
+  #
+  # @note Can be overridden by putting `lock_spin:` in your call to `#lock_and_cache`
+  def LockAndCache.lock_spin=(seconds)
+    @lock_spin = seconds.to_f
   end
 
+  # @private
+  def LockAndCache.lock_spin
+    @lock_spin || DEFAULT_LOCK_SPIN
+  end
+
+  # @private
+  def LockAndCache.lock_manager
+    @lock_manager
+  end
+
+  # @private
   class Key
     attr_reader :obj
     attr_reader :method_id
@@ -53,6 +87,9 @@ module LockAndCache
 
   end
 
+  # Clear a cache given exactly the method and exactly the same arguments
+  #
+  # @note Does not unlock.
   def lock_and_cache_clear(method_id, *key_parts)
     debug = (ENV['LOCK_AND_CACHE_DEBUG'] == 'true')
     key = LockAndCache::Key.new self, method_id, key_parts
@@ -61,13 +98,20 @@ module LockAndCache
     LockAndCache.storage.del digest
   end
 
+  # Lock and cache a method given key parts.
+  #
+  # @param key_parts [*] Parts that you want to include in the lock and cache key
+  #
+  # @return The cached value (possibly newly calculated).
   def lock_and_cache(*key_parts)
     raise "need a block" unless block_given?
     debug = (ENV['LOCK_AND_CACHE_DEBUG'] == 'true')
     caller[0] =~ /in `(\w+)'/
     method_id = $1 or raise "couldn't get method_id from #{kaller[0]}"
-    options = key_parts.pop.stringify_keys if key_parts.last.is_a?(Hash)
-    expires = options['expires'] if options
+    options = key_parts.last.is_a?(Hash) ? key_parts.pop.stringify_keys : {}
+    expires = options['expires']
+    lock_expires = options.fetch 'lock_expires', LockAndCache.lock_expires
+    lock_spin = options.fetch 'lock_spin', LockAndCache.lock_spin
     key = LockAndCache::Key.new self, method_id, key_parts
     digest = key.digest
     storage = LockAndCache.storage
@@ -76,20 +120,29 @@ module LockAndCache
       return ::Marshal.load(storage.get(digest))
     end
     Thread.exclusive { $stderr.puts "[lock_and_cache] B #{key.debug}" } if debug
-    ActiveRecord::Base.with_advisory_lock(digest) do
+    retval = nil
+    lock_manager = LockAndCache.lock_manager
+    lock_digest = 'lock/' + digest
+    lock_info = nil
+    begin
+      until lock_info = lock_manager.lock(lock_digest, lock_expires)
+        sleep lock_spin
+      end
       Thread.exclusive { $stderr.puts "[lock_and_cache] C #{key.debug}" } if debug
       if storage.exists digest
-        ::Marshal.load storage.get(digest)
+        retval = ::Marshal.load storage.get(digest)
       else
         Thread.exclusive { $stderr.puts "[lock_and_cache] D #{key.debug}" } if debug
-        memo = yield
+        retval = yield
         if expires
-          storage.setex digest, expires, ::Marshal.dump(memo)
+          storage.setex digest, expires, ::Marshal.dump(retval)
         else
-          storage.set digest, ::Marshal.dump(memo)
+          storage.set digest, ::Marshal.dump(retval)
         end
-        memo
       end
+    ensure
+      lock_manager.unlock lock_info
     end
+    retval
   end
 end

data/lock_and_cache.gemspec

@@ -18,15 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'activerecord'
+  spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'hash_digest'
-  spec.add_runtime_dependency 'with_advisory_lock'
+  spec.add_runtime_dependency 'redis'
+  spec.add_runtime_dependency 'redlock'
 
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'activesupport'
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'thread'
+  spec.add_development_dependency 'yard'
 end

data/spec/lock_and_cache_spec.rb

@@ -10,13 +10,13 @@ class Foo
   end
 
   def click
-    lock_and_cache(self) do
+    lock_and_cache do
       @count += 1
     end
   end
 
   def click_exp
-    lock_and_cache(self, expires: 1, foo: :bar) do
+    lock_and_cache(expires: 1, foo: :bar) do
       @count_exp += 1
     end
   end
@@ -44,14 +44,12 @@ class Bar
     end
     sleep 1
     @count += 1
-    Thread.exclusive do
-      $clicking.delete @id
-    end
+    $clicking.delete @id
     @count
   end
 
   def click
-    lock_and_cache(self) do
+    lock_and_cache do
       unsafe_click
     end
   end
@@ -63,7 +61,7 @@ end
 
 describe LockAndCache do
   before do
-    LockAndCache.flush
+    LockAndCache.storage.flushdb
   end
 
   it 'has a version number' do
@@ -79,7 +77,7 @@ describe LockAndCache do
 
     it "can be cleared" do
       expect(foo.click).to eq(1)
-      foo.lock_and_cache_clear :click, foo
+      foo.lock_and_cache_clear :click
       expect(foo.click).to eq(2)
     end
 
@@ -93,7 +91,8 @@ describe LockAndCache do
 
   describe "locking" do
     let(:bar) { Bar.new(rand.to_s) }
-    it "it blows up normally" do
+
+    it "it blows up normally (simple thread)" do
       a = Thread.new do
         bar.unsafe_click
       end
@@ -106,7 +105,21 @@ describe LockAndCache do
       end.to raise_error(/somebody/)
     end
 
-    it "doesn't blow up if you lock it" do
+    it "it blows up (pre-existing thread pool, more reliable)" do
+      pool = Thread.pool 2
+      Thread::Pool.abort_on_exception = true
+      expect do
+        pool.process do
+          bar.unsafe_click
+        end
+        pool.process do
+          bar.unsafe_click
+        end
+        pool.shutdown
+      end.to raise_error(/somebody/)
+    end
+
+    it "doesn't blow up if you lock it (simple thread)" do
       a = Thread.new do
         bar.click
       end
@@ -117,6 +130,18 @@ describe LockAndCache do
       b.join
     end
 
+    it "doesn't blow up if you lock it (pre-existing thread pool, more reliable)" do
+      pool = Thread.pool 2
+      Thread::Pool.abort_on_exception = true
+      pool.process do
+        bar.click
+      end
+      pool.process do
+        bar.click
+      end
+      pool.shutdown
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'lock_and_cache'
 
-ActiveRecord::Base.establish_connection adapter: 'postgresql', database: 'lock_and_cache_test'
-
 require 'redis'
 LockAndCache.storage = Redis.new
 
+require 'thread/pool'
+
 require 'pry'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: lock_and_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: with_advisory_lock
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,44 +86,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: thread
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -161,6 +161,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt