rdf 0.0.5 → 0.0.6

data/lib/rdf/statement.rb

@@ -1,6 +1,23 @@
 module RDF
   ##
   # An RDF statement.
+  #
+  # @example Creating an RDF statement
+  #   s = RDF::URI.new("http://gemcutter.org/gems/rdf")
+  #   p = RDF::DC.creator
+  #   o = RDF::URI.new("http://ar.to/#self")
+  #   RDF::Statement.new(s, p, o)
+  #
+  # @example Creating an RDF statement with a context
+  #   RDF::Statement.new(s, p, o, :context => uri)
+  #
+  # @example Creating an RDF statement from a `Hash`
+  #   RDF::Statement.new({
+  #     :subject   => RDF::URI.new("http://gemcutter.org/gems/rdf"),
+  #     :predicate => RDF::DC.creator,
+  #     :object    => RDF::URI.new("http://ar.to/#self"),
+  #   })
+  #
   class Statement < Value
     # @return [Object]
     attr_accessor :id
@@ -18,14 +35,35 @@ module RDF
     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 = {})
-      @id = options[:id] if options.has_key?(:id)
-      @context = options[:context] || options[:graph]
-      @subject, @predicate, @object = s, p, o
+    # @overload initialize(options = {})
+    #   @param  [Hash{Symbol => Object}] options
+    #   @option options [Resource]       :subject   (nil)
+    #   @option options [URI]            :predicate (nil)
+    #   @option options [Value]          :object    (nil)
+    #   @option options [Resource]       :context   (nil)
+    #
+    # @overload initialize(subject, predicate, object, options = {})
+    #   @param  [Resource]               subject
+    #   @param  [URI]                    predicate
+    #   @param  [Value]                  object
+    #   @param  [Hash{Symbol => Object}] options
+    #   @option options [Resource]       :context   (nil)
+    def initialize(subject = nil, predicate = nil, object = nil, options = {})
+      case subject
+        when Hash
+          options    = subject
+          subject    = options.delete(:subject)
+          predicate  = options.delete(:predicate)
+          object     = options.delete(:object)
+          initialize(subject, predicate, object, options)
+        else
+          @id        = options.delete(:id) if options.has_key?(:id)
+          @context   = options.delete(:context) || options.delete(:graph)
+          @options   = options
+          @subject   = subject
+          @predicate = predicate
+          @object    = object
+      end
     end
 
     ##
@@ -136,9 +174,14 @@ module RDF
     alias_method :to_ary, :to_triple
 
     ##
-    # @return [Hash]
-    def to_hash
-      { subject => { predicate => object } }
+    # Returns the components of this statement as a `Hash`.
+    #
+    # @param  [Symbol] subject_key
+    # @param  [Symbol] predicate_key
+    # @param  [Symbol] object_key
+    # @return [Hash{Symbol => Value}]
+    def to_hash(subject_key = :subject, predicate_key = :predicate, object_key = :object)
+      {subject_key => subject, predicate_key => predicate, object_key => object}
     end
 
     ##

data/lib/rdf/uri.rb

@@ -3,6 +3,15 @@ require 'addressable/uri'
 module RDF
   ##
   # A Uniform Resource Identifier (URI).
+  #
+  # @example Creating a URI reference
+  #   uri = RDF::URI.new("http://rdf.rubyforge.org/")
+  #
+  # @example Getting the string representation of a URI
+  #   uri.to_s #=> "http://rdf.rubyforge.org/"
+  #
+  # @see http://en.wikipedia.org/wiki/Uniform_Resource_Identifier
+  # @see http://addressable.rubyforge.org/
   class URI < Node
     ##
     # @param  [String] uri
@@ -21,6 +30,16 @@ module RDF
     end
 
     ##
+    # Returns `true`.
+    #
+    # @return [Boolean]
+    def uri?
+      true
+    end
+
+    ##
+    # Returns `false`.
+    #
     # @return [Boolean]
     def anonymous?
       false

data/lib/rdf/value.rb

@@ -3,11 +3,62 @@ module RDF
   # An RDF value.
   #
   # @abstract
+  # @see Graph
+  # @see Literal
+  # @see Node
+  # @see Resource
+  # @see Statement
+  # @see URI
   class Value
-    # Prevent instantiation of this class.
+    # Prevent the instantiation of this class.
     private_class_method :new
 
     ##
+    # Returns `true` if this value is a graph.
+    #
+    # @return [Boolean]
+    def graph?
+      false
+    end
+
+    ##
+    # Returns `true` if this value is a literal.
+    #
+    # @return [Boolean]
+    def literal?
+      false
+    end
+
+    ##
+    # Returns `true` if this value is a blank node.
+    #
+    # @return [Boolean]
+    def node?
+      false
+    end
+
+    ##
+    # Returns `true` if this value is a URI.
+    #
+    # @return [Boolean]
+    def uri?
+      false
+    end
+
+    alias_method :iri?, :uri?
+
+    ##
+    # Compares this value to `other` for sorting purposes.
+    #
+    # @param  [Object]  other
+    # @return [Integer] -1, 0, 1
+    def <=>(other)
+      self.to_s <=> other.to_s
+    end
+
+    ##
+    # Returns a developer-readable representation of this value.
+    #
     # @return [String]
     def inspect
       sprintf("#<%s:%#0x(%s)>", self.class.name, object_id, to_s)
@@ -16,7 +67,7 @@ module RDF
     private
 
       def self.inherited(child) #:nodoc:
-        # Enable instantiation of subclasses.
+        # Enable the instantiation of any subclasses.
         child.send(:public_class_method, :new)
         super
       end

data/lib/rdf/version.rb

@@ -2,7 +2,7 @@ module RDF
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 5
+    TINY  = 6
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/rdf/vocabulary.rb

@@ -1,6 +1,23 @@
 module RDF
   ##
   # An RDF vocabulary.
+  #
+  # @example Using pre-defined RDF vocabularies
+  #   include RDF
+  #   DC.title      #=> RDF::URI("http://purl.org/dc/terms/title")
+  #   FOAF.knows    #=> RDF::URI("http://xmlns.com/foaf/0.1/knows")
+  #   RDFS.seeAlso  #=> RDF::URI("http://www.w3.org/2000/01/rdf-schema#seeAlso")
+  #   RSS.title     #=> RDF::URI("http://purl.org/rss/1.0/title")
+  #   OWL.sameAs    #=> RDF::URI("http://www.w3.org/2002/07/owl#sameAs")
+  #   XSD.dateTime  #=> RDF::URI("http://www.w3.org/2001/XMLSchema#dateTime")
+  #
+  # @example Using ad-hoc RDF vocabularies
+  #   foaf = RDF::Vocabulary.new("http://xmlns.com/foaf/0.1/")
+  #   foaf.knows    #=> RDF::URI("http://xmlns.com/foaf/0.1/knows")
+  #   foaf[:name]   #=> RDF::URI("http://xmlns.com/foaf/0.1/name")
+  #   foaf['mbox']  #=> RDF::URI("http://xmlns.com/foaf/0.1/mbox")
+  #
+  # @see http://www.w3.org/TR/curie/
   class Vocabulary
     ##
     # @return [String]

data/lib/rdf/writer.rb

@@ -4,15 +4,10 @@ module RDF
   #
   # @abstract
   class Writer
-    autoload :NTriples, 'rdf/writer/ntriples'
+    autoload :NTriples, 'rdf/writer/ntriples' # @deprecated
 
     include Enumerable
 
-    @@subclasses       = []
-    @@file_extensions  = {}
-    @@content_types    = {}
-    @@content_encoding = {}
-
     ##
     # Enumerates known RDF writer classes.
     #
@@ -22,23 +17,12 @@ module RDF
       !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
+        when :ntriples then RDF::NTriples::Writer
+        else nil # FIXME
       end
     end
 
@@ -149,25 +133,6 @@ module RDF
 
     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
@@ -214,6 +179,19 @@ module RDF
         "\"#{string}\""
       end
 
+    private
+
+      @@subclasses = [] # @private
+
+      def self.inherited(child) # @private
+        @@subclasses << child
+        super
+      end
+
+      def self.format(klass)
+        # TODO
+      end
+
   end
 
   class WriterError < IOError; end

data/lib/rdf/writer/ntriples.rb

@@ -1,50 +1,5 @@
-module RDF class Writer
-  ##
-  # An N-Triples serializer.
-  #
-  # @see <http://www.w3.org/TR/rdf-testcases/#ntriples>
-  class NTriples < Writer
-    content_type 'text/plain', :extension => :nt
-    content_encoding 'ascii'
-
-    ##
-    # @param  [String] text
-    # @return [void]
-    def write_comment(text)
-      puts "# #{text}"
-    end
-
-    ##
-    # @param  [Resource] subject
-    # @param  [URI]      predicate
-    # @param  [Value]    object
-    # @return [void]
-    def write_triple(subject, predicate, object)
-      s = format_uri(subject)
-      p = format_uri(predicate)
-      o = object.kind_of?(RDF::URI) ? format_uri(object) : format_literal(object)
-      puts "%s %s %s ." % [s, p, o]
-    end
-
-    ##
-    # @param  [node] Resource
-    # @return [void]
-    def format_uri(node)
-      "<%s>" % uri_for(node)
-    end
-
-    ##
-    # @param  [String, Literal] literal
-    # @return [void]
-    def format_literal(literal) # TODO
-      #if literal.kind_of?(RDF::Literal)
-      #  text = quoted(escaped(literal.value))
-      #  text << "@#{literal.language}" if literal.language
-      #  text << "^^<#{uri_for(literal.type)}>" if literal.type
-      #  text
-      #else
-        quoted(escaped(literal.to_s))
-      #end
-    end
+module RDF
+  class Writer
+    NTriples = RDF::NTriples::Writer # @deprecated
   end
-end end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdf
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Arto Bendiken
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-27 00:00:00 +01:00
+date: 2009-12-30 00:00:00 +01:00
 default_executable: rdf
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
 - !ruby/object:Gem::Dependency 
   name: addressable
   type: :runtime
@@ -58,9 +68,18 @@ files:
 - bin/rdf-subjects
 - lib/df.rb
 - lib/rdf/cli.rb
+- lib/rdf/format.rb
 - lib/rdf/graph.rb
 - lib/rdf/literal.rb
 - lib/rdf/node.rb
+- lib/rdf/ntriples/format.rb
+- lib/rdf/ntriples/reader.rb
+- lib/rdf/ntriples/writer.rb
+- lib/rdf/ntriples.rb
+- lib/rdf/query/pattern.rb
+- lib/rdf/query/solution.rb
+- lib/rdf/query/variable.rb
+- lib/rdf/query.rb
 - lib/rdf/reader/ntriples.rb
 - lib/rdf/reader.rb
 - lib/rdf/repository.rb