ruote-couch 2.1.1

data/CHANGELOG.txt

@@ -0,0 +1,5 @@
+
+= ruote-couch - CHANGELOG.txt
+
+== ruote-couch 2.1.0    not yet released
+

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,26 @@
+
+= ruote-couch
+
+A storage implementation for ruote 2.1.x.
+
+Warning : this is a very naive implementation for now. No optimizations.
+
+
+== license
+
+MIT
+
+
+== Links
+
+http://ruote.rubyforge.org
+http://github.com/jmettraux/ruote
+
+http://jmettraux.wordpress.com (blog)
+
+
+== feedback
+
+mailing list : http://groups.google.com/group/openwferu-users
+irc : irc.freenode.net #ruote
+

data/Rakefile

@@ -0,0 +1,77 @@
+
+require 'rubygems'
+require 'rake'
+
+require 'lib/ruote/couch/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::Couch::VERSION
+  gem.name = 'ruote-couch'
+  gem.summary = 'CouchDB storage for ruote 2.1'
+  gem.description = %{
+CouchDB storage for ruote 2.1 (ruby workflow engine)
+  }.strip
+  gem.email = 'jmettraux@gmail.com'
+  gem.homepage = 'http://github.com/jmettraux/ruote-couch'
+  gem.authors = [ 'John Mettraux' ]
+  gem.rubyforge_project = 'ruote'
+
+  gem.test_file = 'test/test.rb'
+
+  #gem.add_dependency 'yajl-ruby'
+  #gem.add_dependency 'json'
+  gem.add_dependency 'rufus-jig', '>= 0.1.6'
+  gem.add_development_dependency 'yard', '>= 0'
+
+  # 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-couch', '--title',
+      "ruote-couch #{Ruote::Couch::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-couch #{account}:#{webdir}/"
+end
+

data/TODO.txt

@@ -0,0 +1,8 @@
+
+[ ] view for ats
+[ ] view for crons
+
+[ ] jig / r-couch should not rely on exceptions
+
+[x] ct_2 --couch says put(gone) is returning nil... :(
+

data/lib/ruote-couch.rb

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

data/lib/ruote/couch.rb

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

data/lib/ruote/couch/database.rb

@@ -0,0 +1,145 @@
+#--
+# 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.
+#++
+
+
+module Ruote::Couch
+
+  class Database
+
+    attr_reader :type
+
+    def initialize (host, port, type, name, re_put_ok=true)
+
+      @couch = Rufus::Jig::Couch.new(host, port, name, :re_put_ok => re_put_ok)
+      @couch.put('.') unless @couch.get('.')
+
+      @type = type
+
+      prepare
+    end
+
+    def put (doc, opts)
+
+      doc['put_at'] = Ruote.now_to_utc_s
+
+      @couch.put(doc, :update_rev => opts[:update_rev])
+        #
+        # :update_rev => true :
+        # updating the current doc _rev, this trick allows
+        # direct "create then apply" chaining
+    end
+
+    def get (key)
+
+      @couch.get(key)
+    end
+
+    def delete (doc)
+
+      begin
+
+        @couch.delete(doc)
+
+      rescue Rufus::Jig::HttpError => he
+        if he.status == 404
+          true
+        else
+          raise he
+        end
+      end
+    end
+
+    def get_many (key, opts)
+
+      os = if l = opts[:limit]
+        "&limit=#{l}"
+      else
+        ''
+      end
+
+      rs = @couch.get("_all_docs?include_docs=true#{os}")
+
+      rs = rs['rows'].collect { |e| e['doc'] }
+
+      rs = rs.select { |doc| doc['_id'].match(key) } if key
+        # naive...
+
+      rs
+    end
+
+    def dump
+
+      s = "=== #{@type} ===\n"
+
+      get_many(nil, {}).inject(s) do |s1, e|
+        s1 << "\n"
+        e.keys.sort.inject(s1) do |s2, k|
+          s2 << "  #{k} => #{e[k].inspect}\n"
+        end
+      end
+    end
+
+    def shutdown
+
+      @couch.close
+    end
+
+    def purge!
+
+      @couch.delete('.')
+      @couch.close
+    end
+
+    protected
+
+    def prepare
+
+      # nothing to do for a index-less database
+    end
+  end
+
+  class WfidIndexedDatabase < Database
+
+    #DESIGN_DOC_TEMPLATE = %{
+    #  {
+    #    "_id": "_design/ruote",
+    #    "version": 0,
+    #
+    #    "views": {
+    #      "by_type": {
+    #        "map": "function (doc) { emit(doc.type, doc); }"
+    #      }
+    #    }
+    #  }
+    #}.strip
+
+    protected
+
+    def prepare
+
+      # TODO
+    end
+  end
+end
+

data/lib/ruote/couch/storage.rb

@@ -0,0 +1,144 @@
+#--
+# 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 'ruote/storage/base'
+require 'ruote/couch/version'
+require 'ruote/couch/database'
+require 'rufus/jig' # gem install rufus-jig
+
+
+module Ruote
+module Couch
+
+  class CouchStorage
+
+    include Ruote::StorageBase
+
+    attr_reader :couch
+
+    def initialize (host, port, options={})
+
+      @host = host
+      @port = port
+
+      @options = options
+
+      @prefix = options['prefix'] || ''
+      @prefix = "#{@prefix}_" if @prefix.size > 0
+
+      @dbs = {}
+
+      %w[ msgs schedules configurations variables ].each do |type|
+
+        @dbs[type] = Database.new(
+          @host, @port, type, "#{@prefix}ruote_#{type}")
+      end
+
+      %w[ errors workitems ].each do |type|
+
+        @dbs[type] = WfidIndexedDatabase.new(
+          @host, @port, type, "#{@prefix}ruote_#{type}")
+      end
+
+      @dbs['expressions'] = WfidIndexedDatabase.new(
+        @host, @port, 'expressions', "#{@prefix}ruote_expressions", false)
+
+      put_configuration
+    end
+
+    def put (doc, opts={})
+
+      @dbs[doc['type']].put(doc, opts)
+    end
+
+    def get (type, key)
+
+      @dbs[type].get(key)
+    end
+
+    def delete (doc)
+
+      db = @dbs[doc['type']]
+
+      raise ArgumentError.new("no database for type '#{doc['type']}'") unless db
+
+      db.delete(doc)
+    end
+
+    def get_many (type, key=nil, opts={})
+
+      @dbs[type].get_many(key, opts)
+    end
+
+    def purge!
+
+      @dbs.values.each { |db| db.purge! }
+    end
+
+    def dump (type)
+
+      @dbs[type].dump
+    end
+
+    def shutdown
+
+      @dbs.values.each { |db| db.shutdown }
+    end
+
+    # Mainly used by ruote's test/unit/ut_17_storage.rb
+    #
+    def add_test_type (type)
+
+      @dbs[type] = Database.new(
+        @host, @port, type, "#{@prefix}ruote_#{type}", false)
+    end
+
+    protected
+
+    def put_configuration
+
+      return if get('configurations', 'engine')
+
+      conf = { '_id' => 'engine', 'type' => 'configurations' }.merge!(@options)
+
+      put(conf)
+    end
+
+#    def put_design_document
+#
+#      doc = Rufus::Jig::Json.decode(
+#        File.read(File.join(File.dirname(__FILE__), 'storage.json')))
+#
+#      current = @couch.get('_design/ruote')
+#
+#      if current.nil? || doc['version'] >= (current['version'] || -1)
+#
+#        @couch.delete(current) if current
+#        @couch.put(doc)
+#      end
+#    end
+  end
+end
+end
+

data/lib/ruote/couch/version.rb

@@ -0,0 +1,7 @@
+
+module Ruote
+module Couch
+  VERSION = '2.1.1'
+end
+end
+

data/ruote-couch.gemspec

@@ -0,0 +1,66 @@
+# 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-couch}
+  s.version = "2.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux"]
+  s.date = %q{2009-12-31}
+  s.description = %q{CouchDB storage for ruote 2.1 (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-couch.rb",
+     "lib/ruote/couch.rb",
+     "lib/ruote/couch/database.rb",
+     "lib/ruote/couch/storage.rb",
+     "lib/ruote/couch/version.rb",
+     "ruote-couch.gemspec",
+     "test/functional/ft_0_echo.rb",
+     "test/functional/test.rb",
+     "test/integration_connection.rb",
+     "test/path_helper.rb",
+     "test/test.rb",
+     "test/test_helper.rb",
+     "test/unit/test.rb",
+     "test/unit/ut_0_initial.rb"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/ruote-couch}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruote}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{CouchDB storage for ruote 2.1}
+  s.test_files = [
+    "test/test.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<rufus-jig>, [">= 0.1.6"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rufus-jig>, [">= 0.1.6"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rufus-jig>, [">= 0.1.6"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test/functional/ft_0_echo.rb

@@ -0,0 +1,42 @@
+
+#
+# testing ruote-couch
+#
+# Fri Dec 11 22:06:25 JST 2009
+#
+
+require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
+
+require 'ruote/engine'
+require 'ruote/worker'
+
+require File.join(File.dirname(__FILE__), '..', 'integration_connection.rb')
+
+
+class FtInitialTest < Test::Unit::TestCase
+
+  def test_echo
+
+    #require 'ruote/storage/hash_storage'
+    #storage = Ruote::HashStorage.new
+    #require 'ruote/storage/fs_storage'
+    #storage = Ruote::FsStorage.new('work')
+
+    storage = new_storage(nil)
+
+    engine = Ruote::Engine.new(Ruote::Worker.new(storage))
+
+    engine.context[:noisy] = true
+
+    pdef = Ruote.process_definition :name => 'test' do
+      echo '* SEEN *'
+    end
+
+    wfid = engine.launch(pdef)
+
+    engine.wait_for(wfid)
+
+    #storage.purge!
+  end
+end
+

data/test/functional/test.rb

@@ -0,0 +1,11 @@
+
+#
+# testing ruote-couch
+#
+# Fri Dec 11 20:11:39 JST 2009
+#
+
+Dir.glob(File.join(File.dirname(__FILE__), 'ft_*.rb')).sort.each { |t|
+  require(t)
+}
+

data/test/integration_connection.rb

@@ -0,0 +1,23 @@
+
+#
+# testing ruote-couch
+#
+# Sun Dec 13 20:22:43 JST 2009
+#
+
+require 'yajl' rescue require 'json'
+Rufus::Json.detect_backend
+
+require 'patron' rescue nil
+
+require 'ruote/couch/storage'
+
+
+def new_storage (opts)
+
+  opts ||= {}
+
+  Ruote::Couch::CouchStorage.new(
+    '127.0.0.1', 5984, opts.merge!('prefix' => 'test'))
+end
+

data/test/path_helper.rb

@@ -0,0 +1,16 @@
+
+#
+# testing ruote-couch
+#
+# Thu Dec 10 11:04:02 JST 2009
+#
+
+ruote_lib = File.expand_path(
+  File.join(File.dirname(__FILE__), *%w[ .. .. ruote lib ]))
+ruote_couch_lib = File.expand_path(
+  File.join(File.dirname(__FILE__), *%w[ .. lib ]))
+
+[ ruote_lib, ruote_couch_lib ].each do |lib|
+  $:.unshift(lib) unless $:.include?(lib)
+end
+

data/test/test.rb

@@ -0,0 +1,10 @@
+
+#
+# testing Ruote-couch
+#
+# Fri Dec 11 20:10:30 JST 2009
+#
+
+load File.dirname(__FILE__) + '/unit/test.rb'
+load File.dirname(__FILE__) + '/functional/test.rb'
+

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+
+#
+# testing ruote-couch
+#
+# Thu Dec 10 11:09:17 JST 2009
+#
+
+require 'yajl'
+
+require File.join(File.dirname(__FILE__), 'path_helper')
+
+require 'test/unit'
+

data/test/unit/test.rb

@@ -0,0 +1,11 @@
+
+#
+# testing ruote-couch
+#
+# Fri Dec 11 20:12:37 JST 2009
+#
+
+Dir.glob(File.join(File.dirname(__FILE__), 'ut_*.rb')).sort.each { |t|
+  require(t)
+}
+

data/test/unit/ut_0_initial.rb

@@ -0,0 +1,27 @@
+
+#
+# testing ruote-couch
+#
+# Thu Dec 10 11:07:56 JST 2009
+#
+
+require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
+
+require 'ruote/couch/storage'
+
+
+class UtInitialTest < Test::Unit::TestCase
+
+  def test_connect
+
+    storage = Ruote::Couch::CouchStorage.new(
+      '127.0.0.1', 5984, :prefix => 'test')
+
+    v = storage.get_many('configurations')
+
+    #p v
+
+    assert_equal 1, v.size
+  end
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: ruote-couch
+version: !ruby/object:Gem::Version 
+  version: 2.1.1
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-31 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rufus-jig
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: CouchDB storage for ruote 2.1 (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-couch.rb
+- lib/ruote/couch.rb
+- lib/ruote/couch/database.rb
+- lib/ruote/couch/storage.rb
+- lib/ruote/couch/version.rb
+- ruote-couch.gemspec
+- test/functional/ft_0_echo.rb
+- test/functional/test.rb
+- test/integration_connection.rb
+- test/path_helper.rb
+- test/test.rb
+- test/test_helper.rb
+- test/unit/test.rb
+- test/unit/ut_0_initial.rb
+has_rdoc: true
+homepage: http://github.com/jmettraux/ruote-couch
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ruote
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: CouchDB storage for ruote 2.1
+test_files: 
+- test/test.rb