openhab-scripting 5.49.0 → 5.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cd17ad8e229eaed4db0be72e682f771612f10c59a1fed7612dae537eb5df073
-  data.tar.gz: a10d086518f1069b0f283f3ba680572f55ce4e5ef372397dde455259330b27ae
+  metadata.gz: b70d205b061cb7bea4228face2481a0ccdb11a9947c8b4194b972db0a15c6935
+  data.tar.gz: 60ac7bf7347d4027766fc0285e61bcb849203196e2d625e8181da4e04e96c220
 SHA512:
-  metadata.gz: ffd401dad6cd239b69f6c28c394d87fbfc9bbe557f3f080520ff579034170dfaabd84f9fc883d53a1b4c2a97bdffa767964a1526010764c7b28bac427cbc3d0a
-  data.tar.gz: d8e684891946c9b0fa67ff1b29f0a4ceabc1d1173611ff904993cf39589bc89aad7b882d647bf1eda1045d7f37210d5dc56ea04023bbc4d7638cf2f016f4c1e5
+  metadata.gz: 13014e726aa0efe66e5e1034f31f0a5c6688c7e19373cd314dfc93145137ce9232b8fa710c889b69dc2f07f18b109649f73fb20e720bde56e5bee8b10168601e
+  data.tar.gz: 264e3d3d6b351e466b9317728fabf1f086addbd6318ab1a349d57b711a7d26559cf85d8619d8b41cd31969edf7af8dda844ffad128f6edce6cb00538fba8cf15

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

@@ -168,7 +168,7 @@ module OpenHAB
 
           proxied_self = Proxy.new(self)
 
-          return yield(proxied_self) if instance_variable_defined?(:@modifying) && @modifying
+          return yield(proxied_self) if proxied_self.instance_variable_get(:@modifying)
 
           begin
             provider = self.provider
@@ -178,15 +178,15 @@ module OpenHAB
               provider = nil
               logger.debug { "Forcing modifications to non-managed item #{name}" }
             end
-            @modified = false
-            @modifying = true
+            proxied_self.instance_variable_set(:@modified, false)
+            proxied_self.instance_variable_set(:@modifying, true)
 
             r = yield(proxied_self)
 
-            provider&.update(self) if @modified
+            provider&.update(self) if proxied_self.instance_variable_get(:@modified)
             r
           ensure
-            @modifying = false
+            proxied_self.instance_variable_set(:@modifying, false)
           end
         end
 
@@ -197,7 +197,9 @@ module OpenHAB
           modify do
             next if label == value
 
-            @modified = true
+            proxied_self = Proxy.new(self)
+
+            proxied_self.instance_variable_set(:@modified, true)
             set_label(value)
           end
         end
@@ -210,7 +212,9 @@ module OpenHAB
             value = value&.to_s
             next if category == value
 
-            @modified = true
+            proxied_self = Proxy.new(self)
+
+            proxied_self.instance_variable_set(:@modified, true)
             set_category(value)
           end
         end
@@ -234,7 +238,9 @@ module OpenHAB
             values = DSL::Items::Tags.normalize(*values)
             next if values.to_set == tags.to_set
 
-            @modified = true
+            proxied_self = Proxy.new(self)
+
+            proxied_self.instance_variable_set(:@modified, true)
             remove_all_tags
             add_tags(values)
           end

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

@@ -582,12 +582,9 @@ module OpenHAB
         # @return [String]
         def inspect
           s = "#<OpenHAB::Core::Items::#{type}Item#{type_details} #{name} #{label.inspect} state=#{raw_state.inspect}"
-          # @deprecated OH 4.3 Remove if guard when dropping support for OH 4.3
-          if respond_to?(:last_state)
-            s += " last_state=#{last_state.inspect}" if last_state
-            s += " last_state_update=#{last_state_update}" if last_state_update
-            s += " last_state_change=#{last_state_change}" if last_state_change
-          end
+          s += " last_state=#{last_state.inspect}" if last_state
+          s += " last_state_update=#{last_state_update}" if last_state_update
+          s += " last_state_change=#{last_state_change}" if last_state_change
           s += " category=#{category.inspect}" if category
           s += " tags=#{tags.to_a.inspect}" unless tags.empty?
           s += " groups=#{group_names}" unless group_names.empty?

data/lib/openhab/core/rules/tagged_array.rb

@@ -23,7 +23,7 @@ module OpenHAB
         #
         def [](uid)
           rule = $rules.get(uid)
-          rule.tagged?(@tag) ? rule : nil
+          rule if rule&.tagged?(@tag)
         end
         alias_method :include?, :[]
         alias_method :key?, :[]

data/lib/openhab/core_ext/between.rb

@@ -16,6 +16,8 @@ module OpenHAB
       #   @param [Range] range A range to check
       #   @return [true,false]
       #
+      # @see TimePredicates#within? to check if a time is within a certain distance of another time
+      #
       def between?(min, max = nil)
         range = if max
                   Range.new(min, max, false)

data/lib/openhab/core_ext/java/instant.rb

@@ -13,6 +13,7 @@ module OpenHAB
       class Instant < java.lang.Object
         extend Forwardable
         include Time
+        include TimePredicates
         include Between
 
         class << self # rubocop:disable Lint/EmptyClass

data/lib/openhab/core_ext/java/local_date.rb

@@ -10,6 +10,7 @@ module OpenHAB
       # Extensions to {java.time.LocalDate}
       class LocalDate
         include Time
+        include TimePredicates
         include Between
         include Ephemeris
 

data/lib/openhab/core_ext/java/local_time.rb

@@ -35,6 +35,7 @@ module OpenHAB
       #   end
       #
       class LocalTime
+        include TimePredicates
         include Between
 
         # @!parse include Time

data/lib/openhab/core_ext/java/month.rb

@@ -9,6 +9,7 @@ module OpenHAB
 
       # Extensions to {java.time.Month}
       class Month
+        include TimePredicates
         include Between
 
         # @!parse include Time

data/lib/openhab/core_ext/java/month_day.rb

@@ -9,6 +9,7 @@ module OpenHAB
 
       # Extensions to {java.time.MonthDay}
       class MonthDay
+        include TimePredicates
         include Between
         include Ephemeris
 

data/lib/openhab/core_ext/java/time.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../time_predicates"
+
 module OpenHAB
   module CoreExt
     module Java
@@ -24,6 +26,7 @@ module OpenHAB
 
         # @!visibility private
         def self.included(klass)
+          klass.prepend(OpenHAB::CoreExt::TimePredicates)
           klass.singleton_class.prepend(ClassMethods)
           klass.remove_method(:==)
           klass.alias_method(:inspect, :to_s)

data/lib/openhab/core_ext/java/zoned_date_time.rb

@@ -13,6 +13,7 @@ module OpenHAB
       class ZonedDateTime
         extend Forwardable
         include Time
+        include TimePredicates
         include Between
 
         class << self # rubocop:disable Lint/EmptyClass

data/lib/openhab/core_ext/ruby/date.rb

@@ -3,11 +3,14 @@
 require "forwardable"
 require "date"
 
+require_relative "../time_predicates"
+
 # Extensions to Date
 class Date
   extend Forwardable
   include OpenHAB::CoreExt::Between
   include OpenHAB::CoreExt::Ephemeris
+  include OpenHAB::CoreExt::TimePredicates
 
   #
   # Extends {#+} to allow adding a {java.time.temporal.TemporalAmount TemporalAmount}

data/lib/openhab/core_ext/ruby/date_time.rb

@@ -3,6 +3,8 @@
 require "date"
 require "forwardable"
 
+require_relative "../time_predicates"
+
 # DateTime inherits from Date, but is more similar to Time semantically.
 # So it avoid alias_method chain bombs, and to ensure the correct end methods
 # exist here, we define the important methods from Time here as well.
@@ -12,6 +14,7 @@ class DateTime < Date
   extend Forwardable
   include OpenHAB::CoreExt::Between
   include OpenHAB::CoreExt::Ephemeris
+  include OpenHAB::CoreExt::TimePredicates
 
   # (see Time#plus_with_temporal)
   def plus_with_temporal(other)

data/lib/openhab/core_ext/ruby/time.rb

@@ -2,11 +2,14 @@
 
 require "forwardable"
 
+require_relative "../time_predicates"
+
 # Extensions to Time
 class Time
   extend Forwardable
   include OpenHAB::CoreExt::Between
   include OpenHAB::CoreExt::Ephemeris
+  include OpenHAB::CoreExt::TimePredicates
 
   #
   # @!method +(other)

data/lib/openhab/core_ext/time_predicates.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module CoreExt
+    # Predicate helpers for date/time-like objects.
+    module TimePredicates
+      #
+      # Checks whether the object is within a maximum allowable distance (epsilon)
+      # of a specific anchor time.
+      #
+      # @example Check if a timestamp is within 5 minutes of right now
+      #   event_time.within?(5.minutes)
+      #
+      # @example Check if a timestamp is within 30 seconds of an explicit execution deadline
+      #   log_time.within?(30.seconds, of: deadline)
+      #
+      # @param [java.time.temporal.TemporalAmount, Numeric] epsilon the maximum allowable time difference/distance
+      # @param [ZonedDateTime, Time] of the anchor time to compare against (defaults to now)
+      # @return [true, false] true if the absolute difference between self and the anchor is less than epsilon
+      #
+      def within?(epsilon, of: ZonedDateTime.now)
+        # Convert times to a common float representation (like epoch seconds) to do the math
+        # Or use native Java duration differences if keeping it in the Java ecosystem
+        (of - self).to_f.abs < epsilon.to_f
+      end
+    end
+  end
+end

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.49.0"
+    VERSION = "5.50.0"
   end
 end

data/lib/openhab/dsl.rb

@@ -737,8 +737,8 @@ module OpenHAB
     # @example
     #   persistence(:influxdb) do
     #     Item1.persist
-    #     Item1.changed_since(1.hour)
-    #     Item1.average_since(12.hours)
+    #     Item1.changed_since?(1.hour.ago)
+    #     Item1.average_since(12.hours.ago)
     #   end
     #
     # @param [Object] service Persistence service either as a String or a Symbol

data/lib/openhab/rspec/helpers.rb

@@ -417,10 +417,23 @@ module OpenHAB
       #   end
       #
       def spec_log_lines
-        File.open(log_file, "rb") do |f|
-          f.seek(@log_index) if @log_index
-          f.read.split("\n")
+        lines = []
+
+        # Give the underlying Log4j file channel up to ~50ms to flush its buffer to disk
+        5.times do
+          lines = File.open(log_file, "rb") do |f|
+            f.seek(@log_index) if @log_index
+            f.read.split("\n")
+          end
+
+          # If we read lines, break early. If it's still empty, yield execution to the
+          # JVM thread scheduler so the file appender thread can finish flushing.
+          break unless lines.empty?
+
+          sleep 0.01
         end
+
+        lines
       end
 
       private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.49.0
+  version: 5.50.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -255,6 +255,7 @@ files:
 - lib/openhab/core_ext/ruby/range.rb
 - lib/openhab/core_ext/ruby/symbol.rb
 - lib/openhab/core_ext/ruby/time.rb
+- lib/openhab/core_ext/time_predicates.rb
 - lib/openhab/dsl.rb
 - lib/openhab/dsl/config_description/builder.rb
 - lib/openhab/dsl/debouncer.rb
@@ -360,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.15
+rubygems_version: 4.0.16
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting
 test_files: []