openhab-scripting 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34dcff6b869bdb1bbcf1e61d84ffe7ff07d039204ee868d16f0f249c3074e898
-  data.tar.gz: 39645a3f3486d9bba7db56a43d4c60883c346eea007242603a2dd2f7c8aa3b6e
+  metadata.gz: a39d84f4797ad4d9807e581919e5a681e0b6ba52df5a64f395bc2409cb2d7f38
+  data.tar.gz: d56eb7cb6e9a3a50dd07407bed0a9be23f3b719b676c1e2d4bbf82685f049f73
 SHA512:
-  metadata.gz: 303f0751aac26ab7f28a4350ff03151a3a03bb1559f51ae0130c830ea5e20d6bb4165929a173ed4e749cf62ee0e4ab66f1f79845e8e851d44a288407e11be5a5
-  data.tar.gz: dfee68ab34f41a303886bc8028ae7a30ff4baaee2fd87cc75602bfa7d82f57c2c3a7bf6190f6efecdb2a364c21a4514fe59984e9da8574cf19c5f3fd782abc7e
+  metadata.gz: 4bfda0871cefc7b2a0a95ea0d8528ab50111192727f4380f441c922eb5214573a59c9e0c7f39b9c13b26f9ee733607548445477f5b9a79ee7c1028cbbf064db6
+  data.tar.gz: 73002d6de64e98d48dd4f5b0a7ad0439c2bed9b15cdabfe36cffbf026930b0cdeac98da0b748e477362f28a19bdfdb2c0223749dbe6ae353ddc8a4e7b52341b6

data/lib/openhab/dsl/actions.rb

@@ -9,7 +9,6 @@ module OpenHAB
     # Module to import and streamline access to OpenHAB actions
     #
     module Actions
-      java_import org.openhab.core.library.types.PercentType
       include OpenHAB::Log
 
       OpenHAB::Core::OSGI.services('org.openhab.core.model.script.engine.action.ActionService')&.each do |service|
@@ -83,7 +82,7 @@ module OpenHAB
       # @return [void]
       #
       def say(text, voice: nil, sink: nil, volume: nil)
-        volume = PercentType.new(volume&.to_i) unless volume.is_a?(PercentType) || volume.nil?
+        volume = Types::PercentType.new(volume) unless volume.is_a?(Types::PercentType) || volume.nil?
         Voice.say text, voice, sink, volume
       end
 
@@ -97,7 +96,7 @@ module OpenHAB
       # @return [void]
       #
       def play_sound(filename, sink: nil, volume: nil)
-        volume = PercentType.new(volume&.to_i) unless volume.is_a?(PercentType) || volume.nil?
+        volume = Types::PercentType.new(volume) unless volume.is_a?(Types::PercentType) || volume.nil?
         Audio.playSound sink, filename, volume
       end
     end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative 'generic_item'
+
+module OpenHAB
+  module DSL
+    module Items
+      # Functionality to implement +ensure+/+ensure_states+
+      module Ensure
+        # Contains the global +ensure_states+ method
+        module EnsureStates
+          # Global method that takes a block and for the duration of the block
+          # all commands sent will check if the item is in the command's state
+          # before sending the command.
+          #
+          # @example Turn on several switches only if they're not already on
+          #   ensure_states do
+          #     Switch1.on
+          #     Switch2.on
+          #   end
+          def ensure_states
+            old = Thread.current[:ensure_states]
+            Thread.current[:ensure_states] = true
+            yield
+          ensure
+            Thread.current[:ensure_states] = old
+          end
+          module_function :ensure_states
+        end
+
+        # Contains the +ensure+ method mixed into {GenericItem} and {GroupItem::GroupMembers}
+        module Ensurable
+          # Fluent method call that you can chain commands on to, that will
+          # then automatically ensure that the item is not in the command's
+          # state before sending the command.
+          #
+          # @example Turn switch on only if it's not on
+          #   MySwitch.ensure.on
+          # @example Turn on all switches in a group that aren't already on
+          #   MySwitchGroup.members.ensure.on
+          def ensure
+            GenericItemDelegate.new(self)
+          end
+        end
+
+        # Extensions for {Items::GenericItem} to implement {Ensure}'s
+        # functionality
+        module GenericItem
+          include Ensurable
+
+          # If +ensure_states+ is active (by block or chained method), then
+          # check if this item is in the command's state before actually
+          # sending the command
+          def command(command)
+            return super unless Thread.current[:ensure_states]
+            return if command == state
+
+            super
+          end
+          alias << command
+        end
+
+        # "anonymous" class that wraps any method call in +ensure_states+
+        # before forwarding to the wrapped object
+        # @!visibility private
+        class GenericItemDelegate
+          def initialize(item)
+            @item = item
+          end
+
+          # activate +ensure_states+ before forwarding to the wrapped object
+          def method_missing(method, *args, &block)
+            return super unless @item.respond_to?(method)
+
+            ensure_states do
+              @item.__send__(method, *args, &block)
+            end
+          end
+
+          # .
+          def respond_to_missing?(method, include_private = false)
+            @item.respond_to?(method, include_private) || super
+          end
+        end
+      end
+
+      GenericItem.prepend(Ensure::GenericItem)
+      GroupItem::GroupMembers.include(Ensure::Ensurable)
+    end
+  end
+end
+
+Object.include OpenHAB::DSL::Items::Ensure::EnsureStates

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

@@ -31,6 +31,74 @@ module OpenHAB
           def to_a
             group.get_members.to_a
           end
+
+          # Send a command to each member of the group
+          #
+          # @return [GroupMembers] +self+
+          def command(command)
+            each { |item| item << command }
+          end
+          alias << command
+
+          # @!method refresh
+          #   Send the +REFRESH+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method on
+          #   Send the +ON+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method off
+          #   Send the +OFF+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method up
+          #   Send the +UP+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method down
+          #   Send the +DOWN+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method stop
+          #   Send the +STOP+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method move
+          #   Send the +MOVE+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method increase
+          #   Send the +INCREASE+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method desrease
+          #   Send the +DECREASE+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method play
+          #   Send the +PLAY+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method pause
+          #   Send the +PAUSE+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method rewind
+          #   Send the +REWIND+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method fast_forward
+          #   Send the +FASTFORWARD+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method next
+          #   Send the +NEXT+ command to each member of the group
+          #   @return [GroupMembers] +self+
+
+          # @!method previous
+          #   Send the +PREVIOUS+ command to each member of the group
+          #   @return [GroupMembers] +self+
         end
 
         include Enumerable

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

@@ -18,6 +18,8 @@ require_relative 'player_item'
 require_relative 'rollershutter_item'
 require_relative 'string_item'
 
+require_relative 'ensure'
+
 module OpenHAB
   module DSL
     # Contains all OpenHAB *Item classes, as well as associated support
@@ -51,7 +53,7 @@ module OpenHAB
 
         # defined methods for commanding an item to one of the Enum states
         # as well as predicates for if an ItemCommandEvent is one of those commands
-        def def_command_methods(klass) # rubocop:disable Metrics/MethodLength method has single purpose
+        def def_command_methods(klass) # rubocop:disable Metrics method has single purpose
           values_for_enums(klass.ACCEPTED_COMMAND_TYPES).each do |value|
             command = Types::COMMAND_ALIASES[value.to_s]
             next if klass.instance_methods.include?(command)
@@ -63,6 +65,13 @@ module OpenHAB
               end                  # end
             RUBY
 
+            OpenHAB::Core.logger.trace("Defining GroupItem::GroupMembers##{command} for #{value}")
+            GroupItem::GroupMembers.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+              def #{command}        # def on
+                each(&:#{command})  #   each(&:on)
+              end                   # end
+            RUBY
+
             OpenHAB::Core.logger.trace("Defining ItemCommandEvent##{command}? for #{value}")
             MonkeyPatch::Events::ItemCommandEvent.class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{command}?        # def refresh?

data/lib/openhab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -58,6 +58,7 @@ files:
 - lib/openhab/dsl/items/contact_item.rb
 - lib/openhab/dsl/items/date_time_item.rb
 - lib/openhab/dsl/items/dimmer_item.rb
+- lib/openhab/dsl/items/ensure.rb
 - lib/openhab/dsl/items/generic_item.rb
 - lib/openhab/dsl/items/group_item.rb
 - lib/openhab/dsl/items/image_item.rb