ansi_sgr_to_html 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODcxYmU1NDNiN2FjNjRlM2QxNDNiYjc4NWFmYzU5MGRlZWIyNmE4NA==
+  data.tar.gz: !binary |-
+    Y2Y0N2JlMDI4NTliNjNlZDBhNGQwNjRhYWIyOWQxNDdhNmVhY2MzMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NDcxM2Y0ODk1ODczMmIzNTNjMmIzYjIxMzc4NDNhYjg1ZWU5MjFiNjY3OGJh
+    MjFlNWJiMDc0N2EyODQ1NzVkYTg4NTM1OGJkOGFkOTY2ZWJjNTUwYTkyMjlh
+    NTliZjc1MDNmYTczNmE2ZmU1NmUzYjk5ZmRkMzRhYjE1MTE3ZDk=
+  data.tar.gz: !binary |-
+    OGE4MTZiNzM0Y2MxOTgxMjRhYjZhZWE0NjNhNzI0YmMyZTFhMGM0NWYyYzJl
+    ODZhZDdkOGVjNjliOGUzNjM1MTBjZGU0ZGNjZGEwMGM2YmE4YWU5N2M1OWZi
+    NjMwYjU5YWQ2NWQ2NGYzMGJhMjkxYWQzZWYxMjQ5Y2EwZWI1MDM=

data/lib/ansi_sgr_to_html.rb

@@ -1,5 +1,20 @@
 # This is generated by ragel - write me a mail if you are interested in the main source.
 # Its not included, currently, as I dont want the gem to depend on ragel, for installation.
+
+# =ANSI SGR code to HTML converter
+# This gem converts text with ANSI SGR codes to HTML. SGR? Yes, fonts, bold, colors, etc. are ANSI SGR sequences, other ANSI escape codes are not supported.
+# In other words, the only codes that actually make sense to convert are supported, as moving the cursor would not be convertible.
+# ==Overview
+# - supports all standardized SGR codes except ideograms or codes 50-59
+#   * this means it supports alternative fonts (user specified)
+#   * blink codes supported! Slow and fast!
+#   * full support for all SGR color codes, meaning 4bit, 8bit and 24bit colors, for both, foreground and background (most other gems do not, especially not 24bit colors)
+# - supports sequences of SGR codes separated by ';' (some other gems do not)
+# - configurable options by user
+#   * custom set all 10 alternative fonts (default: all inherit default font)
+#   * is bold only bold, or also bright (default: both)
+#   * fully user defineable basic 16 color tables, or pick from preset (default: xterm)
+# - flat output, no nested spans like some other gems (smaller output than most other gems)
 class ANSI_SGR_To_HTML
 	@@HTML_escapes = {'&'=>'&amp;','"'=>'&quot;','<'=>'&lt;','>'=>'&gt;',"\r"=>"\r","\n"=>"\n"} # newlines controlled by option
 	@@Col_tab_256 = [
@@ -43,7 +58,18 @@ class ANSI_SGR_To_HTML
 		:osx_term => ['000000', 'C23621', '25BC24', 'ADAD27', '492EE1', 'D338D3', '33BBC8', 'CBCCCD', '818383', 'FC391F', '31E722', 'EAEC23', '5833FF', 'F935F8', '14F0F0', 'E9EBEB']
 	}
 	@@CSS_blink_keyframes = '<style>@keyframes term_blink { 0%,50% { opacity: 1; } 51%,100% { opacity: 0; } }</style>'
-	def initialize(font_styles = [nil]*10, k_21_is_double_underline = true, k_1_is_bold_and_bright = true, k_turn_eol_into_br = false, col_tab_16 = :xterm)
+	# Create new instance of converter
+	# 
+	# ======Example
+	#   >> ANSI_SGR_To_HTML.new(false, :osx_term, ['serif','Courier New']+[nil]*7+['Fraktur'], true, true)
+	# 
+	# ======Arguments
+	# [k_turn_eol_into_br] pass true if converter should turn newlines into <br/> on the fly (redundant if output is wrapped in <pre>)
+	# [col_tab_16] specify either array with 16 css colors (first 8 are low, last 8 are bright colors), or preset name (:xterm, :osx_term, :cmd, :vga)
+	# [font_styles] Array with ten font-names (or nil, to use default), to be used for SGR codes 11-20
+	# [k_1_is_bold_and_bright] true renders bold text (SGR code 1) also in bright colors (if color is from basic 16-color table)
+	# [k_21_is_double_underline] specify, whether SGR code 21 disables bold text, or enable double-underline
+	def initialize(k_turn_eol_into_br = false, col_tab_16 = :xterm, font_styles = [nil]*10, k_1_is_bold_and_bright = true, k_21_is_double_underline = true)
 		@k_21_is_double_underline = k_21_is_double_underline;
 		@k_1_is_bold_and_bright   = k_1_is_bold_and_bright;
 		@k_turn_eol_into_br       = k_turn_eol_into_br;
@@ -244,6 +270,11 @@ class << self
 end
 self.ansi_sgr_to_html_en_main = 43;
 	end
+	# Convert string
+	# 
+	# ======Arguments:
+	# [i] Input (string at the moment, future versions are planned to accept streams)
+	# [o] Output, anything with << to append to (e.g. String, $stdout, etc.) or nil to get a string returned after complete conversion
 	def convert(i, o=nil) # i is string, o can be anything with <<
 		o = '' unless o
 begin

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansi_sgr_to_html
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Tassilo Philipp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies: []
 description: Converter for complete ANSI SGR codes to HTML. Similar to ansitags gem,
   but smaller output (no nested spans), faster (converts everything in one pass),
@@ -25,26 +24,25 @@ files:
 homepage: 
 licenses:
 - ISC
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.30
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Converts strings with ANSI SGR codes to HTML
 test_files: []