Iterators and Enumarables

.circleci/config.yml

@@ -0,0 +1,75 @@
+version: 2.1
+
+jobs:
+  test:
+    parameters:
+      version:
+        type: string
+        default: "1.21"
+    docker:
+      - image: cimg/go:<<parameters.version>>
+    environment:
+      TEST_RESULTS: /tmp/test-results
+    working_directory: ~/gods
+    steps:
+      - run:
+          name: Print Go version (go version)
+          command: |
+            go version
+      - checkout
+      - run:
+          name: Run tests
+          command: |
+            mkdir -p $TEST_RESULTS
+            go install gotest.tools/gotestsum@latest
+            go test -v ./... | go tool test2json > $TEST_RESULTS/test2json-output.json
+            gotestsum --junitfile $TEST_RESULTS/gotestsum-report.xml
+      - run:
+          name: Calculate test coverage
+          command: |
+            mkdir -p $TEST_RESULTS
+            go test -coverprofile=coverage.out ./... > /dev/null
+            go test -race -coverprofile=coverage.txt -covermode=atomic ./... > /dev/null
+            go tool cover -html=coverage.out -o coverage.html
+            mv coverage.html $TEST_RESULTS
+      - run:
+          name: Upload test coverage
+          command: |
+            bash <(curl -s https://codecov.io/bash)
+      - run:
+          name: Lint (golint)
+          command: |
+            go install golang.org/x/lint/golint@latest
+            golint -set_exit_status ./...
+      - run:
+          name: Enforce formatted code (go fmt)
+          command: |
+            ! go fmt ./... 2>&1 | read
+      - run:
+          name: Examine and report suspicious constructs (go vet)
+          command: |
+            go vet -v ./...
+      - run:
+          name: Calculate cyclomatic complexity (gocyclo)
+          command: |
+            go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
+            gocyclo -avg -over 15 ../gods
+      - run:
+          name: Check for unchecked errors (errcheck)
+          command: |
+            go install github.com/kisielk/errcheck@latest
+            errcheck ./...
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: raw-test-output
+      - store_test_results:
+          path: /tmp/test-results
+
+workflows:
+  test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              # To test with and without generics (versions prior to 1.18)
+              version: [ "1.21" ]

.github/dependabot.yml

@@ -0,0 +1,8 @@
+# Ref: https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# 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: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '30 4 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      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@v2
+
+    # ℹ️ 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: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

LICENSE

@@ -20,4 +20,22 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+
+AVL Tree:
+
+Copyright (c) 2017 Benjamin Scher Purcell <benjapurcell@gmail.com>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.