openhab-scripting 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ebe32d36d3366345d28b81bc71d9cd315d1d84feb4a4f1745c882209b1fdbe2
-  data.tar.gz: 95331e97286e86bc993eb979531c5e3f80bc203e752e97aa9f3a60698fd56274
+  metadata.gz: 34dcff6b869bdb1bbcf1e61d84ffe7ff07d039204ee868d16f0f249c3074e898
+  data.tar.gz: 39645a3f3486d9bba7db56a43d4c60883c346eea007242603a2dd2f7c8aa3b6e
 SHA512:
-  metadata.gz: e406fa7d011a733376bb5977293f44d20b893f1f990486f342c541f8d287c453736b75007ba586bfc5e6801638ac71bc6d294ad1b4a436a83247bee157150eb0
-  data.tar.gz: d4fad57e6ad4f71a969b8f8c6791c4240854a74800647a4bed770123221eb2491c251c2a28bcbcd1649225d348aadd91b0efc188adba16a56aa7115620224028
+  metadata.gz: 303f0751aac26ab7f28a4350ff03151a3a03bb1559f51ae0130c830ea5e20d6bb4165929a173ed4e749cf62ee0e4ab66f1f79845e8e851d44a288407e11be5a5
+  data.tar.gz: dfee68ab34f41a303886bc8028ae7a30ff4baaee2fd87cc75602bfa7d82f57c2c3a7bf6190f6efecdb2a364c21a4514fe59984e9da8574cf19c5f3fd782abc7e

data/lib/openhab/dsl/dsl.rb

@@ -10,6 +10,7 @@ require 'openhab/dsl/monkey_patch/ruby/ruby'
 require 'openhab/dsl/monkey_patch/events/events'
 require 'openhab/dsl/monkey_patch/actions/actions'
 require 'openhab/dsl/rules/rule'
+require 'openhab/dsl/rules/terse'
 require 'openhab/dsl/actions'
 require 'openhab/dsl/timers'
 require 'openhab/dsl/group'
@@ -34,6 +35,7 @@ module OpenHAB
       base.send :include, OpenHAB::DSL::Items
       base.send :include, OpenHAB::DSL::Persistence
       base.send :include, OpenHAB::DSL::Rules
+      base.send :include, OpenHAB::DSL::Rules::Terse
       base.send :include, OpenHAB::DSL::States
       base.send :include, OpenHAB::DSL::Things
       base.send :include, OpenHAB::DSL::Timers

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

@@ -3,6 +3,8 @@
 require 'openhab/dsl/items/metadata'
 require 'openhab/dsl/items/persistence'
 
+require_relative 'item_equality'
+
 module OpenHAB
   module DSL
     module Items
@@ -12,6 +14,8 @@ module OpenHAB
       # Ruby
       class GenericItem
         include Log
+        include ItemEquality
+
         prepend Metadata
         prepend Persistence
 
@@ -135,33 +139,6 @@ module OpenHAB
           other.instance_of?(self.class) && hash == other.hash
         end
 
-        #
-        # Check equality, with type conversions
-        #
-        # @param [GenericItem, Types::Type, Object] other object to
-        #   compare to
-        #
-        #   If this item is +NULL+ or +UNDEF+, and +other+ is nil, they are
-        #   considered equal
-        #
-        #   If this item is +NULL+ or +UNDEF+, and other is a {GenericItem}, they
-        #   are only considered equal if the other item is in the exact same
-        #   state (i.e. +NULL+ != +UNDEF+)
-        #
-        #   Otherwise, the state of this item is compared with +other+
-        #
-        # @return [Boolean]
-        #
-        def ==(other)
-          logger.trace("(#{self.class}) #{self} == #{other} (#{other.class})")
-          return true if equal?(other) || eql?(other)
-          return true if !state? && other.nil?
-
-          return raw_state == other.raw_state if other.is_a?(GenericItem)
-
-          state == other
-        end
-
         # @!method null?
         #   Check if the item state == +NULL+
         #   @return [Boolean]

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Items
+      # Shared method for checking item equality by delegating to state
+      module ItemEquality
+        # Check equality, with type conversions
+        #
+        # @param [GenericItem, Types::Type, Object] other object to
+        #   compare to
+        #
+        #   If this item is +NULL+ or +UNDEF+, and +other+ is nil, they are
+        #   considered equal
+        #
+        #   If this item is +NULL+ or +UNDEF+, and other is a {GenericItem}, they
+        #   are only considered equal if the other item is in the exact same
+        #   state (i.e. +NULL+ != +UNDEF+)
+        #
+        #   Otherwise, the state of this item is compared with +other+
+        #
+        # @return [Boolean]
+        #
+        def ==(other)
+          logger.trace("(#{self.class}) #{self} == #{other} (#{other.class})")
+          return true if equal?(other) || eql?(other)
+          return true if !state? && other.nil?
+
+          return raw_state == other.raw_state if other.is_a?(GenericItem)
+
+          state == other
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,8 @@
 
 require 'forwardable'
 
-require 'openhab/dsl/items/comparable_item'
+require_relative 'comparable_item'
+require_relative 'item_equality'
 
 module OpenHAB
   module DSL
@@ -15,6 +16,7 @@ module OpenHAB
 
         # apply meta-programming methods to including class
         def self.included(klass)
+          klass.prepend ItemEquality # make sure this is first
           klass.extend Forwardable
           klass.delegate %i[+ - * / % | positive? negative? to_d to_f to_i to_int zero?] => :state
           # remove the JRuby default == so that we can inherit the Ruby method

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ files:
 - lib/openhab/dsl/items/generic_item.rb
 - lib/openhab/dsl/items/group_item.rb
 - lib/openhab/dsl/items/image_item.rb
+- lib/openhab/dsl/items/item_equality.rb
 - lib/openhab/dsl/items/item_registry.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/metadata.rb
@@ -89,6 +90,7 @@ files:
 - lib/openhab/dsl/rules/property.rb
 - lib/openhab/dsl/rules/rule.rb
 - lib/openhab/dsl/rules/rule_config.rb
+- lib/openhab/dsl/rules/terse.rb
 - lib/openhab/dsl/rules/triggers/changed.rb
 - lib/openhab/dsl/rules/triggers/channel.rb
 - lib/openhab/dsl/rules/triggers/command.rb