rdf 1.1.17.1 → 1.99.0

data/lib/rdf/vocabulary.rb

@@ -12,45 +12,17 @@ module RDF
   # The following vocabularies are pre-defined for your convenience:
   #
   # * {RDF}         - Resource Description Framework (RDF)
-  # * {RDF::CC}     - Creative Commons (CC)
-  # * {RDF::CERT}   - W3 Authentication Certificate (CERT)
-  # * {RDF::DC}     - Dublin Core (DC)
-  # * {RDF::DC11}   - Dublin Core 1.1 (DC11) _deprecated_
-  # * {RDF::DOAP}   - Description of a Project (DOAP)
-  # * {RDF::EXIF}   - Exchangeable Image File Format (EXIF)
-  # * {RDF::FOAF}   - Friend of a Friend (FOAF)
-  # * {RDF::GEO}    - WGS84 Geo Positioning (GEO)
-  # * {RDF::GR}     - Good Relations
-  # * {RDF::HT}   - Hypertext Transfer Protocol (HTTP)
-  # * {RDF::ICAL}   - iCal
-  # * {RDF::MA}     - W3C Meda Annotations
-  # * {RDF::OG}     - FaceBook OpenGraph
   # * {RDF::OWL}    - Web Ontology Language (OWL)
-  # * {RDF::PROV}   - W3C Provenance Ontology
   # * {RDF::RDFS}   - RDF Schema (RDFS)
-  # * {RDF::RSA}    - W3 RSA Keys (RSA)
-  # * {RDF::RSS}    - RDF Site Summary (RSS)
-  # * {RDF::SCHEMA} - Schema.org
-  # * {RDF::SIOC}   - Semantically-Interlinked Online Communities (SIOC)
-  # * {RDF::SKOS}   - Simple Knowledge Organization System (SKOS)
-  # * {RDF::SKOSXL} - SKOS Simple Knowledge Organization System eXtension for Labels (SKOS-XL)
-  # * {RDF::V}      - Data Vocabulary
-  # * {RDF::VCARD}  - vCard vocabulary
-  # * {RDF::VOID}   - Vocabulary of Interlinked Datasets (VoID)
-  # * {RDF::WDRS}   - Protocol for Web Description Resources (POWDER)
-  # * {RDF::WOT}    - Web of Trust (WOT)
-  # * {RDF::XHTML}  - Extensible HyperText Markup Language (XHTML)
-  # * {RDF::XHV}    - W3C XHTML Vocabulary
   # * {RDF::XSD}    - XML Schema (XSD)
   #
+  # Other vocabularies are defined in the [rdf-vocab](http://rubygems.org/gems/rdf-vocab) gem
+  #
   # @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")
   #   RDF.type      #=> RDF::URI("http://www.w3.org/1999/02/22-rdf-syntax-ns#type")
   #   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")
   #
@@ -143,7 +115,7 @@ module RDF
           Term.intern("#{self}property", attributes: {label: "property", vocab: self})
         else
           name, options = args
-          options = {:label => name.to_s, vocab: self}.merge(options || {})
+          options = {label: name.to_s, vocab: self}.merge(options || {})
           uri_str = [to_s, name.to_s].join('')
           Term.cache.delete(uri_str)  # Clear any previous entry
           prop = Term.intern(uri_str, attributes: options)
@@ -247,17 +219,17 @@ module RDF
 
       ##
       # @return [String] The label for the named property
-      # @deprecated Use {RDF::Vocabulary::Term#label}
+      # @deprecated Use {RDF::Vocabulary::Term#label} instead.
       def label_for(name)
-        warn "[DEPRECATION] `Vocabulary.label_for is deprecated. Please use Vocabulary::Term#label instead."
+        warn "[DEPRECATION] `Vocabulary.label_for is deprecated. Please use Vocabulary::Term#label instead. Called from #{Gem.location_of_caller.join(':')}"
         self[name].label || ''
       end
 
       ##
       # @return [String] The comment for the named property
-      # @deprecated Use {RDF::Vocabulary::Term#comment}
+      # @deprecated Use {RDF::Vocabulary::Term#comment} instead.
       def comment_for(name)
-        warn "[DEPRECATION] `Vocabulary.comment_for is deprecated. Please use Vocabulary::Term#comment instead."
+        warn "[DEPRECATION] `Vocabulary.comment_for is deprecated. Please use Vocabulary::Term#comment instead. Called from #{Gem.location_of_caller.join(':')}"
         self[name].comment || ''
       end
 
@@ -315,7 +287,7 @@ module RDF
       # @option options [URI, #to_s] :location
       #   Location from which to load the vocabulary, if not from `uri`.
       # @option options [Array<Symbol>, Hash{Symbol => Hash}] :extra
-      #   Extra terms to add to the vocabulary. In the first form, it is an array of symbols, for which terms are created. In the second, it is a Hash mapping symbols to property attributes, as described in {#property}.
+      #   Extra terms to add to the vocabulary. In the first form, it is an array of symbols, for which terms are created. In the second, it is a Hash mapping symbols to property attributes, as described in {RDF::Vocabulary.property}.
       # @return [RDF::Vocabulary] the loaded vocabulary
       def load(uri, options = {})
         source = options.fetch(:location, uri)
@@ -508,8 +480,39 @@ module RDF
 
     # A Vocabulary Term is a URI that can also act as an {Enumerable} to generate the RDF definition of vocabulary terms as defined within the vocabulary definition.
     class Term < RDF::URI
-      # Attributes of this vocabulary term, used for finding `label` and `comment` and to serialize the term back to RDF.
-      # @return [Hash{Symbol,Resource => Term, #to_s}]
+      # @!method comment
+      #   `rdfs:comment` accessor
+      #   @return [String]
+      # @!method label
+      #   `rdfs:label` accessor
+      #   @return [String]
+      # @!method type
+      #   `rdf:type` accessor
+      #   @return [RDF::URI]
+      # @!method subClassOf
+      #   `rdfs:subClassOf` accessor
+      #   @return [RDF::URI]
+      # @!method subPropertyOf
+      #   `rdfs:subPropertyOf` accessor
+      #   @return [RDF::URI]
+      # @!method domain
+      #   `rdfs:domain` accessor
+      #   @return [RDF::URI]
+      # @!method range
+      #   `rdfs:range` accessor
+      #   @return [RDF::URI]
+      # @!method inverseOf
+      #   `owl:inverseOf` accessor
+      #   @return [RDF::URI]
+      # @!method domainIncludes
+      #   `schema:domainIncludes` accessor
+      #   @return [RDF::URI]
+      # @!method rangeIncludes
+      #   `schema:rangeIncludes` accoessor
+      #   @return [RDF::URI]
+      # @!attribute [rw] attributes
+      #   Attributes of this vocabulary term, used for finding `label` and `comment` and to serialize the term back to RDF.
+      #   @return [Hash{Symbol,Resource => Term, #to_s}]
       attr_accessor :attributes
 
       ##
@@ -680,38 +683,18 @@ module RDF
         @attributes.has_key?(method) || super
       end
 
-      # Accessor for {#domainIncludes}
+      # Accessor for `domainIncludes`
       # @return [RDF::URI]
       def domain_includes
         Array(@attributes[:domainIncludes]).map  {|v| RDF::Vocabulary.expand_pname(v)}
       end
 
-      # Accessor for {#rangeIncludes}
+      # Accessor for `rangeIncludes`
       # @return [RDF::URI]
       def range_includes
         Array(@attributes[:rangeIncludes]).map  {|v| RDF::Vocabulary.expand_pname(v)}
       end
 
-      # @!method comment
-      #   @return [String]
-      # @!method label
-      #   @return [String]
-      # @!method type
-      #   @return [RDF::URI]
-      # @!method subClassOf
-      #   @return [RDF::URI]
-      # @!method subPropertyOf
-      #   @return [RDF::URI]
-      # @!method domain
-      #   @return [RDF::URI]
-      # @!method range
-      #   @return [RDF::URI]
-      # @!method inverseOf
-      #   @return [RDF::URI]
-      # @!method domainIncludes
-      #   @return [RDF::URI]
-      # @!method rangeIncludes
-      #   @return [RDF::URI]
     protected
       # Implement accessor to symbol attributes
       def method_missing(method, *args, &block)

data/lib/rdf/writer.rb

@@ -12,9 +12,9 @@ module RDF
   # @example Obtaining an RDF writer class
   #   RDF::Writer.for(:ntriples)     #=> RDF::NTriples::Writer
   #   RDF::Writer.for("spec/data/output.nt")
-  #   RDF::Writer.for(:file_name      => "spec/data/output.nt")
-  #   RDF::Writer.for(:file_extension => "nt")
-  #   RDF::Writer.for(:content_type   => "text/plain")
+  #   RDF::Writer.for(file_name:      "spec/data/output.nt")
+  #   RDF::Writer.for(file_extension: "nt")
+  #   RDF::Writer.for(content_type:   "application/n-triples")
   #
   # @example Instantiating an RDF writer class
   #   RDF::Writer.for(:ntriples).new($stdout) { |writer| ... }
@@ -78,7 +78,7 @@ module RDF
     #
     # @return [Class]
     def self.for(options = {})
-      options = options.merge(:has_writer => true) if options.is_a?(Hash)
+      options = options.merge(has_writer: true) if options.is_a?(Hash)
       if format = self.format || Format.for(options)
         format.writer
       end
@@ -115,7 +115,7 @@ module RDF
       if io.is_a?(String)
         io = File.open(io, 'w')
       elsif io.respond_to?(:external_encoding) && io.external_encoding
-        options = {:encoding => io.external_encoding}.merge(options)
+        options = {encoding: io.external_encoding}.merge(options)
       end
       io.set_encoding(options[:encoding]) if io.respond_to?(:set_encoding) && options[:encoding]
       method = data.respond_to?(:each_statement) ? :each_statement : :each
@@ -206,7 +206,7 @@ module RDF
     #   the base URI to use when constructing relative URIs (not supported
     #   by all writers)
     # @option options [Boolean]  :unique_bnodes   (false)
-    #   Use unique {Node} identifiers, defaults to using the identifier which the node was originall initialized with (if any). Implementations should ensure that Nodes are serialized using a unique representation independent of any identifier used when creating the node. See {NTriples#format_node}
+    #   Use unique {Node} identifiers, defaults to using the identifier which the node was originall initialized with (if any). Implementations should ensure that Nodes are serialized using a unique representation independent of any identifier used when creating the node. See {NTriples::Writer#format_node}
     # @yield  [writer] `self`
     # @yieldparam  [RDF::Writer] writer
     # @yieldreturn [void]
@@ -260,7 +260,7 @@ module RDF
     #
     # @example
     #   writer.prefixes = {
-    #     :dc => RDF::URI('http://purl.org/dc/terms/'),
+    #     dc: RDF::URI('http://purl.org/dc/terms/'),
     #   }
     #
     # @param  [Hash{Symbol => RDF::URI}] prefixes
@@ -361,9 +361,9 @@ module RDF
     ##
     # @param  [RDF::Graph] graph
     # @return [void] `self`
-    # @deprecated Please use {RDF::Writable#insert_graph} instead 
+    # @deprecated Use {RDF::Writable#insert_graph} instead .
     def write_graph(graph)
-      warn "[DEPRECATION] `Writer#graph_write is deprecated. Please use RDF::Writable#insert instead."
+      warn "[DEPRECATION] `Writer#graph_write is deprecated. Please use RDF::Writable#insert instead. Called from #{Gem.location_of_caller.join(':')}"
       graph.each_triple { |*triple| write_triple(*triple) }
       self
     end
@@ -371,9 +371,9 @@ module RDF
     ##
     # @param  [Array<RDF::Statement>] statements
     # @return [void] `self`
-    # @deprecated replace by `RDF::Writable#insert`
+    # @deprecated Use {RDF::Writable#insert} instead.
     def write_statements(*statements)
-      warn "[DEPRECATION] `Writer#write_statements is deprecated. Please use RDF::Writable#insert instead."
+      warn "[DEPRECATION] `Writer#write_statements is deprecated. Please use RDF::Writable#insert instead. Called from #{Gem.location_of_caller.join(':')}"
       statements.each { |statement| write_statement(statement) }
       self
     end
@@ -384,6 +384,7 @@ module RDF
     # @raise [RDF::WriterError] if validating and attempting to write an invalid {RDF::Statement} or if canonicalizing a statement which cannot be canonicalized.
     def write_statement(statement)
       statement = statement.canonicalize! if canonicalize?
+      raise RDF::WriterError, "Statement #{statement.inspect} is incomplete" if statement.incomplete?
       raise RDF::WriterError, "Statement #{statement.inspect} is invalid" if validate? && statement.invalid?
       write_triple(*statement.to_triple)
       self
@@ -427,7 +428,16 @@ module RDF
         else nil
       end
     end
-    alias_method :format_value, :format_term # @deprecated
+
+    ##
+    # @param  [RDF::Term] term
+    # @return [String]
+    # @since  0.3.0
+    # @deprecated Use {#format_term} instead
+    def format_value(term, options = {})
+      warn "[DEPRECATION] Writer#format_value is being replaced with Writer#format_term in RDF.rb 2.0. Called from #{Gem.location_of_caller.join(':')}"
+      format_term(term, options)
+    end
 
     ##
     # @param  [RDF::Node] value

data/lib/rdf.rb

@@ -55,7 +55,20 @@ module RDF
   autoload :Vocabulary,  'rdf/vocabulary'
   autoload :StrictVocabulary,  'rdf/vocabulary'
   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 }
+
+  # Use const_missing instead of autoload to load most vocabularies so we can provide deprecation messages
+  def self.const_missing(constant)
+    if VOCABS.include?(constant.to_s.downcase.to_sym)
+      warn %([DEPRECATION] the #{constant} vocabulary will be moved to the rdf-vocab gem
+        for the RDF.rb 2.0 release. Use as RDF::Vocab::#{constant}, or include RDF::Vocab in the RDF module.
+        Called from #{Gem.location_of_caller.join(':')}
+      ).gsub(/^\s+/, '') unless [:OWL, :RDFS, :RDFV, :XSD].include?(constant)
+      require "rdf/vocab/#{constant.to_s.downcase}"
+      const_get(constant)
+    else
+      super
+    end
+  end
 
   # Utilities
   autoload :Util,        'rdf/util'
@@ -152,7 +165,9 @@ module RDF
   #   @option options [RDF::URI]       :predicate (nil)
   #   @option options [RDF::Term]      :object    (nil)
   #   @option options [RDF::Resource]  :context   (nil)
-  #     Note, in RDF 1.1, a context MUST be an IRI.
+  #     Alias for :graph_name, :context is deprecated in RDF.rb.
+  #   @option options [RDF::Resource]  :graph_name   (nil)
+  #     Note, a graph_name MUST be an IRI or BNode.
   #   @return [RDF::Statement]
   #
   # @overload Statement(subject, predicate, object, options = {})
@@ -160,7 +175,7 @@ module RDF
   #   @param  [RDF::URI]               predicate
   #   @param  [RDF::Term]              object
   #   @param  [Hash{Symbol => Object}] options
-  #   @option options [RDF::Resource]  :context   (nil)
+  #   @option options [RDF::Resource]  :graph_name   (nil)
   #   @return [RDF::Statement]
   #
   def self.Statement(*args)
@@ -203,7 +218,7 @@ module RDF
   end
 
   ##
-  # Delegate other methods to RDF::RDF
+  # Delegate other methods to RDF::RDFV
   def self.method_missing(property, *args, &block)
     if args.empty?
       # Special-case rdf:_n for all integers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdf
 version: !ruby/object:Gem::Version
-  version: 1.1.17.1
+  version: 1.99.0
 platform: ruby
 authors:
 - Arto Bendiken
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: link_header
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rdf-vocab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rdf-xsd
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -333,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rdf
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby library for working with Resource Description Framework (RDF) data.