openhab-scripting 4.35.0 → 4.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a64a452ca8ff7c31d08ceed61a6e2d466250438365ea71c4de1c968b33198f8c
-  data.tar.gz: 31e41c724ad7b7871e913044259f5d3736130d5634d2f9301b98c7093b97f804
+  metadata.gz: e405e19fe5977dfbe708699abaf9fe3e0e953d2d16450da5b10879b6e0d3494b
+  data.tar.gz: c1ed131f668cd5e214f56164ff10a3e9938df4aaa5f6a55efde4ba23db164f82
 SHA512:
-  metadata.gz: 1cb0812ede637a43674c260dce7124a38fce48c0940cae506125f9c5d6c3ebc3fa08d229a92155060fc5eb816b9e946874cebbc6e0d9654b3405e75879b1dbfd
-  data.tar.gz: cf04212fd7483729494be64840f74c9d6d5241c35c87e4c46f7207c8a007a9d0c537a8379481172d8395cf27c74eae5764d2d2e65ef984d7478104778e19c4a0
+  metadata.gz: d970bd8b607aad49f59d0746ba56711dcf34a0c199547b76008e3e7f375b6836d06841c8cbdb86f056c4f58704690950583f20b76ae1e641515ea332f594f710
+  data.tar.gz: 7cbc491b62553a735e02f25f690a1244801fc2eac7d2a179dd1777d608a34752e5b549ecb41b73df6765c83ef717fe40d030414bb41291d1372872acaa89c9bb

data/lib/openhab/dsl/dsl.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require_relative 'imports'
+
+OpenHAB::DSL.import_presets
+
 require 'openhab/log/logger'
 
 # the order of these is important

data/lib/openhab/dsl/imports.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    include OpenHAB::Log
+    #
+    # Import required java classes
+    #
+    def self.import_presets # rubocop:disable Metrics/AbcSize
+      return if Object.const_get(:ZonedDateTime).is_a?(Class)
+
+      # Fix the import problem in OpenHAB 3.2 addon. Not required in 3.3+
+      [java.time.Duration,
+       java.time.ZonedDateTime,
+       java.time.ZoneId,
+       java.time.temporal.ChronoUnit].each do |klass|
+        Object.const_set(klass.java_class.simple_name.to_sym, klass)
+      end
+    end
+  end
+end

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

@@ -19,11 +19,26 @@ module OpenHAB
         def self.included(klass)
           klass.prepend ItemEquality # make sure this is first
           klass.extend Forwardable
-          klass.delegate %i[+ - * / % | to_d to_f to_i to_int] => :state
+          klass.delegate %i[+ - * / % to_d to_f to_i to_int] => :state
           # remove the JRuby default == so that we can inherit the Ruby method
           klass.remove_method :==
         end
 
+        #
+        # Convert state to a Quantity by calling state (DecimalType)#|
+        # Raise a NoMethodError if state is nil (NULL or UNDEF) instead of delegating to it.
+        # because nil#| would return true, causing an unexpected result
+        #
+        # @param [Unit, String] other the unit to convert to
+        #
+        # @return [QuantityType] the QuantityType in the given unit
+        #
+        def |(other)
+          raise NoMethodError, 'State is nil' unless state?
+
+          state.|(other)
+        end
+
         #
         # Check if NumericItem is truthy? as per defined by library
         #

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

@@ -76,19 +76,15 @@ module OpenHAB
         private
 
         #
-        # Convert timestamp to ZonedDateTime if it's a TemporalAmount
+        # Convert timestamp to ZonedDateTime with duration negated to indicate a time in the past
         #
-        # @param [Object] timestamp to convert
+        # @param [Object] timestamp timestamp to convert
         #
         # @return [ZonedDateTime]
         #
         def to_zdt(timestamp)
-          if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
-            logger.trace("Converting #{timestamp} (#{timestamp.class}) to ZonedDateTime")
-            Java::JavaTime::ZonedDateTime.now.minus(timestamp)
-          else
-            timestamp
-          end
+          timestamp = timestamp.negated if timestamp.is_a? Java::JavaTime::Duration
+          OpenHAB::DSL.to_zdt(timestamp)
         end
 
         #

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

@@ -171,6 +171,7 @@ module OpenHAB
             # rubocop: disable Metrics/AbcSize
             # There is no feasible way to break this method into smaller components
             def execute(_mod = nil, inputs = nil)
+              OpenHAB::DSL.import_presets
               @semaphore.synchronize do
                 thread_local(@thread_locals) do
                   logger.trace "Canceling implicit timer #{@timed_command_details.timer} for "\

data/lib/openhab/dsl/openhab.rb

@@ -3,6 +3,15 @@
 require 'pathname'
 
 module OpenHAB
+  #
+  # Return the OpenHAB conf directory as a ruby pathname
+  #
+  # @return [Pathname] OpenHAB conf path
+  #
+  def self.conf_root
+    Pathname.new(ENV['OPENHAB_CONF'])
+  end
+
   module DSL
     #
     # Provides access to OpenHAB attributes
@@ -12,13 +21,9 @@ module OpenHAB
 
       module_function
 
-      #
-      # Return the OpenHAB conf directory as a ruby pathname
-      #
-      # @return [Pathname] OpenHAB conf path
-      #
+      # @deprecated Please use {OpenHAB.conf_root} instead
       def __conf__
-        Pathname.new(ENV['OPENHAB_CONF'])
+        OpenHAB.conf_root
       end
     end
   end

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

@@ -23,7 +23,6 @@ module OpenHAB
         include OpenHAB::Log
         include OpenHAB::Core::ThreadLocal
         include OpenHAB::DSL::Between
-        java_import java.time.ZonedDateTime
 
         #
         # Create a new Rule
@@ -55,6 +54,7 @@ module OpenHAB
         #
         #
         def execute(mod = nil, inputs = nil)
+          OpenHAB::DSL.import_presets
           thread_local(RULE_NAME: name) do
             logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs.inspect})" }
             logger.trace { "Event details #{inputs['event'].inspect}" } if inputs&.key?('event')

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

@@ -95,11 +95,24 @@ module OpenHAB
       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)
+        # so that timers[timer_id].cancel is equivalent to timers[timer_id].each(&:cancel)
         #
-        def cancel_all
+        def cancel
           each(&:cancel)
         end
+        # @deprecated Please use {cancel} instead
+        alias cancel_all cancel
+
+        #
+        # A shorthand to reschedule all the timer objects held within the set
+        #
+        # @param [Duration] duration An optional duration to reschedule
+        #
+        # @return [TimerSet] Set of timers
+        #
+        def reschedule(duration = nil)
+          each { |timer| timer.reschedule duration }
+        end
       end
     end
   end

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

@@ -9,7 +9,6 @@ require 'openhab/core/thread_local'
 module OpenHAB
   module DSL
     java_import org.openhab.core.model.script.actions.ScriptExecution
-    java_import java.time.ZonedDateTime
 
     # Ruby wrapper for OpenHAB Timer
     # This class implements delegator to delegate methods to the OpenHAB timer
@@ -29,7 +28,6 @@ module OpenHAB
       # @param [Duration] duration Duration until timer should fire
       # @param [Block] block Block to execute when timer fires
       #
-      # rubocop: disable Metrics/MethodLength
       def initialize(duration:, thread_locals: {}, &block)
         @duration = duration
         @thread_locals = thread_locals
@@ -39,15 +37,12 @@ module OpenHAB
         semaphore = Mutex.new
 
         semaphore.synchronize do
-          @timer = ScriptExecution.createTimer(
-            ZonedDateTime.now.plus(to_duration(@duration)), timer_block(semaphore, &block)
-          )
+          @timer = ScriptExecution.createTimer(OpenHAB::DSL.to_zdt(@duration), timer_block(semaphore, &block))
           @rule_timers = Thread.current[:rule_timers]
           super(@timer)
           Timers.timer_manager.add(self)
         end
       end
-      # rubocop: enable Metrics/MethodLength
 
       #
       # Reschedule timer
@@ -60,7 +55,7 @@ module OpenHAB
         duration ||= @duration
 
         Timers.timer_manager.add(self)
-        @timer.reschedule(ZonedDateTime.now.plus(to_duration(duration)))
+        @timer.reschedule(OpenHAB::DSL.to_zdt(duration))
       end
 
       #
@@ -84,6 +79,7 @@ module OpenHAB
       #
       def timer_block(semaphore)
         proc {
+          OpenHAB::DSL.import_presets
           semaphore.synchronize do
             Timers.timer_manager.delete(self)
             thread_local(@thread_locals) do
@@ -92,26 +88,44 @@ module OpenHAB
           end
         }
       end
+    end
 
-      #
-      # Convert argument to a duration
-      #
-      # @param [Java::JavaTimeTemporal::TemporalAmount, #to_f, #to_i, nil] duration Duration
-      #
-      # @raise if duration cannot be used for a timer
-      #
-      # @return Argument converted to seconds if it responds to #to_f or #to_i, otherwise duration unchanged
-      #
-      def to_duration(duration)
-        if duration.nil? || duration.is_a?(Java::JavaTimeTemporal::TemporalAmount)
-          duration
-        elsif duration.respond_to?(:to_f)
-          duration.to_f.seconds
-        elsif duration.respond_to?(:to_i)
-          duration.to_i.seconds
-        else
-          raise ArgumentError, "Supplied argument '#{duration}' cannot be converted to a duration"
-        end
+    #
+    # Convert TemporalAmount (Duration), seconds (float, integer), and Ruby Time to ZonedDateTime
+    # Note: TemporalAmount is added to now
+    #
+    # @param [Object] timestamp to convert
+    #
+    # @return [ZonedDateTime]
+    #
+    def self.to_zdt(timestamp)
+      logger.trace("Converting #{timestamp} (#{timestamp.class}) to ZonedDateTime")
+      return unless timestamp
+
+      case timestamp
+      when Java::JavaTimeTemporal::TemporalAmount then ZonedDateTime.now.plus(timestamp)
+      when ZonedDateTime then timestamp
+      when Time then timestamp.to_java(ZonedDateTime)
+      else
+        to_zdt(seconds_to_duration(timestamp)) ||
+          raise(ArgumentError, 'Timestamp must be a ZonedDateTime, a Duration, a Numeric, or a Time object')
+      end
+    end
+
+    #
+    # Convert numeric seconds to a Duration object
+    #
+    # @param [Float, Integer] secs The number of seconds in integer or float
+    #
+    # @return [Duration]
+    #
+    def self.seconds_to_duration(secs)
+      return unless secs
+
+      if secs.respond_to?(:to_f)
+        secs.to_f.seconds
+      elsif secs.respond_to?(:to_i)
+        secs.to_i.seconds
       end
     end
   end

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

@@ -8,7 +8,6 @@ module OpenHAB
   module DSL
     module Types
       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 - required for jrubyscripting addon <= OH3.2.0
       ::DateTimeType = DateTimeType if ::DateTimeType.is_a?(Java::JavaLang::Class)

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.35.0
+  version: 4.37.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ files:
 - lib/openhab/dsl/dsl.rb
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb
+- lib/openhab/dsl/imports.rb
 - lib/openhab/dsl/items/color_item.rb
 - lib/openhab/dsl/items/comparable_item.rb
 - lib/openhab/dsl/items/contact_item.rb