openhab-scripting 2.11.1 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa36a09bcefbd672716ede992f1525cf81edbf3db5bef1b40e46f7ab0a46837
-  data.tar.gz: 871e30faf15a2bd26010c5d118c26cbc569182bf7b849217b5b751148ec95fb7
+  metadata.gz: 6851ec9dce8db775e48aaf7d08078281e2a2e9c1d6a2c2cd379de0d3fd2391f0
+  data.tar.gz: 2f656d9cb621d3826c72c2aa588d1ba478108bc30cffd32bf8e0e5fae85dbe47
 SHA512:
-  metadata.gz: fe9756bf909c3061d9824cf4a072ddd1e4c83ebdcec5710ebb166db4a9b302d06942bc3a10ab00a89acc28ab6db2c716a1adfd5cf39beee2462fbf253525bb84
-  data.tar.gz: '039eec961406e82062744e131aeb8da4db95dc613c9da0c017f0be70d77edae181f40bdbb49693b8b5244dbcabc9289470fb77eca2033f596285fcc5c0dc1a72'
+  metadata.gz: 248767b8ec14f2f68412f152755beb872b15b6db26b363cc0837419e16f044b8c6b078843cd93c4efe8fe03358256df7cb8d390ebe43ddb6ad00b962ecb197ce
+  data.tar.gz: 9bb8e09d8a34c96b220b16b209c92cf5fce0f1bd54f28086ed3f6e4ae83ab24b0288bb828d9b2111fec3fbef10025b70624b13005140690ce5a9b2556df1a132

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

@@ -22,7 +22,17 @@ module OpenHAB
             item = $ir.getItem(name)
             # rubocop: enable Style/GlobalVars
             (item.is_a? GroupItem) ? nil : item
+          rescue Java::OrgOpenhabCoreItems::ItemNotFoundException
+            nil
           end
+
+          # Returns true if the given item name exists
+          # @param name [String] Item name to check
+          # @return [Boolean] true if the item exists, false otherwise
+          def include?(name)
+            !$ir.getItems(name).empty?
+          end
+          alias key? include?
         end
 
         java_import org.openhab.core.items.GroupItem

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

@@ -59,7 +59,7 @@ module OpenHAB
               if dimension
                 [Quantity.new(other), to_qt]
               elsif @number_item.state?
-                [BigDecimal(other), @number_item.state.to_big_decimal.to_d]
+                [other.to_d, @number_item.state.to_big_decimal.to_d]
               end
             else
               logger.trace("#{self} cannot be coereced to #{other.class}")
@@ -85,7 +85,7 @@ module OpenHAB
                 @number_item.state <=> other.state
               end
             when Numeric
-              @number_item.state.to_big_decimal.to_d <=> BigDecimal(other)
+              @number_item.state.to_big_decimal.to_d <=> other.to_d
             when String
               @number_item.state <=> QuantityType.new(other) if dimension
             end
@@ -199,7 +199,7 @@ module OpenHAB
                   to_d.public_send(operation, other.to_d)
                 end
               elsif other.is_a? Numeric
-                to_d.public_send(operation, BigDecimal(other))
+                to_d.public_send(operation, other.to_d)
               elsif dimension && other.is_a?(String)
                 to_qt.public_send(operation, Quantity.new(other))
               elsif other.respond_to? :coerce

data/lib/openhab/core/dsl/monkey_patch/items/dimmer_item.rb

@@ -14,6 +14,7 @@ Dimmer = DimmerItem
 #
 # rubocop:disable Style/ClassAndModuleChildren
 class Java::OrgOpenhabCoreLibraryItems::DimmerItem
+  include Comparable
   # rubocop:enable Style/ClassAndModuleChildren
   java_import org.openhab.core.library.types.DecimalType
   java_import org.openhab.core.library.types.IncreaseDecreaseType
@@ -85,6 +86,38 @@ class Java::OrgOpenhabCoreLibraryItems::DimmerItem
     target
   end
 
+  #
+  # Compare DimmerItem to supplied object
+  #
+  # @param [Object] other object to compare to
+  #
+  # @return [Integer] -1,0,1 or nil depending on value supplied, nil comparison to supplied object is not possible.
+  #
+  def <=>(other)
+    logger.trace("Comparing #{self} to #{other}")
+    case other
+    when DimmerItem, NumberItem
+      state <=> other.state
+    when DecimalType
+      state <=> other
+    else
+      to_i <=> other.to_i
+    end
+  end
+
+  #
+  # Compare DimmerItem to supplied object.
+  # The == operator needs to be overridden because the parent java object
+  # has .equals which overrides the <=> operator above
+  #
+  # @param [Object] other object to compare to
+  #
+  # @return [Integer] true if the two objects contain the same value, false otherwise
+  #
+  def ==(other)
+    (self <=> other).zero?
+  end
+
   #
   # Check if dimmer has a state and state is not zero
   #
@@ -105,6 +138,15 @@ class Java::OrgOpenhabCoreLibraryItems::DimmerItem
 
   alias to_int to_i
 
+  #
+  # Return the string representation of the dimmer item
+  #
+  # @return [String] String version of the dimmer value
+  #
+  def to_s
+    to_i.to_s
+  end
+
   #
   # Check if dimmer is on
   #

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'core/duration'
-
 module OpenHAB
   module Core
     module DSL
@@ -14,44 +12,18 @@ module OpenHAB
             include OpenHAB::Core
 
             #
-            # Create Duration with unit of seconds
-            #
-            # @return [OpenHAB::Core::Duration] Duration with number of seconds from self
-            #
-            def seconds
-              Duration.new(temporal_unit: :SECONDS, amount: self)
-            end
-
-            #
-            # Create Duration with unit of milliseconds
-            #
-            # @return [OpenHAB::Core::Duration] Duration with number of milliseconds from self
-            #
-            def milliseconds
-              Duration.new(temporal_unit: :MILLISECONDS, amount: self)
-            end
-
-            #
-            # Create Duration with unit of minutes
-            #
-            # @return [OpenHAB::Core::Duration] Duration with number of minutes from self
-            #
-            def minutes
-              Duration.new(temporal_unit: :MINUTES, amount: self)
-            end
-
-            #
-            # Create Duration with unit of hours
+            # Create Duration with the specified unit
             #
-            # @return [OpenHAB::Core::Duration] Duration with number of hours from self
+            # @return [Java::JavaTime::Duration] Duration with number of units from self
             #
-            def hours
-              Duration.new(temporal_unit: :HOURS, amount: self)
+            %w[millis seconds minutes hours].each do |unit|
+              define_method(unit) { Java::JavaTime::Duration.public_send("of_#{unit}", self) }
             end
 
             alias second seconds
-            alias millisecond milliseconds
-            alias ms milliseconds
+            alias millisecond millis
+            alias milliseconds millis
+            alias ms millis
             alias minute minutes
             alias hour hours
           end

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

@@ -3,3 +3,4 @@
 # Monkey patch ruby
 require 'openhab/core/dsl/monkey_patch/ruby/range'
 require 'openhab/core/dsl/monkey_patch/ruby/number'
+require 'bigdecimal/util'

data/lib/openhab/core/dsl/rule/cron.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'java'
-require 'core/duration'
 require 'core/dsl/time_of_day'
 require 'core/cron'
 
@@ -64,8 +63,10 @@ module OpenHAB
               expression_map = EXPRESSION_MAP[value]
               expression_map = at_condition(expression_map, at) if at
               cron(map_to_cron(expression_map))
-            when Duration
-              cron(map_to_cron(value.cron_map))
+            when Java::JavaTime::Duration
+              raise ArgumentError, '"at" cannot be used with duration' if at
+
+              cron(map_to_cron(duration_to_map(value)))
             else
               raise ArgumentExpression, 'Unknown interval' unless expression_map
             end
@@ -93,6 +94,28 @@ module OpenHAB
             %i[second minute hour dom month dow].map { |field| map.fetch(field) }.join(' ')
           end
 
+          #
+          # Convert a Java Duration to a map for the map_to_cron method
+          #
+          # @param duration [Java::JavaTime::Duration] The duration object
+          #
+          # @return [Hash] a map suitable for map_to_cron
+          #
+          def duration_to_map(duration)
+            if duration.to_millis_part.zero? && duration.to_nanos_part.zero? && duration.to_days.zero?
+              %i[second minute hour].each do |unit|
+                to_unit_part = duration.public_send("to_#{unit}s_part")
+                next unless to_unit_part.positive?
+
+                to_unit = duration.public_send("to_#{unit}s")
+                break unless to_unit_part == to_unit
+
+                return EXPRESSION_MAP[unit].merge(unit => "*/#{to_unit}")
+              end
+            end
+            raise ArgumentError, "Cron Expression not supported for duration: #{duration}"
+          end
+
           #
           # If an at time is provided, parse that and merge the new fields into the expression.
           #

data/lib/openhab/core/dsl/rule/item.rb

@@ -35,9 +35,6 @@ module OpenHAB
           # @return [Array] Array of current TriggerDelay objects
           #
           def changed_wait(item, duration:, to: nil, from: nil)
-            # Convert to testing the group if group specified rather than item
-            item = item.group if item.is_a? Group
-
             # If GroupItems specified, use the group state trigger instead
             if item.is_a? GroupItems
               config = { 'groupName' => item.group.name }
@@ -97,7 +94,6 @@ module OpenHAB
           #
           def updated(*items, to: nil)
             items.flatten.each do |item|
-              item = item.group if item.is_a? Group
               logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
               [to].flatten.each do |to_state|
                 case item
@@ -129,7 +125,6 @@ module OpenHAB
           #
           def changed(*items, to: nil, from: nil, for: nil)
             items.flatten.each do |item|
-              item = item.group if item.is_a? Group
               logger.trace("Creating changed trigger for entity(#{item}), to(#{to}), from(#{from})")
               # for is a reserved word in ruby, so use local_variable_get :for
               if (wait_duration = binding.local_variable_get(:for))

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

@@ -113,6 +113,19 @@ module OpenHAB
           def my(&block)
             @caller.instance_eval(&block)
           end
+
+          #
+          # Create a logger where name includes rule name if name is set
+          #
+          # @return [Logging::Logger] Logger with name that appended with rule name if rule name is set
+          #
+          def logger
+            if name
+              Logging.logger(name.chomp.gsub(/\s+/, '_'))
+            else
+              super
+            end
+          end
         end
 
         #
@@ -274,7 +287,7 @@ module OpenHAB
                   process_trigger_delay(mod, inputs)
                 else
                   logger.trace("Item changed to #{state} for #{trigger_delay}, rescheduling timer.")
-                  trigger_delay.timer.reschedule(ZonedDateTime.now.plus(Java::JavaTime::Duration.ofMillis(duration.to_ms)))
+                  trigger_delay.timer.reschedule(ZonedDateTime.now.plus(duration))
                 end
               end
             else

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

@@ -4,8 +4,6 @@ require 'java'
 require 'delegate'
 require 'forwardable'
 
-require 'core/duration'
-
 module OpenHAB
   module Core
     module DSL
@@ -49,7 +47,7 @@ module OpenHAB
 
             semaphore.synchronize do
               @timer = ScriptExecution.createTimer(
-                ZonedDateTime.now.plus(Java::JavaTime::Duration.ofMillis(@duration.to_ms)), @block
+                ZonedDateTime.now.plus(@duration), @block
               )
               super(@timer)
             end
@@ -64,7 +62,7 @@ module OpenHAB
           #
           def reschedule(duration = nil)
             duration ||= @duration
-            @timer.reschedule(ZonedDateTime.now.plus(Java::JavaTime::Duration.ofMillis(duration.to_ms)))
+            @timer.reschedule(ZonedDateTime.now.plus(duration))
           end
         end
 

data/lib/openhab/core/dsl/types/quantity.rb

@@ -46,7 +46,7 @@ module OpenHAB
                         when QuantityType
                           quantity
                         when Numeric
-                          QuantityType.new(BigDecimal(quantity).to_java, AbstractUnit::ONE)
+                          QuantityType.new(quantity.to_d.to_java, AbstractUnit::ONE)
                         else
                           raise "Unexpected type #{quantity.class} provided to Quantity initializer"
                         end
@@ -152,7 +152,7 @@ module OpenHAB
                        logger.trace("Number Item coerced result a(#{a.class})='#{a}' b(#{b.class})='#{b}'")
                        [a.quantity, b.quantity]
                      when Numeric
-                       [quantity, QuantityType.new(BigDecimal(other).to_java, AbstractUnit::ONE)]
+                       [quantity, QuantityType.new(other.to_d.to_java, AbstractUnit::ONE)]
                      else
                        raise TypeError,
                              "Operation '#{operation}' cannot be performed between #{self} and #{other.class}"

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.14.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,6 @@ files:
 - lib/openhab/core/dsl/timers.rb
 - lib/openhab/core/dsl/types/quantity.rb
 - lib/openhab/core/dsl/units.rb
-- lib/openhab/core/duration.rb
 - lib/openhab/core/log.rb
 - lib/openhab/core/patch_load_path.rb
 - lib/openhab/core/startup_delay.rb

data/lib/openhab/core/duration.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/core/cron'
-
-module OpenHAB
-  module Core
-    #
-    # This class represents a duration of time
-    #
-    class Duration
-      include OpenHAB::Core::Cron
-
-      # @return [Array] of supported temperal units (milliseconds, seconds, minutes and hours)
-      TEMPORAL_UNITS = %i[MILLISECONDS SECONDS MINUTES HOURS].freeze
-
-      #
-      # Create a new Duration object
-      #
-      # @param [Symbol] temporal_unit Unit for duration
-      # @param [Integer] amount of that unit
-      #
-      def initialize(temporal_unit:, amount:)
-        unless TEMPORAL_UNITS.include? temporal_unit
-          raise ArgumentError,
-                "Unexpected Temporal Unit: #{temporal_unit}"
-        end
-
-        @temporal_unit = temporal_unit
-        @amount = amount
-      end
-
-      #
-      # Return a map
-      #
-      # @return [Map] Map with fields representing this duration @see OpenHAB::Core::Cron
-      #
-      def cron_map
-        case @temporal_unit
-        when :SECONDS
-          cron_expression_map.merge(second: "*/#{@amount}")
-        when :MINUTES
-          cron_expression_map.merge(minute: "*/#{@amount}")
-        when :HOURS
-          cron_expression_map.merge(hour: "*/#{@amount}")
-        else
-          raise ArgumentError, "Cron Expression not supported for temporal unit: #{temporal_unit}"
-        end
-      end
-
-      #
-      # Convert the duration to milliseconds
-      #
-      # @return [Integer] Duration in milliseconds
-      #
-      def to_ms
-        case @temporal_unit
-        when :MILLISECONDS
-          @amount
-        when :SECONDS
-          @amount * 1000
-        when :MINUTES
-          @amount * 1000 * 60
-        when :HOURS
-          @amount * 1000 * 60 * 60
-        end
-      end
-
-      #
-      # Return a string representation of the duration
-      #
-      # @return [String] Duration in string
-      #
-      def to_s
-        "#{@amount} #{(@amount == 1) ? @temporal_unit.to_s.downcase.delete_suffix('s') : @temporal_unit.to_s.downcase}"
-      end
-    end
-  end
-end