colsole 0.8.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651768cb78375a765cc5913f545c5e133fb95ad7515bfdc95fffb14de74038e
-  data.tar.gz: 3406291b87c5ca7797f1f65729a37d7e371034ba39be79f831d811eb39003508
+  metadata.gz: 832d466f34ab604a7a9cc7b4e92b94aea79fc4fd52e6383c767bf17483be5d7b
+  data.tar.gz: ceb677bb2f0b6125e2f80717709bbb65d4c9b43bc9bf00d994f4c337a0317536
 SHA512:
-  metadata.gz: 60fa6abaa7b8565c39d53d8a706af951b19968c283250aeee53768f382c1b8aead7e0fb0a1f2c6d9a3190f941606dd99e9214de176bbcfe786d0d9f85c5b1ff0
-  data.tar.gz: 64cc7706ef686d49b77b5eb9b2e303db7550c9466d409149075588b3aeee932415967f6040a156ef81d463129a186b51aaa7da010408e712ddd79291f11eb463
+  metadata.gz: 5aa0974a9282c9c3140ae0e16e2b8dfaec4b846cea832a2c46f5d35cd5200ce76d93ebb3bad5f24e785489af1143b3da20acb4f9e8f09e2442b01c90a52fbe54
+  data.tar.gz: 957dc4bf62fd4fcecc0d11e7a2bee220b03e75d0283bdc6d123026fc117b305c2d36b66a9a83b81fbe5f44547aade7cd0ac6dd5cb45ea4bd221cb02c10a0c446

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.
->
+> 
+> - Version 1.0.x is not compatible with older versions
+> - Version 0.8.x is compatible with both the old syntax and new syntax
+> 
 > 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/version.rb

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

data/lib/colsole.rb

@@ -1,5 +1,4 @@
 require 'io/console'
-require 'colsole/compat'
 
 # Utility functions for colorful console applications.
 module Colsole
@@ -22,6 +21,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
@@ -103,24 +104,16 @@ module Colsole
 
   # Convert color markers to ansi colors.
   def colorize(string)
-    # compatibility later
-    compat_string = old_colorize string
-
-    process_color_markers compat_string do |color, styles, text|
+    process_color_markers string do |color, styles, text|
       "#{styles}#{color}#{text}#{ANSI_STYLES['z']}"
     end
   end
 
   # Remove color markers.
   def strip_colors(string)
-    # compatibility layer
-    compat_string = old_strip_colors string
-
-    process_color_markers(compat_string) { |_color, _styles, text| text }
+    process_color_markers(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: 1.0.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies: []
 description: Utility functions for making colorful console applications
 email: db@dannyben.com
@@ -18,7 +18,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/colsole.rb
-- lib/colsole/compat.rb
 - lib/colsole/version.rb
 homepage: https://github.com/DannyBen/colsole
 licenses:
@@ -33,14 +32,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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

data/lib/colsole/compat.rb

@@ -1,59 +0,0 @@
-# This file contains methods that are called by the main Colsole module
-# for compatibility with older versions of colsole.
-# Do not use these methods directly.
-module Colsole
-  def detect_terminal_size(*args)
-    terminal_size(*args)
-  end
-
-  def old_colorize(text)
-    reset = colors['txtrst']
-    reset_called_last = true
-
-    out = text.gsub(/!([a-z]{6})!/) do
-      reset_called_last = $1 == 'txtrst'
-      colors[$1]
-    end
-
-    reset_called_last or out = "#{out}#{reset}"
-    out
-  end
-
-  def old_strip_colors(text)
-    text.gsub(/!([a-z]{6})!/, '')
-  end
-
-  def resay(text)
-    say text, replace: true
-  end
-
-  def say_status(status, message = nil, color = nil)
-    color ||= (message ? :txtgrn : :txtblu)
-    say "!#{color}!#{status.to_s.rjust 12} !txtrst! #{message}".strip
-  end
-
-  def colors
-    @colors ||= begin
-      esc = 27.chr
-      pattern = "#{esc}[%{decor};%{fg}m"
-
-      decors = { txt: 0, bld: 1, und: 4, rev: 7 }
-      color_codes = { blk: 0, red: 1, grn: 2, ylw: 3, blu: 4, pur: 5, cyn: 6, wht: 7 }
-      colors = {}
-
-      decors.each do |dk, dv|
-        color_codes.each do |ck, cv|
-          key = "#{dk}#{ck}"
-          val = pattern % { decor: dv, fg: "3#{cv}" }
-          colors[key] = val
-        end
-      end
-
-      colors['txtbld'] = "#{esc}[1m"
-      colors['txtund'] = "#{esc}[4m"
-      colors['txtrev'] = "#{esc}[7m"
-      colors['txtrst'] = "#{esc}[0m"
-      colors
-    end
-  end
-end