colsole 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6de4cbd3ede2c98135cbe010b74a600f8dc5e85
-  data.tar.gz: 1982bb0999e283100ad40997c096331e6005ee16
+  metadata.gz: 6635dbbf550e4f14b3fce39cdd3bf9ef110f1195
+  data.tar.gz: 8957b89565d28da19efa69a56ec3b76cd5d77b55
 SHA512:
-  metadata.gz: b066d600d0d33f8ad0114ce350cf401a5f86d45bb6ac78fa734269a49a70d4823bb914692edbfca6ab895de4ea69dac271654a7adb623434b3e130d9f4bb1807
-  data.tar.gz: 18544d16a2ed90c759003b22b38083a744b69117e6fc4305734147dd14c5262a3ca6f4d699fb49390ee7d9ca5ad3569f3b7cef1ec14a28fde802796712c9c2ab
+  metadata.gz: 0e8d462f68985228c5aac42bba50f76fadcfcc3a064aa44f39dfe560509e5b4b03caacc8bcc01d1ab4a2167d90fb22b56ac482d6a9910decb65f847da2ec2784
+  data.tar.gz: 4438c599dd9bd5e716b943e43f1d89bad00e9470006c735b17008a545928129f1173a4da0f4851f71822cd9756ecbdc069c0f50b2e4c81c2ad73c6c8b36cb302

data/README.md

@@ -6,9 +6,13 @@ Colsole
 [![Code Climate](https://codeclimate.com/github/DannyBen/colsole/badges/gpa.svg)](https://codeclimate.com/github/DannyBen/colsole)
 [![Gem](https://img.shields.io/gem/dt/colsole.svg)](https://rubygems.org/gems/colsole)
 
+---
 
 Utility functions for colorful console applications.
 
+---
+
+
 Install
 --------------------------------------------------
 
@@ -16,6 +20,16 @@ Install
 $ gem install colsole
 ```
 
+Features
+--------------------------------------------------
+
+- Print colored messages 
+- Color parts of a message
+- Print neatly aligned status messages
+- Word wrap with indentation consideration
+
+See the [Examples file][1] for more.
+
 Primary Functions
 --------------------------------------------------
 
@@ -40,6 +54,20 @@ Embed color markers in the string:
 say "!txtred!I am RED !txtgrn!I am GREEN"
 ```
 
+### `say_status :status, "message" [, :color]`
+
+Print a message with a colored status
+
+```ruby
+say_status :create, "perpetual energy"
+```
+
+You can provide a color in the regulat 6 letter code:
+
+```ruby
+say_status :error, "does not compute", :txtred
+```
+
 ### `word_wrap "   string"`
 
 Wrap long lines while keeping words intact, and keeping 
@@ -84,7 +112,6 @@ Parses and returns a color-flagged string.
 Respects pipe and auto terminates colored strings.
 	
 Call without text to see a list/demo of all available colors.
-	
 
 ### `terminal?`
 
@@ -99,3 +126,11 @@ Checks if the provided string is a command in the path.
 Returns an array [width, height] of the terminal, or the supplied 
 `fallback_value` if it is unable to detect.
 
+
+Color Codes
+--------------------------------------------------
+
+[![Color Codes](https://raw.githubusercontent.com/DannyBen/colsole/master/color-codes.png)](https://raw.githubusercontent.com/DannyBen/colsole/master/color-codes.png)
+
+
+[1]: https://github.com/DannyBen/colsole/blob/master/example.rb

data/lib/colsole.rb

@@ -2,13 +2,14 @@ require "colsole/version"
 
 # Colsole - Colorful Console Applications
 #
-# This class provides several utility functions for console 
-# appliucation developers.
+# This class provides several utility functions for console application 
+# developers.
 #
 # - #colorize string - return a colorized strings
 # - #say string - print a string with colors  
 # - #say! string - print a string with colors to stderr
 # - #resay string - same as say, but overwrite current line  
+# - #say_status symbol, string [, color] - print a message with status
 # - #word_wrap string - wrap a string and maintain indentation
 # - #detect_terminal_size
 #
@@ -41,6 +42,13 @@ module Colsole
     say text, force_color
   end
 
+  # Prints a line with a colored status and message.
+  # Status can be a symbol or a string. Color is optional, defaulted to
+  # green (:txtgrn).
+  def say_status(status, message, color=:txtgrn)
+    say "!#{color}!#{status.to_s.rjust 12} !txtrst! #{message}"
+  end
+
   # Returns true if stdout/stderr is interactive terminal
   def terminal?(stream=:stdout)
     stream == :stdout ? out_terminal? : err_terminal?
@@ -88,8 +96,6 @@ module Colsole
   # Respects pipe and auto terminates colored strings.
   # Call without text to see a list/demo of all available colors.
   def colorize(text=nil, force_color=false, stream=:stdout) 
-    colors = prepare_colors
-
     if text.nil? # Demo
       i=33;
       colors.each do |k,v| 
@@ -117,7 +123,11 @@ module Colsole
 
   private 
 
-  # Create a colors array with keys such as :green and :bld_green
+  def colors
+    @colors ||= prepare_colors
+  end
+
+  # Create a colors array with keys such as :txtgrn and :bldgrn
   # and values which are the escape codes for the colors.
   def prepare_colors
     esc = 27.chr
@@ -141,4 +151,4 @@ module Colsole
   end
 end
 
-self.extend Colsole
+self.extend Colsole

data/lib/colsole/version.rb

@@ -1,3 +1,3 @@
 module Colsole
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colsole
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile