everyday-cli-utils 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22981760ec07c6812935693a6ee28d02441e6bb1
-  data.tar.gz: f888f94e58a15d8bb2bfdb5ea04af6903dfe43b8
+  metadata.gz: eab4ed95a5c1dc20cf4e4faa6202989b19a85d97
+  data.tar.gz: 00c28312e37700149f707cd2a718c05e8331859a
 SHA512:
-  metadata.gz: 86fd47cad9ba83012945384c904870a346c374deda57a085221b1244cde553da9832473b66962aaa6c858549668f94937f1040149aa0ad8ae6ea6b591df1905f
-  data.tar.gz: 01344d8e1f8bbef5f4a4eb7d8da778474344dcdbfdbf8b948500b63c56e3cc991aeea1b6a7de48dca02dbc1f8d38bbad367d8b0f3e091b4938a54786e3d0a60b
+  metadata.gz: aa9403aff6a4d6d30698ed1119b98cba40697a9519f6d31c18157d581fd6f0c6d99fcd13f7177a28a3036ac9fc573f8114a36acc01dca34a4596256313900ac4
+  data.tar.gz: eec2dcca50851e200c609ef100cee89f982d5669d0434f700b2e927acca5e6fe401d17e56409282b6a51f7a69310fd26404f98ad948326c14653d32fa468020a

data/README.md

@@ -6,7 +6,9 @@
 [![Code Climate](https://codeclimate.com/github/henderea/everyday-cli-utils.png)](https://codeclimate.com/github/henderea/everyday-cli-utils)
 [![Coverage Status](https://coveralls.io/repos/henderea/everyday-cli-utils/badge.png?branch=master)](https://coveralls.io/r/henderea/everyday-cli-utils?branch=master)
 
-A few CLI and general utilities.  Includes a numbered-menu select loop utility, a ANSI formatting escape code handler, a text-based histogram maker, k-means and n-means (k-means with minimum optimal k) calculators, various collection utility methods, a Curses wrapper with up/down scrolling and more handled easily, and a utility for using OptionParser with less code.
+A few CLI and general utilities.  Includes a numbered-menu select loop utility, a ANSI formatting escape code handler, a text-based histogram maker, k-means and n-means (k-means with minimum optimal k) calculators, various collection utility methods, and a utility for using OptionParser with less code.
+
+Note: The curses utility has been moved to the `everyday-curses` gem
 
 ## Issue Tracking
 Please use <https://everydayprogramminggenius.atlassian.net/browse/ECU> for issue tracking.
@@ -155,10 +157,38 @@ Much shorter, right?
 
 There is also a static version of the method in `EverydayCliUtils::Format` that takes the string as a parameter, for those of you that use the "safe" version.
 
+Here's the two-letter color keys:
+
+```ruby
+{
+  'bk' => :black,
+  'rd' => :red,
+  'gr' => :green,
+  'yw' => :yellow,
+  'bl' => :blue,
+  'pu' => :purple,
+  'cy' => :cyan,
+  'wh' => :white,
+  'no' => :none
+}
+```
+
 As of version 0.5.0, there is now a `String#mycenter` method that takes a length and an optional character (defaults to `' '`) and centers the string using that character and length.  This is designed to mimic the built-in `String#center` method, but add support for handling the formatting, since formatting is done by adding non-printing characters to the string.  If you were to use the built-in `center` method, you would be adding too little padding.
 
 There is also a static version of the method in `EverydayCliUtils::Format` that takes the string as a parameter, for those of you that use the "safe" version.
 
+As of version 1.2.0, there is now support for using color profiles in `String#format_all`.  Here's an example:
+
+```ruby
+EverydayCliUtils::Format.color_profile(:p1, bold: true, underline: true, fgcolor: :yellow, bgcolor: :green)
+EverydayCliUtils::Format.color_profile(:p2, underline: true, fgcolor: :yellow)
+'abc {def}(:p1) ghi {jkl}(:p2) mno'.format_all
+```
+
+This gives the same result as the earlier example.  With color profiles, you define it once and can use it as many times as you want.  So if you have an application that lets the user choose colors for certain things, you can define a color profile with the chosen colors once and re-use it as many times as you want.
+
+Please note that if you define a second color profile with the same id, it will overwrite the first one.
+
 ###EverydayCliUtils::Histogram
 
 Create a text-based histogram.  This is an extension to the `Enumerable` module, unless you import `:histogram_safe`, in which case you can use the static methods in `EverydayCliUtils::Histogram`, with an added first parameter of the collection.
@@ -250,66 +280,6 @@ Return the data joined into a single string with `join_str` in between the eleme
 ####Hash.expand
 Takes a shorthand hash (like `{ [:a, :b, :c, :d] => '1-4', e: '5' }`) and turns it into a full hash (like `{ a: '1-4', b: '1-4', c: '1-4', d: '1-4', :e => '5' }`)
 
-###EverydayCliUtils::MyCurses
-
-Encapsulates the code for dealing with the curses library.
-
-###Fields:
-####MyCurses.headers
-An array storing the header lines that will be printed out with `MyCurses.myprints`.
-
-####MyCurses.bodies
-An array storing the body lines that will be printed out with `MyCurses.myprints`.
-
-####MyCurses.footers
-An array storing the footer lines that will be printed out with `MyCurses.myprints`.
-
-###Methods:
-
-####MyCurses.new(use\_curses, linesh, linesf)
-Initializes the class and sets the basic options.
-
-######Parameters
-* `use_curses`: `true` to use curses, `false` to use `puts`
-* `linesh`: the number of header lines
-* `linesf`: the number of footer lines
-
-####MyCurses.clear
-Clear the `headers`, `bodies`, and `footers` arrays
-
-####MyCurses.myprints
-Print out all of the lines stored in the `headers`, `bodies`, and `footers` arrays.  If `use_curses` is `true`, it will use curses and allow for scrolling.  Otherwise, it will just print out all of the lines with `puts`
-
-####MyCurses.read\_ch
-Update the character from the body pad.
-
-####MyCurses.clear\_ch
-Clear out any newline, ENTER, UP, or DOWN characters from the queue.
-
-####MyCurses.scroll\_iteration
-Update the display (including doing any scrolling) and read the next character.
-
-####MyCurses.header\_live\_append(str)
-Append `str` to the header pad immediately and update it.  Does not modify the `headers` array.
-
-######Parameters
-* `str`: the string to append
-
-####MyCurses.body\_live\_append(str)
-Append `str` to the body pad immediately and update it.  Does not modify the `bodies` array.
-
-######Parameters
-* `str`: the string to append
-
-####MyCurses.footer\_live\_append(str)
-Append `str` to the footer pad immediately and update it.  Does not modify the `footers` array.
-
-######Parameters
-* `str`: the string to append
-
-####MyCurses.dispose
-Close out the curses screen if curses was used.
-
 ###EverydayCliUtils::Option
 
 Some utility methods for the `OptionParser` class.

data/lib/everyday-cli-utils/safe/format.rb

@@ -108,14 +108,15 @@ module EverydayCliUtils
       colors    = 'bk|rd|gr|yw|bl|pu|cy|wh|no'
       color_map = { 'bk' => :black, 'rd' => :red, 'gr' => :green, 'yw' => :yellow, 'bl' => :blue, 'pu' => :purple, 'cy' => :cyan, 'wh' => :white, 'no' => :none }
       regex     = /\{(.+?)\}\((bd)?(ul)?(?:f(#{colors}))?(?:b(#{colors}))?\)/
-      text.gsub(regex) { |m|
+      regex2    = /\{(.+?)\}\(:(.+?)\)/
+      text.gsub(regex) { |_|
         txt       = $1
         bold      = !$2.nil?
         underline = !$3.nil?
         fg        = $4.nil? ? nil : color_map[$4]
         bg        = $5.nil? ? nil : color_map[$5]
         format(txt, build_string(bold, underline, fg, bg))
-      }
+      }.gsub(regex2) { |_| format($1, color_profile_string($2.to_sym)) }
     end
 
     def self.mycenter(str, len, char = ' ')
@@ -125,5 +126,19 @@ module EverydayCliUtils
       a = len - tlen - b
       "#{char * b}#{str}#{char * a}"
     end
+
+    ColorProfile = Struct.new(:bold, :underline, :fgcolor, :bgcolor)
+
+    def self.color_profile(id, options = {})
+      @color_profiles     ||= {}
+      @color_profiles[id] = ColorProfile.new(options[:bold], options[:underline], options[:fgcolor] || nil, options[:bgcolor] || nil)
+    end
+
+    def self.color_profile_string(id)
+      @color_profiles ||= {}
+      profile         = @color_profiles[id]
+      profile.nil? ? nil : self::build_string(profile.bold, profile.underline, profile.fgcolor, profile.bgcolor)
+    end
   end
+
 end

data/lib/everyday-cli-utils/version.rb

@@ -1,3 +1,3 @@
 module EverydayCliUtils
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/everyday-cli-utils/format_spec.rb

@@ -68,6 +68,14 @@ describe EverydayCliUtils::Format do
     str.format_all.should eq expected
   end
 
+  it 'allows color profiles for use in shorthand for formatting in-string' do
+    EverydayCliUtils::Format.color_profile(:p1, bold: true, underline: true, fgcolor: :yellow, bgcolor: :green)
+    EverydayCliUtils::Format.color_profile(:p2, underline: true, fgcolor: :yellow)
+    str      = 'abc {def}(:p1) ghi {jkl}(:p2) mno'
+    expected = "abc #{'def'.format_bold_underline_fg_yellow_bg_green} ghi #{'jkl'.format_underline_fg_yellow} mno"
+    str.format_all.should eq expected
+  end
+
   it 'allows centering a formatted string' do
     str                   = 'abc'
     str2                  = str.center(10)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everyday-cli-utils
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Henderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,12 +103,10 @@ files:
 - everyday-cli-utils.gemspec
 - lib/everyday-cli-utils.rb
 - lib/everyday-cli-utils/ask.rb
-- lib/everyday-cli-utils/curses_utils.rb
 - lib/everyday-cli-utils/format.rb
 - lib/everyday-cli-utils/histogram.rb
 - lib/everyday-cli-utils/kmeans.rb
 - lib/everyday-cli-utils/maputil.rb
-- lib/everyday-cli-utils/mycurses.rb
 - lib/everyday-cli-utils/option.rb
 - lib/everyday-cli-utils/safe/format.rb
 - lib/everyday-cli-utils/safe/histogram.rb

data/lib/everyday-cli-utils/curses_utils.rb

@@ -1,40 +0,0 @@
-#module EverydayCliUtils
-#  module CursesUtils
-#    COLOR_TO_CURSES = {
-#        :black  => Curses::COLOR_BLACK,
-#        :red    => Curses::COLOR_RED,
-#        :green  => Curses::COLOR_GREEN,
-#        :yellow => Curses::COLOR_YELLOW,
-#        :blue   => Curses::COLOR_BLUE,
-#        :purple => Curses::COLOR_MAGENTA,
-#        :cyan   => Curses::COLOR_CYAN,
-#        :white  => Curses::COLOR_WHITE,
-#        :none   => -1,
-#    }
-#
-#    def find_color(bgcolor, fgcolor)
-#      @colors.find_index { |v| v[0] == (fgcolor || :none) && v[1] == (bgcolor || :none) }
-#    end
-#
-#    def add_color(bgcolor, fgcolor)
-#      Curses::init_pair(@colors.count + 1, COLOR_TO_CURSES[fgcolor || :none], COLOR_TO_CURSES[bgcolor || :none])
-#      ind = @colors.count + 1
-#      @colors << [fgcolor || :none, bgcolor || :none]
-#      ind
-#    end
-#
-#
-#    private
-#    def handle_color(fgcolor, bgcolor)
-#      return 0 if (fgcolor.nil? || fgcolor == :none) && (bgcolor.nil? || bgcolor == :none)
-#      ind = find_color(bgcolor, fgcolor)
-#      ind = ind.nil? ? add_color(bgcolor, fgcolor) : ind + 1
-#      Curses::color_pair(ind)
-#    end
-#
-#    def get_format(str)
-#      bold, underline, fgcolor, bgcolor = Format::parse_format(str)
-#      (bold ? Curses::A_BOLD : 0) | (underline ? Curses::A_UNDERLINE : 0) | handle_color(fgcolor, bgcolor)
-#    end
-#  end
-#end

data/lib/everyday-cli-utils/mycurses.rb

@@ -1,199 +0,0 @@
-#require 'curses'
-#require_relative 'format'
-#require_relative 'curses_utils'
-#
-#module EverydayCliUtils
-#  class MyCurses
-#    include CursesUtils
-#    #region External
-#    def initialize(use_curses, linesh, linesf)
-#      @use_curses = use_curses
-#      @linesh     = linesh
-#      @linesf     = linesf
-#      @colors     = []
-#      @headers    = []
-#      @bodies     = []
-#      @footers    = []
-#      @cur_l      = 0
-#      @max_l      = 0
-#      @ch         = nil
-#      setup_curses(linesf, linesh) if @use_curses
-#    end
-#
-#    def setup_curses(linesf, linesh)
-#      Curses::noecho
-#      Curses::init_screen
-#      @subpad_start = linesh
-#      update_subpad_size
-#      @padh = Curses::Pad.new(linesh, Curses::cols)
-#      @padb = Curses::Pad.new(Curses::lines - linesh - linesf, Curses::cols)
-#      @padf = Curses::Pad.new(linesf, Curses::cols)
-#      configure_curses
-#    end
-#
-#    def configure_curses
-#      @padh.keypad(true)
-#      @padh.clear
-#      @padh.nodelay = true
-#      @padb.keypad(true)
-#      @padb.clear
-#      @padb.nodelay = true
-#      @padf.keypad(true)
-#      @padf.clear
-#      @padf.nodelay = true
-#      Curses::cbreak
-#      Curses::start_color
-#      Curses::use_default_colors
-#    end
-#
-#    def clear
-#      @headers = []
-#      @bodies  = []
-#      @footers = []
-#    end
-#
-#    def myprints
-#      @use_curses ? print_curses : print_normal
-#    end
-#
-#    def print_normal
-#      @headers.each { |v| puts v }
-#      @bodies.each { |v| puts v }
-#      @footers.each { |v| puts v }
-#    end
-#
-#    def print_curses
-#      resize_curses
-#      myprint(@headers.join("\n"), @padh)
-#      myprint(@bodies.join("\n"), @padb)
-#      myprint(@footers.join("\n"), @padf)
-#      update_max_l
-#      @cur_l = [@cur_l, @max_l].min
-#      padh_refresh
-#      padb_refresh
-#      padf_refresh
-#    end
-#
-#    def resize_curses
-#      @padh.resize(@headers.count, Curses::cols)
-#      @padb.resize(@bodies.count, Curses::cols)
-#      @padf.resize(@footers.count, Curses::cols)
-#      @padh.clear
-#      @padb.clear
-#      @padf.clear
-#      @padh.setpos(0, 0)
-#      @padb.setpos(0, 0)
-#      @padf.setpos(0, 0)
-#    end
-#
-#    def read_ch
-#      @ch = @padf.getch
-#    end
-#
-#    def clear_ch
-#      read_ch
-#      while @ch == 10 || @ch == Curses::Key::ENTER || @ch == Curses::Key::UP || @ch == Curses::Key::DOWN
-#        read_ch
-#      end
-#    end
-#
-#    def scroll_iteration
-#      old_subpad_size = @subpad_size
-#      update_subpad_size
-#      update_max_l
-#      update_scroll(@subpad_size != old_subpad_size)
-#      sleep(0.05)
-#      read_ch
-#    end
-#
-#    def header_live_append(str)
-#      @padh << str
-#      padh_refresh
-#    end
-#
-#    def body_live_append(str)
-#      @padb << str
-#      padb_refresh
-#    end
-#
-#    def footer_live_append(str)
-#      @padf << str
-#      padf_refresh
-#    end
-#
-#    def dispose
-#      Curses::close_screen if @use_curses
-#    end
-#
-#    #endregion
-#
-#    #region Internal
-#    def myputs(text, pad)
-#      myprint("#{text}\n", pad)
-#    end
-#
-#    def myprint(text, pad)
-#      if @use_curses
-#        if text.include?("\e")
-#          pieces = text.scan(/#{"\e"}\[(.+?)m([^#{"\e"}]+?)#{"\e"}\[0m|([^#{"\e"}]+)/)
-#          pieces.each { |v|
-#            if v[2].nil?
-#              pad.attron(get_format(v[0])) {
-#                pad << v[1]
-#              }
-#            else
-#              pad << v[2]
-#            end
-#          }
-#        else
-#          pad << text
-#        end
-#      else
-#        print text
-#      end
-#    end
-#
-#    def update_max_l
-#      @max_l = [0, @bodies.count - @subpad_size].max
-#    end
-#
-#    def update_subpad_size
-#      Curses::refresh
-#      @subpad_size = Curses::lines - @linesh - @linesf
-#    end
-#
-#    def padh_refresh
-#      @padh.refresh(0, 0, 0, 0, @subpad_start - 1, Curses::cols - 1)
-#    end
-#
-#    def padb_refresh
-#      @padb.refresh(@cur_l, 0, @subpad_start, 0, @subpad_start + @subpad_size - 1, Curses::cols - 1)
-#    end
-#
-#    def padf_refresh
-#      @padf.refresh(0, 0, @subpad_start + [@subpad_size, @bodies.count].min, 0, @subpad_start + [@subpad_size, @bodies.count].min + @footers.count, Curses::cols - 1)
-#    end
-#
-#    def update_scroll(force_refresh = false)
-#      if @ch == Curses::Key::UP
-#        @cur_l = [0, @cur_l - 1].max
-#      elsif @ch == Curses::Key::DOWN
-#        @cur_l = [@max_l, @cur_l + 1].min
-#      end
-#      @cur_l = [@cur_l, @max_l].min
-#      if @ch == Curses::Key::UP || @ch == Curses::Key::DOWN || force_refresh
-#        Curses::refresh
-#        padh_refresh
-#        padb_refresh
-#        padf_refresh
-#      end
-#      @cur_l
-#    end
-#
-#    #endregion
-#
-#    attr_reader :ch
-#    attr_accessor :bodies, :headers, :footers
-#    private :myputs, :myprint, :update_max_l, :update_subpad_size, :padh_refresh, :padb_refresh, :padf_refresh, :update_scroll
-#  end
-#end