Skip to content

Add Option to Keep Query Prefixes #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vitalis-wiens wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Option to Keep Query Prefixes #187

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97e3867
Add Option to Keep Query Prefixes
vitalis-wiens Mar 7, 2025
16a16b4
Add Option for fixed set of prefixes
vitalis-wiens Mar 11, 2025
4fb5dd8
Revised the option for the generator
vitalis-wiens Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions lib/SparqlGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,20 @@ Generator.prototype.toQuery = function (q) {
Generator.prototype.baseAndPrefixes = function (q) {
var base = q.base ? ('BASE <' + q.base + '>' + this._newline) : '';
var prefixes = '';
var queryPrefixes = Object.keys(q.prefixes || {});
var addedPrefixes = [];
var fixedPrefixes = this._options.fixedPrefixes ?? {};
for (var key in q.prefixes) {
if (this._options.allPrefixes || this._usedPrefixes[key])
prefixes += 'PREFIX ' + key + ': <' + q.prefixes[key] + '>' + this._newline;
}
// ensure that we do not add prefixes multiple times
if (addedPrefixes.includes(key)) {
Copy link
Owner

@RubenVerborgh RubenVerborgh Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How could that happen when q.prefixes does not change?

continue;
}
if (this._options.allPrefixes || this._usedPrefixes[key] || fixedPrefixes[key] ||
(this._options.keepQueryPrefixes && queryPrefixes.includes(key))
)
prefixes += 'PREFIX ' + key + ': <' + q.prefixes[key] + '>' + this._newline;
addedPrefixes.push(key);
}
return base + prefixes;
};

Expand Down Expand Up @@ -451,6 +461,8 @@ function mapJoin(array, sep, func, self) {
/**
* @param options {
* allPrefixes: boolean,
* keepQueryPrefixes: boolean,
* fixedPrefixes: object
* indentation: string,
* newline: string
* }
Expand Down
52 changes: 52 additions & 0 deletions test/SparqlGenerator-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,58 @@ var parsedQueriesPath = __dirname + '/../test/parsedQueries/';
var unusedPrefixesPath = __dirname + '/../test/unusedPrefixes/';

describe('A SPARQL generator', function () {
it('should preserve mentioned prefixes in the query', function () {
var parser = new SparqlParser({
prefixes: {
schema: "https://schema.org/",
owl: "http://www.w3.org/2002/07/owl#"
}
});
var parsedQuery = parser.parse('PREFIX db_opt: <https://db.control.param_10> \n SELECT * WHERE {?s a owl:Class}');
var generator = new SparqlGenerator({allPrefixes: false, keepQueryPrefixes: true});
var generatedQuery = generator.stringify(parsedQuery);
var expectedQuery = 'PREFIX db_opt: <https://db.control.param_10>\nPREFIX owl: <http://www.w3.org/2002/07/owl#>\nSELECT * WHERE { ?s <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> owl:Class. }';
expect(generatedQuery).toEqual(expectedQuery);
});

it('should preserve fixed prefixes provided to the generator', function () {
var parser = new SparqlParser({
prefixes: {
schema: "https://schema.org/",
owl: "http://www.w3.org/2002/07/owl#"
}
});

var parsedQuery = parser.parse('PREFIX db_opt: <https://db.control.param_10> \n SELECT * WHERE {?s a owl:Class}');

var generator = new SparqlGenerator({allPrefixes: false, fixedPrefixes: {
schema: "https://schema.org/",
db_opt: "https://db.control.param_10"
}});
var generatedQuery = generator.stringify(parsedQuery);
var expectedQuery = 'PREFIX db_opt: <https://db.control.param_10>\nPREFIX schema: <https://schema.org/>\nPREFIX owl: <http://www.w3.org/2002/07/owl#>\nSELECT * WHERE { ?s <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> owl:Class. }';
expect(generatedQuery).toEqual(expectedQuery);
});

it('should preserve fixed prefixes provided to the generator and additional mentioned prefixes', function () {
var parser = new SparqlParser({
prefixes: {
schema: "https://schema.org/",
owl: "http://www.w3.org/2002/07/owl#"
}
});

var parsedQuery = parser.parse('PREFIX db_opt: <https://db.control.param_10>\nPREFIX db_optimization: <https://db.optimization.param_100>\n SELECT * WHERE {?s a owl:Class}');

var generator = new SparqlGenerator({allPrefixes: false, keepQueryPrefixes:true, fixedPrefixes: {
schema: "https://schema.org/",
db_opt: "https://db.control.param_10"
}});
var generatedQuery = generator.stringify(parsedQuery);
var expectedQuery = 'PREFIX db_opt: <https://db.control.param_10>\nPREFIX db_optimization: <https://db.optimization.param_100>\nPREFIX schema: <https://schema.org/>\nPREFIX owl: <http://www.w3.org/2002/07/owl#>\nSELECT * WHERE { ?s <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> owl:Class. }';
expect(generatedQuery).toEqual(expectedQuery);
});

var defaultGenerator = new SparqlGenerator();

describe('in SPARQL mode', () => {
Expand Down