openhab-scripting 2.14.2 → 2.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf896ff53247e4170a9d3c09ebd3b337114bcc8509963001f4ccea9a4c81d52f
-  data.tar.gz: 974c4e5175053de2818fa725de5376458f21a01bc45fb444ac4a6b82e84685bb
+  metadata.gz: 7471d207d040d9fb085fa45e4f6be88f7ad9d99b0987b6a6845f2bb85c8bf5ab
+  data.tar.gz: b000d8e9397d5556c4387f09e1ec247ccd8303cfa83b27722737e38324ac91b6
 SHA512:
-  metadata.gz: f3d966995bcf7d4d6ae5ff5a6567af8e47e57355d7ac438b46b236755205a6dbc955520f28734901f8e49b8d415b6a0497f82f1a89a698cc90d61363621d9396
-  data.tar.gz: 0a76fe6c623432d7203ddbac268690be10ff7c9bcdcd1a2b56ace1cda3ead34f036ee70cd7f66c695c284faba921f37b3e5bbf6a091b616b31a2ca94e1c4cb89
+  metadata.gz: 13d1994d629262afc44f8c8e62c965e65e383e91224b8fbd12d83f9ec61fa707a0655060c805e3342b373adc5d3034f1744defca1803f84d52190aab055cd8de
+  data.tar.gz: 368969daaa876bdebbd0b60b8818f9da333c2c6d9df96fa7f00abf99df4891f32cd2151d576a6819c2213630fd1ccf3e1a81a1ddc5aa48d2bfe20be776a3c91a

data/lib/openhab/core/dsl.rb

@@ -19,6 +19,7 @@ require 'core/dsl/gems'
 require 'core/dsl/units'
 require 'core/dsl/types/quantity'
 require 'core/dsl/states'
+require 'core/dsl/persistence'
 
 module OpenHAB
   #
@@ -30,6 +31,7 @@ module OpenHAB
     #
     module DSL
       # Extend the calling module/class with the DSL
+      # rubocop: disable Metrics/MethodLength
       def self.extended(base)
         base.send :include, OpenHAB::Core::DSL::Rule
         base.send :include, OpenHAB::Core::DSL::Items
@@ -40,8 +42,10 @@ module OpenHAB
         base.send :include, OpenHAB::Core::DSL::Timers
         base.send :include, OpenHAB::Core::DSL::States
         base.send :include, OpenHAB::Core::DSL::Tod
+        base.send :include, OpenHAB::Core::DSL::Persistence
         base.send :include, Things
       end
+      # rubocop: enable Metrics/MethodLength
     end
   end
 end

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

@@ -27,6 +27,7 @@ end
 #
 module EntityLookup
   include Logging
+
   #
   # Decorate items with Ruby wrappers
   #
@@ -34,26 +35,32 @@ module EntityLookup
   #
   # @return [Array] Array of decorated items
   #
-  # rubocop: disable Metrics/MethodLength
-  # Disabled line length - case dispatch pattern
   def self.decorate_items(*items)
-    items.flatten.map do |item|
-      case item
-      when GroupItem
-        decorate_group(item)
-      when Java::Org.openhab.core.library.items::NumberItem
-        OpenHAB::Core::DSL::Items::NumberItem.new(item)
-      when Java::Org.openhab.core.library.items::StringItem
-        OpenHAB::Core::DSL::Items::StringItem.new(item)
-      else
-        item
-      end
+    items.flatten.map { |item| decorate_item(item) }
+  end
+
+  #
+  # Decorate item with Ruby wrappers
+  #
+  # @param [Object] item the item object to decorate
+  #
+  # @return [Object] the ruby wrapper for the item
+  #
+  def self.decorate_item(item)
+    case item
+    when GroupItem
+      decorate_group(item)
+    when Java::Org.openhab.core.library.items::NumberItem
+      OpenHAB::Core::DSL::Items::NumberItem.new(item)
+    when Java::Org.openhab.core.library.items::StringItem
+      OpenHAB::Core::DSL::Items::StringItem.new(item)
+    else
+      item
     end
   end
-  # rubocop: enable Metrics/MethodLength
 
   #
-  # Loops up a Thing in the OpenHAB registry replacing '_' with ':'
+  # Looks up a Thing in the OpenHAB registry replacing '_' with ':'
   #
   # @param [String] name of Thing to lookup in Thing registry
   #
@@ -86,7 +93,7 @@ module EntityLookup
     # rubocop: disable Style/GlobalVars
     item = $ir.get(name)
     # rubocop: enable Style/GlobalVars
-    EntityLookup.decorate_items(item).first
+    EntityLookup.decorate_item(item)
   end
 
   #

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

@@ -86,6 +86,15 @@ module OpenHAB
           def to_s
             "[#{map(&:to_s).join(',')}]"
           end
+
+          #
+          # Get an ID for the group, using the label if set, otherwise group name
+          #
+          # @return [String] label if set otherwise name
+          #
+          def id
+            label || name
+          end
         end
       end
     end

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

@@ -21,7 +21,7 @@ module OpenHAB
             # rubocop: disable Style/GlobalVars
             item = $ir.getItem(name)
             # rubocop: enable Style/GlobalVars
-            item.is_a?(GroupItem) ? nil : item
+            item.is_a?(GroupItem) ? nil : EntityLookup.decorate_item(item)
           rescue Java::OrgOpenhabCoreItems::ItemNotFoundException
             nil
           end

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

@@ -58,7 +58,7 @@ module OpenHAB
             when Quantity then coerce_from_quantity(other)
             when Numeric then  coerce_from_numeric(other)
             else
-              logger.trace("#{self} cannot be coereced to #{other.class}")
+              logger.trace("#{self} cannot be coerced to #{other.class}")
               nil
             end
           end
@@ -71,14 +71,19 @@ module OpenHAB
           # @return [Integer] -1,0,1 or nil depending on value supplied,
           #   nil comparison to supplied object is not possible.
           #
+          # rubocop: disable Metrics/AbcSize
           def <=>(other)
-            logger.trace("Comparing #{self} to #{other}")
+            logger.trace("NumberItem #{self} <=> #{other} (#{other.class})")
             case other
             when NumberItem then number_item_compare(other)
-            when Numeric then  @number_item.state.to_big_decimal.to_d <=> other.to_d
-            when String  then  @number_item.state <=> QuantityType.new(other) if dimension
+            when Numeric then @number_item.state.to_big_decimal.to_d <=> other.to_d
+            when String then @number_item.state <=> QuantityType.new(other) if dimension
+            else
+              other = other.state if other.respond_to? :state
+              @number_item.state <=> other
             end
           end
+          # rubocop: enable Metrics/AbcSize
 
           #
           # Convert NumberItem to a Quantity

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

@@ -75,6 +75,8 @@ module OpenHAB
               @string_item.state <=> other.state
             when String
               @string_item.state.to_s <=> other
+            else
+              @string_item.state <=> other
             end
           end
 

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

@@ -96,12 +96,27 @@ class Java::OrgOpenhabCoreLibraryItems::DimmerItem
   def <=>(other)
     logger.trace("Comparing #{self} to #{other}")
     case other
-    when DimmerItem, NumberItem
-      state <=> other.state
-    when DecimalType
-      state <=> other
+    when Java::OrgOpenhabCoreItems::GenericItem, NumberItem then state <=> other.state
+    when DecimalType then state <=> other
+    when Numeric then state.to_big_decimal.to_d <=> other.to_d
+    else compare_to(other)
+    end
+  end
+
+  #
+  # Coerce objects into a DimmerItem
+  #
+  # @param [Object] other object to coerce to a DimmerItem if possible
+  #
+  # @return [Object] Numeric when applicable
+  #
+  def coerce(other)
+    logger.trace("Coercing #{self} as a request from  #{other.class}")
+    case other
+    when Numeric
+      [other, state.to_big_decimal.to_d]
     else
-      to_i <=> other.to_i
+      [other, state]
     end
   end
 

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

@@ -6,6 +6,7 @@ require 'bigdecimal'
 
 # Monkey patch items
 require 'openhab/core/dsl/monkey_patch/items/metadata'
+require 'openhab/core/dsl/monkey_patch/items/persistence'
 require 'openhab/core/dsl/monkey_patch/items/contact_item'
 require 'openhab/core/dsl/monkey_patch/items/dimmer_item'
 require 'openhab/core/dsl/monkey_patch/items/switch_item'
@@ -127,4 +128,5 @@ class Java::OrgOpenhabCoreItems::GenericItem
   # rubocop:enable Style/ClassAndModuleChildren
   prepend OpenHAB::Core::DSL::MonkeyPatch::Items::ItemExtensions
   prepend OpenHAB::Core::DSL::MonkeyPatch::Items::Metadata
+  prepend OpenHAB::Core::DSL::MonkeyPatch::Items::Persistence
 end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module DSL
+      module MonkeyPatch
+        module Items
+          #
+          # Persistence extension for Items
+          #
+          module Persistence
+            %w[persist last_update].each do |method|
+              define_method(method) do |service = nil|
+                service ||= persistence_service
+                PersistenceExtensions.public_send(method, self, service&.to_s)
+              end
+            end
+
+            #
+            # Return the previous state of the item
+            #
+            # @param skip_equal [Boolean] if true, skips equal state values and
+            #        searches the first state not equal the current state
+            # @param service [String] the name of the PersistenceService to use
+            #
+            # @return the previous state or nil if no previous state could be found,
+            #         or if the default persistence service is not configured or
+            #         does not refer to a valid service
+            #
+            def previous_state(service = nil, skip_equal: false)
+              service ||= persistence_service
+              PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
+            end
+
+            %w[
+              average_since
+              changed_since
+              delta_since
+              deviation_since
+              evolution_rate
+              historic_state
+              maximum_since
+              minimum_since
+              sum_since
+              updated_since
+              variance_since
+            ].each do |method|
+              define_method(method) do |timestamp, service = nil|
+                service ||= persistence_service
+                if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
+                  timestamp = Java::JavaTime::ZonedDateTime.now.minus(timestamp)
+                end
+                PersistenceExtensions.public_send(method, self, timestamp, service&.to_s)
+              end
+            end
+
+            private
+
+            #
+            # Get the specified persistence service from the current thread local variable
+            #
+            # @return [Object] Persistence service name as String or Symbol, or nil if not set
+            #
+            def persistence_service
+              Thread.current.thread_variable_get(:persistence_service)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'openhab/core/dsl/types/quantity'
+
+module OpenHAB
+  module Core
+    module DSL
+      module MonkeyPatch
+        module Ruby
+          #
+          # Extend String class
+          #
+          module StringExtensions
+            include OpenHAB::Core
+
+            #
+            # Compares String to another object
+            #
+            # @param [Object] other object to compare to
+            #
+            # @return [Boolean]  true if the two objects contain the same value, false otherwise
+            #
+            def ==(other)
+              case other
+              when OpenHAB::Core::DSL::Types::Quantity, QuantityType
+                other == self
+              else
+                super
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+#
+# Prepend String class with comparison extensions
+#
+class String
+  prepend OpenHAB::Core::DSL::MonkeyPatch::Ruby::StringExtensions
+end

data/lib/openhab/core/dsl/monkey_patch/types/decimal_type.rb

@@ -10,15 +10,51 @@ class Java::OrgOpenhabCoreLibraryTypes::DecimalType
   # rubocop:enable Style/ClassAndModuleChildren
 
   #
-  # Compare self to other using Java BigDecimal compare method
+  # Compare DecimalType to supplied object
   #
   # @param [Object] other object to compare to
   #
-  # @return [Boolean] True if have the same BigDecimal representation, false otherwise
+  # @return [Integer] -1,0,1 or nil depending on value supplied, nil comparison to supplied object is not possible.
   #
-  def ==(other)
-    return equals(other) unless other.is_a? Integer
+  def <=>(other)
+    logger.trace("#{self.class} #{self} <=> #{other} (#{other.class})")
+    case other
+    when Numeric
+      to_big_decimal.compare_to(other.to_d)
+    when Java::OrgOpenhabCoreTypes::UnDefType
+      1
+    else
+      other = other.state if other.respond_to? :state
+      compare_to(other)
+    end
+  end
+
+  #
+  # Coerce objects into a DecimalType
+  #
+  # @param [Object] other object to coerce to a DecimalType if possible
+  #
+  # @return [Object] Numeric when applicable
+  #
+  def coerce(other)
+    logger.trace("Coercing #{self} as a request from #{other.class}")
+    case other
+    when Numeric
+      [other.to_d, to_big_decimal]
+    else
+      [other, self]
+    end
+  end
 
-    to_big_decimal.compare_to(Java::JavaMath::BigDecimal.new(other)).zero?
+  #
+  # Compare self to other through the spaceship operator
+  #
+  # @param [Object] other object to compare to
+  #
+  # @return [Boolean] True if equals
+  #
+  def ==(other)
+    logger.trace("#{self.class} #{self} == #{other} (#{other.class})")
+    (self <=> other).zero?
   end
 end

data/lib/openhab/core/dsl/monkey_patch/types/quantity_type.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'java'
+
+#
+# MonkeyPatching QuantityType
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreLibraryTypes::QuantityType
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  #
+  # Compare QuantityType 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("#{self.class} #{self} <=> #{other} (#{other.class})")
+    case other
+    when Java::OrgOpenhabCoreTypes::UnDefType then 1
+    when String then self <=> Quantity.new(other)
+    when OpenHAB::Core::DSL::Types::Quantity then self <=> other.quantity
+    else
+      other = other.state if other.respond_to? :state
+      compare_to(other)
+    end
+  end
+
+  #
+  # Coerce objects into a QuantityType
+  #
+  # @param [Object] other object to coerce to a QuantityType if possible
+  #
+  # @return [Object] Numeric when applicable
+  #
+  def coerce(other)
+    logger.trace("Coercing #{self} as a request from #{other.class}")
+    case other
+    when String
+      [Quantity.new(other), self]
+    else
+      [other, self]
+    end
+  end
+
+  #
+  # Compare self to other using the spaceship operator
+  #
+  # @param [Object] other object to compare to
+  #
+  # @return [Boolean] True if equals
+  #
+  def ==(other)
+    (self <=> other).zero?
+  end
+end

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

@@ -5,3 +5,4 @@ require 'core/dsl/monkey_patch/types/open_closed_type'
 require 'core/dsl/monkey_patch/types/on_off_type'
 require 'core/dsl/monkey_patch/types/decimal_type'
 require 'core/dsl/monkey_patch/types/percent_type'
+require 'core/dsl/monkey_patch/types/quantity_type'

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module DSL
+      #
+      # Provides support for interacting with OpenHAB Persistence service
+      #
+      module Persistence
+        #
+        # Sets a thread local variable to set the default persistence service
+        # for method calls inside the block
+        #
+        # @param [Object] Persistence service either as a String or a Symbol
+        # @yield [] Block executed in context of the supplied persistence service
+        #
+        #
+        def persistence(service)
+          Thread.current.thread_variable_set(:persistence_service, service)
+          yield
+        ensure
+          Thread.current.thread_variable_set(:persistence_service, nil)
+        end
+      end
+    end
+  end
+end

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

@@ -221,20 +221,18 @@ module OpenHAB
           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
+          # Patch event to decorate event.item with our item wrapper
           #
-          # @param [OpenHAB Event] event to check for item accessor
-          # @param [OpenHAB Event Inputs] inputs inputs to running rule
+          # @param [OpenHAB Event] event patch
           #
-          def add_event_item(event, inputs)
-            return if event.nil? || defined?(event.item)
+          def decorate_event_item(event)
+            return if event.nil?
 
             class << event
-              attr_accessor :item
+              def item
+                EntityLookup.lookup_item(item_name)
+              end
             end
-            event.item = inputs&.dig('triggeringItem')
           end
 
           #
@@ -266,6 +264,7 @@ module OpenHAB
           #
           #
           def process_otherwise_task(event, task)
+            decorate_event_item(event)
             logger.trace { "Executing rule '#{name}' otherwise block with event(#{event})" }
             task.block.call(event)
           end
@@ -292,9 +291,7 @@ module OpenHAB
           #
           #
           def process_trigger_task(event, task)
-            # rubocop: disable Style/GlobalVars
-            triggering_item = $ir.get(event&.itemName)
-            # rubocop: enable Style/GlobalVars
+            triggering_item = EntityLookup.lookup_item(event&.itemName)
             logger.trace { "Executing rule '#{name}' trigger block with item (#{triggering_item})" }
             task.block.call(triggering_item) if triggering_item
           end
@@ -307,8 +304,8 @@ module OpenHAB
           # @param [Run] task to execute
           #
           #
-          def process_run_task(event, inputs, task)
-            add_event_item(event, inputs)
+          def process_run_task(event, _inputs, task)
+            decorate_event_item(event)
             logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
             task.block.call(event)
           end

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

@@ -69,7 +69,7 @@ module OpenHAB
             end
             logger.trace("Creating Changed Wait Change Trigger for #{config}")
             trigger = append_trigger(trigger, config)
-            @trigger_delays = { trigger.id => TriggerDelay.new(to: to, from: from, duration: duration) }
+            @trigger_delays[trigger.id] = TriggerDelay.new(to: to, from: from, duration: duration)
           end
 
           #

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

@@ -127,7 +127,7 @@ module OpenHAB
         end
 
         # Modules that refines the Ruby Range object cover? and include? methods to support TimeOfDay ranges
-        class TimeOfDayRangeElement
+        class TimeOfDayRangeElement < Numeric
           include Comparable
           include Logging
 
@@ -138,6 +138,8 @@ module OpenHAB
           def initialize(sod:, range_begin:)
             @sod = sod
             @range_begin = range_begin
+
+            super()
           end
 
           # Returns the current second of day advanced by 1 second

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.14.2
+  version: 2.16.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,15 +54,19 @@ files:
 - lib/openhab/core/dsl/monkey_patch/items/group_item.rb
 - lib/openhab/core/dsl/monkey_patch/items/items.rb
 - lib/openhab/core/dsl/monkey_patch/items/metadata.rb
+- lib/openhab/core/dsl/monkey_patch/items/persistence.rb
 - lib/openhab/core/dsl/monkey_patch/items/switch_item.rb
 - lib/openhab/core/dsl/monkey_patch/ruby/number.rb
 - lib/openhab/core/dsl/monkey_patch/ruby/range.rb
 - lib/openhab/core/dsl/monkey_patch/ruby/ruby.rb
+- lib/openhab/core/dsl/monkey_patch/ruby/string.rb
 - lib/openhab/core/dsl/monkey_patch/types/decimal_type.rb
 - lib/openhab/core/dsl/monkey_patch/types/on_off_type.rb
 - lib/openhab/core/dsl/monkey_patch/types/open_closed_type.rb
 - lib/openhab/core/dsl/monkey_patch/types/percent_type.rb
+- lib/openhab/core/dsl/monkey_patch/types/quantity_type.rb
 - lib/openhab/core/dsl/monkey_patch/types/types.rb
+- lib/openhab/core/dsl/persistence.rb
 - lib/openhab/core/dsl/property.rb
 - lib/openhab/core/dsl/rule/automation_rule.rb
 - lib/openhab/core/dsl/rule/guard.rb