tcp-server 1.0.7-java → 1.0.8-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 119b17b7637a9d30ba40c82660e9b2c9eebbabbe59264cbb49e88b82cef6805c
-  data.tar.gz: 5fa1261d06c758e2934944f79fc9f747d73f387dd4e2ed04cb119fe496a34010
+  metadata.gz: 3c55987f7d6c92030cd96937448d5dea7b62c5dd43292e2d47a5b1901cdcbfa8
+  data.tar.gz: 6396aaaa64e18e454801debd881e618558ab65bec55de917fd328f0f4cdc041e
 SHA512:
-  metadata.gz: 3d911168c44588f3c89b557b800bde9cbaf5603185c4c850bf6362c8e24458110ed2b1c33ea8736032d7003d01068a4e7b7bf58151e334adab2b1fef2adba251
-  data.tar.gz: f2863e4c56547ae3f8af9f1b37085863ffefd3f5ffd07eb46a1e288c72694189ff52e44c7fdb1e1b20ee68c8b841a93699e9d32a2ad4defff093e8ac265b567a
+  metadata.gz: 115f8b7d5bc5f8f48cfdb72eb4b81d6128f4b69af919eeaed79693bfb04aa1d09d893ba8970682f74afd417cb46c4176b73ca2b70ed082d0adec9268e8d53010
+  data.tar.gz: e1c144c6b38c6adca2e96c5e99cbd4a31d52aebe2076e7bd7cc82d2700c0e1f9c11a20d93f32943b6995a6a0e8ba4c20300e6d35170130982403736f64815050

data/README.md

@@ -124,7 +124,7 @@ Here is a bird's-eye view of the project layout.
 
 ```sh
 # date && tree -I "logs|vendor|tmp"
-Tue Jun 28 20:25:51 CDT 2022
+Wed Jul 20 13:18:23 CDT 2022
 .
 ├── Dockerfile
 ├── Gemfile
@@ -158,12 +158,11 @@ Tue Jun 28 20:25:51 CDT 2022
 │   ├── test_spec.rb
 │   └── verify
 │       └── verify_spec.rb
-├── tcp-server-1.0.6-java.gem
 ├── tcp-server-jruby.gemspec
 ├── tcp_server.png
 └── tcp_server.rb
 
-5 directories, 31 files
+5 directories, 30 files
 ```
 
 

data/lib/client.rb

@@ -27,22 +27,17 @@ end
 
 # The Client module
 module Client
-  # rubocop: disable Metrics/MethodLength
   def client_config
     @client_config ||= {
       host: '0.0.0.0',
       port: 8080,
       ssl: false,
-      idle_reading: 5 * 60, # seconds
-      idle_writing: 30, # seconds
-      log_requests: false,
       log_level: Logger::INFO,
       quit_commands: %i[bye cease desist exit leave quit stop terminate],
       max_frame_length: 8192,
       delimiter: Java::io.netty.handler.codec.Delimiters.lineDelimiter
     }.freeze
   end
-  # rubocop: enable Metrics/MethodLength
   module_function :client_config
 end
 
@@ -108,7 +103,7 @@ module Client
   # The InstanceMethods module
   module InstanceMethods
     def puts(msg)
-      sleep 0.1 until @channel.isActive()
+      wait_until_channel_is_active
       msg.chomp!
       log.trace "#puts msg: #{msg.inspect}"
       raise 'Message is empty!' if msg.nil? || msg.empty?
@@ -123,6 +118,10 @@ module Client
       nil
     end
 
+    def wait_until_channel_is_active(timeout = 5, give_up = Time.now + timeout)
+      sleep 0.1 until @channel.active? || Time.now > give_up
+    end
+
     def connect(host = @options[:host], port = @options[:port])
       return unless @channel.nil?
       # Start the connection attempt.
@@ -151,7 +150,7 @@ module Client
 
     def session
       when_client_has_shut_down(@client_group) do |group|
-        log.debug "Channel group has shut down: #{group.inspect}"
+        log.debug "Channel group has shut down: #{group}"
       end
       @user_app.nil? ? read_user_commands : invoke_user_app
     end
@@ -184,13 +183,13 @@ module Client
 
     def channel_unregistered(ctx)
       log.trace "##{__method__} channel: #{ctx.channel}"
-      shutdown
+      # shutdown
     end
 
     def message_received(ctx, message)
       notify :message_received, ctx, message
       if @application_handler.nil?
-        $stdout.puts message.chomp unless message.nil?
+        $stdout.print message.chomp unless message.nil?
       else
         @application_handler.call(ctx, message)
       end
@@ -205,10 +204,11 @@ module Client
     def read_user_commands
       log.trace 'Reading user commands'
       loop do
+        log.debug 'Waiting for user input...'
         input = $stdin.gets
         raise 'Poll failure from stdin' if input.nil?
         break unless @channel.active?
-        break if execute_command(input).is_a?(AbstractChannel::CloseFuture)
+        break unless execute_command(input).nil?
       end
     end
 
@@ -232,17 +232,19 @@ module Client
 
     def add_listener(listener)
       listeners << listener
+    ensure
+      log.trace "Listeners: #{listeners}"
     end
 
     def remove_listener(listener)
       listeners.delete(listener)
     end
 
-    def notify(message, *args)
-      return if listeners.empty?
-      log.trace "Notifying listeners (#{listeners}) of message: #{message}"
+    def notify(event, *args)
       listeners.each do |listener|
-        listener.send(message.to_sym, *args) if listener.respond_to?(message.to_sym)
+        next unless listener.respond_to?(event.to_sym)
+        log.trace "Notifying listener #{listener} of event: #{event}"
+        listener.send(event.to_sym, *args)
       end
     end
   end
@@ -350,12 +352,7 @@ module Client
 
   # The ChannelInitializer class
   class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
-    # The encoder and decoder are sharable. If they were not, then
-    # constant definitions could not be used.
-    DECODER = StringDecoder.new
-    ENCODER = StringEncoder.new
-    MAX_FRAME_LENGTH = 8192
-    attr_accessor :handlers
+    attr_accessor :decoder, :encoder, :handlers
 
     def initialize(options = {})
       super()
@@ -363,6 +360,8 @@ module Client
       @host = @options[:host]
       @port = @options[:port]
       @handlers = []
+      @decoder = StringDecoder.new
+      @encoder = StringEncoder.new
     end
 
     def <<(handler)
@@ -372,15 +371,17 @@ module Client
     def initChannel(channel)
       pipeline = channel.pipeline
       pipeline.addLast(ssl_handler(channel)) if @options[:ssl]
-      pipeline.addLast(
-        DelimiterBasedFrameDecoder.new(MAX_FRAME_LENGTH, Delimiters.lineDelimiter()),
-        DECODER,
-        ENCODER
-      )
+      # pipeline.addLast(frame_decoder)
+      pipeline.addLast(decoder)
+      pipeline.addLast(encoder)
       add_user_handlers(pipeline)
       pipeline.addLast(default_handler)
     end
 
+    def frame_decoder
+      DelimiterBasedFrameDecoder.new(@options[:max_frame_length], @options[:delimiter])
+    end
+
     def default_handler
       @default_handler ||= ::Client::ModularHandler.new
     end
@@ -455,32 +456,32 @@ end
 module Client
   # The ArgumentsParser class
   class ArgumentsParser
-    Flags = %i[banner port ssl log_level help version].freeze
     attr_reader :parser, :options
 
     def initialize(parser = OptionParser.new, options = ::Client.client_config.dup)
       @parser = parser
       @options = options
-      Flags.each { |method_name| method(method_name).call }
+      @flags = %i[banner port ssl log_level help version]
+      @flags.each { |method_name| method(method_name)&.call if respond_to?(method_name) }
     end
 
     def banner
-      @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} [host] [port] [options]"
+      @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] <hostname> [port]"
       @parser.separator ''
       @parser.separator 'Options:'
     end
 
     def host
       description = "Connect to server at this host; default: #{@options[:host]}"
-      @parser.on('-h', '--host=<host>s', description) do |v|
+      @parser.on('-h', '--hostname=<hostname>', description) do |v|
         @options[:host] = v
       end
     end
 
-    IntegerPattern = /^\d+$/.freeze
+    def validated_port(val, integer_pattern = /^\d+$/)
+      raise OptionParser::InvalidArgument, "Invalid port: #{val}" unless \
+        integer_pattern.match?(val.to_s) && val.positive? && val < 65_536
 
-    def validated_port(val)
-      raise "Invalid port: #{v}" unless IntegerPattern.match?(val.to_s) && val.positive? && val < 65_536
       val
     end
 
@@ -499,6 +500,7 @@ module Client
 
     def log_level
       @parser.on_tail('-v', '--verbose', 'Increase verbosity') do
+        @options[:log_level] ||= 0
         @options[:log_level] -= 1
       end
     end
@@ -516,19 +518,28 @@ module Client
         exit
       end
     end
+
+    def parse_positional_arguments!
+      @options[:host] = ARGV.shift or raise OptionParser::MissingArgument, 'hostname'
+      return if (given_port = ARGV.shift&.to_i).nil?
+
+      @options[:port] = validated_port(given_port).to_i
+    end
   end
   # class ArgumentsParser
 
-  # rubocop: disable Metrics/AbcSize
   def parse_arguments(arguments_parser = ArgumentsParser.new)
     arguments_parser.parser.parse!(ARGV)
-    arguments_parser.options[:host] = v.to_s unless (v = ARGV.shift).nil?
-    arguments_parser.options[:port] = validated_port(v).to_i unless (v = ARGV.shift).nil?
+    arguments_parser.parse_positional_arguments!
     arguments_parser.options
-  rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption => e
+  rescue OptionParser::InvalidArgument, OptionParser::InvalidOption,
+         OptionParser::MissingArgument, OptionParser::NeedlessArgument => e
+    puts e.message
+    puts parser
+    exit
+  rescue OptionParser::AmbiguousOption => e
     abort e.message
   end
-  # rubocop: enable Metrics/AbcSize
 end
 # module Client
 
@@ -549,12 +560,12 @@ end
 
 # The Client module
 module Client
-  # The ConsoleHandler class
-  class ConsoleHandler
+  # The Console class
+  class Console
     def message_received(ctx, message)
       log.trace "##{__method__} channel: #{ctx.channel}, message: #{message}"
       log.debug "Received message: #{message}"
-      puts message.chomp unless message.nil?
+      $stdout.print message unless message.nil?
     end
   end
 end
@@ -568,8 +579,7 @@ module Client
   # rubocop: disable Metrics/MethodLength
   def main(args = parse_arguments)
     Logging.log_level = args[:log_level]
-    handlers = [::Client::Monitor.new, ::Client::ConsoleHandler.new]
-    ::TCP::Client.new(args, *handlers)
+    ::TCP::Client.new(args, ::Client::Console.new, ::Client::Monitor.new)
   rescue Interrupt => e
     warn format(InterruptTemplate, class: e.class)
     exit

data/lib/server/argument_parser.rb

@@ -18,16 +18,13 @@ require_relative 'config'
 module Server
   # The ArgumentsParser class
   class ArgumentsParser
-    Flags = %i[
-      banner port ssl idle_reading idle_writing log_requests log_level help
-      version
-    ].freeze
     attr_reader :parser, :options
 
     def initialize(option_parser = OptionParser.new)
       @parser = option_parser
       @options = ::Server.server_config.dup
-      Flags.each { |method_name| method(method_name).call }
+      @flags = %i[banner port ssl idle_reading idle_writing log_requests log_level help version]
+      @flags.each { |method_name| method(method_name).call }
     end
 
     def banner
@@ -36,10 +33,10 @@ module Server
       @parser.separator 'Options:'
     end
 
-    IntegerPattern = /^\d+$/.freeze
+    def validated_port(val, integer_pattern = /^\d+$/)
+      raise OptionParser::InvalidArgument, "Invalid port: #{v}" unless \
+        integer_pattern.match?(val.to_s) && val.positive? && val < 65_536
 
-    def validated_port(val)
-      raise "Invalid port: #{v}" unless IntegerPattern.match?(val.to_s) && val.positive? && val < 65_536
       val
     end
 

data/lib/server/channel_initializer.rb

@@ -30,11 +30,7 @@ module Server
 
   # The ChannelInitializer class
   class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
-    # The encoder and decoder are sharable. If they were not, then
-    # constant definitions could not be used.
-    DECODER = StringDecoder.new
-    ENCODER = StringEncoder.new
-    attr_accessor :user_handlers
+    attr_accessor :decoder, :encoder, :user_handlers
     attr_reader :options
 
     def initialize(channel_group, options = {})
@@ -42,6 +38,8 @@ module Server
       @channel_group = channel_group
       @options = options
       @user_handlers = @options.fetch(:handlers, [])
+      @decoder = StringDecoder.new
+      @encoder = StringEncoder.new
     end
 
     def <<(handler)
@@ -51,15 +49,15 @@ module Server
     def initChannel(channel)
       pipeline = channel.pipeline
       pipeline.addLast(ssl_handler(channel)) if @options[:ssl]
-      pipeline.addLast(
-        DelimiterBasedFrameDecoder.new(@options[:max_frame_length], @options[:delimiter]),
-        DECODER,
-        ENCODER
-      )
+      pipeline.addLast(frame_decoder, @decoder, @encoder)
       add_user_handlers(pipeline)
       pipeline.addLast(default_handler)
     end
 
+    def frame_decoder
+      DelimiterBasedFrameDecoder.new(@options[:max_frame_length], @options[:delimiter])
+    end
+
     def default_handler
       @default_handler ||= ::Server::ModularHandler.new(@channel_group)
     end

data/lib/server/listenable.rb

@@ -22,17 +22,19 @@ module Server
 
     def add_listener(listener)
       listeners << listener
+    ensure
+      log.trace "Listeners: #{listeners}"
     end
 
     def remove_listener(listener)
       listeners.delete(listener)
     end
 
-    def notify(message, *args)
-      return if listeners.empty?
-      log.trace "Notifying listeners (#{listeners}) of message: #{message}"
+    def notify(event, *args)
       listeners.each do |listener|
-        listener.send(message.to_sym, *args) if listener.respond_to?(message.to_sym)
+        next unless listener.respond_to?(event.to_sym)
+        log.trace "Notifying listener #{listener} of event: #{event}"
+        listener.send(event.to_sym, *args)
       end
     end
   end

data/lib/server/message_handler.rb

@@ -42,7 +42,7 @@ module Server
       log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
       msg&.chomp!
       log.info "Received message: #{msg}"
-      return super(ctx, msg) unless respond_to?(:handle_message) && @handler.arity == 2
+      return super(ctx, msg) unless respond_to?(:handle_message) && @handler&.arity == 2
       handle_message(ctx, msg)
     end
 

data/lib/server/version.rb

@@ -12,5 +12,5 @@
 
 # The Server module
 module Server
-  VERSION = '1.0.7'.freeze
+  VERSION = '1.0.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-server
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement