Class: Spork::Server

Inherits:
Object
  • Object
show all
Includes:
CustomIOStreams
Defined in:
lib/spork/server.rb

Overview

An abstract class that is implemented to create a server

(This was originally based off of spec_server.rb from rspec-rails (David Chelimsky), which was based on Florian Weber’s TDDMate)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CustomIOStreams

included, #stderr, #stdout

Constructor Details

#initialize(options = {}) ⇒ Server

Returns a new instance of Server.



14
15
16
17
 
# File 'lib/spork/server.rb', line 14

def initialize(options = {})
  @run_strategy = options[:run_strategy]
  @port = options[:port]
end

Instance Attribute Details

#port ⇒ Object

Returns the value of attribute port.



36
37
38
 
# File 'lib/spork/server.rb', line 36

def port
  @port
end

#run_strategy ⇒ Object (readonly)

Returns the value of attribute run_strategy.



11
12
13
 
# File 'lib/spork/server.rb', line 11

def run_strategy
  @run_strategy
end

Class Method Details

.run(options = {}) ⇒ Object 



19
20
21
 
# File 'lib/spork/server.rb', line 19

def self.run(options = {})
  new(options).listen
end

Instance Method Details

#abort ⇒ Object 



50
51
52
 
# File 'lib/spork/server.rb', line 50

def abort
  run_strategy.abort
end

#listen ⇒ Object

Sets up signals and starts the DRb service. If it’s successful, it doesn’t return. Not ever. You don’t need to override this.

Raises:

  • (RuntimeError) 


24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/spork/server.rb', line 24

def listen
  raise RuntimeError, "you must call Spork.using_spork! before starting the server" unless Spork.using_spork?
  trap("SIGINT") { sig_int_received }
  trap("SIGTERM") { abort; exit!(0) }
  trap("USR2") { abort; restart } if Signal.list.has_key?("USR2")
  @drb_service = DRb.start_service("druby://127.0.0.1:#{port}", self)
  Spork.each_run { @drb_service.stop_service } if @run_strategy.class == Spork::RunStrategy::Forking
  stderr.puts "Spork is ready and listening on #{port}!"
  stderr.flush
  DRb.thread.join
end

#run(argv, stderr, stdout) ⇒ Object

This is the public facing method that is served up by DRb. To use it from the client side (in a testing framework):

DRb.start_service("druby://localhost:0") # this allows Ruby to do some magical stuff so you can pass an output stream over DRb.
                                         # see http://redmine.ruby-lang.org/issues/show/496 to see why localhost:0 is used.
spec_server = DRbObject.new_with_uri("druby://127.0.0.1:8989")
spec_server.run(options.argv, $stderr, $stdout)

When implementing a test server, don’t override this method: override run_tests instead.



46
47
48
 
# File 'lib/spork/server.rb', line 46

def run(argv, stderr, stdout)
  run_strategy.run(argv, stderr, stdout)
end