settlers 0.2.1 → 0.3.0

data/lib/settlers.rb

@@ -1,3 +1,28 @@
-require 'settlers/java_command'
-require 'settlers/jar'
-require 'settlers/application'
+require 'pathname'
+require 'rbconfig'
+require 'rbconfig/datadir'
+
+module Settlers
+  VERSION = '0.3.0'
+
+  autoload :Address,     'settlers/address'
+  autoload :Application, 'settlers/application'
+  autoload :Bonjour,     'settlers/bonjour'
+  autoload :Client,      'settlers/client'
+  autoload :Collector,   'settlers/collector'
+  autoload :Java,        'settlers/java'
+  autoload :Observer,    'settlers/observer'
+  autoload :Server,      'settlers/server'
+  autoload :UI,          'settlers/ui'
+
+  def self.datadir
+    @@datadir ||= begin
+      datadir = RbConfig.datadir('settlers')
+      if !File.exist?(datadir)
+        warn "#{datadir} does not exist. Trying again with data directory relative to __FILE__."
+        datadir = File.expand_path('../../data/settlers', __FILE__)
+      end
+      Pathname.new(datadir)
+    end
+  end
+end

data/lib/settlers/address.rb

@@ -0,0 +1,23 @@
+require 'ipaddr'
+
+module Settlers
+  class Address < Struct.new(:name, :host, :port)
+    include Comparable
+
+    def self.from(reply, info)
+      new reply.name, info.address, reply.port
+    end
+
+    def <=>(other)
+      [name, ip, port] <=> [other.name, other.ip, other.port]
+    end
+
+    def ip
+      IPAddr.new(host)
+    end
+
+    def to_s
+      "#{name} (#{host}:#{port})"
+    end
+  end
+end

data/lib/settlers/application.rb

@@ -1,131 +1,66 @@
-require 'optparse'
-require 'set'
-require 'shellwords'
-
-require 'rubygems'
-require 'dnssd'
-require 'highline/import'
-
 module Settlers
   class Application
-    attr_accessor :server, :client, :style
-
-    def initialize(*args)
-      self.server = Server.new
-      self.client = Client.new
-      self.style  = StandaloneGame
-      parse_options(args)
-    end
+    DEFAULT_PORT = 7777
 
-    def run
-      style.new(self).run
-    end
+    def initialize
+      @collector = Collector.new
+      @ui        = UI.new
 
-    def start_server
-      server.start
-    end
+      @defaults = %w(--server)
 
-    def start_client(server)
-      client.start(server)
-    end
+      @options = OptionParser.new do |opts|
+        opts.banner  = "Usage: #{File.basename($0)} [--client]"
+        opts.separator ''
+        opts.version = Settlers::VERSION
 
-    def find_server
-      choose(*available_servers)
-    end
+        opts.on('-c', '--client', 'Discover and connect to a game server.') do
+          @announcer  = NullObject.new
+          @discoverer = Bonjour.new
+          @server     = NullObject.new
+        end
 
-    private
+        opts.on('-s', '--server[=PORT]', Integer, 'Launch, announce, and connect to a game server.', ". PORT defaults to #{DEFAULT_PORT}.") do |port|
+          @announcer  = Bonjour.new
+          @discoverer = NullObject.new
+          @server     = Server.new(port || DEFAULT_PORT)
+        end
 
-    def parse_options(args)
-      # TODO it would be nice to provide a quick tabtab definition here.
-      OptionParser.new do |opts|
-        opts.on('-c', '--client') { self.style = BonjourClientGame }
-        opts.parse!(args)
+        opts.separator 'Defaults:'
+        opts.separator "#{opts.summary_indent}#{@defaults.join(' ')}"
       end
     end
 
-    class StandaloneGame < Struct.new(:app)
-      def run
-        app.start_server
-        app.start_client(app.server)
+    def run(args)
+      begin
+        @options.parse!(@defaults.dup.concat(args))
+      rescue OptionParser::ParseError
+        @options.abort($!)
       end
-    end
 
-    class BonjourClientGame < Struct.new(:app)
-      def run
-        app.start_client(app.find_server)
-      end
-    end
+      @server.add_observer(@announcer)
+      @server.add_observer(@collector)
+      @server.start
 
-    def available_servers(timeout = 3)
-      servers = Set.new
+      @discoverer.add_observer(@collector)
+      @discoverer.start
 
-      dns = DNSSD.browse('_settlers._tcp') do |reply|
-        DNSSD.resolve(reply.name, reply.type, reply.domain) do |resolve_reply|
-          servers << RemoteServer.new(reply.name, resolve_reply.target, resolve_reply.port)
-        end
+      @ui.choose_server(@collector) do |address|
+        Client.new(address).start
       end
-
-      puts 'Looking for settlers servers nearby...'
-      sleep timeout
-      dns.stop
-
-      return servers
     end
 
-    class Server
-      # Maybe we can change these to attr_writer as we'd like to make them command-line configurable.
-      attr_reader :name, :host, :port, :startup_delay, :maximum_connections, :username, :password, :robot_names
-
-      def initialize
-        @name = "#{`hostname -s`.chomp}-#{`whoami`.chomp}"
-        @host = 'localhost'
-        @port = 8880
-        @startup_delay = 4
-        @maximum_connections = 12
-        @username = 'root'
-        @password = ''
-        @robot_names = %w(Leonardo Humperdink Elwood)
-      end
-
-      def start
-        announce
-        serve
-        sleep(startup_delay)
-        start_robots
-      end
-
-      private
-
-      def announce
-        # Maybe it would be nice to include a TextRecord here providing something of a description?
-        DNSSD.register(name, '_settlers._tcp', 'local', port) do |rr|
-          puts "Announcing settlers server available on port #{port}."
-        end
-      end
+    private
 
-      def serve
-        # TODO move the Shellwords.escape call inside of JavaCommand.start
-        Jar.new('JSettlersServer.jar').running('soc.server.SOCServer').start(port, maximum_connections, username, Shellwords.escape(password))
+    class NullObject #:nodoc:
+      def add_observer(observer)
       end
 
-      def start_robots
-        robot_names.each do |name|
-          # TODO move the Shellwords.escape call inside of JavaCommand.start
-          Jar.new('JSettlersServer.jar').running('soc.robot.SOCRobotClient').start(host, port, name, Shellwords.escape(password))
-        end
+      def update(*args)
       end
-    end
 
-    class RemoteServer < Struct.new(:name, :host, :port)
-      def to_s
-        "#{name} (#{host}:#{port})"
+      def start
       end
     end
 
-    class Client
-      def start(server)
-        Jar.new('JSettlers.jar').running('soc.client.SOCPlayerClient').run(server.host, server.port)
-      end
-    end
   end
 end

data/lib/settlers/bonjour.rb

@@ -0,0 +1,35 @@
+require 'dnssd'
+require 'observer'
+
+module Settlers
+  class Bonjour
+    TYPE = '_settlers._tcp'
+
+    include Observable
+    include Observer
+
+    # To confirm registration is working, run `mDNS -B _settlers._tcp`.
+    def server_exists_at(address)
+      DNSSD.register!(address.name, TYPE, nil, address.port)
+    end
+
+    def start(timeout=5)
+      puts "Looking for servers for up to #{timeout} seconds..."
+
+      DNSSD.browse(TYPE) do |browse|
+        DNSSD.resolve(browse) do |reply|
+          DNSSD.getaddrinfo!(reply.target, DNSSD::Service::IPv4) do |info|
+            changed
+            notify_observers :server_exists_at, Address.from(reply, info)
+          end
+        end
+      end
+
+      sleep timeout
+    end
+
+    def DNSSD.getaddrinfo!(*args, &block) #:nodoc:
+      run(DNSSD::Service.new, :getaddrinfo, *args, &block)
+    end
+  end
+end

data/lib/settlers/client.rb

@@ -0,0 +1,11 @@
+module Settlers
+  class Client
+    def initialize(address)
+      @address = address
+    end
+
+    def start
+      Java.client.run(@address.host, @address.port)
+    end
+  end
+end

data/lib/settlers/collector.rb

@@ -0,0 +1,24 @@
+require 'set'
+
+module Settlers
+  class Collector
+    include Enumerable
+    include Observer
+
+    def initialize
+      @addresses = Set.new
+    end
+
+    def server_exists_at(address)
+      @addresses.add(address)
+    end
+
+    def each(&block)
+      @addresses.sort.each(&block)
+    end
+
+    def size
+      @addresses.size
+    end
+  end
+end

data/lib/settlers/java.rb

@@ -0,0 +1,39 @@
+module Settlers
+  class Java
+    def self.server
+      new('soc.server.SOCServer')
+    end
+
+    def self.client
+      new('soc.client.SOCPlayerClient')
+    end
+
+    JAR = Settlers.datadir.join('jsettlers-1.1.09', 'JSettlers.jar')
+
+    def initialize(class_name)
+      @class_name = class_name
+    end
+
+    def run(*args)
+      pid = quietly_fork(args)
+      Process.waitpid(pid)
+    end
+
+    def start(*args)
+      pid = quietly_fork(args)
+      at_exit { Process.kill 'INT', pid }
+    end
+
+    private
+
+    def quietly_fork(args)
+      args.map! { |arg| arg.to_s }
+
+      fork do
+        STDOUT.reopen '/dev/null'
+        STDERR.reopen '/dev/null'
+        exec 'java', '-cp', JAR, @class_name, *args
+      end
+    end
+  end
+end

data/lib/settlers/observer.rb

@@ -0,0 +1,7 @@
+module Settlers
+  module Observer
+    def update(*args)
+      send(*args) if respond_to?(args.first)
+    end
+  end
+end

data/lib/settlers/server.rb

@@ -0,0 +1,25 @@
+require 'observer'
+
+module Settlers
+  class Server
+    include Observable
+
+    def initialize(port)
+      @address = Address.new(name, '127.0.0.1', port)
+    end
+
+    def start
+      Java.server.start(@address.port, 10, 'root', '')
+      changed
+      notify_observers :server_exists_at, @address
+    end
+
+    private
+
+    def name
+      login = Etc.getlogin
+      name  = Etc.getpwnam(login).gecos
+      "#{name}'s Settlers Server"
+    end
+  end
+end

data/lib/settlers/ui.rb

@@ -0,0 +1,30 @@
+require 'highline'
+
+module Settlers
+  class UI
+    def initialize
+      @console = HighLine.new
+    end
+
+    def choose_server(list)
+      yield case list.size
+            when 0
+              abort 'No servers to choose from.'
+            when 1
+              list.first
+            else
+              choose_from_many(list)
+            end
+    end
+
+    private
+
+    def choose_from_many(list)
+      begin
+        @console.choose(*list)
+      rescue Interrupt
+        abort "\nGoodbye."
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: settlers
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Matthew Todd
@@ -9,39 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 +01:00
-default_executable: settlers
+date: 2010-06-18 00:00:00 +03:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  requirement: *id001
+  name: shoe
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: dnssd
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
+  requirement: *id002
   name: highline
+  prerelease: false
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  requirement: *id003
+  name: dnssd
+  prerelease: false
+  type: :runtime
 description: 
 email: matthew.todd@gmail.com
 executables: 
@@ -51,21 +69,24 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- Rakefile
-- settlers.gemspec
 - README.rdoc
 - bin/settlers
+- data/settlers/jsettlers-1.1.09/COPYING.txt
+- data/settlers/jsettlers-1.1.09/JSettlers.jar
+- data/settlers/jsettlers-1.1.09/README.txt
+- data/settlers/jsettlers-1.1.09/VERSIONS.txt
+- lib/settlers/address.rb
 - lib/settlers/application.rb
-- lib/settlers/jar.rb
-- lib/settlers/java_command.rb
+- lib/settlers/bonjour.rb
+- lib/settlers/client.rb
+- lib/settlers/collector.rb
+- lib/settlers/java.rb
+- lib/settlers/observer.rb
+- lib/settlers/server.rb
+- lib/settlers/ui.rb
 - lib/settlers.rb
-- resources/jsettlers-1.0.6/COPYING.txt
-- resources/jsettlers-1.0.6/JSettlers.jar
-- resources/jsettlers-1.0.6/JSettlersServer.jar
-- resources/jsettlers-1.0.6/README.txt
-- resources/jsettlers-1.0.6/VERSIONS.txt
 has_rdoc: true
-homepage: 
+homepage: http://github.com/matthewtodd/settlers
 licenses: []
 
 post_install_message: 
@@ -73,26 +94,34 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- settlers-0.2.1
+- settlers-0.3.0
 - --inline-source
+- --webcvs
+- http://github.com/matthewtodd/settlers/blob/v0.3.0/
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
-requirements: []
-
+requirements: 
+- java
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Provides a simple command-line executable for playing Robb Thomas' JSettlers game.