ruote-dm 2.1.9 → 2.1.10

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = ruote-dm - CHANGELOG.txt
 
 
+== ruote-dm 2.1.10    released 2010/06/15
+
+- :ide key, :length => 255 for MySQL (thanks irfn)
+- _rev now starting at 1 (instead of 0)
+
+
 == ruote-dm 2.1.9    released 2010/03/24
 
 - storage participant queries with more than 1 field are now possible

data/CREDITS.txt

@@ -9,11 +9,12 @@
 
 == contributors
 
+- irfn (debugging on MySQL)
 - asm (many bug reports)
 - Kenneth Kalmer (http://www.opensourcery.co.za/)
 
 
 == many thanks to
 
-- the DataMapper team
+- the DataMapper authors and contributors
 

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2001-2009, John Mettraux, jmettraux@gmail.com
+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

data/README.rdoc

@@ -6,7 +6,29 @@ ruote 2.1 extension for DataMapper (dm) persistence
 
 == usage
 
-well...
+This is how a ruote engine is setup with a ruote-dm storage (postgres) and a worker :
+
+  require 'rubygems'
+  require 'json' # gem install json
+  require 'ruote'
+  require 'ruote-dm' # gem install ruote-dm
+  
+  #DataMapper.setup(:default, 'sqlite3::memory:')
+  #DataMapper.setup(:default, 'sqlite3:ruote_test.db')
+  DataMapper.setup(:default, 'postgres://localhost/ruote_test')
+  
+  engine = Ruote::Engine.new(
+    Ruote::Worker.new(
+      Ruote::Dm::DmStorage.new(:default)))
+
+  # ...
+
+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.
 
 
 == running tests

data/TODO.txt

@@ -1,9 +1,15 @@
 
 [o] [test/functional/ft_20_storage_participant.rb:176]: <1> expected but was <4>
     not on ruby 1.9.1, but on ruby 1.8.7p72
+[o] msgs / schedules : simplify like ruote-redis did
+[o] `--> init _rev at 1 (like ruote-redis)
+[o] `--> then investigate ct_X weaknesses (transactions ?)
+[o] `--> then investigate ct_X weaknesses
 
 [ ] storage : control #save result
 [ ] examine indices (index) (participant_name ?) perf perf perf
 
-[ ] investigate ct_0_ weakness
+[ ] write example on how to use active-record to "read" workitems
+
+[ ] crunner.sh 2 weakness
 

data/lib/ruote/dm/storage.rb

@@ -30,20 +30,44 @@ require 'ruote/dm/version'
 module Ruote
 module Dm
 
+  #
+  # All the ruote data is stored in a single ruote_dm_document table.
+  #
+  # The doc/data itself is stored in the 'doc' column, as JSON.
+  #
+  # Yajl-ruby is recommended for fast {de|en}coding with JSON.
+  #
   class Document
     include DataMapper::Resource
 
-    property :ide, String, :key => true, :length => 2048, :required => true
+    property :ide, String, :key => true, :length => 255, :required => true
     property :rev, Integer, :key => true, :required => true
     property :typ, String, :key => true, :required => true
     property :doc, Text, :length => 2**32 - 1, :required => true, :lazy => false
 
     property :participant_name, String, :length => 512
+
+    def to_h
+      Rufus::Json.decode(doc)
+    end
   end
 
   #
   # A datamapper-powered storage for ruote.
   #
+  #   require 'rubygems'
+  #   require 'json' # gem install json
+  #   require 'ruote'
+  #   require 'ruote-dm' # gem install ruote-dm
+  #
+  #   #DataMapper.setup(:default, 'sqlite3::memory:')
+  #   #DataMapper.setup(:default, 'sqlite3:ruote_test.db')
+  #   DataMapper.setup(:default, 'postgres://localhost/ruote_test')
+  #
+  #   engine = Ruote::Engine.new(
+  #     Ruote::Worker.new(
+  #       Ruote::Dm::DmStorage.new(:default)))
+  #
   class DmStorage
 
     include Ruote::StorageBase
@@ -58,48 +82,72 @@ module Dm
       put_configuration
     end
 
+    def put_msg (action, options)
+
+      # put_msg is a unique action, no need for all the complexity of put
+
+      DataMapper.repository(@repository) do
+
+        doc = prepare_msg_doc(action, options)
+
+        insert(doc, 1)
+      end
+
+      nil
+    end
+
+    def put_schedule (flavour, owner_fei, s, msg)
+
+      # put_schedule is a unique action, no need for all the complexity of put
+
+      doc = prepare_schedule_doc(flavour, owner_fei, s, msg)
+
+      return nil unless doc
+
+      DataMapper.repository(@repository) do
+
+        insert(doc, 1)
+
+        doc['_id']
+      end
+    end
+
     def put (doc, opts={})
 
       DataMapper.repository(@repository) do
 
-        d = Document.first(:ide => doc['_id'], :typ => doc['type'])
+        current = do_get(doc['type'], doc['_id'])
 
-        return Rufus::Json.decode(d.doc) if d && d.rev != doc['_rev']
+        rev = doc['_rev'].to_i
 
-        if doc['_rev'].nil?
+        return true if current.nil? && rev > 0
+        return current.to_h if current && rev != current.rev
 
-          d = Document.new(
-            :ide => doc['_id'],
-            :rev => 0,
-            :typ => doc['type'],
-            :doc => Rufus::Json.encode(doc.merge(
-              '_rev' => 0, 'put_at' => Ruote.now_to_utc_s)),
-            :participant_name => doc['participant_name']
-          ).save
+        nrev = rev + 1
 
-          doc['_rev'] = 0 if opts[:update_rev]
+        begin
 
-        else
+          insert(doc, nrev)
+
+          current.destroy! if current
 
-          return true unless d
+          doc['_rev'] = nrev if opts[:update_rev]
 
-          d.rev = d.rev + 1
-          d.doc = Rufus::Json.encode(doc.merge(
-            '_rev' => d.rev, 'put_at' => Ruote.now_to_utc_s))
-          d.save
+          return nil
 
-          doc['_rev'] = d.rev if opts[:update_rev]
+        rescue DataObjects::IntegrityError => ie
+          #p :clash
         end
 
-        nil
+        get(doc['type'], doc['_id'])
       end
     end
 
     def get (type, key)
 
       DataMapper.repository(@repository) do
-        d = Document.first(:typ => type, :ide => key)
-        d ? Rufus::Json.decode(d.doc) : nil
+        d = do_get(type, key)
+        d ? d.to_h : nil
       end
     end
 
@@ -109,14 +157,17 @@ module Dm
 
       DataMapper.repository(@repository) do
 
-        d = Document.first(
-          :typ => doc['type'], :ide => doc['_id'], :rev => doc['_rev'])
+        r = put(doc)
+
+        #p [ 0, true, doc['_id'], Thread.current.object_id.to_s[-3..-1] ] if r
 
-        return true unless d
+        return true unless r.nil?
 
-        d.destroy!
+        r = Document.all(:typ => doc['type'], :ide => doc['_id']).destroy!
 
-        nil
+        #p [ 1, r ? nil : true, doc['_id'], Thread.current.object_id.to_s[-3..-1] ]
+
+        r ? nil : true
       end
     end
 
@@ -139,7 +190,7 @@ module Dm
       end
 
       DataMapper.repository(@repository) do
-        Document.all(q).collect { |d| Rufus::Json.decode(d.doc) }
+        Document.all(q).collect { |d| d.to_h }
       end
     end
 
@@ -157,9 +208,15 @@ module Dm
       end
     end
 
-    #def dump (type)
-    #  @dbs[type].dump
-    #end
+    def dump (type)
+
+      s = "=== #{type} ===\n"
+
+      get_many(type).inject(s) do |s1, h|
+        s1 << "  #{Ruote::FlowExpressionId.to_storage_id(h['fei'])}"
+        s1 << " => #{h['original_tree'].first} #{h['_rev']}\n"
+      end
+    end
 
     def shutdown
 
@@ -192,7 +249,7 @@ module Dm
       Document.all(
         :typ => type, :participant_name => participant_name
       ).collect { |d|
-        Rufus::Json.decode(d.doc)
+        d.to_h
       }
     end
 
@@ -206,9 +263,7 @@ module Dm
       like.push(Rufus::Json.encode(value)) if value
       like.push('%')
 
-      Document.all(:typ => type, :doc.like => like.join).collect { |d|
-        Rufus::Json.decode(d.doc)
-      }
+      Document.all(:typ => type, :doc.like => like.join).collect { |d| d.to_h }
     end
 
     def query_workitems (criteria)
@@ -235,13 +290,29 @@ module Dm
         ([ 'doc LIKE ?' ] * likes.size).join(' AND '), *likes
       ] unless likes.empty?
 
-      Document.all(cr).collect { |d|
-        Ruote::Workitem.new(Rufus::Json.decode(d.doc))
-      }
+      Document.all(cr).collect { |d| d.to_h }
     end
 
     protected
 
+    def insert (doc, rev)
+
+      Document.new(
+        :ide => doc['_id'],
+        :rev => rev,
+        :typ => doc['type'],
+        :doc => Rufus::Json.encode(doc.merge(
+          '_rev' => rev,
+          'put_at' => Ruote.now_to_utc_s)),
+        :participant_name => doc['participant_name']
+      ).save!
+    end
+
+    def do_get (type, key)
+
+      Document.first(:typ => type, :ide => key, :order => :rev.desc)
+    end
+
     # Don't put configuration if it's already in
     #
     # (avoid storages from trashing configuration...)

data/lib/ruote/dm/version.rb

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

data/lib/ruote/dm.rb

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

data/ruote-dm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote-dm}
-  s.version = "2.1.9"
+  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-03-24}
+  s.date = %q{2010-06-15}
   s.description = %q{datamapper storage for ruote (a ruby workflow engine)}
   s.email = %q{jmettraux@gmail.com}
   s.extra_rdoc_files = [
@@ -24,17 +24,18 @@ Gem::Specification.new do |s|
      "Rakefile",
      "TODO.txt",
      "lib/ruote-dm.rb",
+     "lib/ruote/dm.rb",
      "lib/ruote/dm/storage.rb",
      "lib/ruote/dm/version.rb",
      "ruote-dm.gemspec",
-     "test/integration_connection.rb",
+     "test/functional_connection.rb",
      "test/test.rb"
   ]
   s.homepage = %q{http://github.com/jmettraux/ruote-dm}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruote}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{datamapper storage for ruote (a ruby workflow engine)}
   s.test_files = [
     "test/test.rb"
@@ -45,20 +46,20 @@ 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.9"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.10"])
       s.add_runtime_dependency(%q<dm-core>, [">= 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.9"])
+      s.add_dependency(%q<ruote>, [">= 2.1.10"])
       s.add_dependency(%q<dm-core>, [">= 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.9"])
+    s.add_dependency(%q<ruote>, [">= 2.1.10"])
     s.add_dependency(%q<dm-core>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])

data/test/{integration_connection.rb → functional_connection.rb}

@@ -23,7 +23,7 @@ DataMapper.setup(:default, 'postgres://localhost/ruote_test')
 #DataMapper.setup(:default, 'sqlite3:ruote_test.db')
 
 #DataMapper.repository(:default) do
-#  Ruote::Dm::Document.all.destroy!
+#  Ruote::Dm::Document.all.destroy! rescue nil
 #  Ruote::Dm::Document.auto_upgrade!
 #end
 

metadata

@@ -1,12 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-dm
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 2
-  - 1
-  - 9
-  version: 2.1.9
+  version: 2.1.10
 platform: ruby
 authors: 
 - John Mettraux
@@ -14,71 +9,59 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-24 00:00:00 +09:00
+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 
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 9
-        version: 2.1.9
-  type: :runtime
-  version_requirements: *id001
+        version: 2.1.10
+    version: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id002
+    version: 
 - !ruby/object:Gem::Dependency 
   name: yard
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
-  version_requirements: *id003
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
-  version_requirements: *id004
+    version: 
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
-  version_requirements: *id005
+    version: 
 description: datamapper storage for ruote (a ruby workflow engine)
 email: jmettraux@gmail.com
 executables: []
@@ -96,10 +79,11 @@ files:
 - Rakefile
 - TODO.txt
 - lib/ruote-dm.rb
+- lib/ruote/dm.rb
 - lib/ruote/dm/storage.rb
 - lib/ruote/dm/version.rb
 - ruote-dm.gemspec
-- test/integration_connection.rb
+- test/functional_connection.rb
 - test/test.rb
 has_rdoc: true
 homepage: http://github.com/jmettraux/ruote-dm
@@ -114,20 +98,18 @@ 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.6
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: datamapper storage for ruote (a ruby workflow engine)