Feature/quantum

.ameba.yml

@@ -0,0 +1,61 @@
+Excluded:
+  - repositories/**/*.cr
+
+Lint/DebugCalls:
+  Excluded:
+  - drivers/**/*_spec.cr
+
+# NOTE: These should all be reviewed on an individual basis to see if their
+#       complexity can be reasonably reduced.
+Metrics/CyclomaticComplexity:
+  Description: Disallows methods with a cyclomatic complexity higher than `MaxComplexity`
+  MaxComplexity: 10
+  Excluded:
+  - drivers/helvar/net.cr
+  - drivers/mulesoft/booking_api.cr
+  - drivers/samsung/displays/mdc_protocol.cr
+  - drivers/cisco/dna_spaces.cr
+  - drivers/cisco/meraki/dashboard.cr
+  - drivers/cisco/switch/snooping_catalyst.cr
+  - drivers/gantner/relaxx/protocol_json.cr
+  - drivers/place/bookings.cr
+  - drivers/place/area_management.cr
+  - drivers/place/smtp.cr
+  - drivers/hitachi/projector/cp_tw_series_basic.cr
+  - drivers/panasonic/projector/nt_control.cr
+  - drivers/lumens/dc193.cr
+  Enabled: false
+  Severity: Convention
+
+Lint/UselessAssign:
+  Description: Disallows useless variable assignments
+  # NOTE: Not enabled due to the extremely large hit count.
+  #       Discussion with driver authors on whether this pattern is intended.
+  Enabled: false
+  Severity: Warning
+
+Style/VerboseBlock:
+  Description: Identifies usage of collapsible single expression blocks.
+  ExcludeCallsWithBlock: false
+  ExcludeMultipleLineBlocks: true
+  ExcludeOperators: false
+  ExcludePrefixOperators: false
+  ExcludeSetters: true
+  Enabled: false
+  Severity: Convention
+
+Style/VariableNames:
+  Description: Enforces variable names to be in underscored case
+  # NOTE: Not enabled due to the extremely large hit count.
+  #       Discussion with driver authors on whether this pattern is intended.
+  Enabled: false
+  Severity: Convention
+
+# NOTE: These appear to be triggered by assignment in case expressions, could be an ameba bug
+Lint/ShadowingOuterLocalVar:
+  Description: Disallows the usage of the same name as outer local variables for block
+    or proc arguments.
+  Excluded:
+  - drivers/cisco/switch/snooping_catalyst.cr
+  Enabled: true
+  Severity: Warning

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'Bug: A concise description of the behaviour'
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behaviour or a minimal code snippet that demonstrates the behaviour.
+
+**Expected behaviour**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots or a paste of terminal output**
+
+If applicable, add screenshots to help explain your problem.
+
+**Versions (please complete the following information):**
+
+- Output of `$ crystal version`
+- Driver version [e.g. 3.x] 
+
+**Additional context**
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/driver_migration.md

@@ -0,0 +1,20 @@
+---
+name: Driver Migration
+about: Migrate existing Ruby Engine Driver to Crystal
+title: 'Driver Migration: Migrate existing Ruby driver'
+labels: driver
+assignees: ''
+
+---
+
+**Driver to be Migrated**
+
+Information about the driver to be migrated.
+
+**Link to Existing Driver**
+
+Link to existing Driver on Ruby Drivers Repo.
+
+**Additional context**
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/driver_request.md

@@ -0,0 +1,32 @@
+---
+name: Driver Request
+about: Request a new driver to be created
+title: 'Driver Request: Information required to create a new driver'
+labels: driver
+assignees: ''
+
+---
+
+**Driver Type**
+
+Logic/Device/SSH/Websocket
+
+**Manufacturer**
+
+Manufacturer of device, software or service
+
+**Model/Service**
+
+Model or Service
+
+**Link to or Attach Device API or Protocol**
+
+If applicable, add screenshots to help explain your problem.
+
+**Describe any desired functionality**
+
+- Control all aspects of device
+
+**Additional context**
+
+Add any other context about the driver request here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'RFC: Concise description of desired feature'
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build.yml

@@ -0,0 +1,42 @@
+name: Build and Publish Drivers
+on:
+  push:
+    branches: [master]
+
+env:
+  CRYSTAL_VERSION: 1.4.1
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    environment: Build
+    steps:
+      - uses: actions/checkout@v3
+
+      # Binary Cache Logic
+      #############################################################################################
+
+      - uses: actions/cache@v3
+        with:
+          path: binaries
+          key: drivers-${{ env.CRYSTAL_VERSION }}-${{ github.run_id }}
+          restore-keys: drivers-${{ env.CRYSTAL_VERSION }}-
+
+      #############################################################################################
+
+      - uses: FranzDiebold/github-env-vars-action@v2  # https://github.com/github/feedback/discussions/5251
+      - name: Build Drivers
+        run: |
+          ./harness build \
+            --discover \
+            --strict-driver-info \
+            --repository-uri https://github.com/${{ github.repository }} \
+            --repository-path ./repositories/local \
+            --ref ${{ github.sha }}
+        env:
+          CRYSTAL_VERSION: ${{ env.CRYSTAL_VERSION }}
+          AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
+          AWS_SECRET: ${{ secrets.AWS_SECRET }}
+          AWS_KEY: ${{ secrets.AWS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}

.github/workflows/ci.yml

@@ -0,0 +1,136 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: "0 6 * * 1"
+
+env:
+  PARALLEL_TESTS: 10
+  PARALLEL_BUILDS: 2
+
+jobs:
+  docs:
+    if: false # Temporarily disable as docs just _do not work_ for a driver
+    name: "Crystal Docs"
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container: crystallang/crystal
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Shards
+        run: shards install --ignore-crystal-version
+      - name: Docs
+        run: crystal docs
+
+  style:
+    name: "Style"
+    uses: PlaceOS/.github/.github/workflows/crystal-style.yml@main
+
+  subset-report:
+    name: "Subset Report - crystal: ${{ matrix.crystal }}, stable: ${{ matrix.stable }}"
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ !matrix.stable }}
+    strategy:
+      fail-fast: false
+      matrix:
+        stable: [true]
+        crystal:
+          - 1.3.2
+          - 1.4.1
+        include:
+          - stable: false
+            crystal: nightly
+    steps:
+      - id: changes
+        uses: trilom/file-changes-action@v1.2.4
+        with:
+          output: ' '
+      - uses: actions/checkout@v3
+      - name: Cache shards
+        uses: actions/cache@v3
+        with:
+          path: lib
+          key: ${{ hashFiles('shard.lock') }}
+      - name: Driver Report
+        # Skip subset report if dependencies have changed
+        if: ${{ !contains(steps.changes.outputs.files, 'shard.yml') && !contains(steps.changes.outputs.files, 'shard.lock')  }}
+        run: |
+          ./harness \
+          report \
+            --verbose \
+            --tests=${{ env.PARALLEL_TESTS }} \
+            --builds=${{ env.PARALLEL_BUILDS }} \
+            ${{ steps.changes.outputs.files }}
+        env:
+          AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          CRYSTAL_VERSION: ${{ matrix.crystal }}
+      - name: Upload failure logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: logs-${{ matrix.crystal }}-${{ github.sha }}
+          path: .logs/*.log
+
+  full-report:
+    name: "Full Report - crystal: ${{ matrix.crystal }}, stable: ${{ matrix.stable }}"
+    needs: subset-report
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ !matrix.stable }}
+    strategy:
+      fail-fast: false
+      matrix:
+        stable: [true]
+        crystal:
+          - 1.3.2
+          - 1.4.1
+        include:
+          - stable: false
+            crystal: nightly
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Cache shards
+        uses: actions/cache@v3
+        with:
+          path: lib
+          key: ${{ hashFiles('shard.lock') }}
+
+      # Binary Cache Logic
+      #############################################################################################
+
+      - uses: actions/cache@v3
+        with:
+          path: binaries
+          key: drivers-${{ env.CRYSTAL_VERSION }}-${{ github.run_id }}
+          restore-keys: drivers-${{ env.CRYSTAL_VERSION }}-
+
+      #############################################################################################
+
+      - name: Driver Report
+        run: |
+          ./harness \
+          report \
+            --verbose \
+            --tests=${{ env.PARALLEL_TESTS }} \
+            --builds=${{ env.PARALLEL_BUILDS }}
+        env:
+          AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          CRYSTAL_VERSION: ${{ matrix.crystal }}
+      - name: Show build container logs
+        if: ${{ failure() }}
+        run: docker-compose logs build
+      - name: Show drivers container logs
+        if: ${{ failure() }}
+        run: docker-compose logs drivers
+      - name: Upload failure logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: logs-${{ matrix.crystal }}-${{ github.sha }}
+          path: .logs/*.log

.gitignore

@@ -1,6 +1,14 @@
-doc
-lib
+*.dwarf
+*.rdb
+.DS_Store
 .crystal
 .shards
 app
-*.dwarf
+bin
+doc
+docs
+binaries
+lib
+.logs
+repositories/*
+src

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug",
+      "type": "gdb",
+      "request": "launch",
+      "target": "./bin/test-harness",
+      "cwd": "${workspaceRoot}",
+      "preLaunchTask": "Compile",
+      "setupCommands": [
+        { "text": "-gdb-set follow-fork-mode child" }
+      ]
+    }
+  ]
+}