Skip to content

Commit

Permalink
Add file comments with Jump banner
Browse files Browse the repository at this point in the history
  • Loading branch information
@daledavies
daledavies committed Jul 19, 2022
1 parent 93bab6b commit cc00b97
Show file tree
Hide file tree
Showing 29 changed files with 301 additions and 24 deletions.
1 change: 0 additions & 1 deletion docker/entrypoint.sh
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/env bash
set -Eeuo pipefail


echo >&2 "-------------------------------------------------------------"
echo >&2 "";
echo >&2 " ██ ██ ██ ███ ███ ██████"
Expand Down
14 changes: 11 additions & 3 deletions jumpapp/assets/js/src/classes/Clock.js
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
/**
* Calculate the time, local to the requested location from
* the OpenWeather API, by passing in the number of seconds
* that location has shifted from UTC based on the timezones.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

/**
* Calculate the time, local to the requested location from
* the OpenWeather API, by passing in the number of seconds
* that location has shifted from UTC based on the timezones.
*/
export default class Clock {
/**
* Calculate the time shifted from UTC.
Expand Down
12 changes: 12 additions & 0 deletions jumpapp/assets/js/src/classes/Greeting.js
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

import Clock from "./Clock";

export default class Greeting {
Expand Down
12 changes: 12 additions & 0 deletions jumpapp/assets/js/src/classes/Main.js
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

import Clock from './Clock';
import EventEmitter from 'eventemitter3';
import Fuse from 'fuse.js';
Expand Down
10 changes: 9 additions & 1 deletion jumpapp/assets/js/src/classes/SearchSuggestions.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
/**
* Generate search suggestions.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

/**
* Generate search suggestions.
*/
export default class SearchSuggestions {

constructor(searchengines, inputelm, containerelm, eventemitter) {
Expand Down
12 changes: 12 additions & 0 deletions jumpapp/assets/js/src/classes/Weather.js
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

export default class Weather {

/**
Expand Down
11 changes: 10 additions & 1 deletion jumpapp/assets/js/src/index.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
/**
* Do some fancy UI stuff in a rather unfancy way.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

/**
* Do some fancy UI stuff in a rather unfancy way.
*/

import Main from './classes/Main';
import version from '../../../.jump-version';

Expand Down
11 changes: 10 additions & 1 deletion jumpapp/background-css.php
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
<?php
/**
* Generate dynamic CSS for randomising the background image.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

/**
* Generate dynamic CSS for randomising the background image.
*/

// Provided by composer for psr-4 style autoloading.
require __DIR__ .'/vendor/autoload.php';

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/API/AbstractAPI.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\API;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/API/Icon.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\API;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/API/Unsplash.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\API;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/API/Weather.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\API;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Background.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Cache.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Config.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Exceptions/TagNotFoundException.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\Exceptions;

Expand Down
11 changes: 8 additions & 3 deletions jumpapp/classes/Main.php
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
<?php

/**
* TO DO:
* - use CSRF token in weatherdata and icon api
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump;
Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Pages/AbstractPage.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\Pages;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Pages/ErrorPage.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\Pages;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Pages/HomePage.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\Pages;

Expand Down
11 changes: 11 additions & 0 deletions jumpapp/classes/Pages/TagPage.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump\Pages;

Expand Down
14 changes: 11 additions & 3 deletions jumpapp/classes/SearchEngines.php
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <[email protected]>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/

namespace Jump;

use \Exception;

/**
* Loads and validates the search engines defined in searchengines.json.
*
* @author Dale Davies <[email protected]>
* @license MIT
*/
class SearchEngines {
private array $default;
Expand Down
Loading

0 comments on commit cc00b97

Please sign in to comment.