fuzz 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f44c39816f92d7768e60a4f294c88e1dc56f1f9bda7f2c6dea0324721de1cb9
-  data.tar.gz: a3f71c073214cd1b1762c81651acc15e44bc8640cfa025a2d45d0907017b60e1
+  metadata.gz: f9d42afd0f155728e3950089a89cf53ea30567cd151f40726a3e554e0a734daa
+  data.tar.gz: 0f384622fe5d6c66e6ac7c09b2221a972a4c7155ed51513c2fde9fab9266cf50
 SHA512:
-  metadata.gz: 4b2977173802a64185ec315cced434cb0f47c5bb6a3ec7d1ad1f1309aca215ed4fa8c0d6f222270b14535fa022de83e8b699cf4a572d95e966fe48f9c5f69f23
-  data.tar.gz: 7d2854f73da095b8c140424a190b39c3f2401132fcacb7bd7373c9fa98c4544cc296ac4761b5df14df866141f4797ae03d9a7a73a14816434ac4aab7b4522bed
+  metadata.gz: 2e25ce9074901620fdeeb50a4aaaa90ec0b39d7c7ba0af27797d186e6fe9f63f8a52772ff81a59d13b9c87bfd8cc16912308ae1888d27a8936d354e1ae610039
+  data.tar.gz: 23c5622897c83d6dbb517adaa6dae68004b29761403b9339a7633cffdee55ff7addb2af0ee31099f7e7c322f7a807fa9e563a05be3c0f3536311b1c3e9f77bd9

data/Gemfile.lock

@@ -1,12 +1,20 @@
 PATH
   remote: .
   specs:
-    fuzz (0.1.0)
+    fuzz (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -21,12 +29,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  coveralls
   fuzz!
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -1,19 +1,28 @@
-## Fuzz: interactively select Ruby objects with `rofi`
+## Fuzz: interactively select Ruby objects with `rofi`, `dmenu`, or `pick`
+
+[![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)
+[![Coverage Status](https://coveralls.io/repos/github/hrs/fuzz/badge.svg?branch=master)](https://coveralls.io/github/hrs/fuzz?branch=master)
+[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
 
 I often write scripts in which a user needs to choose one of a number of
 possibilities: maybe they need to select a directory, or a file, or an action,
 or just an arbitrary object.
 
-[rofi][] is a really cool tool for that! It provides a visual way for a user to
-use fuzzy searching to choose among a selection of strings.
+[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.
 
-Unfortunately, though, it does *just* choose between strings. But my scripts
-would often be a lot simpler if the user were able to select arbitrary Ruby
-objects. Fuzz manages the translation between lists of strings that can be
-selected through `rofi` and the associated collection of Ruby objects, and thus
-makes it a bit easier to write interactive and OOP-friendly Ruby scripts.
+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
+Ruby objects. Fuzz manages the translation between lists of strings that can be
+selected through these visual pickers and the associated collection of Ruby
+objects, which makes it a bit easier to write interactive and OOP-friendly Ruby
+scripts.
 
 [rofi]: https://github.com/DaveDavenport/rofi
+[dmenu]: https://tools.suckless.org/dmenu
+[pick]: https://github.com/calleerlandsson/pick
 
 ### For example
 
@@ -35,14 +44,14 @@ system("vlc \"#{ choice.path }\"")
 ```
 
 The call to `#pick` will call `#to_s` on every episode, display the results
-through `rofi`, get the user's choice, and use that to return the corresponding
-object.
+through `rofi` (the default picker), get the user's choice, and use that to
+return the corresponding object.
 
 [RubyTapas screencasts]: https://www.rubytapas.com/
 
 ### Caching selections
 
-If you run your script frequently, you may find that you often make the same
+If you run your script frequently you may find that you often make the same
 selections. It's convenient to have those selections appear near the top of the
 list.
 
@@ -66,11 +75,62 @@ and it complies with the [XDG Base Directory Specification][], but you can keep
 
 [XDG Base Directory Specification]: https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
-### Extending `fuzz` beyond `rofi`
+### Supplying a default value
+
+If the user enters a string that doesn't correspond to an object,
+`Fuzz::Selector#pick` will normally return `nil`.
+
+However, you can manually specify a default return value with the `default:`
+option:
+
+```ruby
+Fuzz::Selector.new(
+  [1, 2, 3],
+  default: 42,
+).pick # => returns 42 if the user picks a value other than 1, 2, or 3
+```
+
+### Choosing a different picker
 
-It's possible to use `fuzz` without `rofi`. The `Fuzz::Selector` constructor
-takes an optional `:picker` argument. The supplied object must implement a
-`#pick` method, which should take an array of strings and return a string.
+Fuzz ships with support for `rofi` and `dmenu`. The `Fuzz::Selector` constructor
+takes an optional `picker:` argument to pick a picker.
+
+For example, to use `dmenu` as your picker:
+
+```ruby
+Fuzz::Selector.new(
+  some_objects,
+  picker: Fuzz::DmenuPicker.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`.
+
+### Extending `fuzz` with new pickers
+
+It's possible to extend `fuzz` to use a picker of your choice. The object
+supplied to `picker:` must implement a `#pick` method, which should take an
+array of strings and return a string.
 
 Here's a simple example with a silly picker that always chooses the first
 option:
@@ -90,11 +150,7 @@ selector = Fuzz::Selector.new(
 selector.pick # => 1
 ```
 
-Pickers will usually be more interactive than this, I hope! You might shell out
-to [dmenu][], [pick][], or whatever else you'd like.
-
-[dmenu]: https://wiki.archlinux.org/index.php/Dmenu
-[pick]: https://github.com/calleerlandsson/pick
+Your custom pickers will probably be more interactive than this! =)
 
 ## Installation
 

data/fuzz.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version = Fuzz::VERSION
   spec.authors = ["Harry Schwartz"]
   spec.email = ["hello@harryrschwartz.com"]
-  spec.summary = "Wrap command-line tools to graphically select from a list of Ruby objects!"
+  spec.summary = "Use command-line tools to choose from a list of Ruby objects!"
   spec.homepage = "https://github.com/hrs/fuzz"
   spec.license = "GPL-3.0"
 
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/fuzz.rb

@@ -1,8 +1,11 @@
 module Fuzz
 end
 
+require "fuzz/executable"
 require "fuzz/cache"
+require "fuzz/dmenu_picker"
 require "fuzz/entry"
 require "fuzz/null_cache"
+require "fuzz/rofi_picker"
 require "fuzz/selector"
 require "fuzz/version"

data/lib/fuzz/cache.rb

@@ -1,53 +1,55 @@
 require "fileutils"
 
-class Fuzz::Cache
-  def initialize(cache_file)
-    @cache_file = File.expand_path(cache_file)
-    @entries = cache_entries(@cache_file)
-  end
+module Fuzz
+  class Cache
+    def initialize(cache_file)
+      @cache_file = File.expand_path(cache_file)
+      @entries = cache_entries(@cache_file)
+    end
 
-  def weight(title)
-    entries.fetch(title, 0)
-  end
+    def weight(title)
+      entries.fetch(title, 0)
+    end
 
-  def increment!(title)
-    entries[title] = weight(title) + 1
-    write
-  end
+    def increment(title)
+      entries[title] = weight(title) + 1
+      write
+    end
 
-  private
+    private
 
-  attr_reader :cache_file, :entries
+    attr_reader :cache_file, :entries
 
-  def write
-    File.open(cache_file, "w") do |file|
-      entries.each do |title, count|
-        file.puts("#{ count } #{ title }")
+    def write
+      File.open(cache_file, "w") do |file|
+        entries.each do |title, count|
+          file.puts("#{ count } #{ title }")
+        end
       end
     end
-  end
 
-  def cache_entries(cache_file)
-    if File.exist?(cache_file)
-      hash_from_file(File.new(cache_file))
-    else
-      {}
+    def cache_entries(cache_file)
+      if File.exist?(cache_file)
+        hash_from_file(File.new(cache_file))
+      else
+        {}
+      end
     end
-  end
 
-  def hash_from_file(cache_file)
-    cache_file.readlines.inject({}) { |hash, line|
-      count, title = line.split(" ", 2)
-      hash[title.strip] = count.to_i
-      hash
-    }
-  end
+    def hash_from_file(cache_file)
+      cache_file.readlines.inject({}) { |hash, line|
+        count, title = line.split(" ", 2)
+        hash[title.strip] = count.to_i
+        hash
+      }
+    end
 
-  def directory
-    File.dirname(cache_file)
-  end
+    def directory
+      File.dirname(cache_file)
+    end
 
-  def ensure_directory_exists
-    FileUtils.mkdir_p(directory)
+    def ensure_directory_exists
+      FileUtils.mkdir_p(directory)
+    end
   end
 end

data/lib/fuzz/dmenu_picker.rb

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

data/lib/fuzz/entry.rb

@@ -1,19 +1,23 @@
-class Fuzz::Entry
-  include Comparable
+module Fuzz
+  class Entry
+    include Comparable
 
-  attr_reader :title, :object, :weight
+    attr_reader :title, :object, :weight
 
-  def initialize(title:, object:, weight:)
-    @title = title
-    @object = object
-    @weight = weight
-  end
+    def initialize(title:, object:, weight:)
+      @title = title
+      @object = object
+      @weight = weight
+    end
+
+    def <=>(other)
+      other_weight = other.weight
 
-  def <=>(other)
-    if weight != other.weight
-      other.weight <=> weight
-    else
-      title <=> other.title
+      if weight != other_weight
+        other_weight <=> weight
+      else
+        title <=> other.title
+      end
     end
   end
 end

data/lib/fuzz/executable.rb

@@ -0,0 +1,28 @@
+module Fuzz
+  class MissingExecutableError < StandardError
+  end
+
+  class Executable
+    def initialize(command)
+      @command = command
+    end
+
+    def error_if_missing
+      if !installed?
+        raise(
+          MissingExecutableError,
+          "Can't find the `#{ command }` executable!",
+        )
+      end
+    end
+
+    private
+
+    attr_reader :command
+
+    def installed?
+      system("which #{ command }")
+      $?.success?
+    end
+  end
+end

data/lib/fuzz/null_cache.rb

@@ -1,14 +1,16 @@
-class Fuzz::NullCache
-  def initialize(*)
-  end
+module Fuzz
+  class NullCache
+    def initialize(*)
+    end
 
-  def weight(*)
-    0
-  end
+    def weight(*)
+      0
+    end
 
-  def increment!(*)
-  end
+    def increment(*)
+    end
 
-  def write
+    def write
+    end
   end
 end

data/lib/fuzz/pick_picker.rb

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

data/lib/fuzz/rofi_picker.rb

@@ -1,26 +1,15 @@
-class Fuzz::RofiPicker
-  def initialize
-    assert_executable_available
-  end
+module Fuzz
+  class RofiPicker
+    def pick(keys)
+      Fuzz::Executable.new("rofi").error_if_missing
 
-  def pick(keys)
-    `echo "#{ keys.join("\n") }" | #{ command }`.strip
-  end
+      `echo "#{ keys.join("\n") }" | #{ command }`.strip
+    end
 
-  private
+    private
 
-  def command
-    "rofi -show run -matching fuzzy -dmenu -i"
-  end
-
-  def assert_executable_available
-    if !installed?
-      raise "Can't find the `rofi` executable!"
+    def command
+      "rofi -show run -matching fuzzy -dmenu -i"
     end
   end
-
-  def installed?
-    `which rofi`
-    $?.success?
-  end
 end

data/lib/fuzz/selector.rb

@@ -3,42 +3,52 @@ require_relative "entry"
 require_relative "rofi_picker"
 require_relative "null_cache"
 
-class Fuzz::Selector
-  def initialize(items, options = {})
-    @cache = options.fetch(:cache, Fuzz::NullCache.new)
-    @picker = options.fetch(:picker, Fuzz::RofiPicker.new)
-    @entries = items.map { |item| make_entry(item, @cache) }
-  end
+module Fuzz
+  class Selector
+    def initialize(items, options = {})
+      @cache = options.fetch(:cache, Fuzz::NullCache.new)
+      @default = options.fetch(:default, nil)
+      @picker = options.fetch(:picker, Fuzz::RofiPicker.new)
+      @entries = items.map { |item| make_entry(item, @cache) }
+    end
 
-  def pick
-    title = picker.pick(titles)
-    chosen_entry = find_entry_by_title(title)
+    def pick
+      title = picker.pick(titles)
+      chosen_entry = find_entry_by_title(title)
 
-    if chosen_entry.nil?
-      nil
-    else
-      cache.increment!(chosen_entry.title)
-      chosen_entry.object
+      if chosen_entry.nil?
+        default
+      else
+        cache.increment(chosen_entry.title)
+        chosen_entry.object
+      end
     end
-  end
 
-  private
+    private
 
-  attr_reader :entries, :picker, :cache
+    attr_reader(
+      :cache,
+      :default,
+      :entries,
+      :picker,
+    )
 
-  def titles
-    entries.sort.map(&:title)
-  end
+    def titles
+      entries.sort.map(&:title)
+    end
 
-  def find_entry_by_title(title)
-    entries.detect { |entry| entry.title == title }
-  end
+    def find_entry_by_title(title)
+      entries.detect { |entry| entry.title == title }
+    end
 
-  def make_entry(item, cache)
-    Fuzz::Entry.new(
-      title: item.to_s,
-      object: item,
-      weight: cache.weight(item.to_s) || 0,
-    )
+    def make_entry(item, cache)
+      title = item.to_s
+
+      Fuzz::Entry.new(
+        title: title,
+        object: item,
+        weight: cache.weight(title) || 0,
+      )
+    end
   end
 end

data/lib/fuzz/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuzz
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Harry Schwartz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,8 +87,11 @@ files:
 - fuzz.gemspec
 - lib/fuzz.rb
 - lib/fuzz/cache.rb
+- lib/fuzz/dmenu_picker.rb
 - lib/fuzz/entry.rb
+- lib/fuzz/executable.rb
 - lib/fuzz/null_cache.rb
+- lib/fuzz/pick_picker.rb
 - lib/fuzz/rofi_picker.rb
 - lib/fuzz/selector.rb
 - lib/fuzz/version.rb
@@ -101,5 +118,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Wrap command-line tools to graphically select from a list of Ruby objects!
+summary: Use command-line tools to choose from a list of Ruby objects!
 test_files: []