1
0
mirror of https://github.com/dwaxweiler/connector-mobilizon synced 2025-06-05 21:59:25 +02:00

217 Commits

Author SHA1 Message Date
f0e955aa47 release version 1.1.0 2024-07-18 19:19:17 +02:00
80abd9a461 npm audit fix 2024-07-18 19:04:55 +02:00
fb1db8e836 update dependencies 2024-07-18 19:03:41 +02:00
db080657db confirm compatibility with WordPress 6.6 2024-07-18 18:51:47 +02:00
979ecbc91f upgrade gulp to version 5 2024-05-16 08:57:35 +01:00
08e80615c6 add note about API to description 2024-05-15 08:34:06 +01:00
526d57d1b2 add missing changelog entry 2024-05-15 08:32:32 +01:00
718d66506b update some dev dependencies 2024-05-15 08:31:06 +01:00
cccd1a78b5 add some spacing between event items 2024-05-14 10:30:42 +02:00
fa99821ffc fix undefined variable for both error views 2024-05-14 10:28:39 +02:00
7bc35a3923 mention use of GraphQL API 2024-05-13 14:23:37 +02:00
82800a9db3 clarify two steps in release procedure 2024-04-06 08:27:24 +02:00
46170377af prepare next release 2024-04-06 08:25:16 +02:00
5c1a186456 release version 1.0.0 2024-04-06 08:22:26 +02:00
7a0075e5ed clarify features 2024-04-06 07:50:47 +02:00
392d552dab npm audit fix 2024-04-06 07:42:42 +02:00
797a08cfb6 update dev dependencies 2024-04-06 07:41:15 +02:00
c5279a37f3 remove unused code and dependencies 2024-04-05 23:44:53 +02:00
99e58d0382 update dependencies 2024-04-05 23:39:30 +02:00
dc1949ba4c move requests to backend (#18) 2024-04-05 23:26:11 +02:00
3269ccca1a add missing readme changelog entry 2024-04-02 22:13:20 +02:00
2d91350cc9 prepare next release 2024-04-02 22:09:58 +02:00
e7fd47a346 release version 0.11.5 2024-04-02 22:09:20 +02:00
8d4e81878e confirm compatibility with WordPress 6.5 2024-04-02 22:02:55 +02:00
418dc829d0 document after-release step 2024-04-02 22:01:53 +02:00
a75d3a3915 prepare next release 2023-11-11 20:43:50 +01:00
d2fb67b5bc release version 0.11.4 2023-11-11 20:39:06 +01:00
a9f5205d78 remove Qodana Github action 2023-11-11 20:31:50 +01:00
25c76e4998 increase Node version number in Github action 2023-11-11 20:30:22 +01:00
6157cf3988 update dependencies 2023-11-11 20:28:16 +01:00
8644a7103c confirm compatibility with WordPress 6.4 2023-11-11 20:24:59 +01:00
4fd516bcf8 release version 0.11.3 2023-07-25 22:25:55 +02:00
238fdcf261 release version 0.11.2 2023-07-25 22:14:24 +02:00
eaf1ffa0c8 confirm compatibility with WordPress 6.3 2023-07-25 20:17:28 +02:00
48477a158e add missing changelog entry 2023-07-25 20:16:49 +02:00
9b4778b494 npm audit fix 2023-07-25 20:04:04 +02:00
60363d8a5c update dependencies 2023-07-25 20:03:31 +02:00
51ae9b9616 update dependencies 2023-05-07 18:00:02 +02:00
637142d00d release version 0.11.1 2023-05-07 17:46:27 +02:00
163d0d27a6 revert minimum PHP version to 7.4 to allow some more time for upgrading PHP 2023-05-07 17:41:36 +02:00
d0ada74642 release version 0.11.0 2023-03-29 23:00:36 +02:00
b242c33733 remove bootstrap from qodana.yaml 2023-03-29 22:47:59 +02:00
cac233ec45 set minimum PHP version to 8.0 2023-03-29 22:32:29 +02:00
9e394ac837 confirm compatibility with WP 6.2 2023-03-29 22:30:45 +02:00
b2811ad169 update dependencies 2023-03-29 22:26:44 +02:00
40f351efbf prefer online 2023-02-16 08:10:10 +01:00
ad0a9f77f8 ignore scripts too 2023-02-16 08:04:32 +01:00
76a2217582 use npm ci in qodana instead 2023-02-16 08:00:01 +01:00
742b16808c add qodana.yaml 2023-02-16 07:57:10 +01:00
41419e6550 Merge pull request #14 from wordpress-connector-for-mobilizon/update-deps
Update dependencies
2023-02-12 18:13:49 +01:00
ab7e7274d0 fix versions 2023-02-12 18:11:24 +01:00
b7742d3803 npm audit fix 2023-02-12 18:05:30 +01:00
e5dc313f6c update luxon 2023-02-12 18:02:33 +01:00
3b4c53da81 update dev deps 2023-02-12 17:56:48 +01:00
87434fc1c1 add qodana 2023-02-12 17:20:20 +01:00
81c4759a9e release version 0.10.1 2022-10-26 23:41:32 +02:00
ad5f1753cb change node version of test pipeline 2022-10-26 23:34:03 +02:00
6cde75b65c npm audit fix 2022-10-26 23:32:23 +02:00
5a3550568c update dependencies 2022-10-26 23:31:05 +02:00
23390db0a9 update dev dependencies 2022-10-26 23:18:39 +02:00
4d5acc3714 confirm compatibility with WordPress 6.1 2022-10-26 22:57:39 +02:00
72df79b092 add note to release procedure about adding new files in SVN 2022-06-19 09:52:14 +02:00
d1be3b169d release version 0.10.0 2022-06-19 09:48:06 +02:00
5af00fc85e reuse constant 2022-06-19 09:30:36 +02:00
f76653f05c remove unused Gutenberg block editor dependency 2022-06-19 09:24:42 +02:00
995f6681e6 split up release procedure step to be clearer 2022-06-19 09:19:58 +02:00
a6f0bd9584 update dev dependencies 2022-06-19 09:18:45 +02:00
59970db3b8 add comma 2022-06-10 12:37:17 +02:00
d2e3c55e1a add missing changelog entry 2022-06-10 12:33:45 +02:00
99d97c5a5e update dev dependencies 2022-06-09 20:24:32 +02:00
64a61426e0 fix typo 2022-06-09 20:24:04 +02:00
3f09fbb563 create installation section in readme.txt 2022-06-09 20:16:07 +02:00
3360a9e7a7 add Gutenberg events list block 2022-06-09 20:09:08 +02:00
c042851184 Merge branch 'main' into block 2022-06-03 23:32:46 +02:00
09a47029f3 add missing changelog entries to readme.txt 2022-05-19 18:30:10 +02:00
977d7e57c6 release version 0.9.1 2022-05-19 18:27:06 +02:00
e84a4cfc73 real fix 2022-05-19 18:25:38 +02:00
eb10341337 fix WordPress compatibility version number 2022-05-19 18:22:04 +02:00
f769d5d8c1 release version 0.9.0 2022-05-19 18:16:17 +02:00
f54126babc confirm compatibility with WordPress 6.0 2022-05-19 18:09:37 +02:00
7dab9d71c6 update dependencies 2022-05-19 18:02:49 +02:00
0479deca56 improve explanation of group name filter 2022-05-19 08:39:20 +02:00
c51610b054 fix displaying error message for the case the group is not found 2022-05-19 08:08:21 +02:00
367a1c97b2 update changelog 2022-03-20 10:27:30 +01:00
01c5f19e39 switch to exact version number dependencies 2022-03-20 10:25:05 +01:00
42c2c945ba npm audit fix 2022-03-20 10:23:31 +01:00
9311fb42bb update dependencies 2022-03-20 10:21:38 +01:00
ba3b069527 update dev dependencies 2022-03-20 10:15:34 +01:00
87a55e5302 update dev dependencies 2022-02-18 16:30:46 +01:00
dd42ebf712 release version 0.8.0 2022-01-09 13:10:38 +01:00
0c6bf3d3a4 npm audit fix 2022-01-09 12:59:52 +01:00
77b58ccf07 add changelog reference to README 2022-01-09 12:58:27 +01:00
184d5627a3 trim events' location, change variable name 2022-01-09 12:54:58 +01:00
ec12889815 add babel 2022-01-09 12:35:26 +01:00
4270145a55 update changelog 2022-01-09 12:16:38 +01:00
3ed5129cd2 update dependency luxon 2022-01-09 12:14:49 +01:00
6dca75b2ce update dev dependencies c8, lint-staged 2022-01-09 12:13:15 +01:00
647629b5a9 update dev dependencies ava, eslint, eslint-plugin-ava and migrate to ES modules 2022-01-09 12:11:24 +01:00
fa91324f18 confirm compatibility with WordPress 5.9 2022-01-05 17:45:40 +01:00
c47ed3385d release version 0.7.0 2021-12-23 17:51:22 +01:00
740e59ea66 improve a changelog entry 2021-12-23 17:17:59 +01:00
a287d93b9f Fix Invalid DateTime on event end time being null 2021-12-23 17:16:03 +01:00
688868cbe9 update dependencies graphql, luxon 2021-12-23 16:49:43 +01:00
924aa095ff update dev dependencies copy-webpack-plugin, lint-staged 2021-12-23 16:44:50 +01:00
876c3e3840 Merge branch 'main' into block 2021-12-14 17:54:47 +01:00
d5419448e1 remove unneeded folder 2021-12-14 17:51:13 +01:00
53d08e7174 Merge branch 'main' into block 2021-12-14 15:33:07 +01:00
d32320a540 remove bartlett/php-compatinfo 2021-12-09 19:58:45 +01:00
acf86e42f5 add eslint and prettier to pre-commit hook 2021-12-09 19:54:38 +01:00
35e29cf793 add prettier 2021-12-09 19:46:19 +01:00
b0f4ea8d7a add missing test change 2021-12-09 19:05:29 +01:00
34aaaa7db9 add group not found error message #11 2021-12-09 19:03:00 +01:00
80dd0c9c50 update changelog too 2021-12-09 18:35:38 +01:00
f8583423a4 set minimum PHP version to oldest officially supported 7.4 2021-12-09 18:34:46 +01:00
86ed058363 update dependencies graphql, graphql-request 2021-12-09 18:23:57 +01:00
2033cc7328 prevent husky from being installed in CI 2021-12-09 18:20:03 +01:00
fad14485bd add husky and pre-commit hook to run tests 2021-12-09 18:14:16 +01:00
8d4735f138 update dev dependencies copy-webpack-plugin, eslint, jsdom, webpack 2021-12-09 18:09:25 +01:00
2b9cde92ac npm audit fix 2021-11-10 21:36:12 +01:00
51686efe93 update dependencies graphql, luxon 2021-11-09 22:23:48 +01:00
78f7c693e8 update dev dependencies eslint, webpack 2021-11-09 22:19:18 +01:00
632cdfdb0d add missing changelog entry 2021-11-09 22:11:49 +01:00
af46fe974f use webpack directly and npm scripts more in general 2021-11-09 22:10:35 +01:00
4417ae78b6 update jsdom, webpack 2021-11-01 21:19:15 +01:00
b487013cac refactor entry file 2021-11-01 21:17:10 +01:00
2725707296 use const instead of let 2021-11-01 21:06:07 +01:00
0b7021942e add basic block 2021-11-01 20:55:37 +01:00
0ed7a57a01 Update codeql-analysis.yml 2021-10-26 20:39:14 +02:00
4abde347a4 update dependencies graphql, graphql-request, and changelog 2021-10-26 20:33:56 +02:00
036fd1da41 update dev dependencies c8, eslint, eslint-plugin-ava, jsdom, webpack, webpack-cli, webpack-stream 2021-10-26 20:11:16 +02:00
d1617fed00 add composer commands 2021-08-26 22:30:43 +02:00
fada60e0b8 set minimum PHP version to oldest officially supported 7.3 2021-08-26 22:30:18 +02:00
07534e08ea release version 0.6.2 2021-08-24 19:35:10 +02:00
32e87115b3 fix empty WordPress timezone_string option resulting in Invalid DateTime [#10] 2021-08-24 19:23:57 +02:00
cee386acd2 update webpack(-cli) 2021-08-24 18:12:09 +02:00
70e0d96e1f upgrade to Luxon 2.x [#9] 2021-08-24 18:10:23 +02:00
4707fedee0 npm audit fix 2021-08-15 21:51:31 +02:00
0b6350f03e update graphql-request 2021-08-15 21:49:14 +02:00
39b6800e97 update dev dependencies 2021-08-15 21:47:34 +02:00
da9afa64c8 ignore .idea folder 2021-08-15 21:26:37 +02:00
53393ef0df fix typo 2021-08-15 21:26:37 +02:00
20d3d771c8 create LICENSE.md 2021-07-31 16:01:23 +02:00
a6b713b47a release version 0.6.1 2021-07-13 17:18:26 +02:00
05a2b2a2b3 update changelog 2021-07-13 17:12:35 +02:00
cb0f29c008 confirm compatibility with WordPress 5.8 2021-07-13 17:09:20 +02:00
de483e301c update luxon, webpack 2021-07-13 17:08:48 +02:00
fcd8c79a62 npm audit fix 2021-07-08 22:37:41 +02:00
02567fb1bd clarify last release procedure step 2021-07-08 22:35:53 +02:00
536a6c6686 update eslint, webpack 2021-07-08 22:34:41 +02:00
744c0c593b update graphql, c8, eslint, webpack, webpack-cli 2021-06-26 15:12:03 +02:00
d38d3c0906 release version 0.6.0 2021-06-02 11:02:59 +02:00
f91c0a00fa update changelog and readme 2021-06-02 10:45:07 +02:00
fc64731921 npm audit fix 2021-06-02 10:38:01 +02:00
23bd4f2d15 update deps jsdom, object-hash, webpack 2021-06-02 10:36:59 +02:00
7795ccc36a optionally display the current offset as short name after the time via the general plugin settings 2021-05-23 15:37:29 +02:00
0b3c998e56 update dev dependency eslint 2021-05-23 14:23:30 +02:00
e927bdf239 update luxon and dev dependencies eslint, gulp-replace, webpack, webpack-cli 2021-05-20 09:33:05 +02:00
00d3a3be7c capitalize name 2021-05-06 09:50:08 +02:00
8f54398b43 release version 0.5.0 2021-05-06 09:37:23 +02:00
c131076f1a add missing changelog entry 2021-05-06 09:23:08 +02:00
2d2b1b9293 improve translatability 2021-05-06 09:23:08 +02:00
a3a980d6db let eslint ignore gulpfile.js 2021-05-06 09:23:08 +02:00
60870eae3c add CodeQL Analysis Github action 2021-05-05 13:47:32 +02:00
8f345ba4e4 use Node 14.x only 2021-05-05 12:43:29 +02:00
6ce3f49e52 remove setup-icu, add running on node 14.x and 16.x 2021-05-05 12:32:28 +02:00
c8a999d028 revert use of NODE_ICU_DATA 2021-05-05 12:26:10 +02:00
05d6f78c0c npm ci before npm install 2021-05-05 12:03:53 +02:00
105c6e1240 do not run tests twice 2021-05-05 12:00:13 +02:00
ec63b4ec9e set NODE_ICU_DATA manually in action 2021-05-05 11:57:39 +02:00
2dc823505b remove action-uses-icu-function 2021-05-05 11:52:09 +02:00
6bf4cb95b1 add ICU to action 2021-05-05 11:49:38 +02:00
054e313a4d default to en-GB locale, fix test failing due to time zone being null 2021-05-05 11:36:57 +02:00
89145fe9ed take WordPress time zone into account 2021-05-05 10:40:46 +02:00
22c0b22b8e let luxon take zone from string 2021-05-05 10:13:16 +02:00
bc86f8e7c9 refactor 2021-05-05 10:02:57 +02:00
a8584096d8 localise dates 2021-05-04 11:16:18 +02:00
65b42ba1e7 set locale for tests 2021-05-04 10:37:30 +02:00
eae2d422e0 let build only run on Node 12.x 2021-05-04 10:14:58 +02:00
e30eaa47d2 fix build command 2021-05-03 22:03:19 +02:00
dd0f4a7965 create test Github action 2021-05-03 22:00:45 +02:00
4c0de97ff2 update dev dependencies 2021-05-03 21:52:13 +02:00
74522103a2 remove use of global in test 2021-05-03 21:45:50 +02:00
bfa6c00e45 clearly list features 2021-04-23 08:05:01 +02:00
a5605d4d13 improve release procedure steps 2021-04-20 21:44:10 +02:00
9c553b7dda release version 0.4.0 2021-04-20 21:34:41 +02:00
f5a7e1ed04 update webpack, npm audit fix 2021-04-20 21:21:52 +02:00
f181743ecf add plugin icon 2021-04-20 21:19:18 +02:00
72f2c12343 extract two methods from main file 2021-04-13 21:10:28 +02:00
cf49fb47d6 clean up exports and imports 2021-04-13 20:50:56 +02:00
748649bde3 enable full JS source code coverage 2021-04-13 20:17:07 +02:00
3fd69fc7f6 add changelog entry 2021-04-11 22:48:19 +02:00
540731e28a update dev dependencies 2021-04-11 22:47:49 +02:00
233cdbf8fa show events' location 2021-04-11 22:42:50 +02:00
56d501464e add JS coverage tool 2021-04-09 13:08:29 +02:00
f36e2a6e6a add where caching happens 2021-04-06 08:35:27 +02:00
b8ffbdb835 release version 0.3.0 2021-04-05 18:39:06 +02:00
710103bb10 npm audit fix 2021-04-05 18:26:02 +02:00
c9b04cb2f8 add tests for session-cache, fix a test 2021-04-05 18:23:37 +02:00
12e6adacbf update changelog 2021-04-05 17:57:47 +02:00
08cad477d1 update webpack 2021-04-05 17:57:19 +02:00
0ee1d8cc18 add ESLint 2021-04-05 17:53:47 +02:00
1e4d0c0a09 add few words to description 2021-04-05 17:18:02 +02:00
28245574d8 add 2 min request cache, remove a few unneeded semicolons 2021-04-04 18:03:05 +02:00
214fc50d6d update package json files with donation details 2021-04-04 10:00:02 +02:00
f580b4fb69 add release step of tagging in git 2021-03-28 22:31:16 +02:00
aa8012c8e8 add donation link 2021-03-28 22:28:32 +02:00
8b6e312645 fix name 2021-03-28 22:21:09 +02:00
c28d5ec50e add explanatory sentence and link to WordPress repo 2021-03-28 22:14:29 +02:00
8e9445b60a update dependencies 2021-03-28 22:09:59 +02:00
4dd1084a3f describe release procedure further 2021-03-10 16:40:14 +01:00
4c604c4fc4 release version 0.2.2 2021-03-10 16:22:41 +01:00
db9e9edf00 confirm compatibility with WordPress 5.7 2021-03-10 16:17:29 +01:00
7675e0e2ba updated dependencies 2021-03-10 16:14:37 +01:00
b2f01d46d8 update webpack 2021-01-16 15:25:37 +01:00
e50dc76968 fix whitespace 2021-01-16 15:21:46 +01:00
ac9cca3b26 improve release procedure documentation 2021-01-16 15:21:16 +01:00
1df834cbca fix type of change in changelog 2021-01-15 22:06:57 +01:00
73 changed files with 23257 additions and 9489 deletions

55
.eslintrc.json Normal file
View File

@ -0,0 +1,55 @@
{
"env": {
"browser": true,
"es2020": true
},
"globals": {
"MOBILIZON_CONNECTOR": "readonly"
},
"parser": "@babel/eslint-parser",
"extends": [
"eslint:recommended",
"plugin:ava/recommended",
"plugin:@wordpress/eslint-plugin/recommended"
],
"parserOptions": {
"ecmaVersion": 11,
"requireConfigFile": false,
"sourceType": "module",
"babelOptions": {
"presets": ["@babel/preset-react"]
}
},
"plugins": [
"ava",
"jsx"
],
"rules": {
"import/no-unresolved": [
"off"
],
"indent": [
"error",
2
],
"no-console": [
"error", {
"allow": ["error"]
}
],
"prettier/prettier": [
"off"
],
"quotes": [
"error",
"single"
],
"react/jsx-key": [
"off"
],
"semi": [
"error",
"never"
]
}
}

71
.github/workflows/codeql-analysis.yml vendored Normal file
View File

@ -0,0 +1,71 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: 'CodeQL'
on:
push:
branches: [main]
pull_request:
# The branches below must be a subset of the branches above
branches: [main]
schedule:
- cron: '39 19 * * 4'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: ['javascript']
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
steps:
- name: Checkout repository
uses: actions/checkout@v2
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
#- name: Autobuild
# uses: github/codeql-action/autobuild@v1
# Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
- run: |
npm install
npm run build-prod
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

30
.github/workflows/test.yml vendored Normal file
View File

@ -0,0 +1,30 @@
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
name: Node.js CI
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- name: Upgrade NPM
run: npm install -g npm
- run: npm ci --ignore-scripts
- run: npm run build-prod

5
.gitignore vendored
View File

@ -1,3 +1,8 @@
.idea/
build/
coverage/
node_modules/
vendor/
.phpunit.cache
.phpunit.result.cache

5
.gulp.json Normal file
View File

@ -0,0 +1,5 @@
{
"flags": {
"gulpfile": "gulpfile.cjs"
}
}

2
.husky/pre-commit Executable file
View File

@ -0,0 +1,2 @@
npm test
lint-staged

8
.prettierignore Normal file
View File

@ -0,0 +1,8 @@
.idea
build
coverage
node_modules
vendor
.eslintrc.json
composer.lock
LICENSE.md

4
.prettierrc.json Normal file
View File

@ -0,0 +1,4 @@
{
"semi": false,
"singleQuote": true
}

201
LICENSE.md Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -1,22 +1,54 @@
# Connector for Mobilizon
Connector for Mobilizon allows you to display the upcoming events of [Mobilizon](https://joinmobilizon.org/), which is a federated event listing platform, on your WordPress website.
More details can be found in the [WordPress Plugin Directory](https://wordpress.org/plugins/connector-mobilizon/).
The current changelog can be found under [source/changelog.txt](source/changelog.txt).
This plugin uses [Mobilizon's GraphQL API](https://docs.joinmobilizon.org/contribute/graphql_api/).
## Development
### Setup
1. Make sure `npm` and `composer` are installed.
2. Run: `npm install`
3. Run: `php composer.phar install`
3. Run: `composer install`
### Development build
1. Build: `npm run build-dev`
2. Make sure to keep `changelog.txt` up-to-date.
### Release procedure
1. Make sure `changelog.txt` is up-to-date. Use a new version number and copy over the new section into `readme.txt`.
2. Build: `npm run build-prod`
3. Determine minimum PHP version for code and update package.json if needed: `./vendor/bin/phpcompatinfo analyser:run ./source`
4. Make sure screenshots are up-to-date.
1. Make sure `changelog.txt` is up-to-date.
2. Create a new section with a new version number.
3. Copy over the new section into `readme.txt`.
4. Update `package.json` with the same version number.
5. Update the `package-lock.json`: `npm i --package-lock-only`
6. Build: `npm run build-prod`
7. Make sure screenshots are up-to-date.
8. Copy the built plugin into `/trunk` of SVN.
9. Create a new tag of the new version: `svn cp trunk tags/<version>`
10. Check the version number occurrences in both folders.
11. Make sure to handle exclamation and question marks in `svn status`.
12. Commit everything together to the release SVN: `svn ci -m "release version <version>"`
13. Commit the new version in git with the same message.
14. Tag the new version: `git tag v<version>`
15. Push the new tag to the repository: `git push --tags`
16. Append `-next` to the version number in `package.json`.
17. Update the `package-lock.json`: `npm i --package-lock-only`
18. Commit: `git commit -am "prepare next release"`
### Other commands
- Run ESLint: `npm run eslint`
- Run JavaScript code coverage with tests: `npm run coverage`
- Run tests: `npm test`
- Delete build folder: `gulp clean`
- Delete build folder: `npm run clean`
- Update PHP dependencies: `composer update`
- Check for direct PHP dependency updates: `composer outdated --direct`
- Format code with prettier: `npm run format`
- Generate `vendor/autoload.php` file after creating new class: `composer dump-autoload`

BIN
assets/icon-128x128.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

BIN
assets/icon-256x256.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

16
assets/icon.svg Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<g transform="matrix(3.1904,0,0,3.1904,-120.199,-271.206)">
<circle cx="37.675" cy="125.127" r="29.385" style="fill:rgb(71,68,103);"/>
</g>
<g transform="matrix(1.26548,0,0,2.29215,-58.5821,-124.97)">
<path d="M120.375,110.363L201.527,106.002L201.527,101.64L221.522,110.363L201.527,119.087L201.527,114.725L120.375,110.363Z" style="fill:rgb(255,213,153);"/>
</g>
<g transform="matrix(1.18916,0.432821,-0.783962,2.15392,28.3042,-121.978)">
<path d="M120.375,110.363L201.527,106.002L201.527,101.64L221.522,110.363L201.527,119.087L201.527,114.725L120.375,110.363Z" style="fill:rgb(255,213,153);"/>
</g>
<g transform="matrix(1.18916,-0.432821,0.783962,2.15392,-144.737,-97.4496)">
<path d="M120.375,110.363L201.527,106.002L201.527,101.64L221.522,110.363L201.527,119.087L201.527,114.725L120.375,110.363Z" style="fill:rgb(255,213,153);"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

BIN
assets/screenshot-5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

3
babel.config.json Normal file
View File

@ -0,0 +1,3 @@
{
"presets": ["@babel/preset-env", "@babel/preset-react"]
}

View File

@ -1,5 +1,10 @@
{
"require": {
"bartlett/php-compatinfo": "^5.4"
"autoload": {
"psr-4": {
"MobilizonConnector\\": "source/includes/"
}
},
"require-dev": {
"phpunit/phpunit": "^9.6"
}
}

4207
composer.lock generated

File diff suppressed because it is too large Load Diff

49
gulpfile.cjs Normal file
View File

@ -0,0 +1,49 @@
/* eslint-disable no-undef */
const { dest, src } = require('gulp')
const replace = require('gulp-replace')
const PACKAGE = require('./package.json')
const FOLDER_BUILD = './build'
function injectMetadata() {
return src(
[
FOLDER_BUILD + '/front/block-events-loader.js',
FOLDER_BUILD + '/' + PACKAGE.name + '.php',
FOLDER_BUILD + '/includes/Constants.php',
FOLDER_BUILD + '/readme.txt',
],
{ base: './' },
)
.pipe(replace('<wordpress-author-name>', PACKAGE.author.name))
.pipe(replace('<wordpress-author-url>', PACKAGE.author.url))
.pipe(replace('<wordpress-description>', PACKAGE.description))
.pipe(replace('<wordpress-donation-link>', PACKAGE.funding.url))
.pipe(replace('<wordpress-license>', PACKAGE.license))
.pipe(
replace(
'<wordpress-minimum-version>',
PACKAGE.additionalDetails.wordpressMinimumVersion,
),
)
.pipe(replace('<wordpress-name>', PACKAGE.name))
.pipe(replace('<wordpress-nice-name>', PACKAGE.additionalDetails.niceName))
.pipe(
replace(
'<wordpress-php-minimum-version>',
PACKAGE.additionalDetails.phpMinimumVersion,
),
)
.pipe(
replace(
'<wordpress-tested-up-to-version>',
PACKAGE.additionalDetails.wordpressTestedUpToVersion,
),
)
.pipe(replace('<wordpress-version>', PACKAGE.version))
.pipe(dest('.'))
}
exports.inject = injectMetadata

View File

@ -1,79 +0,0 @@
const { dest, series, src } = require('gulp');
const del = require('del');
const replace = require('gulp-replace');
const webpack = require('webpack-stream');
const PACKAGE = require('./package.json');
const FOLDER_SOURCE = './source'
const FOLDER_BUILD = './build';
let mode = 'development';
function clean(cb) {
del(FOLDER_BUILD);
cb();
}
const eventsLoaderOutputPath = PACKAGE.name + '/front/events-loader';
const eventsLoaderInputPath = FOLDER_SOURCE + '/' + PACKAGE.name + '/front/events-loader.js';
function bundleFrontend() {
return src(FOLDER_SOURCE + '/' + PACKAGE.name + '/front/events-loader.js')
.pipe(webpack({
mode,
entry: {
[eventsLoaderOutputPath]: eventsLoaderInputPath,
},
output: {
filename: '[name].js',
},
}))
.pipe(dest(FOLDER_BUILD));
}
function copyBackend() {
return src([
FOLDER_SOURCE + '/**/*.php',
FOLDER_SOURCE + '/**/*.txt'
])
.pipe(dest(FOLDER_BUILD));
}
function injectMetadata() {
return src([
FOLDER_BUILD + '/' + eventsLoaderOutputPath + '.js',
FOLDER_BUILD + '/' + PACKAGE.name + '/' + PACKAGE.name + '.php',
FOLDER_BUILD + '/' + PACKAGE.name + '/includes/constants.php',
FOLDER_BUILD + '/' + PACKAGE.name + '/readme.txt'
], { base: './' })
.pipe(replace('<wordpress-author-name>', PACKAGE.author.name))
.pipe(replace('<wordpress-author-url>', PACKAGE.author.url))
.pipe(replace('<wordpress-description>', PACKAGE.description))
.pipe(replace('<wordpress-license>', PACKAGE.license))
.pipe(replace('<wordpress-minimum-version>', PACKAGE.additionalDetails.wordpressMinimumVersion))
.pipe(replace('<wordpress-name>', PACKAGE.name))
.pipe(replace('<wordpress-nice-name>', PACKAGE.additionalDetails.niceName))
.pipe(replace('<wordpress-php-minimum-version>', PACKAGE.additionalDetails.phpMinimumVersion))
.pipe(replace('<wordpress-tested-up-to-version>', PACKAGE.additionalDetails.wordpressTestedUpToVersion))
.pipe(replace('<wordpress-version>', PACKAGE.version))
.pipe(dest('.'));
}
exports.front = bundleFrontend;
exports.copy = copyBackend;
exports.inject = injectMetadata;
const build = series(clean, bundleFrontend, copyBackend, injectMetadata);
const buildDev = series((cb) => { mode = 'development'; cb(); }, build);
const buildProd = series((cb) => { mode = 'production'; cb(); }, build);
exports.clean = clean;
exports.dev = buildDev;
exports.default = buildDev;
exports.prod = buildProd;

BIN
icon.afdesign Normal file

Binary file not shown.

25801
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,46 +1,70 @@
{
"name": "connector-mobilizon",
"version": "0.2.1",
"description": "Display mobilizon events in WordPress.",
"version": "1.1.0",
"description": "Display Mobilizon events in WordPress.",
"private": true,
"type": "module",
"scripts": {
"build-dev": "gulp dev",
"build-prod": "ava && gulp prod",
"test": "ava"
"build-dev": "webpack --mode=development && gulp inject",
"build-prod": "rimraf -- build && ava && webpack --mode=production && gulp inject",
"clean": "rimraf -- build",
"coverage": "c8 --all --reporter=html --reporter=text --include=source/**/*.js ava",
"eslint": "npx eslint source/**/*.js",
"format": "npx prettier --write .",
"prepare": "husky",
"test": "ava && ./vendor/bin/phpunit"
},
"author": {
"name": "Daniel Waxweiler",
"url": "https://www.danielwaxweiler.net/"
},
"funding": {
"type": "individual",
"url": "https://paypal.me/dwaxweiler"
},
"license": "Apache-2.0",
"dependencies": {
"graphql": "^15.4.0",
"graphql-request": "^3.4.0",
"luxon": "^1.25.0"
"graphql": "16.9.0",
"luxon": "3.4.4"
},
"devDependencies": {
"ava": "^3.15.0",
"del": "^6.0.0",
"esm": "^3.2.25",
"gulp": "^4.0.2",
"gulp-replace": "^1.0.0",
"jsdom": "^16.4.0",
"webpack": "^5.11.1",
"webpack-cli": "^4.3.1",
"webpack-stream": "^6.1.1"
"@babel/core": "7.24.9",
"@babel/eslint-parser": "7.24.8",
"@babel/preset-env": "7.24.8",
"@babel/preset-react": "7.24.7",
"@wordpress/eslint-plugin": "20.0.0",
"ava": "6.1.3",
"babel-loader": "9.1.3",
"browser-env": "3.3.0",
"c8": "10.1.2",
"copy-webpack-plugin": "12.0.2",
"eslint": "8.57.0",
"eslint-plugin-ava": "14.0.0",
"eslint-plugin-jsx": "0.1.0",
"eslint-plugin-react": "7.34.4",
"esm": "3.2.25",
"gulp": "5.0.0",
"gulp-replace": "1.1.4",
"husky": "9.1.1",
"lint-staged": "15.2.7",
"prettier": "3.3.3",
"rimraf": "5.0.9",
"webpack": "5.93.0",
"webpack-cli": "5.1.4"
},
"ava": {
"files": [
"./source/**/*test.js"
],
"require": [
"esm"
]
},
"additionalDetails": {
"niceName": "Connector for Mobilizon",
"phpMinimumVersion": 5.4,
"phpMinimumVersion": 7.4,
"wordpressMinimumVersion": 5.6,
"wordpressTestedUpToVersion": 5.6
"wordpressTestedUpToVersion": "6.6"
},
"lint-staged": {
"source/**/*.js": "eslint",
"**/*": "prettier --write --ignore-unknown"
}
}

27
phpunit.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
bootstrap="vendor/autoload.php"
cacheResultFile=".phpunit.cache/test-results"
executionOrder="depends,defects"
forceCoversAnnotation="false"
beStrictAboutCoversAnnotation="true"
beStrictAboutOutputDuringTests="true"
beStrictAboutTodoAnnotatedTests="true"
convertDeprecationsToExceptions="true"
failOnRisky="true"
failOnWarning="true"
verbose="true">
<testsuites>
<testsuite name="default">
<directory>tests</directory>
</testsuite>
</testsuites>
<coverage cacheDirectory=".phpunit.cache/code-coverage"
processUncoveredFiles="true">
<include>
<directory suffix=".php">source/includes</directory>
</include>
</coverage>
</phpunit>

2
qodana.yaml Normal file
View File

@ -0,0 +1,2 @@
version: '1.0'
linter: jetbrains/qodana-js:2022.3-eap

169
source/changelog.txt Normal file
View File

@ -0,0 +1,169 @@
### [Unreleased]
#### Added
#### Changed
#### Deprecated
#### Removed
#### Fixed
#### Security
### [1.1.0]
#### Added
- Add some spacing between event items
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.6
#### Fixed
- Fix undefined variable $classNamePrefix for both error views
### [1.0.0]
#### Added
- Display name of group when it cannot be found
#### Changed
- Let backend do requests to API of Mobilizon instance for increased privacy
- Update dependencies
#### Fixed
- Fix displaying more than one block in the editor
### [0.11.5]
#### Changed
- Confirm compatibility with WordPress 6.5
### [0.11.4]
#### Changed
- Confirm compatibility with WordPress 6.4
- Update dependencies
### [0.11.3]
#### Fixed
- Clean up distributed files
### [0.11.2]
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.3
### [0.11.1]
#### Fixed
- Revert minimum PHP version to 7.4 to allow some more time for upgrading PHP
### [0.11.0]
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.2
#### Security
- Set minimum PHP version to oldest stable 8.0
### [0.10.1]
#### Changed
- Confirm compatibility with WordPress 6.1
- Update dependencies
### [0.10.0]
#### Added
- Add Gutenberg events list block
- Show loading indicator during request
#### Changed
- Set list style type to none and left padding to zero for all occurences
- Move shortcut usage description into installation section in `readme.txt`
- Update dependencies
### [0.9.1] - 2020-05-19
#### Fixed
- Fix WordPress compatibility version number
### [0.9.0] - 2020-05-19
#### Added
- Improve explanation of group name filter
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.0
#### Fixed
- Fix displaying error message for the case the group is not found
### [0.8.0] - 2022-01-09
#### Added
- Add support for older browsers using babel
#### Changed
- Confirm compatibility with WordPress 5.9
- Update dependencies
#### Fixed
- Use ES modules correctly
- Trim events' location
### [0.7.0] - 2021-12-23
#### Added
- Add specific error message for the case the group is not found
- Add code formatter prettier
#### Changed
- Update dependencies
- Simplify build process
#### Fixed
- Fix Invalid DateTime on event end time being null
#### Security
- Set minimum PHP version to oldest stable 7.4
### [0.6.2] - 2021-08-24
#### Changed
- Update dependencies
#### Fixed
- Fix empty WordPress timezone_string option resulting in Invalid DateTime
### [0.6.1] - 2021-07-13
#### Changed
- Confirm compatibility with WordPress 5.8
- Update dependencies
### [0.6.0] - 2021-06-02
#### Added
- Optionally display the current offset as short name after the time via the general plugin settings
#### Changed
- Update dependencies
#### Fixed
- Capitalise Mobilizon name in description
### [0.5.0] - 2021-05-06
#### Added
- Localise dates based on the WordPress locale and time zone
#### Changed
- Clearly list features in `readme.txt` description
- Update dev dependencies c8, eslint, gulp-replace, webpack
#### Fixed
- Improve translatability
### [0.4.0] - 2021-04-20
#### Added
- Show events' location if set: `description` and `locality` fields
- Plugin icon
#### Changed
- Update dev dependencies eslint, jsdom, webpack
### [0.3.0] - 2021-04-05
#### Added
- Donation link to WordPress Plugin Directory sidebar and to `package.json`
- Cache requests for 2 minutes
- Set up ESLint static code analysis
#### Changed
- Update luxon dependency
- Update dev dependencies jsdom, webpack, webpack-cli
### [0.2.2] - 2021-03-10
#### Changed
- Confirm compatibility with WordPress 5.7
- Update graphql dependency
- Update dev dependencies jsdom, webpack, webpack-cli, webpack-stream
### [0.2.1] - 2021-01-15
#### Fixed
- Add missing backtick to `readme.txt`
### [0.2.0] - 2021-01-15
#### Added
- `changelog.txt`
- Changelog maintenance steps to `README.md`
- Link to Github repository in `readme.txt`
- Option to show events of a specific group by indicating its name
#### Changed
- Use same Markdown style in `README.md` as in other documents
### [0.1.0] - 2021-01-09
initial release

View File

@ -0,0 +1,90 @@
<?php
/**
* Plugin Name: <wordpress-nice-name>
* Author: <wordpress-author-name>
* Author URI: <wordpress-author-url>
* Description: <wordpress-description>
* Version: <wordpress-version>
* Requires at least: <wordpress-minimum-version>
* Requires PHP: <wordpress-php-minimum-version>
* License: <wordpress-license>
*/
require_once __DIR__ . '/includes/exceptions/GeneralException.php';
require_once __DIR__ . '/includes/exceptions/GroupNotFoundException.php';
require_once __DIR__ . '/includes/Constants.php';
require_once __DIR__ . '/includes/Api.php';
require_once __DIR__ . '/includes/EventsCache.php';
require_once __DIR__ . '/includes/Settings.php';
require_once __DIR__ . '/includes/DateTimeWrapper.php';
require_once __DIR__ . '/includes/Formatter.php';
require_once __DIR__ . '/includes/GraphQlClient.php';
require_once __DIR__ . '/includes/EventsListBlock.php';
require_once __DIR__ . '/includes/EventsListShortcut.php';
require_once __DIR__ . '/includes/EventsListWidget.php';
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
final class Mobilizon_Connector {
private function __construct() {
add_action('init', [$this, 'register_api']);
add_action('init', [$this, 'register_blocks']);
add_action('init', [$this, 'register_settings'], 1); // required for register_blocks
add_action('init', [$this, 'register_shortcut']);
add_action('widgets_init', [$this, 'register_widget']);
register_activation_hook(__FILE__, [$this, 'enable_activation']);
}
public static function init() {
// Create singleton instance.
static $instance = false;
if(!$instance) {
$instance = new self();
}
return $instance;
}
public function enable_activation() {
MobilizonConnector\Settings::setDefaultOptions();
}
private function load_settings_globally_before_script($scriptName) {
$settings = array(
'isShortOffsetNameShown' => MobilizonConnector\Settings::isShortOffsetNameShown(),
'locale' => str_replace('_', '-', get_locale()),
'timeZone' => wp_timezone_string()
);
wp_add_inline_script($scriptName, 'var MOBILIZON_CONNECTOR = ' . json_encode($settings), 'before');
}
public function register_api() {
MobilizonConnector\Api::init();
}
public function register_blocks() {
$scriptName = MobilizonConnector\EventsListBlock::initAndReturnScriptName();
$this->load_settings_globally_before_script($scriptName);
}
public function register_settings() {
MobilizonConnector\Settings::init();
}
public function register_shortcut() {
MobilizonConnector\EventsListShortcut::init();
}
public function register_widget() {
register_widget('MobilizonConnector\EventsListWidget');
}
}
function mobilizon_connector_run_plugin() {
return Mobilizon_Connector::init();
}
mobilizon_connector_run_plugin();

View File

@ -1,23 +0,0 @@
### [Unreleased]
Added
Changed
Deprecated
Removed
Fixed
Security
### [0.2.1] - 2021-01-15
Changed
- Add missing backtick to `readme.txt`
### [0.2.0] - 2021-01-15
Added
- `changelog.txt`
- Changelog maintenance steps to `README.md`
- Link to Github repository in `readme.txt`
- Option to show events of a specific group by indicating its name
Changed
- Use same Markdown style in `README.md` as in other documents
### [0.1.0] - 2021-01-09
initial release

View File

@ -1,42 +0,0 @@
<?php
/**
* Plugin Name: <wordpress-nice-name>
* Author: <wordpress-author-name>
* Author URI: <wordpress-author-url>
* Description: <wordpress-description>
* Version: <wordpress-version>
* Requires at least: <wordpress-minimum-version>
* Requires PHP: <wordpress-php-minimum-version>
* License: <wordpress-license>
*/
require_once __DIR__ . '/includes/constants.php';
require_once __DIR__ . '/includes/settings.php';
require_once __DIR__ . '/includes/events-list-shortcut.php';
require_once __DIR__ . '/includes/events-list-widget.php';
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
function mobilizon_connector_activate() {
MobilizonConnector\Settings::setDefaultOptions();
}
register_activation_hook(__FILE__, 'mobilizon_connector_activate');
function mobilizon_connector_initialize() {
MobilizonConnector\Settings::init();
MobilizonConnector\EventsListShortcut::init();
}
add_action('init', 'mobilizon_connector_initialize');
function mobilizon_connector_load_scripts() {
wp_enqueue_script(MobilizonConnector\NAME . '-js', plugins_url('front/events-loader.js', __FILE__ ));
}
add_action('wp_enqueue_scripts', 'mobilizon_connector_load_scripts');
function mobilizon_connector_register_events_list_widget() {
register_widget('MobilizonConnector\EventsListWidget');
}
add_action('widgets_init', 'mobilizon_connector_register_events_list_widget');

View File

@ -1,53 +0,0 @@
import test from 'ava';
import { DateTimeWrapper } from './date-time-wrapper';
test('#getShortDate usual date', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
t.is(d.getShortDate(), '24/12/2020')
})
test('#get24Time usual time', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
t.is(d.get24Time(), '17:45')
})
test('#equalsDate same date, different time', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
const e = new DateTimeWrapper('2020-12-24T17:46:01Z')
t.true(d.equalsDate(e))
})
test('#equalsDate different date, different time', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
const e = new DateTimeWrapper('2021-11-25T17:46:01Z')
t.false(d.equalsDate(e))
})
test('#equalsDate different day, different time', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
const e = new DateTimeWrapper('2020-12-25T17:46:01Z')
t.false(d.equalsDate(e))
})
test('#equalsDate different month, different time', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
const e = new DateTimeWrapper('2020-11-24T17:46:01Z')
t.false(d.equalsDate(e))
})
test('#equalsDate different year, different time', t => {
const d = new DateTimeWrapper('2020-12-24T16:45:00Z')
const e = new DateTimeWrapper('2021-12-24T17:46:01Z')
t.false(d.equalsDate(e))
})
test('#getCurrentDatetimeAsString correct format', t => {
const d = DateTimeWrapper.getCurrentDatetimeAsString()
t.is(d[4], '-')
t.is(d[7], '-')
t.is(d[10], 'T')
t.is(d[13], ':')
t.is(d[16], ':')
t.is(d[19], '.')
t.is(d[d.length-3], ':')
})

View File

@ -1,28 +0,0 @@
import { DateTime } from 'luxon';
export class DateTimeWrapper {
constructor(text) {
this.dateTime = DateTime.fromISO(text)
}
getShortDate() {
return this.dateTime.toLocaleString(DateTime.DATE_SHORT)
}
get24Time() {
return this.dateTime.toLocaleString(DateTime.TIME_24_SIMPLE)
}
equalsDate(other) {
return this.dateTime &&
other.dateTime &&
this.dateTime.day === other.dateTime.day &&
this.dateTime.month === other.dateTime.month &&
this.dateTime.year === other.dateTime.year
}
static getCurrentDatetimeAsString() {
return DateTime.local().toString();
}
}

View File

@ -1,59 +0,0 @@
import { DateTimeWrapper } from './date-time-wrapper';
import * as GraphqlWrapper from './graphql-wrapper'
import * as HtmlCreator from './html-creator'
const NAME = '<wordpress-name>';
function displayEvents(data, list) {
const maxEventsCount = list.getAttribute('data-maximum')
const events = data.events ? data.events.elements : data.group.organizedEvents.elements
const eventsCount = Math.min(maxEventsCount, events.length)
for (let i = 0; i < eventsCount; i++) {
const li = document.createElement('li')
const a = HtmlCreator.createAnchorElement({ text: events[i].title, url: events[i].url });
li.appendChild(a)
const br = document.createElement('br')
li.appendChild(br)
const beginsOn = new DateTimeWrapper(events[i].beginsOn)
const endsOn = new DateTimeWrapper(events[i].endsOn)
let dateText = beginsOn.getShortDate()
dateText += ' ' + beginsOn.get24Time()
dateText += ' - '
if (!beginsOn.equalsDate(endsOn)) {
dateText += endsOn.getShortDate() + ' '
}
dateText += endsOn.get24Time()
const textnode = document.createTextNode(dateText);
li.appendChild(textnode)
list.appendChild(li)
}
}
function displayErrorMessage(data, list) {
console.error(data)
for (let i = 0; i < list.children.length; i++) {
list.children[i].style.display = 'block'
}
}
document.addEventListener('DOMContentLoaded', () => {
const eventLists = document.getElementsByClassName(NAME + '_events-list')
for (let list of eventLists) {
const url = list.getAttribute('data-url') + '/api'
const limit = list.getAttribute('data-maximum')
const groupName = list.getAttribute('data-group-name')
if (groupName) {
GraphqlWrapper.getUpcomingEventsByGroupName({ url, limit, groupName })
.then((data) => displayEvents(data, list))
.catch((data) => displayErrorMessage(data, list))
} else {
GraphqlWrapper.getUpcomingEvents({ url, limit })
.then((data) => displayEvents(data, list))
.catch((data) => displayErrorMessage(data, list))
}
}
})

View File

@ -1,41 +0,0 @@
import { request, gql } from 'graphql-request'
import { DateTimeWrapper } from './date-time-wrapper'
export function getUpcomingEvents({ url, limit }) {
const query = gql`
query {
events(limit:${limit}) {
elements {
id,
title,
url,
beginsOn,
endsOn
},
total
}
}
`
return request(url, query)
}
export function getUpcomingEventsByGroupName({ url, limit, groupName }) {
const afterDatetime = DateTimeWrapper.getCurrentDatetimeAsString();
const query = gql`
query {
group(preferredUsername:"${groupName}") {
organizedEvents(afterDatetime:"${afterDatetime}", limit:${limit}) {
elements {
id,
title,
url,
beginsOn,
endsOn
},
total
}
}
}
`
return request(url, query)
}

View File

@ -1,15 +0,0 @@
import test from 'ava';
import { JSDOM } from 'jsdom';
import * as HtmlCreator from './html-creator';
test.beforeEach(() => {
global.document = new JSDOM().window.document
})
test('createAnchorElement() usual parameters', t => {
const a = HtmlCreator.createAnchorElement({ text: 'a', url: 'b' })
t.is(a.tagName, 'A')
t.is(a.innerHTML, 'a')
t.is(a.getAttribute('href'), 'b')
})

View File

@ -1,45 +0,0 @@
# <wordpress-nice-name>
Contributors: dwaxweiler
Tags: mobilizon, events
Stable tag: <wordpress-version>
Requires at least: <wordpress-minimum-version>
Tested up to: <wordpress-tested-up-to-version>
Requires PHP: <wordpress-php-minimum-version>
License: <wordpress-license>
<wordpress-description>
## Description
<wordpress-nice-name> allows you to display the upcoming events of [Mobilizon](https://joinmobilizon.org/), which is a federated event listing platform.
You can display the upcoming events using a widget and everywhere else using a shortcut.
Shortcut format with limiting the number of events to show to 3 for example: `[<wordpress-name>-events-list events-count=3]`
Optionally, you can only show the events of a specific group by indicatings its name: `[<wordpress-name>-events-list events-count=3 group-name="mygroup"]`
The source code is available on [Github](https://github.com/dwaxweiler/connector-mobilizon).
## Screenshots
1. Events list
2. General settings
3. Widget creation
4. Shortcut creation
## Changelog
### [0.2.1] - 2021-01-15
Changed
- Add missing backtick to `readme.txt`
### [0.2.0] - 2021-01-15
Added
- `changelog.txt`
- Changelog maintenance steps to `README.md`
- Link to Github repository in `readme.txt`
- Option to show events of a specific group by indicating its name
Changed
- Use same Markdown style in `README.md` as in other documents
### [0.1.0] - 2021-01-09
initial release

View File

@ -1,12 +0,0 @@
<?php
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
?>
<ul class="<?php echo esc_attr($classNamePrefix); ?>_events-list"
data-url="<?php echo esc_attr($url); ?>"
data-maximum="<?php echo esc_attr($eventsCount); ?>"
data-group-name="<?php echo esc_attr($groupName); ?>">
<li style="display: none;"><?php echo esc_html_e('The events could not be loaded!', $textDomain); ?></li>
</ul>

View File

@ -0,0 +1 @@
import './blocks/events-list/index.js'

View File

@ -0,0 +1,113 @@
/* eslint-disable @wordpress/i18n-ellipsis */
import {
clearEventsList,
displayErrorMessage,
displayEvents,
hideErrorMessages,
showLoadingIndicator,
} from '../../events-displayer.js'
const { InspectorControls, useBlockProps } = wp.blockEditor
const { Panel, PanelBody } = wp.components
const { useEffect } = wp.element
const { __ } = wp.i18n
const NAME = '<wordpress-name>'
export default ({ attributes, setAttributes }) => {
let timer
const blockProps = useBlockProps({
className: NAME + '_events-list',
})
function reloadEventList(eventsCount, groupName) {
if (timer) {
clearTimeout(timer)
}
timer = setTimeout(async () => {
const container = document.getElementById(blockProps.id)
if (container) {
hideErrorMessages(container)
clearEventsList(container)
showLoadingIndicator(container)
let url = `/wp-json/connector-mobilizon/v1/events?eventsCount=${eventsCount}`
if (groupName) {
url += `&groupName=${groupName}`
}
await fetch(url)
.then((response) => response.text())
.then((data) => {
const events = JSON.parse(data)
displayEvents({
events,
document,
container,
maxEventsCount: eventsCount,
})
})
.catch((data) => {
displayErrorMessage({ data, container })
})
}
}, 500)
}
useEffect(() => {
reloadEventList(attributes.eventsCount, attributes.groupName)
}, [])
function updateEventsCount(event) {
let newValue = Number(event.target.value)
if (newValue < 1) newValue = 1
setAttributes({ eventsCount: newValue })
reloadEventList(newValue, attributes.groupName)
}
function updateGroupName(event) {
const newValue = event.target.value
setAttributes({ groupName: newValue })
reloadEventList(attributes.eventsCount, newValue)
}
return [
<InspectorControls>
<Panel>
<PanelBody title={__('Events List Settings', '<wordpress-name>')}>
<label
className="components-base-control__label"
htmlFor={NAME + '_events-count'}
>
{__('Number of events to show', '<wordpress-name>')}
</label>
<input
className="components-text-control__input"
type="number"
value={attributes.eventsCount}
onChange={updateEventsCount}
id={NAME + '_events-count'}
/>
<label
className="components-base-control__label"
htmlFor={NAME + '_group-name'}
>
{__('Group name (optional)', '<wordpress-name>')}
</label>
<input
className="components-text-control__input"
type="text"
value={attributes.groupName}
onChange={updateGroupName}
id={NAME + '_group-name'}
/>
</PanelBody>
</Panel>
</InspectorControls>,
<div {...blockProps}>
<div className="general-error" style={{ display: 'none' }}>
{__('The events could not be loaded!', '<wordpress-name>')}
</div>
<div className="group-not-found" style={{ display: 'none' }}>
{__('The group could not be found!', '<wordpress-name>')}
</div>
<div className="loading-indicator" style={{ display: 'none' }}>
{__('Loading...', '<wordpress-name>')}
</div>
<ul style={{ 'list-style-type': 'none', 'padding-left': 0 }}></ul>
</div>,
]
}

View File

@ -0,0 +1,7 @@
import edit from './edit.js'
const { registerBlockType } = wp.blocks
const NAME = '<wordpress-name>'
registerBlockType(NAME + '/events-list', { edit })

View File

@ -0,0 +1,87 @@
import test from 'ava'
import DateTimeWrapper from './date-time-wrapper.js'
test('#getShortDate usual date', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
t.is(d.getShortDate(), '24/12/2020')
})
test('#getShortDate usual date with timezone string', (t) => {
const d = new DateTimeWrapper({
text: '2020-12-24T16:45:00Z',
timeZone: 'Europe/Rome',
})
t.is(d.getShortDate(), '24/12/2020')
})
test('#getShortDate usual date with fixed offset', (t) => {
const d = new DateTimeWrapper({
text: '2020-12-24T16:45:00Z',
timeZone: 'UTC+02:00',
})
t.is(d.getShortDate(), '24/12/2020')
})
test('#getShortDate usual date with fixed offset without UTC prefix', (t) => {
const d = new DateTimeWrapper({
text: '2020-12-24T16:45:00Z',
timeZone: '+02:00',
})
t.is(d.getShortDate(), '24/12/2020')
})
test('#getShortDate usual date with empty time zone', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z', timeZone: '' })
t.is(d.getShortDate(), '24/12/2020')
})
test('#get24Time usual time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
t.is(d.get24Time(), '16:45')
})
test('#equalsDate same date, different time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
const e = new DateTimeWrapper({ text: '2020-12-24T17:46:01Z' })
t.true(d.equalsDate(e))
})
test('#equalsDate different date, different time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
const e = new DateTimeWrapper({ text: '2021-11-25T17:46:01Z' })
t.false(d.equalsDate(e))
})
test('#equalsDate different day, different time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
const e = new DateTimeWrapper({ text: '2020-12-25T17:46:01Z' })
t.false(d.equalsDate(e))
})
test('#equalsDate different month, different time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
const e = new DateTimeWrapper({ text: '2020-11-24T17:46:01Z' })
t.false(d.equalsDate(e))
})
test('#equalsDate different year, different time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
const e = new DateTimeWrapper({ text: '2021-12-24T17:46:01Z' })
t.false(d.equalsDate(e))
})
test('#getCurrentDatetimeAsString correct format', (t) => {
const d = DateTimeWrapper.getCurrentDatetimeAsString()
t.is(d[4], '-')
t.is(d[7], '-')
t.is(d[10], 'T')
t.is(d[13], ':')
t.is(d[16], ':')
t.is(d[19], '.')
t.is(d[d.length - 3], ':')
})
test('#getShortOffsetName usual time', (t) => {
const d = new DateTimeWrapper({ text: '2020-12-24T16:45:00Z' })
t.is(d.getShortOffsetName(), 'UTC')
})

View File

@ -0,0 +1,42 @@
import { DateTime } from 'luxon'
export default class DateTimeWrapper {
constructor({ locale = 'en-GB', text, timeZone = 'utc' } = {}) {
if (!timeZone) {
timeZone = 'utc'
}
if (
timeZone.includes(':') &&
timeZone.substring(0, 3).toUpperCase() !== 'UTC'
) {
timeZone = 'UTC' + timeZone
}
this.dateTime = DateTime.fromISO(text, { locale, zone: timeZone })
}
getShortDate() {
return this.dateTime.toLocaleString(DateTime.DATE_SHORT)
}
getShortOffsetName() {
return this.dateTime.offsetNameShort
}
get24Time() {
return this.dateTime.toLocaleString(DateTime.TIME_24_SIMPLE)
}
equalsDate(other) {
return (
this.dateTime &&
other.dateTime &&
this.dateTime.day === other.dateTime.day &&
this.dateTime.month === other.dateTime.month &&
this.dateTime.year === other.dateTime.year
)
}
static getCurrentDatetimeAsString() {
return DateTime.now().toString()
}
}

View File

@ -0,0 +1,117 @@
import test from 'ava'
import browserEnv from 'browser-env'
import {
displayEvents,
displayErrorMessage,
hideErrorMessages,
showLoadingIndicator,
} from './events-displayer.js'
test.before(() => {
browserEnv()
window.MOBILIZON_CONNECTOR = {
locale: 'en-GB',
timeZone: 'utc',
}
})
test.beforeEach((t) => {
t.context.container = document.createElement('div')
const errorMessageGeneral = document.createElement('div')
errorMessageGeneral.setAttribute('class', 'general-error')
errorMessageGeneral.setAttribute('style', 'display: none;')
t.context.container.appendChild(errorMessageGeneral)
const errorMessageGroupNotFound = document.createElement('div')
errorMessageGroupNotFound.setAttribute('class', 'group-not-found')
errorMessageGroupNotFound.setAttribute('style', 'display: none;')
t.context.container.appendChild(errorMessageGroupNotFound)
const loadingIndicator = document.createElement('div')
loadingIndicator.setAttribute('class', 'loading-indicator')
loadingIndicator.setAttribute('style', 'display: none;')
t.context.container.appendChild(loadingIndicator)
const list = document.createElement('ul')
t.context.container.appendChild(list)
})
test('#displayEvents one event', (t) => {
const events = [
{
title: 'a',
url: 'b',
beginsOn: '2021-04-15T10:30:00Z',
endsOn: '2021-04-15T15:30:00Z',
physicalAddress: {
description: 'c',
locality: 'd',
},
},
]
const container = t.context.container
displayEvents({ events, document, container, maxEventsCount: 2 })
const list = container.querySelector('ul')
t.is(list.children[0].childNodes[0].tagName, 'A')
t.is(list.children[0].childNodes[0].getAttribute('href'), 'b')
t.is(list.children[0].childNodes[0].childNodes[0].nodeValue, 'a')
t.is(list.children[0].childNodes[1].tagName, 'BR')
t.is(list.children[0].childNodes[2].nodeValue, '15/04/2021 10:30 - 15:30')
t.is(list.children[0].childNodes[3].tagName, 'BR')
t.is(list.children[0].childNodes[4].nodeValue, 'c, d')
})
test('#displayErrorMessage no list entries shown', (t) => {
const container = t.context.container
displayErrorMessage({ data: '', container })
const list = container.querySelector('ul')
t.is(list.children.length, 0)
})
test('#displayErrorMessage general error message display', (t) => {
const container = t.context.container
displayErrorMessage({ data: '', container })
t.is(container.querySelector('.general-error').style.display, 'block')
t.is(container.querySelector('.group-not-found').style.display, 'none')
t.is(container.querySelector('.loading-indicator').style.display, 'none')
})
test('#displayErrorMessage group not found error message display', (t) => {
const container = t.context.container
const data = {
response: {
errors: [
{
code: 'group_not_found',
},
],
},
}
displayErrorMessage({ data, container })
t.is(container.querySelector('.general-error').style.display, 'none')
t.is(container.querySelector('.group-not-found').style.display, 'block')
t.is(container.querySelector('.loading-indicator').style.display, 'none')
})
test('#showLoadingIndicator remove events', (t) => {
const container = t.context.container
const loadingIndicator = container.querySelector('.loading-indicator')
t.is(loadingIndicator.style.display, 'none')
showLoadingIndicator(container)
t.is(loadingIndicator.style.display, 'block')
})
test('#hideErrorMessages remove events', (t) => {
const container = t.context.container
const generalErrorMessage = container.querySelector('.general-error')
const groupNotFoundErrorMessage = container.querySelector('.group-not-found')
generalErrorMessage.style.display = 'block'
groupNotFoundErrorMessage.style.display = 'block'
t.is(generalErrorMessage.style.display, 'block')
t.is(groupNotFoundErrorMessage.style.display, 'block')
hideErrorMessages(container)
t.is(generalErrorMessage.style.display, 'none')
t.is(groupNotFoundErrorMessage.style.display, 'none')
})

View File

@ -0,0 +1,91 @@
import Formatter from './formatter.js'
import { createAnchorElement } from './html-creator.js'
export function clearEventsList(container) {
const list = container.querySelector('ul')
list.replaceChildren()
}
export function displayEvents({ events, document, container, maxEventsCount }) {
hideLoadingIndicator(container)
const isShortOffsetNameShown =
window.MOBILIZON_CONNECTOR.isShortOffsetNameShown
const locale = window.MOBILIZON_CONNECTOR.locale
const timeZone = window.MOBILIZON_CONNECTOR.timeZone
const eventsCount = Math.min(maxEventsCount, events.length)
const list = container.querySelector('ul')
for (let i = 0; i < eventsCount; i++) {
const li = document.createElement('li')
const a = createAnchorElement({
document,
text: events[i].title,
url: events[i].url,
})
li.appendChild(a)
const br = document.createElement('br')
li.appendChild(br)
const date = Formatter.formatDate({
locale,
start: events[i].beginsOn,
end: events[i].endsOn,
timeZone,
isShortOffsetNameShown,
})
const textnode = document.createTextNode(date)
li.appendChild(textnode)
if (events[i].physicalAddress) {
const location = Formatter.formatLocation({
description: events[i].physicalAddress.description,
locality: events[i].physicalAddress.locality,
})
if (location) {
const brBeforeLocation = document.createElement('br')
li.appendChild(brBeforeLocation)
const textnodeLocation = document.createTextNode(location)
li.appendChild(textnodeLocation)
}
}
list.appendChild(li)
}
}
export function displayErrorMessage({ data, container }) {
hideLoadingIndicator(container)
if (
Object.prototype.hasOwnProperty.call(data, 'response') &&
Object.prototype.hasOwnProperty.call(data.response, 'errors') &&
data.response.errors.length > 0 &&
Object.prototype.hasOwnProperty.call(data.response.errors[0], 'code') &&
data.response.errors[0].code === 'group_not_found'
) {
const message = container.querySelector('.group-not-found')
message.style.display = 'block'
} else {
const message = container.querySelector('.general-error')
message.style.display = 'block'
console.error(data)
}
}
export function showLoadingIndicator(container) {
const indicator = container.querySelector('.loading-indicator')
indicator.style.display = 'block'
}
function hideLoadingIndicator(container) {
const indicator = container.querySelector('.loading-indicator')
indicator.style.display = 'none'
}
export function hideErrorMessages(container) {
container.querySelector('.group-not-found').style.display = 'none'
container.querySelector('.general-error').style.display = 'none'
}

View File

@ -0,0 +1,73 @@
import test from 'ava'
import Formatter from './formatter.js'
test('#formatDate one date', (t) => {
const date = Formatter.formatDate({
start: '2021-04-15T10:30:00Z',
end: '2021-04-15T15:30:00Z',
})
t.is(date, '15/04/2021 10:30 - 15:30')
})
test('#formatDate one date with short offset name', (t) => {
const date = Formatter.formatDate({
start: '2021-04-15T10:30:00Z',
end: '2021-04-15T15:30:00Z',
isShortOffsetNameShown: true,
})
t.is(date, '15/04/2021 10:30 - 15:30 (UTC)')
})
test('#formatDate two dates', (t) => {
const date = Formatter.formatDate({
start: '2021-04-15T10:30:00Z',
end: '2021-04-16T15:30:00Z',
})
t.is(date, '15/04/2021 10:30 - 16/04/2021 15:30')
})
test('#formatDate two dates with short offset name', (t) => {
const date = Formatter.formatDate({
start: '2021-04-15T10:30:00Z',
end: '2021-04-16T15:30:00Z',
isShortOffsetNameShown: true,
})
t.is(date, '15/04/2021 10:30 - 16/04/2021 15:30 (UTC)')
})
test('#formatDate second date is null', (t) => {
const date = Formatter.formatDate({
start: '2021-04-15T10:30:00Z',
end: null,
})
t.is(date, '15/04/2021 10:30')
})
test('#formatDate second date is null with short offset name', (t) => {
const date = Formatter.formatDate({
start: '2021-04-15T10:30:00Z',
end: null,
isShortOffsetNameShown: true,
})
t.is(date, '15/04/2021 10:30 (UTC)')
})
test('#formatLocation both parameters', (t) => {
const location = Formatter.formatLocation({ description: 'a', locality: 'b' })
t.is(location, 'a, b')
})
test('#formatLocation description only', (t) => {
const location = Formatter.formatLocation({ description: 'a' })
t.is(location, 'a')
})
test('#formatLocation description with space only', (t) => {
const location = Formatter.formatLocation({ description: ' ' })
t.is(location, '')
})
test('#formatLocation locality only', (t) => {
const location = Formatter.formatLocation({ locality: 'a' })
t.is(location, 'a')
})

45
source/front/formatter.js Normal file
View File

@ -0,0 +1,45 @@
import DateTimeWrapper from './date-time-wrapper.js'
export default class Formatter {
static formatDate({ locale, timeZone, start, end, isShortOffsetNameShown }) {
const startDateTime = new DateTimeWrapper({
locale,
text: start,
timeZone,
})
let dateText = startDateTime.getShortDate()
dateText += ' ' + startDateTime.get24Time()
if (!end && isShortOffsetNameShown) {
dateText += ' (' + startDateTime.getShortOffsetName() + ')'
}
if (end) {
const endDateTime = new DateTimeWrapper({ locale, text: end, timeZone })
if (!startDateTime.equalsDate(endDateTime)) {
dateText += ' - '
dateText += endDateTime.getShortDate() + ' '
} else {
dateText += ' - '
}
dateText += endDateTime.get24Time()
if (isShortOffsetNameShown) {
dateText += ' (' + endDateTime.getShortOffsetName() + ')'
}
}
return dateText
}
static formatLocation({ description, locality }) {
let location = ''
if (description && description.trim()) {
location += description.trim()
}
if (location && locality) {
location += ', '
}
if (locality) {
location += locality
}
return location
}
}

View File

@ -0,0 +1,15 @@
import test from 'ava'
import browserEnv from 'browser-env'
import { createAnchorElement } from './html-creator.js'
test.beforeEach(() => {
browserEnv()
})
test('#createAnchorElement usual parameters', (t) => {
const a = createAnchorElement({ document, text: 'a', url: 'b' })
t.is(a.tagName, 'A')
t.is(a.innerHTML, 'a')
t.is(a.getAttribute('href'), 'b')
})

View File

@ -1,4 +1,4 @@
export function createAnchorElement({ text, url }) {
export function createAnchorElement({ document, text, url }) {
const a = document.createElement('a')
a.setAttribute('href', url)
a.setAttribute('target', '_blank')

53
source/includes/Api.php Normal file
View File

@ -0,0 +1,53 @@
<?php
namespace MobilizonConnector;
class Api {
public static function init() {
add_action('rest_api_init', 'MobilizonConnector\Api::init_api');
}
public static function init_api() {
register_rest_route(
NAME . '/v1',
'/events',
[
'methods' => 'GET',
'callback' => 'MobilizonConnector\Api::get_events',
'args' => [
'eventsCount' => [
'required' => true,
'validate_callback' => function($param, $request, $key) {
return is_numeric($param) && $param > 0;
}
],
'groupName' => [
'validate_callback' => function($param, $request, $key) {
return !is_numeric($param);
}
]
],
'permission_callback' => '__return_true',
]
);
}
public static function get_events($request) {
$eventsCount = $request['eventsCount'];
$groupName = isset($request['groupName']) ? $request['groupName'] : '';
$url = Settings::getUrl();
try {
if ($groupName) {
$events = GraphQlClient::get_upcoming_events_by_group_name($url, (int) $eventsCount, $groupName);
} else {
$events = GraphQlClient::get_upcoming_events($url, (int) $eventsCount);
}
return $events;
} catch (GeneralException $e) {
return new \WP_Error('events_not_loading', 'The events could not be loaded!', array('status' => 500));
} catch (GroupNotFoundException $e) {
return new \WP_Error('group_not_found', sprintf('The group "%s" could not be found!', $groupName), array('status' => 404));
}
}
}

View File

@ -1,12 +1,6 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
const DEFAULT_EVENTS_COUNT = 5;
const NAME = '<wordpress-name>';
const NICE_NAME = '<wordpress-nice-name>';
const TEXT_DOMAIN = '<wordpress-name>';

View File

@ -0,0 +1,34 @@
<?php
namespace MobilizonConnector;
final class DateTimeWrapper {
private $dateTime;
private $locale;
private $timeZone;
public function __construct(string $text, string $locale = 'en-GB', string $timeZone = 'utc') {
if (!$locale) {
$locale = 'en-GB';
}
if (!$timeZone) {
$timeZone = 'utc';
}
$this->dateTime = new \DateTime($text);
$this->locale = $locale;
$this->timeZone = new \DateTimeZone($timeZone);
}
public function get24Time(): string {
$formatter = \IntlDateFormatter::create($this->locale, \IntlDateFormatter::NONE, \IntlDateFormatter::SHORT, $this->timeZone);
return $formatter->format($this->dateTime);
}
public function getShortDate(): string {
$formatter = \IntlDateFormatter::create($this->locale, \IntlDateFormatter::SHORT, \IntlDateFormatter::NONE, $this->timeZone);
return $formatter->format($this->dateTime);
}
public function getTimeZoneName(): string {
return $this->timeZone->getName();
}
}

View File

@ -0,0 +1,19 @@
<?php
namespace MobilizonConnector;
final class EventsCache {
private static $MAX_AGE_IN_S = 120;
public static function set(array $parameters, mixed $data): void {
// md5 is used as key must be 172 characters or fewer in length.
$key = md5(json_encode($parameters));
set_transient($key, $data, self::$MAX_AGE_IN_S);
}
public static function get(array $parameters): mixed {
$key = md5(json_encode($parameters));
$data = get_transient($key);
return $data;
}
}

View File

@ -0,0 +1,65 @@
<?php
namespace MobilizonConnector;
class EventsListBlock {
public static function initAndReturnScriptName(): string {
$scriptName = NAME . '-block-starter';
wp_register_script($scriptName, plugins_url(NAME . '/front/block-events-loader.js'), [
'wp-block-editor',
'wp-blocks',
'wp-components',
'wp-i18n'
]);
register_block_type(NAME . '/events-list', [
'api_version' => 2,
'title' => __('Events List', 'connector-mobilizon'),
'description' => __('A list of the upcoming events of the connected Mobilizon instance.', 'connector-mobilizon'),
'category' => 'widgets',
'icon' => 'list-view',
'supports' => [
'html' => false
],
'attributes' => [
'eventsCount' => [
'type' => 'number',
'default' => 3,
],
'groupName' => [
'type' => 'string',
],
],
'editor_script' => $scriptName,
'render_callback' => 'MobilizonConnector\EventsListBlock::render',
]);
return $scriptName;
}
public static function render($block_attributes, $content) {
$url = Settings::getUrl();
$eventsCount = $block_attributes['eventsCount'];
$groupName = isset($block_attributes['groupName']) ? $block_attributes['groupName'] : '';
$classNamePrefix = NAME;
ob_start();
try {
if ($groupName) {
$events = GraphQlClient::get_upcoming_events_by_group_name($url, (int) $eventsCount, $groupName);
} else {
$events = GraphQlClient::get_upcoming_events($url, (int) $eventsCount);
}
$locale = get_locale();
$isShortOffsetNameShown = Settings::isShortOffsetNameShown();
$timeZone = wp_timezone_string();
require dirname(__DIR__) . '/view/events-list.php';
} catch (GeneralException $e) {
require dirname(__DIR__) . '/view/events-list-not-loaded.php';
} catch (GroupNotFoundException $e) {
require dirname(__DIR__) . '/view/events-list-group-not-found.php';
}
$output = ob_get_clean();
return $output;
}
}

View File

@ -1,11 +1,6 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
class EventsListShortcut {
public static function init() {
@ -24,14 +19,29 @@ class EventsListShortcut {
), $atts
);
$classNamePrefix = NAME;
$url = Settings::getUrl();
$eventsCount = $atts_with_overriden_defaults['events-count'];
$groupName = $atts_with_overriden_defaults['group-name'];
$url = Settings::getUrl();
$textDomain = TEXT_DOMAIN;
$classNamePrefix = NAME;
ob_start();
require dirname(__DIR__) . '/view/events-list.php';
try {
if ($groupName) {
$events = GraphQlClient::get_upcoming_events_by_group_name($url, (int) $eventsCount, $groupName);
} else {
$events = GraphQlClient::get_upcoming_events($url, (int) $eventsCount);
}
$locale = get_locale();
$isShortOffsetNameShown = Settings::isShortOffsetNameShown();
$timeZone = wp_timezone_string();
require dirname(__DIR__) . '/view/events-list.php';
} catch (GeneralException $e) {
require dirname(__DIR__) . '/view/events-list-not-loaded.php';
} catch (GroupNotFoundException $e) {
require dirname(__DIR__) . '/view/events-list-group-not-found.php';
}
$output = ob_get_clean();
return $output;
}

View File

@ -1,19 +1,14 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
class EventsListWidget extends \WP_Widget {
public function __construct() {
parent::__construct(
NAME . '-events-list',
NICE_NAME . ' ' . esc_html__('Events List', TEXT_DOMAIN),
NICE_NAME . ' ' . __('Events List', 'connector-mobilizon'),
array(
'description' => __('A list of the upcoming events of the connected Mobilizon instance.', TEXT_DOMAIN),
'description' => __('A list of the upcoming events of the connected Mobilizon instance.', 'connector-mobilizon'),
),
);
}
@ -25,22 +20,36 @@ class EventsListWidget extends \WP_Widget {
echo $args['before_title'].apply_filters('widget_title', $options['title']).$args['after_title'];
}
$classNamePrefix = NAME;
$url = Settings::getUrl();
$eventsCount = $options['eventsCount'];
$groupName = isset($options['groupName']) ? $options['groupName'] : '';
$url = Settings::getUrl();
$textDomain = TEXT_DOMAIN;
$classNamePrefix = NAME;
require dirname(__DIR__) . '/view/events-list.php';
try {
if ($groupName) {
$events = GraphQlClient::get_upcoming_events_by_group_name($url, (int) $eventsCount, $groupName);
} else {
$events = GraphQlClient::get_upcoming_events($url, (int) $eventsCount);
}
$locale = get_locale();
$isShortOffsetNameShown = Settings::isShortOffsetNameShown();
$timeZone = wp_timezone_string();
require dirname(__DIR__) . '/view/events-list.php';
} catch (GeneralException $e) {
require dirname(__DIR__) . '/view/events-list-not-loaded.php';
} catch (GroupNotFoundException $e) {
require dirname(__DIR__) . '/view/events-list-group-not-found.php';
}
echo $args['after_widget'];
}
public function form($options) {
$title = !empty($options['title']) ? $options['title'] : esc_html__('Events', TEXT_DOMAIN);
$title = !empty($options['title']) ? $options['title'] : __('Events', 'connector-mobilizon');
$eventsCount = !empty($options['eventsCount']) ? $options['eventsCount'] : DEFAULT_EVENTS_COUNT;
$groupName = !empty($options['groupName']) ? $options['groupName'] : '';
$textDomain = TEXT_DOMAIN;
require dirname(__DIR__) . '/view/events-list-widget/form.php';
}

View File

@ -0,0 +1,42 @@
<?php
namespace MobilizonConnector;
final class Formatter
{
public static function format_date(string $locale, string $timeZone, string $start, ?string $end, bool $isShortOffsetNameShown): string {
$startDateTime = new DateTimeWrapper($start, $locale, $timeZone);
$dateText = $startDateTime->getShortDate();
$dateText .= ' ' . $startDateTime->get24Time();
if (!$end && $isShortOffsetNameShown) {
$dateText .= ' (' . $startDateTime->getTimeZoneName() . ')';
}
if ($end) {
$endDateTime = new DateTimeWrapper($end, $locale, $timeZone);
if ($startDateTime->getShortDate() != $endDateTime->getShortDate()) {
$dateText .= ' - ';
$dateText .= $endDateTime->getShortDate() . ' ';
} else {
$dateText .= ' - ';
}
$dateText .= $endDateTime->get24Time();
if ($isShortOffsetNameShown) {
$dateText .= ' (' . $endDateTime->getTimeZoneName() . ')';
}
}
return $dateText;
}
public static function format_location(string $description, string $locality): string {
$location = '';
if ($description && trim($description)) {
$location .= trim($description);
}
if ($location && $locality) {
$location .= ', ';
}
if ($locality) {
$location .= $locality;
}
return $location;
}
}

View File

@ -0,0 +1,113 @@
<?php
namespace MobilizonConnector;
final class GraphQlClient {
public static function query(string $endpoint, string $query, array $variables = [], ?string $token = null): array
{
$headers = ['Content-Type: application/json'];
if ($token !== null) {
$headers[] = "Authorization: bearer $token";
}
$context = stream_context_create([
'http' => [
'method' => 'POST',
'header' => $headers,
'content' => json_encode(['query' => $query, 'variables' => $variables]),
]
]);
$data = @file_get_contents($endpoint, false, $context);
if ($data === false) {
$error = error_get_last();
throw new \ErrorException($error['message'], $error['type']);
}
return json_decode($data, true);
}
public static function get_upcoming_events(string $url, int $limit): array {
$query = <<<'GRAPHQL'
query ($limit: Int) {
events(limit: $limit) {
elements {
id,
title,
url,
beginsOn,
endsOn,
physicalAddress {
description,
locality
}
},
total
}
}
GRAPHQL;
$cachedEvents = EventsCache::get(['url' => $url, 'query' => $query, 'limit' => $limit]);
if ($cachedEvents !== false) {
return $cachedEvents;
}
$endpoint = $url . '/api';
$data = self::query($endpoint, $query, ['limit' => $limit]);
self::checkData($data);
$events = $data['data']['events']['elements'];
EventsCache::set(['url' => $url, 'query' => $query, 'limit' => $limit], $events);
return $events;
}
public static function get_upcoming_events_by_group_name(string $url, int $limit, string $groupName): array {
$query = <<<'GRAPHQL'
query ($afterDatetime: DateTime, $groupName: String!, $limit: Int) {
group(preferredUsername: $groupName) {
organizedEvents(afterDatetime: $afterDatetime, limit: $limit) {
elements {
id,
title,
url,
beginsOn,
endsOn,
physicalAddress {
description,
locality
}
},
total
}
}
}
GRAPHQL;
$afterDatetime = date(\DateTime::ISO8601);
$cachedEvents = EventsCache::get(['url' => $url, 'query' => $query, 'afterDatetime' => $afterDatetime, 'groupName' => $groupName, 'limit' => $limit]);
if ($cachedEvents !== false) {
return $cachedEvents;
}
$endpoint = $url . '/api';
$data = self::query($endpoint, $query, ['afterDatetime' => $afterDatetime, 'groupName' => $groupName, 'limit' => $limit]);
self::checkData($data);
$events = $data['data']['group']['organizedEvents']['elements'];
EventsCache::set(['url' => $url, 'query' => $query, 'afterDatetime' => $afterDatetime, 'groupName' => $groupName, 'limit' => $limit], $events);
return $events;
}
private static function checkData($data) {
if (isset($data['errors'])) {
if (count($data['errors']) > 0 &&
isset($data['errors'][0]['code']) &&
$data['errors'][0]['code'] === 'group_not_found') {
throw new GroupNotFoundException(serialize($data['errors'][0]));
} else {
throw new GeneralException(serialize($data['errors']));
}
}
}
}

View File

@ -1,17 +1,15 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
class Settings {
private static $DEFAULT_OPTION_URL = 'https://mobilizon.fr';
private static $DEFAULT_IS_SHORT_OFFSET_NAME_SHOWN = false;
private static $PAGE_NAME = 'wordpress_mobilizon';
private static $OPTIONS_GROUP_NAME = 'wordpress_mobilizon';
private static $OPTION_NAME_IS_SHORT_OFFSET_NAME_SHOWN = 'wordpress_mobilizon_is_short_offset_name_shown';
private static $OPTION_NAME_URL = 'wordpress_mobilizon_url';
private static $SETTING_FIELD_NAME_IS_SHORT_OFFSET_NAME_SHOWN = 'wordpress_mobilizon_field_is_short_offset_name_shown';
private static $SETTING_FIELD_NAME_URL = 'wordpress_mobilizon_field_url';
private static $SETTINGS_SECTION_NAME = 'wordpress_mobilizon_section_general';
@ -21,6 +19,10 @@ class Settings {
}
public static function init_settings() {
register_setting(
self::$OPTIONS_GROUP_NAME,
self::$OPTION_NAME_IS_SHORT_OFFSET_NAME_SHOWN
);
register_setting(
self::$OPTIONS_GROUP_NAME,
self::$OPTION_NAME_URL,
@ -29,14 +31,14 @@ class Settings {
add_settings_section(
self::$SETTINGS_SECTION_NAME,
__('General Settings', TEXT_DOMAIN),
__('General Settings', 'connector-mobilizon'),
'',
self::$PAGE_NAME
);
add_settings_field(
self::$SETTING_FIELD_NAME_URL,
__('URL', TEXT_DOMAIN),
__('URL', 'connector-mobilizon'),
'MobilizonConnector\Settings::output_field_url',
self::$PAGE_NAME,
self::$SETTINGS_SECTION_NAME,
@ -44,10 +46,24 @@ class Settings {
'label_for' => self::$SETTING_FIELD_NAME_URL
)
);
add_settings_field(
self::$SETTING_FIELD_NAME_IS_SHORT_OFFSET_NAME_SHOWN,
__('Display named offset', 'connector-mobilizon'),
'MobilizonConnector\Settings::output_field_is_short_offset_name_shown',
self::$PAGE_NAME,
self::$SETTINGS_SECTION_NAME,
array(
'label_for' => self::$SETTING_FIELD_NAME_IS_SHORT_OFFSET_NAME_SHOWN
)
);
}
public static function output_field_is_short_offset_name_shown($args) {
$isShortOffsetNameShown = self::isShortOffsetNameShown();
require dirname(__DIR__) . '/view/settings/is-short-offset-name-shown-field.php';
}
public static function output_field_url($args) {
$textDomain = TEXT_DOMAIN;
$url = self::getUrl();
require dirname(__DIR__) . '/view/settings/url-field.php';
}
@ -58,7 +74,7 @@ class Settings {
add_settings_error(
self::$OPTION_NAME_URL,
'wordpress_mobilizon_field_url_error',
__('The URL is invalid.', TEXT_DOMAIN),
__('The URL is invalid.', 'connector-mobilizon'),
'error'
);
}
@ -70,7 +86,7 @@ class Settings {
public static function register_settings_page() {
add_options_page(
NICE_NAME . ' ' . __('Settings', TEXT_DOMAIN),
NICE_NAME . ' ' . __('Settings', 'connector-mobilizon'),
NICE_NAME,
'manage_options',
NAME . '-settings',
@ -85,15 +101,21 @@ class Settings {
require dirname(__DIR__) . '/view/settings/page.php';
}
public static function isShortOffsetNameShown() {
return get_option(self::$OPTION_NAME_IS_SHORT_OFFSET_NAME_SHOWN);
}
public static function getUrl() {
return get_option(self::$OPTION_NAME_URL);
}
public static function setDefaultOptions() {
add_option(self::$OPTION_NAME_IS_SHORT_OFFSET_NAME_SHOWN, self::$DEFAULT_IS_SHORT_OFFSET_NAME_SHOWN);
add_option(self::$OPTION_NAME_URL, self::$DEFAULT_OPTION_URL);
}
public static function deleteAllOptions() {
delete_option(self::$OPTION_NAME_IS_SHORT_OFFSET_NAME_SHOWN);
delete_option(self::$OPTION_NAME_URL);
}

View File

@ -0,0 +1,12 @@
<?php
namespace MobilizonConnector;
class GeneralException extends \Exception {
public function __construct($message, $code = 0, Throwable $previous = null) {
parent::__construct($message, $code, $previous);
}
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
}
}

View File

@ -0,0 +1,12 @@
<?php
namespace MobilizonConnector;
class GroupNotFoundException extends \Exception {
public function __construct($message, $code = 0, Throwable $previous = null) {
parent::__construct($message, $code, $previous);
}
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
}
}

206
source/readme.txt Normal file
View File

@ -0,0 +1,206 @@
# <wordpress-nice-name>
Contributors: dwaxweiler
Donate link: <wordpress-donation-link>
Tags: mobilizon, events
Stable tag: <wordpress-version>
Requires at least: <wordpress-minimum-version>
Tested up to: <wordpress-tested-up-to-version>
Requires PHP: <wordpress-php-minimum-version>
License: <wordpress-license>
<wordpress-description>
## Description
<wordpress-nice-name> allows you to display the upcoming events of [Mobilizon](https://joinmobilizon.org/), which is a federated event listing platform, on your WordPress website.
Features
- Display events as Gutenberg block, as widget and as shortcut
- Display events' title with link, date, and location, if available
- Cache requests' responses for 2 minutes in the database
- Configure number of events to show per block, per widget and per shortcut
- Optionally filter events by a specific public group per block, per widget and per shortcut
- Set the URL of the Mobilizon instance in the settings
- Toggle adding named offset in brackets after the time in the settings
This plugin requests the events via Mobilizon's GraphQL API.
The source code is available on [Github](https://github.com/dwaxweiler/connector-mobilizon).
## Installation
Shortcut format with limiting the number of events to show to 3 for example: `[<wordpress-name>-events-list events-count=3]`
Optionally, you can only show the events of a specific group by indicatings its name: `[<wordpress-name>-events-list events-count=3 group-name="mygroup"]`
You have to use their username, e.g. `@nosliensvivants`, and append the name of their instance if they use a different one, e.g. `@yaam_berlin@mobilize.berlin`.
## Screenshots
1. Events list
2. General settings
3. Widget creation
4. Shortcut creation
5. Gutenberg block in editor
## Changelog
### [1.1.0]
#### Added
- Add some spacing between event items
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.6
#### Fixed
- Fix undefined variable $classNamePrefix for both error views
### [1.0.0]
#### Added
- Display name of group when it cannot be found
#### Changed
- Let backend do requests to API of Mobilizon instance for increased privacy
- Update dependencies
#### Fixed
- Fix displaying more than one block in the editor
### [0.11.5]
#### Changed
- Confirm compatibility with WordPress 6.5
### [0.11.4]
#### Changed
- Confirm compatibility with WordPress 6.4
- Update dependencies
### [0.11.3]
#### Fixed
- Clean up distributed files
### [0.11.2]
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.3
### [0.11.1]
#### Fixed
- Revert minimum PHP version to 7.4 to allow some more time for upgrading PHP
### [0.11.0]
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.2
#### Security
- Set minimum PHP version to oldest stable 8.0
### [0.10.1]
#### Changed
- Confirm compatibility with WordPress 6.1
- Update dependencies
### [0.10.0]
#### Added
- Add Gutenberg events list block
- Show loading indicator during request
#### Changed
- Set list style type to none and left padding to zero for all occurences
- Move shortcut usage description into installation section in `readme.txt`
- Update dependencies
### [0.9.1] - 2020-05-19
#### Fixed
- Fix WordPress compatibility version number
### [0.9.0] - 2020-05-19
#### Added
- Improve explanation of group name filter
#### Changed
- Update dependencies
- Confirm compatibility with WordPress 6.0
#### Fixed
- Fix displaying error message for the case the group is not found
### [0.8.0] - 2022-01-09
#### Added
- Add support for older browsers using babel
#### Changed
- Confirm compatibility with WordPress 5.9
- Update dependencies
#### Fixed
- Use ES modules correctly
- Trim events' location
### [0.7.0] - 2021-12-23
#### Added
- Add specific error message for the case the group is not found
- Add code formatter prettier
#### Changed
- Update dependencies
- Simplify build process
#### Fixed
- Fix Invalid DateTime on event end time being null
#### Security
- Set minimum PHP version to oldest stable 7.4
### [0.6.2] - 2021-08-24
#### Changed
- Update dependencies
#### Fixed
- Fix empty WordPress timezone_string option resulting in Invalid DateTime
### [0.6.1] - 2021-07-13
#### Changed
- Confirm compatibility with WordPress 5.8
- Update dependencies
### [0.6.0] - 2021-06-02
#### Added
- Optionally display the current offset as short name after the time via the general plugin settings
#### Changed
- Update dependencies
#### Fixed
- Capitalise Mobilizon name in description
### [0.5.0] - 2021-05-06
#### Added
- Localise dates based on the WordPress locale and time zone
#### Changed
- Clearly list features in `readme.txt` description
- Update dev dependencies c8, eslint, gulp-replace, webpack
#### Fixed
- Improve translatability
### [0.4.0] - 2021-04-20
#### Added
- Show events' location if set: `description` and `locality` fields
- Plugin icon
#### Changed
- Update dev dependencies eslint, jsdom, webpack
### [0.3.0] - 2021-04-05
#### Added
- Donation link to WordPress Plugin Directory sidebar and to `package.json`
- Cache requests for 2 minutes
- Set up ESLint static code analysis
#### Changed
- Update luxon dependency
- Update dev dependencies jsdom, webpack, webpack-cli
### [0.2.2] - 2021-03-10
#### Changed
- Confirm compatibility with WordPress 5.7
- Update graphql dependency
- Update dev dependencies jsdom, webpack, webpack-cli, webpack-stream
### [0.2.1] - 2021-01-15
#### Fixed
- Add missing backtick to `readme.txt`
### [0.2.0] - 2021-01-15
#### Added
- `changelog.txt`
- Changelog maintenance steps to `README.md`
- Link to Github repository in `readme.txt`
- Option to show events of a specific group by indicating its name
#### Changed
- Use same Markdown style in `README.md` as in other documents
### [0.1.0] - 2021-01-09
initial release

View File

@ -1,6 +1,6 @@
<?php
require_once __DIR__ . '/includes/constants.php';
require_once __DIR__ . '/includes/settings.php';
require_once __DIR__ . '/includes/Constants.php';
require_once __DIR__ . '/includes/Settings.php';
// If uninstall.php is not called by WordPress, exit.
if (!defined('WP_UNINSTALL_PLUGIN')) {

View File

@ -0,0 +1,11 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
?>
<div class="<?php echo esc_attr($classNamePrefix); ?>_events-list">
<?php echo esc_html(sprintf(__('The group "%s" could not be found!', 'connector-mobilizon'), $groupName)); ?>
</div>

View File

@ -0,0 +1,11 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
?>
<div class="<?php echo esc_attr($classNamePrefix); ?>_events-list">
<?php esc_html_e('The events could not be loaded!', 'connector-mobilizon'); ?>
</div>

View File

@ -1,18 +1,20 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
?>
<p>
<label for="<?php echo esc_attr($this->get_field_id('title')); ?>"><?php esc_attr_e('Title', $textDomain); ?>:</label>
<label for="<?php echo esc_attr($this->get_field_id('title')); ?>"><?php esc_html_e('Title', 'connector-mobilizon'); ?>:</label>
<input class="widefat" id="<?php echo esc_attr($this->get_field_id('title')); ?>" name="<?php echo esc_attr($this->get_field_name('title')); ?>" type="text" value="<?php echo esc_attr($title); ?>">
</p>
<p>
<label for="<?php echo esc_attr($this->get_field_id('eventsCount')); ?>"><?php esc_attr_e('Number of events to show', $textDomain); ?>:</label>
<label for="<?php echo esc_attr($this->get_field_id('eventsCount')); ?>"><?php esc_html_e('Number of events to show', 'connector-mobilizon'); ?>:</label>
<input class="tiny-text" id="<?php echo esc_attr($this->get_field_id('eventsCount')); ?>" name="<?php echo esc_attr($this->get_field_name('eventsCount')); ?>" type="number" value="<?php echo esc_attr($eventsCount); ?>" min="1">
</p>
<p>
<label for="<?php echo esc_attr($this->get_field_id('groupName')); ?>"><?php esc_attr_e('Group name (optional)', $textDomain); ?>:</label>
<label for="<?php echo esc_attr($this->get_field_id('groupName')); ?>"><?php esc_html_e('Group name (optional)', 'connector-mobilizon'); ?>:</label>
<input class="widefat" id="<?php echo esc_attr($this->get_field_id('groupName')); ?>" name="<?php echo esc_attr($this->get_field_name('groupName')); ?>" type="text" value="<?php echo esc_attr($groupName); ?>">
</p>

View File

@ -0,0 +1,23 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
?>
<div class="<?php echo esc_attr($classNamePrefix); ?>_events-list">
<ul style="list-style-type: none; padding-left: 0;">
<?php foreach($events as $event) { ?>
<li style="margin-top: 10px;">
<a href="<?php echo esc_attr($event['url']); ?>"><?php echo esc_html_e($event['title']); ?></a>
<br>
<?php echo esc_html_e(Formatter::format_date($locale, $timeZone, $event['beginsOn'], $event['endsOn'], $isShortOffsetNameShown)); ?>
<?php if (isset($event['physicalAddress'])) { ?>
<br>
<?php echo esc_html_e(Formatter::format_location($event['physicalAddress']['description'], $event['physicalAddress']['locality'])) ?>
<?php } ?>
</li>
<?php } ?>
</ul>
</div>

View File

@ -0,0 +1,15 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
}
?>
<input id="<?php echo esc_attr($args['label_for']); ?>"
name="<?php echo esc_attr(self::$OPTION_NAME_IS_SHORT_OFFSET_NAME_SHOWN); ?>"
type="checkbox"
<?php echo $isShortOffsetNameShown == true ? 'checked' : ''; ?>>
<p class="description">
<?php esc_html_e('The time zone of this WordPress installation is used. Whether the current offset should be displayed in brackets after the time, e.g. 10:00 (UTC)', 'connector-mobilizon'); ?>
</p>

View File

@ -1,4 +1,6 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;

View File

@ -1,4 +1,6 @@
<?php
namespace MobilizonConnector;
// Exit if this file is called directly.
if (!defined('ABSPATH')) {
exit;
@ -10,5 +12,5 @@ if (!defined('ABSPATH')) {
type="url"
value="<?php echo esc_attr($url); ?>">
<p class="description">
<?php esc_html_e('The URL of the Mobilizon instance whose events you want to list, e.g. https://example.net', $textDomain); ?>
<?php esc_html_e('The URL of the Mobilizon instance whose events you want to list, e.g. https://example.net', 'connector-mobilizon'); ?>
</p>

View File

@ -0,0 +1,47 @@
<?php
declare(strict_types=1);
use MobilizonConnector\DateTimeWrapper;
use PHPUnit\Framework\TestCase;
final class DateTimeWrapperTest extends TestCase {
public function testCanGet24TimeForUsualTime(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z');
$this->assertSame('16:45', $d->get24Time());
}
public function testCanGetShortDateForUsualDate(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z');
$this->assertSame('24/12/2020', $d->getShortDate());
}
public function testCanGetShortDateForUsualDateWithLocaleWithUnderscore(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z');
$this->assertSame('24/12/2020', $d->getShortDate(), 'en_GB');
}
public function testCanGetShortDateForUsualDateWithTimezoneString(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z', 'en-GB', 'Europe/Rome');
$this->assertSame('24/12/2020', $d->getShortDate());
}
public function testCanGetShortDateForUsualDateWithNamedOffset(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z', 'en-GB', 'UTC');
$this->assertSame('24/12/2020', $d->getShortDate());
}
public function testCanGetShortDateForUsualDateWithOffset(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z', 'en-GB', '+02:00');
$this->assertSame('24/12/2020', $d->getShortDate());
}
public function testCanGetShortDateForUsualDateWithEmptyTimezone(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z', 'en-GB', '');
$this->assertSame('24/12/2020', $d->getShortDate());
}
public function testCanGetShortOffsetNameForUsualTime(): void {
$d = new DateTimeWrapper('2020-12-24T16:45:00Z');
$this->assertSame('UTC', $d->getTimeZoneName());
}
}

52
tests/FormatterTest.php Normal file
View File

@ -0,0 +1,52 @@
<?php
declare(strict_types=1);
use MobilizonConnector\Formatter;
use PHPUnit\Framework\TestCase;
final class FormatterTest extends PHPUnit\Framework\TestCase
{
public function testCanDateFormatOneDate(): void {
$this->assertSame('15/04/2021 10:30 - 15:30', Formatter::format_date('en-GB', 'UTC', '2021-04-15T10:30:00Z', '2021-04-15T15:30:00Z', false));
}
public function testCanDateFormatOneDateWithOffset(): void {
$this->assertSame('15/04/2021 10:30 - 15:30 (UTC)', Formatter::format_date('en-GB', 'UTC', '2021-04-15T10:30:00Z', '2021-04-15T15:30:00Z', true));
}
public function testCanDateFormatOneDateWithTimeZoneOffset(): void {
$this->assertSame('15/04/2021 11:30 - 16:30', Formatter::format_date('en-GB', '+01:00', '2021-04-15T10:30:00Z', '2021-04-15T15:30:00Z', false));
}
public function testCanDateFormatTwoDates(): void {
$this->assertSame('15/04/2021 10:30 - 16/04/2021 15:30', Formatter::format_date('en-GB', 'UTC', '2021-04-15T10:30:00Z', '2021-04-16T15:30:00Z', false));
}
public function testCanDateFormatTwoDatesWithOffset(): void {
$this->assertSame('15/04/2021 10:30 - 16/04/2021 15:30 (UTC)', Formatter::format_date('en-GB', 'UTC', '2021-04-15T10:30:00Z', '2021-04-16T15:30:00Z', true));
}
public function testCanDateFormatWhenSecondDateIsNull(): void {
$this->assertSame('15/04/2021 10:30', Formatter::format_date('en-GB', 'UTC', '2021-04-15T10:30:00Z', null, false));
}
public function testCanDateFormatWhenSecondDateIsNullWithOffset(): void {
$this->assertSame('15/04/2021 10:30 (UTC)', Formatter::format_date('en-GB', 'UTC', '2021-04-15T10:30:00Z', null, true));
}
public function testCanLocationFormatBothParameters(): void {
$this->assertSame('a, b', Formatter::format_location('a', 'b'));
}
public function testLocationFormatDescriptionOnly(): void {
$this->assertSame('a', Formatter::format_location('a', ''));
}
public function testLocationFormatDescriptionWithSpaceOnly(): void {
$this->assertSame('', Formatter::format_location(' ', ''));
}
public function testLocationFormatLocalityOnly(): void {
$this->assertSame('a', Formatter::format_location('', 'a'));
}
}

46
webpack.config.cjs Normal file
View File

@ -0,0 +1,46 @@
/* eslint-disable no-undef */
const path = require('path')
const CopyPlugin = require('copy-webpack-plugin')
const FOLDER_SOURCE = './source'
module.exports = {
entry: {
'block-events-loader': FOLDER_SOURCE + '/front/block-events-loader.js',
},
output: {
filename: '[name].js',
path: path.resolve(__dirname, 'build/front'),
},
module: {
rules: [
{
test: /\.m?js$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader',
options: {
presets: [['@babel/preset-env', { targets: 'defaults' }]],
},
},
},
],
},
plugins: [
new CopyPlugin({
patterns: [
{
context: FOLDER_SOURCE,
from: '**/*.php',
to: '../',
},
{
context: FOLDER_SOURCE,
from: '**/*.txt',
to: '../',
},
],
}),
],
}