openhab-scripting 2.19.3 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d53929fa49d74df4409422669c809e146723ef88862019ee77dbf8f671b2e0
-  data.tar.gz: 3d421f3dd17058b3319bf1973da3c39f4dcc74b1a04ac365b1361be0afb59ab8
+  metadata.gz: b163016271e25f2e7e4607db6bb97d3e1fadc1e19b6d8a0396560278aa70c4ea
+  data.tar.gz: e133649130e7c960f0e4b1174fe20644111d933f339aabe8256dbfcf39862f10
 SHA512:
-  metadata.gz: ef748b3b0b3f7e4e85a7b2523df44101ceb64c9170358e5521fb2601880aefd5fd789c71d88c2115b339323081013e53032daf7e1b7e25ffda9010493da9cbec
-  data.tar.gz: 7468514e99d37e180e694b07ef751c5f9badf56dbc94f43e9ed982c9a7799760c37940dfaaa5c0adaecbfb3d82505a184401bad565ab88c56c0401207c3f2176
+  metadata.gz: c93bb71565595e355f1e8a3669bff9a389bbc92bc1d7f1b27e534c055c6bbfb45bc39d2220672d06e061c099c48cc73fdfad72642959e2c0abc8329f13bd5811
+  data.tar.gz: 5cf280a5718af694e89d2f5c8262bd6930ef8dea1bf61f697e72391bb0be58089e6c7677e1c2a22b6dfe31f7fb16c137706f1ecadcf76fcacd8f9280225b542b

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Holds methods to automatically generate commands and
+      # accessors for items
+      module ItemCommand
+        #
+        # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
+        # string representation of the enum value For example, an enum with values of STOP and START
+        # would create methods stop() and start() that send the corresponding STOP and START commands to the item
+        #
+        # @param [Java::JavaLang::Enum] command_enum Enumeration to create commands for
+        #
+        #
+        def item_command(command_enum)
+          # rubocop:disable Style/HashEachMethods
+          # Disable rule because Java enum does not support each_value
+          command_enum.values.each do |command|
+            command_method = command.to_s.downcase
+            define_method(command_method) do
+              self.command(command)
+            end
+          end
+          # rubocop:enable Style/HashEachMethods
+        end
+
+        #
+        # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
+        # string representation appended with a question mark '?' of the enum value For example,
+        # an enum with values of UP and DOWN would create methods up? and down? that check
+        # if the current state matches the value of the enum
+        #
+        # @param [Java::JavaLang::Enum] command_enum Enumeration to create methods for each value
+        #   to check if current state matches that enum
+        # @yield [state] Optional block that can be used to transform state prior to comparison
+        #
+        #
+        def item_state(command_enum)
+          # rubocop:disable Style/HashEachMethods
+          # Disable rule because Java enum does not support each_value
+          command_enum.values.each do |command|
+            status_method = "#{command.to_s.downcase}?"
+            define_method(status_method) do
+              state? && state.as(command_enum) == command
+            end
+          end
+          # rubocop:enable Style/HashEachMethods
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@
 
 require 'forwardable'
 require 'java'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL
@@ -11,6 +12,7 @@ module OpenHAB
       #
       class RollershutterItem < Numeric
         extend Forwardable
+        extend OpenHAB::DSL::Items::ItemCommand
         include Comparable
 
         def_delegator :@rollershutter_item, :to_s
@@ -19,6 +21,10 @@ module OpenHAB
         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
+
         #
         # Creates a new RollershutterItem
         #
@@ -32,24 +38,6 @@ module OpenHAB
           super()
         end
 
-        #
-        # Check if the rollershutter is up
-        #
-        # @return [Boolean] true if the rollershutter is up, false otherwise
-        #
-        def up?
-          state.as(UpDownType) == UpDownType::UP
-        end
-
-        #
-        # Check if the rollershutter is down
-        #
-        # @return [Boolean] true if the rollershutter is down, false otherwise
-        #
-        def down?
-          state.as(UpDownType) == UpDownType::DOWN
-        end
-
         #
         # Returns the rollershutter's position
         #
@@ -104,34 +92,6 @@ module OpenHAB
           state.as(UpDownType).equals(other)
         end
 
-        #
-        # Sends an UP command to the Item
-        #
-        def up
-          command UpDownType::UP
-        end
-
-        #
-        # Sends a DOWN command to the Item
-        #
-        def down
-          command UpDownType::DOWN
-        end
-
-        #
-        # Sends a STOP command to the Item
-        #
-        def stop
-          command StopMoveType::STOP
-        end
-
-        #
-        # Sends a MOVE command to the Item
-        #
-        def move
-          command StopMoveType::MOVE
-        end
-
         #
         # Define math operations
         #

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL
@@ -20,24 +21,11 @@ module OpenHAB
         # Monkey patch Contact Item with Ruby methods
         #
         class ContactItem
-          java_import org.openhab.core.library.types.OpenClosedType
-          #
-          # Check if the contact is open
-          #
-          # @return [Boolean] True if contact has state and is open, false otherwise
-          #
-          def open?
-            state? && state == OpenClosedType::OPEN
-          end
+          extend OpenHAB::DSL::Items::ItemCommand
 
-          #
-          # Check if the contact is closed
-          #
-          # @return [Boolean] True if contact has state and is closed, false otherwise
-          #
-          def closed?
-            state? && state == OpenClosedType::CLOSED
-          end
+          java_import Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
+
+          item_state Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
 
           #
           # Compares contacts to OpenClosedTypes

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

@@ -101,10 +101,10 @@ module OpenHAB
           #
           # Get the string representation of the state of the item
           #
-          # @return [String] State of the item as a string if not UNDEF or NULL, nil otherwise
+          # @return [String] State of the item as a string
           #
           def to_s
-            state&.to_s
+            method(:state).super_method.call.to_s # call the super state to include UNDEF/NULL
           end
 
           #

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

@@ -134,6 +134,18 @@ module OpenHAB
               end
             end
 
+            #
+            # Implements Hash#dig-like functionaity to metadata
+            #
+            # @param [String] key The first key
+            # @param [Array<String, Symbol>] keys More keys to dig deeper
+            #
+            # @return [OpenHAB::DSL::MonkeyPatch::Items::MetadataItem], or nil if the namespace doesn't exist
+            #
+            def dig(key, *keys)
+              keys.empty? ? self[key]&.value : self[key]&.dig(*keys)
+            end
+
             #
             # Enumerates through all the namespaces
             #

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

@@ -49,7 +49,12 @@ module OpenHAB
               if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
                 timestamp = Java::JavaTime::ZonedDateTime.now.minus(timestamp)
               end
-              PersistenceExtensions.public_send(method, self, timestamp, service&.to_s)
+              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
             end
           end
 

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'java'
+require 'openhab/dsl/items/item_command'
+
 module OpenHAB
   module DSL
     module MonkeyPatch
@@ -16,43 +19,15 @@ module OpenHAB
         # Monkeypatching SwitchItem to add Ruby Support methods
         #
         class SwitchItem
-          java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
-          #
-          # Send the OFF command to the switch
-          #
-          #
-          def off
-            command(OnOffType::OFF)
-          end
+          extend OpenHAB::DSL::Items::ItemCommand
 
-          #
-          # Send the OFF command to the switch
-          #
-          #
-          def on
-            command(OnOffType::ON)
-          end
+          java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
 
-          #
-          # Check if a switch is on
-          #
-          # @return [Boolean] True if the switch is on, false otherwise
-          #
-          def on?
-            state? && state == OnOffType::ON
-          end
+          item_command Java::OrgOpenhabCoreLibraryTypes::OnOffType
+          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
 
           alias truthy? on?
 
-          #
-          # Check if a switch is off
-          #
-          # @return [Boolean] True if the switch is off, false otherwise
-          #
-          def off?
-            state? && state == OnOffType::OFF
-          end
-
           #
           # Send a command to invert the state of the switch
           #

data/lib/openhab/dsl/monkey_patch/ruby/string.rb

@@ -21,7 +21,7 @@ module OpenHAB
           #
           def ==(other)
             case other
-            when OpenHAB::DSL::Types::Quantity, QuantityType
+            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType
               other == self
             else
               super

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

@@ -122,7 +122,7 @@ module OpenHAB
         # @return [Boolean] true if no from state is defined or defined state equals supplied state
         #
         def check_from(trigger_delay, state)
-          trigger_delay.from.nil? || trigger_delay.from == state
+          trigger_delay.from.nil? || state == trigger_delay.from
         end
 
         #
@@ -134,7 +134,7 @@ module OpenHAB
         # @return [Boolean] true if no to state is defined or defined state equals supplied state
         #
         def check_to(trigger_delay, state)
-          trigger_delay.to.nil? || trigger_delay.to == state
+          trigger_delay.to.nil? || state == trigger_delay.to
         end
 
         #

data/lib/openhab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.19.3
+  version: 2.21.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -40,6 +40,7 @@ files:
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb
 - lib/openhab/dsl/items/datetime_item.rb
+- lib/openhab/dsl/items/item_command.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/number_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb