gem_of_thrones 0.2.1

data/.travis.yml

@@ -0,0 +1,5 @@
+script: "bundle exec rake"
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+gem 'rake'
+gem 'rspec', '~>2'
+gem 'activesupport', '>3'
+gem 'memcached'
+gem 'benhutton-libmemcached_store'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    gem_of_thrones (0.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    benhutton-libmemcached_store (0.3.2)
+      memcached
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    memcached (1.3.5)
+    multi_json (1.3.4)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (> 3)
+  benhutton-libmemcached_store
+  gem_of_thrones!
+  memcached
+  rake
+  rspec (~> 2)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+
+task :default do
+  sh "rspec spec/"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/gem_of_thrones/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/Readme.md

@@ -0,0 +1,39 @@
+Everybody wants to be king, but only one can win (synchronized via a distributed cache).<br/>
+Update something everybody depends on without doing it multiple times or using a cron.
+
+Cache must support the interface `write(key, value, :expires_in => xxx, :unless_exist => true)`,<br/>
+which afaik only `ActiveSupport::Cache::MemCacheStore` and [ActiveSupport::Cache::LibmemcachedStore](https://github.com/benhutton/libmemcached_store) do.
+
+
+Install
+=======
+    gem install gem_of_thrones
+Or
+
+    rails plugin install git://github.com/grosser/gem_of_thrones.git
+
+
+Usage
+=====
+
+    aspirant = GemOfThrones.new(
+      :cache => Rails.cache, # where to store the lock ?
+      :timeout => 60 # if current king does not react the next aspirant will take its place
+    )
+
+    Thread.new do
+      loop do
+        # if I can be king (there is no king or the old king did not do anything)
+        if aspirant.rise_to_power
+          # do something that should only be done by one
+        end
+        sleep 30 # if you choose a timeout greater then the throne timeout the king will always change
+      end
+    end
+
+Author
+======
+[Zendesk](http://zendesk.com)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://secure.travis-ci.org/grosser/gem_of_thrones.png)](http://travis-ci.org/grosser/gem_of_thrones)

data/gem_of_thrones.gemspec

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+name = "gem_of_thrones"
+require "#{name}/version"
+
+Gem::Specification.new name, GemOfThrones::VERSION do |s|
+  s.summary = "Everybody wants to be king, but only one can win (synchronized via a distributed cache)"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
+end

data/lib/gem_of_thrones.rb

@@ -0,0 +1,38 @@
+require "gem_of_thrones/version"
+
+class GemOfThrones
+  def initialize(options)
+    @options = {
+      :timeout => 10 * 60,
+      :cache_key => "GemOfThrones.",
+      :cache => "You have to set :cache",
+    }.merge(options)
+
+    raise "Only integers are supported for timeout" if options[:timeout].is_a?(Float)
+  end
+
+  def rise_to_power
+    i_am_king! :try => !in_power?
+  end
+
+  private
+
+  def i_am_king!(options)
+    @options[:cache].write(@options[:cache_key], myself,
+      :expires_in => @options[:timeout],
+      :unless_exist => options[:try]
+    )
+  end
+
+  def in_power?
+    current_king == myself
+  end
+
+  def current_king
+    @options[:cache].read(@options[:cache_key])
+  end
+
+  def myself
+    @myself ||= "#{Process.pid}-#{object_id}-#{Time.now.to_f}"
+  end
+end

data/lib/gem_of_thrones/version.rb

@@ -0,0 +1,3 @@
+class GemOfThrones
+  VERSION = '0.2.1'
+end

data/spec/gem_of_thrones_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe GemOfThrones do
+  let(:cache){ ActiveSupport::Cache::LibmemcachedStore.new(:namespace => "GemOfThronesTest") }
+
+  before do
+    cache.clear
+  end
+
+  def new_game(options={})
+    GemOfThrones.new({:cache => cache, :mutex_timeout => 0.01}.merge(options))
+  end
+
+  it "has a VERSION" do
+    GemOfThrones::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  it "raises with unsupported timeouts" do
+    expect{
+      new_game(:timeout => 0.1)
+    }.to raise_error
+  end
+
+  describe "#rise_to_power" do
+    it "executes if there is no king" do
+      result = nil
+      if new_game.rise_to_power
+        result = 1
+      end
+      result.should == 1
+    end
+
+    it "executes if the king is alive" do
+      result = nil
+      if new_game.rise_to_power
+        result = 1
+      end
+      if new_game.rise_to_power
+        result = 2
+      end
+      result.should == 1
+    end
+
+    it "executes if the king stays alive" do
+      result = nil
+      game = new_game
+      if game.rise_to_power
+        result = 1
+      end
+      if game.rise_to_power
+        result = 2
+      end
+      result.should == 2
+    end
+
+    it "executes if the king died" do
+      result = nil
+      if new_game(:timeout => 1).rise_to_power
+        result = 1
+      end
+      sleep 1.1
+      if new_game.rise_to_power
+        result = 2
+      end
+      result.should == 2
+    end
+
+    # using fractions of seconds leads to randomly failing tests
+    it "ruling keeps the king in power" do
+      result = nil
+      old_king = new_game(:timeout => 3)
+      if old_king.rise_to_power
+        result = 1
+      end
+      sleep 2
+      if old_king.rise_to_power
+        result = 2
+      end
+      sleep 2
+      if new_game.rise_to_power
+        result = 3
+      end
+      result.should == 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift 'lib'
+require 'gem_of_thrones'
+
+require 'memcached'
+require 'active_support/cache'
+require 'active_support/cache/libmemcached_store'
+
+# needed by ActiveSupport::Cache::Store
+class String
+  def duplicable?
+    true
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: gem_of_thrones
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-09 00:00:00 Z
+dependencies: []
+
+description: 
+email: michael@grosser.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- gem_of_thrones.gemspec
+- lib/gem_of_thrones.rb
+- lib/gem_of_thrones/version.rb
+- spec/gem_of_thrones_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/gem_of_thrones
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Everybody wants to be king, but only one can win (synchronized via a distributed cache)
+test_files: []
+