openhab-scripting 2.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5c554c32f29417abb195eca4ab36ebffb6a1f5dad807e71c15b5bbe2228a6c5
+  data.tar.gz: 9355d486f42858c69feda536b8846969d6486530a13c13b2a47dfcb813869c4d
+SHA512:
+  metadata.gz: 8aaf8b2c5f27c638ef612ee0604818e845900dacfa548a37046116c55c804609b9f6e59194be101a909d140a734a5551029add33aec1713d0b0f907f1e0d320c
+  data.tar.gz: c193b11a25f445884dc88b47588697de809cbd4ea7740dcb329b89eb2137657e339e3b3ed5637df5590bf25a977b7d09db397d01bd4fa399f510dc8ffdd6cad8

data/.github/workflows/workflow.yml

@@ -0,0 +1,327 @@
+name: Openhab-JRuby-Scripting
+
+on: 
+  pull_request:
+  push:
+    branches:
+      - main
+
+env:
+  RUBY_VERSION: 2.5
+  GITHUB_TOKEN: ${{ github.token }}
+
+jobs:
+
+ rubocop:
+   runs-on: ubuntu-18.04
+   continue-on-error: true
+   steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - name: Install bundler
+       run: gem install bundler -N
+     - name: Gem Cache
+       uses: actions/cache@v2
+       with: 
+        path: vendor/bundle
+        key: gems-${{ hashFiles('**/Gemfile.lock') }}
+     - name: Install gems
+       run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+     - name: Rubocop 
+       run: bundle exec rubocop
+
+ commit-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v2
+
+ cucumber-lint:
+   runs-on: ubuntu-18.04
+   continue-on-error: true
+   steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - name: Install bundler
+       run: gem install bundler -N       
+     - name: Gem Cache
+       uses: actions/cache@v2
+       with: 
+        path: vendor/bundle
+        key: gems-${{ hashFiles('**/Gemfile.lock') }}
+     - name: Install gems
+       run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+     - name: Cucumber Lint 
+       run: bundle exec cuke_linter
+ 
+ yard-coverage:
+   runs-on: ubuntu-18.04
+   steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - name: Install bundler
+       run: gem install bundler -N       
+     - name: Gem Cache
+       uses: actions/cache@v2
+       with: 
+        path: vendor/bundle
+        key: gems-${{ hashFiles('**/Gemfile.lock') }}
+     - name: Install gems
+       run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+     - name: Yard Coverage
+       run: |
+            bundle exec yard stats --list-undoc
+            bundle exec yard stats | grep "100.00% documented"
+
+
+ openhab-setup:
+   runs-on: ubuntu-18.04
+   steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - uses: actions/setup-java@v1
+       with:
+         java-version: '11.0.8' 
+         java-package: jre
+     - name: Install bundler
+       run: gem install bundler -N
+     - name: Cache Gems 
+       uses: actions/cache@v2
+       with: 
+        path: vendor/bundle
+        key: gems-${{ hashFiles('**/Gemfile.lock') }}
+     - name: Install gems
+       run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+     - name: Cache OpenHAB setup
+       id: cache
+       uses: actions/cache@v2
+       with: 
+        path: tmp/
+        key: OpenHAB-setup-${{ hashFiles('bundle/*jrubyscripting*.jar') }}
+     - name: Setup OpenHAB
+       if: steps.cache.outputs.cache-hit != 'true'
+       run: bundle exec rake openhab:setup
+ 
+ cucumber-matrix:
+   runs-on: ubuntu-18.04
+   outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+   steps: 
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - id: set-matrix
+       run: |
+         JSON=$(ruby -e '
+           require "json"
+           feature_maps = Dir["features/**/*.feature"].map { |feature| { feature: File.basename(feature,".feature"), file: feature } } 
+           include_map = {}
+           include_map["include"]= feature_maps
+           puts include_map.to_json
+         ') 
+         echo $JSON
+         echo "::set-output name=matrix::$( echo "$JSON" )"
+
+ cucumber:
+    needs: [cucumber-matrix, openhab-setup]
+    runs-on: ubuntu-18.04
+    strategy:
+      matrix:  ${{fromJson(needs.cucumber-matrix.outputs.matrix)}}
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '11.0.8' 
+          java-package: jre
+      - name: Install bundler
+        run: gem install bundler -N
+      - name: Restore Gems 
+        uses: actions/cache@v2
+        with: 
+          path: vendor/bundle
+          key: gems-${{ hashFiles('**/Gemfile.lock') }}
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Restore OpenHAB setup
+        uses: actions/cache@v2
+        with: 
+          path: tmp/
+          key: OpenHAB-setup-${{ hashFiles('bundle/*jrubyscripting*.jar') }}
+      - name: Cucumber
+        run: bundle exec rake features[${{ matrix.file }}]
+      - name: Generate OpenHAB Dump
+        run: bundle exec rake openhab:dump
+        if: failure()
+      - name: Upload OpenHAB Logs
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: OpenHAB-logs-${{ github.workflow }}-${{ github.run_number }}-${{ matrix.feature }}
+          path: |
+            tmp/cucumber_logs
+            tmp/karaf.log
+            tmp/openhab/userdata/logs
+            tmp/openhab/userdata/*.zip
+            tmp/openhab/conf/automation/jsr223/ruby/personal/
+          retention-days: 2
+
+ pickles-docs:
+  if: github.ref == 'refs/heads/main'
+  runs-on: windows-latest
+  steps:
+    - uses: actions/checkout@v2
+    - name: Install pickles
+      run: choco install pickles
+    - name: Generate Pickles docs
+      shell: cmd
+      run:  |
+          call refreshenv
+          pickles -f features -o pickles --df html || VER>NUL
+    - uses: actions/upload-artifact@v2
+      with:
+        name: pickles-docs
+        path: pickles/
+        if-no-files-found: error
+        retention-days: 1
+  
+ docs:
+   needs: [cucumber, pickles-docs]
+   if: github.ref == 'refs/heads/main'
+   runs-on: ubuntu-18.04
+   steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - name: Install bundler
+       run: gem install bundler -N
+     - name: Gem Cache
+       uses: actions/cache@v2
+       with: 
+        path: vendor/bundle
+        key: gems-${{ hashFiles('**/Gemfile.lock') }}
+     - name: Install gems
+       run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+     - name: Build yard docs
+       run: |
+          bundle exec rake yard
+     - name: Download pickles docs
+       uses: actions/download-artifact@v2
+       with:
+         name: pickles-docs
+         path: docs/pickles
+     - name: Publish docs
+       uses: JamesIves/github-pages-deploy-action@3.7.1
+       with:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+         BRANCH: gh-pages 
+         FOLDER: docs 
+         CLEAN: true 
+         SINGLE_COMMIT: true 
+
+ 
+ release:
+   needs: cucumber 
+   if: github.ref == 'refs/heads/main'
+   runs-on: ubuntu-18.04
+   steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-ruby@v1
+       with:
+         ruby-version: ${{ env.RUBY_VERSION }}
+     - name: Install bundler
+       run: gem install bundler -N
+     - name: Gem Cache
+       uses: actions/cache@v2
+       with: 
+        path: vendor/bundle
+        key: gems-${{ hashFiles('**/Gemfile.lock') }}
+     - name: Install gems
+       run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+     - name: Current Version 
+       id: current_version
+       run: |
+          bundle exec rake version
+          VERSION=$( bundle exec rake version )
+          echo "::set-output name=version::$( echo "$VERSION" )"
+     - name: Gets latest created release info
+       id: latest_release
+       run: |
+          git fetch --tags
+          git tag | tail -1
+          TAG_NAME=$(git tag | tail -1)
+          echo "::set-output name=tag_name::$( echo "$TAG_NAME" )"
+     - name: Prepare Release
+       if:  ${{ steps.current_version.outputs.version != steps.latest_release.outputs.tag_name}}
+       run: |
+          echo "New version detected, preparing release"
+          echo "Released Version: ${{ steps.latest_release.outputs.tag_name }}" 
+          echo "Current Version: ${{ steps.current_version.outputs.version }}" 
+          bundle exec rake gh:package
+     - name: Get JRuby Bundle
+       id: jruby_bundle
+       if:  ${{ steps.current_version.outputs.version != steps.latest_release.outputs.tag_name}}
+       run: |
+          echo "Finding JRuby Bundle"
+          BUNDLE=$(ls bundle/*.jar)
+          echo "Found: $BUNDLE"
+          echo "::set-output name=file::$( echo "$BUNDLE" )"
+     - name: Create Release
+       if:  ${{ steps.current_version.outputs.version != steps.latest_release.outputs.tag_name}}
+       uses: actions/create-release@v1
+       id: create_release
+       env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+       with:
+         prerelease: true
+         tag_name: ${{ steps.current_version.outputs.version }}
+         release_name: Release ${{ steps.current_version.outputs.version }}
+         body_path: CHANGELOG.md
+     - name: Upload OpenHAB JRuby Scripting Assets
+       if:  ${{ steps.current_version.outputs.version != steps.latest_release.outputs.tag_name}}
+       uses: actions/upload-release-asset@v1
+       env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+       with:
+         upload_url: ${{ steps.create_release.outputs.upload_url }} 
+         asset_path: ./pkg/OpenHABJRuby-${{steps.current_version.outputs.version}}.zip
+         asset_name: OpenHABJRuby-${{steps.current_version.outputs.version}}.zip
+         asset_content_type: application/zip
+     - name: Upload OpenHAB JRuby Bundle Assets
+       if:  ${{ steps.current_version.outputs.version != steps.latest_release.outputs.tag_name}}
+       uses: actions/upload-release-asset@v1
+       env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+       with:
+         upload_url: ${{ steps.create_release.outputs.upload_url }} 
+         asset_path: ${{ steps.jruby_bundle.outputs.file }}
+         asset_name: OpenHAB JRuby Bundle Jar
+         asset_content_type: application/jar

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/_site/
+/docs/.jekyll-cache/
+/docs/yard/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.obsidian/
+openhab.code-workspace
+/.idea/
+.java-verison
+.ruby-version
+.jekyll-cache/

data/.java-version

@@ -0,0 +1 @@
+11.0.8

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--output-dir docs/yard

data/CHANGELOG.md

@@ -0,0 +1,113 @@
+# JRuby OpenHAB Scripting change log
+
+All notable changes to this project will be documented in this file.
+
+Project versioning adheres to [Semantic Versioning](http://semver.org/). <br>
+Commit convention is based on [Conventional Commits](http://conventionalcommits.org). <br>
+Change log format is based on [Keep a Changelog](http://keepachangelog.com/). <br>
+
+## 2.9.0
+### Added
+- Support OpenHAB Actions
+
+## 2.8.1
+### Fixed
+- Fixed StringItem comparison against a string
+
+## 2.8.0
+### Added
+- Support for accessing item metadata namespace, value, and configuration
+
+## 2.7.0
+### Added
+- SwitchItem.toggle to toggle a SwitchItem similar to SwitchItem << !SwitchItem
+
+## 2.6.1
+### Fixed
+- Race condition with `after` block
+- Unknown constant error in certain cases uses `between` blocks
+
+## 2.6.0
+### Added
+- `TimeOfDay.between?` to check if TimeOfDay object is between supplied range
+### Fixed
+- Reference in rules to TimeOfDay::ALL_DAY
+
+
+## 2.5.1
+### Fixed
+- Corrected time of day parsing to be case insensitive
+- Merge conflict
+
+## 2.5.0
+### Added
+- `between` can be used throughout rules systems
+#### Changed
+- TimeOfDay parsing now supports AM/PM
+
+## 2.4.0
+### Added
+- Support to allow comparison of TimeOfDay objects against strings
+- Support for storing and restoring Item states
+
+## 2.3.0
+### Added
+- Support for rule description
+
+## 2.2.1
+### Fixed
+- `!` operator on SwitchItems now returns ON if item is UNDEF or NULL
+
+## 2.2.0
+### Added
+- Support for thing triggers in rules
+
+### Changed
+- Updated docs to point to OpenHAB document for script locations
+
+## 2.1.0 
+### Added
+- Timer delegate for 'active?', 'running?', 'terminated?'
+
+## 2.0.1
+### Fixed
+- Logging of mod and/or inputs can cause an exception of they are nil
+- Timers (after) now available inside of rules
+
+### Changed
+ - DSL imports now shared by OpenHAB module and Rules Module
+
+## 2.0.0
+### Added
+- Timer delegate for `after` method that supports reschedule
+
+### Changed
+- **Breaking:** `after` now returns a ruby Timer delegate
+
+## 1.1.0
+### Added
+- Added support for channels triggers to rules
+ 
+### Changed
+- Fixed documentation for changed/updated/receive_command options
+
+## 1.0.0
+### Changed
+- **Breaking:** Changed commanded method for rules to received_command
+
+## 0.2.0
+### Added
+- Ability to execute rules based on commands sent to items, groups and group members
+- Ability to send updates from item objects
+
+### Changed
+- Fixed documentation for comparing dimensioned items against strings
+
+## 0.1.0
+### Added
+- Support for item updates within rules languages
+### Changed
+- Installation instructions to specify using latest release rather than a specific version
+
+## 0.0.1 
+- Initial release