rdf 0.0.3 → 0.0.4

data/lib/rdf/literal.rb

@@ -0,0 +1,96 @@
+module RDF
+  ##
+  # An RDF literal.
+  class Literal < Value
+    # @return [String] The normalized string representation of the value.
+    attr_accessor :value
+
+    # @return [Symbol] The language tag (optional).
+    attr_accessor :language
+
+    # @return [URI] The XML Schema datatype URI (optional).
+    attr_accessor :datatype
+
+    ##
+    # @param  [Object]
+    # @option options [Symbol] :language (nil)
+    # @option options [URI]    :datatype (nil)
+    def initialize(value, options = {})
+      @value = value
+      @language = options[:language] ? options[:language].to_s.to_sym : nil
+
+      if datatype = options[:datatype]
+        @datatype = datatype.respond_to?(:to_uri) ? datatype.to_uri : URI.new(datatype.to_s)
+      else
+        @datatype = case value
+          when String     then nil # implicit XSD.string
+          when TrueClass  then XSD.boolean
+          when FalseClass then XSD.boolean
+          when Fixnum     then XSD.int
+          when Integer    then XSD.long # FIXME
+          when Float
+            @value = case
+              when value.nan? then 'NaN'
+              when value.infinite? then value.to_s[0...-'inity'.length].upcase
+              else value.to_f
+            end
+            XSD.double
+          when Time, Date, DateTime
+            require 'time'
+            @value = value.respond_to?(:xmlschema) ? value.xmlschema : value.to_s
+            case value
+              when DateTime then XSD.dateTime
+              when Date     then XSD.date
+              when Time     then XSD.dateTime
+            end
+        end
+      end
+
+      @value = @value.to_s
+    end
+
+    ##
+    # @return [Boolean]
+    def eql?(other)
+      other.is_a?(Literal) && self == other
+    end
+
+    ##
+    # @return [Boolean]
+    def ==(other)
+      case other
+        when Literal
+          value.eql?(other.value) &&
+          language.eql?(other.language) &&
+          datatype.eql?(other.datatype)
+        when String
+          value.eql?(other) &&
+            language.nil? &&
+            datatype.nil?
+        else false
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    def plain?
+      language.nil? && datatype.nil?
+    end
+
+    ##
+    # @return [Boolean]
+    def typed?
+      !datatype.nil?
+    end
+
+    ##
+    # @return [String]
+    def to_s
+      quoted = value # FIXME
+      output = "\"#{quoted}\""
+      output << "@#{language}" if language
+      output << "^^<#{datatype}>" if datatype
+      output
+    end
+  end
+end

data/lib/rdf/node.rb

@@ -0,0 +1,32 @@
+module RDF
+  ##
+  # An RDF blank node, also known as an unlabeled node.
+  class Node < Resource
+    # @return [String]
+    attr_accessor :id
+
+    ##
+    # @param  [#to_s]
+    def initialize(id = nil)
+      @id = (id || object_id).to_s
+    end
+
+    ##
+    # @return [Boolean]
+    def anonymous?() true end
+
+    ##
+    # @return [Boolean]
+    def labeled?()   !unlabeled? end
+
+    ##
+    # @return [Boolean]
+    def unlabeled?() anonymous? end
+
+    ##
+    # @return [String]
+    def to_s
+      "_:%s" % id.to_s
+    end
+  end
+end

data/lib/rdf/reader.rb

@@ -1,34 +1,53 @@
 module RDF
-  class ReaderError < IOError; end
-
+  ##
+  # An RDF parser.
+  #
+  # @abstract
   class Reader
     autoload :NTriples, 'rdf/reader/ntriples'
 
     include Enumerable
 
-    @@subclasses = []
-    @@file_extensions = {}
-    @@content_types = {}
+    @@subclasses       = []
+    @@file_extensions  = {}
+    @@content_types    = {}
     @@content_encoding = {}
 
+    ##
+    # Enumerates known RDF reader classes.
+    #
+    # @yield  [klass]
+    # @yieldparam [Class]
     def self.each(&block)
       !block_given? ? @@subclasses : @@subclasses.each { |klass| yield klass }
     end
 
+    ##
+    # @return [{String => Symbol}]
     def self.content_types
       @@content_types
     end
 
+    ##
+    # @return [{Symbol => String}]
     def self.file_extensions
       @@file_extensions
     end
 
+    ##
+    # @param  [Symbol] format
+    # @return [Class]
     def self.for(format)
       klass = case format.to_s.downcase.to_sym
         when :ntriples then RDF::Reader::NTriples
       end
     end
 
+    ##
+    # @param  [String] filename
+    # @option options [Symbol] :format (:ntriples)
+    # @yield  [reader]
+    # @yieldparam [Reader]
     def self.open(filename, options = {}, &block)
       options[:format] ||= :ntriples # FIXME
 
@@ -37,6 +56,10 @@ module RDF
       end
     end
 
+    ##
+    # @param  [IO, String] input
+    # @yield  [reader]
+    # @yieldparam [Reader]
     def initialize(input = $stdin, options = {}, &block)
       @options = options
       @nodes   = {}
@@ -47,35 +70,57 @@ module RDF
       block.call(self) if block_given?
     end
 
+    ##
+    # @yield  [statement]
+    # @yieldparam [Statement]
+    # @return [Reader]
     def each(&block)
       each_statement(&block)
     end
 
+    ##
+    # @yield  [statement]
+    # @yieldparam [Statement]
+    # @return [Reader]
     def each_statement(&block)
       each_triple { |*triple| block.call(Statement.new(*triple)) }
+      self
     end
 
+    ##
+    # @yield  [triple]
+    # @yieldparam [Array]
+    # @return [Reader]
     def each_triple(&block)
       begin
         loop { block.call(*read_triple) }
       rescue EOFError => e
       end
+      self
     end
 
     protected
 
+      ##
+      # @raise [NotImplementedError] unless implemented in subclass
       def read_triple
         raise NotImplementedError
       end
 
+      ##
+      # @raise [ReaderError]
       def fail_subject
         raise RDF::ReaderError, "expected subject in #{@input.inspect} line #{lineno}"
       end
 
+      ##
+      # @raise [ReaderError]
       def fail_predicate
         raise RDF::ReaderError, "expected predicate in #{@input.inspect} line #{lineno}"
       end
 
+      ##
+      # @raise [ReaderError]
       def fail_object
         raise RDF::ReaderError, "expected object in #{@input.inspect} line #{lineno}"
       end
@@ -125,4 +170,6 @@ module RDF
       end
 
   end
+
+  class ReaderError < IOError; end
 end

data/lib/rdf/reader/ntriples.rb

@@ -1,15 +1,18 @@
 module RDF class Reader
-  # See <http://www.w3.org/TR/rdf-testcases/#ntriples>
+  ##
+  # An N-Triples parser.
+  #
+  # @see http://www.w3.org/TR/rdf-testcases/#ntriples
   class NTriples < Reader
-
     content_type 'text/plain', :extension => :nt
     content_encoding 'ascii'
 
     protected
 
+      ##
+      # @return [Array, nil]
+      # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar
       def read_triple
-        # <http://www.w3.org/TR/rdf-testcases/#ntrip_grammar>
-
         loop do
           readline.strip! # EOFError thrown on end of input
 
@@ -22,31 +25,35 @@ module RDF class Reader
         end
       end
 
+      ##
+      # @return [Boolean]
+      # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (comment)
       def read_comment
-        # <http://www.w3.org/TR/rdf-testcases/#ntrip_grammar> (comment)
-
         match(/^#\s*(.*)$/)
       end
 
+      ##
+      # @return [URI, nil]
+      # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (uriref)
       def read_uriref
-        # <http://www.w3.org/TR/rdf-testcases/#ntrip_grammar> (uriref)
-
         if uri = match(/^<([^>]+)>/)
           RDF::URI.parse(uri)
         end
       end
 
+      ##
+      # @return [Node, nil]
+      # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (nodeID)
       def read_bnode
-        # <http://www.w3.org/TR/rdf-testcases/#ntrip_grammar> (nodeID)
-
         if node_id = match(/^_:([A-Za-z][A-Za-z0-9]*)/)
           @nodes[node_id] ||= Object.new # TODO: RDF::Node.new
         end
       end
 
+      ##
+      # @return [String, Literal, nil]
+      # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (literal)
       def read_literal
-        # <http://www.w3.org/TR/rdf-testcases/#ntrip_grammar> (literal)
-
         if literal = match(/^"((?:\\"|[^"])*)"/)
           literal = unescaped(literal)
 
@@ -62,15 +69,16 @@ module RDF class Reader
         end
       end
 
+      ##
+      # @param  [String] string
+      # @return [String]
+      # @see http://www.w3.org/TR/rdf-testcases/#ntrip_strings
       def unescaped(string)
-        # <http://www.w3.org/TR/rdf-testcases/#ntrip_strings>
-
         ["\t", "\n", "\r", "\"", "\\"].each do |escape|
           string.gsub!(escape.inspect[1...-1], escape)
         end
         string.gsub!(/\\u([0-9A-Fa-f]{4,4})/u) { [$1.hex].pack('U*') }
         string.gsub!(/\\U([0-9A-Fa-f]{8,8})/u) { [$1.hex].pack('U*') }
-
         string
       end
 

data/lib/rdf/resource.rb

@@ -0,0 +1,10 @@
+module RDF
+  ##
+  # An RDF resource.
+  #
+  # @abstract
+  class Resource < Value
+    # Prevent instantiation of this class.
+    private_class_method :new
+  end
+end

data/lib/rdf/statement.rb

@@ -1,30 +1,77 @@
 module RDF
   ##
   # An RDF statement.
-  class Statement
+  class Statement < Value
+    # @return [Object]
+    attr_accessor :id
+
+    # @return [Resource]
     attr_accessor :context
+
+    # @return [Resource]
     attr_accessor :subject
+
+    # @return [URI]
     attr_accessor :predicate
+
+    # @return [Value]
     attr_accessor :object
 
+    ##
+    # @param  [Resource] s
+    # @param  [URI]      p
+    # @param  [Value]    o
+    # @option options [Resource] :context (nil)
     def initialize(s = nil, p = nil, o = nil, options = {})
       @context = options[:context] || options[:graph]
       @subject, @predicate, @object = s, p, o
     end
 
+    ##
+    # @return [Boolean]
     def asserted?()  !quoted? end
+
+    ##
+    # @return [Boolean]
     def quoted?()    false end
 
+    ##
+    # @return [Boolean]
     def has_graph?()     has_context? end
+
+    ##
+    # @return [Boolean]
     def has_context?()   !!context end
+
+    ##
+    # @return [Boolean]
     def has_subject?()   !!subject end
+
+    ##
+    # @return [Boolean]
     def has_predicate?() !!predicate end
+
+    ##
+    # @return [Boolean]
     def has_object?()    !!object end
 
+    ##
+    # @param  [Statement] other
+    # @return [Boolean]
+    def eql?(other)
+      other.is_a?(Statement) && self == other
+    end
+
+    ##
+    # @param  [Object] other
+    # @return [Boolean]
     def ==(other)
       to_a == other.to_a
     end
 
+    ##
+    # @param  [Statement] other
+    # @return [Boolean]
     def ===(other)
       return false if has_subject?   && subject   != other.subject
       return false if has_predicate? && predicate != other.predicate
@@ -32,10 +79,17 @@ module RDF
       return true
     end
 
+    ##
+    # @param  [Integer] index
+    # @return [Value]
     def [](index)
       to_a[index]
     end
 
+    ##
+    # @param  [Integer] index
+    # @param  [Value]   value
+    # @return [Value]
     def []=(index, value)
       case index
         when 0 then subject   = value
@@ -45,16 +99,34 @@ module RDF
       end
     end
 
-    def to_a() to_ary end
-
-    def to_ary
+    ##
+    # @return [Array]
+    def to_triple
       [subject, predicate, object]
     end
 
+    ##
+    # @return [Array]
+    def to_quad
+      [subject, predicate, object, context]
+    end
+
+    ##
+    # @return [Array]
+    def to_a()   to_triple end
+
+    ##
+    # @return [Array]
+    def to_ary() to_triple end
+
+    ##
+    # @return [Hash]
     def to_hash
       { subject => { predicate => object } }
     end
 
+    ##
+    # @return [String]
     def to_s
       require 'stringio' unless defined?(StringIO)
       StringIO.open do |buffer|
@@ -64,9 +136,5 @@ module RDF
         buffer.string
       end
     end
-
-    def inspect
-      sprintf("#<%s:%#0x(%s)>", self.class.name, object_id, to_s)
-    end
   end
 end