ruote-couch 2.1.5 → 2.1.7

data/CHANGELOG.txt

@@ -2,6 +2,11 @@
 = ruote-couch - CHANGELOG.txt
 
 
+== ruote-couch 2.1.7    released 2010/02/15
+
+- enabled Ruote::StorageParticipant#query(criteria)
+
+
 == ruote-couch 2.1.5    released 2010/01/28
 
 - implemented CouchStorage#by_wfid and #by_participant

data/README.rdoc

@@ -3,7 +3,27 @@
 
 A storage implementation for ruote 2.1.x.
 
-Warning : this is a very naive implementation for now. No optimizations.
+Warning : this is a very naive implementation for now. Not many optimizations...
+
+
+== running tests
+
+assuming you have
+
+  ruote/
+  ruote-couch/
+
+* unit tests :
+
+get into ruote/ and do
+
+  ruby test/unit/storage.rb --couch
+
+* functional tests :
+
+get into ruote/ and do
+
+  ruby test/functional/test.rb --couch
 
 
 == license

data/Rakefile

@@ -33,10 +33,9 @@ CouchDB storage for ruote 2.1 (ruby workflow engine)
   gem.test_file = 'test/test.rb'
 
   gem.add_dependency 'ruote', ">= #{Ruote::Couch::VERSION}"
-  #gem.add_dependency 'yajl-ruby'
-  #gem.add_dependency 'json'
-  gem.add_dependency 'rufus-jig', '>= 0.1.12'
-  gem.add_development_dependency 'yard', '>= 0'
+  gem.add_dependency 'rufus-jig', '>= 0.1.13'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'jeweler'
 
   # gemspec spec : http://www.rubygems.org/read/chapter/20
 end

data/lib/ruote/couch/database.rb

@@ -30,6 +30,9 @@ module Ruote::Couch
   #
   # A database corresponds to a Couch database (not a Couch server).
   #
+  # There is one database per ruote document type (msgs, workitems,
+  # expressions, ...)
+  #
   class Database
 
     attr_reader :type
@@ -130,11 +133,11 @@ module Ruote::Couch
     #
     def query_options (opts)
 
-      if l = opts[:limit]
-        "&limit=#{l}"
-      else
-        ''
-      end
+      opts = opts.select { |k, v| [ :limit, :skip ].include?(k) && v != nil }
+
+      s = opts.collect { |k, v| "#{k}=#{v}" }.join('&')
+
+      s.length > 0 ? "&#{s}" : ''
     end
 
     def query (uri)
@@ -143,6 +146,15 @@ module Ruote::Couch
 
       rs['rows'].collect { |e| e['doc'] }
     end
+
+    def query_by_post (uri, keys)
+
+      keys = { 'keys' => keys }
+
+      rs = @couch.post(uri, keys)
+
+      rs['rows'].collect { |e| e['doc'] }.uniq
+    end
   end
 
   #
@@ -166,6 +178,13 @@ module Ruote::Couch
       end
     end
 
+    # Used by WorkitemDatabase#query
+    #
+    def by_wfid (wfid)
+
+      get_many(/!#{wfid}$/, {})
+    end
+
     protected
 
     def design_doc
@@ -215,6 +234,42 @@ module Ruote::Couch
         "&include_docs=true#{query_options(opts)}")
     end
 
+    # This method is called by CouchStorage#query
+    #
+    def query_workitems (criteria)
+
+      offset = criteria.delete('offset')
+      limit = criteria.delete('limit')
+
+      wfid =
+        criteria.delete('wfid')
+      pname =
+        criteria.delete('participant_name') || criteria.delete('participant')
+
+      if criteria.empty? && (wfid.nil? ^ pname.nil?)
+        return by_participant(pname) if pname
+        return by_wfid(wfid) # if wfid
+      end
+
+      return get_many(nil, {}).collect { |hwi| Ruote::Workitem.new(hwi) } \
+        if criteria.empty?
+
+      cr = criteria.collect { |fname, fvalue| { fname => fvalue } }
+
+      opts = { :skip => offset, :limit => limit }
+
+      hwis = query_by_post(
+        "_design/ruote/_view/by_field?include_docs=true#{query_options(opts)}",
+        cr)
+
+      hwis = hwis.select { |hwi| hwi['fei']['wfid'] == wfid } if wfid
+
+      hwis = hwis.select { |hwi|
+        Ruote::StorageParticipant.matches?(hwi, pname, criteria) }
+
+      hwis.collect { |hwi| Ruote::Workitem.new(hwi) }
+    end
+
     protected
 
     def design_doc
@@ -237,11 +292,11 @@ module Ruote::Couch
 
                 emit(field, null);
 
-                var k = {};
-                k[field] = doc.fields[field]
-                emit(k, null);
+                var entry = {};
+                entry[field] = doc.fields[field]
+                emit(entry, null);
                   //
-                  // have to use that k trick...
+                  // have to use that 'entry' trick...
                   // else the field is named 'field'
               }
             }

data/lib/ruote/couch/storage.rb

@@ -31,12 +31,23 @@ require 'rufus/jig' # gem install rufus-jig
 module Ruote
 module Couch
 
+  #
+  # A CouchDB storage mechanism for ruote.
+  #
+  # The storage merely 'routes' work to Ruote::Couch::Database instances,
+  # one per document 'type' (expressions, msgs, schedules, variables, ...)
+  #
   class CouchStorage
 
     include Ruote::StorageBase
 
     attr_reader :couch
 
+    # Hooks the storage to a CouchDB instance.
+    #
+    # The main option is 'prefix', which indicate which prefix should be
+    # added to all the database names used by this storage.
+    #
     def initialize (host, port, options={})
 
       @host = host
@@ -145,6 +156,11 @@ module Couch
       @dbs['workitems'].by_field(field, value)
     end
 
+    def query_workitems (criteria)
+
+      @dbs['workitems'].query_workitems(criteria)
+    end
+
     protected
 
     def put_configuration

data/lib/ruote/couch/version.rb

@@ -1,7 +1,7 @@
 
 module Ruote
 module Couch
-  VERSION = '2.1.5'
+  VERSION = '2.1.7'
 end
 end
 

data/ruote-couch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote-couch}
-  s.version = "2.1.5"
+  s.version = "2.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-01-28}
+  s.date = %q{2010-02-15}
   s.description = %q{CouchDB storage for ruote 2.1 (ruby workflow engine)}
   s.email = %q{jmettraux@gmail.com}
   s.extra_rdoc_files = [
@@ -28,14 +28,8 @@ Gem::Specification.new do |s|
      "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"
+     "test/test.rb"
   ]
   s.homepage = %q{http://github.com/jmettraux/ruote-couch}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -52,18 +46,21 @@ Gem::Specification.new do |s|
     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.5"])
-      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.12"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.7"])
+      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.13"])
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<ruote>, [">= 2.1.5"])
-      s.add_dependency(%q<rufus-jig>, [">= 0.1.12"])
+      s.add_dependency(%q<ruote>, [">= 2.1.7"])
+      s.add_dependency(%q<rufus-jig>, [">= 0.1.13"])
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<ruote>, [">= 2.1.5"])
-    s.add_dependency(%q<rufus-jig>, [">= 0.1.12"])
+    s.add_dependency(%q<ruote>, [">= 2.1.7"])
+    s.add_dependency(%q<rufus-jig>, [">= 0.1.13"])
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
   end
 end
 

data/test/test.rb

@@ -1,10 +1,7 @@
 
-#
-# 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'
+puts %{
+  ~~~
+  please read the README about how to run ruote-dm tests
+  ~~~
+}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-couch
 version: !ruby/object:Gem::Version 
-  version: 2.1.5
+  version: 2.1.7
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 +09:00
+date: 2010-02-15 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.5
+        version: 2.1.7
     version: 
 - !ruby/object:Gem::Dependency 
   name: rufus-jig
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.12
+        version: 0.1.13
     version: 
 - !ruby/object:Gem::Dependency 
   name: yard
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  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: []
@@ -63,14 +73,8 @@ files:
 - 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: []

data/test/functional/ft_0_echo.rb

@@ -1,42 +0,0 @@
-
-#
-# 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

@@ -1,11 +0,0 @@
-
-#
-# 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/path_helper.rb

@@ -1,16 +0,0 @@
-
-#
-# 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_helper.rb

@@ -1,13 +0,0 @@
-
-#
-# 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

@@ -1,11 +0,0 @@
-
-#
-# 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

@@ -1,25 +0,0 @@
-
-#
-# testing ruote-couch
-#
-# Thu Dec 10 11:07:56 JST 2009
-#
-
-require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
-require File.join(File.dirname(__FILE__), '..', 'integration_connection.rb')
-
-
-class UtInitialTest < Test::Unit::TestCase
-
-  def test_connect
-
-    storage = new_storage(nil)
-
-    v = storage.get_many('configurations')
-
-    #p v
-
-    assert_equal 1, v.size
-  end
-end
-