ruote-redis 2.1.10

data/CHANGELOG.txt

@@ -0,0 +1,9 @@
+
+= ruote-redis - CHANGELOG.txt
+
+
+== ruote-redis 2.1.10    released 2010/06/15
+
+- works with redis-rb 1.0.2 and 2.0
+- initial release
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2001-2010, John Mettraux, jmettraux@gmail.com
+
+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/README.rdoc

@@ -0,0 +1,73 @@
+
+= ruote-redis
+
+Redis persistence for ruote 2.1 (a ruby workflow engine)
+
+
+== usage
+
+The storage is instantiate by passing a redis-rb instance to the storage.
+
+  require 'redis' # gem install redis
+  require 'ruote' # gem install ruote
+  require 'ruote-redis' # gem install ruote-redis
+
+  engine = Ruote::Engine.new(
+    Ruote::Worker.new(
+      Ruote::Redis::RedisStorage.new(
+        ::Redis.new(:db => 14, :thread_safe => true), {})))
+
+  # ...
+
+Passing an em-redis instance might work, but I haven't tried.
+
+Tested with Redis 1.3.8 (redis-rb 2.0.1).
+
+
+== running tests
+
+assuming you have
+
+  ruote/
+  ruote-redis/
+
+start a redis server instance (port 6379) and then 
+
+
+* unit tests :
+
+get into ruote/ and do
+
+  ruby test/unit/storage.rb --redis
+
+* functional tests :
+
+get into ruote/ and do
+
+  ruby test/functional/test.rb --redis
+
+
+== license
+
+MIT
+
+
+== links
+
+* http://code.google.com/p/redis/
+* http://github.com/ezmobius/redis-rb
+
+* http://ruote.rubyforge.org/
+* http://github.com/jmettraux/ruote-redis
+
+
+== feedback
+
+mailing list : http://groups.google.com/group/openwferu-users
+irc : irc.freenode.net #ruote
+
+
+== many thanks to
+
+- the Redis authors and the redis-rb authors
+

data/Rakefile

@@ -0,0 +1,78 @@
+
+require 'rubygems'
+require 'rake'
+
+require 'lib/ruote/redis/version.rb'
+
+#
+# CLEAN
+
+require 'rake/clean'
+CLEAN.include('pkg', 'tmp', 'html')
+task :default => [ :clean ]
+
+
+#
+# GEM
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+
+  gem.version = Ruote::Redis::VERSION
+  gem.name = 'ruote-redis'
+  gem.summary = 'Redis storage for ruote (a ruby workflow engine)'
+  gem.description = %{
+Redis storage for ruote (a ruby workflow engine)
+  }.strip
+  gem.email = 'jmettraux@gmail.com'
+  gem.homepage = 'http://github.com/jmettraux/ruote-redis'
+  gem.authors = [ 'John Mettraux' ]
+  gem.rubyforge_project = 'ruote'
+
+  #gem.test_file = 'test/test.rb'
+
+  gem.add_dependency 'ruote', ">= #{Ruote::Redis::VERSION}"
+  gem.add_dependency 'redis', '>= 2.0.1'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'jeweler'
+
+  # gemspec spec : http://www.rubygems.org/read/chapter/20
+end
+Jeweler::GemcutterTasks.new
+
+
+#
+# DOC
+
+begin
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |doc|
+    doc.options = [
+      '-o', 'html/ruote-redis', '--title',
+      "ruote-redis #{Ruote::Redis::VERSION}"
+    ]
+  end
+
+rescue LoadError
+
+  task :yard do
+    abort "YARD is not available : sudo gem install yard"
+  end
+end
+
+
+#
+# TO THE WEB
+
+task :upload_website => [ :clean, :yard ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/ruote'
+
+  sh "rsync -azv -e ssh html/ruote-redis #{account}:#{webdir}/"
+end
+

data/TODO.txt

@@ -0,0 +1,10 @@
+
+[x] methods specific to StorageParticipant
+[o] redis -> @redis
+
+[ ] 1 ::Redis instance per thread ? (instead of :thread_safe => true)
+[ ] update to redis-rb 2.0 (which has sthing about threads)
+    http://blog.citrusbyte.com/2010/05/14/redis-rb-200/
+
+[ ] double-check for deletion of old keys
+

data/lib/ruote-redis.rb

@@ -0,0 +1,3 @@
+
+require 'ruote/redis/storage'
+

data/lib/ruote/redis.rb

@@ -0,0 +1,3 @@
+
+require 'ruote/redis/storage'
+

data/lib/ruote/redis/storage.rb

@@ -0,0 +1,297 @@
+#--
+# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+#require 'redis'
+  # now letting the end-user doing this require
+
+require 'rufus-json'
+require 'ruote/storage/base'
+require 'ruote/redis/version'
+
+
+module Ruote
+module Redis
+
+  #
+  # A Redis storage for ruote.
+  #
+  # The constructor accepts two arguments, the first one is a Redis instance
+  # ( see http://github.com/ezmobius/redis-rb ), the second one is the classic
+  # ruote engine options ( see
+  # http://ruote.rubyforge.org/configuration.html#engine )
+  #
+  #   require 'redis' # gem install redis
+  #   require 'ruote' # gem install ruote
+  #   require 'ruote-redis' # gem install ruote-redis
+  #
+  #   engine = Ruote::Engine.new(
+  #     Ruote::Worker.new(
+  #       Ruote::Redis::RedisStorage.new(
+  #         ::Redis.new(:db => 14, :thread_safe => true), {})))
+  #
+  #
+  # == em-redis
+  #
+  # Not tried, but I guess, that substituting an instance of em-redis for
+  # the redis instance passed to the constructor might work.
+  # http://github.com/madsimian/em-redis
+  #
+  # If you try and it works, feedback is welcome
+  # http://groups.google.com/group/openwferu-users
+  #
+  class RedisStorage
+
+    include Ruote::StorageBase
+
+    attr_reader :redis
+
+    def initialize (redis, options={})
+
+      @redis = redis
+      @options = options
+
+      def @redis.keys_to_a (opt)
+        r = keys(opt)
+        r.is_a?(Array) ? r : r.split(' ')
+      end
+
+      put_configuration
+    end
+
+    def reserve (doc)
+
+      @redis.del(key_for(doc))
+    end
+
+    def put_msg (action, options)
+
+      doc = prepare_msg_doc(action, options)
+
+      @redis.set(key_for(doc), to_json(doc))
+
+      nil
+    end
+
+    def put_schedule (flavour, owner_fei, s, msg)
+
+      if doc = prepare_schedule_doc(flavour, owner_fei, s, msg)
+        @redis.set(key_for(doc), to_json(doc))
+        return doc['_id']
+      end
+
+      nil
+    end
+
+    def delete_schedule (schedule_id)
+
+      @redis.del(key_for('schedules', schedule_id))
+    end
+
+    def put (doc, opts={})
+
+      rev = doc['_rev'].to_i
+      key = key_for(doc)
+
+      current_rev = @redis.get(key).to_i
+
+      return true if current_rev == 0 && rev > 0
+      return do_get(doc, current_rev) if rev != current_rev
+
+      nrev = rev + 1
+
+      # the setnx here is crucial in multiple workers env...
+
+      r = @redis.setnx(
+        key_rev_for(doc, nrev),
+        to_json(doc.merge('_rev' => nrev), opts))
+
+      return get(doc['type'], doc['_id']) if r == false
+
+      @redis.set(key, nrev)
+      @redis.del(key_rev_for(doc, rev)) if rev > 0
+
+      doc['_rev'] = nrev if opts[:update_rev]
+
+      nil
+    end
+
+    def get (type, key)
+
+      do_get(type, key, @redis.get(key_for(type, key)))
+    end
+
+    def delete (doc)
+
+      raise ArgumentError.new(
+        "can't delete doc without _rev") unless doc['_rev']
+
+      r = put(doc, :delete => true)
+
+      return r if r != nil
+
+      @redis.keys_to_a("#{key_for(doc)}*").sort.each { |k|
+        Thread.pass # lingering a bit...
+        @redis.del(k)
+      }
+        # deleting the key_rev last and making 1 'keys' call preliminarily
+
+      nil
+    end
+
+    def get_many (type, key=nil, opts={})
+
+      keys = "#{type}/*"
+
+      ids = if type == 'msgs' || type == 'schedules'
+
+        @redis.keys_to_a(keys)
+
+      else
+
+        @redis.keys_to_a(keys).inject({}) { |h, k|
+
+          if m = k.match(/^[^\/]+\/([^\/]+)\/(\d+)$/)
+
+            if ( ! key) || m[1].match(key)
+
+              o = h[m[1]]
+              n = [ m[2].to_i, k ]
+              h[m[1]] = [ m[2].to_i, k ] if ( ! o) || o.first < n.first
+            end
+          end
+
+          h
+        }.values.collect { |i| i[1] }
+      end
+
+      if l = opts[:limit]
+        ids = ids[0, l]
+      end
+
+      ids.inject([]) do |a, i|
+        v = @redis.get(i)
+        a << Rufus::Json.decode(v) if v
+        a
+      end
+    end
+
+    def ids (type)
+
+      @redis.keys_to_a("#{type}/*").inject([]) { |a, k|
+
+        if m = k.match(/^[^\/]+\/([^\/]+)$/)
+          a << m[1]
+        end
+
+        a
+      }.sort
+    end
+
+    def purge!
+
+      @redis.keys_to_a('*').each { |k| @redis.del(k) }
+    end
+
+    #def dump (type)
+    #  @dbs[type].dump
+    #end
+
+    def shutdown
+    end
+
+    # Mainly used by ruote's test/unit/ut_17_storage.rb
+    #
+    def add_type (type)
+    end
+
+    # Nukes a db type and reputs it (losing all the documents that were in it).
+    #
+    def purge_type! (type)
+
+      @redis.keys_to_a("#{type}/*").each { |k| @redis.del(k) }
+    end
+
+    protected
+
+    #   key_for(doc)
+    #   key_for(type, key)
+    #
+    def key_for (*args)
+
+      a = args.first
+
+      (a.is_a?(Hash) ? [ a['type'], a['_id'] ] : args[0, 2]).join('/')
+    end
+
+    #   key_rev_for(doc)
+    #   key_rev_for(doc, rev)
+    #   key_rev_for(type, key, rev)
+    #
+    def key_rev_for (*args)
+
+      as = nil
+      a = args.first
+
+      if a.is_a?(Hash)
+        as = [ a['type'], a['_id'], a['_rev'] ] if a.is_a?(Hash)
+        as[2] = args[1] if args[1]
+      else
+        as = args[0, 3]
+      end
+
+      as.join('/')
+    end
+
+    def do_get (*args)
+
+      d = @redis.get(key_rev_for(*args))
+
+      d ? Rufus::Json.decode(d) : nil
+    end
+
+    def to_json (doc, opts={})
+
+      doc = if opts[:delete]
+        nil
+      else
+        doc.merge('put_at' => Ruote.now_to_utc_s)
+      end
+
+      Rufus::Json.encode(doc)
+    end
+
+    # Don't put configuration if it's already in
+    #
+    # (avoid storages from trashing configuration...)
+    #
+    def put_configuration
+
+      return if get('configurations', 'engine')
+
+      put({ '_id' => 'engine', 'type' => 'configurations' }.merge(@options))
+    end
+  end
+end
+end
+

data/lib/ruote/redis/version.rb

@@ -0,0 +1,7 @@
+
+module Ruote
+module Redis
+  VERSION = '2.1.10'
+end
+end
+

data/ruote-redis.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruote-redis}
+  s.version = "2.1.10"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux"]
+  s.date = %q{2010-06-15}
+  s.description = %q{Redis storage for ruote (a ruby workflow engine)}
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG.txt",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "lib/ruote-redis.rb",
+     "lib/ruote/redis.rb",
+     "lib/ruote/redis/storage.rb",
+     "lib/ruote/redis/version.rb",
+     "ruote-redis.gemspec",
+     "test/functional_connection.rb"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/ruote-redis}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruote}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Redis storage for ruote (a ruby workflow engine)}
+  s.test_files = [
+    "test/functional_connection.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.10"])
+      s.add_runtime_dependency(%q<redis>, [">= 2.0.1"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<ruote>, [">= 2.1.10"])
+      s.add_dependency(%q<redis>, [">= 2.0.1"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruote>, [">= 2.1.10"])
+    s.add_dependency(%q<redis>, [">= 2.0.1"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/test/functional_connection.rb

@@ -0,0 +1,31 @@
+
+#
+# testing ruote-redis
+#
+# Thu Apr  1 21:35:07 JST 2010
+#
+
+require 'yajl' rescue require 'json'
+require 'rufus-json'
+Rufus::Json.detect_backend
+
+require 'redis'
+require 'ruote-redis'
+
+
+class RrLogger
+  def method_missing (m, *args)
+    super if args.length != 1
+    puts ". #{Time.now.to_f} #{Thread.current.object_id} #{args.first}"
+  end
+end
+
+
+def new_storage (opts)
+
+  Ruote::Redis::RedisStorage.new(
+    ::Redis.new(:db => 14, :thread_safe => true),
+    #::Redis.new(:db => 14, :thread_safe => true, :logger => RrLogger.new),
+    opts)
+end
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: ruote-redis
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 10
+  version: 2.1.10
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-15 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruote
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 10
+        version: 2.1.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Redis storage for ruote (a ruby workflow engine)
+email: jmettraux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- CHANGELOG.txt
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- TODO.txt
+- lib/ruote-redis.rb
+- lib/ruote/redis.rb
+- lib/ruote/redis/storage.rb
+- lib/ruote/redis/version.rb
+- ruote-redis.gemspec
+- test/functional_connection.rb
+has_rdoc: true
+homepage: http://github.com/jmettraux/ruote-redis
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ruote
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Redis storage for ruote (a ruby workflow engine)
+test_files: 
+- test/functional_connection.rb