openhab-scripting 4.47.0 → 5.0.0

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

@@ -1,326 +0,0 @@
-# frozen_string_literal: true
-
-require 'delegate'
-require 'forwardable'
-require 'openhab/core/osgi'
-require 'openhab/log/logger'
-
-module OpenHAB
-  module DSL
-    module Items
-      #
-      # Metadata extension for Items
-      #
-      module Metadata
-        include OpenHAB::Log
-
-        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_delegator :__getobj__, :to_h, :to_hash
-
-          def initialize(metadata: nil, key: nil, value: nil, config: nil)
-            @metadata = metadata || Metadata.new(key || MetadataKey.new('', ''), value&.to_s, config)
-            super(MetadataItem.to_ruby(@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 [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 [org.openhab.core.items.Metadata] the old metadata
-          #
-          def value=(value)
-            metadata = Metadata.new(@metadata&.uID, value&.to_s, @metadata&.configuration)
-            NamespaceAccessor.registry.update(metadata) if @metadata&.uID
-          end
-
-          #
-          # Set the entire configuration to a hash
-          #
-          # @return [org.openhab.core.items.Metadata] the old metadata
-          #
-          def config=(config)
-            config = config.to_hash if config.respond_to?(:to_hash)
-            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
-
-          #
-          # Recursively convert the supplied Hash object into a Ruby Hash and recreate the keys and values
-          #
-          # @param [Hash] hash to convert
-          #
-          # @return [Hash] The converted hash
-          #
-          def self.to_ruby_hash(hash)
-            return unless hash.respond_to? :each_with_object
-
-            hash.each_with_object({}) { |(key, value), ruby_hash| ruby_hash[to_ruby(key)] = to_ruby(value) }
-          end
-
-          #
-          # Recursively convert the supplied array to a Ruby array and recreate all String values
-          #
-          # @param [Object] array to convert
-          #
-          # @return [Array] The converted array
-          #
-          def self.to_ruby_array(array)
-            return unless array.respond_to? :each_with_object
-
-            array.each_with_object([]) { |value, ruby_array| ruby_array << to_ruby(value) }
-          end
-
-          # Convert the given object to Ruby equivalent
-          def self.to_ruby(value)
-            case value
-            when Hash, java.util.Map then to_ruby_hash(value)
-            when Array, java.util.List then to_ruby_array(value)
-            when String then String.new(value)
-            else value
-            end
-          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::DSL::Items::MetadataItem], or nil if the namespace doesn't exist
-          #
-          def [](namespace)
-            logger.trace("Getting metadata for item: #{@item_name}, namespace '#{namespace}'")
-            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::DSL::Items::MetadataItem,
-          # 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::DSL::Items::MetadataItem]
-          #
-          def []=(namespace, value)
-            meta_value, configuration = update_from_value(value)
-
-            key = MetadataKey.new(namespace, @item_name)
-            metadata = Metadata.new(key, meta_value&.to_s, configuration.to_h)
-            # 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
-
-          #
-          # Implements Hash#dig-like functionaity to metadata
-          #
-          # @param [String] key The first key
-          # @param [Array<String, Symbol>] keys More keys to dig deeper
-          #
-          # @return [OpenHAB::DSL::Items::MetadataItem], or nil if the namespace doesn't exist
-          #
-          def dig(key, *keys)
-            keys.empty? ? self[key]&.value : self[key]&.dig(*keys)
-          end
-
-          #
-          # Enumerates through all the namespaces
-          #
-          def each
-            return unless block_given?
-
-            NamespaceAccessor.registry.getAll.each do |meta|
-              if meta.uID.itemName == @item_name
-                yield meta.uID.namespace, MetadataItem.to_ruby(meta.value), MetadataItem.to_ruby(meta.configuration)
-              end
-            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 [org.openhab.core.items.MetadataRegistry]
-          #
-          def self.registry
-            @registry ||= OpenHAB::Core::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

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/dsl/items/numeric_item'
-
-module OpenHAB
-  module DSL
-    module Items
-      java_import org.openhab.core.library.items.NumberItem
-
-      # Adds methods to core OpenHAB NumberItem type to make it more natural in
-      # Ruby
-      class NumberItem < GenericItem
-        include NumericItem
-      end
-    end
-  end
-end

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-require_relative 'comparable_item'
-require_relative 'item_equality'
-
-module OpenHAB
-  module DSL
-    module Items
-      # Mixin for implementing type coercieon, equality, and arithmetic for
-      # number-like items
-      module NumericItem
-        include Comparable
-        include ComparableItem
-
-        # apply meta-programming methods to including class
-        # @!visibility private
-        def self.included(klass)
-          klass.prepend ItemEquality # make sure this is first
-          klass.extend Forwardable
-          klass.delegate %i[+ - * / % to_d to_f to_i to_int] => :state
-          # remove the JRuby default == so that we can inherit the Ruby method
-          klass.remove_method :==
-        end
-
-        #
-        # Convert state to a Quantity by calling state (DecimalType)#|
-        # Raise a NoMethodError if state is nil (NULL or UNDEF) instead of delegating to it.
-        # because nil#| would return true, causing an unexpected result
-        #
-        # @param [Unit, String] other the unit to convert to
-        #
-        # @return [QuantityType] the QuantityType in the given unit
-        #
-        def |(other)
-          raise NoMethodError, 'State is nil' unless state?
-
-          state.|(other)
-        end
-
-        #
-        # Check if NumericItem is truthy? as per defined by library
-        #
-        # @return [Boolean] True if item is not in state +UNDEF+ or +NULL+ and value is not zero.
-        #
-        def truthy?
-          state && !state.zero?
-        end
-
-        #
-        # Type Coercion
-        #
-        # Coerce object to a NumericType
-        #
-        # @param [Types::NumericType, Numeric] other object to coerce to a
-        #   DateTimeType
-        #
-        # @return [[Types::NumericType, Types::NumericType]]
-        #
-        def coerce(other)
-          logger.trace("Coercing #{self} as a request from #{other.class}")
-          return [other, nil] unless state?
-          return [other, state] if other.is_a?(Types::NumericType) || other.respond_to?(:to_d)
-        end
-
-        # raw numbers translate directly to DecimalType, not a string
-        # @!visibility private
-        def format_type(command)
-          return Types::DecimalType.new(command) if command.is_a?(Numeric)
-
-          super
-        end
-
-        %i[positive? negative? zero?].each do |predicate|
-          class_eval <<~RUBY, __FILE__, __LINE__ + 1
-            def #{predicate}              # def positive?
-              return false unless state?  #   return false unless state?
-                                          #
-              state.#{predicate}          #   state.positive?
-            end                           # end
-          RUBY
-        end
-      end
-    end
-  end
-end