openhab-scripting 2.23.0 → 2.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b38e635249a2d0e8633e75504eb3e42f79399d1e66b90f5242f3dc8062c711b
-  data.tar.gz: dcb573a627b8f93d5a4f6e1bbb8e9b8033f4765b33e49ab88d07414e055b5e7f
+  metadata.gz: 1af0c9d15b41ac54e58540ccab079a6c084931abf80f5add687511d332d3afa2
+  data.tar.gz: 5e3c341ecf96ab4fb11b6ca6cefae01a27dc02b2498e9e3896ef4683baa3f6e5
 SHA512:
-  metadata.gz: c6b8e1f865bf8912e0575495c0539e96acd5f7c8dc77582ab355bee6e5def4e45701cf159d77b12fe7975cb8493fafbcc0260706f2bd500fddeecf4a66683e5e
-  data.tar.gz: fb3c37bf6fdd9f9f95feb26e39e44cd336b7da07a4831e1d3b8079bcbac0f57c005c7324e683dbcb5baa67c60124e947e965edb88b3f8a43a51f03e29fa383a9
+  metadata.gz: e0238451b9d78d45c225f98ede7b86580e26c7c3edfc7681f6942b7f5a7c4dbfb67f98c5c76ccf8a437cfa779bfa2eb9b0c8639b1c4a24206b99b8ca80a3803f
+  data.tar.gz: 616d30281aef1da66964cba5d1c6365b24939f4fbec3070e4251551e3c8c7552191835da12e4795d5698e9671add7739a411e53e7b347de65a8b4a9c0fb249a0

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

@@ -4,6 +4,7 @@ require 'forwardable'
 require 'java'
 require 'time'
 require 'openhab/dsl/types/datetime'
+require 'openhab/dsl/items/item_delegate'
 
 module OpenHAB
   module DSL
@@ -16,6 +17,7 @@ module OpenHAB
       class DateTimeItem
         extend Forwardable
         include Comparable
+        include OpenHAB::DSL::Items::ItemDelegate
 
         def_delegator :@datetime_item, :to_s
 
@@ -27,6 +29,8 @@ module OpenHAB
         #
         def initialize(datetime_item)
           @datetime_item = datetime_item
+          item_delegate { @datetime_item }
+          item_delegate { to_dt }
         end
 
         #
@@ -61,36 +65,6 @@ module OpenHAB
         def zone
           to_dt.zone if state?
         end
-
-        #
-        # Check if missing method can be delegated to other contained objects
-        #
-        # @param [String, Symbol] meth The method name to check for
-        #
-        # @return [Boolean] true if DateTimeItem or DateTime responds to the method, false otherwise
-        #
-        def respond_to_missing?(meth, *)
-          @datetime_item.respond_to?(meth) || to_dt.respond_to?(meth)
-        end
-
-        #
-        # Forward missing methods to the OpenHAB Item, or a DateTime object wrapping its state
-        #
-        # @param [String] meth method name
-        # @param [Array] args arguments for method
-        # @param [Proc] block <description>
-        #
-        # @return [Object] Value from delegated method in OpenHAB NumberItem
-        #
-        def method_missing(meth, *args, &block)
-          if @datetime_item.respond_to?(meth)
-            @datetime_item.__send__(meth, *args, &block)
-          elsif state?
-            to_dt.send(meth, *args, &block)
-          else
-            raise NoMethodError, "undefined method `#{meth}' for #{self.class}"
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'java'
+require 'openhab/log/logger'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Holds methods to delegate to items
+      #
+      module ItemDelegate
+        include OpenHAB::Log
+
+        #
+        # Delegates methods to the object returned from the supplied block if
+        #   they don't exist in the object this is included in.  If the supplied block returns nil, no delegation occurs
+        # If this item is called more than once delegation occurs in the order of invocation, i.e. the object returned
+        #   by the first block is delegated to if it responds to the missing method,
+        #   then the second block is processed, etc.
+        #
+        # @param [Proc] &delegate delgegate block
+        #
+        #
+        def item_delegate(&delegate)
+          @delegates ||= []
+          @delegates << delegate
+        end
+
+        #
+        # Delegate missing method calls to delegates supplied to item_delgate method
+        #  if no delegates exist or respond to missing method, super is invoked which will
+        #  throw the appropriate method missing error
+        #
+        # @param [String] meth misisng method
+        # @param [Array] *args Arguments to the missing method
+        # @param [Proc] &block supplied to the missing method
+        #
+        # @return [Object] Result of missing method invocation
+        #
+        def method_missing(meth, *args, &block)
+          logger.trace("Method (#{meth}) missing for item #{self.class}")
+          delegate = delegate_for(meth)
+          if delegate
+            logger.trace("Delegating #{meth} to #{delegate.class}")
+            delegate.__send__(meth, *args, &block)
+          else
+            super
+          end
+        end
+
+        #
+        # Checks if any of the supplied delgates respond to a specific method
+        #
+        # @param [String] meth method to check for
+        # @param [Boolean] _include_private if private methods should be checked
+        #
+        # @return [Boolean] True if any delegates respond to method, false otherwise
+        #
+        def respond_to_missing?(meth, _include_private = false)
+          logger.trace("Checking if (#{self.class}) responds to (#{meth})")
+          responds = !delegate_for(meth).nil?
+          logger.trace("(#{self.class}) responds to (#{meth}) (#{responds})")
+          responds
+        end
+
+        private
+
+        #
+        # Find a delegate for the supplied method
+        #
+        # @param [String] meth method to find delegate for
+        #
+        # @return [Boolean] True if any method responds to the supplied delegate, false otherwise
+        #
+        def delegate_for(meth)
+          (@delegates || []).each do |delegate_block|
+            delegate = delegate_block.call(meth)
+            logger.trace("Checking if delegate (#{delegate.class}) responds to (#{meth})")
+            if delegate.respond_to? meth
+              logger.trace("Delegate (#{delegate.class}) found for method (#{meth})")
+              return delegate
+            end
+          end
+          logger.trace("No delegate found for method (#{meth})")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ require 'bigdecimal'
 require 'forwardable'
 require 'java'
 require 'openhab/dsl/types/quantity'
+require 'openhab/dsl/items/item_delegate'
 
 module OpenHAB
   module DSL
@@ -17,6 +18,8 @@ module OpenHAB
       class NumberItem < Numeric
         extend Forwardable
 
+        include OpenHAB::DSL::Items::ItemDelegate
+
         def_delegator :@number_item, :to_s
 
         java_import org.openhab.core.library.types.DecimalType
@@ -31,6 +34,7 @@ module OpenHAB
         #
         def initialize(number_item)
           @number_item = number_item
+          item_delegate { @number_item }
           super()
         end
 
@@ -146,40 +150,6 @@ module OpenHAB
           @number_item.dimension
         end
 
-        #
-        # Forward missing methods to Openhab Number Item if they are defined
-        #
-        # @param [String] meth method name
-        # @param [Array] args arguments for method
-        # @param [Proc] block <description>
-        #
-        # @return [Object] Value from delegated method in OpenHAB NumberItem
-        #
-        def method_missing(meth, *args, &block)
-          logger.trace("Method missing, performing dynamic lookup for: #{meth}")
-          if @number_item.respond_to?(meth)
-            @number_item.__send__(meth, *args, &block)
-          elsif ::Kernel.method_defined?(meth) || ::Kernel.private_method_defined?(meth)
-            ::Kernel.instance_method(meth).bind_call(self, *args, &block)
-          else
-            super(meth, *args, &block)
-          end
-        end
-
-        #
-        # Checks if this method responds to the missing method
-        #
-        # @param [String] method_name Name of the method to check
-        # @param [Boolean] _include_private boolean if private methods should be checked
-        #
-        # @return [Boolean] true if this object will respond to the supplied method, false otherwise
-        #
-        def respond_to_missing?(method_name, _include_private = false)
-          @number_item.respond_to?(method_name) ||
-            ::Kernel.method_defined?(method_name) ||
-            ::Kernel.private_method_defined?(method_name)
-        end
-
         %w[+ - * /].each do |operation|
           define_method(operation) do |other|
             logger.trace("Execution math operation '#{operation}' on #{inspect} with #{other.inspect}")

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

@@ -3,6 +3,7 @@
 require 'forwardable'
 require 'java'
 require 'openhab/dsl/items/item_command'
+require 'openhab/dsl/items/item_delegate'
 
 module OpenHAB
   module DSL
@@ -13,6 +14,7 @@ module OpenHAB
       class RollershutterItem < Numeric
         extend Forwardable
         extend OpenHAB::DSL::Items::ItemCommand
+        include OpenHAB::DSL::Items::ItemDelegate
         include Comparable
 
         def_delegator :@rollershutter_item, :to_s
@@ -35,6 +37,9 @@ module OpenHAB
           logger.trace("Wrapping #{rollershutter_item}")
           @rollershutter_item = rollershutter_item
 
+          item_delegate { @rollershutter_item }
+          item_delegate { position }
+
           super()
         end
 
@@ -79,19 +84,6 @@ module OpenHAB
           end
         end
 
-        #
-        # Case equality
-        #
-        # @param [Java::OrgOpenhabCoreLibraryTypes::UpDownType, Numeric] other Other object to compare against
-        #
-        # @return [Boolean] true if self can be defined as other, false otherwise
-        #
-        def ===(other)
-          super unless other.is_a? UpDownType
-
-          state.as(UpDownType).equals(other)
-        end
-
         #
         # Define math operations
         #
@@ -101,38 +93,6 @@ module OpenHAB
             left.send(operator, right)
           end
         end
-
-        #
-        # Checks if this method responds to the missing method
-        #
-        # @param [String] meth Name of the method to check
-        # @param [Boolean] _include_private boolean if private methods should be checked
-        #
-        # @return [Boolean] true if this object will respond to the supplied method, false otherwise
-        #
-        def respond_to_missing?(meth, _include_private = false)
-          @rollershutter_item.respond_to?(meth) || position.respond_to?(meth)
-        end
-
-        #
-        # Forward missing methods to Openhab RollershutterItem or the PercentType representing it's state
-        #   if they are defined
-        #
-        # @param [String] meth method name
-        # @param [Array] args arguments for method
-        # @param [Proc] block <description>
-        #
-        # @return [Object] Value from delegated method in OpenHAB NumberItem
-        #
-        def method_missing(meth, *args, &block)
-          if @rollershutter_item.respond_to?(meth)
-            @rollershutter_item.__send__(meth, *args, &block)
-          elsif position.respond_to?(meth)
-            position.__send__(meth, *args, &block)
-          else
-            raise NoMethodError, "No method `#{meth}' defined for #{self.class}"
-          end
-        end
       end
     end
   end

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

@@ -3,6 +3,7 @@
 require 'bigdecimal'
 require 'forwardable'
 require 'java'
+require 'openhab/dsl/items/item_delegate'
 
 module OpenHAB
   module DSL
@@ -12,7 +13,9 @@ module OpenHAB
       #
       class StringItem
         extend Forwardable
+
         include Comparable
+        include OpenHAB::DSL::Items::ItemDelegate
 
         # @return [Regex] Regular expression matching blank strings
         BLANK_RE = /\A[[:space:]]*\z/.freeze
@@ -27,6 +30,10 @@ module OpenHAB
         #
         def initialize(string_item)
           @string_item = string_item
+
+          item_delegate { @string_item }
+          item_delegate { @string_item.state&.to_full_string&.to_s }
+
           super()
         end
 
@@ -78,42 +85,6 @@ module OpenHAB
             @string_item.state <=> other
           end
         end
-
-        #
-        # Forward missing methods to Openhab String Item or String representation of the item if they are defined
-        #
-        # @param [String] meth method name
-        # @param [Array] args arguments for method
-        # @param [Proc] block <description>
-        #
-        # @return [Object] Value from delegated method in OpenHAB StringItem or Ruby String
-        #
-        def method_missing(meth, *args, &block)
-          if @string_item.respond_to?(meth)
-            @string_item.__send__(meth, *args, &block)
-          elsif @string_item.state&.to_full_string&.to_s.respond_to?(meth)
-            @string_item.state.to_full_string.to_s.__send__(meth, *args, &block)
-          elsif ::Kernel.method_defined?(meth) || ::Kernel.private_method_defined?(meth)
-            ::Kernel.instance_method(meth).bind_call(self, *args, &block)
-          else
-            super(meth, *args, &block)
-          end
-        end
-
-        #
-        # Checks if this method responds to the missing method
-        #
-        # @param [String] method_name Name of the method to check
-        # @param [Boolean] _include_private boolean if private methods should be checked
-        #
-        # @return [Boolean] true if this object will respond to the supplied method, false otherwise
-        #
-        def respond_to_missing?(method_name, _include_private = false)
-          @string_item.respond_to?(method_name) ||
-            @string_item.state&.to_full_string&.to_s.respond_to?(method_name) ||
-            ::Kernel.method_defined?(method_name) ||
-            ::Kernel.private_method_defined?(method_name)
-        end
       end
     end
   end

data/lib/openhab/dsl/monkey_patch/items/dimmer_item.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'openhab/dsl/items/item_command'
+require 'forwardable'
 
 module OpenHAB
   module DSL
@@ -25,31 +27,13 @@ module OpenHAB
           java_import Java::OrgOpenhabCoreLibraryTypes::DecimalType
           java_import Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
 
-          #
-          # Add the current dimmer value to the supplied object
-          #
-          # @param [Object] other object to add the dimmer value to
-          #
-          # @return [Integer] Current dimmer value plus value of supplied object
-          #
-          def +(other)
-            return unless state?
+          extend Forwardable
+          extend OpenHAB::DSL::Items::ItemCommand
 
-            state.to_big_decimal.intValue + other
-          end
+          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
+          item_command Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
 
-          #
-          # Subtract the supplied object from the current value of the dimmer
-          #
-          # @param [Object] other object to subtract from the dimmer value
-          #
-          # @return [Integer] Current dimmer value minus value of supplied object
-          #
-          def -(other)
-            return unless state?
-
-            state.to_big_decimal.intValue - other
-          end
+          def_delegator :state, :to_s
 
           #
           # Dim the dimmer
@@ -59,17 +43,9 @@ module OpenHAB
           # @return [Integer] level target for dimmer
           #
           def dim(amount = 1)
-            return unless state?
-
-            target = [state.to_big_decimal.intValue - amount, 0].max
-
-            if amount == 1
-              command(IncreaseDecreaseType::DECREASE)
-            else
-              command(target)
-            end
-
-            target
+            [state&.to_big_decimal&.intValue&.-(amount), 0].compact
+                                                           .max
+                                                           .tap { |target| command(target) }
           end
 
           #
@@ -80,16 +56,7 @@ module OpenHAB
           # @return [Integer] level target for dimmer
           #
           def brighten(amount = 1)
-            return unless state?
-
-            target = state.to_big_decimal.intValue + amount
-
-            if amount == 1
-              command(IncreaseDecreaseType::INCREASE)
-            else
-              command(target)
-            end
-            target
+            state&.to_big_decimal&.intValue&.+(amount)&.tap { |target| command(target) }
           end
 
           #
@@ -120,10 +87,8 @@ module OpenHAB
           def coerce(other)
             logger.trace("Coercing #{self} as a request from  #{other.class}")
             case other
-            when Numeric
-              [other, state.to_big_decimal.to_d]
-            else
-              [other, state]
+            when Numeric then [other, state.to_big_decimal.to_d]
+            else [other, state]
             end
           end
 
@@ -140,6 +105,16 @@ module OpenHAB
             (self <=> other).zero?
           end
 
+          #
+          # Define math operations
+          #
+          %i[+ - / *].each do |operator|
+            define_method(operator) do |other|
+              right, left = coerce(other)
+              left.send(operator, right)
+            end
+          end
+
           #
           # Check if dimmer has a state and state is not zero
           #
@@ -159,33 +134,6 @@ module OpenHAB
           end
 
           alias to_int to_i
-
-          #
-          # Return the string representation of the dimmer item
-          #
-          # @return [String] String version of the dimmer value
-          #
-          def to_s
-            to_i.to_s
-          end
-
-          #
-          # Check if dimmer is on
-          #
-          # @return [Boolean] True if item is not UNDEF or NULL and has a value greater than 0
-          #
-          def on?
-            state&.to_big_decimal&.intValue&.positive?
-          end
-
-          #
-          # Check if dimmer is off
-          #
-          # @return [Boolean] True if item is not UNDEF or NULL and has a state of 0
-          #
-          def off?
-            state&.to_big_decimal&.intValue&.zero?
-          end
         end
       end
     end

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '2.23.0'
+  VERSION = '2.23.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 2.23.1
 platform: ruby
 authors:
 - Brian O'Connell
@@ -41,6 +41,7 @@ files:
 - lib/openhab/dsl/group.rb
 - lib/openhab/dsl/items/datetime_item.rb
 - lib/openhab/dsl/items/item_command.rb
+- lib/openhab/dsl/items/item_delegate.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/number_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb