openhab-scripting 4.0.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf75e647f468a653d6848739cf2552ba57b9d1b1d81f33eed2f3719315d28d11
-  data.tar.gz: 8f6403a4642e1edd1eb3047d438939b5d127c0fd0eca57c8989e9a72bf0bdb39
+  metadata.gz: 4d752e22ac324370b7c63e7e38455cd919f3f64abece0fc7ab62fd29c72953b7
+  data.tar.gz: 34c7cd408a075c831e7ea75e55f907bd57203268da81f34e318657d18ad6a90f
 SHA512:
-  metadata.gz: 9e0ea6a8962334965162c95ff2db82a3fcf0485c6b80fefd2ea0814d0883678052bd52306093ea70e2cb0aec9e3fb8df42fd9290f9b9b21ddfb71db11649f104
-  data.tar.gz: 4d492998dd50c6b25fd845df988d7ef418e5d2a8a66c339bf5fabf990cd6380d6a588ee6fc899d47d697564b78c88397a77d362a39da0a6d7f9d7ba3c99d4c71
+  metadata.gz: bc29460c4a427f81fa6a8ce0760d746d0bf1513574e72f89a17c4d5647c22dc860abe12c60d4a0904f5c32927725bed03ff8ff62212bd45217e05d9b9e3fe01a
+  data.tar.gz: b29f6d50649f32134815cb71b9c2d42b466f9d0147a613bbc2225f99469f5c5d4194a7a5c47f81c20757b149c2e5bcc7133fc6b099025f43132ecef25bb2cfc2

data/lib/openhab/dsl/group.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require 'delegate'
-require 'forwardable'
+require 'java'
+require 'singleton'
+
 require 'openhab/core/entity_lookup'
 require 'openhab/dsl/items/group_item'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -14,16 +16,27 @@ module OpenHAB
       #
       # Provide access to groups as a set
       #
-      class Groups < SimpleDelegator
+      class Groups
+        include LazyArray
+        include Singleton
+
         #
         # Get a OpenHAB Group by name
         # @param [String] name of the group to retrieve
         #
         # @return [Set] of OpenHAB Groups
         #
-        def[](name)
-          group = OpenHAB::Core::EntityLookup.lookup_item(name)
-          group.is_a?(OpenHAB::DSL::Items::GroupItem) ? group : nil
+        def [](name)
+          group = Core::EntityLookup.lookup_item(name)
+          group.is_a?(Items::GroupItem) ? group : nil
+        end
+        alias include? []
+        alias key? include?
+
+        # explicit conversion to array
+        def to_a
+          items = $ir.items.grep(org.openhab.core.items.GroupItem) # rubocop:disable Style/GlobalVars
+          Core::EntityLookup.decorate_items(items)
         end
       end
 
@@ -33,9 +46,7 @@ module OpenHAB
       # @return [Set] of OpenHAB Groups
       #
       def groups
-        # rubocop: disable Style/GlobalVars
-        Groups.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.grep(Java::OrgOpenhabCoreItems::GroupItem)))
-        # rubocop: enable Style/GlobalVars
+        Groups.instance
       end
     end
   end

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

@@ -3,9 +3,11 @@
 require 'delegate'
 require 'forwardable'
 require 'java'
+
+require 'openhab/core/entity_lookup'
 require 'openhab/dsl/items/item_command'
 require 'openhab/dsl/items/item_delegate'
-require 'openhab/core/entity_lookup'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -13,7 +15,9 @@ module OpenHAB
       #
       # Class for indicating to triggers that a group trigger should be used
       #
-      class GroupMembers < SimpleDelegator
+      class GroupMembers
+        include LazyArray
+
         attr_reader :group
 
         #
@@ -23,7 +27,11 @@ module OpenHAB
         #
         def initialize(group_item)
           @group = group_item
-          super(OpenHAB::Core::EntityLookup.decorate_items(@group.members.to_a))
+        end
+
+        # explicit conversion to array
+        def to_a
+          OpenHAB::Core::EntityLookup.decorate_items(group.members.to_a)
         end
       end
 
@@ -74,7 +82,7 @@ module OpenHAB
         # Iterates through the direct members of the Group
         #
         def each(&block)
-          OpenHAB::Core::EntityLookup.decorate_items(@group_item.members.to_a).each(&block)
+          members.each(&block)
         end
 
         #

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'singleton'
+
 require 'openhab/core/entity_lookup'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -12,11 +15,14 @@ module OpenHAB
       #
       # Delegates to underlying set of all OpenHAB Items, provides convenience methods
       #
-      class Items < SimpleDelegator
+      class Items
+        include LazyArray
+        include Singleton
+
         # Fetches the named item from the the ItemRegistry
         # @param [String] name
         # @return Item from registry, nil if item missing or requested item is a Group Type
-        def[](name)
+        def [](name)
           OpenHAB::Core::EntityLookup.lookup_item(name)
         rescue Java::OrgOpenhabCoreItems::ItemNotFoundException
           nil
@@ -26,19 +32,21 @@ module OpenHAB
         # @param name [String] Item name to check
         # @return [Boolean] true if the item exists, false otherwise
         def include?(name)
-          # rubocop: disable Style/GlobalVars
-          !$ir.getItems(name).empty?
-          # rubocop: enable Style/GlobalVars
+          !$ir.getItems(name).empty? # rubocop: disable Style/GlobalVars
+        end
+        alias key? []
+
+        # explicit conversion to array
+        def to_a
+          items = $ir.items.grep_v(org.openhab.core.items.GroupItem) # rubocop:disable Style/GlobalVars
+          OpenHAB::Core::EntityLookup.decorate_items(items)
         end
-        alias key? include?
       end
 
       # Fetches all non-group items from the item registry
       # @return [OpenHAB::DSL::Items::Items]
       def items
-        # rubocop: disable Style/GlobalVars
-        Items.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.grep_v(Java::OrgOpenhabCoreItems::GroupItem)))
-        # rubocop: enable Style/GlobalVars
+        Items.instance
       end
     end
   end

data/lib/openhab/dsl/lazy_array.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    # common base class for array-like collections that have lookup
+    # methods to avoid instantiating the elements if you only use
+    # the lookup method
+    #
+    # your class should implement to_a
+    #
+    module LazyArray
+      include Enumerable
+
+      # Calls the given block once for each Thing, passing that Thing as a
+      # parameter. Returns self.
+      #
+      # If no block is given, an Enumerator is returned.
+      def each(&block)
+        to_a.each(&block)
+        self
+      end
+
+      # implicitly convertible to array
+      def to_ary
+        to_a
+      end
+
+      # delegate any other methods to the actual array
+      # exclude mutating methods though
+      def method_missing(method, *args, &block)
+        return to_a.send(method, *args, &block) if method[-1] != '!' && Array.instance_methods.include?(method)
+
+        super
+      end
+
+      # advertise that methods exist that would be delegated to Array
+      def respond_to_missing?(method, include_private = false)
+        return true if method[-1] != '!' && Array.instance_methods.include?(method.to_sym)
+
+        super
+      end
+    end
+  end
+end

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

@@ -16,6 +16,11 @@ module OpenHAB
         # MonkeyPatching Decimal Type
         #
         class DecimalType
+          extend Forwardable
+
+          delegate %i[to_d zero?] => :to_big_decimal
+          delegate %i[positive? negative?] => :to_d
+
           #
           # @param [Object] other object to compare to
           #

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

@@ -22,7 +22,7 @@ module OpenHAB
         #
         #
         def received_command(*items, command: nil, commands: nil)
-          separate_groups(items).flatten.each do |item|
+          separate_groups(items).each do |item|
             logger.trace("Creating received command trigger for item(#{item})"\
                          "command(#{command}) commands(#{commands})")
 

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

@@ -61,9 +61,13 @@ module OpenHAB
         # @return [Array] A new flat array with any GroupMembers object left intact
         #
         def separate_groups(item_array)
-          return item_array if item_array.grep(Array).length.zero?
+          # we want to support anything that can be flattened... i.e. responds to to_ary
+          # we want to be more lenient than only things that are currently Array,
+          # but Enumerable is too lenient because Array#flatten won't traverse interior
+          # Enumerables
+          return item_array unless item_array.find { |item| item.respond_to?(:to_ary) }
 
-          groups, items = item_array.partition { |item| item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers }
+          groups, items = item_array.partition { |item| item.is_a?(OpenHAB::DSL::Items::GroupItem::GroupMembers) }
           groups + separate_groups(items.flatten(1))
         end
 

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

@@ -20,7 +20,7 @@ module OpenHAB
         # @return [Trigger] Trigger for updated entity
         #
         def updated(*items, to: nil)
-          separate_groups(items).flatten.each do |item|
+          separate_groups(items).each do |item|
             logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
             [to].flatten.each do |to_state|
               trigger, config = create_update_trigger(item, to_state)

data/lib/openhab/dsl/things.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require 'delegate'
 require 'java'
+require 'singleton'
+
 require 'openhab/log/logger'
 require 'openhab/dsl/actions'
-require 'delegate'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -76,32 +79,36 @@ module OpenHAB
       #
       # Wraps all Things in a delegator to underlying set and provides lookup method
       #
-      class Things < SimpleDelegator
-        java_import org.openhab.core.thing.ThingUID
+      class Things
+        include LazyArray
+        include Singleton
 
         # Gets a specific thing by name in the format binding_id:type_id:thing_id
         # @return Thing specified by name or nil if name does not exist in thing registry
-        def[](uid)
-          thing_uid = ThingUID.new(*uid.split(':'))
-          # rubocop: disable Style/GlobalVars
-          thing = $things.get(thing_uid)
-          # rubocop: enable Style/GlobalVars
+        def [](uid)
+          thing_uid = org.openhab.core.thing.ThingUID.new(*uid.split(':'))
+          thing = $things.get(thing_uid) # rubocop: disable Style/GlobalVars
           return unless thing
 
           logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
           Thing.new(thing)
         end
+        alias include? []
+        alias key? []
+
+        # explicit conversion to array
+        def to_a
+          $things.getAll.map { |thing| Thing.new(thing) } # rubocop: disable Style/GlobalVars
+        end
       end
 
       #
       # Get all things known to OpenHAB
       #
-      # @return [Set] of all Thing objects known to openhab
+      # @return [Things] all Thing objects known to OpenHAB
       #
       def things
-        # rubocop: disable Style/GlobalVars
-        Things.new($things.getAll.map { |thing| Thing.new(thing) }.to_set)
-        # rubocop: enable Style/GlobalVars
+        Things.instance
       end
     end
   end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - lib/openhab/dsl/items/player_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb
 - lib/openhab/dsl/items/string_item.rb
+- lib/openhab/dsl/lazy_array.rb
 - lib/openhab/dsl/monkey_patch/actions/actions.rb
 - lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb
 - lib/openhab/dsl/monkey_patch/events/events.rb