colsole 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651768cb78375a765cc5913f545c5e133fb95ad7515bfdc95fffb14de74038e
-  data.tar.gz: 3406291b87c5ca7797f1f65729a37d7e371034ba39be79f831d811eb39003508
+  metadata.gz: 277f45ee7c12e0c6090bd41752a275feef3357c38a1d3cbca522f9089ce68d49
+  data.tar.gz: f21a9866ce164222627f314c4ffe0c16046d705f5d544783b1d5f3598a54cf18
 SHA512:
-  metadata.gz: 60fa6abaa7b8565c39d53d8a706af951b19968c283250aeee53768f382c1b8aead7e0fb0a1f2c6d9a3190f941606dd99e9214de176bbcfe786d0d9f85c5b1ff0
-  data.tar.gz: 64cc7706ef686d49b77b5eb9b2e303db7550c9466d409149075588b3aeee932415967f6040a156ef81d463129a186b51aaa7da010408e712ddd79291f11eb463
+  metadata.gz: c74ab05a5fea57685109cbcf2bdc033e0b0ba7f191a5ea491e4d31a1bcee335718d7e74481a031b19e99203e14dd34646542985199a001d15c2dbfc0dd52a8da
+  data.tar.gz: af3bcd3c64f66cc5dd5a89c96f4e92946160082ea08e017e68c3eda311525c6de5688759bdfe858d084231dae835d4c091ed9ca6af225f640ef2803a61b0e4d9

data/README.md

@@ -9,10 +9,10 @@
 Utility functions for colorful console applications.
 
 > **Upgrade Note**
->
+> 
 > This README is for the latest version of colsole (0.8.x), which is compatible
 > with older versions. Version 1.x will NOT be compatible.
->
+> 
 > See [Uprading](#upgrading) below.
 
 ## Install
@@ -23,6 +23,21 @@ Add to your Gemfile:
 $ gem 'colsole', '>= 0.8.1', '< 2.0'
 ```
 
+## Usage
+
+```ruby
+require 'colsole'
+include Colsole
+say 'b`Blue` Man Group'
+```
+
+All the methods described below can also be called directly on the `Colsole` module. This is useful when you want to use it at the top level of your project, without namespace contamination:
+
+```ruby
+require 'colsole'
+Colsole.say 'b`Blue` Man Group'
+```
+
 ## Examples
 
 See the [Examples file](https://github.com/DannyBen/colsole/blob/master/example.rb).
@@ -60,7 +75,6 @@ say "downloading data... "
 say "download complete.", replace: true
 ```
 
-
 ### `word_wrap "   string" [, length]`
 
 Wrap long lines while keeping words intact, and keeping indentation based on the
@@ -111,7 +125,6 @@ fallback if it is unable to detect.
 Returns only the terminal width or height. This is a shortcut to 
 `terminal_size[0]` / terminal_size[1].
 
-
 ## Colors
 
 Strings that are surrounded by backticks, and preceded by a color code and
@@ -123,24 +136,24 @@ say "this is b`blue` and ru`this is red underlined`"
 
 The one letter color code is required, followed by up to 3 style code.
 
-| Color Code | Color
-|------------|-------
-| `n`        | no color
-| `k`        | black
-| `r`        | red
-| `g`        | green
-| `y`        | yellow
-| `b`        | blue
-| `m`        | magenta
-| `c`        | cyan
-| `w`        | white
-
-| Style Code | Style
-|------------|-------
-| `b`        | bold
-| `u`        | underlined
-| `i`        | inverted
-| `z`        | terminate
+| Color Code | Color    |
+| ---------- | -------- |
+| `n`        | no color |
+| `k`        | black    |
+| `r`        | red      |
+| `g`        | green    |
+| `y`        | yellow   |
+| `b`        | blue     |
+| `m`        | magenta  |
+| `c`        | cyan     |
+| `w`        | white    |
+
+| Style Code | Style      |
+| ---------- | ---------- |
+| `b`        | bold       |
+| `u`        | underlined |
+| `i`        | inverted   |
+| `z`        | terminate  |
 
 ## Upgrading
 
@@ -150,7 +163,6 @@ markers. For easy transition, it is compatible with older versions.
 Follow these steps to upgrade:
 
 ```ruby
-
 # => Require a more flexible version
 # change this
 gem 'colsole'

data/lib/colsole/compat.rb

@@ -2,6 +2,8 @@
 # for compatibility with older versions of colsole.
 # Do not use these methods directly.
 module Colsole
+module_function
+
   def detect_terminal_size(*args)
     terminal_size(*args)
   end

data/lib/colsole/version.rb

@@ -1,3 +1,3 @@
 module Colsole
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

data/lib/colsole.rb

@@ -22,6 +22,8 @@ module Colsole
     'z' => "\e[0m", # terminate
   }
 
+module_function
+
   # Output a string with optional color markers to stdout.
   # If text is ended with a white space, you can call again with replace: true
   # to replace that line
@@ -119,8 +121,6 @@ module Colsole
     process_color_markers(compat_string) { |_color, _styles, text| text }
   end
 
-private
-
   def process_color_markers(string)
     string.gsub(/([rgybmcn])([ubi]{0,3})`([^`]*)`/) do
       color = ANSI_COLORS[$1]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colsole
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies: []
 description: Utility functions for making colorful console applications
 email: db@dannyben.com
@@ -40,7 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Colorful Console Applications