openhab-scripting 5.4.2 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98baaf8e8f9abf971d25737d726127c8b7396f600e0a34079f8b4c8ae26eef64
-  data.tar.gz: ea340479297eb523bed7ea18ab033c381c3b0479ca6b7b289689c87e90fcab47
+  metadata.gz: 9b21bcd2b958405fb4b4843435e3a6ffa14690af1b6f58139897982a7d55323f
+  data.tar.gz: a1c258192db348813c49b94e21492771d9b2e7d6515e6aff0e04b5bba7786711
 SHA512:
-  metadata.gz: 8059407518f7f621aa0ed19b11f1d3d51c423c6692dcf90e6342b39907f72021325127c28b28008089f507747debaa7ea07876d276c7252e4501f81de911e46e
-  data.tar.gz: 6896b15e4bfc5cada7ce6eda2ae11f551d94fbf1e9911b649059dc59be9f949064d0ade274396a620810b58cdf7c67898423e56410974f8a317bc081e48bd2b4
+  metadata.gz: 81fd4bfaa0f3cb1907622938750dc0eabcc51b0d46d8ad39fd63282ad6118771f79b38a72fc10ffaa19f0037564d1adb710c7da0b981dad37f9cdf9b6f665cfd
+  data.tar.gz: 1b30d461514d2f952e71e3ce7325dd5582fa386ca21723458b725378f6f78880f96bf5693a03aeb64d8a70775830979fe6d8f732c67076abaf9fd687e0ff4948

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

@@ -74,13 +74,20 @@ module OpenHAB
         # All persistence methods that require a timestamp
         # Note the _between methods are automatically created from the _since methods
         PERSISTENCE_METHODS = (QUANTITY_METHODS +
-                              %i[changed_since?
-                                 count_since
-                                 count_state_changes_since
-                                 historic_state
-                                 maximum_since
-                                 minimum_since
-                                 updated_since?]).freeze
+                              %i[ changed_since?
+                                  count_since
+                                  count_state_changes_since
+                                  historic_state
+                                  maximum_since
+                                  minimum_since
+                                  updated_since?])
+
+        # @deprecated OH3.4 - in openHAB 4, just add :get_all_states_since and freeze the list above
+        if Gem::Version.new(OpenHAB::Core::VERSION) >= Gem::Version.new("4.0.0")
+          PERSISTENCE_METHODS << :get_all_states_since
+        end
+        PERSISTENCE_METHODS.freeze
+
         private_constant :QUANTITY_METHODS, :PERSISTENCE_METHODS
 
         # @!method persist(service = nil)
@@ -275,6 +282,21 @@ module OpenHAB
         #   @param [Symbol, String] service An optional persistence id instead of the default persistence service.
         #   @return [Integer] The number of values persisted for this item.
 
+        # @!method all_states_since(timestamp, service = nil)
+        #   @since openHAB 4.0
+        #   Returns all the states from a point in time until now.
+        #   @param [#to_zoned_date_time] timestamp The point in time from which to search
+        #   @param [Symbol, String] service An optional persistence id instead of the default persistence service.
+        #   @return [Array<HistoricState>] An array of {HistoricState} persisted for this item.
+
+        # @!method all_states_between(start, finish, service = nil)
+        #   @since openHAB 4.0
+        #   Returns all the states between two points in time.
+        #   @param [#to_zoned_date_time] start The point in time from which to search
+        #   @param [#to_zoned_date_time] finish The point in time to which to search
+        #   @param [Symbol, String] service An optional persistence id instead of the default persistence service.
+        #   @return [Array<HistoricState>] An array of {HistoricState} persisted for this item.
+
         %i[persist last_update].each do |method|
           define_method(method) do |service = nil|
             service ||= persistence_service
@@ -363,6 +385,11 @@ module OpenHAB
 
         alias_method :state_changes_since, :count_state_changes_since
         alias_method :state_changes_between, :count_state_changes_between
+        # @deprecated OH 3.4 - if guard is unnecessary in OH4
+        if Gem::Version.new(OpenHAB::Core::VERSION) >= Gem::Version.new("4.0.0")
+          alias_method :all_states_since, :get_all_states_since
+          alias_method :all_states_between, :get_all_states_between
+        end
 
         private
 
@@ -391,15 +418,21 @@ module OpenHAB
         # @return [HistoricState] a {HistoricState} object if the result was a HistoricItem
         # @return [QuantityType] a `QuantityType` object if the result was an average, delta, deviation,
         #                        sum, or variance.
+        # @return [Array<HistoricState>] an array of {HistoricState} objects if the result was an array
+        #                        of HistoricItem
         # @return [Object] the original result object otherwise.
         #
         def wrap_result(result, method)
-          if result.is_a?(org.openhab.core.persistence.HistoricItem)
-            return HistoricState.new(quantify(result.state), result)
-          end
-          return quantify(result) if QUANTITY_METHODS.include?(method)
+          case result
+          when org.openhab.core.persistence.HistoricItem
+            HistoricState.new(quantify(result.state), result)
+          when java.util.Collection, Array
+            result.to_a.map { |historic_item| wrap_result(historic_item, method) }
+          else
+            return quantify(result) if QUANTITY_METHODS.include?(method)
 
-          result
+            result
+          end
         end
 
         #

data/lib/openhab/dsl/rules/triggers/conditions/duration.rb

@@ -81,7 +81,8 @@ module OpenHAB
             def process_active_timer(timer, inputs, mod, &block)
               old_state = Conditions.old_state_from(inputs)
               new_state = Conditions.new_state_from(inputs)
-              if new_state != @tracking_from && @conditions.process(mod: nil, inputs: { "state" => new_state })
+              if @conditions.from? && new_state != @tracking_from &&
+                 @conditions.process(mod: nil, inputs: { "state" => new_state })
                 logger.trace("Item changed from #{old_state} to #{new_state} for #{self}, keep waiting.")
               else
                 logger.trace("Item changed from #{old_state} to #{new_state} for #{self}, canceling timer.")

data/lib/openhab/dsl/rules/triggers/conditions/generic.rb

@@ -41,6 +41,13 @@ module OpenHAB
               true
             end
 
+            #
+            # Returns true if a `from` condition was specified
+            #
+            def from?
+              !@from.nil?
+            end
+
             private
 
             def check_value(value, expected_value)

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/log.rb

@@ -296,8 +296,8 @@ module OpenHAB
       return error if debug?
 
       if error.respond_to? :backtrace_locations
-        backtrace = error.backtrace_locations.map(&:to_s).grep_v(INTERNAL_CALL_REGEX)
-        error.set_backtrace(backtrace)
+        backtrace = error.backtrace_locations&.map(&:to_s)&.grep_v(INTERNAL_CALL_REGEX)
+        error.set_backtrace(backtrace) if backtrace
       elsif error.respond_to? :stack_trace
         backtrace = error.stack_trace.reject { |line| JAVA_INTERNAL_CALL_REGEX.match? line.to_s }
         error.set_stack_trace(backtrace)

data/lib/openhab/rspec/helpers.rb

@@ -229,8 +229,17 @@ module OpenHAB
         bundle = org.osgi.framework.FrameworkUtil.get_bundle(org.openhab.core.persistence.PersistenceService.java_class)
         bundle.bundle_context.register_service(org.openhab.core.persistence.PersistenceService.java_class, ps, nil)
 
-        # wait for the rule engine
         rs = OSGi.service("org.openhab.core.service.ReadyService")
+
+        # Add a fake automation:scriptEngineFactories to satisfy startlevel 30
+        begin
+          sef_marker = org.openhab.core.automation.module.script.internal.ScriptEngineFactoryBundleTracker::READY_MARKER
+          rs.mark_ready(sef_marker)
+        rescue NameError
+          # @deprecated OH3.4 NOOP - the ScriptEngineFactoryBundleTracker doesn't exist in OH3
+        end
+
+        # wait for the rule engine
         filter = org.openhab.core.service.ReadyMarkerFilter.new
                     .with_type(org.openhab.core.service.StartLevelService::STARTLEVEL_MARKER_TYPE)
                     .with_identifier(org.openhab.core.service.StartLevelService::STARTLEVEL_RULEENGINE.to_s)

data/lib/openhab/rspec.rb

@@ -16,7 +16,7 @@ require_relative "rspec/helpers"
 require_relative "rspec/karaf"
 require_relative "rspec/hooks"
 
-return unless defined?(RSpec)
+require "rspec/core"
 
 RSpec.configure do |c|
   c.add_setting :openhab_automation_search_paths, default: [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.4.2
+  version: 5.5.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-23 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler