openhab-scripting 4.44.2 → 4.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fc4da63132db46b324f609f104065c23d2ca43f9caa44e1736fcaa5aa0cefc1
-  data.tar.gz: db4f92843a5c3cba9a11a83c37a832eadd115bdcc75269d2b30800db61bff84b
+  metadata.gz: 92e2d3cfb9d4cda1452db68930c6f0d291ee3c81b1df4f9cbf4cfe9e0946d1a3
+  data.tar.gz: b2df2b5577372f44b0a7ab265abc9e03c8ee3fcec1c24152302f42cf66892221
 SHA512:
-  metadata.gz: 62976743367c2cda9c3d88f3fed7701feae81a852226dc93b2c9a41702035ba453e98a21ae3365030a467cc9bd899834eb63d144be2d589fba2716188b7cb2a0
-  data.tar.gz: 8f88d0b217d6bcfa7029f601acb551eaf030f63452a99cafba05be514b11ec8b000efbdd9dc3dbc8fed2c98c4e9e19e2e617cdb86749353173679a6ed2118073
+  metadata.gz: d0f865451318a850196975f2d5482eaba83a33229c050475bf8ea46fdf058ad95ca494dc2cf2ae1f0b1aae38fd29a78fbeffefbaf2eadd2d669dbbe66ab33fb5
+  data.tar.gz: 8b268e91ca36f4450a1ea73a6794b0b7fe8651a0e8566573f5168d046260c3b6b8d11fae78ada7d2c86331ce6c08ed9c4cdf66ad3ff08e6bcb049e76823cd46b

data/lib/openhab/dsl/dsl.rb

@@ -7,14 +7,16 @@ OpenHAB::DSL.import_presets
 require 'openhab/log/logger'
 
 # the order of these is important
-require 'openhab/dsl/types/types'
-require 'openhab/dsl/items/items'
-require 'openhab/dsl/monkey_patch/ruby/ruby'
+require_relative 'types/types'
+require_relative 'items/items'
 
-require 'openhab/dsl/monkey_patch/events/events'
-require 'openhab/dsl/monkey_patch/actions/actions'
-require 'openhab/dsl/rules/rule'
-require 'openhab/dsl/rules/terse'
+require_relative 'monkey_patch/ruby/ruby'
+require_relative 'monkey_patch/java/java'
+require_relative 'monkey_patch/events/events'
+require_relative 'monkey_patch/actions/actions'
+
+require_relative 'rules/rule'
+require_relative 'rules/terse'
 require_relative 'actions'
 require_relative 'channel'
 require_relative 'timers'

data/lib/openhab/dsl/monkey_patch/java/java.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'local_time'
+require_relative 'zoned_date_time'

data/lib/openhab/dsl/monkey_patch/java/local_time.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'time_extensions'
+
+module OpenHAB
+  module DSL
+    # monkey patches
+    module MonkeyPatch
+      # extensions to Java objects
+      module JavaExtensions
+        #
+        # Extend LocalTime class to support arithmetic operators
+        #
+        module LocalTimeExtensions
+          include TimeExtensions
+          include OpenHAB::Log
+
+          # apply meta-programming methods to prepending class
+          # @!visibility private
+          def self.prepended(klass)
+            # remove the JRuby default == so that we can inherit the Ruby method
+            klass.remove_method :==
+          end
+
+          #
+          # Comparison
+          #
+          # @param [LocalTime,TimeOfDay] other object to compare to
+          #
+          # @return [Integer] -1, 0, +1 depending on whether +other+ is
+          #   less than, equal to, or greater than self
+          #
+          def compare_to(other)
+            logger.trace("(#{self.class}) #{self} compare_to #{other} (#{other.class})")
+            other = other.local_time if other.is_a?(TimeOfDay)
+            super
+          end
+        end
+      end
+    end
+  end
+end
+
+java.time.LocalTime.prepend(OpenHAB::DSL::MonkeyPatch::JavaExtensions::LocalTimeExtensions)

data/lib/openhab/dsl/monkey_patch/java/time_extensions.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    # monkey patches
+    module MonkeyPatch
+      # Extensions to Java objects
+      module JavaExtensions
+        # Common extensions to Java date/time classes
+        module TimeExtensions
+          #
+          # Add other TemporalAmount or Duration object
+          #
+          # @param [TemporalAmount] other the TemporalAmount to be added to this ZonedDateTime object
+          #
+          # @return [ZonedDateTime] The resulting ZonedDateTime object after adding {other}
+          #
+          def +(other)
+            plus(other)
+          end
+
+          #
+          # Subtract other TemporalAmount or Duration object
+          #
+          # @param [TemporalAmount] other the TemporalAmount to be subtracted from this ZonedDateTime object
+          #
+          # @return [ZonedDateTime] The resulting ZonedDateTime object after subtracting {other}
+          #
+          def -(other)
+            minus(other)
+          end
+
+          #
+          # Compare against another time object
+          #
+          # @param [Object] other The other time object to compare against.
+          #
+          # @return [Integer] -1, 0, +1 depending on whether +other+ is
+          #   less than, equal to, or greater than self
+          #
+          def <=>(other)
+            compare_to(other)
+          rescue StandardError
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/java/zoned_date_time.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'time_extensions'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Extends the functionalities of Java classes
+      #
+      module JavaExtensions
+        #
+        # Extend ZonedDateTime class to support arithmetic operators
+        #
+        module ZonedDateTimeExtensions
+          include TimeExtensions
+          include OpenHAB::Log
+
+          # apply meta-programming methods to prepending class
+          # @!visibility private
+          def self.prepended(klass)
+            # remove the JRuby default == so that we can inherit the Ruby method
+            klass.remove_method :==
+          end
+
+          #
+          # Comparison
+          #
+          # @param [ZonedDateTime,Time] other object to compare to
+          #
+          # @return [Integer] -1, 0, +1 depending on whether +other+ is
+          #   less than, equal to, or greater than self
+          #
+          def compare_to(other)
+            logger.trace("(#{self.class}) #{self} compare_to #{other} (#{other.class})")
+            other = other.to_java(ZonedDateTime) if other.is_a? Time
+            super
+          end
+        end
+      end
+    end
+  end
+end
+
+ZonedDateTime.prepend(OpenHAB::DSL::MonkeyPatch::JavaExtensions::ZonedDateTimeExtensions)

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
-require 'openhab/dsl/monkey_patch/ruby/number'
-require 'openhab/dsl/monkey_patch/ruby/string'
+require_relative 'number'
+require_relative 'string'
+require_relative 'time'
 require 'bigdecimal/util'

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'openhab/dsl/time/time_of_day'
+
 module OpenHAB
   module DSL
     # monkey patches
@@ -16,7 +18,8 @@ module OpenHAB
             when Types::QuantityType,
               Types::DateTimeType,
               Items::DateTimeItem,
-              Items::NumericItem
+              Items::NumericItem,
+              Between::TimeOfDay
               other == self
             else
               super

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      module Ruby
+        # Extend Time class to allow adding/subtracting against Duration
+        module TimeExtensions
+          #
+          # Add time offset
+          #
+          # @param [Numeric,Duration] other The offset to add
+          #
+          # @return [Time] The resulting time after adding the given offset
+          #
+          def +(other)
+            other = to_seconds(other)
+            super
+          end
+
+          #
+          # Subtract time offset
+          #
+          # @param [Numeric,Duration] other The offset to subtract
+          #
+          # @return [Time] The resulting time after subtracting the given offset
+          #
+          def -(other)
+            other = to_seconds(other)
+            super
+          end
+
+          #
+          # Convert to ZonedDateTime
+          #
+          # @return [ZonedDateTime] The current time object converted to ZonedDateTime
+          #
+          def to_zdt
+            to_java(ZonedDateTime)
+          end
+
+          private
+
+          #
+          # Convert to floating point seconds if the given value reponds to to_nanos
+          #
+          # @param [Numeric,Duration] value The duration to convert into seconds.
+          #
+          # @return [Numeric] The number of seconds from the given value
+          #
+          def to_seconds(value)
+            value = value.to_nanos.to_f / 1_000_000_000 if value.respond_to? :to_nanos
+            value
+          end
+        end
+      end
+    end
+  end
+end
+
+Time.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::TimeExtensions)

data/lib/openhab/dsl/time/time_of_day.rb

@@ -20,6 +20,7 @@ module OpenHAB
       # @since 0.0.1
       class TimeOfDay
         include Comparable
+        include OpenHAB::Log
 
         # Immutable Java object containing Time Of Day
         # @return [Java.Time.LocalTime] reprsenting the Time Of Day
@@ -114,11 +115,11 @@ module OpenHAB
         # @return [Number, nil] -1,0,1 if other TimeOfDay is less than, equal to, or greater than this TimeOfDay
         #   or nil if an object other than TimeOfDay is provided
         def <=>(other)
+          logger.trace("(#{self.class}) #{self} <=> #{other} (#{other.class})")
           case other
-          when TimeOfDay
-            @local_time.compare_to(other.local_time)
-          when String
-            @local_time.compare_to(TimeOfDay.parse(other).local_time)
+          when TimeOfDay then @local_time.compare_to(other.local_time)
+          when String then @local_time.compare_to(TimeOfDay.parse(other).local_time)
+          when LocalTime then @local_time.compare_to(other)
           else
             -(other <=> self)
           end
@@ -146,7 +147,7 @@ module OpenHAB
         #
         # Convert object to TimeOfDay object
         #
-        # @param [Object] object TimeOfDay or String to be converted
+        # @param [Object] object TimeOfDay, String, or LocalTime to be converted
         #
         # @return [TimeOfDay] TimeOfDay created from supplied object
         #
@@ -155,6 +156,8 @@ module OpenHAB
           when String then TimeOfDay.parse(object)
           when Time, OpenHAB::DSL::Types::DateTimeType, OpenHAB::DSL::Items::DateTimeItem
             TimeOfDay.new(h: object.hour, m: object.min, s: object.sec)
+          when LocalTime
+            TimeOfDay.new(h: object.hour, m: object.minute, s: object.second)
           else object
           end
         end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.44.2
+  version: 4.45.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,9 +108,14 @@ files:
 - lib/openhab/dsl/monkey_patch/events/item_state.rb
 - lib/openhab/dsl/monkey_patch/events/item_state_changed.rb
 - lib/openhab/dsl/monkey_patch/events/thing_status_info.rb
+- lib/openhab/dsl/monkey_patch/java/java.rb
+- lib/openhab/dsl/monkey_patch/java/local_time.rb
+- lib/openhab/dsl/monkey_patch/java/time_extensions.rb
+- lib/openhab/dsl/monkey_patch/java/zoned_date_time.rb
 - lib/openhab/dsl/monkey_patch/ruby/number.rb
 - lib/openhab/dsl/monkey_patch/ruby/ruby.rb
 - lib/openhab/dsl/monkey_patch/ruby/string.rb
+- lib/openhab/dsl/monkey_patch/ruby/time.rb
 - lib/openhab/dsl/openhab.rb
 - lib/openhab/dsl/persistence.rb
 - lib/openhab/dsl/rules/automation_rule.rb