sdl4r 0.9.3 → 0.9.4

data/CHANGELOG

@@ -0,0 +1,13 @@
+== v0.9.4 (6-aug-2010)
+
+=== Major changes:
+
+* The use of BigDecimal (standard) has been preferred to Flt::DecNum.
+* "sdl4r/sdl.rb" has been renamed to "sdl4r/sdl4r.rb"
+* A sdl4r.rb has been added so that users can actually write (as the documentation pretended):
+
+    require 'sdl4r'
+
+* SDL4R#coerce_or_fail has been implemented, which means that random objects can't be added to a
+  Tag as before. Rational instances are coerced using Rational#to_f.
+* Added usual time methods to SdlTimeSpan: day(), hour(), min(), sec(), usec()

data/README

@@ -328,10 +328,10 @@ integer (32 bits signed):: Integer (Fixnum or Bignum)
 long integer (64 bits signed):: Integer (Fixnum or Bignum)
 float (32 bits signed):: Float
 double float (64 bits signed):: Float
-decimal (128+ bits signed):: Flt::DecNum (if installed; see http://flt.rubyforge.org/), core numeric classes otherwise
+decimal (128+ bits signed):: BigDecimal
 boolean:: true (TrueClass) and false (FalseClass)
 date (day):: Date
-date time:: DateTime
+date time:: DateTime (see SDL4R#new_date_time if you want to get Time instances from the parsers)
 time span:: SdlTimeSpan
 binary:: SdlBinary (to avoid confusion with simple strings)
 null:: nil (NilClass)

data/Rakefile

@@ -10,14 +10,14 @@ spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.summary = "Simple Declarative Language for Ruby library"
   s.name = 'sdl4r'
-  s.version = '0.9.3'
+  s.version = '0.9.4'
   s.requirements << 'none'
   s.require_path = 'lib'
   s.authors = ['Philippe Vosges', 'Daniel Leuck']
   s.email = 'sdl-users@ikayzo.org'
   s.rubyforge_project = 'sdl4r'
   s.homepage = 'http://www.ikayzo.org/confluence/display/SDL/Home'
-  s.files = FileList['lib/sdl4r/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*', 'doc/*'].to_a
+  s.files = FileList['lib/sdl4r.rb', 'lib/sdl4r/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*', 'doc/**/*'].to_a
   s.test_files = FileList[ 'test/**/*test.rb' ].to_a
   s.description = <<EOF
   The Simple Declarative Language provides an easy way to describe lists, maps,
@@ -47,7 +47,7 @@ end
 
 Rake::RDocTask.new do |rd|
   files = ['README', 'LICENSE', 'CHANGELOG',
-    'lib/sdl4r/**/*.rb', 'doc/**/*.rdoc', 'test/*.rb']
+    'lib/sdl4r.rb', 'lib/sdl4r/**/*.rb', 'doc/**/*.rdoc', 'test/*.rb']
   rd.main = 'README'
   rd.rdoc_files.include(files)
   rd.rdoc_dir = "doc"

data/TODO.txt

@@ -11,7 +11,8 @@
     with or without given block. Same goes for each_value(), etc.
 [x] Is Base64 really compatible with the format defined in the Java version ?
     ==> Seems so after having implemented more of the standard tests.
-[ ] Support both DateTime and Time in parsing (see Parser#combine())
+[x] Support both DateTime and Time in parsing (see Parser#combine())
+    ==> SDL4R::new_date_time can be overriden
 [x] Use Date instead of DateTime if only day was specified in SDL (parser.rb)
 [x] Add a remove_all_children() to Tag
 [x] Rethink the interfaces to access sub-tags, values, attributes, etc
@@ -38,8 +39,8 @@
 [A] Use YARD in order to generate documentation ?
     ==> alternatively, I tried to generate some RDoc templates but none worked in Rake...
 [x] In the documentation, present a table giving the returned Ruby type for each SDL type.
-[A] Change the interface of SdlTimeSpan to look like the interfaces of Date, DateTime or Time
-    ==> Really? This is a timespan, not a date.
+[x] Change the interface of SdlTimeSpan to look like the interfaces of Date, DateTime or Time
+    ==> Add alias methods.
 [x] Have SdlTimeSpan implement Comparable
 [ ] BUG: the line number is too high by 1 (the column is correct).
 [x] PB: binary fields shouldn't be kept as Strings because they would not be saved as binaries but
@@ -93,12 +94,17 @@
     ==> Moved to the Parser namespace.
 [x] Factorize "each_child..." methods in Tag and refactor "children(recursive, name)" consequently
     + invert "name" and "recursive" in "children()"
-[ ] Return copies or original arrays in Tag?
+[x] Return copies or original arrays in Tag?
+    ==> we return the implementation Arrays or Hashes (or whatever) for efficiency.
+        However, we ask the users not to assume anything as we might protect the returned objects in
+        the future.
 [A] BUG: test_tag_write_parse() does not work from the command line (ruby v1.8.7).
     ==> This is normal provided that flt was not installed.
-[ ] Tag.to_string(): break up long lines using the backslash
+[A] Tag.to_string(): break up long lines using the backslash
+    ==> unless, some day, someone asks for it...
 [ ] Tag.hash: the implementation is not very efficient.
-    ==> Difficult to make better and simple
+    ==> Difficult to make better and still simple
+    ==> Maybe possible when it's frozen.
 [x] Implement reading from a URL(?) Other sources idiomatic in Ruby?
     ==> Strings, URIs, Pathnames, IOs
 [x] See the XML and YAML APIs to find enhancements.
@@ -128,15 +134,17 @@
 [x] State in the README that without Flt, all the tests can't run.
     ==> it's stated explicitely in the test
 [w] Make it so that each test appears separately in test.rb (if possible)
-[ ] Have the use of Flt be optional.
-[ ] Be sure that there is a way to change the precision of Flt outside of SDL4R
-[ ] Turn Rationals to Floats in coerc_or_fail()?
+[A] Have the use of Flt be optional.
+    ==> We use BigDecimal instead.
+[x] Be sure that there is a way to change the precision of Flt outside of SDL4
+    ==> just change the precision in your thread before parsing
+[x] Turn Rationals to Floats in coerce_or_fail()?
 [ ] BUG: "rake package" tries to archive the contents twice: once with the command that I configure
-    in Rakefime, once with a zip command that can't work on my machine (zip is not installed). Why?
+    in Rakefile, once with a zip command that can't work on my machine (zip is not installed). Why?
     At least, the first archive is created and seems correct.
 [x] Add a "Getting Started" chapter to the README
 [ ] FUTURE: Would we need a "write" method in SDL4R?
-[ ] Implement coerce_or_fail: it is right now allowed to add any garbage to the SDL tags
+[x] Implement coerce_or_fail: it is right now allowed to add any garbage to the SDL tags
 [x] Fix the doc of Tag.add_value
 [ ] Add tests and release a RC or beta version
 [x] Make the parser components disappear from the RDoc
@@ -158,3 +166,12 @@
 [x] Add tests for to_xml_string
 [x] Be stricter and more explicit with Tag and attributes name/namespace
 [x] Fix set_attributes: it was correct before.
+[ ] Input relevant URLs on http://rubygems.org
+[x] What prevents from doing the following?
+    tag.values << IO.new("toto.txt")
+    ==> It doesn't break the behavior as long as the value type is OK. Even if it is not allowed,
+        it still is not too bad.
+[x] Somehow, I didn't choose BigDecimal when I started to use Flt::DecNum. Can't remember why but
+    seems overly complicated.
+    ==> Remove Flt.
+[x] Rename sdl.rb to sdl4r.rb

data/doc/classes/SDL4R.html

@@ -0,0 +1,681 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>Module: SDL4R</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">SDL4R</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/sdl4r/sdl_time_span_rb.html">
+                lib/sdl4r/sdl_time_span.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/sdl_parse_error_rb.html">
+                lib/sdl4r/sdl_parse_error.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/tag_rb.html">
+                lib/sdl4r/tag.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/parser_rb.html">
+                lib/sdl4r/parser.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/sdl_binary_rb.html">
+                lib/sdl4r/sdl_binary.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/parser/reader_rb.html">
+                lib/sdl4r/parser/reader.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/parser/tokenizer_rb.html">
+                lib/sdl4r/parser/tokenizer.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/parser/token_rb.html">
+                lib/sdl4r/parser/token.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/parser/time_span_with_zone_rb.html">
+                lib/sdl4r/parser/time_span_with_zone.rb
+                </a>
+        <br />
+                <a href="../files/lib/sdl4r/sdl4r_rb.html">
+                lib/sdl4r/sdl4r.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Gathers utility methods.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">SdlBinary</a>&nbsp;&nbsp;
+      <a href="#M000004">coerce_or_fail</a>&nbsp;&nbsp;
+      <a href="#M000002">format</a>&nbsp;&nbsp;
+      <a href="#M000003">new_date_time</a>&nbsp;&nbsp;
+      <a href="#M000006">read</a>&nbsp;&nbsp;
+      <a href="#M000009">to_attribute_map</a>&nbsp;&nbsp;
+      <a href="#M000007">to_value</a>&nbsp;&nbsp;
+      <a href="#M000008">to_value_array</a>&nbsp;&nbsp;
+      <a href="#M000005">validate_identifier</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="SDL4R/Parser.html" class="link">SDL4R::Parser</a><br />
+Class <a href="SDL4R/SdlBinary.html" class="link">SDL4R::SdlBinary</a><br />
+Class <a href="SDL4R/SdlParseError.html" class="link">SDL4R::SdlParseError</a><br />
+Class <a href="SDL4R/SdlTimeSpan.html" class="link">SDL4R::SdlTimeSpan</a><br />
+Class <a href="SDL4R/Tag.html" class="link">SDL4R::Tag</a><br />
+
+    </div>
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">MAX_INTEGER_32</td>
+          <td>=</td>
+          <td class="context-item-value">2**31 - 1</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">MIN_INTEGER_32</td>
+          <td>=</td>
+          <td class="context-item-value">-(2**31)</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">MAX_INTEGER_64</td>
+          <td>=</td>
+          <td class="context-item-value">2**63 - 1</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">MIN_INTEGER_64</td>
+          <td>=</td>
+          <td class="context-item-value">-(2**63)</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">BASE64_WRAP_LINE_LENGTH</td>
+          <td>=</td>
+          <td class="context-item-value">72</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">ESCAPED_QUOTES</td>
+          <td>=</td>
+          <td class="context-item-value">{       &quot;\&quot;&quot; =&gt; &quot;\\\&quot;&quot;,       &quot;'&quot; =&gt; &quot;\\'&quot;,       &quot;`&quot; =&gt; &quot;\\`&quot;,     }</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">ESCAPED_CHARS</td>
+          <td>=</td>
+          <td class="context-item-value">{       &quot;\\&quot; =&gt; &quot;\\\\&quot;,       &quot;\t&quot; =&gt; &quot;\\t&quot;,       &quot;\r&quot; =&gt; &quot;\\r&quot;,       &quot;\n&quot; =&gt; &quot;\\n&quot;,     }</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">SdlBinary</span><span class="method-args">(o)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Try to coerce &#8216;o&#8217; into a <a
+href="SDL4R.html#M000001">SdlBinary</a>. Raise an ArgumentError if it
+fails.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl_binary.rb, line 69</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-constant">SdlBinary</span>(<span class="ruby-identifier">o</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">SdlBinary</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">String</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-constant">SdlBinary</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">o</span>)
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;can't coerce argument&quot;</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">coerce_or_fail</span><span class="method-args">(o)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Coerce the type to a standard SDL type or raises an ArgumentError.
+</p>
+<p>
+Returns <tt>o</tt> if of the following classes: NilClass, String, Numeric,
+Float, TrueClass, FalseClass, Date, DateTime, Time, <a
+href="SDL4R/SdlTimeSpan.html">SdlTimeSpan</a>, <a
+href="SDL4R.html#M000001">SdlBinary</a>,
+</p>
+<p>
+Rationals are turned into Floats using Rational#to_f.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 149</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">coerce_or_fail</span>(<span class="ruby-identifier">o</span>)
+    <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">o</span>
+
+    <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Rational</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_f</span>
+
+    <span class="ruby-keyword kw">when</span> <span class="ruby-constant">NilClass</span>,
+        <span class="ruby-constant">String</span>,
+        <span class="ruby-constant">Numeric</span>,
+        <span class="ruby-constant">Float</span>,
+        <span class="ruby-constant">TrueClass</span>,
+        <span class="ruby-constant">FalseClass</span>,
+        <span class="ruby-constant">Date</span>,
+        <span class="ruby-constant">DateTime</span>,
+        <span class="ruby-constant">Time</span>,
+        <span class="ruby-constant">SdlTimeSpan</span>,
+        <span class="ruby-constant">SdlBinary</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>
+
+    <span class="ruby-keyword kw">end</span>
+
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;#{o.class.name} is not coercible to an SDL type&quot;</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">format</span><span class="method-args">(o, add_quotes = true, line_prefix = &quot;&quot;, indent = &quot;\t&quot;)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates an SDL string representation for a given object and returns it.
+</p>
+<table>
+<tr><td valign="top"><tt>o</tt>:</td><td>the object to <a href="SDL4R.html#M000002">format</a>
+
+</td></tr>
+<tr><td valign="top"><tt>add_quotes</tt>:</td><td>indicates whether quotes will be added to Strings and characters (true by
+default)
+
+</td></tr>
+<tr><td valign="top"><tt>line_prefix</tt>:</td><td>the line prefix to use (&quot;&quot; by default)
+
+</td></tr>
+<tr><td valign="top"><tt>indent</tt>:</td><td>the indent string to use (&quot;\t&quot; by default)
+
+</td></tr>
+</table>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 42</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">format</span>(<span class="ruby-identifier">o</span>, <span class="ruby-identifier">add_quotes</span> = <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">line_prefix</span> = <span class="ruby-value str">&quot;&quot;</span>, <span class="ruby-identifier">indent</span> = <span class="ruby-value str">&quot;\t&quot;</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">add_quotes</span>
+        <span class="ruby-identifier">o_length</span> = <span class="ruby-value">0</span>
+        <span class="ruby-identifier">o</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp re">/./</span><span class="ruby-identifier">m</span>) { <span class="ruby-identifier">o_length</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> } <span class="ruby-comment cmt"># counts the number of chars (as opposed of bytes)</span>
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o_length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">escape</span>(<span class="ruby-identifier">o</span>, <span class="ruby-value str">&quot;'&quot;</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;'&quot;</span>
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-value str">'&quot;'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">escape</span>(<span class="ruby-identifier">o</span>, <span class="ruby-value str">'&quot;'</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">'&quot;'</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">escape</span>(<span class="ruby-identifier">o</span>)
+      <span class="ruby-keyword kw">end</span>
+      
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Bignum</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;BD&quot;</span>
+      
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>)
+      <span class="ruby-keyword kw">if</span> <span class="ruby-constant">MIN_INTEGER_32</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">o</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">o</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-constant">MAX_INTEGER_32</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span>
+      <span class="ruby-keyword kw">elsif</span> <span class="ruby-constant">MIN_INTEGER_64</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">o</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">o</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-constant">MAX_INTEGER_64</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;L&quot;</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;BD&quot;</span>
+      <span class="ruby-keyword kw">end</span>
+      
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Float</span>)
+      <span class="ruby-keyword kw">return</span> (<span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;F&quot;</span>)
+      
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Rational</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_f</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;F&quot;</span>
+
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">BigDecimal</span>)
+      <span class="ruby-identifier">s</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span>(<span class="ruby-value str">'F'</span>)
+      <span class="ruby-identifier">s</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp re">/\.0$/</span>, <span class="ruby-value str">&quot;&quot;</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-node">&quot;#{s}BD&quot;</span>
+
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">nil?</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;null&quot;</span>
+
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">SdlBinary</span>)
+      <span class="ruby-identifier">encoded_o</span> = <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">o</span>.<span class="ruby-identifier">bytes</span>)
+      <span class="ruby-identifier">encoded_o</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/[\r\n]/</span><span class="ruby-identifier">m</span>, <span class="ruby-value str">&quot;&quot;</span>) <span class="ruby-comment cmt"># Remove the EOL inserted every 60 chars</span>
+
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">add_quotes</span>
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">encoded_o</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-constant">BASE64_WRAP_LINE_LENGTH</span>
+          <span class="ruby-comment cmt"># FIXME: we should a constant or some parameter instead of hardcoded spaces</span>
+          <span class="ruby-identifier">wrap_lines_in_ascii</span>(<span class="ruby-identifier">encoded_o</span>, <span class="ruby-constant">BASE64_WRAP_LINE_LENGTH</span>, <span class="ruby-node">&quot;#{line_prefix}#{indent}&quot;</span>)
+          <span class="ruby-identifier">encoded_o</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">0</span>, <span class="ruby-node">&quot;[#{$/}&quot;</span>)
+          <span class="ruby-identifier">encoded_o</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{$/}#{line_prefix}]&quot;</span>
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-identifier">encoded_o</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-value">0</span>, <span class="ruby-value str">&quot;[&quot;</span>)
+          <span class="ruby-identifier">encoded_o</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;]&quot;</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">encoded_o</span>
+      
+    <span class="ruby-comment cmt"># Below, we use &quot;#{o.year}&quot; instead of &quot;%Y&quot; because &quot;%Y&quot; always emit 4 chars at least even if</span>
+    <span class="ruby-comment cmt"># the date is before 1000.</span>
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">DateTime</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Time</span>)
+      <span class="ruby-identifier">milliseconds</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">DateTime</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">get_date_milliseconds</span>(<span class="ruby-identifier">o</span>) <span class="ruby-operator">:</span> (<span class="ruby-identifier">o</span>.<span class="ruby-identifier">usec</span> <span class="ruby-operator">/</span> <span class="ruby-value">10</span>).<span class="ruby-identifier">to_i</span>
+
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">zone</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-node">&quot;#{o.year}/%m/%d %H:%M:%S%Z&quot;</span>)
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-node">&quot;#{o.year}/%m/%d %H:%M:%S&quot;</span>)
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">zone</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-node">&quot;#{o.year}/%m/%d %H:%M:%S.&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">milliseconds</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-value">3</span>, <span class="ruby-value str">'0'</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;%Z&quot;</span>)
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-node">&quot;#{o.year}/%m/%d %H:%M:%S.&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">milliseconds</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-value">3</span>, <span class="ruby-value str">'0'</span>))
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+
+    <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Date</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-node">&quot;#{o.year}/%m/%d&quot;</span>)
+      
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_s</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">new_date_time</span><span class="method-args">(year, month, day, hour, min, sec, time_zone_offset)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates and returns the object representing a datetime (DateTime in the
+default implementation). This method is, by default, called by the <a
+href="SDL4R/Parser.html">Parser</a> class. It could be overriden as follows
+in order to get Time instances from all the <a href="SDL4R.html">SDL4R</a>
+parsers.
+</p>
+<pre>
+  module SDL4R
+    def self.new_date_time(year, month, day, hour, min, sec, time_zone_offset)
+      Time.utc(year, month, day, hour, min, sec)
+    end
+  end
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 137</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new_date_time</span>(<span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>, <span class="ruby-identifier">day</span>, <span class="ruby-identifier">hour</span>, <span class="ruby-identifier">min</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">time_zone_offset</span>)
+    <span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>, <span class="ruby-identifier">day</span>, <span class="ruby-identifier">hour</span>, <span class="ruby-identifier">min</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">time_zone_offset</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">read</span><span class="method-args">(input)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates and returns a tag named &quot;root&quot; and add all the tags
+specified in the given <tt>input</tt>.
+</p>
+<table>
+<tr><td valign="top"><tt>input</tt>:</td><td>String, IO, Pathname or URI.
+
+</td></tr>
+</table>
+<pre>
+  root = SDL4R::read(&lt;&lt;EOF
+  planets {
+    earth area_km2=510900000
+    mars
+  }
+  EOF
+  )
+
+  root = SDL4R::read(Pathname.new(&quot;my_dir/my_file.sdl&quot;))
+
+  IO.open(&quot;my_dir/my_file.sdl&quot;, &quot;r&quot;) { |io|
+    root = SDL4R::read(io)
+  }
+
+  root = SDL4R::read(URI.new(&quot;http://my_site/my_file.sdl&quot;))
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 230</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">input</span>)
+    <span class="ruby-constant">Tag</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;root&quot;</span>).<span class="ruby-identifier">read</span>(<span class="ruby-identifier">input</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">to_attribute_map</span><span class="method-args">(s)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Parse a string representing the attributes portion of an SDL tag and return
+the results as a map.
+</p>
+<p>
+Example
+</p>
+<pre>
+  hash = SDL4R.to_attribute_hash(&quot;value=1 debugging=on time=12:24:01&quot;);
+
+  # { &quot;value&quot; =&gt; 1, &quot;debugging&quot; =&gt; true, &quot;time&quot; =&gt; SdlTimeSpan.new(12, 24, 01) }
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 268</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_attribute_map</span>(<span class="ruby-identifier">s</span>)
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;'s' cannot be null&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">nil?</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">read</span>(<span class="ruby-value str">&quot;atts &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">s</span>).<span class="ruby-identifier">child</span>.<span class="ruby-identifier">attributes</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">to_value</span><span class="method-args">(s)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Parses and returns the value corresponding with the specified SDL literal.
+</p>
+<pre>
+  SDL4R.to_value(&quot;\&quot;abcd\&quot;&quot;) # =&gt; &quot;abcd&quot;
+  SDL4R.to_value(&quot;1&quot;) # =&gt; 1
+  SDL4R.to_value(&quot;null&quot;) # =&gt; nil
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 240</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_value</span>(<span class="ruby-identifier">s</span>)
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;'s' cannot be null&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">nil?</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">read</span>(<span class="ruby-identifier">s</span>).<span class="ruby-identifier">child</span>.<span class="ruby-identifier">value</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">to_value_array</span><span class="method-args">(s)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Parse the string of values and return a list. The string is handled as if
+it is the values portion of an SDL tag.
+</p>
+<p>
+Example
+</p>
+<pre>
+  array = SDL4R.to_value_array(&quot;1 true 12:24:01&quot;)
+</pre>
+<p>
+Will return an int, a boolean, and a time span.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 254</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_value_array</span>(<span class="ruby-identifier">s</span>)
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;'s' cannot be null&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">nil?</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">read</span>(<span class="ruby-identifier">s</span>).<span class="ruby-identifier">child</span>.<span class="ruby-identifier">values</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="#M000005" class="method-signature">
+          <span class="method-name">validate_identifier</span><span class="method-args">(identifier)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Validates an SDL identifier String. SDL Identifiers must start with a
+Unicode letter or underscore (_) and contain only unicode letters, digits,
+underscores (_), dashes(-) and periods (.).
+</p>
+<h2>Raises</h2>
+<p>
+ArgumentError if the identifier is not legal
+</p>
+<p>
+TODO: support UTF-8 identifiers
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sdl4r/sdl4r.rb, line 182</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validate_identifier</span>(<span class="ruby-identifier">identifier</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">identifier</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">identifier</span>.<span class="ruby-identifier">empty?</span>
+      <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;SDL identifiers cannot be null or empty.&quot;</span>
+    <span class="ruby-keyword kw">end</span>
+
+    <span class="ruby-comment cmt"># in Java, was if(!Character.isJavaIdentifierStart(identifier.charAt(0)))</span>
+    <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">identifier</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^[a-zA-Z_]/</span>
+      <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
+        <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">identifier</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">0</span>] <span class="ruby-operator">+</span>
+        <span class="ruby-value str">&quot;' is not a legal first character for an SDL identifier. &quot;</span> <span class="ruby-operator">+</span>
+        <span class="ruby-value str">&quot;SDL Identifiers must start with a unicode letter or &quot;</span> <span class="ruby-operator">+</span>
+        <span class="ruby-value str">&quot;an underscore (_).&quot;</span>
+    <span class="ruby-keyword kw">end</span>
+    
+    <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">identifier</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">identifier</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^[a-zA-Z_][a-zA-Z_0-9\-\.]*$/</span>
+      <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> <span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">identifier</span>.<span class="ruby-identifier">length</span>
+        <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">identifier</span>[<span class="ruby-identifier">i</span><span class="ruby-operator">..</span><span class="ruby-identifier">i</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^[a-zA-Z_0-9\-]$/</span>
+          <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
+            <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">identifier</span>[<span class="ruby-identifier">i</span><span class="ruby-operator">..</span><span class="ruby-identifier">i</span>] <span class="ruby-operator">+</span> 
+            <span class="ruby-value str">&quot;' is not a legal character for an SDL identifier. &quot;</span> <span class="ruby-operator">+</span>
+            <span class="ruby-value str">&quot;SDL Identifiers must start with a unicode letter or &quot;</span> <span class="ruby-operator">+</span>
+            <span class="ruby-value str">&quot;underscore (_) followed by 0 or more unicode &quot;</span> <span class="ruby-operator">+</span>
+            <span class="ruby-value str">&quot;letters, digits, underscores (_), or dashes (-)&quot;</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>