Skip to content
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

Jump to bottom

fix: Extract SLD version from SLD #696 and #925 #926

Merged
merged 3 commits into from
Jun 19, 2024
Merged

fix: Extract SLD version from SLD #696 and #925 #926

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
0d33e10
fix: extract version from file #696 and #925
pprev94 Jun 18, 2024
262baa4
fix: add property _readingSldVersion which is automatically read from…
pprev94 Jun 19, 2024
b9e874d
feat: add test reading from one version and write to another
pprev94 Jun 19, 2024
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
/build
/browser

# history
/.history

# misc
.DS_Store
.env.local
Expand Down
96 changes: 64 additions & 32 deletions src/SldStyleParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,14 @@ import {
numberExpression
} from './Util/SldUtil';

export type SldVersion = '1.0.0' | '1.1.0';
const SLD_VERSIONS = ['1.0.0', '1.1.0'] as const;

export type SldVersion = (typeof SLD_VERSIONS)[number];

export type ConstructorParams = {
numericFilterFields?: string[];
boolFilterFields?: string[];
/* optional for reading style (it will be guessed from sld style) and mandatory for writing */
sldVersion?: SldVersion;
symbolizerUnits?: string;
parserOptions?: X2jOptionsOptional;
Expand Down Expand Up @@ -271,7 +274,7 @@ export class SldStyleParser implements StyleParser<string> {

/**
* String indicating the SLD version to use. 1.1.0 will make use of
* Symbology Encoding. Default ist to use SLD 1.0.0
* Symbology Encoding.
*/
private _sldVersion: SldVersion = '1.0.0';

Expand All @@ -291,6 +294,28 @@ export class SldStyleParser implements StyleParser<string> {
this._sldVersion = sldVersion;
}


/**
* String indicating the SLD version used in reading mode
*/
private _readingSldVersion: SldVersion = '1.0.0';

/**
* Getter for _readingSldVersion
* @return
*/
get readingSldVersion(): SldVersion {
return this._readingSldVersion;
}

/**
* Setter for _readingSldVersion
* @param sldVersion The _readingSldVersion value to set
*/
set readingSldVersion(sldVersion: SldVersion) {
this._readingSldVersion = sldVersion;
}

/**
* Used to add a `uom` attribute to the symbolizer tag. Can be one of
* `metre`, `foot` or `pixel`. Defaults to pixel.
Expand Down Expand Up @@ -325,6 +350,13 @@ export class SldStyleParser implements StyleParser<string> {
return new Promise<ReadStyleResult>((resolve) => {
try {
const sldObject = this.parser.parse(sldString);

const version = getAttribute(sldObject[0], 'version');
if (!SLD_VERSIONS.includes(version)) {
throw new Error(`SLD version must be ${SLD_VERSIONS.toString()}`);
}
this._readingSldVersion = version;

const geoStylerStyle: Style = this.sldObjectToGeoStylerStyle(sldObject);
resolve({
output: geoStylerStyle
Expand Down Expand Up @@ -601,14 +633,14 @@ export class SldStyleParser implements StyleParser<string> {
const lineSymbolizer: GsLineSymbolizer = {
kind: 'Line'
};
const strokeEl = get(sldSymbolizer, 'Stroke');
const color = getParameterValue(strokeEl, 'stroke', this.sldVersion);
const width = getParameterValue(strokeEl, 'stroke-width', this.sldVersion);
const opacity = getParameterValue(strokeEl, 'stroke-opacity', this.sldVersion);
const lineJoin = getParameterValue(strokeEl, 'stroke-linejoin', this.sldVersion);
const lineCap = getParameterValue(strokeEl, 'stroke-linecap', this.sldVersion);
const dashArray = getParameterValue(strokeEl, 'stroke-dasharray', this.sldVersion);
const dashOffset = getParameterValue(strokeEl, 'stroke-dashoffset', this.sldVersion);
const strokeEl = get(sldSymbolizer, 'Stroke', this.readingSldVersion);
const color = getParameterValue(strokeEl, 'stroke', this.readingSldVersion);
const width = getParameterValue(strokeEl, 'stroke-width', this.readingSldVersion);
const opacity = getParameterValue(strokeEl, 'stroke-opacity', this.readingSldVersion);
const lineJoin = getParameterValue(strokeEl, 'stroke-linejoin', this.readingSldVersion);
const lineCap = getParameterValue(strokeEl, 'stroke-linecap', this.readingSldVersion);
const dashArray = getParameterValue(strokeEl, 'stroke-dasharray', this.readingSldVersion);
const dashOffset = getParameterValue(strokeEl, 'stroke-dashoffset', this.readingSldVersion);

if (!isNil(color)) {
lineSymbolizer.color = color;
Expand Down Expand Up @@ -673,15 +705,15 @@ export class SldStyleParser implements StyleParser<string> {
const haloEl = get(sldSymbolizer, 'Halo');
const haloFillEl = get(haloEl, 'Fill');

const color = getParameterValue(fillEl, 'fill', this.sldVersion);
const opacity = getParameterValue(fillEl, 'fill-opacity', this.sldVersion);
const color = getParameterValue(fillEl, 'fill', this.readingSldVersion);
const opacity = getParameterValue(fillEl, 'fill-opacity', this.readingSldVersion);

const fontFamily = getParameterValue(fontEl, 'font-family', this.sldVersion);
const fontStyle = getParameterValue(fontEl, 'font-style', this.sldVersion);
const fontSize = getParameterValue(fontEl, 'font-size', this.sldVersion);
const fontWeight = getParameterValue(fontEl, 'font-weight', this.sldVersion);
const fontFamily = getParameterValue(fontEl, 'font-family', this.readingSldVersion);
const fontStyle = getParameterValue(fontEl, 'font-style', this.readingSldVersion);
const fontSize = getParameterValue(fontEl, 'font-size', this.readingSldVersion);
const fontWeight = getParameterValue(fontEl, 'font-weight', this.readingSldVersion);

const haloColor = getParameterValue(haloFillEl, 'fill', this.sldVersion);
const haloColor = getParameterValue(haloFillEl, 'fill', this.readingSldVersion);

if (!isNil(labelEl)) {
textSymbolizer.label = this.getTextSymbolizerLabelFromSldSymbolizer(labelEl);
Expand All @@ -694,7 +726,7 @@ export class SldStyleParser implements StyleParser<string> {
if (!isNil(haloRadius)) {
textSymbolizer.haloWidth = numberExpression(haloRadius);
}
const haloOpacity = getParameterValue(haloFillEl, 'fill-opacity', this.sldVersion);
const haloOpacity = getParameterValue(haloFillEl, 'fill-opacity', this.readingSldVersion);
if (!isNil(haloOpacity)) {
textSymbolizer.haloOpacity = numberExpression(haloOpacity);
}
Expand Down Expand Up @@ -815,16 +847,16 @@ export class SldStyleParser implements StyleParser<string> {
const strokeEl = get(sldSymbolizer, 'Stroke');
const fillEl = get(sldSymbolizer, 'Fill');

const fillOpacity = getParameterValue(fillEl, 'fill-opacity', this.sldVersion);
const color = getParameterValue(fillEl, 'fill', this.sldVersion);
const fillOpacity = getParameterValue(fillEl, 'fill-opacity', this.readingSldVersion);
const color = getParameterValue(fillEl, 'fill', this.readingSldVersion);

const outlineColor = getParameterValue(strokeEl, 'stroke', this.sldVersion);
const outlineWidth = getParameterValue(strokeEl, 'stroke-width', this.sldVersion);
const outlineOpacity = getParameterValue(strokeEl, 'stroke-opacity', this.sldVersion);
const outlineDashArray = getParameterValue(strokeEl, 'stroke-dasharray', this.sldVersion);
const outlineCap = getParameterValue(strokeEl, 'stroke-linecap', this.sldVersion);
const outlineJoin = getParameterValue(strokeEl, 'stroke-linejoin', this.sldVersion);
// const outlineDashOffset = getParameterValue(strokeEl, 'stroke-dashoffset', this.sldVersion);
const outlineColor = getParameterValue(strokeEl, 'stroke', this.readingSldVersion);
const outlineWidth = getParameterValue(strokeEl, 'stroke-width', this.readingSldVersion);
const outlineOpacity = getParameterValue(strokeEl, 'stroke-opacity', this.readingSldVersion);
const outlineDashArray = getParameterValue(strokeEl, 'stroke-dasharray', this.readingSldVersion);
const outlineCap = getParameterValue(strokeEl, 'stroke-linecap', this.readingSldVersion);
const outlineJoin = getParameterValue(strokeEl, 'stroke-linejoin', this.readingSldVersion);
// const outlineDashOffset = getParameterValue(strokeEl, 'stroke-dashoffset', this.readingSldVersion);

const graphicFill = get(sldSymbolizer, 'Fill.GraphicFill');
if (!isNil(graphicFill)) {
Expand Down Expand Up @@ -916,8 +948,8 @@ export class SldStyleParser implements StyleParser<string> {
const opacity = get(sldSymbolizer, 'Graphic.Opacity.#text');
const size = get(sldSymbolizer, 'Graphic.Size.#text');
const rotation = get(sldSymbolizer, 'Graphic.Rotation.#text');
const fillOpacity = getParameterValue(fillEl, 'fill-opacity', this.sldVersion);
const color = getParameterValue(fillEl, 'fill', this.sldVersion);
const fillOpacity = getParameterValue(fillEl, 'fill-opacity', this.readingSldVersion);
const color = getParameterValue(fillEl, 'fill', this.readingSldVersion);
const displacement = get(sldSymbolizer, 'Graphic.Displacement');

const markSymbolizer: GsMarkSymbolizer = {
Expand Down Expand Up @@ -976,15 +1008,15 @@ export class SldStyleParser implements StyleParser<string> {
throw new Error('MarkSymbolizer cannot be parsed. Unsupported WellKnownName.');
}

const strokeColor = getParameterValue(strokeEl, 'stroke', this.sldVersion);
const strokeColor = getParameterValue(strokeEl, 'stroke', this.readingSldVersion);
if (!isNil(strokeColor)) {
markSymbolizer.strokeColor = strokeColor;
}
const strokeWidth = getParameterValue(strokeEl, 'stroke-width', this.sldVersion);
const strokeWidth = getParameterValue(strokeEl, 'stroke-width', this.readingSldVersion);
if (!isNil(strokeWidth)) {
markSymbolizer.strokeWidth = numberExpression(strokeWidth);
}
const strokeOpacity = getParameterValue(strokeEl, 'stroke-opacity', this.sldVersion);
const strokeOpacity = getParameterValue(strokeEl, 'stroke-opacity', this.readingSldVersion);
if (!isNil(strokeOpacity)) {
markSymbolizer.strokeOpacity = numberExpression(strokeOpacity);
}
Expand Down
12 changes: 11 additions & 1 deletion src/SldStyleParser.v1.0.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ it('SldStyleParser is defined', () => {
expect(SldStyleParser).toBeDefined();
});

describe('SldStyleParser implements StyleParser', () => {
describe('SldStyleParser implements StyleParser (reading)', () => {
let styleParser: SldStyleParser;

beforeEach(() => {
Expand Down Expand Up @@ -361,6 +361,14 @@ describe('SldStyleParser implements StyleParser', () => {
});
});
});
});

describe('SldStyleParser implements StyleParser (writing)', () => {
let styleParser: SldStyleParser;

beforeEach(() => {
styleParser = new SldStyleParser({sldVersion: '1.0.0'});
});

describe('#writeStyle', () => {
it('is defined', () => {
Expand Down Expand Up @@ -924,6 +932,7 @@ describe('SldStyleParser implements StyleParser', () => {

it('creates the correct order in a text symbolizer', async () => {
const styleParserOrder = new SldStyleParser({
sldVersion: '1.0.0',
Copy link
Contributor

Choose a reason for hiding this comment

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

this can probably be omitted, as version 1.0.0 is set as default.

builderOptions: {
format: true
}
Expand All @@ -935,6 +944,7 @@ describe('SldStyleParser implements StyleParser', () => {
});
it('adds unsupportedProperties to the write output', async () => {
const styleParserOrder = new SldStyleParser({
sldVersion: '1.0.0',
Copy link
Contributor

Choose a reason for hiding this comment

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

see comment above

builderOptions: {
format: true
}
Expand Down
15 changes: 11 additions & 4 deletions src/SldStyleParser.v1.1.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,11 @@ it('SldStyleParser is defined', () => {
expect(SldStyleParser).toBeDefined();
});

describe('SldStyleParser with Symbology Encoding implements StyleParser', () => {
describe('SldStyleParser with Symbology Encoding implements StyleParser (reading)', () => {
let styleParser: SldStyleParser;

beforeEach(() => {
styleParser = new SldStyleParser({
sldVersion: '1.1.0'
});
styleParser = new SldStyleParser();
});

describe('#readStyle', () => {
Expand Down Expand Up @@ -370,11 +368,20 @@ describe('SldStyleParser with Symbology Encoding implements StyleParser', () =>
});
});
});
});

describe('SldStyleParser with Symbology Encoding implements StyleParser (writing)', () => {
let styleParser: SldStyleParser;

beforeEach(() => {
styleParser = new SldStyleParser({sldVersion: '1.1.0'});
});

describe('#writeStyle', () => {
it('is defined', () => {
expect(styleParser.writeStyle).toBeDefined();
});

it('can write a SLD 1.1 PointSymbolizer', async () => {
const { output: sldString } = await styleParser.writeStyle(point_simplepoint);
expect(sldString).toBeDefined();
Expand Down
Loading