gamefic-mud 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a8fbce2090194a364d012ad04c933a9c1ff572f
-  data.tar.gz: 31c1ff56b98dd54c820092872fb379f92224c6e8
+SHA256:
+  metadata.gz: ff2aa9c86a961ebb613299ee247dc201b473c7659c4a035546e4143f0a35b863
+  data.tar.gz: 5abc56417d93af1c3dea919e90614672eb4f920024971f52235487399194f2d0
 SHA512:
-  metadata.gz: 8b4ff2794d6b3aeb5e52c700635c7c72efee2e5f01f3d57ef0e3b12e3b76ea8734a0c532afd2b61d833c3b0647d5f8aa563e2f8951f4d5aa261b705b7fbfaf47
-  data.tar.gz: 2307f17548a756283f15571eab5c04da03e268ce4d86df59fd74b65a029fdd02bb858b8dc3b15f804a5988249265bf795fefc39de162f347a971a9a0001ef62a
+  metadata.gz: cb8514110747d8d4d8df20c48e0c6685bc2a6b8961dbdc47c0439fd668c0a8dd75f55eb01e70a847681cc667a01c46ca75f40117f5483e2fa1e14dd3028a0ccd
+  data.tar.gz: b5ecc5b4e032a94298c17d9e198883182be82881ecaa5001d7ab6aaa730301b75671347437f813e551c94a7b525e10fa7fdf432374088dda1c2bda020a9f6944

data/lib/gamefic-mud.rb

@@ -1,8 +1,9 @@
-module Gamefic
-
-  module Mud
-    autoload :Engine, 'gamefic-mud/engine'
-    autoload :User, 'gamefic-mud/user'
-  end
-
-end
+require 'gamefic'
+
+module Gamefic
+  module Mud
+    autoload :Adapter, 'gamefic-mud/adapter'
+    autoload :Engine, 'gamefic-mud/engine'
+    autoload :State, 'gamefic-mud/state'
+  end
+end

data/lib/gamefic-mud/adapter.rb

@@ -0,0 +1,9 @@
+module Gamefic
+  module Mud
+    module Adapter
+      autoload :Common, 'gamefic-mud/adapter/common'
+      autoload :Tcp, 'gamefic-mud/adapter/tcp'
+      autoload :Websocket, 'gamefic-mud/adapter/websocket'
+    end
+  end
+end

data/lib/gamefic-mud/adapter/common.rb

@@ -0,0 +1,60 @@
+module Gamefic
+  module Mud
+    module Adapter
+      # Common attributes and methods of client adapters.
+      #
+      module Common
+        # @return [Plot]
+        attr_accessor :plot
+
+        # @return [Actor]
+        attr_accessor :character
+
+        # @return [State::Base]
+        attr_reader :state
+
+        # @param state [Class<State::Base>]
+        # @return [void]
+        def start state
+          @state = state.new(self)
+          @state.start
+        end
+
+        def session
+          @session ||= {}
+        end
+
+        def [] key
+          session[key]
+        end
+
+        def []= key, value
+          session[key] = value
+        end
+
+        # @!method send_raw(data)
+        #   Send raw data to the client outside of the game.
+        #   Normally, game-related data is sent through the character,
+        #   usually via `character#tell` or `character#stream`. `#raw_data`
+        #   allows the engine to communicate with the client outside of the
+        #   game proper, e.g., to display a login prompt.
+        #
+        #   Adapters should implement this method.
+        #
+        #   @abstract
+        #   @param data [String] The message text
+        #   @return [void]
+
+        # @!method update(output)
+        #   Send a game update to the client. The engine uses this method to
+        #   broadcast messages and provide data about the current game state.
+        #
+        #   Adapters should implement this method.
+        #
+        #   @abstract
+        #   @param output [Hash]
+        #   @return [void]
+      end
+    end
+  end
+end

data/lib/gamefic-mud/adapter/tcp.rb

@@ -0,0 +1,61 @@
+require 'html_to_ansi'
+require 'socket'
+
+module Gamefic
+  module Mud
+    module Adapter
+      # The TCP client adapter module.
+      #
+      module Tcp
+        include Common
+
+        # @return [String]
+        attr_reader :ip_addr
+
+        # @return [Integer]
+        attr_reader :port
+
+        def post_init
+          port, ip = Socket.unpack_sockaddr_in(get_peername)
+          @port = port
+          @ip_addr = ip
+          puts "Connection received from #{ip}:#{port}"
+        end
+
+        def receive_data data
+          state.process data
+        end
+
+        def update output
+          # TCP connections are assumed to be terminal clients. Convert messages and options into
+          # an HTML block and convert it to ANSI text.
+          text = output[:messages]
+          unless output[:options].nil?
+            list = '<ol>'
+            state[:options].each do |o|
+              list += "<li>#{o}</li>"
+            end
+            list += "</ol>"
+            text += list
+          end
+          # @todo The line endings should probably be a function of HtmlToAnsi.
+          send_data HtmlToAnsi.convert(text).gsub(/\n/, "\r\n")
+        end
+
+        def send_raw data
+          send_data data
+        end
+
+        def receive_data data
+          state.process data.to_s.strip
+        end
+
+        def unbind
+          puts "Disconnecting from #{ip_addr}:#{port}"
+          # @todo Right way to remove player from game?
+          plot.destroy character unless character.nil?
+        end
+      end
+    end
+  end
+end

data/lib/gamefic-mud/adapter/websocket.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module Gamefic
+  module Mud
+    module Adapter
+      # The WebSocket client adapter module.
+      #
+      module Websocket
+        include Common
+
+        # @param output [Hash]
+        # @return [void]
+        def update output
+          # Websocket connections are assumed to be rich clients. Send them
+          # the entire output hash and let them determine how to render the
+          # data.
+          send output.to_json
+        end
+
+        # @param data [String]
+        # @return [void]
+        def send_raw data
+          # Convert raw text to a hash with a `messages` key so the WebSocket
+          # client can rely on a single standard for incoming data.
+          update({messages: data})
+        end
+      end
+    end
+  end
+end

data/lib/gamefic-mud/engine.rb

@@ -1,146 +1,129 @@
-require 'websocket-eventmachine-server'
-
-module Gamefic
-
-  class Mud::Engine < Gamefic::Engine::Base
-    def post_initialize
-      @web_connections = {}
-      @accepts = []
-    end
-
-    def will_accept type: :tcpsocket, host: '0.0.0.0', port: 4342
-      @accepts.push({ type: type, host: host, port: port })
-    end
-
-    def will_accept_tcpsocket host: '0.0.0.0', port: 4342
-      will_accept type: :tcpsocket, host: host, port: port
-    end
-
-    def will_accept_websocket host: '0.0.0.0', port: 4343
-      will_accept type: :websocket, host: host, port: port
-    end
-
-    def run
-      EM.epoll
-      EM.run do
-        trap("TERM") { stop }
-        trap("INT")  { stop }
-        
-        if @accepts.empty?
-          will_accept
-        end
-        @accepts.each { |a|
-          if a[:type] == :websocket
-            start_websocket host: a[:host], port: a[:port]
-          else
-            start_tcpsocket host: a[:host], port: a[:port]
-          end
-        }
-
-        EventMachine.add_periodic_timer 1 do
-          plot.ready
-          plot.update
-          plot.players.each { |p|
-            data = p.user.flush
-            if data != ''
-              p.user.update data
-              p.user.prompt p.prompt
-            end
-          }
-        end
-      end
-
-    end
-
-    def stop
-      puts "Terminating WebSocket Server"
-      EventMachine.stop
-    end
-
-    private
-
-    def start_websocket host:, port:
-      ::WebSocket::EventMachine::Server.start(host: host, port: port) do |ws|
-
-        ws.onopen do
-          puts "Client connected"
-          user = Gamefic::Mud::User::WebSocket.new(ws, self)
-          user.start Mud::User::State::Login
-          @web_connections[ws] = user
-        end
-
-        ws.onmessage do |msg, type|
-          @web_connections[ws].process msg
-        end
-
-        ws.onclose do
-          puts "Client disconnected"
-          plot.destroy @web_connections[ws].character unless @web_connections[ws].character.nil?
-          @web_connections.delete ws
-        end
-
-        ws.onerror do |e|
-          puts "Error: #{e}"
-        end
-
-        ws.onping do |msg|
-          puts "Received ping: #{msg}"
-        end
-
-        ws.onpong do |msg|
-          puts "Received pong: #{msg}"
-        end
-
-      end
-
-      puts "WebSocket server started on #{host}:#{port}"
-    end
-
-    module TcpHandler
-      attr_accessor :plot
-      attr_accessor :user
-      attr_reader :ip_addr
-      attr_reader :port
-
-      def post_init
-        port, ip = Socket.unpack_sockaddr_in(get_peername)
-        @port = port
-        @ip_addr = ip
-        puts "Connection received from #{ip}:#{port}"
-      end
-
-      def receive_data data
-        # HACK Convert to UTF-8 and close connection on errors
-        conv = ''
-        data.each_byte { |b|
-          c = b.chr.encode('UTF-8')
-          if c.valid_encoding?
-            conv += c
-          else
-            conv += '?'
-          end
-        }
-        conv.strip!
-        user.process conv
-      rescue Encoding::UndefinedConversionError
-        puts 'Throwing away garbage'
-        close_connection
-      end
-      def unbind
-        puts "Disconnecting from #{ip_addr}:#{port}"
-        plot.destroy user.character unless user.character.nil?
-      end
-    end
-
-    def start_tcpsocket host:, port:
-      EventMachine.start_server host, port, TcpHandler do |conn|
-        conn.plot = plot
-        conn.user = Gamefic::Mud::User::TcpSocket.new(conn, self)
-        conn.user.start Mud::User::State::Login
-      end
-
-      puts "Telnet server started on #{host}:#{port}"
-    end
-  end
-
-end
+require 'eventmachine'
+require 'em-websocket'
+
+module Gamefic
+  module Mud
+    # The MUD server engine. Responsible for handling client connections and
+    # updating the game state.
+    #
+    class Engine
+      # @return [Plot]
+      attr_reader :plot
+
+      # @param plot [Plot] The game plot
+      # @param start [Class<State::Base>] The initial state for new connections
+      # @param interval [Numeric] The number of seconds between updates
+      def initialize plot, start: State::Guest, interval: 1
+        @plot = plot
+        @start = start
+        @interval = interval
+        @web_connections = {}
+        @accepts = []
+        @connections = []
+      end
+
+      # Tell the engine to run a TCP or WebSocket server.
+      #
+      # @param type [Symbol] :tcpsocket or :websocket
+      # @param host [String] The host name
+      # @param port [Integer] The port number
+      # @return [void]
+      def will_accept type: :tcpsocket, host: '0.0.0.0', port: 4342
+        @accepts.push({ type: type, host: host, port: port })
+      end
+
+      # Tell the engine to run a TCP server.
+      #
+      # @param host [String] The host name
+      # @param port [Integer] The port number
+      # @return [void]
+      def will_accept_tcpsocket host: '0.0.0.0', port: 4342
+        will_accept type: :tcpsocket, host: host, port: port
+      end
+
+      # Tell the engine to run a WebSocket server.
+      #
+      # @param host [String] The host name
+      # @param port [Integer] The port number
+      # @return [void]
+      def will_accept_websocket host: '0.0.0.0', port: 4343
+        will_accept type: :websocket, host: host, port: port
+      end
+
+      # Start the engine.
+      #
+      # @return [void]
+      def run
+        EM.epoll
+        EM.run do
+          trap("TERM") { stop }
+          trap("INT")  { stop }
+
+          # Start a default TCP server if none are configured
+          will_accept if @accepts.empty?
+
+          @accepts.each do |a|
+            if a[:type] == :websocket
+              start_websocket host: a[:host], port: a[:port]
+            else
+              start_tcpsocket host: a[:host], port: a[:port]
+            end
+          end
+
+          EventMachine.add_periodic_timer @interval do
+            plot.update
+            plot.ready
+            @connections.each do |conn|
+              next unless conn.character
+              conn.update conn.character.output
+            end
+          end
+        end
+      end
+
+      def self.start plot, **options
+        engine = new(plot, **options)
+        yield(engine) if block_given?
+        engine.run
+      end
+
+      # Stop the engine.
+      #
+      # @return [void]
+      def stop
+        puts "Terminating server"
+        EventMachine.stop
+      end
+
+      private
+
+      def start_websocket host:, port:
+        EM::WebSocket.run(host: host, port: port) do |ws|
+          ws.onopen do |_handshake|
+            ws.extend Adapter::Websocket
+            ws.plot = plot
+            ws.start @start
+            @connections.push ws
+          end
+
+          # WebSocket messages are handled here because using `receive_data` in
+          # the adapter raises character encoding errors.
+          ws.onmessage do |msg|
+            ws.state.process msg.to_s.strip
+          end
+        end
+        puts "WebSocket server started on #{host}:#{port}"
+      end
+
+      def start_tcpsocket host:, port:
+        EventMachine.start_server host, port, Adapter::Tcp do |conn|
+          conn.plot = plot
+          conn.start @start
+          @connections.push conn
+        end
+
+        puts "Telnet server started on #{host}:#{port}"
+      end
+    end
+  end
+end

data/lib/gamefic-mud/state.rb

@@ -0,0 +1,9 @@
+module Gamefic
+  module Mud
+    module State
+      autoload :Base, 'gamefic-mud/state/base'
+      autoload :Guest, 'gamefic-mud/state/guest'
+      autoload :Play, 'gamefic-mud/state/play'
+    end
+  end
+end

data/lib/gamefic-mud/state/base.rb

@@ -0,0 +1,34 @@
+module Gamefic
+  module Mud
+    module State
+      # An abstract class for handling client states.
+      #
+      class Base
+        # @return [Adapter::Common]
+        attr_reader :adapter
+
+        # @param adapter [Adapter::Common]
+        def initialize adapter
+          @adapter = adapter
+        end
+
+        # Called when a client's state changes.
+        # Subclasses should implement this method.
+        #
+        # @return [void]
+        def start
+          puts "User started #{self.class}"
+        end
+
+        # Called when a message is received from a client.
+        # Subclasses should implement this method.
+        #
+        # @param message [String]
+        # @return [void]
+        def process message
+          puts "User sent #{message} in #{self.class}"
+        end
+      end
+    end
+  end
+end

data/lib/gamefic-mud/state/guest.rb

@@ -0,0 +1,28 @@
+module Gamefic
+  module Mud
+    module State
+      # A simple introductory state that creates a character with a name
+      # provided by the user. MUDs in production should implement a more
+      # robust version of authentication, but this is sufficient for testing
+      # and development.
+      #
+      class Guest < Base
+        def start
+          adapter.send_raw 'Enter your name: '
+        end
+
+        def process message
+          if message.strip.empty?
+            adapter.send_raw "Blank names are not allowed.\r\n"
+            start
+          else
+            character = adapter.plot.make_player_character
+            character.name = message.strip
+            adapter.character = character
+            adapter.start Mud::State::Play
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gamefic-mud/state/play.rb

@@ -0,0 +1,22 @@
+module Gamefic
+  module Mud
+    module State
+      # The typical gameplay handler. This state processes client messages as
+      # commands to be executed by the player's character.
+      #
+      class Play < Base
+        def start
+          adapter.plot.introduce adapter.character
+          # Since the game is already running when the player connects, the
+          # plot update flushes messages received in the introduction. We're
+          # working around the problem by sending them here.
+          adapter.update({ messages: adapter.character.messages })
+        end
+
+        def process message
+          adapter.character.queue.push message unless message == ''
+        end
+      end
+    end
+  end
+end

data/lib/gamefic-mud/version.rb

@@ -1,5 +1,5 @@
-module Gamefic
-  module Mud
-    VERSION = '0.0.1'
-  end
-end
+module Gamefic
+  module Mud
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -1,43 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-mud
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: gamefic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: websocket-eventmachine-server
+  name: html_to_ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 description: An engine for running multiplayer games with Gamefic
 email: fsnyder@gamefic.com
 executables: []
@@ -45,21 +107,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gamefic-mud.rb
+- lib/gamefic-mud/adapter.rb
+- lib/gamefic-mud/adapter/common.rb
+- lib/gamefic-mud/adapter/tcp.rb
+- lib/gamefic-mud/adapter/websocket.rb
 - lib/gamefic-mud/engine.rb
-- lib/gamefic-mud/user.rb
-- lib/gamefic-mud/user/base.rb
-- lib/gamefic-mud/user/state.rb
-- lib/gamefic-mud/user/state/base.rb
-- lib/gamefic-mud/user/state/login.rb
-- lib/gamefic-mud/user/state/play.rb
-- lib/gamefic-mud/user/tcpsocket.rb
-- lib/gamefic-mud/user/websocket.rb
+- lib/gamefic-mud/state.rb
+- lib/gamefic-mud/state/base.rb
+- lib/gamefic-mud/state/guest.rb
+- lib/gamefic-mud/state/play.rb
 - lib/gamefic-mud/version.rb
 homepage: http://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,9 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Gamefic MUD
 test_files: []

data/lib/gamefic-mud/user.rb

@@ -1,10 +0,0 @@
-module Gamefic
-
-  module Mud::User
-    autoload :Base, 'gamefic-mud/user/base'
-    autoload :State, 'gamefic-mud/user/state'
-    autoload :WebSocket, 'gamefic-mud/user/websocket'
-    autoload :TcpSocket, 'gamefic-mud/user/tcpsocket'
-  end
-
-end

data/lib/gamefic-mud/user/base.rb

@@ -1,32 +0,0 @@
-module Gamefic
-
-  class Mud::User::Base < Gamefic::User::Base
-    attr_accessor :character
-    attr_reader :engine
-
-    def initialize connection, engine
-      @connection = connection
-      @engine = engine
-      @state = Mud::User::State::Base.new(self)
-    end
-
-    def start user_state
-      @state = user_state.new(self)
-      @state.start
-    end
-
-    def process message
-      @state.process message
-    end
-
-    def update data
-    end
-
-    def transmit data
-    end
-
-    def prompt text
-    end
-  end
-
-end

data/lib/gamefic-mud/user/state.rb

@@ -1,9 +0,0 @@
-module Gamefic
-
-  module Mud::User::State
-    autoload :Base, 'gamefic-mud/user/state/base'
-    autoload :Login, 'gamefic-mud/user/state/login'
-    autoload :Play, 'gamefic-mud/user/state/play'
-  end
-
-end

data/lib/gamefic-mud/user/state/base.rb

@@ -1,23 +0,0 @@
-module Gamefic
-
-  module Mud::User::State
-
-    class Base
-      attr_reader :user
-
-      def initialize user
-        @user ||= user
-      end
-
-      def start
-        puts "User started #{self.class}"
-      end
-
-      def process message
-        puts "User sent #{message} in #{self.class}"
-      end
-
-    end
-    
-  end
-end

data/lib/gamefic-mud/user/state/login.rb

@@ -1,21 +0,0 @@
-module Gamefic
-
-  module Mud::User::State
-
-    class Login < Base
-
-      def start
-        user.prompt 'Enter your name:'
-      end
-
-      def process message
-        character = user.engine.plot.make Character, name: message, description: "#{message} is your name."
-        character.connect user
-        user.character = character
-        user.transmit "Welcome, #{message}."
-        user.start Mud::User::State::Play
-      end
-    end
-
-  end
-end

data/lib/gamefic-mud/user/state/play.rb

@@ -1,13 +0,0 @@
-module Gamefic
-
-  class Mud::User::State::Play < Mud::User::State::Base
-    def start
-      user.engine.plot.introduce user.character
-    end
-
-    def process message
-      user.character.queue.push message unless message == ''
-    end
-  end
-
-end

data/lib/gamefic-mud/user/tcpsocket.rb

@@ -1,19 +0,0 @@
-require 'gamefic/text'
-
-module Gamefic
-  
-  class Mud::User::TcpSocket < Mud::User::Base
-    def update data
-      transmit "\n" + Gamefic::Text::Html::Conversions.html_to_ansi(data)
-    end
-
-    def transmit data
-      @connection.send_data data
-    end
-
-    def prompt text
-      transmit "\n#{text} "
-    end
-  end
-
-end

data/lib/gamefic-mud/user/websocket.rb

@@ -1,17 +0,0 @@
-module Gamefic
-
-  class Mud::User::WebSocket < Mud::User::Base
-    def update data
-      transmit data
-    end
-
-    def transmit data
-      @connection.send data
-    end
-
-    def prompt text
-      transmit "<label class=\"prompt\">#{text}</label>"
-    end
-  end
-
-end