gameoverseer 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc1d90c8155b62e40a08e8c8987686264990b2e7
+  data.tar.gz: 1d2d48e384a4c599fb75bb93c6698aeaaaf5a7c8
+SHA512:
+  metadata.gz: 520d1046beb53d18155082fad0c6c1a53997af2775f1d705343a6d9b58ad11f0b687e8a9ef25ae0976c5caaa06d113ea5ffa5df26bf23d437f324f5bd83f7f4d
+  data.tar.gz: 63649b30b5d5fdf85050a20aa5df3f059a6636336f495434c1fb9549bd2b58dc69d2da7a7fa5baf9c2c7658e43224bee8010c8561a270bf03f89cf5a00d3021b

data/.gitignore

@@ -1,3 +1,4 @@
-log-*.txt
-protocol.md
-*.gem
+log-*.txt
+.yardoc/*
+protocol.md
+*.gem

data/Gemfile

@@ -1,10 +1,3 @@
-source "https://rubygems.org"
-
-# gemspec
-
-gem "gosu"
-gem "nio4r", git: "https://github.com/MagLev/nio4r.git", branch: "johnnyt/recursive-lock-fix"
-gem "celluloid"
-gem "renet"# use rubygems version for now, git: "https://github.com/jvranish/rENet.git"
-gem "multi_json"
-gem "net-ssh"
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -1,34 +1,30 @@
-GIT
-  remote: https://github.com/MagLev/nio4r.git
-  revision: d22d0b9da828462f0ab14043f476388888430eb2
-  branch: johnnyt/recursive-lock-fix
-  specs:
-    nio4r (1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    gosu (0.8.7.2)
-    gosu (0.8.7.2-x86-mingw32)
-    hitimes (1.2.2-java)
-    hitimes (1.2.2-x86-mingw32)
-    multi_json (1.10.1)
-    net-ssh (2.9.2)
-    renet (0.1.14)
-    renet (0.1.14-x86-mingw32)
-    timers (4.0.1)
-      hitimes
-
-PLATFORMS
-  java
-  x86-mingw32
-
-DEPENDENCIES
-  celluloid
-  gosu
-  multi_json
-  net-ssh
-  nio4r!
-  renet
+PATH
+  remote: .
+  specs:
+    gameoverseer (0.1.2)
+      concurrent-ruby
+      gosu (= 0.10.6)
+      multi_json
+      renet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.1)
+    concurrent-ruby (1.0.1-java)
+    gosu (0.10.6)
+    gosu (0.10.6-x64-mingw32)
+    gosu (0.10.6-x86-mingw32)
+    multi_json (1.11.3)
+    renet (0.2.1)
+
+PLATFORMS
+  java
+  x64-mingw32
+  x86-mingw32
+
+DEPENDENCIES
+  gameoverseer!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,48 +1,51 @@
-# GameOverseer
-A game server, designed to be able to play host to up to 4 players in Planet Wars.
-
-This repo is a complete rewrite of  [GameOverseer](https://github.com/cyberarm/gameoverseer).
-
-# Status
-In development.
-Any examples given are subject to be outdated at anytime.
-
-# Install
-### Using bundler
-Add this to your Gemfile
-``` ruby
-gem "gameoverseer"
-```
-and run to install.
-```
-bundle install
-```
-
-### Or using RubyGems
-```
-gem install gameoverseer
-```
-
-# Usage
-``` ruby
-require 'gameoverseer'
-
-# Write a service for your game
-class GameWorld < GameOverseer::Service
-  def setup
-    channel_manager.register_channel('game_world', self)
-  end
-
-  def process(data)
-    # Do stuff with the data hash.
-  end
-
-  def version
-    "1.3.75"
-  end
-end
-
-host = "localhost"
-port = 56789
-GameOverseer.activate(host, port)
-```
+[![Code Climate](https://codeclimate.com/github/cyberarm/rewrite-gameoverseer/badges/gpa.svg)](https://codeclimate.com/github/cyberarm/rewrite-gameoverseer)
+[![Inline docs](http://inch-ci.org/github/cyberarm/rewrite-gameoverseer.svg?branch=master)](http://inch-ci.org/github/cyberarm/rewrite-gameoverseer)
+
+# GameOverseer
+A game server, designed to be able to play host to up to 4 players in Planet Wars.
+
+This repo is a complete rewrite of  [GameOverseer](https://github.com/cyberarm/gameoverseer).
+
+# Status
+In development.
+Any examples given are subject to be outdated at anytime.
+
+# Install
+### Using bundler
+Add this to your Gemfile
+``` ruby
+gem "gameoverseer"
+```
+and run to install.
+```
+bundle install
+```
+
+### Or using RubyGems
+```
+gem install gameoverseer
+```
+
+# Usage
+``` ruby
+require 'gameoverseer'
+
+# Write a service for your game
+class GameWorld < GameOverseer::Service
+  def setup
+    channel_manager.register_channel('game_world', self)
+  end
+
+  def process(data)
+    # Do stuff with the data hash.
+  end
+
+  def version
+    "1.3.75"
+  end
+end
+
+host = "localhost"
+port = 56789
+GameOverseer.activate(host, port)
+```

data/gameoverseer.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib", "bin"]
 
-  s.add_runtime_dependency "gosu"
-  s.add_runtime_dependency "celluloid"
+  s.add_runtime_dependency "gosu", "0.10.6"
+  s.add_runtime_dependency "concurrent-ruby"
   s.add_runtime_dependency "renet"
   s.add_runtime_dependency "multi_json"
 end

data/lib/gameoverseer/channels/channel_manager.rb

@@ -1,36 +1,49 @@
-module GameOverseer
-  class ChannelManager
-    CHAT = 0
-    WORLD= 1
-    HANDSHAKE = 2
-    FAULT=3
-    def initialize
-      @channels = {}
-      ChannelManager.instance = self
-    end
-
-    def register_channel(channel, service)
-      _channel = channel.downcase
-      unless @channels[_channel]
-        @channels[_channel] = service
-        GameOverseer::Console.log("ChannelManager> mapped '#{_channel}' to '#{service.class}'.")
-      else
-        raise "Could not map channel '#{_channel}' because '#{@channels[data[_channel]].class}' is already using it."
-      end
-    end
-
-    def send_to_service(data, client_id)
-      GameOverseer::Console.log("ChannelManager> sent '#{data}' to '#{@channels[data['channel']].class}'.")
-      @channels[data['channel']].client_id = client_id
-      @channels[data['channel']].process(data)
-    end
-
-    def self.instance
-      @instance
-    end
-
-    def self.instance=_instance
-      @instance = _instance
-    end
-  end
-end
+module GameOverseer
+
+  # Handles routing packets to the services that subscribe to channels
+  class ChannelManager
+    CHAT = 0
+    WORLD= 1
+    HANDSHAKE = 2
+    FAULT=3
+
+    def initialize
+      @channels = {}
+      ChannelManager.instance = self
+    end
+
+    # Enables a service to subscribe to a channel
+    # @param channel [String]
+    # @param service [Service]
+    def register_channel(channel, service)
+      _channel = channel.downcase
+      unless @channels[_channel]
+        @channels[_channel] = service
+        GameOverseer::Console.log("ChannelManager> mapped '#{_channel}' to '#{service.class}'.")
+      else
+        raise "Could not map channel '#{_channel}' because '#{@channels[data[_channel]].class}' is already using it."
+      end
+    end
+
+    # Routes packet to {Service}
+    # @param client_id [Integer] ID of client that sent the packet
+    # @param data [Hash] data from packet
+    def send_to_service(client_id, data)
+      GameOverseer::Console.log("ChannelManager> sent '#{data}' to '#{@channels[data['channel']].class}'.")
+      @channels[data['channel']].client_id = client_id
+      @channels[data['channel']].process(data)
+    end
+
+    # Returns instance of active {ChannelManager}
+    # @return [ChannelManager]
+    def self.instance
+      @instance
+    end
+
+    # Sets instance of {ChannelManager} that is used through out the system
+    # @param _instance [ChannelManager]
+    def self.instance=_instance
+      @instance = _instance
+    end
+  end
+end

data/lib/gameoverseer/clients/client_manager.rb

@@ -1,50 +1,66 @@
-module GameOverseer
-  class ClientManager
-    attr_accessor :clients
-
-    def initialize
-      ClientManager.instance = self
-      @clients = []
-    end
-
-    def add(client_id, ip_address)
-      @clients << {client_id: client_id, ip_address: ip_address}
-      GameOverseer::Services.client_connected(client_id, ip_address)
-    end
-
-    def update(client_id, key, value)
-      @clients.each do |hash|
-        if hash[:client_id] == client_id
-          hash[key] = value
-        end
-      end
-    end
-
-    def get(client_id)
-      _hash = @clients.detect do |hash|
-        if hash[:client_id] == client_id
-          true
-        end
-      end
-
-      return _hash
-    end
-
-    def remove(client_id)
-      @clients.each do |hash|
-        if hash[:client_id] == client_id
-          @clients.delete(hash)
-          GameOverseer::Services.client_disconnected(client_id)
-        end
-      end
-    end
-
-    def self.instance
-      @instance
-    end
-
-    def self.instance=_instance
-      @instance = _instance
-    end
-  end
-end
+module GameOverseer
+
+  # Stores client data
+  class ClientManager
+    attr_accessor :clients
+
+    def initialize
+      ClientManager.instance = self
+      @clients = []
+    end
+
+    # Add client to clients list
+    # @param client_id [Integer]
+    # @param ip_address [String]
+    def add(client_id, ip_address)
+      @clients << {client_id: client_id, ip_address: ip_address}
+      GameOverseer::Services.client_connected(client_id, ip_address)
+    end
+
+    # Store client specific data in a {Hash}
+    # @param client_id [Integer] ID of client
+    # @param key [String|Symbol]
+    # @param value What the key should equal
+    def update(client_id, key, value)
+      @clients.each do |hash|
+        if hash[:client_id] == client_id
+          hash[key] = value
+        end
+      end
+    end
+
+    # Gets client data
+    # @param client_id [Integer]
+    # @return [Hash] hash containing client data
+    def get(client_id)
+      _hash = @clients.detect do |hash|
+        if hash[:client_id] == client_id
+          true
+        end
+      end
+
+      return _hash
+    end
+
+    # Removes client data and disconnects client
+    # @param client_id [Integer] ID of client
+    def remove(client_id)
+      @clients.each do |hash|
+        if hash[:client_id] == client_id
+          @clients.delete(hash)
+          GameOverseer::Services.client_disconnected(client_id)
+        end
+      end
+    end
+
+    # @return [ClientManager]
+    def self.instance
+      @instance
+    end
+
+    # @param _instance [ClientManager]
+    def self.instance=_instance
+      @instance = _instance
+    end
+  end
+end

data/lib/gameoverseer/console/console.rb

@@ -1,207 +1,206 @@
-module GameOverseer
-  class Console < Gosu::Window
-    include Celluloid
-    # TODO: Use Gosu::Window.record to lower number of objects that need to be drawn
-
-    PENDING_LOG = []
-    def initialize
-      GameOverseer::Console.instance = self
-      super(720, 480, false)
-      $window = self
-      $window.caption = "GameOverseer Console"
-      $window.text_input = Gosu::TextInput.new
-
-      @default_text_instance = Gosu::Font.new($window, 'Consolas', 18)
-      @messages = []
-      setup_ui
-    end
-
-    def needs_cursor?
-      true
-    end
-
-    def draw
-      @ui_image.draw(0,0,0) if defined?(@ui_image)
-    end
-
-    def update
-      update_ui
-      @ui_image = $window.record(720, 480) {draw_ui}
-    end
-
-    def setup_ui
-      @current_text = text_instance
-      @current_text_x = 4
-
-      # Required first message
-      @messages << {
-        text: '',
-        instance: text_instance,
-        color: Gosu::Color::WHITE,
-        x: 4,
-        y: 480-26-18,
-        z: 1
-      }
-
-      submit_text("#{Time.now.strftime('%c')}", false)
-    end
-
-    def draw_ui
-      draw_rect(0,0, 720, 26, Gosu::Color.rgb(200, 75, 25))
-      draw_rect(0,454, 720, 480, Gosu::Color::WHITE)
-      text_instance.draw("GameOverSeer Console. GameOverseer version #{GameOverSeer::VERSION} #{GameOverSeer::RELEASE_NAME} #{@messages.count}", 4, 4, 3)
-      @current_text.draw("#{$window.text_input.text}", @current_text_x, 458, 3, 1, 1, Gosu::Color::BLACK)
-      draw_rect(@caret+@current_text_x, 456, 2.0+@caret+@current_text_x, 474, Gosu::Color::BLUE, 4) if defined?(@caret) && @render_caret
-
-      @messages.each do |message|
-        message[:instance].draw(message[:text],message[:x],message[:y],message[:z], 1, 1, message[:color])
-        p message[:color] unless message[:color] == Gosu::Color::WHITE
-      end
-    end
-
-    def update_ui
-      PENDING_LOG.each do |log_message|
-        submit_text(log_message, false) if log_message.strip.length > 0
-        PENDING_LOG.delete(log_message)
-      end
-
-      @caret = @current_text.text_width($window.text_input.text[0...$window.text_input.caret_pos])
-
-      @caret_tick = 0 unless defined?(@caret_tick)
-      @render_caret = true if @caret_tick < 15
-      @render_caret = false if @caret_tick > 30
-
-      @caret_tick = 0 unless @caret_tick < 45
-      @caret_tick+=1
-
-      value = @current_text.text_width($window.text_input.text)+@current_text_x
-      if value >= 720
-        @current_text_x-=4
-      elsif value <= 715
-        @current_text_x+=4 unless @current_text_x >= 4
-      end
-    end
-
-    def text_instance
-      @default_text_instance
-    end
-
-    def draw_rect(x1,y1, x2,y2, color = Gosu::Color::GRAY, z = 2)
-      $window.draw_quad(x1, y1, color, x2, y1, color, x1, y2, color, x2, y2, color, z)
-    end
-
-    def scroll(direction)
-      case direction
-      when :down
-        if @messages.last[:y] >= 480 - 26 - 18
-          @messages.each do |message|
-            message[:y]-=18
-          end
-        end
-      when :up
-        if @messages.first[:y] <= 26#<= 480 - 26 - 32
-          @messages.each do |message|
-            message[:y]+=18
-          end
-        end
-      end
-    end
-
-    def clean_messages(count)
-      if @messages.count >= count
-        @messages.delete(@messages.first)
-      end
-    end
-
-    def button_up(id)
-      case id
-      when 41 # Escape
-        # Quit?
-      when 40 # Enter
-        submit_text($window.text_input.text)
-      when 88 # Numpad Enter
-        submit_text($window.text_input.text)
-      when 259 # Mouse wheel
-        scroll(:up)
-      when 260  # Mouse wheel
-        scroll(:down)
-      end
-    end
-
-    def self.instance
-      @instance
-    end
-
-    def self.instance=_instance
-      @instance = _instance
-    end
-
-    def self.log(string)
-      self.log_it(string) if string.strip.length > 0
-      begin
-        GameOverseer::Console.instance.submit_text(string, false)
-      rescue NoMethodError
-        self.defer_log(string)
-      end
-    end
-
-    def self.log_with_color(string, color = Gosu::Color::WHITE)
-      self.log_it(string) if string.strip.length > 0
-      GameOverseer::Console.instance.submit_text(string, false, color)
-    end
-
-    def self.defer_log(string)
-      PENDING_LOG << string
-    end
-
-    def self.log_it(string)
-      puts string
-      retry_limit = 0
-      begin
-        @log_file = File.open("#{Dir.pwd}/logs/log-#{Time.now.strftime('%B-%d-%Y')}.txt", 'a+') unless defined? @log_file
-        @log_file.write "[#{Time.now.strftime('%c')}] #{string}\n"
-      rescue Errno::ENOENT
-        Dir.mkdir("#{Dir.pwd}/logs") unless File.exist?("#{Dir.pwd}/logs") && File.directory?("#{Dir.pwd}/logs")
-        retry_limit+=1
-        retry unless retry_limit >= 2
-      end
-    end
-
-    protected
-    def submit_text(text, from_console = true, color = Gosu::Color::WHITE)
-      if text.strip.length > 0
-        clean_messages(300)
-        text = "Console> #{text}" if from_console
-        GameOverseer::Console.log_it(text)
-        if text.length > 83
-          temp_text = text[0..83]
-          @messages.each do |message|
-            message[:y]-=18
-          end
-          @messages << {
-            text: temp_text,
-            instance: text_instance,
-            color: color,
-            x: 4,
-            y: @messages.last[:y] + 18,
-            z: 1
-          }
-          submit_text(text[83..text.length], false)
-        else
-          @messages.each do |message|
-            message[:y]-=18
-          end
-          @messages << {
-            text: text,
-            instance: text_instance,
-            color: color,
-            x: 4,
-            y: @messages.last[:y] + 18,
-            z: 1
-          }
-        end
-        $window.text_input = Gosu::TextInput.new if from_console
-      end
-    end
-  end
-end
+module GameOverseer
+  class Console < Gosu::Window
+    # TODO: Use Gosu::Window.record to lower number of objects that need to be drawn
+
+    PENDING_LOG = []
+    def initialize
+      GameOverseer::Console.instance = self
+      super(720, 480, false)
+      $window = self
+      $window.caption = "GameOverseer Console"
+      $window.text_input = Gosu::TextInput.new
+
+      @default_text_instance = Gosu::Font.new($window, 'Consolas', 18)
+      @messages = []
+      setup_ui
+    end
+
+    def needs_cursor?
+      true
+    end
+
+    def draw
+      @ui_image.draw(0,0,0) if defined?(@ui_image)
+    end
+
+    def update
+      update_ui
+      @ui_image = $window.record(720, 480) {draw_ui}
+    end
+
+    def setup_ui
+      @current_text = text_instance
+      @current_text_x = 4
+
+      # Required first message
+      @messages << {
+        text: '',
+        instance: text_instance,
+        color: Gosu::Color::WHITE,
+        x: 4,
+        y: 480-26-18,
+        z: 1
+      }
+
+      submit_text("#{Time.now.strftime('%c')}", false)
+    end
+
+    def draw_ui
+      draw_rect(0,0, 720, 26, Gosu::Color.rgb(200, 75, 25))
+      draw_rect(0,454, 720, 480, Gosu::Color::WHITE)
+      text_instance.draw("GameOverSeer Console. GameOverseer version #{GameOverseer::VERSION} #{GameOverseer::RELEASE_NAME} #{@messages.count}", 4, 4, 3)
+      @current_text.draw("#{$window.text_input.text}", @current_text_x, 458, 3, 1, 1, Gosu::Color::BLACK)
+      draw_rect(@caret+@current_text_x, 456, 2.0+@caret+@current_text_x, 474, Gosu::Color::BLUE, 4) if defined?(@caret) && @render_caret
+
+      @messages.each do |message|
+        message[:instance].draw(message[:text],message[:x],message[:y],message[:z], 1, 1, message[:color])
+        p message[:color] unless message[:color] == Gosu::Color::WHITE
+      end
+    end
+
+    def update_ui
+      PENDING_LOG.each do |log_message|
+        submit_text(log_message, false) if log_message.strip.length > 0
+        PENDING_LOG.delete(log_message)
+      end
+
+      @caret = @current_text.text_width($window.text_input.text[0...$window.text_input.caret_pos])
+
+      @caret_tick = 0 unless defined?(@caret_tick)
+      @render_caret = true if @caret_tick < 15
+      @render_caret = false if @caret_tick > 30
+
+      @caret_tick = 0 unless @caret_tick < 45
+      @caret_tick+=1
+
+      value = @current_text.text_width($window.text_input.text)+@current_text_x
+      if value >= 720
+        @current_text_x-=4
+      elsif value <= 715
+        @current_text_x+=4 unless @current_text_x >= 4
+      end
+    end
+
+    def text_instance
+      @default_text_instance
+    end
+
+    def draw_rect(x1,y1, x2,y2, color = Gosu::Color::GRAY, z = 2)
+      $window.draw_quad(x1, y1, color, x2, y1, color, x1, y2, color, x2, y2, color, z)
+    end
+
+    def scroll(direction)
+      case direction
+      when :down
+        if @messages.last[:y] >= 480 - 26 - 18
+          @messages.each do |message|
+            message[:y]-=18
+          end
+        end
+      when :up
+        if @messages.first[:y] <= 26#<= 480 - 26 - 32
+          @messages.each do |message|
+            message[:y]+=18
+          end
+        end
+      end
+    end
+
+    def clean_messages(count)
+      if @messages.count >= count
+        @messages.delete(@messages.first)
+      end
+    end
+
+    def button_up(id)
+      case id
+      when 41 # Escape
+        # Quit?
+      when 40 # Enter
+        submit_text($window.text_input.text)
+      when 88 # Numpad Enter
+        submit_text($window.text_input.text)
+      when 259 # Mouse wheel
+        scroll(:up)
+      when 260  # Mouse wheel
+        scroll(:down)
+      end
+    end
+
+    def self.instance
+      @instance
+    end
+
+    def self.instance=_instance
+      @instance = _instance
+    end
+
+    def self.log(string)
+      self.log_it(string) if string.strip.length > 0
+      begin
+        GameOverseer::Console.instance.submit_text(string, false)
+      rescue NoMethodError
+        self.defer_log(string)
+      end
+    end
+
+    def self.log_with_color(string, color = Gosu::Color::WHITE)
+      self.log_it(string) if string.strip.length > 0
+      GameOverseer::Console.instance.submit_text(string, false, color)
+    end
+
+    def self.defer_log(string)
+      PENDING_LOG << string
+    end
+
+    def self.log_it(string)
+      puts string
+      retry_limit = 0
+      begin
+        @log_file = File.open("#{Dir.pwd}/logs/log-#{Time.now.strftime('%B-%d-%Y')}.txt", 'a+') unless defined? @log_file
+        @log_file.write "[#{Time.now.strftime('%c')}] #{string}\n"
+      rescue Errno::ENOENT
+        Dir.mkdir("#{Dir.pwd}/logs") unless File.exist?("#{Dir.pwd}/logs") && File.directory?("#{Dir.pwd}/logs")
+        retry_limit+=1
+        retry unless retry_limit >= 2
+      end
+    end
+
+    protected
+    def submit_text(text, from_console = true, color = Gosu::Color::WHITE)
+      if text.strip.length > 0
+        clean_messages(300)
+        text = "Console> #{text}" if from_console
+        GameOverseer::Console.log_it(text)
+        if text.length > 83
+          temp_text = text[0..83]
+          @messages.each do |message|
+            message[:y]-=18
+          end
+          @messages << {
+            text: temp_text,
+            instance: text_instance,
+            color: color,
+            x: 4,
+            y: @messages.last[:y] + 18,
+            z: 1
+          }
+          submit_text(text[83..text.length], false)
+        else
+          @messages.each do |message|
+            message[:y]-=18
+          end
+          @messages << {
+            text: text,
+            instance: text_instance,
+            color: color,
+            x: 4,
+            y: @messages.last[:y] + 18,
+            z: 1
+          }
+        end
+        $window.text_input = Gosu::TextInput.new if from_console
+      end
+    end
+  end
+end