ruote-library 1.0.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+Gemfile.lock
+ruote_work/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruote-library.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Hartog C. de Mik
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# ruote-library
+
+A process library for Ruote
+
+## Usage
+
+```ruby
+require 'ruote-library'
+
+library = Ruote::ProcessLibrary.new("/path/to/processes")
+radial_pdef = library.fetch "some_process"
+
+dashboard.launch(radial_pdef, workitem, vars)
+```
+
+## Contributing
+
+Contributions are most welcome - please follow this convention:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ruote-library.rb

@@ -0,0 +1,120 @@
+require 'singleton'
+require 'strscan'
+require 'ruote/reader'
+
+module Ruote
+  # A keeper of books^W processes
+  #
+  # === Usage
+  #   lib = ProcessLibrary.new("/path/to/processes")
+  #   pdef_radial = lib.fetch('process_name')
+  #
+  class ProcessLibrary
+    class ProcessNotFound < RuntimeError; end
+
+    # @param [String] root The path to the process library on disk.
+    def initialize(root)
+      @root = root
+    end
+
+    # Fetch a process definition from the library. Possible making it more
+    # complete
+    #
+    # === Fetching referenced
+    #
+    # Imagine you have these files:
+    #   > cat process_one.radial
+    #   define process_one
+    #     do_something
+    #     subprocess ref: process_two
+    #
+    #   > cat process_two.radial
+    #   define process_two
+    #     do_something_spectacular
+    #     subprocess 'funny/three'
+    #
+    #   > cat funny/three.radial
+    #   define 'funny/three'
+    #     be_funny
+    #
+    # When you do ProcessLibrary.fetch("process_one") you will receive:
+    #
+    #   define process_one
+    #     do_something
+    #     subprocess ref: process_two
+    #
+    #     define process_two
+    #       do_something_spectacular
+    #       subprocess funny/three
+    #
+    #     define funny/three
+    #       be_funny
+    #
+    # In other words: fetch() loads any referenced subprocess that are not
+    # defined in the original definition. (Notice the missing single-quotes?)
+    #
+    # === Caveat
+    # In order for this to work you must:
+    #
+    # * Name your files like your (sub)processes, including path from @root
+    # * Use the 'subprocess' expression 
+    #   (see: http://ruote.rubyforge.org/exp/subprocess.html)
+    #   otherwise the library will not be able to tell the diference between a
+    #   participant and a subprocess
+    #
+    # @param [String] name The name of the file to fetch
+    # @return [String] radial process definition (regardless of what was in
+    #   the file)
+    def fetch(name, indent=0)
+      # turn into a radial, with the given indent depth
+      radial = ::Ruote::Reader.to_radial(
+        ::Ruote::Reader.read(self.read(name)),
+        indent
+      )
+
+      # check if the radial references any subprocesses not defined in this
+      # definition and fetch-and-append them
+      #
+      if radial =~ /subprocess/
+        # find the subs
+        subs = radial.scan(/subprocess (.+)$/).flatten.map do |sub|
+          sub.split(/, ?/).first.gsub(/[\'\"]/, '').gsub('ref: ', '')
+        end
+
+        # find the definitions
+        defines = radial.scan(/define (.+)$/).flatten.map do |define|
+          define.gsub(/[\'\"]/, '').gsub('name: ', '')
+        end
+
+        # substract the defs from the subs and load the remaining subs
+        subs -= defines
+        subs.each do |sub|
+          radial += "\n" + fetch(sub, 1) + "\n"
+        end
+      end
+
+      return radial
+    end
+
+    # Read a process definition from file
+    #
+    # @param [String] name The name of the process - should be the filename,
+    #   the extension is optional and tried in the order .radial, .json and 
+    #   finaly .xml
+    #
+    # @return [String] The contents of the first found file
+    #
+    def read(name)
+      path = File.join(@root, name)
+      return File.read(path) if File.exists?(path)
+
+      %w[radial json xml].each do |ext|
+        ext_path = path + ".#{ext}"
+        return File.read(ext_path) if File.exists?(ext_path)
+      end
+
+      raise ProcessNotFound,
+        "Coud not find a process named: #{name}[.radial|.json|.xml] in #{@root}"
+    end
+  end
+end

data/ruote-library.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Hartog C. de Mik"]
+  gem.email         = ["hartog@organisedminds.com"]
+  gem.description   = %q{A library for Ruote processes, based on FS storage and sub-processes}
+  gem.summary       = %q{Ruote process library}
+  gem.homepage      = "https://github.com/coffeeaddict/ruote-library"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ruote-library"
+  gem.require_paths = ["lib"]
+  gem.version       = "1.0.0"
+
+  gem.add_dependency 'ruote', ['~> 2.3']
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'mocha'
+end

data/spec/library/01_basic_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+root = File.expand_path("../../support/processes", __FILE__)
+
+describe Ruote::ProcessLibrary do
+  before(:each) do
+    @library = Ruote::ProcessLibrary.new(root)
+
+    @dash.register_participant "debug" do |wi|
+      text = wi.params['text'] || wi.params['message']
+      wi.fields["trace"] << "debug"
+ 
+      if text
+        text.gsub!(/\$\{f:([^\}]+)\}/) { wi.fields[$1] }
+        STDERR.puts "{#{wi.wfid}}: #{text}"
+      else
+        STDERR.puts "{#{wi.wfid}}: WORKITEM : #{wi.fields.inspect}"
+      end
+    end
+
+    @dash.register_participant "*" do |wi|
+      wi.fields['trace'] << wi.params['ref']
+    end
+  end
+
+  describe :single_process do
+    it "should raise an error on non-existing files" do
+      expect {
+        @library.fetch("ce-ci-nest-pas-une-file")
+      }.to raise_error(Ruote::ProcessLibrary::ProcessNotFound)
+    end
+
+    it "should fetch a json process" do
+      pdef = @library.fetch("json.json")
+      pdef.should be_kind_of String
+    end
+    
+    it "should fetch an xml process" do
+      pdef = @library.fetch("xml.xml")
+      pdef.should be_kind_of String
+    end
+    
+    it "should auto-apply an extension" do
+      pdef = @library.fetch("xml")
+      pdef.should be_kind_of String
+    end
+    
+    it "should return a radial process" do
+      pdef = @library.fetch("json")
+      pdef.should be_kind_of String
+
+      Ruote::Reader.to_radial(Ruote::Reader.read(pdef)).should eq pdef
+    end
+    
+    it "should be executable" do
+      pdef = @library.fetch("json")
+      wfid = @dash.launch(pdef, { trace: [] } )
+      res  = @dash.wait_for(wfid)
+      
+      res.should trace(%w[alpha bravo charlie])
+    end
+  end
+
+  describe :sub_process do
+    it "should not read a subprocess when defined" do
+      pdef = @library.fetch("defined")
+      wfid = @dash.launch(pdef, { trace: [] } )
+      res  = @dash.wait_for(wfid)
+      
+      res.should trace(%w[abc_alpha abc_bravo abc_charlie])
+    end
+    
+    it "should read a subprocess when not defined" do
+      pdef = @library.fetch("subs")
+      wfid = @dash.launch(pdef, { trace: [] } )
+      res  = @dash.wait_for(wfid)
+      
+      res.should trace(%w[root_alpha root_beta alpha bravo charlie])      
+    end
+
+    it "should read subprocess recursively" do
+      pdef = @library.fetch("recursive")
+      wfid = @dash.launch(pdef, { trace: [] } )
+      res  = @dash.wait_for(wfid)
+      
+      res.should trace(%w[recursive_alpha root_alpha alpha])      
+    end
+    
+    it "should read from subdirectories" do
+      pdef = @library.fetch("army/build")
+      pdef.should be_kind_of String
+    end
+    
+    it "should read from subdirectories recursively" do
+      pdef = @library.fetch("country/attack")
+      pdef.should be_kind_of String
+      
+      wfid = @dash.launch(pdef, { trace: [] } )
+      res  = @dash.wait_for(wfid)
+      
+      res.should trace(
+        %w[recruit_troops train_troops build_phalanx_formation send_formation]
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'ruby_parser'
+require 'sexp_processor'
+require 'ruby2ruby'
+
+require 'ruote-library'
+
+require 'rufus-json/automatic'
+require 'ruote'
+require 'ruote/storage/fs_storage'
+
+require 'singleton'
+
+Dir[File.expand_path( "../support/**/*.rb", __FILE__)].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.tty = true
+  config.mock_with :mocha
+
+  config.before(:all) do
+    @dash = Ruote::Dashboard.new(
+      Ruote::Worker.new(
+        Ruote::FsStorage.new('ruote_work')))
+  end
+end

data/spec/support/01_rspec_helper.rb

@@ -0,0 +1,9 @@
+module RSpecWorldHelper
+  def RWorld(constant)
+    RSpec.configure do |config|
+      config.include constant
+    end
+  end
+end
+
+include RSpecWorldHelper

data/spec/support/processes/army/attack.radial

@@ -0,0 +1,4 @@
+define army/attack
+  # roman army style
+  build_phalanx_formation
+  send_formation direction: 'forward'

data/spec/support/processes/army/build.radial

@@ -0,0 +1,3 @@
+define army/build
+  recruit_troops
+  train_troops

data/spec/support/processes/country/attack.radial

@@ -0,0 +1,4 @@
+define country/attack
+  iterator on_val: 'army, navy, airforce', to_var: 'type'
+    subprocess army/build, type: '${v:type}'
+    subprocess army/attack, type: '${v:type}'

data/spec/support/processes/defined.radial

@@ -0,0 +1,10 @@
+define defined
+  alpha
+  bravo
+  subprocess ref: abc
+
+  define abc
+    sequence
+      abc_alpha
+      abc_bravo
+      abc_charlie

data/spec/support/processes/json.json

@@ -0,0 +1 @@
+["define",{"json":null},[["sequence",{},[["alpha",{},[]],["bravo",{},[]],["charlie",{},[]]]]]]

data/spec/support/processes/recursive.radial

@@ -0,0 +1,3 @@
+define recursive
+  recursive_alpha
+  subprocess ref: subs

data/spec/support/processes/subs.radial

@@ -0,0 +1,4 @@
+define subs
+  root_alpha
+  root_beta
+  subprocess ref: json

data/spec/support/processes/xml.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<define ref="xml">
+  <sequence>
+    <alpha/>
+    <charlie/>
+  </sequence>
+</define>

data/spec/support/trace_matcher.rb

@@ -0,0 +1,31 @@
+module TraceMatcher
+  def trace(list)
+    list = [list] unless list.is_a?(Array)
+    TraceMatcher::Matcher.new(list)
+  end
+  
+  class Matcher
+    def initialize(list)
+      @expected = list
+    end
+    
+    def matches?(actual)
+      @actual = actual
+      matches = @expected.map do |e|
+        @actual['workitem']['fields']['trace'].include?(e)
+      end
+      
+      !matches.any? { |x| x == false }
+    end
+    
+    def failure_message
+      "Expected #{@actual['workitem']['fields']} to execute all of #{@expected}"
+    end
+    
+    def negative_failure_message
+      "Expected #{@actual['workitem']['fields']} to not execute any of #{@expected}"
+    end
+  end
+end
+
+RWorld(TraceMatcher)

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ruote-library
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Hartog C. de Mik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruote
+  requirement: &16232700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16232700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16232300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16232300
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &14938560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14938560
+description: A library for Ruote processes, based on FS storage and sub-processes
+email:
+- hartog@organisedminds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ruote-library.rb
+- ruote-library.gemspec
+- spec/library/01_basic_spec.rb
+- spec/spec_helper.rb
+- spec/support/01_rspec_helper.rb
+- spec/support/processes/army/attack.radial
+- spec/support/processes/army/build.radial
+- spec/support/processes/country/attack.radial
+- spec/support/processes/defined.radial
+- spec/support/processes/json.json
+- spec/support/processes/recursive.radial
+- spec/support/processes/subs.radial
+- spec/support/processes/xml.xml
+- spec/support/trace_matcher.rb
+homepage: https://github.com/coffeeaddict/ruote-library
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ruote process library
+test_files: []
+has_rdoc: