rdf 0.2.3 → 0.3.0.pre

data/lib/rdf/writer.rb

@@ -1,6 +1,9 @@
 module RDF
   ##
-  # An RDF serializer.
+  # The base class for RDF serializers.
+  #
+  # @example Loading an RDF writer implementation
+  #   require 'rdf/ntriples'
   #
   # @example Iterating over known RDF writer classes
   #   RDF::Writer.each { |klass| puts klass.name }
@@ -33,15 +36,16 @@ module RDF
   # @see RDF::Format
   # @see RDF::Reader
   class Writer
-    extend RDF::Util::Aliasing::LateBound
     extend  ::Enumerable
+    extend  RDF::Util::Aliasing::LateBound
     include RDF::Writable
 
     ##
     # Enumerates known RDF writer classes.
     #
     # @yield  [klass]
-    # @yieldparam [Class]
+    # @yieldparam  [Class] klass
+    # @yieldreturn [void] ignored
     # @return [Enumerator]
     def self.each(&block)
       @@subclasses.each(&block)
@@ -122,8 +126,11 @@ module RDF
     end
 
     ##
+    # Buffers output into a string buffer.
+    #
     # @yield  [writer]
-    # @yieldparam [Writer] writer
+    # @yieldparam  [RDF::Writer] writer
+    # @yieldreturn [void]
     # @return [String]
     def self.buffer(*args, &block)
       StringIO.open do |buffer|
@@ -133,9 +140,13 @@ module RDF
     end
 
     ##
-    # @param  [String]                 filename
+    # Writes output to the given `filename`.
+    #
+    # @param  [String, #to_s] filename
     # @param  [Hash{Symbol => Object}] options
-    # @return [Writer]
+    #   any additional options (see {RDF::Writer#initialize})
+    # @option options [Symbol] :format (nil)
+    # @return [RDF::Writer]
     def self.open(filename, options = {}, &block)
       File.open(filename, 'wb') do |file|
         self.for(options[:format] || filename).new(file, options, &block)
@@ -143,11 +154,24 @@ module RDF
     end
 
     ##
-    # @param  [IO, File]               output
+    # Initializes the writer.
+    #
+    # @param  [IO, File] output
+    #   the output stream
     # @param  [Hash{Symbol => Object}] options
-    # @option options [Hash] :prefixes ({})
-    # @yield  [writer]
-    # @yieldparam [RDF::Writer] writer
+    #   any additional options
+    # @option options [Encoding] :encoding     (Encoding::UTF_8)
+    #   the encoding to use on the output stream (Ruby 1.9+)
+    # @option options [Boolean]  :canonicalize (false)
+    #   whether to canonicalize literals when serializing
+    # @option options [Hash]     :prefixes     (Hash.new)
+    #   the prefix mappings to use (not supported by all writers)
+    # @option options [#to_s]    :base_uri     (nil)
+    #   the base URI to use when constructing relative URIs (not supported
+    #   by all writers)
+    # @yield  [writer] `self`
+    # @yieldparam  [RDF::Writer] writer
+    # @yieldreturn [void]
     def initialize(output = $stdout, options = {}, &block)
       @output, @options = output, options.dup
       @nodes, @node_id  = {}, 0
@@ -155,29 +179,55 @@ module RDF
       if block_given?
         write_prologue
         case block.arity
-          when 1 then block.call(self)
-          else instance_eval(&block)
+          when 0 then instance_eval(&block)
+          else block.call(self)
         end
         write_epilogue
       end
     end
 
     ##
-    # Returns the options for this writer.
+    # Any additional options for this writer.
     #
-    # @return [Hash{Symbol => Object}]
+    # @return [Hash]
+    # @since  0.2.2
     attr_reader :options
 
     ##
     # Returns the URI prefixes currently defined for this writer.
     #
+    # @example
+    #   writer.prefixes[:dc]  #=> RDF::URI('http://purl.org/dc/terms/')
+    #
     # @return [Hash{Symbol => RDF::URI}]
+    # @since  0.2.2
     def prefixes
-      options[:prefixes] ||= {}
+      @options[:prefixes] ||= {}
     end
 
     ##
-    # Defines a named URI prefix for this writer.
+    # Defines the given URI prefixes for this writer.
+    #
+    # @example
+    #   writer.prefixes = {
+    #     :dc => RDF::URI('http://purl.org/dc/terms/'),
+    #   }
+    #
+    # @param  [Hash{Symbol => RDF::URI}] prefixes
+    # @return [Hash{Symbol => RDF::URI}]
+    # @since  0.3.0
+    def prefixes=(prefixes)
+      @options[:prefixes] = prefixes
+    end
+
+    ##
+    # Defines the given named URI prefix for this writer.
+    #
+    # @example Defining a URI prefix
+    #   writer.prefix :dc, RDF::URI('http://purl.org/dc/terms/')
+    #
+    # @example Returning a URI prefix
+    #   writer.prefix(:dc)    #=> RDF::URI('http://purl.org/dc/terms/')
     #
     # @overload prefix(name, uri)
     #   @param  [Symbol, #to_s]   name
@@ -186,73 +236,82 @@ module RDF
     # @overload prefix(name)
     #   @param  [Symbol, #to_s]   name
     #
-    # @return [void]
+    # @return [RDF::URI]
     def prefix(name, uri = nil)
       name = name.respond_to?(:to_sym) ? name.to_sym : name.to_s.to_sym
       uri.nil? ? prefixes[name] : prefixes[name] = RDF::URI(uri)
     end
-
     alias_method :prefix!, :prefix
 
     ##
     # Flushes the underlying output buffer.
     #
-    # @return [void]
+    # @return [void] `self`
     def flush
       @output.flush if @output.respond_to?(:flush)
+      self
     end
-
     alias_method :flush!, :flush
 
     ##
-    # @return [void]
+    # @return [void] `self`
     # @abstract
-    def write_prologue() end
+    def write_prologue
+      self
+    end
 
     ##
-    # @return [void]
+    # @return [void] `self`
     # @abstract
-    def write_epilogue() end
+    def write_epilogue
+      self
+    end
 
     ##
     # @param  [String] text
-    # @return [void]
+    # @return [void] `self`
     # @abstract
-    def write_comment(text) end
+    def write_comment(text)
+      self
+    end
 
     ##
     # @param  [RDF::Graph] graph
-    # @return [void]
+    # @return [void] `self`
     def write_graph(graph)
       graph.each_triple { |*triple| write_triple(*triple) }
+      self
     end
 
     ##
     # @param  [Array<RDF::Statement>] statements
-    # @return [void]
+    # @return [void] `self`
     def write_statements(*statements)
       statements.flatten.each { |statement| write_statement(statement) }
+      self
     end
 
     ##
     # @param  [RDF::Statement] statement
-    # @return [void]
+    # @return [void] `self`
     def write_statement(statement)
       write_triple(*statement.to_triple)
+      self
     end
 
     ##
     # @param  [Array<Array(RDF::Resource, RDF::URI, RDF::Value)>] triples
-    # @return [void]
+    # @return [void] `self`
     def write_triples(*triples)
       triples.each { |triple| write_triple(*triple) }
+      self
     end
 
     ##
     # @param  [RDF::Resource] subject
     # @param  [RDF::URI]      predicate
     # @param  [RDF::Value]    object
-    # @return [void]
+    # @return [void] `self`
     # @raise  [NotImplementedError] unless implemented in subclass
     # @abstract
     def write_triple(subject, predicate, object)
@@ -269,7 +328,7 @@ module RDF
     # @return [String]
     def format_value(value, options = {})
       case value
-        when String       then format_literal(RDF::Literal.new(value, options), options)
+        when String       then format_literal(RDF::Literal(value, options), options)
         when RDF::List    then format_list(value, options)
         when RDF::Literal then format_literal(value, options)
         when RDF::URI     then format_uri(value, options)
@@ -279,7 +338,7 @@ module RDF
     end
 
     ##
-    # @param  [Node]                   value
+    # @param  [RDF::Node] value
     # @param  [Hash{Symbol => Object}] options
     # @return [String]
     # @raise  [NotImplementedError] unless implemented in subclass
@@ -289,7 +348,7 @@ module RDF
     end
 
     ##
-    # @param  [URI]                    value
+    # @param  [RDF::URI] value
     # @param  [Hash{Symbol => Object}] options
     # @return [String]
     # @raise  [NotImplementedError] unless implemented in subclass
@@ -299,7 +358,7 @@ module RDF
     end
 
     ##
-    # @param  [Literal, String, #to_s] value
+    # @param  [RDF::Literal, String, #to_s] value
     # @param  [Hash{Symbol => Object}] options
     # @return [String]
     # @raise  [NotImplementedError] unless implemented in subclass
@@ -309,7 +368,7 @@ module RDF
     end
 
     ##
-    # @param  [List] value
+    # @param  [RDF::List] value
     # @param  [Hash{Symbol => Object}] options
     # @return [String]
     # @abstract
@@ -346,16 +405,6 @@ module RDF
       "_:n#{@node_id += 1}"
     end
 
-    ##
-    # @deprecated
-    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]
@@ -375,11 +424,17 @@ module RDF
 
     @@subclasses = [] # @private
 
-    def self.inherited(child) # @private
+    ##
+    # @private
+    # @return [void]
+    def self.inherited(child)
       @@subclasses << child
       super
     end
-  end # class Writer
+  end # Writer
 
-  class WriterError < IOError; end
-end
+  ##
+  # The base class for RDF serialization errors.
+  class WriterError < IOError
+  end # WriterError
+end # RDF

data/lib/rdf.rb

@@ -26,51 +26,53 @@ module RDF
   Enumerator = defined?(::Enumerator) ? ::Enumerator : ::Enumerable::Enumerator
 
   # RDF mixins
-  autoload :Countable,  'rdf/mixin/countable'
-  autoload :Durable,    'rdf/mixin/durable'
-  autoload :Enumerable, 'rdf/mixin/enumerable'
-  autoload :Inferable,  'rdf/mixin/inferable'
-  autoload :Mutable,    'rdf/mixin/mutable'
-  autoload :Queryable,  'rdf/mixin/queryable'
-  autoload :Readable,   'rdf/mixin/readable'
-  autoload :Writable,   'rdf/mixin/writable'
+  autoload :Countable,   'rdf/mixin/countable'
+  autoload :Durable,     'rdf/mixin/durable'
+  autoload :Enumerable,  'rdf/mixin/enumerable'
+  autoload :Indexable,   'rdf/mixin/indexable'
+  autoload :Inferable,   'rdf/mixin/inferable'
+  autoload :Mutable,     'rdf/mixin/mutable'
+  autoload :Queryable,   'rdf/mixin/queryable'
+  autoload :Readable,    'rdf/mixin/readable'
+  autoload :Writable,    'rdf/mixin/writable'
 
   # RDF objects
-  autoload :Graph,      'rdf/model/graph'
-  autoload :Literal,    'rdf/model/literal'
-  autoload :Node,       'rdf/model/node'
-  autoload :Resource,   'rdf/model/resource'
-  autoload :Statement,  'rdf/model/statement'
-  autoload :URI,        'rdf/model/uri'
-  autoload :Value,      'rdf/model/value'
+  autoload :Graph,       'rdf/model/graph'
+  autoload :Literal,     'rdf/model/literal'
+  autoload :Node,        'rdf/model/node'
+  autoload :Resource,    'rdf/model/resource'
+  autoload :Statement,   'rdf/model/statement'
+  autoload :URI,         'rdf/model/uri'
+  autoload :Value,       'rdf/model/value'
 
   # RDF collections
-  autoload :List,       'rdf/model/list'
+  autoload :List,        'rdf/model/list'
 
   # RDF serialization
-  autoload :Format,     'rdf/format'
-  autoload :Reader,     'rdf/reader'
-  autoload :ReaderError,'rdf/reader'
-  autoload :Writer,     'rdf/writer'
-  autoload :WriterError,'rdf/writer'
+  autoload :Format,      'rdf/format'
+  autoload :Reader,      'rdf/reader'
+  autoload :ReaderError, 'rdf/reader'
+  autoload :Writer,      'rdf/writer'
+  autoload :WriterError, 'rdf/writer'
 
   # RDF serialization formats
-  autoload :NTriples,   'rdf/ntriples'
-  autoload :NQuads,     'rdf/nquads'
+  autoload :NTriples,    'rdf/ntriples'
+  autoload :NQuads,      'rdf/nquads'
 
   # RDF storage
-  autoload :Repository, 'rdf/repository'
+  autoload :Repository,  'rdf/repository'
+  autoload :Transaction, 'rdf/transaction'
 
   # RDF querying
-  autoload :Query,      'rdf/query'
+  autoload :Query,       'rdf/query'
 
   # RDF vocabularies
-  autoload :Vocabulary, 'rdf/vocab'
+  autoload :Vocabulary,  'rdf/vocab'
   VOCABS = Dir.glob(File.join(File.dirname(__FILE__), 'rdf', 'vocab', '*.rb')).map { |f| File.basename(f)[0...-(File.extname(f).size)].to_sym } rescue []
   VOCABS.each { |v| autoload v.to_s.upcase.to_sym, "rdf/vocab/#{v}" unless v == :rdf }
 
   # Utilities
-  autoload :Util,       'rdf/util'
+  autoload :Util,        'rdf/util'
 
   ##
   # Alias for `RDF::Resource.new`.

metadata

@@ -1,21 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: rdf
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  - pre
+  version: 0.3.0.pre
 platform: ruby
 authors: 
 - Arto Bendiken
 - Ben Lavender
+- Gregg Kellogg
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-08-26 00:00:00 +02:00
+date: 2010-11-18 00:00:00 +01:00
 default_executable: rdf
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,13 +25,12 @@ dependencies:
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 2
         - 2
-        - 0
-        version: 2.2.0
+        version: "2.2"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -41,9 +42,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 5
-        - 8
-        version: 0.5.8
+        - 6
+        - 0
+        version: 0.6.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -65,13 +66,14 @@ dependencies:
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 2
         - 3
-        version: 0.2.3
+        - 0
+        - pre
+        version: 0.3.0.pre
   type: :development
   version_requirements: *id004
 description: RDF.rb is a pure-Ruby library for working with Resource Description Framework (RDF) data.
@@ -84,7 +86,7 @@ extra_rdoc_files: []
 
 files: 
 - AUTHORS
-- CONTRIBUTORS
+- CREDITS
 - README
 - UNLICENSE
 - VERSION
@@ -96,6 +98,7 @@ files:
 - lib/rdf/mixin/countable.rb
 - lib/rdf/mixin/durable.rb
 - lib/rdf/mixin/enumerable.rb
+- lib/rdf/mixin/indexable.rb
 - lib/rdf/mixin/inferable.rb
 - lib/rdf/mixin/mutable.rb
 - lib/rdf/mixin/queryable.rb
@@ -125,12 +128,16 @@ files:
 - lib/rdf/ntriples.rb
 - lib/rdf/query/pattern.rb
 - lib/rdf/query/solution.rb
+- lib/rdf/query/solutions.rb
 - lib/rdf/query/variable.rb
 - lib/rdf/query.rb
 - lib/rdf/reader.rb
 - lib/rdf/repository.rb
+- lib/rdf/transaction.rb
 - lib/rdf/util/aliasing.rb
 - lib/rdf/util/cache.rb
+- lib/rdf/util/file.rb
+- lib/rdf/util/uuid.rb
 - lib/rdf/util.rb
 - lib/rdf/version.rb
 - lib/rdf/vocab/cc.rb
@@ -174,11 +181,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.8.1
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: rdf