openhab-scripting 2.16.2 → 2.19.0

data/lib/openhab/core/dsl.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'core/log'
-require 'core/dsl/monkey_patch/events'
-require 'core/dsl/monkey_patch/ruby/ruby'
-require 'core/dsl/monkey_patch/items/items'
-require 'core/dsl/monkey_patch/types/types'
-require 'core/dsl/monkey_patch/actions/actions'
-require 'core/dsl/rule/rule'
-require 'core/dsl/actions'
-require 'core/dsl/timers'
-require 'core/dsl/group'
-require 'core/dsl/things'
-require 'core/dsl/items/items'
-require 'core/dsl/items/number_item'
-require 'core/dsl/time_of_day'
-require 'core/dsl/gems'
-require 'core/dsl/units'
-require 'core/dsl/types/quantity'
-require 'core/dsl/states'
-require 'core/dsl/persistence'
-
-module OpenHAB
-  #
-  #  Holds core functions for OpenHAB Helper Library
-  #
-  module Core
-    #
-    # Module to be extended to access the OpenHAB Ruby DSL
-    #
-    module DSL
-      # Extend the calling module/class with the DSL
-      # rubocop: disable Metrics/MethodLength
-      def self.extended(base)
-        base.send :include, OpenHAB::Core::DSL::Rule
-        base.send :include, OpenHAB::Core::DSL::Items
-        base.send :include, OpenHAB::Core::DSL::Types
-        base.send :include, OpenHAB::Core::DSL::Groups
-        base.send :include, OpenHAB::Core::DSL::Units
-        base.send :include, OpenHAB::Core::DSL::Actions
-        base.send :include, OpenHAB::Core::DSL::Timers
-        base.send :include, OpenHAB::Core::DSL::States
-        base.send :include, OpenHAB::Core::DSL::Tod
-        base.send :include, OpenHAB::Core::DSL::Persistence
-        base.send :include, Things
-      end
-      # rubocop: enable Metrics/MethodLength
-    end
-  end
-end

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

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/osgi'
-
-module OpenHAB
-  module Core
-    module DSL
-      #
-      # Module to import and steramlime access to OpenHAB actions
-      #
-      module Actions
-        java_import org.openhab.core.library.types.PercentType
-        include Logging
-
-        OpenHAB::OSGI.services('org.openhab.core.model.script.engine.action.ActionService')&.each do |service|
-          java_import service.actionClass.to_s
-          logger.trace("Loaded ACTION: #{service.actionClass}")
-        end
-        # Import common actions
-        %w[Exec HTTP Ping].each { |action| java_import "org.openhab.core.model.script.actions.#{action}" }
-
-        #
-        # Return an OpenHAB Action object for the given scope and thing
-        #
-        # @param scope [String] The action scope
-        # @param thing_uid [String] Thing UID
-        #
-        # @return [Object] OpenHAB action
-        #
-        def actions(scope, thing_uid)
-          # rubocop: disable Style/GlobalVars
-          $actions.get(scope, thing_uid)
-          # rubocop: enable Style/GlobalVars
-        end
-
-        #
-        # Gets the list of action objects associated with a specific ThingUID
-        #
-        # @param [Java::org::openhab::core::thing::ThingUID] thing_uid to get associated actions for
-        #
-        # @return [Array] of action objects associated with thing_uid, may be empty
-        #
-        def actions_for_thing(thing_uid)
-          thing_uid = thing_uid.to_s
-          # rubocop: disable Style/GlobalVars
-          action_keys = $actions.action_keys
-          # rubocop: enable Style/GlobalVars
-          logger.trace("Registered actions: '#{action_keys}' for thing '#{thing_uid}'")
-          action_keys.map { |action_key| action_key.split('-', 2) }
-                     .select { |action_pair| action_pair.last == thing_uid }
-                     .map(&:first)
-                     .map { |scope| actions(scope, thing_uid) }
-        end
-
-        #
-        # Send notification to an email or broadcast
-        #
-        # @param msg [String] The notification message to send
-        # @param email [String] The email address to send to. If nil, the message will be broadcasted
-        #
-        # @return [void]
-        #
-        def notify(msg, email: nil)
-          unless defined? NotificationAction
-            raise NoMethodError, 'NotificationAction is not available. Please install the OpenHAB cloud addon'
-          end
-
-          if email
-            NotificationAction.sendNotification email, msg
-          else
-            NotificationAction.sendBroadcastNotification msg
-          end
-        end
-
-        #
-        # Say text via OpenHAB Text-To-Speech service, Voice.say()
-        #
-        # @param text [String] The text to say
-        # @param voice [String] Specify a particular voice to use
-        # @param sink [String] Specify a particular sink to output the speech
-        # @param volume [PercentType] Specify the volume for the speech
-        #
-        # @return [void]
-        #
-        def say(text, voice: nil, sink: nil, volume: nil)
-          volume = PercentType.new(volume&.to_i) unless volume.is_a?(PercentType) || volume.nil?
-          Voice.say text, voice, sink, volume
-        end
-
-        #
-        # Play an audio file via OpenHAB sound service, Audio.playSound()
-        #
-        # @param filename [String] The sound file to play
-        # @param sink [String] Specify a particular sink to output the speech
-        # @param volume [PercentType] Specify the volume for the speech
-        #
-        # @return [void]
-        #
-        def play_sound(filename, sink: nil, volume: nil)
-          volume = PercentType.new(volume&.to_i) unless volume.is_a?(PercentType) || volume.nil?
-          Audio.playSound sink, filename, volume
-        end
-      end
-    end
-  end
-end

data/lib/openhab/core/dsl/entities.rb

@@ -1,147 +0,0 @@
-# frozen_string_literal: true
-
-require 'pp'
-require 'java'
-require 'set'
-require 'core/dsl/group'
-require 'core/log'
-require 'core/dsl/items/number_item'
-require 'core/dsl/items/string_item'
-
-# Automation lookup and injection of OpenHab entities
-java_import org.openhab.core.items.GroupItem
-
-#
-# Implements const_missing to return OpenHAB items or things if mapping to missing name if they exist
-#
-# @param [String] name Capital string that was not set as a constant and to be looked up
-#
-# @return [Object] OpenHAB Item or Thing if their name exist in OpenHAB item and thing regestries
-#
-def Object.const_missing(name)
-  EntityLookup.lookup_item(name) || EntityLookup.lookup_thing(name) || super
-end
-
-#
-# Manages access to OpenHAB entities
-#
-module EntityLookup
-  include Logging
-
-  #
-  # Decorate items with Ruby wrappers
-  #
-  # @param [Array] items Array of items to decorate
-  #
-  # @return [Array] Array of decorated items
-  #
-  def self.decorate_items(*items)
-    items.flatten.map { |item| decorate_item(item) }
-  end
-
-  #
-  # Decorate item with Ruby wrappers
-  #
-  # @param [Object] item the item object to decorate
-  #
-  # @return [Object] the ruby wrapper for the item
-  #
-  def self.decorate_item(item)
-    case item
-    when GroupItem
-      decorate_group(item)
-    when Java::Org.openhab.core.library.items::NumberItem
-      OpenHAB::Core::DSL::Items::NumberItem.new(item)
-    when Java::Org.openhab.core.library.items::StringItem
-      OpenHAB::Core::DSL::Items::StringItem.new(item)
-    else
-      item
-    end
-  end
-
-  #
-  # Looks up a Thing in the OpenHAB registry replacing '_' with ':'
-  #
-  # @param [String] name of Thing to lookup in Thing registry
-  #
-  # @return [Thing] if found, nil otherwise
-  #
-  def self.lookup_thing(name)
-    logger.trace("Looking up thing(#{name})")
-    # Convert from : syntax to underscore
-    name = name.to_s if name.is_a? Symbol
-
-    # Thing UIDs have at least 3 segements
-    return if name.count('_') < 3
-
-    name = name.gsub('_', ':')
-    # rubocop: disable Style/GlobalVars
-    $things.get(Java::OrgOpenhabCoreThing::ThingUID.new(name))
-    # rubocop: enable Style/GlobalVars
-  end
-
-  #
-  # Lookup OpenHAB items in item registry
-  #
-  # @param [String] name of item to lookup
-  #
-  # @return [Item] OpenHAB item if registry contains a matching item, nil othewise
-  #
-  def self.lookup_item(name)
-    logger.trace("Looking up item(#{name})")
-    name = name.to_s if name.is_a? Symbol
-    # rubocop: disable Style/GlobalVars
-    item = $ir.get(name)
-    # rubocop: enable Style/GlobalVars
-    EntityLookup.decorate_item(item)
-  end
-
-  #
-  # Automatically looks up OpenHAB items and things in appropriate registries
-  #
-  # @param [method] method Name of item to lookup
-  # @param [<Type>] args method arguments
-  # @param [<Type>] block supplied to missing method
-  #
-  # @return [Object] Item or Thing if found in registry
-  #
-  def method_missing(method, *args, &block)
-    return if method.to_s == 'scriptLoaded'
-    return if method.to_s == 'scriptUnloaded'
-
-    logger.trace("method missing, performing OpenHab Lookup for: #{method}")
-    EntityLookup.lookup_item(method) || EntityLookup.lookup_thing(method) || super
-  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)
-    logger.trace("Checking if OpenHAB entites exist for #{method_name}")
-    method_name = method_name.to_s if method_name.is_a? Symbol
-
-    method_name == 'scriptLoaded' ||
-      method_name == 'scriptUnloaded' ||
-      EntityLookup.lookup_item(method_name) ||
-      EntityLookup.lookup_thing(method_name) ||
-      super
-  end
-
-  #
-  # Decorate a group from an item base
-  #
-  # @param [OpenHAB item] item item to convert to a group item
-  #
-  # @return [OpenHAB::Core::DSL::Groups::Group] Group created from supplied item
-  #
-  def self.decorate_group(item)
-    group = OpenHAB::Core::DSL::Groups::Group.new(Set.new(EntityLookup.decorate_items(item.all_members.to_a)))
-    group.group = item
-    group
-  end
-end

data/lib/openhab/core/dsl/group.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-require 'delegate'
-require 'forwardable'
-require 'openhab/core/dsl/entities'
-
-module OpenHAB
-  module Core
-    module DSL
-      #
-      # Provides access to OpenHAB Groups
-      #
-      module Groups
-        #
-        # Indicator struct interpreted by rules to trigger based on items contained in a group
-        #
-        GroupItems = Struct.new(:group, keyword_init: true)
-
-        #
-        # Provide access to groups as a set
-        #
-        class Groups < SimpleDelegator
-          #
-          # Get a OpenHAB Group by name
-          # @param [String] name of the group to retrieve
-          #
-          # @return [Set] of OpenHAB Groups
-          #
-          def[](name)
-            group = EntityLookup.lookup_item(name)
-            group.is_a?(Group) ? group : nil
-          end
-        end
-
-        #
-        # Retreive all OpenHAB groups
-        #
-        # @return [Set] of OpenHAB Groups
-        #
-        def groups
-          # rubocop: disable Style/GlobalVars
-          Groups.new(EntityLookup.decorate_items($ir.items.select { |item| item.is_a? GroupItem }))
-          # rubocop: enable Style/GlobalVars
-        end
-
-        # Group class that provides access to OpenHAB group object and delegates other methods to
-        # a set of group items
-        class Group < SimpleDelegator
-          extend Forwardable
-
-          java_import org.openhab.core.items.GroupItem
-
-          # @return [org.openhab.core.items.GroupItem] OpenHAB Java Group Item
-          attr_accessor :group
-
-          # @!macro [attach] def_delegators
-          #   @!method $2
-          #     Forwards to org.openhab.core.items.GroupItem
-          #     @see org::openhab::core::items::GroupItem
-          def_delegator :@group, :name
-          def_delegator :@group, :label
-
-          #
-          # Gets members of this group that are themselves a group
-          #
-          # @return [Set] Set of members that are of type group
-          #
-          def groups
-            group.members.grep(org.openhab.core.items.GroupItem)
-          end
-
-          #
-          # Wraps the group in a struct, this method is intended to be called
-          # as an indicator to the rule method that the user wishes to trigger
-          # based on changes to group items
-          #
-          # @return [GroupItems] Indicator struct used by rules engine to trigger based on item changes
-          #
-          def items
-            GroupItems.new(group: group)
-          end
-
-          #
-          # @return [String] List of groups seperated by commas
-          #
-          def to_s
-            "[#{map(&:to_s).join(',')}]"
-          end
-
-          #
-          # Get an ID for the group, using the label if set, otherwise group name
-          #
-          # @return [String] label if set otherwise name
-          #
-          def id
-            label || name
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/core/dsl/entities'
-
-module OpenHAB
-  module Core
-    module DSL
-      #
-      # Manages OpenHAB items
-      #
-      module Items
-        #
-        # Delegates to underlying set of all OpenHAB Items, provides convenience methods
-        #
-        class Items < SimpleDelegator
-          # Fetches the named item from the the ItemRegistry
-          # @param [String] name
-          # @return Item from registry, nil if item missing or requested item is a Group Type
-          def[](name)
-            # rubocop: disable Style/GlobalVars
-            item = $ir.getItem(name)
-            # rubocop: enable Style/GlobalVars
-            item.is_a?(GroupItem) ? nil : EntityLookup.decorate_item(item)
-          rescue Java::OrgOpenhabCoreItems::ItemNotFoundException
-            nil
-          end
-
-          # Returns true if the given item name exists
-          # @param name [String] Item name to check
-          # @return [Boolean] true if the item exists, false otherwise
-          def include?(name)
-            # rubocop: disable Style/GlobalVars
-            !$ir.getItems(name).empty?
-            # rubocop: enable Style/GlobalVars
-          end
-          alias key? include?
-        end
-
-        java_import org.openhab.core.items.GroupItem
-        # Fetches all non-group items from the item registry
-        # @return [OpenHAB::Core::DSL::Items::Items]
-        def items
-          # rubocop: disable Style/GlobalVars
-          Items.new(EntityLookup.decorate_items($ir.items.reject { |item| item.is_a? GroupItem }))
-          # rubocop: enable Style/GlobalVars
-        end
-      end
-    end
-  end
-end