├── conf.json
├── public
├── favicon.ico
├── GitHub-Mark-120px-plus.png
├── style.css
└── app.js
├── .babelrc
├── .travis.yml
├── webpack.dev.config.js
├── test
├── bob.js
├── alice.js
└── setup.js
├── webpack.prod.config.js
├── src
├── index.js
├── rdf
│ ├── quad.js
│ ├── node.spec.js
│ ├── node.js
│ ├── serialize.js
│ ├── graph.js
│ ├── graph.spec.js
│ └── serialize.spec.js
├── util.js
├── util.spec.js
├── backends
│ ├── in-memory-backend.js
│ ├── backend.spec.js
│ ├── backend.js
│ ├── web-backend.js
│ ├── in-memory-backend.spec.js
│ └── web-backend.spec.js
├── lang
│ ├── tokens.js
│ ├── ast.js
│ ├── lexer.spec.js
│ ├── lexer.js
│ ├── parser.js
│ └── parser.spec.js
├── web.spec.js
├── web.js
├── errors.js
├── query.spec.js
└── query.js
├── webpack.base.config.js
├── .gitignore
├── LICENSE
├── index.html
├── grammar.txt
├── package.json
└── README.md
/conf.json:
--------------------------------------------------------------------------------
1 | {
2 | "plugins": ["node_modules/jsdoc-strip-async-await"]
3 | }
4 |
--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deiu/twinql/master/public/favicon.ico
--------------------------------------------------------------------------------
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": ["env"],
3 | "plugins": ["transform-runtime", "transform-object-rest-spread"]
4 | }
5 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - 7.3.0
4 | after_success:
5 | - npm run coverage:coveralls
6 |
--------------------------------------------------------------------------------
/public/GitHub-Mark-120px-plus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deiu/twinql/master/public/GitHub-Mark-120px-plus.png
--------------------------------------------------------------------------------
/webpack.dev.config.js:
--------------------------------------------------------------------------------
1 | const config = require('./webpack.base.config')
2 |
3 | module.exports = Object.assign({}, config, {
4 | devtool: 'inline-source-map'
5 | })
6 |
--------------------------------------------------------------------------------
/test/bob.js:
--------------------------------------------------------------------------------
1 | export default `
2 | @prefix foaf: .
3 |
4 | <#bob> a foaf:Person
5 | ; foaf:name "Bob"
6 | ; foaf:knows
7 | .
8 | `
9 |
--------------------------------------------------------------------------------
/webpack.prod.config.js:
--------------------------------------------------------------------------------
1 | const webpack = require('webpack')
2 |
3 | const config = require('./webpack.base.config')
4 |
5 | module.exports = Object.assign({}, config, {
6 | plugins: [
7 | new webpack.optimize.UglifyJsPlugin()
8 | ]
9 | })
10 |
--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
1 | import query from './query'
2 | import Backend from './backends/backend'
3 | import InMemoryBackend from './backends/in-memory-backend'
4 | import WebBackend from './backends/web-backend'
5 |
6 | /**
7 | * The main entrypoint. Exports the query function and available backends.
8 | * @module
9 | */
10 |
11 | export { query, Backend, InMemoryBackend, WebBackend }
12 |
--------------------------------------------------------------------------------
/src/rdf/quad.js:
--------------------------------------------------------------------------------
1 | import Immutable from 'immutable'
2 |
3 | /**
4 | * Provides functionality for dealing with RDF Quads.
5 | * @module
6 | */
7 |
8 | /**
9 | * An Immutable.Record to represent RDF Quads
10 | * @class
11 | * @extends external:Immutable.Record
12 | */
13 | const Quad = Immutable.Record({
14 | subject: null,
15 | predicate: null,
16 | object: null,
17 | graph: null
18 | })
19 |
20 | export default Quad
21 |
--------------------------------------------------------------------------------
/src/util.js:
--------------------------------------------------------------------------------
1 | import Immutable from 'immutable'
2 |
3 | /**
4 | * Iterates over key, value pairs in an object
5 | * @param {Object} obj
6 | * @returns {Iterator} an iterator yielding arrays of the form [k, v]
7 | */
8 | export function * iterObj (obj) {
9 | for (let k of Object.keys(obj)) {
10 | yield [k, obj[k]]
11 | }
12 | }
13 |
14 | export const immutableHashCode = (...vals) => Immutable.List(vals).hashCode()
15 |
--------------------------------------------------------------------------------
/webpack.base.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path')
2 |
3 | module.exports = {
4 | entry: ['./src/index.js'],
5 | output: {
6 | filename: 'bundle.js',
7 | path: path.resolve(__dirname, 'build'),
8 | library: 'twinql',
9 | libraryTarget: 'umd'
10 | },
11 | module: {
12 | loaders: [
13 | {
14 | test: /\.js$/,
15 | exclude: /(node_modules)/,
16 | loader: 'babel-loader'
17 | }
18 | ]
19 | },
20 | externals: {
21 | child_process: 'child_process',
22 | fs: 'fs'
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/src/util.spec.js:
--------------------------------------------------------------------------------
1 | /* eslint-env mocha */
2 | import { iterObj } from './util'
3 |
4 | describe('util', () => {
5 | describe('iterObj', () => {
6 | it('iterates over the key/value pairs in plain objects', () => {
7 | const obj = {
8 | one: 'ONE',
9 | two: 2,
10 | three: x => x * 2
11 | }
12 | const foundKeyValPairs = []
13 | for (let kvp of iterObj(obj)) {
14 | foundKeyValPairs.push(kvp)
15 | }
16 | expect(Object.keys(obj)).to.eql(foundKeyValPairs.map(([k, v]) => k))
17 | expect(Object.values(obj)).to.eql(foundKeyValPairs.map(([k, v]) => v))
18 | })
19 | })
20 | })
21 |
--------------------------------------------------------------------------------
/test/alice.js:
--------------------------------------------------------------------------------
1 | export default `
2 | @prefix foaf: .
3 | @prefix dbo: .
4 | @prefix pim: .
5 | @prefix solid: .
6 | @prefix xsd: .
7 |
8 | <#alice> a foaf:Person
9 | ; foaf:name "Alice"
10 | ; foaf:knows
11 | ; foaf:knows <#spot>
12 | ; foaf:age "24"^^xsd:integer
13 | ; foaf:based_near "Estados Unidos"@es
14 | ; pim:storage
15 | ; solid:publicTypeIndex
16 | .
17 |
18 | <#spot> a dbo:Dog
19 | ; foaf:name "Spot"
20 | ; foaf:knows <#alice>
21 | .
22 | `
23 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 |
6 | # Runtime data
7 | pids
8 | *.pid
9 | *.seed
10 |
11 | # Directory for instrumented libs generated by jscoverage/JSCover
12 | lib-cov
13 |
14 | # Coverage directory used by tools like istanbul
15 | coverage
16 |
17 | # nyc test coverage
18 | .nyc_output
19 |
20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
21 | .grunt
22 |
23 | # node-waf configuration
24 | .lock-wscript
25 |
26 | # Compiled binary addons (http://nodejs.org/api/addons.html)
27 | build/Release
28 |
29 | # Dependency directories
30 | node_modules
31 | jspm_packages
32 |
33 | # Optional npm cache directory
34 | .npm
35 |
36 | # Optional REPL history
37 | .node_repl_history
38 |
39 | .DS_Store
40 | build
41 | docs
42 | lib
43 |
--------------------------------------------------------------------------------
/src/backends/in-memory-backend.js:
--------------------------------------------------------------------------------
1 | import Backend from './backend'
2 |
3 | /**
4 | * Implements a backend for a single in-memory graph.
5 | * @module
6 | */
7 |
8 | /**
9 | * A backend for an in-memory graph
10 | * @extends {module:backends/backend~Backend}
11 | */
12 | class InMemoryBackend extends Backend {
13 | /**
14 | * Create an InMemoryBackend
15 | * @param {module:rdf/graph~Graph} graph - the local graph
16 | */
17 | constructor (graph) {
18 | super()
19 | this.graph = graph
20 | }
21 |
22 | async getObjects (subject, predicate) {
23 | return this.graph.match({ subject, predicate })
24 | }
25 |
26 | async getSubjects (predicate, object, namedGraph) {
27 | return this.graph.match({
28 | predicate,
29 | object,
30 | graph: namedGraph || null
31 | })
32 | }
33 | }
34 |
35 | export default InMemoryBackend
36 |
--------------------------------------------------------------------------------
/src/backends/backend.spec.js:
--------------------------------------------------------------------------------
1 | /* eslint-env mocha */
2 | import { spy } from 'sinon'
3 |
4 | import Backend from './backend'
5 |
6 | describe('backend', () => {
7 | describe('Backend', () => {
8 | it('has an abstract getObjects method', () => {
9 | return expect(new Backend().getObjects())
10 | .to.be.rejectedWith(/not implemented/)
11 | })
12 |
13 | it('has an abstract getSubjects method', () => {
14 | return expect(new Backend().getSubjects())
15 | .to.be.rejectedWith(/not implemented/)
16 | })
17 |
18 | describe('events', () => {
19 | it('can register and trigger event handlers', () => {
20 | const spy1 = spy()
21 | const spy2 = spy()
22 | const spy3 = spy()
23 | const backend = new Backend()
24 | backend.on('myEvent', spy1)
25 | backend.on('myEvent', spy2)
26 | backend.on('someOtherEvent', spy3)
27 | backend.trigger('myEvent')
28 | expect(spy1).to.have.been.calledOnce
29 | expect(spy2).to.have.been.calledOnce
30 | expect(spy3).not.to.have.been.called
31 | })
32 | })
33 | })
34 | })
35 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 Daniel Friedman
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/src/lang/tokens.js:
--------------------------------------------------------------------------------
1 | // An enumeration of language tokens
2 | export const tokenTypes = {
3 | URI: 'URI',
4 | PREFIXED_URI: 'PREFIXED_URI',
5 | NAME: 'NAME',
6 | LPAREN: 'LPAREN',
7 | RPAREN: 'RPAREN',
8 | LBRACE: 'LBRACE',
9 | RBRACE: 'RBRACE',
10 | LSQUARE: 'LSQUARE',
11 | RSQUARE: 'RSQUARE',
12 | STRLIT: 'STRLIT',
13 | ARROW: 'ARROW',
14 | PREFIX: 'PREFIX',
15 | EOF: 'EOF'
16 | }
17 |
18 | // A mapping from token text to token types
19 | export const keywords = {
20 | '=>': tokenTypes.ARROW,
21 | '@prefix': tokenTypes.PREFIX
22 | }
23 |
24 | // A mapping from symbols to token types
25 | export const symbols = {
26 | '(': tokenTypes.LPAREN,
27 | ')': tokenTypes.RPAREN,
28 | '{': tokenTypes.LBRACE,
29 | '}': tokenTypes.RBRACE,
30 | '[': tokenTypes.LSQUARE,
31 | ']': tokenTypes.RSQUARE
32 | }
33 |
34 | export const NAME_REGEX = /^[a-zA-Z]+[a-zA-Z0-9_-]*$/
35 |
36 | // Captures two groups. The first is the prefixed name and the second is the
37 | // path.
38 | export const PREFIXED_URI_REGEX = /^([a-zA-Z]+[a-zA-Z0-9_-]*):(.+)$/
39 |
40 | export class Token {
41 | constructor (type, value, line, column) {
42 | this.type = type
43 | this.value = value
44 | this.line = line
45 | this.column = column
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/src/rdf/node.spec.js:
--------------------------------------------------------------------------------
1 | /* eslint-env mocha */
2 | import Immutable from 'immutable'
3 |
4 | import { Node, nodeSet } from './node'
5 |
6 | describe('node', () => {
7 | describe('Node', () => {
8 | it('constructs an immutable record', () => {
9 | expect(Node()).to.be.an.instanceof(Immutable.Record)
10 | })
11 |
12 | it('creates default fields for `termType`, `value`, `language`, and `datatype`', () => {
13 | const node = Node()
14 | expect(node.termType).to.be.null
15 | expect(node.value).to.be.null
16 | expect(node.language).to.be.null
17 | expect(node.datatype).to.be.null
18 | expect(node.notRealField).to.be.undefined
19 | })
20 | })
21 |
22 | describe('nodeSet', () => {
23 | it('creates an immutable set', () => {
24 | expect(nodeSet()).to.be.an.instanceof(Immutable.Set)
25 | })
26 |
27 | it('converts its iterable argument to Nodes', () => {
28 | const ns = nodeSet([
29 | { termType: 'NamedNode', value: 'https://example.com/' }
30 | ])
31 | const first = ns.first()
32 | expect(first).to.be.an.instanceof(Immutable.Record)
33 | expect(first.termType).to.equal('NamedNode')
34 | expect(first.value).to.equal('https://example.com/')
35 | })
36 | })
37 | })
38 |
--------------------------------------------------------------------------------
/src/web.spec.js:
--------------------------------------------------------------------------------
1 | /* eslint-env mocha */
2 | import nock from 'nock'
3 |
4 | import { HttpError } from './errors'
5 | import { fetchGraph } from './web'
6 | import Graph from './rdf/graph'
7 |
8 | describe('web', () => {
9 | describe('fetchGraph', () => {
10 | const DOMAIN = 'http://localhost:8000'
11 |
12 | afterEach(() => {
13 | nock.cleanAll()
14 | })
15 |
16 | it('rejects on non-2XX statuses', () => {
17 | nock(DOMAIN)
18 | .get('/graph')
19 | .reply(400)
20 |
21 | return expect(fetchGraph(`${DOMAIN}/graph`))
22 | .to.be.rejectedWith('Bad Request')
23 | })
24 |
25 | it('rejects on timeout', () => {
26 | nock(DOMAIN)
27 | .get('/graph')
28 | .reply((uri, requestBody, cb) => setTimeout(() => cb(
29 | null,
30 | [200, '', { 'Content-Type': 'text/turtle' }]
31 | ), 10))
32 |
33 | return expect(fetchGraph(`${DOMAIN}/graph`, { timeout: 0 }))
34 | .to.be.rejectedWith('Request timed out')
35 | })
36 |
37 | it('resolves to the indexed graph stored at the given URI', () => {
38 | nock(DOMAIN)
39 | .get('/graph')
40 | .reply(200, '', { 'Content-Type': 'text/turtle' })
41 |
42 | return expect(fetchGraph(`${DOMAIN}/graph`))
43 | .to.eventually.eql(new Graph())
44 | })
45 | })
46 | })
47 |
--------------------------------------------------------------------------------
/src/rdf/node.js:
--------------------------------------------------------------------------------
1 | import Immutable from 'immutable'
2 |
3 | /**
4 | * Provides immutable datatypes for dealing with RDF nodes.
5 | * @module
6 | */
7 |
8 | /**
9 | * @external Immutable
10 | * @see https://facebook.github.io/immutable-js/docs/#/
11 | */
12 |
13 | /**
14 | * @class Set
15 | * @memberof external:Immutable
16 | * @see https://facebook.github.io/immutable-js/docs/#/Set
17 | */
18 |
19 | /**
20 | * @class Record
21 | * @memberof external:Immutable
22 | * @see https://facebook.github.io/immutable-js/docs/#/Record
23 | */
24 |
25 | /**
26 | * A union type for nodes in the graph
27 | * @typedef {(module:parsetree.Uri|module:parsetree.StringLiteral|module:rdf/node.NodeRecord)} NodeLike
28 | */
29 |
30 | /**
31 | * An immutable set of Nodes
32 | * @typedef NodeSet {external:Immutable.Set}
33 | */
34 |
35 | /**
36 | * An Immutable.Record to represent RDF Nodes
37 | * @class
38 | * @extends external:Immutable.Record
39 | */
40 | export const Node = Immutable.Record({
41 | termType: null,
42 | value: null,
43 | language: null,
44 | datatype: null
45 | })
46 |
47 | /**
48 | * Constructs an {@link external:Immutable.Set} of {@link module:rdf/node.NodeRecord}s.
49 | *
50 | * @param {Array} [nodes=[]] - A list of RDF Nodes
51 | * @return {NodeSet} the set of nodes
52 | */
53 | export function nodeSet (nodes = []) {
54 | return Immutable.Set(nodes.map(Node))
55 | }
56 |
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | twinql pad
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
16 |
24 |
25 |
26 |
Query
27 |
28 |
29 |
30 |
31 |
35 |
15 |