openhab-jrubyscripting 5.0.0.rc10 → 5.0.0.rc12

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "delegate"
+require_relative "../proxy"
 
 module OpenHAB
   module Core
@@ -11,6 +12,13 @@ module OpenHAB
         # Not really an Item, but pretends to be
         # @!parse include Item
 
+        # @!visibility private
+        EVENTS = [Events::ItemAddedEvent::TYPE, Events::ItemUpdatedEvent::TYPE, Events::ItemRemovedEvent::TYPE].freeze
+        # @!visibility private
+        UID_METHOD = :name
+
+        include Core::Proxy
+
         # @return [String]
         attr_reader :name
 
@@ -18,19 +26,15 @@ module OpenHAB
         # Set the proxy item (called by super)
         #
         def __setobj__(item)
-          @name = item.name
-          # Convert name to Java version for faster lookups
-          @java_name = item.name.to_java
+          @item = item.is_a?(Item) ? item : nil
+          @name ||= item.name if item
         end
 
         #
-        # Lookup item from item registry
+        # @return [Item, nil]
         #
         def __getobj__
-          r = $ir.get(@name)
-          return yield if r.nil? && block_given?
-
-          r
+          @item
         end
 
         # @return [Module]
@@ -88,9 +92,9 @@ module OpenHAB
         # @return [GroupItem::Members]
         # @raise [NoMethodError] if item is not a GroupItem, or a dummy.
         def members
-          return super unless __getobj__.nil?
+          return GroupItem::Members.new(self) if __getobj__.nil?
 
-          GroupItem::Members.new(self)
+          __getobj__.members
         end
 
         # @return [String]
@@ -112,15 +116,17 @@ module OpenHAB
         end
 
         # needs to return `false` if we know we're not a {GroupItem}
-        def respond_to?(method, *)
-          return __getobj__.nil? if method.to_sym == :members
+        def respond_to?(method, *args)
+          obj = __getobj__
+          return obj.respond_to?(method, *args) if method.to_sym == :members && !obj.nil?
 
           super
         end
 
         # needs to return `false` if we know we're not a {GroupItem}
-        def respond_to_missing?(method, *)
-          return __getobj__.nil? if method.to_sym == :members
+        def respond_to_missing?(method, *args)
+          obj = __getobj__
+          return obj.respond_to_missing?(method, *args) if method.to_sym == :members && !obj.nil?
 
           super
         end

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

@@ -48,6 +48,8 @@ module OpenHAB
         # @yield Block executed in the context of a {DSL::Items::Builder}
         # @return [Object] The return value of the block.
         #
+        # (see Items::Builder)
+        #
         def build(preferred_provider = nil, &block)
           DSL::Items::BaseBuilderDSL.new(preferred_provider).instance_eval_with_dummy_items(&block)
         end
@@ -57,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/items.rb

@@ -62,9 +62,9 @@ module OpenHAB
 
             logger.trace("Defining #{klass}##{command} for #{value}")
             klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
-              def #{command}(for: nil, on_expire: nil, &block)                                          # def on(for: nil, on_expire: nil, &block )
-                command(#{value}, for: binding.local_variable_get(:for), on_expire: on_expire, &block)  #   command(ON, for: nil, expire: nil, &block)
-              end                                                                                       # end
+              ruby2_keywords def #{command}(*args, &block)  # ruby2_keywords def on(*args, &block)
+                command(#{value}, *args, &block)            #   command(ON, *args, &block)
+              end                                           # end
             RUBY
 
             logger.trace("Defining Enumerable##{command} for #{value}")

data/lib/openhab/core/profile_factory.rb

@@ -69,10 +69,12 @@ module OpenHAB
 
           params[:callback] = @callback
           params[:context] = @context
-          params[:config] = @context.configuration
+          params[:configuration] = @context.configuration.properties
           params[:link] = @callback.link
           params[:item] = @callback.link.item
           params[:channel_uid] = @callback.link.linked_uid
+          params[:state] ||= nil
+          params[:command] ||= nil
 
           kwargs = {}
           @block.parameters.each do |(param_type, name)|

data/lib/openhab/core/proxy.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "weakref"
+
+require_relative "script_handling"
+
+module OpenHAB
+  module Core
+    #
+    # Contains the infrastructure necessary to listen for events when objects are
+    # added/removed from their registry, and keep Proxy objects up-to-date with
+    # their underlying object.
+    #
+    # The including class must meet a few requirements:
+    #  * Have an `EVENTS` constant that is an Array<String> of the events to
+    #    listen for
+    #  * The _last_ entry in the `EVENTS` array must be the "removed" event
+    #  * It must have a sibling class called `Provider`, with a `.registry`
+    #    method
+    #  * It's parent module, downcased and with trailing "s" stripped, must be
+    #    the method name to retrieve an object from one of the incoming events
+    #
+    # @!visibility private
+    #
+    module Proxy
+      #
+      # Registers and listens to openHAB bus events for objects getting
+      # added/updated/removed, and updates references from proxy objects
+      # to real objects.
+      #
+      # Proxies are tracked (via a WeakRef), and their underlying object is
+      # if it has changed.
+      #
+      class EventSubscriber
+        include Singleton
+        include org.openhab.core.events.EventSubscriber
+
+        def initialize
+          @proxies = java.util.concurrent.ConcurrentHashMap.new
+          @parent_module = Object.const_get(self.class.name.split("::")[0..-3].join("::"), false)
+          @object_type = @parent_module.name.split("::").last.downcase[0..-2].to_sym
+
+          @event_types = @parent_module::Proxy::EVENTS
+          @uid_method = @parent_module::Proxy::UID_METHOD
+          @registry = @parent_module::Provider.registry
+          @registration = OSGi.register_service(self, "event.topics": "openhab/*")
+          ScriptHandling.script_unloaded { @registration.unregister }
+        end
+
+        #
+        # @!attribute [r] subscribed_event_types
+        # @return [Set<String>]
+        #
+        def subscribed_event_types
+          @event_types.to_set
+        end
+
+        # @return [org.openhab.core.events.EventFilter, nil]
+        def event_filter
+          nil
+        end
+
+        #
+        # @param [Events::AbstractEvent] event
+        # @return [void]
+        #
+        def receive(event)
+          uid = event.__send__(@object_type).__send__(@uid_method)
+          object = @registry.get(uid) unless event.class.simple_name == @event_types.last
+
+          @proxies.compute_if_present(uid) do |_, proxy_ref|
+            proxy = resolve_ref(proxy_ref)
+            next nil unless proxy
+
+            proxy.__setobj__(object)
+            proxy_ref
+          end
+        end
+
+        #
+        # Get or create a Proxy for the given raw openHAB object.
+        #
+        def fetch(object)
+          result = nil
+
+          @proxies.compute(object.__send__(@uid_method)) do |_k, proxy_ref|
+            result = resolve_ref(proxy_ref)
+            proxy_ref = nil unless result
+            result ||= yield
+
+            proxy_ref || WeakRef.new(result)
+          end
+
+          result
+        end
+
+        private
+
+        def resolve_ref(proxy_ref)
+          proxy_ref.__getobj__ if proxy_ref&.weakref_alive?
+        rescue WeakRef::RefError
+          nil
+        end
+      end
+
+      # @!visibility private
+      module ClassMethods
+        # Intercepts calls to create new proxies, and returns the already
+        # existing (and tracked) proxy if it exists. Otherwise it does create
+        # a new instance of Proxy.
+        def new(object)
+          self::EventSubscriber.instance.fetch(object) { super }
+        end
+      end
+
+      # @!visibility private
+      def self.included(klass)
+        klass.singleton_class.prepend(ClassMethods)
+        # 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

@@ -17,7 +17,7 @@ module OpenHAB
             #
             # The ItemChannelLink registry
             #
-            # @return [org.openhab.core.thing.link.ItemChanneLinkRegistry]
+            # @return [org.openhab.core.thing.link.ItemChannelLinkRegistry]
             #
             def registry
               @registry ||= OSGi.service("org.openhab.core.thing.link.ItemChannelLinkRegistry")
@@ -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/proxy.rb

@@ -12,6 +12,14 @@ module OpenHAB
         extend Forwardable
         def_delegators :__getobj__, :class, :is_a?, :kind_of?
 
+        # @!visibility private
+        EVENTS = [Events::ThingAddedEvent::TYPE, Events::ThingUpdatedEvent::TYPE,
+                  Events::ThingRemovedEvent::TYPE].freeze
+        # @!visibility private
+        UID_METHOD = :uid
+
+        include Core::Proxy
+
         # Returns the list of channels associated with this Thing
         #
         # @note This is defined on this class, and not on {Thing}, because

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

@@ -33,7 +33,7 @@ module OpenHAB
 
         class << self
           #
-          # Parses a String representing a time into an {java.time.DateTimeType}. First tries to parse it
+          # Parses a String representing a time into a {DateTimeType}. First tries to parse it
           #   using Java's parser, then falls back to the Ruby `Time.parse`.
           #
           # @param [String] time_string
@@ -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
@@ -71,6 +71,7 @@ module OpenHAB
         def_delegator :zoned_date_time, :to_epoch_second, :to_i
         def_delegator :zoned_date_time, :to_time
 
+        # @!visibility private
         alias_method :day, :mday
 
         #

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

@@ -11,7 +11,7 @@ module OpenHAB
       DecimalType = org.openhab.core.library.types.DecimalType
 
       #
-      # {DecimalType} uses a {java.lang.BigDecimal} internally and thus can be
+      # {DecimalType} uses a {java.math.BigDecimal} internally and thus can be
       # used for integers, longs and floating point numbers alike.
       #
       # @example DecimalType can be used in case statements with ranges

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

@@ -21,11 +21,11 @@ module OpenHAB
         #   Undef State
 
         # @!method null?
-        #   Check if `self == NULL`
+        #   Check if `self` == {NULL}
         #   @return [true,false]
 
         # @!method undef?
-        #   Check if `self == UNDEF`
+        #   Check if `self` == {UNDEF}
         #   @return [true,false]
       end
     end

data/lib/openhab/core/value_cache.rb

@@ -26,7 +26,7 @@ module OpenHAB
     #
     # @note Only the {OpenHAB::DSL.shared_cache sharedCache} is exposed in Ruby.
     #   For a private cache, simply use an instance variable. See
-    #   {file:docs/ruby-basics.md#Variables Instance Variables}.
+    #   {file:docs/ruby-basics.md#variables Instance Variables}.
     #
     # @note Because every script or UI rule gets it own JRuby engine instance,
     #   you cannot rely on being able to access Ruby objects between them. Only

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module CoreExt
+    #
+    # Forwards ephemeris helper methods to `#to_zoned_date_time` provided by
+    # the mixed-in class.
+    #
+    # @note openHAB's built-in holiday definitions are based on _bank_
+    #   holidays, so may give some unexpected results. For example, 2022-12-25
+    #   is _not_ Christmas in England because it lands on a Sunday that year,
+    #   so Christmas is considered to be 2022-12-26. See
+    #   [the source](https://github.com/svendiedrichsen/jollyday/tree/master/src/main/resources/holidays)
+    #   for exact definitions. You can always provide your own holiday
+    #   definitions with {OpenHAB::DSL.holiday_file holiday_file} or
+    #   {OpenHAB::DSL.holiday_file! holiday_file!}.
+    #
+    # @see https://www.openhab.org/docs/configuration/actions.html#ephemeris Ephemeris Action
+    # @see Core::Actions::Ephemeris.holiday_name Ephemeris.holiday_name
+    #
+    module Ephemeris
+      # (see Java::ZonedDateTime#holiday)
+      def holiday(holiday_file = nil)
+        to_zoned_date_time.holiday(holiday_file)
+      end
+
+      # (see Java::ZonedDateTime#holiday?)
+      def holiday?(holiday_file = nil)
+        to_zoned_date_time.holiday?(holiday_file)
+      end
+
+      # (see Java::ZonedDateTime#next_holiday)
+      def next_holiday(holiday_file = nil)
+        to_zoned_date_time.next_holiday(holiday_file)
+      end
+
+      # (see Java::ZonedDateTime#weekend?)
+      def weekend?
+        to_zoned_date_time.weekend?
+      end
+
+      # (see Java::ZonedDateTime#in_dayset?)
+      def in_dayset?(set)
+        to_zoned_date_time.in_dayset?(set)
+      end
+
+      # (see Java::ZonedDateTime#days_until)
+      def days_until(holiday, holiday_file = nil)
+        to_zoned_date_time.days_until(holiday, holiday_file)
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module OpenHAB
         #
         # `self`, all superclasses and interfaces, recursively.
         #
-        # @return [Array<java.reflect.Type>]
+        # @return [Array<java.lang.reflect.Type>]
         #
         def generic_ancestors
           ancestors.flat_map do |klass|

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

@@ -5,13 +5,37 @@ module OpenHAB
     module Java
       Duration = java.time.Duration
 
-      # Extensions to Duration
+      # Extensions to {java.time.Duration Java Duration}
       class Duration
         include Between
         # @!parse include TemporalAmount
 
+        #
+        # Convert to integer number of seconds
+        #
+        # @return [Integer]
+        #
         alias_method :to_i, :seconds
 
+        #
+        # @!method zero?
+        #   @return [true,false] Returns true if the duration is zero length.
+        #
+
+        #
+        # @!method negative?
+        #   @return [true,false] Returns true if the duration is less than zero.
+        #
+
+        unless instance_methods.include?(:positive?)
+          #
+          # @return [true, false] Returns true if the duration is greater than zero.
+          #
+          def positive?
+            self > 0 # rubocop:disable Style/NumericPredicate
+          end
+        end
+
         #
         # Convert to number of seconds
         #
@@ -28,6 +52,8 @@ module OpenHAB
           return to_f <=> other if other.is_a?(Numeric)
 
           super
+        rescue TypeError
+          nil
         end
 
         #