openhab-scripting 3.9.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9d4ad3fd6bcd47f7441c909955c5d242847458c5436ed7d970df401c1914c8
-  data.tar.gz: 7f6ce878e39bd7ca0ede464fb8b8cbeb3a9559968befad9feea2dfdfa07729a2
+  metadata.gz: bf75e647f468a653d6848739cf2552ba57b9d1b1d81f33eed2f3719315d28d11
+  data.tar.gz: 8f6403a4642e1edd1eb3047d438939b5d127c0fd0eca57c8989e9a72bf0bdb39
 SHA512:
-  metadata.gz: 4172131bbed8203614f2fa187394abe46c6789d12ac8d80930719f6dce1acfd0528ac992f3fe456f2a735d711d3a48515cc01d32e9b7a36d86a030e40e07fcbc
-  data.tar.gz: 85712a1ab410d97079b4a88f0cc55472dd23ef9b9ca0cf9dd664420e2819e9f0b23f23ea26b27939ab3a5867eac5a101c78071f073be753920b7f16bae9845ce
+  metadata.gz: 9e0ea6a8962334965162c95ff2db82a3fcf0485c6b80fefd2ea0814d0883678052bd52306093ea70e2cb0aec9e3fb8df42fd9290f9b9b21ddfb71db11649f104
+  data.tar.gz: 4d492998dd50c6b25fd845df988d7ef418e5d2a8a66c339bf5fabf990cd6380d6a588ee6fc899d47d697564b78c88397a77d362a39da0a6d7f9d7ba3c99d4c71

data/lib/openhab/core/entity_lookup.rb

@@ -129,7 +129,7 @@ module OpenHAB
         # Thing UIDs have at least 3 segements
         return if name.count('_') < 3
 
-        name = name.gsub('_', ':')
+        name = name.tr('_', ':')
         # rubocop: disable Style/GlobalVars
         $things.get(Java::OrgOpenhabCoreThing::ThingUID.new(name))
         # rubocop: enable Style/GlobalVars

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

@@ -68,6 +68,7 @@ module OpenHAB
         def members
           GroupMembers.new(@group_item)
         end
+        alias items members
 
         #
         # Iterates through the direct members of the Group

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

@@ -2,6 +2,7 @@
 
 require 'java'
 require 'openhab/log/logger'
+require 'openhab/dsl/monkey_patch/events/item_command'
 
 module OpenHAB
   module DSL
@@ -28,7 +29,7 @@ module OpenHAB
           command_enum.values.each do |command|
             command_method = command.to_s.downcase
             command_method = methods.transform_keys(&:to_sym).fetch(command_method.to_sym, command_method)
-            logger.trace("Creating command method (#{command_method}) for #{self.class}")
+            logger.trace("Creating command method (#{command_method}) for #{self}")
             define_method(command_method) do
               self.command(command)
             end
@@ -54,7 +55,7 @@ module OpenHAB
           command_enum.values.each do |command|
             status_method = "#{command.to_s.downcase}?"
             status_method = methods.transform_keys(&:to_sym).fetch(status_method.to_sym, status_method)
-            logger.trace("Creating status method (#{status_method}) for #{self.class}")
+            logger.trace("Creating status method (#{status_method}) for #{self}")
             define_method(status_method) do
               state? && state.as(command_enum) == command
             end
@@ -70,7 +71,7 @@ module OpenHAB
         # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
         #   will be used as the method name instead, for example `:play? => :playing?`
         #
-        def item_type(item_class, methods = {})
+        def item_type(item_class, methods = {}) # rubocop:disable Metrics/MethodLength
           item_class.field_reader(:ACCEPTED_DATA_TYPES)
           item_class.field_reader(:ACCEPTED_COMMAND_TYPES)
           item_class.ACCEPTED_DATA_TYPES.select(&:is_enum)
@@ -78,7 +79,10 @@ module OpenHAB
                     .each { |type| item_state(type.ruby_class, methods) }
           item_class.ACCEPTED_COMMAND_TYPES.select(&:is_enum)
                     .grep_v(UnDefType)
-                    .each { |type| item_command(type.ruby_class, methods) }
+                    .each do |type|
+                      item_command(type.ruby_class, methods)
+                      MonkeyPatch::Events::ItemCommandEvent.def_enum_predicates(type.ruby_class)
+                    end
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/events/item_command.rb

@@ -15,7 +15,26 @@ module OpenHAB
         # Monkey patch with ruby style accesors
         #
         class ItemCommandEvent
+          include Log
+
           alias command item_command
+
+          #
+          # 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 check if the command is corresponding STOP and START type
+          #
+          # @param [Java::JavaLang::Enum] command_enum Enumeration to create commands for
+          #
+          def self.def_enum_predicates(command_enum)
+            command_enum.values.each do |command| # rubocop:disable Style/HashEachMethods : Java enum does not have each_value
+              command_method = "#{command.to_s.downcase}?"
+              logger.trace("Creating predicate method (#{command_method}) for #{self}")
+              define_method(command_method) do
+                self.command == command
+              end
+            end
+          end
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/events/item_state.rb

@@ -10,12 +10,51 @@ module OpenHAB
       #
       module Events
         java_import Java::OrgOpenhabCoreItemsEvents::ItemStateEvent
+        java_import Java::OrgOpenhabCoreTypes::UnDefType
+
+        # Helpers common to ItemStateEvent and ItemStateChangedEvent
+        module ItemStateUnDefTypeHelpers
+          #
+          # Check if the state == UNDEF
+          #
+          # @return [Boolean] True if the state is UNDEF, false otherwise
+          #
+          def undef?
+            item_state == UnDefType::UNDEF
+          end
+
+          #
+          # Check if the state == NULL
+          #
+          # @return [Boolean] True if the state is NULL, false otherwise
+          def null?
+            item_state == UnDefType::NULL
+          end
+
+          #
+          # Check if the state is defined (not UNDEF or NULL)
+          #
+          # @return [Boolean] True if state is not UNDEF or NULL
+          #
+          def state?
+            undef? == false && null? == false
+          end
+
+          #
+          # Get the item state
+          #
+          # @return [State] OpenHAB state if state is not UNDEF or NULL, nil otherwise
+          #
+          def state
+            item_state if state?
+          end
+        end
 
         #
         # MonkeyPatch with ruby style accessors
         #
         class ItemStateEvent
-          alias state item_state
+          include ItemStateUnDefTypeHelpers
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/events/item_state_changed.rb

@@ -10,13 +10,50 @@ module OpenHAB
       #
       module Events
         java_import Java::OrgOpenhabCoreItemsEvents::ItemStateChangedEvent
+        java_import Java::OrgOpenhabCoreTypes::UnDefType
 
         #
         # MonkeyPatch with ruby style accessors
         #
         class ItemStateChangedEvent
-          alias state item_state
-          alias last old_item_state
+          include ItemStateUnDefTypeHelpers
+
+          #
+          # Check if state was == UNDEF
+          #
+          # @return [Boolean] True if the state is UNDEF, false otherwise
+          #
+          def was_undef?
+            old_item_state == UnDefType::UNDEF
+          end
+
+          #
+          # Check if state was == NULL
+          #
+          # @return [Boolean] True if the state is NULL, false otherwise
+          def was_null?
+            old_item_state == UnDefType::NULL
+          end
+
+          #
+          # Check if state was defined (not UNDEF or NULL)
+          #
+          # @return [Boolean] True if state is not UNDEF or NULL
+          #
+          def was?
+            was_undef? == false && was_null? == false
+          end
+
+          #
+          # Get the previous item state
+          #
+          # @return [State] OpenHAB state if state was not UNDEF or NULL, nil otherwise
+          #
+          def was
+            old_item_state if was?
+          end
+
+          alias last was
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/types/increase_decrease_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
+
+        #
+        # Monkey patch for DSL use
+        #
+        class IncreaseDecreaseType
+          alias inspect to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/types/next_previous_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreLibraryTypes::NextPreviousType
+
+        #
+        # Monkey patch for DSL use
+        #
+        class NextPreviousType
+          alias inspect to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/types/on_off_type.rb

@@ -33,16 +33,9 @@ module OpenHAB
           #  nil if object cannot be compared
           #
           def ===(other)
-            # A case statement here causes and infinite loop
-            # rubocop:disable Style/CaseLikeIf
-            if self == ON
-              other.on? if other.respond_to? :on?
-            elsif self == OFF
-              other.off? if other.respond_to?('off?')
-            else
-              false
-            end
-            # rubocop:enable Style/CaseLikeIf
+            (on? && other.respond_to?(:on?) && other.on?) ||
+              (off? && other.respond_to?(:off?) && other.off?) ||
+              super
           end
 
           #
@@ -59,6 +52,26 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Check if the state is ON
+          #
+          # @return [Boolean] true if ON, false otherwise
+          #
+          def on?
+            self == ON
+          end
+
+          #
+          # Check if the state is OFF
+          #
+          # @return [Boolean] true if OFF, false otherwise
+          #
+          def off?
+            self == OFF
+          end
+
+          alias inspect to_s
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/types/open_closed_type.rb

@@ -25,13 +25,9 @@ module OpenHAB
           # @return [Boolean] True if the other object is a ContactItem and has the same state
           #
           def ===(other)
-            if other.respond_to?(:state)
-              self == other.state
-            elsif other.is_a? OpenClosedType
-              self == other
-            else
+            (open? && other.respond_to?(:open?) && other.open?) ||
+              (closed? && other.respond_to?(:closed?) && other.closed?) ||
               super
-            end
           end
 
           #
@@ -48,6 +44,26 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Check if the state is OPEN
+          #
+          # @return [Boolean] true if OPEN, false otherwise
+          #
+          def open?
+            self == OPEN
+          end
+
+          #
+          # Check if the state is CLOSED
+          #
+          # @return [Boolean] true if CLOSED, false otherwise
+          #
+          def closed?
+            self == CLOSED
+          end
+
+          alias inspect to_s
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/types/percent_type.rb

@@ -25,6 +25,51 @@ module OpenHAB
             super
           end
           # rubocop:enable Lint/UselessMethodDefinition
+
+          #
+          # Provide details about PercentType object
+          #
+          # @return [String] Representing details about the PercentType object
+          #
+          def inspect
+            "#{to_string}%"
+          end
+
+          #
+          # Check if the state is ON
+          #
+          # @return [Boolean] true if ON, false otherwise
+          #
+          def on?
+            as(OnOffType).on?
+          end
+
+          #
+          # Check if the state is OFF
+          #
+          # @return [Boolean] true if OFF, false otherwise
+          #
+          def off?
+            as(OnOffType).off?
+          end
+
+          #
+          # Check if the state is UP
+          #
+          # @return [Boolean] true if UP, false otherwise
+          #
+          def up?
+            !!as(UpDownType)&.up?
+          end
+
+          #
+          # Check if the state is DOWN
+          #
+          # @return [Boolean] true if DOWN, false otherwise
+          #
+          def down?
+            !!as(UpDownType)&.down?
+          end
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/types/play_pause_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreLibraryTypes::PlayPauseType
+
+        #
+        # Monkey patch for DSL use
+        #
+        class PlayPauseType
+          alias inspect to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/types/refresh_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreTypes::RefreshType
+
+        #
+        # Monkey patch for DSL use
+        #
+        class RefreshType
+          alias inspect to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/types/rewind_fastforward_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreLibraryTypes::RewindFastforwardType
+
+        #
+        # Monkey patch for DSL use
+        #
+        class RewindFastforwardType
+          alias inspect to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/types/stop_move_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreLibraryTypes::StopMoveType
+
+        #
+        # Monkey patch for DSL use
+        #
+        class StopMoveType
+          alias inspect to_s
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,12 @@
 require 'openhab/dsl/monkey_patch/types/open_closed_type'
 require 'openhab/dsl/monkey_patch/types/on_off_type'
 require 'openhab/dsl/monkey_patch/types/decimal_type'
+require 'openhab/dsl/monkey_patch/types/increase_decrease_type'
+require 'openhab/dsl/monkey_patch/types/next_previous_type'
 require 'openhab/dsl/monkey_patch/types/percent_type'
+require 'openhab/dsl/monkey_patch/types/play_pause_type'
 require 'openhab/dsl/monkey_patch/types/quantity_type'
+require 'openhab/dsl/monkey_patch/types/refresh_type'
+require 'openhab/dsl/monkey_patch/types/rewind_fastforward_type'
+require 'openhab/dsl/monkey_patch/types/stop_move_type'
 require 'openhab/dsl/monkey_patch/types/up_down_type'

data/lib/openhab/dsl/monkey_patch/types/up_down_type.rb

@@ -45,6 +45,26 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Check if the state is UP
+          #
+          # @return [Boolean] true if UP, false otherwise
+          #
+          def up?
+            self == UP
+          end
+
+          #
+          # Check if the state is DOWN
+          #
+          # @return [Boolean] true if DOWN, false otherwise
+          #
+          def down?
+            self == DOWN
+          end
+
+          alias inspect to_s
         end
       end
     end

data/lib/openhab/dsl/timers.rb

@@ -31,14 +31,14 @@ module OpenHAB
         # @param [Duration] duration Duration until timer should fire
         # @param [Block] block Block to execute when timer fires
         #
-        def initialize(duration:, &block)
+        def initialize(duration:)
           @duration = duration
 
           # A semaphore is used to prevent a race condition in which calling the block from the timer thread
           # occurs before the @timer variable can be set resulting in @timer being nil
           semaphore = Mutex.new
 
-          timer_block = proc { semaphore.synchronize { block.call(self) } }
+          timer_block = proc { semaphore.synchronize { yield(self) } }
 
           semaphore.synchronize do
             @timer = ScriptExecution.createTimer(

data/lib/openhab/dsl/types/datetime.rb

@@ -81,7 +81,7 @@ module OpenHAB
 
           case other
           when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement then to_tod <=> other
-          when String then self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
+          when String then self <=> DateTime.parse(DATE_ONLY_REGEX.match?(other) ? "#{other}'T'00:00:00#{zone}" : other)
           else
             self <=> DateTime.from(other)
           end
@@ -120,7 +120,7 @@ module OpenHAB
           when Numeric then DateTime.from(to_time - other)
           when String
             dt = DateTime.parse(other)
-            TIME_ONLY_REGEX =~ other ? self - dt.to_f : time_diff(dt)
+            TIME_ONLY_REGEX.match?(other) ? self - dt.to_f : time_diff(dt)
           when Duration then DateTime.new(zoned_date_time.minus(other))
           when Time, DateTime, DateTimeType, DateTimeItem then time_diff(other)
           end
@@ -298,7 +298,7 @@ module OpenHAB
         # @return [Java::org::openhab::core::library::types::DateTimeType] Object representing the same time
         #
         def self.parse(time_string)
-          time_string += 'Z' if TIME_ONLY_REGEX =~ time_string
+          time_string += 'Z' if TIME_ONLY_REGEX.match?(time_string)
           DateTime.new(DateTimeType.new(time_string))
         rescue Java::JavaLang::StringIndexOutOfBoundsException, Java::JavaLang::IllegalArgumentException
           # Try ruby's Time.parse if OpenHAB's DateTimeType parser fails

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 3.9.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,10 +84,16 @@ files:
 - lib/openhab/dsl/monkey_patch/ruby/string.rb
 - lib/openhab/dsl/monkey_patch/ruby/time.rb
 - lib/openhab/dsl/monkey_patch/types/decimal_type.rb
+- lib/openhab/dsl/monkey_patch/types/increase_decrease_type.rb
+- lib/openhab/dsl/monkey_patch/types/next_previous_type.rb
 - lib/openhab/dsl/monkey_patch/types/on_off_type.rb
 - lib/openhab/dsl/monkey_patch/types/open_closed_type.rb
 - lib/openhab/dsl/monkey_patch/types/percent_type.rb
+- lib/openhab/dsl/monkey_patch/types/play_pause_type.rb
 - lib/openhab/dsl/monkey_patch/types/quantity_type.rb
+- lib/openhab/dsl/monkey_patch/types/refresh_type.rb
+- lib/openhab/dsl/monkey_patch/types/rewind_fastforward_type.rb
+- lib/openhab/dsl/monkey_patch/types/stop_move_type.rb
 - lib/openhab/dsl/monkey_patch/types/types.rb
 - lib/openhab/dsl/monkey_patch/types/up_down_type.rb
 - lib/openhab/dsl/persistence.rb