ruote-dm 2.1.10 → 2.1.11

data/CHANGELOG.txt

@@ -2,8 +2,19 @@
 = ruote-dm - CHANGELOG.txt
 
 
+== ruote-dm 2.1.11    released 2010/10/01
+
+- get_many(x, y, descending => true)
+- adapted for engines.processes pagination
+- ! added 'wfi' column to Document table
+- workitems.by_participant() :skip and :limit support
+- get_many(x, y, :skip => 10) support
+- get_many(x, y, :count => true) support
+
+
 == ruote-dm 2.1.10    released 2010/06/15
 
+- multi-workers hardened
 - :ide key, :length => 255 for MySQL (thanks irfn)
 - _rev now starting at 1 (instead of 0)
 

data/CREDITS.txt

@@ -3,15 +3,16 @@
 
 == authors
 
-- John Mettraux  http://jmettraux.wordpress.com
-- Jordan Ritter (http://github.com/jpr5)
+- John Mettraux - http://github.com/jmettraux
+- Jordan Ritter - http://github.com/jpr5
 
 
 == contributors
 
-- irfn (debugging on MySQL)
-- asm (many bug reports)
-- Kenneth Kalmer (http://www.opensourcery.co.za/)
+- Torsten Schoenebaum - http://github.com/tosch
+- Irfan (debugging on MySQL) - http://github.com/irfn
+- asm (many bug reports) - http://github.com/asm
+- Kenneth Kalmer - (http://www.opensourcery.co.za/)
 
 
 == many thanks to

data/README.rdoc

@@ -28,7 +28,7 @@ To create the tables in the database :
   Ruote::Dm::Document.auto_migrate!
 
 
-Tested with dm 0.9.2 and dm 1.0.0, with the postgresql and the msyql adapters.
+Tested with dm 1.0.2, with the postgresql and the msyql adapters.
 
 
 == running tests
@@ -42,13 +42,18 @@ assuming you have
 
 get into ruote/ and do
 
-  ruby test/unit/storage.rb --dm
+  ruby test/unit/storage.rb -- --dm
 
 * functional tests :
 
 get into ruote/ and do
 
-  ruby test/functional/test.rb --dm
+  ruby test/functional/test.rb -- --dm
+
+
+== known issues
+
+It works well on OSX, but test/functional/ct_2_cancel.rb is failing. Since OSX isn't a often met server platform, we haven't investigated further.
 
 
 == license

data/Rakefile

@@ -34,6 +34,7 @@ datamapper storage for ruote (a ruby workflow engine)
 
   gem.add_dependency 'ruote', ">= #{Ruote::Dm::VERSION}"
   gem.add_dependency 'dm-core'
+  gem.add_dependency 'dm-migrations'
   #gem.add_dependency 'dm-aggregates'
   #gem.add_dependency 'dm-types'
   gem.add_development_dependency 'yard'
@@ -48,33 +49,30 @@ Jeweler::GemcutterTasks.new
 #
 # DOC
 
-begin
-
-  require 'yard'
+#
+# make sure to have rdoc 2.5.x to run that
+#
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rd|
 
-  YARD::Rake::YardocTask.new do |doc|
-    doc.options = [
-      '-o', 'html/ruote-dm', '--title',
-      "ruote-dm #{Ruote::Dm::VERSION}"
-    ]
-  end
+  rd.main = 'README.rdoc'
+  rd.rdoc_dir = 'rdoc/ruote-dm_rdoc'
 
-rescue LoadError
+  rd.rdoc_files.include(
+    'README.rdoc', 'CHANGELOG.txt', 'CREDITS.txt', 'lib/**/*.rb')
 
-  task :yard do
-    abort "YARD is not available : sudo gem install yard"
-  end
+  rd.title = "ruote-dm #{Ruote::Dm::VERSION}"
 end
 
 
 #
 # TO THE WEB
 
-task :upload_website => [ :clean, :yard ] do
+task :upload_rdoc => [ :clean, :rdoc ] do
 
   account = 'jmettraux@rubyforge.org'
   webdir = '/var/www/gforge-projects/ruote'
 
-  sh "rsync -azv -e ssh html/ruote-dm #{account}:#{webdir}/"
+  sh "rsync -azv -e ssh rdoc/ruote-dm_rdoc #{account}:#{webdir}/"
 end
 

data/TODO.txt

@@ -5,11 +5,12 @@
 [o] `--> init _rev at 1 (like ruote-redis)
 [o] `--> then investigate ct_X weaknesses (transactions ?)
 [o] `--> then investigate ct_X weaknesses
+[x] storage.close
 
 [ ] storage : control #save result
 [ ] examine indices (index) (participant_name ?) perf perf perf
 
 [ ] write example on how to use active-record to "read" workitems
 
-[ ] crunner.sh 2 weakness
+[x] crunner.sh 2 weakness... only weak on OSX
 

data/lib/ruote/dm/storage.rb

@@ -45,6 +45,7 @@ module Dm
     property :typ, String, :key => true, :required => true
     property :doc, Text, :length => 2**32 - 1, :required => true, :lazy => false
 
+    property :wfid, String, :index => true
     property :participant_name, String, :length => 512
 
     def to_h
@@ -175,22 +176,23 @@ module Dm
 
       q = { :typ => type }
 
-      if l = opts[:limit]
-        q[:limit] = l
-      end
+      if l = opts[:limit]; q[:limit] = l; end
+      if s = opts[:skip]; q[:offset] = s; end
 
-      if key
-        q[:ide.like] = if m = key.source.match(/(.+)\$$/)
-          "%#{m[1]}"
-        elsif m = key.source.match(/^\^(.+)/)
-          "#{m[1]}%"
-        else
-          "%#{key.source}%"
-        end
-      end
+      keys = key ? Array(key) : nil
+      q[:wfid] = keys if keys && keys.first.is_a?(String)
 
       DataMapper.repository(@repository) do
-        Document.all(q).collect { |d| d.to_h }
+
+        return Document.all(q).count if opts[:count]
+
+        docs = Document.all(q)
+        docs = docs.reverse if opts[:descending]
+        docs = docs.collect { |d| d.to_h }
+
+        keys && keys.first.is_a?(Regexp) ?
+          docs.select { |doc| keys.find { |key| key.match(doc['_id']) } } :
+          docs
       end
     end
 
@@ -242,15 +244,15 @@ module Dm
     # A provision made for workitems, allow to query them directly by
     # participant name.
     #
-    def by_participant (type, participant_name)
+    def by_participant (type, participant_name, opts)
 
       raise NotImplementedError if type != 'workitems'
 
-      Document.all(
+      query = {
         :typ => type, :participant_name => participant_name
-      ).collect { |d|
-        d.to_h
-      }
+      }.merge(opts)
+
+      Document.all(query).collect { |d| d.to_h }
     end
 
     # Querying workitems by field (warning, goes deep into the JSON structure)
@@ -268,6 +270,10 @@ module Dm
 
     def query_workitems (criteria)
 
+      cr = { :typ => 'workitems' }
+
+      return Document.all(cr).count if criteria['count']
+
       offset = criteria.delete('offset')
       limit = criteria.delete('limit')
 
@@ -276,8 +282,6 @@ module Dm
       pname =
         criteria.delete('participant_name') || criteria.delete('participant')
 
-      cr = { :typ => 'workitems' }
-
       cr[:ide.like] = "%!#{wfid}" if wfid
       cr[:offset] = offset if offset
       cr[:limit] = limit if limit
@@ -290,7 +294,7 @@ module Dm
         ([ 'doc LIKE ?' ] * likes.size).join(' AND '), *likes
       ] unless likes.empty?
 
-      Document.all(cr).collect { |d| d.to_h }
+      Document.all(cr).collect { |d| Ruote::Workitem.new(d.to_h) }
     end
 
     protected
@@ -304,10 +308,16 @@ module Dm
         :doc => Rufus::Json.encode(doc.merge(
           '_rev' => rev,
           'put_at' => Ruote.now_to_utc_s)),
+        :wfid => extract_wfid(doc),
         :participant_name => doc['participant_name']
       ).save!
     end
 
+    def extract_wfid (doc)
+
+      doc['wfid'] || (doc['fei'] ? doc['fei']['wfid'] : nil)
+    end
+
     def do_get (type, key)
 
       Document.first(:typ => type, :ide => key, :order => :rev.desc)

data/lib/ruote/dm/version.rb

@@ -1,7 +1,7 @@
 
 module Ruote
 module Dm
-  VERSION = '2.1.10'
+  VERSION = '2.1.11'
 end
 end
 

data/ruote-dm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote-dm}
-  s.version = "2.1.10"
+  s.version = "2.1.11"
 
   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.date = %q{2010-10-01}
   s.description = %q{datamapper storage for ruote (a ruby workflow engine)}
   s.email = %q{jmettraux@gmail.com}
   s.extra_rdoc_files = [
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruote}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{datamapper storage for ruote (a ruby workflow engine)}
   s.test_files = [
     "test/test.rb"
@@ -46,21 +46,24 @@ 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.10"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.11"])
       s.add_runtime_dependency(%q<dm-core>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-migrations>, [">= 0"])
       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<ruote>, [">= 2.1.11"])
       s.add_dependency(%q<dm-core>, [">= 0"])
+      s.add_dependency(%q<dm-migrations>, [">= 0"])
       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<ruote>, [">= 2.1.11"])
     s.add_dependency(%q<dm-core>, [">= 0"])
+    s.add_dependency(%q<dm-migrations>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/test/functional_connection.rb

@@ -19,10 +19,12 @@ elsif ARGV.include?('-ls') || ARGV.include?('--ls')
 end
 
 DataMapper.setup(:default, 'postgres://localhost/ruote_test')
+#DataMapper.setup(:default, 'mysql://root:root@localhost/ruote_test')
 #DataMapper.setup(:default, 'sqlite3::memory:')
 #DataMapper.setup(:default, 'sqlite3:ruote_test.db')
 
 #DataMapper.repository(:default) do
+#  require 'dm-migrations' # gem install dm-migrations
 #  Ruote::Dm::Document.all.destroy! rescue nil
 #  Ruote::Dm::Document.auto_upgrade!
 #end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-dm
 version: !ruby/object:Gem::Version 
-  version: 2.1.10
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 11
+  version: 2.1.11
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,59 +14,83 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 +09:00
+date: 2010-10-01 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruote
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.10
-    version: 
+        segments: 
+        - 2
+        - 1
+        - 11
+        version: 2.1.11
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: dm-core
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: dm-migrations
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rake
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id006
 description: datamapper storage for ruote (a ruby workflow engine)
 email: jmettraux@gmail.com
 executables: []
@@ -98,18 +127,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ruote
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: datamapper storage for ruote (a ruby workflow engine)