friends 0.17 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67aca011d40b8ec1f5f92dda50a441dff1363523
-  data.tar.gz: fdd5c7f7459f4bf28773d4e6c1ef3ab4d462f35e
+  metadata.gz: cafcf4ae0c7862e767cfa66d62f82358aa4427dd
+  data.tar.gz: ce713e78e33183b58d1dfe8a0a4ee56434bef476
 SHA512:
-  metadata.gz: 4d05eff21075277e8bc244c69c4bf506c52b74955ef841d65a0fd23cd883d48af4f0d652ccde694ec453e4460355f542251c891f97ad6fe0986f49b08952e273
-  data.tar.gz: 8df26c543ce7c25dc6a1c1474914fd170ca973019b27834df33c5003b1900e07f5112a02c96117dd8b4eb7c17fb1f1c3af9e9c8a5e722ce2ee06b9ca883e2e36
+  metadata.gz: abe895385b3b8fead89b0d05693b8c8ccce448a3a0af2af65bb0eb0441cc22e4b25d8de0d62b2318572053d5db977ec69dd33b90003017b89bd7349124baa0e1
+  data.tar.gz: 26ccbf5fe8b0178a8473ed8c7b541bed990cc9d65644760cd21a642a00a4b840048c1a3cde58e87c619d3ee5554e660342b4fce81bc7a012ea29bdff3c631509

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## [v0.18](https://github.com/JacobEvelyn/friends/tree/v0.18) (2016-05-02)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.17...v0.18)
+
+**Implemented enhancements:**
+
+- Improve documentation [\#92](https://github.com/JacobEvelyn/friends/issues/92)
+- Have a way to correct mistakes? [\#91](https://github.com/JacobEvelyn/friends/issues/91)
+- Allow friends to be found with first name and last name initial [\#87](https://github.com/JacobEvelyn/friends/issues/87)
+
+**Fixed bugs:**
+
+- Nicknames including first names should match over first name [\#111](https://github.com/JacobEvelyn/friends/issues/111)
+
+**Merged pull requests:**
+
+- Match friends with first name and last name initial [\#114](https://github.com/JacobEvelyn/friends/pull/114) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Give nicknames matching precedence over first names [\#113](https://github.com/JacobEvelyn/friends/pull/113) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Add `friends edit` command [\#112](https://github.com/JacobEvelyn/friends/pull/112) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Organize documentation in README [\#110](https://github.com/JacobEvelyn/friends/pull/110) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.17](https://github.com/JacobEvelyn/friends/tree/v0.17) (2016-03-28)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.16...v0.17)
 
@@ -62,7 +82,7 @@
 **Merged pull requests:**
 
 - Improve handling of double-names and names within names [\#81](https://github.com/JacobEvelyn/friends/pull/81) ([JacobEvelyn](https://github.com/JacobEvelyn))
-- Update RuboCop and fix many offenses [\#79](https://github.com/JacobEvelyn/friends/pull/79) ([bloomyminded](https://github.com/bloomyminded))
+- Update RuboCop and fix many offenses [\#79](https://github.com/JacobEvelyn/friends/pull/79) ([codyjroberts](https://github.com/codyjroberts))
 
 ## [v0.12](https://github.com/JacobEvelyn/friends/tree/v0.12) (2016-01-16)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.11...v0.12)
@@ -75,7 +95,7 @@
 **Merged pull requests:**
 
 - Update README and CONTRIBUTING docs. Closes \#76 [\#77](https://github.com/JacobEvelyn/friends/pull/77) ([JacobEvelyn](https://github.com/JacobEvelyn))
-- Add rename friend [\#75](https://github.com/JacobEvelyn/friends/pull/75) ([bloomyminded](https://github.com/bloomyminded))
+- Add rename friend [\#75](https://github.com/JacobEvelyn/friends/pull/75) ([codyjroberts](https://github.com/codyjroberts))
 
 ## [v0.11](https://github.com/JacobEvelyn/friends/tree/v0.11) (2016-01-13)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.10...v0.11)

data/README.md

@@ -5,25 +5,66 @@
 Spend time with the people you care about. Introvert-tested.
 Extrovert-approved.
 
-### What is it?
-
-**Friends** is both a Ruby library and a command-line interface that
+## Table of Contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Core concepts](#core-concepts)
+  - [Global flags](#global-flags)
+  - [Syncing across multiple machines](#syncing-across-multiple-machines)
+  - [Command reference](#command-reference)
+    - [`add`](#add)
+      - [`add activity`](#add-activity)
+      - [`add friend`](#add-friend)
+      - [`add location`](#add-location)
+      - [`add nickname`](#add-nickname)
+    - [`clean`](#clean)
+    - [`graph`](#graph)
+    - [`help`](#help)
+    - [`list`](#list)
+      - [`list activities`](#list-activities)
+      - [`list favorites`](#list-favorites)
+      - [`list friends`](#list-friends)
+      - [`list locations`](#list-locations)
+    - [`remove nickname`](#remove-nickname)
+    - [`rename`](#rename)
+      - [`rename friend`](#rename-friend)
+      - [`rename location`](#rename-location)
+    - [`set location`](#set)
+    - [`stats`](#stats)
+    - [`suggest`](#suggest)
+    - [`update`](#update)
+- [Other documentation](#other-documentation)
+- [Contributing (it's encouraged!)](#contributing-its-encouraged)
+- [Code of Conduct](#code-of-conduct)
+- [License](#license)
+
+----
+
+## Overview
+
+`friends` is both a Ruby library and a command-line interface that
 allows you to keep track of your relationships with the people you
 care about.
 
-### Why use it?
+`friends` gives you:
+- More organization around staying in touch with friends and
+  family.
+- A way to track the ebbs and flows of your relationships over
+  time.
+- Suggestions for who to call or hang out with when you have free
+  time, whether it's fifteen minutes or an entire weekend.
+- A low-cost way to record and remember big moments in your life.
+
+Its philosophy emphasizes:
 
-1. **Friends** gives you:
-  - More organization around staying in touch with friends and
-    family.
-  - A way to track the ebbs and flows of your relationships over
-    time.
-  - Suggestions for who to call or hang out with when you have free
-    time, whether it's fifteen minutes or an entire weekend.
-  - A low-cost way to record and remember big moments in your life.
-2. **Friends** stores its data in a human-readable `friends.md`
-  Markdown file. No proprietary formats here!
-3. **Friends** is open-source and very open to new ideas. Contribute!
+- **Simplicity**—it should be quick and easy to use.
+- **Transparency**—all data is stored in a human-readable Markdown file. No
+  proprietary formats here! And in addition to being open-source, `friends` is
+  very much open to new ideas. Contribute!
+- **Intelligence**—specify dates with English phrases like "yesterday." Specify
+  friends with their first names, even when you're friends with many *Joanne*s. `friends` will figure it out.
 
 ## Installation
 
@@ -31,240 +72,443 @@ care about.
 $ gem install friends
 ```
 
-## Usage*
+Easy, huh?
 
-*Note that the command-line output is colored, which this README cannot show.
+## Usage
+
+### Core concepts
+
+`friends` is structured around several different types of things:
 
-### Basic commands:
+- **Activities**: The things you do. Each activity has a date associated with
+  it.
+- **Friends**: The people you do *activities* with. Each friend has a name and,
+  optionally, one or several nicknames.
+- **Locations**: The places in which *activities* happen.
 
-##### Add a friend:
+The `friends.md` Markdown file that stores all of your data contains:
+
+- an alphabetical list of all locations:
+
+```markdown
+### Locations:
+- Atlantis
+- Marie's Diner
+- Paris
 ```
-$ friends add friend "Grace Hopper"
-Friend added: "Grace Hopper"
+
+- an alphabetical list of all friends and their nicknames and locations:
+
+```markdown
+### Friends:
+- George Washington Carver
+- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris]
+- Marie Curie [Atlantis]
+```
+
+- and an ordered list of all activities:
+
+```markdown
+### Activities:
+- 2015-11-01: **Grace Hopper** and I went to _Marie's Diner_. George had to cancel at the last minute.
+- 2015-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**.
+- 2014-12-31: Celebrated the new year in _Paris_ with **Marie Curie**.
+- 2014-11-15: Talked to **George Washington Carver** on the phone for an hour.
+```
+
+See the example
+[`friends.md`](https://github.com/JacobEvelyn/friends/blob/master/friends.md)
+file for more information.
+
+### Global flags
+
+`friends` supports several global flags that can be used on any command when
+specified before the name of the command, like: `friends [flags] [command]`.
+
+These flags are:
+
+- `--debug`: Debug error messages with a full backtrace.
+- `--filename`: Set the location of the friends file to use (default: ./friends.md)
+
+```bash
+$ friends --filename ./test/tmp/friends.md clean
+File cleaned: "./test/tmp/friends.md"
+```
+
+- `--quiet`: Quiet output messages.
+
+```bash
+$ friends --quiet add activity "Went rollerskating with George."
+$ # No output!
+```
+
+In addition, these flags may be used without any command:
+
+- `--help`: Show the help menu. This is equivalent to `friends help`.
+Help menus are available for all levels of commands:
+
+```bash
+$ friends --help
+```
+
+```bash
+$ friends list --help
 ```
-##### Record an activity with a friend:
+
+```bash
+$ friends list activities --help
 ```
+
+- `--version`: Show the `friends` program version.
+
+### Syncing across multiple machines
+
+Wouldn't it be nice to be able to use `friends` across all of your
+devices? Hooray, you can! Just put the `friends.md` file in your
+Dropbox/Box Sync/Google Drive/whatever folder and use the
+`--filename` flag. You can even set up a Bash/Zsh/whatever alias to
+do this for you, like so:
+
+```bash
+alias friends="friends --filename '~/Dropbox/friends.md'"
+```
+
+### Command reference*
+
+*Note that the command-line output is colored, which this README cannot show.
+
+#### `add`
+
+##### `add activity`
+
+```bash
 $ friends add activity "Got lunch with Grace and George."
 Activity added: "2015-01-04: Got lunch with Grace Hopper and George Washington Carver."
 ```
+
 `friends` will **automatically** figure out which "Grace" and "George" you're referring to, *even if you're friends with lots of different Graces and Georges*.
 
-You can of course specify a date for the activity:
+Nicknames will be used to match friends in activities,
+just like formal names:
+
+```bash
+$ friends add activity "Invented debugging with The Admiral."
+Activity added: "2016-01-06: Invented debugging with Grace Hopper."
+```
+
+You can also use the first initial of a last name instead of the whole thing.
+`friends` will figure out what to do with those pesky periods (if you include
+them) based on whether you're in the middle of a sentence or not:
+
+```bash
+$ friends add activity "Got lunch with Earnest H and Earnest S. in the park. Man, I like Earnest H. but really love Earnest S."
+Activity added: "2016-05-01: Got lunch with Earnest Hemingway and Earnest Shackleton in the park. Man, I like Earnest Hemingway but really love Earnest Shackleton."
+```
+
+And locations will be matched as well:
+
+```bash
+$ friends add activity "Went swimming near atlantis with George."
+Activity added: "2016-01-06: Went swimming near Atlantis with George Washington Carver."
 ```
+
+You can of course specify a date for the activity:
+
+```bash
 $ friends add activity "Yesterday: Celebrated the new year with Marie."
 Activity added: "2014-12-31: Celebrated the new year with Marie Curie."
 ```
+
 Or get an **interactive prompt** by just typing `friends add activity`, with or without a date specified:
-```
+
+```bash
 $ friends add activity 2015-11-01
 2015-11-01: <type description here>
 ```
+
 **Natural-language dates** work just fine:
-```
+
+```bash
 $ friends add activity 'last Monday'
 2016-03-07: <type description here>
 ```
+
 You can escape the names of friends you don't want `friends` to match with a backslash:
-```
+
+```bash
 $ friends add activity "2015-11-01: Grace and I went to \Marie's Diner. \George had to cancel at the last minute."
 Activity added: "2015-11-01: Grace Hopper and I went to Marie's Diner. George had to cancel at the last minute."
 ```
-##### Set a friend's nicknames:
+
+##### `add friend`
+
+```bash
+$ friends add friend "Grace Hopper"
+Friend added: "Grace Hopper"
+```
+
+##### `add location`
+
+```
+$ friends add location Atlantis
+Location added: "Atlantis"
 ```
+
+##### `add nickname`
+
+```bash
 $ friends add nickname "Grace Hopper" "The Admiral"
 Nickname added: "Grace Hopper (a.k.a. The Admiral)
 $ friends add nickname "Grace Hopper" "Amazing Grace"
 Nickname added: "Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace)"
 ```
-Nicknames will be used to match friends in activities,
-just like formal names:
-```
-$ friends add activity "Invented debugging with Amazing Grace.""
-Activity added: "2016-01-06: Invented debugging with Amazing Grace Hopper."
-```
-And they can be removed as well:
-```
-$ friends remove nickname "Grace Hopper" "The Admiral"
-Nickname removed: "Grace Hopper (a.k.a. Amazing Grace)"
-```
-##### Set a friend's location:
-```
-$ friends set location Marie Paris
-Marie Curie's location set to: Paris
-```
-##### Change a friend's name:
-```
-$ friends rename friend "Grace Hopper" "Grace Brewster Murray Hopper"
-Name changed: "Grace Brewster Murray Hopper (a.k.a. Amazing Grace)"
-```
-##### Change the name of a location:
-```
-$ friends rename location Paris "Paris, France"
-Location renamed: "Paris, France"
-```
-##### Suggest a friend to do something with:
+
+#### `clean`
+
+Reads and re-writes the `friends.md` file:
+
+```bash
+$ friends clean
+File cleaned: "./friends.md"
 ```
-$ friends suggest
-Distant friend: Marie Curie
-Moderate friend: Grace Hopper
-Close friend: George Washington Carver
+
+This command is useful after manual editing of the file, for re-ordering its
+contents.
+
+#### `edit`
+
+Allows you to manually edit the file:
+
+```bash
+$ friends edit
+Opening "./friends.md" in vim
 ```
-Or only suggest friends in a specific location:
+
+The file is opened with the command specified by the `$EDITOR` environment
+variable, falling back to `vim` if it is not set:
+
+```bash
+$ export EDITOR=atom
+$ friends edit
+Opening "./friends.md" in atom
 ```
-$ friends suggest --in Paris
-Distant friend: Marie Curie
+
+#### `graph`
+
+Graphs (in color!) your relationship with a given friend over time:
+
+```bash
+$ friends graph George
+Nov 2014 |█
+Dec 2014 |
+Jan 2015 |█████
+Feb 2015 |███
 ```
-##### Add a location for your friends and activities:
+
+Or just graph all of your activities:
+
+```bash
+$ friends graph
+Nov 2014 |███
+Dec 2014 |██
+Jan 2015 |███████
+Feb 2015 |█████
 ```
-$ friends add location Atlantis
-Location added: "Atlantis"
+
+#### `help`
+
+Displays a help menu. This is equivalent to `friends --help`.
+
+```bash
+$ friends help
+NAME
+    friends - Spend time with the people you care about. Introvert-tested. Extrovert-approved.
+
+SYNOPSIS
+    friends [global options] command [command options] [arguments...]
+
+...
 ```
-##### And locations will be matched as well:
+
+Help menus are available for all levels of commands:
+
+```bash
+$ friends help
 ```
-$ friends add activity "Went swimming near atlantis with George."
-Activity added: "2016-01-06: Went swimming near Atlantis with George Washington Carver."
+
+```bash
+$ friends help list
 ```
-##### List the activities you've recorded:
+
+```bash
+$ friends help list activities
 ```
+
+#### `list`
+
+##### `list activities`
+
+Lists recent activities:
+
+```bash
 $ friends list activities
 2015-01-04: Got lunch with Grace Hopper and George Washington Carver.
 2014-12-31: Celebrated the new year with Marie Curie in New York City.
 2014-11-15: Talked to George Washington Carver on the phone for an hour.
 ```
-Or only list the activities you did with a certain friend:
+
+You can adjust how many activities are shown:
+
+```bash
+$ friends list activities --limit 2
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver.
+2014-12-31: Celebrated the new year with Marie Curie in New York City.
 ```
+
+Or only list the activities you did with a certain friend:
+
+```bash
 $ friends list activities --with "George"
 2015-01-04: Got lunch with Grace Hopper and George Washington Carver.
 2014-11-15: Talked to George Washington Carver on the phone for an hour.
-
 ```
+
 Or filter your activities by location:
-```
+
+```bash
 $ friends list activities --in "New York"
 2014-12-31: Celebrated the new year with Marie Curie in New York City.
 ```
-##### Find your favorite friends:
-```
+
+##### `list favorites`
+
+Lists your "favorite" friends (by total number of activities):
+
+```bash
 $ friends list favorites
 Your favorite friends:
 1. George Washington Carver (2 activities)
 2. Grace Hopper             (1)
 3. Marie Curie              (1)
 ```
-Or get a specific number of favorites:
-```
+
+You can specify a number of favorites to show:
+
+```bash
 $ friends list favorites --limit 2
 Your favorite friends:
 1. George Washington Carver (2 activities)
 2. Grace Hopper             (1)
 ```
-##### Graph (in color!) your relationship with a friend over time:
-```
-$ friends graph George
-Nov 2014 |█
-Dec 2014 |
-Jan 2015 |█████
-Feb 2015 |███
-```
-##### Or just graph all of your activities:
-```
-$ friends graph
-Nov 2014 |███
-Dec 2014 |██
-Jan 2015 |███████
-Feb 2015 |█████
-```
-##### Or just check out your lifetime stats:
-```
-$ friends stats
-Total activities: 4
-Total friends: 3
-Total time elapsed: 5 days
-```
-##### List all of your friends:
-```
+
+##### `list friends`
+
+Lists all of your friends:
+
+```bash
 $ friends list friends
 George Washington Carver
 Grace Hopper
 Marie Curie
 ```
-Or list only the friends in a specific location:
-```
+
+You can filter your friends by location:
+
+```bash
 $ friends list friends --in Paris
 Marie Curie
 ```
-##### List the locations you've added:
+
+##### `list locations`
+
+Lists all of the locations you've added:
+
 ```
 $ friends list locations
 Atlantis
 New York City
 Paris
 ```
-##### Update to the latest version:
-```
-$ friends update
-Updated to friends 0.3
-```
-### Global options:
 
-##### --quiet
+#### `remove nickname`
 
-Quiet output messages:
-```
-$ friends --quiet add activity "Went rollerskating with George."
-$ # No output!
+Removes a specific nickname from a friend:
+
+```bash
+$ friends remove nickname "Grace Hopper" "The Admiral"
+Nickname removed: "Grace Hopper (a.k.a. Amazing Grace)"
 ```
 
-##### --filename
+#### `rename`
 
-Change the location/name of the `friends.md` file:
-```
-$ friends --filename ./test/tmp/friends.md clean
-File cleaned: "./test/tmp/friends.md"
+##### `rename friend`
+
+```bash
+$ friends rename friend "Grace Hopper" "Grace Brewster Murray Hopper"
+Name changed: "Grace Brewster Murray Hopper (a.k.a. Amazing Grace)"
 ```
 
-##### --clean
+##### `rename location`
 
-Force cleaning of the `friends.md` file, even if the command does not
-normally write to the file.
-```
-$ friends --clean list friends
-George Washington Carver
-Grace Hopper
-Marie Curie
-File cleaned: "./friends.md"
+```bash
+$ friends rename location Paris "Paris, France"
+Location renamed: "Paris, France"
 ```
 
-### Advanced usage:
+#### `set location`
+
+Sets a friend's location:
 
-Wouldn't it be nice to be able to use **Friends** across all of your
-devices? Hooray, you can! Just put the `friends.md` file in your
-Dropbox/Box Sync/Google Drive/whatever folder and use the
-`--filename` flag. You can even set up a Bash/Zsh/whatever alias to
-do this for you, like so:
 ```bash
-alias friends="friends --filename '~/Dropbox/friends.md'"
+$ friends set location Marie Paris
+Marie Curie's location set to: Paris
 ```
 
-### Help:
+#### `stats`
 
-Help menus are available for all levels of commands:
-```
-$ friends --help
+Gives you your lifetime usage stats:
+
+```bash
+$ friends stats
+Total activities: 4
+Total friends: 3
+Total time elapsed: 5 days
 ```
+
+#### `suggest`
+
+Gives you suggestions of up to three random friends to do something with, based
+on how often you've done things with them in the past:
+
+```bash
+$ friends suggest
+Distant friend: Marie Curie
+Moderate friend: Grace Hopper
+Close friend: George Washington Carver
 ```
-$ friends list --help
+
+You can request suggestions of friends in a specific location:
+
+```bash
+$ friends suggest --in Paris
+Distant friend: Marie Curie
 ```
+
+#### `update`
+
+Updates `friends` to the latest version on RubyGems:
+
 ```
-$ friends list activities --help
+$ friends update
+Updated to friends 0.17
 ```
 
-## Documentation
+## Other documentation
 
-In case you're *really* interested, we have
-[documentation](http://www.rubydoc.info/github/JacobEvelyn/friends).
+In case you're *really* interested, we have documentation on
+[RubyDoc](http://www.rubydoc.info/github/JacobEvelyn/friends).
 
-## Contributing
+## Contributing (it's encouraged!)
 
 If you have an idea,
 [make a GitHub Issue](https://github.com/JacobEvelyn/friends/issues/new)!

data/RELEASING.md

@@ -7,7 +7,8 @@ These are steps for the maintainer to take to release a new version of this gem.
 2. Commit the change (`git add -A && git commit -m 'Bump to vX.X'`).
 3. Add a tag (`git tag -am "vX.X" vX.X`).
 4. `git push && git push --tags`
-5. `github_changelog_generator && git add -A && git commit -m 'Update CHANGELOG for vX.X'`
-6. `git push`
-7. `gem build friends.gemspec && gem push *.gem && rm *.gem`
-8. Celebrate!
+5. `CHANGELOG_GITHUB_TOKEN=... github_changelog_generator`
+6. `git add -A && git commit -m 'Update CHANGELOG for vX.X'`
+7. `git push`
+8. `gem build friends.gemspec && gem push *.gem && rm *.gem`
+9. Celebrate!

data/bin/friends

@@ -34,9 +34,8 @@ switch [:debug],
 desc "Updates the `friends` program"
 command :update do |update|
   update.action do
-    search = `gem search friends`
     # rubocop:disable Lint/AssignmentInCondition
-    if match = search.match(/^friends\s\(([^\)]+)\)$/)
+    if match = `gem search friends`.match(/^friends\s\(([^\)]+)\)$/)
       # rubocop:enable Lint/AssignmentInCondition
       remote_version = match[1]
       if Semverse::Version.coerce(remote_version) >
@@ -56,6 +55,17 @@ command :update do |update|
   end
 end
 
+desc "Opens the `friends.md` file in $EDITOR for manual editing"
+command :edit do |edit|
+  edit.action do |global_options|
+    editor = ENV["EDITOR"] || "vim"
+    filename = global_options[:filename]
+
+    puts "Opening \"#{filename}\" in #{editor}" unless global_options[:quiet]
+    Kernel.exec "#{editor} #{filename}"
+  end
+end
+
 desc "Lists friends, activities, and locations"
 command :list do |list|
   list.desc "List all friends"

data/friends.md

@@ -6,7 +6,7 @@
 
 ### Friends:
 - George Washington Carver
-- Grace Hopper (a.k.a. The Admiral) [Paris]
+- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris]
 - Marie Curie [Atlantis]
 
 ### Locations:

data/lib/friends/friend.rb

@@ -101,7 +101,28 @@ module Friends
 
       # Create the list of regexes and return it.
       chunks = name.split(Regexp.new(splitter))
-      [chunks, [chunks.first], *@nicknames.map { |n| [n] }].map do |words|
+
+      # We check nicknames before first names because nicknames may contain
+      # first names, as in "Amazing Grace" being a nickname for Grace Hopper.
+      [
+        chunks,
+        *@nicknames.map { |n| [n] },
+
+        # Match a first name followed by a last name initial, period, and then
+        # (via lookahead) spacing followed by a lowercase letter. This matches
+        # the "Jake E." part of something like "Jake E. and I went skiing." This
+        # allows us to correctly count the period as part of the name when it's
+        # in the middle of a sentence.
+        [chunks.first, "#{chunks.last[0]}\.(?=#{splitter}(?-i)[a-z])"],
+
+        # If the above doesn't match, we check for just the first name and then
+        # a last name initial. This matches the "Jake E" part of something like
+        # "I went skiing with Jake E." This allows us to correctly exclude the
+        # period from the name when it's at the end of a sentence.
+        [chunks.first, chunks.last[0]],
+
+        [chunks.first]
+      ].map do |words|
         Friends::RegexBuilder.regex(words.join(splitter))
       end
     end

data/lib/friends/regex_builder.rb

@@ -21,17 +21,22 @@ module Friends
     NO_LEADING_ALPHABETICALS = "(?<![A-z])".freeze
     NO_TRAILING_ALPHABETICALS = "(?![A-z])".freeze
 
+    # We ignore case within the regex as opposed to globally to allow consumers
+    # of this API the ability to pass in strings that turn off this modifier
+    # with the "(?-i)" string.
+    IGNORE_CASE = "(?i)".freeze
+
     def self.regex(str)
       Regexp.new(
         NO_LEADING_BACKSLASH +
         NO_LEADING_ASTERISKS +
         NO_LEADING_UNDERSCORES +
         NO_LEADING_ALPHABETICALS +
+        IGNORE_CASE +
         str +
         NO_TRAILING_ALPHABETICALS +
         NO_TRAILING_UNDERSCORES +
-        NO_TRAILING_ASTERISKS,
-        Regexp::IGNORECASE
+        NO_TRAILING_ASTERISKS
       )
     end
   end

data/lib/friends/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Friends
-  VERSION = "0.17".freeze
+  VERSION = "0.18".freeze
 end

data/test/activity_spec.rb

@@ -173,6 +173,78 @@ describe Friends::Activity do
       end
     end
 
+    describe "when description has nicknames" do
+      let(:description) { "Lunch with Lizzy and Johnny." }
+      it "matches friends" do
+        friend1.add_nickname("Lizzy")
+        friend2.add_nickname("Johnny")
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend1.name}** and **#{friend2.name}**."
+      end
+    end
+
+    describe "when discription has nicknames which contain first names" do
+      let(:nickname1) { "Awesome #{friend1.name}" }
+      let(:nickname2) { "Long #{friend2.name} Silver" }
+      let(:description) { "Lunch with #{nickname1} and #{nickname2}." }
+      it "matches friends" do
+        friend1.add_nickname(nickname1)
+        friend2.add_nickname(nickname2)
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend1.name}** and **#{friend2.name}**."
+      end
+    end
+
+    describe 'when description ends with "<first name> <last name initial>"' do
+      let(:description) { "Lunch with John C" }
+      it "matches the friend" do
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend2.name}**"
+      end
+    end
+
+    describe 'when description ends with "<first name> <last name initial>".' do
+      let(:description) { "Lunch with John C." }
+      it "matches the friend and keeps the period" do
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend2.name}**."
+      end
+    end
+
+    describe "when description has \"<first name> <last name initial>\" in "\
+             "the middle of a sentence" do
+      let(:description) { "Lunch with John C in the park." }
+      it "matches the friend" do
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend2.name}** in the park."
+      end
+    end
+
+    describe "when description has \"<first name> <last name initial>.\" in "\
+             "the middle of a sentence" do
+      let(:description) { "Lunch with John C. in the park." }
+      it "matches the friend and swallows the period" do
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend2.name}** in the park."
+      end
+    end
+
+    describe "when description has \"<first name> <last name initial>\". at "\
+             "the end of a sentence" do
+      let(:description) { "Lunch with John C. It was great!" }
+      it "matches the friend and keeps the period" do
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend2.name}**. It was great!"
+      end
+    end
+
     describe "when names are not entered case-sensitively" do
       let(:description) { "Lunch with elizabeth cady stanton." }
       it "matches friends" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.17'
+  version: '0.18'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic