Skip to content

Commit 59301c3

Browse files
Findus23sgiehl
andauthored
more neutral wording and other style improvements (matomo-org#17540)
* more neutral wording and other style improvements * two more changes * updates expected test files Co-authored-by: sgiehl <[email protected]>
1 parent 937e666 commit 59301c3

File tree

8 files changed

+30
-31
lines changed

8 files changed

+30
-31
lines changed

PRIVACY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ In this section we document how to protect the privacy of visitors who are track
77

88
### Anonymise visitor IP addresses
99
By default, Matomo stores the visitor IP address (IPv4 or IPv6 format) in the database for each new visitor.
10-
If a visitor has a static IP address this means her browsing history can be easily identified across several days and
10+
If a visitor has a static IP address this means their browsing history can be easily identified across several days and
1111
even across several websites tracked within the same Matomo server. You can anonymize IP addresses to ensure visitors cannot
1212
be tracked this way: [How to anonymise IP addresses.](https://matomo.org/docs/privacy/#step-1-automatically-anonymize-visitor-ips)
1313

config/global.ini.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@
352352
; or make sure the date ranges users' want to see will be processed somehow.
353353
archiving_range_force_on_browser_request = 1
354354

355-
; By default Matomo will automatically archive all date ranges any user has chosen in his account settings.
355+
; By default Matomo will automatically archive all date ranges any user has chosen in their account settings.
356356
; This is limited to the available options last7, previous7, last30 and previous30.
357357
; If you need any other period, or want to ensure one of those is always archived, you can define them here
358358
archiving_custom_ranges[] =

core/Tracker/ScheduledTasksRunner.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function runScheduledTasks()
4343
// this could be too aggressive minimum interval (some hours would be skipped in case of low traffic)
4444
$minimumInterval = TrackerConfig::getConfigValue('scheduled_tasks_min_interval');
4545

46-
// If the user disabled browser archiving, he has already setup a cron
46+
// If the user disabled browser archiving, they have already setup a cron
4747
// To avoid parallel requests triggering the Scheduled Tasks,
4848
// Get last time tasks started executing
4949
$cache = Cache::getCacheGeneral();

js/piwik.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -5958,7 +5958,7 @@ if (typeof window.Matomo !== 'object') {
59585958
*
59595959
* When you call this method, we imply that the user has given cookie consent for this page view, and will also
59605960
* imply consent for all future page views unless the cookie expires or the user
5961-
* deletes all her or his cookies. Remembering cookie consent means even if you call {@link disableCookies()},
5961+
* deletes all their cookies. Remembering cookie consent means even if you call {@link disableCookies()},
59625962
* then cookies will still be enabled and it won't disable cookies since the user has given consent for cookies.
59635963
*
59645964
* Please note that this feature requires you to set the `cookieDomain` and `cookiePath` correctly. Please
@@ -6760,8 +6760,8 @@ if (typeof window.Matomo !== 'object') {
67606760

67616761
/**
67626762
* When called, no tracking request will be sent to the Matomo server until you have called `setConsentGiven()`
6763-
* unless consent was given previously AND you called {@link rememberConsentGiven()} when the user gave her
6764-
* or his consent.
6763+
* unless consent was given previously AND you called {@link rememberConsentGiven()} when the user gave their
6764+
* consent.
67656765
*
67666766
* This may be useful when you want to implement for example a popup to ask for consent before tracking the user.
67676767
* Once the user has given consent, you should call {@link setConsentGiven()} or {@link rememberConsentGiven()}.
@@ -6842,7 +6842,7 @@ if (typeof window.Matomo !== 'object') {
68426842
*
68436843
* When you call this method, we imply that the user has given consent for this page view, and will also
68446844
* imply consent for all future page views unless the cookie expires (if timeout defined) or the user
6845-
* deletes all her or his cookies. This means even if you call {@link requireConsent()}, then all requests
6845+
* deletes all their cookies. This means even if you call {@link requireConsent()}, then all requests
68466846
* will still be tracked.
68476847
*
68486848
* Please note that this feature requires you to set the `cookieDomain` and `cookiePath` correctly and requires

plugins/UsersManager/Controller.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ protected function initViewAnonymousUserSettings($view)
447447
$anonymousDefaultReport = Piwik::getLoginPluginName();
448448
} else {
449449
// we manually imitate what would happen, in case the anonymous user logs in
450-
// and is redirected to the first website available to him in the list
450+
// and is redirected to the first website available to them in the list
451451
// @see getDefaultWebsiteId()
452452
$anonymousDefaultReport = '1';
453453
$anonymousDefaultSite = $anonymousSites[0]['key'];

tests/README.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
Piwik comes with unit tests, integration tests, system tests, Javascript tests and UI tests.
2-
This document briefly describes how to use and modify Piwik tests.
1+
Matomo comes with unit tests, integration tests, system tests, Javascript tests and UI tests.
2+
This document briefly describes how to use and modify Matomo tests.
33

44
## Continuous Integration
55

66
We use Travis CI for our continuous integration server. It automatically runs our battery of thousands of unit/integration/screenshot tests
77
after each commit to our GIT repo. More information at the links:
88

9-
* Piwik on Travis CI: https://travis-ci.org/piwik/piwik
10-
* QA in Piwik: https://matomo.org/qa/
9+
* Matomo on Travis CI: https://travis-ci.com/matomo-org/matomo
1110

12-
Each core Piwik developer is responsible to keep the build green. If a developer breaks the build, he will receive an email from Travis CI.
11+
Each core Matomo developer is responsible to keep the build green. If a developer breaks the build, they will receive an E-Mail from Travis CI.
1312

1413
The next section explains how you can run the test suite on your own dev machine.
1514

16-
## How To Run Piwik Tests
15+
## How To Run Matomo Tests
1716

18-
To run tests, you must install Piwik via Git and set it up for development. A guide for this is available in our [Developer Zone](http://developer.piwik.org/guides/getting-started-part-1). The part about "Creating a plugin" can be skipped.
17+
To run tests, you must install Matomo via Git and set it up for development. A guide for this is available in our [Developer Zone](https://developer.matomo.org/guides/getting-started-part-1). The part about "Creating a plugin" can be skipped.
1918

2019
To execute the tests:
2120

@@ -29,21 +28,21 @@ To execute the tests:
2928

3029
## PHPUnit Tests
3130

32-
1. To install PHPUnit, run `php composer.phar install --dev` in the Piwik root directory.
31+
1. To install PHPUnit, run `php composer.phar install --dev` in the Matomo root directory.
3332

34-
2. Ensure the `[database_tests]` section in `piwik/config/config.ini.php` is set up correctly,
33+
2. Ensure the `[database_tests]` section in `matomo/config/config.ini.php` is set up correctly,
3534
i.e. with the correct password to prevent the following error:
3635
`SQLSTATE[28000] [1045] Access denied for user 'root'@'localhost' (using password: NO)`
3736

3837
3. Run the tests
3938

40-
$ cd /path/to/piwik
39+
$ cd /path/to/matomo
4140
$ ./console tests:run --testsuite unit
4241
$ ./console tests:run --testsuite integration
4342
$ ./console tests:run --testsuite system
4443

4544
There are also two main groups of tests: core and plugins
46-
For example run `./console tests:run core` to run all Core Piwik tests.
45+
For example run `./console tests:run core` to run all Core Matomo tests.
4746

4847
You can combine testsuite and groups like this:
4948
`./console tests:run --testsuite unit core`. This would run all unit tests in core.
@@ -69,7 +68,7 @@ your test will be really fast.
6968
It is an integration test if you have any dependency to a loaded plugin, to the filesystem, web, config, database or something
7069
similar. It is an integration test if you test multiple classes in one test.
7170

72-
It is a system test if you - for instance - make a call to Piwik itself via HTTP or CLI and the whole system is being tested.
71+
It is a system test if you - for instance - make a call to Matomo itself via HTTP or CLI and the whole system is being tested.
7372

7473
### Why do we split tests in unit, integration, system and ui folders?
7574

@@ -88,14 +87,14 @@ not tested they would be still marked as tested when running integration tests.
8887

8988
System tests files are in `tests/PHPUnit/System/*Test.php`
9089

91-
System tests allow to test how major Piwik components interact together.
90+
System tests allow to test how major Matomo components interact together.
9291
A test will typically generate hits to the Tracker (record visits and page views)
9392
and then test all API responses and for each API output. It then checks that they match expected XML (or CSV, json, etc.).
9493
If a test fails, you can compare the processed/ and expected/ directories in a graphical text compare tool, such as WinMerge on Win, or MELD on Linux, or even with PhpStorm, to easily view changes between files.
9594

9695
For example using Meld, click on "Start new comparison", "Directory comparison",
97-
in "Original" select "path/to/piwik/tests/PHPUnit/System/expected"
98-
in "Mine" select "path/to/piwik/tests/PHPUnit/System/processed"
96+
in "Original" select "path/to/matomo/tests/PHPUnit/System/expected"
97+
in "Mine" select "path/to/matomo/tests/PHPUnit/System/processed"
9998

10099
If changes are expected due to the code changes you make, simply copy the file from processed/ to expected/, and test will then pass. Copying files is done easily using Meld (ALT+LEFT).
101100
Otherwise, if you didn't expect to modify the API outputs, it might be that your changes are breaking some features unexpectedly.
@@ -133,11 +132,11 @@ If you use Ubuntu or another Linux distribution, you must make one change to the
133132

134133
## JavaScript Tests
135134

136-
piwik.js is unit tested and you can run the Javascript tests at: /piwik/tests/javascript/
135+
piwik.js is unit tested and you can run the Javascript tests at: /matomo/tests/javascript/
137136

138137
## Testing Data
139138

140-
See [tests/README.testing-data.md](https://github.com/matomo-org/matomo/blob/master/tests/README.testing-data.md) to import testing data in Piwik.
139+
See [tests/README.testing-data.md](https://github.com/matomo-org/matomo/blob/master/tests/README.testing-data.md) to import testing data in Matomo.
141140

142141
## UI Screenshots Tests
143142

@@ -151,7 +150,7 @@ You can retrieve the files generated during the build (the build artifacts) at [
151150

152151
### Test logs on CI
153152

154-
By default tests running on Travis CI will log all messages of at least `INFO` level in `$PIWIK_ROOT_DIR/tmp/logs/piwik.log`. In a given travis build output, you can view the logs by clicking on the line `$ cat $PIWIK_ROOT_DIR/tmp/logs/matomo.log` at the end of the build output text.
153+
By default tests running on Travis CI will log all messages of at least `INFO` level in `$PIWIK_ROOT_DIR/tmp/logs/matomo.log`. In a given travis build output, you can view the logs by clicking on the line `$ cat $PIWIK_ROOT_DIR/tmp/logs/matomo.log` at the end of the build output text.
155154

156155
Note: `DEBUG` and `VERBOSE` messages are not logged by default (to keep Travis page loading fast). At any time you can temporarily enable logging by [modifying this file](https://github.com/matomo-org/matomo/blob/master/tests/PHPUnit/config.ini.travis.php#L23-27) and changing `log_level = info` to `log_level = debug` or `log_level = verbose`.
157156

@@ -176,7 +175,7 @@ See [tests/PHPUnit/Benchmarks/README.md](https://github.com/matomo-org/matomo/bl
176175

177176
### Profiling
178177

179-
See [tests/README.xhprof.md](https://github.com/matomo-org/matomo/blob/master/tests/README.xhprof.md) for help on how to profile Piwik with XHProf.
178+
See [tests/README.xhprof.md](https://github.com/matomo-org/matomo/blob/master/tests/README.xhprof.md) for help on how to profile Matomo with XHProf.
180179

181180

182181

Loading
Loading

0 commit comments

Comments
 (0)