ansi_text_styles 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aed6d3739fa4c771809a72dec79d896a93dd405c
-  data.tar.gz: 5665e88349cc2b1ad2e372faea083034fa10e49e
+  metadata.gz: ce57a08a3632e003a946d04b3356266a149a501c
+  data.tar.gz: 2efe703e32a6aa8f9637574bbed7003e05ad702e
 SHA512:
-  metadata.gz: 110e80f80b2d9d54b9521ad8d2d4e762b9ba3a943eb820dc8368c1e75e4b51817e5035c91e1029d1e259a019732e753da77346a9926d97ae0d41b07ba11166fc
-  data.tar.gz: 925fe64c3795c2aea5f4f5bbbf7e82a2e8bb950548e0430a19bf5ebd03104ead8b2c56ba777b1ae81f7969ea5b6389276cbaaff2fce988093be5a42ac8a0d2a6
+  metadata.gz: 3a89e30934e52f48c3556f6b77b6c8b89b8218016f503d05b9e7b05b88284eca089b1375b49ef2feebecc86c32c32845ba57c9b72aa53e65189dee4501f576a4
+  data.tar.gz: 3cdac58a6cedadc16859b9cc7acc3bb134bc550058b967faf59da58950c8489ab4e1ff17e927fa457e5e522238dfde86c4d1c98d6e0b398bcfebd7a8f53ca740

data/lib/ansi_text_styles/examples/8_bit_colour.rb

@@ -0,0 +1,43 @@
+require 'ansi_text_styles'
+
+using AnsiTextStyles::Refinement
+
+puts
+puts "Standard and high intensity colours"
+puts
+
+# Standard and high intensity colours
+(0..15).each do |fg|
+  row = (0..15).collect do |bg|
+    'xxx'.center(5).style(fg: fg, bg: bg)
+  end
+  puts row.join
+end
+
+puts
+puts "216 colours"
+puts
+
+# 216 colours
+colours = (16..231).collect do |bg|
+  fg = (bg - 16) % 36 < 18 ? 15 : 0
+  bg.to_s.center(5).style(fg: fg, bg: bg)
+end
+
+colours.each_slice(36).collect do |row|
+  puts row.join
+end
+
+puts
+puts "Greyscale colours"
+puts
+
+# Greyscale colours
+colours = (232..255).collect do |bg|
+  fg = (bg - 16) % 24 < 12 ? 15 : 0
+  bg.to_s.center(5).style(fg: fg, bg: bg)
+end
+
+colours.each_slice(12) do |row|
+  puts row.join
+end

data/lib/ansi_text_styles/examples/basic.rb

@@ -0,0 +1,6 @@
+require 'ansi_text_styles'
+
+using AnsiTextStyles
+
+puts "How are you?".style(:blue, :bold) + " " + 'I am good!'.style(:red, :bold)
+puts '%s %s' % ["How are you?".style(:blue, :bold), 'I am good!'.style(:red, :bold)]

data/lib/ansi_text_styles/examples/chainable.rb

@@ -0,0 +1,6 @@
+require 'ansi_text_styles'
+
+using AnsiTextStyles
+
+puts 'How are you?'.blue.bold + " " + 'I am good!'.red.bold
+puts '%s %s' % ["How are you?".blue.bold, 'I am good!'.red.bold]

data/lib/ansi_text_styles/examples/logger.rb

@@ -0,0 +1,24 @@
+require 'ansi_text_styles'
+
+class ColourLogger
+  using AnsiTextStyles
+
+  def self.status(text)
+  "[#{text}]".ljust(7)
+  end
+
+  def self.log_msg(status_text, message)
+  "%s %s" % [status(status_text), message]
+  end
+
+  def self.log_info(message)
+  log_msg('INFO'.green, message)
+  end
+
+  def self.log_error(message)
+  log_msg('ERROR'.red, message)
+  end
+end
+
+puts ColourLogger.log_info('a pretty colourised info message')
+puts ColourLogger.log_error('a pretty colourised error message')

data/lib/ansi_text_styles/examples/stored_styles.rb

@@ -0,0 +1,14 @@
+require 'ansi_text_styles'
+
+using AnsiTextStyles
+
+text_styles = {
+    red_bold:       [:red, :bold],
+    blue_underline: [:blue, :underline],
+    pretty:         [:bg_magenta, :blink],
+  }
+
+text_styles.each do |name, style|
+  styled_text = "Text styled multiple ways".style(style)
+  puts "%s: %s" % [name, styled_text]
+end

data/lib/ansi_text_styles/examples/true_colour.rb

@@ -0,0 +1,14 @@
+require 'ansi_text_styles'
+
+using AnsiTextStyles::Refinement
+
+# String.include AnsiTextStyles
+puts 'Foreground using RGB array'.style(fg: [123, 6, 88])
+puts 'Foreground using RGB hash'.style(fg: { r: 5, g: 67, b: 145})
+
+puts 'Background using RGB array'.style(bg: [6, 200, 56])
+puts 'Background using RGB hash'.style(bg: { red: 56, green: 99, blue: 240})
+
+
+puts 'Foreground and Background using RGB array'.style(fg: [250, 200, 4], bg: [6, 7, 245])
+puts 'Foreground and Background using RGB hash'.style(fg: { red: 70, green: 222, blue: 9}, bg: { r: 200, g: 8, b: 0})

data/lib/ansi_text_styles.rb

@@ -1,17 +1,21 @@
 module AnsiTextStyles
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   STYLES = {
       # text properties
       none: 0, # turn off all attributes
-      bold: 1, bright: 1, # these do the same thing really
-      italic: 3, underline: 4, blink: 5,
+      bold: 1, bright: 1, # bold or increased intensity
+      faint: 2, # decreased intensity
+      italic: 3, underline: 4,
+      blink: 5, blink_slow: 5, # slow blink
+      blink_fast: 6, # fast blink
       reverse: 7, # swap foreground and background colours
       hide: 8, # foreground color same as background
+      crossed_out: 9,
 
       # foreground colours
-      black: 30, grey: 90, lt_grey: 37, :white => 97,
+      black: 30, grey: 90, lt_grey: 37, white: 97,
       red: 31, lt_red: 91, 
       green: 32, lt_green: 92,
       dk_yellow: 33, brown: 33, yellow: 93,
@@ -19,6 +23,7 @@ module AnsiTextStyles
       magenta: 35, pink: 95, lt_magenta: 95,
       cyan: 36, lt_cyan: 96,
       default: 39,
+      default_fg: 39,
       
       # background colours
       bg_black: 40, bg_grey: 100, bg_lt_grey: 47, bg_white: 107,
@@ -28,6 +33,7 @@ module AnsiTextStyles
       bg_blue: 44, bg_lt_blue: 104,
       bg_magenta: 45, bg_pink: 105, bg_lt_magenta: 105,
       bg_cyan: 46, bg_lt_cyan: 106,
+      default_bg: 49,
     }
 
   def self.styles
@@ -35,10 +41,29 @@ module AnsiTextStyles
   end
 
   refine String do
-    # applies the text attributes to the current string
-    def style(*styles)
+    def style_code(*codes)
+      "\e[%sm%s\e[m" % [codes.flatten.compact.join(';'), self.to_s]
+    end
+
+    # applies the named style to the current string
+    def style(*styles, fg: nil, bg: nil)
+      # convert styles to codes
       codes = STYLES.values_at(*styles.flatten).compact
-      "\e[%sm%s\e[m" % [codes.join(';'), self.to_s]
+
+      # convert foreground and background codes
+      codes.push(*coerce_rgb_code(fg))
+      codes.push(*coerce_rgb_code(bg, bg: true))
+
+      style_code(codes)
+    end
+
+    def coerce_rgb_code(value, bg: false)
+      v = bg ? 48 : 38
+      case value
+      when Array   ; [v, 2, *Array.new(3) {|i| value[i] || 0 }[0...3]]
+      when Hash    ; [v, 2, value[:r] || value[:red] || 0, value[:g] || value[:green] || 0, value[:b] || value[:blue] || 0]
+      when Integer ; [v, 5, value]
+      end
     end
 
     # create instance methods for each text attribute (chainable)
@@ -48,4 +73,3 @@ module AnsiTextStyles
   end
 
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ansi_text_styles
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brent Jacobs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-10-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -18,6 +18,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ansi_text_styles.rb
+- lib/ansi_text_styles/examples/8_bit_colour.rb
+- lib/ansi_text_styles/examples/basic.rb
+- lib/ansi_text_styles/examples/chainable.rb
+- lib/ansi_text_styles/examples/logger.rb
+- lib/ansi_text_styles/examples/stored_styles.rb
+- lib/ansi_text_styles/examples/true_colour.rb
 homepage: https://github.com/br3nt/ansi_text_styles
 licenses:
 - MIT
@@ -38,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Adds methods to apply ANSI colour codes and text styles to strings.