rdf 3.1.7 → 3.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e220d98b1d53ade20bf5999761a948e495597dc74eaccd6830c22adadc77fa4
-  data.tar.gz: 13b643963aeb32f99e2c455490e3cbc661c56153abb6dd38ff192e42ce0ee5f5
+  metadata.gz: ff64fa365f10553262446da5494bf2bb592dffe9c409cda37239e0726a5e1f4d
+  data.tar.gz: 6915405e0bc437cf0be2a88697145757131ea1d054040b9e7823c26c998a8568
 SHA512:
-  metadata.gz: 9a845aa06b3cb0af80aa3e2ca0d9f051d4158258d5007032f73b974c4976e0dd9a34b8d1c55eda3fe2b5fd8c5f9ee9528647514f81387f0032e4adcbc8a0f46d
-  data.tar.gz: 388f74852651a13a7a24f10c6dee8767d76d44b7d002d58efc356dfae76629c7fccd0c462a19df874ee64c39516b838661e4b586847718084a41ad72644483fa
+  metadata.gz: 0b73a1e41bdb9c53d7dcff97c2b14f785b1f02be8233dcf8ffdd36f9fbc426dcdff5e0af4cb0a31e11fd5edcc76442a2fe6f9d0c1483855a91e340b407ee4753
+  data.tar.gz: d93d42dcd04f9ff35676a43d1a71b3e84c5fe1a94118a3b0dd7e94aa708e23e5bb0310fb136fa98956b192f7098eb48fe25a91d22c0287e66041a7f73a704b15

data/README.md

@@ -6,9 +6,29 @@ This is a pure-Ruby library for working with [Resource Description Framework
 * <https://ruby-rdf.github.com/rdf>
 
 [![Gem Version](https://badge.fury.io/rb/rdf.png)](https://badge.fury.io/rb/rdf)
-[![Build Status](https://travis-ci.org/ruby-rdf/rdf.png?branch=master)](https://travis-ci.org/ruby-rdf/rdf)
-[![Coverage Status](https://coveralls.io/repos/ruby-rdf/rdf/badge.svg)](https://coveralls.io/r/ruby-rdf/rdf)
-[![Join the chat at https://gitter.im/ruby-rdf/rdf](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ruby-rdf/rdf?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://github.com/ruby-rdf/rdf/workflows/CI/badge.svg?branch=develop)](https://github.com/ruby-rdf/rdf/actions?query=workflow%3ACI)
+[![Coverage Status](https://coveralls.io/repos/ruby-rdf/rdf/badge.svg?branch=develop)](https://coveralls.io/github/ruby-rdf/rdf?branch=develop)
+[![Gitter chat](https://badges.gitter.im/ruby-rdf/rdf.png)](https://gitter.im/ruby-rdf/rdf)
+
+## Table of contents
+
+1. [Features](#features)
+2. [Differences between RDF 1.0 and RDF 1.1](#differences-between-rdf-1-0-and-rdf-1-1)
+3. [Tutorials](#tutorials)
+4. [Command Line](#command-line)
+5. [Examples](#examples)
+6. [Reader/Writer convenience methods](#reader/writer-convenience-methods)
+7. [RDF* (RDFStar)](#rdf*-(rdfstar))
+8. [Documentation](#documentation)
+9. [Dependencies](#dependencies)
+10. [Installation](#installation)
+11. [Download](#download)
+12. [Resources](#resources)
+13. [Mailing List](#mailing-list)
+14. [Authors](#authors)
+15. [Contributors](#contributors)
+16. [Contributing](#contributing)
+17. [License](#license)
 
 ## Features
 
@@ -39,6 +59,22 @@ resources. Clients may also consider using [RestClient Components][] to enable
 client-side caching of HTTP results using [Rack::Cache][] or other Rack
 middleware.
 
+See {RDF::Util::File} for configuring other mechanisms for retrieving resources.
+
+### Term caching and configuration
+
+RDF.rb uses a weak-reference cache for storing internalized versions of URIs and Nodes. This is particularly useful for Nodes as two nodes are equivalent only if they're the same node.
+
+By default, each cache can grow to an unlimited size, but this can be configured using {RDF.config}, for general limits, along with URI- or Node-specific limits.
+
+For example, to limit the size of the URI intern cache only:
+
+    RDF.config.uri_cache_size = 10_000
+
+The default for creating new caches without a specific initialization size can be set using:
+
+    RDF.config.cache_size = 100_000
+
 ## Differences between RDF 1.0 and RDF 1.1
 
 This version of RDF.rb is fully compatible with [RDF 1.1][], but it creates some
@@ -60,7 +96,7 @@ the 1.1 release of RDF.rb:
 * {RDF::Util::File.open\_file} now performs redirects and manages `base_uri` based on W3C recommendations:
   * `base_uri` is set to the original URI if a status 303 is provided, otherwise any other redirect will set `base_uri` to the redirected location.
   * `base_uri` is set to the content of the `Location` header if status is _success_.
-* Additionally, {RDF::Util::File.open\_file} sets the result encoding from `charset` if provided, defaulting to `UTF-8`. Other access methods include `last_modified` and `content_type`, 
+* Additionally, {RDF::Util::File.open\_file} sets the result encoding from `charset` if provided, defaulting to `UTF-8`. Other access methods include `last_modified` and `content_type`,
 * {RDF::StrictVocabulary} added with an easy way to keep vocabulary definitions up to date based on their OWL or RDFS definitions. Most vocabularies are now StrictVocabularies meaning that an attempt to resolve a particular term in that vocabulary will error if the term is not defined in the vocabulary.
 * New vocabulary definitions have been added for [ICal](http://www.w3.org/2002/12/cal/icaltzd#), [Media Annotations (MA)](http://www.w3.org/ns/ma-ont#), [Facebook OpenGraph (OG)](http://ogp.me/ns#), [PROV](http://www.w3.org/ns/prov#), [SKOS-XL (SKOSXL)](http://www.w3.org/2008/05/skos-xl#), [Data Vocabulary (V)](http://rdf.data-vocabulary.org/), [VCard](http://www.w3.org/2006/vcard/ns#), [VOID](http://rdfs.org/ns/void#http://rdfs.org/ns/void#), [Powder-S (WDRS)](http://www.w3.org/2007/05/powder-s#), and [XHV](http://www.w3.org/1999/xhtml/vocab#).
 
@@ -73,6 +109,7 @@ Notably, {RDF::Queryable#query} and {RDF::Query#execute} are now completely symm
 * [Getting started with RDF and SPARQL using 4store and RDF.rb](https://www.jenitennison.com/blog/node/152)
 
 ## Command Line
+
 When installed, RDF.rb includes a `rdf` shell script which acts as a wrapper to perform a number of different
 operations on RDF files using available readers and writers.
 
@@ -96,7 +133,7 @@ Different RDF gems will augment the `rdf` script with more capabilities, which m
     require 'rdf/ntriples'
     graph = RDF::Graph.new << [:hello, RDF::RDFS.label, "Hello, world!"]
     graph.dump(:ntriples)
-    
+
 or
 
     RDF::Writer.open("hello.nt") { |writer| writer << graph }
@@ -105,7 +142,7 @@ or
 
     require 'rdf/ntriples'
     graph = RDF::Graph.load("https://ruby-rdf.github.com/rdf/etc/doap.nt")
-    
+
 or
 
     RDF::Reader.open("https://ruby-rdf.github.com/rdf/etc/doap.nt") do |reader|
@@ -115,19 +152,20 @@ or
     end
 
 ### Reading RDF data in other formats
+
 {RDF::Reader.open} and {RDF::Repository.load} use a number of mechanisms to determine the appropriate reader
 to use when loading a file. The specific format to use can be forced using, e.g. `format: :ntriples`
 option where the specific format symbol is determined by the available readers. Both also use
 MimeType or file extension, where available.
 
     require 'rdf/nquads'
-    
+
     graph = RDF::Graph.load("https://ruby-rdf.github.com/rdf/etc/doap.nq", format: :nquads)
 
 A specific sub-type of Reader can also be invoked directly:
 
     require 'rdf/nquads'
-    
+
     RDF::NQuads::Reader.open("https://ruby-rdf.github.com/rdf/etc/doap.nq") do |reader|
       reader.each_statement do |statement|
         puts statement.inspect
@@ -141,6 +179,7 @@ be detected from filename or other options, or that more than one format is iden
 match will be used to read the input.
 
 ### Writing RDF data using other formats
+
 {RDF::Writer.open}, {RDF::Enumerable#dump}, {RDF::Writer.dump} take similar options to {RDF::Reader.open} to determine the
 appropriate writer to use.
 
@@ -160,6 +199,7 @@ A specific sub-type of Writer can also be invoked directly:
     File.open("hello.nq", "w") {|f| f << repo.dump(:nquads)}
 
 ## Reader/Writer convenience methods
+
 {RDF::Enumerable} implements `to_{format}` for each available instance of {RDF::Reader}.
 For example, if `rdf/turtle` is loaded, this allows the following:
 
@@ -179,7 +219,7 @@ Note that no prefixes are loaded automatically, however they can be provided as
 ### Querying RDF data using basic graph patterns (BGPs)
 
     require 'rdf/ntriples'
-    
+
     graph = RDF::Graph.load("https://ruby-rdf.github.com/rdf/etc/doap.nt")
     query = RDF::Query.new({
       person: {
@@ -188,7 +228,7 @@ Note that no prefixes are loaded automatically, however they can be provided as
         FOAF.mbox => :email,
       }
     }, **{})
-    
+
     query.execute(graph) do |solution|
       puts "name=#{solution.name} email=#{solution.email}"
     end
@@ -246,17 +286,10 @@ By default, the N-Triples reader will reject a document containing a subject res
     end
     # => RDF::ReaderError
 
-Readers support a `rdfstar` option with either `:PG` (Property Graph) or `:SA` (Separate Assertions) modes. In `:PG` mode, statements that are used in the subject or object positions are also implicitly added to the graph:
+Readers support a boolean valued `rdfstar` option.
 
     graph = RDF::Graph.new do |graph|
-      RDF::NTriples::Reader.new(nt, rdfstar: :PG) {|reader| graph << reader}
-    end
-    graph.count #=> 2
-
-When using the `:SA` mode, only one statement is asserted, although the reified statement is contained within the graph.
-
-    graph = RDF::Graph.new do |graph|
-      RDF::NTriples::Reader.new(nt, rdfstar: :SA) {|reader| graph << reader}
+      RDF::NTriples::Reader.new(nt, rdfstar: true) {|reader| graph << reader}
     end
     graph.count #=> 1
 
@@ -442,7 +475,6 @@ This repository uses [Git Flow](https://github.com/nvie/gitflow) to mange develo
   which you will be asked to agree to on the first commit to a repo within the organization.
   Note that the agreement applies to all repos in the [Ruby RDF](https://github.com/ruby-rdf/) organization.
 
-
 ## License
 
 This is free and unencumbered public domain software. For more information,
@@ -478,9 +510,9 @@ see <https://unlicense.org/> or the accompanying {file:UNLICENSE} file.
 [RDF::TriX]:        https://ruby-rdf.github.com/rdf-trix
 [RDF::Turtle]:      https://ruby-rdf.github.com/rdf-turtle
 [RDF::Raptor]:      https://ruby-rdf.github.com/rdf-raptor
-[RDF*]:             https://lists.w3.org/Archives/Public/public-rdf-star/
+[RDF*]:             https://w3c.github.io/rdf-star/rdf-star-cg-spec.html
 [LinkedData]:       https://ruby-rdf.github.com/linkeddata
 [JSON::LD]:         https://ruby-rdf.github.com/json-ld
 [RestClient]:       https://rubygems.org/gems/rest-client
 [RestClient Components]: https://rubygems.org/gems/rest-client-components
-[Rack::Cache]:      https://rtomayko.github.io/rack-cache/
+[Rack::Cache]:      https://rtomayko.github.io/rack-cache/

data/VERSION

@@ -1 +1 @@
-3.1.7
+3.1.12

data/lib/rdf.rb

@@ -2,6 +2,7 @@ require 'stringio'
 require 'bigdecimal'
 require 'date'
 require 'time'
+require "ostruct"
 
 require 'rdf/version'
 require 'rdf/extensions'
@@ -79,6 +80,29 @@ module RDF
   # CLI
   autoload :CLI,         'rdf/cli'
 
+  ##
+  # Configuration, used open for configuring constants used within the codebase.
+  #
+  # @example set default cache size to be at most 10,000 entries
+  #
+  #   RDF.config.cache_size = 10_000
+  #
+  # @example set cache size for interned URIs to 5,000 entries
+  #
+  #   RDF.config.uri_cache_size = 5_000
+  #
+  # Defaults:
+  #   * `cache_size`: -1
+  #   * `uri_cache_size`: `cache_size`
+  #   * `node_cache_size`: `cache_size`
+  #
+  # @note cache configurations must be set before initial use, when the caches are allocated.
+  # @see RDF::Util::Cache.new
+  # @return [Object]
+  def self.config
+    @config ||= OpenStruct.new(cache_size: -1, uri_cache_size: nil, node_cache_size: nil)
+  end
+
   ##
   # Alias for `RDF::Resource.new`.
   #

data/lib/rdf/cli.rb

@@ -8,9 +8,26 @@ begin
   require 'linkeddata'
 rescue LoadError
   # Silently load without linkeddata, but try some others
-  %w(microdata n3 rdfa rdfxml reasoner tabular trig trix turtle vocab xsd json/ld ld/patch).each do |ser|
+  %w(
+     json/ld
+     ld/patch
+     rdf/microdata
+     rdf/n3
+     rdf/ordered_repo
+     rdf/rdfa
+     rdf/rdfxml
+     rdf/reasoner
+     rdf/tabular
+     rdf/trig
+     rdf/trix
+     rdf/turtle
+     rdf/vocab
+     rdf/xsd
+     shacl
+     shex
+  ).each do |ser|
     begin
-      require ser.include?('/') ? ser : "rdf/#{ser}"
+      require ser
     rescue LoadError
     end
   end
@@ -162,6 +179,7 @@ module RDF
     # * `lambda` code run to execute command.
     # * `filter` Option values that must match for command to be used
     # * `control` Used to indicate how (if) command is displayed
+    # * `repository` Use this repository, if set
     # * `options` an optional array of `RDF::CLI::Option` describing command-specific options.
     # * `option_use`: A hash of option symbol to option usage, used for overriding the default status of an option for this command.
     # @return [Hash{Symbol => Hash{Symbol => Object}}]
@@ -315,7 +333,7 @@ module RDF
 
           # Add format-specific reader options
           reader.options.each do |cli_opt|
-            next if options.options.has_key?(cli_opt.symbol)
+            next if options.options.key?(cli_opt.symbol)
             on_args = cli_opt.on || []
             on_args << cli_opt.description if cli_opt.description
             options.on(*on_args) do |opt_arg|
@@ -337,7 +355,7 @@ module RDF
 
           # Add format-specific writer options
           writer.options.each do |cli_opt|
-            next if options.options.has_key?(cli_opt.symbol)
+            next if options.options.key?(cli_opt.symbol)
             on_args = cli_opt.on || []
             on_args << cli_opt.description if cli_opt.description
             options.on(*on_args) do |opt_arg|
@@ -401,7 +419,7 @@ module RDF
       end
 
       cli_opts.each do |cli_opt|
-        next if opts.has_key?(cli_opt.symbol)
+        next if opts.key?(cli_opt.symbol)
         on_args = cli_opt.on || []
         on_args << cli_opt.description if cli_opt.description
         options.on(*on_args) do |arg|
@@ -456,7 +474,7 @@ module RDF
     # @param  [Array<String>] args
     # @param  [IO] output
     # @param  [OptionParser] option_parser
-    # @param [Hash{Symbol => Hash{Symbol => Array[String]}}] messages used for confeying non primary-output which is structured.
+    # @param [Hash{Symbol => Hash{Symbol => Array[String]}}] messages used for conveying non primary-output which is structured.
     # @param  [Hash{Symbol => Object}] options
     # @return [Boolean]
     def self.exec(args, output: $stdout, option_parser: nil, messages: {}, **options)
@@ -493,6 +511,9 @@ module RDF
             raise ArgumentError, "Incompatible command #{c} used with option #{opt}=#{options[opt]}"
           end
         end
+
+        # The command may specify a repository instance to use
+        options[:repository] ||= COMMANDS[c.to_sym][:repository]
       end
 
       # Hacks for specific options
@@ -501,9 +522,13 @@ module RDF
       options[:format] = options[:format].to_sym if options[:format]
       options[:output_format] = options[:output_format].to_sym if options[:output_format]
 
-      @repository = options[:ordered] ?
-        [].extend(RDF::Enumerable, RDF::Queryable) :
-        RDF::Repository.new
+      # Allow repository to be set via option.
+      # If RDF::OrderedRepo is present, use it if the `ordered` option is specified, otherwise extend an Array.
+      @repository = options[:repository] || case
+        when RDF.const_defined?(:OrderedRepo) then RDF::OrderedRepo.new
+        when options[:ordered] then [].extend(RDF::Enumerable, RDF::Queryable)
+        else RDF::Repository.new
+      end
 
       # Parse input files if any command requires it
       if cmds.any? {|c| COMMANDS[c.to_sym][:parse]}
@@ -518,7 +543,10 @@ module RDF
 
       # Run each command in sequence
       cmds.each do |command|
-        COMMANDS[command.to_sym][:lambda].call(args, output: output, **options.merge(messages: messages))
+        COMMANDS[command.to_sym][:lambda].call(args,
+          output: output,
+          messages: messages,
+          **options.merge(repository: repository))
       end
 
       # Normalize messages

data/lib/rdf/mixin/enumerable.rb

@@ -12,15 +12,15 @@ module RDF
   #   enumerable.count
   #
   # @example Checking whether a specific statement exists
-  #   enumerable.has_statement?(RDF::Statement(subject, predicate, object))
-  #   enumerable.has_triple?([subject, predicate, object])
-  #   enumerable.has_quad?([subject, predicate, object, graph_name])
+  #   enumerable.statement?(RDF::Statement(subject, predicate, object))
+  #   enumerable.triple?([subject, predicate, object])
+  #   enumerable.quad?([subject, predicate, object, graph_name])
   #
   # @example Checking whether a specific value exists
-  #   enumerable.has_subject?(RDF::URI("https://rubygems.org/gems/rdf"))
-  #   enumerable.has_predicate?(RDF::RDFS.label)
-  #   enumerable.has_object?(RDF::Literal("A Ruby library for working with Resource Description Framework (RDF) data.", language: :en))
-  #   enumerable.has_graph?(RDF::URI("http://ar.to/#self"))
+  #   enumerable.subject?(RDF::URI("https://rubygems.org/gems/rdf"))
+  #   enumerable.predicate?(RDF::RDFS.label)
+  #   enumerable.object?(RDF::Literal("A Ruby library for working with Resource Description Framework (RDF) data.", language: :en))
+  #   enumerable.graph?(RDF::URI("http://ar.to/#self"))
   #
   # @example Enumerating all statements
   #   enumerable.each_statement do |statement|
@@ -127,14 +127,25 @@ module RDF
     end
 
     ##
-    # Returns `true` if `self` contains the given RDF statement.
+    # @overload statement?
+    #   Returns `false` indicating this is not an RDF::Statemenet.
+    #   @return [Boolean]
+    #   @see RDF::Value#statement?
+    # @overload statement?(statement)
+    #   Returns `true` if `self` contains the given RDF statement.
     #
-    # @param  [RDF::Statement] statement
-    # @return [Boolean]
-    def has_statement?(statement)
-      !enum_statement.find { |s| s.eql?(statement) }.nil?
+    #   @param  [RDF::Statement] statement
+    #   @return [Boolean]
+    def statement?(*args)
+      case args.length
+      when 0 then false
+      when 1
+        args.first && !enum_statement.find { |s| s.eql?(args.first) }.nil?        
+      else raise ArgumentError("wrong number of arguments (given #{args.length}, expected 0 or 1)")
+      end
     end
-    alias_method :include?, :has_statement?
+    alias_method :has_statement?, :statement?
+    alias_method :include?, :statement?
 
     ##
     # Iterates the given block for each RDF statement.
@@ -194,9 +205,10 @@ module RDF
     #
     # @param  [Array(RDF::Resource, RDF::URI, RDF::Term)] triple
     # @return [Boolean]
-    def has_triple?(triple)
+    def triple?(triple)
       triples.include?(triple)
     end
+    alias_method :has_triple?, :triple?
 
     ##
     # Iterates the given block for each RDF triple.
@@ -255,9 +267,10 @@ module RDF
     #
     # @param  [Array(RDF::Resource, RDF::URI, RDF::Term, RDF::Resource)] quad
     # @return [Boolean]
-    def has_quad?(quad)
+    def quad?(quad)
       quads.include?(quad)
     end
+    alias_method :has_quad?, :quad?
 
     ##
     # Iterates the given block for each RDF quad.
@@ -321,9 +334,10 @@ module RDF
     #
     # @param  [RDF::Resource] value
     # @return [Boolean]
-    def has_subject?(value)
+    def subject?(value)
       enum_subject.include?(value)
     end
+    alias_method :has_subject?, :subject?
 
     ##
     # Iterates the given block for each unique RDF subject term.
@@ -386,9 +400,10 @@ module RDF
     #
     # @param  [RDF::URI] value
     # @return [Boolean]
-    def has_predicate?(value)
+    def predicate?(value)
       enum_predicate.include?(value)
     end
+    alias_method :has_predicate?, :predicate?
 
     ##
     # Iterates the given block for each unique RDF predicate term.
@@ -451,9 +466,10 @@ module RDF
     #
     # @param  [RDF::Term] value
     # @return [Boolean]
-    def has_object?(value)
+    def object?(value)
       enum_object.include?(value)
     end
+    alias_method :has_object?, :object?
 
     ##
     # Iterates the given block for each unique RDF object term.
@@ -511,7 +527,7 @@ module RDF
     def terms(unique: true)
       unless unique
         enum_statement.
-          map(&:to_quad).
+          map(&:terms).
           flatten.
           compact
       else
@@ -520,14 +536,24 @@ module RDF
     end
 
     ##
-    # Returns `true` if `self` contains the given RDF subject term.
+    # @overload term?
+    #   Returns `false` indicating this is not an RDF::Statemenet.
+    #   @see RDF::Value#statement?
+    #   @return [Boolean]
+    # @overload term?(value)
+    #   Returns `true` if `self` contains the given RDF subject term.
     #
-    # @param  [RDF::Resource] value
-    # @return [Boolean]
-    # @since 2.0
-    def has_term?(value)
-      enum_term.include?(value)
+    #   @param  [RDF::Resource] value
+    #   @return [Boolean]
+    #   @since 2.0
+    def term?(*args)
+      case args.length
+      when 0 then super
+      when 1 then args.first && enum_term.include?(args.first)
+      else raise ArgumentError("wrong number of arguments (given #{args.length}, expected 0 or 1)")
+      end
     end
+    alias_method :has_term?, :term?
 
     ##
     # Iterates the given block for each unique RDF term (subject, predicate, object, or graph_name).
@@ -551,8 +577,8 @@ module RDF
       if block_given?
         values = {}
         each_statement do |statement|
-          statement.to_quad.each do |value|
-            unless value.nil? || values.include?(value.hash)
+          statement.terms.each do |value|
+            unless values.include?(value.hash)
               values[value.hash] = true
               yield value
             end
@@ -595,9 +621,10 @@ module RDF
     # @param  [RDF::Resource, false] graph_name
     #   Use value `false` to query for the default graph_name
     # @return [Boolean]
-    def has_graph?(graph_name)
+    def graph?(graph_name)
       enum_statement.any? {|s| s.graph_name == graph_name}
     end
+    alias_method :has_graph?, :graph?
 
     ##
     # Limits statements to be from a specific graph.