openhab-scripting 2.23.3 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ae7c9c46b7dff785181b7846dc6e6e6b9f27d445d7f1b7cc108814e1e75531
-  data.tar.gz: fffb46ad699350c94c580a3cb8ee2545a3c7c5372a81d4c7dc867cb834ee33db
+  metadata.gz: 4ce40856625691eb49a22ee19ac02bd030dba8cdf6e62f86736f9974cf7e2162
+  data.tar.gz: 98e2226b8d4286f16a7f3b4ae40ef45246489df9464d1b3a6f5f7eea37ed93cb
 SHA512:
-  metadata.gz: 790a2b3838ce8847bf3dafe567336400c43dae0b9d638318c7c1d70539f60ed45714af3f376f2a93f27265b222dd35474b1fb477eb1c892258cea401ab3ff321
-  data.tar.gz: 5085945c207f2b00353ca899fab65a2e0990751c083b433729b22e3d798dac11b1a4e99a3d07fdaf6db439d5787e06b9d9a984661496b8a767d13d668f077b43
+  metadata.gz: d3e2329d4a8b1ef612348f135a827e0011ffa0fa6b2958d2d333def5777db2ed76bd91e3cd0310c2075fe0b941b6936482a21c3ef20cca4a14283780629704b8
+  data.tar.gz: d809054def4036f6b42faf9aa069a9f201fd0fd01120df1ebb32df91a5b7069a8073237153b1f0ac2ced5477e47a24547496fab48b317d57fbb100dc286eb59f

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

@@ -16,10 +16,11 @@ module OpenHAB
       #
       class DateTimeItem
         extend Forwardable
+        extend OpenHAB::DSL::Items::ItemDelegate
+
         include Comparable
-        include OpenHAB::DSL::Items::ItemDelegate
 
-        def_delegator :@datetime_item, :to_s
+        def_item_delegator :@datetime_item
 
         #
         # Create a new DateTimeItem
@@ -29,8 +30,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_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,11 +16,9 @@ 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
 
-        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
@@ -34,7 +32,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,10 +14,10 @@ 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
@@ -37,8 +37,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

@@ -15,13 +15,13 @@ module OpenHAB
         extend Forwardable
 
         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
 
         #
         # Create a new StringItem
@@ -31,8 +31,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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.23.3
+  version: 2.24.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler