ansi-select 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbdb0d626907ead9edbe0c70ece388639bfd60b2
-  data.tar.gz: f6c5d41601a0ba70f4c5c14ba6b30992968fd6d6
+  metadata.gz: 31facd9c408f0836c2f8ab324fc26995701a433d
+  data.tar.gz: f6dc35cd7b1ea27db706eaba87912afe22abb5f9
 SHA512:
-  metadata.gz: 93fd756748db4238b3fd331c947ae32973596909b04c349d40469688a1dcda566695c5109c1200514c4511f15d56c3e355d44fc3bd528abdd7e6df21a942a573
-  data.tar.gz: beebfe8259573a84716765cbd55d0ac64e394bbb0f8a1aedb3c470972a5665b62070dbe4f3b377f5010fe6fc8756b3fe5d7111a601db708421bf5aa17d66de6b
+  metadata.gz: c13549de88f3ddc5905ea2813122140b1b0fec2a58a87a35c911e0fea365181867fa8fd2c8a06be1f4bd0b9668956aa267e3465f7d2e4a545d8b972cc4e2f14a
+  data.tar.gz: df044fe624e21523b04bccc32bf76e7565b055171d0cb946fbf84f68c30ceeecbe5637d2df1c88f20abf127e903e16d1b68653d9bf888c879c29079fed9b5395

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.2.0
+
+* Add multi select.

data/README.md

@@ -1,4 +1,4 @@
-![](https://dl.dropboxusercontent.com/spa/dlqheu39w0arg9q/yaano147.png)
+![](https://dl.dropboxusercontent.com/spa/dlqheu39w0arg9q/gvpg7_fw.png)
 
 ## Installation
 
@@ -13,17 +13,25 @@ There are two options:
 
 ```bash
 echo some words to choose from | tr ' ' '\n' | ansi-select
+
 cd $(ls -d */ | ansi-select) # Go to a visually selected subdirectory.
 git checkout $(git branch | ansi-select) # The same, but with git branches.
+
+rm -r $(ls | ansi-select --multi) # Delete all the selected files.
 ```
 
 * A Ruby library.
 
 ```ruby
-require "ansi/select"
+require "ansi/selector"
+
+beverage = Ansi::Selector.select(["coffee", "tee"])
+
+puts "Would you like some additions?"
+additions = Ansi::Selector.multi_select(["sugar", "cream", "milk"])
 
-answer = Ansi::Select.new(["some", "words", "to", "choose", "from"]).select
-print "You chose #{answer}."
+print "Here's your #{beverage}. "
+print "We've also added #{additions.join(', ')}." if additions.present?
 ```
 
 The Ruby interface has an additional benefit of accepting any objects that respond
@@ -32,10 +40,7 @@ to `#to_s` and returning one of them instead of a string.
 
 ## Keyboard
 
-You can use up and down keys or `j`/`k` for navigation, and space or return key for choosing an option.
-If you've changed your mind, you can quit with Ctrl+C or `q`.
-
-
-## TODO
-
-* Support multi-select.
+* Up and down arrows or `j`/`k` to move around.
+* Return to choose.
+* Space to toggle in multi select mode.
+* Ctrl-c or `q` to quit.

data/ansi-select.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ansi/select/version'
+require 'ansi/selector/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ansi-select"
-  spec.version       = Ansi::Select::VERSION
+  spec.version       = Ansi::Selector::VERSION
   spec.authors       = ["Volodymyr Shatskyi"]
   spec.email         = ["shockone89@gmail.com"]
 
-  spec.summary       = %q{Simple, not full-screen, ncurses-like TUI select}
-  spec.description   = %q{This gem allows you to select an array element (where an array is arbitrary input) with a pretty text user interface.}
+  spec.summary       = %q{A simple, not full-screen, ncurses-like TUI selector}
+  spec.description   = %q{This gem allows you to select array elements (where an array is some arbitrary input) with a pretty text user interface.}
   spec.homepage      = "https://github.com/shockone/ansi-select"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/bin/ansi-select

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-require 'ansi/select'
+require 'ansi/selector'
 
-puts Ansi::Select.new(STDIN.readlines.map(&:chomp)).select
+method_name = ARGV.include?('--multi') ? :multi_select : :select
+
+puts Ansi::Selector.public_send(method_name, STDIN.readlines.map(&:chomp))

data/lib/ansi/selector.rb

@@ -0,0 +1,21 @@
+module Ansi
+  class Selector
+    # @param [Array<#to_s>] options
+    #
+    # @return [#to_s] option
+    def self.select(options)
+      require_relative "selector/single_impl"
+
+      SingleImpl.new(options).select
+    end
+
+    # @param [Array<#to_s>] options
+    #
+    # @return [Array<#to_s>] option
+    def self.multi_select(options)
+      require_relative "selector/multi_impl"
+
+      MultiImpl.new(options).select
+    end
+  end
+end

data/lib/ansi/selector/impl.rb

@@ -0,0 +1,133 @@
+require "io/console"
+
+module Ansi
+  class Selector
+    class Impl
+      CODES = {
+        standout_mode: `tput rev`,
+        exit_standout_mode: `tput rmso`,
+        cursor_up: `tput cuu1`,
+        cursor_down: `tput cud1`,
+        carriage_return_key: `tput cr`
+      }
+
+      def initialize(options)
+        @options = options
+
+        @highlighted_line_index = 0
+        @cursor_line_index = 0
+      end
+
+      def select
+        print_options
+        answer = ask_to_choose
+        go_to_line(@options.size)
+
+        answer
+      ensure
+        tty.close
+      end
+
+      private
+
+      # @return [File]
+      def tty
+        @tty ||= File.open('/dev/tty', 'w+')
+      end
+
+      def print_options
+        @options.each.with_index do |_, index|
+          print_line(index, index == @highlighted_line_index)
+
+          unless index == @options.size - 1
+            tty.print $/ # This strange thing is a cross-platform new line.
+            @cursor_line_index += 1
+          end
+        end
+
+        go_to_line(0)
+      end
+
+      # @return [String]
+      def listen_carefully_to_keyboard
+        tty.noecho do
+          tty.raw do
+            input = tty.getc.chr
+            if input == "\e"
+              input << tty.read_nonblock(3) rescue nil
+              input << tty.read_nonblock(2) rescue nil
+            end
+
+            input
+          end
+        end
+      end
+
+      # @return [#to_s]
+      def ask_to_choose
+        loop do
+          input = listen_carefully_to_keyboard
+
+          case input
+          when "\u0003", "q"
+            exit(0)
+          when " "
+            space_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
+          when "\e[B", "j", CODES[:cursor_down]
+            highlight_line(@highlighted_line_index + 1) unless @highlighted_line_index == @options.size - 1
+          end
+        end
+      end
+
+      # @param [Fixnum] index
+      # @param [Boolean] highlight
+      def print_line(index, highlight)
+        go_to_line(index)
+
+        if highlight
+          tty.print(CODES[:standout_mode] + prefix(index) + @options[index] + CODES[:exit_standout_mode])
+        else
+          tty.print(prefix(index) + @options[index])
+        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
+          # do nothing
+        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] }
+        end
+
+        @cursor_line_index = index
+        tty.print CODES[:carriage_return_key]
+      end
+
+      def prefix(index)
+        raise NotImplementedError
+      end
+
+      def space_handler
+        raise NotImplementedError
+      end
+
+      def carriage_return_handler
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/ansi/selector/multi_impl.rb

@@ -0,0 +1,29 @@
+require_relative 'impl'
+
+module Ansi
+  class Selector
+    class MultiImpl < Impl
+      def initialize(options)
+        super
+
+        # @type [Array<Boolean>]
+        @selected_options = []
+      end
+
+      private
+
+      def prefix(index)
+        @selected_options[index] ? '[x] ' : '[ ] '
+      end
+
+      def space_handler
+        @selected_options[@cursor_line_index] = !@selected_options[@cursor_line_index]
+        print_line(@cursor_line_index, true)
+      end
+
+      def carriage_return_handler
+        @selected_options.map.with_index { |value, index| @options[index] if value }.compact
+      end
+    end
+  end
+end

data/lib/ansi/selector/single_impl.rb

@@ -0,0 +1,21 @@
+require_relative 'impl'
+
+module Ansi
+  class Selector
+    class SingleImpl < Impl
+      private
+
+      def prefix(index)
+        ' '
+      end
+
+      def space_handler
+        # Do nothing
+      end
+
+      def carriage_return_handler
+        @options[@highlighted_line_index]
+      end
+    end
+  end
+end

data/lib/ansi/selector/version.rb

@@ -0,0 +1,5 @@
+module Ansi
+  class Selector
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansi-select
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Volodymyr Shatskyi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: This gem allows you to select an array element (where an array is arbitrary
-  input) with a pretty text user interface.
+description: This gem allows you to select array elements (where an array is some
+  arbitrary input) with a pretty text user interface.
 email:
 - shockone89@gmail.com
 executables:
@@ -52,13 +52,17 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - ansi-select.gemspec
 - bin/ansi-select
-- lib/ansi/select.rb
-- lib/ansi/select/version.rb
+- lib/ansi/selector.rb
+- lib/ansi/selector/impl.rb
+- lib/ansi/selector/multi_impl.rb
+- lib/ansi/selector/single_impl.rb
+- lib/ansi/selector/version.rb
 homepage: https://github.com/shockone/ansi-select
 licenses: []
 metadata: {}
@@ -81,5 +85,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Simple, not full-screen, ncurses-like TUI select
+summary: A simple, not full-screen, ncurses-like TUI selector
 test_files: []

data/lib/ansi/select.rb

@@ -1,121 +0,0 @@
-# coding: utf-8
-
-require "io/console"
-
-module Ansi
-  class Select
-    CODES = {
-      standout_mode: `tput rev`,
-      exit_standout_mode: `tput rmso`,
-      cursor_up: `tput cuu1`,
-      cursor_down: `tput cud1`,
-      carriage_return_key: `tput cr`
-    }
-
-    # @param [Array<#to_s>] options
-    def initialize(options)
-      @options = options
-
-      @highlighted_line_index = 0
-      @cursor_line_index = 0
-    end
-
-    # @return [#to_s] option
-    def select
-      print_options
-      answer = ask_to_choose
-      go_to_line(@options.size)
-
-      answer
-    ensure
-      tty.close
-    end
-
-    private
-
-    # @return [File]
-    def tty
-      @tty ||= File.open('/dev/tty', 'w+')
-    end
-
-    def print_options
-      @options.each.with_index do |_, index|
-        print_line(index, index == @highlighted_line_index)
-
-        unless index == @options.size - 1
-          tty.print $/ # This strange thing is a cross-platform new line.
-          @cursor_line_index += 1
-        end
-      end
-
-      go_to_line(0)
-    end
-
-    # @return [String]
-    def listen_carefully_to_keyboard
-      tty.noecho do
-        tty.raw do
-          input = tty.getc.chr
-          if input == "\e"
-            input << tty.read_nonblock(3) rescue nil
-            input << tty.read_nonblock(2) rescue nil
-          end
-
-          input
-        end
-      end
-    end
-
-    # @return [#to_s]
-    def ask_to_choose
-      loop do
-        input = listen_carefully_to_keyboard
-
-        case input
-        when "\u0003", "q"
-          exit(0)
-        when CODES[:carriage_return_key], " "
-          break @options[@highlighted_line_index]
-        when "\e[A", "k", CODES[:cursor_up]
-          highlight_line(@highlighted_line_index - 1) unless @highlighted_line_index == 0
-        when "\e[B", "j", CODES[:cursor_down]
-          highlight_line(@highlighted_line_index + 1) unless @highlighted_line_index == @options.size - 1
-        end
-      end
-    end
-
-    # @param [Fixnum] index
-    # @param [Boolean] highlight
-    def print_line(index, highlight)
-      go_to_line(index)
-
-      if highlight
-        tty.print "#{CODES[:standout_mode]}#{@options[index]}#{CODES[:exit_standout_mode]}"
-      else
-        tty.print @options[index]
-      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
-        # do nothing
-      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] }
-      end
-
-      @cursor_line_index = index
-      tty.print CODES[:carriage_return_key]
-    end
-  end
-end

data/lib/ansi/select/version.rb

@@ -1,5 +0,0 @@
-module Ansi
-  class Select
-    VERSION = "0.1.0"
-  end
-end