openhab-scripting 4.33.1 → 4.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0fd2f85782ad0a007078d471419f3f9992b458208a7874e39e80ecd5a85d0d8
-  data.tar.gz: 41f084c809a72e5bec86051ebe717ed23754071f41fec8ecc440eeb6b8213116
+  metadata.gz: a64a452ca8ff7c31d08ceed61a6e2d466250438365ea71c4de1c968b33198f8c
+  data.tar.gz: 31e41c724ad7b7871e913044259f5d3736130d5634d2f9301b98c7093b97f804
 SHA512:
-  metadata.gz: 94153780fdbbc416f95d75629cd5e379538d5e9be267286ed92f765bb18fc1c3a373ccf6abc8e9053bc03d36779270f177c9174858281a0bd00016bdadf4ffa5
-  data.tar.gz: dc8c70670e7ca22e718339e2247de37e8cf6b6c50a4039ade08b6ecb0247a42f6c44adf3e43f088c4fc12088de757f807ba578e8d1f4806f8d0a76d07504b2df
+  metadata.gz: 1cb0812ede637a43674c260dce7124a38fce48c0940cae506125f9c5d6c3ebc3fa08d229a92155060fc5eb816b9e946874cebbc6e0d9654b3405e75879b1dbfd
+  data.tar.gz: cf04212fd7483729494be64840f74c9d6d5241c35c87e4c46f7207c8a007a9d0c537a8379481172d8395cf27c74eae5764d2d2e65ef984d7478104778e19c4a0

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

@@ -42,7 +42,7 @@ module OpenHAB
           @guard = config.guard
           # Convert between to correct range or nil if not set
           between = config.between&.then { between(config.between) }
-          @between = between || OpenHAB::DSL::Between::ALL_DAY
+          @between = between
           @trigger_conditions = config.trigger_conditions
           @attachments = config.attachments
         end
@@ -153,6 +153,8 @@ module OpenHAB
         # Loggging inflates method length
         def check_guards(event:)
           if @guard.should_run? event
+            return true if @between.nil?
+
             now = Time.now
             return true if @between.cover? now
 

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

@@ -13,16 +13,19 @@ module OpenHAB
         #
         # Create a rule that executes at the specified interval
         #
-        # @param [Object] value Symbol or Duration to execute this rule
+        # @param [Object] value String, Symbol, Duration, or MonthDay to execute this rule
         # @param [Object] at TimeOfDay or String representing TimeOfDay in which to execute rule
         # @param [Object] attach object to be attached to the trigger
         #
         #
         def every(value, at: nil, attach: nil)
+          return every(MonthDay.parse(value), at: at, attach: attach) if value.is_a? String
+
           cron_expression = case value
                             when Symbol then Cron.from_symbol(value, at)
                             when Java::JavaTime::Duration then Cron.from_duration(value, at)
-                            else raise ArgumentExpression, 'Unknown interval'
+                            when Java::JavaTime::MonthDay then Cron.from_monthday(value, at)
+                            else raise ArgumentError, 'Unknown interval'
                             end
           cron(cron_expression, attach: attach)
         end
@@ -32,8 +35,18 @@ module OpenHAB
         #
         # @param [String] expression OpenHAB style cron expression
         # @param [Object] attach object to be attached to the trigger
+        # @param [Hash] elements cron expression elements (second, minute, hour, dom, month, dow, year)
         #
-        def cron(expression, attach: nil)
+        def cron(expression = nil, attach: nil, **fields)
+          if fields.any?
+            raise ArgumentError, 'Cron elements cannot be used with a cron expression' if expression
+
+            cron_expression = Cron.from_fields(fields)
+            return cron(cron_expression, attach: attach)
+          end
+
+          raise ArgumentError, 'Missing cron expression or elements' unless expression
+
           cron = Cron.new(rule_triggers: @rule_triggers)
           cron.trigger(config: { 'cronExpression' => expression }, attach: attach)
         end
@@ -59,7 +72,8 @@ module OpenHAB
               hour: '*',
               dom: '?',
               month: '*',
-              dow: '?'
+              dow: '?',
+              year: '*'
             }.freeze
           private_constant :CRON_EXPRESSION_MAP
 
@@ -96,7 +110,7 @@ module OpenHAB
           #
           # Create a cron map from a duration
           #
-          # @param [java::time::Duration] duration
+          # @param [Java::JavaTime::Duration] duration
           # @param [Object] at TimeOfDay or String representing time of day
           #
           # @return [Hash] map describing cron expression
@@ -107,6 +121,20 @@ module OpenHAB
             map_to_cron(duration_to_map(duration))
           end
 
+          #
+          # Create a cron map from a MonthDay
+          #
+          # @param [Java::JavaTime::MonthDay] month_day
+          # @param [Object] at TimeOfDay or String representing time of day
+          #
+          # @return [Hash] map describing cron expression
+          #
+          def self.from_monthday(monthday, at)
+            expression_map = EXPRESSION_MAP[:day].merge(month: monthday.month_value, dom: monthday.day_of_month)
+            expression_map = at_condition(expression_map, at) if at
+            map_to_cron(expression_map)
+          end
+
           #
           # Create a cron map from a symbol
           #
@@ -121,6 +149,19 @@ module OpenHAB
             map_to_cron(expression_map)
           end
 
+          #
+          # Create a cron map from cron elements
+          #
+          # @param [Hash] elements Cron fields (second, minute, hour, dom, month, dow, year)
+          #
+          # @return [Hash] map describing cron expression
+          #
+          def self.from_fields(fields)
+            fields = fields.transform_values { |value| value.to_s.gsub(/\s+/, '') }
+            expression_map = CRON_EXPRESSION_MAP.merge(fields)
+            map_to_cron(expression_map)
+          end
+
           #
           # Map cron expression to to cron string
           #
@@ -129,7 +170,7 @@ module OpenHAB
           # @return [String] OpenHAB cron string
           #
           def self.map_to_cron(map)
-            %i[second minute hour dom month dow].map { |field| map.fetch(field) }.join(' ')
+            %i[second minute hour dom month dow year].map { |field| map.fetch(field) }.join(' ')
           end
 
           #

data/lib/openhab/dsl/states.rb

@@ -28,6 +28,18 @@ module OpenHAB
         end
         states
       end
+
+      #
+      # Check if all the given items have a state (not UNDEF or NULL)
+      #
+      # @param [Array] items whose state must be non-nil
+      # @param [<Type>] check_things when true, also ensures that all linked things are online
+      #
+      # @return [Boolean] true if all the items have a state, false otherwise
+      #
+      def state?(*items, things: false)
+        items.flatten.all? { |item| (!things || item.things.all?(&:online?)) && item.state? }
+      end
     end
 
     module Support

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.33.1
+  version: 4.35.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler