console-glitter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6dc7f133fc08089409ca94c2faccc434cfadc80
+  data.tar.gz: e7ded778c22128e5378af28f24c1463cc8616aed
+SHA512:
+  metadata.gz: fd4af9e20d868a6159feb8f728df53b9ff45e84524054690df857fc2adbb2c7b0a6392e044ab2fbf41107769a25196779d6f34b9a939f95b132b352857c1ecb2
+  data.tar.gz: 29da738fc607e8016e35cc67118957141174407bbfc82dbccf68af8d99a635808ae79ec24ba1b7144a97e4cd0572150b555d1b232aa97d91ae59e95d201438ee

data/lib/console-glitter.rb

@@ -0,0 +1,152 @@
+require 'console-glitter/version'
+require 'console-glitter/ansi'
+
+module ConsoleGlitter
+  module UI extend self
+    extend ANSI
+    # Public: Prompt user for input, allowing for a default answer and a list
+    # of valid responses to be provided.
+    #
+    # question - Query to be presented to the user.
+    # options  - Hash containing arguments defining acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.  If
+    #                              this is nil, a non-empty answer MUST be
+    #                              given.
+    #            :allow_empty    - Whether or not to allow empty responses.
+    #                              Unless explicitly allowed, empty answers
+    #                              will be rejected.
+    #            :valid_answers  - An Array containing all valid responses.  If
+    #                              this is empty, any answer will be accepted
+    #                              (except empty answers as specified above).
+    #
+    # Returns a String containing the answer provided by the user.
+    def prompt(question, options = {})
+      default = options[:default_answer].to_s
+      allow_empty = options[:allow_empty]
+      valid = options[:valid_answers] || []
+
+      default_display = " [#{default.strip}]" unless default.empty?
+      question.strip!
+
+      answer = nil
+      while answer.nil?
+        print "#{question}#{default_display}> "
+        answer = $stdin.readline.strip
+        answer = default if answer.empty?
+
+        if answer.empty?
+          answer = nil unless allow_empty
+        elsif valid.any?
+          answer = nil unless valid.grep(answer).any?
+        end
+      end
+
+      answer
+    end
+
+    # Public: Wrap Console#prompt but accept only a Y/N response.
+    #
+    # question - String containing the question to present to the user.
+    # args     - Hash containing arguments to control acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.
+    #
+    # Returns true or false corresponding to Y or N answer respectively.
+    def prompt_yn(question, args = {})
+      args[:valid_answers] = []
+      answer = nil
+
+      until answer =~ /^[yn]/i
+        answer = prompt(question, args)
+      end
+
+      /^n/i.match(answer).nil?
+    end
+
+    # Public: Render a "spinner" on the command line and yield to a block,
+    # reporting success if nothing is raised, or else reporting failure.
+    #
+    # message - Message to be displayed describing the task being evaluated.
+    # block   - Block to be yielded to determine pass or fail.
+    #
+    # Returns the result of the yielded block if successful.
+    # Raises whatever is raised inside the yielded block.
+    def spinner(message, &block)
+      success = nil
+      result = nil
+
+      pre = "\r#{bold}#{white} [#{reset}"
+      post = "#{bold}#{white}] #{reset}#{message}"
+      pre_ok = "\r#{bold}#{white} [#{green} ok "
+      pre_fail = "\r#{bold}#{white} [#{red}fail"
+
+      thread = Thread.new do
+        step = 0
+        spin = ["    ", ".   ", "..  ", "... ", "....", " ...", "  ..", "   ."]
+        while success.nil?
+          print "#{pre}#{spin[step % 8]}#{post}"
+          step += 1
+          sleep 0.5
+        end
+
+        if success
+          print "#{pre_ok}#{post}\n"
+        else
+          print "#{pre_fail}#{post}\n"
+        end
+      end
+
+      begin
+        result = yield
+        success = true
+        thread.join
+        return result
+      rescue
+        success = false
+        thread.join
+        raise
+      end
+    end
+
+    # Public: Generate a formatted, printable table.
+    #
+    # rows   - An Array containing Hashes which contain desired options to
+    #          display. (e.g. [{"col1" => "a", "col2" => "b"}])
+    # labels - Hash containing key-value pairs to label each key in options.
+    #          (default: nil)
+    #
+    # Returns a String containing the grid.
+    # Raises ArgumentError if anything but an Array is passed as rows.
+    def build_grid(rows, labels = nil)
+      if labels.nil?
+        labels = rows[0].keys.reduce({}) { |c,e| c.merge({e => e}) }
+      end
+
+      keys = labels.keys
+
+      max_width = labels.reduce({}) do |c,e|
+        c.merge({e[0]=> ([labels] + rows).map { |r| r[e[0]].length }.max})
+      end
+
+      grid_rule = max_width.reduce('+') do |c,e|
+        c + ('-' * (e[1] + 2)) + '+'
+      end
+      grid_rule << "\n"
+
+      grid = grid_rule.dup
+      grid << keys.reduce('|') do |c,e|
+        c + " #{bold}% #{max_width[e]}s#{reset} |" % labels[e]
+      end
+      grid << "\n"
+
+      grid << rows.reduce(grid_rule) do |c,e|
+        content = keys.reduce('') do |s,k|
+          s + " % #{max_width[k]}s |" % e[k]
+        end
+        c + "|#{content}\n"
+      end
+      grid << grid_rule
+    end
+  end
+end

data/lib/console-glitter/ansi.rb

@@ -0,0 +1,148 @@
+module ConsoleGlitter
+  module ANSI extend self
+    # Public: Return an appropriate escape sequence depending upon the current
+    # platform.
+    #
+    # sequence - Control code(s) to be escaped.  Multiple codes may be chained,
+    #            separated by ';'.
+    #
+    # Examples
+    #
+    #   ConsoleGlitter::ANSI.escape 0
+    #   # => "\033[0m"
+    #
+    # Returns a String.
+    def escape(sequence)
+      RUBY_PLATFORM =~ /win/i ? '' : "\033[#{sequence}m" 
+    end
+
+    # Public: Generate an escape sequence to set the foreground color to an
+    # approximation of a 4 or 8 bit per channel hex RGB color a la CSS.
+    #
+    # color - String containing hex digits describing the color to convert.
+    #         May be 4 or 8 bits per channel (3 or 6 characters long,
+    #         respectively).
+    #
+    # Examples
+    #
+    #   ConsoleGlitter::ANSI.hex_color("00FFFF")
+    #   # => "\033[38;5;51m"
+    #   ConsoleGlitter::ANSI.hex_color("F0F")
+    #   # => "\033[38;5;201m"
+    #
+    # Returns the appropriate escape code as a Fixnum.
+    def hex_color(color)
+      escape [38, 5, closest(color)].join(';')
+    end
+
+    # Public: Generate an escape sequence to set the bg color to an
+    # approximation of a 4 or 8 bit per channel hex RGB color a la CSS.
+    #
+    # color - String containing hex digits describing the color to convert.
+    #         May be 4 or 8 bits per channel (3 or 6 characters long,
+    #         respectively).
+    #
+    # Examples
+    #
+    #   ConsoleGlitter::ANSI.bg_hex_color("00FFFF")
+    #   # => "\033[38;5;51m"
+    #   ConsoleGlitter::ANSI.bg_hex_color("F0F")
+    #   # => "\033[38;5;201m"
+    #
+    # Returns the appropriate escape code as a Fixnum.
+    def bg_hex_color(color)
+      escape [48, 5, closest(color)].join(';')
+    end
+
+    private
+
+    # Internal: Allow on-the-fly definition of ANSI control sequences.  Methods
+    # are created for convenience which will either wrap the result of a block
+    # in the tag specified and a reset tag, or else simply return the code in
+    # question.
+    #
+    # name - String or Symbol containing the name of the constant to be
+    #        defined.
+    # code - ANSI escape code to be saved.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <name>(block)
+    #
+    # name  - Name specified.
+    # block - Optional block to be evaluated, the result of which will placed
+    #         in between the escape code specified.
+    def ansi(name, code)
+      code = escape(code)
+
+      define_method(name.to_sym) do |&block|
+        if block
+          "#{code}#{block.call}#{reset}"
+        else
+          code
+        end
+      end
+    end
+
+    # Internal: Parse a string describing either a 4 or 8 bit-per-channel color
+    # (similar to CSS formatting), matching it with the closest approximation
+    # for 256 color mode.
+    #
+    # color - String containing hex digits describing the color to convert.
+    #         May be 4 or 8 bits per channel (3 or 6 characters long,
+    #         respectively).
+    #
+    # Examples
+    #
+    #   ConsoleGlitter::ANSI.closest("00FFFF")
+    #   # => 51
+    #   ConsoleGlitter::ANSI.closest("F0F")
+    #   # => 201
+    #
+    # Returns the appropriate escape code as a Fixnum.
+    def closest(color)
+      bpc = 4
+      bpc *= 2 if color.length > 3
+      color = color.to_i(16)
+
+      blue = color % (1 << bpc)
+      green = ((color - blue) % (1 << (bpc * 2))) >> bpc
+      red = (color - (blue + green)) >> (bpc * 2)
+
+      # 216 (6**3) colors are mapped in 256 color mode (40 colors are otherwise
+      # reserved for normal and bold standard colors from 0x00 to 0x0f in
+      # addition to a 24 color gradient from black to white from 0xe8 - 0xff.)
+      [blue,green,red].each_with_index.map do |c,i|
+        (c/(((1 << bpc)-1)/5)) * 6**i
+      end.
+      reduce(&:+) + 0x10
+    end
+
+    # Define most common ANSI sequences 
+    ansi :reset,     0
+    ansi :bold,      1
+    ansi :faint,     2
+    ansi :underline, 4
+    ansi :blink,     5
+
+    ansi :black,   30
+    ansi :red,     31
+    ansi :green,   32
+    ansi :brown,   33
+    ansi :blue,    34
+    ansi :magenta, 35
+    ansi :cyan,    36
+    ansi :white,   37
+
+    ansi :bg_black,   40
+    ansi :bg_red,     41
+    ansi :bg_green,   42
+    ansi :bg_brown,   43
+    ansi :bg_blue,    44
+    ansi :bg_magenta, 45
+    ansi :bg_cyan,    46
+    ansi :bg_white,   47
+  end
+end

data/lib/console-glitter/version.rb

@@ -0,0 +1,3 @@
+module ConsoleGlitter
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: console-glitter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Wuest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-07 00:00:00.000000000 Z
+dependencies: []
+description: Tools for building nice looking CLI applications
+email: chris@chriswuest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/console-glitter.rb
+- lib/console-glitter/ansi.rb
+- lib/console-glitter/version.rb
+homepage: http://github.com/cwuest/console-glitter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Tools for prettier CLI apps
+test_files: []
+has_rdoc: