backport 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9693d9fb93dc1efb03c85d3abe258cd54e2fa4bca03e8bc2f64a45a56783269a
-  data.tar.gz: a7abdaa602ccbfda748cdace2af071af73651ecff42663ac237def501260f457
+  metadata.gz: ef66ad1688e603cf9a8c9844c5551bbc3ca9187abf747bca2064e46fb7c2600f
+  data.tar.gz: 3952f19adbe1639f82c98568d4adc97aa0c690d5fa568fef768efbcf6134ee7c
 SHA512:
-  metadata.gz: bbc92f9838a571f7cb9ea71334961cf34013a41e1010147ec4f54d4c5efde68c37b4f7cb9f0d9d52ad8ebe23ac9fa83e24568d690044ed200d838a1cb2c50358
-  data.tar.gz: a5cdf05eb09d40bc352fd07ed2d23b85107875551c9718e0145e7abdf92f670ff784e99b50b8daf5879c7a0cbe92dca1d8ca4b3a42ed73a482610085fd56e986
+  metadata.gz: 334cb82482d72e1b617fa9fa2a1a1b87764b800e4a8abf6ecc2c63fc012406fb05bf744b362aa6f3211aae0f868ab188902132825602ee3909b54358e2cd1813
+  data.tar.gz: 2ff55f4495545b50e4e226f961d38b5471cc8d1890a4339091f126139f61422e1ae3af1e1a8c3fc80aafb915b187da099ef312a5e7da1ad4a500f737e9a6909c

data/.rubocop.yml

@@ -2,3 +2,5 @@ Style/MethodDefParentheses:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,6 @@
 ---
 sudo: false
 language: ruby
-cache: bundler
 rvm:
   - 2.1
   - 2.2
@@ -9,6 +8,7 @@ rvm:
   - 2.4
   - 2.5.1
   - 2.5.3
+  - 2.6
   - jruby-9.0.5.0
   - jruby-9.1.16.0
 matrix:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.0 - February 19, 2019
+- Renamed Adapter#sending to Adapter#receiving
+- Travis tests up to Ruby 2.6
+
 ## 0.3.0 - January 10, 2019
 - Basic logging
 - Differentiate between "expected" and "unexpected" exceptions in Tcpip

data/README.md

@@ -1,80 +1,80 @@
-# Backport
-
-A pure Ruby library for event-driven IO.
-
-This library is designed with portability as the highest priority, which is why it's written in pure Ruby. Consider [EventMachine](https://github.com/eventmachine/eventmachine) if you need a solution that's faster, more mature, and scalable.
-
-## Installation
-
-Install the gem:
-
-```
-gem install backport
-```
-
-Or add it to your application's Gemfile:
-
-```ruby
-gem 'backport'
-```
-
-## Usage
-
-### Examples
-
-A simple echo server:
-
-```ruby
-require 'backport'
-
-module MyAdapter
-  def opening
-    puts "Opening a connection"
-  end
-
-  def closing
-    puts "Closing a connection"
-  end
-
-  def sending data
-    write "Client sent: #{data}"
-  end
-end
-
-Backport.run do
-  Backport.prepare_tcp_server(host: 'localhost', port: 8000, adapter: MyAdapter)
-end
-```
-
-An interval server that runs once per second:
-
-```ruby
-require 'backport'
-
-Backport.run do
-  Backport.prepare_interval 1 do
-    puts "tick"
-  end
-end
-```
-
-### Using Adapters
-
-Backport servers that handle client connections, such as TCP servers, use an
-adapter to provide an application interface to the client. Developers can
-provide their own adapter implementations in two ways: a Ruby module that will
-be used to extend a Backport::Adapter object, or a class that extends
-Backport::Adapter. In either case, the adapter should provide the following
-methods:
-
-* `opening`: A callback triggered when the client connection is accepted
-* `closing`: A callback triggered when the client connection is closed
-* `sending(data)`: A callback triggered when the server receives data from the client
-
-Backport::Adapter also provides the following methods:
-
-* `write(data)`: Send raw data to the client
-* `write_line(data)`: Send a line of data to the client
-* `close`: Disconnect the client from the server
-* `closed?`: True if the connection is closed
-* `remote`: A hash of data about the client, e.g., the remote IP address
+# Backport
+
+A pure Ruby library for event-driven IO.
+
+This library is designed with portability as the highest priority, which is why it's written in pure Ruby. Consider [EventMachine](https://github.com/eventmachine/eventmachine) if you need a solution that's faster, more mature, and scalable.
+
+## Installation
+
+Install the gem:
+
+```
+gem install backport
+```
+
+Or add it to your application's Gemfile:
+
+```ruby
+gem 'backport'
+```
+
+## Usage
+
+### Examples
+
+A simple echo server:
+
+```ruby
+require 'backport'
+
+module MyAdapter
+  def opening
+    puts "Opening a connection"
+  end
+
+  def closing
+    puts "Closing a connection"
+  end
+
+  def receiving data
+    write "Client sent: #{data}"
+  end
+end
+
+Backport.run do
+  Backport.prepare_tcp_server(host: 'localhost', port: 8000, adapter: MyAdapter)
+end
+```
+
+An interval server that runs once per second:
+
+```ruby
+require 'backport'
+
+Backport.run do
+  Backport.prepare_interval 1 do
+    puts "tick"
+  end
+end
+```
+
+### Using Adapters
+
+Backport servers that handle client connections, such as TCP servers, use an
+adapter to provide an application interface to the client. Developers can
+provide their own adapter implementations in two ways: a Ruby module that will
+be used to extend a Backport::Adapter object, or a class that extends
+Backport::Adapter. In either case, the adapter should provide the following
+methods:
+
+* `opening`: A callback triggered when the client connection is accepted
+* `closing`: A callback triggered when the client connection is closed
+* `receiving(data)`: A callback triggered when the server receives data from the client
+
+Backport::Adapter also provides the following methods:
+
+* `write(data)`: Send raw data to the client
+* `write_line(data)`: Send a line of data to the client
+* `close`: Disconnect the client from the server
+* `closed?`: True if the connection is closed
+* `remote`: A hash of data about the client, e.g., the remote IP address

data/backport.gemspec

@@ -1,27 +1,28 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "backport/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "backport"
-  spec.version       = Backport::VERSION
-  spec.authors       = ["Fred Snyder"]
-  spec.email         = ["fsnyder@castwide.com"]
-
-  spec.summary       = %q{A pure Ruby library for event-driven IO}
-  spec.homepage      = "http://github.com/castwide/backport"
-  spec.license       = "MIT"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov", "~> 0.14"
-end
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "backport/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "backport"
+  spec.version       = Backport::VERSION
+  spec.authors       = ["Fred Snyder"]
+  spec.email         = ["fsnyder@castwide.com"]
+
+  spec.summary       = %q{A pure Ruby library for event-driven IO}
+  spec.homepage      = "http://github.com/castwide/backport"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.14"
+end

data/lib/backport.rb

@@ -1,4 +1,4 @@
-require "backport/version"
+require 'backport/version'
 require 'logger'
 
 # An event-driven IO library.

data/lib/backport/adapter.rb

@@ -40,13 +40,13 @@ module Backport
     # @return [void]
     def closing; end
 
-    # A callback triggered when the client sends data to the server. Subclasses
-    # and/or modules should override this method to provide their own
-    # functionality.
+    # A callback triggered when the server receives data from the client.
+    # Subclasses and/or modules should override this method to provide their
+    # own functionality.
     #
     # @param data [String]
     # @return [void]
-    def sending(data); end
+    def receiving(data); end
 
     # Send data to the client.
     #

data/lib/backport/client.rb

@@ -5,6 +5,10 @@ module Backport
     # @return [Adapter]
     attr_reader :adapter
 
+    # @param input [IO]
+    # @param output [IO]
+    # @param adapter [Class, Module]
+    # @param remote [Hash]
     def initialize input, output, adapter, remote = {}
       @in = input
       @out = output
@@ -13,6 +17,8 @@ module Backport
       @buffer = ''
     end
 
+    # True if the client is stopped.
+    #
     def stopped?
       @stopped ||= false
     end
@@ -41,13 +47,22 @@ module Backport
     # @deprecated Prefer #start to #run for non-blocking client/server methods
     alias run start
 
-    # Notify the adapter that the client is sending data.
+    # Handle a tick from the server. This method will check for client input
+    # and update the adapter accordingly, or stop the client if the adapter is
+    # closed.
     #
-    # @param data [String]
-    def sending data
-      @adapter.sending data
+    # @return [void]
+    def tick
+      if adapter.closed?
+        stop
+      else
+        input = read
+        @adapter.receiving input unless input.nil?
+      end
     end
 
+    private
+
     # Read the client input. Return nil if the input buffer is empty.
     #
     # @return [String, nil]
@@ -60,8 +75,7 @@ module Backport
       return tmp unless tmp.empty?
     end
 
-    private
-
+    # @return [Adapter]
     def make_adapter cls_mod, remote
       if cls_mod.is_a?(Class) && cls_mod <= Backport::Adapter
         @adapter = cls_mod.new(@out, remote)
@@ -73,25 +87,34 @@ module Backport
       end
     end
 
+    # @return [Mutex]
     def mutex
       @mutex ||= Mutex.new
     end
 
+    # Start the thread that checks the input IO for client data.
+    #
+    # @return [void]
     def run_input_thread
       Thread.new do
-        until stopped?
-          @in.flush
-          begin
-            chars = @in.sysread(255)
-          rescue EOFError, Errno::ECONNRESET
-            chars = nil
-          end
-          if chars.nil?
-            stop
-            break
-          end
-          mutex.synchronize { @buffer.concat chars }
-        end
+        read_input until stopped?
+      end
+    end
+
+    # Read input from the client.
+    #
+    # @return [void]
+    def read_input
+      @in.flush
+      begin
+        chars = @in.sysread(255)
+      rescue EOFError, Errno::ECONNRESET
+        chars = nil
+      end
+      if chars.nil?
+        stop
+      else
+        mutex.synchronize { @buffer.concat chars }
       end
     end
   end

data/lib/backport/machine.rb

@@ -50,6 +50,9 @@ module Backport
       @servers ||= []
     end
 
+    # Update the machine's servers.
+    #
+    # @return [void]
     def tick
       servers.delete_if(&:stopped?)
       stop if servers.empty?
@@ -58,6 +61,9 @@ module Backport
 
     private
 
+    # Start the thread that updates servers via the #tick method.
+    #
+    # @return [void]
     def run_server_thread
       servers.map(&:start)
       until stopped?

data/lib/backport/server/connectable.rb

@@ -6,9 +6,9 @@ module Backport
     #
     module Connectable
       def tick
-        clients.each do |client|
-          input = client.read
-          client.sending input unless input.nil?
+        mutex.synchronize do
+          clients.each(&:tick)
+          clients.delete_if(&:stopped?)
         end
       end
 
@@ -24,6 +24,12 @@ module Backport
       def clients
         @clients ||= []
       end
+
+      private
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
     end
   end
 end

data/lib/backport/server/tcpip.rb

@@ -14,20 +14,6 @@ module Backport
         @stopped = false
       end
 
-      def tick
-        mutex.synchronize do
-          clients.each do |client|
-            if client.adapter.closed?
-              client.stop
-              next
-            end
-            input = client.read
-            client.sending input unless input.nil?
-          end
-          clients.delete_if(&:stopped?)
-        end
-      end
-
       def starting
         start_accept_thread
       end
@@ -37,8 +23,8 @@ module Backport
         return if socket.closed?
         begin
           socket.shutdown Socket::SHUT_RDWR
-        rescue Errno::ENOTCONN, IOError => e
-          Backport.logger.info "Minor exception while stopping server [#{e.class}] #{e.message}"
+        rescue Errno::ENOTCONN, IOError => err
+          Backport.logger.info "Minor exception while stopping server [#{err.class}] #{err.message}"
         end
         socket.close
       end
@@ -63,13 +49,13 @@ module Backport
             clients.push Client.new(conn, conn, @adapter, data)
             clients.last.run
             result = clients.last
-          rescue IO::WaitReadable, Errno::EAGAIN => e
+          rescue IO::WaitReadable, Errno::EAGAIN
             # ignore
-          rescue Errno::ENOTSOCK, IOError => e
-            Backport.logger.info "Server stopped with minor exception [#{e.class}] #{e.message}"
+          rescue Errno::ENOTSOCK, IOError => err
+            Backport.logger.info "Server stopped with minor exception [#{err.class}] #{err.message}"
             stop
-          rescue Exception => e
-            Backport.logger.warn "Server stopped with major exception [#{e.class}] #{e.message}"
+          rescue Exception => err
+            Backport.logger.warn "Server stopped with major exception [#{err.class}] #{err.message}"
             stop
           end
         end
@@ -81,10 +67,6 @@ module Backport
       # @return [TCPSocket]
       attr_reader :socket
 
-      def mutex
-        @mutex ||= Mutex.new
-      end
-
       def start_accept_thread
         Thread.new do
           until stopped?

data/lib/backport/version.rb

@@ -1,3 +1,3 @@
 module Backport
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: backport
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="