sxp 0.0.3 → 0.0.4

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/sxp.rb

@@ -1,7 +1,73 @@
 require 'sxp/version'
 require 'sxp/extensions'
-require 'sxp/pair'
-require 'sxp/list'
-require 'sxp/reader'
 require 'sxp/writer'
-require 'sxp/generator'
+
+module SXP
+  autoload :Pair,      'sxp/pair'
+  autoload :List,      'sxp/list'
+  autoload :Generator, 'sxp/generator'
+  autoload :Reader,    'sxp/reader'
+
+  ##
+  # Reads all S-expressions from a given input URI using the HTTP or FTP
+  # protocols.
+  #
+  # @param  [String, #to_s]          url
+  # @param  [Hash{Symbol => Object}] options
+  # @return [Enumerable<Object>]
+  def self.read_url(url, options = {})
+    require 'openuri'
+    open(url.to_s, 'rb', nil, options) { |io| read_all(io, options) }
+  end
+
+  ##
+  # Reads all S-expressions from the given input files.
+  #
+  # @param  [Enumerable<String>]     filenames
+  # @param  [Hash{Symbol => Object}] options
+  # @return [Enumerable<Object>]
+  def self.read_files(*filenames)
+    options = filenames.last.is_a?(Hash) ? filenames.pop : {}
+    filenames.map { |filename| read_file(filename, options) }.inject { |sxps, sxp| sxps + sxp }
+  end
+
+  ##
+  # Reads all S-expressions from a given input file.
+  #
+  # @param  [String, #to_s]          filename
+  # @param  [Hash{Symbol => Object}] options
+  # @return [Enumerable<Object>]
+  def self.read_file(filename, options = {})
+    File.open(filename.to_s, 'rb') { |io| read_all(io, options) }
+  end
+
+  ##
+  # Reads all S-expressions from the given input stream.
+  #
+  # @param  [IO, StringIO, String]   input
+  # @param  [Hash{Symbol => Object}] options
+  # @return [Enumerable<Object>]
+  def self.read_all(input, options = {})
+    Reader.new(input, options).read_all
+  end
+
+  ##
+  # Reads one S-expression from the given input stream.
+  #
+  # @param  [IO, StringIO, String]   input
+  # @param  [Hash{Symbol => Object}] options
+  # @return [Object]
+  def self.read(input, options = {})
+    Reader.new(input, options).read
+  end
+
+  class << self
+    alias_method :parse,       :read
+    alias_method :parse_all,   :read_all
+    alias_method :parse_files, :read_files
+    alias_method :parse_file,  :read_file
+    alias_method :parse_url,   :read_url
+    alias_method :parse_uri,   :read_url # @deprecated
+    alias_method :read_uri,    :read_url # @deprecated
+  end
+end # module SXP

data/lib/sxp/extensions.rb

@@ -1,6 +1,10 @@
+##
+# Extensions for Ruby's `Symbol` class.
 class Symbol
   ##
-  # Returns +true+ if this is a keyword symbol.
+  # Returns `true` if this is a keyword symbol.
+  #
+  # @return [Boolean]
   def keyword?
     to_s[-1] == ?:
   end

data/lib/sxp/generator.rb

@@ -1,14 +1,26 @@
 module SXP
+  ##
+  # An S-expression generator.
   class Generator
+    ##
+    # @param  [Array]  sxps
+    # @return [Object]
     def self.string(*sxps)
       require 'stringio' unless defined?(StringIO)
       write(StringIO.new, *sxps).instance_variable_get('@buffer').string
     end
 
+    ##
+    # @param  [Array]  sxps
+    # @return [Object]
     def self.print(*sxps)
       write($stdout, *sxps)
     end
 
+    ##
+    # @param  [Object] out
+    # @param  [Array]  sxps
+    # @return [Object]
     def self.write(out, *sxps)
       generator = self.new(out)
       sxps.each do |sxp|
@@ -17,6 +29,8 @@ module SXP
       generator
     end
 
+    ##
+    # @param  [Object] buffer
     def initialize(buffer)
       @output = [@buffer = buffer]
       @indent = 0
@@ -24,39 +38,53 @@ module SXP
 
     protected
 
-      def emit(text, options = {})
-        if out = @output.last
-          out.print(' ' * (indent * 2)) if options[:indent]
-          out.print(text)
-        end
+    ##
+    # @param  [String]                 text
+    # @param  [Hash{Symbol => Object}] options
+    # @return [void]
+    def emit(text, options = {})
+      if out = @output.last
+        out.print(' ' * (indent * 2)) if options[:indent]
+        out.print(text)
       end
+    end
 
-      def captured(&block)
-        require 'stringio' unless defined?(StringIO)
-        begin
-          @output.push(buffer = StringIO.new)
-          block.call
-        ensure
-          @output.pop
-        end
-        buffer.string
+    ##
+    # @yield
+    # @return [String]
+    def captured(&block)
+      require 'stringio' unless defined?(StringIO)
+      begin
+        @output.push(buffer = StringIO.new)
+        block.call
+      ensure
+        @output.pop
       end
+      buffer.string
+    end
 
-      def indented(&block)
-        begin
-          increase_indent!
-          block.call
-        ensure
-          decrease_indent!
-        end
+    ##
+    # @yield
+    # @return [Object]
+    def indented(&block)
+      begin
+        increase_indent!
+        block.call
+      ensure
+        decrease_indent!
       end
+    end
 
-      def increase_indent!()
-        @indent += 1
-      end
+    ##
+    # @return [void]
+    def increase_indent!
+      @indent += 1
+    end
 
-      def decrease_indent!()
-        @indent -= 1
-      end
-  end
-end
+    ##
+    # @return [void]
+    def decrease_indent!
+      @indent -= 1
+    end
+  end # class Generator
+end # module SXP

data/lib/sxp/list.rb

@@ -1,62 +1,106 @@
 require 'sxp/pair'
 
 module SXP
+  ##
+  # A singly-linked list.
   class List < Pair
     include Enumerable
 
+    ##
+    # @param  [Array]  elements
+    # @return [Object]
     def self.[](*elements)
       self.new(elements)
     end
 
+    ##
+    # @param  [Array]  elements
+    # @yield  [list]
+    # @yieldparam [List] list
     def initialize(elements = [], &block)
       @pair = nil
       unshift(*elements) unless elements.empty?
       block.call(self) if block_given?
     end
 
+    ##
+    # @return [String]
     def inspect
       "(" << map { |value| value.inspect }.join(' ') << ")"
     end
 
-    def head() first end
-    def tail() rest end
+    ##
+    # @return [Object]
+    def head
+      first
+    end
+
+    ##
+    # @return [Object]
+    def tail
+      rest
+    end
 
+    ##
+    # @return [Object]
     def rest
       empty? ? false : @pair.tail
     end
 
-    # Array interface
-
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def &(other)
       self.class.new(self.to_a & other.to_a)
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def |(other)
       self.class.new(self.to_a | other.to_a)
     end
 
+    ##
+    # @param  [Object] times
+    # @return [Object]
     def *(times)
       result = (self.to_a * times)
       result.is_a?(Array) ? self.class.new(result) : result
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def +(other)
       self.class.new(self.to_a + other.to_a)
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def -(other)
       self.class.new(self.to_a - other.to_a)
     end
 
+    ##
+    # @param  [Object] object
+    # @return [Object]
     def <<(object)
       push(object)
       self
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def <=>(other)
       to_a <=> other.to_a
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def ==(other)
       case other
         when List
@@ -68,56 +112,89 @@ module SXP
       end
     end
 
+    ##
+    # @param  [Array]   args
+    # @return [Object]
     def [](*args)
       result = to_a[*args]
       result.is_a?(Array) ? self.class.new(result) : result # FIXME
     end
 
+    ##
+    # @param  [Array]   args
+    # @return [Object]
     def []=(*args)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Object] object
+    # @return [Object]
     def assoc(object)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Integer] index
+    # @return [Object]
     def at(index)
       to_a.at(index)
     end
 
+    ##
+    # @return [Object]
     def clear
       @pair = nil
       self
     end
 
+    ##
+    # @return [Object]
     def collect!(&block)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Object]
     def compact
       self.class.new(to_a.compact)
     end
 
+    ##
+    # @return [Object]
     def compact!
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Object]
     def concat(other)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Object] object
+    # @return [Object]
     def delete(object, &block)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Integer] index
+    # @return [Object]
     def delete_at(index)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Object]
     def delete_if(&block)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Enumerator]
     def each(&block)
       pair = @pair
       while pair != nil
@@ -127,19 +204,25 @@ module SXP
       self
     end
 
+    ##
+    # @return [Enumerator]
     def each_index(&block)
       index = 0
       each do
         block.call(index)
         index += 1
       end
-      self
     end
 
+    ##
+    # @return [Boolean]
     def empty?
       @pair.nil?
     end
 
+    ##
+    # @param  [Object] other
+    # @return [Boolean]
     def eql?(other)
       case other
         when self then true
@@ -148,14 +231,23 @@ module SXP
       end
     end
 
+    ##
+    # @param  [Array]  args
+    # @return [Object]
     def fetch(*args, &block)
       to_a.fetch(*args, &block)
     end
 
+    ##
+    # @param  [Array]  args
+    # @return [Object]
     def fill(*args, &block)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Integer] count
+    # @return [Object]
     def first(count = nil)
       case
         when count.nil?
@@ -167,30 +259,50 @@ module SXP
       end
     end
 
+    ##
+    # @return [Object]
     def flatten
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Object]
     def flatten!
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Object] object
+    # @return [Object]
     def include?(object)
       to_a.include?(object)
     end
 
+    ##
+    # @param  [Object] object
+    # @return [Object]
     def index(object)
       to_a.index(object)
     end
 
+    ##
+    # @param  [Integer] index
+    # @param  [Array]   objects
+    # @return [Object]
     def insert(index, *objects)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [String] separator
+    # @return [Object]
     def join(separator = $,)
       to_a.join(separator)
     end
 
+    ##
+    # @param  [Integer] count
+    # @return [Object]
     def last(count = nil)
       case
         when count.nil?
@@ -200,38 +312,60 @@ module SXP
       end
     end
 
+    ##
+    # @return [Integer]
     def length
       @length ||= to_a.length
     end
 
+    ##
+    # @return [Object]
     def map!(&block)
       collect!(&block)
     end
 
+    ##
+    # @return [Integer]
     def nitems
       to_a.nitems
     end
 
+    ##
+    # @param  [Object] template
+    # @return [Object]
     def pack(template)
       to_a.pack(template)
     end
 
+    ##
+    # @return [Object]
     def pop
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Array]  objects
+    # @return [Object]
     def push(*objects)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Object] key
+    # @return [Object]
     def rassoc(key)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Object]
     def reject!(&block)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Object] other_list
+    # @return [Object]
     def replace(other_list)
       case other_list
         when Pair
@@ -247,72 +381,110 @@ module SXP
       self
     end
 
+    ##
+    # @return [Object]
     def reverse
       self.class.new(to_a.reverse)
     end
 
+    ##
+    # @return [Object]
     def reverse!
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Object]
     def reverse_each(&block)
       to_a.reverse_each(&block)
       self
     end
 
+    ##
+    # @param  [Object] object
+    # @return [Object]
     def rindex(object)
       to_a.rindex(object)
     end
 
+    ##
+    # @return [Object]
     def shift
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Integer]
     def size
       length
     end
 
+    ##
+    # @param  [Array]  args
+    # @return [Object]
     def slice(*args)
       self[*args]
     end
 
+    ##
+    # @param  [Array]  args
+    # @return [Object]
     def slice!(*args)
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [Object]
     def sort(&block)
       (array = to_a).sort!(&block)
       self.class.new(array)
     end
 
+    ##
+    # @return [Object]
     def sort!
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @return [List]
     def to_list
       self
     end
 
+    ##
+    # @return [Pair]
     def to_pair
       @pair
     end
 
+    ##
+    # @return [String]
     def to_s
       join
     end
 
+    ##
+    # @return [Object]
     def transpose
       self.class.new(to_a.transpose)
     end
 
+    ##
+    # @return [Object]
     def uniq
       self.class.new(to_a.uniq)
     end
 
+    ##
+    # @return [Object]
     def uniq!
       raise NotImplementedError # TODO
     end
 
+    ##
+    # @param  [Array]  objects
+    # @return [Object]
     def unshift(*objects)
       objects.reverse_each do |object|
         @pair = Pair.new(object, @pair)
@@ -320,8 +492,11 @@ module SXP
       self
     end
 
+    ##
+    # @param  [Array]  selector
+    # @return [Object]
     def values_at(*selector)
       self.class.new(to_a.values_at(*selector))
     end
-  end
-end
+  end # class List
+end # module SXP

data/lib/sxp/pair.rb

@@ -1,39 +1,64 @@
 module SXP
+  ##
   class Pair
+    # @return [Object]
     attr_accessor :head
+
+    # @return [Object]
     attr_accessor :tail
 
+    ##
+    # @param  [Object] head
+    # @param  [Object] tail
     def initialize(head = nil, tail = nil)
       @head, @tail = head, tail
     end
 
-    def inspect
-      case
-        when tail.nil?
-          "(#{head.inspect})"
-        else
-          "(#{head.inspect} . #{tail.inspect})"
-      end
-    end
-
+    ##
+    # Returns `true` if the head and tail of this pair are both `nil`.
+    #
+    # @return [Boolean]
     def empty?
       head.nil? && tail.nil?
     end
 
     ##
-    # @see http://srfi.schemers.org/srfi-1/srfi-1.html#ImproperLists
+    # Returns `true` if the tail of this pair is not `nil` or another pair.
+    #
+    # @return [Boolean]
+    # @see    http://srfi.schemers.org/srfi-1/srfi-1.html#ImproperLists
     def dotted?
       !proper?
     end
 
     ##
-    # @see http://srfi.schemers.org/srfi-1/srfi-1.html#ImproperLists
+    # Returns `true` if the tail of this pair is `nil` or another pair.
+    #
+    # @return [Boolean]
+    # @see    http://srfi.schemers.org/srfi-1/srfi-1.html#ImproperLists
     def proper?
       tail.nil? || tail.is_a?(Pair)
     end
 
+    ##
+    # Returns an array representation of this pair.
+    #
+    # @return [Array]
     def to_a
       [head, tail]
     end
-  end
-end
+
+    ##
+    # Returns a developer-friendly representation of this pair.
+    #
+    # @return [String]
+    def inspect
+      case
+        when tail.nil?
+          "(#{head.inspect})"
+        else
+          "(#{head.inspect} . #{tail.inspect})"
+      end
+    end
+  end # class Pair
+end # module SXP

data/lib/sxp/reader.rb

@@ -1,67 +1,6 @@
 module SXP
   ##
-  # Reads all S-expressions from a given input URI using the HTTP or FTP
-  # protocols.
-  #
-  # @param  [String, #to_s]          url
-  # @param  [Hash{Symbol => Object}] options
-  # @return [Enumerable<Object>]
-  def self.read_url(url, options = {})
-    require 'openuri'
-    open(url.to_s, 'rb', nil, options) { |io| read_all(io, options) }
-  end
-
-  ##
-  # Reads all S-expressions from the given input files.
-  #
-  # @param  [Enumerable<String>]     filenames
-  # @param  [Hash{Symbol => Object}] options
-  # @return [Enumerable<Object>]
-  def self.read_files(*filenames)
-    options = filenames.last.is_a?(Hash) ? filenames.pop : {}
-    filenames.map { |filename| read_file(filename, options) }.inject { |sxps, sxp| sxps + sxp }
-  end
-
-  ##
-  # Reads all S-expressions from a given input file.
-  #
-  # @param  [String, #to_s]          filename
-  # @param  [Hash{Symbol => Object}] options
-  # @return [Enumerable<Object>]
-  def self.read_file(filename, options = {})
-    File.open(filename.to_s, 'rb') { |io| read_all(io, options) }
-  end
-
-  ##
-  # Reads all S-expressions from the given input stream.
-  #
-  # @param  [IO, StringIO, String]   input
-  # @param  [Hash{Symbol => Object}] options
-  # @return [Enumerable<Object>]
-  def self.read_all(input, options = {})
-    Reader.new(input, options).read_all
-  end
-
-  ##
-  # Reads one S-expression from the given input stream.
-  #
-  # @param  [IO, StringIO, String]   input
-  # @param  [Hash{Symbol => Object}] options
-  # @return [Object]
-  def self.read(input, options = {})
-    Reader.new(input, options).read
-  end
-
-  class << self
-    alias_method :parse,       :read
-    alias_method :parse_all,   :read_all
-    alias_method :parse_files, :read_files
-    alias_method :parse_file,  :read_file
-    alias_method :parse_url,   :read_url
-    alias_method :parse_uri,   :read_url # @deprecated
-    alias_method :read_uri,    :read_url # @deprecated
-  end
-
+  # The base class for S-expression parsers.
   class Reader
     include Enumerable
 
@@ -76,8 +15,12 @@ module SXP
     RATIONAL        = /^([+-]?\d+)\/(\d+)$/
     ATOM            = /^[^\s()\[\]]+/
 
+    # @return [Object]
     attr_reader :input
 
+    ##
+    # @param  [Object] input
+    # @param  [Hash{Symbol => Object}] options
     def initialize(input, options = {})
       case
         when [:getc, :ungetc, :eof?].all? { |x| input.respond_to?(x) }
@@ -90,10 +33,17 @@ module SXP
       end
     end
 
+    ##
+    # @yield  [object]
+    # @yieldparam [Object] object
+    # @return [Enumerator]
     def each(&block)
-      block.call(read)
+      block.call(read) if block_given? # FIXME
     end
 
+    ##
+    # @param  [Hash{Symbol => Object}] options
+    # @return [Array]
     def read_all(options = {})
       list = []
       catch (:eof) do
@@ -102,6 +52,9 @@ module SXP
       list
     end
 
+    ##
+    # @param  [Hash{Symbol => Object}] options
+    # @return [Object]
     def read(options = {})
       skip_comments
       token, value = read_token
@@ -122,6 +75,8 @@ module SXP
 
     alias_method :skip, :read
 
+    ##
+    # @return [Object]
     def read_token
       case peek_char
         when nil    then :eof
@@ -133,6 +88,8 @@ module SXP
       end
     end
 
+    ##
+    # @param [Array]
     def read_list
       list = []
       catch (:eol) do
@@ -141,23 +98,28 @@ module SXP
       list
     end
 
+    ##
+    # @return [Object]
     def read_sharp
       skip_char # '#'
       case char = read_char
-        when ?n then nil
-        when ?f then false
-        when ?t then true
-        when ?b then read_integer(2)
-        when ?o then read_integer(8)
-        when ?d then read_integer(10)
-        when ?x then read_integer(16)
+        when ?n  then nil
+        when ?f  then false
+        when ?t  then true
+        when ?b  then read_integer(2)
+        when ?o  then read_integer(8)
+        when ?d  then read_integer(10)
+        when ?x  then read_integer(16)
         when ?\\ then read_character
-        when ?; then skip; read
-        when ?! then skip_line # shebang
+        when ?;  then skip; read
+        when ?!  then skip_line; read # shebang
         else raise Error, "invalid sharp-sign read syntax: ##{char.chr}"
       end
     end
 
+    ##
+    # @param  [Integer] base
+    # @return [Integer]
     def read_integer(base = 10)
       case buffer = read_literal
         when self.class.const_get(:"INTEGER_BASE_#{base}")
@@ -166,6 +128,8 @@ module SXP
       end
     end
 
+    ##
+    # @return [Object]
     def read_atom
       case buffer = read_literal
         when '.'             then buffer.to_sym
@@ -176,6 +140,8 @@ module SXP
       end
     end
 
+    ##
+    # @return [String]
     def read_string
       buffer = String.new
       skip_char # '"'
@@ -190,6 +156,8 @@ module SXP
       buffer
     end
 
+    ##
+    # @return [String]
     def read_character
       case char = read_char
         when ?b then ?\b
@@ -203,12 +171,16 @@ module SXP
       end
     end
 
+    ##
+    # @return [String]
     def read_literal
       buffer = String.new
       buffer << read_char while !eof? && peek_char.chr =~ ATOM
       buffer
     end
 
+    ##
+    # @return [void]
     def skip_comments
       until eof?
         case (char = peek_char).chr
@@ -219,18 +191,25 @@ module SXP
       end
     end
 
+    ##
+    # @param  [Integer] count
+    # @return [String]
     def read_chars(count = 1)
       buffer = ''
       count.times { buffer << read_char.chr }
       buffer
     end
 
+    ##
+    # @return [String]
     def read_char
       char = @input.getc
       raise EOF, 'unexpected end of input' if char.nil?
       char
     end
 
+    ##
+    # @return [void]
     def skip_line
       loop do
         break if eof? || read_char.chr == $/
@@ -239,13 +218,18 @@ module SXP
 
     alias_method :skip_char, :read_char
 
+    ##
+    # @return [String]
     def peek_char
       char = @input.getc
       @input.ungetc char unless char.nil?
       char
     end
 
-    def eof?() @input.eof? end
-  end
-
-end
+    ##
+    # @return [Boolean]
+    def eof?
+      @input.eof?
+    end
+  end # class Reader
+end # module SXP

data/lib/sxp/version.rb

@@ -2,7 +2,7 @@ module SXP
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/sxp/writer.rb

@@ -1,34 +1,94 @@
+##
+# Extensions for Ruby's `Object` class.
 class Object
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
   def to_sxp
     to_s.to_json
   end
 end
 
+##
+# Extensions for Ruby's `NilClass` class.
 class NilClass
-  def to_sxp; '#n'; end
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
+  def to_sxp
+    '#n'
+  end
 end
 
+##
+# Extensions for Ruby's `FalseClass` class.
 class FalseClass
-  def to_sxp; '#f'; end
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
+  def to_sxp
+    '#f'
+  end
 end
 
+##
+# Extensions for Ruby's `TrueClass` class.
 class TrueClass
-  def to_sxp; '#t'; end
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
+  def to_sxp
+    '#t'
+  end
 end
 
+##
+# Extensions for Ruby's `String` class.
 class String
-  def to_sxp; inspect; end
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
+  def to_sxp
+    inspect
+  end
 end
 
+##
+# Extensions for Ruby's `Symbol` class.
 class Symbol
-  def to_sxp; to_s; end
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
+  def to_sxp
+    to_s
+  end
 end
 
+##
+# Extensions for Ruby's `Integer` class.
 class Integer
-  def to_sxp; to_s; end
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
+  def to_sxp
+    to_s
+  end
 end
 
+##
+# Extensions for Ruby's `Float` class.
 class Float
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
   def to_sxp
     case
       when nan? then 'nan.'
@@ -38,19 +98,37 @@ class Float
   end
 end
 
+##
+# Extensions for Ruby's `Array` class.
 class Array
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
   def to_sxp
     '(' << map { |x| x.to_sxp }.join(' ') << ')'
   end
 end
 
+##
+# Extensions for Ruby's `Time` class.
 class Time
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
   def to_sxp
     '#@' << (respond_to?(:xmlschema) ? xmlschema : to_i).to_s
   end
 end
 
+##
+# Extensions for Ruby's `Regexp` class.
 class Regexp
+  ##
+  # Returns the SXP representation of this object.
+  #
+  # @return [String]
   def to_sxp
     '#' << inspect
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Arto Bendiken
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 +02:00
+date: 2010-05-25 00:00:00 +02:00
 default_executable: sxp2rdf
 dependencies: 
 - !ruby/object:Gem::Dependency