console 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d335e8b78f82a73be6a3cf6ab279594277fe4fd492d82db5da34695643219e
-  data.tar.gz: 22dd7d9b66f54a1bd38e563158d5ff58148e9f744d06a4d391ef8ae01676bb9d
+  metadata.gz: dc372565fdcca828bd36391080df923729df6f902637a56740a2f7eb3e639188
+  data.tar.gz: be63ec825ce033d4f882ff98ee038811b98d72dedfa577bfdb8453eeebf3dcd3
 SHA512:
-  metadata.gz: 9c4947d01b98cf603d14444be28815d4e7b6d3e3b7627be3b6f1d4d4d56f97702e7b61827c7c966533d696b73b9a0138b5a74fb2388fec645b5619b2e741ad2e
-  data.tar.gz: 8ecfe1ee0c30bc99b2662f6095defde0e99c8594a8a49b9c513f14914b80f84c9bc7ee7e13064097ac225a2f9a7a132ebae6b8f31c610cecd4c58e4cbfb77cf7
+  metadata.gz: 07d52f0ec479b661e6920d0942f3fa6aab1077706bdab02ab928025ef9c8e66e7066c6d39badac7778276eb1aaa13f5c715218aaf5c658a6b39fb22271d58aea
+  data.tar.gz: d05e1500655f528b1f4ccdbaad80cfcdb19dd68ce1cd3201f1736ba0af05e06aa4a6ccd7d79505b6c5c9d8214cf93170a573f342753ed20008ac71aa9c53a73a

data/lib/console/{generic.rb → event.rb}

@@ -18,9 +18,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-module Console
-	class Generic
-		def format(buffer, terminal)
-		end
-	end
-end
+require_relative 'event/spawn'
+require_relative 'event/failure'

data/lib/console/event/failure.rb

@@ -0,0 +1,78 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'generic'
+
+module Console
+	module Event
+		class Failure < Generic
+			def self.current_working_directory
+				Dir.getwd
+			rescue # e.g. Errno::EMFILE
+				nil
+			end
+			
+			def self.for(exception)
+				self.new(exception, self.current_working_directory)
+			end
+			
+			def initialize(exception, root = nil)
+				@exception = exception
+				@root = root
+			end
+			
+			attr :exception
+			attr :root
+			
+			def self.register(terminal)
+				terminal[:exception_title] ||= terminal.style(:red, nil, :bold)
+				terminal[:exception_detail] ||= terminal.style(:yellow)
+				terminal[:exception_backtrace] ||= terminal.style(:red)
+			end
+			
+			def format(output, terminal, verbose)
+				format_exception(@exception, nil, output, terminal, verbose)
+			end
+			
+			def format_exception(exception, prefix = nil, output, terminal, verbose)
+				lines = exception.message.lines.map(&:chomp)
+				
+				output.puts "  #{prefix}#{terminal[:exception_title]}#{exception.class}#{terminal.reset}: #{lines.shift}"
+				
+				lines.each do |line|
+					output.puts "  #{terminal[:exception_detail]}#{line}#{terminal.reset}"
+				end
+				
+				exception.backtrace&.each_with_index do |line, index|
+					path, offset, message = line.split(":")
+					
+					# Make the path a bit more readable
+					path.gsub!(/^#{@root}\//, "./") if @root
+					
+					output.puts "  #{index == 0 ? "→" : " "} #{terminal[:exception_backtrace]}#{path}:#{offset}#{terminal.reset} #{message}"
+				end
+				
+				if exception.cause and verbose
+					format_exception(exception.cause, "Caused by ", output, terminal)
+				end
+			end
+		end
+	end
+end

data/lib/console/event/generic.rb

@@ -0,0 +1,31 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Console
+	module Event
+		class Generic
+			def self.register(terminal)
+			end
+			
+			def format(buffer, terminal)
+			end
+		end
+	end
+end

data/lib/console/{shell.rb → event/spawn.rb}

@@ -21,45 +21,50 @@
 require_relative 'generic'
 
 module Console
-	class Shell < Generic
-		def self.for(*arguments, **options)
-			if arguments.first.is_a?(Hash)
-				self.new(*arguments, **options)
-			else
-				self.new(nil, arguments, **options)
+	module Event
+		class Spawn < Generic
+			def self.for(*arguments, **options)
+				if arguments.first.is_a?(Hash)
+					self.new(*arguments, **options)
+				else
+					self.new(nil, arguments, **options)
+				end
 			end
-		end
-		
-		def initialize(environment, *arguments, **options)
-			@environment = environment
-			@arguments = arguments
-			@options = options
-		end
-		
-		attr :environment
-		attr :arguments
-		attr :options
-		
-		def chdir_string(options)
-			if options and chdir = options[:chdir]
-				" in #{chdir}"
+			
+			def initialize(environment, *arguments, **options)
+				@environment = environment
+				@arguments = arguments
+				@options = options
 			end
-		end
-		
-		def self.register(terminal)
-			terminal[:shell_command] ||= terminal.style(:blue, nil, :bold)
-		end
-		
-		def format(output, terminal, verbose)
-			arguments = @arguments.flatten.collect(&:to_s)
 			
-			output.puts "  #{terminal[:shell_command]}#{arguments.join(' ')}#{terminal.reset}#{chdir_string(options)}"
+			attr :environment
+			attr :arguments
+			attr :options
+			
+			def chdir_string(options)
+				if options and chdir = options[:chdir]
+					" in #{chdir}"
+				end
+			end
+			
+			def self.register(terminal)
+				terminal[:shell_command] ||= terminal.style(:blue, nil, :bold)
+			end
 			
-			if verbose and @environment
-				@environment.each do |key, value|
-					output.puts "    export #{key}=#{value}"
+			def format(output, terminal, verbose)
+				arguments = @arguments.flatten.collect(&:to_s)
+				
+				output.puts "  #{terminal[:shell_command]}#{arguments.join(' ')}#{terminal.reset}#{chdir_string(options)}"
+				
+				if verbose and @environment
+					@environment.each do |key, value|
+						output.puts "    export #{key}=#{value}"
+					end
 				end
 			end
 		end
 	end
+	
+	# Deprecated.
+	Shell = Event::Spawn
 end

data/lib/console/terminal/logger.rb

@@ -19,9 +19,7 @@
 # THE SOFTWARE.
 
 require_relative '../buffer'
-
-require_relative '../shell'
-require_relative '../error'
+require_relative '../event'
 
 require_relative 'text'
 require_relative 'xterm'
@@ -64,8 +62,10 @@ module Console
 			end
 			
 			def register_defaults(terminal)
-				Shell.register(terminal)
-				Error.register(terminal)
+				Event.constants.each do |constant|
+					klass = Event.const_get(constant)
+					klass.register(terminal)
+				end
 			end
 			
 			UNKNOWN = 'unknown'
@@ -100,8 +100,8 @@ module Console
 			def format_argument(argument, output)
 				case argument
 				when Exception
-					Error.new(argument).format(output, @terminal, @verbose)
-				when Generic
+					Event::Failure.new(argument).format(output, @terminal, @verbose)
+				when Event::Generic
 					argument.format(output, @terminal, @verbose)
 				else
 					format_value(argument, output)

data/lib/console/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Console
-	VERSION = "1.0.0"
+	VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -83,12 +83,13 @@ files:
 - lib/console.rb
 - lib/console/buffer.rb
 - lib/console/capture.rb
-- lib/console/error.rb
+- lib/console/event.rb
+- lib/console/event/failure.rb
+- lib/console/event/generic.rb
+- lib/console/event/spawn.rb
 - lib/console/filter.rb
-- lib/console/generic.rb
 - lib/console/logger.rb
 - lib/console/serialized/logger.rb
-- lib/console/shell.rb
 - lib/console/split.rb
 - lib/console/terminal.rb
 - lib/console/terminal/logger.rb
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Beautiful logging for Ruby.

data/lib/console/error.rb

@@ -1,76 +0,0 @@
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require_relative 'generic'
-
-module Console
-	class Error < Generic
-		def self.current_working_directory
-			Dir.getwd
-		rescue # e.g. Errno::EMFILE
-			nil
-		end
-		
-		def self.for(exception)
-			self.new(exception, self.current_working_directory)
-		end
-		
-		def initialize(exception, root = nil)
-			@exception = exception
-			@root = root
-		end
-		
-		attr :exception
-		attr :root
-		
-		def self.register(terminal)
-			terminal[:exception_title] ||= terminal.style(:red, nil, :bold)
-			terminal[:exception_detail] ||= terminal.style(:yellow)
-			terminal[:exception_backtrace] ||= terminal.style(:red)
-		end
-		
-		def format(output, terminal, verbose)
-			format_exception(@exception, nil, output, terminal, verbose)
-		end
-		
-		def format_exception(exception, prefix = nil, output, terminal, verbose)
-			lines = exception.message.lines.map(&:chomp)
-			
-			output.puts "  #{prefix}#{terminal[:exception_title]}#{exception.class}#{terminal.reset}: #{lines.shift}"
-			
-			lines.each do |line|
-				output.puts "  #{terminal[:exception_detail]}#{line}#{terminal.reset}"
-			end
-			
-			exception.backtrace&.each_with_index do |line, index|
-				path, offset, message = line.split(":")
-				
-				# Make the path a bit more readable
-				path.gsub!(/^#{@root}\//, "./") if @root
-				
-				output.puts "  #{index == 0 ? "→" : " "} #{terminal[:exception_backtrace]}#{path}:#{offset}#{terminal.reset} #{message}"
-			end
-			
-			if exception.cause and verbose
-				format_exception(exception.cause, "Caused by ", output, terminal)
-			end
-		end
-	end
-end