openhab-scripting 2.14.3 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7d7048855cb4074024e55eb6bc763859c7c41220108dc2115cde683b7d84eb2
-  data.tar.gz: a9fdcb6e2605eab24f8c0dd74a1a307bd50c12e3b1dc0c499ae5d8627a8c4eb1
+  metadata.gz: e06a1b4a2697fe4ac5d03467fb324ce1cf4d6e674946a7d96dae8928974b2460
+  data.tar.gz: 522268dcd796de02ee8dde9417d5a044dab87ef8a8d8100957268fc544443d3b
 SHA512:
-  metadata.gz: c513245aa07d4a4cd21490c3761e2a3ea93f108ff9751ab7f679e79e30941ebe411e7cc3eac9312f51913988122dcaea2f228dbc15d3caa71e5aea6ffe1f7d2e
-  data.tar.gz: b54ef2191000331f5cfc671e5b3ec0183661ea3c56a80d55d269873e18bb5e340225bb1994db5748d462c49d5ba876aa8d8be60ec61e4b9b49868ff31ad9a5cb
+  metadata.gz: 51ea02b7ccc10fc831a17627e31f0b0d7e250e778a08c8e7d226118c61cb98a07761eabee1299e9c6a4a83e949b448c20f1c7ebb7e5877939b601f1108929cec
+  data.tar.gz: 1ea8435d4826e815c212e422e714ac0480266b2ebc283c4471116cf08f45b3336758c75a1b74d00d631f1c7b729e078620dd72d4e9b853465eee06010e2ea027

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.14.3
+  version: 2.15.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -54,6 +54,7 @@ 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
@@ -63,6 +64,7 @@ files:
 - 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/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