openhab-scripting 4.26.4 → 4.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd63a855a2b36bd98bbec644125c3d3969b5de15c34a6a068c1569be78af7df7
-  data.tar.gz: 742a8bc187187d0b3efec387286781464567bb87e77723b7c46a97fa5f5b3f82
+  metadata.gz: 824e2af85aba6737c05884f3f6ca06adc1873a388b8091062781b274290c6476
+  data.tar.gz: 159ed6ce10d55640c37b61429a937f4dafaecf529479b3423552bff9d929d30d
 SHA512:
-  metadata.gz: 7b70022cd9e0fdcc545611ca0a36b5a6122884b8cccfa1f1992cbec7b1d19b24cb86fa55e127b258500c318090dbf0bb9009d3916d32d61c0c2ca3f2e0edb290
-  data.tar.gz: cd6bcd955c3c853bc6e52cdd999e096ca5ecc78bbd61f1db4ff9426395220fe9156a8f458deee0637f85e1c6dc27f2e7b74c8835c2c984d84f2baa92c4a9eb65
+  metadata.gz: 3f6f18504814c73aad6e9c5d5a7548ae17165dff3d4f85a618103f79574389d201c82a528ec09b27b37e975b05b47bb0cd78e958ba0a4bb3b094314f842b9c0e
+  data.tar.gz: d0baf3b51e76656b68e24faa3ceb8d0e76e6afea89b2ba6f81c152ce0f2ddb560fe1942af225f8f1b7ace9c5d3e9c1605c83a1654bddecdceb16f57d47c93b6e

data/lib/openhab/core/entity_lookup.rb

@@ -5,6 +5,7 @@ require 'java'
 require 'set'
 
 require 'openhab/log/logger'
+require_relative 'item_proxy'
 
 # Automation lookup and injection of OpenHab entities
 
@@ -91,7 +92,8 @@ module OpenHAB
       def self.lookup_item(name)
         logger.trace("Looking up item(#{name})")
         name = name.to_s if name.is_a? Symbol
-        $ir.get(name) # rubocop: disable Style/GlobalVars
+        item = $ir.get(name) # rubocop: disable Style/GlobalVars
+        ItemProxy.new(item) unless item.nil?
       end
     end
   end

data/lib/openhab/core/item_proxy.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'forwardable'
+
+module OpenHAB
+  module Core
+    # Class is a proxy to underlying item
+    class ItemProxy < Delegator
+      extend Forwardable
+      def_delegators :__getobj__, :class, :is_a?, :kind_of?, :instance_of?
+
+      #
+      # Set the proxy item (called by super)
+      #
+      def __setobj__(item)
+        # Convert name to java version for faster lookups
+        @item_name = item.name.to_java
+      end
+
+      #
+      # Lookup item from item registry
+      #
+      def __getobj__
+        $ir.get(@item_name) # rubocop:disable Style/GlobalVars
+      end
+    end
+  end
+end

data/lib/openhab/dsl/items/ensure.rb

@@ -53,7 +53,11 @@ module OpenHAB
           # sending the command
           def command(command)
             return super unless Thread.current[:ensure_states]
-            return if command == state
+
+            logger.trace do
+              "#{name} ensure #{command}, format_type_pre: #{format_type_pre(command)}, current state: #{state}"
+            end
+            return if state == format_type_pre(command)
 
             super
           end

data/lib/openhab/dsl/items/generic_item.rb

@@ -33,6 +33,13 @@ module OpenHAB
           def ACCEPTED_DATA_TYPES
             [org.openhab.core.types.UnDefType.java_class].freeze
           end
+
+          #
+          # Override to support ItemProxy
+          #
+          def ===(other)
+            other.instance_of?(self)
+          end
         end
         # rubocop:enable Naming/MethodName
 
@@ -128,7 +135,7 @@ module OpenHAB
         # @return [Array<Group>] All groups that this item is part of
         #
         def groups
-          group_names.map { |name| Groups.groups[name] }
+          group_names.map { |name| Groups.groups[name] }.compact
         end
 
         # Return the item's thing if this item is linked with a thing. If an item is linked to more than one thing,

data/lib/openhab/dsl/items/items.rb

@@ -6,11 +6,9 @@ require 'openhab/dsl/types/types'
 require_relative 'item_registry'
 
 require_relative 'generic_item'
-
 require_relative 'switch_item'
 require_relative 'date_time_item'
 require_relative 'dimmer_item'
-
 require_relative 'color_item'
 require_relative 'contact_item'
 require_relative 'group_item'

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -304,7 +304,7 @@ module OpenHAB
           end
           false
         rescue StandardError => e
-          print_backtrace(e)
+          logger.log_exception(e, name)
         end
         # rubocop:enable Metrics/MethodLength
 
@@ -328,7 +328,7 @@ module OpenHAB
             end
           end
         rescue StandardError => e
-          print_backtrace(e)
+          logger.log_exception(e, name)
         end
 
         #
@@ -399,16 +399,6 @@ module OpenHAB
           @run_context.instance_exec(event, &task.block)
         end
 
-        #
-        # Print error and stack trace without calls to internal classes
-        #
-        # @param [Exception] error A rescued error
-        #
-        def print_backtrace(error)
-          error = logger.clean_backtrace(error)
-          logger.error { "#{error.message} (#{error.class})\nIn rule: #{name}\n#{error.backtrace&.join("\n")}" }
-        end
-
         #
         # Create a new hash in which all elements are converted to strings
         #

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

@@ -26,7 +26,7 @@ module OpenHAB
       @registry = OpenHAB::Core.rule_registry
       class << self
         attr_reader :script_rules, :automation_manager, :registry
-end
+      end
 
       #
       # Create a new rule
@@ -35,7 +35,7 @@ end
       # @yield [] Block executed in context of a RuleConfig
       #
       #
-      # rubocop: disable Metrics
+      # rubocop: disable Metrics/MethodLength
       def rule(rule_name, &block)
         thread_local(RULE_NAME: rule_name) do
           @rule_name = rule_name
@@ -47,10 +47,9 @@ end
           nil # Must return something other than the rule object. See https://github.com/boc-tothefuture/openhab-jruby/issues/438
         end
       rescue StandardError => e
-        puts "#{e.class}: #{e.message}"
-        re_raise_with_backtrace(e)
+        logger.log_exception(e, @rule_name)
       end
-      # rubocop: enable Metrics
+      # rubocop: enable Metrics/MethodLength
 
       #
       # Cleanup rules in this script file
@@ -62,16 +61,6 @@ end
 
       private
 
-      #
-      # Re-raises a rescued error to OpenHAB with added rule name and stack trace
-      #
-      # @param [Exception] error A rescued error
-      #
-      def re_raise_with_backtrace(error)
-        error = logger.clean_backtrace(error)
-        raise error, "#{error.message}\nIn rule: #{@rule_name}\n#{error.backtrace.join("\n")}"
-      end
-
       #
       # Process a rule based on the supplied configuration
       #

data/lib/openhab/dsl/states.rb

@@ -48,7 +48,9 @@ module OpenHAB
       # @return [StateStorage] item states
       #
       def store_states(*items)
-        items = items.flatten
+        items = items.flatten.map do |item|
+          item.respond_to?(:__getobj__) ? item.__getobj__ : item
+        end
         states = StateStorage.new(BusEvent.storeStates(*items).to_h)
         if block_given?
           yield

data/lib/openhab/dsl/timers/manager.rb

@@ -39,7 +39,7 @@ module OpenHAB
 
           if timer.respond_to? :id
             logger.trace("Adding #{timer} with id #{timer.id.inspect} timer ids")
-            @timer_ids[timer.id] = Set.new unless @timer_ids[timer.id]
+            @timer_ids[timer.id] = TimerSet.new unless @timer_ids[timer.id]
             @timer_ids[timer.id] << timer
           end
 
@@ -87,6 +87,19 @@ module OpenHAB
           @timers.clear
         end
       end
+
+      #
+      # Provide additional methods for the timers set
+      #
+      class TimerSet < Set
+        #
+        # A shorthand to cancel all the timer objects held within the set
+        # so that timers[timer_id].cancel_all is equivalent to timers[timer_id].each(&:cancel)
+        #
+        def cancel_all
+          each(&:cancel)
+        end
+      end
     end
   end
 end

data/lib/openhab/dsl/types/date_time_type.rb

@@ -7,8 +7,8 @@ require 'java'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.DateTimeType
-      java_import java.time.ZonedDateTime
+      DateTimeType = org.openhab.core.library.types.DateTimeType
+      java_import java.time.ZonedDateTime # This is needed for the addon prior to ruby_class fix (OH 3.2.0)
 
       # global alias
       ::DateTimeType = DateTimeType

data/lib/openhab/dsl/types/decimal_type.rb

@@ -6,7 +6,7 @@ require_relative 'numeric_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.DecimalType
+      DecimalType = org.openhab.core.library.types.DecimalType
 
       #
       # Add methods to core OpenHAB DecimalType to make it behave as a Ruby

data/lib/openhab/dsl/types/hsb_type.rb

@@ -6,7 +6,7 @@ require_relative 'percent_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.HSBType
+      HSBType = org.openhab.core.library.types.HSBType
 
       # global alias
       ::HSBType = HSBType

data/lib/openhab/dsl/types/increase_decrease_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.IncreaseDecreaseType
+      IncreaseDecreaseType = org.openhab.core.library.types.IncreaseDecreaseType
 
       # Adds methods to core OpenHAB IncreaseDecreaseType to make it more
       # natural in Ruby

data/lib/openhab/dsl/types/next_previous_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.NextPreviousType
+      NextPreviousType = org.openhab.core.library.types.NextPreviousType
 
       # Adds methods to core OpenHAB NextPreviousType to make it more
       # natural in Ruby

data/lib/openhab/dsl/types/on_off_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.OnOffType
+      OnOffType = org.openhab.core.library.types.OnOffType
 
       # Adds methods to core OpenHAB OnOffType to make it more natural in Ruby
       class OnOffType

data/lib/openhab/dsl/types/open_closed_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.OpenClosedType
+      OpenClosedType = org.openhab.core.library.types.OpenClosedType
 
       # Adds methods to core OpenHAB OpenClosedType to make it more natural in Ruby
       class OpenClosedType

data/lib/openhab/dsl/types/percent_type.rb

@@ -5,7 +5,7 @@ require_relative 'decimal_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.PercentType
+      PercentType = org.openhab.core.library.types.PercentType
 
       # global alias
       ::PercentType = PercentType

data/lib/openhab/dsl/types/play_pause_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.PlayPauseType
+      PlayPauseType = org.openhab.core.library.types.PlayPauseType
 
       # Adds methods to core OpenHAB PlayPauseType to make it more
       # natural in Ruby

data/lib/openhab/dsl/types/point_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.PointType
+      PointType = org.openhab.core.library.types.PointType
 
       # global scope
       # @!visibility private

data/lib/openhab/dsl/types/quantity_type.rb

@@ -5,7 +5,7 @@ require_relative 'numeric_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.QuantityType
+      QuantityType = org.openhab.core.library.types.QuantityType
 
       # global alias
       ::QuantityType = QuantityType

data/lib/openhab/dsl/types/refresh_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.types.RefreshType
+      RefreshType = org.openhab.core.types.RefreshType
 
       # Adds methods to core OpenHAB RefreshType to make it more natural in Ruby
       class RefreshType # rubocop:disable Lint/EmptyClass

data/lib/openhab/dsl/types/rewind_fastforward_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.RewindFastforwardType
+      RewindFastforwardType = org.openhab.core.library.types.RewindFastforwardType
 
       # Adds methods to core OpenHAB RewindFastforwardType to make it more
       # natural in Ruby

data/lib/openhab/dsl/types/stop_move_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.StopMoveType
+      StopMoveType = org.openhab.core.library.types.StopMoveType
 
       # Adds methods to core OpenHAB StopMoveType to make it more
       # natural in Ruby

data/lib/openhab/dsl/types/string_type.rb

@@ -7,7 +7,7 @@ require_relative 'comparable_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.StringType
+      StringType = org.openhab.core.library.types.StringType
 
       #
       # Add methods to core OpenHAB StringType to make it behave as a Ruby

data/lib/openhab/dsl/types/un_def_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.types.UnDefType
+      UnDefType = org.openhab.core.types.UnDefType
 
       # Adds methods to core OpenHAB UnDefType to make it more natural in Ruby
       class UnDefType # rubocop:disable Lint/EmptyClass

data/lib/openhab/dsl/types/up_down_type.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.UpDownType
+      UpDownType = org.openhab.core.library.types.UpDownType
 
       # Adds methods to core OpenHAB UpDownType to make it more natural in Ruby
       class UpDownType

data/lib/openhab/log/configuration.rb

@@ -6,7 +6,7 @@ module OpenHAB
     # This module holds global configuration values
     module Configuration
       # -*- coding: utf-8 -*-
-      LOG_PREFIX = 'jsr223.jruby'
+      LOG_PREFIX = 'org.openhab.automation.jruby'
 
       #
       # Gets the log prefix

data/lib/openhab/log/logger.rb

@@ -82,6 +82,16 @@ module OpenHAB
         error
       end
 
+      #
+      # Print error and stack trace without calls to internal classes
+      #
+      # @param [Exception] error A rescued error
+      #
+      def log_exception(exception, rule_name)
+        exception = clean_backtrace(exception)
+        error { "#{exception.message} (#{exception.class})\nIn rule: #{rule_name}\n#{exception.backtrace&.join("\n")}" }
+      end
+
       private
 
       #

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.26.4
+  version: 4.28.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - lib/openhab.rb
 - lib/openhab/core/entity_lookup.rb
+- lib/openhab/core/item_proxy.rb
 - lib/openhab/core/load_path.rb
 - lib/openhab/core/openhab_setup.rb
 - lib/openhab/core/osgi.rb