openhab-scripting 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2c9b98ae8645ba9006e801fb670b8858442117e731f9eddd37186824f655704
-  data.tar.gz: b594df3783cbce82b7d1a80187f4455e2afa5ffad3230b1c64f7c7be8a7b6a66
+  metadata.gz: 01e9ddbd43a59fec9db3fa391d42cacb0cd1a03c7d116e995815df940847b28b
+  data.tar.gz: ef98bb992444788122499056470c2fde3fbfbdb6659a72228df0f2c46bd8cecb
 SHA512:
-  metadata.gz: 8d9dacf04c0bdeec592a0bd4742009754eb32433523b6f88a9abe34f1294d17fd41a93b940b5701f6b2dc28d1a7d29fef04d5eb07d98e9b0eeb9473aa25e1967
-  data.tar.gz: cb5585d43b36d101db8b3d81686eb503e6393e0336d0ff626a3ad7d33b6c0720ce13993886453176df2f245c3feea5c10dd42b19908d31ae4734919c72c4f09f
+  metadata.gz: 4499127b7c667c3290eb3d106624649ff04eff597eb95668c868bcaf5236f99a9149adf4b74e4750e2d092bc5cd7c3cc8b56b6470968f34c6324985b8bec7472
+  data.tar.gz: 93a18bda44e472326eb5952d089f5a8eb1f221bc566c861c9abee4cce08c21b5a8d29aa5168b05c5c54c3e61e613e1834ff01c39f18f57dcc2efc8d4c9eacbb5

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

@@ -5,6 +5,7 @@ require 'java'
 require 'time'
 require 'openhab/dsl/types/datetime'
 require 'openhab/dsl/items/item_delegate'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL

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

@@ -43,7 +43,7 @@ module OpenHAB
         # @return [Java::OrgOpenhabCoreLibraryTypes::PercentType] the position of the rollershutter
         #
         def position
-          state.as(PercentType)
+          state&.as(PercentType)
         end
 
         #
@@ -54,6 +54,8 @@ module OpenHAB
         # @return [Integer] -1, 0 or 1 depending on the result of the comparison
         #
         def <=>(other)
+          return nil unless state?
+
           case other
           when PercentType, Java::OrgOpenhabCoreLibraryTypes::DecimalType then position.compare_to(other)
           when Numeric then position.int_value <=> other
@@ -73,8 +75,8 @@ module OpenHAB
           raise ArgumentError, "Cannot coerce to #{other.class}" unless other.is_a? Numeric
 
           case other
-          when Integer then [other, position.int_value]
-          when Float then [other, position.float_value]
+          when Integer then [other, position&.int_value]
+          when Float then [other, position&.float_value]
           end
         end
 
@@ -84,7 +86,7 @@ module OpenHAB
         %i[+ - * / %].each do |operator|
           define_method(operator) do |other|
             right, left = coerce(other)
-            left.send(operator, right)
+            left&.send(operator, right)
           end
         end
       end

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

@@ -36,6 +36,8 @@ module OpenHAB
           #   result from super if not supplied an OpenClosedType
           #
           def ==(other)
+            other = other.get_state_as(OpenClosedType) if other.respond_to?(:get_state_as)
+
             if other.is_a? OpenClosedType
               state? && state == other
             else

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

@@ -9,6 +9,18 @@ module OpenHAB
         #
         module Persistence
           java_import Java::OrgOpenhabCoreTypesUtil::UnitUtils
+
+          # A wrapper for OpenHAB's HistoricItem that returns the state directly
+          class HistoricState < SimpleDelegator
+            attr_reader :timestamp, :state
+
+            def initialize(state, timestamp)
+              @state = state
+              @timestamp = timestamp
+              super(@state)
+            end
+          end
+
           # All persistence methods that could return a Quantity
           QUANTITY_METHODS = %i[average_since
                                 delta_since
@@ -45,13 +57,18 @@ module OpenHAB
           #
           def previous_state(service = nil, skip_equal: false)
             service ||= persistence_service
-            PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
+            result = PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
+            HistoricState.new(quantify(result.state), result.timestamp)
           end
 
           PERSISTENCE_METHODS.each do |method|
             define_method(method) do |timestamp, service = nil|
               service ||= persistence_service
               result = PersistenceExtensions.public_send(method, self, to_zdt(timestamp), service&.to_s)
+              if result.is_a? Java::OrgOpenhabCorePersistence::HistoricItem
+                return HistoricState.new(quantify(result.state), result.timestamp)
+              end
+
               QUANTITY_METHODS.include?(method) ? quantify(result) : result
             end
           end

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

@@ -56,6 +56,8 @@ module OpenHAB
           #   otherwise result from super
           #
           def ==(other)
+            other = other.get_state_as(OnOffType) if other.respond_to?(:get_state_as)
+
             if other.is_a? OnOffType
               state? && state == other
             else

data/lib/openhab/dsl/monkey_patch/ruby/string.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'openhab/dsl/types/quantity'
+require 'openhab/dsl/types/datetime'
+require 'openhab/dsl/items/datetime_item'
 
 module OpenHAB
   module DSL
@@ -21,7 +23,8 @@ module OpenHAB
           #
           def ==(other)
             case other
-            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType
+            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType,
+              OpenHAB::DSL::Types::DateTime, OpenHAB::DSL::Items::DateTimeItem
               other == self
             else
               super

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

@@ -44,6 +44,21 @@ module OpenHAB
             end
             # rubocop:enable Style/CaseLikeIf
           end
+
+          #
+          # Test for equality
+          #
+          # @param [Object] other Other object to compare against
+          #
+          # @return [Boolean] true if self and other can be considered equal, false otherwise
+          #
+          def ==(other)
+            if other.respond_to?(:get_state_as)
+              self == other.get_state_as(OnOffType)
+            else
+              super
+            end
+          end
         end
       end
     end

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

@@ -33,6 +33,21 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Test for equality
+          #
+          # @param [Object] other Other object to compare against
+          #
+          # @return [Boolean] true if self and other can be considered equal, false otherwise
+          #
+          def ==(other)
+            if other.respond_to?(:get_state_as)
+              self == other.get_state_as(OpenClosedType)
+            else
+              super
+            end
+          end
         end
       end
     end

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

@@ -30,6 +30,21 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Test for equality
+          #
+          # @param [Object] other Other object to compare against
+          #
+          # @return [Boolean] true if self and other can be considered equal, false otherwise
+          #
+          def ==(other)
+            if other.respond_to?(:get_state_as)
+              self == other.get_state_as(UpDownType)
+            else
+              super
+            end
+          end
         end
       end
     end

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

@@ -29,6 +29,7 @@ module OpenHAB
           set_name(config.name)
           set_description(config.description)
           set_triggers(config.triggers)
+          @run_context = config.caller
           @run_queue = config.run
           @guard = config.guard
           between = config.between&.yield_self { between(config.between) }
@@ -288,7 +289,7 @@ module OpenHAB
         #
         def process_otherwise_task(event, task)
           logger.trace { "Executing rule '#{name}' otherwise block with event(#{event})" }
-          task.block.call(event)
+          @run_context.instance_exec(event, &task.block)
         end
 
         #
@@ -316,7 +317,7 @@ module OpenHAB
           return unless event&.item
 
           logger.trace { "Executing rule '#{name}' trigger block with item (#{event.item})" }
-          task.block.call(event.item)
+          @run_context.instance_exec(event.item, &task.block)
         end
 
         #
@@ -328,7 +329,7 @@ module OpenHAB
         #
         def process_run_task(event, task)
           logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
-          task.block.call(event)
+          @run_context.instance_exec(event, &task.block)
         end
 
         #

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

@@ -23,10 +23,11 @@ module OpenHAB
       def rule(rule_name, &block)
         @rule_name = rule_name
         config = RuleConfig.new(rule_name, block.binding)
-        config.instance_eval(&block)
+        config.instance_exec(config, &block)
         config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
         logger.trace { config.inspect }
         process_rule_config(config)
+        config
       rescue StandardError => e
         re_raise_with_backtrace(e)
       end

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

@@ -40,6 +40,9 @@ module OpenHAB
         # @return [Array] Of trigger guards
         attr_accessor :guard
 
+        # @return [Object] object that invoked rule method
+        attr_accessor :caller
+
         #
         # Struct holding a run block
         #

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

@@ -75,13 +75,13 @@ module OpenHAB
         # @return [Integer] -1, 0 or 1 depending on the outcome
         #
         def <=>(other)
+          if other.respond_to?(:zoned_date_time)
+            return zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
+          end
+
           case other
-          when DateTime, DateTimeType, DateTimeItem
-            zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
-          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement
-            to_tod <=> other
-          when String
-            self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
+          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement then to_tod <=> other
+          when String then self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
           else
             self <=> DateTime.from(other)
           end

data/lib/openhab/log/logger.rb

@@ -22,9 +22,21 @@ module OpenHAB
       #
       # Regex for matching internal calls in a stack trace
       #
-      INTERNAL_CALL_REGEX = %r{(openhab-scripting-.*/lib)|(org/jruby/)}.freeze
+      INTERNAL_CALL_REGEX = %r{(openhab-scripting-.*/lib)|org[./]jruby}.freeze
       private_constant :INTERNAL_CALL_REGEX
 
+      #
+      # Regex for matching internal calls in a java stack trace
+      #
+      EXCLUDED_JAVA_PACKAGES = /jdk\.internal\.reflect|java\.lang\.reflect|org\.openhab|java\.lang\.Thread\.run/.freeze
+      private_constant :EXCLUDED_JAVA_PACKAGES
+
+      #
+      # Regex for matching internal calls in a java stack trace
+      #
+      JAVA_INTERNAL_CALL_REGEX = Regexp.union(INTERNAL_CALL_REGEX, EXCLUDED_JAVA_PACKAGES).freeze
+      private_constant :JAVA_INTERNAL_CALL_REGEX
+
       #
       # Create a new logger
       #
@@ -60,8 +72,13 @@ module OpenHAB
       def clean_backtrace(error)
         return error if debug_enabled?
 
-        backtrace = error.backtrace_locations.reject { |line| INTERNAL_CALL_REGEX.match? line.to_s }
-        error.set_backtrace(backtrace.map(&:to_s))
+        if error.respond_to? :backtrace_locations
+          backtrace = error.backtrace_locations.map(&:to_s).reject { |line| INTERNAL_CALL_REGEX.match? line }
+          error.set_backtrace(backtrace)
+        elsif error.respond_to? :stack_trace
+          backtrace = error.stack_trace.reject { |line| JAVA_INTERNAL_CALL_REGEX.match? line.to_s }
+          error.set_stack_trace(backtrace)
+        end
         error
       end
 

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler