friends 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c928a672142f62f482efa128ae2d09e8bb724fd4
-  data.tar.gz: 72d50a764d49a98b1d0e227817536a87274c9588
+  metadata.gz: 67aca011d40b8ec1f5f92dda50a441dff1363523
+  data.tar.gz: fdd5c7f7459f4bf28773d4e6c1ef3ab4d462f35e
 SHA512:
-  metadata.gz: 1cfd5df61aa2f136dc49117a6e7bab7fd4b7c28b776885d564d59c4ffffe0a5c5a92ca04f7557b2a2a214dc6eaefbffc47e23003fd4d658a3d62eff03047c311
-  data.tar.gz: dc9e3a6aeac267ca1ab720936d170cf921224a637b8a9ae96da2672acc5bfe74873810825d53138d24082303e1c9ec5057aeea1ae4110ad80be72ed4f9079567
+  metadata.gz: 4d05eff21075277e8bc244c69c4bf506c52b74955ef841d65a0fd23cd883d48af4f0d652ccde694ec453e4460355f542251c891f97ad6fe0986f49b08952e273
+  data.tar.gz: 8df26c543ce7c25dc6a1c1474914fd170ca973019b27834df33c5003b1900e07f5112a02c96117dd8b4eb7c17fb1f1c3af9e9c8a5e722ce2ee06b9ca883e2e36

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## [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)
+
+**Implemented enhancements:**
+
+- Add --in flag to `suggest` [\#106](https://github.com/JacobEvelyn/friends/issues/106)
+- Allow locations to be renamed [\#105](https://github.com/JacobEvelyn/friends/issues/105)
+- Add --in location flag to `list activities` [\#100](https://github.com/JacobEvelyn/friends/issues/100)
+- Add --in location flag to `list friends` [\#99](https://github.com/JacobEvelyn/friends/issues/99)
+- Add location matching to activity descriptions [\#97](https://github.com/JacobEvelyn/friends/issues/97)
+- Add `list locations` command [\#96](https://github.com/JacobEvelyn/friends/issues/96)
+- Add `add location` command [\#95](https://github.com/JacobEvelyn/friends/issues/95)
+- Add backwards-compatible \#\#\# Locations: heading to friends.md file. [\#94](https://github.com/JacobEvelyn/friends/issues/94)
+- Update documentation for `graph` and `stats` commands [\#93](https://github.com/JacobEvelyn/friends/issues/93)
+- Add location features [\#107](https://github.com/JacobEvelyn/friends/pull/107) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Fix documentation formatting and typos [\#104](https://github.com/JacobEvelyn/friends/pull/104) ([andypearson](https://github.com/andypearson))
+- Add backwards-compatible `add location` and `list locations` commands [\#101](https://github.com/JacobEvelyn/friends/pull/101) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
+**Merged pull requests:**
+
+- Add location matching/highlighting to activities [\#103](https://github.com/JacobEvelyn/friends/pull/103) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Add documentation for `graph` and `stats` commands [\#102](https://github.com/JacobEvelyn/friends/pull/102) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.16](https://github.com/JacobEvelyn/friends/tree/v0.16) (2016-03-23)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.15...v0.16)
 

data/CONTRIBUTING.md

@@ -17,7 +17,8 @@ that's great as well!
 (`git checkout -b my-new-feature`).
 6. Make your changes. Add or modify tests if necessary!
 (Run tests with `rake test`.) Do your best to conform to
-existing style and commenting patterns.
+existing style and commenting patterns. You can run the local version of the
+`friends` script with `bundle exec bin/friends`.
 7. Update the `README.md` as necessary to include your changes.
 8. Commit your changes
 (`git commit -am "Add some feature"`). You should see

data/README.md

@@ -87,11 +87,21 @@ 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:
 ```
 $ friends suggest
@@ -99,11 +109,26 @@ Distant friend: Marie Curie
 Moderate friend: Grace Hopper
 Close friend: George Washington Carver
 ```
+Or only suggest friends in a specific location:
+```
+$ friends suggest --in Paris
+Distant friend: Marie Curie
+```
+##### Add a location for your friends and activities:
+```
+$ friends add location Atlantis
+Location added: "Atlantis"
+```
+##### And locations will be matched as well:
+```
+$ friends add activity "Went swimming near atlantis with George."
+Activity added: "2016-01-06: Went swimming near Atlantis with George Washington Carver."
+```
 ##### List the activities you've recorded:
 ```
 $ 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.
+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:
@@ -112,6 +137,11 @@ $ 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:
+```
+$ friends list activities --in "New York"
+2014-12-31: Celebrated the new year with Marie Curie in New York City.
 ```
 ##### Find your favorite friends:
 ```
@@ -130,12 +160,27 @@ Your favorite friends:
 ```
 ##### Graph (in color!) your relationship with a friend over time:
 ```
-$ friends graph "George"
+$ 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:
 ```
 $ friends list friends
@@ -143,6 +188,18 @@ George Washington Carver
 Grace Hopper
 Marie Curie
 ```
+Or list only the friends in a specific location:
+```
+$ friends list friends --in Paris
+Marie Curie
+```
+##### List the locations you've added:
+```
+$ friends list locations
+Atlantis
+New York City
+Paris
+```
 ##### Update to the latest version:
 ```
 $ friends update

data/bin/friends

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
 
-# Todo:
-# - Split out serialization into separate repository.
-# - Add auto check for updates.
-# - Allow easy editing of most recent entry.
-
 require "gli"
 require "paint"
 require "readline"
@@ -61,12 +56,16 @@ command :update do |update|
   end
 end
 
-desc "Lists friends or activities"
+desc "Lists friends, activities, and locations"
 command :list do |list|
   list.desc "List all friends"
   list.command :friends do |list_friends|
-    list_friends.action do
-      puts @introvert.list_friends
+    list_friends.flag [:in],
+                      arg_name: "LOCATION",
+                      desc: "List only friends in the given location"
+
+    list_friends.action do |_, options|
+      puts @introvert.list_friends(location_name: options[:in])
     end
   end
 
@@ -105,14 +104,29 @@ command :list do |list|
                          arg_name: "NAME",
                          desc: "List only activities involving the given friend"
 
+    list_activities.flag [:in],
+                         arg_name: "LOCATION",
+                         desc: "List only activities in the given location"
+
     list_activities.action do |_, options|
       limit = options[:limit].to_i
-      puts @introvert.list_activities(limit: limit, with: options[:with])
+      puts @introvert.list_activities(
+        limit: limit,
+        with: options[:with],
+        location_name: options[:in]
+      )
+    end
+  end
+
+  list.desc "List all locations"
+  list.command :locations do |list_locations|
+    list_locations.action do
+      puts @introvert.list_locations
     end
   end
 end
 
-desc "Adds a friend or activity"
+desc "Adds a friend (or nickname), activity, or location"
 command :add do |add|
   add.desc "Adds a friend"
   add.arg_name "NAME"
@@ -133,7 +147,7 @@ command :add do |add|
       # If there's no description, prompt the user for one.
       if activity.description.nil? || activity.description.empty?
         activity.description = Readline.readline(activity.display_text)
-        activity.highlight_friends(introvert: @introvert)
+        activity.highlight_description(introvert: @introvert)
       end
 
       @message = "Activity added: \"#{activity.display_text}\""
@@ -141,6 +155,16 @@ command :add do |add|
     end
   end
 
+  add.desc "Adds a location"
+  add.arg_name "LOCATION"
+  add.command :location do |add_location|
+    add_location.action do |_, _, args|
+      location = @introvert.add_location(name: args.first)
+      @message = "Location added: \"#{location.name}\""
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
+
   add.desc "Adds a nickname to a friend"
   add.arg_name "NAME NICKNAME"
   add.command :nickname do |add_nickname|
@@ -152,6 +176,19 @@ command :add do |add|
   end
 end
 
+desc "Set data about friends"
+command :set do |set|
+  set.desc "Set a friend's location"
+  set.arg_name "NAME LOCATION"
+  set.command :location do |set_location|
+    set_location.action do |_, _, args|
+      friend = @introvert.set_location(name: args.first, location_name: args[1])
+      @message = "#{friend.name}'s location set to: #{friend.location_name}"
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
+end
+
 desc "Remove a nickname"
 command :remove do |remove|
   remove.desc "Removes a nickname from a friend"
@@ -165,8 +202,8 @@ command :remove do |remove|
   end
 end
 
-desc "Graph a friend's relationship over time"
-arg_name "NAME"
+desc "Graph all activities or a friend's relationship over time"
+arg_name "NAME (default: none)"
 command :graph do |graph|
   graph.action do |_, _, args|
     # This math is taken from Minitest's Pride plugin (the PrideLOL class).
@@ -192,8 +229,12 @@ end
 
 desc "Suggest friends to do activities with"
 command :suggest do |suggest|
-  suggest.action do
-    suggestions = @introvert.suggest
+  suggest.flag [:in],
+               arg_name: "LOCATION",
+               desc: "Suggest only friends in the given location"
+
+  suggest.action do |_, options|
+    suggestions = @introvert.suggest(location_name: options[:in])
 
     puts "Distant friend: "\
       "#{Paint[suggestions[:distant].sample || 'None found', :bold, :magenta]}"
@@ -222,18 +263,33 @@ command :stats do |stats|
   end
 end
 
-desc "Renames a friend"
+desc "Renames a friend or location"
 command :rename do |rename|
   rename.desc "Renames a friend"
   rename.arg_name "NAME NEW_NAME"
   rename.command :friend do |rename_friend|
     rename_friend.action do |_, _, args|
-      friend = @introvert.rename_friend(old_name: args.first,
-                                        new_name: args[1])
+      friend = @introvert.rename_friend(
+        old_name: args.first,
+        new_name: args[1]
+      )
       @message = "Name changed: \"#{friend}\""
       @dirty = true # Mark the file for cleaning.
     end
   end
+
+  rename.desc "Renames a location"
+  rename.arg_name "NAME NEW_NAME"
+  rename.command :location do |rename_location|
+    rename_location.action do |_, _, args|
+      location = @introvert.rename_location(
+        old_name: args.first,
+        new_name: args[1]
+      )
+      @message = "Location renamed: \"#{location.name}\""
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
 end
 
 # Before each command, clean up all arguments and create the global Introvert.

data/friends.md

@@ -1,10 +1,15 @@
 ### Activities:
-- 2015-11-01: **Grace Hopper** and I went to Marie's Diner. George had to cancel at the last minute.
+- 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 with **Marie Curie**.
+- 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.
 
 ### Friends:
 - George Washington Carver
-- Grace Hopper (a.k.a. The Admiral)
-- Marie Curie
+- Grace Hopper (a.k.a. The Admiral) [Paris]
+- Marie Curie [Atlantis]
+
+### Locations:
+- Atlantis
+- Marie's Diner
+- Paris

data/lib/friends/activity.rb

@@ -34,7 +34,9 @@ module Friends
       # Partition lets us parse "Today" and "Today: I awoke." identically.
       date_s, _, description = str.partition(DATE_PARTITION)
 
+      # rubocop:disable Lint/AssignmentInCondition
       if time = Chronic.parse(date_s)
+        # rubocop:enable Lint/AssignmentInCondition
         @date = time.to_date
         @description = description
       else
@@ -52,10 +54,18 @@ module Friends
       date_s = Paint[date, :bold]
       description_s = description.to_s
       # rubocop:disable Lint/AssignmentInCondition
-      while match = description_s.match(/(\*\*)([^\*]+)(\*\*)/)
+      while match = description_s.match(/\*\*([^\*]+)\*\*/)
         # rubocop:enable Lint/AssignmentInCondition
         description_s = "#{match.pre_match}"\
-                        "#{Paint[match[2], :bold, :magenta]}"\
+                        "#{Paint[match[1], :bold, :magenta]}"\
+                        "#{match.post_match}"
+      end
+
+      # rubocop:disable Lint/AssignmentInCondition
+      while match = description_s.match(/_([^_]+)_/)
+        # rubocop:enable Lint/AssignmentInCondition
+        description_s = "#{match.pre_match}"\
+                        "#{Paint[match[1], :bold, :yellow]}"\
                         "#{match.post_match}"
       end
       "#{date_s}: #{description_s}"
@@ -66,11 +76,78 @@ module Friends
       "#{SERIALIZATION_PREFIX}#{date}: #{description}"
     end
 
+    # Modify the description to turn inputted friend names
+    # (e.g. "Jacob" or "Jacob Evelyn") into full asterisk'd names
+    # (e.g. "**Jacob Evelyn**") and inputted location names (e.g. "Atlantis")
+    # into full underscore'd names (e.g. "_Atlantis_").
+    # @param introvert [Introvert] used to access internal data structures to
+    #   perform object matching
+    def highlight_description(introvert:)
+      highlight_locations(introvert: introvert)
+      highlight_friends(introvert: introvert)
+    end
+
+    # Updates a friend's old_name to their new_name
+    # @param [String] old_name
+    # @param [String] new_name
+    # @return [String] if name found in description
+    # @return [nil] if no change was made
+    def update_friend_name(old_name:, new_name:)
+      @description.gsub!(
+        Regexp.new("(?<=\\*\\*)#{old_name}(?=\\*\\*)"),
+        new_name
+      )
+    end
+
+    # Updates a location's old_name to their new_name
+    # @param [String] old_name
+    # @param [String] new_name
+    # @return [String] if name found in description
+    # @return [nil] if no change was made
+    def update_location_name(old_name:, new_name:)
+      @description.gsub!(Regexp.new("(?<=_)#{old_name}(?=_)"), new_name)
+    end
+
+    # @param location [Location] the location to test
+    # @return [Boolean] true iff this activity includes the given location
+    def includes_location?(location:)
+      @description.scan(/(?<=_)[^_]+(?=_)/).include? location.name
+    end
+
+    # @param friend [Friend] the friend to test
+    # @return [Boolean] true iff this activity includes the given friend
+    def includes_friend?(friend:)
+      friend_names.include? friend.name
+    end
+
+    # Find the names of all friends in this description.
+    # @return [Array] list of all friend names in the description
+    def friend_names
+      @description.scan(/(?<=\*\*)\w[^\*]*(?=\*\*)/).uniq
+    end
+    memoize :friend_names
+
+    private
+
+    # Modify the description to turn inputted location names (e.g. "Atlantis")
+    # into full underscore'd names (e.g. "_Atlantis_").
+    # @param introvert [Introvert] used to access internal data structures to
+    #   perform location matching
+    def highlight_locations(introvert:)
+      introvert.regex_location_map.each do |regex, location|
+        # If we find a match, replace all instances of the matching text with
+        # the location's name. We use single-underscores to indicate locations.
+        description_matches(regex: regex, replace: true, indicator: "_") do
+          location.name
+        end
+      end
+    end
+
     # 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] used to access the list of friends and the
-    #  connections between the
+    # @param introvert [Introvert] used to access internal data structures to
+    #   perform friend matching
     # 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
@@ -89,7 +166,7 @@ module Friends
       definite_map.each do |regex, friend_list|
         # If we find a match, add the friend to the matched list and replace all
         # instances of the matching text with the friend's name.
-        description_matches(regex: regex, replace: true) do
+        description_matches(regex: regex, replace: true, indicator: "**") do
           friend = friend_list.first # There's only one friend in the list.
           matched_friends << friend
           friend.name
@@ -101,7 +178,7 @@ module Friends
       # Now, we look at regex matches that are ambiguous.
       ambiguous_map.each do |regex, friend_list|
         # If we find a match, add the friend to the possible-match list.
-        description_matches(regex: regex, replace: false) do
+        description_matches(regex: regex, replace: false, indicator: "**") do
           possible_matched_friends << friend_list
         end
       end
@@ -117,7 +194,7 @@ module Friends
       ambiguous_map.each do |regex, friend_list|
         # If we find a match, take the most likely and replace all instances of
         # the matching text with that friend's name.
-        description_matches(regex: regex, replace: true) do
+        description_matches(regex: regex, replace: true, indicator: "**") do
           friend_list.sort_by do |friend|
             [-friend.likelihood_score, -friend.n_activities]
           end.first.name
@@ -129,45 +206,19 @@ module Friends
       @description = @description.delete("\\")
     end
 
-    # Updates a friend's old_name to their new_name
-    # @param [String] old_name
-    # @param [String] new_name
-    # @return [String] if name found in description
-    # @return [nil] if no change was made
-    def update_name(old_name:, new_name:)
-      description.gsub!(
-        Regexp.new("(?<=\\*\\*)#{old_name}(?=\\*\\*)"),
-        new_name)
-    end
-
-    # @param friend [Friend] the friend to test
-    # @return [Boolean] true iff this activity includes the given friend
-    def includes_friend?(friend:)
-      friend_names.include? friend.name
-    end
-
-    # Find the names of all friends in this description.
-    # @return [Array] list of all friend names in the description
-    def friend_names
-      description.scan(/(?<=\*\*)\w[^\*]*(?=\*\*)/).uniq
-    end
-    memoize :friend_names
-
-    private
-
     # This method accepts a block, and tests a regex on the @description
     # instance variable.
     # - If the regex does not match, the block is not executed.
     # - If the regex matches, the block is executed exactly once, and:
     #   - If `replace` is true, all of the regex's matches are replaced by the
     #     return value of the block, EXCEPT when the matched text is between a
-    #     set of double-asterisks ("**") indicating it is already part of
-    #     another friend's matched name.
+    #     set of double-asterisks ("**") or single-underscores ("_") indicating
+    #     it is already part of another location or friend's matched name.
     #   - If `replace` is not true, we do not modify @description.
     # @param regex [Regexp] the regex to test against @description
     # @param replace [Boolean] true iff we should replace regex matches with the
     #   yielded block's result in @description
-    def description_matches(regex:, replace:)
+    def description_matches(regex:, replace:, indicator:)
       # rubocop:disable Lint/AssignmentInCondition
       return unless match = @description.match(regex) # Abort if no match.
       # rubocop:enable Lint/AssignmentInCondition
@@ -176,14 +227,22 @@ module Friends
 
       position = 0 # Prevent infinite looping by tracking last match position.
       loop do
-        # Only make a replacement if we're not between a set of "**"s.
+        # Only make a replacement if we're not between a set of "**"s or "_"s.
         if match.pre_match.scan("**").size % 2 == 0 &&
-           match.post_match.scan("**").size % 2 == 0
-          @description = "#{match.pre_match}**#{str}**#{match.post_match}"
+           match.post_match.scan("**").size % 2 == 0 &&
+           match.pre_match.scan("_").size % 2 == 0 &&
+           match.post_match.scan("_").size % 2 == 0
+          @description = [
+            match.pre_match,
+            indicator,
+            str,
+            indicator,
+            match.post_match
+          ].join
         else
-          # If we're between double-asterisks we're already part of a name, so
-          # we don't make a substitution. We update `position` to avoid infinite
-          # looping.
+          # If we're between double-asterisks or single-underscores we're
+          # already part of a name, so we don't make a substitution. We update
+          # `position` to avoid infinite looping.
           position = match.end(0)
         end