sparql-client 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38ac883367777a453e1af010eb241ee4c14ee3dc
-  data.tar.gz: 2b251fa756f8adb385e95394bb1497d917021340
+  metadata.gz: 9cbfcd66988f16d017ebcabef5ab454d3d06ca46
+  data.tar.gz: a11a2a6ec4df3ad78cf190250e5992d0ac9f4279
 SHA512:
-  metadata.gz: 7a3044448b1e7e7bb252de265834bf76bedae8deafa28a1861a49d1b08e6ec9fd62d54e3c19b70a39cd76cd595e8e8d8524287aeb6ad751eff080e1ddeac5ec6
-  data.tar.gz: f4839f05b1441be9bde48f8e411d85ecd86c433b670da202c8a0ca0a3f62f6c931470438ca7f213cf6aacc144581806058f03380db418d875934208df7956693
+  metadata.gz: fa4d22153b5828a56da4d7b0bc648987be93ebdc31e3162f44a945f6536436715d2325090a27061997ab894f2e4c352d8620393736483981812a132c426858e5
+  data.tar.gz: a953798c28628c65350ca3ce3d6819e4986a6dda587fd4ce1a926c1c1dcaf88cd229762ec1c2956eb89aa32191b98dfdcacfe9b96da9ffb52f8adc4cfc2731bd

data/README

@@ -66,11 +66,28 @@ This is a [Ruby][] implementation of a [SPARQL][] client for [RDF.rb][].
 
     puts result.inspect   #=> true or false
 
+### Inserting data into a graph
+
+    # INSERT DATA { <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> "J. Random Hacker" .}
+    data = RDF::Graph.new do |graph|
+      graph << [RDF::URI('http://example.org/jhacker'), RDF::FOAF.name, "J. Random Hacker"]
+    end
+    insert_data(data)
+
+### Deleting data from a graph
+
+    # DELETE DATA { <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> "J. Random Hacker" .}
+    data = RDF::Graph.new do |graph|
+      graph << [RDF::URI('http://example.org/jhacker'), RDF::FOAF.name, "J. Random Hacker"]
+    end
+    delete_data(data)
+
 ##Documentation
 
 * {SPARQL::Client}
   * {SPARQL::Client::Query}
   * {SPARQL::Client::Repository}
+  * {SPARQL::Client::Update}
 
 ##Dependencies
 

data/VERSION

@@ -1 +1 @@
-1.1.5
+1.1.6

data/lib/sparql/client/query.rb

@@ -7,7 +7,9 @@ module SPARQL; class Client
   #
   class Query < RDF::Query
     ##
-    # @return [Symbol]
+    # The form of the query.
+    #
+    # @return [:select, :ask, :construct, :describe]
     # @see    http://www.w3.org/TR/sparql11-query/#QueryForms
     attr_reader :form
 
@@ -16,13 +18,18 @@ module SPARQL; class Client
     attr_reader :options
 
     ##
+    # Values returned from previous query.
+    #
     # @return [Array<[key, RDF::Value]>]
     attr_reader :values
 
     ##
     # Creates a boolean `ASK` query.
     #
-    # @param  [Hash{Symbol => Object}] options
+    # @example ASK WHERE { ?s ?p ?o . }
+    #   Query.ask.where([:s, :p, :o])
+    #
+    # @param  [Hash{Symbol => Object}] options (see {#initialize})
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#ask
     def self.ask(options = {})
@@ -32,11 +39,15 @@ module SPARQL; class Client
     ##
     # Creates a tuple `SELECT` query.
     #
+    # @example SELECT * WHERE { ?s ?p ?o . }
+    #   Query.select.where([:s, :p, :o])
+    #
     # @param  [Array<Symbol>]          variables
     # @return [Query]
     #
     # @overload self.select(*variables, options)
     #   @param  [Array<Symbol>]          variables
+    #   @param  [Hash{Symbol => Object}] options (see {#initialize})
     #   @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#select
     def self.select(*variables)
@@ -47,11 +58,15 @@ module SPARQL; class Client
     ##
     # Creates a `DESCRIBE` query.
     #
+    # @example DESCRIBE * WHERE { ?s ?p ?o . }
+    #   Query.describe.where([:s, :p, :o])
+    #
     # @param  [Array<Symbol, RDF::URI>] variables
     # @return [Query]
     #
     # @overload self.describe(*variables, options)
     #   @param  [Array<Symbol, RDF::URI>] variables
+    #   @param  [Hash{Symbol => Object}] options (see {#initialize})
     #   @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#describe
     def self.describe(*variables)
@@ -62,12 +77,15 @@ module SPARQL; class Client
     ##
     # Creates a graph `CONSTRUCT` query.
     #
+    # @example CONSTRUCT { ?s ?p ?o . } WHERE { ?s ?p ?o . }
+    #   Query.construct([:s, :p, :o]).where([:s, :p, :o])
+    #
     # @param  [Array<RDF::Query::Pattern, Array>] patterns
     # @return [Query]
     #
     # @overload self.construct(*variables, options)
     #   @param  [Array<RDF::Query::Pattern, Array>] patterns
-    #   @param  [Hash{Symbol => Object}]            options
+    #   @param  [Hash{Symbol => Object}] options (see {#initialize})
     #   @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#construct
     def self.construct(*patterns)
@@ -79,7 +97,7 @@ module SPARQL; class Client
     # @param  [Symbol, #to_s]          form
     # @overload self.construct(*variables, options)
     #   @param  [Symbol, #to_s]          form
-    #   @param  [Hash{Symbol => Object}] options
+    #   @param  [Hash{Symbol => Object}] options (see {Client#initialize})
     # @yield  [query]
     # @yieldparam [Query]
     def initialize(form = :ask, options = {}, &block)
@@ -89,6 +107,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example ASK WHERE { ?s ?p ?o . }
+    #   query.ask.where([:s, :p, :o])
+    #
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#ask
     def ask
@@ -97,6 +118,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . }
+    #   query.select.where([:s, :p, :o])
+    #
     # @param  [Array<Symbol>] variables
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#select
@@ -106,6 +130,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example DESCRIBE * WHERE { ?s ?p ?o . }
+    #   query.describe.where([:s, :p, :o])
+    #
     # @param  [Array<Symbol>] variables
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#describe
@@ -117,6 +144,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example CONSTRUCT { ?s ?p ?o . } WHERE { ?s ?p ?o . }
+    #   query.construct([:s, :p, :o]).where([:s, :p, :o])
+    #
     # @param  [Array<RDF::Query::Pattern, Array>] patterns
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#construct
@@ -125,6 +155,10 @@ module SPARQL; class Client
       self
     end
 
+    ##
+    # @example SELECT * FROM <a> WHERE \{ ?s ?p ?o . \}
+    #   query.select.from(RDF::URI.new(a)).where([:s, :p, :o])
+    #
     # @param [RDF::URI] uri
     # @return [Query]
     # @see http://www.w3.org/TR/sparql11-query/#specifyingDataset
@@ -134,6 +168,10 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . }
+    #   query.select.where([:s, :p, :o])
+    #   query.select.whether([:s, :p, :o])
+    #
     # @param  [Array<RDF::Query::Pattern, Array>] patterns_queries
     #   splat of zero or more patterns followed by zero or more queries.
     # @return [Query]
@@ -148,6 +186,16 @@ module SPARQL; class Client
     alias_method :whether, :where
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . } ORDER BY ?o
+    #   query.select.where([:s, :p, :o]).order(:o)
+    #   query.select.where([:s, :p, :o]).order_by(:o)
+    #
+    # @example SELECT * WHERE { ?s ?p ?o . } ORDER BY ?o ?p
+    #   query.select.where([:s, :p, :o]).order_by(:o, :p)
+    #
+    # @example SELECT * WHERE { ?s ?p ?o . } ORDER BY ASC(?o) DESC(?p)
+    #   query.select.where([:s, :p, :o]).order_by(:o => :asc, :p => :desc)
+    #
     # @param  [Array<Symbol, String>] variables
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#modOrderBy
@@ -159,6 +207,35 @@ module SPARQL; class Client
     alias_method :order_by, :order
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . } ORDER BY ASC(?o)
+    #   query.select.where([:s, :p, :o]).order.asc(:o)
+    #   query.select.where([:s, :p, :o]).asc(:o)
+    #
+    # @param  [Array<Symbol, String>] variables
+    # @return [Query]
+    # @see    http://www.w3.org/TR/sparql11-query/#modOrderBy
+    def asc(var)
+      (options[:order_by] ||= []) << {var => :asc}
+      self
+    end
+
+    ##
+    # @example SELECT * WHERE { ?s ?p ?o . } ORDER BY DESC(?o)
+    #   query.select.where([:s, :p, :o]).order.desc(:o)
+    #   query.select.where([:s, :p, :o]).desc(:o)
+    #
+    # @param  [Array<Symbol, String>] variables
+    # @return [Query]
+    # @see    http://www.w3.org/TR/sparql11-query/#modOrderBy
+    def desc(var)
+      (options[:order_by] ||= []) << {var => :desc}
+      self
+    end
+
+    ##
+    # @example SELECT ?s WHERE { ?s ?p ?o . } GROUP BY ?s
+    #   query.select(:s).where([:s, :p, :o]).group_by(:s)
+    #
     # @param  [Array<Symbol, String>] variables
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#groupby
@@ -170,6 +247,9 @@ module SPARQL; class Client
     alias_method :group_by, :group
 
     ##
+    # @example SELECT DISTINCT ?s WHERE { ?s ?p ?o . }
+    #   query.select(:s).distinct.where([:s, :p, :o])
+    #
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#modDuplicates
     def distinct(state = true)
@@ -178,6 +258,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT REDUCED ?s WHERE { ?s ?p ?o . }
+    #   query.select(:s).reduced.where([:s, :p, :o])
+    #
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#modDuplicates
     def reduced(state = true)
@@ -186,6 +269,8 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE { GRAPH ?g { ?s ?p ?o . } }
+    #   query.select.graph(:g).where([:s, :p, :o])
     # @param  [RDF::Value] graph_uri_or_var
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#queryDataset
@@ -200,6 +285,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . } OFFSET 100
+    #   query.select.where([:s, :p, :o]).offset(100)
+    #
     # @param  [Integer, #to_i] start
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#modOffset
@@ -208,6 +296,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . } LIMIT 10
+    #   query.select.where([:s, :p, :o]).limit(10)
+    #
     # @param  [Integer, #to_i] length
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#modResultLimit
@@ -216,6 +307,9 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE { ?s ?p ?o . } OFFSET 100 LIMIT 10
+    #   query.select.where([:s, :p, :o]).slice(100, 10)
+    #
     # @param  [Integer, #to_i] start
     # @param  [Integer, #to_i] length
     # @return [Query]
@@ -226,6 +320,12 @@ module SPARQL; class Client
     end
 
     ##
+    # @example PREFIX dc: <http://purl.org/dc/elements/1.1/> PREFIX foaf: <http://xmlns.com/foaf/0.1/> SELECT * WHERE \{ ?s ?p ?o . \}
+    #   query.select.
+    #     prefix(dc: RDF::URI("http://purl.org/dc/elements/1.1/")).
+    #     prefix(foaf: RDF::URI("http://xmlns.com/foaf/0.1/")).
+    #     where([:s, :p, :o])
+    #
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#prefNames
     def prefix(string)
@@ -234,6 +334,10 @@ module SPARQL; class Client
     end
 
     ##
+    # @example SELECT * WHERE \{ ?s ?p ?o . OPTIONAL \{ ?s a ?o . ?s \<http://purl.org/dc/terms/abstract\> ?o . \} \}
+    #   query.select.where([:s, :p, :o]).
+    #     optional([:s, RDF.type, :o], [:s, RDF::DC.abstract, :o])
+    #
     # @return [Query]
     # @see    http://www.w3.org/TR/sparql11-query/#optionals
     def optional(*patterns)
@@ -382,7 +486,40 @@ module SPARQL; class Client
 
       if options[:order_by]
         buffer << 'ORDER BY'
-        buffer += options[:order_by].map { |var| var.is_a?(String) ? var : "?#{var}" }
+        options[:order_by].map { |elem|
+          case elem
+            # .order_by({ :var1 => :asc, :var2 => :desc})
+            when Hash
+              elem.each { |key, val|
+                # check provided values
+                if !key.is_a?(Symbol)
+                  raise ArgumentError, 'keys of hash argument must be a Symbol'
+                elsif !val.is_a?(Symbol) || (val != :asc && val != :desc)
+                  raise ArgumentError, 'values of hash argument must either be `:asc` or `:desc`'
+                end
+                buffer << "#{val == :asc ? 'ASC' : 'DESC'}(?#{key})"
+              }
+            # .order_by([:var1, :asc], [:var2, :desc])
+            when Array
+              # check provided values
+              if elem.length != 2
+                raise ArgumentError, 'array argument must specify two elements'
+              elsif !elem[0].is_a?(Symbol)
+                raise ArgumentError, '1st element of array argument must contain a Symbol'
+              elsif !elem[1].is_a?(Symbol) || (elem[1] != :asc && elem[1] != :desc)
+                raise ArgumentError, '2nd element of array argument must either be `:asc` or `:desc`'
+              end
+              buffer << "#{elem[1] == :asc ? 'ASC' : 'DESC'}(?#{elem[0]})"
+            # .order_by(:var1, :var2)
+            when Symbol
+              buffer << "?#{elem}"
+            # .order_by('ASC(?var1) DESC(?var2)')
+            when String
+              buffer << elem
+            else
+              raise ArgumentError, 'argument provided to `order()` must either be an Array, Symbol or String'
+          end
+        }
       end
 
       buffer << "OFFSET #{options[:offset]}" if options[:offset]

data/lib/sparql/client/repository.rb

@@ -2,7 +2,7 @@ module SPARQL; class Client
   ##
   # A read-only repository view of a SPARQL endpoint.
   #
-  # @see RDF::Repository
+  # @see `RDF::Repository`
   class Repository < RDF::Repository
     # @return [SPARQL::Client]
     attr_reader :client
@@ -18,7 +18,7 @@ module SPARQL; class Client
 
     ##
     # Returns the client for the update_endpoint if specified, otherwise the
-    # {client}.
+    # {#client}.
     #
     # @return [SPARQL::Client]
     def update_client
@@ -186,7 +186,7 @@ module SPARQL; class Client
 
     ##
     # Deletes RDF statements from `self`.
-    # If any statement contains a {Query::Variable}, it is
+    # If any statement contains an `RDF::Query::Variable`, it is
     # considered to be a pattern, and used to query
     # self to find matching statements to delete.
     #
@@ -231,7 +231,7 @@ module SPARQL; class Client
     #     repository.query([nil, RDF::DOAP.developer, nil])
     #     repository.query(:predicate => RDF::DOAP.developer)
     #
-    # @fixme This should use basic SPARQL query mechanism.
+    # @todo This should use basic SPARQL query mechanism.
     #
     # @param  [Pattern] pattern
     # @see    RDF::Queryable#query_pattern

data/lib/sparql/client/update.rb

@@ -2,26 +2,128 @@ class SPARQL::Client
   ##
   # SPARQL 1.1 Update operation builders.
   module Update
+    ##
+    # Insert statements into the graph
+    #
+    # @example INSERT DATA \{ <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> \"J. Random Hacker\" .\}
+    #   data = RDF::Graph.new do |graph|
+    #     graph << [RDF::URI('http://example.org/jhacker'), RDF::FOAF.name, "J. Random Hacker"]
+    #   end
+    #   insert_data(data)
+    #
+    # @example INSERT DATA \{ GRAPH <http://example.org/> \{\}\}
+    #   insert_data(RDF::Graph.new, :graph => 'http://example.org/')
+    #   insert_data(RDF::Graph.new).graph('http://example.org/')
+    #
+    # @param (see InsertData#initialize)
     def self.insert_data(*arguments)
       InsertData.new(*arguments)
     end
 
+    ##
+    # Delete statements from the graph
+    #
+    # @example DELETE DATA \{ <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> \"J. Random Hacker\" .\}
+    #   data = RDF::Graph.new do |graph|
+    #     graph << [RDF::URI('http://example.org/jhacker'), RDF::FOAF.name, "J. Random Hacker"]
+    #   end
+    #   delete_data(data)
+    #
+    # @example DELETE DATA \{ GRAPH <http://example.org/> \{\}\}
+    #   delete_data(RDF::Graph.new, :graph => 'http://example.org/')
+    #   delete_data(RDF::Graph.new).graph('http://example.org/')
+    #
+    # @param (see DeleteData#initialize)
     def self.delete_data(*arguments)
       DeleteData.new(*arguments)
     end
 
+    ##
+    # Load statements into the graph
+    #
+    # @example LOAD <http://example.org/data.rdf>
+    #   load(RDF::URI(http://example.org/data.rdf))
+    #
+    # @example LOAD SILENT <http://example.org/data.rdf>
+    #   load(RDF::URI(http://example.org/data.rdf)).silent
+    #   load(RDF::URI(http://example.org/data.rdf), silent: true)
+    #
+    # @example LOAD <http://example.org/data.rdf> INTO <http://example.org/data.rdf>
+    #   load(RDF::URI(http://example.org/data.rdf)).into(RDF::URI(http://example.org/data.rdf))
+    #   load(RDF::URI(http://example.org/data.rdf), into: RDF::URI(http://example.org/data.rdf))
+    #
+    # @param (see Load#initialize)
     def self.load(*arguments)
       Load.new(*arguments)
     end
 
+    ##
+    # Load statements into the graph
+    #
+    # @example CLEAR GRAPH <http://example.org/data.rdf>
+    #   clear.graph(RDF::URI(http://example.org/data.rdf))
+    #   clear(:graph, RDF::URI(http://example.org/data.rdf))
+    #
+    # @example CLEAR DEFAULT
+    #   clear.default
+    #   clear(:default)
+    #
+    # @example CLEAR NAMED
+    #   clear.named
+    #   clear(:named)
+    #
+    # @example CLEAR ALL
+    #   clear.all
+    #   clear(:all)
+    #
+    # @example CLEAR SILENT ALL
+    #   clear.all.silent
+    #   clear(:all, silent: true)
+    #
+    # @param (see Clear#initialize)
     def self.clear(*arguments)
       Clear.new(*arguments)
     end
 
+    ##
+    # Create a graph
+    #
+    # @example CREATE GRAPH <http://example.org/data.rdf>
+    #   create(RDF::URI(http://example.org/data.rdf))
+    #
+    # @example CREATE SILENT GRAPH <http://example.org/data.rdf>
+    #   create(RDF::URI(http://example.org/data.rdf)).silent
+    #   create(RDF::URI(http://example.org/data.rdf), silent: true)
+    #
+    # @param (see Create#initialize)
     def self.create(*arguments)
       Create.new(*arguments)
     end
 
+    ##
+    # Drop a graph
+    #
+    # @example DROP GRAPH <http://example.org/data.rdf>
+    #   drop.graph(RDF::URI(http://example.org/data.rdf))
+    #   drop(:graph, RDF::URI(http://example.org/data.rdf))
+    #
+    # @example DROP DEFAULT
+    #   drop.default
+    #   drop(:default)
+    #
+    # @example DROP NAMED
+    #   drop.named
+    #   drop(:named)
+    #
+    # @example DROP ALL
+    #   drop.all
+    #   drop(:all)
+    #
+    # @example DROP ALL SILENT
+    #   drop.all.silent
+    #   drop(:all, silent: true)
+    #
+    # @param (see Drop#initialize)
     def self.drop(*arguments)
       Drop.new(*arguments)
     end
@@ -39,11 +141,13 @@ class SPARQL::Client
       ##
       # Generic Update always returns statements
       #
-      # @return expects_statements?
+      # @return [true]
       def expects_statements?
         true
       end
 
+      ##
+      # Set `silent` option
       def silent
         self.options[:silent] = true
         self
@@ -53,13 +157,30 @@ class SPARQL::Client
     ##
     # @see http://www.w3.org/TR/sparql11-update/#insertData
     class InsertData < Operation
+      # @return [RDF::Enumerable]
       attr_reader :data
 
+      ##
+      # Insert statements into the graph
+      #
+      # @example INSERT DATA \{ <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> \"J. Random Hacker\" .\}
+      #   data = RDF::Graph.new do |graph|
+      #     graph << [RDF::URI('http://example.org/jhacker'), RDF::FOAF.name, "J. Random Hacker"]
+      #   end
+      #   insert_data(data)
+      #   
+      # @param [Array<RDF::Statement>, RDF::Enumerable] data
+      # @param  [Hash{Symbol => Object}] options
       def initialize(data, options = {})
         @data = data
         super(options)
       end
 
+      ##
+      # Cause data to be inserted into the graph specified by `uri`
+      #
+      # @param [RDF::URI] uri
+      # @return [self]
       def graph(uri)
         self.options[:graph] = uri
         self
@@ -68,7 +189,7 @@ class SPARQL::Client
       ##
       # InsertData always returns result set
       #
-      # @return expects_statements?
+      # @return [true]
       def expects_statements?
         false
       end
@@ -86,13 +207,30 @@ class SPARQL::Client
     ##
     # @see http://www.w3.org/TR/sparql11-update/#deleteData
     class DeleteData < Operation
+      # @return [RDF::Enumerable]
       attr_reader :data
 
+      ##
+      # Delete statements from the graph
+      #
+      # @example DELETE DATA \{ <http://example.org/jhacker> <http://xmlns.com/foaf/0.1/name> \"J. Random Hacker\" .\}
+      #   data = RDF::Graph.new do |graph|
+      #     graph << [RDF::URI('http://example.org/jhacker'), RDF::FOAF.name, "J. Random Hacker"]
+      #   end
+      #   delete_data(data)
+      #   
+      # @param [Array<RDF::Statement>, RDF::Enumerable] data
+      # @param  [Hash{Symbol => Object}] options
       def initialize(data, options = {})
         @data = data
         super(options)
       end
 
+      ##
+      # Cause data to be deleted from the graph specified by `uri`
+      #
+      # @param [RDF::URI] uri
+      # @return [self]
       def graph(uri)
         self.options[:graph] = uri
         self
@@ -122,6 +260,11 @@ class SPARQL::Client
         super(options)
       end
 
+      ##
+      # Cause data to be deleted and inserted from the graph specified by `uri`
+      #
+      # @param [RDF::URI] uri
+      # @return [self]
       def graph(uri)
         self.options[:graph] = uri
         self
@@ -163,6 +306,24 @@ class SPARQL::Client
       attr_reader :from
       attr_reader :into
 
+
+      ##
+      # Load statements into the graph
+      #
+      # @example LOAD <http://example.org/data.rdf>
+      #   load(RDF::URI(http://example.org/data.rdf))
+      #
+      # @example LOAD SILENT<http://example.org/data.rdf>
+      #   load(RDF::URI(http://example.org/data.rdf)).silent
+      #   load(RDF::URI(http://example.org/data.rdf), silent: true)
+      #
+      # @example LOAD <http://example.org/data.rdf> INTO <http://example.org/data.rdf>
+      #   load(RDF::URI(http://example.org/data.rdf)).into(RDF::URI(http://example.org/data.rdf))
+      #   load(RDF::URI(http://example.org/data.rdf), into: RDF::URI(http://example.org/data.rdf))
+      # @param [RDF::URI] from
+      # @param  [Hash{Symbol => Object}] options
+      # @option [RDF::URI] :into
+      # @option [Boolean] :silent
       def initialize(from, options = {})
         options = options.dup
         @from = RDF::URI(from)
@@ -170,8 +331,13 @@ class SPARQL::Client
         super(options)
       end
 
-      def into(url)
-        @into = RDF::URI(url)
+      ##
+      # Cause data to be loaded into graph specified by `uri`
+      #
+      # @param [RDF::URI] uri
+      # @return [self]
+      def into(uri)
+        @into = RDF::URI(uri)
         self
       end
 
@@ -189,21 +355,38 @@ class SPARQL::Client
     class Clear < Operation
       attr_reader :uri
 
+      ##
+      # Cause data to be cleared from graph specified by `uri`
+      #
+      # @param [RDF::URI] uri
+      # @return [self]
       def graph(uri)
         @what, @uri = :graph, uri
         self
       end
 
+      ##
+      # Cause data to be cleared from the default graph
+      #
+      # @return [self]
       def default
         @what = :default
         self
       end
 
+      ##
+      # Cause data to be cleared from named graphs
+      #
+      # @return [self]
       def named
         @what = :named
         self
       end
 
+      ##
+      # Cause data to be cleared from all graphs
+      #
+      # @return [self]
       def all
         @what = :all
         self
@@ -212,7 +395,7 @@ class SPARQL::Client
       ##
       # Clear always returns statements
       #
-      # @return expects_statements?
+      # @return [false]
       def expects_statements?
         false
       end
@@ -236,6 +419,7 @@ class SPARQL::Client
     class Create < Operation
       attr_reader :uri
 
+      # @param  [Hash{Symbol => Object}] options
       def initialize(uri, options = {})
         @uri = RDF::URI(uri)
         super(options)

data/lib/sparql/client.rb

@@ -108,6 +108,7 @@ module SPARQL
     ##
     # Executes a boolean `ASK` query.
     #
+    # @param (see Query.ask)
     # @return [Query]
     def ask(*args)
       call_query_method(:ask, *args)
@@ -116,7 +117,7 @@ module SPARQL
     ##
     # Executes a tuple `SELECT` query.
     #
-    # @param  [Array<Symbol>] args
+    # @param (see Query.select)
     # @return [Query]
     def select(*args)
       call_query_method(:select, *args)
@@ -125,7 +126,7 @@ module SPARQL
     ##
     # Executes a `DESCRIBE` query.
     #
-    # @param  [Array<Symbol, RDF::URI>] args
+    # @param (see Query.describe)
     # @return [Query]
     def describe(*args)
       call_query_method(:describe, *args)
@@ -134,7 +135,7 @@ module SPARQL
     ##
     # Executes a graph `CONSTRUCT` query.
     #
-    # @param  [Array<Symbol>] args
+    # @param (see Query.construct)
     # @return [Query]
     def construct(*args)
       call_query_method(:construct, *args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparql-client
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Arto Bendiken
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -80,14 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sparql-client
-rubygems_version: 2.4.3
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: SPARQL client for RDF.rb.