rtml 1.2.2 → 2.0.0.alpha.1

data/spec/widgets/event_listener_spec.rb

@@ -0,0 +1,51 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::EventListener do
+  before(:each) do
+    @doc = Rtml::Document.new
+    @doc.screen :on_cancel
+    @doc.screen :on_menu
+    @doc.screen :on_key
+  end
+
+  context "at document level" do
+    it "should raise an error given an invalid key" do
+      proc { @doc.on :invalid_key => 'invalid_destination' }.should raise_error(Rtml::Errors::RulesViolationError)
+    end
+
+    it "should assign a cancel button" do
+      @doc.on :cancel => 'on_cancel'
+      @doc.to_tml.should have_selector(:defaults, :cancel => '#on_cancel')
+    end
+
+    it "should assign a menu button" do
+      @doc.on :menu => 'on_menu'
+      @doc.to_tml.should have_selector(:defaults, :menu => '#on_menu')
+    end
+  end
+
+  context "at screen level" do
+    before(:each) { @scr = @doc.screen :main }
+    
+    it "should raise an error given an invalid key" do
+      proc { @scr.on :invalid_key => 'invalid_destination' }.should raise_error(Rtml::Errors::RulesViolationError)
+    end
+
+    it "should assign a cancel button" do
+      @scr.on :cancel => 'on_cancel'
+      @doc.to_tml.should have_selector(:variant, :uri => '#on_cancel', :key => "cancel")
+    end
+
+    it "should assign a menu button" do
+      @scr.on :menu => 'on_menu'
+      @doc.to_tml.should have_selector(:variant, :uri => '#on_menu', :key => "menu")
+    end
+
+    %w(0 1 2 3 4 5 6 7 8 9 00 f1 f2 f3 f4 f5 f6 f7 f8 f9 down up stop enter).each do |key|
+      it "should assign a #{key} button" do
+        @scr.on key => "on_key"
+        @doc.to_tml.should have_selector(:variant, :uri => "#on_key", :key => key)
+      end
+    end
+  end
+end

data/spec/widgets/frontend_spec.rb

@@ -0,0 +1,59 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::Frontend do
+  before :each do
+    @doc = Rtml::Document.new(:name => 'magcard')
+    @doc.view.view_paths << File.join(Rtml.root, "spec/support/app/views")
+  end
+
+  it "should not send the :file option into element properties" do
+    scr = @doc.screen :main
+    scr.display :file => 'magcard/main'
+    scr.to_tml.should_not have_selector(:display, :file => 'magcard/main')
+  end
+
+  it "should accept a screen name for rendering" do
+    scr = @doc.screen :main
+    cnt = scr.display :main
+    cnt.to_tml.should == "<display> \n\tHello, World!\n</display>"
+  end
+
+  it "should infer display view content from subprocessing" do
+    content_text = "Hello, World"
+    scr = @doc.screen :main
+    cnt = scr.display { inner_content content_text }
+
+    cnt.to_tml.should == "<display> \n\t#{content_text}\n</display>"
+  end
+
+  it "should infer display view content from document and screen names" do
+    scr = @doc.screen :main
+    cnt = scr.display
+    cnt.to_tml.should == "<display> \n\tHello, World!\n</display>"
+  end
+
+  it "should infer print view content from subprocessing" do
+    content_text = "Hello, World"
+    scr = @doc.screen :main
+    cnt = scr.print { inner_content content_text }
+    cnt.to_tml.should == "<print> \n\t#{content_text}\n</print>"
+  end
+
+  it "should infer print view content from document and screen names" do
+    scr = @doc.screen :main
+    cnt = scr.print
+    cnt.to_tml.should == "<print> \n\tHello, World!\n</print>"
+  end
+
+  it "should receive display content from a single string argument" do
+    scr = @doc.screen :main
+    cnt = scr.display "Hello"
+    cnt.to_tml.should == "<display> \n\tHello\n</display>"
+  end
+
+  it "should receive print content from a single string argument" do
+    scr = @doc.screen :main
+    cnt = scr.print "Hello"
+    cnt.to_tml.should == "<print> \n\tHello\n</print>"
+  end
+end

data/spec/widgets/highlevel_variable_processing_spec.rb

@@ -0,0 +1,149 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::HighlevelVariableProcessing do
+  before :each do
+    @doc = Rtml::Document.new
+    @doc.strings :first_name, :last_name, :full_name
+    @doc.integer :amount
+    @doc.integer :sale
+  end
+
+  context "using periods instead of array operators" do
+    context "with one TML variable assigned to another" do
+      before :each do
+        @doc.screen :test do
+          tvars.first_name = tvars.last_name
+        end
+      end
+
+      it "should create a setvar tag with value tmlvar:other_variable" do
+        @doc.to_tml.should =~ /tmlvar:last_name/m
+      end
+
+      it "should not include the literal value of tmlvar:other_variable" do
+        (@doc.to_tml =~ /tmlvar:#<Rtml/).should be_nil
+      end
+    end
+  end
+
+  context "with one TML variable assigned to another" do
+    before :each do
+      @doc.screen :test do
+        tvars[:first_name] = tvars[:last_name]
+      end
+    end
+
+    it "should create a setvar tag with value tmlvar:other_variable" do
+      @doc.to_tml.should =~ /tmlvar:last_name/m
+    end
+    
+    it "should not include the literal value of tmlvar:other_variable" do
+      (@doc.to_tml =~ /tmlvar:#<Rtml/).should be_nil
+    end
+  end
+
+  context "with several tmlvar assignments and conditional variants" do
+    before :each do
+      @doc.screen :init, :main do
+        terminal_variables[:amount] = 0
+        terminal_variables[:first_name] = 'John'
+        tvars[:last_name] = 'Smith'
+        tvars[:full_name] = tvars[:first_name] + tvars[:last_name]
+
+        _if(   tvars[:amount] >  0) { tvars[:sale] = true }
+        _elsif(tvars[:amount] == 0) { tvars[:sale] = false }
+        _else                       { tvars[:amount] = 0   }
+      end
+      @doc.screen :main
+
+      @tml = @doc.to_tml
+    end
+
+    it "should not include 'next' attribute in the generated 'screen' element" do
+      (@doc / "screen[id=init]").first.property('next').should be_nil
+    end
+
+    it "should place quotes around numbers" do
+      @tml.should_not match(/lo=0/)
+    end
+
+    it "should not set the :next attribute to an RTML screen object instead of its :id" do
+      @tml.should_not match(/next=\#<Rtml/)
+    end
+
+    context "with generated :next screen" do
+      before :each do
+        @nxt = ((@doc / 'init').first / 'next').first
+        @nxt.should_not be_nil
+        (@nxt.properties.inspect =~ /name: "\#<Rtml/).should be_nil
+      end
+
+      it "should generate a :uri pointing to an anchor" do
+        #puts @tml
+        @nxt.property('uri').should_not be_nil
+        @nxt.properties.first.to_tml[5].should == ?#
+      end
+
+      context "with 2 generated variants" do
+        before :each do
+          (@variants = @nxt / "variant").should have(2).elements
+        end
+
+        it "should generate the first variant with :lo => '0'" do
+          @variants.first.property('lo').to_s.should == '0'
+        end
+
+        it "should generate the first variant with :op => 'less_or_equal'" do
+          @variants.first.property('op').to_s.should == 'less_or_equal'
+        end
+
+        it "should generate the first variant with :ro => 'tmlvar:amount'" do
+          @variants.first.property('ro').to_s.should == 'tmlvar:amount'
+        end
+
+        it "should generate the second variant with :lo => 'tmlvar:amount'" do
+          @variants.second.property('lo').to_s.should == 'tmlvar:amount'
+        end
+
+        it "should generate the second variant with :op => 'equal'" do
+          @variants.second.property('op').to_s.should == 'equal'
+        end
+
+        it "should generate the second variant with :ro => '0'" do
+          @variants.second.property('ro').to_s.should == '0'
+        end
+      end
+
+    end
+  end
+
+  context "with high level variable assignments" do
+    before :each do
+      @doc.screen :init do
+        terminal_variables[:amount] = 0
+        terminal_variables[:first_name] = 'John'
+        terminal_variables[:last_name] = 'Smith'
+        terminal_variables[:full_name] = tvars[:first_name] + tvars[:last_name]
+      end
+    end
+
+    it "should generate setvars with the expected values" do
+      init = (@doc / 'init').first
+      assert_not_nil init, "Init screen doesn't exist"
+      (setvars = init / "setvar").should have(4).items
+      setvars.each do |setvar|
+        case setvar.property('name')
+          when 'amount' then assert_equal 0, setvar.property('lo')
+          when 'first_name' then assert_equal 'John', setvar.property('lo')
+          when 'last_name' then assert_equal 'Smith', setvar.property('lo')
+          when 'full_name' then
+            assert_equal 'tmlvar:first_name', setvar.property('lo')
+            assert_equal 'tmlvar:last_name', setvar.property('ro')
+            assert_equal 'plus', setvar.property('op')
+          else
+            flunk "Unexpected variable name: #{setvar.property('name')}; expected one of %w(amount first_name last_name full_name)"
+        end
+      end
+    end
+  end
+end

data/spec/widgets/screen_variable_processing_spec.rb

@@ -0,0 +1,57 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::ScreenVariableProcessing do
+  before :each do
+    @doc = Rtml::Document.new
+  end
+
+  it "should convert true and false into integers" do
+    @doc.boolean :is_sale
+    @doc.boolean :initialized
+
+    @doc.screen :idle do
+      set :is_sale => false
+      set :initialized => true
+    end
+
+    assert_nil @doc.to_tml =~ /=(['"]|)true(['"]|)/, "Found a reference to 'true'"
+    assert_nil @doc.to_tml =~ /=(['"]|)false(['"]|)/, "Found a reference to 'false'"
+  end
+
+  it "should not create format if not specified" do
+    @doc.string :some_value
+    @doc.screen :idle do
+      set :some_value => 'Colin'
+    end
+
+    assert_nil @doc.screens.first.to_tml =~ /format=\"\"/, 'Format should not have been generated'
+  end
+
+  it "should raise if variable is not defined" do
+    assert_raises Rtml::Errors::InvalidOptionError do
+      @doc.string :first_name
+      @doc.screen :main do
+        set :first_name => 'Colin', :last_name => 'MacKenzie'
+      end
+    end
+  end
+
+  it "should set value of variables from screens" do
+    assert_nothing_raised do
+      @doc.string :first_name, :last_name, :full_name
+      @doc.screen :main do
+        set :first_name => 'Colin', :last_name => 'MacKenzie'
+        set :full_name => 'tmlvar:first_name + tmlvar:last_name'
+      end
+    end
+
+    assert_not_nil(t = @doc.screens.first / "setvar[lo=MacKenzie]")
+    assert_equal "MacKenzie", t.first.property('lo')
+    assert_not_nil(t = @doc.screens.first / "setvar[lo=tmlvar:first_name]")
+    assert_equal "tmlvar:first_name", t.first.property('lo')
+    assert_not_nil(t = @doc.screens.first / "setvar[op=plus]")
+    assert_equal "plus", t.first.property('op')
+    assert_not_nil(t = @doc.screens.first / "setvar[ro=tmlvar:last_name]")
+    assert_equal "tmlvar:last_name", t.first.property('ro')
+  end
+end

data/spec/widgets/screen_variants_spec.rb

@@ -0,0 +1,97 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::ScreenVariants do
+  before :each do
+    @doc = Rtml::Document.new
+    @scr = @doc.screen :test_screen, :next => "default_next"
+    @variant_options = {:uri => 'loop_again', :lo => 'tmlvar:counter', :op => 'less', :ro => 'tmlvar:loop_count'}
+  end
+
+  it "should produce 3 separate variants" do
+    @scr.goto "1", :if => 'tmlvar:one == 1'
+    @scr.goto "2", :if => 'tmlvar:one < 2'
+    @scr.goto "3", :if => 'tmlvar:one > 2'
+
+    (nxt = (@scr / "next")).should have(1).item
+    (nxt.first / "variant").should have(3).items
+  end
+
+  it "should produce a valid VARIANT via timeout" do
+    @scr.goto @variant_options[:uri], :timeout => '10'
+    assert_not_nil nxt = (@scr / "next").first, "screen/next not found"
+    assert_equal 'default_next', nxt.property('uri')
+    assert_not_nil var = (nxt / "variant").first, "screen/next/variant not found"
+    assert_equal @variant_options[:uri], var.property('uri')
+    assert_equal '10', var.property('timeout')
+  end
+
+  it "should produce a valid VARIANT via hotkey" do
+    @scr.goto @variant_options[:uri], :key => "00"
+    assert_not_nil nxt = (@scr / "next").first, "screen/next not found"
+    assert_equal 'default_next', nxt.property('uri')
+    assert_not_nil var = (nxt / "variant").first, "screen/next/variant not found"
+    assert_equal @variant_options[:uri], var.property('uri')
+    assert_equal '00', var.property('key')
+  end
+
+  it "should produce a valid VARIANT element indirectly from an array" do
+    @scr.property('next', '')
+    @scr.next_screen 'default_next'
+    @scr.goto @variant_options[:uri], :if => ["tmlvar:counter", '<', 'tmlvar:loop_count']
+    assert_not_nil nxt = (@scr / "next").first, "screen/next not found"
+    assert_equal 'default_next', nxt.property('uri')
+    assert_not_nil var = (nxt / "variant").first, "screen/next/variant not found"
+    assert_equal @variant_options[:uri], var.property('uri')
+    assert_equal @variant_options[:lo], var.property('lo')
+    assert_equal @variant_options[:ro], var.property('ro')
+    assert_equal @variant_options[:op], var.property('op')
+  end
+
+  it "should produce a valid VARIANT element indirectly from a string" do
+    @scr.property('next', '')
+    @scr.next_screen 'default_next'
+    @scr.goto @variant_options[:uri], :if => "tmlvar:counter < tmlvar:loop_count"
+    assert_not_nil nxt = (@scr / "next").first, "screen/next not found"
+    assert_equal 'default_next', nxt.property('uri')
+    assert_not_nil var = (nxt / "variant").first, "screen/next/variant not found"
+    assert_equal @variant_options[:uri], var.property('uri')
+    assert_equal @variant_options[:lo], var.property('lo')
+    assert_equal @variant_options[:ro], var.property('ro')
+    assert_equal @variant_options[:op], var.property('op')
+  end
+
+  it "should produce a valid VARIANT element directly" do
+    @scr.variant @variant_options
+    assert_not_nil (ele = (@scr / "next").first), "screen/next not found"
+    assert_not_nil (var = (ele / "variant").first), "screen/next/variant not found"
+    assert_equal @variant_options[:uri], var.property('uri')
+    assert_equal @variant_options[:lo], var.property('lo')
+    assert_equal @variant_options[:ro], var.property('ro')
+    assert_equal @variant_options[:op], var.property('op')
+  end
+
+  it "should infer default NEXT element pointing to ASSERT if it does not otherwise exist" do
+    @scr.property('next', '')
+    #assert_raises Rtml::Errors::ScreenVariantError do
+      @scr.variant @variant_options
+    #end
+    # assertion screen is now generated last, just prior to #to_tml
+    #assert_length 1, @tml_docs / "screen[id=assert]", "screen#assert not found"
+    assert_equal "assert", (@scr / "next").first.property('uri'), "generated NEXT['uri'] is not an assertion failure"
+  end
+
+  # test that it raises an error when any required key is missing
+  [:uri, :lo, :op, :ro].each do |key|
+    it "should raise on variant with no #{key}" do
+      assert_raises ArgumentError do
+        @scr.variant @variant_options.without(key)
+      end
+    end
+  end
+
+  it "should respond to entry points" do
+    Rtml::Widgets::ScreenVariants.entry_points.each do |entry_point|
+      assert @scr.respond_to?(entry_point), "Screen does not respond_to? #{entry_point.inspect}"
+    end
+  end
+end

data/spec/widgets/screens_spec.rb

@@ -0,0 +1,55 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::Screens do
+  before :each do
+    @doc = Rtml::Document.new
+  end
+
+  it "should have a #gui_configuration" do
+    Rtml::Widgets::Screens.gui_configuration.should_not be_nil
+  end
+
+  context "with a #gui_configuration" do
+    before(:each) { @gui = Rtml::Widgets::Screens.gui_configuration }
+
+    #it "should have a title" do
+    #  @gui.title.should_not be_blank
+    #end
+
+    it "should construct initialization arguments from a hash of fields" do
+      fields = {:name => "screen_name", :next => "next_screen"}
+      arguments = @gui.construct_arguments(fields)
+      arguments.should == ["screen_name", {:next => "next_screen"}]
+    end
+  end
+
+  it "should find or build a TML screen" do
+    # build a few screens
+    @doc.screen :init, :main, :timeout => 3
+    @doc.screen :main
+    @doc.screens.should have(2).items
+
+    # find and update but don't create a screen
+    scr = @doc.screen(:init, :other)
+    scr.should be_kind_of(Rtml::Dom::ScreenElement)
+    @doc.screens.should have(2).items
+  end
+
+  it "should allow subelements for screens" do
+    # build a few screens
+    @doc.screen :init, :main, :timeout => 3 do
+      setvar :name => "oebr.transid", :lo => '1'
+    end
+
+    @doc.screen :main do
+      display
+    end
+    
+    @doc.screens.should have(2).items
+    @doc.screens.first.elements.should have(1).item
+    @doc.screens.second.elements.should have(1).item
+
+    (@doc.screen(:init) / :setvar).should have(1).setvar
+    (@doc.screen(:main) / :display).should have(1).element
+  end
+end