Merge pull request #69 from bxparks/develop

merge v1.7.4 into master

Author: bxparks

.github/workflows/python_tools.yml

@@ -23,20 +23,17 @@ jobs:
     - name: Checkout AceTime
       uses: actions/checkout@v2
 
-    - name: Checkout 3rd Party Repos
+    - name: Checkout Additional Repos
       run: |
         cd ..
         git clone https://github.com/bxparks/EpoxyDuino
         git clone https://github.com/bxparks/AUnit
         git clone https://github.com/bxparks/AceCommon
+        git clone https://github.com/bxparks/AceTimeTools
+        git clone https://github.com/bxparks/AceTimeValidation
         git clone https://github.com/eggert/tz
         git clone https://github.com/HowardHinnant/date
 
-    - name: Install libcurl4-openssl-dev
-      run: |
-        sudo apt update
-        sudo apt install -y libcurl4-openssl-dev
-
     - name: Set up Python 3.7
       uses: actions/setup-python@v1
       with:
@@ -48,12 +45,16 @@ jobs:
     - name: Install Python Dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r tools/requirements.txt
+        pip install -r ../AceTimeTools/requirements.txt
+
+    - name: Install libcurl4-openssl-dev
+      run: |
+        sudo apt update
+        sudo apt install -y libcurl4-openssl-dev
 
     - name: Build compare_cpp
       run: |
-        cd tools/compare_cpp
-        make
+        make -C ../AceTimeTools/compare_cpp
 
     # Run just BasicHinnantDateTest and ExtendedHinnantDateTest. When a new
     # TZDB version comes out, the Python pytz, dateutil, and Java validation
@@ -62,10 +63,12 @@ jobs:
 
     - name: BasicHinnantDateTest
       run: |
-        make -C tests/validation/BasicHinnantDateTest
-        make -C tests/validation/BasicHinnantDateTest runtests
+        cd ../AceTimeValidation
+        make -C BasicHinnantDateTest
+        make -C BasicHinnantDateTest runtests
 
     - name: ExtendedHinnantDateTest
       run: |
-        make -C tests/validation/ExtendedHinnantDateTest
-        make -C tests/validation/ExtendedHinnantDateTest runtests
+        cd ../AceTimeValidation
+        make -C ExtendedHinnantDateTest
+        make -C ExtendedHinnantDateTest runtests

.github/workflows/validation.yml

@@ -1,6 +1,14 @@
 # Changelog
 
 * Unreleased
+* 1.7.4 (2021-08-26)
+    * Move `./tools` directory into new
+      [AceTimeTool](https://github.com/bxparks/AceTimeTools) repo.
+    * Move `./tests/validation` directory into new
+      [AceTimeValidation](https://github.com/bxparks/AceTimeValidation) repo.
+        * Update `.github/workflows/validation.yml` to use AceTimeValidation
+          instead of `./tests/validation`.
+    * This is a maintenance release. No changes to the core library code.
 * 1.7.3 (2021-08-25)
     * Fix numerous broken links in documents moved to `docs/*.md` in an earlier
       refactoring.
@@ -34,7 +42,7 @@
         * Use that for general questions and discussions.
         * Reserve [GitHub Issues](https://github.com/bxparks/AceTime/issues)
           for bugs and feature requests.
-    * Add `tools/compare_noda` to compare Noda Time against AceTime.
+    * Add `AceTimeTools/compare_noda` to compare Noda Time against AceTime.
         * Add `--nzd_file` flag to `compare_noda` to allow custom NodaZoneData
           files.
         * Run the Noda Time `TzdbCompiler` manually to generate custom

CHANGELOG.md

@@ -238,10 +238,11 @@ available.
   should be a sibling to the `AceTime` repo:
     * `$ cd ../date`
     * `$ git pull`
-* Verify that `AceTime` and Hinnant `date` agree with each other using the
-  same TZDB version.
+* Verify that the `AceTime` library and the Hinnant `date` library agree with
+  each other using the same TZDB version. This requires going into the
+  [AceTimeValidation](https://github.com/bxparks/AceTimeValidation) project.
     * BasicHinnantDateTest
-        * `$ cd tests/validation/BasicHinnantDateTest`
+        * `$ cd .../AceTimeValidation/BasicHinnantDateTest`
         * Update the `TZ_VERSION` variable in the `Makefile` with the commit tag
           of the new TZDB version. (e.g. `TZ_VERSION = 2020c`).
         * `$ make clean`
@@ -250,7 +251,7 @@ available.
         * There should be no failures: `TestRunner summary: 268 passed, 0
           failed, 0 skipped, 0 timed out, out of 268 test(s).`
     * ExtendedHinnantDateTest
-        * `$ cd tests/validation/ExtendedHinnantDateTest`
+        * `$ cd .../AceTimeValidation/ExtendedHinnantDateTest`
         * Update the `TZ_VERSION` variable in the `Makefile` with the commit tag
           of the new TZDB version. (e.g. `TZ_VERSION = 2020c`).
         * `$ make clean`
@@ -267,21 +268,21 @@ available.
         * `$ cd src/ace_time/zonedbx`
         * Edit the `Makefile` and update the `TZ_VERSION`.
         * `$ make`
-    * `tools/zonedbpy`
-        * `$ cd tools/zonedbpy`
+    * `AceTimeTools/zonedbpy`
+        * `$ cd AceTimeTools/zonedbpy`
         * Edit the `Makefile` and update the `TZ_VERSION`.
         * `$ make`
 * Update the CHANGELOG.md.
 * Commit the changes to git
     * `$ git add ...`
     * `$ git commit -m "..."`
 
-There are 6 other validation tests in `tests/validation` that compare AceTime
-with other 3rd party librarties (Python pytz, Python dateutil, and Java date).
-Unfortunately, they all seem to use the underlying TZDB version provided by the
-Operating System, and I have not been able to figure out how to manually update
-this dependency manually. When a new TZDB is released, all of these other tests
-will fail until the underying timezone database of the OS is updated.
+There are 6 other validation tests in the AceTimeValidation project that compare
+AceTime with other third party libraries (Python pytz, Python dateutil, and Java
+date). Unfortunately, they all seem to use the underlying TZDB version provided
+by the Operating System, and I have not been able to figure out how to manually
+update this dependency manually. When a new TZDB is released, all of these other
+tests will fail until the underlying timezone database of the OS is updated.
 
 ## Release Process
 
@@ -291,7 +292,6 @@ will fail until the underying timezone database of the OS is updated.
     * `docs/date_time_timezone.md`
     * `docs/clock_system_clock.md`
     * `docs/installation.md`
-    * `docs/validation.md`
     * ...
     * `docs/doxygen.cfg`
     * `library.properties`

DEVELOPER.md

@@ -1,7 +1,6 @@
 # AceTime
 
 [![AUnit Tests](https://github.com/bxparks/AceTime/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/bxparks/AceTime/actions/workflows/aunit_tests.yml)
-[![Python Tools](https://github.com/bxparks/AceTime/actions/workflows/python_tools.yml/badge.svg)](https://github.com/bxparks/AceTime/actions/workflows/python_tools.yml)
 [![Validation Tests](https://github.com/bxparks/AceTime/actions/workflows/validation.yml/badge.svg)](https://github.com/bxparks/AceTime/actions/workflows/validation.yml)
 
 The AceTime library provides Date, Time, and TimeZone classes which can convert
@@ -35,15 +34,10 @@ This library can be an alternative to the Arduino Time
 (https://github.com/PaulStoffregen/Time) and Arduino Timezone
 (https://github.com/JChristensen/Timezone) libraries.
 
-**Version**: 1.7.3 (2021-08-25, TZ DB version 2021a)
+**Version**: 1.7.4 (2021-08-26, TZ DB version 2021a)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
-**IMPORTANT CHANGE for v1.2**: This library now depends on the the "AceCommon"
-library for some of its low-level routines. See the
-[docs/installation.md](docs/installation.md) for
-installation instructions.
-
 ## Table of Contents
 
 * [Overview](#Overview)
@@ -279,7 +273,7 @@ The creation of a TimeZone from its zoneName or its zoneId using a
 ### Validation
 
 The details of how the Date, Time and TimeZone classes are validated are given
-in [docs/validation.md](docs/validation.md).
+in [AceTimeValidation](https://github.com/bxparks/AceTimeValidation).
 
 The ZoneInfo Database and the algorithms in this library have been validated to
 match the UTC offsets calculated using 5 other date/time libraries written in
@@ -607,15 +601,15 @@ The following boards are *not* supported:
     * megaAVR (e.g. Nano Every)
     * SAMD21 boards w/ `arduino:samd` version >= 1.8.10 (e.g. MKRZero)
     * MKRZero
-    * Raspberry Pi Pic RP2040
+    * Raspberry Pi Pico RP2040
 
 <a name="ToolChain"></a>
 ### Tool Chain
 
 This library was developed and tested using:
 
 * [Arduino IDE 1.8.13](https://www.arduino.cc/en/Main/Software)
-* [Arduino CLI 0.14.0](https://arduino.github.io/arduino-cli)
+* [Arduino CLI 0.15.2](https://arduino.github.io/arduino-cli)
 * [SpenceKonde ATTinyCore 1.5.2](https://github.com/SpenceKonde/ATTinyCore)
 * [Arduino AVR Boards 1.8.3](https://github.com/arduino/ArduinoCore-avr)
 * [Arduino SAMD Boards 1.8.9](https://github.com/arduino/ArduinoCore-samd)
@@ -627,9 +621,12 @@ This library was developed and tested using:
 * [Teensydino 1.53](https://www.pjrc.com/teensy/td_download.html)
 
 This library is *not* compatible with:
-* [Arduino megaAVR](https://github.com/arduino/ArduinoCore-megaavr/)
-* [MegaCoreX](https://github.com/MCUdude/MegaCoreX)
-* [Arduino SAMD Boards >=1.8.10](https://github.com/arduino/ArduinoCore-samd)
+
+* Any platform using the
+  [ArduinoCore-API](https://github.com/arduino/ArduinoCore-api), for example:
+    * [Arduino megaAVR](https://github.com/arduino/ArduinoCore-megaavr/)
+    * [MegaCoreX](https://github.com/MCUdude/MegaCoreX)
+    * [Arduino SAMD Boards >=1.8.10](https://github.com/arduino/ArduinoCore-samd)
 
 It should work with [PlatformIO](https://platformio.org/) but I have
 not tested it.

README.md

@@ -12,7 +12,7 @@ sense for these classes to be in a separate library because the other parts of
 AceTime library are not dependent of the Clock classes. But for now, these
 classes live within the AceTime library.
 
-**Version**: 1.7.3 (2021-08-25, TZ DB version 2021a)
+**Version**: 1.7.4 (2021-08-26, TZ DB version 2021a)
 
 ## Table of Contents
 

docs/clock_system_clock.md

@@ -122,7 +122,7 @@ based upon the `<chrono>` standard library and consists of several libraries of
 which `date.h` and `tz.h` are comparable to AceTime. Modified versions of these
 libraries were voted into the C++20 standard.
 
-Unfortunately these libaries are not suitable for an Arduino microcontroller
+Unfortunately these libraries are not suitable for an Arduino microcontroller
 environment because:
 
 * The libraries depend extensively on 64-bit integers which are
@@ -141,14 +141,14 @@ environment because:
   library.
 
 The Hinnant date libraries were invaluable for writing the
-[BasicHinnantDateTest](../tests/validation/BasicHinnantDateTest/)
+[BasicHinnantDateTest](https://github.com/bxparks/AceTimeValidation/tree/master/BasicHinnantDateTest)
 and
-[ExtendedHinnantDateTest](../tests/validation/ExtendedHinnantDateTest/)
+[ExtendedHinnantDateTest](https://github.com/bxparks/AceTimeValidation/tree/master/ExtendedHinnantDateTest)
 validation tests which compare the AceTime algorithms to the Hinnant Date
 algorithms. For all times zones between the years 2000 until 2050, the AceTime
 UTC offsets (`TimeZone::getUtcOffset()`), timezone abbreviations
 (`TimeZone::getAbbrev()`), and epochSecond conversion to date components
-(`ZonedDateTime::fromEpochSeconds()`) match the results from the Hinannt Date
+(`ZonedDateTime::fromEpochSeconds()`) match the results from the Hinnant Date
 libraries.
 
 <a name="Cctz"></a>

docs/comparisons.md

@@ -12,7 +12,7 @@ following namespaces:
   `ExtendedZoneManager`
 * `ace_time::internal`: not normally needed by app developers
 
-**Version**: 1.7.3 (2021-08-25, TZ DB version 2021a)
+**Version**: 1.7.4 (2021-08-26, TZ DB version 2021a)
 
 ## Table of Contents
 
@@ -2053,7 +2053,7 @@ C++ code representing these custom zone registries from a list of zones.)
 (**TBD**: It might also be useful for app developers to create custom datasets
 with different range of years. The tools are all here, but not explicitly
 documented currently. Examples of how to this do exist inside the various
-`Makefile` files in the `tests/validation/` directory.)
+`Makefile` files in the AceTimeValidation project.)
 
 <a name="PrintToString"></a>
 ## Print To String

docs/date_time_timezone.md

@@ -38,7 +38,7 @@ PROJECT_NAME           = "AceTime"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.7.3
+PROJECT_NUMBER         = 1.7.4
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

docs/doxygen.cfg

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">1.7.3</span>
+   &#160;<span id="projectnumber">1.7.4</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>
@@ -141,8 +141,8 @@
 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160; </div>
 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160; </div>
 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
-<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION 10703</span></div>
-<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION_STRING &quot;1.7.3&quot;</span></div>
+<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION 10704</span></div>
+<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION_STRING &quot;1.7.4&quot;</span></div>
 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160; </div>
 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->