openhab-scripting 4.1.3 → 4.4.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'java'
+require_relative 'item_event'
 
 module OpenHAB
   module DSL
@@ -9,32 +9,75 @@ module OpenHAB
       # Patches OpenHAB events
       #
       module Events
-        java_import Java::OrgOpenhabCoreItemsEvents::ItemCommandEvent
-
-        #
-        # Monkey patch with ruby style accesors
-        #
-        class ItemCommandEvent
-          include Log
+        java_import org.openhab.core.items.events.ItemCommandEvent
 
+        # Adds methods to core OpenHAB ItemCommandEvent to make it more natural in Ruby
+        class ItemCommandEvent < ItemEvent
+          # @return [Type]
           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
+          # @!method refresh?
+          #   Check if == +REFRESH+
+          #   @return [Boolean]
+
+          # @!method on?
+          #   Check if == +ON+
+          #   @return [Boolean]
+
+          # @!method off?
+          #   Check if == +OFF+
+          #   @return [Boolean]
+
+          # @!method up?
+          #   Check if == +UP+
+          #   @return [Boolean]
+
+          # @!method down?
+          #   Check if == +DOWN+
+          #   @return [Boolean]
+
+          # @!method stop?
+          #   Check if == +STOP+
+          #   @return [Boolean]
+
+          # @!method move?
+          #   Check if == +MOVE+
+          #   @return [Boolean]
+
+          # @!method increase?
+          #   Check if == +INCREASE+
+          #   @return [Boolean]
+
+          # @!method decrease?
+          #   Check if == +DECREASE+
+          #   @return [Boolean]
+
+          # @!method play?
+          #   Check if == +PLAY+
+          #   @return [Boolean]
+
+          # @!method pause?
+          #   Check if == +PAUSE+
+          #   @return [Boolean]
+
+          # @!method rewind?
+          #   Check if == +REWIND+
+          #   @return [Boolean]
+
+          # @!method fast_forward?
+          #   Check if == +FASTFORWARD+
+          #   @return [Boolean]
+
+          # @deprecated
+          # @!parse alias fastforward? fast_forward?
+
+          # @!method next?
+          #   Check if == +NEXT+
+          #   @return [Boolean]
+
+          # @!method previous?
+          #   Check if == +PREVIOUS+
+          #   @return [Boolean]
         end
       end
     end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'java'
-
 module OpenHAB
   module DSL
     module MonkeyPatch
@@ -9,14 +7,16 @@ module OpenHAB
       # Patches OpenHAB events
       #
       module Events
-        java_import Java::OrgOpenhabCoreItemsEvents::ItemEvent
+        java_import org.openhab.core.items.events.ItemEvent
 
         #
-        # MonkeyPatch to add item
+        # Adds methods to core OpenHAB ItemEvent to make it more natural in Ruby
         #
         class ItemEvent
           #
-          # Return a decorated item
+          # The triggering item
+          #
+          # @return [GenericItem]
           #
           def item
             OpenHAB::Core::EntityLookup.lookup_item(item_name)

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'java'
+require 'openhab/dsl/types/un_def_type'
 
 module OpenHAB
   module DSL
@@ -9,18 +9,17 @@ module OpenHAB
       # Patches OpenHAB events
       #
       module Events
-        java_import Java::OrgOpenhabCoreItemsEvents::ItemStateEvent
-        java_import Java::OrgOpenhabCoreTypes::UnDefType
+        java_import org.openhab.core.items.events.ItemStateEvent
 
         # Helpers common to ItemStateEvent and ItemStateChangedEvent
-        module ItemStateUnDefTypeHelpers
+        module ItemState
           #
           # Check if the state == UNDEF
           #
           # @return [Boolean] True if the state is UNDEF, false otherwise
           #
           def undef?
-            item_state == UnDefType::UNDEF
+            item_state == UNDEF
           end
 
           #
@@ -28,7 +27,7 @@ module OpenHAB
           #
           # @return [Boolean] True if the state is NULL, false otherwise
           def null?
-            item_state == UnDefType::NULL
+            item_state == NULL
           end
 
           #
@@ -37,13 +36,13 @@ module OpenHAB
           # @return [Boolean] True if state is not UNDEF or NULL
           #
           def state?
-            undef? == false && null? == false
+            !item_state.is_a?(Types::UnDefType)
           end
 
           #
           # Get the item state
           #
-          # @return [State] OpenHAB state if state is not UNDEF or NULL, nil otherwise
+          # @return [Types::PrimitiveState] OpenHAB state if state is not UNDEF or NULL, nil otherwise
           #
           def state
             item_state if state?
@@ -51,10 +50,10 @@ module OpenHAB
         end
 
         #
-        # MonkeyPatch with ruby style accessors
+        # Adds methods to core OpenHAB ItemStateEvent to make it more natural in Ruby
         #
-        class ItemStateEvent
-          include ItemStateUnDefTypeHelpers
+        class ItemStateEvent < ItemEvent
+          include ItemState
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'java'
+require 'openhab/dsl/types/un_def_type'
 
 module OpenHAB
   module DSL
@@ -9,14 +9,13 @@ module OpenHAB
       # Patches OpenHAB events
       #
       module Events
-        java_import Java::OrgOpenhabCoreItemsEvents::ItemStateChangedEvent
-        java_import Java::OrgOpenhabCoreTypes::UnDefType
+        java_import org.openhab.core.items.events.ItemStateChangedEvent
 
         #
-        # MonkeyPatch with ruby style accessors
+        # Adds methods to core OpenHAB ItemStateChangedEvent to make it more natural in Ruby
         #
-        class ItemStateChangedEvent
-          include ItemStateUnDefTypeHelpers
+        class ItemStateChangedEvent < ItemEvent
+          include ItemState
 
           #
           # Check if state was == UNDEF
@@ -24,7 +23,7 @@ module OpenHAB
           # @return [Boolean] True if the state is UNDEF, false otherwise
           #
           def was_undef?
-            old_item_state == UnDefType::UNDEF
+            old_item_state == UNDEF
           end
 
           #
@@ -32,7 +31,7 @@ module OpenHAB
           #
           # @return [Boolean] True if the state is NULL, false otherwise
           def was_null?
-            old_item_state == UnDefType::NULL
+            old_item_state == NULL
           end
 
           #
@@ -41,18 +40,18 @@ module OpenHAB
           # @return [Boolean] True if state is not UNDEF or NULL
           #
           def was?
-            was_undef? == false && was_null? == false
+            !old_item_state.is_a?(Types::UnDefType)
           end
 
           #
           # Get the previous item state
           #
-          # @return [State] OpenHAB state if state was not UNDEF or NULL, nil otherwise
+          # @return [Types::Type] OpenHAB state if state was not UNDEF or NULL, nil otherwise
           #
           def was
             old_item_state if was?
           end
-
+          # @deprecated
           alias last was
         end
       end

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

@@ -16,7 +16,7 @@ module OpenHAB
           # @return [Java::JavaTime::Duration] Duration with number of units from self
           #
           %w[millis seconds minutes hours].each do |unit|
-            define_method(unit) { Java::JavaTime::Duration.public_send("of_#{unit}", self) }
+            define_method(unit) { java.time.Duration.public_send("of_#{unit}", self) }
           end
 
           alias second seconds
@@ -37,7 +37,7 @@ module OpenHAB
           # @return [Java::JavaTime::Duration] Duration truncated to an integral number of milliseconds from self
           #
           def millis
-            Java::JavaTime::Duration.of_millis(to_i)
+            java.time.Duration.of_millis(to_i)
           end
 
           #
@@ -74,6 +74,26 @@ module OpenHAB
           alias minute minutes
           alias hour hours
         end
+
+        #
+        # Extend numeric to create quantity object
+        #
+        module NumericExtensions
+          #
+          # Convert Numeric to a QuantityType
+          #
+          # @param [Object] other String or Unit representing an OpenHAB Unit
+          #
+          # @return [Types::QuantityType] +self+ as a {Types::QuantityType} of the supplied Unit
+          #
+          def |(other)
+            other = org.openhab.core.types.util.UnitUtils.parse_unit(other.to_str) if other.respond_to?(:to_str)
+
+            return super unless other.is_a?(javax.measure.Unit)
+
+            QuantityType.new(to_d.to_java, other)
+          end
+        end
       end
     end
   end
@@ -81,3 +101,6 @@ end
 
 Integer.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::IntegerExtensions)
 Float.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::FloatExtensions)
+Numeric.include(OpenHAB::DSL::MonkeyPatch::Ruby::NumericExtensions)
+# Integer already has #|, so we have to prepend it here
+Integer.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::NumericExtensions)

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-# Monkey patch ruby
-require 'openhab/dsl/monkey_patch/ruby/range'
 require 'openhab/dsl/monkey_patch/ruby/number'
 require 'openhab/dsl/monkey_patch/ruby/string'
-require 'openhab/dsl/monkey_patch/ruby/time'
 require 'bigdecimal/util'

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

@@ -1,44 +1,44 @@
 # frozen_string_literal: true
 
-require 'openhab/dsl/types/quantity'
-require 'openhab/dsl/types/datetime'
-require 'openhab/dsl/items/datetime_item'
-
 module OpenHAB
   module DSL
+    # monkey patches
     module MonkeyPatch
+      # extensions to core Ruby objects
       module Ruby
-        #
-        # Extend String class
-        #
+        # extend String class so that it will do semantic comparisons against
+        # DateTimeType and QuantityType, instead of converting the latter to
+        # String and doing an exact match
         module StringExtensions
-          include OpenHAB::Core
-
-          #
-          # Compares String to another object
-          #
-          # @param [Object] other object to compare to
-          #
-          # @return [Boolean]  true if the two objects contain the same value, false otherwise
-          #
+          # {include:StringExtensions}
           def ==(other)
             case other
-            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType,
-              OpenHAB::DSL::Types::DateTime, OpenHAB::DSL::Items::DateTimeItem
+            when Types::QuantityType,
+              Types::DateTimeType,
+              Items::DateTimeItem,
+              Items::NumericItem
               other == self
             else
               super
             end
           end
+
+          # {include:StringExtensions}
+          def <=>(other)
+            case other
+            when Types::QuantityType,
+              Types::DateTimeType,
+              Items::DateTimeItem,
+              Items::NumericItem
+              (other <=> self)&.-@()
+            else
+              super
+            end
+          end
         end
       end
     end
   end
 end
 
-#
-# Prepend String class with comparison extensions
-#
-class String
-  prepend OpenHAB::DSL::MonkeyPatch::Ruby::StringExtensions
-end
+String.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::StringExtensions)

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Rules
+      # Module containing terse rule stubs
+      module Terse
+        %i[changed channel cron every updated received_command].each do |trigger|
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{trigger}(*args, name: nil, **kwargs, &block)                   # def changed(*args, name: nil, **kwargs, &block)
+              # if no name is given, just default to the name of the rules file  #   # if no name is given, just default to the name of the rules file
+              name ||= File.basename(caller_locations.last.path)                 #   name ||= File.basename(caller_locations.last.path)
+              rule name do                                                       #   rule name do
+                #{trigger}(*args, **kwargs)                                      #     changed(*args, **kwargs)
+                run(&block)                                                      #     run(&block)
+              end                                                                #   end
+            end                                                                  # end
+            module_function #{trigger.inspect}                                   # module_function :changed
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/states.rb

@@ -48,7 +48,7 @@ module OpenHAB
       # @return [StateStorage] item states
       #
       def store_states(*items)
-        items = items.flatten.map { |item| item.respond_to?(:oh_item) ? item.oh_item : item }
+        items = items.flatten
         states = StateStorage.new(BusEvent.storeStates(*items).to_h)
         if block_given?
           yield

data/lib/openhab/dsl/time_of_day.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'java'
 require 'openhab/log/logger'
-require 'openhab/dsl/items/datetime_item'
-require 'openhab/dsl/types/datetime'
+require 'openhab/dsl/types/date_time_type'
 require 'time'
 
 module OpenHAB
@@ -173,7 +171,7 @@ module OpenHAB
           case object
           when TimeOfDay then adjust_second_of_day(object.local_time.to_second_of_day)
           when String then adjust_second_of_day(TimeOfDay.parse(object).local_time.to_second_of_day)
-          when Time, OpenHAB::DSL::Types::DateTime, OpenHAB::DSL::Items::DateTimeItem
+          when Time, OpenHAB::DSL::Types::DateTimeType, OpenHAB::DSL::Items::DateTimeItem
             adjust_second_of_day(TimeOfDay.new(h: object.hour, m: object.min, s: object.sec)
             .local_time.to_second_of_day)
           when TimeOfDayRangeElement then object.sod
@@ -218,7 +216,7 @@ module OpenHAB
       private_class_method def to_time_of_day(object)
         case object
         when String then TimeOfDay.parse(object)
-        when Time, OpenHAB::DSL::Types::DateTime, OpenHAB::DSL::Items::DateTimeItem
+        when Time, OpenHAB::DSL::Types::DateTimeType, OpenHAB::DSL::Items::DateTimeItem
           TimeOfDay.new(h: object.hour, m: object.min, s: object.sec)
         else object
         end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    # Comparable#== is overwritten by Type, because DecimalType etc.
+    # inherits from Comparable on the Java side, so it's in the wrong place
+    # in the ancestor list
+    # @!visibility private
+    module ComparableType
+      # re-implement
+      # @!visibility private
+      def ==(other)
+        r = self <=> other
+
+        return false if r.nil?
+
+        r.zero?
+      end
+    end
+  end
+end