backport 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cda5ef5baf957e3f8c8f22c3e52ad07cbc921de4750a2d5c5bab9dd97898b87a
-  data.tar.gz: 4f981e41226043f45cae6cb20d5483fc013c6d39b35ac31bedd01181ec750c41
+  metadata.gz: bb7787742f0eda4aab85f3b7cd388f69ad1870a4298f4b6f4862577f198685f0
+  data.tar.gz: 00c7263e5c3dc511f3a13a12d2e5cf7335d9c2feab66b63430ae363975284b73
 SHA512:
-  metadata.gz: 457b297349e1d47ab14fb3f9e047a95ce807ff1371789307a53b067cd606ef96f1ceb24dd5f4fbfb8c26d21ddda437b5fd38e367340b3c3af48cdb21009311aa
-  data.tar.gz: 12f234691c663322e8e6385245faa13730be2eeccdf4a664a2c6f4d020b8b406ba9cf11bf2c97ea59c2cfe890a41da862c58ff13408a578b4dc41ccf5349b774
+  metadata.gz: cc68f707447563a776948af2e86cfd2d683659fe11ce81ee21d37536e7fc5818935ff9e763a4fcb4d4022460cf3088c14f830fa1faefb9577aff959a5a6e0c3a
+  data.tar.gz: 14be66a01490aaa143da303aac0f9f0c3061ea4dbad0e284f4e07a463fc5dd6b807b677b3f70f1ce8191312b3b12d1429bb8e87d883bf3ea61e9bc8fcd91eee9

data/.travis.yml

@@ -8,6 +8,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - jruby-head
 matrix:
   include:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.0 - June 13, 2021
+- Improved handling of multiple machines
+- Rescue StandardError instead of Exception
+
 ## 1.1.2 - August 4, 2019
 - Rescue Errno::ENOTSOCK
 

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in backport.gemspec
-gemspec
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in backport.gemspec
+gemspec

data/lib/backport.rb

@@ -15,7 +15,7 @@ module Backport
     # @param adapter [Adapter]
     # @return [void]
     def prepare_stdio_server adapter: Adapter
-      machine.prepare Backport::Server::Stdio.new(adapter: adapter)
+      machines.last.prepare Backport::Server::Stdio.new(adapter: adapter)
     end
 
     # Prepare a TCP server to run in Backport.
@@ -25,7 +25,7 @@ module Backport
     # @param adapter [Adapter]
     # @return [void]
     def prepare_tcp_server host: 'localhost', port: 1117, adapter: Adapter
-      machine.prepare Backport::Server::Tcpip.new(host: host, port: port, adapter: adapter)
+      machines.last.prepare Backport::Server::Tcpip.new(host: host, port: port, adapter: adapter)
     end
 
     # Prepare an interval server to run in Backport.
@@ -33,7 +33,7 @@ module Backport
     # @param period [Float] Seconds between intervals
     # @return [void]
     def prepare_interval period, &block
-      machine.prepare Backport::Server::Interval.new(period, &block)
+      machines.last.prepare Backport::Server::Interval.new(period, &block)
     end
 
     # Run the Backport machine. The provided block will be executed before the
@@ -48,25 +48,39 @@ module Backport
     #
     # @return [void]
     def run &block
+      machine = Machine.new
+      machines.push machine
       machine.run &block
+      machines.delete machine
     end
 
-    # Stop the Backport machine.
+    # Stop all running Backport machines.
+    #
+    # For more accurate control, consider stopping the machine
+    # from the self reference in Machine#run, e.g.:
+    #
+    # ```
+    # Backport.run do |machine|
+    #   # ...
+    #   machine.stop
+    # end
+    # ```
     #
     # @return [void]
     def stop
-      machine.stop
+      machines.last.stop unless machines.empty?
     end
 
+    # @return [Logger]
     def logger
       @logger ||= Logger.new(STDERR, level: Logger::WARN, progname: 'Backport')
     end
 
     private
 
-    # @return [Machine]
-    def machine
-      @machine ||= Machine.new
+    # @return [Array<Machine>]
+    def machines
+      @machines ||= []
     end
   end
 end

data/lib/backport/adapter.rb

@@ -76,6 +76,7 @@ module Backport
     #   The server is responsible for implementation details like closing the
     #   client's socket.
     #
+    # @return [void]
     def close
       return if closed?
       _data[:closed] = true

data/lib/backport/client.rb

@@ -16,6 +16,7 @@ module Backport
     def initialize input, output, adapter, remote = {}
       @in = input
       @out = output
+      @mutex = Mutex.new
       @adapter = make_adapter(adapter, remote)
       @stopped = true
       @buffer = ''
@@ -33,6 +34,7 @@ module Backport
     # callback. The server is responsible for implementation details like
     # closing the client's socket.
     #
+    # @return [void]
     def stop
       return if stopped?
       @adapter.closing
@@ -44,6 +46,7 @@ module Backport
     # Start running the client. This method will start the thread that reads
     # client input from IO.
     #
+    # @return [void]
     def start
       return unless stopped?
       @stopped = false
@@ -77,22 +80,22 @@ module Backport
       return tmp unless tmp.empty?
     end
 
+    # @param mod_cls [Module, Class] The Adapter module or class
+    # @param remote [Hash] Remote client data
     # @return [Adapter]
-    def make_adapter cls_mod, remote
-      if cls_mod.is_a?(Class) && cls_mod <= Backport::Adapter
-        @adapter = cls_mod.new(@out, remote)
-      elsif cls_mod.class == Module
+    def make_adapter mod_cls, remote
+      if mod_cls.is_a?(Class) && mod_cls <= Backport::Adapter
+        @adapter = mod_cls.new(@out, remote)
+      elsif mod_cls.class == Module
         @adapter = Adapter.new(@out, remote)
-        @adapter.extend cls_mod
+        @adapter.extend mod_cls
       else
-        raise TypeError, "#{cls_mod} is not a valid Backport adapter"
+        raise TypeError, "#{mod_cls} is not a valid Backport adapter"
       end
     end
 
     # @return [Mutex]
-    def mutex
-      @mutex ||= Mutex.new
-    end
+    attr_reader :mutex
 
     # Start the thread that checks the input IO for client data.
     #

data/lib/backport/machine.rb

@@ -4,18 +4,20 @@ module Backport
   class Machine
     def initialize
       @stopped = true
+      @mutex = Mutex.new
     end
 
     # Run the machine. If a block is provided, it gets executed before the
     # maching starts its main loop. The main loop blocks program execution
     # until the machine is stopped.
     #
+    # @yieldparam [self]
     # @return [void]
     def run
       return unless stopped?
       servers.clear
       @stopped = false
-      yield if block_given?
+      yield self if block_given?
       run_server_thread
     end
 
@@ -52,6 +54,7 @@ module Backport
     end
 
     # @param server [Server::Base]
+    # @return [void]
     def update server
       if server.stopped?
         servers.delete server
@@ -63,9 +66,8 @@ module Backport
 
     private
 
-    def mutex
-      @mutex ||= Mutex.new
-    end
+    # @return [Mutex]
+    attr_reader :mutex
 
     # Start the thread that updates servers via the #tick method.
     #

data/lib/backport/server/base.rb

@@ -10,6 +10,7 @@ module Backport
 
       # Start the server.
       #
+      # @return [void]
       def start
         return if started?
         starting
@@ -18,6 +19,7 @@ module Backport
 
       # Stop the server.
       #
+      # @return [void]
       def stop
         return if stopped?
         stopping

data/lib/backport/server/connectable.rb

@@ -5,10 +5,12 @@ module Backport
     # Connectable servers check clients for incoming data on each tick.
     #
     module Connectable
+      # @return [void]
       def starting
         clients.map(&:run)
       end
 
+      # @return [void]
       def stopping
         clients.map(&:stop)
       end
@@ -20,6 +22,7 @@ module Backport
 
       private
 
+      # @return [Mutex]
       def mutex
         @mutex ||= Mutex.new
       end

data/lib/backport/server/interval.rb

@@ -28,6 +28,7 @@ module Backport
 
       private
 
+      # @return [void]
       def run_ready_thread
         Thread.new do
           until stopped?

data/lib/backport/server/stdio.rb

@@ -5,6 +5,9 @@ module Backport
     class Stdio < Base
       include Connectable
 
+      # @param input [IO]
+      # @param output [IO]
+      # @param adapter [Module, Class]
       def initialize input: STDIN, output: STDOUT, adapter: Adapter
         @in = input
         @out = output
@@ -14,6 +17,8 @@ module Backport
         clients.last.add_observer self
       end
 
+      # @param client [Client]
+      # @return [void]
       def update client
         client.tick
       end

data/lib/backport/server/tcpip.rb

@@ -8,6 +8,10 @@ module Backport
     class Tcpip < Base
       include Connectable
 
+      # @param host [String]
+      # @param port [Integer]
+      # @param adapter [Module, Class]
+      # @param socket_class [Class]
       def initialize host: 'localhost', port: 1117, adapter: Adapter, socket_class: TCPServer
         @socket = socket_class.new(host, port)
         @adapter = adapter
@@ -58,17 +62,19 @@ module Backport
             result = clients.last
           rescue IO::WaitReadable, Errno::EAGAIN
             # ignore
-          rescue Errno::ENOTSOCK, IOError => err
-            Backport.logger.info "Server stopped with minor exception [#{err.class}] #{err.message}"
+          rescue Errno::ENOTSOCK, IOError => e
+            Backport.logger.info "Server stopped with minor exception [#{e.class}] #{e.message}"
             stop
-          rescue Exception => err
-            Backport.logger.warn "Server stopped with major exception [#{err.class}] #{err.message}"
+          rescue StandardError => e
+            Backport.logger.warn "Server stopped with major exception [#{e.class}] #{e.message}"
             stop
           end
         end
         result
       end
 
+      # @param client [Client]
+      # @return [void]
       def update client
         if client.stopped?
           clients.delete client
@@ -82,6 +88,7 @@ module Backport
       # @return [TCPSocket]
       attr_reader :socket
 
+      # @return [void]
       def start_accept_thread
         Thread.new do
           until stopped?

data/lib/backport/version.rb

@@ -1,3 +1,3 @@
 module Backport
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backport
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2021-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A pure Ruby library for event-driven IO