openhab-jrubyscripting 5.0.0.rc11 → 5.0.0.rc12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc3911eb787dc73ea31109aa6d4d8c3896a1019b381a70030f152c668f0b8f2e
-  data.tar.gz: ebd2d7005e9f17827a4bf58d38b7fc2476a497cb428aab0270290c3c98461b80
+  metadata.gz: 38b109c413cbb8b06c2c43e57ad12e6278139b1cf56d887289ada297c8991272
+  data.tar.gz: 24e6235ce553d4e2ec9447c94407054b9c1c075c6a190a3ce5ed5ebb2421753c
 SHA512:
-  metadata.gz: df4c1df793cd44700467728c63df6ba9d12ecf7111fc7daf2b9a8f4953c68575082f9f4b87f70a42bfedcc9af70d4537e45b6fb2d8b78ac8e7e3f7cca22aaf4b
-  data.tar.gz: de1c8f5847bbbeb3eed3268ceedc2a61213b4f6ab269372a08bd4d8217f6b384a2c62b5ceb1f9de2777d264d0d6eb4e02fde6f245fa4fcc0dc03d068041a11bb
+  metadata.gz: a3e0f9f2f58d906ff72f5923817a2b5651a96f4710bbd29ad6ecffc3991722db5f8b1702de90e05ef1854ffe49c3d4214a699f271aaf0ac26a2dd03ad20c71f5
+  data.tar.gz: a51e80b23b82e7c38db1ac8d263b0a2776a70ad7fe9f401b1ae035f26a06d3660534e4c64c4d1c88a06fb9ee47ef64422b02bdfd26446e8edb148461c1403eca

data/lib/openhab/core/actions/exec.rb

@@ -4,47 +4,47 @@ module OpenHAB
   module Core
     module Actions
       # @see https://www.openhab.org/docs/configuration/actions.html#exec-actions Exec Actions
-      class Exec
-        class << self # rubocop:disable Lint/EmptyClass
-          # @!method execute_command_line
-          #
-          # @return [void]
-          #
-          # @overload execute_command_line(command_line)
-          #
-          #   Executes a command on the command line without waiting for the
-          #   command to complete.
-          #
-          #   @param [String] command_line
-          #   @return [void]
-          #
-          #   @example Execute an external command
-          #     rule 'Run a command' do
-          #       every :day
-          #       run do
-          #         Exec.execute_command_line('/bin/true')
-          #       end
-          #     end
-          #
-          # @overload execute_command_line(timeout, command_line)
-          #
-          #   Executes a command on the command and waits timeout seconds for
-          #   the command to complete, returning the output from the command
-          #   as a String.
-          #
-          #   @param [Duration] timeout
-          #   @param [String] command_line
-          #   @return [String]
-          #
-          #   @example Execute an external command and process its results
-          #     rule 'Run a command' do
-          #       every :day
-          #       run do
-          #         TodaysHoliday_String.update(Exec.execute_command_line(5.seconds, '/home/cody/determine_holiday.rb')
-          #       end
-          #     end
-          #
-        end
+      class Exec # rubocop:disable Lint/EmptyClass
+        # @!scope class
+
+        # @!method execute_command_line
+        #
+        # @return [void]
+        #
+        # @overload execute_command_line(command_line)
+        #
+        #   Executes a command on the command line without waiting for the
+        #   command to complete.
+        #
+        #   @param [String] command_line
+        #   @return [void]
+        #
+        #   @example Execute an external command
+        #     rule 'Run a command' do
+        #       every :day
+        #       run do
+        #         Exec.execute_command_line('/bin/true')
+        #       end
+        #     end
+        #
+        # @overload execute_command_line(timeout, command_line)
+        #
+        #   Executes a command on the command and waits timeout seconds for
+        #   the command to complete, returning the output from the command
+        #   as a String.
+        #
+        #   @param [Duration] timeout
+        #   @param [String] command_line
+        #   @return [String]
+        #
+        #   @example Execute an external command and process its results
+        #     rule 'Run a command' do
+        #       every :day
+        #       run do
+        #         TodaysHoliday_String.update(Exec.execute_command_line(5.seconds, '/home/cody/determine_holiday.rb')
+        #       end
+        #     end
+        #
       end
     end
   end

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

@@ -45,9 +45,10 @@ module OpenHAB
         # Time types need formatted as ISO8601
         # @!visibility private
         def format_type(command)
-          return Types::DateTimeType.new(command) if command.is_a?(java.time.ZonedDateTime)
+          return command if command.is_a?(Types::DateTimeType)
+          return Types::DateTimeType.new(command.to_zoned_date_time) if command.respond_to?(:to_zoned_date_time)
+          return Types::DateTimeType.new(DSL.try_parse_time_like(command.to_str)) if command.respond_to?(:to_str)
 
-          command = command.iso8601 if command.respond_to?(:iso8601)
           super
         end
       end

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

@@ -163,9 +163,99 @@ module OpenHAB
           # make sure to use Type, because this method is used for both
           # #update and #command
           return type if type.is_a?(Types::Type)
+          return NULL if type.nil?
 
           type.to_s
         end
+
+        #
+        # Defers notifying openHAB of modifications to multiple attributes until the block is complete.
+        #
+        # @param [true, false] force When true, allow modifications to file-based items.
+        #   Normally a FrozenError is raised when attempting to modify file-based items, since
+        #   they will then be out-of-sync with the definition on disk. Advanced users may do this
+        #   knowingly and intentionally though, so an escape hatch is provided to allow runtime
+        #   modifications.
+        # @yield
+        # @return [Object] the block's return value
+        #
+        # @example Modify label and tags for an item
+        #   MySwitch.modify do
+        #     MySwitch.label = "New Label"
+        #     MySwitch.tags = :labeled
+        #   end
+        #
+        def modify(force: false)
+          raise ArgumentError, "you must pass a block to modify" unless block_given?
+          return yield if instance_variable_defined?(:@modifying) && @modifying
+
+          begin
+            provider = self.provider
+            if provider && !provider.is_a?(org.openhab.core.common.registry.ManagedProvider)
+              raise FrozenError, "Cannot modify item #{name} from provider #{provider.inspect}." unless force
+
+              provider = nil
+              logger.debug("Forcing modifications to non-managed item #{name}")
+            end
+            @modified = false
+            @modifying = true
+
+            r = yield
+
+            provider&.update(self) if @modified
+            r
+          ensure
+            @modifying = false
+          end
+        end
+
+        # @!attribute [rw] label
+        # The item's descriptive label.
+        # @return [String]
+        def label=(value)
+          modify do
+            next if label == value
+
+            @modified = true
+            set_label(value)
+          end
+        end
+
+        # @!attribute [rw] category
+        # The item's category.
+        # @return [String]
+        def category=(value)
+          modify do
+            value = value&.to_s
+            next if category == value
+
+            @modified = true
+            set_category(value)
+          end
+        end
+
+        # @!attribute [rw] tags
+        #   The item's tags
+        #   @return [Array<String>]
+        #   @overload tags
+        #     Returns the item's tags.
+        #     @return [Array<String>]
+        #   @overload tags=(values)
+        #     Sets the item's tags.
+        #
+        #     To remove all tags, assign an empty array or nil.
+        #     @param [Array<String,Symbol,Semantics::Tag>] values Tags to set.
+        #     @return [void]
+        def tags=(values)
+          modify do
+            values = DSL::Items::ItemBuilder.normalize_tags(*values)
+            next if values.to_set == tags.to_set
+
+            @modified = true
+            remove_all_tags
+            add_tags(values)
+          end
+        end
       end
     end
   end

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

@@ -24,10 +24,6 @@ module OpenHAB
         #   The item's name.
         #   @return [String]
 
-        # @!attribute [r] label
-        #   The item's descriptive label.
-        #   @return [String, nil]
-
         # @!attribute [r] accepted_command_types
         #   @return [Array<Class>] An array of {Command}s that can be sent as commands to this item
 
@@ -35,7 +31,7 @@ module OpenHAB
         #   @return [Array<Class>] An array of {State}s that can be sent as commands to this item
 
         #
-        # The item's {#label} if one is defined, otherwise it's {#name}.
+        # The item's {GenericItem#label label} if one is defined, otherwise its {#name}.
         #
         # @return [String]
         #
@@ -46,7 +42,7 @@ module OpenHAB
         #
         # @!attribute [r] groups
         #
-        # Return all groups that this item is part of
+        # Returns all groups that this item is part of
         #
         # @return [Array<Group>] All groups that this item is part of
         #
@@ -81,7 +77,7 @@ module OpenHAB
         # @example Access namespace1's configuration
         #   Item1.metadata["namespace1"]["config1"]
         #
-        # @example Safely search for the specified value - no errors are raised, only nil returned if a key in the chain doesn"t exist
+        # @example Safely search for the specified value - no errors are raised, only nil returned if a key in the chain doesn't exist
         #   Item1.metadata.dig("namespace1", "config1") # => "foo"
         #   Item1.metadata.dig("namespace2", "config1") # => nil
         #
@@ -189,7 +185,7 @@ module OpenHAB
         #
         # @return [Array<Thing>] An array of things or an empty array
         def things
-          registry = OSGi.service("org.openhab.core.thing.link.ItemChannelLinkRegistry")
+          registry = Things::Links::Provider.registry
           channels = registry.get_bound_channels(name).to_a
           channels.map(&:thing_uid).uniq.map { |tuid| EntityLookup.lookup_thing(tuid) }.compact
         end
@@ -206,6 +202,11 @@ module OpenHAB
           "#{s}>"
         end
 
+        # @return [org.openhab.core.common.registry.Provider]
+        def provider
+          Provider.registry.provider_for(self)
+        end
+
         private
 
         # Allows sub-classes to append additional details to the type in an inspect string

data/lib/openhab/core/items/metadata/hash.rb

@@ -384,7 +384,7 @@ module OpenHAB
           alias_method :to_s, :inspect
 
           #
-          # @raise [RuntimeError] if the provider is not a
+          # @raise [FrozenError] if the provider is not a
           #   {org.openhab.core.common.registry.ManagedProvider ManagedProvider} that can be updated.
           # @return [org.openhab.core.common.registry.ManagedProvider]
           #

data/lib/openhab/core/items/metadata/namespace_hash.rb

@@ -218,8 +218,12 @@ module OpenHAB
             return @hash.each_key(&block) unless attached?
             return to_enum(:each_key) unless block
 
-            Provider.registry.all.each do |meta|
-              yield meta.uid.namespace if meta.uid.item_name == @item_name
+            if Provider.registry.respond_to?(:get_all_namespaces)
+              keys.each(&block)
+            else
+              Provider.registry.all.each do |meta|
+                yield meta.uid.namespace if meta.uid.item_name == @item_name
+              end
             end
             self
           end
@@ -313,6 +317,10 @@ module OpenHAB
 
           # @!visibility private
           def keys
+            if Provider.registry.respond_to?(:get_all_namespaces)
+              return Provider.registry.get_all_namespaces(@item_name).to_a
+            end
+
             each_key.to_a
           end
 

data/lib/openhab/core/items/metadata/provider.rb

@@ -32,8 +32,8 @@ module OpenHAB
           # @return [void]
           #
           def remove_item_metadata(item_name)
-            @elements.delete_if do |k, v|
-              next unless k.item_name == item_name
+            @elements.delete_if do |_k, v|
+              next unless v.uid.item_name == item_name
 
               notify_listeners_about_removed_element(v)
               true

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

@@ -77,7 +77,6 @@ module OpenHAB
                               %i[changed_since?
                                  count_since
                                  count_state_changes_since
-                                 evolution_rate
                                  historic_state
                                  maximum_since
                                  minimum_since
@@ -183,11 +182,22 @@ module OpenHAB
         #   @return [true,false] True if the item's state changed between `start` and `finish`, False otherwise.
 
         # @!method evolution_rate(timestamp, service = nil)
-        #   Returns the evolution rate of the item's state since the given time
-        #   @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.
+        #   Returns the evolution rate of the item's state
         #   @return [DecimalType, QuantityType, nil] The evolution rate since `timestamp`,
         #     or nil if no previous state could be found.
+        #   @overload evolution_rate(timestamp, service = nil)
+        #     Returns the evolution rate of the item's state since the given time
+        #     @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 [DecimalType, QuantityType, nil] The evolution rate since `timestamp`,
+        #       or nil if no previous state could be found.
+        #   @overload evolution_rate(start, finish, service = nil)
+        #     Returns the evolution rate of the item's state 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 [DecimalType, QuantityType, nil] The evolution rate between `start` and `finish`,
+        #       or nil if no previous state could be found.
 
         # @!method historic_state(timestamp, service = nil)
         #   Returns the the item's state at the given time
@@ -317,6 +327,40 @@ module OpenHAB
           end
         end
 
+        # evolution_rate's "between" method is overloaded with the same name
+        method = :evolution_rate
+        define_method(method) do |start, finish_or_service = nil, service = nil|
+          if service.nil?
+            if finish_or_service.respond_to?(:to_zoned_date_time)
+              service = persistence_service
+              finish = finish_or_service
+            else
+              service = finish_or_service || persistence_service
+              finish = nil
+            end
+          else
+            finish = finish_or_service
+          end
+
+          result = if finish
+                     Actions::PersistenceExtensions.public_send(
+                       method,
+                       self,
+                       start.to_zoned_date_time,
+                       finish.to_zoned_date_time,
+                       service&.to_s
+                     )
+                   else
+                     Actions::PersistenceExtensions.public_send(
+                       method,
+                       self,
+                       start.to_zoned_date_time,
+                       service&.to_s
+                     )
+                   end
+          wrap_result(result, method)
+        end
+
         alias_method :state_changes_since, :count_state_changes_since
         alias_method :state_changes_between, :count_state_changes_between
 

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

@@ -59,16 +59,25 @@ module OpenHAB
         #
         # The item must be a managed item (typically created by Ruby or in the UI).
         #
+        # Any associated metadata or channel links are also removed.
+        #
         # @param [String, Item] item_name
         # @param recursive [true, false] Remove the item's members if it's a group
         # @return [Item, nil] The removed item, if found.
         def remove(item_name, recursive: false)
           item_name = item_name.name if item_name.is_a?(Item)
           provider = Provider.registry.provider_for(item_name)
-          unless provider.is_a?(org.openhab.core.common.registry.ManagedProvider)
+          unless provider.is_a?(ManagedProvider)
             raise "Cannot remove item #{item_name} from non-managed provider #{provider.inspect}"
           end
 
+          Metadata::Provider.registry.providers.grep(ManagedProvider).each do |managed_provider|
+            managed_provider.remove_item_metadata(item_name)
+          end
+
+          Things::Links::Provider.registry.providers.grep(ManagedProvider).each do |managed_provider|
+            managed_provider.remove_links_for_item(item_name)
+          end
           provider.remove(item_name, recursive)
         end
       end

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

@@ -12,13 +12,13 @@ module OpenHAB
         #
         # Create a StateStorage object that stores the states of the given items
         #
-        # @param [Array<Item>] items A list of items
+        # @param [Item] items A list of items
         #
         # @return [StateStorage] A state storage object
         #
         # @!visibility private
         def self.from_items(*items)
-          StateStorage.new($events.store_states(*items).to_h)
+          StateStorage.new($events.store_states(*items.map(&:to_java)).to_h)
         end
 
         #

data/lib/openhab/core/proxy.rb

@@ -120,6 +120,11 @@ module OpenHAB
         # define a sub-class of EventSubscriber as a child class of the including class
         klass.const_set(:EventSubscriber, Class.new(EventSubscriber))
       end
+
+      # @!visibility private
+      def to_java
+        __getobj__
+      end
     end
   end
 end

data/lib/openhab/core/registry.rb

@@ -4,7 +4,7 @@ module OpenHAB
   module Core
     Registry = org.openhab.core.common.registry.AbstractRegistry
 
-    Registry.field_reader :elementToProvider, :elementReadLock, :identifierToElement
+    Registry.field_reader :elementToProvider, :elementReadLock, :identifierToElement, :providerToElements
 
     # @abstract
     #
@@ -19,12 +19,22 @@ module OpenHAB
       #
       def provider_for(key)
         elementReadLock.lock
-        return nil unless (element = identifierToElement[key])
+        if key.is_a?(org.openhab.core.common.registry.Identifiable)
+          element = key
+        else
+          return nil unless (element = identifierToElement[key])
+        end
 
         elementToProvider[element]
       ensure
         elementReadLock.unlock
       end
+
+      # @!attribute [r] providers
+      # @return [Enumerable<org.openhab.core.common.registry.Provider>]
+      def providers
+        providerToElements.keys
+      end
     end
   end
 end

data/lib/openhab/core/rules.rb

@@ -13,7 +13,7 @@ module OpenHAB
 
       class << self
         #
-        # @!attribute [r] rule_manager
+        # @!attribute [r] manager
         # @return [org.openhab.core.automation.RuleManager] The openHAB rule manager/engine
         #
         def manager

data/lib/openhab/core/things/links/provider.rb

@@ -33,6 +33,44 @@ module OpenHAB
               current.add(link)
             end
           end
+
+          #
+          # Removes all links to a given item.
+          #
+          # @param [String] item_name
+          # @return [Integer] how many links were removed
+          #
+          def remove_links_for_item(item_name)
+            count = 0
+            @elements.delete_if do |_k, v|
+              next unless v.item_name == item_name
+
+              count += 1
+              notify_listeners_about_removed_element(v)
+              true
+            end
+            count
+          end
+          alias_method :removeLinksForItem, :remove_links_for_item
+
+          #
+          # Removes all links to a given thing.
+          #
+          # @param [ThingUID] thing_uid
+          # @return [Integer] how many links were removed
+          #
+          def remove_links_for_thing(thing_uid)
+            count = 0
+            @elements.delete_if do |_k, v|
+              next unless v.linked_uid.thing_uid == thing_uid
+
+              count += 1
+              notify_listeners_about_removed_element(v)
+              true
+            end
+            count
+          end
+          alias_method :removeLinksForThing, :remove_links_for_thing
         end
       end
     end

data/lib/openhab/core/things/registry.rb

@@ -61,6 +61,10 @@ module OpenHAB
             raise "Cannot remove thing #{thing_uid} from non-managed provider #{provider.inspect}"
           end
 
+          Links::Provider.registry.providers.grep(ManagedProvider).each do |managed_provider|
+            managed_provider.remove_links_for_thing(thing_uid)
+          end
+
           provider.remove(thing_uid)
         end
       end

data/lib/openhab/core/timer.rb

@@ -28,7 +28,7 @@ module OpenHAB
       #   @return [true,false]
 
       def_delegator :@timer, :has_terminated, :terminated?
-      def_delegators :@timer, :active?, :cancelled?, :running?
+      def_delegators :@timer, :active?, :cancelled?, :running?, :execution_time
 
       # @return [Object, nil]
       attr_accessor :id
@@ -49,19 +49,7 @@ module OpenHAB
         @id = id
         @thread_locals = thread_locals
         @block = block
-        @timer = if defined?(ScriptExecution)
-                   ScriptExecution.create_timer(1.minute.from_now) { execute }
-                 else # DEPRECATED: openHAB 3.4.0
-                   org.openhab.core.model.script.actions.ScriptExecution.create_timer(
-                     # create it far enough in the future so it won't execute until we finish setting it up
-                     1.minute.from_now,
-                     # when running in rspec, it may have troubles finding this class
-                     # for auto-conversion of block to interface, so use .impl
-                     org.eclipse.xtext.xbase.lib.Procedures::Procedure0.impl { execute }
-                   )
-                 end
-        # DEPRECATED: openHAB 3.4.0.M6
-        @timer.class.field_reader :future unless @timer.respond_to?(:future)
+        @timer = ScriptExecution.create_timer(1.minute.from_now) { execute }
         reschedule(@time)
       end
 
@@ -79,11 +67,7 @@ module OpenHAB
       alias_method :to_s, :inspect
 
       # @!attribute [r] execution_time
-      # @return [ZonedDateTime, nil] the scheduled execution time, or `nil` if the timer was cancelled
-      def execution_time
-        # DEPRECATED: openHAB 3.4.0.M6 (just remove the entire method)
-        @timer.future.scheduled_time
-      end
+      #   @return [ZonedDateTime, nil] the scheduled execution time, or `nil` if the timer was cancelled
 
       #
       # Reschedule timer

data/lib/openhab/core/types/date_time_type.rb

@@ -46,7 +46,7 @@ module OpenHAB
           rescue java.lang.StringIndexOutOfBoundsException, java.lang.IllegalArgumentException => e
             # Try Ruby's Time.parse if DateTimeType parser fails
             begin
-              ::Time.parse(time_string).to_zoned_date_time
+              DateTimeType.new(::Time.parse(time_string).to_zoned_date_time)
             rescue ArgumentError
               raise ArgumentError, e.message
             end

data/lib/openhab/core.rb

@@ -3,12 +3,12 @@
 module OpenHAB
   # Contains classes and modules that wrap actual openHAB objects
   module Core
-    # The openHAB Version. >= 3.3.0 is required.
+    # The openHAB Version. >= 3.4.0 is required.
     # @return [String]
     VERSION = org.openhab.core.OpenHAB.version.freeze
 
-    unless Gem::Version.new(VERSION) >= Gem::Version.new("3.3.0")
-      raise "`openhab-jrubyscripting` requires openHAB >= 3.3.0"
+    unless Gem::Version.new(VERSION) >= Gem::Version.new("3.4.0")
+      raise "`openhab-jrubyscripting` requires openHAB >= 3.4.0"
     end
 
     # @return [Integer] Number of seconds to wait between checks for automation manager

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

@@ -52,6 +52,8 @@ module OpenHAB
           return to_f <=> other if other.is_a?(Numeric)
 
           super
+        rescue TypeError
+          nil
         end
 
         #

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

@@ -7,16 +7,24 @@ module OpenHAB
     module Java
       java_import java.time.LocalDate
 
-      # Extensions to LocalDate
+      # Extensions to {java.time.LocalDate}
       class LocalDate
         include Time
         include Between
         include Ephemeris
 
-        class << self # rubocop:disable Lint/EmptyClass
-          # @!attribute [r] now
-          #   @return [ZonedDateTime]
-        end
+        # @!scope class
+
+        # @!attribute [r] now
+        #   @return [LocalDate]
+
+        # @!method parse(text, formatter=nil)
+        #   Converts the given text into a LocalDate.
+        #   @param [String] text The text to parse
+        #   @param [java.time.format.DateTimeFormatter] formatter The formatter to use
+        #   @return [LocalDate]
+
+        # @!scope instance
 
         # @param [TemporalAmount, LocalDate, Numeric] other
         #   If other is a Numeric, it's interpreted as days.
@@ -25,11 +33,11 @@ module OpenHAB
         def -(other)
           case other
           when Date
-            Period.of_days(day_of_year - other.yday)
+            self - other.to_local_date
           when MonthDay
             self - other.at_year(year)
           when LocalDate
-            Period.of_days(day_of_year - other.day_of_year)
+            Period.between(other, self)
           when Duration
             minus_days(other.to_days)
           when Numeric

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

@@ -7,6 +7,8 @@ module OpenHAB
     module Java
       java_import java.time.LocalTime
 
+      #
+      # Extensions to {java.time.LocalTime}
       #
       # @example
       #   break_time = LocalTime::NOON
@@ -36,15 +38,23 @@ module OpenHAB
         include Between
         # @!parse include Time
 
-        # @!visibility private
         class << self
+          # @!attribute [r] now
+          #   @return [LocalTime]
+
+          # @!visibility private
+          alias_method :raw_parse, :parse
+
           #
-          # Parses strings in the form "h[:mm[:ss]] [am/pm]"
+          # Parses strings in the form "h[:mm[:ss]] [am/pm]" when no formatter is given.
           #
           # @param [String] string
+          # @param [java.time.format.DateTimeFormatter] formatter The formatter to use
           # @return [LocalTime]
           #
-          def parse(string)
+          def parse(string, formatter = nil)
+            return raw_parse(string, formatter) if formatter
+
             format = /(am|pm)$/i.match?(string) ? "h[:mm[:ss][.S]][ ]a" : "H[:mm[:ss][.S]]"
             java_send(:parse, [java.lang.CharSequence, java.time.format.DateTimeFormatter],
                       string, java.time.format.DateTimeFormatterBuilder.new

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

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

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

@@ -7,7 +7,7 @@ module OpenHAB
     module Java
       java_import java.time.MonthDay
 
-      # Extensions to MonthDay
+      # Extensions to {java.time.MonthDay}
       class MonthDay
         include Between
         include Ephemeris
@@ -39,12 +39,22 @@ module OpenHAB
 
         # @return [MonthDay]
         def +(other)
-          (LocalDate.of(1900, month, day_of_month) + other).to_month_day
+          case other
+          when java.time.temporal.TemporalAmount, Numeric
+            (LocalDate.of(1900, month, day_of_month) + other).to_month_day
+          else
+            (to_local_date(other.to_local_date) + other).to_month_day
+          end
         end
 
         # @return [MonthDay, Period]
         def -(other)
-          d = (LocalDate.of(1900, month, day_of_month) - other)
+          d = case other
+              when java.time.temporal.TemporalAmount, Numeric
+                LocalDate.of(1900, month, day_of_month) - other
+              else
+                to_local_date(other.to_local_date) - other
+              end
           return d if d.is_a?(java.time.Period)
 
           d.to_month_day

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

@@ -5,7 +5,7 @@ module OpenHAB
     module Java
       java_import java.time.Period
 
-      # Extensions to Period
+      # Extensions to {java.time.Period}
       class Period
         # @!parse include TemporalAmount
 

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

@@ -5,7 +5,7 @@ module OpenHAB
     module Java
       java_import java.time.temporal.TemporalAmount
 
-      # Extensions to TemporalAmount
+      # Extensions to {java.time.temporal.TemporalAmount}
       module TemporalAmount
         # Subtract `self` to {ZonedDateTime.now}
         # @return [ZonedDateTime]

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

@@ -50,7 +50,11 @@ module OpenHAB
         # Convert `other` to this class, if possible
         # @return [Array, nil]
         def coerce(other)
-          [other.send(self.class.coercion_method), self] if other.respond_to?(self.class.coercion_method)
+          coercion_method = self.class.coercion_method
+          return unless other.respond_to?(coercion_method)
+          return [other.send(coercion_method), self] if other.method(coercion_method).arity.zero?
+
+          [other.send(coercion_method, self), self]
         end
       end
     end

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

@@ -7,18 +7,31 @@ module OpenHAB
     module Java
       ZonedDateTime = java.time.ZonedDateTime
 
-      # Extensions to ZonedDateTime
+      # Extensions to {java.time.ZonedDateTime}
       class ZonedDateTime
         include Time
         include Between
 
         class << self # rubocop:disable Lint/EmptyClass
+          # @!scope class
+
           # @!attribute [r] now
           #   @return [ZonedDateTime]
+
+          # @!method parse(text, formatter = nil)
+          #   Parses a string into a ZonedDateTime object.
+          #
+          #   @param [String] text The text to parse.
+          #   @param [java.time.format.DateTimeFormatter] formatter The formatter to use.
+          #   @return [ZonedDateTime]
         end
 
+        # @!scope instance
+
         # @return [LocalTime]
-        alias_method :to_local_time, :toLocalTime
+        def to_local_time(_context = nil)
+          toLocalTime
+        end
 
         # @return [Month]
         alias_method :to_month, :month

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

@@ -85,9 +85,9 @@ class Date
   #
   def coerce(other)
     return nil unless other.respond_to?(:to_date)
-    return [other.to_date(self), self] if other.method(:to_date).arity == 1
+    return [other.to_date, self] if other.method(:to_date).arity.zero?
 
-    [other.to_date, self]
+    [other.to_date(self), self]
   end
 
   remove_method :inspect

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

@@ -151,7 +151,12 @@ module OpenHAB
         # @return [QuantityType] `self` as a {QuantityType} of the supplied Unit
         #
         def |(unit) # rubocop:disable Naming/BinaryOperatorParameterName
-          unit = org.openhab.core.types.util.UnitUtils.parse_unit(unit.to_str) if unit.respond_to?(:to_str)
+          if unit.respond_to?(:to_str)
+            parsed_unit = org.openhab.core.types.util.UnitUtils.parse_unit(unit.to_str)
+            raise ArgumentError, "Unknown unit #{unit}" unless parsed_unit
+
+            unit = parsed_unit
+          end
 
           return super unless unit.is_a?(javax.measure.Unit)
 

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

@@ -187,6 +187,30 @@ module OpenHAB
           def item_factory
             @item_factory ||= org.openhab.core.library.CoreItemFactory.new
           end
+
+          #
+          # Convert the given array to an array of strings.
+          # Convert Semantics classes to their simple name.
+          #
+          # @param [String,Symbol,Semantics::Tag] tags A list of strings, symbols, or Semantics classes
+          # @return [Array] An array of strings
+          #
+          # @example
+          #   tags = normalize_tags("tag1", Semantics::LivingRoom)
+          #
+          # @!visibility private
+          def normalize_tags(*tags)
+            semantics = proc { |tag| tag.respond_to?(:java_class) && tag < Semantics::Tag }
+
+            tags.compact.map do |tag|
+              case tag
+              when String then tag
+              when Symbol then tag.to_s
+              when semantics then tag.java_class.simple_name
+              else raise ArgumentError, "`#{tag}` must be a subclass of Semantics::Tag, a `Symbol`, or a `String`."
+              end
+            end
+          end
         end
 
         # @param dimension [Symbol, nil] The unit dimension for a {NumberItem} (see {ItemBuilder#dimension})
@@ -294,18 +318,7 @@ module OpenHAB
         # @return [void]
         #
         def tag(*tags)
-          unless tags.all? do |tag|
-                   tag.is_a?(String) ||
-                   tag.is_a?(Symbol) ||
-                   (tag.is_a?(Module) && tag < Semantics::Tag)
-                 end
-            raise ArgumentError, "`tag` must be a subclass of Semantics::Tag, or a `String``."
-          end
-
-          tags.each do |tag|
-            tag = tag.name.split("::").last if tag.is_a?(Module) && tag < Semantics::Tag
-            @tags << tag.to_s
-          end
+          @tags += self.class.normalize_tags(*tags)
         end
 
         #

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -35,7 +35,8 @@ module OpenHAB
           super()
           set_name(config.name)
           set_description(config.description)
-          set_tags(to_string_set(config.tags))
+          tags = DSL::Items::ItemBuilder.normalize_tags(*config.tags)
+          set_tags(tags.to_set)
           set_triggers(config.triggers)
           self.uid = config.uid
           @run_context = config.caller
@@ -297,28 +298,6 @@ module OpenHAB
           @run_context.instance_exec(&task.block)
         end
 
-        #
-        # Convert the given array to a set of strings.
-        # Convert Semantics classes to their simple name
-        #
-        # @example
-        #   to_string_set("tag1", Semantics::LivingRoom)
-        #
-        # @param tags [Array] An array of strings or Semantics classes
-        #
-        # @return [Set] A set of strings
-        #
-        def to_string_set(*tags)
-          tags = tags.flatten.map do |tag|
-            if tag.respond_to?(:java_class) && tag < org.openhab.core.semantics.Tag
-              tag.java_class.simple_name
-            else
-              tag.to_s
-            end
-          end
-          Set.new(tags)
-        end
-
         #
         # Create a new hash in which all elements are converted to strings
         #

data/lib/openhab/dsl/rules/builder.rb

@@ -358,7 +358,7 @@ module OpenHAB
         #
         # Set the rule's tags.
         #
-        # @param [String, Class, Array<String, Class>] tags
+        # @param [String, Symbol, Semantics::Tag] tags A list of tags to assign to the rule.
         # @return [void]
         #
         # @example
@@ -1101,7 +1101,10 @@ module OpenHAB
         #   :saturday,
         #   :sunday] value
         #   When to execute rule.
-        # @param [LocalTime, String, nil] at What time of day to execute rule
+        # @param [LocalTime, String, Core::Items::DateTimeItem, nil] at What time of day to execute rule
+        #   If `value` is `:day`, `at` can be a {Core::Items::DateTimeItem DateTimeItem}, and
+        #   the trigger will run every day at the (time only portion of) current state of the
+        #   item. If the item is {NULL} or {UNDEF}, the trigger will not run.
         # @param [Object] attach Object to be attached to the trigger
         # @return [void]
         #
@@ -1157,11 +1160,23 @@ module OpenHAB
         #     run { logger.info "Happy Valentine's Day!" }
         #   end
         #
+        # @example
+        #   rule "Every day at sunset" do
+        #     every :day, at: Sunset_Time
+        #     run { logger.info "It's getting dark" }
+        #   end
+        #
         def every(value, at: nil, attach: nil)
           return every(java.time.MonthDay.parse(value), at: at, attach: attach) if value.is_a?(String)
 
           @ruby_triggers << [:every, value, { at: at }]
 
+          if value == :day && at.is_a?(Item)
+            raise ArgumentError, "Attachments are not supported with dynamic datetime triggers" unless attach.nil?
+
+            return trigger("timer.DateTimeTrigger", itemName: at.name, timeOnly: true)
+          end
+
           cron_expression = case value
                             when Symbol then Cron.from_symbol(value, at)
                             when Duration then Cron.from_duration(value, at)
@@ -1502,6 +1517,36 @@ module OpenHAB
           trigger("core.GenericEventTrigger", eventTopic: topic, eventSource: source, eventTypes: types, attach: attach)
         end
 
+        #
+        # Creates a trigger based on the time stored in a {DateTimeItem}
+        #
+        # The trigger will dynamically update any time the state of the item
+        # changes. If the item is {NULL} or {UNDEF}, the trigger will not run.
+        #
+        # @param [Item, String, Symbol] item The item (or it's name)
+        # @return [void]
+        #
+        # @example
+        #   rule "say hello when the kids get home from school" do
+        #     at HomeFromSchool_Time
+        #     run do
+        #       KitchenEcho_TTS << "hi kids! how was school?"
+        #     end
+        #   end
+        #
+        #   rule "set home from school time" do
+        #     on_load
+        #     every :day, at: "5:00am" do
+        #     run do
+        #       HomeFromSchool_Time.ensure.update(school_day? ? LocalTime.parse("3:30pm") : NULL)
+        #     end
+        #   end
+        #
+        def at(item)
+          item = item.name if item.is_a?(Item)
+          trigger("timer.DateTimeTrigger", itemName: item.to_s)
+        end
+
         #
         # Create a generic trigger given the trigger type uid and a configuration hash
         #

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.0.0.rc11"
+    VERSION = "5.0.0.rc12"
   end
 end

data/lib/openhab/dsl.rb

@@ -152,8 +152,6 @@ module OpenHAB
     #
     # @see Core::ValueCache ValueCache
     #
-    # @since openHAB 3.4.0
-    #
     def shared_cache
       $sharedCache
     end
@@ -523,9 +521,6 @@ module OpenHAB
     #   end # the states will be restored here
     #
     def store_states(*items)
-      items = items.flatten.map do |item|
-        item.respond_to?(:__getobj__) ? item.__getobj__ : item
-      end
       states = Core::Items::StateStorage.from_items(*items)
       if block_given?
         yield
@@ -604,18 +599,39 @@ module OpenHAB
     #     Item1.average_since(12.hours)
     #   end
     #
-    # @see OpenHAB::Core::Items::Persistence
-    #
-    # @param [Object] service service either as a String or a Symbol
+    # @param [Object] service Persistence service either as a String or a Symbol
     # @yield [] Block executed in context of the supplied persistence service
     # @return [Object] The return value from the block.
     #
+    # @see persistence!
+    # @see OpenHAB::Core::Items::Persistence
+    #
     def persistence(service)
-      old = Thread.current[:openhab_persistence_service]
-      Thread.current[:openhab_persistence_service] = service
+      old = persistence!(service)
       yield
     ensure
-      Thread.current[:openhab_persistence_service] = old
+      persistence!(old)
+    end
+
+    #
+    # Permanently sets the default persistence service for the current thread
+    #
+    # @note This method is only intended for use at the top level of rule
+    #   scripts. If it's used within library methods, or hap-hazardly within
+    #   rules, things can get very confusing because the prior state won't be
+    #   properly restored.
+    #
+    # @param [Object] service Persistence service either as a String or a Symbol. When nil, use
+    #   the system's default persistence service.
+    # @return [Object,nil] The previous persistence service settings, or nil when using the system's default.
+    #
+    # @see persistence
+    # @see OpenHAB::Core::Items::Persistence
+    #
+    def persistence!(service = nil)
+      old = Thread.current[:openhab_persistence_service]
+      Thread.current[:openhab_persistence_service] = service
+      old
     end
 
     #

data/lib/openhab/rspec/helpers.rb

@@ -265,12 +265,13 @@ module OpenHAB
       # @return [void]
       #
       def load_rules
-        automation_path = "#{org.openhab.core.OpenHAB.config_folder}/automation/ruby"
+        automation_paths = Array(::RSpec.configuration.openhab_automation_search_paths)
+
         lib_dirs = rubylib_dirs.map { |d| File.join(d, "") }
         lib_dirs << File.join(gem_home, "")
 
         SuspendRules.suspend_rules do
-          files = Dir["#{automation_path}/**/*.rb"]
+          files = automation_paths.map { |p| Dir["#{p}/**/*.rb"] }.flatten
           files.reject! do |f|
             lib_dirs.any? { |l| f.start_with?(l) }
           end

data/lib/openhab/rspec/hooks.rb

@@ -100,6 +100,7 @@ module OpenHAB
           restore_autoupdate_items
           Mocks::PersistenceService.instance.reset
           Hooks.cache_script_extension.sharedCache.clear if DSL.shared_cache
+          DSL.persistence!(nil)
         end
       end
     end

data/lib/openhab/rspec/mocks/timer.rb

@@ -17,6 +17,39 @@ module OpenHAB
         end
         ZonedDateTime.singleton_class.prepend(MockedZonedDateTime)
 
+        # @!visibility private
+        module MockedLocalDate
+          def now
+            mocked_time_stack_item = Timecop.top_stack_item
+            return super unless mocked_time_stack_item
+
+            mocked_time_stack_item.time.to_zoned_date_time.to_local_date
+          end
+        end
+        LocalDate.singleton_class.prepend(MockedLocalDate)
+
+        # @!visibility private
+        module MockedLocalTime
+          def now
+            mocked_time_stack_item = Timecop.top_stack_item
+            return super unless mocked_time_stack_item
+
+            mocked_time_stack_item.time.to_zoned_date_time.to_local_time
+          end
+        end
+        LocalTime.singleton_class.prepend(MockedLocalTime)
+
+        # @!visibility private
+        module MockedMonthDay
+          def now
+            mocked_time_stack_item = Timecop.top_stack_item
+            return super unless mocked_time_stack_item
+
+            mocked_time_stack_item.time.to_zoned_date_time.to_month_day
+          end
+        end
+        MonthDay.singleton_class.prepend(MockedMonthDay)
+
         # extend Timecop to support Java time classes
         # @!visibility private
         module TimeCopStackItem

data/lib/openhab/rspec.rb

@@ -15,3 +15,12 @@ require_relative "rspec/configuration"
 require_relative "rspec/helpers"
 require_relative "rspec/karaf"
 require_relative "rspec/hooks"
+
+return unless defined?(RSpec)
+
+RSpec.configure do |c|
+  c.add_setting :openhab_automation_search_paths, default: [
+    "#{org.openhab.core.OpenHAB.config_folder}/automation/ruby",
+    "#{org.openhab.core.OpenHAB.config_folder}/automation/jsr223"
+  ]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-jrubyscripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc11
+  version: 5.0.0.rc12
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler