rspec-openhab-scripting 0.0.4-java → 0.0.7-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29dc9d000dc362c190a0bc94a93157b62d82ca884ab9294ebae673c3e83606ad
-  data.tar.gz: c60c6ee40ba4cc183a5e73bb97140738e3af52b10661bb4aa86f8d519f385903
+  metadata.gz: 76dfb6fa24e9d5efd4f0857cde57ae0c299f7ff5b6c16d08981fe04aa5ab3f52
+  data.tar.gz: b587bf33488da0f9a095eba35997ae4e615b6f8729ed11e1f8c514d1a195e7e1
 SHA512:
-  metadata.gz: d5d10546a4617918135c998db4e26d51a03519ac0ab48e41367c4da6064b2e771986af4aad1e5f2dcc757e152fa3a7791494517f58bd9de76faba22a6035395c
-  data.tar.gz: d7eafd0592fe84c0dfd8753a783cf9639eeb28cd803a80237a15ec70e49f23afe00934ff65a63691b8c50d1ad07b2aff1f3085ea890f4b8f042436dbb50f1924
+  metadata.gz: 80961c7142353a5cd237414ed8a854a1ce33ef4fe0a32c758bf3a41921e6a3cf92e811fc635b9c72cc5e2d59cf1eb92710ad0a8cbb6cf6a357400180e8c4ba56
+  data.tar.gz: a3cef22e84c40c6f9780830873a0ac1c548e7076c81df9afe9d8fbe9e9bb30e9c316dc6352d329e1c7d95c0be470ebb319f2a7d2c3668c9b8462b24e7e45ebca

data/lib/rspec/openhab/actions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Actions
+      # redefine these to do nothing so that rules won't fail
+      def notify(msg, email: nil) # rubocop:disable Lint/UnusedMethodArgument:
+        logger.debug("notify: #{msg}")
+      end
+
+      def say(text, voice: nil, sink: nil, volume: nil) # rubocop:disable Lint/UnusedMethodArgument:
+        logger.debug("say: #{text}")
+      end
+
+      def play_sound(filename, sink: nil, volume: nil) # rubocop:disable Lint/UnusedMethodArgument:
+        logger.debug("play_sound: #{filename}")
+      end
+    end
+  end
+end

data/lib/rspec/openhab/api.rb

@@ -15,12 +15,19 @@ module OpenHAB
     end
 
     def version
-      body = @faraday.get.body
-      version = body.dig("runtimeInfo", "version")
-      version = "#{version}-SNAPSHOT" if body.dig("runtimeInfo", "buildString")&.start_with?("Build #")
+      version = root_data.dig("runtimeInfo", "version")
+      version = "#{version}-SNAPSHOT" if root_data.dig("runtimeInfo", "buildString")&.start_with?("Build #")
       version
     end
 
+    def locale
+      root_data["locale"]
+    end
+
+    def measurement_system
+      root_data["measurementSystem"]
+    end
+
     def items
       @faraday.get("items", metadata: ".*").body
     end
@@ -30,5 +37,11 @@ module OpenHAB
     rescue Faraday::ResourceNotFound
       nil
     end
+
+    private
+
+    def root_data
+      @root_data ||= @faraday.get.body
+    end
   end
 end

data/lib/rspec/openhab/dsl/imports.rb

@@ -34,8 +34,11 @@ module OpenHAB
       class BundleContext
         include org.osgi.framework.BundleContext
 
+        attr_reader :bundles
+
         def initialize(event_manager)
           @event_manager = event_manager
+          @bundles = []
         end
 
         def register_service(klass, service, _properties)
@@ -46,6 +49,10 @@ module OpenHAB
 
           @event_manager.add_event_subscriber(service)
         end
+
+        def get_service_reference(klass); end
+        def get_service(klass); end
+        def add_bundle_listener(listener); end
       end
 
       # don't depend on org.openhab.core.test
@@ -100,6 +107,17 @@ module OpenHAB
         end
       end
 
+      class ComponentContext
+        include org.osgi.service.component.ComponentContext
+
+        attr_reader :properties, :bundle_context
+
+        def initialize(bundle_context)
+          @properties = java.util.Hashtable.new
+          @bundle_context = bundle_context
+        end
+      end
+
       # subclass to expose private fields
       class EventManager < org.openhab.core.internal.events.OSGiEventManager
         field_reader :typedEventFactories, :typedEventSubscribers
@@ -108,6 +126,8 @@ module OpenHAB
       @imported = false
 
       class << self
+        attr_accessor :api
+
         def import_presets
           return if @imported
 
@@ -127,6 +147,9 @@ module OpenHAB
           at_exit { eh.close }
           ea = EventAdmin.new(eh)
           ep = org.openhab.core.internal.events.OSGiEventPublisher.new(ea)
+          bc = BundleContext.new(em)
+          cc = ComponentContext.new(bc)
+          cc.properties["measurementSystem"] = api.measurement_system if api
 
           # the registries!
           ss = VolatileStorageService.new
@@ -138,6 +161,9 @@ module OpenHAB
           ir.managed_provider = mip = org.openhab.core.items.ManagedItemProvider.new(ss, nil)
           ir.add_provider(mip)
           ir.event_publisher = ep
+          up = org.openhab.core.internal.i18n.I18nProviderImpl.new(cc)
+          ir.unit_provider = up
+          ir.item_state_converter = org.openhab.core.internal.items.ItemStateConverterImpl.new(up)
           tr = org.openhab.core.thing.internal.ThingRegistryImpl.new
           mtr = org.openhab.core.automation.internal.type.ModuleTypeRegistryImpl.new
           rr = org.openhab.core.automation.internal.RuleRegistryImpl.new
@@ -187,10 +213,11 @@ module OpenHAB
           se = org.openhab.core.automation.module.script.rulesupport.internal
                   .RuleSupportScriptExtension.new(rr, srp, scmhf, scmtp, spmhf)
           sew = ScriptExtensionManagerWrapper.new(se)
-          $se = $scriptExtension = sew # rubocop:disable Style/GlobalVars
+          $se = $scriptExtension = sew
 
           # need to create some singletons referencing registries
-          org.openhab.core.model.script.ScriptServiceUtil.new(ir, tr, ep, nil, nil)
+          scheduler = org.openhab.core.internal.scheduler.SchedulerImpl.new
+          org.openhab.core.model.script.ScriptServiceUtil.new(ir, tr, ep, nil, scheduler)
           org.openhab.core.model.script.internal.engine.action.SemanticsActionService.new(ir)
 
           # link up event bus infrastructure
@@ -206,7 +233,6 @@ module OpenHAB
           em.add_event_factory(ief)
 
           # set up the rules engine part 2
-          bc = BundleContext.new(em)
           k = org.openhab.core.automation.internal.module.factory.CoreModuleHandlerFactory
           # depending on OH version, this class is set up differently
           cmhf = begin

data/lib/rspec/openhab/items.rb

@@ -3,45 +3,75 @@
 module RSpec
   module OpenHAB
     module Items
-      module_function
-
-      # rubocop:disable Style/GlobalVars
-      def populate_items_from_api(api)
-        all_items = api.items
-        all_items.each do |item_json|
-          type, _dimension = item_json["type"].split(":")
-          if type == "Group"
-            if item_json["groupType"]
-              type, _dimension = item_json["groupType"].split(":")
+      class << self
+        def populate_items_from_api(api)
+          all_items = api.items
+
+          gfh = org.openhab.core.internal.items.GroupFunctionHelper.new
+
+          all_items.each do |item_json|
+            type, _dimension = item_json["type"].split(":")
+            if type == "Group"
+              if item_json["groupType"]
+                type, _dimension = item_json["groupType"].split(":")
+                klass = ::OpenHAB::DSL::Items.const_get(:"#{type}Item")
+                base_item = klass.new(item_json["name"])
+              end
+              if item_json["function"]
+                dto = org.openhab.core.items.dto.GroupFunctionDTO.new
+                dto.name = item_json.dig("function", "name")
+                dto.params = item_json.dig("function", "params")
+                function = gfh.create_group_function(dto, base_item)
+              end
+              item = GroupItem.new(item_json["name"], base_item, function)
+            else
               klass = ::OpenHAB::DSL::Items.const_get(:"#{type}Item")
-              base_item = klass.new(item_json["name"])
+              item = klass.new(item_json["name"])
             end
-            # TODO: create group function
-            item = GroupItem.new(item_json["name"], base_item)
-          else
-            klass = ::OpenHAB::DSL::Items.const_get(:"#{type}Item")
-            item = klass.new(item_json["name"])
-          end
 
-          item.label = item_json["label"]
-          item_json["tags"].each do |tag|
-            item.add_tag(tag)
+            item.label = item_json["label"]
+            item_json["tags"].each do |tag|
+              item.add_tag(tag)
+            end
+            item_json["metadata"]&.each do |key, config|
+              item.meta[key] = config["value"], config["config"]
+            end
+
+            $ir.add(item)
           end
-          item_json["metadata"]&.each do |key, config|
-            item.meta[key] = config["value"], config["config"]
+          all_items.each do |item_json| # rubocop:disable Style/CombinableLoops
+            item_json["groupNames"].each do |group_name|
+              next unless (group = $ir.get(group_name))
+
+              group.add_member($ir.get(item_json["name"]))
+            end
           end
+        end
+      end
 
-          $ir.add(item)
+      def autoupdate_all_items
+        @autoupdated_items ||= {}
+        $ir.for_each do |_provider, item|
+          @autoupdated_items[item] = item.meta.delete("autoupdate") if item.meta.key?("autoupdate")
         end
-        all_items.each do |item_json| # rubocop:disable Style/CombinableLoops
-          item_json["groupNames"].each do |group_name|
-            next unless (group = $ir.get(group_name))
+      end
 
-            group.add_member($ir.get(item_json["name"]))
-          end
+      private
+
+      def restore_autoupdate_items
+        return unless instance_variable_defined?(:@autoupdated_items)
+
+        @autoupdated_items.each do |(item, meta)|
+          item.meta["autoupdate"] = meta
+        end
+      end
+
+      ::RSpec.configure do |config|
+        config.include(self)
+        config.after do
+          restore_autoupdate_items
         end
       end
-      # rubocop:enable Style/GlobalVars
     end
   end
 end

data/lib/rspec/openhab/state.rb

@@ -2,8 +2,19 @@
 
 RSpec.configure do |config|
   config.before(:each) do
-    $ir.for_each do |_provider, item| # rubocop:disable Style/GlobalVars
+    ep = $ir.event_publisher
+
+    # stash event publishers to avoid triggering any rules
+    $ir.for_each do |_provider, item|
+      item.event_publisher = nil
+    end
+
+    $ir.for_each do |_provider, item| # rubocop:disable Style/CombinableLoops
       item.state = NULL # don't use update, to avoid triggering any rules
     end
+  ensure
+    $ir.for_each do |_provider, item|
+      item.event_publisher = ep
+    end
   end
 end

data/lib/rspec/openhab/timer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:each) do
+    OpenHAB::DSL::Timers.timer_manager.cancel_all
+  end
+  config.after(:each) do
+    OpenHAB::DSL::Timers.timer_manager.cancel_all
+  end
+end

data/lib/rspec/openhab/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenHAB
-    VERSION = "0.0.4"
+    VERSION = "0.0.7"
   end
 end

data/lib/rspec-openhab-scripting.rb

@@ -34,10 +34,10 @@ maven_require do
   require "jar tech.units, indriya, 2.1.3"
 
   require "jar org.openhab.core.bundles, org.openhab.core, #{openhab_version}"
-  require "jar org.openhab.core.bundles, org.openhab.core.config.core, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.automation, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.automation.module.script, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.automation.module.script.rulesupport, #{openhab_version}"
+  require "jar org.openhab.core.bundles, org.openhab.core.config.core, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.io.monitor, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.model.core, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.model.script, #{openhab_version}"
@@ -59,17 +59,16 @@ end
 require "openhab/log/logger"
 require "rspec/openhab/core/logger"
 require "openhab/dsl/imports"
+OpenHAB::DSL::Imports.api = api
 OpenHAB::DSL::Imports.import_presets
 
 require "openhab"
 
+require "rspec/openhab/actions"
 require "rspec/openhab/core/cron_scheduler"
 
-# openhab-scripting uses a require_relative, so our override doesn't get used
-OpenHAB::DSL.send(:remove_const, :Timer)
-require_relative "rspec/openhab/dsl/timers/timer"
-
 # RSpec additions
+require "rspec/core"
 require "rspec/openhab/dsl/rules/rspec"
 require "rspec/openhab/state"
 require "rspec/openhab/trigger"
@@ -78,13 +77,19 @@ require "rspec/openhab/items"
 
 RSpec::OpenHAB::Items.populate_items_from_api(api)
 
+# make bundler/inline _not_ destroy the already existing load path
+module Bundler
+  module SharedHelpers
+    def clean_load_path; end
+  end
+end
+
 # load rules files
 OPENHAB_AUTOMATION_PATH = "#{org.openhab.core.OpenHAB.config_folder}/automation/jsr223/ruby/personal"
 
-# set up some environment the rules files expect
 Dir["#{OPENHAB_AUTOMATION_PATH}/*.rb"].each do |f|
   load f
 rescue Exception => e # rubocop:disable Lint/RescueException
-  warn "Failed loading #{f}: #{e}"
+  warn "Failed loading #{f}: #{e.inspect}"
   warn e.backtrace
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: java
 authors:
 - Cody Cutrer
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.42'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  name: rspec-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -158,7 +172,7 @@ extra_rdoc_files: []
 files:
 - lib/rspec-openhab-scripting.rb
 - lib/rspec-openhab-scripting_jars.rb
-- lib/rspec/bundler/inline.rb
+- lib/rspec/openhab/actions.rb
 - lib/rspec/openhab/api.rb
 - lib/rspec/openhab/core/cron_scheduler.rb
 - lib/rspec/openhab/core/load_path.rb
@@ -168,9 +182,9 @@ files:
 - lib/rspec/openhab/core/script_handling.rb
 - lib/rspec/openhab/dsl/imports.rb
 - lib/rspec/openhab/dsl/rules/rspec.rb
-- lib/rspec/openhab/dsl/timers/timer.rb
 - lib/rspec/openhab/items.rb
 - lib/rspec/openhab/state.rb
+- lib/rspec/openhab/timer.rb
 - lib/rspec/openhab/trigger.rb
 - lib/rspec/openhab/version.rb
 - lib/rspec/openhab/wait.rb

data/lib/rspec/bundler/inline.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Bundler
-  class DummyDsl
-    def source(*); end
-  end
-end
-
-def gemfile(*, &block)
-  # needs to be a no-op, since we're already running in the context of bundler
-  Bundler::DummyDsl.new.instance_eval(&block)
-end

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

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    class Timer
-      #
-      # Create a new Timer Object
-      #
-      # @param [Duration] duration Duration until timer should fire
-      # @param [Block] block Block to execute when timer fires
-      #
-      def initialize(duration:, thread_locals: {}, &block) # rubocop:disable Lint/UnusedMethodArgument
-        @duration = duration
-
-        Timers.timer_manager.add(self)
-      end
-
-      def reschedule(duration = nil)
-        duration ||= @duration
-
-        Timers.timer_manager.add(self)
-        reschedule(OpenHAB::DSL.to_zdt(duration))
-      end
-
-      #
-      # Cancel timer
-      #
-      # @return [Boolean] True if cancel was successful, false otherwise
-      #
-      def cancel
-        Timers.timer_manager.delete(self)
-      end
-
-      def terminated?; end
-      alias_method :has_terminated, :terminated?
-
-      private
-
-      def timer_block
-        proc do
-          Timers.timer_manager.delete(self)
-          yield(self)
-        end
-      end
-    end
-
-    #
-    # Convert TemporalAmount (Duration), seconds (float, integer), and Ruby Time to ZonedDateTime
-    # Note: TemporalAmount is added to now
-    #
-    # @param [Object] timestamp to convert
-    #
-    # @return [ZonedDateTime]
-    #
-    def self.to_zdt(timestamp)
-      logger.trace("Converting #{timestamp} (#{timestamp.class}) to ZonedDateTime")
-      return unless timestamp
-
-      case timestamp
-      when Java::JavaTimeTemporal::TemporalAmount then ZonedDateTime.now.plus(timestamp)
-      when ZonedDateTime then timestamp
-      when Time then timestamp.to_java(ZonedDateTime)
-      else
-        to_zdt(seconds_to_duration(timestamp)) ||
-          raise(ArgumentError, "Timestamp must be a ZonedDateTime, a Duration, a Numeric, or a Time object")
-      end
-    end
-
-    #
-    # Convert numeric seconds to a Duration object
-    #
-    # @param [Float, Integer] secs The number of seconds in integer or float
-    #
-    # @return [Duration]
-    #
-    def self.seconds_to_duration(secs)
-      return unless secs
-
-      if secs.respond_to?(:to_f)
-        secs.to_f.seconds
-      elsif secs.respond_to?(:to_i)
-        secs.to_i.seconds
-      end
-    end
-  end
-end