term 0.9.1

data/lib/term/confirm.rb

@@ -0,0 +1,64 @@
+# cording: utf-8
+
+require 'term/redio'
+
+require 'term/color'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class String
+
+  def ok?
+    print "#{self}? ".green
+    @begin_confirm_pos = IO.hide.pos
+    process_confirm_input
+    IO.show
+    @res
+  end
+
+  private
+
+  # print confirm.
+  def print_confirm(confirm, run)
+    IO.to @begin_confirm_pos
+    if @res = confirm
+      print '✔'.red
+      print ' ✖' if run
+    else
+      print '✔ ' if run
+      print '✖'.red
+    end
+    @confirm_loop = run
+  end
+
+  # process confirm input confirm event.
+  def process_confirm_input
+    print_confirm(true, true)
+    @confirm_loop = true
+    while @confirm_loop
+      input = IO.input
+      process_confirm_mouse_click input
+      process_confirm_keyboard_input input[:key]
+    end
+  end
+
+  # process confirm mouse confirm event.
+  def process_confirm_mouse_click(input)
+    if (input[:type] == :left_pressed) && (input[:pos][:y] == @begin_confirm_pos[:y])
+      if input[:pos][:x] == @begin_confirm_pos[:x]
+        print_confirm(true, false)
+      elsif input[:pos][:x] == @begin_confirm_pos[:x] + 2
+        print_confirm(false, false)
+      end
+    end
+  end
+
+  # process confirm keyboard confirm event.
+  def process_confirm_keyboard_input(key)
+    case key
+    when :enter then print_confirm(@res, false)
+    when :Y, :y then print_confirm(true, false)
+    when :N, :n then print_confirm(false, false)
+    when :tab, :down, :left, :space, :up, :right then print_confirm(!@res, true)
+    end
+  end
+end

data/lib/term/cursor.rb

@@ -0,0 +1,177 @@
+# coding: utf-8
+
+require 'io/console'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class IO
+  # move cursor to home position (0-0).
+  #
+  # @return [self] Term self.
+  def self.home
+    print "\e[H"
+    self
+  end
+
+  # save current cursor position & attrs.
+  #
+  # @return [Term] Term self.
+  def self.save
+    print "\e7"
+    self
+  end
+
+  # restore saved cursor position & attrs.
+  #
+  # @return [Term] Term self.
+  def self.restore
+    print "\e8"
+    self
+  end
+
+  # make cursor invisible.
+  #
+  # @return [Term] Term self.
+  def self.hide
+    print "\e[?25l"
+    self
+  end
+
+  # make cursor visible.
+  #
+  # @return [Term] Term self.
+  def self.show
+    print "\e[?25h"
+    self
+  end
+
+  # query cursor position.
+  #
+  # @return [Hash] pos cursor position.
+  def self.pos
+    $stdin.raw do
+      print "\e[6n"
+      y_axis, x_axis = $stdin.gets('R')[2..-2].split(';')
+      { x: x_axis.to_i - 1, y: y_axis.to_i - 1 }
+    end
+  end
+
+  # home-positioning to x and y coordinates.
+  # @param pos [Hash] opt the coordinates
+  # @option opt [Integer] x the x coordinates, default 0
+  # @option opt [Integer] y the y coordinates, default 0
+  # @return [Term] Term self.
+  def self.to(pos)
+    x_axis = pos[:x] || 0
+    y_axis = pos[:y] || 0
+    print "\e[#{y_axis + 1};#{x_axis + 1}H" # ANSI uses 1-1 as home
+    self
+  end
+
+  # moves the cursor up by num rows.
+  #
+  # @param num [Integer] the rows, the default num is 1.
+  # @return [Term] Term self.
+  def self.up(num = 1)
+    print "\e[#{num}A" # CUU
+    self
+  end
+
+  # moves the cursor down by num rows.
+  #
+  # @param num [Integer] the rows, the default num is 1.
+  # @return [Term] Term self.
+  def self.down(num = 1)
+    print "\e[#{num}B" # CUD
+    self
+  end
+
+  # moves the cursor forward by num columns.
+  #
+  # @param num [Integer] the columns, the default num is 1.
+  # @return [Term] Term self.
+  def self.forward(num = 1)
+    print "\e[#{num}C" # CUF
+    self
+  end
+
+  # moves the cursor backward by num columns.
+  #
+  # @param num [Integer] the columns, the default num is 1.
+  # @return [Term] Term self.
+  def self.backward(num = 1)
+    print "\e[#{num}D" # CUB
+    self
+  end
+
+  # cursor next line num times.
+  #
+  # @param num [Integer] the times, the default num is 1.
+  # @return [Term] Term self.
+  def self.next_line(num = 1)
+    print "\e[#{num}E"
+    self
+  end
+
+  # cursor preceding line num times.
+  #
+  # @param num [Integer] the times, the default num is 1.
+  # @return [Term] Term self.
+  def self.prev_line(num = 1)
+    print "\e[#{num}F"
+    self
+  end
+
+  # clear screen.
+  #
+  # @note cursor position unchanged
+  # @return [Term] Term self.
+  def self.clear
+    print "\e[2J"
+    self
+  end
+
+  # clear line from current cursor position to end of line.
+  #
+  # @note cursor position unchanged
+  # @return [Term] Term self.
+  def self.clear_forward
+    print "\e[K"
+    self
+  end
+
+  # clear line from beginning to current cursor position.
+  #
+  # @note cursor position unchanged
+  # @return [Term] Term self.
+  def self.clear_backward
+    print "\e[1K"
+    self
+  end
+
+  # clear whole line.
+  #
+  # @note cursor position unchanged
+  # @return [Term] Term self.
+  def self.clear_line
+    print "\e[2K"
+    self
+  end
+
+  # erase the screen from the current line up to the top of the screen.
+  #
+  # @note cursor position unchanged
+  # @return [Term] Term self.
+  def self.clear_up
+    print "\e[1J"
+    self
+  end
+
+  # erase the screen from the current line down to the top of the screen.
+  #
+  # @note cursor position unchanged
+  # @return [Term] Term self.
+  def self.clear_down
+    print "\e[J"
+    self
+  end
+end

data/lib/term/font.rb

@@ -0,0 +1,23 @@
+# cording: utf-8
+
+require 'artii'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class String
+  # string fonts builder cache hash.
+  class << self; attr_accessor :fonts end
+  @fonts = {}
+
+  # set the font.
+  #
+  # @note using `artii` gem.
+  #   typing `artii -l` to see all fonts.
+  # @example
+  #   puts "term".font('big')
+  # @param name [String] the font name
+  # @return [String] string with the font style.
+  def font(name)
+    font_builder = self.class.fonts[name.to_s] ||= Artii::Base.new(font: name)
+    font_builder.output self
+  end
+end

data/lib/term/input.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require 'term/cursor'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class IO
+  # get keybord & mouse key.
+  #
+  # @return [Hash] keybord & mouse key
+  def self.input
+    $stdin.raw do
+      print "\e[?1000h" # DEC Private Mode Set
+      str = $stdin.readpartial(4096).force_encoding('utf-8')
+      print "\e[?1000l" # DEC Private Mode Reset
+      parse_key_str str
+    end
+  end
+
+  # keybord & mouse hash.
+  KEY = {
+    "\e[A" => :up,
+    "\e[B" => :down,
+    "\e[C" => :right,
+    "\e[D" => :left,
+    "\t" => :tab,
+    "\r" => :enter,
+    ' ' => :space,
+    "\e\[M" => :mouse
+  }.freeze
+
+  # parse key str
+  def self.parse_key_str(str)
+    key = KEY[str[0, 3]] || str.to_sym
+    if key == :mouse
+      type, mouse_x, mouse_y = str[3, 3].unpack('CCC')
+      type = %i(left_pressed scroll_down right_pressed released)[type & 0b11]
+      { key: key, type: type, pos: { x: mouse_x - 33, y: mouse_y - 33 } }
+    else
+      { key: key }
+    end
+  end
+end

data/lib/term/password.rb

@@ -0,0 +1,63 @@
+# coding: utf-8
+
+require 'term/input'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class IO
+  # get password.
+  #
+  # @return [String] password
+  def self.password
+    @begin_password_pos = IO.hide.pos
+    hide_password_text
+    process_password_input
+    IO.show
+    @password_text || ''
+  end
+
+  # process password input event.
+  def self.process_password_input
+    @redio_loop = true
+    while @redio_loop
+      input = IO.input
+      process_password_mouse_click input
+      process_password_keyboard_input input[:key]
+    end
+  end
+  private_class_method :process_password_input
+
+  # process keyboard input event.
+  def self.process_password_keyboard_input(key)
+    @password_text ||= ''
+    @password_text << key.to_s if key.size == 1
+    @redio_loop = false if key == :enter
+  end
+  private_class_method :process_password_keyboard_input
+
+  # process mouse click event.
+  def self.process_password_mouse_click(input)
+    type = input[:type]
+    pos = input[:pos]
+    if (type == :left_pressed) && (pos == @end_password_pos)
+      show_password_text
+    else
+      hide_password_text
+    end
+  end
+  private_class_method :process_password_mouse_click
+
+  # hide password text.
+  def self.hide_password_text
+    IO.to(@begin_password_pos).clear_forward
+    print '🔑 : ⚫ ⚫ ⚫ ⚫ ⚫ ⚫ ⚫ ⚫ 👁️'
+    @end_password_pos ||= IO.pos
+  end
+  private_class_method :hide_password_text
+
+  # show password text.
+  def self.show_password_text
+    IO.to(@begin_password_pos).clear_forward
+    print "🔑 : #{@password_text || ''}"
+  end
+  private_class_method :show_password_text
+end

data/lib/term/process_bar.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+require 'term/window'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class Numeric
+  # get process bar.
+  #
+  # @example process bar
+  #   print i.process_bar
+  # @param width [Integer] process width
+  # @return [String] process bar
+  def process_bar(width = IO.width - 8)
+    percent = format(' %3d%', self)
+    line = '-' * width
+    if self <= 0
+      "[#{line.insert(0, '🛫')}]#{percent}"
+    elsif self >= 100
+      "[#{line.insert(-1, '🛬')}]#{percent}"
+    else
+      "[#{line.insert((self / 100.0 * width).to_i, '✈️')}]#{percent}"
+    end
+  end
+end

data/lib/term/qrcode.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+require 'rqrcode'
+
+require 'term/color'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+class String
+  # get qrcode.
+  #
+  # @return [String] qrcode
+  def qrcode
+    RQRCode::QRCode.new(self).as_ansi(quiet_zone_size: 0)
+  end
+end

data/lib/term/redio.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+
+require 'term/cursor'
+require 'term/input'
+
+# @author {mailto:cuihaiqin@gmail.com cuihq}
+module Enumerable
+  # the redio Component.
+  #
+  # @example redio
+  #   ['a', 'b', 7].redio
+  # @return [Object] the redio val
+  def redio
+    size.times { print $/ }
+    @begin_pos = IO.up(size).hide.pos
+    process_input_redio
+    IO.show
+    @redio_res
+  end
+
+  private
+
+  # print redio.
+  def print_redio(index = 0)
+    IO.to @begin_pos
+    @redio_res = index.to_i % size
+    @item_ys = []
+    each_with_index do |item, num|
+      print_redio_item item, num
+    end
+  end
+
+  # print redio item.
+  def print_redio_item(item, num)
+    @item_ys[num] = IO.pos[:y]
+    print "#{@redio_res == num ? '🔘' : '⭕️'} #{num}. #{item}#{$/}"
+  end
+
+  # process redio input.
+  def process_input_redio
+    print_redio
+    @redio_loop = true
+    while @redio_loop
+      input = IO.input
+      process_redio_mouse_click input
+      process_redio_keyboard_input input[:key]
+    end
+  end
+
+  # process redio mouse click event.
+  def process_redio_mouse_click(input)
+    if input[:type] == :left_pressed
+      list_item = @item_ys.find_index input[:pos][:y]
+      print_redio list_item if list_item
+      @redio_loop = false
+    end
+  end
+
+  # process redio keyboard input event.
+  def process_redio_keyboard_input(key)
+    case key
+    when :enter then @redio_loop = false
+    when /\d/ then print_redio(key.to_s)
+    when :tab, :down, :left, :space then print_redio(@redio_res.succ)
+    when :up, :right then print_redio(@redio_res.pred)
+    end
+  end
+end