openhab-scripting 2.11.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 506ce31e641f76fe22663d36003bdbfcec17d01042c882bf240e85d18f622525
-  data.tar.gz: d4b390223605105da4308a6b11a6124f9e953cd916d6bfdb7cd4788da01ef008
+  metadata.gz: 376e7ceca67ad5ca1dfedcacee9096e97819f3a382404ddde4f7beb579416e7d
+  data.tar.gz: bdffa11dab63e1910d38a1232c38e2b9d64deaac1d8ea3610de464792d75173e
 SHA512:
-  metadata.gz: 987a35a048c611e33e990dc9b3c9d83fd592ba844ee90781c976d2c66b43bdb10837c2c3652c4140b5acc7af6214315a7015f3b64c088943ecaa2a82e65a6477
-  data.tar.gz: f70fbff98656f3ad15a45ebd2a693462a43dce48515724818f5421bfaf91c194aab9db0c2011c7f1379b38fd6c315fb1ba329664c53cca330dd41970a4831f81
+  metadata.gz: 712aa971a831d8b700ecbe23b429a083518deb3bf7c2b68aa91cc0f3e5253ac9a32087025994705b94d268db58ef73e27767dcb3ce182e4477bfa115c6c476e0
+  data.tar.gz: e450d32857df9dd5aea47cc5e0baa7043e06901282324d2dfd4623cb2eac03c8fb60335e3de2e680911f1d4ad24095c2533fd3a9d5c90501694f849019e2d225

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/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/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 }
@@ -128,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
@@ -303,6 +316,23 @@ module OpenHAB
             false
           end
 
+          #
+          # Patch event to include event.item when it doesn't exist
+          # This is to patch a bug see https://github.com/boc-tothefuture/openhab-jruby/issues/75
+          # It may be fixed in the openhab core in the future, in which case, this patch will no longer be necessary
+          #
+          # @param [OpenHAB Event] event to check for item accessor
+          # @param [OpenHAB Event Inputs] inputs inputs to running rule
+          #
+          def add_event_item(event, inputs)
+            return if event.nil? || defined?(event.item)
+
+            class << event
+              attr_accessor :item
+            end
+            event.item = inputs&.dig('triggeringItem')
+          end
+
           #
           # Process the run queue
           #
@@ -317,7 +347,7 @@ module OpenHAB
               when RuleConfig::Run
 
                 event = inputs&.dig('event')
-
+                add_event_item(event, inputs)
                 logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
                 task.block.call(event)
               when RuleConfig::Trigger

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-03 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