ansi-select 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d261e8c4cb86463bfba558e2c3104c30679d5a02
-  data.tar.gz: 43851d45c17b1a4da2cce1da10952cceeea302ef
+  metadata.gz: e0b7678dcd7b0eb448dc1ffa8cd3ee7621c89093
+  data.tar.gz: 4e7f2a784d81aa8c3e488715ab795381ec87fcd1
 SHA512:
-  metadata.gz: 691c63cfcfad6589ad5d423e8e8fb3b6c204054a998a841728c5bb63dfd8260296fcfc09f5094f4e879fc0ba881cdc7c7a2fd08fbb870fd6a56d0c3e21159852
-  data.tar.gz: 3f5777142597d125447659e280377941481d78559863b12f5180df015de50e58c417ad02c9af6e6521a5c3daec06f68ba06f58b55153019267031089b569c758
+  metadata.gz: 008e8fa95ec62bfcf6ebb7233b3b4f6cc360fe3ef275ce3f515d4955fef24783bc92e589ff1d1b3c6ed694c4c08c64e0f353786c4f84fa7d62fbfbd8706ae088
+  data.tar.gz: 709585d4347c5398ac9030d4566f8f5fe6827aeca847fe065778f776c47876754219e62c4eca4ff87749eb541a32ce6bea7b0585c93ab5d36ef3e0752f87e7cb

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.3.0
+
+* Fix default formatter not defined error.
+* Add ellipsis to options that don't fit into the screen.
+* Re-render on terminal resize.
+* Scroll if options don't fit into the terminal.
+
 ### 0.2.5
 
 * Allow to preselect options.

data/bin/ansi-select

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'ansi/selector'
+require_relative '../lib/ansi/selector'
 
 method_name = ARGV.include?('--multi') ? :multi_select : :select
 

data/lib/ansi/selector.rb

@@ -1,32 +1,34 @@
 module Ansi
   class Selector
-    # @param [Array<Object>] options
-    # @param [Proc] formatter
-    # @param [Fixnum] preselected
-    #
-    # @return [Object] option
-    def self.select(options, formatter: default_formatter, preselected: 0)
-      require_relative "selector/single_impl"
+    class << self
+      # @param [Array<Object>] options
+      # @param [Proc] formatter
+      # @param [Fixnum] preselected
+      #
+      # @return [Object] option
+      def select(options, formatter: default_formatter, preselected: 0)
+        require_relative "selector/single_impl"
 
-      SingleImpl.new(options, formatter, preselected).select
-    end
+        SingleImpl.new(options, formatter, preselected).select
+      end
 
-    # @param [Array<Object>] options
-    # @param [Proc] formatter
-    # @param [Array<Fixnum>] preselected
-    #
-    # @return [Array<Object>] option
-    def self.multi_select(options, formatter: default_formatter, preselected: [])
-      require_relative "selector/multi_impl"
+      # @param [Array<Object>] options
+      # @param [Proc] formatter
+      # @param [Array<Fixnum>] preselected
+      #
+      # @return [Array<Object>] option
+      def multi_select(options, formatter: default_formatter, preselected: [])
+        require_relative "selector/multi_impl"
 
-      MultiImpl.new(options, formatter, preselected).select
-    end
+        MultiImpl.new(options, formatter, preselected).select
+      end
 
-    private
+      private
 
-    # @return [Proc]
-    def default_formatter
-      ->(option) { option.name }
+      # @return [Proc]
+      def default_formatter
+        :to_s.to_proc
+      end
     end
   end
 end

data/lib/ansi/selector/impl.rb

@@ -16,20 +16,54 @@ module Ansi
         @formatter = formatter
         @highlighted_line_index = 0
         @cursor_line_index = 0
+        @columns = terminal_columns
 
         # Converts options to column-aligned strings.
-        formatted = @options.map(&@formatter).map(&method(:Array))
+        formatted = @options.map(&@formatter).map(&method(:Array)).map { |line| line.map(&method(:strip_ansi_colors)) }
         @formatted ||= formatted.map do |f|
           f.map.with_index do |part, column|
             width = formatted.map { |fm| fm[column] }.compact.map(&:size).max
             part.to_s.ljust(width)
           end.join('  ')
         end
+
+        Signal.trap('SIGWINCH', proc do
+          columns = terminal_columns
+          if columns < @columns && !all_options_fit?(columns)
+            # When a buffer gets narrower, the text that doesn't fit into the screen anymore
+            # starts jumping around in a way that makes it hard to predict. In such case we
+            # clear everything and re-print options at the beginning of the buffer to
+            # simplify things.
+            tty.print(`printf '\e[2J'`)
+            tty.print(`tput cup 0 0`)
+          else
+            print_line(0)
+          end
+
+          @columns = columns
+          print_options
+        end)
+      end
+
+      def all_options_fit?(columns)
+        option_indices.map(&method(:final_text_for_line)).map(&:size).all? { |size| size < columns }
+      end
+
+      # @return [Fixnum]
+      def terminal_columns
+        `tput cols`.to_i
+      end
+
+      # @return [Fixnum]
+      def terminal_lines
+        `tput lines`.to_i
       end
 
       def select
         print_options
         answer = ask_to_choose
+        # We need to reprint here in order to render the lines that are behind the buffer.
+        range(@highlighted_line_index, @options.size - 1).each(&method(:print_line))
         go_to_line(@options.size)
 
         answer
@@ -45,16 +79,16 @@ module Ansi
       end
 
       def print_options
-        @options.each.with_index do |_, index|
-          print_line(index, index == @highlighted_line_index)
+        @options[0...terminal_lines].each.with_index do |_, index|
+          print_line(index)
 
           unless index == @options.size - 1
-            tty.print $/ # This strange thing is a cross-platform new line.
+            tty.print $/ # This global variable is a cross-platform new line.
             @cursor_line_index += 1
           end
         end
 
-        go_to_line(0)
+        print_line(0)
       end
 
       # @return [String]
@@ -81,38 +115,36 @@ module Ansi
           when "\u0003", "q"
             exit(0)
           when " "
-            space_handler
+            space_key_handler
           when CODES[:carriage_return_key]
             break carriage_return_handler
           when "\e[A", "k", CODES[:cursor_up]
-            highlight_line(@highlighted_line_index - 1) unless @highlighted_line_index == 0
+            scroll_to(@highlighted_line_index - 1)
           when "\e[B", "j", CODES[:cursor_down]
-            highlight_line(@highlighted_line_index + 1) unless @highlighted_line_index == @options.size - 1
+            scroll_to(@highlighted_line_index + 1)
           end
         end
       end
 
       # @param [Fixnum] index
-      # @param [Boolean] highlight
-      def print_line(index, highlight)
+      def scroll_to(index)
+        indices_to_reprint = range(@highlighted_line_index, index)
+        @highlighted_line_index = indices_to_reprint.last
+        indices_to_reprint.each(&method(:print_line))
+      end
+
+      # @param [Fixnum] index
+      def print_line(index)
         go_to_line(index)
-        text = prefix(index) + @formatted[index]
+        text = final_text_for_line(index)
 
-        if highlight
+        if index == @highlighted_line_index
           tty.print(CODES[:standout_mode] + text + CODES[:exit_standout_mode])
         else
           tty.print(text)
         end
       end
 
-      # @param [Fixnum] index
-      def highlight_line(index)
-        print_line(@highlighted_line_index, false)
-        print_line(index, true)
-
-        @highlighted_line_index = index
-      end
-
       # @param [Fixnum] index
       def go_to_line(index)
         if index == @cursor_line_index
@@ -120,24 +152,55 @@ module Ansi
         elsif index > @cursor_line_index
           (index - @cursor_line_index).times { tty.print CODES[:cursor_down] }
         else
-          (@cursor_line_index - index).times { tty.print CODES[:cursor_up] }
+          row_before_going = `bash position.sh`.to_i
+          (@cursor_line_index - index).times do |step|
+            tty.print(`tput ri`) if step >= row_before_going
+            tty.print CODES[:cursor_up]
+          end
         end
 
         @cursor_line_index = index
         tty.print CODES[:carriage_return_key]
       end
 
+      # @param [Fixnum] index
+      #
+      # @return [String]
+      def final_text_for_line(index)
+        maybe_add_ellipsis(prefix(index) + @formatted[index])
+      end
+
+      # @param [String] text
+      def maybe_add_ellipsis(text)
+        text.size >= @columns ? text[0...(@columns - 2)] + '…' : text
+      end
+
+      # @param [String] text
+      #
+      # @return [String]
+      def strip_ansi_colors(text)
+        text.gsub(/\e\[(\d+;?)+m/, '')
+      end
+
       def prefix(index)
         raise NotImplementedError
       end
 
-      def space_handler
+      def space_key_handler
         raise NotImplementedError
       end
 
       def carriage_return_handler
         raise NotImplementedError
       end
+
+      def option_indices
+        (0...@options.size)
+      end
+
+      def range(from, to)
+        ((from <= to) ? from.upto(to) : from.downto(to)).to_a.select { |index| (0...@options.size).cover?(index) }
+      end
     end
   end
 end

data/lib/ansi/selector/multi_impl.rb

@@ -14,9 +14,9 @@ module Ansi
         @selected_options[index] ? ' [x] ' : ' [ ] '
       end
 
-      def space_handler
+      def space_key_handler
         @selected_options[@cursor_line_index] = !@selected_options[@cursor_line_index]
-        print_line(@cursor_line_index, true)
+        print_line(@cursor_line_index)
       end
 
       def carriage_return_handler

data/lib/ansi/selector/single_impl.rb

@@ -14,7 +14,7 @@ module Ansi
         ' '
       end
 
-      def space_handler
+      def space_key_handler
         # Do nothing
       end
 

data/lib/ansi/selector/version.rb

@@ -1,5 +1,5 @@
 module Ansi
   class Selector
-    VERSION = "0.2.5"
+    VERSION = "0.3.0"
   end
 end

data/position.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# based on a script from http://invisible-island.net/xterm/xterm.faq.html
+exec < /dev/tty
+oldstty=$(stty -g)
+stty raw -echo min 0
+# on my system, the following line can be replaced by the line below it
+echo -en "\033[6n" > /dev/tty
+# tput u7 > /dev/tty    # when TERM=xterm (and relatives)
+IFS=';' read -r -d R -a pos
+stty $oldstty
+# change from one-based to zero based so they work with: tput cup $row $col
+row=$((${pos[0]:2} - 1))    # strip off the esc-[
+
+echo "$row"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansi-select
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Volodymyr Shatskyi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - lib/ansi/selector/multi_impl.rb
 - lib/ansi/selector/single_impl.rb
 - lib/ansi/selector/version.rb
+- position.sh
 homepage: https://github.com/shockone/ansi-select
 licenses: []
 metadata: {}