rtml 1.2.2 → 2.0.0.alpha.1

data/spec/models/rtml/dom/element_spec.rb

@@ -0,0 +1,14 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Dom::Element do
+  before(:each) do
+    @ele = Rtml::Dom::Element.new
+  end
+
+  it "should never create two properties with the same name" do
+    @ele.property :name, "test"
+    @ele.property :name, "test"
+
+    @ele.properties.should have(1).item
+  end
+end

data/spec/models/rtml/dom/frontend_element_spec.rb

@@ -0,0 +1,22 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Dom::FrontendElement do
+  before :each do
+    @doc = Rtml::Document.new(:name => 'magcard')
+    @doc.view.view_paths << File.join(Rtml.root, "spec/support/app/views")
+    @doc.setup_default_document
+  end
+
+  it "should infer view content from subprocessing" do
+    inner_content = "Hello, World"
+    scr = @doc.screen :main
+    cnt = scr.static_content { inner_content }
+    cnt.to_tml.should == inner_content
+  end
+
+  it "should infer view content from document and screen names" do
+    scr = @doc.screen :main
+    cnt = scr.static_content
+    cnt.to_tml.should == "Hello, World!"
+  end
+end

data/spec/models/rtml/dom/property_spec.rb

@@ -0,0 +1,28 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Dom::Property do
+  before :each do
+    @short = Rtml::Dom::Property.new(:name => 'id', :value => 'prop_test_id')
+    @long1 = Rtml::Dom::Property.new(:name => 'id', :value => 'property_test_id_with_long_name')
+    @long2 = Rtml::Dom::Property.new(:name => 'id', :value => 'property_test_id_with_another_long_name')
+  end
+
+  # Replace this with your real tests.
+  it "should restrict length of ID properties" do
+    @short.tml_value.should have(12).characters
+    @long1.tml_value.should have(12).characters
+    @long2.tml_value.should have(12).characters
+  end
+
+  it "should produce unique TML IDs" do
+    @short.to_tml.should_not == @long1.to_tml
+    @short.to_tml.should_not == @long2.to_tml
+    @long1.to_tml.should_not == @long2.to_tml
+  end
+
+  it "should produce the same TML ID consistently" do
+    @short.to_tml.should == @short.to_tml
+    @long1.to_tml.should == @long1.to_tml
+    @long2.to_tml.should == @long2.to_tml
+  end
+end

data/spec/models/rtml/dom/screen_element_spec.rb

@@ -0,0 +1,11 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Dom::ScreenElement do
+  before :each do
+    @ele = Rtml::Dom::ScreenElement.new(:name => :screen)
+  end
+
+  it "should convert its name to a string after instantiation" do
+    @ele.name.should be_a_kind_of(String)
+  end
+end

data/spec/models/rtml/instruction_spec.rb

@@ -0,0 +1,45 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::Instruction do
+  context "built statically" do
+    it "should produce a document from a class method" do
+      rtml_document = Rtml::Instruction.follow([
+        'screen :init, :main',
+        'screen :main',
+        '  display "test"',
+      ])
+
+      rtml_document.should resemble(:tml => [:screen, {:screen => :display}])
+    end
+
+    it "should produce a document from instances" do
+      instructions = [ Rtml::Instruction.new(:name => :screen, :arguments => {:name => :init, :next => :main}),
+                       Rtml::Instruction.new(:name => :screen, :arguments => {:name => :main}) ]
+      instructions.last.instructions.build(:name => :display, :arguments => {:content => "test"})
+
+      rtml_document = Rtml::Document.new
+      rtml_document.setup_default_document
+
+      instructions.each { |instruction| instruction.follow(rtml_document) }
+      rtml_document.should resemble(:tml => [:screen, {:screen => :display}])
+    end
+  end
+
+  context "built dynamically" do
+    context "with an entry point that exists" do
+      it "should be able to find its Widget" do
+        doc = Rtml::Document.create
+        instr = Rtml::Instruction.create(:source => doc, :x => 0, :y => 0, :name => "screen")
+        instr.widget.should == Rtml::Widgets::Screens
+      end
+    end
+
+    context "with an entry point that does not exist" do
+      it "should find a nil Widget" do
+        doc = Rtml::Document.create
+        instr = Rtml::Instruction.create(:source => doc, :x => 0, :y => 0, :name => "missing_entry_point_name")
+        instr.widget.should == nil
+      end
+    end
+  end
+end

data/spec/models/rtml/state/variable_mapping_spec.rb

@@ -0,0 +1,9 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::State::VariableMapping do
+  %w(datetime datetime_start itid model os part_number serial_number).each do |var|
+    it "should map tmlvar:terminal.#{var} to state.#{var}" do
+      subject["terminal.#{var}"].should == var
+    end
+  end
+end

data/spec/models/rtml/state_spec.rb

@@ -0,0 +1,8 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe Rtml::State do
+  # Replace this with your real tests.
+  it "is the truth" do
+    true.should be(true)
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,3 @@
+--exclude "spec/*,gems/*,features/*"
+--rails
+--aggregate "coverage.data"

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format nested
+--loadby mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+unless $rtml_spec_helper_already_loaded
+  $rtml_spec_helper_already_loaded = 1
+  $LOAD_PATH << File.join(File.dirname(__FILE__), 'support/app/controllers')
+
+  # this loads the Rails spec helper, if any, and reloads the current spec helper if run outside of a Rails project
+  # (ie, in the RTML working project dir). Reloading this file is safe thanks to $rtml_spec_helper_already_loaded == 1.
+  require 'spec_helper'
+  unless defined?(RAILS_ROOT)
+    require File.join(File.dirname(__FILE__), 'support/rails')
+    gem 'rspec-rails'
+    gem 'webrat'
+  end
+
+  begin
+    require 'spec/autorun'
+    require 'spec/rails'
+    require 'webrat'
+    require 'webrat/integrations/rspec-rails'
+  rescue LoadError
+    puts $!.message
+    puts
+    puts "Please make sure the following development dependencies are installed before continuing:"
+    puts "  rspec"
+    puts "  rspec-rails"
+    puts "  webrat"
+    exit
+  end
+
+  require 'rtml/test/spec'
+  Spec::Example::ExampleGroupFactory.default(RtmlExampleGroup)
+  # Now... this is redundant for working project tests, but absolutely critical for in-Rails tests.
+  # TODO: Don't load it if it's redundant... Need to know whether it's in-rails or not for that, though.
+  ActionController::Base.view_paths << File.join(File.dirname(__FILE__), 'support/app/views')
+  Rtml.configuration.rtml_helper_paths << File.join(File.dirname(__FILE__), 'support/app/rtml_helpers')
+  Rtml.configuration.widget_paths << File.join(File.dirname(__FILE__), 'support/lib/rtml/widgets')
+  require File.join(File.dirname(__FILE__), 'support/app/controllers/inherited_controller')
+
+  Dir[File.expand_path(File.join(File.dirname(__FILE__),'support/rspec','**','*.rb'))].each {|f| require f }
+
+  Spec::Runner.configure do |config|
+    config.after(:each) do
+      Rtml::Document.destroy_all
+    end
+  end
+end

data/spec/support/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/support/app/controllers/inherited_controller.rb

@@ -0,0 +1,8 @@
+class InheritedController < RtmlController
+  before_filter :i
+
+  # Used for testing instance variable inheritance -- see spec/support/app/rtml_helpers/inherited/index.rb
+  def i
+    @i = 5
+  end
+end

data/spec/support/app/rtml_helpers/inherited/index.rb

@@ -0,0 +1,10 @@
+Rtml.action :index, :inherited do
+  #cache false
+  #expires_at { Time.now }
+  #on :cancel => embedded_app
+
+  screen :overridden, :main do
+    raise "Variable @i is not equal to 5, which means instance variable inheritence has been fubarred." unless @i == 5
+    display :file => 'rtml/index/main'
+  end
+end

data/spec/support/app/rtml_helpers/rtml/index.rb

@@ -0,0 +1,14 @@
+Rtml::actions_for RtmlController do
+  def index
+    expires_at { Time.parse('Thu Apr 15, 11:14 AM') }
+    string :name
+
+    screen :idle, :main do
+      tvars[:name] = 'Colin'
+    end
+
+    screen :main, :main do
+      display
+    end
+  end
+end

data/spec/support/app/views/README.txt

@@ -0,0 +1,6 @@
+These views are used to make sure RTML is mapping views correctly. They are separated from the main application for
+organization's sake. Unit tests wishing to take advantage of these views should make sure to include something like...
+
+  document.view.view_paths << File.join(RAILS_ROOT, "test/views")
+
+...so that the views can be found. By default, RTML view paths are copied from Rails::Configuration.new.view_paths.

data/spec/support/app/views/layouts/layout.rtml.erb

@@ -0,0 +1,3 @@
+header
+<%=yield%>
+footer

data/spec/support/app/views/magcard/_partial.erb

@@ -0,0 +1 @@
+this is a partial

data/spec/support/app/views/magcard/main.rtml.erb

@@ -0,0 +1 @@
+Hello, World!

data/spec/support/app/views/rtml/index.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>Test Output</title>
+  </head>
+  <body>
+    <h1>Test Output</h1>
+    This test output is in HTML format.
+  </body>
+</html>

data/spec/support/app/views/rtml/index/main.rtml.erb

@@ -0,0 +1 @@
+<h1>I'm Here</h1>

data/spec/support/config/database.yml

@@ -0,0 +1,17 @@
+base: &BASE
+  adapter: sqlite3
+  database: <%=File.join(($root_dir ? File.join($root_dir, 'tmp') : 'db'), 'rtml_test_db.sqlite3')%>
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *BASE
+
+test:
+  <<: *BASE
+
+production:
+  <<: *BASE
+
+cucumber:
+  <<: *BASE

data/spec/support/config/environment.rb

@@ -0,0 +1 @@
+# see ../rails.rb

data/spec/support/config/initializers/rtml.rb

@@ -0,0 +1,6 @@
+Rtml.configure do |config|
+  config.log_tml = true
+  #config.widget_paths += [ "widgets" ]
+  #config.rtml_helper_paths += ["spec/support/rtml_helpers"]
+end
+

data/spec/support/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect_rtml :controller => 'rtml', :action => 'index', :format => 'rtml'
+end

data/spec/support/config/tml_dom_ruleset.rb

@@ -0,0 +1,82 @@
+# This file quite literally tells RTML the "rules" governing the TML document structure. You could modify this file
+# if you are directly inventing a TML-ish language of your own, but otherwise it's probably best to leave this file
+# as it is, or else you are at risk of generating invalid TML.
+#
+# Was going to store all of this in the DB, but decided it's probably better for everyone to just static load it.
+# Might revisit this someday, but for now, whatever.
+
+tags %W{
+  a baddata base br call_func card col colgroup dd defaults display div dl dt econn error form getvar h1 h2 h3 h4 h5
+  h6 head hr img input layout li link log logdcl logrec next ol p pinentry postvar pre print prompt screen setvar span
+  strtemplate submit submit_log table tbody td textarea tfoot tform th thead tml tmlpost tr ul vardcl variant
+}
+
+root :tml
+order do
+  head :base, :link, :defaults, :error
+  logdcl :vardcl, :layout
+  screen :setvar, :strtemplate, :logrec, :next, :error, :call_func, :display, :print, :submit, :tform
+  submit :econn, :getvar, :submit_log
+  table :col, :colgroup, :thead, :tfoot, :tbody, :tr
+  tform :baddata, :card, :prompt, :pinentry
+  tml :head, :vardcl, :logdcl, :screen
+end
+children :layout, all_tag_names - [:form]
+children :print, %W{div dl h1 h2 h3 h4 h5 h6 hr img log ol p pre table ul form}
+children :display, %W{a br div dl form getvar h1 h2 h3 h4 h5 h6 hr img input log ol p pre span table textarea ul}
+children :p, %W{a br getvar input span textarea}
+children do
+  a :img
+  baddata %W{a br div dl h1 h2 h3 h4 h5 h6 hr img getvar ol p pre span table ul}
+  colgroup :col
+  dd %W{a br span getvar input textarea div dl h1 h2 h3 h4 h5 h6 hr img ol p pre table ul form}
+  div %W{a br div dl form getvar h1 h2 h3 h4 h5 h6 hr img input ol p pre span table textarea ul}
+  dl %W{dt dd}, :minimum => 1 #dt+ dd+
+  dt %W{a br div dl form getvar h1 h2 h3 h4 h5 h6 hr img input ol p pre span table textarea ul}
+  econn :variant #variant*
+  error :variant #variant*
+  form %W{div dl h1 h2 h3 h4 h5 h6 hr img ol p pre table ul input textarea}
+  h1 %W{a br getvar input span textarea}
+  h2 %W{a br getvar input span textarea}
+  h3 %W{a br getvar input span textarea}
+  h4 %W{a br getvar input span textarea}
+  h5 %W{a br getvar input span textarea}
+  h6 %W{a br getvar input span textarea}
+  head %W{base defaults error}, :minimum => 0, :maximum => 1 #base?, defaults?, error?
+  head :link # link*
+  input :baddata, :minimum => 0, :maximum => 1
+  li %W{a br span getvar input textarea div dl h1 h2 h3 h4 h5 h6 hr img ol p pre table ul form}
+  log %W{vardcl layout}
+  send :next, %W{variant}
+  ol :li
+  pre %W{a br getvar input span textarea}
+  prompt %W{div dl h1 h2 h3 h4 h5 h6 hr img ol p pre table ul}
+  screen %W{setvar strtemplate logrec}
+  screen %W{next error call_func display print submit tform}, :maximum => 1
+  span %W{a br span getvar input textarea}
+  strtemplate :getvar, :minimum => 0, :maximum => 9
+  submit :econn, :maximum => 1
+  submit %W{getvar submit_log}
+  table %W{col colgroup tbody tr}
+  table %W{thead tfoot}, :maximum => 1
+  tbody :tr
+  td %W{a br span getvar input textarea div dl h1 h2 h3 h4 h5 h6 hr img ol p pre table ul form dd display li print td
+        th}
+  textarea :baddata, :maximum => 1
+  tfoot :tr
+  tform %W{baddata prompt}, :maximum => 1
+  tform :card
+  tform :pinentry, :maximum => 1
+  th %W{a br span getvar input textarea div dl h1 h2 h3 h4 h5 h6 hr img ol p pre table ul form dd display li print td
+        th}
+  thead :tr
+  tml :head, :maximum => 1
+  tml %W{vardcl logdcl screen}
+  tmlpost :postvar
+  tr :th, :td
+  ul :li
+  variant :li
+end
+
+freeze # prevent further modification of the rules
+

data/spec/support/db/schema.rb

@@ -0,0 +1,14 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/spec/support/lib/rtml/widgets/test_widget1.rb

@@ -0,0 +1,15 @@
+class TestWidget1 < Rtml::Widget
+  affects :document # a model
+  entry_point :start1, :hash_entry_1, :hash_entry_2
+  entry_point :missing_widget_entry_point
+
+  shared :hash_with_value => Hash
+
+  def hash_entry_1
+    hash_with_value[:value] = 1
+  end
+
+  def hash_entry_2
+    hash_with_value[:value] = 2 unless hash_with_value[:value] == 1
+  end
+end

data/spec/support/lib/rtml/widgets/test_widget2.rb

@@ -0,0 +1,4 @@
+class TestWidget2 < Rtml::Widget
+  affects :screen   # an element name
+  entry_point :start2
+end

data/spec/support/rails.rb

@@ -0,0 +1,22 @@
+RAILS_ROOT = File.join(File.dirname(__FILE__)) unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    unless defined?(vendor_rails?)
+      def vendor_rails?
+        false
+      end
+    end
+  end
+end
+
+require 'rubygems'
+gem 'rails', '>= 2.3.5'
+require 'initializer'
+
+Rails::Initializer.run do |config|
+  # NOTE: this gem should match the version unpacked in vendor/gems, NOT any installed or working copies!
+  config.gem 'rtml-bootstrapper', :version => '2.0.0', :lib => 'init_rtml_working_copy'
+  config.action_controller.session = { :key => '_myapp_session', :secret => '1'*60 }
+  config.log_path = File.join($root_dir, "tmp/rtml.log") if $root_dir
+end