ansi-select 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbdb0d626907ead9edbe0c70ece388639bfd60b2
+  data.tar.gz: f6c5d41601a0ba70f4c5c14ba6b30992968fd6d6
+SHA512:
+  metadata.gz: 93fd756748db4238b3fd331c947ae32973596909b04c349d40469688a1dcda566695c5109c1200514c4511f15d56c3e355d44fc3bd528abdd7e6df21a942a573
+  data.tar.gz: beebfe8259573a84716765cbd55d0ac64e394bbb0f8a1aedb3c470972a5665b62070dbe4f3b377f5010fe6fc8756b3fe5d7111a601db708421bf5aa17d66de6b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+ansi-select

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ansi-select.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+![](https://dl.dropboxusercontent.com/spa/dlqheu39w0arg9q/yaano147.png)
+
+## Installation
+
+    $ gem install ansi-select
+
+
+## Usage
+
+There are two options:
+
+* A standalone executable. Lines passed to STDIN will form your options. The result will be printed to STDOUT.
+
+```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.
+```
+
+* A Ruby library.
+
+```ruby
+require "ansi/select"
+
+answer = Ansi::Select.new(["some", "words", "to", "choose", "from"]).select
+print "You chose #{answer}."
+```
+
+The Ruby interface has an additional benefit of accepting any objects that respond
+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.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ansi-select.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ansi/select/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ansi-select"
+  spec.version       = Ansi::Select::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.homepage      = "https://github.com/shockone/ansi-select"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/ansi-select

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'ansi/select'
+
+puts Ansi::Select.new(STDIN.readlines.map(&:chomp)).select

data/lib/ansi/select.rb

@@ -0,0 +1,121 @@
+# 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

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: ansi-select
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodymyr Shatskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- shockone89@gmail.com
+executables:
+- ansi-select
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- ansi-select.gemspec
+- bin/ansi-select
+- lib/ansi/select.rb
+- lib/ansi/select/version.rb
+homepage: https://github.com/shockone/ansi-select
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple, not full-screen, ncurses-like TUI select
+test_files: []