ruote-kit 2.1.11 → 2.2.0.3

data/CHANGELOG.txt

@@ -2,7 +2,12 @@
 = ruote-kit - CHANGELOG.txt
 
 
-== ruote-kit - 2.1.11    not yet released
+== ruote-kit - 2.2.0    not yet released
+
+- Adapted to ruote 2.2.0 : Parser -> Reader (patch by Chris Buben)
+
+
+== ruote-kit - 2.1.11    not released
 
 - RuoteKit.run_worker(storage) will not return (since it will let the worker
   run in the current thread)

data/CREDITS.txt

@@ -0,0 +1,23 @@
+
+= CREDITS
+
+
+== Main project team
+
+- Kenneth Kalmer - http://opensourcery.co.za
+- Torsten Schönebaum - http://www.torstenschoenebaum.de
+- John Mettraux - http://jmettraux.wordpress.com
+
+
+== Contributors
+
+- Chris Buben - https://github.com/cbuben
+- Joeri Samson - https://github.com/joerixaop
+
+
+== Feedback
+
+- Eric Smith (broken 2.2.0.2)
+- Simone Carletti - https://github.com/weppos
+- Nicolai Reuschling - https://github.com/codeblogger
+

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
+Copyright (c) 2009-2011 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,10 +1,7 @@
 
-= ruote-kit (RESTful ruote & middleware)
+= ruote-kit (ruote on rack)
 
-* http://kit.rubyforge.org/ruote (soon)
-* http://kit.rubyforge.org/ruote/rdoc (soon)
-
-A RESTful wrapper around the ruote[http://ruote.rubyforge.org] workflow engine,
+A wrapper around the ruote[http://ruote.rubyforge.org] workflow engine,
 built as a modular sinatra[http://www.sinatrarb.com/] application.
 
 Follow development:
@@ -31,7 +28,7 @@ Have a look at the Gemfile if you want to see the various dependencies.
 === Using the source
 
 * Get the source files using git
-    $ git clone http://github.com/kennethkalmer/ruote-kit.git && cd ruote-kit
+    $ git clone http://github.com/tosch/ruote-kit.git && cd ruote-kit
 * Make sure every dependency is resolved
     $ bundle install
 * Get going
@@ -108,6 +105,46 @@ Example:
 
 === Notes for Rails
 
+ruote-kit ships with an application template for Ruby on Rails 3.
+
+==== Generate a new Rails app using ruote[-kit]
+
+*   install Rails
+        $ gem install rails
+*   create a new Rails app by running
+        $ rails new foo -m http://github.com/tosch/ruote-kit/raw/master/rails-template.rb
+*   cd into the new Rails dir
+        $ cd foo
+*   make sure all dependencies are met
+        $ bundle install
+
+==== Update an existing Rails app to use ruote[-kit]
+
+*   in your Rails dir, apply the app template
+        $ rake rails:template LOCATION=http://github.com/tosch/ruote-kit/raw/master/rails-template.rb
+
+==== Configure your ruote-kit integration
+
+See config/initializers/ruote-kit.rb in your Rails app.
+
+==== Run
+
+    $ rails server
+
+Browse to http://localhost:3000/_ruote and you'll see there are no running
+processes. You could change that using the "Launch process" link ;-)
+
+==== Using Ruote from within Rails
+
+You can access Ruote's engine anywhere in your Rails code by calling
+    RuoteKit.engine
+So launching a workflow process is as easy as
+    RuoteKit.engine.launch your_process_definition
+The storage participant (used by the catchall participant) is available at
+    RuoteKit.storage_participant
+
+==== Example application
+
 See http://github.com/tosch/ruote-on-rails for an example Rails app.
 
 == Configuring ruote-kit & ruote
@@ -242,7 +279,7 @@ Please do not hesitate to come back with *any* feedback.
 
 (The MIT License)
 
-Copyright (c) 2009-2010 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
+Copyright (c) 2009-2011 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,55 +1,88 @@
 
-require 'rake/tasklib'
-
-require "rubygems"
-require "bundler"
-Bundler.setup(:default, :test, :build)
-
-require File.join(File.dirname(__FILE__), 'lib/ruote-kit/version')
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = 'ruote-kit'
-    gemspec.version = RuoteKit::VERSION
-    gemspec.summary = 'ruote workflow engine, wrapped in a loving rack embrace'
-    gemspec.description = 'ruote-kit is a RESTful Rack app for the ruote workflow engine'
-    gemspec.email = 'kenneth.kalmer@gmail.com'
-    gemspec.homepage = 'http://github.com/tosch/ruote-kit'
-    gemspec.authors = [ 'kenneth.kalmer@gmail.com', 'Torsten Schoenebaum', 'John Mettraux' ]
-    gemspec.extra_rdoc_files.include '*.txt'
-
-    gemspec.files.include 'lib/ruote-kit/public/**/*'
-    gemspec.executables.clear
-
-    gemspec.add_bundler_dependencies
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with 'gem install jeweler'"
+$:.unshift('.') # 1.9.2
+
+require 'rubygems'
+require 'rubygems/user_interaction' if Gem::RubyGemsVersion == '1.5.0'
+
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+
+
+#
+# clean
+
+CLEAN.include('pkg', 'rdoc')
+
+
+#
+# test / spec
+
+task :spec do
+
+  #sh 'rspec spec/'
+  sh 'bundle exec rspec spec/'
+end
+
+task :test => :spec
+task :default => :spec
+
+
+#
+# gem
+
+GEMSPEC_FILE = Dir['*.gemspec'].first
+GEMSPEC = eval(File.read(GEMSPEC_FILE))
+GEMSPEC.validate
+
+
+desc %{
+  builds the gem and places it in pkg/
+}
+task :build do
+
+  sh "gem build #{GEMSPEC_FILE}"
+  sh "mkdir pkg" rescue nil
+  sh "mv #{GEMSPEC.name}-#{GEMSPEC.version}.gem pkg/"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+desc %{
+  builds the gem and pushes it to rubygems.org
+}
+task :push => :build do
+
+  sh "gem push pkg/#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+
+#
+# rdoc
+#
+# make sure to have rdoc 2.5.x to run that
+
+Rake::RDocTask.new do |rd|
+
+  rd.main = 'README.rdoc'
+  rd.rdoc_dir = 'rdoc'
+
+  rd.rdoc_files.include(
+    'README.rdoc', 'CHANGELOG.txt', 'CREDITS.txt', 'lib/**/*.rb')
+
+  rd.title = "#{GEMSPEC.name} #{GEMSPEC.version}"
 end
 
-task :spec #=> :check_dependencies
 
-task :default => :spec
+#
+# upload_rdoc
 
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
+desc %{
+  upload the rdoc to rubyforge
+}
+task :upload_rdoc => [ :clean, :rdoc ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/ruote'
+
+  sh "rsync -azv -e ssh rdoc/#{GEMSPEC.name}_rdoc #{account}:#{webdir}/"
 end
+

data/TODO.txt

@@ -9,4 +9,12 @@
 [ ] expression : re_apply OK but reply too
 
 [ ] If-Match etag
+[ ] JSON pretty encode output mode (only necessary with CURL and co)
+
+[ ] relative paths : http://groups.google.com/group/rack-devel/browse_thread/thread/32312e78f42351f0
+
+[ ] application/vnd.ruote.lambda.io+json;type=xxx
+
+[ ] update rspec
+[ ] write ruote-kit.gemspec manually
 

data/lib/ruote-kit/helpers/json_helpers.rb

@@ -147,7 +147,7 @@ module RuoteKit
           result << hlink(resource.to_s, :rel => 'all')
 
           lim = @limit || settings.limit
-          las = (@count / lim) * lim
+          las = (@count / lim) * lim rescue 0
           pre = [ 0, @skip - lim ].max
           nex = [ @skip + lim, las ].min
 

data/lib/ruote-kit/helpers/misc_helpers.rb

@@ -27,7 +27,7 @@ end
 
       def sample_process_tree
 
-        Rufus::Json.encode(Ruote::Parser.parse(sample_process))
+        Rufus::Json.encode(Ruote::Reader.read(sample_process))
       end
     end
   end

data/lib/ruote-kit/helpers/render_helpers.rb

@@ -26,7 +26,8 @@ module RuoteKit
       #
       HTTP_CODES = {
         400 => 'bad request',
-        404 => 'resource not found'
+        404 => 'resource not found',
+        412 => 'precondition failed'
       }
 
       # HTTP errors
@@ -58,6 +59,22 @@ module RuoteKit
         end
       end
 
+      # http error 412 if if-match header is set to an etag different to the
+      # value given
+      #
+      def check_if_match_etag(value)
+        value = '"%s"' % value
+
+        if etags = request.env['HTTP_IF_MATCH']
+          etags = etags.split(/\s*,\s*/)
+
+          unless etags.include?(value) || etags.include?('*')
+            http_error(412)
+            halt
+          end
+        end
+      end
+
       # Extract the process tree
       #
       def process_tree(object)

data/lib/ruote-kit/public/_ruote/stylesheets/ruote-fluo-editor.css

@@ -1,6 +1,6 @@
 
 #fluo_editor {
-  font: 14px/1.5em monaco, mono;
+  font: 14px/1.4em monaco, mono;
   text-align: left;
   color: #000;
   border: 1px solid #c1c1c1;

data/lib/ruote-kit/resources/expressions.rb

@@ -13,6 +13,8 @@ class RuoteKit::Application
 
       return http_error(404) unless @expression
 
+      etag @expression.to_h['_rev']
+
       respond_with :expression
     else
 
@@ -26,6 +28,8 @@ class RuoteKit::Application
 
     return http_error(404) unless expression
 
+    check_if_match_etag(expression.to_h['_rev'])
+
     if params[:_kill]
       RuoteKit.engine.kill_expression(expression.fei)
     else
@@ -44,6 +48,8 @@ class RuoteKit::Application
 
     return http_error(404) unless expression
 
+    check_if_match_etag(expression.to_h['_rev'])
+
     info = begin
       fetch_re_apply_info
     rescue Rufus::Json::ParserError => pe

data/lib/ruote-kit/resources/participants.rb

@@ -36,7 +36,9 @@ class RuoteKit::Application
       end
     end
 
-    RuoteKit.engine.participant_list = list
+    unless list.empty?
+      RuoteKit.engine.participant_list = list
+    end
 
     respond_to do |format|
 

data/lib/ruote-kit/resources/schedules.rb

@@ -5,7 +5,7 @@ class RuoteKit::Application
 
   get '/_ruote/schedules/?' do
 
-    @count = RuoteKit.engine.processes(:count => true)
+    @count = RuoteKit.engine.schedules(:count => true)
     paginate
 
     @schedules = RuoteKit.engine.schedules(:skip => @skip, :limit => @limit)

data/lib/ruote-kit/resources/workitems.rb

@@ -34,6 +34,8 @@ class RuoteKit::Application
     return http_error(404) if @workitem.nil? && @workitems.nil?
 
     if @workitem
+      etag @workitem.to_h['_rev']
+
       respond_with :workitem
     else
       respond_with :workitems
@@ -46,6 +48,8 @@ class RuoteKit::Application
 
     return http_error(404) unless @workitem
 
+    check_if_match_etag(@workitem.to_h['_rev'])
+
     options = begin
       field_updates_and_proceed_from_put
     rescue Rufus::Json::ParserError => pe

data/lib/ruote-kit/version.rb

@@ -8,6 +8,6 @@
 
 module RuoteKit
 
-  VERSION = '2.1.11'
+  VERSION = '2.2.0'
 end
 

data/lib/ruote-kit/views/expression.html.haml

@@ -41,7 +41,7 @@
         %td
           original tree
         %td
-          - ruby = Ruote::Parser.to_ruby(@expression.original_tree)
+          - ruby = Ruote::Reader.to_ruby(@expression.original_tree)
           - rubyline = ruby.split("\n").first
           - json = Rufus::Json.pretty_encode(@expression.original_tree)
           %pre.pdef{ :onclick => 'Rk.toggleNext(this);' } #{rubyline}
@@ -51,7 +51,7 @@
       %td
         tree
       %td
-        - ruby = Ruote::Parser.to_ruby(@expression.tree)
+        - ruby = Ruote::Reader.to_ruby(@expression.tree)
         - rubyline = ruby.split("\n").first
         - json = Rufus::Json.pretty_encode(@expression.tree)
         %pre.pdef{ :onclick => 'Rk.toggleNext(this);' } #{rubyline}

data/lib/ruote-kit/views/layout.html.haml

@@ -54,7 +54,7 @@
 
       #footer
         %div
-          © 2009-2010 Kenneth Kalmer
+          © 2009-2011 Kenneth Kalmer
           |
           %a{ :href => 'http://www.opensourcery.co.za' } blog
           |

data/lib/ruote-kit/views/participants.html.haml

@@ -15,28 +15,29 @@
 
   %table.participants
     %thead
-      %td
-        regex
-      %td
-        classname
-      %td
-        options
-      %td
-         
-
-    - @participants.each_with_index do |pa, i|
       %tr
         %td
-          %input.participant{ :type => :text, :value => pa.regex }
+          regex
         %td
-          %input.participant{ :type => :text, :style => 'width: 350px;', :value => pa.classname }
+          classname
         %td
-          %input.participant{ :type => :text, :style => 'width: 350px;', :value => Rufus::Json.encode(pa.options) }
+          options
         %td
-          %a.ruote_button.ruote_minus_button{ :title => 'remove', :href => '', :onclick => 'remove(this); return false;' }
-          %a.ruote_button.ruote_up_button{ :title => 'move up', :href => '', :onclick => 'move(this, "up"); return false;' }
-          %a.ruote_button.ruote_down_button{ :title => 'move down', :href => '', :onclick => 'move(this, "down"); return false;' }
-          %a.ruote_button.ruote_copy_button{ :title => 'copy', :href => '', :onclick => 'copy(this); return false;' }
+           
+    %tbody
+      - @participants.each_with_index do |pa, i|
+        %tr
+          %td
+            %input.participant{ :type => :text, :value => pa.regex }
+          %td
+            %input.participant{ :type => :text, :style => 'width: 350px;', :value => pa.classname }
+          %td
+            %input.participant{ :type => :text, :style => 'width: 350px;', :value => Rufus::Json.encode(pa.options) }
+          %td
+            %a.ruote_button.ruote_minus_button{ :title => 'remove', :href => '', :onclick => 'remove(this); return false;' }
+            %a.ruote_button.ruote_up_button{ :title => 'move up', :href => '', :onclick => 'move(this, "up"); return false;' }
+            %a.ruote_button.ruote_down_button{ :title => 'move down', :href => '', :onclick => 'move(this, "down"); return false;' }
+            %a.ruote_button.ruote_copy_button{ :title => 'copy', :href => '', :onclick => 'copy(this); return false;' }
 
   %input#put_button{ :type => 'submit', :value => 'PUT /_ruote/participants', :onclick => 'nameInputs(); return true;' }
 
@@ -44,7 +45,7 @@
 :javascript
 
   function nameInputs () {
-    $('tr').each(function (index) {
+    $('tbody tr').each(function (index) {
       var inputs = $(this).children('td').map(function () {
         return $(this).children('input')[0];
       });

data/lib/ruote-kit.rb

@@ -21,16 +21,26 @@ module RuoteKit
       @env ||= defined?(Rails) ? Rails.env : ENV['RACK_ENV'] || 'development'
     end
 
+    # Returns the storage participant associated automatically with any storage
+    #
     def storage_participant
       engine.storage_participant
     end
 
-    def run_worker (storage)
+    # Given a storage, runs a worker and sets RuoteKit.engine accordingly.
+    #
+    # By default, this method won't return (it will 'join' the worker). If you
+    # need to go on after this call, pass false as second parameter
+    # (especially useful in an EventMachine setting).
+    #
+    def run_worker(storage, join=true)
       RuoteKit.engine = Ruote::Engine.new(
-        Ruote::Worker.new(storage), :join => true)
+        Ruote::Worker.new(storage), :join => join)
     end
 
-    def bind_engine (storage)
+    # Uses the given storage for the RuoteKit.engine (no worker running here).
+    #
+    def bind_engine(storage)
       RuoteKit.engine = Ruote::Engine.new(storage)
     end
   end