openhab-jrubyscripting 5.0.0.rc11 → 5.0.0.rc.13

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

@@ -20,27 +20,29 @@ module OpenHAB
         class << self
           # @!visibility private
           # @!macro def_terse_rule
-          #   @!method $1(*args, name :nil, id: nil, **kwargs, &block)
+          #   @!method $1(*args, name :nil, id: nil, on_load: false, **kwargs, &block)
           #   Create a new rule with a $1 trigger.
           #   @param name [String] The name for the rule.
           #   @param id [String] The ID for the rule.
+          #   @param on_load [true, false] If the rule should _also_ trigger immediately when the script loads.
           #   @yield The execution block for the rule.
           #   @return [void]
           #   @see BuilderDSL#$1
           def def_terse_rule(trigger)
             class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-              def #{trigger}(*args, name: nil, id: nil, **kwargs, &block)     # def changed(*args, name: nil, id: nil, **kwargs, &block)
-                raise ArgumentError, "Block is required" unless block         #   raise ArgumentError, "Block is required" unless block
-                                                                              #
-                id ||= NameInference.infer_rule_id_from_block(block)          #   id ||= NameInference.infer_rule_id_from_block(block)
-                script = block.source rescue nil                              #   script = block.source rescue nil
-                caller_binding = block.binding                                #   caller_binding = block.binding
-                rule name, id: id, script: script, binding: caller_binding do #   rule name, id: id, script: script, binding: caller_binding do
-                  #{trigger}(*args, **kwargs)                                 #     changed(*args, **kwargs)
-                  run(&block)                                                 #     run(&block)
-                end                                                           #   end
-              end                                                             # end
-              module_function #{trigger.inspect}                              # module_function :changed
+              def #{trigger}(*args, name: nil, id: nil, on_load: false, **kwargs, &block)     # def changed(*args, name: nil, id: nil, on_load: false, **kwargs, &block)
+                raise ArgumentError, "Block is required" unless block                         #   raise ArgumentError, "Block is required" unless block
+                                                                                              #
+                id ||= NameInference.infer_rule_id_from_block(block)                          #   id ||= NameInference.infer_rule_id_from_block(block)
+                script = block.source rescue nil                                              #   script = block.source rescue nil
+                caller_binding = block.binding                                                #   caller_binding = block.binding
+                rule name, id: id, script: script, binding: caller_binding do                 #   rule name, id: id, script: script, binding: caller_binding do
+                  self.on_load if on_load                                                     #     self.on_load if on_load
+                  #{trigger}(*args, **kwargs)                                                 #     changed(*args, **kwargs)
+                  run(&block)                                                                 #     run(&block)
+                end                                                                           #   end
+              end                                                                             # end
+              module_function #{trigger.inspect}                                              # module_function :changed
             RUBY
           end
         end

data/lib/openhab/dsl/timer_manager.rb

@@ -11,7 +11,7 @@ module OpenHAB
     class TimerManager
       include Singleton
 
-      Core::ScriptHandling.script_unloaded { instance.cancel_all }
+      Core::ScriptHandling.script_unloaded(priority: 40) { instance.cancel_all }
 
       # @!visibility private
       def initialize

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.0.0.rc11"
+    VERSION = "5.0.0.rc.13"
   end
 end

data/lib/openhab/dsl.rb

@@ -30,6 +30,12 @@ module OpenHAB
     # include this before Core::Actions so that Core::Action's method_missing
     # takes priority
     include Core::EntityLookup
+    #
+    # @!parse
+    #   include Core::Actions
+    #   include Core::ScriptHandling
+    #   include Rules::Terse
+    #
     [Core::Actions, Core::ScriptHandling, Rules::Terse].each do |mod|
       # make these available both as regular and class methods
       include mod
@@ -152,8 +158,6 @@ module OpenHAB
     #
     # @see Core::ValueCache ValueCache
     #
-    # @since openHAB 3.4.0
-    #
     def shared_cache
       $sharedCache
     end
@@ -475,6 +479,11 @@ module OpenHAB
       debounce(for: duration, id: id, &block)
     end
 
+    # (see Core::Actions::Transformation.transform)
+    def transform(type, function, value)
+      Transformation.transform(type, function, value)
+    end
+
     #
     # Limit how often the given block executes to the specified interval.
     #
@@ -523,9 +532,6 @@ module OpenHAB
     #   end # the states will be restored here
     #
     def store_states(*items)
-      items = items.flatten.map do |item|
-        item.respond_to?(:__getobj__) ? item.__getobj__ : item
-      end
       states = Core::Items::StateStorage.from_items(*items)
       if block_given?
         yield
@@ -604,18 +610,39 @@ module OpenHAB
     #     Item1.average_since(12.hours)
     #   end
     #
-    # @see OpenHAB::Core::Items::Persistence
-    #
-    # @param [Object] service service either as a String or a Symbol
+    # @param [Object] service Persistence service either as a String or a Symbol
     # @yield [] Block executed in context of the supplied persistence service
     # @return [Object] The return value from the block.
     #
+    # @see persistence!
+    # @see OpenHAB::Core::Items::Persistence
+    #
     def persistence(service)
-      old = Thread.current[:openhab_persistence_service]
-      Thread.current[:openhab_persistence_service] = service
+      old = persistence!(service)
       yield
     ensure
-      Thread.current[:openhab_persistence_service] = old
+      persistence!(old)
+    end
+
+    #
+    # Permanently sets the default persistence service for the current thread
+    #
+    # @note This method is only intended for use at the top level of rule
+    #   scripts. If it's used within library methods, or hap-hazardly within
+    #   rules, things can get very confusing because the prior state won't be
+    #   properly restored.
+    #
+    # @param [Object] service Persistence service either as a String or a Symbol. When nil, use
+    #   the system's default persistence service.
+    # @return [Object,nil] The previous persistence service settings, or nil when using the system's default.
+    #
+    # @see persistence
+    # @see OpenHAB::Core::Items::Persistence
+    #
+    def persistence!(service = nil)
+      old = Thread.current[:openhab_persistence_service]
+      Thread.current[:openhab_persistence_service] = service
+      old
     end
 
     #

data/lib/openhab/osgi.rb

@@ -52,10 +52,8 @@ module OpenHAB
         )
       end
 
-      private
-
       # @!attribute [r] bundle_context
-      # @return [org.osgi.framework.BundleContext] OSGi bundle context
+      # @return [org.osgi.framework.BundleContext] OSGi bundle context for ScriptExtension Class
       def bundle_context
         @bundle_context ||= bundle.bundle_context
       end

data/lib/openhab/rspec/helpers.rb

@@ -12,9 +12,6 @@ module OpenHAB
   # @example Corresponds to `transform/compass.script`
   #   OpenHAB::Transform.compass("30", param: "7")
   #
-  # @example Corresponds to `transform/ruby/compass.script`
-  #   OpenHAB::Transform::Ruby.compass("59 °")
-
   module Transform
     class << self
       # @!visibility private
@@ -265,12 +262,13 @@ module OpenHAB
       # @return [void]
       #
       def load_rules
-        automation_path = "#{org.openhab.core.OpenHAB.config_folder}/automation/ruby"
+        automation_paths = Array(::RSpec.configuration.openhab_automation_search_paths)
+
         lib_dirs = rubylib_dirs.map { |d| File.join(d, "") }
         lib_dirs << File.join(gem_home, "")
 
         SuspendRules.suspend_rules do
-          files = Dir["#{automation_path}/**/*.rb"]
+          files = automation_paths.map { |p| Dir["#{p}/**/*.rb"] }.flatten
           files.reject! do |f|
             lib_dirs.any? { |l| f.start_with?(l) }
           end

data/lib/openhab/rspec/hooks.rb

@@ -100,6 +100,7 @@ module OpenHAB
           restore_autoupdate_items
           Mocks::PersistenceService.instance.reset
           Hooks.cache_script_extension.sharedCache.clear if DSL.shared_cache
+          DSL.persistence!(nil)
         end
       end
     end

data/lib/openhab/rspec/mocks/timer.rb

@@ -17,6 +17,39 @@ module OpenHAB
         end
         ZonedDateTime.singleton_class.prepend(MockedZonedDateTime)
 
+        # @!visibility private
+        module MockedLocalDate
+          def now
+            mocked_time_stack_item = Timecop.top_stack_item
+            return super unless mocked_time_stack_item
+
+            mocked_time_stack_item.time.to_zoned_date_time.to_local_date
+          end
+        end
+        LocalDate.singleton_class.prepend(MockedLocalDate)
+
+        # @!visibility private
+        module MockedLocalTime
+          def now
+            mocked_time_stack_item = Timecop.top_stack_item
+            return super unless mocked_time_stack_item
+
+            mocked_time_stack_item.time.to_zoned_date_time.to_local_time
+          end
+        end
+        LocalTime.singleton_class.prepend(MockedLocalTime)
+
+        # @!visibility private
+        module MockedMonthDay
+          def now
+            mocked_time_stack_item = Timecop.top_stack_item
+            return super unless mocked_time_stack_item
+
+            mocked_time_stack_item.time.to_zoned_date_time.to_month_day
+          end
+        end
+        MonthDay.singleton_class.prepend(MockedMonthDay)
+
         # extend Timecop to support Java time classes
         # @!visibility private
         module TimeCopStackItem

data/lib/openhab/rspec.rb

@@ -15,3 +15,12 @@ require_relative "rspec/configuration"
 require_relative "rspec/helpers"
 require_relative "rspec/karaf"
 require_relative "rspec/hooks"
+
+return unless defined?(RSpec)
+
+RSpec.configure do |c|
+  c.add_setting :openhab_automation_search_paths, default: [
+    "#{org.openhab.core.OpenHAB.config_folder}/automation/ruby",
+    "#{org.openhab.core.OpenHAB.config_folder}/automation/jsr223"
+  ]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-jrubyscripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc11
+  version: 5.0.0.rc.13
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -453,9 +467,9 @@ files:
 - lib/openhab/core_ext/java/unit.rb
 - lib/openhab/core_ext/java/zoned_date_time.rb
 - lib/openhab/core_ext/ruby/array.rb
-- lib/openhab/core_ext/ruby/class.rb
 - lib/openhab/core_ext/ruby/date.rb
 - lib/openhab/core_ext/ruby/date_time.rb
+- lib/openhab/core_ext/ruby/module.rb
 - lib/openhab/core_ext/ruby/numeric.rb
 - lib/openhab/core_ext/ruby/range.rb
 - lib/openhab/core_ext/ruby/symbol.rb
@@ -537,14 +551,14 @@ files:
 - lib/openhab/yard/tags/constant_directive.rb
 - lib/openhab/yard/tags/group_directive.rb
 - lib/openhab/yard/tags/library.rb
-homepage: https://ccutrer.github.io/openhab-jrubyscripting/
+homepage: https://openhab.github.io/openhab-jruby/
 licenses:
 - EPL-2.0
 metadata:
-  homepage_uri: https://ccutrer.github.io/openhab-jrubyscripting/
-  source_code_uri: https://github.com/ccutrer/openhab-jrubyscripting
-  documentation_uri: https://ccutrer.github.io/openhab-jrubyscripting/
-  changelog_uri: https://ccutrer.github.io/openhab-jrubyscripting/file.CHANGELOG.html
+  homepage_uri: https://openhab.github.io/openhab-jruby/
+  source_code_uri: https://github.com/openhab/openhab-jruby
+  documentation_uri: https://openhab.github.io/openhab-jruby/
+  changelog_uri: https://openhab.github.io/openhab-jruby/file.CHANGELOG.html
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -561,7 +575,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting