console 0.5 → 1.0.0

data/lib/console/filter.rb

@@ -0,0 +1,119 @@
+# Copyright, 2017, 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 'buffer'
+
+module Console
+	UNKNOWN = 'unknown'
+	
+	class Filter
+		def self.[] **levels
+			klass = Class.new(self)
+			
+			klass.instance_exec do
+				const_set(:LEVELS, levels)
+				const_set(:MAXIMUM_LEVEL, levels.values.max)
+			
+				levels.each do |name, level|
+					const_set(name.to_s.upcase, level)
+					
+					define_method(name) do |subject = nil, *arguments, &block|
+						enabled = @subjects[subject.class]
+						
+						if enabled == true or (enabled != false and level >= @level)
+							self.call(subject, *arguments, severity: name, **@options, &block)
+						end
+					end
+					
+					define_method("#{name}!") do
+						@level = level
+					end
+					
+					define_method("#{name}?") do
+						@level >= level
+					end
+				end
+			end
+			
+			return klass
+		end
+		
+		def initialize(output, verbose: true, level: 0, **options)
+			@level = level
+			@verbose = verbose
+			
+			@subjects = {}
+			
+			@output = output
+			@options = options
+		end
+		
+		def dup(**options)
+			super().tap do |logger|
+				logger.options = @options.merge(options)
+			end
+		end
+		
+		attr :level
+		attr :verbose
+		
+		attr :subjects
+		
+		attr_accessor :output
+		attr_accessor :options
+		
+		def level= level
+			if level.is_a? Symbol
+				@level = self.class::LEVELS[level]
+			else
+				@level = level
+			end
+		end
+		
+		def verbose!(value = true)
+			@verbose = value
+			@output.verbose!(value)
+		end
+		
+		def off!
+			@level = -1
+		end
+		
+		def all!
+			@level = self.class::MAXIMUM_LEVEL
+		end
+		
+		def enabled?(subject)
+			@subjects[subject.class] == true
+		end
+		
+		def enable(subject)
+			@subjects[subject.class] = true
+		end
+		
+		def disable(subject)
+			@subjects[subject.class] = false
+		end
+		
+		def call(*arguments, &block)
+			@output.call(*arguments, &block)
+		end
+	end
+end

data/lib/console/generic.rb

@@ -0,0 +1,26 @@
+# 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
+	class Generic
+		def format(buffer, terminal)
+		end
+	end
+end

data/lib/console/logger.rb

@@ -0,0 +1,31 @@
+# Copyright, 2017, 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 'filter'
+
+module Console
+	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
+		def initialize(output, **options)
+			super(output, **options)
+			
+			self.info!
+		end
+	end
+end

data/lib/console/serialized/logger.rb

@@ -0,0 +1,71 @@
+# Copyright, 2017, 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 '../buffer'
+require_relative '../filter'
+
+require 'time'
+require 'json'
+
+module Console
+	module Serialized
+		class Logger
+			def initialize(io = $stderr, format: JSON)
+				@io = io
+				@start = Time.now
+				@format = format
+			end
+			
+			attr :io
+			attr :start
+			attr :format
+			
+			def verbose!(value = true)
+			end
+			
+			def call(subject = nil, *arguments, severity: UNKNOWN, &block)
+				message = {
+					time: Time.now.iso8601,
+					severity: severity,
+				}
+				
+				if subject
+					message[:subject] = subject
+				end
+				
+				if arguments.any?
+					message[:arguments] = arguments
+				end
+				
+				if block_given?
+					if block.arity.zero?
+						message[:message] = yield
+					else
+						buffer = StringIO.new
+						yield buffer
+						message[:message] = buffer.string
+					end
+				end
+				
+				@io.puts(@format.dump(message))
+			end
+		end
+	end
+end

data/lib/console/shell.rb

@@ -0,0 +1,65 @@
+# Copyright, 2017, 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 Shell < Generic
+		def self.for(*arguments, **options)
+			if arguments.first.is_a?(Hash)
+				self.new(*arguments, **options)
+			else
+				self.new(nil, arguments, **options)
+			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}"
+			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)}"
+			
+			if verbose and @environment
+				@environment.each do |key, value|
+					output.puts "    export #{key}=#{value}"
+				end
+			end
+		end
+	end
+end

data/lib/console/split.rb

@@ -0,0 +1,42 @@
+
+# Copyright, 2017, 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
+	class Split
+		def self.[] *outputs
+			self.new(outputs)
+		end
+		
+		def initialize(outputs)
+			@outputs = outputs
+		end
+		
+		def verbose!(value = true)
+			@outputs.each{|output| output.verbose!(value)}
+		end
+		
+		def call(level, subject = nil, *arguments, **options, &block)
+			@outputs.each do |output|
+				output.call(level, subject, *arguments, **options, &block)
+			end
+		end
+	end
+end

data/lib/console/terminal.rb

@@ -0,0 +1,21 @@
+# 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 'terminal/logger'

data/lib/console/terminal/logger.rb

@@ -0,0 +1,150 @@
+# Copyright, 2017, 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 '../buffer'
+
+require_relative '../shell'
+require_relative '../error'
+
+require_relative 'text'
+require_relative 'xterm'
+
+module Console
+	module Terminal
+		def self.for(io)
+			if io.isatty
+				XTerm.new(io)
+			else
+				Text.new(io)
+			end
+		end
+		
+		class Logger
+			def initialize(io = $stderr, verbose: false, **options)
+				@io = io
+				@verbose = verbose
+				@start = Time.now
+				
+				@terminal = Terminal.for(io)
+				@terminal[:logger_prefix] ||= @terminal.style(nil, nil, :bold)
+				@terminal[:logger_suffix] ||= @terminal.style(:white, nil, :faint)
+				@terminal[:debug] = @terminal.style(:cyan)
+				@terminal[:info] = @terminal.style(:green)
+				@terminal[:warn] = @terminal.style(:yellow)
+				@terminal[:error] = @terminal.style(:red)
+				@terminal[:fatal] = @terminal[:error]
+				
+				self.register_defaults(@terminal)
+			end
+			
+			attr :io
+			attr_accessor :verbose
+			attr :start
+			attr :terminal
+			
+			def verbose!(value = true)
+				@verbose = value
+			end
+			
+			def register_defaults(terminal)
+				Shell.register(terminal)
+				Error.register(terminal)
+			end
+			
+			UNKNOWN = 'unknown'
+			
+			def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, &block)
+				prefix = build_prefix(name || severity.to_s)
+				indent = " " * prefix.size
+				
+				buffer = Buffer.new("#{indent}| ")
+				
+				if subject
+					format_subject(severity, prefix, subject, buffer)
+				end
+				
+				arguments.each do |argument|
+					format_argument(argument, buffer)
+				end
+				
+				if block_given?
+					if block.arity.zero?
+						format_argument(yield, buffer)
+					else
+						yield(buffer, @terminal)
+					end
+				end
+				
+				@io.write buffer.string
+			end
+			
+			protected
+			
+			def format_argument(argument, output)
+				case argument
+				when Exception
+					Error.new(argument).format(output, @terminal, @verbose)
+				when Generic
+					argument.format(output, @terminal, @verbose)
+				else
+					format_value(argument, output)
+				end
+			end
+			
+			def format_subject(severity, prefix, subject, output)
+				prefix_style = @terminal[severity]
+				
+				if @verbose
+					suffix = " #{@terminal[:logger_suffix]}[pid=#{Process.pid}]#{@terminal.reset}"
+				end
+				
+				output.puts "#{@terminal[:logger_prefix]}#{subject}#{@terminal.reset}#{suffix}", prefix: "#{prefix_style}#{prefix}:#{@terminal.reset} "
+			end
+			
+			def format_value(value, output)
+				string = value.to_s
+				
+				string.each_line do |line|
+					output.puts "#{line}"
+				end
+			end
+			
+			def time_offset_prefix
+				offset = Time.now - @start
+				minutes = (offset/60).floor
+				seconds = (offset - (minutes*60))
+				
+				if minutes > 0
+					"#{minutes}m#{seconds.floor}s"
+				else
+					"#{seconds.round(2)}s"
+				end.rjust(6)
+			end
+			
+			def build_prefix(name)
+				if @verbose
+					"#{time_offset_prefix} #{name.rjust(8)}"
+				else
+					time_offset_prefix
+				end
+			end
+		end
+	end
+end