openhab-scripting 2.23.1 → 2.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af0c9d15b41ac54e58540ccab079a6c084931abf80f5add687511d332d3afa2
-  data.tar.gz: 5e3c341ecf96ab4fb11b6ca6cefae01a27dc02b2498e9e3896ef4683baa3f6e5
+  metadata.gz: 7226c1329289ce5ce0f85f552c091a6c5f89cb27427b9e6419d528c77a792239
+  data.tar.gz: e92ad134d92584fed6ddeeef98984cabc56355cd94f4d205a5228263ac2677d1
 SHA512:
-  metadata.gz: e0238451b9d78d45c225f98ede7b86580e26c7c3edfc7681f6942b7f5a7c4dbfb67f98c5c76ccf8a437cfa779bfa2eb9b0c8639b1c4a24206b99b8ca80a3803f
-  data.tar.gz: 616d30281aef1da66964cba5d1c6365b24939f4fbec3070e4251551e3c8c7552191835da12e4795d5698e9671add7739a411e53e7b347de65a8b4a9c0fb249a0
+  metadata.gz: '0519c68cec3b2316751c36ba27c208267ee86f76230a1722dcd3369d61e19da73a96b6616ed2a71838daf68beb3f64b88e1553f82f8cb00daec4de5c859ecb87'
+  data.tar.gz: f688f894e8a4bde1c3ee12facc846836a922cc7a1120ffd5d89ff41a6d6be1692608467265179543aaed1262394ea37aaa92d4bd5b03ad9eb33bcdd13b06c8dc

data/lib/openhab/dsl/group.rb

@@ -47,7 +47,7 @@ module OpenHAB
       class Group < SimpleDelegator
         extend Forwardable
 
-        java_import org.openhab.core.items.GroupItem
+        java_import Java::OrgOpenhabCoreItems::GroupItem
 
         # @return [org.openhab.core.items.GroupItem] OpenHAB Java Group Item
         attr_accessor :group
@@ -56,8 +56,9 @@ module OpenHAB
         #   @!method $2
         #     Forwards to org.openhab.core.items.GroupItem
         #     @see org::openhab::core::items::GroupItem
-        def_delegator :@group, :name
-        def_delegator :@group, :label
+        %i[name label << command].each do |method|
+          def_delegator :@group, method
+        end
 
         #
         # Gets members of this group that are themselves a group
@@ -65,7 +66,7 @@ module OpenHAB
         # @return [Set] Set of members that are of type group
         #
         def groups
-          group.members.grep(org.openhab.core.items.GroupItem)
+          group.members.grep(GroupItem)
         end
 
         #

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

@@ -16,10 +16,13 @@ module OpenHAB
       #
       class DateTimeItem
         extend Forwardable
+        extend OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemCommand
         include Comparable
-        include OpenHAB::DSL::Items::ItemDelegate
 
-        def_delegator :@datetime_item, :to_s
+        def_item_delegator :@datetime_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::DateTimeItem
 
         #
         # Create a new DateTimeItem
@@ -29,8 +32,8 @@ module OpenHAB
         #
         def initialize(datetime_item)
           @datetime_item = datetime_item
-          item_delegate { @datetime_item }
-          item_delegate { to_dt }
+          item_missing_delegate { @datetime_item }
+          item_missing_delegate { to_dt }
         end
 
         #

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

@@ -51,6 +51,21 @@ module OpenHAB
           end
           # rubocop:enable Style/HashEachMethods
         end
+
+        #
+        # Extract the accepted state and command types from the specified OpenHAB
+        # Item class and pass them to item_state/item_command
+        #
+        # @param [Java::JavaLang::Class] item_class a Class that implements Java::OrgOpenhabCoreItems::Item
+        #
+        def item_type(item_class)
+          item_class.field_reader(:ACCEPTED_DATA_TYPES)
+          item_class.field_reader(:ACCEPTED_COMMAND_TYPES)
+          item_class.ACCEPTED_DATA_TYPES.select(&:is_enum).grep_v(UnDefType).each { |type| item_state(type.ruby_class) }
+          item_class.ACCEPTED_COMMAND_TYPES.select(&:is_enum).grep_v(UnDefType).each do |type|
+            item_command(type.ruby_class)
+          end
+        end
       end
     end
   end

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

@@ -2,6 +2,7 @@
 
 require 'java'
 require 'openhab/log/logger'
+require 'forwardable'
 
 module OpenHAB
   module DSL
@@ -12,6 +13,36 @@ module OpenHAB
       module ItemDelegate
         include OpenHAB::Log
 
+        # @return [Array<Symbol>] Array of methods that by default will be forwarded to an OpenHAB Item.
+        DEFAULT_DELEGATION_METHODS = %i[to_s groups].freeze
+        private_constant :DEFAULT_DELEGATION_METHODS
+
+        #
+        # Extends calling object with DSL and helper methods
+        #
+        # @param [Object] base Object to decorate with DSL and helper methods
+        #
+        #
+        def self.extended(base)
+          base.extend Forwardable
+          base.include OpenHAB::DSL::Items::ItemDelegate
+        end
+
+        #
+        # Delegate a set of methods to the supplied delegator
+        #
+        # @param [Java::OrgOpenhabCoreItems::GenericItem] item to delegate methods to
+        # @param [Symbol] methods to delegate, if not supplied default methods are used
+        #
+        #
+        def def_item_delegator(item, *methods)
+          methods = DEFAULT_DELEGATION_METHODS if methods.size.zero?
+          methods.each do |method|
+            logger.trace("Creating delegate for (#{method}) to #{item}) for #{self.class}")
+            def_delegator item, method
+          end
+        end
+
         #
         # 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
@@ -22,7 +53,7 @@ module OpenHAB
         # @param [Proc] &delegate delgegate block
         #
         #
-        def item_delegate(&delegate)
+        def item_missing_delegate(&delegate)
           @delegates ||= []
           @delegates << delegate
         end

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

@@ -16,17 +16,18 @@ module OpenHAB
       # Disabled because this class has a single responsibility, there does not appear a logical
       # way of breaking it up into multiple classes
       class NumberItem < Numeric
-        extend Forwardable
+        extend OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemCommand
 
-        include OpenHAB::DSL::Items::ItemDelegate
-
-        def_delegator :@number_item, :to_s
+        def_item_delegator :@number_item
 
         java_import org.openhab.core.library.types.DecimalType
         java_import org.openhab.core.library.types.QuantityType
         java_import 'tec.uom.se.format.SimpleUnitFormat'
         java_import 'tec.uom.se.AbstractUnit'
 
+        item_type Java::OrgOpenhabCoreLibraryItems::NumberItem
+
         #
         # Create a new NumberItem
         #
@@ -34,7 +35,7 @@ module OpenHAB
         #
         def initialize(number_item)
           @number_item = number_item
-          item_delegate { @number_item }
+          item_missing_delegate { @number_item }
           super()
         end
 

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

@@ -14,18 +14,12 @@ module OpenHAB
       class RollershutterItem < Numeric
         extend Forwardable
         extend OpenHAB::DSL::Items::ItemCommand
-        include OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemDelegate
         include Comparable
 
-        def_delegator :@rollershutter_item, :to_s
+        def_item_delegator :@rollershutter_item
 
-        java_import Java::OrgOpenhabCoreLibraryTypes::PercentType
-        java_import Java::OrgOpenhabCoreLibraryTypes::UpDownType
-        java_import Java::OrgOpenhabCoreLibraryTypes::StopMoveType
-
-        item_command Java::OrgOpenhabCoreLibraryTypes::StopMoveType
-        item_command Java::OrgOpenhabCoreLibraryTypes::UpDownType
-        item_state   Java::OrgOpenhabCoreLibraryTypes::UpDownType
+        item_type Java::OrgOpenhabCoreLibraryItems::RollershutterItem
 
         #
         # Creates a new RollershutterItem
@@ -37,8 +31,8 @@ module OpenHAB
           logger.trace("Wrapping #{rollershutter_item}")
           @rollershutter_item = rollershutter_item
 
-          item_delegate { @rollershutter_item }
-          item_delegate { position }
+          item_missing_delegate { @rollershutter_item }
+          item_missing_delegate { position }
 
           super()
         end

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

@@ -13,15 +13,17 @@ module OpenHAB
       #
       class StringItem
         extend Forwardable
-
+        extend OpenHAB::DSL::Items::ItemCommand
         include Comparable
-        include OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemDelegate
 
         # @return [Regex] Regular expression matching blank strings
         BLANK_RE = /\A[[:space:]]*\z/.freeze
         private_constant :BLANK_RE
 
-        def_delegator :@string_item, :to_s
+        def_item_delegator :@string_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::StringItem
 
         #
         # Create a new StringItem
@@ -31,8 +33,8 @@ module OpenHAB
         def initialize(string_item)
           @string_item = string_item
 
-          item_delegate { @string_item }
-          item_delegate { @string_item.state&.to_full_string&.to_s }
+          item_missing_delegate { @string_item }
+          item_missing_delegate { @string_item.state&.to_full_string&.to_s }
 
           super()
         end

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB events
+      #
+      module Events
+        java_import Java::OrgOpenhabCoreItemsEvents::ItemEvent
+
+        #
+        # MonkeyPatch to add item
+        #
+        class ItemEvent
+          #
+          # Return a decorated item
+          #
+          def item
+            OpenHAB::Core::EntityLookup.lookup_item(item_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -15,17 +15,6 @@ module OpenHAB
         # MonkeyPatch with ruby style accessors
         #
         class ItemStateChangedEvent
-          #
-          # 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/dsl/monkey_patch/items/contact_item.rb

@@ -25,7 +25,7 @@ module OpenHAB
 
           java_import Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
 
-          item_state Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
+          item_type Java::OrgOpenhabCoreLibraryItems::ContactItem
 
           #
           # Compares contacts to OpenClosedTypes

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

@@ -30,8 +30,7 @@ module OpenHAB
           extend Forwardable
           extend OpenHAB::DSL::Items::ItemCommand
 
-          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
-          item_command Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
+          item_type Java::OrgOpenhabCoreLibraryItems::DimmerItem
 
           def_delegator :state, :to_s
 

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

@@ -115,6 +115,15 @@ module OpenHAB
           def inspect
             toString
           end
+
+          #
+          # Return all groups that this item is part of
+          #
+          # @return [Array<Group>] All groups that this item is part of
+          #
+          def groups
+            group_names.map { |name| OpenHAB::DSL::Groups.groups[name] }
+          end
         end
 
         java_import Java::OrgOpenhabCoreItems::GenericItem

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

@@ -8,7 +8,23 @@ module OpenHAB
         # Persistence extension for Items
         #
         module Persistence
-          %w[persist last_update].each do |method|
+          # All persistence methods that could return a Quantity
+          QUANTITY_METHODS = %i[average_since
+                                delta_since
+                                deviation_since
+                                sum_since
+                                variance_since].freeze
+
+          # All persistence methods that require a timestamp
+          PERSISTENCE_METHODS = (QUANTITY_METHODS +
+                                %i[changed_since
+                                   evolution_rate
+                                   historic_state
+                                   maximum_since
+                                   minimum_since
+                                   updated_since]).freeze
+
+          %i[persist last_update].each do |method|
             define_method(method) do |service = nil|
               service ||= persistence_service
               PersistenceExtensions.public_send(method, self, service&.to_s)
@@ -31,35 +47,48 @@ module OpenHAB
             PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
           end
 
-          %w[
-            average_since
-            changed_since
-            delta_since
-            deviation_since
-            evolution_rate
-            historic_state
-            maximum_since
-            minimum_since
-            sum_since
-            updated_since
-            variance_since
-          ].each do |method|
+          PERSISTENCE_METHODS.each do |method|
             define_method(method) do |timestamp, service = nil|
               service ||= persistence_service
-              if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
-                timestamp = Java::JavaTime::ZonedDateTime.now.minus(timestamp)
-              end
-              result = PersistenceExtensions.public_send(method, self, timestamp, service&.to_s)
-              if result.is_a?(Java::OrgOpenhabCoreLibraryTypes::DecimalType) && respond_to?(:unit) && unit
-                Quantity.new(Java::OrgOpenhabCoreLibraryTypes::QuantityType.new(result.to_big_decimal, unit))
-              else
-                result
-              end
+              result = PersistenceExtensions.public_send(method, self, to_zdt(timestamp), service&.to_s)
+              QUANTITY_METHODS.include?(method) ? quantify(result) : result
             end
           end
 
           private
 
+          #
+          # Convert timestamp to ZonedDateTime if it's a TemporalAmount
+          #
+          # @param [Object] timestamp to convert
+          #
+          # @return [ZonedDateTime]
+          #
+          def to_zdt(timestamp)
+            if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
+              logger.trace("Converting #{timestamp} (#{timestamp.class}) to ZonedDateTime")
+              Java::JavaTime::ZonedDateTime.now.minus(timestamp)
+            else
+              timestamp
+            end
+          end
+
+          #
+          # Convert value to Quantity if it is a DecimalType and a unit is defined
+          #
+          # @param [Object] value The value to convert
+          #
+          # @return [Object] Quantity or the original value
+          #
+          def quantify(value)
+            if value.is_a?(Java::OrgOpenhabCoreLibraryTypes::DecimalType) && respond_to?(:unit) && unit
+              logger.trace("Unitizing #{value} with unit #{unit}")
+              Quantity.new(Java::OrgOpenhabCoreLibraryTypes::QuantityType.new(value.to_big_decimal, unit))
+            else
+              value
+            end
+          end
+
           #
           # Get the specified persistence service from the current thread local variable
           #

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

@@ -23,8 +23,7 @@ module OpenHAB
 
           java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
 
-          item_command Java::OrgOpenhabCoreLibraryTypes::OnOffType
-          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
+          item_type Java::OrgOpenhabCoreLibraryItems::SwitchItem
 
           alias truthy? on?
 

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -243,21 +243,6 @@ module OpenHAB
           false
         end
 
-        #
-        # Patch event to decorate event.item with our item wrapper
-        #
-        # @param [OpenHAB Event] event patch
-        #
-        def decorate_event_item(event)
-          return if event.nil?
-
-          class << event
-            def item
-              OpenHAB::Core::EntityLookup.lookup_item(item_name)
-            end
-          end
-        end
-
         #
         # Process the run queue
         #
@@ -287,7 +272,6 @@ module OpenHAB
         #
         #
         def process_otherwise_task(event, task)
-          decorate_event_item(event)
           logger.trace { "Executing rule '#{name}' otherwise block with event(#{event})" }
           task.block.call(event)
         end
@@ -314,9 +298,10 @@ module OpenHAB
         #
         #
         def process_trigger_task(event, task)
-          triggering_item = OpenHAB::Core::EntityLookup.lookup_item(event&.itemName)
-          logger.trace { "Executing rule '#{name}' trigger block with item (#{triggering_item})" }
-          task.block.call(triggering_item) if triggering_item
+          return unless event&.item
+
+          logger.trace { "Executing rule '#{name}' trigger block with item (#{event.item})" }
+          task.block.call(event.item)
         end
 
         #
@@ -327,7 +312,6 @@ module OpenHAB
         #
         #
         def process_run_task(event, task)
-          decorate_event_item(event)
           logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
           task.block.call(event)
         end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.23.1
+  version: 2.25.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - 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_event.rb
 - lib/openhab/dsl/monkey_patch/events/item_state.rb
 - lib/openhab/dsl/monkey_patch/events/item_state_changed.rb
 - lib/openhab/dsl/monkey_patch/events/thing_status_info.rb