pick 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 231a0858bec544792385a82e9111bdb7debc6860
-  data.tar.gz: 3178c3fb7fd85d4a5e0630e1df1fcb004d7fa08a
+  metadata.gz: 1f578b9b265c6232d57211cfd3d1ef6e5d2c64c7
+  data.tar.gz: 1a937ad868bc21e1301045a7b5402c479cec8775
 SHA512:
-  metadata.gz: ff367787f4196c730c831eea89878df45c1f70091ac4725fb730522e45b8095e4a233214406c64067c570af6dec8f0164bbb01d1162baa6cd4cc6f13e10cc1af
-  data.tar.gz: 026d6830026c67daca200dc0f59934bc2c8dbf6c3244b88d83310547abc3222747e63c27acc99f22afcb6ce52a55343762270d9188fef04dc7bc3318b076732f
+  metadata.gz: 5a43261d19f398144a37004f0cdadacbe35d4786f46990c7ba57ac0c3b25da1ec6f119025e66acfad770609dd4217d722cf895b6860d85ee4b9378cdb048f1fc
+  data.tar.gz: 657b693f29cf2e8067c26b4963464eb0490233b299905c187243006782aa6740387fea1a030ae0945c25e07e2d0fc8f9043d555180d5223845c402cd2713ea9f

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Andy Brody
+Copyright (c) 2017 Andy Brody
 
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007

data/README.md

@@ -1,41 +1,51 @@
 # Pick
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pick`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Pick is a command line tool for selecting from multiple options. It takes items
+on standard input or from a file, and interactively prompts you to choose one
+or more of them.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'pick'
+```sh
+gem install pick
 ```
 
-And then execute:
+## Examples
+
+```sh
+# select a file
+ls | pick
 
-    $ bundle
+# edit a file under the current directory tree
+vim $(find . -type f | pick)
 
-Or install it yourself as:
+# edit multiple files under the current directory tree
+vim $(find . -type f | pick -m)
 
-    $ gem install pick
+# check out a branch interactively
+git branch -a | pick | xargs git checkout
 
-## Usage
+# delete a file, safe even when filenames contain newlines
+find . -type f -print0 | pick -0 | xargs -0 rm -v
 
-TODO: Write usage instructions here
+# delete many files
+find . -type f -print0 | pick -0 -m | xargs -0 rm -v
+
+# choose a color from colors.txt
+pick colors.txt
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can use `pry -r ./lib/pick` to get an interactive shell.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pick.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/ab/pick/.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [GPL v3](https://opensource.org/licenses/GPL-3.0).
 

data/bin/pick

@@ -94,6 +94,4 @@ Options:
   end
 end
 
-if $0 == __FILE__
-  main(ARGV)
-end
+main(ARGV)

data/lib/pick/cli.rb

@@ -3,17 +3,48 @@ require 'tty/screen'
 
 module Pick
   class CLI
+
+    # Read items from input_io and prompt the user to choose among them. Then
+    # print the output to options[:output_io] or stdout.
+    #
+    # @param input_io [IO] The input IO from which to read the items
+    # @param options [Hash] See {.prompt}
+    # @option options :output_io [IO] (STDOUT) The IO to print selected items
+    #   to.
+    # @option options :output_delimiter [String] ("\n") The delimiter to print
+    #   after each selected item.
+    #
     def self.run(input_io, options={})
       answer = prompt(input_io, options)
 
+      return if answer.empty?
+
       output_io = options[:output_io] || STDOUT
 
       out_sep = options[:output_delimiter]
       out_sep ||= "\n"
 
       output_io.print(Array(answer).join(out_sep) + out_sep)
+
+      answer
     end
 
+    # Read items from input_io and prompt the user to choose among them.
+    #
+    # @param input_io [IO] The input IO from which to read the items
+    # @param options [Hash]
+    # @option options :prompt_input [IO] IO to use for prompt input
+    # @option options :prompt_output [IO] IO to use for prompt output
+    # @option options :tty_dev [String] ('/dev/tty') The device to use as the
+    #   default for TTY i/o, used for :prompt_input and :prompt_output
+    # @option options :input_delimiter [String] The string that separates items
+    #   on the input stream.
+    # @option options :multiple [Boolean] Whether to select a single item or
+    #   multiple items
+    #
+    # @return [String, Array<String>] A single item or an array of items chosen
+    #   by the user.
+    #
     def self.prompt(input_io, options={})
       prompt_opts = {}
       options = options.dup
@@ -28,6 +59,10 @@ module Pick
         prompt_opts[:per_page] = options.fetch(:per_page)
       end
 
+      if input_io.tty? && options.fetch(:prompt_output).tty? \
+         && !options[:quiet]
+        options.fetch(:prompt_output).puts('Waiting for input items...')
+      end
 
       # read the input io
       data = input_io.read
@@ -42,8 +77,6 @@ module Pick
       # split input into choices
       choices = data.split(separator)
 
-      prompt = options.fetch(:prompt, 'Pick an option:')
-
       p = TTY::Prompt.new(
         input: options.fetch(:prompt_input),
         output: options.fetch(:prompt_output)

data/lib/pick/version.rb

@@ -1,3 +1,3 @@
 module Pick
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pick
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andy Brody