openhab-scripting 4.26.3 → 4.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392687513a444dec2b461e935da7c333b3796f3b34ca87e38a816d2860ebd91b
-  data.tar.gz: e855efc99e2a355d28ccc59cacfeb91aef879878a6397ef5532e19e8df91b187
+  metadata.gz: 738583da2cd48296525b6b6a2999fe1daba82b0cbb1c410beb7e3575fdf6afbb
+  data.tar.gz: e7d4ff645268380636f69bff6eec42d8b8f650784225afe9d456027b44e11d77
 SHA512:
-  metadata.gz: 914e0d0ebd4f1291cdff34056f67d3268d405b2d5cfd5c19eb51a69893c86f57169b109e3b925455535d78ac37f2611059ed4315161b61c917ad64b6359a88a5
-  data.tar.gz: d62197a91e6d3e8a5f393faf8e644d7e92edf4815893a8d26494a531622c12d17dc2bf1e4ed213899b043f2cbd9c1993a77cab09db952ae49e288d41a6fd2d06
+  metadata.gz: e06a080cedde9ffbb29983f087c93dff1533fe521112c1036015c1f42f93c5a9d164bd0c307d21109c8f3a6abe7cb74e0f63b144cd21d2f7086a1e03d0b9c545
+  data.tar.gz: e23ccc89ee67bc2152efaa91ff33157c74d99d244da3cc11b497b8500b094f40dfc66b61fcb04c18763fe53afaabccba8baa6f2bf05c9f3d5d194915255f8078

data/lib/openhab/core/entity_lookup.rb

@@ -5,6 +5,7 @@ require 'java'
 require 'set'
 
 require 'openhab/log/logger'
+require_relative 'item_proxy'
 
 # Automation lookup and injection of OpenHab entities
 
@@ -91,7 +92,8 @@ module OpenHAB
       def self.lookup_item(name)
         logger.trace("Looking up item(#{name})")
         name = name.to_s if name.is_a? Symbol
-        $ir.get(name) # rubocop: disable Style/GlobalVars
+        item = $ir.get(name) # rubocop: disable Style/GlobalVars
+        ItemProxy.new(item) unless item.nil?
       end
     end
   end

data/lib/openhab/core/item_proxy.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'forwardable'
+
+module OpenHAB
+  module Core
+    # Class is a proxy to underlying item
+    class ItemProxy < Delegator
+      extend Forwardable
+      def_delegators :__getobj__, :class, :is_a?, :kind_of?, :instance_of?
+
+      #
+      # Set the proxy item (called by super)
+      #
+      def __setobj__(item)
+        # Convert name to java version for faster lookups
+        @item_name = item.name.to_java
+      end
+
+      #
+      # Lookup item from item registry
+      #
+      def __getobj__
+        $ir.get(@item_name) # rubocop:disable Style/GlobalVars
+      end
+    end
+  end
+end

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

@@ -53,7 +53,11 @@ module OpenHAB
           # sending the command
           def command(command)
             return super unless Thread.current[:ensure_states]
-            return if command == state
+
+            logger.trace do
+              "#{name} ensure #{command}, format_type_pre: #{format_type_pre(command)}, current state: #{state}"
+            end
+            return if state == format_type_pre(command)
 
             super
           end

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

@@ -33,6 +33,13 @@ module OpenHAB
           def ACCEPTED_DATA_TYPES
             [org.openhab.core.types.UnDefType.java_class].freeze
           end
+
+          #
+          # Override to support ItemProxy
+          #
+          def ===(other)
+            other.instance_of?(self)
+          end
         end
         # rubocop:enable Naming/MethodName
 
@@ -128,7 +135,7 @@ module OpenHAB
         # @return [Array<Group>] All groups that this item is part of
         #
         def groups
-          group_names.map { |name| Groups.groups[name] }
+          group_names.map { |name| Groups.groups[name] }.compact
         end
 
         # Return the item's thing if this item is linked with a thing. If an item is linked to more than one thing,

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

@@ -6,11 +6,9 @@ require 'openhab/dsl/types/types'
 require_relative 'item_registry'
 
 require_relative 'generic_item'
-
 require_relative 'switch_item'
 require_relative 'date_time_item'
 require_relative 'dimmer_item'
-
 require_relative 'color_item'
 require_relative 'contact_item'
 require_relative 'group_item'

data/lib/openhab/dsl/states.rb

@@ -48,7 +48,9 @@ module OpenHAB
       # @return [StateStorage] item states
       #
       def store_states(*items)
-        items = items.flatten
+        items = items.flatten.map do |item|
+          item.respond_to?(:__getobj__) ? item.__getobj__ : item
+        end
         states = StateStorage.new(BusEvent.storeStates(*items).to_h)
         if block_given?
           yield

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'java'
+
 module OpenHAB
   module DSL
     # Support for time related functions
@@ -8,40 +10,21 @@ module OpenHAB
       module MonthDayRange
         include OpenHAB::Log
 
-        java_import java.time.Year
-
-        # Lambdas are used to calculate the year for the month day
-        # which must happen during evaluation time to support that rules
-        # creation and evaluation for execution are done in distinct phases
-        @current_year = -> { return Year.now }
-        @next_year = -> { return Year.now.plus_years(1) }
-
-        class << self
-          attr_reader :current_year, :next_year
-        end
-
         # Creates a range that can be compared against MonthDay objects, strings
         # or anything responding to 'to_date' to see if they are within the range
         # @return Range object representing a MonthDay Range
-        # rubocop:disable Metrics/AbcSize
-        # Range method cannot be broken up cleaner
         def self.range(range)
-          logger.trace "Creating MonthDay range from #{range}"
           raise ArgumentError, 'Supplied object must be a range' unless range.is_a? Range
 
           start = MonthDay.parse(range.begin)
           ending = MonthDay.parse(range.end)
 
-          logger.trace "Month Day Range Start(#{start}) - End (#{ending})"
-
-          # Wrap to next year if ending day of month is before starting day of month
-          ending_year = ending < start ? next_year : current_year
+          start_range = DayOfYear.new(month_day: start, range: start..ending)
+          ending_range = DayOfYear.new(month_day: ending, range: start..ending)
+          logger.trace "Month Day Range Start(#{start}) - End (#{ending}) - Created from (#{range})"
 
-          start_range = MonthDayRangeElement.new(month_day: start, year: current_year)
-          ending_range = MonthDayRangeElement.new(month_day: ending, year: ending_year)
           range.exclude_end? ? (start_range...ending_range) : (start_range..ending_range)
         end
-        # rubocop:enable Metrics/AbcSize
 
         # Checks if supplied range can be converted to a month day range
         # @param [Range] range to check begin and end values of
@@ -52,54 +35,80 @@ module OpenHAB
           MonthDay.day_of_month?(range.begin) && MonthDay.day_of_month?(range.end)
         end
 
-        # Represents a range element for a MonthDay object
-        # The LocalDate (MonthDay + Year) is dynamically calculated to allow for
-        # being used as a guard during rule evaluation
-        class MonthDayRangeElement
+        # Converts a MonthDay to a day of year
+        # which is represented as a number from 1 to 732 to support comparisions when the range overlaps a year boundary
+        class DayOfYear
           include Comparable
           include OpenHAB::Log
           java_import java.time.LocalDate
-          java_import java.time.Year
+
+          attr_accessor :month_day
+
+          # Number of days in a leap year
+          DAYS_IN_YEAR = 366
 
           # Create a new MonthDayRange element
           # @param [MonthDay] MonthDay element
-          # @param [Lambda] year lambda to calculate year to convert MonthDay to LocalDate
+          # @param [Range] Underlying MonthDay range
           #
-          def initialize(month_day:, year:)
+          def initialize(month_day:, range:)
             @month_day = month_day
-            @year = year
-          end
-
-          # Convert into a LocalDate using year lambda supplied in initializer
-          def to_local_date
-            @year.call.at_month_day(@month_day)
+            @range = range
           end
 
           # Returns the MonthDay advanced by 1 day
           # Required by Range class
           def succ
-            next_date = to_local_date.plus_days(1)
-            # Handle rollover to next year
-            year = -> { Year.from(next_date) }
-            MonthDayRangeElement.new(month_day: MonthDay.from(next_date), year: year)
+            next_day_of_month = @month_day.day_of_month + 1
+            next_month = @month_day.month_value
+
+            if next_day_of_month > @month_day.month.max_length
+              next_day_of_month = 1
+              next_month = @month_day.month.plus(1).value
+            end
+
+            DayOfYear.new(month_day: MonthDay.of(next_month, next_day_of_month), range: @range)
+          end
+
+          #
+          # Offset by 1 year if the range begin is greater than the range end
+          # and if the month day is less than the begining of the range
+          # @return [Number] 366 if the month_day should be offset by a year
+          def offset
+            @range.begin > @range.end && month_day < @range.begin ? DAYS_IN_YEAR : 0
+          end
+
+          #
+          # Calculate the day within the range for the underlying month day
+          # @return [Number] Representation of the MonthDay as a number from 1 to 732
+          def day_in_range
+            @day_in_range ||= month_day.max_day_of_year + offset
           end
 
           # Compare MonthDayRangeElement to other objects as required by Range class
-          # rubocop:disable Metrics/AbcSize
-          # Case statement needs to work against multiple types
-          def <=>(other)
+          def <=>(other) # rubocop:disable Metrics/AbcSize
             case other
-            when LocalDate then to_local_date.compare_to(other)
-            when Date then self.<=>(LocalDate.of(other.year, other.month, other.day))
-            when MonthDay then self.<=>(MonthDayRange.current_year.call.at_month_day(other))
+            when DayOfYear then day_in_range.<=>(other.day_in_range)
+            when MonthDay then self.<=>(DayOfYear.new(month_day: other, range: @range))
+            when LocalDate then self.<=>(MonthDay.of(other.month_value, other.day_of_month))
+            when Date then self.<=>(MonthDay.of(other.month, other.day))
             else
-              return self.<=>(other.to_local_date) if other.respond_to? :to_local_date
-              return self.<=>(other.to_date) if other.respond_to? :to_date
+              return self.<=>(other.to_local_date) if other.respond_to?(:to_local_date)
+              return self.<=>(other.to_date) if other.respond_to?(:to_date)
 
               raise "Unable to convert #{other.class} to compare to MonthDay"
             end
           end
-          # rubocop:enable Metrics/AbcSize
+        end
+      end
+
+      java_import java.time.Month
+      # Extend Month with helper method
+      class Month
+        # Calcalute and memoize the maximum number of days in a year before this month
+        # @return [Number] maximum nummber of days in a year before this month
+        def max_days_before
+          @max_days_before ||= Month.values.select { |month| month < self }.sum(&:max_length)
         end
       end
 
@@ -108,6 +117,7 @@ module OpenHAB
       class MonthDay
         include OpenHAB::Log
         java_import java.time.format.DateTimeFormatter
+        java_import java.time.Month
 
         #
         # Constructor
@@ -117,11 +127,9 @@ module OpenHAB
         #
         # @return [Object] MonthDay object
         #
-        # rubocop: disable Naming/MethodParameterName
-        def self.new(m:, d:)
+        def self.new(m:, d:) # rubocop:disable Naming/MethodParameterName
           MonthDay.of(m, d)
         end
-        # rubocop: enable Naming/MethodParameterName
 
         # Parse MonthDay string as defined with by Monthday class without leading double dash "--"
         def self.parse(string)
@@ -136,11 +144,23 @@ module OpenHAB
           /^-*[01][0-9]-[0-3]\d$/.match? obj.to_s
         end
 
+        # Get the maximum (supports leap years) day of the year this month day could be
+        def max_day_of_year
+          day_of_month + month.max_days_before
+        end
+
         # Remove -- from MonthDay string representation
         def to_s
           to_string.delete_prefix('--')
         end
 
+        # Checks if MonthDay is between the dates of the supplied range
+        # @param [Range] range to check against MonthDay
+        # @return [true,false] true if the MonthDay falls within supplied range, false otherwise
+        def between?(range)
+          MonthDayRange.range(range).cover? self
+        end
+
         # remove the inherited #== method to use our <=> below
         remove_method :==
 
@@ -151,6 +171,9 @@ module OpenHAB
           case other
           when String
             self.<=>(MonthDay.parse(other))
+          when OpenHAB::DSL::Between::MonthDayRange::DayOfYear
+            # Compare with DayOfYear and invert result
+            -other.<=>(self)
           else
             super
           end

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

@@ -39,7 +39,7 @@ module OpenHAB
 
           if timer.respond_to? :id
             logger.trace("Adding #{timer} with id #{timer.id.inspect} timer ids")
-            @timer_ids[timer.id] = Set.new unless @timer_ids[timer.id]
+            @timer_ids[timer.id] = TimerSet.new unless @timer_ids[timer.id]
             @timer_ids[timer.id] << timer
           end
 
@@ -87,6 +87,19 @@ module OpenHAB
           @timers.clear
         end
       end
+
+      #
+      # Provide additional methods for the timers set
+      #
+      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)
+        #
+        def cancel_all
+          each(&:cancel)
+        end
+      end
     end
   end
 end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.26.3
+  version: 4.28.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-02 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - lib/openhab.rb
 - lib/openhab/core/entity_lookup.rb
+- lib/openhab/core/item_proxy.rb
 - lib/openhab/core/load_path.rb
 - lib/openhab/core/openhab_setup.rb
 - lib/openhab/core/osgi.rb