openhab-scripting 4.46.2 → 5.0.0

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

@@ -1,227 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'semantics/enumerable'
-
-module OpenHAB
-  module DSL
-    module Items
-      # Module for implementing semantics helper methods on [GenericItem]
-      #
-      # Wraps https://www.openhab.org/javadoc/latest/org/openhab/core/model/script/actions/semantics,
-      # as well as adding a few additional convenience methods.
-      # Also includes Classes for each semantic tag.
-      #
-      # Be warned that the Semantic model is stricter than can actually be
-      # described by tags and groups on an Item. It makes assumptions that any
-      # given item only belongs to one semantic type (Location, Equipment, Point).
-      #
-      # See https://github.com/openhab/openhab-core/blob/main/bundles/org.openhab.core.semantics/model/SemanticTags.csv
-      module Semantics
-        # @!visibility private
-        # import the actual semantics action
-        SemanticsAction = org.openhab.core.model.script.actions.Semantics
-        private_constant :SemanticsAction
-
-        # import all the semantics constants
-        [org.openhab.core.semantics.model.point.Points,
-         org.openhab.core.semantics.model.property.Properties,
-         org.openhab.core.semantics.model.equipment.Equipments,
-         org.openhab.core.semantics.model.location.Locations].each do |parent_tag|
-          parent_tag.stream.for_each do |tag|
-            const_set(tag.simple_name.to_sym, tag.ruby_class)
-          end
-        end
-
-        # put ourself into the global namespace, replacing the action
-        ::Semantics = self # rubocop:disable Naming/ConstantName
-
-        # Checks if this Item is a Location
-        #
-        # This is implemented as checking if the item's semantic_type
-        # is a Location. I.e. an Item has a single semantic_type.
-        #
-        # @return [true, false]
-        def location?
-          SemanticsAction.location?(self)
-        end
-
-        # Checks if this Item is an Equipment
-        #
-        # This is implemented as checking if the item's semantic_type
-        # is an Equipment. I.e. an Item has a single semantic_type.
-        #
-        # @return [true, false]
-        def equipment?
-          SemanticsAction.equipment?(self)
-        end
-
-        # Checks if this Item is a Point
-        #
-        # This is implemented as checking if the item's semantic_type
-        # is a Point. I.e. an Item has a single semantic_type.
-        #
-        # @return [true, false]
-        def point?
-          SemanticsAction.point?(self)
-        end
-
-        # Checks if this Item has any semantic tags
-        # @return [true, false]
-        def semantic?
-          !!semantic_type
-        end
-
-        # Gets the related Location Item of this Item.
-        #
-        # Checks ancestor groups one level at a time, returning the first Location Item found.
-        #
-        # @return [GenericItem, nil]
-        def location
-          SemanticsAction.get_location(self)
-        end
-
-        # Returns the sub-class of [Location] related to this Item.
-        #
-        # In other words, the semantic_type of this Item's Location.
-        #
-        # @return [Class]
-        def location_type
-          SemanticsAction.get_location_type(self)&.ruby_class
-        end
-
-        # Gets the related Equipment Item of this Item.
-        #
-        # Checks ancestor groups one level at a time, returning the first Equipment Item found.
-        #
-        # @return [GenericItem, nil]
-        def equipment
-          SemanticsAction.get_equipment(self)
-        end
-
-        # Returns the sub-class of [Equipment] related to this Item.
-        #
-        # In other words, the semantic_type of this Item's Equipment.
-        #
-        # @return [Class]
-        def equipment_type
-          SemanticsAction.get_equipment_type(self)&.ruby_class
-        end
-
-        # Returns the sub-class of [Point] this Item is tagged with.
-        #
-        # @return [Class]
-        def point_type
-          SemanticsAction.get_point_type(self)&.ruby_class
-        end
-
-        # Returns the sub-class of [Property] this Item is tagged with.
-        # @return [Class]
-        def property_type
-          SemanticsAction.get_property_type(self)&.ruby_class
-        end
-
-        # Returns the sub-class of [Tag] this Item is tagged with.
-        #
-        # It will only return the first applicable Tag, preferring
-        # a sub-class of [Location], [Equipment], or [Point] first,
-        # and if none of those are found, looks for a [Property].
-        # @return [Class]
-        def semantic_type
-          SemanticsAction.get_semantic_type(self)&.ruby_class
-        end
-
-        # Return the related Point Items.
-        #
-        # Searches this Equipment Item for Points that are tagged appropriately.
-        #
-        # If called on a Point Item, it will automatically search for sibling Points
-        # (and remove itself if found).
-        #
-        # @example Get all points for a TV
-        #   eGreatTV.points
-        # @example Search an Equipment item for its switch
-        #   eGuestFan.points(Semantics::Switch) # => [GuestFan_Dimmer]
-        # @example Search a Thermostat item for its current temperature item
-        #   eFamilyThermostat.points(Semantics::Status, Semantics::Temperature)
-        #   # => [FamilyThermostat_AmbTemp]
-        # @example Search a Thermostat item for is setpoints
-        #   eFamilyThermostat.points(Semantics::Control, Semantics::Temperature)
-        #   # => [FamilyThermostat_HeatingSetpoint, FamilyThermostat_CoolingSetpoint]
-        # @example Given a A/V receiver's input item, search for its power item
-        #   FamilyReceiver_Input.points(Semantics::Switch) # => [FamilyReceiver_Switch]
-        #
-        # @param [Class] point_or_property_types
-        #   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>]
-        def points(*point_or_property_types)
-          return members.points(*point_or_property_types) if equipment? || location?
-
-          # automatically search the parent equipment (or location?!) for sibling points
-          result = (equipment || location)&.points(*point_or_property_types) || []
-          # remove self. but avoid state comparisons
-          result.delete_if { |item| item.eql?(self) }
-        end
-      end
-    end
-  end
-end
-
-# Additions to Enumerable to allow easily filtering groups of items based on the semantic model
-module Enumerable
-  # Returns a new array of items that are a semantics Location (optionally of the given type)
-  def locations(type = nil)
-    if type && !(type < OpenHAB::DSL::Items::Semantics::Location)
-      raise ArgumentError, 'type must be a subclass of Location'
-    end
-
-    result = select(&:location?)
-    result.select! { |i| i.location_type <= type } if type
-
-    result
-  end
-  # @deprecated Please use {#locations}
-  alias sublocations locations
-
-  # Returns a new array of items that are a semantics equipment (optionally of the given type)
-  #
-  # @example Get all TVs in a room
-  #   lGreatRoom.equipments(Semantics::Screen)
-  def equipments(type = nil)
-    if type && !(type < OpenHAB::DSL::Items::Semantics::Equipment)
-      raise ArgumentError, 'type must be a subclass of Equipment'
-    end
-
-    result = select(&:equipment?)
-    result.select! { |i| i.equipment_type <= type } if type
-
-    result
-  end
-
-  # Returns a new array of items that are semantics points (optionally of a given type)
-  #
-  # @example Get all the power switch items for every equipment in a room
-  #   lGreatRoom.equipments.points(Semantics::Switch)
-  def points(*point_or_property_types) # rubocop:disable Metrics
-    unless (0..2).cover?(point_or_property_types.length)
-      raise ArgumentError, "wrong number of arguments (given #{point_or_property_types.length}, expected 0..2)"
-    end
-    unless point_or_property_types.all? do |tag|
-             tag < OpenHAB::DSL::Items::Semantics::Point || tag < OpenHAB::DSL::Items::Semantics::Property
-           end
-      raise ArgumentError, 'point_or_property_types must all be a subclass of Point or Property'
-    end
-    if point_or_property_types.count { |tag| tag < OpenHAB::DSL::Items::Semantics::Point } > 1 ||
-       point_or_property_types.count { |tag| tag < OpenHAB::DSL::Items::Semantics::Property } > 1
-      raise ArgumentError, 'point_or_property_types cannot both be a subclass of Point or Property'
-    end
-
-    select do |point|
-      point.point? && point_or_property_types.all? do |tag|
-        (tag < OpenHAB::DSL::Items::Semantics::Point && point.point_type <= tag) ||
-          (tag < OpenHAB::DSL::Items::Semantics::Property && point.property_type&.<=(tag))
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-require 'openhab/dsl/items/comparable_item'
-
-module OpenHAB
-  module DSL
-    module Items
-      java_import org.openhab.core.library.items.StringItem
-
-      # Adds methods to core OpenHAB StringItem type to make it more natural in
-      # Ruby
-      class StringItem < GenericItem
-        extend Forwardable
-        include Comparable
-        include ComparableItem
-
-        remove_method :==
-
-        # @return [Regex] Regular expression matching blank strings
-        BLANK_RE = /\A[[:space:]]*\z/.freeze
-        private_constant :BLANK_RE
-
-        #
-        # 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 state?
-
-          state.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?
-          state? && !blank?
-        end
-
-        # any method that exists on String gets forwarded to state (which will forward as
-        # necessary)
-        delegate (String.instance_methods - instance_methods) => :state
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    #
-    # Patches OpenHAB items
-    #
-    module Items
-      java_import org.openhab.core.library.items.SwitchItem
-
-      # Alias class names for easy is_a? comparisons
-      ::Switch = SwitchItem
-
-      # Adds methods to core OpenHAB SwitchItem type to make it more natural in
-      # Ruby
-      class SwitchItem < GenericItem
-        remove_method :==
-
-        def truthy?
-          on?
-        end
-
-        # Convert boolean commands to ON/OFF
-        # @!visibility private
-        def format_type(command)
-          return Types::OnOffType.from(command) if [true, false].include?(command)
-
-          super
-        end
-
-        #
-        # Send a command to invert the state of the switch
-        #
-        # @return [Types::OnOffType] Inverted state
-        #
-        def toggle
-          command(!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 [Types::OnOffType] Inverted state
-        #
-        def !
-          return !state if state?
-
-          ON
-        end
-
-        # @!method on?
-        #   Check if the item state == +ON+
-        #   @return [Boolean]
-
-        # @!method off?
-        #   Check if the item state == +OFF+
-        #   @return [Boolean]
-
-        # @!method on
-        #   Send the +ON+ command to the item
-        #   @return [SwitchItem] +self+
-
-        # @!method off
-        #   Send the +OFF+ command to the item
-        #   @return [SwitchItem] +self+
-      end
-    end
-  end
-end

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

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

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB actions
-      #
-      module Actions
-        begin
-          # openHAB 3.3 uses ScriptThingActionsImpl
-          java_import Java::OrgOpenhabCoreAutomationModuleScriptInternalDefaultscope::ScriptThingActionsImpl
-        rescue NameError
-          # openHAB 3.2 uses ScriptThingActions
-          java_import Java::OrgOpenhabCoreAutomationModuleScriptInternalDefaultscope::ScriptThingActions
-          ScriptThingActionsImpl = ScriptThingActions
-        end
-
-        #
-        # MonkeyPatching ScriptThingActions
-        #
-        class ScriptThingActionsImpl
-          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
-            self.class.THING_ACTIONS_MAP.keys
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/dsl/monkey_patch/events/item_event'
-require 'openhab/dsl/monkey_patch/events/item_state'
-require 'openhab/dsl/monkey_patch/events/item_state_changed'
-require 'openhab/dsl/monkey_patch/events/item_command'
-require 'openhab/dsl/monkey_patch/events/thing_status_info'

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

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'item_event'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB events
-      #
-      module Events
-        java_import org.openhab.core.items.events.ItemCommandEvent
-
-        # Adds methods to core OpenHAB ItemCommandEvent to make it more natural in Ruby
-        class ItemCommandEvent < ItemEvent
-          # @return [Type]
-          alias command item_command
-
-          # @!method refresh?
-          #   Check if == +REFRESH+
-          #   @return [Boolean]
-
-          # @!method on?
-          #   Check if == +ON+
-          #   @return [Boolean]
-
-          # @!method off?
-          #   Check if == +OFF+
-          #   @return [Boolean]
-
-          # @!method up?
-          #   Check if == +UP+
-          #   @return [Boolean]
-
-          # @!method down?
-          #   Check if == +DOWN+
-          #   @return [Boolean]
-
-          # @!method stop?
-          #   Check if == +STOP+
-          #   @return [Boolean]
-
-          # @!method move?
-          #   Check if == +MOVE+
-          #   @return [Boolean]
-
-          # @!method increase?
-          #   Check if == +INCREASE+
-          #   @return [Boolean]
-
-          # @!method decrease?
-          #   Check if == +DECREASE+
-          #   @return [Boolean]
-
-          # @!method play?
-          #   Check if == +PLAY+
-          #   @return [Boolean]
-
-          # @!method pause?
-          #   Check if == +PAUSE+
-          #   @return [Boolean]
-
-          # @!method rewind?
-          #   Check if == +REWIND+
-          #   @return [Boolean]
-
-          # @!method fast_forward?
-          #   Check if == +FASTFORWARD+
-          #   @return [Boolean]
-
-          # @deprecated
-          # @!parse alias fastforward? fast_forward?
-
-          # @!method next?
-          #   Check if == +NEXT+
-          #   @return [Boolean]
-
-          # @!method previous?
-          #   Check if == +PREVIOUS+
-          #   @return [Boolean]
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB events
-      #
-      module Events
-        java_import org.openhab.core.items.events.ItemEvent
-
-        #
-        # Adds methods to core OpenHAB ItemEvent to make it more natural in Ruby
-        #
-        class ItemEvent
-          #
-          # The triggering item
-          #
-          # @return [GenericItem]
-          #
-          def item
-            OpenHAB::Core::EntityLookup.lookup_item(item_name)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/dsl/types/un_def_type'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB events
-      #
-      module Events
-        java_import org.openhab.core.items.events.ItemStateEvent
-
-        # Helpers common to ItemStateEvent and ItemStateChangedEvent
-        module ItemState
-          #
-          # Check if the state == UNDEF
-          #
-          # @return [Boolean] True if the state is UNDEF, false otherwise
-          #
-          def undef?
-            item_state == UNDEF
-          end
-
-          #
-          # Check if the state == NULL
-          #
-          # @return [Boolean] True if the state is NULL, false otherwise
-          def null?
-            item_state == NULL
-          end
-
-          #
-          # Check if the state is defined (not UNDEF or NULL)
-          #
-          # @return [Boolean] True if state is not UNDEF or NULL
-          #
-          def state?
-            !item_state.is_a?(Types::UnDefType)
-          end
-
-          #
-          # Get the item state
-          #
-          # @return [Types::PrimitiveState] OpenHAB state if state is not UNDEF or NULL, nil otherwise
-          #
-          def state
-            item_state if state?
-          end
-        end
-
-        #
-        # Adds methods to core OpenHAB ItemStateEvent to make it more natural in Ruby
-        #
-        class ItemStateEvent < ItemEvent
-          include ItemState
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/dsl/types/un_def_type'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB events
-      #
-      module Events
-        java_import org.openhab.core.items.events.ItemStateChangedEvent
-
-        #
-        # Adds methods to core OpenHAB ItemStateChangedEvent to make it more natural in Ruby
-        #
-        class ItemStateChangedEvent < ItemEvent
-          include ItemState
-
-          #
-          # Check if state was == UNDEF
-          #
-          # @return [Boolean] True if the state is UNDEF, false otherwise
-          #
-          def was_undef?
-            old_item_state == UNDEF
-          end
-
-          #
-          # Check if state was == NULL
-          #
-          # @return [Boolean] True if the state is NULL, false otherwise
-          def was_null?
-            old_item_state == NULL
-          end
-
-          #
-          # Check if state was defined (not UNDEF or NULL)
-          #
-          # @return [Boolean] True if state is not UNDEF or NULL
-          #
-          def was?
-            !old_item_state.is_a?(Types::UnDefType)
-          end
-
-          #
-          # Get the previous item state
-          #
-          # @return [Types::Type] OpenHAB state if state was not UNDEF or NULL, nil otherwise
-          #
-          def was
-            old_item_state if was?
-          end
-          # @deprecated
-          alias last was
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB events
-      #
-      module Event
-        java_import org.openhab.core.thing.events.ThingStatusInfoChangedEvent
-        java_import org.openhab.core.thing.events.ThingStatusInfoEvent
-        #
-        # Monkey patch with ruby style accessors
-        #
-        class ThingStatusInfoChangedEvent
-          alias uid get_thing_uid
-          alias last get_old_status_info
-          alias status status_info
-        end
-
-        #
-        # Monkey patch with ruby style accessors
-        #
-        class ThingStatusInfoEvent
-          alias uid get_thing_uid
-          alias status status_info
-        end
-      end
-    end
-  end
-end

data/lib/openhab/dsl/monkey_patch/java/java.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'local_time'
-require_relative 'zoned_date_time'