console 0.5 → 1.0.0

data/lib/console/terminal/text.rb

@@ -0,0 +1,67 @@
+# 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 'io/console'
+
+module Console
+	# Styled terminal output.
+	module Terminal
+		class Text
+			def initialize(output)
+				@output = output
+				@styles = {}
+			end
+			
+			def [] key
+				@styles[key]
+			end
+			
+			def []= key, value
+				@styles[key] = value
+			end
+			
+			def style(foreground, background = nil, *attributes)
+			end
+			
+			def reset
+			end
+			
+			def write(*args, style: nil)
+				if style and prefix = self[style]
+					@output.write(prefix)
+					@output.write(*args)
+					@output.write(self.reset)
+				else
+					@output.write(*args)
+				end
+			end
+			
+			def puts(*args, style: nil)
+				if style and prefix = self[style]
+					@output.write(prefix)
+					@output.puts(*args)
+					@output.write(self.reset)
+				else
+					@output.puts(*args)
+				end
+			end
+		end
+	end
+end

data/lib/console/terminal/xterm.rb

@@ -0,0 +1,80 @@
+# 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 'io/console'
+
+require_relative 'text'
+
+module Console
+	# Styled terminal output.
+	module Terminal
+		class XTerm < Text
+			COLORS = {
+				black: 0,
+				red: 1,
+				green: 2,
+				yellow: 3,
+				blue: 4,
+				magenta: 5,
+				cyan: 6,
+				white: 7,
+				default: 9,
+			}
+			
+			ATTRIBUTES = {
+				normal: 0,
+				bold: 1,
+				bright: 1,
+				faint: 2,
+				italic: 3,
+				underline: 4,
+				blink: 5,
+				reverse: 7,
+				hidden: 8,
+			}
+			
+			def size
+				@output.winsize
+			end
+			
+			def style(foreground, background = nil, *attributes)
+				tokens = []
+				
+				if foreground
+					tokens << 30 + COLORS.fetch(foreground)
+				end
+				
+				if background
+					tokens << 40 + COLORS.fetch(background)
+				end
+				
+				attributes.each do |attribute|
+					tokens << ATTRIBUTES.fetch(attribute){attribute.to_i}
+				end
+				
+				return "\e[#{tokens.join(';')}m"
+			end
+			
+			def reset
+				"\e[0m"
+			end
+		end
+	end
+end

data/lib/console/version.rb

@@ -0,0 +1,23 @@
+# 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
+	VERSION = "1.0.0"
+end

data/proposal.md

@@ -0,0 +1,84 @@
+# 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)
+)
+```

metadata

@@ -1,72 +1,121 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: console
-version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: 
-  segments: 
-  - 0
-  - 5
-  version: "0.5"
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
-- William Morgan
+authors:
+- Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-27 20:12:30 -07:00
-default_executable: 
-dependencies: []
-
-description: Console is a helper class for displaying super-ASCII strings on the console. Console is needed when you want to mix two-column (e.g. Chinese) and single-column (e.g. ASCII) characters and know how much horizontal realestate the result takes on the screen. This is generally necessary when you want to have internationalization support in a console-based program. Console currently provides utility methods for determining the display width of a string, and for taking a substring based on display position and display width.
-email: wmorgan-console@masanjin.net
+date: 2019-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
 executables: []
-
-extensions: 
-- ext/console/extconf.rb
-extra_rdoc_files: 
-- README
-- ext/console/console.c
-files: 
-- README
-- ext/console/extconf.rb
-- ext/console/console.c
-- test/console.rb
-- lib/console/string.rb
-has_rdoc: true
-homepage: http://masanjin.net/console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- console.gemspec
+- lib/console.rb
+- lib/console/buffer.rb
+- lib/console/capture.rb
+- lib/console/error.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
+- lib/console/terminal/text.rb
+- lib/console/terminal/xterm.rb
+- lib/console/version.rb
+- proposal.md
+homepage: https://github.com/socketry/console
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- -c
-- utf8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 3.0.2
 signing_key: 
-specification_version: 3
-summary: Console is a helper for properly handling super-ASCII strings on the console.
+specification_version: 4
+summary: Beautiful logging for Ruby.
 test_files: []
-

data/README

@@ -1,51 +0,0 @@
-Console is a helper class for displaying super-ASCII strings on the console.
-
-Console is necessary when you want to mix multi-column (e.g.  Chinese, Japanese
-and Korean characters) and single-column (e.g. ASCII, Latin, Vietnamese)
-characters on screen in such a way that the display width matters. This is
-typically the case in curses programs with i18n support, but can be necessary
-in certain internationalized $stdout applications as well.
-
-Note that display width is different from a) the number of bytes in the string,
-and b) the number of characters in the string. When you move beyond ASCII
-strings, these three metrics can all have distinct values for a given string.
-
-The Console gem currently provides these methods:
-
-- Console.init_locale!: set the program's locale from the appropriate
-  environment variables. (Ruby 1.8 programs must call this before calling any
-  of the other methods. Ruby 1.9 programs can call it or skip it without
-  effect.)
-- Console.display_width: calculates the display width of a string
-- Console.display_slice: returns a substring according to display offset
-  and display width parameters.
-
-If you require 'console', you will get just those methods.
-
-If you require 'console/string', you will get String#display_width and
-String#display_slice methods directly on all strings.
-
-= EXAMPLE USAGE
-
-  ## encoding: UTF-8 (this comment required for ruby 1.9)
-  require 'rubygems' # this line required for ruby 1.8
-  require 'console'
-  require 'console/string'
-
-  Console.init_locale!
-
-  STRING = "我能吞下玻璃而不傷身體。Góa ē-tàng chia̍h po-lê, mā bē tio̍h-siong.私はガラスを食べられます。それは私を傷つけません。I can eat glass and it doesn't hurt me."
-  COLS = 30
-
-  rows = STRING.display_width / COLS
-  (0 .. rows).each { |i| puts STRING.display_slice(i * COLS, COLS) }
-
-The result will be displayed in an even 30-column block on the console, even
-though some characters in the string require two columns to display and some
-characters require one column.
-
-= MORE
-
-The console homepage is <code>http://masanjin.net/console/</code>.
-The console git repo is <code>git://masanjin.net/console</code>.
-