hq-logger 0.0.0

data/lib/hq/logger.rb

@@ -0,0 +1,217 @@
+module HQ
+class Logger
+
+	attr_accessor :hostname
+
+	MESSAGE_TYPES = [
+		:trace,
+		:timing,
+		:debug,
+		:detail,
+		:notice,
+		:warning,
+		:error,
+	]
+
+	def initialize
+
+		require "hq/tools/logger/multi-logger"
+
+		@multi_logger =
+			MultiLogger.new
+
+	end
+
+	def message text, level, *content
+		message text, level, *content
+	end
+
+	def message_partial text, level, *content
+		message_partial text, level, options
+	end
+
+	def message_complete text, level, *content
+		message_complete text, level, options
+	end
+
+	def trace text, *contents
+		message text, :trace, *contents
+	end
+
+	def timing text, *contents
+		message text, :timing, *contents
+	end
+
+	def debug text, *contents
+		message text, :debug, *contents
+	end
+
+	def detail text, *contents
+		message text, :detail, *contents
+	end
+
+	def notice text, *contents
+		message text, :notice, *contents
+	end
+
+	def warning text, *contents
+		message text, :warning, *contents
+	end
+
+	def error text, *contents
+		message text, :error, *contents
+	end
+
+	def time text, level = :timing
+
+		time_start =
+			Time.now
+
+		begin
+
+			yield
+
+		ensure
+
+			time_end =
+				Time.now
+
+			timing_ms =
+				((time_end - time_start) * 1000).to_i
+
+			timing_str =
+				case timing_ms
+					when (0...1000)
+						"%dms" % [ timing_ms ]
+					when (1000...10000)
+						"%.2fs" % [ timing_ms.to_f / 1000 ]
+					when (10000...100000)
+						"%.1fs" % [ timing_ms.to_f / 1000 ]
+					else
+						"%ds" % [ timing_ms / 1000 ]
+				end
+
+			message \
+				"#{text} took #{timing_str}",
+				level
+
+		end
+
+	end
+
+	def die text, status = 1
+		error text
+		exit status
+	end
+
+	def add_auto str
+
+		level, format, filename =
+			str.split ":", 3
+
+		add_target \
+			filename ? File.open(filename, "a") : STDOUT,
+			format || :ansi,
+			level || hq_config["default-log-level"] || :detail
+
+	end
+
+	def add_target out, format, level
+
+		raise "Invalid log level #{level}" \
+			unless MESSAGE_TYPES.include? level.to_sym
+
+		logger =
+			case format.to_sym
+
+				when :ansi
+					require "hq/tools/logger/ansi-logger"
+					HQ::Tools::Logger::AnsiLogger.new
+
+				when :html
+					require "hq/tools/logger/html-logger"
+					HQ::Tools::Logger::HtmlLogger.new
+
+				when :raw
+					require "hq/tools/logger/raw-logger"
+					HQ::Tools::Logger::RawLogger.new
+
+				when :text
+					require "hq/tools/logger/text-logger"
+					HQ::Tools::Logger::TextLogger.new
+
+				else
+					raise "Error"
+
+			end
+
+		logger.out = out
+		logger.level = level
+
+		@multi_logger.add_logger logger
+
+	end
+
+	def add_logger logger
+		@multi_logger.add_logger logger
+	end
+
+	def self.level_includes level_1, level_2
+
+		index_1 =
+			MESSAGE_TYPES.index(level_1.to_sym)
+
+		index_2 =
+			MESSAGE_TYPES.index(level_2.to_sym)
+
+		return index_1 <= index_2
+
+	end
+
+	def output content, mode = :normal
+
+		raise "Must provide hostname" \
+			unless content["hostname"]
+
+		@multi_logger.output \
+			content,
+			{ mode: mode }
+
+	end
+
+	def message text, level, *content
+
+		output({
+			"type" => "log",
+			"hostname" => hostname,
+			"level" => level,
+			"text" => text,
+			"content" => content,
+		})
+
+	end
+
+	def message_partial text, level, *content
+
+		output({
+			"type" => "log",
+			"level" => level,
+			"text" => text,
+			"content" => content
+		}, :partial)
+
+	end
+
+	def message_complete text, level, *content
+
+		output({
+			"type" => "log",
+			"level" => level,
+			"text" => text,
+			"content" => content
+		}, :complete)
+
+	end
+
+end
+end

data/spec/hq/logger/ansi-logger-spec.rb

@@ -0,0 +1,108 @@
+require "hq/logger/ansi-logger"
+require "hq/logger/logger-examples"
+
+module HQ
+class Logger
+
+describe AnsiLogger do
+
+	include_examples "a logger"
+
+	context "#output" do
+
+		def ansi_line colour, text
+			return [
+				AnsiLogger::ANSI_CODES[:bold],
+				AnsiLogger::ANSI_CODES[:blue],
+				"hostname:",
+				" ",
+				AnsiLogger::ANSI_CODES[colour],
+				text,
+				AnsiLogger::ANSI_CODES[:normal],
+				"\n",
+			]
+		end
+
+		it "log without content" do
+
+			output_for(sample_log_without_content).should == [
+				ansi_line(:cyan, "|text"),
+			].flatten.join
+
+		end
+
+		it "log with content" do
+
+			output_for(sample_log_with_content).should == [
+				ansi_line(:cyan, "|text"),
+				ansi_line(:normal, "|  content 1"),
+				ansi_line(:normal, "|  content 2"),
+			].flatten.join
+
+		end
+
+		it "exception" do
+
+			output_for(sample_exception).should == [
+				ansi_line(:cyan, "|text"),
+				ansi_line(:normal, "|  message"),
+				ansi_line(:normal, "|    backtrace 1"),
+				ansi_line(:normal, "|    backtrace 2"),
+			].join
+
+		end
+
+		it "diff" do
+
+			output_for(sample_diff).should == [
+				ansi_line(:cyan, "|text"),
+				ansi_line(:magenta, "|  diff 1"),
+				ansi_line(:magenta, "|  diff 2"),
+				ansi_line(:magenta, "|  diff 3"),
+				ansi_line(:red, "|  diff 4"),
+				ansi_line(:blue, "|  diff 5"),
+				ansi_line(:white, "|  diff 6"),
+			].join
+
+		end
+
+		it "command with output" do
+
+			output_for(sample_command_with_output).should == [
+				ansi_line(:cyan, "|text"),
+				ansi_line(:normal, "|  output 1"),
+				ansi_line(:normal, "|  output 2"),
+			].join
+
+		end
+
+		it "command without output" do
+
+			output_for(sample_command_without_output).should == [
+				ansi_line(:cyan, "|text"),
+			].join
+
+		end
+
+		it "command-output" do
+
+			output_for(sample_command_output).should == [
+				ansi_line(:normal, "|  text"),
+			].join
+
+		end
+
+	end
+
+	context "#valid_modes" do
+
+		it "returns [ :normal, :partial ]" do
+			subject.valid_modes.should == [ :normal, :partial ]
+		end
+
+	end
+
+end
+
+end
+end

data/spec/hq/logger/html-logger-spec.rb

@@ -0,0 +1,148 @@
+require "hq/logger/html-logger"
+require "hq/logger/logger-examples"
+
+module HQ
+class Logger
+
+describe HtmlLogger do
+
+	include_examples "a logger"
+
+	context "#output" do
+
+		it "log without content" do
+
+			output_for(sample_log_without_content).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+		it "log with empty content" do
+
+			output_for(sample_log_with_empty_content).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+		it "log with content" do
+
+			output_for(sample_log_with_content).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|\t<div class=\"hq-log-content\">\n",
+				"|\t\t<div class=\"hq-log-simple\">content 1</div>\n",
+				"|\t\t<div class=\"hq-log-simple\">content 2</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+		it "exception" do
+
+			output_for(sample_exception).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|\t<div class=\"hq-log-content\">\n",
+				"|\t\t<div class=\"hq-log-exception\">\n",
+				"|\t\t\t<div class=\"hq-log-exception-message\">message</div>\n",
+				"|\t\t\t<div class=\"hq-log-exception-backtrace\">\n",
+				"|\t\t\t\t<div class=\"hq-log-exception-backtrace-line\">" +
+					"backtrace 1</div>\n",
+				"|\t\t\t\t<div class=\"hq-log-exception-backtrace-line\">" +
+					"backtrace 2</div>\n",
+				"|\t\t\t</div>\n",
+				"|\t\t</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+		it "diff" do
+
+			output_for(sample_diff).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|\t<div class=\"hq-log-content\">\n",
+				"|\t\t<div class=\"hq-log-diff\">\n",
+				"|\t\t\t<div class=\"hq-log-diff-minus-minus-minus\">diff 1</div>\n",
+				"|\t\t\t<div class=\"hq-log-diff-plus-plus-plus\">diff 2</div>\n",
+				"|\t\t\t<div class=\"hq-log-diff-at-at\">diff 3</div>\n",
+				"|\t\t\t<div class=\"hq-log-diff-minus\">diff 4</div>\n",
+				"|\t\t\t<div class=\"hq-log-diff-plus\">diff 5</div>\n",
+				"|\t\t\t<div class=\"hq-log-diff-else\">diff 6</div>\n",
+				"|\t\t</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+		it "command with output" do
+
+			output_for(sample_command_with_output).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|\t<div class=\"hq-log-content\">\n",
+				"|\t\t<div class=\"hq-log-command-output\">\n",
+				"|\t\t\t<div class=\"hq-log-command-output-line\">output 1</div>\n",
+				"|\t\t\t<div class=\"hq-log-command-output-line\">output 2</div>\n",
+				"|\t\t</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+		it "command without output" do
+
+			output_for(sample_command_without_output).should == [
+				"|<div class=\"hq-log-item hq-log-item-debug\">\n",
+				"|\t<div class=\"hq-log-head\">\n",
+				"|\t\t<div class=\"hq-log-hostname\">hostname</div>\n",
+				"|\t\t<div class=\"hq-log-text\">text</div>\n",
+				"|\t</div>\n",
+				"|</div>\n",
+			].join
+
+		end
+
+	end
+
+	context "#valid_modes" do
+
+		it "returns [ :normal, :complete ]" do
+			subject.valid_modes.should == [ :normal, :complete ]
+		end
+
+	end
+
+end
+
+end
+end

data/spec/hq/logger/multi-logger-spec.rb

@@ -0,0 +1,30 @@
+require "hq/logger/multi-logger"
+
+module HQ
+class Logger
+
+describe MultiLogger do
+
+	context "#output" do
+
+		it "outputs to all added loggers" do
+
+			logger_1 = double "logger 1"
+			logger_2 = double "logger 2"
+
+			subject.add_logger logger_1
+			subject.add_logger logger_2
+
+			logger_1.should_receive(:output).with(:a, :b, :c)
+			logger_2.should_receive(:output).with(:a, :b, :c)
+
+			subject.output :a, :b, :c
+
+		end
+
+	end
+
+end
+
+end
+end

data/spec/hq/logger/raw-logger-spec.rb

@@ -0,0 +1,48 @@
+require "hq/logger/raw-logger"
+require "hq/logger/logger-examples"
+
+module HQ
+class Logger
+
+describe RawLogger do
+
+	include_examples "a logger"
+
+	context "#output" do
+
+		it "outputs JSON" do
+
+			json = output_for(sample_log_with_content)
+
+			MultiJson.load(json).should == {
+				"mode" => "normal",
+				"content" => [
+					{
+						"type" => "log",
+						"level" => "debug",
+						"hostname" => "hostname",
+						"text" => "text",
+						"content" => [
+							"content 1",
+							"content 2",
+						],
+					},
+				],
+			}
+
+		end
+
+	end
+
+	context "#valid_modes" do
+
+		it "returns [ :normal, :partial, :complete ]" do
+			subject.valid_modes.should == [ :normal, :partial, :complete ]
+		end
+
+	end
+
+end
+
+end
+end

data/spec/hq/logger/text-logger-spec.rb

@@ -0,0 +1,95 @@
+require "hq/logger/logger-examples"
+require "hq/logger/text-logger"
+
+module HQ
+class Logger
+
+describe TextLogger do
+
+	include_examples "a logger"
+
+	context "#output" do
+
+		it "log without content" do
+
+			output_for(sample_log_without_content).should == [
+				"hostname debug: |text\n"
+			].join
+
+		end
+
+		it "log with content" do
+
+			output_for(sample_log_with_content).should == [
+				"hostname debug: |text\n",
+				"hostname debug: |  content 1\n",
+				"hostname debug: |  content 2\n",
+			].join
+
+		end
+
+		it "exception" do
+
+			output_for(sample_exception).should == [
+				"hostname debug: |text\n",
+				"hostname debug: |  message\n",
+				"hostname debug: |    backtrace 1\n",
+				"hostname debug: |    backtrace 2\n",
+			].join
+
+		end
+
+		it "diff" do
+
+			output_for(sample_diff).should == [
+				"hostname debug: |text\n",
+				"hostname debug: |  diff 1\n",
+				"hostname debug: |  diff 2\n",
+				"hostname debug: |  diff 3\n",
+				"hostname debug: |  diff 4\n",
+				"hostname debug: |  diff 5\n",
+				"hostname debug: |  diff 6\n",
+			].join
+
+		end
+
+		it "command with output" do
+
+			output_for(sample_command_with_output).should == [
+				"hostname debug: |text\n",
+				"hostname debug: |  output 1\n",
+				"hostname debug: |  output 2\n",
+			].join
+
+		end
+
+		it "command without output" do
+
+			output_for(sample_command_without_output).should == [
+				"hostname debug: |text\n",
+			].join
+
+		end
+
+		it "command-output" do
+
+			output_for(sample_command_output).should == [
+				"hostname debug: |  text\n",
+			].join
+
+		end
+
+	end
+
+	context "#valid_modes" do
+
+		it "returns [ :normal, :partial ]" do
+			subject.valid_modes.should == [ :normal, :partial ]
+		end
+
+	end
+
+end
+
+end
+end

data/spec/hq/logger-spec.rb

@@ -0,0 +1,9 @@
+require "hq/logger"
+
+module HQ
+
+describe Logger do
+	# TODO tests here please
+end
+
+end