@unvt/charites 0.1.1 → 0.1.4

package/test/build.spec.ts

@@ -3,34 +3,139 @@ import path from 'path'
 import fs from 'fs'
 import os from 'os'
 
-import { build } from '../src/commands/build'
+import { build, buildWatch } from '../src/commands/build'
 import { defaultValues } from '../src/lib/defaultValues'
 
 describe('Test for the `build.ts`.', () => {
+  const styleYaml = path.join(__dirname, 'data/style.yml')
+  const iconSource = path.join(__dirname, 'data/icons')
+  let tmpdir = ''
+  let styleJson = ''
 
-  const stylePath = path.join(__dirname, 'data/style.yml')
+  beforeEach(function () {
+    tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
+    styleJson = path.join(tmpdir, 'style.json')
+  })
 
-  it('Should convert `data/style.yml` to JSON.', () => {
-    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
-    const styleJson = path.join(tmpdir, 'style.json')
+  afterEach(function () {
+    const cleanup = [
+      'style.json',
+      'basic-white.png',
+      'basic-white.json',
+      'basic-white@2x.png',
+      'basic-white@2x.json',
+      'icons',
+    ]
+    cleanup.forEach((fileName) => {
+      if (fs.existsSync(fileName)) {
+        fs.rmSync(path.join(__dirname, '..', fileName), { recursive: true })
+      }
+    })
+  })
 
-    build(stylePath, styleJson, {provider: defaultValues.provider})
+  it('Should convert `data/style.yml` to JSON.', async () => {
+    await build(styleYaml, styleJson, { provider: defaultValues.provider })
 
     // The file should exists.
-    assert.deepEqual(true, !! fs.statSync(styleJson))
+    assert.deepEqual(true, !!fs.statSync(styleJson))
     assert.deepEqual(8, JSON.parse(fs.readFileSync(styleJson, 'utf-8')).version)
-  });
+  })
 
-  it('Should minify `data/style.yml` to JSON.', () => {
-
-    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
-    const styleJson = path.join(tmpdir, 'style.json')
-
-    build(stylePath, styleJson, {provider: defaultValues.provider, compactOutput: true})
+  it('Should minify `data/style.yml` to JSON.', async () => {
+    await build(styleYaml, styleJson, {
+      provider: defaultValues.provider,
+      compactOutput: true,
+    })
 
     const contents = fs.readFileSync(styleJson, 'utf-8')
     const lines = contents.split('\n').length
 
     assert.deepEqual(lines, 1)
-  });
-});
+  })
+
+  it('Should build command replace sprite url with the option `--sprite-url`.', async () => {
+    const expectedUrl = 'http://localhost:8080/icons'
+
+    await build(styleYaml, styleJson, {
+      provider: defaultValues.provider,
+      spriteUrl: expectedUrl,
+      spriteInput: iconSource,
+      spriteOutput: tmpdir,
+    })
+
+    assert.deepEqual(
+      expectedUrl,
+      JSON.parse(fs.readFileSync(styleJson, 'utf-8')).sprite,
+    )
+  })
+
+  it('Should build icons with the option `--sprite-url`. Icon file name is set by spriteUrl', async () => {
+    const expectedIconName = 'dark'
+    const expectedPng = path.join(tmpdir, `${expectedIconName}.png`)
+    const expectedJson = path.join(tmpdir, `${expectedIconName}.json`)
+
+    await build(styleYaml, styleJson, {
+      provider: defaultValues.provider,
+      spriteUrl: `http://localhost:8080/${expectedIconName}`,
+      spriteInput: iconSource,
+      spriteOutput: tmpdir,
+    })
+
+    assert.deepEqual(true, !!fs.statSync(expectedPng))
+    assert.deepEqual(true, !!fs.statSync(expectedJson))
+  })
+
+  it('Use sprite name that specified in style.json with no --sprite-url option', async () => {
+    const expectedIconName = 'basic-white' // from test/data/style.yml
+    const expectedPng = path.join(tmpdir, `${expectedIconName}.png`)
+    const expectedJson = path.join(tmpdir, `${expectedIconName}.json`)
+
+    await build(styleYaml, styleJson, {
+      provider: defaultValues.provider,
+      spriteInput: iconSource,
+      spriteOutput: tmpdir,
+    })
+
+    // The file should exists.
+    assert.deepEqual(true, !!fs.statSync(expectedPng))
+    assert.deepEqual(true, !!fs.statSync(expectedJson))
+  })
+
+  it('Should not create sprite when input directory is not exist.', async () => {
+    const noExistInputDir = path.join(__dirname, 'data/hellooooo')
+
+    try {
+      await build(styleYaml, styleJson, {
+        provider: defaultValues.provider,
+        spriteInput: noExistInputDir,
+        spriteOutput: tmpdir,
+      })
+    } catch (error) {
+      assert.deepEqual(true, !!error) // It should have something error.
+    }
+  })
+
+  it('Should watch `*.yml` and convert it to JSON', async () => {
+    const sleep = (ms: number) => new Promise((res) => setTimeout(res, ms))
+
+    const watcher = buildWatch(styleYaml, styleJson, {
+      provider: defaultValues.provider,
+    })
+    await sleep(500)
+    const yamlData1 = fs
+      .readFileSync(styleYaml, 'utf-8')
+      .replace('metadata: {}', 'metadata: aaa')
+    fs.writeFileSync(styleYaml, yamlData1)
+    await sleep(500)
+    await watcher.close()
+    assert.deepEqual(true, !!fs.statSync(styleJson))
+    assert.deepEqual(
+      'aaa',
+      JSON.parse(fs.readFileSync(styleJson, 'utf-8')).metadata,
+    )
+    const yamlData2 = fs
+      .readFileSync(styleYaml, 'utf-8')
+      .replace('metadata: aaa', 'metadata: {}')
+    fs.writeFileSync(styleYaml, yamlData2)
+  })
+})

package/test/convert.spec.ts

@@ -6,18 +6,17 @@ import os from 'os'
 import { convert } from '../src/commands/convert'
 
 describe('Test for the `convert.ts`.', () => {
-
   const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
   const jsonPath = path.join(__dirname, 'data/convert.json')
   const yamlPath = path.join(tmp, 'convert.yml')
   const layerPath = path.join(tmp, 'layers/background.yml')
 
   it('Should convert `data/convert.json` to YAML.', () => {
-
     convert(jsonPath, yamlPath)
     const yml = fs.readFileSync(yamlPath, 'utf-8')
 
-    assert.equal(`version: 8
+    assert.equal(
+      `version: 8
 name: example
 metadata: {}
 sources:
@@ -29,15 +28,16 @@ glyphs: https://glyphs.geolonia.com/{fontstack}/{range}.pbf
 layers:
   - !!inc/file layers/background.yml
 id: example
-`, yml)
-  });
+`,
+      yml,
+    )
+  })
 
   it('Should create layers directory.', () => {
-
     convert(jsonPath, yamlPath)
 
     const result = fs.existsSync(layerPath)
 
     assert.equal(true, result)
   })
-});
+})

package/test/data/icons/aerialway.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 17 17" height="17" width="17"><title>aerialway-11.svg</title><rect fill="none" x="0" y="0" width="17" height="17"></rect><rect x="1" y="1" rx="4" ry="4" width="15" height="15" stroke="#ffffff" style="stroke-linejoin:round;stroke-miterlimit:4;" fill="#ffffff" stroke-width="2"></rect><rect x="1" y="1" width="15" height="15" rx="4" ry="4" fill="#415cbd"></rect><path fill="#ffffff" transform="translate(3 3)" d="M9,4.5H6V3.1c0.1992-0.1183,0.3512-0.3021,0.43-0.52L9.5,2C9.7761,2,10,1.7761,10,1.5S9.7761,1,9.5,1
+	L6.25,1.61C5.8847,1.1957,5.2528,1.156,4.8386,1.5213C4.713,1.6321,4.6172,1.7726,4.56,1.93L1.5,2.5C1.2239,2.5,1,2.7239,1,3
+	s0.2239,0.5,0.5,0.5l3.25-0.61C4.8213,2.9732,4.9057,3.0442,5,3.1v1.4H2c-0.5523,0-1,0.4477-1,1V9c0,0.5523,0.4477,1,1,1h7
+	c0.5523,0,1-0.4477,1-1V5.5C10,4.9477,9.5523,4.5,9,4.5z M5,8.5H2.5v-3H5V8.5z M8.5,8.5H6v-3h2.5V8.5z"></path></svg>

package/test/data/init/init.yml

@@ -0,0 +1,6 @@
+version: 8
+name: My Style
+sprite: ''
+glyphs: ''
+sources: {}
+layers: []

package/test/data/init/init_metadata.yml

@@ -0,0 +1,60 @@
+version: 8
+name: My Style
+sprite: ''
+glyphs: ''
+sources:
+  tiles.mbtiles:
+    type: vector
+    tiles:
+      - https://optgeo.github.io/kokoromi-rw/zxy/{z}/{x}/{y}.pbf
+    minzoom: '0'
+    maxzoom: '15'
+layers:
+  - id: boundary
+    type: fill
+    source: tiles.mbtiles
+    source-layer: boundary
+    layout: {}
+    paint: {}
+  - id: building
+    type: fill
+    source: tiles.mbtiles
+    source-layer: building
+    layout: {}
+    paint: {}
+  - id: nature
+    type: fill
+    source: tiles.mbtiles
+    source-layer: nature
+    layout: {}
+    paint: {}
+  - id: place
+    type: fill
+    source: tiles.mbtiles
+    source-layer: place
+    layout: {}
+    paint: {}
+  - id: road
+    type: fill
+    source: tiles.mbtiles
+    source-layer: road
+    layout: {}
+    paint: {}
+  - id: route
+    type: fill
+    source: tiles.mbtiles
+    source-layer: route
+    layout: {}
+    paint: {}
+  - id: structure
+    type: fill
+    source: tiles.mbtiles
+    source-layer: structure
+    layout: {}
+    paint: {}
+  - id: water
+    type: fill
+    source: tiles.mbtiles
+    source-layer: water
+    layout: {}
+    paint: {}

package/test/data/init/init_tilejson.yml

@@ -0,0 +1,28 @@
+version: 8
+name: My Style
+sprite: ''
+glyphs: ''
+sources:
+  OpenStreetMap:
+    type: vector
+    url: >-
+      https://raw.githubusercontent.com/mapbox/tilejson-spec/master/3.0.0/example/osm.json
+layers:
+  - id: telephone
+    type: fill
+    source: OpenStreetMap
+    source-layer: telephone
+    layout: {}
+    paint: {}
+  - id: bicycle_parking
+    type: fill
+    source: OpenStreetMap
+    source-layer: bicycle_parking
+    layout: {}
+    paint: {}
+  - id: showers
+    type: fill
+    source: OpenStreetMap
+    source-layer: showers
+    layout: {}
+    paint: {}

package/test/data/init/init_tilejson_without_layers.yml

@@ -0,0 +1,9 @@
+version: 8
+name: My Style
+sprite: ''
+glyphs: ''
+sources:
+  Geography Class:
+    type: vector
+    url: https://a.tiles.mapbox.com/v3/aj.1x1-degrees.json
+layers: []

package/test/data/init/tilejson/init_decomposite.yml

@@ -0,0 +1,13 @@
+version: 8
+name: My Style
+sprite: ''
+glyphs: ''
+sources:
+  OpenStreetMap:
+    type: vector
+    url: >-
+      https://raw.githubusercontent.com/mapbox/tilejson-spec/master/3.0.0/example/osm.json
+layers:
+  - !!inc/file layers/telephone.yml
+  - !!inc/file layers/bicycle_parking.yml
+  - !!inc/file layers/showers.yml

package/test/data/init/tilejson/layers/bicycle_parking.yml

@@ -0,0 +1,6 @@
+id: bicycle_parking
+type: fill
+source: OpenStreetMap
+source-layer: bicycle_parking
+layout: {}
+paint: {}

package/test/data/init/tilejson/layers/showers.yml

@@ -0,0 +1,6 @@
+id: showers
+type: fill
+source: OpenStreetMap
+source-layer: showers
+layout: {}
+paint: {}

package/test/data/init/tilejson/layers/telephone.yml

@@ -0,0 +1,6 @@
+id: telephone
+type: fill
+source: OpenStreetMap
+source-layer: telephone
+layout: {}
+paint: {}

package/test/get-sprite-slug.spec.ts

@@ -0,0 +1,34 @@
+import { assert } from 'chai'
+import path from 'path'
+import fs from 'fs'
+import { getSpriteSlug } from '../src/lib/get-sprite-slug'
+
+const stylePath = path.join(__dirname, 'data/style.json')
+const styleJson = fs.readFileSync(stylePath, 'utf-8')
+
+describe('Test for the `get-sprite-slug.ts`.', () => {
+  it('should get sprite slug from style.json', async () => {
+    const spriteSlug = getSpriteSlug(JSON.parse(styleJson))
+
+    // the test/data/style.json sprit slug is basic-white
+    assert.deepEqual('basic-white', spriteSlug)
+  })
+
+  it("should return false with no icon's slug in url", async () => {
+    const styleObject = JSON.parse(styleJson)
+    const styleObject1 = styleObject
+    const styleObject2 = styleObject
+
+    styleObject.sprite = 'http://localhost:8080'
+    styleObject1.sprite = 'http://localhost:8080/'
+    styleObject2.sprite = ''
+
+    const spriteSlug = getSpriteSlug(styleObject)
+    const spriteSlug1 = getSpriteSlug(styleObject1)
+    const spriteSlug2 = getSpriteSlug(styleObject2)
+
+    assert.isFalse(spriteSlug)
+    assert.isFalse(spriteSlug1)
+    assert.isFalse(spriteSlug2)
+  })
+})

package/test/init.spec.ts

@@ -0,0 +1,151 @@
+import { assert } from 'chai'
+import path from 'path'
+import fs from 'fs'
+import os from 'os'
+import YAML from 'js-yaml'
+
+import { init, initOptions } from '../src/commands/init'
+
+describe('Test for the `init.ts`.', () => {
+  it('Should initialize default style.yml.', async () => {
+    const tempStylePath = path.join(__dirname, 'data/init/init.yml')
+    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
+    const styleYaml = path.join(tmpdir, 'style.yml')
+
+    await init(styleYaml, {})
+
+    // The file should exists.
+    assert.deepEqual(true, !!fs.statSync(styleYaml))
+    // the file should be the same with init.yml
+    assert.deepEqual(
+      YAML.load(fs.readFileSync(styleYaml, 'utf8')),
+      YAML.load(fs.readFileSync(tempStylePath, 'utf-8')),
+    )
+  })
+
+  it('Should initialize default composited style.yml from tilejson provided', async () => {
+    const tempStylePath = path.join(__dirname, 'data/init/init_tilejson.yml')
+    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
+    const styleYaml = path.join(tmpdir, 'style.yml')
+
+    const options: initOptions = {
+      tilejsonUrls:
+        'https://raw.githubusercontent.com/mapbox/tilejson-spec/master/3.0.0/example/osm.json',
+      compositeLayers: true,
+    }
+
+    await init(styleYaml, options)
+
+    // The file should exists.
+    assert.deepEqual(true, !!fs.statSync(styleYaml))
+    // the file should be the same with init_tilejson.yml
+    assert.deepEqual(
+      YAML.load(fs.readFileSync(styleYaml, 'utf8')),
+      YAML.load(fs.readFileSync(tempStylePath, 'utf-8')),
+    )
+  })
+
+  it('Should produce composited style.yml without layers if tilejson without vector_layers is specified', async () => {
+    const tempStylePath = path.join(
+      __dirname,
+      'data/init/init_tilejson_without_layers.yml',
+    )
+    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
+    const styleYaml = path.join(tmpdir, 'style.yml')
+
+    const options: initOptions = {
+      tilejsonUrls: 'https://a.tiles.mapbox.com/v3/aj.1x1-degrees.json',
+      compositeLayers: true,
+    }
+
+    await init(styleYaml, options)
+
+    // The file should exists.
+    assert.deepEqual(true, !!fs.statSync(styleYaml))
+    assert.deepEqual(
+      YAML.load(fs.readFileSync(styleYaml, 'utf8')),
+      YAML.load(fs.readFileSync(tempStylePath, 'utf-8')),
+    )
+  })
+
+  it('Should initialize default decomposited style.yml from tilejson provided', async () => {
+    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
+    const styleYaml = path.join(tmpdir, 'style.yml')
+
+    const options: initOptions = {
+      tilejsonUrls:
+        'https://raw.githubusercontent.com/mapbox/tilejson-spec/master/3.0.0/example/osm.json',
+      compositeLayers: false,
+    }
+
+    await init(styleYaml, options)
+
+    // The file should exists.
+    assert.deepEqual(true, !!fs.statSync(styleYaml))
+    // the file should be the same with init_tilejson.yml
+    assert.deepEqual(
+      fs.readFileSync(styleYaml, 'utf8'),
+      fs.readFileSync(
+        path.join(__dirname, 'data/init/tilejson/init_decomposite.yml'),
+        'utf-8',
+      ),
+    )
+    assert.deepEqual(
+      YAML.load(
+        fs.readFileSync(
+          path.join(tmpdir, 'layers/bicycle_parking.yml'),
+          'utf8',
+        ),
+      ),
+      YAML.load(
+        fs.readFileSync(
+          path.join(__dirname, 'data/init/tilejson/layers/bicycle_parking.yml'),
+          'utf-8',
+        ),
+      ),
+    )
+    assert.deepEqual(
+      YAML.load(
+        fs.readFileSync(path.join(tmpdir, 'layers/showers.yml'), 'utf8'),
+      ),
+      YAML.load(
+        fs.readFileSync(
+          path.join(__dirname, 'data/init/tilejson/layers/showers.yml'),
+          'utf-8',
+        ),
+      ),
+    )
+    assert.deepEqual(
+      YAML.load(
+        fs.readFileSync(path.join(tmpdir, 'layers/telephone.yml'), 'utf8'),
+      ),
+      YAML.load(
+        fs.readFileSync(
+          path.join(__dirname, 'data/init/tilejson/layers/telephone.yml'),
+          'utf-8',
+        ),
+      ),
+    )
+  })
+
+  it('Should initialize default decomposited style.yml from metadatajson provided', async () => {
+    const tempStylePath = path.join(__dirname, 'data/init/init_metadata.yml')
+    const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'charites-'))
+    const styleYaml = path.join(tmpdir, 'init_metadata.yml')
+
+    const options: initOptions = {
+      metadatajsonUrls:
+        'https://optgeo.github.io/kokoromi-rw/zxy/metadata.json',
+      compositeLayers: true,
+    }
+
+    await init(styleYaml, options)
+
+    // The file should exists.
+    assert.deepEqual(true, !!fs.statSync(styleYaml))
+    assert.deepEqual(
+      YAML.load(fs.readFileSync(styleYaml, 'utf8')),
+      YAML.load(fs.readFileSync(tempStylePath, 'utf-8')),
+    )
+  })
+})

package/test/validate-style.spec.ts

@@ -1,18 +1,20 @@
 import { assert } from 'chai'
+import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec/types'
 
 import { validateStyle } from '../src/lib/validate-style'
 
 describe('Test for the `validate-style.ts`.', () => {
   it('should validate as expected.', (done) => {
-    const style = {
+    // @ts-ignore
+    const style: StyleSpecification = {
       version: 8,
     }
 
     try {
       validateStyle(style)
-    } catch(error) {
-      assert.deepEqual(true, !! error) // It should have something error.
+    } catch (error) {
+      assert.deepEqual(true, !!error) // It should have something error.
       done()
     }
-  });
-});
+  })
+})

package/test/yaml-parser.spec.ts

@@ -8,18 +8,18 @@ describe('Test for the `yaml-parser.ts`.', () => {
     const yamlPath = path.join(__dirname, 'data/example.yml')
     const style = parser(yamlPath)
 
-    assert.deepEqual({
-      color: '#ff0000',
-      'stroke-width': 2,
-      background: '#ff0000',
-      backgroundColor: '#ffff00',
-      alias: '#ff0000',
-      fruits: [ 'apple', 'banana', '#ff0000' ],
-      names: [
-        "John",
-        "花子",
-        "#ff0000"
-      ]
-    }, style)
-  });
-});
+    assert.deepEqual(
+      {
+        // @ts-ignore
+        color: '#ff0000',
+        'stroke-width': 2,
+        background: '#ff0000',
+        backgroundColor: '#ffff00',
+        alias: '#ff0000',
+        fruits: ['apple', 'banana', '#ff0000'],
+        names: ['John', '花子', '#ff0000'],
+      },
+      style,
+    )
+  })
+})

package/tsconfig.json

@@ -15,5 +15,7 @@
     "module": "commonjs",
     "outDir": "./dist"
   },
-  "include": ["src/cli.ts"]
+  "include": [
+    "src/cli.ts"
+  ]
 }