openhab-scripting 2.16.0 → 2.17.0

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,62 +32,59 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/openhab.rb
-- lib/openhab/configuration.rb
-- lib/openhab/core/cron.rb
-- lib/openhab/core/debug.rb
-- lib/openhab/core/dsl.rb
-- lib/openhab/core/dsl/actions.rb
-- lib/openhab/core/dsl/entities.rb
-- lib/openhab/core/dsl/gems.rb
-- lib/openhab/core/dsl/group.rb
-- lib/openhab/core/dsl/items/items.rb
-- lib/openhab/core/dsl/items/number_item.rb
-- lib/openhab/core/dsl/items/string_item.rb
-- lib/openhab/core/dsl/monkey_patch/actions/actions.rb
-- lib/openhab/core/dsl/monkey_patch/actions/script_thing_actions.rb
-- lib/openhab/core/dsl/monkey_patch/events.rb
-- lib/openhab/core/dsl/monkey_patch/events/item_command.rb
-- lib/openhab/core/dsl/monkey_patch/events/item_state_changed.rb
-- lib/openhab/core/dsl/monkey_patch/events/thing_status_info.rb
-- lib/openhab/core/dsl/monkey_patch/items/contact_item.rb
-- lib/openhab/core/dsl/monkey_patch/items/dimmer_item.rb
-- lib/openhab/core/dsl/monkey_patch/items/group_item.rb
-- lib/openhab/core/dsl/monkey_patch/items/items.rb
-- lib/openhab/core/dsl/monkey_patch/items/metadata.rb
-- lib/openhab/core/dsl/monkey_patch/items/persistence.rb
-- lib/openhab/core/dsl/monkey_patch/items/switch_item.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/number.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/range.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/ruby.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/string.rb
-- lib/openhab/core/dsl/monkey_patch/types/decimal_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/on_off_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/open_closed_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/percent_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/quantity_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/types.rb
-- lib/openhab/core/dsl/persistence.rb
-- lib/openhab/core/dsl/property.rb
-- lib/openhab/core/dsl/rule/automation_rule.rb
-- lib/openhab/core/dsl/rule/guard.rb
-- lib/openhab/core/dsl/rule/rule.rb
-- lib/openhab/core/dsl/rule/rule_config.rb
-- lib/openhab/core/dsl/rule/triggers/changed.rb
-- lib/openhab/core/dsl/rule/triggers/channel.rb
-- lib/openhab/core/dsl/rule/triggers/command.rb
-- lib/openhab/core/dsl/rule/triggers/cron.rb
-- lib/openhab/core/dsl/rule/triggers/trigger.rb
-- lib/openhab/core/dsl/rule/triggers/updated.rb
-- lib/openhab/core/dsl/states.rb
-- lib/openhab/core/dsl/things.rb
-- lib/openhab/core/dsl/time_of_day.rb
-- lib/openhab/core/dsl/timers.rb
-- lib/openhab/core/dsl/types/quantity.rb
-- lib/openhab/core/dsl/units.rb
-- lib/openhab/core/log.rb
-- lib/openhab/core/patch_load_path.rb
-- lib/openhab/core/startup_delay.rb
-- lib/openhab/osgi.rb
+- lib/openhab/core/entity_lookup.rb
+- lib/openhab/core/openhab_setup.rb
+- lib/openhab/core/osgi.rb
+- lib/openhab/dsl/actions.rb
+- lib/openhab/dsl/dsl.rb
+- lib/openhab/dsl/gems.rb
+- lib/openhab/dsl/group.rb
+- lib/openhab/dsl/items/items.rb
+- lib/openhab/dsl/items/number_item.rb
+- lib/openhab/dsl/items/string_item.rb
+- lib/openhab/dsl/monkey_patch/actions/actions.rb
+- lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb
+- lib/openhab/dsl/monkey_patch/events/events.rb
+- lib/openhab/dsl/monkey_patch/events/item_command.rb
+- lib/openhab/dsl/monkey_patch/events/item_state_changed.rb
+- lib/openhab/dsl/monkey_patch/events/thing_status_info.rb
+- lib/openhab/dsl/monkey_patch/items/contact_item.rb
+- lib/openhab/dsl/monkey_patch/items/dimmer_item.rb
+- lib/openhab/dsl/monkey_patch/items/group_item.rb
+- lib/openhab/dsl/monkey_patch/items/items.rb
+- lib/openhab/dsl/monkey_patch/items/metadata.rb
+- lib/openhab/dsl/monkey_patch/items/persistence.rb
+- lib/openhab/dsl/monkey_patch/items/switch_item.rb
+- lib/openhab/dsl/monkey_patch/ruby/number.rb
+- lib/openhab/dsl/monkey_patch/ruby/range.rb
+- lib/openhab/dsl/monkey_patch/ruby/ruby.rb
+- lib/openhab/dsl/monkey_patch/ruby/string.rb
+- lib/openhab/dsl/monkey_patch/types/decimal_type.rb
+- lib/openhab/dsl/monkey_patch/types/on_off_type.rb
+- lib/openhab/dsl/monkey_patch/types/open_closed_type.rb
+- lib/openhab/dsl/monkey_patch/types/percent_type.rb
+- lib/openhab/dsl/monkey_patch/types/quantity_type.rb
+- lib/openhab/dsl/monkey_patch/types/types.rb
+- lib/openhab/dsl/persistence.rb
+- lib/openhab/dsl/rules/automation_rule.rb
+- lib/openhab/dsl/rules/guard.rb
+- lib/openhab/dsl/rules/property.rb
+- lib/openhab/dsl/rules/rule.rb
+- lib/openhab/dsl/rules/rule_config.rb
+- lib/openhab/dsl/rules/triggers/changed.rb
+- lib/openhab/dsl/rules/triggers/channel.rb
+- lib/openhab/dsl/rules/triggers/command.rb
+- lib/openhab/dsl/rules/triggers/cron.rb
+- lib/openhab/dsl/rules/triggers/trigger.rb
+- lib/openhab/dsl/rules/triggers/updated.rb
+- lib/openhab/dsl/states.rb
+- lib/openhab/dsl/things.rb
+- lib/openhab/dsl/time_of_day.rb
+- lib/openhab/dsl/timers.rb
+- lib/openhab/dsl/types/quantity.rb
+- lib/openhab/dsl/units.rb
+- lib/openhab/log/configuration.rb
+- lib/openhab/log/logger.rb
 - lib/openhab/version.rb
 homepage: https://boc-tothefuture.github.io/openhab-jruby/
 licenses: []

data/lib/openhab/configuration.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# This module holds global configuration values
-module Configuration
-  # -*- coding: utf-8 -*-
-  LOG_PREFIX = 'jsr223.jruby'
-
-  #
-  # Gets the log prefix
-  #
-  # @return [String] Prefix for all log entries
-  #
-  def self.log_prefix
-    LOG_PREFIX
-  end
-end

data/lib/openhab/core/cron.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module Core
-    #
-    # Module for Cron related methods
-    #
-    module Cron
-      #
-      # Retruns a default map for cron expressions that fires every second
-      # This map is usually updated via merge by other methods to refine cron type triggers.
-      #
-      # @return [Map] Map with symbols for :seconds, :minute, :hour, :dom, :month, :dow configured to fire every second
-      #
-      def cron_expression_map
-        {
-          second: '*',
-          minute: '*',
-          hour: '*',
-          dom: '?',
-          month: '*',
-          dow: '?'
-        }
-      end
-    end
-  end
-end

data/lib/openhab/core/debug.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'pp'
-require 'core/log'
-require 'core/dsl/things'
-
-#
-# Module to support debugging information about the Ruby or OpenHAB environment
-#
-module Debug
-  include Logging
-  include OpenHAB::Core::DSL::Things
-
-  #
-  # Print the loadpath, instance and global variables
-  #
-  def debug_variables
-    pp "Instance #{instance_variables}"
-    pp "Global #{global_variables}"
-    pp "Load Path #{$LOAD_PATH}"
-    # pp "Constants #{Module.constants}"
-  end
-
-  #
-  # Print information about the OpenHAB instance
-  #
-  def debug_openhab
-    logger.debug { "Things - Count #{things.size}" }
-    things.each do |thing|
-      logger.debug { "Thing:(#{thing.label})  UID:(#{thing.uid}) Channels(#{thing.channels.map(&:uid).join(', ')})" }
-    end
-    # logger.debug { $things.getAll.join(", ") }
-  end
-end

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,140 +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
-  #
-  # rubocop: disable Metrics/MethodLength
-  # Disabled line length - case dispatch pattern
-  def self.decorate_items(*items)
-    items.flatten.map do |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
-  end
-  # rubocop: enable Metrics/MethodLength
-
-  #
-  # Loops 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_items(item).first
-  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