nknm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7682d91b7519b141a17817c2c54d7c0396c52bb5a94a7a551fdc0d82a425907
+  data.tar.gz: f888e6194163c955f14f1057f45be5a18ebc473daa03359e5f83b0b8aa251489
+SHA512:
+  metadata.gz: 341035cde6c5c19f769e353e7fb830cdde3058dccae2b61b31319f31671b863e0b43fb95608d33fda0419f199589f2d3bb7a630d6f2d5b794cfa1cedf54a7429
+  data.tar.gz: 8e5f1bf38bc3d4801d91dff1ea93bf7d777e73e3331ad1993e6a313cc50cbca5d91a7721528915c639fa12a7e6ca812b6b4438632c4b596c1444ff8addc4ca78

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,7 @@
+**.DS_Store
+*.gem
+Gemfile.lock
+.bundle
+.yardoc
+doc
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--protected lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kevinstuffandthings@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Kevin McDonald
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# Nknm ![Build Status](https://github.com/kevinstuffandthings/nknm/actions/workflows/ruby.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/nknm.svg)](https://badge.fury.io/rb/nknm)
+
+Select from a list of items using easy-to-type nicknames.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# update with the version of your choice
+gem 'nknm'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install nknm
+```
+
+## Usage
+Require the gem in your code:
+```ruby
+require "nknm"
+```
+
+You can use a static list of names:
+```ruby
+# source your names from a known list, or from a file, or anything...
+options = Nknm::Lists::Names.new(%w[First Second Third Fourth Fifth])
+
+nickname = Nknm::Nickname.new("fh")
+options.matches_for(nickname).map(&:to_s)
+# => ["Fourth", "Fifth"]
+
+nickname = Nknm::Nickname.new("s")
+options.matches_for(nickname).map(&:to_s)
+# => ["Second"]
+```
+
+If you want to choose items from a directory, you can do that too:
+```ruby
+# try named params like `include_subdirs` or `include_files` (both default to true)
+options = Nknm::Lists::Directory.new("/Users/kevin/Development")
+```
+
+#### Selectors
+Using a terminal, and getting back multiple selections? Use a `Selector`:
+```ruby
+options = Nknm::Lists::Names.new(%w[First Second Third Fourth Fifth])
+nickname = Nknm::Nickname.new("f")
+matches = options.matches_for(nickname)
+
+selection = Nknm::List::Selectors::Terminal.build(matches).selection
+puts "You selected: #{selection}" if selection
+```
+
+You'll be prompted with:
+```
+1) First
+2) Fourth
+3) Fifth
+?
+```
+
+Enter the number of your selection at the `?` prompt, and you'll have your match!
+
+# Why?
+As a terminal user and microservice engineer, I jump back-and-forth between a lot of different projects.
+I have a single directory that holds about 60 different git repos, and I like to be able to jump to any one of them from anywhere,
+without having to set up a ton of aliases, or type out full names.
+
+So, in my `~/.bashrc`, I might set up something like this:
+```bash
+export GIT_REPO_BASEDIR=/Users/kevin/Development
+
+function nd
+{
+  local dir=$(nknm-dir -F $GIT_REPO_BASEDIR $1)
+  if [ -n "$dir" ]
+  then
+    cd $dir
+  else
+    echo "No matching directory found" >&2
+    return 1
+  fi
+}
+export -f nd
+```
+
+Then, from my terminal prompt, I can be whisked away to the directory of my choosing:
+```bash
+-(git:main)-(16:57:28)-(~/Development/nknm/bin)-
+$ nd dar
+1) /Users/kevin/Development/darryl
+2) /Users/kevin/Development/docker-library
+? 1
+-(git:features/overlaps2)-(16:57:44)-(~/Development/darryl)-
+$
+```
+
+And when there's a single match for the nickname, no additional prompting is required.
+
+# Problems?
+Please submit an [issue](https://github.com/kevinstuffandthings/nknm/issues).
+We'll figure out how to get you up and running with Nknm as smoothly as possible.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "standard/rake"
+
+Dir.glob("lib/tasks/*.rake").each { |r| load r }

data/bin/nknm-dir

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "nknm"
+require "optparse"
+
+options = {include_files: true, include_subdirs: true}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options] DIRECTORY NICKNAME"
+
+  opts.on("-F", "--no-files", "Avoid files") { options[:include_files] = false }
+  opts.on("-D", "--no-subdirs", "Avoid sub-directories") { options[:include_subdirs] = false }
+end.parse!
+
+if ARGV.length == 2
+  directory = Nknm::Lists::Directory.new(ARGV[0])
+  nickname = Nknm::Nickname.new(ARGV[1])
+  matches = directory.matches_for(nickname)
+  puts Nknm::List::Selectors::Terminal.build(matches).selection
+end

data/lib/nknm/list/matches.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    class Matches
+      include Enumerable
+      attr_reader :items
+
+      def initialize(items = nil)
+        @items = Array(items).compact
+      end
+
+      def each
+        items.each { |i| yield i }
+      end
+
+      # Is this set of matches empty?
+      # @return [Boolean]
+      def empty?
+        items.length == 0
+      end
+
+      # Does this set of matches contain a single item?
+      # @return [Boolean]
+      def single?
+        items.length == 1
+      end
+    end
+  end
+end

data/lib/nknm/list/selector.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    class Selector
+      UnselectableItemsError = Class.new(StandardError)
+
+      # Build the desired selector for the specified items.
+      # @param items [Array, Nknm::List::Matches]
+      # @return [Selector]
+      def self.build(items)
+        matches = if items.is_a?(Array)
+          Nknm::List::Matches.new(items)
+        elsif items.is_a?(Nknm::List::Matches)
+          items
+        end
+        raise UnselectableItemsError if matches.nil?
+
+        selector = matches.single? || matches.empty? ? Nknm::List::Selector : self
+        selector.new(matches.items)
+      end
+
+      attr_reader :items
+
+      # Get the resolved selection from the items.
+      # @return [Object] the first item in the list
+      def selection
+        items.first
+      end
+
+      protected
+
+      def initialize(items)
+        @items = items
+      end
+    end
+  end
+end
+
+%w[terminal].each { |f| require_relative "./selectors/#{f}" }

data/lib/nknm/list/selectors/terminal.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    module Selectors
+      class Terminal < Nknm::List::Selector
+        # Generate a menu within the terminal that allows a user to
+        # select the desired item from the list.
+        # @return [Object] the user-selected option
+        def selection
+          items.each_with_index { |s, i| stream.puts "#{i + 1}) #{s}" }
+          stream.write "? "
+          idx = $stdin.readline.to_i - 1
+          items[idx] if idx >= 0
+        end
+
+        private
+
+        def stream
+          @_stream ||= $stderr
+        end
+      end
+    end
+  end
+end

data/lib/nknm/list.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    # :nocov:
+    def items
+      raise NotImplementedError
+    end
+    # :nocov:
+
+    # Get a set of matches for the specified nickname.
+    # @param nickname [Nknm::Nickname]
+    # @return [Matches]
+    def matches_for(nickname)
+      Matches.new(items.select { |i| nickname.for?(i.to_word) })
+    end
+  end
+end
+
+require_relative "./list/matches"
+require_relative "./list/selector"

data/lib/nknm/lists/directory.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Nknm
+  module Lists
+    class Directory < Nknm::List
+      attr_reader :path
+
+      # Create a new list based on a filesystem directory.
+      # @param path [String] the directory path to examine
+      # @param include_files [Boolean] should files be included?
+      # @param include_subdirs [Boolean] should directories be included?
+      # @return [Directory]
+      def initialize(path, include_files: true, include_subdirs: true)
+        @path = path
+        @include_files, @include_subdirs = include_files, include_subdirs
+      end
+
+      # Get all the desired items from the specified directory.
+      # @return [Array<Entry>]
+      def items
+        @_items ||= Dir[File.join(path, "*")]
+          .select { |i| include?(i) }
+          .map { |i| Entry.new(i) }
+      end
+
+      private
+
+      def include?(item)
+        (@include_files || !File.file?(item)) && (@include_subdirs || !File.directory?(item))
+      end
+
+      class Entry
+        attr_reader :path
+        alias_method :to_s, :path
+
+        def initialize(path)
+          @path = path
+        end
+
+        # Turn this entry into a word matchable by a nickname.
+        # @return [String]
+        def to_word
+          @_to_word ||= File.basename(path).downcase
+        end
+      end
+    end
+  end
+end

data/lib/nknm/lists/names.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Nknm
+  module Lists
+    class Names < Nknm::List
+      # Create a new list based on an array of items.
+      # @param items [Array<String>]
+      # @return [Names]
+      def initialize(items)
+        @names = Array(items).compact
+      end
+
+      # Get all the items included in the list.
+      # @return [Array<Entry>]
+      def items
+        @_items ||= @names.map { |n| Entry.new(n) }
+      end
+
+      private
+
+      class Entry
+        attr_reader :name
+        alias_method :to_s, :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        # Turn this entry into a word matchable by a nickname.
+        # @return [String]
+        def to_word
+          @_to_word ||= name.downcase
+        end
+      end
+    end
+  end
+end

data/lib/nknm/lists.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+%w[directory names].each { |f| require_relative "./lists/#{f}" }

data/lib/nknm/nickname.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nknm
+  class Nickname
+    attr_reader :text
+    alias_method :to_s, :text
+
+    def initialize(text)
+      @text = text
+    end
+
+    # Is this nickname suitable for the specified word?
+    # @param word [String]
+    # @return [Boolean]
+    def for?(word)
+      regex.match?(word)
+    end
+
+    private
+
+    def regex
+      @_regex ||= Regexp.compile("^#{(text || "").to_s.downcase.chars.join(".*")}")
+    end
+  end
+end

data/lib/nknm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nknm
+  VERSION = "0.0.1"
+end

data/lib/nknm.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "nknm/version"
+
+# Nknm
+module Nknm
+end
+
+%w[list lists nickname].each { |f| require_relative "./nknm/#{f}" }

data/nknm.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nknm/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nknm"
+  spec.version = Nknm::VERSION
+  spec.authors = ["Kevin McDonald"]
+  spec.email = ["kevinstuffandthings@gmail.com"]
+  spec.summary = "Select items from a list using easy-to-type nicknames"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/kevinstuffandthings/nknm"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "yard"
+end

data/spec/lib/nknm/list/matches_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    describe Matches do
+      context "empty" do
+        it "is considered empty" do
+          expect(subject).to be_empty
+        end
+
+        it "is not single" do
+          expect(subject).not_to be_single
+        end
+
+        it "has nothing to iterate over" do
+          count = 0
+          subject.each { |i| count += 1 }
+          expect(count).to eq 0
+        end
+      end
+
+      context "single" do
+        let(:item) { double }
+        subject { described_class.new(item) }
+
+        it "is not considered empty" do
+          expect(subject).not_to be_empty
+        end
+
+        it "is single" do
+          expect(subject).to be_single
+        end
+
+        it "can iterate over the one item" do
+          count = 0
+          subject.each do |i|
+            expect(item).to eq item
+            count += 1
+          end
+          expect(count).to eq 1
+        end
+      end
+
+      context "multiple" do
+        let(:items) { [double, double, double] }
+        subject { described_class.new(items) }
+
+        it "is not considered empty" do
+          expect(subject).not_to be_empty
+        end
+
+        it "is not single" do
+          expect(subject).not_to be_single
+        end
+
+        it "can iterate over the set of items" do
+          subject.each_with_index do |item, i|
+            expect(item).to eq items[i]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/nknm/list/selector_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    describe Selector do
+      describe "::build" do
+        let(:selector) { described_class }
+        let(:input) { items }
+        subject { selector.build(input) }
+
+        context "invalid items" do
+          let(:items) { double }
+
+          it "will raise an error if you attempt to build it with something unselectable" do
+            expect { subject }.to raise_error described_class::UnselectableItemsError
+          end
+        end
+
+        context "valid items" do
+          let(:selector) { Class.new(described_class) }
+
+          shared_examples_for("a selector with items") do
+            it "has the items it was passed, regardless of whether they were wrapped in matches or not" do
+              expect(subject.items).to eq items
+            end
+          end
+
+          shared_examples_for("a boring item selector") do
+            it "does not build the specific selector, because it doesn't need to" do
+              expect(subject).not_to be_a selector
+            end
+
+            it "builds a simple selector directly" do
+              expect(subject).to be_instance_of described_class
+            end
+
+            it_behaves_like "a selector with items"
+          end
+
+          shared_examples_for("a multi item selector") do
+            it "builds the specific selector" do
+              expect(subject).to be_a selector
+            end
+
+            it_behaves_like "a selector with items"
+          end
+
+          context "empty items" do
+            let(:items) { [] }
+
+            it_behaves_like "a boring item selector"
+
+            context "as matches" do
+              let(:input) { Nknm::List::Matches.new(items) }
+
+              it_behaves_like "a boring item selector"
+            end
+          end
+
+          context "single item" do
+            let(:items) { ["eight"] }
+
+            it_behaves_like "a boring item selector"
+
+            context "as matches" do
+              let(:input) { Nknm::List::Matches.new(items) }
+
+              it_behaves_like "a boring item selector"
+            end
+          end
+
+          context "multi item" do
+            let(:items) { %w[two four six] }
+
+            it_behaves_like "a multi item selector"
+
+            context "as matches" do
+              let(:input) { Nknm::List::Matches.new(items) }
+
+              it_behaves_like "a multi item selector"
+            end
+          end
+        end
+      end
+
+      describe "#selection" do
+        let(:items) { [] }
+        subject { described_class.send(:new, items) }
+
+        it "gives you nothing with an empty item list" do
+          expect(subject.selection).to be_nil
+        end
+
+        context "with items" do
+          let(:items) { %w[stuff things whatever] }
+
+          it "will just give you the first item" do
+            expect(subject.selection).to eq "stuff"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/nknm/list/selectors/terminal_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Nknm
+  class List
+    module Selectors
+      describe Terminal do
+        subject { described_class.build(%w[one two three four]) }
+
+        it "is a selector, through and through" do
+          expect(subject).to be_instance_of described_class
+          expect(subject).to be_a Nknm::List::Selector
+        end
+
+        describe "#selection" do
+          let(:stream) { $stderr }
+          before(:each) do
+            expect(stream).to receive(:puts).with("1) one").ordered
+            expect(stream).to receive(:puts).with("2) two").ordered
+            expect(stream).to receive(:puts).with("3) three").ordered
+            expect(stream).to receive(:puts).with("4) four").ordered
+            expect(stream).to receive(:write) do |prompt|
+              expect(prompt).to include("?")
+              expect(prompt).not_to include("\n")
+            end
+          end
+
+          it "returns no selection with an empty response" do
+            expect($stdin).to receive(:readline).and_return nil
+            expect(subject.selection).to be nil
+          end
+
+          it "returns no selection for an invalid response" do
+            expect($stdin).to receive(:readline).and_return "x"
+            expect(subject.selection).to be nil
+          end
+
+          it "returns the proper selection to correspond to the provided number" do
+            expect($stdin).to receive(:readline).and_return "3"
+            expect(subject.selection).to eq "three"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/nknm/list_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nknm
+  describe List do
+    let(:item1) { double(to_word: "x1") }
+    let(:item2) { double(to_word: "y2") }
+    let(:item3) { double(to_word: "z3") }
+    before(:each) { allow(subject).to receive(:items).and_return [item1, item2, item3] }
+
+    describe "#matches_for" do
+      let(:nickname) { instance_double(Nknm::Nickname) }
+      let(:matches) { subject.matches_for(nickname) }
+
+      it "will build a list of matches for the items that match the nickname" do
+        expect(nickname).to receive(:for?).with("x1").and_return true
+        expect(nickname).to receive(:for?).with("y2").and_return false
+        expect(nickname).to receive(:for?).with("z3").and_return true
+
+        expect(matches).to be_a described_class::Matches
+        expect(matches.items).to match_array [item1, item3]
+      end
+    end
+  end
+end

data/spec/lib/nknm/lists/directory_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Nknm
+  module Lists
+    describe Directory do
+      let(:path) { File.join(File.dirname(__FILE__), "directory", "example") }
+      subject { described_class.new(path) }
+
+      describe "#items" do
+        let(:paths) { subject.items.map(&:to_s) }
+        let(:words) { subject.items.map(&:to_word) }
+
+        context "entire directory" do
+          it "finds all files+directories from the path" do
+            expect(paths).to match_array [
+              File.join(path, "File 1.txt"),
+              File.join(path, "file 2.txt"),
+              File.join(path, "directory_a"),
+              File.join(path, "Directory_B"),
+              File.join(path, "directory_c")
+            ]
+          end
+
+          it "can translate the entries into words" do
+            expect(words).to match_array [
+              "file 1.txt",
+              "file 2.txt",
+              "directory_a",
+              "directory_b",
+              "directory_c"
+            ]
+          end
+        end
+
+        context "files only" do
+          subject { described_class.new(path, include_subdirs: false) }
+
+          it "finds all files+directories from the path" do
+            expect(paths).to match_array [
+              File.join(path, "File 1.txt"),
+              File.join(path, "file 2.txt")
+            ]
+          end
+
+          it "can translate the entries into words" do
+            expect(words).to match_array [
+              "file 1.txt",
+              "file 2.txt"
+            ]
+          end
+        end
+
+        context "subdirectories only" do
+          subject { described_class.new(path, include_files: false) }
+
+          it "finds all files+directories from the path" do
+            expect(paths).to match_array [
+              File.join(path, "directory_a"),
+              File.join(path, "Directory_B"),
+              File.join(path, "directory_c")
+            ]
+          end
+
+          it "can translate the entries into words" do
+            expect(words).to match_array [
+              "directory_a",
+              "directory_b",
+              "directory_c"
+            ]
+          end
+        end
+
+        context "nothing" do
+          subject { described_class.new(path, include_files: false, include_subdirs: false) }
+
+          it "finds nothing at all" do
+            expect(paths).to be_empty
+          end
+
+          it "has no words" do
+            expect(words).to be_empty
+          end
+        end
+      end
+
+      describe "#matches_for" do
+        it "will respond to #matches_for, and that's good enough" do
+          expect(subject).to respond_to :matches_for
+        end
+      end
+    end
+  end
+end

data/spec/lib/nknm/lists/names_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nknm
+  module Lists
+    describe Names do
+      subject { described_class.new(["Flurp", "bloop bloop", "MITTENS!"]) }
+
+      describe "#items" do
+        let(:names) { subject.items.map(&:to_s) }
+        let(:words) { subject.items.map(&:to_word) }
+
+        it "returns all the names it was given" do
+          expect(names).to match_array [
+            "Flurp",
+            "bloop bloop",
+            "MITTENS!"
+          ]
+        end
+
+        it "can translate the entries into words" do
+          expect(words).to match_array [
+            "flurp",
+            "bloop bloop",
+            "mittens!"
+          ]
+        end
+      end
+
+      describe "#matches_for" do
+        it "will respond to #matches_for, and that's good enough" do
+          expect(subject).to respond_to :matches_for
+        end
+      end
+    end
+  end
+end

data/spec/lib/nknm/nickname_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Nknm
+  describe Nickname do
+    describe "#for?" do
+      {
+        tng: [%w[tngtng things tenalgrap tingy], %w[nothing tognar torg]],
+        s: [%w[ssss slim still sandy], %w[goop fsck t-shirt]]
+      }.each do |nickname, (yes, no)|
+        context "#{nickname}" do
+          subject { described_class.new(nickname) }
+
+          yes.each do |word|
+            it "matches #{word}" do
+              expect(subject.for?(word)).to be true
+            end
+          end
+
+          no.each do |word|
+            it "does not match #{word}" do
+              expect(subject.for?(word)).to be false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
+require "nknm"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: nknm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin McDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: pry-byebug
+  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
+    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: rspec
+  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: simplecov
+  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: standard
+  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: yard
+  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'
+description: Select items from a list using easy-to-type nicknames
+email:
+- kevinstuffandthings@gmail.com
+executables:
+- nknm-dir
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/nknm-dir
+- lib/nknm.rb
+- lib/nknm/list.rb
+- lib/nknm/list/matches.rb
+- lib/nknm/list/selector.rb
+- lib/nknm/list/selectors/terminal.rb
+- lib/nknm/lists.rb
+- lib/nknm/lists/directory.rb
+- lib/nknm/lists/names.rb
+- lib/nknm/nickname.rb
+- lib/nknm/version.rb
+- nknm.gemspec
+- spec/lib/nknm/list/matches_spec.rb
+- spec/lib/nknm/list/selector_spec.rb
+- spec/lib/nknm/list/selectors/terminal_spec.rb
+- spec/lib/nknm/list_spec.rb
+- spec/lib/nknm/lists/directory/example/Directory_B/.gitkeep
+- spec/lib/nknm/lists/directory/example/File 1.txt
+- spec/lib/nknm/lists/directory/example/directory_a/.gitkeep
+- spec/lib/nknm/lists/directory/example/directory_c/.gitkeep
+- spec/lib/nknm/lists/directory/example/file 2.txt
+- spec/lib/nknm/lists/directory_spec.rb
+- spec/lib/nknm/lists/names_spec.rb
+- spec/lib/nknm/nickname_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kevinstuffandthings/nknm
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Select items from a list using easy-to-type nicknames
+test_files:
+- spec/lib/nknm/list/matches_spec.rb
+- spec/lib/nknm/list/selector_spec.rb
+- spec/lib/nknm/list/selectors/terminal_spec.rb
+- spec/lib/nknm/list_spec.rb
+- spec/lib/nknm/lists/directory/example/Directory_B/.gitkeep
+- spec/lib/nknm/lists/directory/example/File 1.txt
+- spec/lib/nknm/lists/directory/example/directory_a/.gitkeep
+- spec/lib/nknm/lists/directory/example/directory_c/.gitkeep
+- spec/lib/nknm/lists/directory/example/file 2.txt
+- spec/lib/nknm/lists/directory_spec.rb
+- spec/lib/nknm/lists/names_spec.rb
+- spec/lib/nknm/nickname_spec.rb
+- spec/spec_helper.rb