rdf 0.0.3 → 0.0.4

data/lib/rdf/uri.rb

@@ -1,5 +1,69 @@
 require 'addressable/uri'
 
 module RDF
-  include Addressable
+  ##
+  # A Uniform Resource Identifier (URI).
+  class URI < Node
+    ##
+    # @param  [String] uri
+    # @return [URI]
+    def self.parse(uri)
+      self.new(uri)
+    end
+
+    ##
+    # @param  [URI, String, #to_s] uri
+    def initialize(uri)
+      @uri = case uri
+        when Addressable::URI then uri
+        else Addressable::URI.parse(uri.to_s)
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    def anonymous?
+      false
+    end
+
+    ##
+    # @param  [URI] other
+    # @return [Boolean]
+    def eql?(other)
+      other.is_a?(URI) && self == other
+    end
+
+    ##
+    # @param  [Object] other
+    # @return [Boolean]
+    def ==(other)
+      other.respond_to?(:to_uri) && @uri == other.to_uri
+    end
+
+    ##
+    # @return [URI]
+    def to_uri
+      @uri
+    end
+
+    ##
+    # @return [String]
+    def to_s
+      @uri.to_s
+    end
+
+    protected
+
+      def respond_to?(symbol) #:nodoc:
+        @uri.respond_to?(symbol) || super
+      end
+
+      def method_missing(symbol, *args, &block) #:nodoc:
+        if @uri.respond_to?(symbol)
+          @uri.send(symbol, *args, &block)
+        else
+          super
+        end
+      end
+  end
 end

data/lib/rdf/value.rb

@@ -0,0 +1,25 @@
+module RDF
+  ##
+  # An RDF value.
+  #
+  # @abstract
+  class Value
+    # Prevent instantiation of this class.
+    private_class_method :new
+
+    ##
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(%s)>", self.class.name, object_id, to_s)
+    end
+
+    private
+
+      def self.inherited(child) #:nodoc:
+        # Enable instantiation of subclasses.
+        child.send(:public_class_method, :new)
+        super
+      end
+
+  end
+end

data/lib/rdf/version.rb

@@ -2,13 +2,18 @@ module RDF
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY].join('.')
     STRING << "-#{EXTRA}" if EXTRA
 
+    ##
+    # @return [String]
     def self.to_s()   STRING end
+
+    ##
+    # @return [String]
     def self.to_str() STRING end
   end
 end

data/lib/rdf/vocabulary.rb

@@ -2,7 +2,8 @@ module RDF
   ##
   # An RDF vocabulary.
   class Vocabulary
-
+    ##
+    # @return [String]
     def self.inspect
       if self == Vocabulary
         self.to_s
@@ -11,15 +12,32 @@ module RDF
       end
     end
 
-    def self.to_uri() RDF::URI.parse(to_s) end
-    def self.to_s()   @@uris.has_key?(self) ? @@uris[self].to_s : super end
+    ##
+    # @return [URI]
+    def self.to_uri
+      RDF::URI.parse(to_s)
+    end
+
+    ##
+    # @return [String]
+    def self.to_s
+      @@uris.has_key?(self) ? @@uris[self].to_s : super
+    end
 
+    ##
+    # @param  [#to_s] property
+    # @return [URI]
     def self.[](property)
       RDF::URI.parse([to_s, property.to_s].join(''))
     end
 
+    ##
+    # @param  [Symbol]
+    # @return [void]
     def self.property(symbol) end # TODO
 
+    ##
+    # @param  [URI, String]
     def initialize(uri)
       case uri
         when RDF::URI then @uri = uri.to_s
@@ -27,13 +45,25 @@ module RDF
       end
     end
 
+    ##
+    # @return [String]
     def inspect
       sprintf("#<%s:%#0x(%s)>", self.class.name, object_id, to_s)
     end
 
-    def to_uri() RDF::URI.parse(to_s) end
-    def to_s()   @uri.to_s end
+    ##
+    # @return [URI]
+    def to_uri
+      RDF::URI.parse(to_s)
+    end
+
+    ##
+    # @return [String]
+    def to_s() @uri.to_s end
 
+    ##
+    # @param  [#to_s] property
+    # @return [URI]
     def [](property)
       RDF::URI.parse([to_s, property.to_s].join(''))
     end
@@ -42,14 +72,16 @@ module RDF
       @@uris = {}
       @@uri  = nil
 
+      ##
       # @private
-      def self.create(uri)
+      def self.create(uri) #:nodoc:
         @@uri = uri
         self
       end
 
+      ##
       # @private
-      def self.inherited(subclass)
+      def self.inherited(subclass) #:nodoc:
         unless @@uri.nil?
           subclass.send(:private_class_method, :new)
           @@uris[subclass] = @@uri
@@ -75,6 +107,9 @@ module RDF
 
   end
 
+  ##
+  # @param  [String] uri
+  # @return [Class]
   def self.Vocabulary(uri)
     Vocabulary.create(uri)
   end

data/lib/rdf/vocabulary/cc.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Creative Commons (CC)
+  # Creative Commons (CC) vocabulary.
+  #
+  # @see http://creativecommons.org/ns
   class CC < Vocabulary("http://creativecommons.org/ns#")
     # TODO
   end

data/lib/rdf/vocabulary/dc.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Dublin Core (DC)
+  # Dublin Core (DC) vocabulary.
+  #
+  # @see http://dublincore.org/schemas/rdfs/
   class DC < Vocabulary("http://purl.org/dc/terms/")
     # TODO
   end

data/lib/rdf/vocabulary/doap.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Description of a Project (DOAP)
+  # Description of a Project (DOAP) vocabulary.
+  #
+  # @see http://trac.usefulinc.com/doap
   class DOAP < Vocabulary("http://usefulinc.com/ns/doap#")
     # TODO
   end

data/lib/rdf/vocabulary/exif.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Exchangeable Image File Format (EXIF)
+  # Exchangeable Image File Format (EXIF) vocabulary.
+  #
+  # @see http://www.w3.org/2003/12/exif/
   class EXIF < Vocabulary("http://www.w3.org/2003/12/exif/ns#")
     # TODO
   end

data/lib/rdf/vocabulary/foaf.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Friend of a Friend (FOAF)
+  # Friend of a Friend (FOAF) vocabulary.
+  #
+  # @see http://xmlns.com/foaf/spec/
   class FOAF < Vocabulary("http://xmlns.com/foaf/0.1/")
     # TODO
   end

data/lib/rdf/vocabulary/http.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Hypertext Transfer Protocol (HTTP)
+  # Hypertext Transfer Protocol (HTTP) vocabulary.
+  #
+  # @see http://www.w3.org/2006/http
   class HTTP < Vocabulary("http://www.w3.org/2006/http#")
     # TODO
   end

data/lib/rdf/vocabulary/owl.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Web Ontology Language (OWL)
+  # Web Ontology Language (OWL) vocabulary.
+  #
+  # @see http://www.w3.org/TR/owl-overview/
   class OWL < Vocabulary("http://www.w3.org/2002/07/owl#")
     # TODO
   end

data/lib/rdf/vocabulary/rdf.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Resource Description Framework (RDF)
+  # Resource Description Framework (RDF) vocabulary.
+  #
+  # @see http://www.w3.org/RDF/
   class RDF < Vocabulary("http://www.w3.org/1999/02/22-rdf-syntax-ns#")
     # TODO
   end

data/lib/rdf/vocabulary/rdfs.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # RDF Schema (RDFS)
+  # RDF Schema (RDFS) vocabulary.
+  #
+  # @see http://www.w3.org/TR/rdf-schema/
   class RDFS < Vocabulary("http://www.w3.org/2000/01/rdf-schema#")
     # TODO
   end

data/lib/rdf/vocabulary/rss.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # RDF Site Summary (RSS)
+  # RDF Site Summary (RSS) vocabulary.
+  #
+  # @see http://web.resource.org/rss/1.0/
   class RSS < Vocabulary("http://purl.org/rss/1.0/")
     # TODO
   end

data/lib/rdf/vocabulary/sioc.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Semantically-Interlinked Online Communities (SIOC)
+  # Semantically-Interlinked Online Communities (SIOC) vocabulary.
+  #
+  # @see http://rdfs.org/sioc/spec/
   class SIOC < Vocabulary("http://rdfs.org/sioc/ns#")
     # TODO
   end

data/lib/rdf/vocabulary/skos.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Simple Knowledge Organization System (SKOS)
+  # Simple Knowledge Organization System (SKOS) vocabulary.
+  #
+  # @see http://www.w3.org/TR/skos-reference/skos.html
   class SKOS < Vocabulary("http://www.w3.org/2004/02/skos/core#")
     # TODO
   end

data/lib/rdf/vocabulary/wot.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Web of Trust (WOT)
+  # Web of Trust (WOT) vocabulary.
+  #
+  # @see http://xmlns.com/wot/0.1/
   class WOT < Vocabulary("http://xmlns.com/wot/0.1/")
     # TODO
   end

data/lib/rdf/vocabulary/xhtml.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # Extensible HyperText Markup Language (XHTML)
+  # Extensible HyperText Markup Language (XHTML) vocabulary.
+  #
+  # @see http://www.w3.org/1999/xhtml/vocab/
   class XHTML < Vocabulary("http://www.w3.org/1999/xhtml/vocab#")
     # TODO
   end

data/lib/rdf/vocabulary/xsd.rb

@@ -1,6 +1,8 @@
 module RDF
   ##
-  # XML Schema (XSD)
+  # XML Schema (XSD) vocabulary.
+  #
+  # @see http://www.w3.org/XML/Schema
   class XSD < Vocabulary("http://www.w3.org/2001/XMLSchema#")
     # TODO
   end

data/lib/rdf/writer.rb

@@ -0,0 +1,220 @@
+module RDF
+  ##
+  # An RDF serializer.
+  #
+  # @abstract
+  class Writer
+    autoload :NTriples, 'rdf/writer/ntriples'
+
+    include Enumerable
+
+    @@subclasses       = []
+    @@file_extensions  = {}
+    @@content_types    = {}
+    @@content_encoding = {}
+
+    ##
+    # Enumerates known RDF writer classes.
+    #
+    # @yield  [klass]
+    # @yieldparam [Class]
+    def self.each(&block)
+      !block_given? ? @@subclasses : @@subclasses.each { |klass| yield klass }
+    end
+
+    ##
+    # Returns the list of known MIME content types.
+    def self.content_types
+      @@content_types
+    end
+
+    ##
+    # Returns the list of known file extensions.
+    def self.file_extensions
+      @@file_extensions
+    end
+
+    ##
+    # Returns the RDF writer class for the given format.
+    def self.for(format)
+      klass = case format.to_s.downcase.to_sym
+        when :ntriples then RDF::Writer::NTriples
+      end
+    end
+
+    def self.buffer(*args, &block)
+      require 'stringio' unless defined?(StringIO)
+
+      StringIO.open do |buffer|
+        self.new(buffer, *args) { |writer| block.call(writer) }
+        buffer.string
+      end
+    end
+
+    def self.open(filename, options = {}, &block)
+      options[:format] ||= :ntriples # FIXME
+
+      File.open(filename, 'wb') do |file|
+        self.for(options[:format]).new(file, options, &block)
+      end
+    end
+
+    def initialize(output = $stdout, options = {}, &block)
+      @output, @options = output, options
+      @nodes, @node_id = {}, 0
+
+      if block_given?
+        write_prologue
+        block.call(self)
+        write_epilogue
+      end
+    end
+
+    ##
+    # @abstract
+    def write_prologue() end
+
+    ##
+    # @abstract
+    def write_epilogue() end
+
+    ##
+    # @abstract
+    def write_comment(text) end
+
+    ##
+    # @raise [ArgumentError]
+    def <<(data)
+      case data # TODO
+        #when Graph
+        #  write_graph(data)
+        #when Resource
+        #  #register!(resource) && write_node(resource)
+        #  write_resource(data)
+        when Statement
+          write_statement(data)
+        else
+          if data.respond_to?(:to_a)
+            write_triple(*data.to_a)
+          else
+            raise ArgumentError.new("expected RDF::Statement or RDF::Resource, got #{data.inspect}")
+          end
+      end
+    end
+
+    ##
+    # @param  [Graph] graph
+    def write_graph(graph)
+      write_triples(*graph.triples)
+    end
+
+    def write_resource(subject) # FIXME
+      edge_nodes = []
+      subject.each do |predicate, objects|
+        [objects].flatten.each do |object|
+          edge_nodes << object if register!(object)
+          write_triple subject, predicate, object
+        end
+      end
+      edge_nodes.each { |node| write_resource node }
+    end
+
+    ##
+    # @param  [Array<Statement>] statements
+    def write_statements(*statements)
+      statements.flatten.each { |stmt| write_statement(stmt) }
+    end
+
+    ##
+    # @param  [Statement] statement
+    def write_statement(statement)
+      write_triple(*statement.to_a)
+    end
+
+    ##
+    # @param  [Array<Array>] triples
+    def write_triples(*triples)
+      triples.each { |triple| write_triple(*triple) }
+    end
+
+    ##
+    # @param  [Resource] subject
+    # @param  [URI]      predicate
+    # @param  [Value]    object
+    # @raise  [NotImplementedError] unless implemented in subclass
+    # @abstract
+    def write_triple(subject, predicate, object)
+      raise NotImplementedError # override in subclasses
+    end
+
+    protected
+
+      def self.inherited(child) #:nodoc:
+        @@subclasses << child
+        super
+      end
+
+      def self.content_type(type, options = {})
+        @@content_types[type] ||= []
+        @@content_types[type] << self
+
+        if options[:extension]
+          extensions = [options[:extension]].flatten.map { |ext| ext.to_sym }
+          extensions.each { |ext| @@file_extensions[ext] = type }
+        end
+      end
+
+      def self.content_encoding(encoding)
+        @@content_encoding[self] = encoding.to_sym
+      end
+
+      def puts(*args)
+        @output.puts(*args)
+      end
+
+      ##
+      # @param  [Resource] uriref
+      # @return [String]
+      def uri_for(uriref)
+        if uriref.respond_to?(:anonymous?) && uriref.anonymous?
+          @nodes[uriref]
+        elsif uriref.respond_to?(:to_uri)
+          uriref.to_uri.to_s
+        else
+          uriref.to_s
+        end
+      end
+
+      ##
+      # @return [String]
+      def node_id
+        "_:n#{@node_id += 1}"
+      end
+
+      def register!(resource)
+        if resource.kind_of?(RDF::Resource)
+          unless @nodes[resource] # have we already seen it?
+            @nodes[resource] = resource.uri || node_id
+          end
+        end
+      end
+
+      ##
+      # @param  [String] string
+      # @return [String]
+      def escaped(string)
+        string.gsub("\\", "\\\\").gsub("\t", "\\\t").
+          gsub("\n", "\\\n").gsub("\r", "\\\r").gsub("\"", "\\\"")
+      end
+
+      ##
+      # @param  [String] string
+      # @return [String]
+      def quoted(string)
+        "\"#{string}\""
+      end
+
+  end
+
+  class WriterError < IOError; end
+end