colorato 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6270007938fb0916b87353d58dd27bd2e7955d746480e857b1ed2519211993
-  data.tar.gz: 3ffb11adc797a497a7b63fafb7e9a92c46fe65b36ae802e53b3651b96f3f292a
+  metadata.gz: 6a04ec628455d986e1a98d0046ee1b63b1f046c1bc6d7018ef5cf2524998e18e
+  data.tar.gz: 947d85416c2d2f2a2d28645f97858788886a58b5c4088ac4b4bb55917ca781aa
 SHA512:
-  metadata.gz: 1a81a30427e2ba3952cddd887f8c113219ae7ef3f96672a9f3464eda375abcfd09c6a74d5a39e28d8a05da24f32b7ce89041ed141c5828c8126f393361aa3f4d
-  data.tar.gz: 8ac4184b1ecfd075a9ff9e877ac0db21b1c244787a978f57ef6c5226e276fcc36fbcd924e904c296b6eff185b1eac6f62fcdfe0d89d657009bbf079c32203d3c
+  metadata.gz: 261f7abe0f7bebe479efae920db1ccc976c547ea2e312e1406b7efa637d0273e1eb77483b6945e63b6c3204c61389c40ef7172db1f4ca6e1bc0d64be8889add1
+  data.tar.gz: 968df424e0014f91f5cbe5fce37b51576790ecfd04453e6a88d168e2b096b8de9cbd617b765eef0cf76c0c96c5adf8c765794cad3364daa7c9db4f9b20f85764

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 # colorato
 
 
+## 1.0.0 released 2023-01-03
+
+* Introduce `make colo.rb`
+* Allow for Colorato .colors, .nocolours, .nocolors and .no_colors
+* Limit to Colorato.colours and Colorato.no_colours
+
+
 ## 0.9.0 released 2023-01-02
 
 * initial release

data/README.md

@@ -4,6 +4,136 @@
 ANSI colours tool. Taken out of [flor](https://github.com/floraison/flor).
 
 
+## Usage
+
+```ruby
+require 'colorato'
+
+C = Colorato.colours
+NC = Colorato.nocolours
+
+C.blue # => "\e[34m"
+C.blue('car') # => "\e[34mcar\e[0;0m"
+
+NC.blue('car') # => "car"
+```
+
+### .decolour(string)
+
+```ruby
+Colorato.decoulour("car") # => 'car'
+Colorato.decoulour("\e[34mcar\e[0;0m") # => 'car'
+```
+
+### .nocolour_length(string)
+
+```ruby
+Colorato.nocolour_length("car") # => 3
+Colorato.nocolour_length("\e[34mcar\e[0;0m") # => 3
+```
+
+### .truncate_string(string, maxlength, ellipsis='...')
+
+```ruby
+Colorato.truncate_string("hello world!", 7)
+  # => "hello w..."
+Colorato.truncate_string("hello #{@colours.blue('world')}!", 7)
+  # => "hello \e[34mw\e[0;0m..."
+
+Colorato.truncate_string("hello world!", 7, 'XXX')
+  # => "hello wXXX"
+Colorato.truncate_string("hello #{@colours.blue('world')}!", 7, 'XXX')
+  # => "hello \e[34mw\e[0;0mXXX"
+
+Colorato.truncate_string("hello world!", 7, :ellipsis)
+  # => "hello Ol…"
+Colorato.truncate_string("hello #{@colours.blue('world')}!", 7, :ellipsis)
+  # => "hello \e[34mw\e[0;0m…"
+```
+
+### colours
+
+```ruby
+  def reset(s=nil)
+  def bright(s=nil)
+  def dim(s=nil)
+  def underlined(s=nil)
+  def blink(s=nil)
+  def reverse(s=nil)
+  def hidden(s=nil)
+  def strike(s=nil)
+  def default(s=nil)
+  def black(s=nil)
+  def red(s=nil)
+  def green(s=nil)
+  def yellow(s=nil)
+  def blue(s=nil)
+  def magenta(s=nil)
+  def cyan(s=nil)
+  def light_gray(s=nil)
+  def dark_gray(s=nil)
+  def light_red(s=nil)
+  def light_green(s=nil)
+  def light_yellow(s=nil)
+  def light_blue(s=nil)
+  def light_magenta(s=nil)
+  def light_cyan(s=nil)
+  def white(s=nil)
+  def bg_default(s=nil)
+  def bg_black(s=nil)
+  def bg_red(s=nil)
+  def bg_green(s=nil)
+  def bg_yellow(s=nil)
+  def bg_blue(s=nil)
+  def bg_magenta(s=nil)
+  def bg_cyan(s=nil)
+  def bg_light_gray(s=nil)
+  def bg_dark_gray(s=nil)
+  def bg_light_red(s=nil)
+  def bg_light_green(s=nil)
+  def bg_light_yellow(s=nil)
+  def bg_light_blue(s=nil)
+  def bg_light_magenta(s=nil)
+  def bg_light_cyan(s=nil)
+  def bg_white(s=nil)
+  alias brown yellow
+  alias purple magenta
+  alias dark_grey dark_gray
+  alias light_grey light_gray
+  alias rd red
+  alias bl blue
+  alias bu blue
+  alias ba black
+  alias bk black
+  alias gn green
+  alias gr green
+  alias dg dark_gray
+  alias gy light_gray
+  alias lg light_gray
+  alias yl yellow
+  alias y yellow
+  alias ma magenta
+  alias wt white
+  alias rs reset
+  alias br bright
+  alias bri bright
+  alias un underlined
+  alias rv reverse
+  alias bn blink
+  alias blg bg_light_gray
+  alias und underlined
+  alias rev reverse
+```
+
+### colo.rb
+
+```
+make colo.rb
+```
+
+Generates a static `colo.rb` ready to be shrunk and pasted in a project.
+
+
 ## LICENSE
 
 MIT, see [LICENSE.txt](LICENSE.txt)

data/lib/colorato/core.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 module Colorato
 
   COLOURS = Hash[*%w[
@@ -26,58 +27,49 @@ module Colorato
 
   ]].freeze
 
-  class Colours
-
-    Colorato::COLOURS.each do |k, v|
-      if v.match(/\A\d/) # Ruby 2.3 doesn't have String#match?
-        class_eval(%{
-          def #{k}(s=nil)
-           s ? "[#{v}m" + s + "" : "[#{v}m"
-           end })
-      else
-        class_eval(
-          "alias #{k} #{v}")
-      end
-    end
-  end
-
-  class NoColours
-
-    Colorato::COLOURS.each do |k, v|
-      if v.match(/\A\d/) # Ruby 2.3 doesn't have String#match?
-        class_eval("def #{k}(s=''); s; end")
-      else
-        class_eval("alias #{k} #{v}")
-      end
+  class Colours; end
+  class NoColours; end
+    #
+  Colorato::COLOURS.each do |k, v|
+
+    if v.match(/\A\d/) # Ruby 2.3 doesn't have String#match?
+
+      ::Colorato::Colours.class_eval(%{
+        def #{k}(s=nil)
+          s ?
+            "\e[#{v}m\#{s}\e[0;0m" :
+            "\e[#{v}m"
+        end })
+      ::Colorato::NoColours.class_eval(%{
+        def #{k}(s=nil)
+          s ?
+            s :
+            ''
+        end })
+
+    else
+
+      c = %{ alias #{k} #{v} }
+      ::Colorato::Colours.class_eval(c)
+      ::Colorato::NoColours.class_eval(c)
     end
   end
 
-  @colours = Colours.new
-  @no_colours = NoColours.new
+  class << self
 
-  def self.no_colours
+    def colours
 
-    @no_colours
-  end
-
-  def self.colours(opts={})
-
-    c = nil;
-      [ :color, :colour, :colors, :colours ].each do |k|
-        if opts.has_key?(k); c = opts[k]; break; end
-      end
-
-    return @colours if c == true
-    return @no_colours if c == false
+      @colours ||= Colours.new
+    end
 
-    o = opts[:out] || $stdout
+    def no_colours
 
-    return @colours if (
-      (o.respond_to?(:log_colours?) ? o.log_colours? : o.tty?) ||
-      ($0[-6..-1] == '/rspec' &&
-        (ARGV.include?('--tty') || ARGV.include?('--color'))))
+      @no_colours ||= NoColours.new
+    end
 
-    @no_colours
+    alias colors colours
+    alias nocolors no_colours
+    alias no_colors no_colours
   end
 end
 

data/lib/colorato/{module.rb → more.rb}

@@ -14,12 +14,17 @@ module Colorato; class << self
 
   def truncate_string(s, maxlen, post='...')
 
+    post = '…' if post == :ellipsis
+
     ncl = no_colour_length(s)
     r = StringIO.new
     l = 0
 
+    col = false
+
     s.scan(/(\x1b\[\d+(?:;\d+)?m|[^\x1b]+)/) do |ss, _|
       if ss[0, 1] == ""
+        col = true
         r << ss
       else
         ss = ss[0, maxlen - l]
@@ -31,6 +36,8 @@ module Colorato; class << self
 
     return r.string if l < maxlen
 
+    r << "\e[0;0m" if col
+
     if post.is_a?(String)
       r << post
     elsif post.is_a?(Proc)
@@ -49,28 +56,3 @@ module Colorato; class << self
 end; end
 
 
-#if $0 == __FILE__
-#
-#  puts "# frozen_string_literal: true"
-#  puts
-#  puts "module Colorato; class << self"
-#  Colorato::COLOURS.each do |k, v|
-#    if v.match?(/\A\d/)
-#      puts "  def #{k}(s=nil); s ? \"[#{v}m\#{s}\" : \"[#{v}m\"; end"
-#    else
-#      puts "  alias #{k} #{v}"
-#    end
-#  end
-#  puts "end; end"
-#  puts
-#  puts "module NoColorato; class << self"
-#  Colorato::COLOURS.each do |k, v|
-#    if v.match?(/\A\d/)
-#      puts "  def #{k}(s=nil); s ? s : ''; end"
-#    else
-#      puts "  alias #{k} #{v}"
-#    end
-#  end
-#  puts "end; end"
-#end
-

data/lib/colorato.rb

@@ -3,9 +3,9 @@
 
 module Colorato
 
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end
 
 require 'colorato/core'
-require 'colorato/module'
+require 'colorato/more'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colorato
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,7 +38,7 @@ files:
 - colorato.gemspec
 - lib/colorato.rb
 - lib/colorato/core.rb
-- lib/colorato/module.rb
+- lib/colorato/more.rb
 homepage: https://github.com/floraison/colorato
 licenses:
 - MIT