console 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 149a9d0738e731ea3ef3159cd25a449f663070406dfa232538a5996fb93c9ce9
-  data.tar.gz: 212772395d4aef7dc7a510d6630e11dfabeb4c8cf2c70f5d272c279a3d2a32ef
+  metadata.gz: '019b21198110cd3da94ef40ce3d666ea19be493e1ef2fa85e818bdd03d67e864'
+  data.tar.gz: 33994cbf5c6349aed18c79f3b20527785de1dd1c2307c49b864382750c2d807d
 SHA512:
-  metadata.gz: d02021cfb6dbf99651d5f1b8653394dd59f2c830b0a62b8c394b70b275030cd2c066a786a9cb1281df55029f9a69455c00a73a1763785cba3a5ccf8769766654
-  data.tar.gz: be05f291ccae55c3a6cce6ed2e5e79fa968682d856bcc502693408c69cc85b563017e8505a0459f6cb0d628bbdc57b58efd28146b460e09b45695652e6263145
+  metadata.gz: dc7b76666ff0f3dda0cfaf3d966f8cd00bae86d0930f34452e6dcd20dc42fac72d2ba9a7533f6dc9bf7790cdb4e1c98c97830434bc36a463ae156104c6caa657
+  data.tar.gz: 9bc0323787283b1fd20357914b1ff12eb1cd19bc20f68c7132bacf7533817829f514d5b408b5421366bf07a38265417ad3b3d93cc1984844affe5d91b0f0889c

data/lib/console/capture.rb

@@ -33,6 +33,10 @@ module Console
 			@buffer.last
 		end
 		
+		def include?(pattern)
+			JSON.dump(@buffer).include?(pattern)
+		end
+		
 		def clear
 			@buffer.clear
 		end

data/lib/console/filter.rb

@@ -26,11 +26,12 @@ module Console
 	class Filter
 		def self.[] **levels
 			klass = Class.new(self)
+			min_level, max_level = levels.values.minmax
 			
 			klass.instance_exec do
 				const_set(:LEVELS, levels)
-				const_set(:MINIMUM_LEVEL, levels.values.min)
-				const_set(:MAXIMUM_LEVEL, levels.values.max)
+				const_set(:MINIMUM_LEVEL, min_level)
+				const_set(:MAXIMUM_LEVEL, max_level)
 				
 				levels.each do |name, level|
 					const_set(name.to_s.upcase, level)
@@ -102,7 +103,7 @@ module Console
 		end
 		
 		def all!
-			@level = -1
+			@level = self.class::MINIMUM_LEVEL - 1
 		end
 		
 		# You can enable and disable logging for classes. This function checks if logging for a given subject is enabled.

data/lib/console/logger.rb

@@ -18,12 +18,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'output'
 require_relative 'filter'
 require_relative 'measure'
 require_relative 'progress'
 
 require_relative 'resolver'
 require_relative 'terminal/logger'
+require_relative 'serialized/logger'
 
 require 'fiber/local'
 
@@ -35,7 +37,7 @@ module Console
 		# You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment.
 		# https://mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.
 		def self.default_log_level(env = ENV)
-			if level = (env['CONSOLE_LEVEL'] || env['CONSOLE_LOG_LEVEL'])
+			if level = env['CONSOLE_LEVEL']
 				LEVELS[level.to_sym] || level.to_i
 			elsif $DEBUG
 				DEBUG
@@ -51,17 +53,25 @@ module Console
 			!$VERBOSE.nil? || env['CONSOLE_VERBOSE']
 		end
 		
-		def self.default_logger(output, verbose: self.verbose?, level: self.default_log_level)
-			terminal = Terminal::Logger.new(output, verbose: verbose)
+		def self.default_logger(output = $stderr, env = ENV, **options)
+			if options[:verbose].nil?
+				options[:verbose] = self.verbose?(env)
+			end
+			
+			if options[:level].nil?
+				options[:level] = self.default_log_level(env)
+			end
+			
+			output = Output.new(output, env, **options)
+			logger = self.new(output, **options)
 			
-			logger = self.new(terminal, verbose: verbose, level: level)
 			Resolver.default_resolver(logger)
 			
 			return logger
 		end
 		
 		def self.local
-			self.default_logger($stderr)
+			self.default_logger
 		end
 		
 		DEFAULT_LEVEL = 1

data/lib/console/output.rb

@@ -0,0 +1,40 @@
+# Copyright, 2021, 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 'output/default'
+require_relative 'output/json'
+require_relative 'output/text'
+require_relative 'output/xterm'
+
+module Console
+	module Output
+		def self.new(output = nil, env = ENV, **options)
+			if names = env['CONSOLE_OUTPUT']
+				names = names.split(',').map(&:to_sym).reverse
+				
+				names.inject(output) do |output, name|
+					Output.const_get(name).new(output, **options)
+				end
+			else
+				return Output::Default.new(output, **options)
+			end
+		end
+	end
+end

data/lib/console/output/default.rb

@@ -0,0 +1,38 @@
+# Copyright, 2021, 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 'xterm'
+require_relative 'json'
+
+module Console
+	module Output
+		module Default
+			def self.new(output, **options)
+				output ||= $stderr
+				
+				if output.tty?
+					XTerm.new(output, **options)
+				else
+					JSON.new(output, **options)
+				end
+			end
+		end
+	end
+end

data/lib/console/output/json.rb

@@ -0,0 +1,31 @@
+# Copyright, 2021, 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 '../serialized/logger'
+
+module Console
+	module Output
+		module JSON
+			def self.new(output, **options)
+				Serialized::Logger.new(output, format: ::JSON, **options)
+			end
+		end
+	end
+end

data/lib/console/output/sensitive.rb

@@ -0,0 +1,118 @@
+# Copyright, 2021, 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 '../serialized/logger'
+
+module Console
+	module Output
+		class Sensitive
+			def initialize(output, **options)
+				@output = output
+			end
+			
+			REDACT = /
+				  phone
+				| email
+				| full_?name
+				| first_?name
+				| last_?name
+				
+				| device_name
+				| user_agent
+				
+				| zip
+				| address
+				| location
+				| latitude
+				| longitude
+				
+				| ip
+				| gps
+				
+				| sex
+				| gender
+				
+				| token
+				| password
+			/xi
+			
+			def redact?(text)
+				text.match?(REDACT)
+			end
+			
+			def redact_hash(arguments, filter)
+				arguments.transform_values do |value|
+					redact(value, filter)
+				end
+			end
+			
+			def redact_array(array, filter)
+				array.map do |value|
+					redact(value, filter)
+				end
+			end
+			
+			def redact(argument, filter)
+				case argument
+				when String
+					if filter
+						filter.call(argument)
+					elsif redact?(argument)
+						"[REDACTED]"
+					else
+						argument
+					end
+				when Array
+					redact_array(argument, filter)
+				when Hash
+					redact_hash(argument, filter)
+				else
+					redact(argument.to_s, filter)
+				end
+			end
+			
+			class Filter
+				def initialize(substitutions)
+					@substitutions = substitutions
+					@pattern = Regexp.union(substitutions.keys)
+				end
+				
+				def call(text)
+					text.gsub(@pattern, @substitutions)
+				end
+			end
+			
+			def call(subject = nil, *arguments, sensitive: true, **options, &block)
+				if sensitive
+					if sensitive.respond_to?(:call)
+						filter = sensitive
+					elsif sensitive.is_a?(Hash)
+						filter = Filter.new(sensitive)
+					end
+					
+					subject = redact(subject, filter)
+					arguments = redact_array(arguments, filter)
+				end
+				
+				@output.call(subject, *arguments, **options)
+			end
+		end
+	end
+end

data/lib/console/output/text.rb

@@ -0,0 +1,31 @@
+# Copyright, 2021, 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'
+
+module Console
+	module Output
+		module Text
+			def self.new(output, **options)
+				Terminal::Logger.new(output, format: Terminal::Text, **options)
+			end
+		end
+	end
+end

data/lib/console/output/xterm.rb

@@ -0,0 +1,31 @@
+# Copyright, 2021, 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'
+
+module Console
+	module Output
+		module XTerm
+			def self.new(output, **options)
+				Terminal::Logger.new(output, format: Terminal::XTerm, **options)
+			end
+		end
+	end
+end

data/lib/console/resolver.rb

@@ -26,6 +26,8 @@ module Console
 		#
 		# e.g. `CONSOLE_WARN=Acorn,Banana CONSOLE_DEBUG=Cat` will set the log level for the classes Acorn and Banana to `warn` and Cat to `debug`. This overrides the default log level.
 		#
+		# You can enable all log levels for a given class by using `CONSOLE_ON=MyClass`. Similarly you can disable all logging using `CONSOLE_OFF=MyClass`.
+		#
 		# @parameter logger [Logger] A logger instance to set the logging levels on.
 		# @parameter env [Hash] The environment to read levels from.
 		#
@@ -33,23 +35,42 @@ module Console
 		# @returns [Resolver] If there were custom logging levels, then the created resolver is returned.
 		def self.default_resolver(logger, env = ENV)
 			# Find all CONSOLE_<LEVEL> variables from environment:
-			levels = Logger::LEVELS
+			levels = logger.class::LEVELS
 				.map{|label, level| [level, env["CONSOLE_#{label.upcase}"]&.split(',')]}
 				.to_h
 				.compact
 			
+			off_klasses = env['CONSOLE_OFF']&.split(',')
+			on_klasses = env['CONSOLE_ON']&.split(',')
+			
+			resolver = nil
+			
 			# If we have any levels, then create a class resolver, and each time a class is resolved, set the log level for that class to the specified level:
-			if levels.any?
-				resolver = Resolver.new
+			if on_klasses&.any?
+				resolver ||= Resolver.new
 				
-				levels.each do |level, names|
-					resolver.bind(names) do |klass|
-						logger.enable(klass, level)
-					end
+				resolver.bind(on_klasses) do |klass|
+					logger.enable(klass, logger.class::MINIMUM_LEVEL - 1)
 				end
+			end
+			
+			if off_klasses&.any?
+				resolver ||= Resolver.new
 				
-				return resolver
+				resolver.bind(off_klasses) do |klass|
+					logger.disable(klass)
+				end
 			end
+			
+			levels.each do |level, names|
+				resolver ||= Resolver.new
+				
+				resolver.bind(names) do |klass|
+					logger.enable(klass, level)
+				end
+			end
+			
+			return resolver
 		end
 		
 		def initialize

data/lib/console/serialized/logger.rb

@@ -27,7 +27,7 @@ require 'json'
 module Console
 	module Serialized
 		class Logger
-			def initialize(io = $stderr, format: JSON)
+			def initialize(io = $stderr, format: JSON, **options)
 				@io = io
 				@start = Time.now
 				@format = format

data/lib/console/terminal/logger.rb

@@ -55,11 +55,11 @@ module Console
 		end
 		
 		class Logger
-			def initialize(io = $stderr, verbose: nil, start_at: Terminal.start_at!, **options)
+			def initialize(io = $stderr, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)
 				@io = io
 				@start_at = start_at
 				
-				@terminal = Terminal.for(io)
+				@terminal = format.nil? ? Terminal.for(io) : format.new(io)
 				
 				if verbose.nil?
 					@verbose = !@terminal.colors?

data/lib/console/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-10 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-local
@@ -115,6 +115,12 @@ files:
 - lib/console/filter.rb
 - lib/console/logger.rb
 - lib/console/measure.rb
+- lib/console/output.rb
+- lib/console/output/default.rb
+- lib/console/output/json.rb
+- lib/console/output/sensitive.rb
+- lib/console/output/text.rb
+- lib/console/output/xterm.rb
 - lib/console/progress.rb
 - lib/console/resolver.rb
 - lib/console/serialized/logger.rb