fabulator 0.0.6 → 0.0.7

data/History.txt

@@ -1,3 +1,23 @@
+=== 0.0.7 2010-09-07
+
+* 5 major enhancement:
+  * Structural elements are easier to code - similar to actions
+  * Fabulator::ActionLib is now Fabulator::TagLib to reflect the more
+    generic nature of the libraries
+  * More robust Structural and Action base classes
+  * Added '?' as a suffix character for expression function names
+    A function with a name ending in '?' will have its return values
+    automatically converted to boolean
+  * Default run-time behavior for Action classes is to run any embedded 
+    actions
+
+* 5 minor enhancement:
+  * Fabulator now depends on the active_support gem
+  * Inheritance is not fully supported, so removing until later
+  * Simpler access to attributes that require evaluation
+  * Simpler access to f:select values and actions
+  * Beginning support for libraries written in XML (testing only for now)
+
 === 0.0.6 2010-08-27
 
 * 4 minor enhancement:

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.add_dependency(%q<libxslt-ruby>, [">= 0.9.7"])
     gem.add_dependency(%q<radius>, [">= 0.6.1"]) 
     gem.add_dependency(%q<RedCloth>, [">= 4.2.0"])
+    gem.add_dependency(%q<activesupport>, [">=2.3.0"])
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/features/step_definitions/expression_steps.rb

@@ -56,7 +56,7 @@ When /I unify the types? (.*)/ do |ts|
       pn = t.split(/:/, 2)
       [ @context.get_ns(pn[0]), pn[1] ]
     }
-  @type_result = Fabulator::ActionLib.unify_types(
+  @type_result = Fabulator::TagLib.unify_types(
     types.collect { |t|
       pn = t.split(/:/, 2)
       [ @context.get_ns(pn[0]), pn[1] ]

data/features/step_definitions/xml_steps.rb

@@ -2,7 +2,8 @@ Given /the statemachine/ do |doc_xml|
   @context ||= Fabulator::Expr::Context.new
 
   if @sm.nil?
-    @sm = Fabulator::Core::StateMachine.new.compile_xml(doc_xml)
+    @sm = Fabulator::Core::StateMachine.new
+    @sm.compile_xml(doc_xml)
   else
     @sm.compile_xml(doc_xml)
   end

data/features/support/env.rb

@@ -4,4 +4,5 @@ $: << File.expand_path(File.dirname(__FILE__))+'/../../lib'
 
 require 'fabulator'
 require 'fabulator/template'
+require 'fabulator/lib'
 require 'spec/expectations'

data/lib/fabulator.rb

@@ -1,5 +1,13 @@
-require 'fabulator/expr'
-require 'fabulator/action_lib'
-require 'fabulator/action'
-require 'fabulator/core'
-require 'fabulator/version'
+require 'active_support/inflector'
+
+module Fabulator
+  FAB_NS='http://dh.tamu.edu/ns/fabulator/1.0#'
+  FAB_LIB_NS='http://dh.tamu.edu/ns/fabulator/library/1.0#'
+
+  require 'fabulator/expr'
+  require 'fabulator/tag_lib'
+  require 'fabulator/action'
+  require 'fabulator/structural'
+  require 'fabulator/core'
+  require 'fabulator/version'
+end

data/lib/fabulator/action.rb

@@ -3,34 +3,38 @@ module Fabulator
 
     def compile_xml(xml, context)
       @context = context.merge(xml)
-      klass = self.class.name
-      if @@attributes[klass]
-        @@attributes[klass].each_pair do |nom, opts|
-          as = "@" + (opts[:as] || nom).to_s
-          self.instance_variable_set(as.to_sym, @context.attribute(opts[:namespace] || @@namespace[klass], nom.to_s, opts))
-        end
-      end
-      @select = @context.get_select(@@has_select[klass]) if @@has_select.has_key?(klass)
-      if @@has_actions[klass]
-        case @@has_actions[klass]
-          when :simple:
-            @actions = @context.compile_actions(xml)
-          when :super:
-            @actions = ActionLib.current_super
-        end
-      end
+      self.setup(xml)
       self
     end
 
-    def self.namespace(href)
+    def has_actions?
+      !@actions.nil? && !@actions.empty?
+    end
+
+    def self.namespace(href = nil)
+      return @@namespace[self.name] if href.nil?
       @@namespace ||= { }
       @@namespace[self.name] = href
     end
 
-    def self.attribute(nom, opts = { })
+    def self.attribute(e_nom, opts = { })
       @@attributes ||= { }
       @@attributes[self.name] ||= { }
-      @@attributes[self.name][nom.to_s] = opts
+      @@attributes[self.name][e_nom.to_s] = opts
+      nom = (opts[:as].nil? ? e_nom : opts[:as]).to_sym
+      if opts[:static]
+        self.instance_eval {
+          attr_reader nom.to_sym
+        }
+      else
+        at_nom = ('@' + nom.to_s).to_sym
+        self.class_eval {
+          define_method(nom.to_s) { |ctx|
+            v = instance_variable_get(at_nom) 
+            v.nil? ? [] : v.run(ctx,false)
+          }
+        }
+      end
     end
 
     def self.has_actions(t = :simple)
@@ -38,9 +42,72 @@ module Fabulator
       @@has_actions[self.name] = t
     end
 
+    def self.has_actions?
+      !@@has_actions.nil? && @@has_actions.has_key?(self.name)
+    end
+
+    def run_actions(ctx)
+      self.has_actions? ? @actions.run(ctx) : [ ]
+    end
+
     def self.has_select(default = '.')
       @@has_select ||= { }
       @@has_select[self.name] = default
     end
+
+    def select(ctx)
+      self.class.has_select? && !@select.nil? ? @select.run(ctx) : [ ]
+    end
+
+    def self.has_select?
+      !@@has_select.nil? && @@has_select.has_key?(self.name)
+    end
+
+#    def self.at_runtime(&block)
+#      @@run_time ||= { }
+#      @@run_time[self.name] = block
+#    end
+#
+
+    def run(context, autovivify = false)
+      self.run_actions(@context.merge(context))
+    end
+
+#    def run(context, autovivify = false)
+#      ret = []
+#      @context.with(context) do |ctx|
+#        proc = @@run_time[self.class.name]
+#        if !proc.nil?
+#          ret = self.instance_eval {
+#            proc.call(ctx, autovivify)
+#          }
+#        end
+#      end
+#      ret
+#    end
+
+  protected
+
+    def setup(xml)
+      klass = self.class.name
+      if @@attributes[klass]
+        @@attributes[klass].each_pair do |nom, opts|
+          as = "@" + (opts[:as] || nom).to_s
+          self.instance_variable_set(as.to_sym, @context.attribute(opts[:namespace] || @@namespace[klass], nom.to_s, opts))
+        end
+      end
+      if self.class.has_select?
+        @select = @context.get_select(@@has_select[klass])
+      end
+      @actions = nil
+      if @@has_actions[klass]
+        case @@has_actions[klass]
+          when :simple:
+            @actions = @context.compile_actions(xml)
+          when :super:
+            @actions = TagLib.current_super
+        end
+      end
+    end
   end
 end

data/lib/fabulator/core/actions.rb

@@ -1,4 +1,4 @@
-require 'fabulator/action_lib'
+require 'fabulator/tag_lib'
 require 'fabulator/core/actions/choose'
 require 'fabulator/core/actions/for_each'
 require 'fabulator/core/actions/variables'
@@ -6,9 +6,24 @@ require 'fabulator/core/actions/variables'
 module Fabulator
   module Core
   module Actions
-  class Lib
-    include ActionLib
-    register_namespace FAB_NS
+  class Lib < TagLib
+    namespace FAB_NS
+
+    structural 'application', Fabulator::Core::StateMachine
+    structural 'view', Fabulator::Core::State
+    structural 'goes-to', Fabulator::Core::Transition
+    #structural 'before', 
+    #structural 'after', 
+    structural 'params', Fabulator::Core::Group
+    structural 'group', Fabulator::Core::Group
+    structural 'param', Fabulator::Core::Parameter
+    structural 'value', Fabulator::Core::Constraint
+    structural 'constraint', Fabulator::Core::Constraint
+    structural 'filter', Fabulator::Core::Filter
+    structural 'sort', Sort
+    structural 'when', When
+    structural 'otherwise', When
+
 
     action 'choose', Choose
     action 'for-each', ForEach
@@ -122,14 +137,14 @@ module Fabulator
     end
 
     reduction 'sum', { :scaling => :log } do |ctx, args|
-      zero = ActionLib.find_op(args.first.vtype, :zero)
+      zero = TagLib.find_op(args.first.vtype, :zero)
       if(zero && zero[:proc])
         res = zero[:proc].call(ctx)
       end
       res = 0 if res.nil?
       return [ res ] if args.empty?
 
-      op = ActionLib.find_op(args.first.vtype, :plus)
+      op = TagLib.find_op(args.first.vtype, :plus)
 
       if op.nil? || op[:proc].nil?
         args.each do |a|

data/lib/fabulator/core/actions/choose.rb

@@ -1,24 +1,12 @@
 module Fabulator
   module Core
   module Actions
-  class Choose < Fabulator::Action
-    def compile_xml(xml, context)
-      super
-
-      @choices = [ ]
-      @default = nil
-
-      xml.each_element do |e|
-        next unless e.namespaces.namespace.href == FAB_NS
-        case e.name
-          when 'when':
-            @choices << When.new.compile_xml(e, @context)
-          when 'otherwise':
-            @default = When.new.compile_xml(e, @context)
-        end
-      end
-      self
-    end
+  class Choose < Fabulator::Structural
+
+    namespace FAB_NS
+
+    contains :when, :as => :choices
+    contains :otherwise, :as => :default
 
     def run(context, autovivify = false)
       @context.with(context) do |ctx|
@@ -27,7 +15,7 @@ module Fabulator
             return c.run(ctx)
           end
         end
-        return @default.run(ctx) unless @default.nil?
+        return @default.first.run(ctx) unless @default.empty?
         return []
       end
     end
@@ -41,14 +29,10 @@ module Fabulator
 
     def run_test(context)
       return true if @test.nil?
-      result = @test.run(@context.merge(context)).collect{ |a| !!a.value }
+      result = self.test(@context.merge(context)).collect{ |a| !!a.value }
       return false if result.nil? || result.empty? || !result.include?(true)
       return true
     end
-
-    def run(context, autovivify = false)
-      return @actions.run(@context.merge(context))
-    end
   end
 
   class If < Fabulator::Action
@@ -60,9 +44,9 @@ module Fabulator
     def run(context, autovivify = false)
       return [ ] if @test.nil?
       @context.with(context) do |ctx|
-        test_res = @test.run(ctx).collect{ |a| !!a.value }
+        test_res = self.test(ctx).collect{ |a| !!a.value }
         return [ ] if test_res.nil? || test_res.empty? || !test_res.include?(true)
-        return @actions.run(ctx)
+        return self.run_actions(ctx)
       end
     end
   end
@@ -72,9 +56,6 @@ module Fabulator
     namespace Fabulator::FAB_NS
     has_actions
 
-    def run(context, autovivify = false)
-       return @actions.run(@context.merge(context),autovivify)
-    end
   end
 
   class Goto < Fabulator::Action
@@ -101,7 +82,7 @@ module Fabulator
       return true if @test.nil?
       @context.with(context) do |ctx|
         ctx.set_var(@as, context) if @as
-        result = @test.run(context).collect{ |a| !!a.value }
+        result = self.test(context).collect{ |a| !!a.value }
         return false if result.nil? || result.empty? || !result.include?(true)
         return true
       end
@@ -109,8 +90,8 @@ module Fabulator
 
     def run(context, autovivify = false)
       @context.with(context) do |ctx|
-        ctx.set_var(@as, context) if @as
-        return @actions.run(context)
+        ctx.set_var(self.as, context) if self.as
+        return self.run_actions(context)
       end
     end
   end
@@ -125,12 +106,12 @@ module Fabulator
       @context.with(context) do |ctx|
         select = ctx.get_select
         if !@test.nil?
-          test_res = @test.run(ctx).collect{ |a| !!a.value }
+          test_res = self.test(ctx).collect{ |a| !!a.value }
           return [ ] if test_res.nil? || test_res.empty? || !test_res.include?(true)
         end
         res = [ ]
-        if select.nil? && !@actions.nil?
-          res = @actions.run(ctx, autovivify)
+        if select.nil? && self.has_actions?
+          res = self.run_actions(ctx)
         elsif !select.nil?
           res = select.run(ctx, autovivify)
         else

data/lib/fabulator/core/actions/for_each.rb

@@ -1,41 +1,31 @@
 module Fabulator
   module Core
   module Actions
-  class ForEach < Fabulator::Action
+  class ForEach < Fabulator::Structural
     namespace Fabulator::FAB_NS
+
     attribute :as, :static => true
-    has_select
-    has_actions
 
-    def compile_xml(xml, context)
-      super
-      @sort = [ ]
+    contains :sort
 
-      xml.each_element do |e|
-        next unless e.namespaces.namespace.href == FAB_NS
-        case e.name
-          when 'sort-by':
-            @sort << Sort.new.compile_xml(e, @context)
-        end
-      end
-      self
-    end
+    has_select
+    has_actions
 
     def run(context, autovivify = false)
       @context.with(context) do |ctx|
-        items = @select.run(ctx)
+        items = self.select(ctx) #@select.run(ctx)
         res = nil
         ctx.in_context do |c|
-          if !@sort.empty?
+          if !@sorts.empty?
             items = items.sort_by{ |i| 
-              c.set_var(@as, i) unless @as.nil? 
-              @sort.collect{|s| s.run(c.with_root(i)) }.join("\0") 
+              c.set_var(self.as, i) unless self.as.nil? 
+              @sorts.collect{|s| s.run(c.with_root(i)) }.join("\0") 
             }
           end
           res = [ ]
           items.each do |i|
-            c.set_var(@as, i) unless @as.nil?
-            res = res + @actions.run(c.with_root(i))
+            c.set_var(self.as, i) unless self.as.nil?
+            res = res + self.run_actions(c.with_root(i))
           end
         end
         return res
@@ -48,7 +38,7 @@ module Fabulator
     has_select
 
     def run(context, autovivify = false)
-      (@select.run(@context.merge(context)).first.to_s rescue '')
+      (self.select(@context.merge(context)).first.to_s rescue '')
     end
   end
 
@@ -62,19 +52,19 @@ module Fabulator
       return [] if @select.nil?
       res = [ ]
       @context.with(context) do |ctx|
-        c = @select.run(ctx)
+        c = self.select(ctx)
         root = nil
-        if @as.nil?
+        if self.as.nil?
           if c.size == 1
             root = c.first
           else
             root = Fabulator::Expr::Node.new('data', context.root.roots, nil, c)
           end
-          res = @actions.run(ctx.with_root(root))
+          res = self.run_actions(ctx.with_root(root))
         else
           ctx.in_context do |ctx2|
-            ctx2.set_var(@as, c)
-            res = @actions.run(ctx2)
+            ctx2.set_var(self.as, c)
+            res = self.run_actions(ctx2)
           end
         end
       end
@@ -92,9 +82,9 @@ module Fabulator
       res = [ ]
       counter = 0
       @context.with(context) do |ctx|
-        lim = @limit.nil? ? 1000 : @limit.run(ctx).first.value
-        while counter < @limit && (!!@test.run(ctx).first.value rescue false)
-          res = res + @actions.run(ctx)
+        lim = self.limit(ctx) #@limit.nil? ? 1000 : @limit.run(ctx).first.value
+        while counter < lim && (!!self.test(ctx).first.value rescue false)
+          res = res + self.run_actions(ctx)
         end
       end
       res