Skip to content

Commit

Permalink
Replace some non-inclusive language (#354)
Browse files Browse the repository at this point in the history
* replaced master

* changed whitelist/blacklist

* fixed travis.yml

* fixed circleci
  • Loading branch information
jwpgage authored Sep 4, 2020
1 parent 6edbe19 commit 5be577e
Show file tree
Hide file tree
Showing 91 changed files with 462 additions and 473 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ version: 2
general:
branches:
only:
- master
- main
- dev
jobs:
build:
Expand Down
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ env:
- ENCRYPTED_GPG_KEY_LOCATION=".travis/secring.gpg.enc"
branches:
only:
- master
- main
- dev
language: java
dist: xenial
Expand All @@ -31,6 +31,6 @@ script:
- chmod -R ug+x .travis
- .travis/build.sh
- .travis/sonar-gate.sh
- .travis/merge-dev-to-master-gate.sh
- .travis/merge-dev-to-main-gate.sh
- .travis/deploy-gate.sh
- .travis/tag-master-gate.sh
- .travis/tag-main-gate.sh
2 changes: 1 addition & 1 deletion .travis/deploy.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env sh

if [ "$TRAVIS_BRANCH" = "master" ] && [ "$TRAVIS_PULL_REQUEST" = "false" ];
if [ "$TRAVIS_BRANCH" = "main" ] && [ "$TRAVIS_PULL_REQUEST" = "false" ];
then
if [ "$MANUAL_RELEASE_TRIGGERED" = "true" ];
then
Expand Down
2 changes: 1 addition & 1 deletion .travis/install.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env sh

if [ "$TRAVIS_BRANCH" = "master" ] && [ "$TRAVIS_PULL_REQUEST" = "false" ];
if [ "$TRAVIS_BRANCH" = "main" ] && [ "$TRAVIS_PULL_REQUEST" = "false" ];
then
openssl aes-256-cbc -K $encrypted_2214f55a5f38_key -iv $encrypted_2214f55a5f38_iv -in $ENCRYPTED_GPG_KEY_LOCATION -out $GPG_KEY_LOCATION -d
fi
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

if [ $TRAVIS_TEST_RESULT -eq 0 ];
then
.travis/merge-dev-to-master.sh
.travis/merge-dev-to-main.sh
RETURN_VALUE=$?
if [ "$RETURN_VALUE" != "0" ];
then
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env sh

GITHUB_REPO="osmlab/atlas-checks"
MERGE_BRANCH=master
MERGE_BRANCH=main
SOURCE_BRANCH=dev

FUNCTION_NAME="merge-$SOURCE_BRANCH-to-$MERGE_BRANCH"
Expand All @@ -23,7 +23,7 @@ then
fi

: ${GITHUB_SECRET_TOKEN:?"GITHUB_SECRET_TOKEN needs to be set in .travis.yml!"}
: ${TRAVIS_COMMIT:?"TRAVIS_COMMIT needs to be available to merge the right commit to master!"}
: ${TRAVIS_COMMIT:?"TRAVIS_COMMIT needs to be available to merge the right commit to main!"}

TEMPORARY_REPOSITORY=$(mktemp -d)
git clone "https://github.com/$GITHUB_REPO" "$TEMPORARY_REPOSITORY"
Expand Down
2 changes: 1 addition & 1 deletion .travis/tag-master-gate.sh → .travis/tag-main-gate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

if [ $TRAVIS_TEST_RESULT -eq 0 ];
then
.travis/tag-master.sh
.travis/tag-main.sh
RETURN_VALUE=$?
if [ "$RETURN_VALUE" != "0" ];
then
Expand Down
2 changes: 1 addition & 1 deletion .travis/tag-master.sh → .travis/tag-main.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env sh

GITHUB_REPO="osmlab/atlas-checks"
RELEASE_BRANCH=master
RELEASE_BRANCH=main

FUNCTION_NAME="tag-$RELEASE_BRANCH"

Expand Down
4 changes: 2 additions & 2 deletions .travis/trigger-release.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env sh

# Use Travis to trigger a release from Master
# Use Travis to trigger a release from Main

GITHUB_ORGANIZATION=osmlab
GITHUB_REPOSITORY_NAME=atlas-checks
Expand All @@ -18,7 +18,7 @@ body='
{
"request":
{
"branch": "master",
"branch": "main",
"config":
{
"before_script": "export MANUAL_RELEASE_TRIGGERED=true"
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Atlas Checks

[![Build Status](https://travis-ci.org/osmlab/atlas-checks.svg?branch=master)](https://travis-ci.org/osmlab/atlas-checks)
[![Build Status](https://travis-ci.org/osmlab/atlas-checks.svg?branch=main)](https://travis-ci.org/osmlab/atlas-checks)
[![quality gate](https://sonarcloud.io/api/project_badges/measure?project=org.openstreetmap.atlas%3Aatlas-checks&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.openstreetmap.atlas%3Aatlas-checks)
[![Maven Central](https://img.shields.io/maven-central/v/org.openstreetmap.atlas/atlas-checks.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.openstreetmap.atlas%22%20AND%20a:%22atlas-checks%22)
[![CircleCI](https://circleci.com/gh/osmlab/atlas-checks/tree/master.svg?style=svg)](https://circleci.com/gh/osmlab/atlas-checks/tree/master)
[![CircleCI](https://circleci.com/gh/osmlab/atlas-checks/tree/main.svg?style=svg)](https://circleci.com/gh/osmlab/atlas-checks/tree/main)

---

Expand Down
2 changes: 1 addition & 1 deletion config/configuration.json
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
},
"ConnectivityCheck": {
"nearby.edge.distance.meters": 2.0,
"blacklisted.highway.filter": "highway->no",
"denylisted.highway.filter": "highway->no",
"challenge": {
"description": "Checks if a node should be connected to a nearby node or edge.",
"blurb": "Connectivity Check",
Expand Down
4 changes: 2 additions & 2 deletions dependencies.gradle
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
project.ext.versions = [
checkstyle: '8.18',
jacoco: '0.8.3',
atlas: '6.2.4',
atlas: '6.2.8',
commons:'2.6',
atlas_generator: '5.0.3',
atlas_generator: '5.1.6',
atlas_checkstyle: '5.6.9',
postgis: '2.1.7.2',
postgres: '42.2.6',
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/RoadNameSpellingConsistencyCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The check provides the user with a collection of flagged road segments and their

### Code Review

The check starts by ensuring a given AtlasObject is a named Master Edge that has not been flagged and is of a high enough HighwayTag priority. The check then collects all Edges that have a common connection to the starting Edge and are also within a configurable search area. The collected Edges are filtered for those that have names that are at an edit distance of 1 from the starting Edge's name. However, there are exceptions in this process. If two Edges' names contain different numbers or space-delimited characters, they are not considered to have inconsistent spelling with one another and are not flagged.
The check starts by ensuring a given AtlasObject is a named Main Edge that has not been flagged and is of a high enough HighwayTag priority. The check then collects all Edges that have a common connection to the starting Edge and are also within a configurable search area. The collected Edges are filtered for those that have names that are at an edit distance of 1 from the starting Edge's name. However, there are exceptions in this process. If two Edges' names contain different numbers or space-delimited characters, they are not considered to have inconsistent spelling with one another and are not flagged.
Any Edges whose names are within 1 edit distance of each other are flagged.

For the source code for this check, please refer to [RoadNameSpellingConsistencyCheck](../../src/main/java/org/openstreetmap/atlas/checks/validation/tag/RoadNameSpellingConsistencyCheck.java)
2 changes: 1 addition & 1 deletion docs/checks/approximateWayCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This check evaluates [Edges](https://github.com/osmlab/atlas/blob/dev/src/main/j
##### Validating the Object
We first validate that the incoming object is:
* An Edge
* A Master edge
* A Main edge
* The Edge is Car Navigable
* The Edge is of a specified minimum highway type

Expand Down
2 changes: 1 addition & 1 deletion docs/checks/bridgeDetailedInfoCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Way [id:4407849](https://www.openstreetmap.org/way/4407849) represents a promine
The validation section ensures that the Atlas object being evaluated is an [Edge](https://github.com/osmlab/atlas/blob/dev/src/main/java/org/openstreetmap/atlas/geography/atlas/items/Edge.java) with the following tags:
* `bridge=yes`
* `railway` -or- `highway` with one of the values: `motorway`, `trunk`, `primary`, `secondary`.
Only _master_ Edges are valid candidates for this check, to avoid duplicate flags on a single bi-directional Way.
Only _main_ Edges are valid candidates for this check, to avoid duplicate flags on a single bi-directional Way.

The check section flags a valid candidate Edge if it is longer than the configurable minimum but does not have a `bridge:structure` tag.

Expand Down
10 changes: 5 additions & 5 deletions docs/checks/duplicateWaysCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We’ll use this information to filter our potential flag candidates.

Our first goal is to validate the incoming Atlas Object. We know two things about roundabouts:
* Must be a valid Edge
* Must be a master Edge
* Must be a main Edge
* Must be car-navigable
* Must not be part of an area
* Must have not already been flagged
Expand All @@ -32,8 +32,8 @@ Our first goal is to validate the incoming Atlas Object. We know two things abou
public boolean validCheckForObject(final AtlasObject object)
{
return object instanceof Edge
// Check to see that the Edge is a master Edge
&& Edge.isMasterEdgeIdentifier(object.getIdentifier())
// Check to see that the Edge is a main Edge
&& Edge.isMainEdgeIdentifier(object.getIdentifier())
// Check to see that the edge has not already been seen
&& !this.isFlagged(object.getIdentifier())
// Check to see that the edge is car navigable
Expand All @@ -55,9 +55,9 @@ statements to validate whether we do in fact want to flag the feature for inspec

final Rectangle bounds = edge.asPolyLine().bounds();
// Get Edges which are contained by or intersect the bounds, and then filter
// Out the non-master Edges as the bounds Edges are not guaranteed to be uni-directional
// Out the non-main Edges as the bounds Edges are not guaranteed to be uni-directional
final Iterable<Edge> edgesInBounds = edge.getAtlas().edgesIntersecting(bounds,
Edge::isMasterEdge);
Edge::isMainEdge);

for (final Edge edgeInBounds : edgesInBounds)
{
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/highwayToFerryTagCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ has *route=FERRY* and *highway=TERTIARY* Tags. Since this is a ferry route, the
In Atlas, OSM elements are represented as Points, Lines, Edges, Areas and Relations. In our case, we're
looking at edges.
The incoming Atlas object must meet the following criteria to be considered for flagging:
* Has to be a Master Edge and its OSM id should not have already been flagged
* Has to be a Main Edge and its OSM id should not have already been flagged
* Has a *route=FERRY* Tag
* Has a highway Tag with priority greater than or equal to a minimum highway type. The default
minimum highway type is PATH which includes MOTORWAY, MOTORWAY_LINK, TRUNK,TRUNK_LINK, PRIMARY,
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/invalidAccessTagCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In [Atlas](https://github.com/osmlab/atlas) roads can only be Edges and Lines, a
public boolean validCheckForObject(final AtlasObject object)
{
return AccessTag.isNo(object) && ((object instanceof Edge) || (object instanceof Line))
&& Edge.isMasterEdgeIdentifier(object.getIdentifier())
&& Edge.isMainEdgeIdentifier(object.getIdentifier())
&& !this.isFlagged(object.getOsmIdentifier()) && isMinimumHighway(object);
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/checks/invalidLanesTagCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public boolean validCheckForObject(final AtlasObject object)
{
return Validators.hasValuesFor(object, LanesTag.class)
&& HighwayTag.isCarNavigableHighway(object) && object instanceof Edge
&& ((Edge) object).isMasterEdge() && !this.lanesFilter.test(object)
&& ((Edge) object).isMainEdge() && !this.lanesFilter.test(object)
&& !this.isFlagged(object.getOsmIdentifier());
}
```
Expand Down Expand Up @@ -103,7 +103,7 @@ private HashSet<Edge> connectedInvalidLanes(final AtlasObject object)
polledEdge = toProcess.poll();
for (final Edge edge : polledEdge.connectedEdges())
{
if (!connectedEdges.contains(edge) && ((Edge) object).isMasterEdge()
if (!connectedEdges.contains(edge) && ((Edge) object).isMainEdge()
&& Validators.hasValuesFor(edge, LanesTag.class)
&& HighwayTag.isCarNavigableHighway(edge) && !this.lanesFilter.test(edge))
{
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/invalidMiniRoundaboutCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ meet the following conditions:
- Is a `Node` object
- Has the tag `highway=MINI_ROUNDABOUT`
- Has less than `valence.minimum` number of car-navigable connecting edges AND
- Has exactly two connecting edges and exactly one of those edges is a master edge OR
- Has exactly two connecting edges and exactly one of those edges is a main edge OR
- The node has neither `direction=CLOCKWISE` nor `direction=ANTICLOCKWISE` values

After performing sensitivity analysis, the best value for `valence.minimum` was determined to be 6,
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/malformedRoundaboutCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Our first goal is to validate the incoming Atlas Object. We know two things abou
* Must have an `iso_country_code` tag
* Must have not already been flagged
* Must have `junction=roundabout` tag
* Must be master edge
* Must be main edge
* Must not have a highway tag value of `cycleway`, `footway`, or `pedestrian`

After the preliminary filtering of features, we need to get all the roundabout's edges. We use a
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/roundaboutMissingTagCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In OpenStreetMap, roundabouts are [Ways](https://wiki.openstreetmap.org/wiki/Way
the `junction=roundabout` tag. We’ll identify ways that are roundabouts without `junction=roundabout` tag.

Our first goal is to validate the incoming Atlas Object.
* Must be a first section of valid master Edge
* Must be a first section of valid main Edge
* Must have not already been flagged
* Must be car navigable
* Must have not `junction` and `area` tag
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/roundaboutValenceCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In OpenStreetMap, roundabouts are [Ways](https://wiki.openstreetmap.org/wiki/Way
the `junction=roundabout` tag. We’ll use this information to filter our potential flag candidates.

Our first goal is to validate the incoming Atlas Object. We know two things about roundabouts:
* Must be a valid master Edge
* Must be a valid main Edge
* Must have not already been flagged
* Must have `junction=roundabout` tag
* Must be car navigable
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/singleSegmentMotorwayCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It is also connected to a roundabout tagged as motorway, but this is ignored (se
In [Atlas](https://github.com/osmlab/atlas), OSM elements are represented as Edges, Points, Lines, Nodes, Areas & Relations; in our case, we’re are looking at
[Edges](https://github.com/osmlab/atlas/blob/dev/src/main/java/org/openstreetmap/atlas/geography/atlas/items/Edge.java).

This check first validates object by checking that they are master Edges, tagged as motorways, not roundabouts, and their OSM id has not already been flagged.
This check first validates object by checking that they are main Edges, tagged as motorways, not roundabouts, and their OSM id has not already been flagged.

Next the valid objects have their connected edges checked to see if there are any tagged with motorway that are not roundabouts.
If none are found the edge is flagged.
Expand Down
2 changes: 1 addition & 1 deletion docs/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ In Intellij, a configuration is used to run a project. With the setup above you
- countries=[ISO3 country code comma separated list]
- maproulette=[Maproulette configuration in format "server:host:project:api_key"]
- saveCheckOutput=false
- master=local
- cluster=local
- configFiles=[Points to the configuration file, should be something like file:/atlas_checks_root_dir/config/configuration.json]
- sparkOptions=spark.executor.memory->4g,spark.driver.memory->4g,spark.rdd.compress->true
Expand Down
2 changes: 1 addition & 1 deletion docs/shardedchecks.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The following are brief descriptions of the parameters that Sharded Atlas Checks
| Output Formats | Comma separated list of output types (flags,geojson,metrics,tippecanoe); MapRoulette output is not available in Sharded Checks |
| Countries | Comma separated list of ISO3 country codes of countries to run |
| Configuration File | Comma separated list of resource URIs for checks configuration json files |
| Master | Spark cluster master URL (just `local` for local environments) |
| Cluster | Spark cluster URL (just `local` for local environments) |

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion docs/standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Atlas Checks locally. The following variables are set in the [gradle.properties]
- checks.local.outputFormat - Which output formats to produced.
- checks.local.startedFolder - A folder used for Spark to work in, this should generally remain unchanged.
- checks.local.countries - The country that is being used to run the checks over. Currently for local standalone this is limited to a single country.
- checks.local.master - This defines the master URL for the cluster, for running locally this should never be changed and remain "local".
- checks.local.cluster - This defines the URL for the cluster, for running locally this should never be changed and remain "local".
- checks.local.sparkOptions - Any custom options that are subsequently sent to Spark. See [Spark Configuration](https://spark.apache.org/docs/1.6.0/configuration.html) for more information.
- checks.local.compressOutput - Whether to create compressed output files or not.

Expand Down
7 changes: 2 additions & 5 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
group=org.openstreetmap.atlas
version=6.0.12-SNAPSHOT

maven2_url=https://oss.sonatype.org/service/local/staging/deploy/maven2/
snapshot_url=https://oss.sonatype.org/content/repositories/snapshots/
project_name="OSM Atlas Checks"
project_description="Tool to run data checks over OSM Atlas data"
project_url=https://github.com/osmlab/atlas-checks
project_license_url=https://github.com/osmlab/atlas-checks/blob/master/LICENSE
project_license_url=https://github.com/osmlab/atlas-checks/blob/main/LICENSE
project_license_slug="BSD 3 Clause"
project_developer=matthieun
project_scm=scm:git:https://github.com/osmlab/atlas-checks.git

# Run profiles
profile=local

## Local (default)
checks.local.sharded=true
checks.local.configFiles=file://@ROOTDIR@/config/configuration.json
Expand All @@ -25,6 +22,6 @@ checks.local.countries=BLZ
checks.local.savePbfAtlas=true
checks.local.compressOutput=false
checks.local.startedFolder=file://@BUILDDIR@/example/tmp/
checks.local.master=local
checks.local.cluster=local
checks.local.multiAtlas=true
checks.local.sparkOptions=spark.executor.memory->4g,spark.driver.memory->4g,spark.rdd.compress->true
Loading

0 comments on commit 5be577e

Please sign in to comment.