openhab-jrubyscripting 5.0.0.rc5 → 5.0.0.rc8

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

@@ -1,31 +1,52 @@
 # frozen_string_literal: true
 
 require "delegate"
-require "forwardable"
 
 module OpenHAB
   module Core
     module Items
-      # Class is a proxy to underlying item
+      # Class is a proxy to underlying {Item}
       # @!visibility private
       class Proxy < Delegator
-        extend Forwardable
-        def_delegators :__getobj__, :class, :is_a?, :kind_of?
+        # Not really an Item, but pretends to be
+        # @!parse include Item
+
+        # @return [String]
+        attr_reader :name
 
         #
         # Set the proxy item (called by super)
         #
         def __setobj__(item)
-          # Convert name to java version for faster lookups
-          @item_name = item.name.to_java
+          @name = item.name
+          # Convert name to Java version for faster lookups
+          @java_name = item.name.to_java
         end
 
         #
         # Lookup item from item registry
         #
         def __getobj__
-          $ir.get(@item_name)
+          r = $ir.get(@name)
+          return yield if r.nil? && block_given?
+
+          r
+        end
+
+        # @return [Module]
+        def class
+          return Item if __getobj__.nil?
+
+          __getobj__.class
+        end
+
+        # @return [true, false]
+        def is_a?(klass)
+          obj = __getobj__
+          # only claim to be a Delegator if we're backed by an actual item at the moment
+          klass == Item || obj.is_a?(klass) || klass == Proxy || (!obj.nil? && super)
         end
+        alias_method :kind_of?, :is_a?
 
         #
         # Need to check if `self` _or_ the delegate is an instance of the
@@ -63,6 +84,46 @@ module OpenHAB
         def !=(other)
           !(self == other) # rubocop:disable Style/InverseMethods
         end
+
+        # @return [GroupItem::Members]
+        # @raise [NoMethodError] if item is not a GroupItem, or a dummy.
+        def members
+          return super unless __getobj__.nil?
+
+          GroupItem::Members.new(self)
+        end
+
+        # @return [String]
+        def inspect
+          return super unless __getobj__.nil?
+
+          "#<OpenHAB::Core::Items::Proxy #{name}>"
+        end
+
+        #
+        # Supports inspect from IRB when we're a dummy item.
+        #
+        # @return [void]
+        # @!visibility private
+        def pretty_print(printer)
+          return super unless __getobj__.nil?
+
+          printer.text(inspect)
+        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
+
+          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
+
+          super
+        end
       end
     end
   end

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

@@ -10,7 +10,7 @@ module OpenHAB
   module Core
     module Items
       #
-      # Provides access to all OpenHAB {GenericItem items}, and acts like an array.
+      # Provides access to all openHAB {Item items}, and acts like an array.
       #
       class Registry
         include LazyArray
@@ -18,7 +18,7 @@ module OpenHAB
 
         # Fetches the named item from the the ItemRegistry
         # @param [String] name
-        # @return [GenericItem] Item from registry, nil if item missing or requested item is a Group Type
+        # @return [Item] Item from registry, nil if item missing or requested item is a Group Type
         def [](name)
           EntityLookup.lookup_item(name)
         rescue org.openhab.core.items.ItemNotFoundException
@@ -49,7 +49,7 @@ module OpenHAB
         # @return [Object] The return value of the block.
         #
         def build(preferred_provider = nil, &block)
-          DSL::Items::BaseBuilderDSL.new(preferred_provider).instance_eval(&block)
+          DSL::Items::BaseBuilderDSL.new(preferred_provider).instance_eval_with_dummy_items(&block)
         end
 
         #
@@ -57,11 +57,11 @@ module OpenHAB
         #
         # The item must be a managed item (typically created by Ruby or in the UI).
         #
-        # @param [String, GenericItem] item_name
+        # @param [String, Item] item_name
         # @param recursive [true, false] Remove the item's members if it's a group
-        # @return [GenericItem, nil] The removed item, if found.
+        # @return [Item, nil] The removed item, if found.
         def remove(item_name, recursive: false)
-          item_name = item_name.name if item_name.is_a?(GenericItem)
+          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)
             raise "Cannot remove item #{item_name} from non-managed provider #{provider.inspect}"

data/lib/openhab/core/items/semantics/enumerable.rb

@@ -40,31 +40,31 @@ module Enumerable
   #
 
   # Returns a new array of items that have at least one of the given tags
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   def tagged(*tags)
     reject { |i| (tags & i.tags.to_a).empty? }
   end
 
   # Returns a new array of items that do not have any of the given tags
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   def not_tagged(*tags)
     select { |i| (tags & i.tags.to_a).empty? }
   end
 
   # Returns a new array of items that are a member of at least one of the given groups
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   def member_of(*groups)
     reject { |i| (groups.map(&:name) & i.group_names).empty? }
   end
 
   # Returns a new array of items that are not a member of any of the given groups
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   def not_member_of(*groups)
     select { |i| (groups.map(&:name) & i.group_names).empty? }
   end
 
   # Returns the group members the elements
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   def members
     grep(OpenHAB::Core::Items::GroupItem).flat_map(&:members)
   end
@@ -149,6 +149,6 @@ module Enumerable
   # can't use `include`, because Enumerable has already been included
   # in other classes
   def ensure
-    OpenHAB::DSL::Items::Ensure::GenericItemDelegate.new(self)
+    OpenHAB::DSL::Items::Ensure::ItemDelegate.new(self)
   end
 end

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

@@ -9,7 +9,7 @@ require_relative "semantics/enumerable"
 module OpenHAB
   module Core
     module Items
-      # Module for implementing semantics helper methods on {GenericItem} in order to easily navigate
+      # Module for implementing semantics helper methods on {Item} in order to easily navigate
       # the {https://www.openhab.org/docs/tutorial/model.html Semantic Model} in your scripts.
       # This can be extremely useful to find related items in rules that are executed for any member of a group.
       #
@@ -161,6 +161,7 @@ module OpenHAB
         GenericItem.include(self)
         GroupItem.extend(Forwardable)
         GroupItem.def_delegators :members, :equipments, :locations
+
         # @!parse
         #   class Items::GroupItem
         #     #
@@ -273,7 +274,7 @@ module OpenHAB
         # Checks ancestor groups one level at a time, returning the first
         # {Location} Item found.
         #
-        # @return [GenericItem, nil]
+        # @return [Item, nil]
         #
         def location
           Actions::Semantics.get_location(self)&.then(&Proxy.method(:new))
@@ -299,7 +300,7 @@ module OpenHAB
         #
         # Checks ancestor groups one level at a time, returning the first {Equipment} Item found.
         #
-        # @return [GenericItem, nil]
+        # @return [Item, nil]
         #
         def equipment
           Actions::Semantics.get_equipment(self)&.then(&Proxy.method(:new))
@@ -379,7 +380,7 @@ module OpenHAB
         #   Pass 1 or 2 classes that are sub-classes of {Point} or {Property}.
         #   Note that when comparing against semantic tags, it does a sub-class check.
         #   So if you search for [Control], you'll get items tagged with [Switch].
-        # @return [Array<GenericItem>]
+        # @return [Array<Item>]
         #
         def points(*point_or_property_types)
           return members.points(*point_or_property_types) if equipment? || location?
@@ -403,7 +404,7 @@ module Enumerable
   #
 
   # Returns a new array of items that are a semantics Location (optionally of the given type)
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   def locations(type = nil)
     if type && (!type.is_a?(Module) || !(type < Semantics::Location))
       raise ArgumentError, "type must be a subclass of Location"
@@ -423,7 +424,7 @@ module Enumerable
   #   that belong to the {Semantics::Equipment equipments}, use {#members}
   #   before calling {#points}. See the example with {#points}.
   #
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   #
   # @example Get all TVs in a room
   #   lGreatRoom.equipments(Semantics::Screen)
@@ -440,7 +441,7 @@ module Enumerable
 
   # Returns a new array of items that are semantics points (optionally of a given type)
   #
-  # @return [Array<GenericItem>]
+  # @return [Array<Item>]
   #
   # @example Get all the power switch items for every equipment in a room
   #   lGreatRoom.equipments.members.points(Semantics::Switch)

data/lib/openhab/core/items.rb

@@ -9,7 +9,7 @@ end
 module OpenHAB
   module Core
     #
-    # Contains the core types that OpenHAB uses to represent items.
+    # Contains the core types that openHAB uses to represent items.
     # Items have states from the {Types} module.
     #
     # You may use an item or group name anywhere {DSL} (or just {Core::EntityLookup})
@@ -25,6 +25,7 @@ module OpenHAB
             Object.const_set(const_name, k) unless Object.const_defined?(const_name)
           end
           Object.const_set(:GenericItem, GenericItem) unless Object.const_defined?(:GenericItem)
+          Object.const_set(:Item, Item) unless Object.const_defined?(:Item)
         end
 
         private

data/lib/openhab/core/provider.rb

@@ -154,7 +154,11 @@ module OpenHAB
 
       # @!visibility private
       def add(element)
-        @elements[element.uid] = element
+        @elements.compute(element.uid) do |_k, old_element|
+          raise ArgumentError, "Element #{element.uid} already exists, and cannot be added again" if old_element
+
+          element
+        end
         notify_listeners_about_added_element(element)
         element
       end
@@ -197,12 +201,15 @@ module OpenHAB
       # @!visibility private
       #
       def update(element)
-        old_element = @elements[element.uid]
-        if old_element
-          @elements[element.uid] = element
-          notify_listeners_about_updated_element(old_element, element)
+        old = nil
+        @elements.compute(element.uid) do |_k, old_element|
+          raise ArgumentError, "Element #{element.uid} does not exist to update" unless old_element
+
+          old = old_element
+          element
         end
-        old_element
+        notify_listeners_about_updated_element(old, element)
+        old
       end
 
       # @!visibility private
@@ -214,7 +221,7 @@ module OpenHAB
 
       def initialize(script_unloaded_before: nil)
         super()
-        @elements = {}
+        @elements = java.util.concurrent.ConcurrentHashMap.new
         self.class.registry.add_provider(self)
         ScriptHandling.script_unloaded(before: script_unloaded_before) { unregister }
       end

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

@@ -6,7 +6,7 @@ module OpenHAB
   module Core
     module Rules
       #
-      # Provides access to all OpenHAB {Rule rules}, and acts like an array.
+      # Provides access to all openHAB {Rule rules}, and acts like an array.
       #
       class Registry
         include LazyArray
@@ -42,7 +42,7 @@ module OpenHAB
         # @return [Object] The result of the block.
         #
         def build(preferred_provider = nil, &block)
-          DSL::Rules::Builder.new(preferred_provider).instance_eval(&block)
+          DSL::Rules::Builder.new(preferred_provider).instance_eval_with_dummy_items(&block)
         end
 
         #

data/lib/openhab/core/rules.rb

@@ -14,7 +14,7 @@ module OpenHAB
       class << self
         #
         # @!attribute [r] rule_manager
-        # @return [org.openhab.core.automation.RuleManager] The OpenHAB rule manager/engine
+        # @return [org.openhab.core.automation.RuleManager] The openHAB rule manager/engine
         #
         def manager
           @manager ||= OSGi.service("org.openhab.core.automation.RuleManager")

data/lib/openhab/core/script_handling.rb

@@ -11,7 +11,7 @@ module OpenHAB
       #
       # Add a block of code to be executed once the rule script has finished loading.
       #
-      # This can occur on OpenHAB start up, when the script is first created, or updated.
+      # This can occur on openHAB start up, when the script is first created, or updated.
       #
       # Multiple hooks can be added by calling {#script_loaded} multiple times.
       # They can be used to perform final initializations.
@@ -37,7 +37,7 @@ module OpenHAB
       #
       # Add a block of code to be executed when the script is unloaded.
       #
-      # This can occur when OpenHAB shuts down, or when the script is being reloaded.
+      # This can occur when openHAB shuts down, or when the script is being reloaded.
       #
       # Multiple hooks can be added by calling {#script_unloaded} multiple times.
       # They can be used to perform final cleanup.
@@ -88,9 +88,9 @@ module OpenHAB
       self.script_loaded = false
 
       #
-      # Executed when OpenHAB unloads a script file
+      # Executed when openHAB unloads a script file
       #
-      def scriptUnloaded # rubocop:disable Naming/MethodName method name dictated by OpenHAB
+      def scriptUnloaded # rubocop:disable Naming/MethodName method name dictated by openHAB
         logger.trace("Script unloaded")
         ScriptHandlingCallbacks.script_unloaded_hooks.each do |hook|
           hook.call
@@ -116,9 +116,9 @@ module OpenHAB
       end
 
       #
-      # Executed when OpenHAB loads a script file
+      # Executed when openHAB loads a script file
       #
-      def scriptLoaded(filename) # rubocop:disable Naming/MethodName method name dictated by OpenHAB
+      def scriptLoaded(filename) # rubocop:disable Naming/MethodName method name dictated by openHAB
         logger.trace("Script loaded: #{filename}")
         ScriptHandlingCallbacks.script_loaded_hooks.each do |hook|
           hook.call

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

@@ -9,7 +9,7 @@ module OpenHAB
 
       #
       # {Channel} is a part of a {Thing} that represents a functionality of it.
-      # Therefore {GenericItem Items} can be linked a to a channel.
+      # Therefore {Item Items} can be linked a to a channel.
       #
       # @!attribute [r] item
       #   (see ChannelUID#item)

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

@@ -28,7 +28,7 @@ module OpenHAB
         # Return the item if this channel is linked with an item. If a channel is linked to more than one item,
         # this method only returns the first item.
         #
-        # @return [GenericItem, nil]
+        # @return [Item, nil]
         #
         def item
           items.first
@@ -39,7 +39,7 @@ module OpenHAB
         #
         # Returns all of the channel's linked items.
         #
-        # @return [Array<GenericItem>] An array of things or an empty array
+        # @return [Array<Item>] An array of things or an empty array
         #
         def items
           registry = OSGi.service("org.openhab.core.thing.link.ItemChannelLinkRegistry")

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

@@ -6,7 +6,7 @@ module OpenHAB
       java_import org.openhab.core.thing.link.ItemChannelLink
 
       #
-      # Represents the link between a {GenericItem} and a {Thing Thing's}
+      # Represents the link between an {Item} and a {Thing Thing's}
       # {Channel}.
       #
       # @!attribute [r] thing
@@ -21,7 +21,7 @@ module OpenHAB
         def_delegator :linked_uid, :thing
 
         # @!attribute [r] item
-        # @return [GenericItem]
+        # @return [Item]
         def item
           DSL.items[item_name]
         end

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

@@ -4,11 +4,11 @@ module OpenHAB
   module Core
     module Things
       #
-      # Contains the link between a {Thing Thing's} {Channel Channels} and {GenericItem Items}.
+      # Contains the link between a {Thing Thing's} {Channel Channels} and {Item Items}.
       #
       module Links
         #
-        # Provides {Items::GenericItem items} linked to {Channel channels} in Ruby to openHAB.
+        # Provides {Items::Item items} linked to {Channel channels} in Ruby to openHAB.
         #
         class Provider < Core::Provider
           include org.openhab.core.thing.link.ItemChannelLinkProvider

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

@@ -6,7 +6,7 @@ module OpenHAB
   module Core
     module Things
       #
-      # Provides access to all OpenHAB {Thing things}, and acts like an array.
+      # Provides access to all openHAB {Thing things}, and acts like an array.
       #
       class Registry
         include LazyArray

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

@@ -9,7 +9,7 @@ module OpenHAB
       #
       # A {Thing} is a representation of a connected part (e.g. physical device
       # or cloud service) from the real world. It contains a list of
-      # {Channel Channels}, which can be bound to {GenericItem Items}.
+      # {Channel Channels}, which can be bound to {Item Items}.
       #
       # @see OpenHAB::DSL.things things[]
       # @see EntityLookup

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

@@ -33,8 +33,8 @@ module OpenHAB
 
         class << self
           #
-          # Parses a String representing a time into an OpenHAB DateTimeType. First tries to parse it
-          #   using java's DateTimeType's parser, then falls back to the Ruby Time.parse
+          # Parses a String representing a time into an {java.time.DateTimeType}. First tries to parse it
+          #   using Java's parser, then falls back to the Ruby `Time.parse`.
           #
           # @param [String] time_string
           #
@@ -44,9 +44,9 @@ module OpenHAB
             time_string = "#{time_string}Z" if TIME_ONLY_REGEX.match?(time_string)
             DateTimeType.new(time_string)
           rescue java.lang.StringIndexOutOfBoundsException, java.lang.IllegalArgumentException => e
-            # Try Ruby's Time.parse if OpenHAB's DateTimeType parser fails
+            # Try Ruby's Time.parse if DateTimeType parser fails
             begin
-              DateTimeType.new(::Time.parse(time_string))
+              ::Time.parse(time_string).to_zoned_date_time
             rescue ArgumentError
               raise ArgumentError, e.message
             end

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

@@ -61,7 +61,7 @@ module OpenHAB
             if args.length == 1 && args.first.respond_to?(:to_str)
               value = args.first.to_str
 
-              # parse some formats OpenHAB doesn't understand
+              # parse some formats openHAB doesn't understand
               # in this case, HTML hex format for rgb
               if (match = value.match(/^#(\h{2})(\h{2})(\h{2})$/))
                 rgb = match.to_a[1..3].map { |v| v.to_i(16) }
@@ -77,7 +77,7 @@ module OpenHAB
             return super unless args.length == 3
 
             # convert from several numeric-like types to the exact types
-            # OpenHAB needs
+            # openHAB needs
             hue = args[0]
             args[0] = if hue.is_a?(DecimalType)
                         hue

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

@@ -12,7 +12,7 @@ module OpenHAB
       # {QuantityType} extends {DecimalType} to handle physical unit measurement.
       #
       # {QuantityType} is part of the [Units of Measurement](https://www.openhab.org/docs/concepts/units-of-measurement.html)
-      # framework in OpenHAB. It is represented as a decimal number with a unit.
+      # framework in openHAB. It is represented as a decimal number with a unit.
       # You can construct a {QuantityType} object by using the pipe operator with any Numeric.
       #
       # @see OpenHAB::DSL.unit unit: Implicit unit conversions

data/lib/openhab/core/types.rb

@@ -7,7 +7,7 @@ end
 module OpenHAB
   module Core
     #
-    # Contains the core types that OpenHAB uses as {State}s for items, and
+    # Contains the core types that openHAB uses as {State}s for items, and
     # {Command}s to be sent to control them.
     #
     # Types are the specific data types that commands and states are. They can be

data/lib/openhab/core/uid.rb

@@ -4,7 +4,7 @@ module OpenHAB
   module Core
     java_import org.openhab.core.common.AbstractUID
 
-    # Adds methods to core OpenHAB AbstractUID to make it more natural in Ruby
+    # Adds methods to core openHAB AbstractUID to make it more natural in Ruby
     class AbstractUID
       # implicit conversion to string
       alias_method :to_str, :to_s