pecorb 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19e38304d5db7cc98da0f3660a476fe82f0cf272
-  data.tar.gz: cf6cc1aec755961576535947fa183bf1333c8c77
+  metadata.gz: dc95ef88893133f15ebad8a99f97f2c1dc2ad1c1
+  data.tar.gz: 51edf909a9588acaae62f4d7caffef90749b507d
 SHA512:
-  metadata.gz: 4508647eb8ed11ae58f10c380f8f4dd4297c7b00c3f9cb058d842924820cb2d64a21228834fbc00a4ac64450893bdc5d495fe5774b9905553c802739fb44bc27
-  data.tar.gz: 227b25c6d687dfc75ed4285e639aa3755ed1f1ff2b25526668fef5c59b13ff6274ea5c92ad95497b08160061e5d1e92cb0f6616b6e335aa30f53cab7edb9145b
+  metadata.gz: 46f6e081725eff2335c66f39419aed3633fb3129ae1621bba1ac1c6091e1429cbab228ab93fb173659cfa384b0ff254a24dccc3f26be5312d8cfa0920f7eb1b0
+  data.tar.gz: e61814a55c82e153708fd76ffb43605874f05201da8cd46ff64303dab70f84dada79f9fcd88d10742c085a8d9e578aed47b974042695794c8b3a7f412a95ca13

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pecorb (1.0.2)
+    pecorb (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -65,9 +65,17 @@ tag for the version, push git commits and tags, and push the `.gem` file to
 Bug reports and pull requests are welcome on GitHub at
 https://github.com/stevenocchipinti/pecorb.
 
-
 ## License
 
 The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
 
+## Kudos
+
+Inspiration and education came from these resources:
+- [inquirer.js](https://github.com/SBoudrias/Inquirer.js/)
+- [inquirer.rb](https://github.com/arlimus/inquirer.rb)
+- [peco](https://github.com/peco/peco)
+- [percol](https://github.com/mooz/percol)
+- [Random Access Terminal - Blog Post](http://graysoftinc.com/terminal-tricks/random-access-terminal)
+- [ANSI Escape Codes - Wikipedia](https://en.wikipedia.org/wiki/ANSI_escape_code)

data/lib/pecorb/console.rb

@@ -0,0 +1,56 @@
+require "io/console"
+
+module Console
+  CSI   = "\e["
+  UP    = "#{CSI}A"
+  DOWN  = "#{CSI}B"
+  RIGHT = "#{CSI}C"
+  LEFT  = "#{CSI}D"
+
+  def read_char
+    $stdin.echo = false
+    $stdin.raw!
+    input = $stdin.getc.chr
+    if input == "\e" then
+      input << $stdin.read_nonblock(3) rescue nil
+      input << $stdin.read_nonblock(2) rescue nil
+    end
+  ensure
+    $stdin.echo = true
+    $stdin.cooked!
+    return input
+  end
+
+  def print(val)          $stderr.print val                 end
+  def puts(val)           $stderr.puts val                  end
+  def output(val)         $stdout.puts val                  end
+
+  def up(n=1)             $stderr.print "#{CSI}#{n}A"       end
+  def down(n=1)           $stderr.print "#{CSI}#{n}B"       end
+  def right(n=1)          $stderr.print "#{CSI}#{n}C"       end
+  def left(n=1)           $stderr.print "#{CSI}#{n}D"       end
+
+  def backspace(n=1)      $stderr.print "\b"*n              end
+  def carriage_return()   $stderr.print "\r"                end
+  def clear_to_eol()      $stderr.print "#{CSI}K"           end
+  def clear_screen()      $stderr.print "#{CSI}H#{CSI}J"    end
+
+  def black()             $stderr.print "#{CSI}#{CSI}30m"   end
+  def red()               $stderr.print "#{CSI}#{CSI}31m"   end
+  def green()             $stderr.print "#{CSI}#{CSI}32m"   end
+  def yellow()            $stderr.print "#{CSI}#{CSI}33m"   end
+  def blue()              $stderr.print "#{CSI}#{CSI}34m"   end
+  def magenta()           $stderr.print "#{CSI}#{CSI}35m"   end
+  def cyan()              $stderr.print "#{CSI}#{CSI}36m"   end
+  def white()             $stderr.print "#{CSI}#{CSI}37m"   end
+  def reset_color()       $stderr.print "#{CSI}#{CSI}0m"    end
+
+  def save_pos
+    $stderr.print "#{CSI}s"
+    if block_given?
+      yield
+      load_pos
+    end
+  end
+  def load_pos() $stderr.print "#{CSI}u" end
+end

data/lib/pecorb/version.rb

@@ -1,3 +1,3 @@
 module Pecorb
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/pecorb.rb

@@ -1,14 +1,9 @@
 require_relative "pecorb/version"
-require "io/console"
+require_relative "pecorb/console"
 
 module Pecorb
   extend self
-
-  KILL_LINE_CHAR = "\x1B[K"
-  CURSOR_UP_CHAR = "\x1B[A"
-  CSI = "\e["
-  SELECTED_COLOR = "#{CSI}\e[36m"
-  RESET_COLOR = "#{CSI}\e[0m"
+  extend Console
 
   @input = ""
   @cursor = 0
@@ -21,9 +16,7 @@ module Pecorb
     @displayed_items = @items = items
     @prompt = prompt
 
-    $stderr.puts prompt
-    print_items(items)
-    move_cursor_from_end_to_start
+    print_menu
 
     while c = read_char
       case c
@@ -32,85 +25,86 @@ module Pecorb
       when /[]/
         @input = ""
         break
+      when /[]/
+        clear_screen
+        print_menu
       when "" # Backspace key
         next if @input.empty? || @cursor <= 0
         @input.slice!(@cursor-1)
         replace_input(@input)
         replace_items { filter_items(@items, @input) }
-        $stderr.print "\b"
+        backspace
         @cursor -= 1
-      when "#{CSI}D" # Left arrow key
+      when Console::LEFT
         next unless @cursor > 0
-        $stderr.print c
+        print c
         @cursor -= 1
-      when "#{CSI}C" # Right arrow key
+      when Console::RIGHT
         next unless @cursor < @input.length
-        $stderr.print c
+        print c
         @cursor += 1
-      when "#{CSI}A" # Up arrow key
-        @selected -= 1 if @selected > 0
+      when Console::UP
+        @selected = (@selected - 1) % @displayed_items.size
         replace_items { filter_items(@items, @input) }
-      when "#{CSI}B" # Down arrow key
-        @selected += 1 if @selected < @displayed_items.size - 1
+      when Console::DOWN
+        @selected = (@selected + 1) % @displayed_items.size
         replace_items { filter_items(@items, @input) }
       else
         @input.insert(@cursor, c)
         replace_input(@input)
         replace_items { filter_items(@items, @input) }
-        $stderr.print c
+        print c
         @cursor += 1
       end
     end
 
     move_cursor_from_start_to_end
-    $stdout.puts @displayed_items[@selected]
+    output @displayed_items[@selected]
     @displayed_items[@selected]
   end
 
   private
 
-  def move_cursor_from_end_to_start
-    # Move up x times and right y times
-    $stderr.print "#{CSI}#{@displayed_items.size+1}A#{CSI}#{@prompt.length}C"
+  def print_menu
+    puts @prompt
+    print_items(@displayed_items)
+    move_cursor_from_end_to_start
+    print @input
   end
 
-  def move_cursor_from_start_to_end
-    # Move down x times and then to the start of the line
-    $stderr.print "#{CSI}#{@displayed_items.size+1}B\r"
+  def move_cursor_from_end_to_start
+    up(@displayed_items.size + 1)
+    right(@prompt.size)
   end
 
-  def read_char
-    $stdin.echo = false
-    $stdin.raw!
-    input = $stdin.getc.chr
-    if input == "\e" then
-      input << $stdin.read_nonblock(3) rescue nil
-      input << $stdin.read_nonblock(2) rescue nil
-    end
-  ensure
-    $stdin.echo = true
-    $stdin.cooked!
-    return input
+  def move_cursor_from_start_to_end
+    down(@displayed_items.size + 1)
+    carriage_return
   end
 
   def replace_input(str)
-    $stderr.print "#{CSI}s"
-    $stderr.print "\b"*@cursor
-    $stderr.print "#{@input}#{CSI}K"
-    $stderr.print "#{CSI}u"
+    save_pos do
+      backspace(@cursor)
+      print @input
+      clear_to_eol
+    end
   end
 
   def replace_items
     return unless block_given?
-    $stderr.print "#{CSI}s"
-    $stderr.print "#{CSI}\r"
-    $stderr.print "#{CSI}B#{CSI}K" * @displayed_items.size
-    $stderr.print "#{CSI}A" * (@displayed_items.size - 1) if @displayed_items.size > 0
-    new_items = yield
-    @displayed_items = new_items
-    @selected = limit_max @selected, @displayed_items.size - 1
-    print_items new_items
-    $stderr.print "#{CSI}u"
+    list_size = @displayed_items.size
+    save_pos do
+      down
+      carriage_return
+      clear_to_eol
+      if list_size > 0
+        (list_size - 1).times { down; clear_to_eol}
+        (list_size - 1).times { up }
+      end
+      @displayed_items = yield
+      @selected = limit_max @selected, list_size - 1
+      print_items @displayed_items
+    end
   end
 
   def limit_max(n, max)
@@ -119,7 +113,14 @@ module Pecorb
 
   def print_items(items)
     items.each_with_index do |item, i|
-      $stderr.puts "#{@selected == i ? "#{SELECTED_COLOR}‣" : " "} #{item}#{RESET_COLOR}"
+      if @selected == i
+        cyan
+        print "‣ "
+      else
+        print "  "
+      end
+      puts item
+      reset_color
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pecorb
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Steven Occhipinti
@@ -68,6 +68,7 @@ files:
 - Rakefile
 - bin/pecorb
 - lib/pecorb.rb
+- lib/pecorb/console.rb
 - lib/pecorb/version.rb
 - pecorb.gemspec
 - pecorb/.gitignore