rsmp 0.3.7 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63163e8e010e001deffd0bba691e343c028ae5edbf3a5c9022529d319c36035e
-  data.tar.gz: 07225c7538b514c3b74dbc307a432f32eb1fe839faaeef4483208206b29e103a
+  metadata.gz: b37598da5f9d49f45c771f6cefeae320304caeaa4c9e8c50ba005442554c88f4
+  data.tar.gz: 29f72fa255248e3c3bb27946877714f262235f252da551d6e4941efbc5b12547
 SHA512:
-  metadata.gz: 6eed25d057be1a6766b94d1127b41f498b4e3532bf5650d7c888321dfe48bafaf2af69ff2d871cc437fc44ae9286d898da2387bc2e267d451aca332d3695159f
-  data.tar.gz: 011f89ceb76bbfdc521ca0730c2d7f1c48663e4faf35576e4e72bee83831813745bc0ce0c45aab4201c1874f1ee21a5c1f6235dbab0c16feab1e3970acc56d3b
+  metadata.gz: d1dd3458a8a619ee06bffd194f93aa16b7b00874d0c76ff52c00b23f5081ea6dde7dbe3e8eb5c5736b6e05938894a6278a1a870a5ea0cb318c962ff2663cddc2
+  data.tar.gz: 70f633dc8a56995df2b1439467664fc00c861208d80fa2da14fc473413aa3d6186a9fd5bc0a727632757a6fececbb5fd5ed6456cdfcb74623db97eeb321637ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.3.7)
+    rsmp (0.4.1)
       async (~> 1.29.1)
       async-io (~> 1.32.1)
       colorize (~> 0.8.1)

data/lib/rsmp/{collector.rb → collect/collector.rb}

@@ -1,6 +1,6 @@
 module RSMP
 
-  # Collects ingoing and/or outgoing messages.
+  # Collects ingoing and/or outgoing messages from a notifier.
   # Can filter by message type and wakes up the client once the desired number of messages has been collected.
   class Collector < Listener
     attr_reader :condition, :messages, :done
@@ -17,22 +17,29 @@ module RSMP
       reset
     end
 
+    # Inspect formatter that shows the message we have collected
     def inspect
       "#<#{self.class.name}:#{self.object_id}, #{inspector(:@messages)}>"
     end
 
+    # Want ingoing messages?
     def ingoing?
       @ingoing == true
     end
 
+    # Want outgoing messages?
     def outgoing?
       @outgoing == true
     end
 
+    # Block until all messages have been collected
     def wait
       @condition.wait
     end
 
+    # Collect message
+    # Will block until all messages have been collected,
+    # or we time out 
     def collect task, options={}, &block
       @options.merge! options
       @block = block
@@ -46,17 +53,20 @@ module RSMP
       return @error if @error
       self
     rescue Async::TimeoutError
-      str = "Did not receive #{@title}"
+      str = "#{@title.capitalize} collection"
       str << " in response to #{options[:m_id]}" if options[:m_id]
-      str << " within #{@options[:timeout]}s"
+      str << " didn't complete within #{@options[:timeout]}s"
       raise RSMP::TimeoutError.new str
     end
 
+    # Get the collected message.
+    def message
+      @messages.first
+    end
+
     # Get the collected messages.
-    # If one message was requested, return it as a plain object instead of array
-    def result
-      return @messages.first if @options[:num] == 1     
-      @messages.first @options[:num] 
+    def messages
+      @messages
     end
 
     # Clear all query results

data/lib/rsmp/collect/matcher.rb

@@ -0,0 +1,109 @@
+module RSMP
+  # Base class for waiting for specific status or command responses, specified by
+  # a list of queries. Queries are defined as an array of hashes, e.g
+  # [
+  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"securityCode", "v"=>"1111"},
+  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"year", "v"=>"2020"},
+  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/}
+  #  ]
+  #
+  # Note that queries can contain regex patterns for values, like /\d+/ in the example above.
+  #
+  # When an input messages is received it typically contains several items, eg:
+  # [
+  #   {"cCI"=>"M0104", "n"=>"month", "v"=>"9", "age"=>"recent"},
+  #   {"cCI"=>"M0104", "n"=>"day", "v"=>"29", "age"=>"recent"},
+  #   {"cCI"=>"M0104", "n"=>"hour", "v"=>"17", "age"=>"recent"}
+  # ]
+  #
+  # Each input item is matched against each of the queries.
+  # If a match is found, it's stored in the @results hash, with the query as the key,
+  # and a mesage and status as the key. In the example above, this query:
+  #
+  # {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/}
+  #
+  # matches this input:
+  #
+  # {"cCI"=>"M0104", "n"=>"month", "v"=>"9", "age"=>"recent"}
+  # 
+  # And the result is stored as:
+  # {
+  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/} =>
+  #     { <StatusResponse message>, {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>"9"} }
+  # }
+
+  class Matcher < Collector
+    attr_reader :queries
+
+    # Initialize with a list of wanted statuses
+    def initialize proxy, want, options={}
+      super proxy, options.merge( ingoing: true, outgoing: false)
+      @queries = want.map { |item| build_query item }
+      @want = want
+    end
+
+    # Build a query object.
+    # Sub-classes should override to use their own query classes.
+    def build_query want
+      Query.new want
+    end
+
+    # Get a results
+    def query_result want
+      query = @queries.find { |q| q.want == want}
+      raise unless query
+      query.got
+    end
+
+    # Get an array of the last item received for each query
+    def reached
+      @queries.map { |query| query.got }.compact
+    end
+
+    # get the first message. Useful when you only collect one mesage
+    def message
+      @queries.first.message
+    end
+
+    # Get messages from results
+    def messages
+      @queries.map { |query| query.message }.uniq
+    end
+
+    # Are there queries left to match?
+    def done?
+      @queries.all? { |query| query.done? }
+    end
+
+    # Get a simplified hash of queries, with values set to either true or false,
+    # indicating which queries have been matched.
+    def status
+      @queries.map { |query| [query.want, query.done?] }.to_h
+    end
+
+    # Get a simply array of bools, showing which queries ahve been matched.
+    def summary
+      @queries.map { |query| query.done? }
+    end
+
+    # Check if a messages matches our criteria.
+    # We iterate through each of the status items or return values in the message
+    # Breaks as soon as where done matching all queries
+    def check_match message
+      return unless match?(message)
+      @queries.each do |query|       # look through queries
+        get_items(message).each do |item|  # look through status items in message
+          matched = query.check_match(item,message)
+          if matched != nil
+            type = {true=>'positive',false=>'negative'}[matched]
+            @proxy.log "Query #{query.want} has #{type} match with item #{item}, reached #{summary}", message: message, level: :info
+            break matched
+          end
+        end
+      end
+#      @proxy.log "match", level: :info
+      nil
+    end
+
+  end
+end

data/lib/rsmp/collect/message_matchers.rb

@@ -0,0 +1,64 @@
+module RSMP
+  # Class for waiting for specific command responses
+  class CommandResponseMatcher < Matcher
+    def initialize proxy, want, options={}
+      super proxy, want, options.merge(
+        type: ['CommandResponse','MessageNotAck'],
+        title:'command response'
+      )
+    end
+
+    def build_query want
+      CommandQuery.new want
+    end
+
+    # Get items, in our case the return values
+    def get_items message
+      message.attributes['rvs']
+    end
+  end
+
+  # Base class for waiting for status updates or responses
+  class StatusUpdateOrResponseMatcher < Matcher
+    def initialize proxy, want, options={}
+      super proxy, want, options.merge
+    end
+
+    def build_query want
+      StatusQuery.new want
+    end
+
+    # Get items, in our case status values
+    def get_items message
+      message.attributes['sS']
+    end
+  end
+
+  # Class for waiting for specific status responses
+  class StatusResponseMatcher < StatusUpdateOrResponseMatcher
+    def initialize proxy, want, options={}
+      super proxy, want, options.merge(
+        type: ['StatusResponse','MessageNotAck'],
+        title: 'status response'
+      )
+    end
+  end
+
+  # Class for waiting for specific status responses
+  class StatusUpdateMatcher < StatusUpdateOrResponseMatcher
+    def initialize proxy, want, options={}
+      super proxy, want, options.merge(
+        type: ['StatusUpdate','MessageNotAck'],
+        title:'status update'
+      )
+    end
+  end
+
+  # Class for waiting for an aggregated status response
+  class AggregatedStatusMatcher < Collector
+    def initialize proxy, options={}
+      required = { type: ['AggregatedStatus','MessageNotAck'], title: 'aggregated status' }
+      super proxy, options.merge(required)
+    end
+  end
+end

data/lib/rsmp/collect/message_queries.rb

@@ -0,0 +1,33 @@
+module RSMP
+  # Match a specific command responses
+  class CommandQuery < Query
+    # Match a return value item against a query
+    def match? item
+      return nil if @want['cCI'] && @want['cCI'] != item['cCI']
+      return nil if @want['n'] && @want['n'] != item['n']
+      if @want['v'].is_a? Regexp
+        return false if @want['v'] && item['v'] !~ @want['v']
+      else
+        return false if @want['v'] && item['v'] != @want['v']
+      end
+      true
+    end
+  end
+
+  # Match a specific status response or update 
+  class StatusQuery < Query
+    # Match a status value against a query
+    def match? item
+      return nil if @want['sCI'] && @want['sCI'] != item['sCI']
+      return nil if @want['cO'] && @want['cO'] != item['cO']
+      return nil if @want['n'] && @want['n'] != item['n']
+      return false if @want['q'] && @want['q'] != item['q']
+      if @want['s'].is_a? Regexp
+        return false if item['s'] !~ @want['s']
+      elsif @want['s']
+        return false if item['s'] != @want['s']
+      end
+      true
+    end
+  end
+end

data/lib/rsmp/collect/query.rb

@@ -0,0 +1,32 @@
+module RSMP
+    
+  # Class that matches a single status or command item
+  class Query
+    attr_reader :want, :got, :message
+
+    def initialize want
+      @want = want
+      @got = nil
+      @message = nil
+      @done = false
+    end
+
+    # Are we done, i.e. did the last checked item match?
+    def done?
+      @done
+    end
+
+    # Check an item and set @done to true if it matches
+    # Always store the item and corresponding message.
+    def check_match item, message
+      @message = message
+      @got = item
+      matched = match? item
+      @done = matched if matched != nil
+      matched
+    end
+
+    def match? item
+    end
+  end
+end

data/lib/rsmp/site_proxy.rb

@@ -335,20 +335,12 @@ module RSMP
       @supervisor.notify_error e, options if @supervisor
     end
 
-    def wait_for_alarm parent_task, options={}
-      matching_alarm = nil
-      message = collect(parent_task,options.merge(type: "Alarm", with_message: true, num: 1)) do |message|
-        # TODO check components
-        matching_alarm = nil
-        alarm = message
+    def collect_alarms parent_task, options={}
+      collect(parent_task,options.merge(type: "Alarm")) do |alarm|
         next if options[:aCId] && options[:aCId] != alarm.attribute("aCId")
         next if options[:aSp] && options[:aSp] != alarm.attribute("aSp")
         next if options[:aS] && options[:aS] != alarm.attribute("aS")
-        matching_alarm = alarm
-        break
-      end
-      if item
-        { message: message, status: matching_alarm }
+        true
       end
     end
 

data/lib/rsmp/tlc.rb

@@ -293,7 +293,8 @@ module RSMP
     def handle_s0002 status_code, status_name=nil
       case status_name
       when 'detectorlogicstatus'
-        RSMP::Tlc.make_status @detector_logics.map { |dl| dl.forced ? '1' : '0' }.join
+        RSMP::Tlc.make_status @detector_logics.each { |dl| p dl.value }
+        RSMP::Tlc.make_status @detector_logics.map { |dl| dl.value ? '1' : '0' }.join
       end
     end
 
@@ -703,7 +704,7 @@ module RSMP
   end
 
   class DetectorLogic < Component
-    attr_reader :status, :forced, :value
+    attr_reader :forced, :value
 
     def initialize node:, id:
       super node: node, id: id, grouped: false
@@ -783,13 +784,20 @@ module RSMP
 
     def handle_m0008 arg
       @node.verify_security_code 2, arg['securityCode']
-      force_detector_logic arg['status']=='True', arg['value']='True'
+      status = arg['status']=='True'
+      mode = arg['mode']=='True'
+      force_detector_logic status, mode
       arg
     end
 
-    def force_detector_logic status, value
-      @forced = status
+    def force_detector_logic forced, value
+      @forced = forced
       @value = value
+      if @forced
+        log "Forcing to #{value}", level: :info
+      else
+        log "Releasing", level: :info
+      end
     end
 
   end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.3.7"
+  VERSION = "0.4.1"
 end

data/lib/rsmp.rb

@@ -17,10 +17,13 @@ require 'rsmp/wait'
 require 'rsmp/node'
 require 'rsmp/supervisor'
 require 'rsmp/components'
-require 'rsmp/notifier'
-require 'rsmp/listener'
-require 'rsmp/collector'
-require 'rsmp/matcher'
+require 'rsmp/collect/notifier'
+require 'rsmp/collect/listener'
+require 'rsmp/collect/collector'
+require 'rsmp/collect/query'
+require 'rsmp/collect/matcher'
+require 'rsmp/collect/message_queries'
+require 'rsmp/collect/message_matchers'
 require 'rsmp/component'
 require 'rsmp/site'
 require 'rsmp/proxy'

data/test.rb

@@ -0,0 +1,27 @@
+class A
+	def go &block
+		@block = block			# block will be converted automatically to a Proc
+		indirect
+	end
+
+	def call
+		@block.call
+	end
+
+	def indirect
+		call
+	end
+
+end
+
+a = A.new
+
+a.go do
+	break		# this is ok. break causes the block to exit, and the encasing method to return - go() will exit
+end
+
+# this raises an error. the block we passed to go() will be called again, and it tries to break
+# but we're not inside a method we can exit from
+
+
+a.indirect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.1
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -205,7 +205,13 @@ files:
 - lib/rsmp.rb
 - lib/rsmp/archive.rb
 - lib/rsmp/cli.rb
-- lib/rsmp/collector.rb
+- lib/rsmp/collect/collector.rb
+- lib/rsmp/collect/listener.rb
+- lib/rsmp/collect/matcher.rb
+- lib/rsmp/collect/message_matchers.rb
+- lib/rsmp/collect/message_queries.rb
+- lib/rsmp/collect/notifier.rb
+- lib/rsmp/collect/query.rb
 - lib/rsmp/component.rb
 - lib/rsmp/components.rb
 - lib/rsmp/convert/export/json_schema.rb
@@ -213,13 +219,10 @@ files:
 - lib/rsmp/deep_merge.rb
 - lib/rsmp/error.rb
 - lib/rsmp/inspect.rb
-- lib/rsmp/listener.rb
 - lib/rsmp/logger.rb
 - lib/rsmp/logging.rb
-- lib/rsmp/matcher.rb
 - lib/rsmp/message.rb
 - lib/rsmp/node.rb
-- lib/rsmp/notifier.rb
 - lib/rsmp/proxy.rb
 - lib/rsmp/rsmp.rb
 - lib/rsmp/site.rb
@@ -231,6 +234,7 @@ files:
 - lib/rsmp/version.rb
 - lib/rsmp/wait.rb
 - rsmp.gemspec
+- test.rb
 homepage: https://github.com/rsmp-nordic/rsmp
 licenses:
 - MIT
@@ -254,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: RoadSide Message Protocol (RSMP) library.

data/lib/rsmp/matcher.rb

@@ -1,195 +0,0 @@
-module RSMP
-
-  # Base class for waiting for specific status or command responses, specified by
-  # a list of queries. Queries are defined as an array of hashes, e.g
-  # [
-  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"securityCode", "v"=>"1111"},
-  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"year", "v"=>"2020"},
-  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/}
-  #  ]
-  #
-  # Note that queries can contain regex patterns for values, like /\d+/ in the example above.
-  #
-  # When an input messages is received it typically contains several items, eg:
-  # [
-  #   {"cCI"=>"M0104", "n"=>"month", "v"=>"9", "age"=>"recent"},
-  #   {"cCI"=>"M0104", "n"=>"day", "v"=>"29", "age"=>"recent"},
-  #   {"cCI"=>"M0104", "n"=>"hour", "v"=>"17", "age"=>"recent"}
-  # ]
-  #
-  # Each input item is matched against each of the queries.
-  # If a match is found, it's stored in the @results hash, with the query as the key,
-  # and a mesage and status as the key. In the example above, this query:
-  #
-  # {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/}
-  #
-  # matches this input:
-  #
-  # {"cCI"=>"M0104", "n"=>"month", "v"=>"9", "age"=>"recent"}
-  # 
-  # And the result is stored as:
-  # {
-  #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/} =>
-  #     { <StatusResponse message>, {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>"9"} }
-  # }
-  #
-  #
-  class Matcher < Collector
-    attr_reader :queries
-
-    # Initialize with a list a wanted statuses
-    def initialize proxy, want, options={}
-      super proxy, options.merge( ingoing: true, outgoing: false)
-      @queries = {}
-      want.each do |query|
-        @queries[query] = nil
-      end
-    end
-
-    # Get the results, as a hash of queries => results
-    def result
-      @queries
-    end
-
-    # Get messages from results
-    def messages
-      @queries.map { |query,result| result[:message] }.uniq
-    end
-
-    # Get items from results
-    def items
-      @queries.map { |query,result| result[:item] }.uniq
-    end
-
-    # Are there queries left to match?
-    def done?
-      @queries.values.all? { |result| result != nil }
-    end
-
-    # Get a simplified hash of queries, with values set to either true or false,
-    # indicating which queries have been matched.
-    def status
-      @queries.transform_values{ |v| v != nil }
-    end
-
-    # Get a simply array of bools, showing which queries ahve been matched.
-    def summary
-      @queries.values.map { |v| v != nil }
-    end
-
-    # Mark a query as matched, by linking it to the matched item and message
-    def keep query, message, item
-      @queries[query] = { message:message, item:item }
-    end
-
-    # Mark a query as not matched
-    def forget query
-      @queries[query] = nil
-    end
-
-    # Check if a messages matches our criteria.
-    # We iterate through each of the status items or return values in the message
-    # Breaks as soon as where done matching all queries
-    def check_match message
-      return unless match?(message)
-      @queries.keys.each do |query|       # look through queries
-        get_items(message).each do |item|  # look through status items in message
-          break if check_item_match message, query, item
-        end
-      end
-    end
-
-    # Check if an item matches, and mark query as matched/unmatched accordingly.
-    def check_item_match message, query, item
-      matched = match_item? query, item
-      if matched == true
-        keep query, message, item
-        true
-      elsif matched == false
-        forget query
-        true
-      end
-    end
-  end
-
-  # Class for waiting for specific command responses
-  class CommandResponseMatcher < Matcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['CommandResponse','MessageNotAck'],
-        title:'command response'
-      )
-    end
-
-    # Get items, in our case the return values
-    def get_items message
-      message.attributes['rvs']
-    end
-
-    # Match a return value item against a query
-    def match_item? query, item
-      return nil if query['cCI'] && query['cCI'] != item['cCI']
-      return nil if query['n'] && query['n'] != item['n']
-      if query['v'].is_a? Regexp
-        return false if query['v'] && item['v'] !~ query['v']
-      else
-        return false if query['v'] && item['v'] != query['v']
-      end
-      true
-    end
-  end
-
-  # Base class for waiting for status updates or responses
-  class StatusUpdateOrResponseMatcher < Matcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge
-    end
-
-    # Get items, in our case status values
-    def get_items message
-      message.attributes['sS']
-    end
-
-    # Match a status value against a query
-    def match_item? query, item
-      return nil if query['sCI'] && query['sCI'] != item['sCI']
-      return nil if query['cO'] && query['cO'] != item['cO']
-      return nil if query['n'] && query['n'] != item['n']
-      return false if query['q'] && query['q'] != item['q']
-      if query['s'].is_a? Regexp
-        return false if query['s'] && item['s'] !~ query['s']
-      else
-        return false if query['s'] && item['s'] != query['s']
-      end
-      true
-    end
-  end
-
-  # Class for waiting for specific status responses
-  class StatusResponseMatcher < StatusUpdateOrResponseMatcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['StatusResponse','MessageNotAck'],
-        title: 'status response'
-      )
-    end
-  end
-
-  # Class for waiting for specific status responses
-  class StatusUpdateMatcher < StatusUpdateOrResponseMatcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['StatusUpdate','MessageNotAck'],
-        title:'status update'
-      )
-    end
-  end
-
-  # Class for waiting for an aggregated status response
-  class AggregatedStatusMatcher < Collector
-    def initialize proxy, options={}
-      required = { type: ['AggregatedStatus','MessageNotAck'], title: 'aggregated status' }
-      super proxy, options.merge(required)
-    end
-  end
-end