rtml 2.0.3 → 2.0.4

data/History.txt

@@ -1,3 +1,6 @@
+=== 2.0.3 2010-04-19
+* RTML 2.0 released!
+
 === 0.0.1 2010-04-12
 
 * 1 major enhancement:

data/Manifest.txt

@@ -9,6 +9,9 @@ app_generators/rtml/templates/rtml_template.rb
 bin/rtml
 builtin/controllers/rtml_controller.rb
 builtin/models/rtml/document.rb
+builtin/models/rtml/document_model_object.rb
+builtin/models/rtml/dom/collections/element_set.rb
+builtin/models/rtml/dom/collections/property_set.rb
 builtin/models/rtml/dom/element.rb
 builtin/models/rtml/dom/frontend_element.rb
 builtin/models/rtml/dom/property.rb
@@ -33,7 +36,7 @@ builtin/widgets/screen_variants.rb
 builtin/widgets/screens.rb
 builtin/widgets/shorthand.rb
 builtin/widgets/static_content.rb
-builtin/widgets/subroutine.rb
+do_profile.rb
 generators/rtml_widget/USAGE
 generators/rtml_widget/rtml_widget_generator.rb
 generators/rtml_widget/templates/default_widget.erb
@@ -47,6 +50,7 @@ lib/extensions/hpricot/doc.rb
 lib/extensions/hpricot/elem.rb
 lib/extensions/string.rb
 lib/rtml.rb
+lib/rtml/assigns.rb
 lib/rtml/configuration.rb
 lib/rtml/controller/before_filters.rb
 lib/rtml/controller/cache_helpers.rb
@@ -60,6 +64,7 @@ lib/rtml/controller/url_helpers.rb
 lib/rtml/dependencies.rb
 lib/rtml/dsl.rb
 lib/rtml/environment.rb
+lib/rtml/errors/application_error.rb
 lib/rtml/errors/invalid_format.rb
 lib/rtml/errors/invalid_operation.rb
 lib/rtml/errors/invalid_option_error.rb
@@ -70,25 +75,33 @@ lib/rtml/errors/processing_error.rb
 lib/rtml/errors/rules_violation_error.rb
 lib/rtml/errors/screen_not_found.rb
 lib/rtml/errors/screen_variant_error.rb
+lib/rtml/errors/simulation_error.rb
 lib/rtml/errors/sti_type_error.rb
 lib/rtml/errors/subprocessing_not_supported.rb
 lib/rtml/errors/unknown_rtml_action.rb
+lib/rtml/errors/variable_error.rb
 lib/rtml/high_level/managed_variable.rb
-lib/rtml/high_level/subroutine.rb
 lib/rtml/high_level/variable_manager.rb
 lib/rtml/inherited_instance_variables.rb
 lib/rtml/init.rb
-lib/rtml/reverse_engineering/crawler.rb
-lib/rtml/reverse_engineering/simulator.rb
-lib/rtml/reverse_engineering/simulator/casting.rb
-lib/rtml/reverse_engineering/simulator/snapshot.rb
-lib/rtml/reverse_engineering/simulator/variable_lookup.rb
-lib/rtml/reverse_engineering/simulator/variable_value.rb
+lib/rtml/links.rb
 lib/rtml/rules/dom_ruleset.rb
 lib/rtml/rules/dom_tag.rb
 lib/rtml/rules/dom_validation.rb
 lib/rtml/rules/tml_param_parser.rb
+lib/rtml/test/builtin_variables.rb
+lib/rtml/test/resemblance_test.rb
+lib/rtml/test/screen.rb
+lib/rtml/test/simulator.rb
+lib/rtml/test/simulator_post_processors/base.rb
+lib/rtml/test/simulator_post_processors/card_parsers.rb
+lib/rtml/test/simulator_post_processors/receipt.rb
+lib/rtml/test/simulator_post_processors/submit.rb
 lib/rtml/test/spec.rb
+lib/rtml/test/spec/matchers.rb
+lib/rtml/test/tml_application.rb
+lib/rtml/test/unit.rb
+lib/rtml/test/variable_scope.rb
 lib/rtml/tmlized_conditions.rb
 lib/rtml/version.rb
 lib/rtml/widget.rb
@@ -113,6 +126,9 @@ rails_generators/rtml/templates/db/migrate/20100113131401_add_options_to_propert
 rails_generators/rtml/templates/db/migrate/20100127173146_add_parent_type_to_rtml_dom_elements.rb
 rails_generators/rtml/templates/db/migrate/20100208114234_create_rtml_states.rb
 rails_generators/rtml/templates/db/migrate/20100303021609_add_x_and_y_to_rtml_instructions.rb
+rails_generators/rtml/templates/db/migrate/20100513165226_add_options_to_rtml_documents.rb
+rails_generators/rtml/templates/db/migrate/20100513165242_remove_dom_elements_mirror.rb
+rails_generators/rtml/templates/db/migrate/20100513165249_remove_dom_properties_mirror.rb
 rails_generators/rtml/templates/doc/io_tml-application-development-guidelines.pdf
 rails_generators/rtml/templates/lib/tasks/rtml.rake
 rails_generators/rtml_action/USAGE
@@ -125,22 +141,26 @@ rails_generators/widget/templates/default_widget.feature.erb
 rails_generators/widget/templates/default_widget_spec.erb
 rails_generators/widget/templates/default_widget_test.erb
 rails_generators/widget/widget_generator.rb
+rtml.gemspec
 script/console
 script/destroy
 script/generate
 script/server
 spec/controllers/inherited_controller_spec.rb
 spec/controllers/rtml_controller_spec.rb
+spec/integration/post_tests_spec.rb
 spec/lib/extensions/hpricot/doc_spec.rb
 spec/lib/extensions/hpricot/elem_spec.rb
 spec/lib/extensions/string_spec.rb
 spec/lib/rtml/extensions_spec.rb
-spec/lib/rtml/reverse_engineering/crawler_spec.rb
-spec/lib/rtml/reverse_engineering/simulator/variable_value_spec.rb
-spec/lib/rtml/reverse_engineering/simulator_spec.rb
+spec/lib/rtml/high_level/variable_manager_spec.rb
 spec/lib/rtml/routes_spec.rb
 spec/lib/rtml/rules/dom_ruleset_spec.rb
 spec/lib/rtml/rules/dom_validation_spec.rb
+spec/lib/rtml/test/simulator/receipt_spec.rb
+spec/lib/rtml/test/simulator_spec.rb
+spec/lib/rtml/test/tml_application_spec.rb
+spec/lib/rtml/test/variable_scope_spec.rb
 spec/lib/rtml/widget_core/generic_widget_consumer_spec.rb
 spec/lib/rtml/widget_core/gui_configuration_spec.rb
 spec/lib/rtml/widget_core/widget_proxy_spec.rb
@@ -155,29 +175,45 @@ spec/models/rtml/instruction_spec.rb
 spec/models/rtml/state/variable_mapping_spec.rb
 spec/models/rtml/state_spec.rb
 spec/rcov.opts
+spec/rtml_action_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 spec/support/app/controllers/application_controller.rb
 spec/support/app/controllers/inherited_controller.rb
+spec/support/app/controllers/post_tests_controller.rb
 spec/support/app/rtml_helpers/inherited/index.rb
 spec/support/app/rtml_helpers/rtml/index.rb
 spec/support/app/views/README.txt
+spec/support/app/views/inherited/instance_variables_test/display.rtml.erb
 spec/support/app/views/layouts/layout.rtml.erb
 spec/support/app/views/magcard/_partial.erb
 spec/support/app/views/magcard/main.rtml.erb
 spec/support/app/views/rtml/index.html.erb
 spec/support/app/views/rtml/index/main.rtml.erb
+spec/support/config/boot.rb
 spec/support/config/database.yml
 spec/support/config/environment.rb
 spec/support/config/environments/development.rb
 spec/support/config/initializers/rtml.rb
 spec/support/config/routes.rb
-spec/support/config/tml_dom_ruleset.rb
 spec/support/db/rtml_test_db.sqlite3
 spec/support/db/schema.rb
 spec/support/lib/rtml/widgets/test_widget1.rb
 spec/support/lib/rtml/widgets/test_widget2.rb
 spec/support/rails.rb
+spec/support/raw_tml/avs.tml
+spec/support/raw_tml/document_level_events.tml
+spec/support/raw_tml/empty_screen.tml
+spec/support/raw_tml/enter_amount.tml
+spec/support/raw_tml/foreign_receiver.tml
+spec/support/raw_tml/foreign_reference.tml
+spec/support/raw_tml/hello_world.tml
+spec/support/raw_tml/loop_x_times.tml
+spec/support/raw_tml/one_screen_with_setvar.tml
+spec/support/raw_tml/receipt.tml
+spec/support/raw_tml/simulator.tml
+spec/support/raw_tml/tmlvar_reference.tml
+spec/support/raw_tml/user_input.tml
 spec/support/raw_tml/valid_document.tml
 spec/support/rspec/example_groups.rb
 spec/support/rspec/matchers.rb
@@ -192,11 +228,13 @@ spec/widgets/highlevel_variable_processing_spec.rb
 spec/widgets/screen_variable_processing_spec.rb
 spec/widgets/screen_variants_spec.rb
 spec/widgets/screens_spec.rb
+spec/widgets/simulator_post_processors/card_parsers_spec.rb
+spec/widgets/simulator_post_processors/submit_spec.rb
 spec/widgets/static_content_spec.rb
-spec/widgets/subroutine_spec.rb
 tasks/db.rake
 tasks/rspec.rake
 tasks/rtml.rake
+tasks/stats.rake
 test/test_generator_helper.rb
 test/test_helper.rb
 test/test_rtml_action_generator.rb

data/Rakefile

@@ -1,5 +1,9 @@
 #RTML_ROOT = File.expand_path(File.join(File.dirname(__FILE__)))
 #require 'rubygems'
+unless defined?(Rails)
+  gem 'rails', '= 2.3.5'
+end
+
 require './spec/support/rails'
 gem 'hoe', '>= 2.1.0'
 require 'hoe'
@@ -19,7 +23,8 @@ $hoe = Hoe.spec 'rtml' do
   self.extra_dev_deps       = [['rspec','>= 1.3.0'], ['rspec-rails','>= 1.3.2'], ['webrat', '>= 0.7.0']]
   self.version              = Rtml::VERSION::STRING
   self.readme_file          = "README.rdoc"
-  self.summary = "RubyTML (or just RTML) is a Ruby framework for communicating with Ingenico's Incendo-based payment devices."
+  self.summary = self.description =
+          "RubyTML (or just RTML) is a Ruby framework for communicating with Ingenico's Incendo-based payment devices."
 end
 
 require 'newgem/tasks'

data/builtin/controllers/rtml_controller.rb

@@ -13,8 +13,16 @@ class RtmlController < (defined? Rails) ? ApplicationController : ActionControll
   hide_action :rtml_document, :rtml_exception
   hide_action :screen_layout, :embedded_app
   helper_method :screen_layout, :embedded_app
-
   rescue_from Exception, :with => :rtml_exception
+  
+  # These are instance variables which will not be copied into RTML Actions or Widgets.
+  class_inheritable_array :rtml_protected_instance_variables
+  read_inheritable_attribute(:rtml_protected_instance_variables) ||
+          write_inheritable_attribute(:rtml_protected_instance_variables, %w(
+            @during_finalization_blocks @terminal_state @rtml_helpers @exception @rtml_document @_request
+            @render_proxy @real_format @update @template
+          ))
+  delegate :rtml_protected_instance_variables, :to => "self.class"
 
   def rtml_exception
     add_view_path(File.expand_path(File.join(Rtml.root, 'builtin/views')))
@@ -28,6 +36,8 @@ class RtmlController < (defined? Rails) ? ApplicationController : ActionControll
 
     if (params[:error_mode] == 'rtml' || rtml) && rtml_helpers.respond_to?(method)
       @exception = $!
+      Rails.logger.error $!.message
+      Rails.logger.error $!.backtrace.join("\n    ")
       rtml_document.reset!
       erase_results
       render :rtml => method
@@ -50,6 +60,7 @@ class RtmlController < (defined? Rails) ? ApplicationController : ActionControll
                                           :controller => self)
   end
 
+
   protected
   def add_view_path(path)
     view_paths << path

data/builtin/models/rtml/document.rb

@@ -3,15 +3,18 @@ class Rtml::Document < ActiveRecord::Base
   @@ruleset_file = File.expand_path(File.join(Rtml.root, "rails_generators/rtml/templates/config/tml_dom_ruleset.rb")) unless File.file?(@@ruleset_file)
   include Rtml::DSL
   include Rtml::Widgets
+  include Rtml::Assigns
   include ActionController::Layout
   layout :layout
   
   set_table_name 'rtml_documents'
-  has_one :root, :class_name => 'Rtml::Dom::Element', :as => :parent, :autosave => true
+  attr_accessor :root
+  #has_one :root, :class_name => 'Rtml::Dom::Element', :as => :parent, :autosave => true
   has_many :instructions, :class_name => 'Rtml::Instruction', :as => :source, :autosave => true
   attr_reader :rules, :controller
   delegate :render, :view_paths, :view_paths=, :to => :view
   delegate :request, :response, :params, :flash, :to => :controller
+  serialize :options, HashWithIndifferentAccess
 
   validates_presence_of :name
   validates_uniqueness_of :name
@@ -19,30 +22,35 @@ class Rtml::Document < ActiveRecord::Base
   def initialize_with_default_document(attributes = nil)
     if attributes
       @controller = attributes.delete(:controller)
-      @initialize_to_empty = attributes.delete(:empty)
       apply_document_options(attributes)
+      attributes.merge!(:options => { :initialize_to_empty => attributes.delete(:empty) })
     end
-    initialize_without_default_document(attributes)
+    initialize_without_default_document(attributes ? attributes.with_indifferent_access : nil)
   end
 
   include Rtml::InheritedInstanceVariables
-  protected_instance_variables.concat ["@controller", "@changed_attributes", "@view", "@new_record", "@initialize_to_empty", "@widget_instances", "@rules", "@root", "@attributes_cache", "@attributes"]
-  
+  protected_instance_variables.concat %w(
+    @controller @changed_attributes @view @new_record @initialize_to_empty @widget_instances
+    @rules @root @attributes_cache @attributes @during_finalization_blocks @instructions @layout_file
+  )
+  alias_method_chain :initialize, :default_document
+
   def after_initialize
-    @rules = Rtml::Document.rules
-    if new_record? && !@initialize_to_empty
+    self.options ||= HashWithIndifferentAccess.new
+    @rules ||= Rtml::Document.rules
+    if !options[:initialize_to_empty]
       setup_default_document
     end
   end
 
-  # This calls root.target, because root is technically an Association object, and target retrieves the actual object.
-  # This resolves ambiguities such as root.build(), which exists as both an Association method (build a new root object)
-  # and as a Widget method (build a new RTML Element).
-  def root_with_target
-    root_without_target.nil? ? nil : root_without_target.target
-  end
-
-  alias_method_chain :root, :target
+#  # This calls root.target, because root is technically an Association object, and target retrieves the actual object.
+#  # This resolves ambiguities such as root.build(), which exists as both an Association method (build a new root object)
+#  # and as a Widget method (build a new RTML Element).
+#  def root_with_target
+#    root_without_target.nil? ? nil : root_without_target.target
+#  end
+#
+#  alias_method_chain :root, :target
 
   def layout(assignment = :_no_assignment)
     if assignment != :_no_assignment
@@ -93,12 +101,10 @@ class Rtml::Document < ActiveRecord::Base
     end
   end
 
-  alias_method_chain :initialize, :default_document
-
   def reset!
     #elements.destroy_all
     #self.elements = []
-    root.destroy if root
+    #root.destroy if root
     self.root = nil
     setup_default_document
     self

data/builtin/models/rtml/document_model_object.rb

@@ -0,0 +1,6 @@
+# A placeholder. In RTML, we often check whether an object is an instance of, say, ActiveRecord::Base.
+# Since we may or may not back out ActiveRecord::Base, we need something to stand in as a superclass
+# of all Widget-able models.
+class Rtml::DocumentModelObject
+
+end

data/builtin/models/rtml/dom/collections/element_set.rb

@@ -0,0 +1,6 @@
+class Rtml::Dom::Collections::ElementSet < Array
+  def destroy_all
+    each { |item| item.before_destroy if item.respond_to?(:before_destroy) }
+    clear
+  end
+end

data/builtin/models/rtml/dom/collections/property_set.rb

@@ -0,0 +1,11 @@
+class Rtml::Dom::Collections::PropertySet < Array
+  def build(options)
+    self << (ret = Rtml::Dom::Property.new(options))
+    ret
+  end
+
+  def destroy_all
+    each { |item| item.before_destroy if item.respond_to?(:before_destroy) }
+    clear
+  end
+end

data/builtin/models/rtml/dom/element.rb

@@ -1,24 +1,40 @@
-class Rtml::Dom::Element < ActiveRecord::Base
+class Rtml::Dom::Element < Rtml::DocumentModelObject
   @@tml_ids = {}
-  set_table_name 'rtml_dom_elements'
-  belongs_to :document, :class_name => 'Rtml::Document'
-  belongs_to :parent, :polymorphic => true#:class_name => 'Rtml::Dom::Element'
-  has_many :elements, :class_name => 'Rtml::Dom::Element', :as => :parent, :autosave => true
-  has_many :properties, :class_name => 'Rtml::Dom::Property', :foreign_key => 'element_id', :autosave => true
-  #alias_method :children, :elements
+#  set_table_name 'rtml_dom_elements'
+#  belongs_to :document, :class_name => 'Rtml::Document'
+#  belongs_to :parent, :polymorphic => true#:class_name => 'Rtml::Dom::Element'
+#  has_many :elements, :class_name => 'Rtml::Dom::Element', :as => :parent, :autosave => true
+#  #has_many :properties, :class_name => 'Rtml::Dom::Property', :foreign_key => 'element_id', :autosave => true
   include Rtml::DSL
   include Rtml::Widgets
+  include Rtml::Assigns
   
   delegate :request, :response, :params, :flash, :controller, :to => :document
   delegate :params, :url_for, :to => :controller
 
+  attr_accessor :document, :parent, :elements
+  attr_writer :name
+
+  class_inheritable_array :rtml_protected_instance_variables
+  read_inheritable_attribute(:rtml_protected_instance_variables) || write_inheritable_attribute(:rtml_protected_instance_variables, %w(
+    @name @parent @during_finalization_blocks @properties @document @elements
+  ))
+
+  def properties
+    @properties ||= Rtml::Dom::Collections::PropertySet.new
+  end
+
   def initialize(*args) #:nodoc:
+    @elements = Rtml::Dom::Collections::ElementSet.new
     options = args.extract_options!
     options[:name] = options[:name].to_s if options.key?(:name)
     properties = options.delete(:properties)
-    if options.empty? then super(options)
-    else super options
-    end
+    @name = options[:name]
+    @document = options[:document]
+    #if options.empty? then super(options)
+    #else super options
+    #end
+    after_initialize if respond_to?(:after_initialize)
     update_properties(properties) if properties
   end
 
@@ -32,7 +48,7 @@ class Rtml::Dom::Element < ActiveRecord::Base
   def rules; document ? document.rules : nil; end           #:nodoc:
 
   def name #:nodoc:
-    (s = super).kind_of?(String) ? s : s.to_s
+    @name.kind_of?(String) ? @name : @name.to_s
   end
 
   def contains?(query)
@@ -90,16 +106,28 @@ class Rtml::Dom::Element < ActiveRecord::Base
 
   # Produces the TML for this element and its children.
   def to_tml
-    top = "#{name} #{properties_string}".strip
     # Going to add a comment here to make it easier for the user to find their junk in raw TML
     r = (property?('id') && !property('id').blank?) ? "<!--#{property('id')}-->".ljust(30) : ""
     if elements.empty?
-      "#{r}<#{top} /> "
+      r + build_empty_tag
     else
-      "#{r}<#{top}> \n#{elements.collect { |i| i.to_tml }.join("\n").indent}\n</#{name}>"
+      r + build_content_tag { elements.collect { |i| i.to_tml }.join("\n").indent }
     end
   end
 
+  # Produces an empty TML tag in the form of <tag_name [attributes] />
+  def build_empty_tag
+    top = "#{name} #{properties_string}".strip
+    "<#{top} /> "
+  end
+
+  # Produces a TML content tag in the form of <tag_name [attributes]>content</tag_name>
+  # Contents are specified as a block, which returns a string.
+  def build_content_tag
+    top = "#{name} #{properties_string}".strip
+    "<#{top}> \n#{yield}\n</#{name}>"
+  end
+
   # Produces the TML properties string for this element.
   # For instance, if this element has a property with name :next and value 'credit', this method will return:
   #   "next=\"credit\""
@@ -133,25 +161,33 @@ class Rtml::Dom::Element < ActiveRecord::Base
     prop.value
   end
 
+  # Finds a property using properties#select rather than properties#find. Useful for when properties exist,
+  # but have not been added to the database.
+  def find_property(name)
+    name = name.to_s if !name.kind_of?(String)
+    properties.select { |prop| return prop if prop.name == name }
+    nil
+  end
+
   # Finds or adds a property for this element with the specified name
   def find_or_add_property(name, options={:drop_if_blank => true})
     options = {:value => options} unless options.kind_of?(Hash)
     prop = properties.select { |p| p.name == name.to_s }.first
     if prop
       if options.key?(:value)
-        if prop.new_record? || prop.changed?
+        #if prop.new_record? || prop.changed?
           prop.value = options.delete(:value)
-        else
-          prop.update_attribute(:value, options.delete(:value))
-        end
+        #else
+        #  prop.update_attribute(:value, options.delete(:value))
+        #end
       end
     else
-      if new_record? || changed?
+      #if new_record? || changed?
         prop = properties.build(:name => name.to_s, :value => options.delete(:value), :options => options.with_indifferent_access)
         prop.element = self
-      else
-        prop = properties.create!(:name => name.to_s, :value => options.delete(:value), :options => options.with_indifferent_access)
-      end
+      #else
+      #  prop = properties.create!(:name => name.to_s, :value => options.delete(:value), :options => options.with_indifferent_access)
+      #end
       #prop = Rtml::Dom::Property.new(:name => name.to_s, :element => self)
       #properties << prop
       #prop.options.merge!(options)
@@ -159,6 +195,14 @@ class Rtml::Dom::Element < ActiveRecord::Base
     prop
   end
 
+  def tml_id
+    if (prop = find_property('id')) && !prop.value.blank?
+      self.class.find_or_create_tml_id(prop.value)
+    else
+      nil
+    end
+  end
+
   class << self #:nodoc:
     ## STI hack; allows you to pass :type => 'SomeClassName' so that they're not all instances of Element
     def new_with_cast(*a, &b)
@@ -171,6 +215,15 @@ class Rtml::Dom::Element < ActiveRecord::Base
     end
     alias_method_chain :new, :cast
 
+    # Finds a pre-existing TML ID. Returns nil if it's not found.
+    def find_tml_id(rtml_name)
+      rtml_name = rtml_name.to_s
+      if @@tml_ids.key?(rtml_name)
+        return @@tml_ids[rtml_name]
+      end
+      nil
+    end
+
     # Some elements must have an "id" property according to the TML specification, and other elements must be able to
     # reference them by this ID. Unfortunately, according to the spec, the ID must not be greater than 12 characters long.
     # This is a decided disadvantage, so we're going to allow RTML developers to create elements with longer names and
@@ -178,14 +231,13 @@ class Rtml::Dom::Element < ActiveRecord::Base
     # need to be truncated. Also, they need a unique identifier attached to them in case the truncation results in
     # ambiguities with other screens. This method takes the specified name and processes it as mentioned, returning
     # this element's TML-ID counterpart.
-    def lookup_tml_id(rtml_name)
-      rtml_name = rtml_name.to_s
-      if @@tml_ids.key?(rtml_name)
-        return @@tml_ids[rtml_name]
+    def find_or_create_tml_id(rtml_name)
+      if tml_id = find_tml_id(rtml_name)
+        return tml_id
       end
 
       next_tml_id = @@tml_ids.keys.length.to_s
-      tmlid = rtml_name
+      tmlid = rtml_name.to_s
       @@tml_ids[rtml_name] =
         if tmlid.length > 12
           tmlid[0...(12-next_tml_id.length)] + next_tml_id