Skip to content
This repository has been archived by the owner on Mar 7, 2019. It is now read-only.

Latest commit

 

History

History
73 lines (59 loc) · 2.74 KB

README.md

File metadata and controls

73 lines (59 loc) · 2.74 KB

DEPRECATION NOTICE

This repository is no longer in use. Please see Mapzen Metro Extracts

metroextractor-cities

Build Status

This data is used to build the extracts found here: Mapzen Metro Extracts.

Extracts are built weekly. If you submit a pull for a new extract, it will not be available until the weekly build has completed. This typically takes place over the weekend.

Description

  • cities.json defines bounding boxes for various metro areas, which are used by chef-metroextractor to produce weekly extracts.

Contributing

You need to perform the following tasks for us to accept a pull request:

  • update cities.json with your changes
    • do not modify cities.geojson; it will be generated automatically when your pull request is merged.
  • run the included tests, which will validate:
  • the syntax of the json
  • that the bounding boxes being sumbitted are valid
  • that the bounding boxes for cities all fall within their encompassing upper level bounding box (e.g. north_america)
  • that there's nothing other than a float provided for the bounding box coordinates
  • the top/left/bottom/right bbox parameters should be carried out to the thousandths (three digits to the right of the decimal)

If you're unable to run the test suite locally, you can submit a pull request, but if the specs fail there will be a delay in getting your request resolved.

If in doubt, just submit an issue with your request rather than a pull request.

Running Tests

You will need to have a Ruby 2.x environment, then simply:

bundle install
bundle exec rake

Passing tests will look similar to the following:

Preparing sandbox
rm -rf /Users/grant/repos/mapzen/metroextractor-cities/spec/tmp
mkdir -p /Users/grant/repos/mapzen/metroextractor-cities/spec/tmp
cp -r Rakefile README.md spec/bbox_numeric_spec.rb spec/bbox_size_spec.rb spec/bbox_spec.rb spec/geojson_spec.rb spec/json_spec.rb spec/ruby_spec.rb spec/whitespace_spec.rb tasks/build_geojson.rb tasks/default.rb tasks/test.rb /Users/grant/repos/mapzen/metroextractor-cities/spec/tmp
Running rubocop
rubocop /Users/grant/repos/mapzen/metroextractor-cities/spec/tmp
Inspecting 11 files
...........

11 files inspected, no offenses detected
Checking cities.json for valid bbox's
OK
Validating cities.json bbox sizes
OK
Validating cities.json bbox input is numeric
OK
Validating cities.json syntax
OK
Checking cities.json for invalid whitespace
OK
Validating cities.geojson syntax
OK

License and Authors