openhab-scripting 4.17.0 → 4.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15ce3ee9beba70f7ec3bb9f22b7c805a3c73dfb08e8b13f8ca7eb9cf8625f367
-  data.tar.gz: 26afc00545927a29657b00ef76bcce40f3d6b831d01362d4a5e9d187c8a6c4b8
+  metadata.gz: 48c997bfb2b0275d7c7666b905eb1599e020c9d434965d9093613540b77460b1
+  data.tar.gz: a81a610e16bb811762faf1e7317432a86e7c332d7356b1b2bea827d674f1442c
 SHA512:
-  metadata.gz: e8db2e2ae436fb49c7de5de26c1570de4b32f279b43b26c5e5e445460c3b496feb9bbeb0a90acab7954de8b664b22d8051f32f4bd8d97fc0ae04e916cbbb9661
-  data.tar.gz: f43eaebacfb2bae1c84c9aa5b275d6256dfd10bffae4aa8722e84d6c83adca275a057080b98acb4875c001bb15c405ade84692008b25aef1d5df20ca87b3666a
+  metadata.gz: ae48e5f3f7e607c81fd2343a094b88e1b6c2041dc398357401ede48a41f0259f60d7c100afc4e3bd3d5217f635cf0d31e77cf072fbbe2b3871bf4f2d85477d94
+  data.tar.gz: 2ad2e05fa15ebc3a6de85ed5de804935d7d48d3b3e6a442dce0846fb0ccf993d07c04d09bed6861d4eb0d1b247a4d20a2d045156f150c9e76105fa7f9a75c361

data/lib/openhab/dsl/dsl.rb

@@ -19,6 +19,7 @@ require 'openhab/dsl/things'
 require 'openhab/dsl/between'
 require 'openhab/dsl/gems'
 require 'openhab/dsl/persistence'
+require 'openhab/dsl/uid'
 require 'openhab/dsl/units'
 require 'openhab/dsl/states'
 

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

@@ -20,6 +20,14 @@ module OpenHAB
           on?
         end
 
+        # Convert boolean commands to ON/OFF
+        # @!visibility private
+        def format_type(command)
+          return Types::OnOffType.from(command) if [true, false].include?(command)
+
+          super
+        end
+
         #
         # Send a command to invert the state of the switch
         #

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

@@ -38,6 +38,7 @@ module OpenHAB
         config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
         logger.trace { config.inspect }
         process_rule_config(config)
+        nil # Must return something other than the rule object. See https://github.com/boc-tothefuture/openhab-jruby/issues/438
       rescue StandardError => e
         re_raise_with_backtrace(e)
       end

data/lib/openhab/dsl/rules/triggers/channel.rb

@@ -15,16 +15,19 @@ module OpenHAB
         #
         # Creates a channel trigger
         #
-        # @param [Array] channels array to create triggers for on form of 'binding_id:type_id:thing_id#channel_id'
+        # @param [String, Channel, ChannelUID, Array<String, Channel, ChannelUID>] channels
+        #   channels to create triggers for in form of 'binding_id:type_id:thing_id#channel_id'
         #   or 'channel_id' if thing is provided
-        # @param [thing] thing to create trigger for if not specified with the channel
-        # @param [String] triggered specific triggering condition to match for trigger
-        #
-        #
-        def channel(*channels, thing: nil, triggered: nil, attach: nil)
-          channels.flatten.each do |channel|
-            channel = [thing, channel].join(':') if thing
-            logger.trace("Creating channel trigger for channel(#{channel}), thing(#{thing}), trigger(#{triggered})")
+        # @param [String, Thing, ThingUID, Array<String, Thing, ThingUID>] thing
+        #   thing(s) to create trigger for if not specified with the channel
+        # @param [String, Array<String>] triggered specific triggering condition(s) to match for trigger
+        #
+        def channel(*channels, thing: nil, triggered: nil, attach: nil) # rubocop:disable Metrics/AbcSize
+          channels.flatten.product([thing].flatten).each do |(channel, t)|
+            channel = channel.uid if channel.is_a?(org.openhab.core.thing.Channel)
+            t = t.uid if t.is_a?(Thing)
+            channel = [t, channel].compact.join(':')
+            logger.trace("Creating channel trigger for channel(#{channel}), thing(#{t}), trigger(#{triggered})")
             [triggered].flatten.each do |trigger|
               create_channel_trigger(channel, trigger, attach)
             end
@@ -36,14 +39,13 @@ module OpenHAB
         #
         # Create a trigger for a channel
         #
-        # @param [Channel] channel to look for triggers
-        # @param [Trigger] trigger specific channel trigger to match
+        # @param [String] channel to look for triggers
+        # @param [String] trigger specific channel trigger to match
         #
         #
         def create_channel_trigger(channel, trigger, attach)
           config = { 'channelUID' => channel }
           config['event'] = trigger.to_s unless trigger.nil?
-          config['channelUID'] = channel
           logger.trace("Creating Change Trigger for #{config}")
           append_trigger(Trigger::CHANNEL_EVENT, config, attach: attach)
         end

data/lib/openhab/dsl/things.rb

@@ -14,7 +14,7 @@ module OpenHAB
     # Support for OpenHAB Things
     #
     module Things
-      java_import Java::OrgOpenhabCoreThing::ThingStatus
+      java_import org.openhab.core.thing.ThingStatus
       include OpenHAB::Log
 
       #

data/lib/openhab/dsl/timers/timer.rb

@@ -41,7 +41,7 @@ module OpenHAB
 
           semaphore.synchronize do
             @timer = ScriptExecution.createTimer(
-              ZonedDateTime.now.plus(@duration), timer_block(semaphore, &block)
+              ZonedDateTime.now.plus(to_duration(@duration)), timer_block(semaphore, &block)
             )
             @rule_timers = Thread.current[:rule_timers]
             super(@timer)
@@ -57,15 +57,13 @@ module OpenHAB
         # @return [Timer] Rescheduled timer instances
         #
         def reschedule(duration = nil)
-          unless duration.nil? || duration.is_a?(Java::JavaTimeTemporal::TemporalAmount)
-            raise ArgumentError, 'Supplied argument must be a duration'
-          end
-
           duration ||= @duration
+
           Timers.timer_manager.add(self)
-          @timer.reschedule(ZonedDateTime.now.plus(duration))
+          @timer.reschedule(ZonedDateTime.now.plus(to_duration(duration)))
         end
 
+        #
         # Cancel timer
         #
         # @return [Boolean] True if cancel was successful, false otherwise
@@ -92,6 +90,27 @@ module OpenHAB
             end
           }
         end
+
+        #
+        # Convert argument to a duration
+        #
+        # @params [Java::JavaTimeTemporal::TemporalAmount, #to_f, #to_i, nil] duration Duration
+        #
+        # @raise if duration cannot be used for a timer
+        #
+        # @return Argument converted to seconds if it responds to #to_f or #to_i, otherwise duration unchanged
+        #
+        def to_duration(duration)
+          if duration.nil? || duration.is_a?(Java::JavaTimeTemporal::TemporalAmount)
+            duration
+          elsif duration.respond_to?(:to_f)
+            duration.to_f.seconds
+          elsif duration.respond_to?(:to_i)
+            duration.to_i.seconds
+          else
+            raise ArgumentError, "Supplied argument '#{duration}' cannot be converted to a duration"
+          end
+        end
       end
     end
   end

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

@@ -41,6 +41,20 @@ module OpenHAB
           equals(other)
         end
 
+        #
+        # Case equality
+        #
+        # @return [Boolean] if the values are of the same Type
+        #                   or item state of the same type
+        #
+        def ===(other)
+          logger.trace("(#{self.class}) #{self} === #{other} (#{other.class})")
+          other = other.state if other.respond_to?(:state)
+          return false unless instance_of?(other.class)
+
+          eql?(other)
+        end
+
         #
         # Check equality, including type conversion
         #

data/lib/openhab/dsl/uid.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    java_import org.openhab.core.common.AbstractUID
+    java_import org.openhab.core.thing.ThingTypeUID
+
+    # Adds methods to core OpenHAB AbstractUID to make it more natural in Ruby
+    class AbstractUID
+      # implicit conversion to string
+      alias to_str to_s
+      # inspect result is just the string representation
+      alias inspect to_s
+
+      # compares if equal to `other`, including string conversion
+      # @return [true, false]
+      def ==(other)
+        return true if equals(other)
+
+        to_s == other
+      end
+    end
+
+    # Adds methods to core OpenHAB ThingUID to make it more natural in Ruby
+    class ThingUID
+      # Returns the id of the binding this thing belongs to
+      # @return [String]
+      def binding_id
+        get_segment(0)
+      end
+    end
+
+    # Adds methods to core OpenHAB ThingTypeUID to make it more natural in Ruby
+    class ThingTypeUID
+      # Returns the id of the binding this thing type belongs to
+      # @return [String]
+      def binding_id
+        get_segment(0)
+      end
+    end
+
+    # have to remove == from all descendant classes so that they'll inherit
+    # the new implementation
+    [org.openhab.core.items.MetadataKey,
+     org.openhab.core.thing.UID,
+     org.openhab.core.thing.ChannelUID,
+     org.openhab.core.thing.ChannelGroupUID,
+     org.openhab.core.thing.ThingUID,
+     org.openhab.core.thing.ThingTypeUID,
+     org.openhab.core.thing.type.ChannelTypeUID,
+     org.openhab.core.thing.type.ChannelGroupTypeUID].each do |klass|
+      klass.remove_method(:==)
+    end
+  end
+end

data/lib/openhab/version.rb

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

data/lib/openhab.rb

@@ -20,23 +20,18 @@ module OpenHAB
   #
   #
   # Number of extensions and includes requires more lines
-  # rubocop: disable Metrics/MethodLength
   def self.extended(base)
     OpenHAB::Core.wait_till_openhab_ready
     base.extend Log
     base.extend OpenHAB::Core::ScriptHandling
     base.extend OpenHAB::Core::EntityLookup
     base.extend OpenHAB::DSL
-    base.extend OpenHAB::DSL::Between
 
     base.send :include, OpenHAB::Core::ScriptHandlingCallbacks
-    base.send :include, OpenHAB::DSL::Items
-    base.send :include, OpenHAB::DSL::Types
     logger.info "OpenHAB JRuby Scripting Library Version #{OpenHAB::VERSION} Loaded"
 
     OpenHAB::Core.add_rubylib_to_load_path
   end
-  # rubocop: enable Metrics/MethodLength
 end
 
 # Extend caller with OpenHAB methods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 4.20.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,7 @@ files:
 - lib/openhab/dsl/types/types.rb
 - lib/openhab/dsl/types/un_def_type.rb
 - lib/openhab/dsl/types/up_down_type.rb
+- lib/openhab/dsl/uid.rb
 - lib/openhab/dsl/units.rb
 - lib/openhab/log/configuration.rb
 - lib/openhab/log/logger.rb