console 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8c2a727909b3b0ca71bcb6a441d47b0cc4c84fa23092bc23e4236f9b08f252
-  data.tar.gz: b66c0287ec6cbdc6269620cb043c2b6a97a7f0144f01502861196f0d0f1300a0
+  metadata.gz: 79f9ed13eedb54202ce2111a451e6e7d744f97db971a6b619ba3decb5aa6c963
+  data.tar.gz: 8c77221c0e50be91b7c1857fde7b596ec7e48eebd67a43287bd01aa3f95e70b4
 SHA512:
-  metadata.gz: cee7d0d65fad3401bbb1eb607c8661ee8c5645c8528a096436bebe8adf66d1d0f2e646b912286a2250a88a1ee25460c29d42bca6d173818b0a8a57e0397e117e
-  data.tar.gz: 03fbb80bc350caba54060baa86f4ed98e15bb2e5b323c1004b84f9b8e87ba29c5e523e996dd6288dfa30a55bd4833265190459e88c2b44a66b45b6188508fe9e
+  metadata.gz: 021e0bd5c98d7019af39186b6fa06e49aed619cb5228051a85725bd43f3f05d8015b6d9bc84baf3a49f51a9b13ac62ed65cb20051f9561939d0fb72c791b8475
+  data.tar.gz: '029abdaded5a4d383e7e4b666c99e2b06c0aaabed87c1da9740c6925ca5e9308eb41b52d61835e0b6a3223efff9b25a98aac555fe43c2ca441ef48f5f27e6f3f'

data/lib/console.rb

@@ -43,14 +43,32 @@ module Console
 			end
 		end
 		
+		# You can change the log level for different classes using CONSOLE_<LEVEL> env vars.
+		#
+		# e.g. `CONSOLE_WARN=Acorn,Banana CONSOLE_DEBUG=Cat` will set the log level for Acorn and Banana to warn and Cat to
+		# debug. This overrides the default log level.
+		#
+		# @param logger [Logger] A logger instance to set the logging levels on.
+		# @param env [Hash] Environment to read levels from.
+		#
+		# @return [nil] if there were no custom logging levels specified in the environment.
+		# @return [Resolver] if there were custom logging levels, then the created resolver is returned.
 		def default_resolver(logger, env = ENV)
-			if names = env['CONSOLE_DEBUG']&.split(',')
+			# find all CONSOLE_<LEVEL> variables from environment
+			levels = Logger::LEVELS
+			.map { |label, level| [level, env["CONSOLE_#{label.to_s.upcase}"]&.split(',')] }
+			.to_h
+			.compact
+
+			# 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
-				
-				resolver.bind(names) do |klass|
-					logger.enable(klass, Logger::DEBUG)
+				levels.each do |level, names|
+					resolver.bind(names) do |klass|
+						logger.enable(klass, level)
+					end
 				end
-				
 				return resolver
 			end
 		end

data/lib/console/event.rb

@@ -20,3 +20,4 @@
 
 require_relative 'event/spawn'
 require_relative 'event/failure'
+require_relative 'event/progress'

data/lib/console/event/progress.rb

@@ -0,0 +1,75 @@
+# 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
+	module Event
+		class Progress < Generic
+			BLOCK = [
+				" ",
+				"▏",
+				"▎",
+				"▍",
+				"▌",
+				"▋",
+				"▊",
+				"▉",
+				"█",
+			]
+			
+			def initialize(current, total)
+				@current = current
+				@total = total
+			end
+			
+			attr :current
+			attr :total
+			
+			def value
+				@current.to_f / @total.to_f
+			end
+			
+			def bar(value = self.value, width = 70)
+				blocks = width * value
+				full_blocks = blocks.floor
+				partial_block = ((blocks - full_blocks) * BLOCK.size).floor
+				
+				if partial_block.zero?
+					BLOCK.last * full_blocks
+				else
+					"#{BLOCK.last * full_blocks}#{BLOCK[partial_block]}"
+				end.ljust(width)
+			end
+			
+			def self.register(terminal)
+				terminal[:progress_bar] ||= terminal.style(:blue, :white)
+			end
+			
+			def as_json
+				{current: @current, total: @total}
+			end
+			
+			def format(output, terminal, verbose)
+				output.puts "#{terminal[:progress_bar]}#{self.bar}#{terminal.reset} #{sprintf('%6.2f', self.value * 100)}%"
+			end
+		end
+	end
+end

data/lib/console/logger.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'filter'
+require_relative 'measure'
 
 module Console
 	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
@@ -27,5 +28,9 @@ module Console
 		def initialize(output, **options)
 			super(output, **options)
 		end
+		
+		def measure(subject, total)
+			Measure.new(self, subject, total)
+		end
 	end
 end

data/lib/console/measure.rb

@@ -0,0 +1,115 @@
+# 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 Measure
+		def initialize(output, subject, total = 0)
+			@output = output
+			@subject = subject
+			
+			@start_time = Time.now
+			
+			@current = 0
+			@total = total
+		end
+		
+		attr :subject
+		
+		attr :current
+		
+		attr :total
+		
+		def duration
+			Time.now - @start_time
+		end
+		
+		def progress
+			@current.to_f / @total.to_f
+		end
+		
+		def remaining
+			@total - @current
+		end
+		
+		def average_duration
+			if @current > 0
+				duration / @current
+			end
+		end
+		
+		def estimated_remaining_time
+			if average_duration = self.average_duration
+				average_duration * remaining
+			end
+		end
+		
+		def increment(amount = 1)
+			@current += amount
+			
+			@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+			
+			return self
+		end
+		
+		def resize(total)
+			@total = total
+			
+			@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+			
+			return self
+		end
+		
+		def mark(*arguments)
+			@output.info(@subject, *arguments)
+		end
+		
+		def to_s
+			if estimated_remaining_time = self.estimated_remaining_time
+				"#{@current}/#{@total} completed in #{self.formatted_duration self.duration}, #{self.formatted_duration estimated_remaining_time} remaining."
+			else
+				"#{@current}/#{@total} completed, waiting for estimate..."
+			end
+		end
+		
+		private
+		
+		def formatted_duration(duration)
+			if duration < 60.0
+				return "#{duration.round(2)}s"
+			end
+			
+			duration /= 60.0
+			
+			if duration < 60.0
+				return "#{duration.round}m"
+			end
+			
+			duration /= 60.0
+			
+			if duration < 60.0
+				return "#{duration.round(1)}h"
+			end
+			
+			duration /= 24.0
+			
+			return "#{duration.round(1)}d"
+		end
+	end
+end

data/lib/console/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,31 +80,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
 - bake/console.rb
-- console.gemspec
 - lib/console.rb
 - lib/console/buffer.rb
 - lib/console/capture.rb
 - lib/console/event.rb
 - lib/console/event/failure.rb
 - lib/console/event/generic.rb
+- lib/console/event/progress.rb
 - lib/console/event/spawn.rb
 - lib/console/filter.rb
 - lib/console/logger.rb
+- lib/console/measure.rb
 - lib/console/resolver.rb
 - lib/console/serialized/logger.rb
 - lib/console/split.rb
@@ -113,12 +106,11 @@ files:
 - lib/console/terminal/text.rb
 - lib/console/terminal/xterm.rb
 - lib/console/version.rb
-- proposal.md
 homepage: https://github.com/socketry/console
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -134,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Beautiful logging for Ruby.
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-Gemfile.lock
-.rspec_status
-.covered.db

data/.rspec

@@ -1,4 +0,0 @@
---format documentation
---color
---require spec_helper
---warnings

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: truffleruby
-    - rvm: jruby-head
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: truffleruby
-    - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in console.gemspec
-gemspec
-
-gem "pry"

data/README.md

@@ -1,212 +0,0 @@
-# Console
-
-Provides beautiful console logging for Ruby applications. Implements fast, buffered log output.
-
-[![Build Status](https://travis-ci.com/socketry/console.svg)](http://travis-ci.com/socketry/console)
-[![Coverage Status](https://coveralls.io/repos/socketry/console/badge.svg)](https://coveralls.io/r/socketry/console)
-
-## Motivation
-
-When Ruby decided to reverse the order of exception backtraces, I finally gave up using the built in logging and decided restore sanity to the output of my programs once and for all!
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'console'
-```
-
-And then execute:
-
-	$ bundle
-
-## Usage
-
-As your code executes, it generates interesting events which you want to know about. The general approach is to use an `Console::Logger` which outputs text to the terminal. The text is generated by inspecting the console that occurred.
-
-Capturing structured information allows it to be used in different ways. These events can be sent to a logger or some other system (e.g. web browser, syslog) and analysed in more detail.
-
-### Default Logger
-
-Generally speaking, use `Console.logger` which is suitable for logging to the user's terminal.
-
-### Environment Variables
-
-#### `CONSOLE_LEVEL=debug`
-
-Control the default logger level. You can set it to any of the supported log levels: `debug`, `info`, `warn`, `error`, `fatal`.
-
-#### `CONSOLE_DEBUG=MyClass,MyModule::MyClass`
-
-Enable debug logging for the specified class names. You can specify one or more class names which will be resolved at runtime.
-
-### Module Integration
-
-```ruby
-require 'console'
-
-# Set the log level:
-Console.logger.debug!
-
-module MyModule
-	extend Console
-	
-	def self.test_logger
-		logger.debug "GOTO LINE 1."
-		logger.info "5 things your doctor won't tell you!"
-		logger.warn "Something didn't work as expected!"
-		logger.error "The matrix has two cats!"
-	end
-	
-	test_logger
-end
-```
-
-### Class Integration
-
-```ruby
-require 'console'
-
-# Set the log level:
-Console.logger.debug!
-
-class MyObject
-	include Console
-
-	def test_logger
-		logger.debug "GOTO LINE 1."
-		logger.info "5 things your doctor won't tell you!"
-		logger.warn "Something didn't work as expected!"
-		logger.error "The matrix has two cats!"
-	end
-end
-
-MyObject.new.test_logger
-```
-
-### Subject Logging
-
-The first argument to the log method is the subject.
-
-```ruby
-class Thing
-	def call
-		Console.logger.info(self) {"Something is going on"}
-	end
-end
-```
-
-Using this approach, you can turn on and off specific subjects by using the class name:
-
-```ruby
-$ CONSOLE_DEBUG=Thing ./script.rb
-```
-
-This will conditionally enable all log statements which have a subject of class `Thing`.
-
-### Console Formatting
-
-Console classes are used to wrap data which can generate structured log messages:
-
-```ruby
-require 'console'
-
-class MyConsole < Console::Generic
-	def format(output, terminal, verbose)
-		output.puts "My console text!"
-	end
-end
-
-Console.logger.info("My Console", MyConsole.new)
-```
-
-#### Failure Events
-
-`Console::Event::Failure` represents an exception and will log the message and backtrace recursively.
-
-#### Spawn Events
-
-`Console::Event::Spawn` represents the execution of a command, and will log the environment, arguments and options used to execute it.
-
-### Custom Log Levels
-
-`Console::Filter` implements support for multiple log levels.
-
-```ruby
-require 'console'
-
-MyLogger = Console::Filter[noise: 0, stuff: 1, broken: 2]
-
-# verbose: true - log severity/name/pid etc.
-logger = MyLogger.new(Console.logger, name: "Java", verbose: true)
-
-logger.broken("It's so janky.")
-```
-
-### Multiple Outputs
-
-Use `Console::Split` to log to multiple destinations.
-
-```ruby
-require 'console/terminal'
-require 'console/serialized/logger'
-require 'console/logger'
-require 'console/split'
-
-terminal = Console::Terminal::Logger.new
-file = Console::Serialized::Logger.new(File.open("log.json", "a"))
-
-logger = Console::Logger.new(Console::Split[terminal, file])
-
-logger.info "I can go everywhere!"
-```
-
-### Custom Logger Output
-
-`Console::Logger` provides a default interface which is a drop in replacemnet for `Logger` and other similar implementations. The only method required for output is `#call(*arguments, **options, &block)`.
-
-```ruby
-require 'console/logger'
-
-output = proc do |*arguments, **options, &block|
-	puts "arguments: #{arguments.inspect} options: #{options.inspect} block: #{block.call}"
-end
-
-logger = Console::Logger.new(output)
-
-logger.info("Hello World!", meta: "data") {"block"}
-# => arguments: ["Hello World!"] options: {:severity=>:info, :meta=>"data"} block: block
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2019, by [Samuel Williams](https://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.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/console.gemspec

@@ -1,27 +0,0 @@
-
-require_relative "lib/console/version"
-
-Gem::Specification.new do |spec|
-	spec.name = "console"
-	spec.version = Console::VERSION
-	spec.licenses = ["MIT"]
-	spec.authors = ["Samuel Williams"]
-	spec.email = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary = "Beautiful logging for Ruby."
-	spec.homepage = "https://github.com/socketry/console"
-	
-	spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-	end
-	
-	spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.require_paths = ["lib"]
-	
-	spec.add_development_dependency "bake"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rake", "~> 10.0"
-	spec.add_development_dependency "rspec", "~> 3.0"
-end

data/proposal.md

@@ -1,84 +0,0 @@
-# Global Logger
-
-Configure what logging looks like globally:
-
-```ruby
-Console.logger
-```
-
-Other logger instances would inherit their initial configuration from the global logger.
-
-Rather than the output being configurable on the global logger, it would always route to `$stdout`. _Or perhaps no destinations should exist and you add one; there must be a way to attach a formatter to even the default destination._
-
-# Adding Destinations
-
-The global logger or any instance could log to multiple destinations:
-
-```ruby
-Console.add(some_io, formatter: some_formatter)
-```
-
-I _think_ that formatters would be defined on destinations. This would allow for writing in one format to `$stdout` and another to `syslog`, for example.
-
-# Logger Instances
-
-Named instances could be created with a given output:
-
-```ruby
-connection_logger = Console.new(:connection, output: ...)
-```
-
-Outputs would not reference an io object, but rather another named instance (defaulting to global). Again, Destinations + Formatters could be added to any instance. This would allow outputs to be chained.
-
-## Instances As Subjects
-
-Perhaps an interesting idea is letting logger instance names be subjects, controllable from the global logger. In the example above, `:connection` would become a known subject that could be enabled/disabled from the global logger:
-
-```ruby
-Console.disable(:connection)
-```
-
-This lets us very easily disable the logging of events of a particular type.
-
----
-
-In [Pakyow's logger](https://gist.github.com/bryanp/0329d58c753f1fa6e99d970960ad006d#file-logger-rb), instances are created in these cases:
-
-* Environment: Single logger for the environment, named `:pkyw`.
-* Connection: Per-Request logger containing the connection id, named `:http`.
-* WebSocket: Per-WebSocket logger containing the WebSocket id, named `:sock`.
-* Async: The logger that async is configured with, named `:asnc`.
-
-Instances could be initialized with metadata that is passed with the console to the formatter:
-
-```ruby
-connection_logger = Console.new(:http, output: ..., connection_id: "123")
-```
-
-# Formatters
-
-Just a class with a `format` method that accepts an `console`, which is a hash or simple object containing the console data along with attached metadata (e.g. timestamp, metadata from the instance). Returns a string, and/or writes directly to the buffer.
-
-# Custom Levels
-
-Pakyow's logger uses the following levels:
-
-* all
-* verbose
-* debug
-* info
-* warn
-* error
-* fatal
-* unknown
-* off
-
-`all` and `off` aren't turned into logging methods in `Pakyow::Logger`, but rather the log level can be set to either one as an easy way to guarantee that all or no logs will be written, without knowing what the lowest and highest level of logging are in the system.
-
-Projects often have different needs, so making this easily configurable on both the global logger and individual logger instances would be amazing:
-
-```ruby
-Console.levels(
-  %i(all verbose debug info warn error fatal unknown off)
-)
-```