rdf 1.99.1 → 2.0.0.beta1

data/lib/rdf/model/dataset.rb

@@ -0,0 +1,48 @@
+module RDF
+  ##
+  # An RDF Dataset
+  #
+  # Datasets are immutable by default. {RDF::Repository} provides an interface 
+  # for mutable Datasets.
+  # 
+  # @see https://www.w3.org/TR/rdf11-concepts/#section-dataset
+  # @see https://www.w3.org/TR/rdf11-datasets/
+  class Dataset
+    include RDF::Countable
+    include RDF::Enumerable
+    include RDF::Durable
+    include RDF::Queryable
+
+    ISOLATION_LEVELS = [ :read_uncommitted, 
+                         :read_committed, 
+                         :repeatable_read, 
+                         :snapshot, 
+                         :serializable].freeze
+
+    ##
+    # Returns a developer-friendly representation of this object.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(%s)>", self.class.name, __id__, uri.to_s)
+    end
+
+    ##
+    # Outputs a developer-friendly representation of this object to
+    # `stderr`.
+    #
+    # @return [void]
+    def inspect!
+      each_statement { |statement| statement.inspect! }
+      nil
+    end
+    
+    ##
+    # @return [Symbol] a representation of the isolation level for reads of this
+    #   Dataset. One of `:read_uncommitted`, `:read_committed`, `:repeatable_read`, 
+    #  `:snapshot`, or `:serializable`.
+    def isolation_level
+      :read_committed
+    end
+  end
+end

data/lib/rdf/model/graph.rb

@@ -27,7 +27,7 @@ module RDF
   #   require 'rdf/trig'  # for TriG support
   #
   #   repository = graph = RDF::Repository.load("https://raw.githubusercontent.com/ruby-rdf/rdf-trig/develop/etc/doap.trig", format: :trig))
-  #   graph = RDF::Graph.new(RDF::URI("http://greggkellogg.net/foaf#me"), data: repository)
+  #   graph = RDF::Graph.new(graph_name: RDF::URI("http://greggkellogg.net/foaf#me"), data: repository)
   class Graph
     include RDF::Value
     include RDF::Countable
@@ -35,6 +35,7 @@ module RDF
     include RDF::Enumerable
     include RDF::Queryable
     include RDF::Mutable
+    include RDF::Transactable
 
     ##
     # Returns the options passed to this graph when it was constructed.
@@ -51,17 +52,7 @@ module RDF
     attr_accessor :graph_name
 
     alias_method :name, :graph_name
-
-    ##
-    # Name of this graph, if it is part of an {RDF::Repository}
-    # @!attribute [rw] graph_name
-    # @return [RDF::Resource]
-    # @since 1.1.0
-    # @deprecated Use {#graph_name} instead.
-    def context
-      warn "[DEPRECATION] Graph#context is being replaced with Graph@graph_name in RDF.rb 2.0. Called from #{Gem.location_of_caller.join(':')}"
-	    graph_name
-    end
+    alias_method :name=, :graph_name=
 
     ##
     # {RDF::Queryable} backing this graph.
@@ -73,16 +64,18 @@ module RDF
     # Creates a new `Graph` instance populated by the RDF data returned by
     # dereferencing the given graph_name Resource.
     #
-    # @param  [String, #to_s]          url
+    # @param  [String, #to_s] url
+    # @param  [RDF::Resource] graph_name
+    #   Set set graph name of each loaded statement
     # @param  [Hash{Symbol => Object}] options
-    #   Options from {RDF::Graph#initialize} and {RDF::Mutable#load}
+    #   Options from {RDF::Reader.open}
     # @yield  [graph]
     # @yieldparam [Graph] graph
     # @return [Graph]
     # @since  0.1.7
-    def self.load(url, options = {}, &block)
-      self.new(options) do |graph|
-        graph.load(url, options)
+    def self.load(url, graph_name: nil, **options, &block)
+      self.new(graph_name: graph_name, **options) do |graph|
+        graph.load(url, graph_name: graph_name, **options)
 
         if block_given?
           case block.arity
@@ -103,21 +96,31 @@ module RDF
     #   @param  [Hash{Symbol => Object}] options
     #   @option options [RDF::Queryable] :data (RDF::Repository.new)
     #     Storage behind this graph.
-    #   @raise [ArgumentError] if a `data` does not support named graphs.
-    #   @note
-    #     Contexts are only useful when used as a projection
-    #     on a `:data` which supports named graphs. Otherwise, there is no
-    #     such thing as a named graph in RDF 1.1, a repository may have
-    #     graphs which are named, but the name is not a property of the graph.
-    # @overload initialize(options)
-    #   @param  [Hash{Symbol => Object}] options
-    #   @option options [RDF::Queryable] :data (RDF::Repository.new)
+    #   @deprecated This form is deprecated in version 2.0.
+    #
+    # @overload initialize(graph_name: nil, data: nil)
+    #   @param  [RDF::Resource]          graph_name
+    #     The graph_name from the associated {RDF::Queryable} associated
+    #     with this graph as provided with the `:data` option
+    #     (only for {RDF::Queryable} instances supporting
+    #     named graphs).
+    #   @param [RDF::Queryable] :data (RDF::Repository.new)
     #     Storage behind this graph.
+    #
+    # @raise [ArgumentError] if a `data` does not support named graphs.
+    # @note
+    #   Graph names are only useful when used as a projection
+    #   on a `:data` which supports named graphs. Otherwise, there is no
+    #   such thing as a named graph in RDF 1.1, a repository may have
+    #   graphs which are named, but the name is not a property of the graph.
     # @yield  [graph]
     # @yieldparam [Graph]
-    def initialize(*args, &block)
-      graph_name = args.shift unless args.first.is_a?(Hash)
-      options = args.first || {}
+    def initialize(*args, graph_name: nil, data: nil, **options, &block)
+      unless args.empty?
+        warn "[DEPRECATION] Graph#initialize now uses keyword arguments. Called from #{Gem.location_of_caller.join(':')}"
+        graph_name ||= args.first
+      end
+
       @graph_name = case graph_name
         when nil then nil
         when RDF::Resource then graph_name
@@ -125,7 +128,7 @@ module RDF
       end
 
       @options = options.dup
-      @data    = @options.delete(:data) || RDF::Repository.new(with_graph_name: false)
+      @data = data || RDF::Repository.new(with_graph_name: false)
 
       raise ArgumentError, "Can't apply graph_name unless initialized with `data` supporting graph_names" if
         @graph_name && !@data.supports?(:graph_name)
@@ -146,7 +149,7 @@ module RDF
       case
         when args.empty?
           raise ArgumentError, "Can't reload graph without a graph_name" unless graph_name.is_a?(RDF::URI)
-          load(graph_name.to_s, {base_uri: graph_name}.merge(@options))
+          load(graph_name.to_s, base_uri: graph_name)
         else super
       end
     end
@@ -186,21 +189,11 @@ module RDF
       @data.durable?
     end
 
-    ##
-    # Returns all unique RDF contexts for this graph.
-    #
-    # @return [Enumerator<RDF::Resource>]
-    # @deprecated Use {#graph_names} instead.
-    def contexts(options = {})
-      warn "[DEPRECATION] Graph#contexts is being replaced with Graph#graph_names in RDF.rb 2.0. Called from #{Gem.location_of_caller.join(':')}"
-      (named? ? [context] : []).to_enum.extend(RDF::Countable)
-    end
-
     ##
     # Returns all unique RDF names for this graph.
     #
     # @return [Enumerator<RDF::Resource>]
-    def graph_names(options = {})
+    def graph_names(unique: true)
       (named? ? [graph_name] : []).extend(RDF::Countable)
     end
 
@@ -241,6 +234,8 @@ module RDF
     ##
     # Returns `true` if this graph contains the given RDF statement.
     #
+    # A statement is in a graph if the statement if it has the same triples without regard to graph_name.
+    #
     # @param  [Statement] statement
     # @return [Boolean]
     # @see    RDF::Enumerable#has_statement?
@@ -267,6 +262,17 @@ module RDF
       end
     end
 
+    ##
+    # @private
+    # @see RDF::Enumerable#project_graph
+    def project_graph(graph_name, &block)
+      if block_given?
+        self.each(&block) if graph_name == self.graph_name
+      else
+        graph_name == self.graph_name ? self : RDF::Graph.new
+      end
+    end
+
     ##
     # Graph equivalence based on the contents of each graph being _exactly_
     # the same. To determine if the have the same _meaning_, consider
@@ -299,6 +305,21 @@ module RDF
       @data.insert(statement)
     end
 
+    ##
+    # @private
+    # @see RDF::Mutable#insert_statements
+    def insert_statements(statements)
+      enum = Enumerable::Enumerator.new do |yielder|
+        
+        statements.send(method = statements.respond_to?(:each_statement) ? :each_statement : :each) do |s|
+          s = s.dup
+          s.graph_name = graph_name
+          yielder << s
+        end
+      end
+      @data.insert(enum)
+    end
+
     ##
     # @private
     # @see RDF::Mutable#delete
@@ -315,17 +336,26 @@ module RDF
       @data.delete(graph_name: graph_name || false)
     end
 
+    ##
+    # @private
+    # Opens a transaction over the graph
+    # @see RDF::Transactable#begin_transaction
+    def begin_transaction(mutable: false, graph_name: @graph_name)
+      @data.send(:begin_transaction, mutable: mutable, graph_name: graph_name)
+    end
+
     protected :query_pattern
     protected :insert_statement
     protected :delete_statement
     protected :clear_statements
+    protected :begin_transaction
 
     ##
     # @private
     # @see    RDF::Enumerable#graphs
     # @since  0.2.0
     def graphs
-      enum_graph
+      Array(enum_graph)
     end
 
     ##

data/lib/rdf/model/list.rb

@@ -27,7 +27,7 @@ module RDF
     # @param  [Array<RDF::Term>] values
     # @return [RDF::List]
     def self.[](*values)
-      self.new(nil, nil, values)
+      self.new(subject: nil, graph: nil, values: values)
     end
 
     ##
@@ -49,21 +49,28 @@ module RDF
     #     g.count # => l.count
     #
     # @overload initialize(subject = nil, graph = nil, values = nil, &block)
-    #   @param  [RDF::URI]          subject
+    #   @param  [RDF::Resource]          subject
+    #     Subject should be an {RDF::Node}, not a {RDF::URI}. A list with an IRI head will not validate, but is commonly used to detect if a list is valid.
     #   @param  [RDF::Graph]        graph
     #   @param  [Array<RDF::Term>]  values
     #     Any values which are not terms are coerced to `RDF::Literal`.
     #   @yield  [list]
     #   @yieldparam [RDF::List] list
-    #   @deprecated Subject should be an {RDF::Node}, not a {RDF::URI}. A list with an IRI head will not validate, but is commonly used to detect if a list is valid.
-    # @overload initialize(subject = nil, graph = nil, values = nil, &block)
-    #   @param  [RDF::Node]         subject (RDF.nil)
+    #   @deprecated This form is deprecated in version 2.0
+    #
+    # @overload initialize(subject: nil, graph: nil, values: nil, &block)
+    #   @param  [RDF::Resource]         subject (RDF.nil)
+    #     Subject should be an {RDF::Node}, not a {RDF::URI}. A list with an IRI head will not validate, but is commonly used to detect if a list is valid.
     #   @param  [RDF::Graph]        graph (RDF::Graph.new)
     #   @param  [Array<RDF::Term>]  values
     #     Any values which are not terms are coerced to `RDF::Literal`.
     #   @yield  [list]
     #   @yieldparam [RDF::List] list
-    def initialize(subject = nil, graph = nil, values = nil, &block)
+    #
+    def initialize(*args, subject: nil, graph: nil, values: nil, &block)
+      unless args.empty?
+        raise ArgumentError, "[FATAL DEPRECATION] List#initialize now uses keyword arguments. Called from #{Gem.location_of_caller.join(':')}"
+      end
       @subject = subject || RDF.nil
       @graph   = graph   || RDF::Graph.new
       is_empty = @graph.query(subject: subject, predicate: RDF.first).empty?
@@ -95,7 +102,15 @@ module RDF
     UNSET = Object.new.freeze # @private
 
     # The canonical empty list.
-    NIL = RDF::List.new(RDF.nil).freeze
+    NIL = RDF::List.new(subject: RDF.nil).freeze
+
+    ##
+    # Is this a {RDF::List}?
+    #
+    # @return [Boolean]
+    def list?
+      true
+    end
 
     ##
     # Validate the list ensuring that
@@ -151,7 +166,7 @@ module RDF
     #
     # @param  [RDF::List] other
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000469
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-26
     def &(other)
       RDF::List[*(to_a & other.to_a)]
     end
@@ -169,7 +184,7 @@ module RDF
     #
     # @param  [RDF::List] other
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000470
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-7C
     def |(other)
       RDF::List[*(to_a | other.to_a)]
     end
@@ -182,7 +197,7 @@ module RDF
     #
     # @param  [RDF::List] other
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000466
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-2B
     def +(other)
       RDF::List[*(to_a + other.to_a)]
     end
@@ -196,7 +211,7 @@ module RDF
     #
     # @param  [RDF::List] other
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000468
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-2D
     def -(other)
       RDF::List[*(to_a - other.to_a)]
     end
@@ -225,7 +240,7 @@ module RDF
     #   @return [RDF::List]
     #
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000467
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-2A
     def *(int_or_str)
       case int_or_str
         when Integer then RDF::List[*(to_a * int_or_str)]
@@ -233,6 +248,19 @@ module RDF
       end
     end
 
+    ##
+    # Returns the element at `index`.
+    #
+    # @example
+    #   RDF::List[1, 2, 3][0]                   #=> RDF::Literal(1)
+    #
+    # @param  [Integer] index
+    # @return [RDF::Term]
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-5B-5D
+    def [](index)
+      at(index)
+    end
+
     ##
     # Element Assignment — Sets the element at `index`, or replaces a subarray from the `start` index for `length` elements, or replaces a subarray specified by the `range` of indices.
     #
@@ -314,7 +342,7 @@ module RDF
       # Clear the list and create a new list using the existing subject
       subject = @subject unless ary.empty? || @subject == RDF.nil
       self.clear
-      new_list = RDF::List.new(subject, @graph, ary)
+      new_list = RDF::List.new(subject: subject, graph: @graph, values: ary)
       @subject = new_list.subject
       ret # Returns inserted values
     end
@@ -328,13 +356,13 @@ module RDF
     # @param  [RDF::Term, Array<RDF::Term>, RDF::List] value
     #   A non-RDF::Term is coerced to a Literal
     # @return [RDF::List]
-    # @see    http://www.ruby-doc.org/core-1.9.3/Array.html#method-i-unshift
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-unshift
     #
     def unshift(value)
       value = case value
         when nil         then RDF.nil
         when RDF::Term   then value
-        when Array       then RDF::List.new(nil, graph, value)
+        when Array       then RDF::List.new(subject: nil, graph: graph, values: value)
         else value
       end
 
@@ -355,7 +383,7 @@ module RDF
     #   RDF::List[1,2,3].shift              #=> 1
     #
     # @return [RDF::Term]
-    # @see    http://www.ruby-doc.org/core-1.9.3/Array.html#method-i-shift
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-shift
     def shift
       return nil if empty?
 
@@ -376,7 +404,7 @@ module RDF
     #   RDF::List[1, 2, 2, 3].clear    #=> RDF::List[]
     #
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9.3/classes/Array.html#method-i-clear
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-clear
     def clear
       until empty?
         shift
@@ -392,12 +420,12 @@ module RDF
     #
     # @param  [RDF::Term] value
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000424
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-3C-3C
     def <<(value)
       value = case value
         when nil         then RDF.nil
         when RDF::Value  then value
-        when Array       then RDF::List.new(nil, graph, value)
+        when Array       then RDF::List.new(subject: nil, graph: graph, values: value)
         else value
       end
 
@@ -439,7 +467,7 @@ module RDF
     #
     # @param  [RDF::List] other
     # @return [Integer]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000461
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-3C-3D-3E
     def <=>(other)
       to_a <=> other.to_a # TODO: optimize this
     end
@@ -452,7 +480,7 @@ module RDF
     #   RDF::List[1, 2, 3].empty?               #=> false
     #
     # @return [Boolean]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000434
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-empty-3F
     def empty?
       graph.query(subject: subject, predicate: RDF.first).empty?
     end
@@ -465,7 +493,7 @@ module RDF
     #   RDF::List[1, 2, 3].length               #=> 3
     #
     # @return [Integer]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000433
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-length
     def length
       each.count
     end
@@ -482,7 +510,7 @@ module RDF
     #
     # @param  [RDF::Term] value
     # @return [Integer]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000436
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-index
     def index(value)
       each.with_index do |v, i|
         return i if v == value
@@ -499,7 +527,7 @@ module RDF
     #     RDF::List[1, 2, 3].slice(0..2) #=> RDF::List[1, 2, 3]
     #
     # @return [RDF::Term]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000462
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-slice
     def slice(*args)
       case argc = args.size
         when 2 then slice_with_start_and_length(*args)
@@ -556,7 +584,7 @@ module RDF
     #   RDF::List[1, 2, 3].at(4)                #=> nil
     #
     # @return [RDF::Term]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000419
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-at
     def at(index)
       each.with_index do |v, i|
         return v if i == index
@@ -683,7 +711,7 @@ module RDF
     #   RDF::List[*(1..10)].last                 #=> RDF::Literal(10)
     #
     # @return [RDF::Term]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000422
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-last
     def last
       graph.first_object(subject: last_subject, predicate: RDF.first)
     end
@@ -696,7 +724,7 @@ module RDF
     #
     # @return [RDF::List]
     def rest
-      (subject = rest_subject).eql?(RDF.nil) ? nil : self.class.new(subject, graph)
+      (subject = rest_subject).eql?(RDF.nil) ? nil : self.class.new(subject: subject, graph: graph)
     end
 
     ##
@@ -707,7 +735,7 @@ module RDF
     #
     # @return [RDF::List]
     def tail
-      (subject = last_subject).eql?(RDF.nil) ? nil : self.class.new(subject, graph)
+      (subject = last_subject).eql?(RDF.nil) ? nil : self.class.new(subject: subject, graph: graph)
     end
 
     ##
@@ -815,7 +843,7 @@ module RDF
     #
     # @param  [String] sep
     # @return [String]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000438
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-join
     def join(sep = $,)
       map(&:to_s).join(sep)
     end
@@ -827,7 +855,7 @@ module RDF
     #   RDF::List[1, 2, 3].reverse              #=> RDF::List[3, 2, 1]
     #
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000439
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-reverse
     def reverse
       RDF::List[*to_a.reverse]
     end
@@ -839,7 +867,7 @@ module RDF
     #   RDF::List[2, 3, 1].sort                 #=> RDF::List[1, 2, 3]
     #
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Enumerable.html#M003038
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-sort
     def sort(&block)
       RDF::List[*super]
     end
@@ -851,7 +879,7 @@ module RDF
     #   RDF::List[2, 3, 1].sort_by(&:to_i)      #=> RDF::List[1, 2, 3]
     #
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Enumerable.html#M003039
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-sort_by
     def sort_by(&block)
       RDF::List[*super]
     end
@@ -863,7 +891,7 @@ module RDF
     #   RDF::List[1, 2, 2, 3].uniq              #=> RDF::List[1, 2, 3]
     #
     # @return [RDF::List]
-    # @see    http://ruby-doc.org/core-1.9/classes/Array.html#M000471
+    # @see    http://ruby-doc.org/core-2.2.2/Array.html#method-i-uniq
     def uniq
       RDF::List[*to_a.uniq]
     end