rtml 1.2.2

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/lib/filter_has_before_render.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FilterHasBeforeRender
+  def before_render?
+    false
+  end
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/tasks/before_render_tasks.rake

@@ -0,0 +1,25 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# desc "Explaining what the task does"
+# task :before_render do
+#   # Task goes here
+# end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/test/before_render_test.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'test_helper'
+
+class BeforeRenderTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/test/test_helper.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/app_generators/rtml/templates/rtml/lib/rtml.rb

@@ -0,0 +1,77 @@
+module Rtml
+  include Rtml::Helpers::TerminalHelpers
+  
+  # Constructs a TML document with the given block, and returns
+  # that document object. If a document object is supplied, it
+  # is passed into the block and returned. If this method has
+  # been called previously, and no document is supplied,
+  # the block is applied to the existing document.
+  #
+  # For example:
+  #  tml_document do
+  #    on :cancel, :goto => embedded_app
+  #    . . .
+  #  end
+  #
+  # Note that this method is only directly available to Views,
+  # which may want to alter the TML document in some slight way
+  # (even though that's Bad Practice!), and if you want access
+  # to it from your controller, you should use either the
+  # Rtml::RtmlAppController#tml_document method to access the
+  # actual document object, or the Rtml::RtmlAppControler#tml
+  # method to apply a block to an existing RTML document.
+  #
+  def tml_document(doc = @tml_document, &bloc)
+#    unless self.kind_of? Rtml::Helpers::FormHelpers
+      #class << self
+        #include Rtml::Helpers::FormHelpers
+      #end
+    #end
+    if doc.nil?
+      doc = Core::TMLDocument.new(self) do end
+      @tml_document = doc
+      doc.process_block &bloc
+    else
+      doc.process_block &bloc
+    end
+    doc
+  end
+  
+  # Used to associate a TML helper with your controller, or
+  # multiple controllers. In your app/helpers/[controller]_tml_helpers/[action]
+  # directory, you can store multiple files which call this method to register
+  # themselves with your controller. The block should contain method declarations,
+  # which can then begin building a TML document without having to directly reference
+  # the Rtml::RtmlAppController#tml_document or Rtml::RtmlAppController#tml methods.
+  #
+  # Example (in app/helpers/[controller]_tml_helpers/[action]/[tml_helper].rb):
+  #   Rtml::actions_for MyTmlAppController do
+  #     def index      # create an index action which will build an RTML document
+  #       on :cancel => embedded_app
+  #       . . .
+  #     end
+  #   end
+  #
+  def self.actions_for(*controllers, &block)
+    raise "actions_for: Block of RTML actions is expected" unless block_given?
+    (controllers.flatten.collect do |controller|
+      case controller
+        when String, Symbol
+          controller.to_s.camelize.constantize
+        else
+          controller
+      end
+    end).each do |controller|
+      # will hold the RTML actions while we generate a list of them
+      sandbox = Rtml::Proxying::Sandbox.new(controller, &block)
+      sandbox.send :include, Rtml::Helpers::ProxyHelpers::FeatureHelpers
+
+      if controller.respond_to? :rtml_interface
+        controller.add_rtml_actions(sandbox.instance_methods)
+        controller.rtml_interface.class.send :include, sandbox
+      else
+        controller.send :include, sandbox
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/rtml/beryl/constants.rb

@@ -0,0 +1,12 @@
+module Rtml::Beryl::Constants
+  States = [ :new, :approved, :declined, :failed, :reversed, :canceled ]
+#  State = {
+#    :new => 0, :approved => 1, :declined => 2, :failed => 3, :reversed => 4, :canceled => 5
+#  }.with_indifferent_access
+#
+  InputMethod = {
+    1 => :swiped,
+    2 => :emv,
+    3 => :keyed
+  }
+end

data/app_generators/rtml/templates/rtml/lib/rtml/beryl/version.rb

@@ -0,0 +1,11 @@
+module Rtml
+  module Beryl
+    module VERSION
+      MAJOR = 1 unless defined? MAJOR
+      MINOR = 1 unless defined? MINOR
+      TINY  = 0 unless defined? TINY
+
+      STRING = [MAJOR, MINOR, TINY].join('.') unless defined? STRING
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/rtml/common/renderable.rb

@@ -0,0 +1,13 @@
+module Rtml::Common::Renderable
+  # Calls one of #render_tml, #to_tml, or #to_s, checking for availability in that order. The result is guaranteed
+  # to be a String.
+  def to_s
+    if self.respond_to? :render_tml
+      self.render_tml
+    elsif self.respond_to? :to_tml
+      self.to_tml
+    else
+      self
+    end.to_s
+  end
+end

data/app_generators/rtml/templates/rtml/lib/rtml/core/include.rb

@@ -0,0 +1,30 @@
+module Rtml
+  module Core
+    #Defines a TML include directive.
+    #This class should not have to be instantiated directly by the user.
+    #See the Rtml::Elements::TMLDocument#include method for usage details.
+    class Include < Element
+      # Constructs and validates the Include directive.
+      def initialize(view = nil, properties = { }, parent = nil)
+        raise "Must specify include type (:css, :stylesheet, :tml)" if properties[:type].nil?
+        raise "Must specify :source" if properties[:source].nil?
+        raise "Invalid include type specified (:css, :stylesheet, :tml)" unless [:css,:tml].include? properties[:type]
+        
+        super view, properties, [:charset,:ref,:type,:rel,:rev,:source], parent
+      end
+      
+      # Constructs the TML to build this Include directive.
+      def to_tml
+        props = self
+        href = props[:source].to_s
+        rev = props[:type]
+        rev = "text/tml" if rev == :tml
+        rev = "stylesheet" if rev == :css
+        href.concat ".tml" if rev == :tml and href['.tml'].nil?
+        href.concat ".css" if rev == :css and href['.css'].nil?
+        
+        "<link href=\"#{href}\" rev=\"#{rev}\" />"
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/rtml/core/layout.rb

@@ -0,0 +1,59 @@
+module Rtml
+  module Core
+    # Layouts are one of the great strengths of Ruby on Rails, and that concept is
+    # not lost within RTML. To use a layout within your RTML helper, just specify
+    # a filename to use:
+    #
+    #   def index
+    #     layout "my_layout_file"
+    #     screen :index do
+    #       . . .
+    #     end
+    #   end
+    #
+    # Unlike the default Rails layouts, an RTML layout is used more than once in a
+    # single document: once for every screen, in fact. Any time you call the
+    # #display method or similar functionality, your layout will will be applied
+    # automatically. You can remove a layout from a particular screen by passing
+    # it a <code>nil</code> value:
+    #
+    #     . . .
+    #     screen :no_layout do
+    #       layout nil
+    #       display
+    #     end
+    #     . . .
+    #
+    # This will remove the layout for just this screen. Obviously, we could have
+    # also passed another layout file into the method call just as easily. The
+    # new layout would be used in place of the old one.
+    #
+    # Note that you can still use the Rails layouts in addition to this, if you
+    # need to do so.
+    #
+    class Layout
+      attr_reader :name
+      attr_accessor :locals
+      
+      # Constructs a new Layout from the given ActionView, filename and optional hash of local variables.
+      def initialize(view, name, locals = { })
+        @view = ActionView::Base.new(view.view_paths, view.assigns)
+        @name = name
+        @locals = locals
+        
+        #@view.render :file => layout, :locals => @locals, &block
+      end
+      
+      # Applies this layout to the given block.
+      # This method departs from standard to_tml implementations in that it 
+      # REQUIRES a block. Without a block, an error will be raised.
+      def to_tml(&block)
+        raise "No block given for layout #{@name}" unless block_given?
+        layout = @name
+        layout = File.join("layouts", layout)# unless layout =~ /\//
+        layout = "#{layout}.rtml.erb" unless layout =~ /.+\..+/
+        @view.render({ :layout => layout, :text => yield.to_s, :locals => @locals }, @locals)
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/rtml/core/next.rb

@@ -0,0 +1,188 @@
+module Rtml
+  module Core
+    # This class is responsible for building the "next" block for the Screen TML object.
+    # The "next" screen is responsible for telling the terminal which screen should be
+    # displayed after this one, and listing the conditions under which that can be true
+    # (if any). Next is generally used from within a Screen object:
+    #
+    #   def index
+    #     screen :screen1, :next => :screen2 do
+    #       . . .
+    #     end
+    #
+    #     screen :screen2 do
+    #       next_screen :screen1
+    #       . . .
+    #     end
+    #   end
+    #
+    # As you can see, it can be passed into a Hash or called as a method using #next_screen.
+    # As mentioned previously, you can also pass conditional screens known in TML as "variants"
+    # into the builder:
+    #
+    #   def index
+    #     integer :trans_type
+    #
+    #     screen :first, :next => :second do
+    #       next_screen :debit,  :if => "tmlvar:trans_type == 1"
+    #       next_screen :credit, :if => "tmlvar:trans_type == 2"
+    #     end
+    #
+    #     screen :second, :next => :first do
+    #       display 'Please select a transaction type.'
+    #     end
+    #
+    #     . . .
+    #   end
+    #
+    # In the above example, if the trans_type variable has been set to 1, the :debit screen
+    # will be shown. If the trans_type has been set to 2, the :credit screen will be displayed.
+    # In all other cases, the :second screen will be displayed.
+    #
+    # You can also associate keys with Next:
+    #    next_screen :debit,  :key => '1'     # user presses '1'
+    #    next_screen :credit, :key => '2'     # user presses '2'
+    #    next_screen :second, :key => :menu   # user presses 'menu' 
+    #
+    class Next
+      attr_reader :variants
+      delegate :each, :to => :variants
+      
+      def initialize
+        clear!
+      end
+      
+      # Returns true if the specified variable is used in this Next object.
+      def uses_variable?(var)
+        @variants.each do |cond, nid|
+          return true if cond =~ /tmlvar:#{Regexp::escape var.name}/ or
+                         nid  =~ /tmlvar:#{Regexp::escape var.name}/
+        end
+        false
+      end
+      
+      # Returns an array of all variable names used in this Next object.
+      def variables_used
+        r = []
+        @variants.each do |cond, nid|
+          if cond =~ /tmlvar:([^'"\s]+)/
+            r << $~[1]
+          end
+          if nid =~ /tmlvar:([^'"\s]+)/
+            r << $~[1]
+          end
+        end
+        r
+      end
+    
+      # Supplies a Variant for this directive.
+      # Example:
+      #   variant :other_screen,  :key    => :f1
+      #   variant :another_scrn,  :if     => 'tmlvar:user.id > 0'
+      #   variant :yet_anthr_scn, :unless => 'tmlvar:user.id == 5'
+      def variant(id, options = { })
+        cond = variant_condition(options)
+        @variants[cond] = id
+        true
+      end
+      
+      # Returns the screen ID associated with the supplied variant hash.
+      def for_variant(options)
+        cond = variant_condition(options)
+        @variants[cond]
+      end
+      
+      # Removes all variants from this Next directive.
+      def clear!
+        @variants = ActiveSupport::OrderedHash.new
+      end
+      
+      # Builds the TML for the Next directive.
+      def to_tml
+        v_a = []
+        variants = @variants.dup
+        first = variants.delete ""
+        v_a << [ "", first ] if first
+        v_a.concat variants.to_a
+        
+        return "" if v_a.length == 0
+        ret = "<next uri='#{v_a.first[1].to_screen_ref}'"
+        if v_a.length == 1
+          ret.concat " />"
+        else
+          ret.concat ">\n"
+          v_a.each_with_index do |arr,index|
+            if index != 0 # we already did the first one
+              ret.concat "\t<variant uri='#{arr[1].to_screen_ref}' #{arr[0]} />\n"
+            end
+          end
+          ret.concat "</next>"
+        end
+        ret
+      end
+      
+      
+      private
+      #This convoluted mess of a method is what builds the conditions from the supplied hash.
+      #Returns an empty string if there are no options to build from.
+      #FIXME: To be rewritten and merged with similar Variable assignment code.
+      def variant_condition(options)
+        if options.blank? or options.nil?
+          return ""
+        end
+        keys = [ (0..9).to_a, '00', ('f1'..'f9').to_a, 'down', 'up', 'menu', 'stop', 'cancel', 'enter', 'any']
+        keys = keys.flatten.collect { |a| a.to_s }
+        lo = ro = op = nil
+        
+        if options[:if]
+          options[:if] = options[:if].strip.split(" ") if options[:if].class == String
+          if options[:if].length == 2
+            options[:if][2] = ''
+          end
+          raise "Condition must have 3 operands" if options[:if].length != 3
+          raise "Key option is prohibited if condition is used" if options[:key]
+          lo = options[:if][0]
+          ro = options[:if][2]
+          op = options[:if][1]
+        elsif options[:unless]
+          options[:unless] = options[:unless].strip.split(" ") if options[:unless].class == String
+          raise "Condition must have 3 operands" if options[:unless].length != 3
+          raise "Key option is prohibited if condition is used" if options[:key]
+          lo = options[:unless][0]
+          ro = options[:unless][2]
+          op = options[:unless][1]
+          #flip operation to convert 'unless' to 'if'
+          case op
+            when '==' then op = '!='
+            when '!=' then op = '=='
+            when '<=' then op = '>'
+            when '>=' then op = '<'
+            when '>'  then op = '<='
+            when '<'  then op = '>='
+            when '=~', 'contains' then ;
+          end
+        elsif options[:key]
+          raise "Invalid key assignment: must be #{keys.inspect}" unless keys.include? options[:key].to_s
+        end
+        
+        case op
+          when '==' then op = 'equal'
+          when '!=' then op = 'not_equal'
+          when '<=' then op = 'less_or_equal'
+          when '>=' then op = 'less'; lo,ro = ro,lo
+          when '>'  then op = 'less_or_equal'; lo,ro = ro,lo
+          when '<'  then op = 'less'
+          when '=~' then op = 'contains'
+        end
+        
+        ret = ""
+        ret.concat " lo=\"#{lo}\"" unless lo.nil?
+        ret.concat " op=\"#{op}\"" unless op.nil?
+        ret.concat " ro=\"#{ro}\"" unless ro.nil?
+        ret.concat " format=\"#{options[:format]}\"" unless options[:format].nil?
+        ret.concat " key=\"#{options[:key]}\"" unless options[:key].nil?
+        ret.strip
+      end
+    end
+  end
+end