mongrel2 0.27.0 → 0.28.0

data/ChangeLog

@@ -1,3 +1,22 @@
+2012-07-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.27.0 for changeset 8883019d3299
+	[b85c576e5fb1] [tip]
+
+	* .hgsigs:
+	Added signature for changeset 6de3cbe2409c
+	[8883019d3299] [v0.27.0]
+
+	* History.rdoc, lib/mongrel2.rb:
+	Bump the minor version, update history.
+	[6de3cbe2409c]
+
+	* README.rdoc, lib/mongrel2/config.rb, lib/mongrel2/connection.rb,
+	lib/mongrel2/control.rb, lib/mongrel2/testing.rb:
+	Updating API documentation.
+	[cfac9894f2ec]
+
 2012-06-30  Michael Granger  <ged@FaerieMUD.org>
 
 	* Manifest.txt, README.rdoc, bin/m2sh.rb, data/mongrel2/config.rb.in,
@@ -6,7 +25,7 @@
 
 	Also adding documentation for them to the README, and moved the
 	DATA_DIR constants into mongrel2/constants.
-	[2f2b9b4bc86f] [tip]
+	[2f2b9b4bc86f]
 
 2012-06-27  Michael Granger  <ged@FaerieMUD.org>
 

data/History.rdoc

@@ -1,3 +1,13 @@
+== v0.28.0 [2012-07-12] Michael Granger <ged@FaerieMUD.org>
+
+- Add Mongrel2::Config::Server pathname methods for the path 
+  attributes (#access_log, #pid_file, etc.).
+- Show the server's URL at startup
+- Finish Config::Server API docs and add a predicate method for
+  use_ssl
+- Remove shell mode from m2sh.rb.
+
+
 == v0.27.0 [2012-07-02] Michael Granger <ged@FaerieMUD.org>
 
 - Adds support for websocket handshake in 'develop' branch.

data/Manifest.txt

@@ -14,7 +14,6 @@ data/mongrel2/css/master.css
 data/mongrel2/js/websock-test.js
 data/mongrel2/mimetypes.sql
 data/mongrel2/websock-test.html
-examples/.env
 examples/Procfile
 examples/README.txt
 examples/async-upload.rb

data/bin/m2sh.rb

@@ -2,7 +2,6 @@
 
 require 'uri'
 require 'pathname'
-require 'shellwords'
 require 'fileutils'
 require 'tnetstring'
 require 'loggability'
@@ -23,7 +22,7 @@ require 'mongrel2/config'
 #
 #   [√]    load  Load a config.
 #   [√]  config  Alias for load.
-#   [√]   shell  Starts an interactive shell.
+#   [-]   shell  Starts an interactive shell.
 #   [√]  access  Prints the access log.
 #   [√] servers  Lists the servers in a config database.
 #   [√]   hosts  Lists the hosts in a server.
@@ -43,7 +42,8 @@ require 'mongrel2/config'
 # well), so I don't plan to implement that. The 'control' command is more-easily
 # accessed via pry+Mongrel2::Control, so I'm not going to implement that, either.
 # Everything else should be analagous to (or better than) the m2sh that comes with
-# mongrel2.
+# mongrel2. I implemented the 'shell' mode, but I found I never used it, and it
+# introduced a dependency on the Termios library, so I removed it.
 #
 class Mongrel2::M2SHCommand
 	extend ::Sysexits,
@@ -67,15 +67,9 @@ class Mongrel2::M2SHCommand
 	end
 
 
-	# Path to the default history file for 'shell' mode
-	HISTORY_FILE = Pathname( "~/.m2shrb.history" )
-
 	# Number of items to store in history by default
 	DEFAULT_HISTORY_SIZE = 100
 
-	# The prompt the 'shell' mode should show
-	PROMPT = 'mongrel2> '
-
 
 	# Class instance variables
 	@command_help = Hash.new {|h,k| h[k] = { :desc => nil, :usage => ''} }
@@ -213,7 +207,6 @@ class Mongrel2::M2SHCommand
 	def initialize( options )
 		Loggability.format_as( :color ) if $stderr.tty?
 		@options = options
-		@shellmode = false
 
 		if @options.debug
 			$DEBUG = true
@@ -234,9 +227,6 @@ class Mongrel2::M2SHCommand
 	# The Trollop options hash the command will read its configuration from
 	attr_reader :options
 
-	# True if running in shell mode
-	attr_reader :shellmode
-
 
 	# Delegate the instance #prompt method to the class method instead
 	define_method( :prompt, &self.method(:prompt) )
@@ -244,7 +234,7 @@ class Mongrel2::M2SHCommand
 
 	### Run the command with the specified +command+ and +args+.
 	def run( command, *args )
-		command ||= 'shell'
+		command ||= 'help'
 		cmd_method = nil
 
 		begin
@@ -330,71 +320,6 @@ class Mongrel2::M2SHCommand
 	help :init, "Initialize a new empty config database."
 
 
-	### The 'shell' command.
-	def shell_command( * )
-		require 'readline'
-		require 'termios'
-		require 'shellwords'
-
-		term = Termios.getattr( $stdin )
-		@shellmode = true
-
-		# Set up the completion callback
-		# self.setup_completion
-
-		# Load saved command-line history
-		self.read_history
-
-		# Run until something sets the quit flag
-		quitting = false
-		until quitting
-			$stderr.puts
-			input = Readline.readline( PROMPT, true )
-			self.log.debug "Input is: %p" % [ input ]
-
-			# EOL makes the shell quit
-			if input.nil?
-				self.log.debug "EOL: setting quit flag"
-				quitting = true
-
-			# Blank input -- just reprompt
-			elsif input == ''
-				self.log.debug "No command. Re-displaying the prompt."
-
-			# Parse everything else into command + args
-			else
-				self.log.debug "Dispatching input: %p" % [ input ]
-				command, *args = Shellwords.split( input )
-
-				# Don't allow recursive shells
-				if command == 'shell'
-					error "Already in a shell."
-					next
-				end
-
-				begin
-					self.run( command, *args )
-				rescue => err
-					error "%p: %s" % [ err.class, err.message ]
-					err.backtrace.each do |frame|
-						self.log.debug "  " + frame
-					end
-				end
-			end
-		end
-
-		message "\nSaving history...\n"
-		self.save_history
-
-		message "done."
-
-	ensure
-		@shellmode = false
-		Termios.tcsetattr( $stdin, Termios::TCSANOW, term )
-	end
-	help :shell, "Start the program in interactive mode."
-
-
 	### The 'access' command
 	def access_command( logfile='logs/access.log', * )
 		#      1$             2$       3$       4$        5$        6$            7$        8$  9$
@@ -511,16 +436,16 @@ class Mongrel2::M2SHCommand
 			server.save
 		end
 
-		# Run the command, waiting for it to finish if invoked from shell mode, or
-		# execing it if not.
 		cmd = [ mongrel2, Mongrel2::Config.dbname.to_s, server.uuid ]
 		cmd.unshift( 'sudo' ) if self.options.sudo
 
-		if @shellmode
-			system( *cmd )
-		else
-			exec( *cmd )
-		end
+		url = "http%s://%s:%d" % [
+			server.use_ssl? ? 's' : '',
+			server.bind_addr,
+			server.port,
+		]
+		header "Starting mongrel2 at: #{url}"
+		exec( *cmd )
 	end
 	help :start, "Starts a server."
 	usage :start, <<-END_USAGE

data/lib/mongrel2.rb

@@ -20,10 +20,10 @@ module Mongrel2
 	abort "\n\n>>> Mongrel2 requires Ruby 1.9.2 or later. <<<\n\n" if RUBY_VERSION < '1.9.2'
 
 	# Library version constant
-	VERSION = '0.27.0'
+	VERSION = '0.28.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 6de3cbe2409c $
+	REVISION = %q$Revision: 511f5e29f0a0 $
 
 
 	require 'mongrel2/constants'

data/lib/mongrel2/config/server.rb

@@ -25,6 +25,95 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	#     port INTEGER,
 	#     use_ssl INTEGER default 0);
 
+	##
+	# :method: uuid
+	# Get the server identifier, which is typically a UUID, but can
+	# in reality be any string of alphanumeric characters and dashes.
+
+	##
+	# :method: uuid=( newuuid )
+	# Set the server identifier.
+
+	##
+	# :method: access_log
+	# Get the path to the server's access log as a String.
+
+	### Get the path to the server's access log as a Pathname
+	def access_log_path
+		path = self.access_log or return nil
+		return Pathname( path )
+	end
+
+
+	##
+	# :method: error_log
+	# Get the path tot he server's error log as a String.
+
+	### Get the path to the server's error log as a Pathname
+	def error_log_path
+		path = self.error_log or return nil
+		return Pathname( path )
+	end
+
+
+	##
+	# :method: chroot
+	# Get the name of the directory Mongrel2 will chroot to if run as root
+	# as a String.
+
+	### Return a Pathname for the server's chroot directory.
+	def chroot_path
+		path = self.chroot or return nil
+		return Pathname( path )
+	end
+
+
+	##
+	# :method: pid_file
+	# Get the path to the server's PID file as a String.
+
+	### The path to the server's PID file as a Pathname.
+	def pid_file_path
+		path = self.pid_file or return nil
+		return Pathname( path )
+	end
+
+
+	##
+	# :method: default_host
+	# Get the name of the default virtualhost for the server. If none
+	# of the hosts' names (or matching pattern) matches the request's Host:
+	# header, the default_host will be used.
+
+	##
+	# :method: name
+	# The huamn-readable name of the server.
+
+	##
+	# :method: bind_addr
+	# The address to bind to on startup.
+
+	##
+	# :method: port
+	# The port to listen on.
+
+
+	### Returns +true+ if the server uses SSL.
+	def use_ssl?
+		return self.use_ssl.nonzero?
+	end
+
+
+	### If +enabled+, the server will use SSL.
+	def use_ssl=( enabled )
+		if !enabled || enabled == 0
+			super( 0 )
+		else
+			super( 1 )
+		end
+	end
+
+
 	#
 	# :section: Associations
 	#
@@ -54,12 +143,6 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	# :section: Socket/Pathname Convenience Methods
 	#
 
-	### Return a Pathname for the server's chroot directory.
-	def chroot_path
-		return Pathname( self.chroot )
-	end
-
-
 	### Return the URI for its control socket.
 	def control_socket_uri
 		# Find the control socket relative to the server's chroot
@@ -84,15 +167,6 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	end
 
 
-	### Return a Pathname for the server's PID file with its chroot directory prepended.
-	def pid_file_path
-		pidfile = self.pid_file
-		pidfile.slice!( 0, 1 ) if pidfile.start_with?( '/' )
-
-		return self.chroot_path + pidfile
-	end
-
-
 	#
 	# :section: Validation Callbacks
 	#

data/spec/mongrel2/config/server_spec.rb

@@ -102,7 +102,13 @@ describe Mongrel2::Config::Server do
 	it "knows what the Pathname of its PID file is" do
 		pidfile = @server.pid_file_path
 		pidfile.should be_a( Pathname )
-		pidfile.to_s.should == '/usr/local/www/run/mongrel2.pid'
+		pidfile.to_s.should == '/run/mongrel2.pid'
+	end
+
+	it "has a predicate that understands the use_ssl value" do
+		@server.use_ssl.should be_false()
+		@server.use_ssl = true
+		@server.use_ssl.should be_true()
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongrel2
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -334,7 +334,6 @@ files:
 - data/mongrel2/js/websock-test.js
 - data/mongrel2/mimetypes.sql
 - data/mongrel2/websock-test.html
-- examples/.env
 - examples/Procfile
 - examples/README.txt
 - examples/async-upload.rb

data/examples/.env

@@ -1,2 +0,0 @@
-RUBYOPT=-I../lib
-MONGREL2=/Users/mgranger/source/C/mongrel2/bin/mongrel2