friends 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 594e797cfad3741eac04b32f65fad9bdaa79e6d6
-  data.tar.gz: d4db59517521f8d5110b85426533d8a199db2d75
+  metadata.gz: 014d82e8189c2cf8442af3e9058d56dbfdfb0fd3
+  data.tar.gz: a4a10982b5139cbe3b800aea6f984e32763beea9
 SHA512:
-  metadata.gz: 2dc7bb05e42a152f8fc5e5d532069295525bceb3c5f30b8a35cbf9b32dcd8561644d947f205a5a0cb964b4d1a2ae084bc745ee14bfa1e48daeb1c880130cf4fe
-  data.tar.gz: e675e071c9be2c956c7d138c327ef15a5c20823643480b754304d7ef9b219159d8de3c853351d054fd9648a0bdd519691be8bafea31d87cb9cbf1dcef6d160e6
+  metadata.gz: ac424ae74a5b3640c9374d4c7a9691d8e5305be1afba2a97f5714dfb662ffa2ea50238c6e30beb54ce48132dc610d8371229d9250a92e349772a5840ea1c9cf1
+  data.tar.gz: 8df418e8482b5d27eeb6823d870cabe1b818931628283e64c74cdb6d8ade3a78ed0371a2bf16415d08cc3e45492cd92ba88db78e0ec227ea138e69ff42c51cd7

data/README.md

@@ -31,34 +31,36 @@ care about.
 $ gem install friends
 ```
 
-## Usage
+## Usage*
+
+*Note that the command-line output is colored, which this README cannot show.
 
 ### Basic commands:
 
-Add a friend:
+##### Add a friend:
 
 ```
 $ friends add friend "Grace Hopper"
 Friend added: "Grace Hopper"
 ```
-List your friends:
-```
-$ friends list friends
-George Washington Carver
-Grace Hopper
-Marie Curie
-```
-Record an activity with a friend:
+##### Record an activity with a friend:
 ```
 $ friends add activity "Got lunch with Grace and George."
 Activity added: "2015-01-04: Got lunch with Grace Hopper and George Washington Carver."
 ```
-Or specify a date for the activity:
+`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:
 ```
 $ friends add activity "2014-12-31: Celebrated the new year with Marie."
 Activity added: "2014-12-31: Celebrated the new year with Marie Curie."
 ```
-List the activities you've recorded:
+Or get an **interactive prompt** by just typing `friends add activity`, with or without a date specified:
+```
+$ friends add activity 2015-11-01
+2015-11-01: <type description here>
+```
+##### List the activities you've recorded:
 ```
 $ friends list activities
 2015-01-04: Got lunch with Grace Hopper and George Washington Carver.
@@ -72,7 +74,7 @@ $ friends list activities --with "George"
 2014-11-15: Talked to George Washington Carver on the phone for an hour.
 
 ```
-Find your favorite friends:
+##### Find your favorite friends:
 ```
 $ friends list favorites
 Your favorite friends:
@@ -87,7 +89,7 @@ Your favorite friends:
 1. George Washington Carver (2 activities)
 2. Grace Hopper             (1)
 ```
-Graph your relationship with a friend over time:
+##### Graph (in color!) your relationship with a friend over time:
 ```
 $ friends graph "George"
 Nov 2014 |█
@@ -95,16 +97,21 @@ Dec 2014 |
 Jan 2015 |█████
 Feb 2015 |███
 ```
-
+##### List all of your friends:
+```
+$ friends list friends
+George Washington Carver
+Grace Hopper
+Marie Curie
+```
 ### Global options:
 
 ##### --quiet
 
 Quiet output messages:
 ```
-$ friends add activity "Went rollerskating with George."
+$ friends --quiet add activity "Went rollerskating with George."
 $ # No output!
-
 ```
 
 ##### --filename
@@ -160,7 +167,7 @@ In case you're *really* interested, we have
 
 If you have an idea,
 [make a GitHub Issue](https://github.com/JacobEvelyn/friends/issues/new)!
-Suggestions are very very welcome, and often are implemented very
+Suggestions are very very welcome, and usually are implemented very
 quickly. And if you'd like to do the implementing yourself:
 
 1. Fork it (https://github.com/JacobEvelyn/friends/fork)

data/bin/friends

@@ -1,12 +1,15 @@
 #!/usr/bin/env ruby
 
 # Todo:
+# - Create file if none exists.
+# - Split out serialization into separate repository.
+# - Add auto check for updates.
+# - Allow friends to have nicknames.
 # - Allow easy editing of most recent entry.
-# - Make automatching use context better. (David & Meryl vs. David & Patricia)
 # - Allow escape char to prevent automatching. ("\Zane wasn't there.")
 
 require "gli"
-require "minitest/pride"
+require "paint"
 
 require "friends/introvert"
 require "friends/version"
@@ -110,14 +113,23 @@ desc "Graph"
 arg_name "NAME"
 command :graph do |graph|
   graph.action do |_, _, args|
+    # This math is taken from Minitest's Pride plugin (the PrideLOL class).
+    PI_3 = Math::PI / 3
+
+    colors = (0...(6 * 7)).map do |n|
+      n *= 1.0 / 6
+      r  = (3 * Math.sin(n           ) + 3).to_i
+      g  = (3 * Math.sin(n + 2 * PI_3) + 3).to_i
+      b  = (3 * Math.sin(n + 4 * PI_3) + 3).to_i
+
+      [r, g, b].map { |c| c * 51 }
+    end
+
     data = @introvert.graph(name: args.first)
 
     data.each do |month, count|
       print "#{month} |"
-
-      colorer = Minitest::PrideLOL.new($stdout)
-      count.times { print colorer.pride "█" }
-      puts
+      puts colors.take(count).map { |rgb| Paint["█", rgb] }.join
     end
   end
 end
@@ -127,9 +139,11 @@ command :suggest do |suggest|
   suggest.action do
     suggestions = @introvert.suggest
 
-    puts "Distant friend: \e[1m#{suggestions[:distant].sample}\e[0m"
-    puts "Moderate friend: \e[1m#{suggestions[:moderate].sample}\e[0m"
-    puts "Close friend: \e[1m#{suggestions[:close].sample}\e[0m"
+    puts "Distant friend: "\
+      "#{Paint[suggestions[:distant].sample, :bold, :magenta]}"
+    puts "Moderate friend: "\
+      "#{Paint[suggestions[:moderate].sample, :bold, :magenta]}"
+    puts "Close friend: #{Paint[suggestions[:close].sample, :bold, :magenta]}"
   end
 end
 

data/friends.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Friends::VERSION
   spec.authors       = ["Jacob Evelyn"]
   spec.email         = ["jacobevelyn@gmail.com"]
-  spec.summary       = %q{Spend time with the people you care about.}
-  spec.description   = %q{Spend time with the people you care about. Introvert-tested. Extrovert-approved.}
+  spec.summary       = "Spend time with the people you care about."
+  spec.description   = "Spend time with the people you care about. Introvert-tested. Extrovert-approved."
   spec.homepage      = "https://github.com/JacobEvelyn/friends"
   spec.license       = "MIT"
 
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "gli", "~> 2.12"
   spec.add_dependency "memoist", "~> 0.11"
+  spec.add_dependency "paint", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"

data/lib/friends/activity.rb

@@ -1,6 +1,7 @@
 # Activity represents an activity you've done with one or more Friends.
 
 require "memoist"
+require "paint"
 
 require "friends/serializable"
 
@@ -34,11 +35,12 @@ module Friends
 
     # @return [String] the command-line display text for the activity
     def display_text
-      date_s = "\e[1m#{date}\e[0m"
+      date_s = Paint[date, :bold]
       description_s = description.to_s
       while match = description_s.match(/(\*\*)([^\*]+)(\*\*)/)
-        description_s =
-          "#{match.pre_match}\e[1m#{match[2]}\e[0m#{match.post_match}"
+        description_s = "#{match.pre_match}"\
+                        "#{Paint[match[2], :bold, :magenta]}"\
+                        "#{match.post_match}"
       end
       "#{date_s}: #{description_s}"
     end
@@ -51,14 +53,15 @@ module Friends
     # Modify the description to turn inputted friend names
     # (e.g. "Jacob" or "Jacob Evelyn") into full asterisk'd names
     # (e.g. "**Jacob Evelyn**")
-    # @param introvert [Introvert] for use in aggregate computations
-    # @param friends [Array] list of friends to highlight in the description
-    # @raise [FriendsError] if more than one friend matches a part of the
-    #   description
-    def highlight_friends(introvert:, friends:)
-      # Map each friend to a list of all possible regexes for that friend.
-      friend_regexes = {}
-      friends.each { |f| friend_regexes[f] = regexes_for_name(f.name) }
+    # @param introvert [Introvert] used to access the list of friends and the
+    #  connections between the
+    # NOTE: When a friend name matches more than one friend, this method chooses
+    # a friend based on a best-guess algorithm that looks at which friends do
+    # activities together and which friends are stronger than others. For
+    # more information see the comments below and the
+    # introvert#set_likelihood_score! method.
+    def highlight_friends(introvert:)
+      friend_regexes = introvert.friend_regex_map
 
       # Create hash mapping regex to friend. Note that because two friends may
       # have the same regex (e.g. /John/), we need to store the names in an
@@ -74,19 +77,51 @@ module Friends
         end
       end
 
-      # Go through the description and substitute full, asterisk'd names for
-      # anything that matches a friend's name.
-      new_description = description.clone
-      regex_map.each do |regex, friends|
-        if friends.size > 1 # If there are multiple matches, find best friend.
-          introvert.set_n_activities!
-          friends.sort_by! { |friend| -friend.n_activities }
+      matched_friends = []
+
+      # First, we find all of the regex matches with only one possibility, and
+      # make those substitutions.
+      regex_map.
+        select { |_, arr| arr.size == 1 }.each do |regex, friend_list|
+        if match = @description.match(regex)
+          friend = friend_list.first # There's only one friend in the list.
+          matched_friends << friend
+          @description = "#{match.pre_match}"\
+            "**#{friend.name}**"\
+            "#{match.post_match}"
         end
+      end
+
+      possible_matched_friends = []
 
-        new_description.gsub!(regex, "**#{friends.first.name}**")
+      # Now, we look at regex matches that are ambiguous.
+      regex_map.
+        reject { |_, arr| arr.size == 1 }.each do |regex, friend_list|
+        if @description.match(regex)
+          possible_matched_friends << friend_list
+        end
       end
 
-      @description = new_description
+      # Now, we compute the likelihood of each friend in the possible-match set.
+      introvert.set_n_activities!
+      introvert.set_likelihood_score!(
+        matches: matched_friends,
+        possible_matches: possible_matched_friends
+      )
+
+      # Now we go through and replace all of the ambiguous matches with our best
+      # guess.
+      regex_map.
+        reject { |_, arr| arr.size == 1 }.each do |regex, friend_list|
+        if match = @description.match(regex)
+          guessed_friend = friend_list.sort_by do |friend|
+            [-friend.likelihood_score, -friend.n_activities]
+          end.first
+          @description = "#{match.pre_match}"\
+            "**#{guessed_friend.name}**"\
+            "#{match.post_match}"
+        end
+      end
     end
 
     # @param friend [Friend] the friend to test
@@ -108,40 +143,5 @@ module Friends
     def <=>(other)
       other.date <=> date
     end
-
-    # @return [Array] a list of all regexes to match the name in a string, with
-    #   longer regexes first
-    #   Note: for now we only match on full names or first names
-    #   Example: [
-    #     /Jacob\s+Morris\s+Evelyn/,
-    #     /Jacob/
-    #   ]
-    def regexes_for_name(name)
-      # We generously allow any amount of whitespace between parts of a name.
-      splitter = "\\s+"
-
-      # We don't want to match names that are directly touching double asterisks
-      # as these are treated as sacred by our program.
-      no_leading_asterisks = "(?<!\\*\\*)"
-      no_ending_asterisks = "(?!\\*\\*)"
-
-      # We don't want to match names that are part of other words.
-      no_leading_alphabeticals = "(?<![A-z])"
-      no_ending_alphabeticals = "(?![A-z])"
-
-      # Create the list of regexes and return it.
-      chunks = name.split(Regexp.new(splitter))
-
-      [chunks, [chunks.first]].map do |words|
-        Regexp.new(
-          no_leading_asterisks +
-          no_leading_alphabeticals +
-          words.join(splitter) +
-          no_ending_alphabeticals +
-          no_ending_asterisks,
-          Regexp::IGNORECASE
-        )
-      end
-    end
   end
 end

data/lib/friends/friend.rb

@@ -37,6 +37,51 @@ module Friends
       @n_activities || 0
     end
 
+    # The likelihood_score that an activity description that matches part of
+    # this friend's name does in fact refer to this friend. A higher
+    # likelihood_score means it is more likely to be this friend. For more
+    # information see the activity#highlight_friends and
+    # introvert#set_likelihood_score! methods.
+    attr_writer :likelihood_score
+    def likelihood_score
+      @likelihood_score || 0
+    end
+
+    # @return [Array] a list of all regexes to match the name in a string, with
+    #   longer regexes first
+    #   Note: for now we only match on full names or first names
+    #   Example: [
+    #     /Jacob\s+Morris\s+Evelyn/,
+    #     /Jacob/
+    #   ]
+    def regexes_for_name
+      # We generously allow any amount of whitespace between parts of a name.
+      splitter = "\\s+"
+
+      # We don't want to match names that are directly touching double asterisks
+      # as these are treated as sacred by our program.
+      no_leading_asterisks = "(?<!\\*\\*)"
+      no_ending_asterisks = "(?!\\*\\*)"
+
+      # We don't want to match names that are part of other words.
+      no_leading_alphabeticals = "(?<![A-z])"
+      no_ending_alphabeticals = "(?![A-z])"
+
+      # Create the list of regexes and return it.
+      chunks = name.split(Regexp.new(splitter))
+
+      [chunks, [chunks.first]].map do |words|
+        Regexp.new(
+          no_leading_asterisks +
+          no_leading_alphabeticals +
+          words.join(splitter) +
+          no_ending_alphabeticals +
+          no_ending_asterisks,
+          Regexp::IGNORECASE
+        )
+      end
+    end
+
     private
 
     # Default sorting for an array of friends is alphabetical.

data/lib/friends/introvert.rb

@@ -22,23 +22,20 @@ module Friends
 
       # Read in the input file. It's easier to do this now and optimize later
       # than try to overly be clever about what we read and write.
-      read_file(filename: @filename)
+      read_file
     end
 
-    attr_reader :filename
-    attr_reader :activities
-
     # Write out the friends file with cleaned/sorted data.
     def clean
       # Short-circuit if we've already cleaned the file so we don't write it
       # twice.
-      return filename if @cleaned_file
+      return @filename if @cleaned_file
 
-      descriptions = activities.sort.map(&:serialize)
-      names = friends.sort.map(&:serialize)
+      descriptions = @activities.sort.map(&:serialize)
+      names = @friends.sort.map(&:serialize)
 
       # Write out the cleaned file.
-      File.open(filename, "w") do |file|
+      File.open(@filename, "w") do |file|
         file.puts(ACTIVITIES_HEADER)
         descriptions.each { |desc| file.puts(desc) }
         file.puts # Blank line separating friends from activities.
@@ -48,7 +45,7 @@ module Friends
 
       @cleaned_file = true
 
-      filename
+      @filename
     end
 
     # Add a friend and write out the new friends file.
@@ -66,7 +63,7 @@ module Friends
         raise FriendsError, e
       end
 
-      friends << friend
+      @friends << friend
       clean # Write a cleaned file.
 
       friend # Return the added friend.
@@ -85,8 +82,8 @@ module Friends
       # If there's no description, prompt the user for one.
       activity.description ||= Readline.readline(activity.display_text)
 
-      activity.highlight_friends(introvert: self, friends: friends)
-      activities << activity
+      activity.highlight_friends(introvert: self)
+      @activities << activity
       clean # Write a cleaned file.
 
       activity # Return the added activity.
@@ -95,7 +92,7 @@ module Friends
     # List all friend names in the friends file.
     # @return [Array] a list of all friend names
     def list_friends
-      friends.map(&:name)
+      @friends.map(&:name)
     end
 
     # List your favorite friends.
@@ -111,13 +108,11 @@ module Friends
       set_n_activities! # Set n_activities for all friends.
 
       # Sort the results, with the most favorite friend first.
-      results = friends.sort_by { |friend| -friend.n_activities }
+      results = @friends.sort_by { |friend| -friend.n_activities }
 
       # If we need to, trim the list.
       results = results.take(limit) unless limit.nil?
 
-      # max_str_size = results.first.n_activities.to_s.size
-      # results.map { |friend| "#{friend.n_activities.to_s.rjust(max_str_size)} #{friend.name}" }
       max_str_size = results.map(&:name).map(&:size).max
       results.map.with_index(0) do |friend, index|
         name = friend.name.ljust(max_str_size)
@@ -133,7 +128,7 @@ module Friends
     #   unfiltered
     # @return [Array] a list of all activity text values
     def list_activities(limit:, with:)
-      acts = activities
+      acts = @activities
 
       # Filter by friend name if argument is passed.
       unless with.nil?
@@ -162,7 +157,7 @@ module Friends
       friend = friend_with_name_in(name) # Find the friend by name.
 
       # Filter out activities that don't include the given friend.
-      acts = activities.select { |act| act.includes_friend?(friend: friend) }
+      acts = @activities.select { |act| act.includes_friend?(friend: friend) }
 
       # Initialize the table of activities to have all of the months of that
       # friend's activity range (including months in the middle of the range
@@ -189,12 +184,12 @@ module Friends
       set_n_activities! # Set n_activities for all friends.
 
       # Sort our friends, with the least favorite friend first.
-      sorted_friends = friends.sort_by(&:n_activities)
+      sorted_friends = @friends.sort_by(&:n_activities)
 
       output = Hash.new { |h, k| h[k] = [] }
 
       # First, get not-so-good friends.
-      while sorted_friends.first.n_activities < 2 do
+      while sorted_friends.first.n_activities < 2
         output[:distant] << sorted_friends.shift.name
       end
 
@@ -205,11 +200,15 @@ module Friends
       output
     end
 
+    ###################################################################
+    # Methods below this are only used internally and are not tested. #
+    ###################################################################
+
     # Sets the n_activities field on each friend.
     def set_n_activities!
       # Construct a hash of friend name to frequency of appearance.
       freq_table = Hash.new { |h, k| h[k] = 0 }
-      activities.each do |activity|
+      @activities.each do |activity|
         activity.friend_names.each do |friend_name|
           freq_table[friend_name] += 1
         end
@@ -222,28 +221,64 @@ module Friends
       end
     end
 
-    private
+    # @return [Hash] mapping each friend to a list of all possible regexes for
+    #   that friend's name
+    def friend_regex_map
+      @friends.each_with_object({}) do |friend, hash|
+        hash[friend] = friend.regexes_for_name
+      end
+    end
+
+    # Sets the likelihood_score field on each friend in `possible_matches`. This
+    # score represents how likely it is that an activity containing the friends
+    # in `matches` and containing a friend from each group in `possible_matches`
+    # contains that given friend.
+    # @param matches [Array<Friend>] the friends in a specific activity
+    # @param possible_matches [Array<Array<Friend>>] an array of groups of
+    #   possible matches, for example:
+    #   [
+    #     [Friend.new(name: "John Doe"), Friend.new(name: "John Deere")],
+    #     [Friend.new(name: "Aunt Mae"), Friend.new(name: "Aunt Sue")]
+    #   ]
+    #   These groups will all contain friends with similar names; the purpose of
+    #   this method is to give us a likelihood that a "John" in an activity
+    #   description, for instance, is "John Deere" vs. "John Doe"
+    def set_likelihood_score!(matches:, possible_matches:)
+      combinations = (matches + possible_matches.flatten).
+        combination(2).
+        reject do |friend1, friend2|
+          (matches & [friend1, friend2]).size == 2 ||
+          possible_matches.any? do |group|
+            (group & [friend1, friend2]).size == 2
+          end
+        end
+
+      @activities.each do |activity|
+        names = activity.friend_names
 
-    # Gets the list of friends as read from the file.
-    # @return [Array] a list of all friends
-    def friends
-      @friends
+        combinations.each do |group|
+          if (names & group.map(&:name)).size == 2
+            group.each { |friend| friend.likelihood_score += 1 }
+          end
+        end
+      end
     end
 
+    private
+
     # Process the friends.md file and store its contents in internal data
     # structures.
-    # @param filename [String] the name of the friends file
-    def read_file(filename:)
+    def read_file
       @friends = []
       @activities = []
 
-      return unless File.exist?(filename)
+      return unless File.exist?(@filename)
 
       state = :initial
       line_num = 0
 
       # Loop through all lines in the file and process them.
-      File.foreach(filename) do |line|
+      File.foreach(@filename) do |line|
         line_num += 1
         line.chomp! # Remove trailing newline from each line.
 
@@ -278,7 +313,7 @@ module Friends
     # @return [Friend] the friend whose name exactly matches the argument
     # @raise [FriendsError] if more than one friend has the given name
     def friend_with_exact_name(name)
-      results = friends.select { |friend| friend.name == name }
+      results = @friends.select { |friend| friend.name == name }
 
       case results.size
       when 0 then nil
@@ -309,7 +344,7 @@ module Friends
     # @return [Array] a list of all friends that match the given text
     def friends_with_name_in(text)
       regex = Regexp.new(text, Regexp::IGNORECASE)
-      friends.select { |friend| friend.name.match(regex) }
+      @friends.select { |friend| friend.name.match(regex) }
     end
 
     # Raise an error that a line in the friends file is malformed.

data/lib/friends/version.rb

@@ -1,3 +1,3 @@
 module Friends
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/test/activity_spec.rb

@@ -56,8 +56,9 @@ describe Friends::Activity do
 
     it do
       subject.
-        must_equal "\e[1m#{date_s}\e[0m: "\
-          "Lunch with \e[1m#{friend1.name}\e[0m and \e[1m#{friend2.name}\e[0m"
+        must_equal "#{Paint[date_s, :bold]}: "\
+          "Lunch with #{Paint[friend1.name, :bold, :magenta]} and "\
+          "#{Paint[friend2.name, :bold, :magenta]}"
     end
   end
 
@@ -72,117 +73,153 @@ describe Friends::Activity do
   end
 
   describe "#highlight_friends" do
-    let(:friend1) { Friends::Friend.new(name: "Elizabeth Cady Stanton") }
-    let(:friend2) { Friends::Friend.new(name: "John Cage") }
+    # Add helpers to set internal states for friends and activities.
+    def stub_friends(val)
+      introvert.instance_variable_set(:@friends, val)
+      yield
+    end
+
+    def stub_activities(val)
+      introvert.instance_variable_set(:@activities, val)
+      yield
+    end
+
     let(:friends) { [friend1, friend2] }
-    let(:description) { "Lunch with #{friend1.name} and #{friend2.name}." }
-    let(:introvert) { Minitest::Mock.new }
+    let(:introvert) { Friends::Introvert.new }
     subject do
-      activity.highlight_friends(introvert: introvert, friends: friends)
+      stub_friends(friends) { activity.highlight_friends(introvert: introvert) }
     end
 
     it "finds all friends" do
       subject
       activity.description.
-        must_equal "Lunch with **#{friend1.name}** and **#{friend2.name}**."
+        must_equal "Lunch with **#{friend1.name}** and **#{friend2.name}**"
     end
 
-    it "matches friends' first names" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Lunch with Elizabeth and John."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-      activity.description.
-        must_equal "Lunch with **#{friend1.name}** and **#{friend2.name}**."
+    describe "when description has first names" do
+      let(:description) { "Lunch with Elizabeth and John." }
+      it "matches friends" do
+        subject
+        activity.description.
+          must_equal "Lunch with **#{friend1.name}** and **#{friend2.name}**."
+      end
     end
 
-    it "matches without case sensitivity" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Lunch with elizabeth cady stanton."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-      activity.description.
-        must_equal "Lunch with **Elizabeth Cady Stanton**."
+    describe "when names are not entered case-sensitively" do
+      let(:description) { "Lunch with elizabeth cady stanton." }
+      it "matches friends" do
+        subject
+        activity.description.must_equal "Lunch with **Elizabeth Cady Stanton**."
+      end
     end
 
-    it "ignores when at beginning of word" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Field trip to the Johnson Co."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-
-      # No match found.
-      activity.description.must_equal "Field trip to the Johnson Co."
+    describe "when name is at beginning of word" do
+      let(:description) { "Field trip to the Johnson Co." }
+      it "does not match a friend" do
+        subject
+        # No match found.
+        activity.description.must_equal "Field trip to the Johnson Co."
+      end
     end
 
-    it "ignores when in middle of word" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Field trip to the JimJohnJames Co."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-
-      # No match found.
-      activity.description.must_equal "Field trip to the JimJohnJames Co."
+    describe "when name is in middle of word" do
+      let(:description) { "Field trip to the JimJohnJames Co." }
+      it "does not match a friend" do
+        subject
+        # No match found.
+        activity.description.must_equal "Field trip to the JimJohnJames Co."
+      end
     end
 
-    it "ignores when at end of word" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Field trip to the JimJohn Co."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-
-      # No match found.
-      activity.description.must_equal "Field trip to the JimJohn Co."
+    describe "when name is at end of word" do
+      let(:description) { "Field trip to the JimJohn Co." }
+      it "does not match a friend" do
+        subject
+        # No match found.
+        activity.description.must_equal "Field trip to the JimJohn Co."
+      end
     end
 
-    it "does not match with leading asterisks" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Dinner with **Elizabeth Cady Stanton."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-
-      # No match found.
-      activity.description.must_equal "Dinner with **Elizabeth Cady Stanton."
+    describe "when name has leading asterisks" do
+      let(:description) { "Dinner with **Elizabeth Cady Stanton." }
+      it "does not match a friend" do
+        subject
+        # No match found.
+        activity.description.must_equal "Dinner with **Elizabeth Cady Stanton."
+      end
     end
 
-    it "does not match with ending asterisks" do
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
+    describe "when name has ending asterisks" do
+      let(:description) { "Dinner with Elizabeth**." }
+      it "does not match a friend" do
+        subject
 
         # Note: for now we can't guarantee that "Elizabeth Cady Stanton**" won't
         # match, because the Elizabeth isn't surrounded by asterisks.
-        description: "Dinner with Elizabeth**."
-      )
-      activity.highlight_friends(introvert: introvert, friends: friends)
-
-      # No match found.
-      activity.description.must_equal "Dinner with Elizabeth**."
+        activity.description.must_equal "Dinner with Elizabeth**."
+      end
     end
 
-    it "chooses the better friend when there are multiple matches" do
-      friend2.name = "Elizabeth II"
-      activity = Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Dinner with Elizabeth."
-      )
+    describe "when there are multiple matches" do
+      describe "when there is context from past activities" do
+        let(:description) { "Dinner with Elizabeth and John." }
+        let(:friends) do
+          [
+            friend1,
+            friend2,
+            Friends::Friend.new(name: "Elizabeth II")
+          ]
+        end
+
+        it "chooses a match based on the context" do
+          # Create a past activity in which Elizabeth Cady Stanton did something
+          # with John Cage. Then, create past activities to make Elizabeth II a
+          # better friend than Elizabeth Cady Stanton.
+          old_activities = [
+            Friends::Activity.new(
+              date_s: date_s,
+              description: "Picnic with **Elizabeth Cady Stanton** and "\
+                           "**John Cage**."
+            ),
+            Friends::Activity.new(
+              date_s: date_s,
+              description: "Got lunch with with **Elizabeth II**."
+            ),
+            Friends::Activity.new(
+              date_s: date_s,
+              description: "Ice skated with **Elizabeth II**."
+            )
+          ]
+
+          # Elizabeth II is the better friend, but historical activities have
+          # had Elizabeth Cady Stanton and John Cage together. Thus, we should
+          # interpret "Elizabeth" as Elizabeth Cady Stanton.
+          stub_activities(old_activities) { subject }
+
+          activity.description.
+            must_equal "Dinner with **Elizabeth Cady Stanton** and "\
+                       "**John Cage**."
+        end
+      end
 
-      # Pretend the introvert sets the friends' n_activities values.
-      introvert.expect(:set_n_activities!, nil)
-      friend1.n_activities = 5
-      friend2.n_activities = 7
+      describe "when there is no context from past activities" do
+        let(:description) { "Dinner with Elizabeth." }
 
-      activity.highlight_friends(introvert: introvert, friends: friends)
+        it "falls back to choosing the better friend" do
+          friend2.name = "Elizabeth II"
 
-      # Pick the friend with more activities.
-      activity.description.must_equal "Dinner with **Elizabeth II**."
+          # Give a past activity to Elizabeth II.
+          old_activity = Friends::Activity.new(
+            date_s: date_s,
+            description: "Do something with **Elizabeth II**."
+          )
 
-      # introvert.verify
+          stub_activities([old_activity]) { subject }
+
+          # Pick the friend with more activities.
+          activity.description.must_equal "Dinner with **Elizabeth II**."
+        end
+      end
     end
   end
 

data/test/friend_spec.rb

@@ -40,6 +40,43 @@ describe Friends::Friend do
     end
   end
 
+  describe "#n_activities" do
+    subject { friend.n_activities }
+
+    it "defaults to zero" do
+      subject.must_equal 0
+    end
+
+    it "is writable" do
+      friend.n_activities += 1
+      subject.must_equal 1
+    end
+  end
+
+  describe "#likelihood_score" do
+    subject { friend.likelihood_score }
+
+    it "defaults to zero" do
+      subject.must_equal 0
+    end
+
+    it "is writable" do
+      friend.likelihood_score += 1
+      subject.must_equal 1
+    end
+  end
+
+  describe "#regexes_for_name" do
+    subject { friend.regexes_for_name }
+
+    it "generates appropriate regexes" do
+      subject.must_equal [
+        /(?<!\*\*)(?<![A-z])Jacob\s+Evelyn(?![A-z])(?!\*\*)/i,
+        /(?<!\*\*)(?<![A-z])Jacob(?![A-z])(?!\*\*)/i
+      ]
+    end
+  end
+
   describe "#<=>" do
     it "sorts alphabetically" do
       aaron = Friends::Friend.new(name: "Aaron")

data/test/introvert_spec.rb

@@ -1,6 +1,22 @@
 require_relative "helper"
 
 describe Friends::Introvert do
+  # Add readers to make internal state easier to test.
+  class Friends::Introvert
+    attr_reader :filename, :activities, :friends
+  end
+
+  # Add helpers to set internal states for friends and activities.
+  def stub_friends(val)
+    introvert.instance_variable_set(:@friends, val)
+    yield
+  end
+
+  def stub_activities(val)
+    introvert.instance_variable_set(:@activities, val)
+    yield
+  end
+
   let(:filename) { "test/tmp/friends.md" }
   let(:args) { { filename: filename } }
   let(:introvert) { Friends::Introvert.new(args) }
@@ -60,8 +76,8 @@ describe Friends::Introvert do
         "#{Friends::Introvert::FRIENDS_HEADER}\n#{name_output}\n"
 
       # Read the input as unsorted, and make sure we get sorted output.
-      introvert.stub(:friends, unsorted_friends) do
-        introvert.stub(:activities, unsorted_activities) do
+      stub_friends(unsorted_friends) do
+        stub_activities(unsorted_activities) do
           subject
           File.read(filename).must_equal expected_output
         end
@@ -75,7 +91,7 @@ describe Friends::Introvert do
     subject { introvert.list_friends }
 
     it "lists the names of friends" do
-      introvert.stub(:friends, friends) do
+      stub_friends(friends) do
         subject.must_equal friend_names
       end
     end
@@ -90,14 +106,14 @@ describe Friends::Introvert do
 
     describe "when there is no existing friend with that name" do
       it "adds the given friend" do
-        introvert.stub(:friends, friends) do
+        stub_friends(friends) do
           subject
           introvert.list_friends.must_include new_friend_name
         end
       end
 
       it "returns the friend added" do
-        introvert.stub(:friends, friends) do
+        stub_friends(friends) do
           subject.name.must_equal new_friend_name
         end
       end
@@ -107,7 +123,7 @@ describe Friends::Introvert do
       let(:new_friend_name) { friend_names.first }
 
       it "raises an error" do
-        introvert.stub(:friends, friends) do
+        stub_friends(friends) do
           proc { subject }.must_raise Friends::FriendsError
         end
       end
@@ -123,7 +139,7 @@ describe Friends::Introvert do
       let(:limit) { 1 }
 
       it "lists that number of activities" do
-        introvert.stub(:activities, activities) do
+        stub_activities(activities) do
           subject.size.must_equal limit
         end
       end
@@ -133,7 +149,7 @@ describe Friends::Introvert do
       let(:limit) { activities.size }
 
       it "lists all activities" do
-        introvert.stub(:activities, activities) do
+        stub_activities(activities) do
           subject.size.must_equal activities.size
         end
       end
@@ -143,7 +159,7 @@ describe Friends::Introvert do
       let(:limit) { activities.size + 5 }
 
       it "lists all activities" do
-        introvert.stub(:activities, activities) do
+        stub_activities(activities) do
           subject.size.must_equal activities.size
         end
       end
@@ -153,7 +169,7 @@ describe Friends::Introvert do
       let(:limit) { nil }
 
       it "lists all activities" do
-        introvert.stub(:activities, activities) do
+        stub_activities(activities) do
           subject.size.must_equal activities.size
         end
       end
@@ -163,7 +179,7 @@ describe Friends::Introvert do
       let(:with) { nil }
 
       it "lists the activities" do
-        introvert.stub(:activities, activities) do
+        stub_activities(activities) do
           subject.must_equal activities.map(&:display_text)
         end
       end
@@ -176,8 +192,8 @@ describe Friends::Introvert do
         let(:friend_names) { ["George Washington Carver", "Boy George"] }
 
         it "raises an error" do
-          introvert.stub(:friends, friends) do
-            introvert.stub(:activities, activities) do
+          stub_friends(friends) do
+            stub_activities(activities) do
               proc { subject }.must_raise Friends::FriendsError
             end
           end
@@ -188,8 +204,8 @@ describe Friends::Introvert do
         let(:friend_names) { ["Joe"] }
 
         it "raises an error" do
-          introvert.stub(:friends, friends) do
-            introvert.stub(:activities, activities) do
+          stub_friends(friends) do
+            stub_activities(activities) do
               proc { subject }.must_raise Friends::FriendsError
             end
           end
@@ -198,8 +214,8 @@ describe Friends::Introvert do
 
       describe "when there is exactly one friend match" do
         it "filters the activities by that friend" do
-          introvert.stub(:friends, friends) do
-            introvert.stub(:activities, activities) do
+          stub_friends(friends) do
+            stub_activities(activities) do
               # Only one activity has that friend.
               subject.must_equal activities[0..0].map(&:display_text)
             end
@@ -218,14 +234,14 @@ describe Friends::Introvert do
     after { File.delete(filename) if File.exists?(filename) }
 
     it "adds the given activity" do
-      introvert.stub(:friends, friends) do
+      stub_friends(friends) do
         subject
         introvert.activities.last.description.must_equal activity_description
       end
     end
 
     it "returns the activity added" do
-      introvert.stub(:friends, friends) do
+      stub_friends(friends) do
         subject.description.must_equal activity_description
       end
     end
@@ -238,8 +254,8 @@ describe Friends::Introvert do
       let(:limit) { nil }
 
       it "returns all friends in order of favoritism with activity counts" do
-        introvert.stub(:friends, friends) do
-          introvert.stub(:activities, activities) do
+        stub_friends(friends) do
+          stub_activities(activities) do
             subject.must_equal [
               "Betsy Ross               (2 activities)",
               "George Washington Carver (1)"
@@ -253,8 +269,8 @@ describe Friends::Introvert do
       let(:limit) { 1 }
 
       it "returns the number of favorites requested" do
-        introvert.stub(:friends, friends) do
-          introvert.stub(:activities, activities) do
+        stub_friends(friends) do
+          stub_activities(activities) do
             subject.must_equal ["Betsy Ross (2 activities)"]
           end
         end
@@ -266,8 +282,8 @@ describe Friends::Introvert do
     subject { introvert.suggest }
 
     it "returns distant, moderate, and close friends" do
-      introvert.stub(:friends, friends) do
-        introvert.stub(:activities, activities) do
+      stub_friends(friends) do
+        stub_activities(activities) do
           subject.must_equal(
             distant: ["George Washington Carver"],
             moderate: [],
@@ -293,7 +309,7 @@ describe Friends::Introvert do
       let(:friend_name) { "e" }
 
       it "raises an error" do
-        introvert.stub(:friends, friends) do
+        stub_friends(friends) do
           proc { subject }.must_raise Friends::FriendsError
         end
       end
@@ -325,8 +341,8 @@ describe Friends::Introvert do
       end
 
       it "returns a hash of months and frequencies" do
-        introvert.stub(:friends, friends) do
-          introvert.stub(:activities, activities) do
+        stub_friends(friends) do
+          stub_activities(activities) do
             strftime_format = Friends::Introvert::GRAPH_DATE_FORMAT
 
             first = activities[0]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement