tcp-server 1.2.0-java → 1.4.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e929584365fe9f6f2f5acd5730590308d9ccf84b7cafc7cb611fe80290014891
-  data.tar.gz: bd0148f3ebe104cc69dd4ed9f37dd68733c3a9e9dcca711184a5dc5e940005b8
+  metadata.gz: 18fc53639397d26d2a0b3755610853697649175288c8288ae0ee7c0b8205eac6
+  data.tar.gz: af583ff89a4eaf27a809a1469df1c5950a470584f588a9e7c83dd51a38ba4147
 SHA512:
-  metadata.gz: 6260d608a17649fe1114e0e9382398e56297a9430ac9755c516578317d2e691fde6063e096847fc9f24e5d9ce8d34b940bf1a798433e19cb736be8ad1d956ca1
-  data.tar.gz: 28e72cd37f04f4a958c638841a8742e13f991c89e91977c9298978695c8801eb29d1ca6c8a71e28ac7e6d3aea37c4022c4998e8a1fe1d308111bf0f0b7162e49
+  metadata.gz: c4fb9fbb2b7edf7fecb14dca462e9f832e6dedd998e0789a4a28f71bf7845caf2ea2721c6d5cddec8d6e2fe0ab636602311b3ce7ff134a6c3b886eace2818760
+  data.tar.gz: f466bc6d5c711d5853adb46805ea9c895a85e2ccbd7b5f5f8006de4a3938e111a5756d690c50db01b2029a710f204f48eb70f595777283746262d0b24d7e7f5d

data/README.md

@@ -18,9 +18,10 @@ You may run the websocket server in a container. Using `[colima]` for a containe
 
 ```sh
 colima start
-docker-compose up --detach
+docker build --tag tcp-server-jruby .
+docker compose up --detach
 nc localhost 4000
-docker-compose down
+docker compose down
 ```
 
 Building the image or running the container:
@@ -45,7 +46,6 @@ See: https://mise.jdx.dev/getting-started.html
 ```sh
 curl https://mise.jdx.dev/install.sh | sh
 ~/.local/bin/mise --version
-mise 2024.x.x
 ```
 
 Enable mise activation in future zsh sessions.
@@ -75,10 +75,10 @@ bundle install
 
 ## Run
 
-The entrypoint for the web application service may now be invoked from a command line interface terminal shell.
+The entrypoint for the TCP server may now be invoked from a command line interface terminal shell.
 
 ```sh
-bundle exec ./tcp_server.rb
+bundle exec exe/tcp_server
 ```
 
 
@@ -96,7 +96,7 @@ bundle exec rake
 To publish the gem after first verifying that the built gem works, execute:
 
 ```sh
-version=$(ruby -r lib/server/version -I . -e 'puts ::Server::VERSION')
+version=$(ruby -r lib/tcp_server/version -I . -e 'puts TcpServer::VERSION')
 git tag --annotate --message "Release ${version}" "${version}-release"
 git push origin --tags
 ```
@@ -105,7 +105,7 @@ git push origin --tags
 Or manually, if necessary:
 
 ```sh
-bundle exec rake verify
+bundle exec rake clean clobber test package verify
 bundle exec rake publish
 ```
 
@@ -124,47 +124,47 @@ bundle exec rake clean clobber
 Here is a bird's-eye view of the project layout.
 
 ```sh
-# date && tree -A -I "logs|vendor|tmp|Gemfile.lock"
-Sat Jul 23 22:12:37 CDT 2022
+$ date; tree --gitignore
+Sun Feb  8 09:29:34 CST 2026
 .
-├── Dockerfile
-├── Gemfile
-├── Gemfile.lock
-├── LICENSE
-├── README.md
-├── Rakefile
 ├── docker-compose.yaml
+├── Dockerfile
 ├── exe
 │   └── tcp_server
+├── Gemfile
 ├── lib
-│   ├── client.rb
-│   ├── demo_listener.rb
-│   ├── logging.rb
-│   ├── server
-│   │   ├── argument_parser.rb
-│   │   ├── channel_initializer.rb
+│   ├── tcp_server
+│   │   ├── arguments_parser.rb
+│   │   ├── channelizer.rb
+│   │   ├── client.rb
 │   │   ├── config.rb
+│   │   ├── default_handler.rb
+│   │   ├── demo_listener.rb
 │   │   ├── instance_methods.rb
 │   │   ├── listenable.rb
+│   │   ├── logging.rb
 │   │   ├── message_handler.rb
 │   │   ├── modular_handler.rb
 │   │   ├── server.rb
-│   │   ├── shutdown_hook.rb
 │   │   └── version.rb
-│   ├── server.rb
-│   ├── tcp-server.rb
 │   └── tcp_server.rb
+├── LICENSE
+├── Rakefile
+├── README.md
 ├── spec
+│   ├── server_arguments_parser_spec.rb
+│   ├── server_default_handler_spec.rb
+│   ├── server_listenable_spec.rb
+│   ├── server_message_handler_spec.rb
 │   ├── spec_helper.rb
 │   ├── test_spec.rb
 │   └── verify
 │       └── verify_spec.rb
-├── tcp-server-1.0.8-java.gem
-├── tcp-server-jruby.gemspec
 ├── tcp_server.png
-└── tcp_server.rb
+├── tcp_server.rb
+└── tcp-server-jruby.gemspec
 
-5 directories, 31 files
+6 directories, 31 files
 ```
 
 

data/Rakefile

@@ -23,7 +23,8 @@ end
 
 desc 'Run the spec tests'
 task :test do
-  system('bundle', 'exec', 'rspec', '--exclude-pattern', 'spec/verify/**/*_spec.rb') or abort
+  # system('bundle', 'exec', 'rspec', '--exclude-pattern', 'spec/verify/**/*_spec.rb') or abort
+  system('bundle', 'exec', 'rspec') or abort
 end
 task test: :lint
 
@@ -41,7 +42,16 @@ task package: %i[clean clobber test]
 
 desc 'Verify the gem'
 task :verify do
-  system('bundle', 'exec', 'rspec', 'spec/verify') or abort
+  env = {
+    'GEM_HOME' => 'tmp',
+    'GEM_PATH' => 'tmp',
+    'BUNDLE_GEMFILE' => nil,
+    'RUBYOPT' => nil
+  }
+
+  # cmd = ['jruby', '-S', 'rspec', 'spec/verify']
+  cmd = ['bundle', 'exec', 'rspec', 'spec/verify']
+  system(env, *cmd) or abort
 end
 task verify: :explode
 

data/exe/tcp_server

@@ -8,10 +8,10 @@
 
 # =begin
 
-# Copyright Nels Nelson 2016-2024 but freely usable (see license)
+# Copyright Nels Nelson 2016-2026 but freely usable (see license)
 
 # =end
 
-require_relative '../lib/server'
+require_relative '../lib/tcp_server'
 
-Object.new.extend(Server).main
+Object.new.extend(TcpServer).main

data/lib/{server/argument_parser.rb → tcp_server/arguments_parser.rb}

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2024 but freely usable (see license)
+# Copyright Nels Nelson 2016-2026 but freely usable (see license)
 #
 # =end
 
@@ -14,15 +14,15 @@ require 'optparse'
 
 require_relative 'config'
 
-# The Server module
-module Server
+# The TcpServer module
+module TcpServer
   # The ArgumentsParser class
   class ArgumentsParser
     attr_reader :parser, :options
 
     def initialize(option_parser = OptionParser.new)
       @parser = option_parser
-      @options = ::Server.server_config.dup
+      @options = TcpServer.server_config.dup
       @flags = %i[banner port ssl idle_reading idle_writing log_requests log_level help version]
       @flags.each { |method_name| method(method_name)&.call if respond_to?(method_name) }
     end
@@ -34,7 +34,7 @@ module Server
     end
 
     def validated_port(value, integer_pattern = /^\d+$/)
-      raise OptionParser::InvalidArgument, "Invalid port: #{value}" unless \
+      raise OptionParser::InvalidArgument, "Invalid port: #{value}" unless
         integer_pattern.match?(value.to_s) && value.positive? && value < 65_536
 
       value
@@ -72,8 +72,8 @@ module Server
     end
 
     def log_level
+      current_level = @options.fetch(:log_level, 0)
       @parser.on_tail('-v', '--verbose', 'Increase verbosity') do
-        current_level = @options.fetch(:log_level, 0)
         @options[:log_level] = current_level - 1
       end
     end
@@ -87,14 +87,14 @@ module Server
 
     def version
       @parser.on_tail('--version', 'Show version') do
-        puts "#{File.basename($PROGRAM_NAME)} version #{::Server::VERSION}"
+        puts "#{File.basename($PROGRAM_NAME)} version #{TcpServer::VERSION}"
         exit
       end
     end
   end
   # class ArgumentsParser
 
-  def parse_arguments(arguments_parser = ::Server::ArgumentsParser.new)
+  def parse_arguments(arguments_parser = TcpServer::ArgumentsParser.new)
     arguments_parser.parser.parse!(ARGV)
     arguments_parser.options
   rescue OptionParser::InvalidArgument, OptionParser::InvalidOption,
@@ -102,4 +102,4 @@ module Server
     abort e.message
   end
 end
-# module Server
+# module TcpServer

data/lib/{server/channel_initializer.rb → tcp_server/channelizer.rb}

@@ -6,30 +6,30 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2024 but freely usable (see license)
+# Copyright Nels Nelson 2016-2026 but freely usable (see license)
 #
 # =end
 
 require 'java'
 require 'netty'
 
+java_import 'io.netty.channel.ChannelInitializer'
+java_import 'io.netty.handler.codec.DelimiterBasedFrameDecoder'
+java_import 'io.netty.handler.codec.string.StringDecoder'
+java_import 'io.netty.handler.codec.string.StringEncoder'
+java_import 'io.netty.handler.ssl.SslContextBuilder'
+java_import 'io.netty.handler.ssl.SslHandler'
+java_import 'io.netty.handler.ssl.util.InsecureTrustManagerFactory'
+java_import 'io.netty.handler.ssl.util.SelfSignedCertificate'
+java_import 'io.netty.util.concurrent.FutureListener'
+
 require_relative 'message_handler'
 require_relative 'modular_handler'
 
-# The Server module
-module Server
-  java_import Java::io.netty.handler.codec.DelimiterBasedFrameDecoder
-  java_import Java::io.netty.handler.codec.Delimiters
-  java_import Java::io.netty.handler.codec.string.StringDecoder
-  java_import Java::io.netty.handler.codec.string.StringEncoder
-  java_import Java::io.netty.handler.ssl.SslContextBuilder
-  java_import Java::io.netty.handler.ssl.SslHandler
-  java_import Java::io.netty.handler.ssl.util.InsecureTrustManagerFactory
-  java_import Java::io.netty.handler.ssl.util.SelfSignedCertificate
-  java_import Java::io.netty.util.concurrent.FutureListener
-
-  # The ChannelInitializer class
-  class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
+# The TcpServer module
+module TcpServer
+  # The Channelizer class
+  class Channelizer < ChannelInitializer
     attr_accessor :decoder, :encoder, :user_handlers
     attr_reader :options
 
@@ -55,11 +55,12 @@ module Server
     end
 
     def frame_decoder
-      DelimiterBasedFrameDecoder.new(@options[:max_frame_length], @options[:delimiter])
+      DelimiterBasedFrameDecoder.new(
+        @options[:max_frame_length], @options[:delimiter])
     end
 
     def default_handler
-      @default_handler ||= ::Server::ModularHandler.new(@channel_group)
+      @default_handler ||= TcpServer::ModularHandler.new(@channel_group)
     end
 
     def add_listener(*listener)
@@ -76,7 +77,7 @@ module Server
       @user_handlers.each do |handler|
         case handler
         when Class then pipeline.addLast(handler.new)
-        when Proc then pipeline.addLast(::Server::MessageHandler.new(&handler))
+        when Proc then pipeline.addLast(TcpServer::MessageHandler.new(&handler))
         else pipeline.addLast(handler)
         end
       end
@@ -89,8 +90,10 @@ module Server
       log.debug 'Initializing SSL context'
       require 'bouncycastle'
       ssc = SelfSignedCertificate.new
-      builder = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey())
-      @ssl_ctx = builder.trustManager(InsecureTrustManagerFactory::INSTANCE).build()
+      builder = SslContextBuilder.forServer(
+        ssc.certificate(), ssc.privateKey())
+      @ssl_ctx = builder.trustManager(
+        InsecureTrustManagerFactory::INSTANCE).build()
     end
 
     def ssl_handler_instance(channel, ssl_ctx = ssl_context)
@@ -106,13 +109,14 @@ module Server
       handler
     end
 
-    def ssl_handshake_future_listener(listener = Object.new.extend(FutureListener))
+    def ssl_handshake_future_listener(
+        listener = Object.new.extend(FutureListener))
       listener.define_singleton_method(:operationComplete) do |future|
         raise future.cause unless future.success?
         session = future.now.pipeline.get('SslHandler#0')&.engine&.session
-        ::Server.log.info "Channel protocol: #{session.protocol}, cipher suite: #{session.cipher_suite}"
+        TcpServer.log.info "Channel protocol: #{session.protocol}, cipher suite: #{session.cipher_suite}"
       rescue StandardError => e
-        ::Server.log.warn "Error handling operation complete event: #{e.message}"
+        TcpServer.log.warn "Error handling operation complete event: #{e.message}"
       end
       listener
     end
@@ -124,6 +128,6 @@ module Server
       ssl_engine
     end
   end
-  # class ChannelInitializer
+  # class Channelizer
 end
-# module Server
+# module TcpServer

data/lib/{client.rb → tcp_server/client.rb}

@@ -8,7 +8,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2024 but freely usable (see license)
+# Copyright Nels Nelson 2016-2026 but freely usable (see license)
 #
 # =end
 
@@ -19,6 +19,23 @@ require 'netty'
 
 require_relative 'logging'
 
+java_import 'io.netty.bootstrap.Bootstrap'
+java_import 'io.netty.channel.AbstractChannel'
+java_import 'io.netty.channel.ChannelInitializer'
+java_import 'io.netty.channel.ChannelOption'
+java_import 'io.netty.channel.SimpleChannelInboundHandler'
+java_import 'io.netty.channel.nio.NioEventLoopGroup'
+java_import 'io.netty.channel.socket.nio.NioSocketChannel'
+java_import 'io.netty.handler.codec.Delimiters'
+java_import 'io.netty.handler.codec.DelimiterBasedFrameDecoder'
+java_import 'io.netty.handler.codec.string.StringDecoder'
+java_import 'io.netty.handler.codec.string.StringEncoder'
+java_import 'io.netty.handler.ssl.SslContextBuilder'
+java_import 'io.netty.handler.ssl.SslHandler'
+java_import 'io.netty.handler.ssl.util.InsecureTrustManagerFactory'
+java_import 'java.util.concurrent.CopyOnWriteArrayList'
+java_import 'java.util.concurrent.LinkedBlockingQueue'
+
 # The Client module
 module Client
   def client_config
@@ -29,7 +46,7 @@ module Client
       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
+      delimiter: Delimiters.lineDelimiter
     }.freeze
   end
   module_function :client_config
@@ -37,19 +54,13 @@ end
 
 # The Client module
 module Client
-  java_import Java::io.netty.bootstrap.Bootstrap
-  java_import Java::io.netty.channel.ChannelOption
-  java_import Java::io.netty.channel.nio.NioEventLoopGroup
-  java_import Java::io.netty.handler.ssl.SslContextBuilder
-  java_import Java::io.netty.handler.ssl.util.InsecureTrustManagerFactory
-
   # The InitializationMethods module
   module InitializationMethods
     def init(options)
       @options = options
       @host = @options[:host]
       @port = @options[:port]
-      @queue = java.util.concurrent.LinkedBlockingQueue.new
+      @queue = LinkedBlockingQueue.new
     end
 
     def bootstrap
@@ -58,15 +69,15 @@ module Client
       @bootstrap.channel(::TCP::CHANNEL_TYPE)
       @bootstrap.option(ChannelOption::TCP_NODELAY, true)
       @bootstrap.handler(logging_handler) if @options[:log_requests]
-      @bootstrap.handler(channel_initializer)
+      @bootstrap.handler(channelizer)
     end
 
     def client_group
       @client_group ||= NioEventLoopGroup.new
     end
 
-    def channel_initializer
-      @channel_initializer ||= ::Client::ChannelInitializer.new(@options)
+    def channelizer
+      @channelizer ||= ::Client::Channelizer.new(@options)
     end
 
     def logging_handler
@@ -74,8 +85,8 @@ module Client
     end
 
     def configure_handlers(*handlers, &block)
-      channel_initializer.default_handler.add_listener(self)
-      channel_initializer.default_handler.listeners.addAll(handlers)
+      channelizer.default_handler.add_listener(self)
+      channelizer.default_handler.listeners.addAll(handlers)
       @user_app = block
       @application_handler = lambda do |ctx, msg|
         if @user_app.nil? || @user_app.arity == 1
@@ -92,13 +103,11 @@ end
 
 # The Client module
 module Client
-  java_import Java::io.netty.channel.AbstractChannel
-
   # The InstanceMethods module
   module InstanceMethods
     def puts(msg)
       wait_until_channel_is_active
-      msg.chomp!
+      msg = msg.chomp
       log.trace "#puts msg: #{msg.inspect}"
       raise 'Message is empty!' if msg.nil? || msg.empty?
       @last_write_future = @channel.writeAndFlush("#{msg}\n")
@@ -221,13 +230,11 @@ module Client
   # The Listenable module
   module Listenable
     def listeners
-      @listeners ||= java.util.concurrent.CopyOnWriteArrayList.new
+      @listeners ||= CopyOnWriteArrayList.new
     end
 
     def add_listener(*listener)
       listeners.addAll(listener)
-    ensure
-      log.trace "Listeners: #{listeners}"
     end
 
     def remove_listener(*listener)
@@ -237,6 +244,8 @@ module Client
     def replace_listeners(*listener)
       listeners.clear
       add_listener(*listener)
+    ensure
+      log.trace "##{__method__} listeners: #{listeners}"
     end
 
     def notify(event, *args)
@@ -253,40 +262,40 @@ end
 
 # The Client module
 module Client
-  # java_import Java::io.netty.channel.ChannelInboundHandlerAdapter
-  java_import Java::io.netty.channel.SimpleChannelInboundHandler
-
   # The ModularHandler class
-  # class ModularHandler < ChannelInboundHandlerAdapter
   class ModularHandler < SimpleChannelInboundHandler
     include ::Client::Listenable
 
+    # Overrides the Java::IoNettyChannel::SimpleChannelInboundHandler#isSharable
+    # method
+    # rubocop: disable Naming/PredicateMethod
     def isSharable
       true
     end
+    # rubocop: enable Naming/PredicateMethod
 
     def channelRegistered(ctx)
       log.trace "##{__method__} channel: #{ctx.channel}"
       notify :channel_registered, ctx
-      super(ctx)
+      super
     end
 
     def channelUnregistered(ctx)
       log.trace "##{__method__} channel: #{ctx.channel}"
       notify :channel_unregistered, ctx
-      super(ctx)
+      super
     end
 
     def channelActive(ctx)
       ::Client.log.debug "Channel active #{ctx.channel}"
       notify :channel_active, ctx
-      super(ctx)
+      super
     end
 
     def channelInactive(ctx)
       log.trace "##{__method__} channel: #{ctx.channel}"
       notify :channel_inactive, ctx
-      super(ctx)
+      super
     end
 
     def messageReceived(ctx, msg)
@@ -297,7 +306,7 @@ module Client
     def channelRead(ctx, msg)
       log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
       notify :channel_read, ctx, msg
-      super(ctx, msg)
+      super
     end
 
     # Please keep in mind that this method will be renamed to
@@ -312,25 +321,25 @@ module Client
     def channelReadComplete(ctx)
       log.trace "##{__method__} channel: #{ctx.channel}"
       notify :channel_read_complete, ctx
-      super(ctx)
+      super
     end
 
     def channelWritabilityChanged(ctx)
       log.trace "##{__method__} channel: #{ctx.channel}"
       notify :channel_writability_changed, ctx
-      super(ctx)
+      super
     end
 
     def userEventTriggered(ctx, evt)
       log.trace "##{__method__} channel: #{ctx.channel}, event: #{evt}"
       notify :user_event_triggered, ctx, evt
-      super(ctx, evt)
+      super
     end
 
     def exceptionCaught(ctx, cause)
       ::Client.log.warn "##{__method__} channel: #{ctx.channel}, cause: #{cause.message}"
       listeners = notify :exception_caught, ctx, cause
-      super(ctx, cause) if listeners.empty?
+      super if listeners.empty?
     end
 
     IdentiferTemplate = '#<%<class>s:0x%<id>s>'.freeze
@@ -346,13 +355,8 @@ end
 
 # The Client module
 module Client
-  java_import Java::io.netty.handler.codec.DelimiterBasedFrameDecoder
-  java_import Java::io.netty.handler.codec.Delimiters
-  java_import Java::io.netty.handler.codec.string.StringDecoder
-  java_import Java::io.netty.handler.codec.string.StringEncoder
-
-  # The ChannelInitializer class
-  class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
+  # The Channelizer class
+  class Channelizer < ChannelInitializer
     attr_accessor :decoder, :encoder, :handlers
 
     def initialize(options = {})
@@ -380,7 +384,8 @@ module Client
     end
 
     def frame_decoder
-      DelimiterBasedFrameDecoder.new(@options[:max_frame_length], @options[:delimiter])
+      DelimiterBasedFrameDecoder.new(
+        @options[:max_frame_length], @options[:delimiter])
     end
 
     def default_handler
@@ -405,7 +410,8 @@ module Client
       return @ssl_ctx unless @ssl_ctx.nil?
       log.debug 'Initializing SSL context'
       builder = SslContextBuilder.forClient()
-      @ssl_ctx = builder.trustManager(InsecureTrustManagerFactory::INSTANCE).build()
+      @ssl_ctx = builder.trustManager(
+        InsecureTrustManagerFactory::INSTANCE).build()
     end
 
     def ssl_handler(channel, ssl_ctx = ssl_context)
@@ -422,13 +428,13 @@ module Client
       ssl_engine
     end
   end
-  # class ChannelInitializer
+  # class Channelizer
 end
 # module Client
 
 # The TCP module
 module TCP
-  CHANNEL_TYPE = Java::io.netty.channel.socket.nio.NioSocketChannel.java_class
+  CHANNEL_TYPE = NioSocketChannel.java_class
 
   # The Client class
   class Client
@@ -439,6 +445,8 @@ module TCP
     def initialize(options = {}, *handlers, &block)
       init(::Client.client_config.merge(options))
       configure_handlers(*handlers, &block)
+      listeners = channelizer.default_handler.listeners
+      log.trace "##{__method__} listeners: #{listeners}"
       connect
       session
     end
@@ -480,7 +488,7 @@ module Client
     end
 
     def validated_port(val, integer_pattern = /^\d+$/)
-      raise OptionParser::InvalidArgument, "Invalid port: #{val}" unless \
+      raise OptionParser::InvalidArgument, "Invalid port: #{val}" unless
         integer_pattern.match?(val.to_s) && val.positive? && val < 65_536
 
       val
@@ -500,9 +508,9 @@ module Client
     end
 
     def log_level
+      current_level = @options.fetch(:log_level, 0)
       @parser.on_tail('-v', '--verbose', 'Increase verbosity') do
-        @options[:log_level] ||= 0
-        @options[:log_level] -= 1
+        @options[:log_level] = current_level - 1
       end
     end
 
@@ -515,7 +523,7 @@ module Client
 
     def version
       @parser.on_tail('--version', 'Show version') do
-        puts "#{File.basename($PROGRAM_NAME)} version #{::Server::VERSION}"
+        puts "#{File.basename($PROGRAM_NAME)} version #{::Client::VERSION}"
         exit
       end
     end