rtml 1.2.2

data/app_generators/rtml/templates/rtml/generators/rtml_widget/templates/basic_widget.rb

@@ -0,0 +1,57 @@
+module Rtml
+  module Widgets
+    class <%=class_name%>Widget < Rtml::Widgets::Widget
+      # To define one or more properties:
+      #   property :property_1, :property_2, . . .
+      # To define properties with callback methods:
+      #   property :property_1 => :callback_1, :property_2 => :callback_2, . . .
+      # You can mix and match:
+      #   property :property_1, :property_2 => :callback, :property_3, . . .
+      <%- properties.each do |prop| -%>
+      # <%=prop.to_s.titleize %>
+      property :<%=prop %>
+      <%- end -%>
+      
+      # To make your widget accessible, specify the class name of either another
+      # Widget, or one of the built-in accessor types (TMLDocument, Screen, Display):
+      # You can specify more than one accessor:
+      #    accessor Screen, TMLDocument
+      # You can also specify the accessor command more than once.
+      <% unless accessors.empty? %>accessor <%=accessors.join(", ")%><% end %>
+
+      # To alias your Widget so that you don't need to call it by its full name, use
+      # the accessor_alias method. You can specify multiple aliases on the same line
+      # by separating them with a comma.
+      accessor_alias :<%=class_name.underscore%>
+      <% unless aliases.empty? %>accessor_alias <%=aliases.collect { |i| ":#{i}" }.join(", ")%><% end %>
+      
+      # If you wish to specify a default value for a property, you should do so in the
+      # init_properties method. Alternatively, you can give it a value of :required and
+      # an error will be raised if the user tries to use your Widget without setting the
+      # property.
+      def init_properties #:nodoc:
+        <%- properties.each do |prop| -%>
+        <%=prop%> :required
+        <%- end -%>
+      end
+
+      # If you specified a callback for a property, above, then you should define that
+      # method:
+      #    def name_assigned(new_val)
+      #      # do something with the new value
+      #      # IMPORTANT: The return value from a callback method is assigned to the property!
+      #      new_val
+      #    end
+
+      # You must define a to_tml method, which returns a String. This will be the
+      # result of your Widget, embedded into the TML document that is being generated.
+      def to_tml #:nodoc:
+        # You can call do_layout on a Widget, Element or String to apply any active layouts.
+        do_layout display <<-end_tml
+          Test Helpers (#{self.class.name})<br/>
+          Find me in lib/tml/widgets/test_helpers_widget.rb
+        end_tml
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/generators/rtml_widget/templates/basic_widget_no_help.rb

@@ -0,0 +1,27 @@
+module Rtml
+  module Widgets
+    class <%=class_name%>Widget < Rtml::Widgets::Widget
+      <%- properties.each do |prop| -%>
+      # <%=prop.to_s.titleize %>
+      property :<%=prop %>
+      <%- end -%>
+      
+      <% unless accessors.empty? %>accessor <%=accessors.join(", ")%><% end %>
+      accessor_alias :<%=class_name.underscore%>
+      <% unless aliases.empty? %>accessor_alias <%=aliases.collect { |i| ":#{i}" }.join(", ")%><% end %>
+      
+      def init_properties #:nodoc:
+        <%- properties.each do |prop| -%>
+        <%=prop%> :required
+        <%- end -%>
+      end
+
+      def to_tml #:nodoc:
+        do_layout display <<-end_tml
+          Test Helpers (#{self.class.name})<br/>
+          Find me in lib/tml/widgets/test_helpers_widget.rb
+        end_tml
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/init.rb

@@ -0,0 +1,40 @@
+unless ((Rails.version >= "2.3.2" rescue false))
+  message = "RTML requires Rails 2.3.2 or higher.  Please use a more recent version of Rails."
+  ActionController::Base::logger.error message
+  puts message
+  raise message
+end
+
+require 'extensions/attr_boolean'
+require 'extensions/rake'
+require 'extensions/array'
+require 'extensions/string'
+require 'extensions/hash'
+require 'extensions/nil_class'
+require 'extensions/regexp'
+require 'extensions/active_record'
+require 'extensions/action_view/partial_template' if Rails.version < "2.3"
+require 'extensions/action_view/base' if Rails.version >= "2.3"
+require 'extensions/action_controller/request'
+require 'extensions/action_controller/routing/route_set'
+require 'extensions/active_support/dependencies' if %W(2.3.2 2.3.3).include? Rails.version
+require 'environment'
+require 'other_plugins'
+require 'open-uri'
+
+# check for updates
+unless ENV['RTML_UPDATE'] == false or ENV['RAILS_ENV'] == 'production'
+  update_file = "http://github.com/sinisterchipmunk/rtml/raw/master/update.rb"
+  begin
+    eval open(update_file).read, binding, update_file, 1
+  rescue
+    warning = ["Could not check for RTML updates: #{$!.message}",
+               "Add the following to config/environments.rb to supress this check:",
+               "\tENV['RTML_UPDATE'] = false"]
+    if defined? Rails
+      warning.each { |line| Rails.logger.warn line }
+    else
+      warning.each { |line| warn line }
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/install.rb

@@ -0,0 +1,18 @@
+# Install hook code here
+require 'ftools'
+require 'find'
+
+%w(public doc).each do |dir|
+  Dir.glob(File.join(File.dirname(__FILE__), dir, "**/*")) do |fi|
+    next if File.directory? fi
+    target = File.join("../../../", fi.sub(File.dirname(__FILE__), ""))
+    unless File.directory? File.dirname(target)
+      puts "Creating directory: #{File.dirname(target)}"
+      File.makedirs(File.dirname(target))
+    end
+    unless File.exist? target
+      puts "Copying file: #{fi}"
+      File.copy(fi, target)
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+require 'find'
+
+Rails.backtrace_cleaner.add_silencer { |line| line =~ /rtml\/helpers\/action_view_wrapper\.rb/ }
+Rails.backtrace_cleaner.add_silencer { |line| line =~ /rtml\/proxying\// }
+
+configuration = template_base = nil
+unless defined? RAILS_ROOT
+  RAILS_ROOT = File.join(File.dirname(__FILE__), "..",'..','..','..')
+end
+PLUGIN_BASE = File.join(RAILS_ROOT, "vendor", "plugins", "rtml")
+
+def add_load_path(path, configuration) #:nodoc:
+  #path.gsub /^#{Regexp.escape File.join(RAILS_ROOT, "")}/, '' if defined? RAILS_ROOT
+  $LOAD_PATH << path
+  configuration.load_paths << path
+  
+  if ENV['RAILS_ENV'] != 'production'
+    po = ((defined? RAILS_ROOT) ? path.gsub(/^#{Regexp.escape File.join(RAILS_ROOT, "")}/, '') : path)
+    ActionController::Base.logger.debug "Added load path #{po}"
+    configuration.load_once_paths.delete(path)
+  end
+end
+
+if defined? Dependencies then configuration = Dependencies
+elsif defined? ActiveSupport::Dependencies then configuration = ActiveSupport::Dependencies
+end
+
+if defined? ActionView
+  if defined? ActionView::Template and ActionView::Template.respond_to? :register_template_handler
+    template_base = ActionView::Template
+  else template_base = ActionView::Base
+  end
+end
+
+if configuration.nil? or template_base.nil?
+  raise "Couldn't find ActiveSupport dependencies and/or ActionView template base! " +
+        "Make sure you are using Rails v2.3.2 or higher."
+end
+
+# autoloading of various stuffs
+configuration.load_once_paths.delete(File.join(File.dirname(__FILE__))) if configuration
+if configuration
+  add_load_path(File.join(PLUGIN_BASE), configuration)
+  add_load_path(File.join(PLUGIN_BASE, "components"), configuration)
+  add_load_path(File.join(PLUGIN_BASE, "lib"), configuration)
+  %w{ controllers helpers models views }.each do |dir|
+    add_load_path(File.join(PLUGIN_BASE, "app", dir), configuration)
+  end
+end
+
+# Register TML and RTML MIME types
+Mime::Type.register "text/tml", :tml
+Mime::Type.register "text/tml", :rtml
+
+# Add TML params parser
+Mime::TML = Mime::Type.lookup('text/tml')
+ActionController::Base.param_parsers[Mime::TML] = Proc.new { |data| Rtml::TmlParamParser.new(data).params }
+
+# May go back to the "old way" (commented, below) if screen inheritence demands a new TemplateHandler
+template_base.register_template_handler :rtml, ActionView::TemplateHandlers::ERB
+#template_base.register_default_template_handler :erb, RtmlTemplateHandler

data/app_generators/rtml/templates/rtml/lib/extensions/action_controller/request.rb

@@ -0,0 +1,9 @@
+class ActionController::Request
+  # Returns true if this request originated from a terminal, irrespective of any debug properties
+  # that may or may not have been set. (For example, if a Web browser has been made to emulate a
+  # terminal, this method will still return false.)
+  def is_terminal?
+    # redefined elsewhere
+    false
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/action_controller/routing/route_set.rb

@@ -0,0 +1,34 @@
+module ActionController
+  module Routing
+    class RouteSet
+      # To solve for an issue in Rails 2.x (known in 2.1.1 and 2.3.2) causing url_for to
+      # return URLs that do not match routing priority. RoR ticket #2510.
+      def routes_for_controller_and_action_and_keys(controller, action, keys)
+        selected = {}
+        routes.each do |route|
+          if route.matches_controller_and_action?(controller, action)
+            len = (keys - route.significant_keys).length
+            selected[route] = len if not selected.values.include? len
+          end
+        end
+        selected.keys.sort_by { |route| (keys - route.significant_keys).length }
+      end
+
+      class Mapper
+        # Modifies your route set to produce TML-compatible routes. Also connects the default
+        # TML request (/index.tml) to the options you provide, if any.
+        #
+        # To use, just add the following to your /config/routes.rb file:
+        #   map.connect_rtml :controller => "start_page"
+        #
+        def connect_rtml(options = {})
+          map = self # just makes it easier for me to copy-paste into routes.rb when debugging these
+          map.connect ':controller/:action/:id'
+          map.connect ':controller/:action.:format'
+          map.connect ':controller/:action.:format.:id'
+          map.connect '/index.tml', options.reverse_merge(:format => 'rtml') unless options.empty?
+        end
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/action_view/base.rb

@@ -0,0 +1,74 @@
+module ActionView
+  class Base
+    # Reimplementation of _pick_partial_template so that view inheritance works as expected
+    # in Rails 2.3 (which saw a pretty major overhaul of Templates, and rendered the
+    # 2.1 and 2.2 view inheritance ineffective.)
+    def _pick_partial_template(partial_path, ctrlr = controller.class)
+      ### NOTE ###
+      #
+      # File actionpack-2.3.4\lib\action_view\partials.rb:
+      # 227           def _pick_partial_template(partial_path) #:nodoc:
+      #
+      if controller and not partial_path.include? '/'
+        if ctrlr == controller.class
+          # if a controller has not been expressly specified,
+          # start with nil controller so that [action]/[partial_path] is searched.
+          _pick_rtml_partial_template(partial_path)
+        else
+          _pick_rtml_partial_template(partial_path, ctrlr)
+        end
+      else
+        begin
+          super(partial_path, ctrlr)
+        rescue ArgumentError
+          super(partial_path)
+        end
+      end
+    end
+    
+    # Searches for a partial template in the following order:
+    #   1. [controller]/[action]/[partial_path]
+    #   2. [controller]/[partial_path]
+    #   3. ./[partial_path]                        (the base of each view path)
+    # If the partial is not found in either of these locations, the controller's superclass
+    # is searched to enable view inheritence for partials.
+    def _pick_rtml_partial_template(partial_path, ctrlr = controller.class)
+      # 1. controller/action/partial_path
+      path = "#{ctrlr.controller_path}/#{controller.params[:action]}/_#{partial_path}"
+      return _attempt_rtml_template(path, partial_path, ctrlr.superclass)
+    rescue MissingTemplate => mt
+      # 2. controller/partial_path
+      begin
+        path = "#{ctrlr.controller_path}/_#{partial_path}"
+        return _attempt_rtml_template(path, partial_path, ctrlr.superclass)
+      rescue MissingTemplate
+        # 3. ./partial_path
+        begin
+          path = partial_path
+          return _attempt_rtml_template(path, partial_path, nil)
+        rescue MissingTemplate
+          begin
+            path = "_#{partial_path}"
+            return _attempt_rtml_template(path, partial_path, nil)
+          rescue MissingTemplate
+            raise mt
+          end
+        end
+      end
+    end
+    
+    # Attempts to find a template at the specified path, and then calls
+    # _pick_rtml_partial_template(partial_path, ctrlr) if it's not there.
+    # If it finds the template, the template is returned.
+    def _attempt_rtml_template(path, partial_path, ctrlr)
+      self.view_paths.find_template(path, self.template_format)
+    rescue MissingTemplate => mt
+      raise mt if ctrlr == ApplicationController or ctrlr.nil?
+      begin
+        _pick_rtml_partial_template(partial_path, ctrlr)
+      rescue MissingTemplate
+        raise mt
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/action_view/partial_template.rb

@@ -0,0 +1,24 @@
+module ActionView#:nodoc:
+  class PartialTemplate < Template#:nodoc:
+    # Changes to this class are copied from the patch at
+    # http://dev.rubyonrails.org/attachment/ticket/7076/add_partial_inheritance.2.diff
+    def partial_pieces(view, partial_path) #:nodoc:
+      if partial_path.include?('/')
+        return File.dirname(partial_path), File.basename(partial_path)
+      else
+        return partial_controller_find(view, partial_path)
+      end
+    end if Rails.version < "2.3"
+    
+    def partial_controller_find(view, partial_path, klass = view.controller.class)#:nodoc:
+      if view.finder.file_exists?("#{klass.controller_path}/_#{partial_path}")  
+        return klass.controller_path, partial_path 
+      elsif !klass.superclass.method_defined?(:controller_path)  
+        # End of the inheritance line 
+        return view.controller.class.controller_path, partial_path 
+      else  
+        return partial_controller_find(view, partial_path, klass.superclass)  
+      end  
+    end if Rails.version < "2.3"
+  end
+end

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

@@ -0,0 +1,13 @@
+module ActiveRecord
+  class Base
+    # Converts the specified method name for this record into a valid
+    # TML variable name.
+    def self.tml_name_for(method)
+      "#{self.name.gsub(/::/, '.')}.#{method}".downcase##{id}."
+    end
+    
+    def tml_name_for(method)
+      self.class.tml_name_for method
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/active_support/dependencies.rb

@@ -0,0 +1,25 @@
+# to address issue in Rails 2.3.2 with "is not missing constant" errors
+# https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2283-unnecessary-exception-raised-in-asdependenciesload_missing_constant
+=begin
+module ActiveSupport
+  module Dependencies
+    extend self
+    
+    #def load_missing_constant(from_mod, const_name)
+    
+    def forgiving_load_missing_constant( from_mod, const_name )
+      begin
+        old_load_missing_constant(from_mod, const_name)
+      rescue ArgumentError => arg_err
+        if arg_err.message == "#{from_mod} is not missing constant #{const_name}!"
+          return from_mod.const_get(const_name)
+        else
+          raise
+        end
+      end
+    end
+    alias :old_load_missing_constant :load_missing_constant
+    alias :load_missing_constant :forgiving_load_missing_constant
+  end
+end
+=end

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

@@ -0,0 +1,15 @@
+class Array
+  # Iterates through this array and constructs a single string composed
+  # of the values returned by calling render_tml, to_tml or to_s on every element in the
+  # array.
+  def to_tml
+    # 1.1.1: to_s now calls render_tml or to_tml as necessary
+    self.collect { |c| c.to_s }.join("\n\n")
+  end
+
+  # Returns only the elements of this array that match either the specified argument or elements
+  # within the specified array.
+  def %(arr)
+    select { |i| arr.kind_of?(Array) ? arr.include?(i) : arr == i }
+  end
+end

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

@@ -0,0 +1,10 @@
+module AttrBoolean
+  def self.included(base)
+    base.instance_eval do
+      def attr_boolean(*a)
+        attr_writer *a
+        a.each { |i| eval "def #{i}?; @#{i}; end", binding, __FILE__, __LINE__ }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+class Hash
+  # Iterates through this Hash and constructs a string
+  # in the format of name="value"
+  def to_xml_params(*which)
+    which = self.keys if which.length == 0
+    which.collect! { |a| a.to_s.downcase }
+    r = ""
+    self.each do |n,v|
+      if which.include? n.to_s.downcase
+        r.concat " "# unless r.blank?
+        r.concat "#{n}=\"#{v}\""
+      end
+    end
+    r
+  end
+  
+  def without_values(*values)
+    ret = {}
+    self.each do |key, value|
+      ret[key] = value unless values.include? value
+    end
+    ret
+  end
+  
+  def to_s(*which)
+    to_xml_params(*which)
+  end
+end