openhab-scripting 2.9.1

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'forwardable'
+require 'java'
+
+module OpenHAB
+  module Core
+    module DSL
+      module Items
+        #
+        # Delegator to OpenHAB String Item
+        #
+        class StringItem
+          extend Forwardable
+          include Comparable
+
+          BLANK_RE = /\A[[:space:]]*\z/.freeze
+          private_constant :BLANK_RE
+
+          def_delegator :@string_item, :to_s
+
+          #
+          # Create a new StringItem
+          #
+          # @param [Java::Org::openhab::core::library::items::StringItem] string_item OpenHAB string item to delegate to
+          #
+          def initialize(string_item)
+            @string_item = string_item
+            super()
+          end
+
+          #
+          # Convert the StringItem into a String
+          #
+          # @return [String] String representation of the StringItem or nil if underlying OpenHAB StringItem does not have a state
+          #
+          def to_str
+            @string_item.state&.to_full_string&.to_s
+          end
+
+          #
+          # Detect if the string is blank (not set or only whitespace)
+          #
+          # @return [Boolean] True if string item is not set or contains only whitespace, false otherwise
+          #
+          def blank?
+            return true unless @string_item.state?
+
+            @string_item.state.to_full_string.to_s.empty? || BLANK_RE.match?(self)
+          end
+
+          #
+          # Check if StringItem is truthy? as per defined by library
+          #
+          # @return [Boolean] True if item is not in state UNDEF or NULL and value is not blank
+          #
+          def truthy?
+            @string_item.state? && blank? == false
+          end
+
+          #
+          # Compare StringItem to supplied object
+          #
+          # @param [Object] other object to compare to
+          #
+          # @return [Integer] -1,0,1 or nil depending on value supplied, nil comparison to supplied object is not possible.
+          #
+          def <=>(other)
+            case other
+            when StringItem
+              @string_item.state <=> other.state
+            when String
+              @string_item.state.to_s <=> 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? && @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
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/dsl/monkey_patch/actions/actions.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Monkey patch actions
+require 'openhab/core/dsl/monkey_patch/actions/script_thing_actions'

data/lib/openhab/core/dsl/monkey_patch/actions/script_thing_actions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'java'
+
+#
+# MonkeyPatching ScriptThingActions
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreAutomationModuleScriptInternalDefaultscope::ScriptThingActions
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  field_reader :THING_ACTIONS_MAP
+
+  #
+  # Fetch keys for all actions defined in OpenHAB
+  #
+  # @return [Set] of keys for defined actions in the form of 'scope-thing_uid'
+  #
+  def action_keys
+    Java::OrgOpenhabCoreAutomationModuleScriptInternalDefaultscope::ScriptThingActions.THING_ACTIONS_MAP.keys
+  end
+end

data/lib/openhab/core/dsl/monkey_patch/events.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'core/dsl/monkey_patch/events/item_state_changed'
+require 'core/dsl/monkey_patch/events/thing_status_info'
+require 'core/dsl/monkey_patch/events/item_command'

data/lib/openhab/core/dsl/monkey_patch/events/item_command.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'java'
+
+#
+# Monkey patch with ruby style accesors
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreItemsEvents::ItemCommandEvent
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  alias command item_command
+end

data/lib/openhab/core/dsl/monkey_patch/events/item_state_changed.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'java'
+
+#
+# MonkeyPatch with ruby style accessors
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreItemsEvents::ItemStateChangedEvent
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  #
+  # Get the item that caused the state change
+  #
+  # @return [Item] Item that caused state change
+  #
+  def item
+    # rubocop:disable Style/GlobalVars
+    $ir.get(item_name)
+    # rubocop:enable Style/GlobalVars
+  end
+
+  alias state item_state
+  alias last old_item_state
+end

data/lib/openhab/core/dsl/monkey_patch/events/thing_status_info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'java'
+
+#
+# Monkey patch with ruby style accessors
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreThingEvents::ThingStatusInfoChangedEvent
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  alias uid get_thing_uid
+  alias last get_old_status_info
+  alias status status_info
+end
+
+#
+# Monkey patch with ruby style accessors
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreThingEvents::ThingStatusInfoEvent
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  alias uid get_thing_uid
+  alias status status_info
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'java'
+
+# Alias for is_a? testing
+java_import org.openhab.core.library.items.ContactItem
+
+#
+# Alias class for ContactItem
+#
+Contact = ContactItem
+
+#
+# Monkey patch Contact Item with Ruby methods
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreLibraryItems::ContactItem
+  java_import org.openhab.core.library.types.OpenClosedType
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  #
+  # Check if the contact is open
+  #
+  # @return [Boolean] True if contact has state and is open, false otherwise
+  #
+  def open?
+    state? && state == OpenClosedType::OPEN
+  end
+
+  #
+  # Check if the contact is closed
+  #
+  # @return [Boolean] True if contact has state and is closed, false otherwise
+  #
+  def closed?
+    state? && state == OpenClosedType::CLOSED
+  end
+
+  #
+  # Compares contacts to OpenClosedTypes
+  #
+  # @param [Object] other object to compare to
+  #
+  # @return [Boolean] True if contact has a state and state equals other, nil if no state,
+  #   result from super if not supplied an OpenClosedType
+  #
+  def ==(other)
+    if other.is_a? OpenClosedType
+      state? && state == other
+    else
+      super
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'java'
+
+java_import org.openhab.core.library.items.DimmerItem
+
+#
+# Alias class for is_a? testing
+#
+Dimmer = DimmerItem
+
+#
+# Monkey Patch DimmerItem
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreLibraryItems::DimmerItem
+  # rubocop:enable Style/ClassAndModuleChildren
+  java_import org.openhab.core.library.types.DecimalType
+  java_import org.openhab.core.library.types.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?
+
+    state.to_big_decimal.intValue + other
+  end
+
+  #
+  # 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
+
+  #
+  # Dim the dimmer
+  #
+  # @param [Integer] amount to dim by
+  #
+  # @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
+  end
+
+  #
+  # Brighten the dimmer
+  #
+  # @param [Integer] amount to brighten by
+  #
+  # @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
+  end
+
+  #
+  # Check if dimmer has a state and state is not zero
+  #
+  # @return [Boolean] True if dimmer is not NULL or UNDEF and value is not 0
+  #
+  def truthy?
+    state? && state != DecimalType::ZERO
+  end
+
+  #
+  # Value of dimmer
+  #
+  # @return [Integer] Value of dimmer or nil if state is UNDEF or NULL
+  #
+  def to_i
+    state&.to_big_decimal&.intValue
+  end
+
+  alias to_int to_i
+
+  #
+  # 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

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+#
+# Monkey patch Group Item
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreItems::GroupItem
+  # rubocop:enable Style/ClassAndModuleChildren
+
+  #
+  # Get all items in a group
+  #
+  # @return [Array] Array of items in the group
+  #
+  def items
+    to_a
+  end
+
+  #
+  # Get all items in the group as an Array
+  #
+  # @return [Array] All items in the group
+  #
+  def to_a
+    all_members.each_with_object([]) { |item, arr| arr << item }
+  end
+end

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'java'
+require 'openhab/core/log'
+require 'bigdecimal'
+
+# Monkey patch items
+require 'openhab/core/dsl/monkey_patch/items/metadata'
+require 'openhab/core/dsl/monkey_patch/items/contact_item'
+require 'openhab/core/dsl/monkey_patch/items/dimmer_item'
+require 'openhab/core/dsl/monkey_patch/items/switch_item'
+require 'openhab/core/dsl/monkey_patch/items/group_item'
+
+module OpenHAB
+  module Core
+    module DSL
+      module MonkeyPatch
+        #
+        # Monkeypatches Items
+        #
+        module Items
+          #
+          # Extensions for Items
+          #
+          module ItemExtensions
+            include Logging
+            java_import org.openhab.core.model.script.actions.BusEvent
+            java_import org.openhab.core.types.UnDefType
+
+            #
+            # Send a command to this item
+            #
+            # @param [Object] command to send to object
+            #
+            #
+            def command(command)
+              command = command.to_java.strip_trailing_zeros if command.is_a? BigDecimal
+              logger.trace "Sending Command #{command} to #{id}"
+              BusEvent.sendCommand(self, command.to_s)
+            end
+
+            alias << command
+
+            #
+            # Send an update to this item
+            #
+            # @param [Object] update the item
+            #
+            #
+            def update(update)
+              logger.trace "Sending Update #{update} to #{id}"
+              BusEvent.postUpdate(self, update.to_s)
+            end
+
+            #
+            # Check if the item state == UNDEF
+            #
+            # @return [Boolean] True if the state is UNDEF, false otherwise
+            #
+            def undef?
+              # Need to explicitly call the super method version because this state will never return UNDEF
+              method(:state).super_method.call == UnDefType::UNDEF
+            end
+
+            #
+            # Check if the item state == NULL
+            #
+            # @return [Boolean] True if the state is NULL, false otherwise
+            def null?
+              # Need to explicitly call the super method version because this state will never return NULL
+              method(:state).super_method.call == UnDefType::NULL
+            end
+
+            #
+            # Check if the item has a state (not UNDEF or NULL)
+            #
+            # @return [Boolean] True if state is not UNDEF or NULL
+            #
+            def state?
+              undef? == false && null? == false
+            end
+
+            #
+            # Get the item state
+            #
+            # @return [State] OpenHAB item state if state is not UNDEF or NULL, nil otherwise
+            #
+            def state
+              super if state?
+            end
+
+            #
+            # Get an ID for the item, using the item label if set, otherwise item name
+            #
+            # @return [String] label if set otherwise name
+            #
+            def id
+              label || name
+            end
+
+            #
+            # Get the string representation of the state of the item
+            #
+            # @return [String] State of the item as a string if not UNDEF or NULL, nil otherwise
+            #
+            def to_s
+              state&.to_s
+            end
+
+            #
+            # Inspect the item
+            #
+            # @return [String] details of the item
+            #
+            def inspect
+              toString
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/ClassAndModuleChildren
+class Java::OrgOpenhabCoreItems::GenericItem
+  # rubocop:enable Style/ClassAndModuleChildren
+  prepend OpenHAB::Core::DSL::MonkeyPatch::Items::ItemExtensions
+  prepend OpenHAB::Core::DSL::MonkeyPatch::Items::Metadata
+end