rsmp 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f137a9e58a8af4524954c33515926c1b6eb2dc8aa7e4fa9bfd00b22f6e5e4bb
-  data.tar.gz: a9710492f633d584e6ac0acdac9b8f5bf9b820dbe3ad14ca31295bc56b41e232
+  metadata.gz: 05d67026eef7404afe7979c198bcfe97bd63e231400e174988ab14454f23ea09
+  data.tar.gz: e82717dc287f0eb2e91577cf5e02d752cdf1d1fef6bdac6f4cf3569494d8da3e
 SHA512:
-  metadata.gz: cb33932006870bcedfbf3a8d07311c1a752ffccdb23c5d72303b80e47fef0f1b61a4a9fc01521afb8c02bfa32a039b54356687e2d912c03ae9c6238159fdc291
-  data.tar.gz: c7161ce4a72fbf33394336ad1d8a8db1aedb5148c8988c66fd7ea361b1afa8efddbccb34e376c47ac030ed30b785b118670f4005412752d490b66696213081f7
+  metadata.gz: 0d971e86ebd1ef25ff52cc4babd23567b2b5e870cc70f7edfc18ce7925a850fd94dfa851e70c16a43d4df1ef174045999ad41c0fd5ad2ed7c074ae022282e441
+  data.tar.gz: 5f991d2aee4af7ac5a30b133ecfa8e1505b005fbc8e7092551f0d28bd4d26cee36fb645aa188e8a9664c0a7d5c991c78a2059445c82e1ec697ff14a8df3d2cdf

data/Gemfile.lock

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

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

@@ -52,11 +52,14 @@ module RSMP
       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,100 @@
+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.map { |wanted_item| build_query wanted_item }
+    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.item
+    end
+
+    # get the first message. Useful when you only collected one mesage
+    def message
+      @queries.first.message
+    end
+
+    # Get messages from results
+    def messages
+      @queries.map { |query| query.message }.uniq
+    end
+
+    # Get items from results
+    def items
+      @queries.map { |query| query.item }.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.query,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
+          break if query.check_match(item,message) != nil #check_item_match message, query, item
+        end
+      end
+    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 @want['s'] && item['s'] !~ @want['s']
+      else
+        return false if @want['s'] && item['s'] != @want['s']
+      end
+      true
+    end
+  end
+end

data/lib/rsmp/collect/query.rb

@@ -0,0 +1,44 @@
+module RSMP
+    
+  # Class that matches a single status or command item
+  class Query
+    attr_reader :want, :item, :message
+
+    def initialize want
+      @want = want
+      @item = nil
+      @message = nil
+      @done = false
+    end
+
+    def done?
+      @done
+    end
+
+    def check_match item, message
+      matched = match? item
+      if matched == true
+        keep message, item
+        true
+      elsif matched == false
+        forget
+        true
+      end
+    end
+
+    def match? item
+    end
+
+    # Mark a query as matched and store item and message
+    def keep message, item
+      @message = message
+      @item = item
+      @done = true
+    end
+
+    # Mark a query as not matched
+    def forget
+      @done = false
+    end
+  end
+end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.3.9"
+  VERSION = "0.4.0"
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-10-27 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
@@ -255,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