n3 1.7.0 → 1.10.0

package/lib/N3DataFactory.js

@@ -275,31 +275,47 @@ function termToId(term) {
 class Quad extends Term {
   constructor(subject, predicate, object, graph) {
     super('');
-    this.subject = subject;
-    this.predicate = predicate;
-    this.object = object;
-    this.graph = graph || DEFAULTGRAPH;
+    this._subject = subject;
+    this._predicate = predicate;
+    this._object = object;
+    this._graph = graph || DEFAULTGRAPH;
   } // ### The term type of this term
 
 
   get termType() {
     return 'Quad';
+  }
+
+  get subject() {
+    return this._subject;
+  }
+
+  get predicate() {
+    return this._predicate;
+  }
+
+  get object() {
+    return this._object;
+  }
+
+  get graph() {
+    return this._graph;
   } // ### Returns a plain object representation of this quad
 
 
   toJSON() {
     return {
       termType: this.termType,
-      subject: this.subject.toJSON(),
-      predicate: this.predicate.toJSON(),
-      object: this.object.toJSON(),
-      graph: this.graph.toJSON()
+      subject: this._subject.toJSON(),
+      predicate: this._predicate.toJSON(),
+      object: this._object.toJSON(),
+      graph: this._graph.toJSON()
     };
   } // ### Returns whether this object represents the same quad as the other
 
 
   equals(other) {
-    return !!other && this.subject.equals(other.subject) && this.predicate.equals(other.predicate) && this.object.equals(other.object) && this.graph.equals(other.graph);
+    return !!other && this._subject.equals(other.subject) && this._predicate.equals(other.predicate) && this._object.equals(other.object) && this._graph.equals(other.graph);
   }
 
 }

package/lib/N3Store.js

@@ -224,7 +224,15 @@ class N3Store {
       }
     };
   } // ## Public methods
-  // ### `addQuad` adds a new quad to the store.
+  // ### `add` adds the specified quad to the dataset.
+  // Returns the dataset instance it was called on.
+  // Existing quads, as defined in Quad.equals, will be ignored.
+
+
+  add(quad) {
+    this.addQuad(quad);
+    return this;
+  } // ### `addQuad` adds a new quad to the store.
   // Returns if the quad index has changed, if the quad did not already exist.
 
 
@@ -273,6 +281,20 @@ class N3Store {
 
   addQuads(quads) {
     for (let i = 0; i < quads.length; i++) this.addQuad(quads[i]);
+  } // ### `delete` removes the specified quad from the dataset.
+  // Returns the dataset instance it was called on.
+
+
+  delete(quad) {
+    this.removeQuad(quad);
+    return this;
+  } // ### `has` determines whether a dataset includes a certain quad.
+  // Returns true or false as appropriate.
+
+
+  has(quad) {
+    const quads = this.getQuads(quad.subject, quad.predicate, quad.object, quad.graph);
+    return quads.length !== 0;
   } // ### `import` adds a stream of quads to the store
 
 
@@ -329,7 +351,17 @@ class N3Store {
 
 
   removeMatches(subject, predicate, object, graph) {
-    return this.remove(this.match(subject, predicate, object, graph));
+    const stream = new _readableStream.Readable({
+      objectMode: true
+    });
+
+    stream._read = () => {
+      for (const quad of this.getQuads(subject, predicate, object, graph)) stream.push(quad);
+
+      stream.push(null);
+    };
+
+    return this.remove(stream);
   } // ### `deleteGraph` removes all triples with the given graph from the store
 
 
@@ -370,22 +402,16 @@ class N3Store {
     }
 
     return quads;
-  } // ### `match` returns a stream of quads matching a pattern.
+  } // ### `match` returns a new dataset that is comprised of all quads in the current instance matching the given arguments.
+  // The logic described in Quad Matching is applied for each quad in this dataset to check if it should be included in the output dataset.
+  // Note: This method always returns a new DatasetCore, even if that dataset contains no quads.
+  // Note: Since a DatasetCore is an unordered set, the order of the quads within the returned sequence is arbitrary.
   // Setting any field to `undefined` or `null` indicates a wildcard.
+  // For backwards compatibility, the object return also implements the Readable stream interface.
 
 
   match(subject, predicate, object, graph) {
-    const stream = new _readableStream.Readable({
-      objectMode: true
-    }); // Initialize stream once it is being read
-
-    stream._read = () => {
-      for (const quad of this.getQuads(subject, predicate, object, graph)) stream.push(quad);
-
-      stream.push(null);
-    };
-
-    return stream;
+    return new DatasetCoreAndReadableStream(this, subject, predicate, object, graph);
   } // ### `countQuads` returns the number of quads matching a pattern.
   // Setting any field to `undefined` or `null` indicates a wildcard.
 
@@ -740,6 +766,13 @@ class N3Store {
 
     if (remove) this.removeQuads(toRemove);
     return lists;
+  } // ### Store is an iterable.
+  // Can be used where iterables are expected: for...of loops, array spread operator,
+  // `yield*`, and destructuring assignment (order is not guaranteed).
+
+
+  *[Symbol.iterator]() {
+    yield* this.getQuads();
   }
 
 } // Determines whether the argument is a string
@@ -749,4 +782,68 @@ exports.default = N3Store;
 
 function isString(s) {
   return typeof s === 'string' || s instanceof String;
+}
+/**
+ * A class that implements both DatasetCore and Readable.
+ */
+
+
+class DatasetCoreAndReadableStream extends _readableStream.Readable {
+  constructor(n3Store, subject, predicate, object, graph) {
+    super({
+      objectMode: true
+    });
+    Object.assign(this, {
+      n3Store,
+      subject,
+      predicate,
+      object,
+      graph
+    });
+  }
+
+  get filtered() {
+    if (!this._filtered) {
+      const {
+        n3Store,
+        graph,
+        object,
+        predicate,
+        subject
+      } = this;
+      const quads = n3Store.getQuads(subject, predicate, object, graph);
+      this._filtered = new N3Store(quads, {
+        factory: n3Store._factory
+      });
+    }
+
+    return this._filtered;
+  }
+
+  _read() {
+    for (const quad of this.filtered.getQuads()) this.push(quad);
+
+    this.push(null);
+  }
+
+  add(quad) {
+    return this.filtered.add(quad);
+  }
+
+  delete(quad) {
+    return this.filtered.delete(quad);
+  }
+
+  has(quad) {
+    return this.filtered.has(quad);
+  }
+
+  match(subject, predicate, object, graph) {
+    return new DatasetCoreAndReadableStream(this.filtered, subject, predicate, object, graph);
+  }
+
+  *[Symbol.iterator]() {
+    yield* this.filtered.getQuads();
+  }
+
 }

package/lib/N3StreamWriter.js

@@ -16,9 +16,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 class N3StreamWriter extends _readableStream.Transform {
   constructor(options) {
     super({
-      encoding: 'utf8'
-    });
-    this._writableState.objectMode = true; // Set up writer with a dummy stream object
+      encoding: 'utf8',
+      writableObjectMode: true
+    }); // Set up writer with a dummy stream object
 
     const writer = this._writer = new _N3Writer.default({
       write: (quad, encoding, callback) => {

package/lib/N3Writer.js

@@ -80,6 +80,7 @@ class N3Writer {
     if (!/triple|quad/i.test(options.format)) {
       this._lineMode = false;
       this._graph = DEFAULTGRAPH;
+      this._baseIRI = options.baseIRI;
       this._prefixIRIs = Object.create(null);
       options.prefixes && this.addPrefixes(options.prefixes);
     } else {
@@ -155,10 +156,12 @@ class N3Writer {
       // If it is a list head, pretty-print it
       if (this._lists && entity.value in this._lists) entity = this.list(this._lists[entity.value]);
       return 'id' in entity ? entity.id : `_:${entity.value}`;
-    } // Escape special characters
+    }
+
+    let iri = entity.value; // Use relative IRIs if requested and possible
 
+    if (this._baseIRI && iri.startsWith(this._baseIRI)) iri = iri.substr(this._baseIRI.length); // Escape special characters
 
-    let iri = entity.value;
     if (escape.test(iri)) iri = iri.replace(escapeAll, characterReplacer); // Try to represent the IRI as prefixed name
 
     const prefixMatch = this._prefixRegex.exec(iri);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n3",
-  "version": "1.7.0",
+  "version": "1.10.0",
   "description": "Lightning fast, asynchronous, streaming Turtle / N3 / RDF library.",
   "author": "Ruben Verborgh <ruben.verborgh@gmail.com>",
   "keywords": [

package/src/N3DataFactory.js

@@ -261,10 +261,10 @@ export function termToId(term) {
 export class Quad extends Term {
   constructor(subject, predicate, object, graph) {
     super('');
-    this.subject   = subject;
-    this.predicate = predicate;
-    this.object    = object;
-    this.graph     = graph || DEFAULTGRAPH;
+    this._subject   = subject;
+    this._predicate = predicate;
+    this._object    = object;
+    this._graph     = graph || DEFAULTGRAPH;
   }
 
   // ### The term type of this term
@@ -272,23 +272,39 @@ export class Quad extends Term {
     return 'Quad';
   }
 
+  get subject() {
+    return this._subject;
+  }
+
+  get predicate() {
+    return this._predicate;
+  }
+
+  get object() {
+    return this._object;
+  }
+
+  get graph() {
+    return this._graph;
+  }
+
   // ### Returns a plain object representation of this quad
   toJSON() {
     return {
       termType:  this.termType,
-      subject:   this.subject.toJSON(),
-      predicate: this.predicate.toJSON(),
-      object:    this.object.toJSON(),
-      graph:     this.graph.toJSON(),
+      subject:   this._subject.toJSON(),
+      predicate: this._predicate.toJSON(),
+      object:    this._object.toJSON(),
+      graph:     this._graph.toJSON(),
     };
   }
 
   // ### Returns whether this object represents the same quad as the other
   equals(other) {
-    return !!other && this.subject.equals(other.subject)     &&
-                      this.predicate.equals(other.predicate) &&
-                      this.object.equals(other.object)       &&
-                      this.graph.equals(other.graph);
+    return !!other && this._subject.equals(other.subject)     &&
+                      this._predicate.equals(other.predicate) &&
+                      this._object.equals(other.object)       &&
+                      this._graph.equals(other.graph);
   }
 }
 export { Quad as Triple };

package/src/N3Store.js

@@ -211,6 +211,14 @@ export default class N3Store {
 
   // ## Public methods
 
+  // ### `add` adds the specified quad to the dataset.
+  // Returns the dataset instance it was called on.
+  // Existing quads, as defined in Quad.equals, will be ignored.
+  add(quad) {
+    this.addQuad(quad);
+    return this;
+  }
+
   // ### `addQuad` adds a new quad to the store.
   // Returns if the quad index has changed, if the quad did not already exist.
   addQuad(subject, predicate, object, graph) {
@@ -259,6 +267,20 @@ export default class N3Store {
       this.addQuad(quads[i]);
   }
 
+  // ### `delete` removes the specified quad from the dataset.
+  // Returns the dataset instance it was called on.
+  delete(quad) {
+    this.removeQuad(quad);
+    return this;
+  }
+
+  // ### `has` determines whether a dataset includes a certain quad.
+  // Returns true or false as appropriate.
+  has(quad) {
+    const quads = this.getQuads(quad.subject, quad.predicate, quad.object, quad.graph);
+    return quads.length !== 0;
+  }
+
   // ### `import` adds a stream of quads to the store
   import(stream) {
     stream.on('data', quad => { this.addQuad(quad); });
@@ -316,7 +338,15 @@ export default class N3Store {
   // ### `removeMatches` removes all matching quads from the store
   // Setting any field to `undefined` or `null` indicates a wildcard.
   removeMatches(subject, predicate, object, graph) {
-    return this.remove(this.match(subject, predicate, object, graph));
+    const stream = new Readable({ objectMode: true });
+
+    stream._read = () => {
+      for (const quad of this.getQuads(subject, predicate, object, graph))
+        stream.push(quad);
+      stream.push(null);
+    };
+
+    return this.remove(stream);
   }
 
   // ### `deleteGraph` removes all triples with the given graph from the store
@@ -373,19 +403,14 @@ export default class N3Store {
     return quads;
   }
 
-  // ### `match` returns a stream of quads matching a pattern.
+  // ### `match` returns a new dataset that is comprised of all quads in the current instance matching the given arguments.
+  // The logic described in Quad Matching is applied for each quad in this dataset to check if it should be included in the output dataset.
+  // Note: This method always returns a new DatasetCore, even if that dataset contains no quads.
+  // Note: Since a DatasetCore is an unordered set, the order of the quads within the returned sequence is arbitrary.
   // Setting any field to `undefined` or `null` indicates a wildcard.
+  // For backwards compatibility, the object return also implements the Readable stream interface.
   match(subject, predicate, object, graph) {
-    const stream = new Readable({ objectMode: true });
-
-    // Initialize stream once it is being read
-    stream._read = () => {
-      for (const quad of this.getQuads(subject, predicate, object, graph))
-        stream.push(quad);
-      stream.push(null);
-    };
-
-    return stream;
+    return new DatasetCoreAndReadableStream(this, subject, predicate, object, graph);
   }
 
   // ### `countQuads` returns the number of quads matching a pattern.
@@ -790,9 +815,61 @@ export default class N3Store {
       this.removeQuads(toRemove);
     return lists;
   }
+
+  // ### Store is an iterable.
+  // Can be used where iterables are expected: for...of loops, array spread operator,
+  // `yield*`, and destructuring assignment (order is not guaranteed).
+  *[Symbol.iterator]() {
+    yield* this.getQuads();
+  }
 }
 
 // Determines whether the argument is a string
 function isString(s) {
   return typeof s === 'string' || s instanceof String;
 }
+
+/**
+ * A class that implements both DatasetCore and Readable.
+ */
+class DatasetCoreAndReadableStream extends Readable {
+  constructor(n3Store, subject, predicate, object, graph) {
+    super({ objectMode: true });
+    Object.assign(this, { n3Store, subject, predicate, object, graph });
+  }
+
+  get filtered() {
+    if (!this._filtered) {
+      const { n3Store, graph, object, predicate, subject } = this;
+      const quads = n3Store.getQuads(subject, predicate, object, graph);
+      this._filtered = new N3Store(quads, { factory: n3Store._factory });
+    }
+    return this._filtered;
+  }
+
+  _read() {
+    for (const quad of this.filtered.getQuads())
+      this.push(quad);
+    this.push(null);
+  }
+
+  add(quad) {
+    return this.filtered.add(quad);
+  }
+
+  delete(quad) {
+    return this.filtered.delete(quad);
+  }
+
+  has(quad) {
+    return this.filtered.has(quad);
+  }
+
+  match(subject, predicate, object, graph) {
+    return new DatasetCoreAndReadableStream(this.filtered, subject, predicate, object, graph);
+  }
+
+  *[Symbol.iterator]() {
+    yield* this.filtered.getQuads();
+  }
+}

package/src/N3StreamWriter.js

@@ -5,8 +5,7 @@ import N3Writer from './N3Writer';
 // ## Constructor
 export default class N3StreamWriter extends Transform {
   constructor(options) {
-    super({ encoding: 'utf8' });
-    this._writableState.objectMode = true;
+    super({ encoding: 'utf8', writableObjectMode: true });
 
     // Set up writer with a dummy stream object
     const writer = this._writer = new N3Writer({

package/src/N3Writer.js

@@ -55,6 +55,7 @@ export default class N3Writer {
     if (!(/triple|quad/i).test(options.format)) {
       this._lineMode = false;
       this._graph = DEFAULTGRAPH;
+      this._baseIRI = options.baseIRI;
       this._prefixIRIs = Object.create(null);
       options.prefixes && this.addPrefixes(options.prefixes);
     }
@@ -145,8 +146,11 @@ export default class N3Writer {
         entity = this.list(this._lists[entity.value]);
       return 'id' in entity ? entity.id : `_:${entity.value}`;
     }
-    // Escape special characters
     let iri = entity.value;
+    // Use relative IRIs if requested and possible
+    if (this._baseIRI && iri.startsWith(this._baseIRI))
+      iri = iri.substr(this._baseIRI.length);
+    // Escape special characters
     if (escape.test(iri))
       iri = iri.replace(escapeAll, characterReplacer);
     // Try to represent the IRI as prefixed name