ruote-couch 2.1.4 → 2.1.5

data/CHANGELOG.txt

@@ -2,11 +2,16 @@
 = ruote-couch - CHANGELOG.txt
 
 
-== ruote-couch 2.1.4    released 2009/01/11
+== ruote-couch 2.1.5    released 2010/01/28
 
-- Ruote::Couch::Storage added #ids(type)
-- Ruote::Couch::Storage added #purge_type!(t)
+- implemented CouchStorage#by_wfid and #by_participant
 
 
-== ruote-couch 2.1.3    released 2009/01/05
+== ruote-couch 2.1.4    released 2010/01/11
+
+- Ruote::Couch::CouchStorage added #ids(type)
+- Ruote::Couch::CouchStorage added #purge_type!(t)
+
+
+== ruote-couch 2.1.3    released 2010/01/05
 

data/Rakefile

@@ -35,7 +35,7 @@ CouchDB storage for ruote 2.1 (ruby workflow engine)
   gem.add_dependency 'ruote', ">= #{Ruote::Couch::VERSION}"
   #gem.add_dependency 'yajl-ruby'
   #gem.add_dependency 'json'
-  gem.add_dependency 'rufus-jig', '>= 0.1.11'
+  gem.add_dependency 'rufus-jig', '>= 0.1.12'
   gem.add_development_dependency 'yard', '>= 0'
 
   # gemspec spec : http://www.rubygems.org/read/chapter/20

data/lib/ruote/couch/database.rb

@@ -22,9 +22,14 @@
 # Made in Japan.
 #++
 
+require 'cgi'
+
 
 module Ruote::Couch
 
+  #
+  # A database corresponds to a Couch database (not a Couch server).
+  #
   class Database
 
     attr_reader :type
@@ -62,20 +67,14 @@ module Ruote::Couch
 
     def get_many (key, opts)
 
-      os = if l = opts[:limit]
-        "&limit=#{l}"
-      else
-        ''
-      end
-
-      rs = @couch.get("_all_docs?include_docs=true#{os}")
+      rs = @couch.get("_all_docs?include_docs=true#{query_options(opts)}")
 
       rs = rs['rows'].collect { |e| e['doc'] }
 
       rs = rs.select { |doc| doc['_id'].match(key) } if key
         # naive...
 
-      rs
+      rs.select { |doc| ! doc['_id'].match(/^\_design\//) }
     end
 
     # Returns a sorted list of the ids of all the docs in this database.
@@ -126,28 +125,140 @@ module Ruote::Couch
 
       # nothing to do for a index-less database
     end
+
+    # (for now, the only option is :limit)
+    #
+    def query_options (opts)
+
+      if l = opts[:limit]
+        "&limit=#{l}"
+      else
+        ''
+      end
+    end
+
+    def query (uri)
+
+      rs = @couch.get(uri)
+
+      rs['rows'].collect { |e| e['doc'] }
+    end
   end
 
+  #
+  # A Couch database with a by_wfid view.
+  #
   class WfidIndexedDatabase < Database
 
-    #DESIGN_DOC_TEMPLATE = %{
-    #  {
-    #    "_id": "_design/ruote",
-    #    "version": 0,
-    #
-    #    "views": {
-    #      "by_type": {
-    #        "map": "function (doc) { emit(doc.type, doc); }"
-    #      }
-    #    }
-    #  }
-    #}.strip
+    def get_many (key, opts)
+
+      if key && m = key.source.match(/!?(.+)\$$/)
+        # let's use the couch view...
+
+        query(
+          "_design/ruote/_view/by_wfid?key=%22#{m[1]}%22" +
+          "&include_docs=true#{query_options(opts)}")
+
+      else
+        # let's use the naive default implementation
+
+        super
+      end
+    end
 
     protected
 
+    def design_doc
+
+      {
+        '_id' => '_design/ruote',
+        'views' => {
+          'by_wfid' => {
+            'map' =>
+              'function (doc) { if (doc.fei) emit(doc.fei.wfid, null); }'
+          }
+        }
+      }
+    end
+
     def prepare
 
-      # TODO
+      d = @couch.get('_design/ruote')
+      @couch.delete(d) if d
+      @couch.put(design_doc)
+    end
+  end
+
+  #
+  # A Couch database with a by_wfid view and a by_field view.
+  #
+  class WorkitemDatabase < WfidIndexedDatabase
+
+    # This method is called by CouchStorage#by_field
+    #
+    def by_field (field, value=nil, opts={})
+
+      field = { field => value } if value
+      field = CGI.escape(Rufus::Json.encode(field))
+
+      query(
+        "_design/ruote/_view/by_field?key=#{field}" +
+        "&include_docs=true#{query_options(opts)}")
+    end
+
+    # This method is called by CouchStorage#by_participant
+    #
+    def by_participant (name, opts={})
+
+      query(
+        "_design/ruote/_view/by_participant_name?key=%22#{name}%22" +
+        "&include_docs=true#{query_options(opts)}")
+    end
+
+    protected
+
+    def design_doc
+
+      doc = super
+
+      # NOTE : with 'by_field', for a workitem with N fields there are
+      # currently 2 * N rows generated per workitem.
+      #
+      # Why not restrict { field => value } keys to only fields whose value
+      # is a string, a boolean or null ? I have the impression that querying
+      # for field whose value is 'complex' (array or hash) is not necessary
+      # (though sounding crazy useful).
+
+      doc['views']['by_field'] = {
+        'map' => %{
+          function(doc) {
+            if (doc.fields) {
+              for (var field in doc.fields) {
+
+                emit(field, null);
+
+                var k = {};
+                k[field] = doc.fields[field]
+                emit(k, null);
+                  //
+                  // have to use that k trick...
+                  // else the field is named 'field'
+              }
+            }
+          }
+        }
+      }
+      doc['views']['by_participant_name'] = {
+        'map' => %{
+          function (doc) {
+            if (doc.participant_name) {
+              emit(doc.participant_name, null);
+            }
+          }
+        }
+      }
+
+      doc
     end
   end
 end

data/lib/ruote/couch/storage.rb

@@ -55,15 +55,15 @@ module Couch
           @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['errors'] = WfidIndexedDatabase.new(
+        @host, @port, 'errors', "#{@prefix}ruote_errors")
 
       @dbs['expressions'] = WfidIndexedDatabase.new(
         @host, @port, 'expressions', "#{@prefix}ruote_expressions", false)
 
+      @dbs['workitems'] = WorkitemDatabase.new(
+        @host, @port, 'workitems', "#{@prefix}ruote_workitems")
+
       put_configuration
     end
 
@@ -128,6 +128,23 @@ module Couch
       end
     end
 
+    # A provision made for workitems, allow to query them directly by
+    # participant name.
+    #
+    def by_participant (type, participant_name)
+
+      raise NotImplementedError if type != 'workitems'
+
+      @dbs['workitems'].by_participant(participant_name)
+    end
+
+    def by_field (type, field, value=nil)
+
+      raise NotImplementedError if type != 'workitems'
+
+      @dbs['workitems'].by_field(field, value)
+    end
+
     protected
 
     def put_configuration
@@ -138,20 +155,6 @@ module Couch
 
       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

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

data/ruote-couch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote-couch}
-  s.version = "2.1.4"
+  s.version = "2.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-01-11}
+  s.date = %q{2010-01-28}
   s.description = %q{CouchDB storage for ruote 2.1 (ruby workflow engine)}
   s.email = %q{jmettraux@gmail.com}
   s.extra_rdoc_files = [
@@ -52,17 +52,17 @@ 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.4"])
-      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.11"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.5"])
+      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.12"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
-      s.add_dependency(%q<ruote>, [">= 2.1.4"])
-      s.add_dependency(%q<rufus-jig>, [">= 0.1.11"])
+      s.add_dependency(%q<ruote>, [">= 2.1.5"])
+      s.add_dependency(%q<rufus-jig>, [">= 0.1.12"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
-    s.add_dependency(%q<ruote>, [">= 2.1.4"])
-    s.add_dependency(%q<rufus-jig>, [">= 0.1.11"])
+    s.add_dependency(%q<ruote>, [">= 2.1.5"])
+    s.add_dependency(%q<rufus-jig>, [">= 0.1.12"])
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end

data/test/unit/ut_0_initial.rb

@@ -6,16 +6,14 @@
 #
 
 require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
-
-require 'ruote/couch/storage'
+require File.join(File.dirname(__FILE__), '..', 'integration_connection.rb')
 
 
 class UtInitialTest < Test::Unit::TestCase
 
   def test_connect
 
-    storage = Ruote::Couch::CouchStorage.new(
-      '127.0.0.1', 5984, :prefix => 'test')
+    storage = new_storage(nil)
 
     v = storage.get_many('configurations')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-couch
 version: !ruby/object:Gem::Version 
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-11 00:00:00 +09:00
+date: 2010-01-28 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.4
+        version: 2.1.5
     version: 
 - !ruby/object:Gem::Dependency 
   name: rufus-jig
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.11
+        version: 0.1.12
     version: 
 - !ruby/object:Gem::Dependency 
   name: yard