openhab-scripting 2.20.1 → 2.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d7de90fee54798d88e51a4ea9f7ac6437852d7c4eb5da2b847700f0dedd5de
-  data.tar.gz: 9a91e9a2ee0d977f4e2a0dd9b0ba50b1db89c71554596bfd8ca86bd9ec168d68
+  metadata.gz: e99181d5d68e3b8deab1440bfc457890ea512a1f25a4da4dc048555f3e296f2a
+  data.tar.gz: 2b07f929d309bda53b78270b9d7274b2373132de08a075af634ca9237a79cea7
 SHA512:
-  metadata.gz: 1d956f08c8884347de414eb9de04a69184c9d95a39c35bd0ff8685ceefb28efe64945a944a87efd11da16f5dceda77be453693b84cc816a7541e3e923b218479
-  data.tar.gz: ab3fd69c22c115a03848b112922f9b489d69c35a1bac3040ef40c9a73ffa8540e73318011768647fe0793a197973239e028949126a83ed233340efbeb667f490
+  metadata.gz: 375b6c769ee121a9dfb88d6a93338de1bd1040b1cb885f8668cdf07c0f0c0dce6d2a34cd744ebe3837a06739477f296bea0e907599b3c5446ebd400745a7a92b
+  data.tar.gz: 64396208c64ddb457a873b7829ee024d01f598c32348c9717229af106e754a545aad10dde6a85dd27045a0ac73844251b4f0bc0f56f8c72ae2b88a6a0c589878

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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.20.1
+  version: 2.20.2
 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