fuzz 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9d42afd0f155728e3950089a89cf53ea30567cd151f40726a3e554e0a734daa
-  data.tar.gz: 0f384622fe5d6c66e6ac7c09b2221a972a4c7155ed51513c2fde9fab9266cf50
+  metadata.gz: f98b1a90c7d969b3844cfcc64615c90d5b1d378e5cd76e79811d2272b727f904
+  data.tar.gz: '08db792fa58a84d9b17d8d688355a34c8e0dbc2509ab99b56df9e3be52bceb54'
 SHA512:
-  metadata.gz: 2e25ce9074901620fdeeb50a4aaaa90ec0b39d7c7ba0af27797d186e6fe9f63f8a52772ff81a59d13b9c87bfd8cc16912308ae1888d27a8936d354e1ae610039
-  data.tar.gz: 23c5622897c83d6dbb517adaa6dae68004b29761403b9339a7633cffdee55ff7addb2af0ee31099f7e7c322f7a807fa9e563a05be3c0f3536311b1c3e9f77bd9
+  metadata.gz: f7cc07b5edaa679982db909227ea627721c200e376cd58ca96df9f964f4f6d343a278eb2785d141121233f4d5bebe643dd89273d6f476b9b8a1fdb3fa8600690
+  data.tar.gz: b3bc45fe924fe680a39a3629c22578788fc66447fd507473af0075451585e01da54406908a06b75c2220d7a5b69ba6d275a8902bfa0e1ae9bb81aad5d95c6825

data/README.md

@@ -1,4 +1,4 @@
-## Fuzz: interactively select Ruby objects with `rofi`, `dmenu`, or `pick`
+## Fuzz: A Ruby wrapper around interactive filtering tools
 
 [![Build Status](https://travis-ci.org/hrs/fuzz.svg?branch=master)](https://travis-ci.org/hrs/fuzz)
 [![Maintainability](https://api.codeclimate.com/v1/badges/326b820a889742177ec2/maintainability)](https://codeclimate.com/github/hrs/fuzz/maintainability)
@@ -11,7 +11,7 @@ or just an arbitrary object.
 
 [rofi][] and [dmenu][] are really cool tools for that! They provide a visual way
 for a user to use fuzzy searching to choose among a selection of strings.
-[pick][] provides a similar service on the command line with ncurses.
+[pick][], [peco][], and [selecta][] provide similar services on the command line.
 
 Unfortunately, though, these tools do *just* choose between strings. But my
 scripts would often be a lot simpler if the user were able to select arbitrary
@@ -23,9 +23,16 @@ scripts.
 [rofi]: https://github.com/DaveDavenport/rofi
 [dmenu]: https://tools.suckless.org/dmenu
 [pick]: https://github.com/calleerlandsson/pick
+[peco]: https://github.com/peco/peco
+[selecta]: https://github.com/garybernhardt/selecta
 
 ### For example
 
+There are more [interesting examples in the wiki][], but here's a simple one to
+get started.
+
+[interesting examples in the wiki]: https://github.com/hrs/fuzz/wiki
+
 I'm a fan of the excellent [RubyTapas screencasts][], and I'd like a script to
 let me interactively search through their titles to pick one to play. Here's a
 way I could do that:
@@ -92,8 +99,17 @@ Fuzz::Selector.new(
 
 ### Choosing a different picker
 
-Fuzz ships with support for `rofi` and `dmenu`. The `Fuzz::Selector` constructor
-takes an optional `picker:` argument to pick a picker.
+Fuzz ships with support for numerous fuzzy-matching tools, which it calls
+"pickers." The `Fuzz::Selector` constructor takes an optional `picker:` argument
+to pick a picker.
+
+| Executable | Creating an instance             |
+|------------|----------------------------------|
+| `dmenu`    | `Fuzz::DmenuPicker.new`          |
+| `peco`     | `Fuzz::PecoPicker.new`           |
+| `pick`     | `Fuzz::PickPicker.new`           |
+| `rofi`     | `Fuzz::RofiPicker.new` (default) |
+| `selecta`  | `Fuzz::SelectaPicker.new`        |
 
 For example, to use `dmenu` as your picker:
 
@@ -104,27 +120,9 @@ Fuzz::Selector.new(
 )
 ```
 
-Or to search in a terminal with the `pick` tool:
-
-```ruby
-
-Fuzz::Selector.new(
-  some_objects,
-  picker: Fuzz::PickPicker.new,
-)
-```
-
-The `rofi` picker is the default, but you can also explicitly specify it:
-
-```ruby
-Fuzz::Selector.new(
-  some_objects,
-  picker: Fuzz::RofiPicker.new,
-)
-```
-
-If your chosen picker can't be found (perhaps it's not installed, or not in your
-`$PATH`), `Fuzz::Selector#pick` will raise a `Fuzz::MissingExecutableError`.
+If the executable associated with your chosen picker can't be found (perhaps
+it's not installed, or not in your `$PATH`), `Fuzz::Selector#pick` will raise a
+`Fuzz::MissingExecutableError`.
 
 ### Extending `fuzz` with new pickers
 

data/lib/fuzz/peco_picker.rb

@@ -0,0 +1,9 @@
+module Fuzz
+  class PecoPicker
+    def pick(keys)
+      Fuzz::Executable.new("peco").error_if_missing
+
+      `echo "#{ keys.join("\n") }" | peco`.strip
+    end
+  end
+end

data/lib/fuzz/selecta_picker.rb

@@ -0,0 +1,9 @@
+module Fuzz
+  class SelectaPicker
+    def pick(keys)
+      Fuzz::Executable.new("selecta").error_if_missing
+
+      `echo "#{ keys.join("\n") }" | selecta`.strip
+    end
+  end
+end

data/lib/fuzz/version.rb

@@ -1,3 +1,3 @@
 module Fuzz
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuzz
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Harry Schwartz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,8 +91,10 @@ files:
 - lib/fuzz/entry.rb
 - lib/fuzz/executable.rb
 - lib/fuzz/null_cache.rb
+- lib/fuzz/peco_picker.rb
 - lib/fuzz/pick_picker.rb
 - lib/fuzz/rofi_picker.rb
+- lib/fuzz/selecta_picker.rb
 - lib/fuzz/selector.rb
 - lib/fuzz/version.rb
 homepage: https://github.com/hrs/fuzz