openhab-scripting 2.9.1

data/lib/openhab/core/patch_load_path.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# The following module patches the load path to include distributed ruby files
+module PatchLoadPath
+  lib_path = File.realpath(File.join(__dir__, '..'))
+  $LOAD_PATH << lib_path unless $LOAD_PATH.include?(lib_path)
+end

data/lib/openhab/core/startup_delay.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'core/log'
+
+#
+# Module when included will pause the current thread until OpenHAB is ready for interaction
+#
+module StartupDelay
+  include Logging
+
+  CHECK_DELAY = 10
+  private_constant :CHECK_DELAY
+
+  logger.info('Checking for Automation manager')
+  # rubocop: disable Style/GlobalVars
+  until $scriptExtension.get('automationManager')
+    logger.info("Automation manager not loaded, checking again in #{CHECK_DELAY} seconds.")
+    sleep CHECK_DELAY
+  end
+  # rubocop: enable Style/GlobalVars
+  logger.info 'Automation manager check complete.'
+end

data/lib/openhab/osgi.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'java'
+require 'openhab/core/log'
+
+module OpenHAB
+  #
+  # OSGI services interface
+  #
+  class OSGI
+    include Logging
+
+    java_import org.openhab.core.model.script.actions.ScriptExecution
+    java_import org.osgi.framework.FrameworkUtil
+
+    #
+    # @param name [String] The service name
+    #
+    # @return [Service]
+    #
+    def self.service(name)
+      ref = bundle_context.getServiceReference(name)
+      service = bundle_context.getService(ref) if ref
+      logger.trace "OSGI service(#{service}) found for '#{name}' using OSGI Service Reference #{ref}"
+
+      service
+    end
+
+    #
+    # @param name [String] The service name
+    # @param filter [String] Filter for service names. See https://docs.osgi.org/javadoc/r4v43/core/org/osgi/framework/Filter.html
+    #
+    # @return [Array] An array of services
+    #
+    def self.services(name, filter: nil)
+      bundle_context.getServiceReferences(name, filter)&.map do |reference|
+        bundle_context.getService(reference)
+      end
+    end
+
+    def self.bundle_context
+      @bundle_context ||= bundle.getBundleContext
+    end
+    private_class_method :bundle_context
+
+    # Get the OSGI Bundle for ScriptExtension Class
+    def self.bundle
+      @bundle ||= FrameworkUtil.getBundle($scriptExtension.class)
+    end
+    private_class_method :bundle
+  end
+end

data/lib/openhab/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+#
+# Holds project version constant
+#
+module OpenHAB
+  # @return [String] Version of OpenHAB helper libraries
+  VERSION = '2.9.1'
+end

data/openhab-scripting.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/openhab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openhab-scripting'
+  spec.version       = OpenHAB::VERSION
+  spec.authors       = ["Brian O'Connell"]
+  spec.email         = ['broconne@gmail.com']
+
+  spec.summary       = 'JRuby Helper Libraries for OpenHAB Scripting'
+  spec.description   = 'JRuby Helper Libraries for OpenHAB Scripting'
+  spec.homepage      = 'https://boc-tothefuture.github.io/openhab-jruby/'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/boc-tothefuture/openhab-jruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/boc-tothefuture/openhab-jruby/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bundle)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/openhab_rules/warmup.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'openhab'
+
+logger.info('OpenHAB warmup complete')

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: openhab-scripting
+version: !ruby/object:Gem::Version
+  version: 2.9.1
+platform: ruby
+authors:
+- Brian O'Connell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-28 00:00:00.000000000 Z
+dependencies: []
+description: JRuby Helper Libraries for OpenHAB Scripting
+email:
+- broconne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/workflow.yml"
+- ".gitignore"
+- ".java-version"
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/userdata/config/org/openhab/restauth.config
+- cucumber.yml
+- docs/_config.yml
+- docs/contributing/index.md
+- docs/examples/conversions.md
+- docs/examples/index.md
+- docs/index.md
+- docs/installation/index.md
+- docs/motivation/index.md
+- docs/usage/execution.md
+- docs/usage/execution/delay.md
+- docs/usage/execution/otherwise.md
+- docs/usage/execution/run.md
+- docs/usage/execution/triggered.md
+- docs/usage/guards.md
+- docs/usage/guards/between.md
+- docs/usage/guards/not_if.md
+- docs/usage/guards/only_if.md
+- docs/usage/index.md
+- docs/usage/items.md
+- docs/usage/items/contact.md
+- docs/usage/items/dimmer.md
+- docs/usage/items/groups.md
+- docs/usage/items/number.md
+- docs/usage/items/string.md
+- docs/usage/items/switch.md
+- docs/usage/misc.md
+- docs/usage/misc/actions.md
+- docs/usage/misc/duration.md
+- docs/usage/misc/gems.md
+- docs/usage/misc/logging.md
+- docs/usage/misc/metadata.md
+- docs/usage/misc/store_states.md
+- docs/usage/misc/time_of_day.md
+- docs/usage/misc/timers.md
+- docs/usage/rule.md
+- docs/usage/things.md
+- docs/usage/triggers.md
+- docs/usage/triggers/changed.md
+- docs/usage/triggers/channel.md
+- docs/usage/triggers/command.md
+- docs/usage/triggers/cron.md
+- docs/usage/triggers/every.md
+- docs/usage/triggers/updated.md
+- lib/openhab.rb
+- lib/openhab/configuration.rb
+- lib/openhab/core/cron.rb
+- lib/openhab/core/debug.rb
+- lib/openhab/core/dsl.rb
+- lib/openhab/core/dsl/actions.rb
+- lib/openhab/core/dsl/entities.rb
+- lib/openhab/core/dsl/gems.rb
+- lib/openhab/core/dsl/group.rb
+- lib/openhab/core/dsl/items/items.rb
+- lib/openhab/core/dsl/items/number_item.rb
+- lib/openhab/core/dsl/items/string_item.rb
+- lib/openhab/core/dsl/monkey_patch/actions/actions.rb
+- lib/openhab/core/dsl/monkey_patch/actions/script_thing_actions.rb
+- lib/openhab/core/dsl/monkey_patch/events.rb
+- lib/openhab/core/dsl/monkey_patch/events/item_command.rb
+- lib/openhab/core/dsl/monkey_patch/events/item_state_changed.rb
+- lib/openhab/core/dsl/monkey_patch/events/thing_status_info.rb
+- lib/openhab/core/dsl/monkey_patch/items/contact_item.rb
+- lib/openhab/core/dsl/monkey_patch/items/dimmer_item.rb
+- lib/openhab/core/dsl/monkey_patch/items/group_item.rb
+- lib/openhab/core/dsl/monkey_patch/items/items.rb
+- lib/openhab/core/dsl/monkey_patch/items/metadata.rb
+- lib/openhab/core/dsl/monkey_patch/items/switch_item.rb
+- lib/openhab/core/dsl/monkey_patch/ruby/number.rb
+- lib/openhab/core/dsl/monkey_patch/ruby/range.rb
+- lib/openhab/core/dsl/monkey_patch/ruby/ruby.rb
+- lib/openhab/core/dsl/monkey_patch/types/decimal_type.rb
+- lib/openhab/core/dsl/monkey_patch/types/on_off_type.rb
+- lib/openhab/core/dsl/monkey_patch/types/open_closed_type.rb
+- lib/openhab/core/dsl/monkey_patch/types/percent_type.rb
+- lib/openhab/core/dsl/monkey_patch/types/types.rb
+- lib/openhab/core/dsl/property.rb
+- lib/openhab/core/dsl/rule/channel.rb
+- lib/openhab/core/dsl/rule/cron.rb
+- lib/openhab/core/dsl/rule/guard.rb
+- lib/openhab/core/dsl/rule/item.rb
+- lib/openhab/core/dsl/rule/rule.rb
+- lib/openhab/core/dsl/rule/triggers.rb
+- lib/openhab/core/dsl/states.rb
+- lib/openhab/core/dsl/things.rb
+- lib/openhab/core/dsl/time_of_day.rb
+- lib/openhab/core/dsl/timers.rb
+- lib/openhab/core/dsl/types/quantity.rb
+- lib/openhab/core/dsl/units.rb
+- lib/openhab/core/duration.rb
+- lib/openhab/core/log.rb
+- lib/openhab/core/patch_load_path.rb
+- lib/openhab/core/startup_delay.rb
+- lib/openhab/osgi.rb
+- lib/openhab/version.rb
+- openhab-scripting.gemspec
+- openhab_rules/warmup.rb
+homepage: https://boc-tothefuture.github.io/openhab-jruby/
+licenses: []
+metadata:
+  homepage_uri: https://boc-tothefuture.github.io/openhab-jruby/
+  source_code_uri: https://github.com/boc-tothefuture/openhab-jruby
+  changelog_uri: https://github.com/boc-tothefuture/openhab-jruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: JRuby Helper Libraries for OpenHAB Scripting
+test_files: []