openhab-scripting 3.1.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beab2ee97613a8a2016969c8410f4abcddc9c780ad16c5683e382bee28526122
-  data.tar.gz: 33f9ecf81357a4812e59188ad3d3f5b7ef034e79e874ec942e3bc880352853d4
+  metadata.gz: 0c609ff8fbe875f98e26f7286f4a72fdd018b5bd96ec4a7272fb7d7ceacc9657
+  data.tar.gz: f5ca4401987517a11e1ddd0b632f5d0c5380751336175d9a21dba3cc16576308
 SHA512:
-  metadata.gz: 97b3a91ecda58df5763a79b6f9d0c3020f7064774e84f62c3716cbb6fc441a0848dee14778126f01cde1ca327e0c5413ea3f5e37e3b3fda1a0d5e432bfe36007
-  data.tar.gz: cece3de478210c8236d6d74a04af2edb1efe136bf4e380f86225df8b76b7b7edf3fcf83fde9dcc376dbcbcc62e443bbd5719cbb2efdc2949249467f06fa677ae
+  metadata.gz: 3b3517f70a227da9d2795fc17b3c9642db3e2ef684bb2611281933d659f5fd14b51f9fcb5472dc2e49c5c051e4debfe560bc064652de41aa172ca0be006689d2
+  data.tar.gz: 1559069e15db427e37c0b13fe03f2cc69cf8aa67d9a943b92453c1c1bd3c192848a713a4f5f8e44c7a57fe1d6bde9a582ca8bbe792a46b5b8e007366cf7457dc

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/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/things.rb

@@ -11,6 +11,7 @@ module OpenHAB
     # Support for OpenHAB Things
     #
     module Things
+      java_import Java::OrgOpenhabCoreThing::ThingStatus
       include OpenHAB::Log
 
       #
@@ -25,6 +26,22 @@ module OpenHAB
           define_action_methods
         end
 
+        #
+        # Defines boolean thing status methods
+        #   uninitialized?
+        #   initializing?
+        #   unknown?
+        #   online?
+        #   offline?
+        #   removing?
+        #   removed?
+        #
+        # @return [Boolean] true if the thing status matches the name
+        #
+        ThingStatus.constants.each do |thingstatus|
+          define_method("#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) }
+        end
+
         private
 
         java_import 'org.openhab.core.automation.annotation.RuleAction'

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.1'
+  VERSION = '3.4.0'
 end

metadata

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