colorato 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6270007938fb0916b87353d58dd27bd2e7955d746480e857b1ed2519211993
-  data.tar.gz: 3ffb11adc797a497a7b63fafb7e9a92c46fe65b36ae802e53b3651b96f3f292a
+  metadata.gz: b28fd8267ee3efc81eeff84c4d0cb31904898b0c97f52277966e720f2e739ffd
+  data.tar.gz: 2d096f6c8970cebea52a1e30fba7bd4fab9d5d85741c1968caed17cc0941d060
 SHA512:
-  metadata.gz: 1a81a30427e2ba3952cddd887f8c113219ae7ef3f96672a9f3464eda375abcfd09c6a74d5a39e28d8a05da24f32b7ce89041ed141c5828c8126f393361aa3f4d
-  data.tar.gz: 8ac4184b1ecfd075a9ff9e877ac0db21b1c244787a978f57ef6c5226e276fcc36fbcd924e904c296b6eff185b1eac6f62fcdfe0d89d657009bbf079c32203d3c
+  metadata.gz: '08c68f4329d2d36927ccfe3d02805ef8f21bde89f0ddb70a71b935454f8b2fcbe6557098d3ded29b2e38664a9307849f5fd9978fe2227867fafa2792ff1c6d75'
+  data.tar.gz: 8cc6529dd0968df22087e816cc6a78b8b6ca4a6a109455b2401e7bf85273072b820b6979af0497aabb8c927b4298dd757a2bc2d4f3f5bb2f3c5f71535bbf210e

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 # colorato
 
 
+## 1.1.0 released 2025-01-16
+
+* colorato.blue { 'blo' + 'ck' }
+* Show the colours when `ruby lib/colorato.rb`
+
+
+## 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/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2015-2023, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2015-2025, John Mettraux, jmettraux+flor@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,6 +4,138 @@
 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"
+C.blue { 'car' } # => "\e[34mcar\e[0;0m"
+
+NC.blue('car') # => "car"
+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/colorato.gemspec

@@ -26,6 +26,7 @@ terminal colors extracted from flor
     'homepage_uri' =>  s.homepage,
     'source_code_uri' => s.homepage,
     #'wiki_uri' => s.homepage + '/wiki',
+    'rubygems_mfa_required' => 'true',
   }
 
   #s.files = `git ls-files`.split("\n")
@@ -40,7 +41,8 @@ terminal colors extracted from flor
   #s.add_runtime_dependency 'raabro', '~> 1.4'
   #s.add_runtime_dependency 'et-orbi', '~> 1', '>= 1.2.7'
 
-  s.add_development_dependency 'rspec', '~> 3.12'
+  #s.add_development_dependency 'rspec', '~> 3.12'
+  s.add_development_dependency 'probatio', '~> 1'
 
   s.require_path = 'lib'
 end

data/lib/colorato/core.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 module Colorato
 
   COLOURS = Hash[*%w[
@@ -11,6 +12,7 @@ module Colorato
     black 30 red 31 green 32 yellow 33 blue 34 magenta 35 cyan 36
     light_gray 37 dark_gray 90 light_red 91 light_green 92 light_yellow 93
     light_blue 94 light_magenta 95 light_cyan 96 white 97
+
     bg_default 49 bg_black 40 bg_red 41 bg_green 42 bg_yellow 43 bg_blue 44
     bg_magenta 45 bg_cyan 46 bg_light_gray 47 bg_dark_gray 100
     bg_light_red 101 bg_light_green 102 bg_light_yellow 103
@@ -26,58 +28,79 @@ 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
+  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, &block)
+          (x = (block && block.call) || s) ?
+            "\e[#{v}m\#{x}\e[0;0m" :
+            "\e[#{v}m"
+        end })
+      ::Colorato::NoColours.class_eval(%{
+        def #{k}(s=nil, &block)
+          (x = (block && block.call) || s) ? x : ''
+        end })
+
+    else
+
+      c = %{ alias #{k} #{v} }
+      ::Colorato::Colours.class_eval(c)
+      ::Colorato::NoColours.class_eval(c)
     end
   end
 
-  class NoColours
+  class << self
 
-    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
+    def colours
+
+      @colours ||= Colours.new
     end
-  end
 
-  @colours = Colours.new
-  @no_colours = NoColours.new
+    def no_colours
 
-  def self.no_colours
+      @no_colours ||= NoColours.new
+    end
 
-    @no_colours
-  end
+    alias colors colours
+    alias nocolors no_colours
+    alias no_colors no_colours
 
-  def self.colours(opts={})
+    def show_colours
 
-    c = nil;
-      [ :color, :colour, :colors, :colours ].each do |k|
-        if opts.has_key?(k); c = opts[k]; break; end
-      end
+      cs = Colorato.colours.public_methods
+        .inject([]) { |a, n|
+          m = n.to_s.match(/^bg_(.+)$/)
+          a << m[1] if m
+          a }
+
+      #%w[ (default) bright dim ].each do |filter|
 
-    return @colours if c == true
-    return @no_colours if c == false
+      puts
 
-    o = opts[:out] || $stdout
+      fs = %w[ (def) bright dim ]
 
-    return @colours if (
-      (o.respond_to?(:log_colours?) ? o.log_colours? : o.tty?) ||
-      ($0[-6..-1] == '/rspec' &&
-        (ARGV.include?('--tty') || ARGV.include?('--color'))))
+      puts "%14s  %-9s  %-9s  %-9s" % ([ '' ] + fs)
+      puts
 
-    @no_colours
+      cs.each do |n|
+        a = [ n ]
+        fs.each do |f|
+          f = Colorato.colours.send(f) rescue ''
+          fgc = f + Colorato.colours.send(n)
+          bgc = f + Colorato.colours.send("bg_#{n}")
+          a << (fgc + 'Text' + Colorato.colours.reset)
+          a << (bgc + '    ' + Colorato.colours.reset)
+        end
+        puts "%14s: %s %s  %s %s  %s %s" % a
+      end
+
+      puts
+    end
   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,12 @@
 
 module Colorato
 
-  VERSION = '0.9.0'
+  VERSION = '1.1.0'
 end
 
 require 'colorato/core'
-require 'colorato/module'
+require 'colorato/more'
+
+
+Colorato.show_colours if __FILE__ == $0
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: colorato
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: probatio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '1'
 description: terminal colors extracted from flor
 email:
 - jmettraux+flor@gmail.com
@@ -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
@@ -48,6 +48,7 @@ metadata:
   bug_tracker_uri: https://github.com/floraison/colorato/issues
   homepage_uri: https://github.com/floraison/colorato
   source_code_uri: https://github.com/floraison/colorato
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: terminal colors for flor