Basic PreUpVer Test

commit 8a932f6a8876f58dde4f0d87dea19ab7e31a3bcf Author: Llewellyn van der Merwe Date: Tue Nov 28 10:36:29 2023 +0200 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..882936f --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules +coverage +.idea \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..8e5fa85 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright (c) 2023 Llewellyn van der Merwe + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8c02b23 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# PreUpVer Library + +## Introduction + +PreUpVer is a versatile JavaScript library designed to automatically update the version numbers of library scripts in your documentation. It identifies specific `

` tags on your webpage and updates them with the latest version tag fetched from a specified repository, ensuring your documentation always displays up-to-date information.
+
+## Installation
+
+To use PreUpVer in your project, include the minified library in the header of your HTML page:
+
+```html
+
+
+```
+
+## How It Works
+
+PreUpVer operates by searching for `` tags with a designated class (`preupver`) and using their data attributes to perform version updates. It simplifies the process of keeping your library references up-to-date in documentation.
+
+### Automatic Detection and Updating
+
+When the webpage loads, PreUpVer finds all `` tags marked with the `preupver` class. It then extracts necessary details from their data attributes and updates each tag with the latest library version.
+
+### Usage
+
+1. **Marking `` Tags:**
+
+   Add the `class="preupver"` to `` tags in your HTML and define the required data attributes for automatic updating:
+
+   ```html
+   +   
+   ```
+
+   Replace `unique-id`, `username`, `library`, and other placeholders with your specific details.
+
+2. **Attributes Explained:**
+
+   - `id`: A unique identifier for the `` tag.
+   - `data-api-url`: The API URL to fetch the latest library version.
+   - `data-description`: A brief description of the library script.
+   - `data-url`: The URL of the script, where `${version}` will be replaced with the latest version number.
+
+### Example
+
+Check out the [tests](https://git.vdm.dev/Llewellyn/PreUpVer/src/branch/master/tests/) folder for the examples we use to test if this library works as expected.
+
+## Advanced Usage
+
+For more advanced scenarios, PreUpVer also provides `TargetLibrary` and `IncludeVersionUpdater` classes, which can be used to manually configure and update `` tags. This is particularly useful for custom implementations or testing purposes.
+
+### Manual Configuration
+
+You can manually create instances of `TargetLibrary` and `IncludeVersionUpdater` for specific `` tags. Refer to the `/tests` directory in the repository for examples and test cases.
+
+## Contributing
+
+We welcome contributions to PreUpVer. Please refer to the repository's contribution guidelines for more information on how to contribute.
+
+## License
+
+PreUpVer is open-source software licensed under the [MIT license](https://git.vdm.dev/Llewellyn/PreUpVer/src/branch/master/LICENSE.md).
diff --git a/dist/js/preupver.js b/dist/js/preupver.js
new file mode 100644
index 0000000..da1bdf1
--- /dev/null
+++ b/dist/js/preupver.js
@@ -0,0 +1,294 @@
+/**
+ * PreUpVer v1.0.0
+ * https://git.vdm.dev/Llewellyn/PreUpVer
+ * (c) 2014 - 2023 Llewellyn van der Merwe
+ * MIT License
+ **/
+
+(function (factory) {
+  typeof define === 'function' && define.amd ? define(factory) :
+  factory();
+})((function () { 'use strict';
+
+  /**
+   * Class for managing local storage of data.
+   */
+  class Memory {
+    // Constant representing one day in milliseconds.
+    static ONE_DAY_IN_MILLISECONDS = 24 * 60 * 60 * 1000;
+
+    /**
+     * Stores data in local storage.
+     *
+     * @param {string} key - The data key.
+     * @param {Object} data - The scripture data to be stored.
+     * @throws {Error} If storing data fails.
+     */
+    static set(key, data) {
+      const item = {
+        data,
+        timestamp: Date.now(),
+      };
+      try {
+        localStorage.setItem(key, JSON.stringify(item));
+      } catch (error) {
+        console.error('Error storing data in local storage:', error);
+        throw error;
+      }
+    }
+
+    /**
+     * Retrieves data from local storage.
+     *
+     * @param {string} key - The data key.
+     * @returns {Promise} The scripture data or null if not found.
+     */
+    static async get(key) {
+      try {
+        const storedItem = localStorage.getItem(key);
+        if (storedItem) {
+          const {data, timestamp} = JSON.parse(storedItem);
+          if (timestamp > Date.now() - Memory.ONE_DAY_IN_MILLISECONDS) {
+            return data;
+          }
+        }
+        return null;
+      } catch (error) {
+        console.error('Error parsing or retrieving data from local storage:', error);
+        throw error;
+      }
+    }
+  }
+
+  /**
+   * Class for handling API calls to fetch scripture data.
+   */
+  class Api {
+    /**
+     * Fetches data from the API, using local storage to cache responses.
+     *
+     * @param {string} apiEndpoint - The endpoint URL for the API.
+     * @param {string} key - The data key.
+     * @returns {Promise

Updated version in Pre Include text