openhab-scripting 2.16.2 → 2.19.0

data/lib/openhab/core/dsl/monkey_patch/items/metadata.rb

@@ -1,283 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'delegate'
-require 'pp'
-require 'forwardable'
-require 'openhab/osgi'
-require 'openhab/core/log'
-
-module OpenHAB
-  module Core
-    module DSL
-      module MonkeyPatch
-        module Items
-          #
-          # Metadata extension for Items
-          #
-          module Metadata
-            include Logging
-
-            java_import org.openhab.core.items.Metadata
-            java_import org.openhab.core.items.MetadataKey
-
-            #
-            # Provide the interface to access namespace's value and configuration
-            #
-            class MetadataItem < SimpleDelegator
-              extend Forwardable
-
-              def_delegator :@metadata, :value
-
-              def initialize(metadata: nil, key: nil, value: nil, config: nil)
-                @metadata = metadata || Metadata.new(key || MetadataKey.new('', ''), value, config)
-                super(@metadata&.configuration)
-              end
-
-              #
-              # Updates the metadata configuration associated with the key
-              #
-              def []=(key, value)
-                configuration = {}.merge(@metadata&.configuration || {}).merge({ key => value })
-                metadata = Metadata.new(@metadata&.uID, @metadata&.value, configuration)
-                NamespaceAccessor.registry.update(metadata) if @metadata&.uID
-              end
-
-              #
-              # Delete the configuration with the given key
-              #
-              # @return [Java::Org::openhab::core::items::Metadata] the old metadata
-              #
-              def delete(key)
-                configuration = {}.merge(@metadata&.configuration || {})
-                configuration.delete(key)
-                metadata = Metadata.new(@metadata&.uID, @metadata&.value, configuration)
-                NamespaceAccessor.registry.update(metadata) if @metadata&.uID
-              end
-
-              #
-              # Set the metadata value
-              #
-              # @return [Java::Org::openhab::core::items::Metadata] the old metadata
-              #
-              def value=(value)
-                raise ArgumentError, 'Value must be a string' unless value.is_a? String
-
-                metadata = Metadata.new(@metadata&.uID, value, @metadata&.configuration)
-                NamespaceAccessor.registry.update(metadata) if @metadata&.uID
-              end
-
-              #
-              # Set the entire configuration to a hash
-              #
-              # @return [Java::Org::openhab::core::items::Metadata] the old metadata
-              #
-              def config=(config)
-                raise ArgumentError, 'Configuration must be a hash' unless config.is_a? Hash
-
-                metadata = Metadata.new(@metadata&.uID, @metadata&.value, config)
-                NamespaceAccessor.registry.update(metadata) if @metadata&.uID
-              end
-              alias configuration= config=
-
-              #
-              # Convert the metadata to an array
-              #
-              # @return [Array[2]] An array of [value, configuration]
-              #
-              def to_a
-                [@metadata&.value, @metadata&.configuration || {}]
-              end
-            end
-
-            #
-            # Provide the interface to access item metadata
-            #
-            class NamespaceAccessor
-              include Enumerable
-
-              def initialize(item_name:)
-                @item_name = item_name
-              end
-
-              #
-              # Return the metadata namespace
-              #
-              # @return [OpenHAB::Core::DSL::MonkeyPatch::Items::MetadataItem], or nil if the namespace doesn't exist
-              #
-              def [](namespace)
-                logger.trace("Namespaces (#{NamespaceAccessor.registry.getAll})")
-                logger.trace("Namespace (#{NamespaceAccessor.registry.get(MetadataKey.new(namespace, @item_name))})")
-                metadata = NamespaceAccessor.registry.get(MetadataKey.new(namespace, @item_name))
-                MetadataItem.new(metadata: metadata) if metadata
-              end
-
-              #
-              # Set the metadata namespace. If the namespace does not exist, it will be created
-              #
-              # @param value [Object] The assigned value can be a OpenHAB::Core::DSL::MonkeyPatch::Items::MetadataItem,
-              # Java::Org::openhab::core::items::Metadata, Array[2] of [value, configuration],
-              # A String to set the value and clear the configuration,
-              # or a Hash to set the configuration and set the value to nil
-              #
-              # @return [OpenHAB::Core::DSL::MonkeyPatch::Items::MetadataItem]
-              #
-              def []=(namespace, value)
-                meta_value, configuration = update_from_value(value)
-
-                key = MetadataKey.new(namespace, @item_name)
-                metadata = Metadata.new(key, meta_value, configuration)
-                # registry.get can be omitted, but registry.update will log a warning for nonexistent metadata
-                if NamespaceAccessor.registry.get(key)
-                  NamespaceAccessor.registry.update(metadata)
-                else
-                  NamespaceAccessor.registry.add(metadata)
-                end
-              end
-
-              #
-              # Enumerates through all the namespaces
-              #
-              def each
-                return unless block_given?
-
-                NamespaceAccessor.registry.getAll.each do |meta|
-                  yield meta.uID.namespace, meta.value, meta.configuration if meta.uID.itemName == @item_name
-                end
-              end
-
-              #
-              # Remove all the namespaces
-              #
-              def clear
-                NamespaceAccessor.registry.removeItemMetadata @item_name
-              end
-
-              #
-              # Delete a specific namespace
-              #
-              # @param namespace [String] The namespace to delete
-              #
-              def delete(namespace)
-                NamespaceAccessor.registry.remove(MetadataKey.new(namespace, @item_name))
-              end
-
-              alias delete_all clear
-
-              #
-              # @return [Boolean] True if the given namespace exists, false otherwise
-              #
-              def key?(namespace)
-                !NamespaceAccessor.registry.get(MetadataKey.new(namespace, @item_name)).nil?
-              end
-
-              alias has_key? key?
-              alias include? key?
-
-              #
-              # Merge the given hash with the current metadata. Existing namespace that matches the name
-              # of the new namespace will be overwritten. Others will be added.
-              #
-              def merge!(*others)
-                return self if others.empty?
-
-                others.each do |other|
-                  case other
-                  when Hash then merge_hash!(other)
-                  when self.class then merge_metadata!(other)
-                  else raise ArgumentError, "merge only supports Hash, or another item's metadata"
-                  end
-                end
-                self
-              end
-
-              #
-              # @return [String] the string representation of all the namespaces with their value and config
-              #
-              def to_s
-                namespaces = []
-                each { |ns, value, config| namespaces << "\"#{ns}\"=>[\"#{value}\",#{config}]" }
-                "{#{namespaces.join(',')}}"
-              end
-
-              #
-              # @return [Java::org::openhab::core::items::MetadataRegistry]
-              #
-              def self.registry
-                @registry ||= OpenHAB::OSGI.service('org.openhab.core.items.MetadataRegistry')
-              end
-
-              private
-
-              #
-              # perform an updated based on the supplied value
-              #
-              # @param [MetadataItem,Metadata,Array,Hash] value to perform update from
-              #
-              # @return [Array<Object,Hash>] Array containing the value and configuration based on the
-              #   the supplied object
-              #
-              def update_from_value(value)
-                case value
-                when MetadataItem then [value.value, value.__getobj__]
-                when Metadata then [value.value, value.configuration]
-                when Array
-                  raise ArgumentError, 'Array must contain 2 elements: value, config' if value.length != 2
-
-                  value
-                when Hash then [nil, value]
-                else [value, nil]
-                end
-              end
-
-              #
-              # Merge the metadata from the supplied other metadata object
-              #
-              # @param [Hash] other metadata object to merge
-              # @yield [key, current_metadata, new_meta] to process merge
-              #
-              #
-              def merge_metadata!(other)
-                other.each do |key, new_value, new_config|
-                  new_meta = new_value, new_config
-                  if block_given?
-                    current_meta = self[key]&.to_a
-                    new_meta = yield key, current_meta, new_meta unless current_meta.nil?
-                  end
-                  self[key] = new_meta
-                end
-              end
-
-              #
-              # Merge a hash into the metadata
-              #
-              # @param [Hash] other to merge into metadata
-              # @yield [key, current_metadata, new_meta] to process merge
-              #
-              #
-              def merge_hash!(other)
-                other.each do |key, new_meta|
-                  if block_given?
-                    current_meta = self[key]&.to_a
-                    new_meta = yield key, current_meta, new_meta unless current_meta.nil?
-                  end
-                  self[key] = new_meta
-                end
-              end
-            end
-
-            #
-            # Accessor to the item's metadata
-            #
-            # @return [NamespaceAccessor] an Enumerable object to access item's namespaces
-            #
-            def meta
-              @meta ||= NamespaceAccessor.new(item_name: name)
-            end
-            alias metadata meta
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,72 +0,0 @@
-# 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/monkey_patch/items/switch_item.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-java_import org.openhab.core.library.items.SwitchItem
-
-# Alias class names for easy is_a? comparisons
-Switch = SwitchItem
-
-#
-# Monkeypatching SwitchItem to add Ruby Support methods
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryItems::SwitchItem
-  java_import org.openhab.core.library.types.OnOffType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # Send the OFF command to the switch
-  #
-  #
-  def off
-    command(OnOffType::OFF)
-  end
-
-  #
-  # Send the OFF command to the switch
-  #
-  #
-  def on
-    command(OnOffType::ON)
-  end
-
-  #
-  # Check if a switch is on
-  #
-  # @return [Boolean] True if the switch is on, false otherwise
-  #
-  def on?
-    state? && state == OnOffType::ON
-  end
-
-  alias truthy? on?
-
-  #
-  # Check if a switch is off
-  #
-  # @return [Boolean] True if the switch is off, false otherwise
-  #
-  def off?
-    state? && state == OnOffType::OFF
-  end
-
-  #
-  # Send a command to invert the state of the switch
-  #
-  # @return [OnOffType] Inverted state
-  #
-  def toggle
-    self << !self
-  end
-
-  #
-  # Return the inverted state of the switch: ON if the switch is OFF, UNDEF or NULL; OFF if the switch is ON
-  #
-  # @return [OnOffType] Inverted state
-  #
-  def !
-    return !state if state?
-
-    OnOffType::ON
-  end
-
-  #
-  # Check for equality against supplied object
-  #
-  # @param [Object] other object to compare to
-  #
-  # @return [Boolean] True if other is a OnOffType and other equals state for this switch item,
-  #   otherwise result from super
-  #
-  def ==(other)
-    if other.is_a? OnOffType
-      state? && state == other
-    else
-      super
-    end
-  end
-end

data/lib/openhab/core/dsl/monkey_patch/ruby/number.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module Core
-    module DSL
-      module MonkeyPatch
-        module Ruby
-          #
-          # Extend integer to create duration object
-          #
-          module IntegerExtensions
-            include OpenHAB::Core
-
-            #
-            # Create Duration with the specified unit
-            #
-            # @return [Java::JavaTime::Duration] Duration with number of units from self
-            #
-            %w[millis seconds minutes hours].each do |unit|
-              define_method(unit) { Java::JavaTime::Duration.public_send("of_#{unit}", self) }
-            end
-
-            alias second seconds
-            alias millisecond millis
-            alias milliseconds millis
-            alias ms millis
-            alias minute minutes
-            alias hour hours
-          end
-        end
-      end
-    end
-  end
-end
-
-#
-# Prepend Integer class with duration extensions
-#
-class Integer
-  prepend OpenHAB::Core::DSL::MonkeyPatch::Ruby::IntegerExtensions
-end