console_view_helper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODQwZGVlN2QyY2I2MWJkNjQ1Yjk0Y2NhNDhlYTZlYTFmYTJkMmQwYQ==
+    N2I4ZWY4MmQ5NjIwYWI1NWJkZjUzZWJhMTE3OGM1YTk3NmJjN2QyMg==
   data.tar.gz: !binary |-
-    NDAyNmUzYjZkZGFiNzA3MzkyOWJmMjdiNDY0NTFhN2RkMjI2ZWI3Zg==
+    OWQ3NWU0ZGRjZDVkNzdiYjEzNmE3YmU3NTkwNDZiM2Q1MmU5ZWU0Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZmFiZGE2MmY2MjliMjU2NjgwZWU1Y2M0Y2IwNzAzZjk4NDUxMGZkMGVkYWU5
-    Nzg3ZTMxNjkxNDI0ZmFiY2Y5M2QzYmQ1ZTM3NGNiZjRlZTBmYTRiNDdhM2M2
-    YzU3ODVhOGZmYWI1ODY3NGM3Yzc0Njc3ZjQwNDBkZmI3MGRmODM=
+    NmEwYjljOWZlZjUwZGRhOGU1NTU3NjNhNzk4Yzk2NTRkY2E3M2U4YjIwZTRl
+    N2RiNDA0OGFhMDRlYTA1NWJiODAxNWY2ZGI5N2U1ZDk2YTUwMTI0OTI5YjM4
+    NzEzYjQ5YmFhYWZkNzAzZTQzYjYyYTQ5ZmJiYmE3OTUwNWEyZjk=
   data.tar.gz: !binary |-
-    MTJjOGM5OWY2Yjk1MTZhYTQ3YjgyMTVjYjdhNTgyNjA4Yzg3NzkzOWMzNTE0
-    ODA3NjI3ODYxOWZjZDcyNDNjOTU3ZjFlYzNhMzAyMWI4ZmJkYTUwMmExNDIz
-    N2FiYmExMzMyNDA5NDA0NmM2ZDljMTU3ZDM3ZDJiMDNmZWE2NDk=
+    MTZlZjdmZmUzNDM2OGJjZjZjZDRmZWMwZWI0NjIxOGJjN2U5OTMwY2NlOWE3
+    YzNhYWY2NGUxYmIxYmI2MmE4NWE0MWUwNDY4N2VjYmZiM2Y4Y2JkZWEzYTBk
+    ZWRkZWIxNjFmOTExNTIzODQ2MzU4ZGYwMDUwMDZjMTNhODIyZGQ=

data/lib/console_view_helper.rb

@@ -1,162 +1,201 @@
-# Encoding: utf-8
-
-# Requires
-require 'io/console'
-require 'colored'
-
-module ConsoleViewHelper
-
-  #########################
-  #        GENERAL        #
-  #########################
-
-  # Indent n times
-  def idt(n = 1)
-    "\t" * n
-  end
-
-  # Asterisk n times
-  def astk(n = 1)
-    '*' * n
-  end
-
-  # New n lines
-  def nl(n = 1)
-    "\n" * n
-  end
-
-  # Hyphen n times
-  def hyphen(n = 1)
-    '-' * n
-  end
-
-  # Underscore n times
-  def underscore(n = 1)
-    '_' * n
-  end
-
-  # Bar n times
-  def bar(n = 1)
-    '|' * n
-  end
-
-  # Whitespace n times
-  def whites(n = 1)
-    ' ' * n
-  end
-
-  # Align text
-  def align(text, size, direction = :left, append = ' ')
-    case direction
-    when :right
-      text.rjust(size, append)
-    when :center
-      text.center(size, append)
-    else
-      text.ljust(size, append)
-    end
-  end
-
-  # 'print' text indented n times
-  def printi(text, n = 1)
-    print idt(n) + text
-  end
-
-  # 'put' text indented n times
-  def putsi(text, n = 1)
-    puts idt(n) + text
-  end
-
-  # Display a fake loading effect
-  def loading_effect(n = 3, opts = {})
-    delay = opts[:delay] || 0.3
-    symbol = opts[:symbol] || '.'
-    1.upto(n) do
-      print symbol
-      sleep delay
-    end
-    nil
-  end
-
-  # Explain the action being performed
-  def explain(doing_txt, done_txt, n = 1, &block)
-    printi doing_txt, n
-    loading_effect
-    result = block.call
-    puts done_txt
-    result
-  end
-
-  # Highlight text with color
-  def colorize(text, status = :normal)
-    case status
-    when :success
-      text.green
-    when :error
-      text.red
-    when :warning
-      text.yellow
-    when :neutral
-      text.blue
-    else
-      text.white
-    end
-  end
-
-  #########################
-  #       COMPONENTS      #
-  #########################
-
-  # Banner
-  def banner(title, opts = {})
-    subtitle = opts[:subtitle]
-    base_width = (subtitle && subtitle.length > title.length ? subtitle.length : title.length) + 4
-    width = opts[:width] || base_width
-    n = opts[:indent] || 0
-    banner = idt(n) + astk(width + 2) + nl
-    banner << idt(n) + astk + whites(width) + astk + nl
-    banner << idt(n) + astk + align(title, width, :center) + astk + nl
-    banner << idt(n) + astk + align(subtitle, width, :center) + astk + nl if subtitle
-    banner << idt(n) + astk + whites(width) + astk + nl
-    banner << idt(n) + astk(width + 2) + nl
-  end
-
-  # User input
-  def input(label = '>>', n = 0)
-    printi label + whites, n
-    gets.strip.chomp
-  end
-
-  # User input, but hidden
-  def hidden_input(label = '>>', n = 0)
-    printi label + whites, n
-    STDIN.noecho(&:gets).strip.chomp
-  end
-
-  # --- 
-  module_function :idt, :astk, :nl, :hyphen, :underscore, :whites, :align, :printi, :putsi, :loading_effect, :explain, :colorize, :banner, :input, :hidden_input
-end
-
-
-# -------------------------- CONSOLE VIEW HELPER ------------------------------
-# - Helper methods to build simple and clean console application interfaces.
-
-# --- HOW TO USE ---
-# - Require and optionally include the module in your view file
-# require 'cosole_view_helper'
-# include ConsoleViewHelper
-
-# - When just required call the methods from the module name
-# ConsoleViewHelper.input 'username:'
-
-# - When included call the methods directly
-# input 'username:'
-
-# --- WINDOW USERS ---
-# - In order to use the 'colorize' method you will need the 'win32console' gem.
-
-# - Get it:
-# gem install 'win32console'
-
-# - Require it:
-# require 'win32console'
+# Encoding: utf-8
+
+# Requires
+require 'io/console'
+require 'colored'
+
+module ConsoleViewHelper
+
+  #########################
+  #        GENERAL        #
+  #########################
+
+  # Indent n times
+  def idt(n = 1)
+    "\t" * n
+  end
+
+  # Asterisk n times
+  def astk(n = 1)
+    '*' * n
+  end
+
+  # New n lines
+  def nl(n = 1)
+    "\n" * n
+  end
+
+  # Hyphen n times
+  def hyphen(n = 1)
+    '-' * n
+  end
+
+  # Underscore n times
+  def underscore(n = 1)
+    '_' * n
+  end
+
+  # Bar n times
+  def bar(n = 1)
+    '|' * n
+  end
+
+  # Whitespace n times
+  def whites(n = 1)
+    ' ' * n
+  end
+
+  # Align text
+  def align(text, size, direction = :left, append = ' ')
+    case direction
+    when :right
+      text.rjust(size, append)
+    when :center
+      text.center(size, append)
+    else
+      text.ljust(size, append)
+    end
+  end
+
+  # 'print' text indented n times
+  def printi(text, n = 1)
+    print idt(n) + text
+  end
+
+  # 'put' text indented n times
+  def putsi(text, n = 1)
+    puts idt(n) + text
+  end
+
+  # Display a fake loading effect
+  def loading_effect(n = 3, opts = {})
+    delay = opts[:delay] || 0.3
+    symbol = opts[:symbol] || '.'
+    1.upto(n) do
+      print symbol
+      sleep delay
+    end
+    nil
+  end
+
+  # Explain the action being performed
+  def explain(doing_txt, done_txt = '', n = 1, &block)
+    printi doing_txt, n
+    loading_effect
+    result = block.call
+    puts done_txt
+    result
+  end
+
+  # Highlight text with color
+  def colorize(text, status = :normal)
+    case status
+    when :success
+      text.green
+    when :error
+      text.red
+    when :warning
+      text.yellow
+    when :neutral
+      text.blue
+    else
+      text.white
+    end
+  end
+
+  #########################
+  #       COMPONENTS      #
+  #########################
+
+  # Banner
+  def banner(title, opts = {})
+    n = opts[:indent] || 0
+    symbol = opts[:symbol] || '*'
+    subtitle = opts[:subtitle]
+    base_width = (subtitle && subtitle.length > title.length ? subtitle.length : title.length) + 4
+    width = opts[:width] || base_width
+    raise ArgumentError.new("Specified width can't be minor thant #{base_width}. Increase or remove the width value.") if width < base_width
+    banner = idt(n) + (symbol * (width + 2)) + nl
+    banner << idt(n) + symbol + whites(width) + symbol + nl
+    banner << idt(n) + symbol + align(title, width, :center) + symbol + nl
+    banner << idt(n) + symbol + align(subtitle, width, :center) + symbol + nl if subtitle
+    banner << idt(n) + symbol + whites(width) + symbol + nl
+    banner << idt(n) + (symbol * (width + 2)) + nl
+  end
+
+  # Table
+  def table(columns, opts = {})
+    raise ArgumentError.new('Pass table columns as an array of arrays') unless columns.is_a?(Array) && columns.select { |item| !item.is_a?(Array) }.empty?
+    # Set options
+    n = opts[:indent] || 0
+    cell_width = opts[:cell_width] || 12
+    cell_separator = opts[:cell_separator] || bar
+    cell_border = opts[:cell_border] || hyphen
+    if opts[:header]
+      opts[:header].each_with_index do |th, i|
+        columns.push [] unless columns[i]
+        columns[i].unshift(th)
+      end
+    end
+    td_width = cell_width - 2
+    tr_width = (cell_width * columns.length) + columns.length + 1
+    
+    # Build table
+    pos, table = 0, ''
+    begin
+      tr_empty_elems = 0
+      tr_str = idt(n) + (cell_border * tr_width) + nl + cell_separator
+      columns.each do |column|
+        td = if column[pos]
+          column[pos]
+        else
+          tr_empty_elems += 1
+          ''
+        end
+        td = align(td[0..td_width], cell_width, :center)
+        tr_str << td + cell_separator 
+      end
+      tr_str << nl
+      table << tr_str if tr_empty_elems != columns.length
+      pos += 1
+    end while tr_empty_elems != columns.length
+    table << idt(n) + (cell_border * tr_width)
+  end
+
+  
+  # List (unordered)
+  def list(items, opts = {})
+    raise ArgumentError.new('Pass list items in an array.') unless items.is_a? Array
+    n = opts[:indent] || 0
+    li_gap = opts[:li_gap] || 1
+    symbol = opts[:symbol] || '•'
+    list = idt(n)
+    items.each_with_index do |li, i|
+      symbol = opts[:ordered] ? "#{i + 1}." : symbol
+      list << symbol + ' ' + li + nl(li_gap) + idt(n)
+    end
+    list
+  end
+  alias_method :ulist, :list
+
+  # Ordered List
+  def olist(items, opts = {})
+    list items, opts.merge(ordered: true)
+  end
+  alias_method :menu, :olist
+
+  # User input
+  def input(label = '>>', n = 0)
+    printi label + whites, n
+    gets.strip.chomp
+  end
+
+  # User input, but hidden
+  def hidden_input(label = '>>', n = 0)
+    printi label + whites, n
+    STDIN.noecho(&:gets).strip.chomp
+  end
+
+  # --- 
+  module_function :idt, :astk, :nl, :hyphen, :underscore, :bar, :whites, :align, :printi, :putsi, :loading_effect, :explain, :colorize, :banner, :menu, :table, :list, :olist, :ulist, :input, :hidden_input
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console_view_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alfonso Mancilla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -24,15 +24,24 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Set of methods and components I use commonly when building console application
-  interfaces.
-email: almancill@gmail.com
+description: ! 'The console_view_helper library is used to build clean and beautiful
+  console application interfaces.
+
+  Customizable Components such as banners, tables, menus, lists, text inputs, hidden
+  text inputs and
+
+  methods as colorize,  putsi, printi, align, explain, among others,
+
+  will help you build a good console application interface with less code and in less
+  time.'
+email:
+- almancill@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/console_view_helper.rb
-homepage: http://rubygems.org/gems/console_view_helper
+homepage: https://github.com/ammancilla/console_view_helper
 licenses:
 - MIT
 metadata: {}
@@ -55,5 +64,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Helper methods to build simple and clean console application interfaces
+summary: Set of components and methods used to build clean and beautiful console application
+  interfaces.
 test_files: []