rmobio 1.1.4 → 1.1.5

data/lib/rmobio/doc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/rmobio/raketasks.rb

@@ -96,7 +96,7 @@ task :rcov do
   Rcov::RcovTask.new do |t|
     t.rcov_opts << '-T --rails'
     t.libs << 'test'
-    t.test_files = FileList['test/*/*_test.rb']
+    t.test_files = FileList['test/*/*_test.rb', 'test/*/*/*_test.rb'] 
     t.verbose = true
   end
 end

data/lib/rmobio/rxml/base_transformer.rb

@@ -0,0 +1,278 @@
+# 
+# Copyright (C) 2007 Mobio Networks, Inc.
+# 
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+# 
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'builder/xmlmarkup'
+require 'singleton'
+module Rmobio 
+  module Rxml 
+  
+=begin rdoc
+Provide a base transformer to translate rxml document to xhtml markup.
+It subclasses the builder library XmlMarkup class so method not defined in this
+transformer class will inherit methods or method missing from XmlMarkup class.
+See XmlMarkup for documentation.
+    
+Example:
+In the controller, get the proper transformer class by passing a client type,
+See TransformerFactory class for supported client types:
+  require 'rmobio/rxml/transformer_factory'
+  @xml = TransformerFactory.get_transformer('xhtml')
+         
+
+Here is the view that uses methods to output xhtml document header, an 
+image and some text:
+    @xml.doctype(xml) do |x|
+      @xml.body(x, 'mobio') do|body|  
+        @xml.image(body, "img1", 'http://localhost:3000/images/rails.png') 
+        @xml.softBr(body)
+        body.b do |y|
+          @xml.text(y, 'My test app')
+        end
+      end
+    end
+The above code generates the following xhtml in Firefox:
+     <?xml version="1.0" encoding="UTF-8" ?>
+     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+     <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+     <head><title>mobio</title></head><body>
+     <img id="img1" src="http://localhost:3000/images/rails.png" /><br/>
+     <b>
+     My test app</b>
+     </body></html> 
+=end
+ 
+    class BaseTransformer < Builder::XmlMarkup
+
+      cattr_accessor :view_buffer, :model_buffer 
+      include Singleton 
+      
+      # Create a base rxml transformer to transform rxml document to xhtml markup
+      #
+      # out::     Object receiving the markup in xhtml
+      # @view_buffer::  buffer to hold the view part of the document
+      # @model_buffer:: buffer to hold the model data of the document
+      # Final document is view_buffer + model_buffer for some subclass transformer (XformsTransformer)
+      #
+      def initialize
+        @view_buffer = ""
+        @model_buffer = "" 
+        super  
+      end
+      
+      def cattr_reader(*syms)
+        syms.flatten.each do |sym|
+          class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+          EOS
+        end
+      end
+
+      def cattr_writer(*syms)
+        syms.flatten.each do |sym|
+          class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+          EOS
+        end
+      end
+
+      def cattr_accessor(*syms)
+        cattr_reader(*syms)
+        cattr_writer(*syms)
+      end
+      
+      # To be implemented. 
+      def transform(xml, client=nil)
+      end 
+      
+      #Generate standdard xhtml document header
+      def doctype(xml)
+        xml << '<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'
+
+        yield xml    
+        xml << "</html>"
+      end 
+    
+      #Generate xthml head and body tag. The document title and style src are optional.
+      #
+      #==== Examples 
+      #  @xml.body(x, 'mobio', "../stylesheets/css/mobio_twitter.css")
+      #Xhtml output:
+      #  <head><meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
+      #  <link href="../stylesheets/css/mobio_twitter.css" rel="stylesheet" type="text/css" />
+      #  <title>mobio</title></head><body>
+      #  </body> 
+      def body(doc, title="",style=nil)
+        doc << "\n<head>"
+        if style
+          doc << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml; charset=UTF-8\" />\r<link href=\"" + style + "\" rel=\"stylesheet\" type=\"text/css\" />"
+        end
+        doc << "<title>#{title}</title></head><body>"    
+        yield doc 
+        doc << "</body>"
+    
+      end
+      
+      #Produce a text string. To apply style for text, wrap the tag with xml tag:
+      #==== Examples
+      #  xml.i do |y|
+      #      @xml.text(y, "my italic example")
+      #  end 
+      #Generates the following xhtml code:
+      # <i>
+      # my italic example
+      # </i>
+      def text(doc, txt="", options={})
+        doc << txt  
+      end
+       
+      #Create a text box. To apply style for text, wrap the tag with xml tag.
+      #Extra html style (cols, rows, etc.) can be specified in the hash variable options.
+      #===== Options
+      #
+      #* <tt>:style</tt> -- specifies html, xhtml style attributes like cols, rows, etc. as a string
+      #* <tt>:xstyle</tt> -- specifies xforms style attributes like height, width, etc. as a string.
+      #
+      #==== Examples 
+      #  
+      #  @xml.textare(body, "some text", 
+      #     :style=>'class="white"', :xstyle=>'height="3ex" style="white"')
+      #generates the following xhtml code:
+      #    <textarea class="white" name="">some text</textarea>
+      def textarea(doc, txt="", options={}) 
+        doc << "\n<textarea #{options[:style]} name=\"#{options[:id]}\">" << txt << "</textarea>"
+      end 
+  
+      #Create user input field. 
+      #1. id:    not used in xhtml client
+      #2. value: initial value that will be displayed when ui is loaded
+      #3. type:  html input type attriute, "text", "password", "submit", etc.
+      #==== Options      
+      #* <tt>:style</tt> -- specifies html, xhtml style attributes like cols, rows, etc. as a string
+      #* <tt>:xstyle</tt> -- specifies xforms style attributes like height, width, etc. as a string.
+      #* <tt>:xpath</tt> -- specifies the xpath of the input data in the model, xforms only.
+      #==== Examples
+      #* a text input box
+      #     @xml.input(f, "name", "john", "text")
+      #generates the xhtml:
+      #     <input  type="text" name="name" value="john"/>
+      #* a password input box
+      #     @xml.input(f, "password", "", "password")
+      #generates the xhtml:
+      #     <input  type="password" name="password" value=""/>
+      #* a submit button
+      #     @xml.input(f, "submit", "Login", "submit") 
+      #generates a submit button:
+      #     <input  type="submit" name="submit" value="Login"/>
+      #
+      def input(doc, id, value, type, options={})
+        doc << "\n<input #{options[:style]} type=\"" << type << "\" name=\"" << id << "\" value=\"" << value << "\"/>\n"
+      end
+  
+      def submit_tag()
+        # do nothing, only implemented in xforms
+      end
+      #Create form tag for submission
+      #1. id:         name of the form
+      #2. action:     the action url that is invoked
+      #3. method:     http 'get' or 'post'
+      def form(doc, id, action, method)
+        doc << "\n<form method=\"" << method.downcase << "\" action=\"" << action << 
+          "\" id=\"#{id}\" #{options[:style]}>"
+       
+        yield doc
+        doc << '</form>'
+      end
+      #Create a html link
+      #1. href:  the link url
+      #2. txt:   text displayed in the link
+      #==== Options
+      #* <tt>:style</tt> -- specifies html, xhtml style attributes as a string
+      def link(doc, href, txt="", options={}, &block) 
+        doc << "\n<a href=\"#{href}\" #{options[:style]}" 
+        doc << ">" << txt << '</a>'
+      end
+      #Not implemented for xhtml client
+      def model_tag(doc, txt)
+        # do nothing  
+      end
+      #Not implemented for xhtml client
+      def view_tag(doc, txt)
+        # do nothing 
+      end
+      #Line break
+      def softBr(doc)  
+        doc.br 
+      end 
+      #Create html img tag.
+      #1. id:   name of the widget
+      #2. src:  the url of the image
+      #==== Options
+      #* <tt>:style</tt> -- specifies html, xhtml style attributes as a string
+      #* <tt>:alt</tt> -- html alt attribute 
+      def image(doc, id, src, options={}) 
+        doc << "\n<img id=\"#{id}\" src=\"" << src << "\" #{options[:style]}"
+        doc << " alt=\"" << options[:alt] << "\"" if options[:alt]
+        doc << '/>'
+      end
+      #Not implemented for html client
+      def instance_tag(doc, id)
+        # do nothing, only implemented in xforms   
+      end
+      #Create table tag
+      #1. style:  html styles
+      #2. xstyle: xforms styles
+      def table(doc, style="", xstyle="") 
+        doc << "\n<table #{style}>"
+        yield doc 
+        doc << '</table>'
+      end
+  
+      def table_row(doc, style="", xstyle="")
+        doc << "\n<tr #{style}>"
+        yield doc 
+        doc << '</tr>'
+      end
+      def table_cell(doc, style="", xstyle="")
+        doc << "<td #{style}>" 
+        yield doc
+        doc << '</td>'
+      end 
+    end
+  end 
+end
+include Rmobio::Rxml

data/lib/rmobio/rxml/html_transformer.rb

@@ -0,0 +1,30 @@
+# 
+# Copyright (C) 2007 Mobio Networks, Inc.
+# 
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+# 
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
+
+  
+require 'builder/xmlmarkup'
+require 'rmobio/rxml/base_transformer'
+require 'singleton'
+
+module Rmobio 
+  module Rxml 
+    class HtmlTransformer < BaseTransformer
+      include Singleton 
+     
+    end
+  end 
+end 

data/lib/rmobio/rxml/transformer_factory.rb

@@ -0,0 +1,49 @@
+# 
+# Copyright (C) 2007 Mobio Networks, Inc.
+# 
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+# 
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
+require 'rmobio/rxml/base_transformer'
+require 'rmobio/rxml/html_transformer'
+require 'rmobio/rxml/wap_transformer'
+require 'rmobio/rxml/xforms_transformer'
+
+module Rmobio 
+  module Rxml 
+    class TransformerFactory
+      # Return a transformer instance based on the client type. 
+      # Available transformer for the following client types:
+      #   xhtml, html, wap and xf (Mobio xforms)
+      def TransformerFactory::get_transformer(client) 
+        kclass = BaseTransformer
+        kclass = 
+          case client 
+        when 'xf'
+          XformsTransformer
+        when 'xhtml'
+          #XhtmlTransformer
+          BaseTransformer
+        when 'html'
+          HtmlTransformer 
+        when 'wap'
+          WapTransformer
+        end 
+        RAILS_DEFAULT_LOGGER.debug('getting transformer instance for client ' + client) 
+        #kclass::get_instance()    
+        kclass::instance 
+      end 
+    
+    end
+  end 
+end 

data/lib/rmobio/rxml/wap_transformer.rb

@@ -0,0 +1,32 @@
+# 
+# Copyright (C) 2007 Mobio Networks, Inc.
+# 
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+# 
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
+
+  
+require 'builder/xmlmarkup'
+require 'rmobio/rxml/base_transformer'
+require 'singleton'
+
+module Rmobio 
+  module Rxml
+    class WapTransformer < BaseTransformer
+      include Singleton 
+       
+    
+    end
+  end
+end 
+