fabulator 0.0.1 → 0.0.2

data/History.txt

@@ -2,3 +2,13 @@
 
 * 1 major enhancement:
   * Initial release
+
+=== 0.0.2 2010-08-10
+
+* 3 major enhancement:
+  * Introduce '*' suffix to indicate a consolidation of a reduction
+  * Reduction functions can now have a corresponding consolidation
+    function.  The reduction will be a fallback for an undefined
+    consolidation.
+  * Use LibXSLT to apply template to html transform (requires the
+    libxslt-ruby gem)

data/Rakefile

@@ -1,48 +1,40 @@
-$: << File.expand_path(File.dirname(__FILE__))+'/lib'
-
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require 'fabulator'
-
-Hoe.plugin :newgem
-# Hoe.plugin :website
-Hoe.plugin :cucumberfeatures
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'fabulator' do
-  self.version = Fabulator::VERSION::STRING
-  self.developer 'James Smith', 'jgsmith@tamu.edu'
-  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fabulator"
+    gem.summary = %Q{XML-based state machine description language and engine.}
+    gem.description = %Q{The fabulator library provides a state machine implementation of a core set of semantics for building data-driven applications using a simple XML language coupled with an XQuery-like expression language.}
+    gem.email = "jgsmith@tamu.edu"
+    gem.homepage = "http://github.com/jgsmith/ruby-fabulator"
+    gem.authors = ["James Smith"]
+    gem.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+    gem.add_dependency(%q<libxslt-ruby>, [">= 0.9.7"])
+    gem.add_dependency(%q<radius>, [">= 0.6.1"]) 
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package fabulator-exhibit as a gem."
 end
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+require 'cucumber'
+require 'cucumber/rake/task'
 
-desc "Look for TODO and FIXME tags in the code"
-task :todo do
-  egrep /(FIXME|TODO|TBD)/
-end
+task :features => 'spec:integration'
 
-desc "verify_committed, verify_rcov, post_news, release"
-task :complete_release => [:verify_committed, :release]
-
-desc "Verifies that there is no uncommitted code"
-task :verify_committed do
-  IO.popen('git status') do |io|
-    io.each_line do |line|
-      raise "\n!!! Do a git commit first !!!\n\n" if line =~ /^#\s*modified:/
-    end
+namespace :spec do
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
   end
+
 end
 
 namespace :update do
@@ -52,3 +44,22 @@ namespace :update do
   end
 end
 
+desc 'Generate documentation for the fabulator exhibit extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fabulator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the fabulator exhibit extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/features/functions.feature

@@ -0,0 +1,164 @@
+@func
+Feature: Function calls and lists
+
+  Scenario: Adding two numbers together as a union
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression (f:sum((1 | 2)))
+   Then I should get 1 item
+     And item 0 should be [3]
+
+  @cons
+  Scenario: Adding two numbers together as a union with sum consolidation
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression (f:sum*((1 | 2)))
+   Then I should get 1 item
+     And item 0 should be [3]
+
+  @cons
+  Scenario: Adding two numbers together as a union with count consolidation
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression (f:count*((1 | 2)))
+   Then I should get 1 item
+     And item 0 should be [3]
+
+  Scenario: Adding two numbers together as a list
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression (f:sum((1, 2)))
+   Then I should get 1 item
+     And item 0 should be [3]
+
+  Scenario: Adding number of elements in a histogram, part 1
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $i := (1 .. 6) + (1 .. 6); f:sum($i))
+    Then I should get 1 item
+     And item 0 should be [6*6*7]
+
+  Scenario: Adding number of elements in a histogram, part 2
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $i := (1 .. 6) + (1 .. 6); f:sum(f:histogram($i)/*))
+    Then I should get 1 item
+     And item 0 should be [6*6]
+
+  Scenario: Split a string
+    Given a context
+      And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $t := "The quick brown fox jumped over the brown spotted cow"; f:split($t, " "))
+    Then I should get 10 items
+     And item 0 should be ['The']
+     And item 1 should be ['quick']
+
+  Scenario: Histogram of text
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $t := "The quick brown fox jumped over the brown spotted cow"; f:histogram(f:split($t, " "))/brown)
+    Then I should get 1 item
+     And item 0 should be [2]
+
+  @hist
+  Scenario: Histogram of text
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $t := f:lower-case("The quick brown fox jumped over the brown spotted cow"); f:histogram*( (f:histogram(f:split($t, " ")), f:histogram(f:split($t, " "))) )/brown)
+    Then I should get 1 item
+     And item 0 should be [4]
+
+  @hist
+  Scenario: Histogram of text with attributes
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $t := f:lower-case("The quick brown fox jumped over the brown spotted cow"); f:histogram*( ( (f:histogram(f:split($t, " ")) with ./*/@line := 1), (f:histogram(f:split($t, " ")) with ./*/@line := 2)) )/brown)
+    Then I should get 1 item
+     And item 0 should be [4]
+
+  Scenario: Joining a range of numbers
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $i := 5; (1 .. $i))
+    Then I should get 5 item
+     And item 0 should be [1]
+     And item 1 should be [2]
+     And item 2 should be [3]
+     And item 3 should be [4]
+     And item 4 should be [5]
+
+  Scenario: Joining a range of numbers
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $i := 5; f:sum((1 .. $i)))
+    Then I should get 1 item
+     And item 0 should be [15]
+
+  Scenario: Joining a range of numbers
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:string-join( (1 .. 5), ','))
+    Then I should get 1 item
+     And item 0 should be ["1,2,3,4,5"]
+
+  Scenario: Joining a range of numbers
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (let $i := 5; f:string-join( (1 .. $i), ','))
+    Then I should get 1 item
+     And item 0 should be ["1,2,3,4,5"]
+
+  Scenario Outline: simple functions
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:<fctn>(<a>))
+    Then I should get 1 item
+      And item 0 should be [<ans>]
+
+    Examples:
+      | fctn     |   a  | ans |
+      | abs      |   -1 |   1 |
+      | abs      |    1 |   1 |
+      | abs      |    0 |   0 |
+      | floor    | 1.23 |   1 |
+      | ceiling  | 1.23 |   2 |
+      | sum      | (1,2) |  3 |
+      | avg      | (1,2,3) | 2 |
+      | max      | (2,3,1) | 3 |
+      | min      | (3,1,2) | 1 |
+
+  Scenario: boolean constant functions - true
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:true())
+    Then I should get 1 item
+      And item 0 should be true
+
+  Scenario: boolean constant functions - false
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:false())
+    Then I should get 1 item
+      And item 0 should be false
+
+  Scenario: Replacing unwanted characters in a string
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:keep("foo bar baz! ter", ('alpha', 'space', 'numeric')))
+    Then I should get 1 item
+      And item 0 should be ['foo bar baz  ter']
+
+  Scenario: Replacing unwanted characters in a string
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:keep("foo bar baz! ter", ('alpha', 'numeric')))
+    Then I should get 1 item
+      And item 0 should be ['foo bar baz ter']
+
+  @bool
+  Scenario: Negating logic
+    Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+    When I run the expression (f:not(f:true()))
+    Then I should get 1 item
+      And item 0 should be [f:false()]

data/features/group-params.feature

@@ -0,0 +1,86 @@
+@group
+Feature: Groups/Parameters
+
+  Scenario: simple machine with a simple transition and filter
+    Given the statemachine
+      """
+        <f:application xmlns:f="http://dh.tamu.edu/ns/fabulator/1.0#">
+          <f:view f:name="start">
+            <f:goes-to f:view="stop">
+              <f:params>
+                <f:param f:name="foo">
+                  <f:filter f:name="trim" />
+                </f:param>
+              </f:params>
+            </f:goes-to>
+          </f:view>
+          <f:view f:name="stop" />
+        </f:application>
+      """
+    Then it should be in the 'start' state
+    When I run it with the following params:
+      | key   | value         |
+      | foo   | bar  b  que   |
+    Then it should be in the 'stop' state
+     And the expression (/foo) should equal ['bar b que']
+
+  Scenario: simple machine with a simple transition and simple value constraint
+    Given the statemachine
+      """
+        <f:application xmlns:f="http://dh.tamu.edu/ns/fabulator/1.0#">
+          <f:view f:name="start">
+            <f:goes-to f:view="stop">
+              <f:params>
+                <f:param f:name="foo">
+                  <f:filter f:name="trim" />
+                  <f:value>bar</f:value>
+                </f:param>
+              </f:params>
+            </f:goes-to>
+          </f:view>
+          <f:view f:name="stop" />
+        </f:application>
+      """
+    Then it should be in the 'start' state
+    When I run it with the following params:
+      | key   | value         |
+      | foo   | bar  b  que   |
+    Then it should be in the 'start' state
+     And the expression (/foo) should be nil
+    When I run it with the following params:
+      | key   | value |
+      | foo   | bar   |
+    Then it should be in the 'stop' state
+     And the expression (/foo) should equal ['bar']
+
+  Scenario: simple machine with a simple transition and simple group
+    Given the statemachine
+      """
+        <f:application xmlns:f="http://dh.tamu.edu/ns/fabulator/1.0#">
+          <f:view f:name="start">
+            <f:goes-to f:view="stop">
+              <f:params>
+                <f:group f:select="/bar">
+                  <f:param f:name="foo">
+                    <f:filter f:name="trim" />
+                    <f:value>bar</f:value>
+                  </f:param>
+                </f:group>
+              </f:params>
+            </f:goes-to>
+          </f:view>
+          <f:view f:name="stop" />
+        </f:application>
+      """
+    Then it should be in the 'start' state
+    When I run it with the following params:
+      | key       | value         |
+      | bar.foo   | bar  b  que   |
+    Then it should be in the 'start' state
+     And the expression (/bar/foo) should be nil
+    When I run it with the following params:
+      | key       | value |
+      | bar.foo   | bar   |
+    Then it should be in the 'stop' state
+     And the expression (/bar/foo) should equal ['bar']
+

data/features/loops.feature

@@ -0,0 +1,55 @@
+Feature: Loops
+
+ Scenario: 'For' with a single variable
+   Given a context
+   When I run the expression (for $i in 1 .. 3 return $i)
+   Then I should get 3 items
+     And item 0 should be [1]
+     And item 1 should be [2]
+     And item 2 should be [3]
+
+ Scenario: 'Some' with a single variable
+   Given a context
+   When I run the expression (some $i in 1 .. 3 satisfies $i mod 2 = 1)
+   Then I should get 1 items
+     And item 0 should be true
+
+ Scenario: 'Every' with a single variable
+   Given a context
+   When I run the expression (every $i in 1 .. 3 satisfies $i mod 2 = 1)
+   Then I should get 1 items
+     And item 0 should be false
+
+ @for
+ Scenario: 'For' with two variables
+   Given a context
+   When I run the expression (for $i in 1 .. 3, $j in 2 to 4 return $i*$j)
+   Then I should get 9 items
+
+ @for
+ Scenario: 'For' within a sum
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression (f:sum(for $i in 1 to 3, $j in 2 to 4 return $i*$j))
+   Then I should get 1 item
+     And item 0 should be [54]
+
+ @with
+ Scenario: 'For' with annotation
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression (for $i in 1 to 3 return $i with ./line := 4)
+   Then I should get 3 items
+     And item 0 should be [1]
+     And item 1 should be [2]
+     And item 2 should be [3]
+
+ @with
+ Scenario: 'For' with annotation
+   Given a context
+     And the prefix f as "http://dh.tamu.edu/ns/fabulator/1.0#"
+   When I run the expression ((for $i in 1 to 3 return $i with ./line := 4)/line)
+   Then I should get 3 items
+     And item 0 should be [4]
+     And item 1 should be [4]
+     And item 2 should be [4]

data/features/paths.feature

@@ -0,0 +1,57 @@
+@paths
+Feature: Path expressions
+
+  Scenario: Finding the numbers
+    Given a context
+      And that [/a] is set to [1 .. 10]
+    When I run the expression (/a)
+    Then I should get 10 items
+
+  Scenario: Finding the positive numbers
+    Given a context
+      And that [/a] is set to [-1 .. 10]
+    When I run the expression (/a[. > 0])
+    Then I should get 10 items
+
+  Scenario: Finding the odd numbers
+    Given a context
+      And that [/a] is set to [1 .. 10]
+    When I run the expression (/a[. mod 2 = 1])
+    Then I should get 5 items
+      And item 0 should be [1]
+      And item 1 should be [3]
+      And item 2 should be [5]
+      And item 3 should be [7]
+      And item 4 should be [9]
+
+  Scenario: Finding the third odd number
+    Given a context
+      And that [/a] is set to [1 .. 10]
+    When I run the expression (/a[. mod 2 = 1][3])
+    Then I should get 1 item
+      And item 0 should be [5]
+
+  Scenario: Finding the third and fifth odd numbers
+    Given a context
+      And that [/a] is set to [1 .. 10]
+    When I run the expression (/a[. mod 2 = 1][3,5])
+    Then I should get 2 items
+      And item 0 should be [5]
+      And item 1 should be [9]
+
+  Scenario: Using an expression to name a node test
+    Given a context
+      And that [/a] is set to [1 .. 10]
+      And that [/b] is set to ['a']
+    When I run the expression (/{/b}[. mod 2 = 1][3,5])
+    Then I should get 2 items
+      And item 0 should be [5]
+      And item 1 should be [9]
+
+  Scenario: Using an expression to name a node test
+    Given a context
+      And that [/a] is set to [1 .. 10]
+    When I run the expression (/{'a'}[. mod 2 = 1][3,5])
+    Then I should get 2 items
+      And item 0 should be [5]
+      And item 1 should be [9]