ruote-library 1.0.0 → 1.1.0

data/lib/ruote-library.rb

@@ -51,17 +51,53 @@ module Ruote
     #       be_funny
     #
     # In other words: fetch() loads any referenced subprocess that are not
-    # defined in the original definition. (Notice the missing single-quotes?)
+    # defined in the original definition.
+    #
+    # === Including referenced
+    #
+    # Image you have thses files:
+    #   > cat base.radial
+    #   define base
+    #     alpha
+    #     bravo
+    #     charly
+    #
+    #   > cat extended.radial
+    #   define extended
+    #     taste_soup
+    #       concurrence
+    #          lib_include base
+    #
+    # When you fetch extended, you will receive
+    #
+    #   define extended
+    #      taste_soup
+    #      concurrence
+    #        alpha
+    #        bravo
+    #        charly
+    #
+    # === Notice the missing single-quotes?
+    # Because the ProcessLibrary turns all files into Radial (even though it
+    # already is a Radial) it performs some optimizing
     #
     # === Caveat
     # In order for this to work you must:
     #
     # * Name your files like your (sub)processes, including path from @root
-    # * Use the 'subprocess' expression 
+    #
+    # * 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
     #
+    # * You cannot have a participant called 'lib_include' if you want to use
+    #   the inclusion mechanism
+    #
+    # === Note on inclusion
+    # 'lib_include' was added as a way to keep the definitions tree simple, it
+    # has no other sane use-case
+    #
     # @param [String] name The name of the file to fetch
     # @return [String] radial process definition (regardless of what was in
     #   the file)
@@ -93,13 +129,21 @@ module Ruote
         end
       end
 
+      if radial =~ /lib_include/
+        extras = radial.scan(/^(\s+)lib_include (.+)$/).map do |indent, process|
+          sub_process = fetch(process, (indent.length / 2) - 1)
+          replacement = sub_process.split("\n")[1..-1].join("\n")
+          radial.gsub!("#{indent}lib_include #{process}", replacement)
+        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 
+    #   the extension is optional and tried in the order .radial, .json and
     #   finaly .xml
     #
     # @return [String] The contents of the first found file

data/ruote-library.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   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.version       = "1.1.0"
 
   gem.add_dependency 'ruote', ['~> 2.3']
 

data/spec/library/01_basic_spec.rb

@@ -103,4 +103,19 @@ describe Ruote::ProcessLibrary do
       )
     end
   end
+
+  describe :inclusion do
+    it "includes other processes" do
+      pdef = @library.fetch("inclusive/test")
+      pdef.should == "define inclusive/test
+  foo
+  bar
+  cursor
+    recruit_troops
+    train_troops
+    rewind unless: \"${f:enough_troops}\"
+    build_phalanx_formation
+    send_formation direction: forward\n"
+    end
+  end
 end

data/spec/support/processes/inclusive/test.radial

@@ -0,0 +1,7 @@
+define inclusive/test
+  foo
+  bar
+  cursor
+    lib_include 'army/build'
+    rewind unless: '${f:enough_troops}'
+    lib_include army/attack

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruote-library
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
-  requirement: &16232700 !ruby/object:Gem::Requirement
+  requirement: &29558760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *16232700
+  version_requirements: *29558760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16232300 !ruby/object:Gem::Requirement
+  requirement: &29558060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16232300
+  version_requirements: *29558060
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &14938560 !ruby/object:Gem::Requirement
+  requirement: &29557080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14938560
+  version_requirements: *29557080
 description: A library for Ruote processes, based on FS storage and sub-processes
 email:
 - hartog@organisedminds.com
@@ -65,6 +65,7 @@ files:
 - spec/support/processes/army/build.radial
 - spec/support/processes/country/attack.radial
 - spec/support/processes/defined.radial
+- spec/support/processes/inclusive/test.radial
 - spec/support/processes/json.json
 - spec/support/processes/recursive.radial
 - spec/support/processes/subs.radial