rdf 0.0.6 → 0.0.7

data/lib/rdf/repository.rb

@@ -1,8 +1,47 @@
 module RDF
   ##
   # An RDF repository.
+  #
+  # @example Creating a transient in-memory repository
+  #   repository = RDF::Repository.new
+  #
+  # @example Checking whether a repository is readable/writable
+  #   repository.readable?
+  #   repository.writable?
+  #
+  # @example Checking whether a repository is persistent or transient
+  #   repository.persistent?
+  #   repository.transient?
+  #
+  # @example Checking whether a repository is empty
+  #   repository.empty?
+  #
+  # @example Checking how many statements a repository contains
+  #   repository.count
+  #
+  # @example Checking whether a repository contains a specific statement
+  #   repository.has_statement?(statement)
+  #
+  # @example Enumerating statements in a repository
+  #   repository.each_statement { |statement| statement.inspect! }
+  #
+  # @example Inserting statements into a repository
+  #   repository.insert(*statements)
+  #   repository.insert(statement)
+  #   repository.insert([subject, predicate, object])
+  #   repository << statement
+  #   repository << [subject, predicate, object]
+  #
+  # @example Deleting statements from a repository
+  #   repository.delete(*statements)
+  #   repository.delete(statement)
+  #   repository.delete([subject, predicate, object])
+  #
+  # @example Deleting all statements from a repository
+  #   repository.clear!
+  #
   class Repository
-    include Enumerable
+    include RDF::Enumerable
 
     # @return [URI]
     attr_reader :uri
@@ -116,7 +155,7 @@ module RDF
     ##
     # Returns the number of RDF statements in the repository.
     #
-    # @return [Integer] 
+    # @return [Integer]
     def size
       @data.size
     end
@@ -124,7 +163,7 @@ module RDF
     alias_method :count, :size
 
     ##
-    # Returns `true` if the repository contains the given RDF statement.
+    # Returns `true` if this repository contains the given RDF `statement`.
     #
     # @param  [Statement] statement
     # @return [Boolean]
@@ -137,16 +176,13 @@ module RDF
     ##
     # Enumerates each RDF statement in the repository.
     #
-    # @yield [statement]
+    # @yield  [statement]
     # @yieldparam [Statement]
-    # @return [Repository]
-    def each_statement(&block)
+    # @return [Enumerator]
+    def each(&block)
       @data.each(&block)
-      self
     end
 
-    alias_method :each, :each_statement
-
     ##
     # Queries the repository for RDF statements matching the given pattern.
     #
@@ -189,7 +225,7 @@ module RDF
     end
 
     ##
-    # Inserts an RDF statement to the repository.
+    # Inserts an RDF statement into the repository.
     #
     # @param  [Statement, Array(Value), #to_a] statement
     # @return [Repository]
@@ -202,6 +238,22 @@ module RDF
       self
     end
 
+    ##
+    # Updates RDF statements in the repository.
+    #
+    # @param  [Array<Statement>] statements
+    # @raise  [TypeError] if the repository is immutable
+    # @return [Repository]
+    def update(*statements)
+      raise TypeError.new("repository is immutable") if immutable?
+      statements.each do |statement|
+        if (statement = create_statement(statement))
+          delete([statement.subject, statement.predicate, nil])
+          insert(statement) if statement.has_object?
+        end
+      end
+    end
+
     ##
     # Inserts RDF statements into the repository.
     #
@@ -211,7 +263,11 @@ module RDF
     def insert(*statements)
       raise TypeError.new("repository is immutable") if immutable?
       statements.each do |statement|
-        insert_statement(statement)
+        if (statement = create_statement(statement)).valid?
+          insert_statement(statement)
+        else
+          raise ArgumentError.new # FIXME
+        end
       end
       self
     end
@@ -225,11 +281,38 @@ module RDF
     def delete(*statements)
       raise TypeError.new("repository is immutable") if immutable?
       statements.each do |statement|
-        delete_statement(statement)
+        if (statement = create_statement(statement)).valid?
+          delete_statement(statement)
+        else
+          query(statement).each do |statement|
+            delete_statement(statement)
+          end
+        end
       end
       self
     end
 
+    ##
+    # Deletes all RDF statements from this repository.
+    #
+    # @return [Repository]
+    def clear
+      @data.clear
+      self
+    end
+
+    alias_method :clear!, :clear
+
+    ##
+    # Outputs a developer-friendly representation of this repository to
+    # `stderr`.
+    #
+    # @return [void]
+    def inspect!
+      each_statement { |statement| statement.inspect! }
+      nil
+    end
+
     protected
 
       def insert_statement(statement)
@@ -240,5 +323,14 @@ module RDF
         @data.delete(statement)
       end
 
+      def create_statement(statement)
+        case statement
+          when Statement then statement
+          when Hash      then Statement.new(statement)
+          when Array     then Statement.new(*statement)
+          else raise ArgumentError.new # FIXME
+        end
+      end
+
   end
 end

data/lib/rdf/version.rb

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

data/lib/rdf/vocab.rb

@@ -0,0 +1,171 @@
+module RDF
+  ##
+  # A {Vocabulary} represents an RDFS or OWL vocabulary.
+  #
+  # ### Vocabularies:
+  #
+  # The following vocabularies are pre-defined for your convenience:
+  #
+  # * {RDF::CC}    - Creative Commons (CC)
+  # * {RDF::DC}    - Dublin Core (DC)
+  # * {RDF::DOAP}  - Description of a Project (DOAP)
+  # * {RDF::EXIF}  - Exchangeable Image File Format (EXIF)
+  # * {RDF::FOAF}  - Friend of a Friend (FOAF)
+  # * {RDF::HTTP}  - Hypertext Transfer Protocol (HTTP)
+  # * {RDF::OWL}   - Web Ontology Language (OWL)
+  # * {RDF::RDFS}  - RDF Schema (RDFS)
+  # * {RDF::RSS}   - RDF Site Summary (RSS)
+  # * {RDF::SIOC}  - Semantically-Interlinked Online Communities (SIOC)
+  # * {RDF::SKOS}  - Simple Knowledge Organization System (SKOS)
+  # * {RDF::WOT}   - Web of Trust (WOT)
+  # * {RDF::XHTML} - Extensible HyperText Markup Language (XHTML)
+  # * {RDF::XSD}   - XML Schema (XSD)
+  #
+  # @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/
+  # @see http://en.wikipedia.org/wiki/QName
+  class Vocabulary
+    ##
+    # Defines a vocabulary term called `property`.
+    #
+    # @param  [Symbol]
+    # @return [void]
+    def self.property(property)
+      metaclass = class << self; self; end
+      metaclass.send(:define_method, property) { self[property] } # class method
+    end
+
+    ##
+    # Returns the URI for the term `property` in this vocabulary.
+    #
+    # @param  [#to_s] property
+    # @return [URI]
+    def self.[](property)
+      RDF::URI.new([to_s, property.to_s].join(''))
+    end
+
+    ##
+    # Returns the base URI for this vocabulary class.
+    #
+    # @return [URI]
+    def self.to_uri
+      RDF::URI.new(to_s)
+    end
+
+    ##
+    # Returns a string representation of this vocabulary class.
+    #
+    # @return [String]
+    def self.to_s
+      @@uris.has_key?(self) ? @@uris[self].to_s : super
+    end
+
+    ##
+    # Returns a developer-friendly representation of this vocabulary class.
+    #
+    # @return [String]
+    def self.inspect
+      if self == Vocabulary
+        self.to_s
+      else
+        sprintf("%s(%s)", superclass.to_s, to_s)
+      end
+    end
+
+    # Undefine all superfluous instance methods:
+    undef_method *(instance_methods - %w(__id__ __send__ __class__ __eval__ instance_eval inspect class))
+
+    ##
+    # @param  [URI, String, #to_s]
+    def initialize(uri)
+      @uri = case uri
+        when RDF::URI then uri.to_s
+        else RDF::URI.parse(uri.to_s) ? uri.to_s : nil
+      end
+    end
+
+    ##
+    # Returns the URI for the term `property` in this vocabulary.
+    #
+    # @param  [#to_s] property
+    # @return [URI]
+    def [](property)
+      RDF::URI.new([to_s, property.to_s].join(''))
+    end
+
+    ##
+    # Returns the base URI for this vocabulary.
+    #
+    # @return [URI]
+    def to_uri
+      RDF::URI.new(to_s)
+    end
+
+    ##
+    # Returns a string representation of this vocabulary.
+    #
+    # @return [String]
+    def to_s
+      @uri.to_s
+    end
+
+    ##
+    # Returns a developer-friendly representation of this vocabulary.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(%s)>", self.class.name, __id__, to_s)
+    end
+
+    protected
+
+      def self.create(uri) # @private
+        @@uri = uri
+        self
+      end
+
+      def self.inherited(subclass) # @private
+        unless @@uri.nil?
+          subclass.send(:private_class_method, :new)
+          @@uris[subclass] = @@uri
+          @@uri = nil
+        end
+      end
+
+      def self.method_missing(property, *args, &block)
+        if args.empty? && @@uris.has_key?(self)
+          self[property]
+        else
+          super
+        end
+      end
+
+      def method_missing(property, *args, &block)
+        if args.empty?
+          self[property]
+        else
+          raise ArgumentError.new("wrong number of arguments (#{args.size} for 0)")
+        end
+      end
+
+    private
+
+      @@uris = {}  # @private
+      @@uri  = nil # @private
+
+  end
+end

data/lib/rdf/vocab/cc.rb

@@ -0,0 +1,18 @@
+module RDF
+  ##
+  # Creative Commons (CC) vocabulary.
+  #
+  # @see http://creativecommons.org/ns
+  class CC < Vocabulary("http://creativecommons.org/ns#")
+    property :attributionName
+    property :attributionURL
+    property :deprecatedOn
+    property :jurisdiction
+    property :legalcode
+    property :license
+    property :morePermissions
+    property :permits
+    property :prohibits
+    property :requires
+  end
+end

data/lib/rdf/vocab/dc.rb

@@ -0,0 +1,63 @@
+module RDF
+  ##
+  # Dublin Core (DC) vocabulary.
+  #
+  # @see http://dublincore.org/schemas/rdfs/
+  class DC < Vocabulary("http://purl.org/dc/terms/")
+    property :abstract
+    property :accessRights
+    property :accrualMethod
+    property :accrualPeriodicity
+    property :accrualPolicy
+    property :alternative
+    property :audience
+    property :available
+    property :bibliographicCitation
+    property :conformsTo
+    property :contributor
+    property :coverage
+    property :created
+    property :creator
+    property :date
+    property :dateAccepted
+    property :dateCopyrighted
+    property :dateSubmitted
+    property :description
+    property :educationLevel
+    property :extent
+    property :format
+    property :hasFormat
+    property :hasPart
+    property :hasVersion
+    property :identifier
+    property :instructionalMethod
+    property :isFormatOf
+    property :isPartOf
+    property :isReferencedBy
+    property :isReplacedBy
+    property :isRequiredBy
+    property :isVersionOf
+    property :issued
+    property :language
+    property :license
+    property :mediator
+    property :medium
+    property :modified
+    property :provenance
+    property :publisher
+    property :references
+    property :relation
+    property :replaces
+    property :requires
+    property :rights
+    property :rightsHolder
+    property :source
+    property :spatial
+    property :subject
+    property :tableOfContents
+    property :temporal
+    property :title
+    property :type
+    property :valid
+  end
+end