openhab-jrubyscripting 5.0.0.rc5 → 5.0.0.rc8

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

@@ -18,7 +18,7 @@ module OpenHAB
           # @param [Object] command to check against
           # @param [Object] attach object to be attached to the trigger
           #
-          # @return [Trigger] OpenHAB triggers
+          # @return [org.openhab.core.automation.Trigger]
           #
           def trigger(item:, command:, attach:)
             case command
@@ -31,9 +31,9 @@ module OpenHAB
           #
           # Creates a trigger with a range condition on the 'command' field
           # @param [Object] item to create changed trigger on
-          # @param [Object] command to restrict trigger to
+          # @param [Range] command to restrict trigger to
           # @param [Object] attach object to be attached to the trigger
-          # @return [Trigger] OpenHAB trigger
+          # @return [org.openhab.core.automation.Trigger]
           #
           def range_trigger(item:, command:, attach:)
             command_range, * = Conditions::Proc.range_procs(command)
@@ -45,7 +45,7 @@ module OpenHAB
           # @param [Object] item to create changed trigger on
           # @param [Object] command to restrict trigger to
           # @param [Object] attach object to be attached to the trigger
-          # @return [Trigger] OpenHAB trigger
+          # @return [org.openhab.core.automation.Trigger]
           #
           def proc_trigger(item:, command:, attach:)
             conditions = Conditions::Proc.new(command: command)
@@ -58,6 +58,7 @@ module OpenHAB
           # @param [Object] item to create trigger for
           # @param [String] command to create trigger for
           # @param [Object] attach object to be attached to the trigger
+          # @return [org.openhab.core.automation.Trigger]
           #
           def command_trigger(item:, command:, attach: nil, conditions: nil)
             type, config = if item.is_a?(GroupItem::Members)
@@ -92,7 +93,7 @@ module OpenHAB
           #
           # Create trigger for group items
           #
-          # @param [Group] group to create trigger for
+          # @param [GroupItem::Members] group to create trigger for
           #
           # @return [Array<Hash,Trigger>] first element is hash of trigger config properties
           #   second element is trigger type

data/lib/openhab/dsl/rules/triggers/conditions/duration.rb

@@ -57,7 +57,7 @@ module OpenHAB
             #
             # Check if trigger guards prevent rule execution
             #
-            # @param [Map] inputs OpenHAB map object describing rule trigger
+            # @param [java.util.Map] inputs map object describing rule trigger
             #
             # @return [true,false] True if the rule should execute, false if trigger guard prevents execution
             #
@@ -70,7 +70,7 @@ module OpenHAB
             # Rerieve the newState and oldState, alternatively newStatus and oldStatus
             # from the input map
             #
-            # @param [Map] inputs OpenHAB map object describing rule trigger
+            # @param [java.util.Map] inputs map object describing rule trigger
             #
             # @return [Array] An array of the values for [newState, oldState] or [newStatus, oldStatus]
             #

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

@@ -33,7 +33,7 @@ module OpenHAB
             }.freeze
           private_constant :CRON_EXPRESSION_MAP
 
-          # @return [Hash] Map of days of the week from symbols to to OpenHAB cron strings
+          # @return [Hash] Map of days of the week from symbols to to openHAB cron strings
           DAY_OF_WEEK_MAP = {
             monday: "MON",
             tuesday: "TUE",
@@ -134,7 +134,7 @@ module OpenHAB
           #
           # @param [Map] map of cron expression
           #
-          # @return [String] OpenHAB cron string
+          # @return [String] openHAB cron string
           #
           def self.map_to_cron(map)
             %i[second minute hour dom month dow year].map { |field| map.fetch(field) }.join(" ")

data/lib/openhab/dsl/rules/triggers/cron/cron_handler.rb

@@ -12,7 +12,7 @@ module OpenHAB
         #
         module CronHandler
           # Cron Trigger Handler that provides trigger IDs
-          # Unfortunatly because the CronTriggerHandler in OpenHAB core is marked internal
+          # Unfortunatly because the CronTriggerHandler in openHAB core is marked internal
           # the entire thing must be recreated here
           class CronTriggerHandler < org.openhab.core.automation.handler.BaseTriggerModuleHandler
             include org.openhab.core.scheduler.SchedulerRunnable
@@ -22,7 +22,7 @@ module OpenHAB
             field_accessor :callback
 
             # Creates a new CronTriggerHandler
-            # @param [Trigger] trigger OpenHAB trigger associated with handler
+            # @param [org.openhab.core.automation.Trigger] trigger openHAB trigger associated with handler
             #
             def initialize(trigger)
               @trigger = trigger
@@ -79,8 +79,8 @@ module OpenHAB
           class CronTriggerHandlerFactory
             include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
 
-            # Invoked by the OpenHAB core to get a trigger handler for the supllied trigger
-            # @param [Trigger] trigger OpenHAB trigger
+            # Invoked by openHAB core to get a trigger handler for the supllied trigger
+            # @param [org.openhab.core.automation.Trigger] trigger
             #
             # @return [WatchTriggerHandler] trigger handler for supplied trigger
             def get(trigger)
@@ -92,7 +92,7 @@ module OpenHAB
             private
 
             #
-            # Creates trigger types and trigger type factories for OpenHAB
+            # Creates trigger types and trigger type factories for openHAB
             #
             def add_script_cron_handler
               Core.automation_manager.add_trigger_handler(
@@ -105,7 +105,7 @@ module OpenHAB
             end
 
             #
-            # Creates trigger types and trigger type factories for OpenHAB
+            # Creates trigger types and trigger type factories for openHAB
             #
             def cron_trigger_type
               org.openhab.core.automation.type.TriggerType.new(

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

@@ -18,7 +18,7 @@ module OpenHAB
           # @param [Item State] to state to restrict trigger to
           # @param [Object] attach object to be attached to the trigger
           #
-          # @return [Trigger] OpenHAB triggers
+          # @return [org.openhab.core.automation.Trigger]
           #
           def trigger(item:, to:, attach:)
             case to
@@ -44,7 +44,7 @@ module OpenHAB
           # @param [Object] item to create changed trigger on
           # @param [Object] to state restrict trigger to
           # @param [Object] attach object to be attached to the trigger
-          # @return [Trigger] OpenHAB trigger
+          # @return [org.openhab.core.automation.Trigger]
           #
           def range_trigger(item:, to:, attach:)
             to, * = Conditions::Proc.range_procs(to)
@@ -56,7 +56,7 @@ module OpenHAB
           # @param [Object] item to create changed trigger on
           # @param [Object] to state restrict trigger to
           # @param [Object] attach object to be attached to the trigger
-          # @return [Trigger] OpenHAB trigger
+          # @return [org.openhab.core.automation.Trigger]
           #
           def proc_trigger(item:, to:, attach:)
             conditions = Conditions::Proc.new(to: to)
@@ -70,7 +70,7 @@ module OpenHAB
           # @param [State] to state restriction on trigger
           # @param [Object] attach object to be attached to the trigger
           #
-          # @return [Trigger] OpenHAB triggers
+          # @return [org.openhab.core.automation.Trigger]
           #
           def update_trigger(item:, to:, attach: nil, conditions: nil)
             type, config = case item
@@ -103,7 +103,7 @@ module OpenHAB
           #
           # Create an update trigger for a group
           #
-          # @param [Item] item to create trigger for
+          # @param [GroupItem::Members] item to create trigger for
           # @param [State] to optional state restriction for target
           #
           # @return [Array<Hash,String>] first element is a String specifying trigger type

data/lib/openhab/dsl/rules/triggers/watch/watch_handler.rb

@@ -10,7 +10,7 @@ module OpenHAB
         #
         module WatchHandler
           #
-          # Creates trigger types and trigger type factories for OpenHAB
+          # Creates trigger types and trigger type factories for openHAB
           #
           private_class_method def self.watch_trigger_type
             org.openhab.core.automation.type.TriggerType.new(
@@ -27,7 +27,7 @@ module OpenHAB
           # Trigger ID for Watch Triggers
           WATCH_TRIGGER_MODULE_ID = "jsr223.jruby.WatchTrigger"
 
-          # Extends the OpenHAB watch service to watch directories
+          # Extends the openHAB watch service to watch directories
           #
           # Must match java method name style
           # rubocop:disable Naming/MethodName
@@ -75,12 +75,12 @@ module OpenHAB
           end
           # rubocop:enable Naming/MethodName
 
-          # Implements the OpenHAB TriggerHandler interface to process Watch Triggers
+          # Implements the openHAB TriggerHandler interface to process Watch Triggers
           class WatchTriggerHandler
             include org.openhab.core.automation.handler.TriggerHandler
 
             # Creates a new WatchTriggerHandler
-            # @param [Trigger] trigger OpenHAB trigger associated with handler
+            # @param [org.openhab.core.automation.Trigger] trigger
             #
             def initialize(trigger)
               @trigger = trigger
@@ -94,21 +94,20 @@ module OpenHAB
             # Create a lambda to use to invoke rule engine when file watch notification happens
             # @param [String] glob to match for notification events
             #
-            # @return [Lambda] lambda to execute on notification events
+            # @return [Proc] lambda to execute on notification events
             #
             def watch_event_handler(glob)
-              lambda { |watch_event|
+              lambda do |watch_event|
                 if watch_event.path.fnmatch?(glob)
                   logger.trace("Received event(#{watch_event})")
                   @rule_engine_callback&.triggered(@trigger, { "event" => watch_event })
                 else
                   logger.trace("Event #{watch_event} did not match glob(#{glob})")
                 end
-              }
+              end
             end
 
-            # Called by OpenHAB to set the rule engine to invoke when triggered
-            # Must match java method name style
+            # Called by openHAB to set the rule engine to invoke when triggered
             def setCallback(callback) # rubocop:disable Naming/MethodName
               @rule_engine_callback = callback
             end
@@ -126,8 +125,8 @@ module OpenHAB
           class WatchTriggerHandlerFactory
             include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
 
-            # Invoked by the OpenHAB core to get a trigger handler for the supllied trigger
-            # @param [Trigger] trigger OpenHAB trigger
+            # Invoked by openHAB core to get a trigger handler for the supllied trigger
+            # @param [org.openhab.core.automation.Trigger] trigger
             #
             # @return [WatchTriggerHandler] trigger handler for supplied trigger
             def get(trigger)
@@ -136,7 +135,7 @@ module OpenHAB
           end
 
           #
-          # Creates trigger types and trigger type factories for OpenHAB
+          # Creates trigger types and trigger type factories for openHAB
           #
           def self.add_watch_handler
             Core.automation_manager.add_trigger_handler(

data/lib/openhab/dsl/things/builder.rb

@@ -6,14 +6,36 @@ module OpenHAB
     # Contains extensions to simplify working with {Core::Things::Thing Thing}s.
     #
     module Things
-      # A thing builder allows you to dynamically create OpenHAB thing at runtime.
+      # A thing builder allows you to dynamically create openHAB things at runtime.
       # This can be useful either to create things as soon as the script loads,
       # or even later based on a rule executing.
       #
-      # @example
+      # @example Create a Thing from the Astro Binding
       #   things.build do
       #     thing "astro:sun:home", "Astro Sun Data", config: { "geolocation" => "0,0" }
       #   end
+      #
+      # @example Create a Thing with Channels
+      #   thing_config = {
+      #     availabilityTopic: "my-switch/status",
+      #     payloadAvailable: "online",
+      #     payloadNotAvailable: "offline"
+      #   }
+      #   things.build do
+      #     thing("mqtt:topic:my-switch", "My Switch", bridge: "mqtt:bridge:mosquitto", config: thing_config) do
+      #       channel("switch1", "switch", config: {
+      #         stateTopic: "stat/my-switch/switch1/state", commandTopic="cmnd/my-switch/switch1/command"
+      #       })
+      #       channel("button1", "string", config: {
+      #         stateTopic: "stat/my-switch/button1/state", commandTopic="cmnd/my-switch/button1/command"
+      #       })
+      #     end
+      #   end
+      #
+      # @see ThingBuilder#initialize ThingBuilder#initialize for #thing's parameters
+      # @see ChannelBuilder#initialize ChannelBuilder#initialize for #channel's parameters
+      # @see Items::Builder
+      #
       class Builder
         # @return [org.openhab.core.things.ManagedThingProvider]
         attr_reader :provider
@@ -96,6 +118,26 @@ module OpenHAB
           end
         end
 
+        #
+        # Constructor for ThingBuilder
+        #
+        # @param [String] uid The ThingUID for the created Thing.
+        #   This can consist one or more segments separated by a colon. When the uid contains:
+        #   - One segment: When the uid contains one segment, `binding` or `bridge` id must be provided.
+        #   - Two segments: `typeid:thingid` The `binding` or `bridge` id must be provided.
+        #   - Three or more segments: `bindingid:typeid:[bridgeid...]:thingid`. The `type` and `bridge` can be omitted
+        # @param [String] label The Thing's label.
+        # @param [String] binding The binding id. When this argument is not provided,
+        #   the binding id must be deducible from the `uid`, `type`, or `bridge`.
+        # @param [String] type The type id. When this argument is not provided,
+        #   it will be deducible from the `uid` if it contains two or more segments.
+        #   To create a Thing with a blank type id, use one segment for `uid` and provide the binding id.
+        # @param [String, BridgeBuilder] bridge The bridge uid, if the Thing should belong to a bridge.
+        # @param [String, Item] location The location of this Thing.
+        #   When given an Item, use the item's label as the location.
+        # @param [Hash] config The Thing's configuration, as required by the binding. The key can be strings or symbols.
+        # @param [true,false] enabled Whether the Thing should be enabled or disabled.
+        #
         def initialize(uid, label = nil, binding: nil, type: nil, bridge: nil, location: nil, config: {}, enabled: nil)
           @channels = []
           uid = uid.to_s
@@ -117,13 +159,18 @@ module OpenHAB
             @bridge_uid = org.openhab.core.thing.ThingUID.new(*bridge_segments)
           end
 
-          @uid = org.openhab.core.thing.ThingUID.new(*[binding, type, @bridge_uid&.id,
-                                                       uid_segments.last].compact)
+          thinguid = if uid_segments.length > 2
+                       [binding, type, uid_segments.last].compact
+                     else
+                       [binding, type, @bridge_uid&.id, uid_segments.last].compact
+                     end
+
+          @uid = org.openhab.core.thing.ThingUID.new(*thinguid)
           @thing_type_uid = org.openhab.core.thing.ThingTypeUID.new(*@uid.all_segments[0..1])
           @label = label
           @location = location
-          @location = location.label if location.is_a?(GenericItem)
-          @config = config
+          @location = location.label if location.is_a?(Item)
+          @config = config.transform_keys(&:to_s)
           @enabled = enabled
         end
 
@@ -132,7 +179,7 @@ module OpenHAB
         def channel(*args, **kwargs, &block)
           channel = ChannelBuilder.new(*args, thing: self, **kwargs)
           channel.instance_eval(&block) if block
-          @channels << channel
+          @channels << channel.build
         end
 
         # @!visibility private
@@ -190,9 +237,22 @@ module OpenHAB
       # The ChannelBuilder DSL allows you to customize a channel
       class ChannelBuilder
         attr_accessor :label
-        attr_reader :uid, :parameters
+        attr_reader :uid, :config, :type
 
-        def initialize(uid, type, label, thing:, group: nil, **parameters)
+        #
+        # Constructor for ChannelBuilder
+        #
+        # This class is instantiated by the {ThingBuilder#channel #channel} method inside a {Builder#thing} block.
+        #
+        # @param [String] uid The channel's ID.
+        # @param [String, ChannelTypeUID, :trigger] type The concrete type of the channel.
+        # @param [String] label The channel label.
+        # @param [thing] thing The thing associated with this channel.
+        #   This parameter is not needed for the {ThingBuilder#channel} method.
+        # @param [String] group The group name.
+        # @param [Hash] config Channel configuration. The keys can be strings or symbols.
+        #
+        def initialize(uid, type, label = nil, thing:, group: nil, config: {})
           @thing = thing
 
           uid = uid.to_s
@@ -207,13 +267,12 @@ module OpenHAB
             uid_segments[-1] = group_segments.join(org.openhab.core.thing.ChannelUID::CHANNEL_GROUP_SEPARATOR)
           end
           @uid = org.openhab.core.thing.ChannelUID.new(thing.uid, uid_segments.last)
-          unless type.is_a?(org.openhab.core.thing.ChannelTypeUID)
-            type = org.openhab.core.thing.ChannelTypeUID.new(thing.uid.binding_id,
-                                                             type)
+          unless type.is_a?(org.openhab.core.thing.type.ChannelTypeUID)
+            type = org.openhab.core.thing.type.ChannelTypeUID.new(thing.uid.binding_id, type)
           end
           @type = type
           @label = label
-          @parameters = parameters
+          @config = config.transform_keys(&:to_s)
         end
 
         # @!visibility private
@@ -221,7 +280,7 @@ module OpenHAB
           org.openhab.core.thing.binding.builder.ChannelBuilder.create(uid)
              .with_kind(kind)
              .with_type(type)
-             .with_configuration(org.openhab.core.config.core.Configuration.new(parameters))
+             .with_configuration(org.openhab.core.config.core.Configuration.new(config))
              .build
         end
 

data/lib/openhab/dsl/version.rb

@@ -2,8 +2,8 @@
 
 module OpenHAB
   module DSL
-    # Version of OpenHAB helper libraries
+    # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.0.0.rc5"
+    VERSION = "5.0.0.rc8"
   end
 end

data/lib/openhab/dsl.rb

@@ -16,7 +16,7 @@ end
 require_relative "core_ext"
 
 #
-# Main OpenHAB Module
+# Main openHAB Module
 #
 module OpenHAB
   #
@@ -69,7 +69,7 @@ module OpenHAB
     #   The state being sent for `:state_from_item` and `:state_from_handler` events.
     # @yieldparam [Core::Things::ItemChannelLink] link
     #   The link between the item and the channel, including its configuration.
-    # @yieldparam [GenericItem] item The linked item.
+    # @yieldparam [Item] item The linked item.
     # @yieldparam [Core::Things::ChannelUID] channel_uid The linked channel.
     # @yieldparam [Hash] configuration The profile configuration.
     # @yieldparam [org.openhab.core.thing.profiles.ProfileContext] context The profile context.
@@ -106,6 +106,19 @@ module OpenHAB
 
     # @!group Object Access
 
+    #
+    # (see Core::ValueCache)
+    #
+    # @return [Core::ValueCache] the cache shared among all scripts and UI rules in all languages.
+    #
+    # @see Core::ValueCache ValueCache
+    #
+    # @since openHAB 3.4.0
+    #
+    def shared_cache
+      $sharedCache
+    end
+
     #
     # Fetches all rules from the rule registry.
     #
@@ -141,7 +154,7 @@ module OpenHAB
     #
     # @example
     #   rule 'search for a suitable item' do
-    #     on_start
+    #     on_load
     #     triggered do
     #       # Send ON to DimmerTest if it exists, otherwise send it to SwitchTest
     #       (items['DimmerTest'] || items['SwitchTest'])&.on
@@ -153,9 +166,9 @@ module OpenHAB
     end
 
     #
-    # Get all things known to OpenHAB
+    # Get all things known to openHAB
     #
-    # @return [Core::Things::Registry] all Thing objects known to OpenHAB
+    # @return [Core::Things::Registry] all Thing objects known to openHAB
     #
     # @example
     #   things.each { |thing| logger.info("Thing: #{thing.uid}")}
@@ -171,7 +184,7 @@ module OpenHAB
     end
 
     #
-    # Provides access to timers created by {after}
+    # Provides access to timers created by {after after}
     #
     # @return [TimerManager]
     def timers
@@ -186,7 +199,8 @@ module OpenHAB
     # ### Reentrant Timers
     #
     # Timers with an id are reentrant by id. Reentrant means that when the same id is encountered,
-    # the timer is rescheduled rather than creating a second new timer.
+    # the timer is rescheduled rather than creating a second new timer. Note that the timer will
+    # execute the block provided in the latest call.
     #
     # This removes the need for the usual boilerplate code to manually keep track of timer objects.
     #
@@ -194,7 +208,7 @@ module OpenHAB
     #
     # When a timer is cancelled, it will be removed from the object.
     #
-    # Be sure that your ids are unique. For example, if you're using {GenericItem items} as your
+    # Be sure that your ids are unique. For example, if you're using {Item items} as your
     # ids, you either need to be sure you don't use the same item for multiple logical contexts,
     # or you need to make your id more specific, by doing something like embedding the item in
     # array with a symbol of the timer's purpose, like `[:vacancy, item]`. But also note that
@@ -221,7 +235,7 @@ module OpenHAB
     #     logger.info("Timer Fired")
     #   end
     #
-    # @example Timers delegate methods to OpenHAB timer objects
+    # @example Timers delegate methods to openHAB timer objects
     #   after 1.second do |timer|
     #     logger.info("Timer is active? #{timer.active?}")
     #   end
@@ -267,9 +281,21 @@ module OpenHAB
     #   end
     #
     # @example Only create a new timer if it isn't already scheduled
-    #  after(1.minute, id: :foo, reschedule: false) do
-    #    logger.info("Timer fired")
-    #  end
+    #   after(1.minute, id: :foo, reschedule: false) do
+    #     logger.info("Timer fired")
+    #   end
+    #
+    # @example Reentrant timers will execute the block from the most recent call
+    #   # In the following example, if Item1 received a command, followed by Item2,
+    #   # the timer will execute the block referring to Item2.
+    #   rule "Execute The Most Recent Block" do
+    #     received_command Item1, Item2
+    #     run do |event|
+    #       after(10.minutes, id: :common_timer) do
+    #         logger.info "The latest command was received from #{event.item}"
+    #       end
+    #     end
+    #   end
     #
     def after(duration, id: nil, reschedule: true, &block)
       raise ArgumentError, "Block is required" unless block
@@ -313,10 +339,10 @@ module OpenHAB
     # Store states of supplied items
     #
     # Takes one or more items and returns a map `{Item => State}` with the
-    # current state of each item. It is implemented by calling OpenHAB's
+    # current state of each item. It is implemented by calling openHAB's
     # [events.storeStates()](https://www.openhab.org/docs/configuration/actions.html#event-bus-actions).
     #
-    # @param [GenericItem] items Items to store states of.
+    # @param [Item] items Items to store states of.
     #
     # @return [Core::Items::StateStorage] item states
     #
@@ -603,7 +629,7 @@ module OpenHAB
     #   Otherwise it's applied to all types.
     # @param [Hash] providers_by_type
     #     A list of providers by type. Type can be `:items`, `:metadata`, `:things`, `:links`,
-    #     a {GenericItem} applying the provider to all metadata on that item, or a String or Symbol
+    #     an {Item} applying the provider to all metadata on that item, or a String or Symbol
     #     applying the provider to all metadata of that namespace.
     #
     #     The provider can be a {org.openhab.core.common.registry.Provider Provider}, `:persistent`,
@@ -667,7 +693,7 @@ module OpenHAB
           thread_providers[type] = provider
         when Symbol, String
           (thread_providers[:metadata_namespaces] ||= {})[type.to_s] = provider
-        when GenericItem
+        when Item
           (thread_providers[:metadata_items] ||= {})[type.name] = provider
         else
           raise ArgumentError, "#{type.inspect} is not provider type"
@@ -702,4 +728,4 @@ OpenHAB::Core::Items.import_into_global_namespace
 # Extend `main` with DSL methods
 singleton_class.include(OpenHAB::DSL)
 
-logger.debug "OpenHAB JRuby Scripting Library Version #{OpenHAB::DSL::VERSION} Loaded"
+logger.debug "openHAB JRuby Scripting Library Version #{OpenHAB::DSL::VERSION} Loaded"

data/lib/openhab/log.rb

@@ -6,7 +6,7 @@ module OpenHAB
   # rubocop:disable Layout/LineLength
 
   #
-  # Provides access to the OpenHAB logging facilities using Ruby logging methods
+  # Provides access to the openHAB logging facilities using Ruby logging methods
   #
   # Logging is available everywhere through the {#logger} object.
   #
@@ -26,7 +26,7 @@ module OpenHAB
   # @example The following entries are in a file named 'log_test.rb'
   #   rule 'foo' do
   #     run { logger.trace('Test logging at trace') } # 2020-12-03 18:05:20.903 [TRACE] [org.openhab.automation.jrubyscripting.foo] - Test logging at trace
-  #     on_start
+  #     on_load
   #   end
   #
   #
@@ -122,7 +122,7 @@ module OpenHAB
   end
 
   #
-  # Ruby Logger that forwards messages at appropriate levels to OpenHAB Logger
+  # Ruby Logger that forwards messages at appropriate levels to openHAB Logger
   #
   class Logger
     # The base prefix for all loggers from this gem.
@@ -150,7 +150,7 @@ module OpenHAB
     private_constant :JAVA_INTERNAL_CALL_REGEX
 
     class << self
-      # The root logger (all of OpenHAB)
+      # The root logger (all of openHAB)
       # @return [Logger]
       def root
         Log.logger(org.slf4j.Logger::ROOT_LOGGER_NAME)
@@ -299,7 +299,7 @@ module OpenHAB
     end
 
     #
-    # Log a message to the OpenHAB Logger
+    # Log a message to the openHAB Logger
     #
     # @param [Symbol] severity Severity to log message at
     # @param [Object] msg to log, if no msg supplied and a block is provided,

data/lib/openhab/rspec/configuration.rb

@@ -3,13 +3,13 @@
 module OpenHAB
   module RSpec
     #
-    # Contains configuration for how the OpenHAB instance should be set
+    # Contains configuration for how the openHAB instance should be set
     # up for the testing environment.
     #
     module Configuration
       class << self
         #
-        # Copy binding configuration from the root OpenHAB instance.
+        # Copy binding configuration from the root openHAB instance.
         #
         # Default `true`.
         # @return [true, false]
@@ -18,7 +18,7 @@ module OpenHAB
 
         #
         # Copy the JSONDB (managed thing and item configuration) from the root
-        # OpenHAB instance.
+        # openHAB instance.
         #
         # Default `true`.
         #
@@ -28,7 +28,7 @@ module OpenHAB
 
         #
         # Use a private (empty) confdir (scripts, rules, items, and things
-        # files), instead of sharing with the root OpenHAB instance.
+        # files), instead of sharing with the root openHAB instance.
         #
         # Default `false`.
         #
@@ -37,7 +37,7 @@ module OpenHAB
         attr_accessor :private_confdir
 
         #
-        # Use the root OpenHAB instance directly, rather than creating a
+        # Use the root openHAB instance directly, rather than creating a
         # private (but linked) instance.
         #
         # Default `false`.

data/lib/openhab/rspec/example_group.rb

@@ -94,7 +94,7 @@ module OpenHAB
         #     it "logs exceptions in rule execution" do
         #       expect(self.class.propagate_exceptions?).to be false
         #       rule do
-        #         on_start
+        #         on_load
         #         run { raise "exception is logged" }
         #       end
         #       expect(spec_log_lines).to include(match(/exception is logged/))