mongrel2 0.28.0 → 0.29.0

data/History.rdoc

@@ -1,3 +1,19 @@
+== v0.29.0 [2012-07-13] Michael Granger <ged@FaerieMUD.org>
+
+- Make m2sh.rb write audit log events for modifying actions
+- Add a --why option to m2sh.rb to allow reasons for actions to be
+  logged.
+- Add a convenience delegator to Mongrel2::Config for logging an
+  action.
+- Finish Mongrel2::Config::Log method documentation
+- Remove RDoc sections from Mongrel2::Config::Server, as they made
+  stuff more difficult to find.
+- Add Mongrel2::Config::Server#to_s
+- Make stringified Log events only include parens if the event has a
+  'why' field.
+- Remove extraneous message from m2sh.rb's quickstart subcommand
+
+
 == v0.28.0 [2012-07-12] Michael Granger <ged@FaerieMUD.org>
 
 - Add Mongrel2::Config::Server pathname methods for the path 

data/bin/m2sh.rb

@@ -185,6 +185,8 @@ class Mongrel2::M2SHCommand
 				opt :sudo, "Use 'sudo' to run the mongrel2 server."
 				opt :port, "Reset the server port to <i> before starting it.",
 					:type => :integer
+				opt :why, "Specify the reason for an action for the event log.",
+					:type => :string
 				text ''
 
 				text 'Other Options:'
@@ -292,6 +294,7 @@ class Mongrel2::M2SHCommand
 		source = File.read( configfile )
 
 		runspace.module_eval( source, configfile, 1 )
+		Mongrel2::Config.log_action( "Loaded config from #{configfile}", self.options.why )
 	end
 	help :load, "Overwrite the config database with the values from the speciifed CONFIGFILE."
 	usage :load, <<-END_USAGE
@@ -444,6 +447,8 @@ class Mongrel2::M2SHCommand
 			server.bind_addr,
 			server.port,
 		]
+
+		Mongrel2::Config.log_action( "Starting server: #{server}", self.options.why )
 		header "Starting mongrel2 at: #{url}"
 		exec( *cmd )
 	end
@@ -467,6 +472,8 @@ class Mongrel2::M2SHCommand
 		control.reload
 		control.close
 		message "done."
+
+		Mongrel2::Config.log_action( "Restarted server #{server}", self.options.why )
 	end
 	help :reload, "Reload the specified server's configuration"
 	usage :reload, "[server]"
@@ -481,6 +488,8 @@ class Mongrel2::M2SHCommand
 		control.stop
 		control.close
 		message "done."
+
+		Mongrel2::Config.log_action( "Stopped server #{server}", self.options.why )
 	end
 	help :stop, "Stop the specified server gracefully"
 	usage :stop, "[server]"
@@ -539,11 +548,6 @@ class Mongrel2::M2SHCommand
 		self.bootstrap_command( configfile )
 		edit( configfile )
 		self.load_command( configfile )
-
-		message '---'
-		header "Point a browser at: "
-		message '---'
-
 		self.start_command()
 	end
 	help :quickstart, "Set up a basic mongrel2 server and run it."

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.28.0'
+	VERSION = '0.29.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 511f5e29f0a0 $
+	REVISION = %q$Revision: cc6fcfdf3335 $
 
 
 	require 'mongrel2/constants'

data/lib/mongrel2/config.rb

@@ -194,6 +194,7 @@ module Mongrel2
 
 			# Force the associations to reset
 			self.db = db
+			self.log_action( "Initialized the config database." )
 		end
 
 
@@ -210,6 +211,14 @@ module Mongrel2
 		end
 
 
+		### Log an entry to the commit log with the given +what+, +why+, +where+, and +how+ values
+		### and return it after it's saved.
+		def self::log_action( what, why=nil, where=nil, how=nil )
+			Mongrel2::Config::Log.log_action( what, why, where, how )
+		end
+
+
+
 		#########
 		protected
 		#########

data/lib/mongrel2/config/log.rb

@@ -38,11 +38,44 @@ class Mongrel2::Config::Log < Mongrel2::Config( :log )
 
 	# :todo: Correct the happened_at, which is set in UTC, but fetched in localtime.
 
+	##
+	# :method: id
+	# Get the ID of the log entry
+
+	##
+	# :method: who
+	# Get "who" was reponsible for the event.
+
+	##
+	# :method: what
+	# Get a description of "what" happened
+
+	##
+	# :method: location
+	# Get the "where" of the event.
+
+	##
+	# :method: happened_at
+	# Get the timestamp of the event.
+
+	##
+	# :method: how
+	# Get a description of "how" the event happened.
+
+	##
+	# :method: why
+	# Get a description of "why" the event happened.
+
+
 
 	### Stringify the log entry and return it.
 	def to_s
 		# 2011-09-09 19:35:40 [who] @where how: what (why)
-		return "%{happened_at} [%{who}] @%{location} %{how}: %{what} (%{why})" % self.values
+		msg = "%{happened_at} [%{who}] @%{location} %{how}: %{what}" % self.values
+		msg += " (#{self.why})" if self.why
+		return msg
 	end
 
 end # class Mongrel2::Config::Log
+
+

data/lib/mongrel2/config/server.rb

@@ -25,6 +25,23 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	#     port INTEGER,
 	#     use_ssl INTEGER default 0);
 
+	##
+	# Return the dataset for looking up a server by its UUID.
+	# :singleton-method: by_uuid
+	# :call-seq:
+	#    by_uuid( uuid )
+	def_dataset_method( :by_uuid ) {|uuid| filter(:uuid => uuid).limit(1) }
+
+
+	##
+	# The hosts[rdoc-ref:Mongrel2::Config::Host] that belong to this server.
+	one_to_many :hosts
+
+	##
+	# The filters[rdoc-ref:Mongrel2::Config::Filter] that will be loaded by this server.
+	one_to_many :filters
+
+
 	##
 	# :method: uuid
 	# Get the server identifier, which is typically a UUID, but can
@@ -114,35 +131,6 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	end
 
 
-	#
-	# :section: Associations
-	#
-
-	##
-	# The hosts[rdoc-ref:Mongrel2::Config::Host] that belong to this server.
-	one_to_many :hosts
-
-	##
-	# The filters[rdoc-ref:Mongrel2::Config::Filter] that will be loaded by this server.
-	one_to_many :filters
-
-
-	#
-	# :section: Dataset Methods
-	#
-
-	##
-	# Return the dataset for looking up a server by its UUID.
-	# :singleton-method: by_uuid
-	# :call-seq:
-	#    by_uuid( uuid )
-	def_dataset_method( :by_uuid ) {|uuid| filter(:uuid => uuid).limit(1) }
-
-
-	#
-	# :section: Socket/Pathname Convenience Methods
-	#
-
 	### Return the URI for its control socket.
 	def control_socket_uri
 		# Find the control socket relative to the server's chroot
@@ -167,10 +155,6 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	end
 
 
-	#
-	# :section: Validation Callbacks
-	#
-
 	### Sequel validation callback: add errors if the record is invalid.
 	def validate
 		self.validates_presence [ :access_log, :error_log, :pid_file, :default_host, :port ],
@@ -178,6 +162,13 @@ class Mongrel2::Config::Server < Mongrel2::Config( :server )
 	end
 
 
+	### Stringification method -- return a human-readable description of the server.
+	def to_s
+		return "%s {%s} %s:%d" % [ self.name, self.uuid, self.bind_addr, self.port ]
+	end
+
+
+
 	### DSL methods for the Server context besides those automatically-generated from its
 	### columns.
 	module DSLMethods

data/spec/mongrel2/config/log_spec.rb

@@ -68,14 +68,28 @@ describe Mongrel2::Config::Log do
 				what:        'what',
 				location:    'location',
 				happened_at: Time.at( 1315598592 ),
-				how:         'how',
-				why:         'why'
+				how:         'how'
 			)
 		end
 
 
 		it "stringifies as a readable log file line" do
 
+			# 2011-09-09 20:29:47 -0700 [mgranger] @localhost m2sh: load etc/mongrel2.conf (updating)
+			@log.to_s.should =~ %r{
+				^
+				(?-x:\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [\+\-]\d{4} )
+				\[who\] \s
+				@location \s
+				how: \s
+				what
+				$
+			}x
+		end
+
+		it "stringifies with a reason if it has one" do
+			@log.why = 'Because'
+
 			# 2011-09-09 20:29:47 -0700 [mgranger] @localhost m2sh: load etc/mongrel2.conf (updating)
 			@log.to_s.should =~ %r{
 				^
@@ -84,7 +98,7 @@ describe Mongrel2::Config::Log do
 				@location \s
 				how: \s
 				what \s
-				\(why\)
+				\(Because\)
 				$
 			}x
 		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongrel2
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-07-12 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri