openhab-scripting 2.23.2 → 2.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee0da4d4273752f4a2e7b0239c09f379f74acbc05edc3f3d10690a923c3d90a
-  data.tar.gz: b807d26604402500b68ebbfc5b4a5afe6a4c65c963a3d1a3f625a703957239f9
+  metadata.gz: f3deb9da52443a92a787b19c30a5e540bf45ffa1f2ce69e7b47554190468e311
+  data.tar.gz: eae005970cf7f0c47f896fa9e2ab194c1a8c23b8901b535cde8b66efcc864e1c
 SHA512:
-  metadata.gz: e9770cad933c03a36f70d320b04e43d9f9394e15da250a1be849a1669a7a863371cac83774d48f76f3dd44c97176b5ccac180f62167adf13c0b316ab431ee41e
-  data.tar.gz: add9dc156271bbec0918744355bf1362e387f3ce4792be28470abc57c03fd0a7e83acf69798bddfb8f142841dd202fa8df65bbb6c85f222bb8f58302f1686062
+  metadata.gz: 5fc8e075065e222e388a0c8b83a53644ea0b6d909f7c7c1109450f4be535a91e77319fa4d73e950df6ad9023bfc8051a242dcafcf51a1ff96934c6a43a9a8b51
+  data.tar.gz: b869685445af147f35ce27a793c8f533fdc39af25842935cd1c3265610383d0332830fae97edb4746a49dc96fd7f351debcb7e1eb28646c174dff03cef5e1c7f

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/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/types/datetime.rb

@@ -22,11 +22,14 @@ module OpenHAB
 
         def_delegator :datetime, :to_s
         def_delegator :zoned_date_time, :month_value, :month
+        def_delegator :zoned_date_time, :day_of_month, :mday
+        def_delegator :zoned_date_time, :day_of_year, :yday
         def_delegator :zoned_date_time, :minute, :min
         def_delegator :zoned_date_time, :second, :sec
         def_delegator :zoned_date_time, :nano, :nsec
         def_delegator :zoned_date_time, :to_epoch_second, :to_i
         alias inspect to_s
+        alias day mday
 
         java_import Java::OrgOpenhabCoreLibraryTypes::DateTimeType
         java_import java.time.ZonedDateTime
@@ -181,6 +184,15 @@ module OpenHAB
           utc_offset.zero?
         end
 
+        #
+        # Returns an integer representing the day of the week, 0..6, with Sunday == 0.
+        #
+        # @return [Integer] The day of week
+        #
+        def wday
+          zoned_date_time.day_of_week.value % 7
+        end
+
         #
         # The timezone
         #

data/lib/openhab/version.rb

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

metadata

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