rsmp 0.1.19 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfbb10fc77baf015a50f7ce94b2ee3b0830a09f8c083b9f0dfbb86fcd4285893
-  data.tar.gz: 8756ab6010d199fdc2e22973ab960156b66f000c7a8feacad201f5be5bb0ff08
+  metadata.gz: 0aea7740c0640bc069efa1ec9426deb23b3bf4e3f7dce4656e3df814500615d3
+  data.tar.gz: 30d954a75a62d71d46b76b30e448dbc2e30281784f18b82488780e9837b1223b
 SHA512:
-  metadata.gz: af59d9680e6717f8d0e89cae43e1a95aa17ad322c54024c4dae91bb8e58216d7fc57c727c3e1d56ac9c6770131f2197f6708cceba890b0b83867a493b410111e
-  data.tar.gz: 20597a90bc6c9abaf196ffba19d233fa76716c2febee7af2c0c057337953d40d77ac965a671716ed5e645fb93734265231def5104efc7a39a6e92fade86a5ce7
+  metadata.gz: 7a42695cbf11f334d1873843a2550e7734d7719e8fca7ef245d32946d71aa884b6305ff329afbd1713caec41bf213bd0aab62d4f91f5d685c05ed5ce929c68f6
+  data.tar.gz: 3e6c90b6aa6d505285fc27613ce06716f5a00a21893d266cb2e31e0c0f99ea2784610f30f9c4a583c129e95c94770c84a08aabcc6e0e35accfc70b94f3aa2e60

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.19)
-      async (~> 1.23.0)
-      async-io (~> 1.27.4)
+    rsmp (0.1.21)
+      async (~> 1.28.3)
+      async-io (~> 1.30.1)
       colorize (~> 0.8.1)
-      json_schemer (~> 0.2.11)
+      json_schemer (~> 0.2.17)
       thor (~> 1.0.1)
 
 GEM
@@ -18,11 +18,11 @@ GEM
       ffi (~> 1.9)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
-    async (1.23.0)
-      console (~> 1.0)
+    async (1.28.3)
+      console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-io (1.27.7)
+    async-io (1.30.1)
       async (~> 1.14)
     backports (3.17.0)
     builder (3.2.4)
@@ -63,7 +63,7 @@ GEM
     multi_test (0.1.2)
     nio4r (2.5.4)
     rake (13.0.1)
-    regexp_parser (2.0.0)
+    regexp_parser (2.0.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -87,7 +87,7 @@ PLATFORMS
 
 DEPENDENCIES
   aruba (~> 1.0.0)
-  bundler (~> 2.1.4)
+  bundler (~> 2.2.3)
   cucumber (~> 3.1.2)
   rake (~> 13.0.1)
   rsmp!
@@ -96,4 +96,4 @@ DEPENDENCIES
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/documentation/{classes.md → classes_and_modules.md}

@@ -1,42 +1,49 @@
-# Classes
+# Classes and Modules
 
-## Class tree:
+## Overview
 ```
+	 Node - - include Logging, Wait
+	/   \
+Super    Site - - include Components
 
-		   .------ Base -------.
-		  /                     \
-	     /                       \
-	    / 	  SiteBase module     \
-	Node 	  /	 	        \ 	   Proxy
-	/   \    /	 	         \    /    \
-Super    Site             SiteProxy	    SupervisorProxy
 
+              Proxy - - include Logging, Wait
+              /    \
+SupervisorProxy    SiteProxy - - include Components, SiteProxyWait
 ```
 
+## Modules
+### Logging
+Handle logging.
 
-## Base
-The Base class handle logging.
+### Wait
+Handles waiting for an async condition and block.
 
-Node and Site inherit from Base.
+### SiteProxyWait
+Handles waiting for different types of messages and responses from a remote site.
 
-## Node
+### Components
+Component handling.
+
+## Classes
+### Node
 A Node has an async task. A node can be started and stopped.
 
 Node has two child classes: Site and Supervisor.
 
-## Site
+### Site
 A Site represents an RSMP site, typically a traffic light, variable message sign, or other type of field equipment. An RSMP site can connect to one or more supervisors.
 
 A Site has one or more SupervisorProxies (connections to supervisor).
 
 A site has one of more components.
 
-## Supervisor 
+### Supervisor 
 A Supervisor represents an RSMP supervisor, typically a central supervisor system. An RSMP supervisor can handle connections one or more sites.
 
 A Supervisor has one or more SiteProxies (connections to sites).
 
-## Proxy
+### Proxy
 A Proxy represents a connection to a remove Site or Supervisor and handles the RSMP interface.
 
 A proxy has an async task listening for messages on an TCP/IP socket. Incoming RSMP messages are parsing and appropriate handles are called.
@@ -45,18 +52,14 @@ A proxy also has a repaating async timer task for handling watchdog and acknowle
 
 Proxy has to child classes: SiteProxy and SupervisorProxy.
 
-## SiteProxy
+### SiteProxy
 A connection to a remote Site.
 
 Handles RSMP messaging specific to a supervisor, including methods for requesting status, sending commands, etc.
 
 A SiteProxy has one or more components, representing the components in the remote site.
 
-## Supervisor Proxy
+### SupervisorProxy
 A connection to a remote Site. Handles RSMP messaging specific to a site, including sending aggregated status, handling status requests, status subscription and command requests.
 
 Status and command requests are delegated to the appropriate components.
-
-## SiteBase
-Things shared between Site and SiteProxy, mainly handling components.
-

data/documentation/message_distribution.md

@@ -0,0 +1,23 @@
+# Message distribution
+
+Proxy - - Distributor --> Receivers
+
+A proxy distributes message to receivers, when they are installed.
+
+Probes are special receivers that waits for specific message, and are used to implement methods for waiting for RMSP responses, statuses, alarms, etc.
+
+Note that Archive is not a receiver, and does not receive messages via the Distributor. Instead the Archive gets and stores messages via the log() interface in the Logging module. The reason is that the items that the Archive and the Logger contain other data as well as the message, like error messages, warnings, text descriptions, colors codes, etc. The Distributor and Receiver handles only Message objects.
+
+## Distributor
+A module that handles distributing messages to receivers.
+
+## Receiver
+Receives messages as long as it's installed into a distributor.
+
+## Probe
+A subclass of Receiver that wait for specific messages. Once received
+the client receives the collection.
+
+## Proxy
+A proxy includes the Distributor module and distributes each message to listerens after processing it.
+

data/lib/rsmp.rb

@@ -10,21 +10,25 @@ require 'json_schemer'
 require 'async/queue'
 
 require 'rsmp/rsmp'
-require 'rsmp/base'
+require 'rsmp/logging'
 require 'rsmp/wait'
-require 'rsmp/version'
 require 'rsmp/node'
 require 'rsmp/supervisor'
+require 'rsmp/components'
+require 'rsmp/notifier'
+
+require 'rsmp/listener'
+require 'rsmp/collector'
 require 'rsmp/component'
-require 'rsmp/site_base'
 require 'rsmp/site'
 require 'rsmp/proxy'
 require 'rsmp/supervisor_proxy'
+require 'rsmp/site_proxy_wait'
 require 'rsmp/site_proxy'
 require 'rsmp/error'
-require 'rsmp/probe'
-require 'rsmp/probe_collection'
 require 'rsmp/message'
 require 'rsmp/logger'
 require 'rsmp/archive'
 require 'rsmp/tlc'
+
+require 'rsmp/version'

data/lib/rsmp/archive.rb

@@ -4,13 +4,12 @@
 module RSMP
   class Archive
     attr_reader :items
-    attr_accessor :probes
 
     @@index = 0
 
-    def initialize
+    def initialize  max=100
       @items = []
-      @probes = ProbeCollection.new
+      @max = max
     end
 
     def self.prepare_item item
@@ -48,20 +47,13 @@ module RSMP
     def add item
       item[:index] = RSMP::Archive.increase_index
       @items << item
-      probe item
-    end
-
-    def capture task, options, &block
-      probe = RSMP::Probe.new self
-      probe.capture task, options, &block
+      if @items.size > @max
+        @items.shift
+      end
     end
     
     private
 
-    def probe item
-      @probes.process item
-    end
-
     def find options, &block
       # search backwards from newest to older, stopping once messages
       # are older that options[:earliest]

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

@@ -3,58 +3,46 @@
 # and the client wakes up.
 
 module RSMP
-  class Probe
+  class Collector < Listener
     attr_reader :condition, :items, :done
 
-    def initialize archive
-      raise ArgumentError.new("Archive expected") unless archive.is_a? Archive
-      @archive = archive
+    def initialize proxy, options={}
+      #raise ArgumentError.new("timeout option is missing") unless options[:timeout]
+      super proxy, options
       @items = []
       @condition = Async::Notification.new
-    end
-
-    def capture task, options={}, &block
-      raise ArgumentError.new("timeout option is missing") unless options[:timeout]
+      @done = false
       @options = options
-      @block = block
       @num = options[:num]
+    end
 
-      if options[:earliest]
-        from = find_timestamp_index options[:earliest]
-        backscan from
-      end
-
-      # if backscan didn't find enough items, then
-      # insert ourself as probe and sleep until enough items are captured
-      if @items.size < @num
-        begin
-          @archive.probes.add self
-          task.with_timeout(options[:timeout]) do
-            @condition.wait
-          end
-        ensure
-          @archive.probes.remove self
-        end
-      end
-
-      if @num == 1
-        @items.first        # if one item was requested, return item instead of array
-      else
-        @items[0..@num-1]   # return array, but ensure we never return more than requested
-      end
+    def wait
+      @condition.wait
     end
 
-    def find_timestamp_index earliest
-      return 0 if earliest == :start
-      (0..@archive.items.size).bsearch do |i|        # use binary search to find item index
-        @archive.items[i][:timestamp] >= earliest
+    def collect_for task, duration
+      siphon do
+        task.sleep duration
       end
     end
 
-    def backscan from
-      from.upto(@archive.items.size-1) do |i|
-        return if process @archive.items[i]
+    def collect task, options={}, &block
+      @num = options[:num] if options[:num]
+      @options[:timeout] = options[:timeout] if options[:timeout]
+      @block = block
+
+      siphon do
+        task.with_timeout(@options[:timeout]) do
+          @condition.wait
+        end
       end
+
+      #if @num == 1
+      #  @items = @items.first       # if one item was requested, return item instead of array
+      #else
+      #  @items = @items.first @num  # return array, but ensure we never return more than requested
+      #end
+      #@items
     end
 
     def reset
@@ -62,18 +50,19 @@ module RSMP
       @done = false
     end
 
-    def process item
+    def notify item
       raise ArgumentError unless item
       return true if @done
+      return if item[:message].direction == :in && @ingoing == false
+      return if item[:message].direction == :out && @outgoing == false
       if matches? item
         @items << item
         if @num && @items.size >= @num
           @done = true
+          @proxy.remove_listener self
           @condition.signal
-          return true
         end
       end
-      false
     end
 
     def matches? item

data/lib/rsmp/{site_base.rb → components.rb}

@@ -1,10 +1,10 @@
 # Things shared between sites and site proxies
 
 module RSMP
-  module SiteBase
+  module Components
     attr_reader :components
     
-    def initialize_site
+    def initialize_components
       @components = {}
     end
 

data/lib/rsmp/listener.rb

@@ -0,0 +1,33 @@
+# Receives messages from a Notifier, as long as it's
+# installed as a listener.
+# Can listen for ingoing and/or outgoing messages.
+
+module RSMP
+  class Listener
+
+    def initialize proxy, options={}
+      @proxy = proxy
+      @ingoing = options[:ingoing] == nil ? true  : options[:ingoing]
+      @outgoing = options[:outgoing] == nil ? false : options[:outgoing]
+    end
+
+    def ingoing?
+      ingoing == true
+    end
+
+    def outgoing?
+      outgoing == true
+    end
+
+    def notify item
+    end
+
+    def siphon &block
+      @proxy.add_listener self
+      yield
+    ensure
+      @proxy.remove_listener self
+    end
+
+  end
+end

data/lib/rsmp/logger.rb

@@ -82,7 +82,6 @@ module RSMP
     end
 
     def colorize level, str
-      #p String.color_samples
       if @settings["color"] == false || @settings["color"] == nil
         str
       elsif @settings["color"] == true
@@ -125,8 +124,9 @@ module RSMP
       end
     end 
 
-    def dump archive, force:false
-      log = archive.items.map do |item|
+    def dump archive, force:false, num:nil
+      num ||= archive.items.size
+      log = archive.items.last(num).map do |item|
         str = build_output item
         str = colorize item[:level], str
       end

data/lib/rsmp/{base.rb → logging.rb}

@@ -3,10 +3,10 @@
 #
 
 module RSMP
-  class Base
+  module Logging
     attr_reader :archive, :logger
 
-    def initialize options
+    def initialize_logging options
       @archive = options[:archive] || RSMP::Archive.new
       @logger = options[:logger] || RSMP::Logger.new(options[:log_settings]) 
     end

data/lib/rsmp/node.rb

@@ -1,16 +1,14 @@
-# RSMP site
-#
-# Handles a single connection to a supervisor.
-# We connect to the supervisor.
+# Base class for sites and supervisors
 
 module RSMP
-  class Node < Base
+  class Node
+    include Logging
     include Wait
 
     attr_reader :archive, :logger, :task, :deferred
 
     def initialize options
-      super options
+      initialize_logging options
       @task = options[:task]
       @deferred = []
     end