openhab-scripting 2.9.1 → 2.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5c554c32f29417abb195eca4ab36ebffb6a1f5dad807e71c15b5bbe2228a6c5
-  data.tar.gz: 9355d486f42858c69feda536b8846969d6486530a13c13b2a47dfcb813869c4d
+  metadata.gz: daa36a09bcefbd672716ede992f1525cf81edbf3db5bef1b40e46f7ab0a46837
+  data.tar.gz: 871e30faf15a2bd26010c5d118c26cbc569182bf7b849217b5b751148ec95fb7
 SHA512:
-  metadata.gz: 8aaf8b2c5f27c638ef612ee0604818e845900dacfa548a37046116c55c804609b9f6e59194be101a909d140a734a5551029add33aec1713d0b0f907f1e0d320c
-  data.tar.gz: c193b11a25f445884dc88b47588697de809cbd4ea7740dcb329b89eb2137657e339e3b3ed5637df5590bf25a977b7d09db397d01bd4fa399f510dc8ffdd6cad8
+  metadata.gz: fe9756bf909c3061d9824cf4a072ddd1e4c83ebdcec5710ebb166db4a9b302d06942bc3a10ab00a89acc28ab6db2c716a1adfd5cf39beee2462fbf253525bb84
+  data.tar.gz: '039eec961406e82062744e131aeb8da4db95dc613c9da0c017f0be70d77edae181f40bdbb49693b8b5244dbcabc9289470fb77eca2033f596285fcc5c0dc1a72'

data/lib/openhab/core/dsl/gems.rb

@@ -1,29 +1,4 @@
 # frozen_string_literal: true
 
 require 'core/log'
-
-begin
-  require 'bundler/inline'
-
-  include Logging
-  logger.debug('Bundler required')
-rescue LoadError
-  include Logging
-  logger.debug('Bundler not found installing')
-
-  begin
-    require 'rubygems/commands/install_command'
-    cmd = Gem::Commands::InstallCommand.new
-    cmd.handle_options ['--no-document', 'bundler', '-v', '2.1.4']
-    cmd.execute
-    logger.debug('Bundler is installed')
-    require 'bundler/inline'
-  rescue Gem::SystemExitException => e
-    if e.exit_code.zero?
-      logger.debug('Bundler is installed')
-      require 'bundler/inline'
-    else
-      logger.error("Error installing bundler, exit code: #{e}")
-    end
-  end
-end
+require 'bundler/inline'

data/lib/openhab/core/dsl/rule/item.rb

@@ -97,6 +97,7 @@ module OpenHAB
           #
           def updated(*items, to: nil)
             items.flatten.each do |item|
+              item = item.group if item.is_a? Group
               logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
               [to].flatten.each do |to_state|
                 case item

data/lib/openhab/core/dsl/rule/rule.rb

@@ -303,6 +303,23 @@ module OpenHAB
             false
           end
 
+          #
+          # Patch event to include event.item when it doesn't exist
+          # This is to patch a bug see https://github.com/boc-tothefuture/openhab-jruby/issues/75
+          # It may be fixed in the openhab core in the future, in which case, this patch will no longer be necessary
+          #
+          # @param [OpenHAB Event] event to check for item accessor
+          # @param [OpenHAB Event Inputs] inputs inputs to running rule
+          #
+          def add_event_item(event, inputs)
+            return if event.nil? || defined?(event.item)
+
+            class << event
+              attr_accessor :item
+            end
+            event.item = inputs&.dig('triggeringItem')
+          end
+
           #
           # Process the run queue
           #
@@ -317,7 +334,7 @@ module OpenHAB
               when RuleConfig::Run
 
                 event = inputs&.dig('event')
-
+                add_event_item(event, inputs)
                 logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
                 task.block.call(event)
               when RuleConfig::Trigger

data/lib/openhab/core/duration.rb

@@ -64,6 +64,15 @@ module OpenHAB
           @amount * 1000 * 60 * 60
         end
       end
+
+      #
+      # Return a string representation of the duration
+      #
+      # @return [String] Duration in string
+      #
+      def to_s
+        "#{@amount} #{(@amount == 1) ? @temporal_unit.to_s.downcase.delete_suffix('s') : @temporal_unit.to_s.downcase}"
+      end
     end
   end
 end

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '2.9.1'
+  VERSION = '2.11.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.11.1
 platform: ruby
 authors:
 - Brian O'Connell
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: JRuby Helper Libraries for OpenHAB Scripting
 email:
 - broconne@gmail.com
@@ -17,64 +31,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/workflow.yml"
-- ".gitignore"
-- ".java-version"
-- ".rspec"
-- ".yardopts"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- Guardfile
-- LICENSE
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- config/userdata/config/org/openhab/restauth.config
-- cucumber.yml
-- docs/_config.yml
-- docs/contributing/index.md
-- docs/examples/conversions.md
-- docs/examples/index.md
-- docs/index.md
-- docs/installation/index.md
-- docs/motivation/index.md
-- docs/usage/execution.md
-- docs/usage/execution/delay.md
-- docs/usage/execution/otherwise.md
-- docs/usage/execution/run.md
-- docs/usage/execution/triggered.md
-- docs/usage/guards.md
-- docs/usage/guards/between.md
-- docs/usage/guards/not_if.md
-- docs/usage/guards/only_if.md
-- docs/usage/index.md
-- docs/usage/items.md
-- docs/usage/items/contact.md
-- docs/usage/items/dimmer.md
-- docs/usage/items/groups.md
-- docs/usage/items/number.md
-- docs/usage/items/string.md
-- docs/usage/items/switch.md
-- docs/usage/misc.md
-- docs/usage/misc/actions.md
-- docs/usage/misc/duration.md
-- docs/usage/misc/gems.md
-- docs/usage/misc/logging.md
-- docs/usage/misc/metadata.md
-- docs/usage/misc/store_states.md
-- docs/usage/misc/time_of_day.md
-- docs/usage/misc/timers.md
-- docs/usage/rule.md
-- docs/usage/things.md
-- docs/usage/triggers.md
-- docs/usage/triggers/changed.md
-- docs/usage/triggers/channel.md
-- docs/usage/triggers/command.md
-- docs/usage/triggers/cron.md
-- docs/usage/triggers/every.md
-- docs/usage/triggers/updated.md
 - lib/openhab.rb
 - lib/openhab/configuration.rb
 - lib/openhab/core/cron.rb
@@ -126,15 +82,13 @@ files:
 - lib/openhab/core/startup_delay.rb
 - lib/openhab/osgi.rb
 - lib/openhab/version.rb
-- openhab-scripting.gemspec
-- openhab_rules/warmup.rb
 homepage: https://boc-tothefuture.github.io/openhab-jruby/
 licenses: []
 metadata:
   homepage_uri: https://boc-tothefuture.github.io/openhab-jruby/
   source_code_uri: https://github.com/boc-tothefuture/openhab-jruby
   changelog_uri: https://github.com/boc-tothefuture/openhab-jruby/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,9 +103,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
+rubyforge_project: 
 rubygems_version: 2.7.6.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: JRuby Helper Libraries for OpenHAB Scripting
 test_files: []

data/.github/workflows/workflow.yml

@@ -1,327 +0,0 @@
-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