rtml 1.2.2 → 2.0.0.alpha.1

data/spec/widgets/static_content_spec.rb

@@ -0,0 +1,43 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::StaticContent do
+  before :each do
+    @doc = Rtml::Document.new(:name => 'magcard', :view_path => File.join(Rtml.root, "spec/support/app/views"))
+    @scr = @doc.screen :main
+  end
+
+  it "should accept a string instead of options or block" do
+    assert_nothing_raised do
+      sc = @scr.static_content("hello")
+      assert_equal "hello", sc.to_tml
+    end
+  end
+
+  it "should accept a partial hash" do
+    assert_nothing_raised do
+      sc = @scr.static_content(:partial => 'partial')
+      assert_equal 'this is a partial', sc.to_tml
+    end
+  end
+
+  it "should accept a file hash" do
+    assert_nothing_raised do
+      sc = @scr.static_content(:file => 'main')
+      assert_equal 'Hello, World!', sc.to_tml
+    end
+  end
+
+  it "should accept no arguments" do
+    assert_nothing_raised do
+      sc = @scr.static_content
+      assert_equal 'Hello, World!', sc.to_tml
+    end
+  end
+
+  it "should accept a block with no other arguments" do
+    assert_nothing_raised do
+      sc = @scr.static_content { "Hello, World" }
+      assert_equal "Hello, World", sc.to_tml
+    end
+  end
+end

data/spec/widgets/subroutine_spec.rb

@@ -0,0 +1,109 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Widgets::Subroutine do
+  before :each do
+    @doc = Rtml::Document.new
+    @doc.boolean :condition_var
+    @doc.boolean :txn_is_emv
+
+    @doc.subroutine :return_true do |args|
+      return true
+    end
+
+    @doc.subroutine :return_false do |args|
+      return false
+    end
+
+    @doc.subroutine :check_is_emv do |args|
+      _if(tvars[:txn_is_emv] == true) { return true }
+      _else { return false }
+    end
+
+    @doc.subroutine :check_condition do |args|
+      tvars[args[:name]] = args[:value]
+      _if(tvars[args[:name]] == true) { goto :condition_is_true }
+      _else { goto :condition_is_untrue }
+    end
+  end
+
+  it "should declare the subroutine return variable" do
+    # the var isn't created until a sub is called.
+    @doc.screen :i do call(:return_true) end
+    assert @doc.variable?(:rtml_sub_return_val)
+  end
+
+  it "should be able to query whether a symbol or string is a subroutine name" do
+    assert @doc.subroutine?("return_true")
+    assert @doc.subroutine?(:return_false)
+    assert @doc.subroutine?(:check_condition)
+    assert !@doc.subroutine?(:not_a_sub)
+    assert !@doc.subroutine?('not_a_sub')
+
+    # and now from a child...
+    assert_raises RuntimeError, "subroutine :return_true not found" do
+      @doc.screen :some_screen do
+        raise if subroutine?("return_true")
+      end
+    end
+  end
+
+  it "should be able to transform the document directly" do
+    @doc.screen :condition_check_screen do
+      call :check_condition, :name => :condition_var, :value => true
+    end
+    
+    #puts @tml_docs.to_tml
+  end
+
+  # add your own tests here
+  it "should contain 2 subroutines called return_true and return_false" do
+    #assert_length 4, @tml_docs.subroutines
+    assert @doc.subroutines.keys.include?('return_true')
+    assert @doc.subroutines.keys.include?('return_false')
+  end
+
+  it "should raise NoMethodError if subroutine does not exist" do
+    assert_raises NoMethodError do
+      @doc.screen(:a_screen).call :no_method
+    end
+  end
+
+  it "should be able to call a subroutine and get the correct response" do
+    @scr = @doc.screen :a_screen
+    assert_equal ["tmlvar:rtml_sub_return_val", "equal", "tmlvar:rtml_sub_return_val"],
+                 @scr.call(:return_true) == "tmlvar:rtml_sub_return_val"
+    assert_not_nil(@var = (@scr / "setvar[name=rtml_sub_return_val]").first)
+    assert_equal true, @var.property('lo')
+    @var.to_tml.should be_valid_tml
+    assert((tml = @scr.to_tml) =~ /setvar[^>]+?lo=["']1["']/, tml)
+
+    assert_equal ["tmlvar:rtml_sub_return_val", "equal", "tmlvar:rtml_sub_return_val"],
+                 @scr.call(:return_false) == "tmlvar:rtml_sub_return_val"
+    assert_not_nil(@var = (@scr / "setvar[name=rtml_sub_return_val]").last)
+    assert_equal false, @var.property('lo')
+    @var.to_tml.should be_valid_tml
+    assert((tml = @scr.to_tml) =~ /setvar[^>]+?lo=["']0["']/, tml)
+
+    # make sure it generated setvars -- why is this necessary??
+    # update - turns out to be an artifact from reordering elements in ElementBuilder#rebuild_invalid_elements.
+    # Resolved, by simply re-adding the same element instead of building an all new one.
+    assert @doc.to_tml =~ /setvar[^>]+?lo=["']1["']/, "element missing - check ElementBuilder#rebuild_invalid_elements"
+    assert @doc.to_tml =~ /setvar[^>]+?lo=["']0["']/, "element missing - check ElementBuilder#rebuild_invalid_elements"
+  end
+
+  it "should be able to conditionally respond to subroutine results" do
+    @doc.string :ret
+    @doc.screen :get_return_value, :check_return_value do
+      tvars[:ret] = call(:check_is_emv)
+    end
+
+    @doc.screen :check_return_value do
+      _if(tvars[:ret] == true) { goto :condition_was_true }
+      _elsif(tvars[:ret] == false) { goto :condition_was_false }
+      _else { goto :condition_was_not_boolean }
+    end
+
+    # TODO: Above produces the expected TML result. Assert that this is true, and then start playing with syntax.
+    #puts @tml_docs.to_tml
+  end
+end

data/tasks/db.rake

@@ -0,0 +1,6 @@
+namespace :db do
+  desc "Run the RTML database migrations"
+  task :migrate do
+    ActiveRecord::Migrator.migrate(File.join(Rtml.root, "rails_generators/rtml/templates/db/migrate"))
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,20 @@
+require 'lib/rtml'
+
+require 'spec/rake/spectask'
+
+Rake.application.instance_variable_get('@tasks').delete('default')
+
+spec_prereq = File.exist?(File.join(RAILS_ROOT, 'config', 'database.yml')) ? "db:test:prepare" : :noop
+task :noop do
+end
+
+#task :default => :spec
+#task :stats => "spec:statsetup"
+
+remove_task :spec
+desc "Run all specs in spec directory (excluding plugin specs)"
+Spec::Rake::SpecTask.new(:rspec => spec_prereq) do |t|
+  t.spec_opts = ['--options', "\"./spec/spec.opts\""]
+  #t.ruby_opts = ["-e 'RTML_ROOT = #{RTML_ROOT.inspect}'"]
+  t.spec_files = FileList[File.join(RTML_ROOT, 'spec/**/*_spec.rb')]
+end

data/tasks/rtml.rake

@@ -0,0 +1,5 @@
+#require 'rake/testtask'
+require 'rake/rdoctask'
+#require 'tasks/rails'
+#
+load File.expand_path(File.join(File.dirname(__FILE__), '../rails_generators/rtml/templates/lib/tasks/rtml.rake'))

data/test/test_generator_helper.rb

@@ -1,3 +1,25 @@
+### This is necessary to fake Rails into not throwing an error.
+# ...don't ask.
+class Configuration
+  attr_reader :plugin_paths
+
+  def initialize
+    @plugin_paths = []
+  end
+end
+
+module Rails
+  def self.configuration
+    Configuration.new
+  end
+end
+
+
+
+
+
+
+
 begin
   require File.dirname(__FILE__) + '/test_helper'
 rescue LoadError

data/test/test_helper.rb

@@ -1,3 +1,3 @@
 require 'stringio'
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/rtml'
+

data/test/test_rtml_action_generator.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+require 'rails_generator'
+
+class TestRtmlActionGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_screens
+    controller_name = "rtml"
+    action_name = "index"
+    screen_names = %w()
+    run_generator('rtml_action', [controller_name, action_name, *screen_names], sources)
+
+    assert_directory_exists "app/rtml_actions/rtml"
+    assert_directory_exists "app/views/rtml"
+    assert_generated_file "app/rtml_actions/rtml/index.rb"
+    assert_generated_file "app/views/rtml/index/idle.rtml.erb"
+  end
+
+  def test_generator_with_screens
+    controller_name = "rtml"
+    action_name = "index"
+    screen_names = %w(idle main enter_pin)
+    run_generator('rtml_action', [controller_name, action_name, *screen_names], sources)
+
+    assert_directory_exists "app/rtml_actions/rtml"
+    assert_directory_exists "app/views/rtml"
+    assert_generated_file "app/rtml_actions/rtml/index.rb"
+    assert_generated_file "app/views/rtml/index/idle.rtml.erb"
+    assert_generated_file "app/views/rtml/index/main.rtml.erb"
+    assert_generated_file "app/views/rtml/index/enter_pin.rtml.erb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "rails_generators"
+  end
+end

data/test/test_rtml_generator.rb

@@ -1,5 +1,7 @@
 require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
 
+require 'rails_generator'
+
 class TestRtmlGenerator < Test::Unit::TestCase
   include RubiGen::GeneratorTestHelper
 
@@ -26,9 +28,27 @@ class TestRtmlGenerator < Test::Unit::TestCase
   #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
 
   def test_generator_without_options
-    run_generator('rtml', [APP_ROOT], sources)
-    assert_directory_exists "path/to/included/folder"
-    assert_generated_file   "path/to/included/folder/some_file"
+    run_generator('rtml', [], sources)
+    assert_directory_exists "config/initializers"
+    assert_directory_exists "db/migrate"
+    assert_directory_exists 'lib/tasks'
+    assert_directory_exists 'doc'
+
+    assert_generated_file "config/initializers/rtml.rb"
+    assert_generated_file "config/tml_dom_ruleset.rb"
+    assert_generated_file 'lib/tasks/rtml.rake'
+    assert_generated_file 'doc/io_tml-application-development-guidelines.pdf'
+
+    # migrations
+    assert_generated_file "db/migrate/20100113131401_add_options_to_properties.rb"
+    assert_generated_file "db/migrate/20100110071920_add_parent_id_to_rtml_instructions.rb"
+    assert_generated_file "db/migrate/20100110060124_create_rtml_instructions.rb"
+    assert_generated_file "db/migrate/20100108165127_create_rtml_documents.rb"
+    assert_generated_file "db/migrate/20100108163827_create_rtml_dom_properties.rb"
+    assert_generated_file "db/migrate/20100108163703_create_rtml_dom_elements.rb"
+    assert_generated_file "db/migrate/20100127173146_add_parent_type_to_rtml_dom_elements.rb"
+    assert_generated_file "db/migrate/20100208114234_create_rtml_states.rb"
+    assert_generated_file "db/migrate/20100303021609_add_x_and_y_to_rtml_instructions.rb"
   end
 
   private
@@ -38,6 +58,6 @@ class TestRtmlGenerator < Test::Unit::TestCase
   end
 
   def generator_path
-    "app_generators"
+    "rails_generators"
   end
 end

data/test/test_rtml_widget_generator.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestRtmlWidgetGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  def test_generator_without_options
+    name = "widget_name"
+    run_generator('rtml_widget', [name], sources)
+    assert_directory_exists "lib/rtml/widgets"
+    assert_directory_exists "test/unit/rtml/widgets"
+
+    assert_generated_file   "lib/rtml/widgets/#{name}.rb"
+    assert_generated_file   "test/unit/rtml/widgets/#{name}_test.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "generators"
+  end
+end

data/test/test_widget_generator.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+require 'rails_generator'
+
+class TestWidgetGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "widget_name"
+    run_generator('widget', [name], sources)
+    assert_directory_exists "lib/rtml/widgets"
+    assert_directory_exists "test/unit/rtml/widgets"
+
+    assert_generated_file   "lib/rtml/widgets/#{name}.rb"
+    assert_generated_file   "test/unit/rtml/widgets/#{name}_test.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "rails_generators"
+  end
+end

data/update.rb

@@ -0,0 +1,19 @@
+# RTML v1.x used this file as an update hook. When RTML was run in development mode, during
+# startup, it would request this file from the RTML GitHub repository and eval it. This file
+# would check the remote (github) version of RTML against the installed version, and
+# report to the user if there is an update available. All of this would only happen if the
+# Rails environment was non-production, and if ENV['RTML_UPDATE'] was true or undefined.
+#
+# Later versions of RTML don't do this check at all because updating RTML could potentially
+# break an existing app -- which means that most users would never perform an in-place upgrade.
+# That simple fact makes the whole update hook pretty much useless.
+#
+# That said, this file no longer actually performs any update checking for either RTML 1.x or
+# any other version, and is simply here to prevent errors from being raised in old versions.
+# (Those errors would just be silenced and ignored anyways, but I like to keep it clean.)
+#
+module RtmlUpdateCheck
+  class RtmlUpdateFailure < RuntimeError; end
+end
+
+nil