friends 0.19 → 0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ba2ca1e570ce12bae59bd92e45eed450b15859d
-  data.tar.gz: f29a32cae219ae83c7cbc925d1493894d76409cb
+  metadata.gz: 1429eb3d555f53ebb68816b253350252370d37bc
+  data.tar.gz: 42095e0608c73c17fd75f8f4bedab8313e19a4b1
 SHA512:
-  metadata.gz: 264af4e8b7d6956401c9a7e6babecb6a8e8b6dc154de383394aef7890c2262685ea90c24c1d525d03802ecb1a028ffbc445cd4306fa91c5badbf044389667d1e
-  data.tar.gz: 674aa75753fc7aedc6f50bbb54956ecd91f6df2d8930d886f5f018e08d9c89b0db2e4f5aa74c014b45b35c6d429809d6fbdb7982598b52b66b0636f377136d3a
+  metadata.gz: ab66c9042a1c23ec4e5c2a1685d03b91d5b66c1382ca3ed64b1822277bf08ed1bbe321a9144f59256d6c369b93f9b954d8d6307a9a50b6c9f6fc4374c9e7df6f
+  data.tar.gz: 87719311645cdff9c7af1a862c9533e8671c1e000c7221f7833226bfcad3f86935de92440acbad5a65aa87bf005485c2b31589cdb3d9ea094973093d13896add

data/.gitignore

@@ -16,3 +16,4 @@ mkmf.log
 ideas.txt
 TODO.txt
 .DS_Store
+.byebug_history

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [v0.20](https://github.com/JacobEvelyn/friends/tree/v0.20) (2016-05-08)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.19...v0.20)
+
+**Implemented enhancements:**
+
+- Add --tagged option to `list friends` [\#119](https://github.com/JacobEvelyn/friends/issues/119)
+- Add --verbose option to `list friends` [\#117](https://github.com/JacobEvelyn/friends/issues/117)
+- Add `list hashtags` command [\#116](https://github.com/JacobEvelyn/friends/issues/116)
+- Add hashtag capabilities to friends [\#90](https://github.com/JacobEvelyn/friends/issues/90)
+- Add hashtag capabilities to activities [\#89](https://github.com/JacobEvelyn/friends/issues/89)
+- Add location data to friends [\#66](https://github.com/JacobEvelyn/friends/issues/66)
+
+**Merged pull requests:**
+
+- Implement hashtags [\#118](https://github.com/JacobEvelyn/friends/pull/118) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.19](https://github.com/JacobEvelyn/friends/tree/v0.19) (2016-05-02)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.18...v0.19)
 

data/README.md

@@ -17,6 +17,7 @@ Extrovert-approved.
     - `add`
       - [`add activity`](#add-activity)
       - [`add friend`](#add-friend)
+      - [`add hashtag`](#add-hashtag)
       - [`add location`](#add-location)
       - [`add nickname`](#add-nickname)
     - [`clean`](#clean)
@@ -28,8 +29,11 @@ Extrovert-approved.
         - [`list favorite friends`](#list-favorite-friends)
         - [`list favorite locations`](#list-favorite-locations)
       - [`list friends`](#list-friends)
+      - [`list hashtags`](#list-hashtags)
       - [`list locations`](#list-locations)
-    - [`remove nickname`](#remove-nickname)
+    - `remove`
+      - [`remove hashtag`](#remove-hashtag)
+      - [`remove nickname`](#remove-nickname)
     - `rename`
       - [`rename friend`](#rename-friend)
       - [`rename location`](#rename-location)
@@ -83,10 +87,14 @@ Easy, huh?
 `friends` is structured around several different types of things:
 
 - **Activities**: The things you do. Each activity has a date associated with
-  it.
+  it. Activities may optionally contain any number of *friends*, *locations*,
+  and *hashtags*.
 - **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.
+  optionally, one or several nicknames. (Examples: `John`, `Grace Hopper`)
+- **Locations**: The places in which *activities* happen. (Examples: `Paris`,
+  `Marie's Diner`)
+- **Hashtags**: A way to categorize your *activities* with tags of your
+  choosing. (Examples: `#exercise`, `#concert`)
 
 The `friends.md` Markdown file that stores all of your data contains:
 
@@ -212,6 +220,14 @@ $ friends add activity "Went swimming near atlantis with George."
 Activity added: "2016-01-06: Went swimming near Atlantis with George Washington Carver."
 ```
 
+Hashtags will be colored if they're provided (though this README can't display
+color so you'll just have to have faith here):
+
+```bash
+$ friends add activity "The office softball team wins a game! #work #exercise"
+Activity added: "2016-05-05: The office softball team wins a game! #work #exercise"
+```
+
 You can of course specify a date for the activity:
 
 ```bash
@@ -247,6 +263,13 @@ $ friends add friend "Grace Hopper"
 Friend added: "Grace Hopper"
 ```
 
+#### `add hashtag`
+
+```bash
+$ friends add hashtag "Grace Hopper" science
+Hashtag added to friend: "Grace Hopper #science
+```
+
 #### `add location`
 
 ```
@@ -350,8 +373,8 @@ 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.
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver. #food
+2014-12-31: Celebrated the new year with Marie Curie in New York City. #partying
 2014-11-15: Talked to George Washington Carver on the phone for an hour.
 ```
 
@@ -359,15 +382,15 @@ 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.
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver. #food
+2014-12-31: Celebrated the new year with Marie Curie in New York City. #partying
 ```
 
 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.
+$ friends list activities --with George
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver. #food
 2014-11-15: Talked to George Washington Carver on the phone for an hour.
 ```
 
@@ -375,7 +398,21 @@ 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.
+2014-12-31: Celebrated the new year with Marie Curie in New York City. #partying
+```
+
+Or by hashtag:
+
+```bash
+$ friends list activities --tagged food
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver. #food
+```
+
+And you can mix and match these options to your heart's content:
+
+```bash
+$ friends list activities --tagged food --with Grace
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver. #food
 ```
 
 #### `list favorite friends`
@@ -422,7 +459,7 @@ Your favorite locations:
 
 #### `list friends`
 
-Lists all of your friends:
+Lists all of your friends in alphabetical order:
 
 ```bash
 $ friends list friends
@@ -431,6 +468,15 @@ Grace Hopper
 Marie Curie
 ```
 
+You can also include friend nicknames, locations, and hashtags:
+
+```bash
+$ friends list friends --verbose
+George Washington Carver
+Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] #navy #science
+Marie Curie [Atlantis] #science
+```
+
 You can filter your friends by location:
 
 ```bash
@@ -438,9 +484,46 @@ $ friends list friends --in Paris
 Marie Curie
 ```
 
+And you can also filter your friends by hashtag:
+
+```bash
+$ friends list friends --tagged science
+Grace Hopper
+Marie Curie
+```
+
+#### `list hashtags`
+
+Lists all hashtags you've used, in alphabetical order:
+
+```bash
+$ friends list hashtags
+#dancing
+#food
+#school
+#swanky
+```
+
+You can limit this to only hashtags from activities:
+
+```bash
+$ friends list hashtags --from activities
+#dancing
+#food
+#swanky
+```
+
+Or only hashtags from friends:
+
+```bash
+$ friends list hashtags --from friends
+#school
+#swanky
+```
+
 #### `list locations`
 
-Lists all of the locations you've added:
+Lists all of the locations you've added, in alphabetical order::
 
 ```
 $ friends list locations
@@ -449,6 +532,15 @@ New York City
 Paris
 ```
 
+#### `remove hashtag`
+
+Removes a specific hashtag from a friend:
+
+```bash
+$ friends remove hashtag "Grace Hopper" fun
+Hashtag removed from friend: "Grace Hopper (a.k.a. Amazing Grace) #OtherHashtag"
+```
+
 #### `remove nickname`
 
 Removes a specific nickname from a friend:

data/bin/friends

@@ -18,6 +18,28 @@ version Friends::VERSION
 subcommand_option_handling :normal
 arguments :strict
 
+class Hashtag
+  # @param str [String] of the form "hashtag" or "#hashtag"
+  # @return [String] the string, with whitespace stripped and a hashtag
+  #   prepended if there isn't one already
+  # NOTE: This logic could be only in the accept block if GLI allowed type
+  # conversions for arguments.
+  # See: https://github.com/davetron5000/gli/issues/241
+  def self.convert_to_hashtag(str)
+    str = str.strip
+    str.size > 0 && str[0] == "#" ? str : "##{str}"
+  end
+end
+
+accept(Hashtag) do |value|
+  Hashtag.convert_to_hashtag(value)
+end
+
+class Stripped ; end
+accept(Stripped) do |value|
+  value.strip
+end
+
 switch [:quiet],
        negatable: false,
        desc: "Quiet output messages"
@@ -72,10 +94,75 @@ command :list do |list|
   list.command :friends do |list_friends|
     list_friends.flag [:in],
                       arg_name: "LOCATION",
-                      desc: "List only friends in the given location"
+                      desc: "List only friends in the given location",
+                      type: Stripped
+
+    list_friends.flag [:tagged],
+                      arg_name: "HASHTAG",
+                      desc: "List only friends with the given hashtag",
+                      type: Hashtag
+
+    list_friends.switch [:verbose],
+                        negatable: false,
+                        desc: "Output friend nicknames, locations, and hashtags"
 
     list_friends.action do |_, options|
-      puts @introvert.list_friends(location_name: options[:in])
+      puts @introvert.list_friends(
+        location_name: options[:in],
+        tagged: options[:tagged],
+        verbose: options[:verbose]
+      )
+    end
+  end
+
+  list.desc "Lists all activities"
+  list.command :activities do |list_activities|
+    list_activities.flag [:limit],
+                         arg_name: "NUMBER",
+                         desc: "The number of activities to return",
+                         default_value: 10,
+                         type: Integer
+
+    list_activities.flag [:with],
+                         arg_name: "NAME",
+                         desc: "List only activities with the given friend",
+                         type: Stripped
+
+    list_activities.flag [:in],
+                         arg_name: "LOCATION",
+                         desc: "List only activities in the given location",
+                         type: Stripped
+
+    list_activities.flag [:tagged],
+                         arg_name: "HASHTAG",
+                         desc: "List only activities with the given hashtag",
+                         type: Hashtag
+
+    list_activities.action do |_, options|
+      puts @introvert.list_activities(
+        limit: options[:limit],
+        with: options[:with],
+        location_name: options[:in],
+        tagged: options[:tagged]
+      )
+    end
+  end
+
+  list.desc "List all locations"
+  list.command :locations do |list_locations|
+    list_locations.action do
+      puts @introvert.list_locations
+    end
+  end
+
+  list.desc "List all hashtags used"
+  list.command :hashtags do |list_hashtags|
+    list_hashtags.flag [:from],
+                       arg_name: '"activities" or "friends" (default: both)',
+                       desc: "List only hashtags from activities or friends "\
+                             "instead of both"
+    list_hashtags.action do |_, options|
+      puts @introvert.list_hashtags(from: options[:from])
     end
   end
 
@@ -85,12 +172,12 @@ command :list do |list|
     list_favorite.command :friends do |list_favorite_friends|
       list_favorite_friends.flag [:limit],
                                  arg_name: "NUMBER",
+                                 desc: "The number of friends to return",
                                  default_value: 10,
-                                 desc: "The number of friends to return"
+                                 type: Integer
 
       list_favorite_friends.action do |_, options|
-        limit = options[:limit].to_i
-        favorites = @introvert.list_favorite_friends(limit: limit)
+        favorites = @introvert.list_favorite_friends(limit: options[:limit])
 
         if limit == 1
           puts "Your best friend is #{favorites.first}"
@@ -109,12 +196,12 @@ command :list do |list|
     list_favorite.command :locations do |list_favorite_locations|
       list_favorite_locations.flag [:limit],
                                    arg_name: "NUMBER",
+                                   desc: "The number of locations to return",
                                    default_value: 10,
-                                   desc: "The number of locations to return"
+                                   type: Integer
 
       list_favorite_locations.action do |_, options|
-        limit = options[:limit].to_i
-        favorites = @introvert.list_favorite_locations(limit: limit)
+        favorites = @introvert.list_favorite_locations(limit: options[:limit])
 
         if limit == 1
           puts "Your favorite location is #{favorites.first}"
@@ -129,38 +216,6 @@ command :list do |list|
       end
     end
   end
-
-  list.desc "Lists all activities"
-  list.command :activities do |list_activities|
-    list_activities.flag [:limit],
-                         arg_name: "NUMBER",
-                         default_value: 10,
-                         desc: "The number of activities to return"
-
-    list_activities.flag [:with],
-                         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],
-        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 nickname), activity, or location"
@@ -183,11 +238,11 @@ 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.description = Readline.readline(activity.to_s)
         activity.highlight_description(introvert: @introvert)
       end
 
-      @message = "Activity added: \"#{activity.display_text}\""
+      @message = "Activity added: \"#{activity}\""
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -211,6 +266,19 @@ command :add do |add|
       @dirty = true # Mark the file for cleaning.
     end
   end
+
+  add.desc "Adds a hashtag to a friend"
+  add.arg_name "NAME HASHTAG"
+  add.command :hashtag do |add_hashtag|
+    add_hashtag.action do |_, _, args|
+      friend = @introvert.add_hashtag(
+        name: args.first,
+        hashtag: Hashtag.convert_to_hashtag(args[1])
+      )
+      @message = "Hashtag added to friend: \"#{friend}\""
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
 end
 
 desc "Set data about friends"
@@ -237,6 +305,19 @@ command :remove do |remove|
       @dirty = true # Mark the file for cleaning.
     end
   end
+
+  remove.desc "Removes a hashtag to a friend"
+  remove.arg_name "NAME HASHTAG"
+  remove.command :hashtag do |remove_hashtag|
+    remove_hashtag.action do |_, _, args|
+      friend = @introvert.remove_hashtag(
+        name: args.first,
+        hashtag: Hashtag.convert_to_hashtag(args[1])
+      )
+      @message = "Hashtag removed from friend: \"#{friend}\""
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
 end
 
 desc "Graph all activities or a friend's relationship over time"
@@ -268,7 +349,8 @@ desc "Suggest friends to do activities with"
 command :suggest do |suggest|
   suggest.flag [:in],
                arg_name: "LOCATION",
-               desc: "Suggest only friends in the given location"
+               desc: "Suggest only friends in the given location",
+               type: Stripped
 
   suggest.action do |_, options|
     suggestions = @introvert.suggest(location_name: options[:in])

data/friends.md

@@ -1,13 +1,13 @@
 ### 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**.
+- 2015-11-01: **Grace Hopper** and I went to _Marie's Diner_. George had to cancel at the last minute. #food
+- 2015-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**. #food
+- 2014-12-31: Celebrated the new year in _Paris_ with **Marie Curie**. #partying
 - 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 a.k.a. Amazing Grace) [Paris]
-- Marie Curie [Atlantis]
+- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] #navy #science
+- Marie Curie [Atlantis] #science
 
 ### Locations:
 - Atlantis

data/lib/friends.rb

@@ -2,4 +2,5 @@ require "friends/introvert"
 require "friends/version"
 
 module Friends
+  HASHTAG_REGEX = /#\p{Alnum}+/
 end

data/lib/friends/activity.rb

@@ -50,7 +50,7 @@ module Friends
     attr_accessor :description
 
     # @return [String] the command-line display text for the activity
-    def display_text
+    def to_s
       date_s = Paint[date, :bold]
       description_s = description.to_s
       # rubocop:disable Lint/AssignmentInCondition
@@ -68,6 +68,10 @@ module Friends
                         "#{Paint[match[1], :bold, :yellow]}"\
                         "#{match.post_match}"
       end
+
+      description_s = description_s.
+                      gsub(HASHTAG_REGEX, Paint['\0', :bold, :cyan])
+
       "#{date_s}: #{description_s}"
     end
 
@@ -120,6 +124,17 @@ module Friends
       friend_names.include? friend.name
     end
 
+    # @param hashtag [String] the hashtag to test, of the form "#hashtag"
+    # @return [Boolean] true iff this activity includes the given hashtag
+    def includes_hashtag?(hashtag:)
+      hashtags.include? hashtag
+    end
+
+    # @return [Set] all hashtags in this activity (including the "#")
+    def hashtags
+      Set.new(@description.scan(HASHTAG_REGEX))
+    end
+
     # Find the names of all friends in this description.
     # @return [Array] list of all friend names in the description
     def friend_names

data/lib/friends/friend.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 # Friend represents a friend. You know, a real-life friend!
 
+require "friends"
 require "friends/regex_builder"
 require "friends/serializable"
 
@@ -15,7 +16,7 @@ module Friends
     def self.deserialization_regex
       # Note: this regex must be on one line because whitespace is important
       # rubocop:disable Metrics/LineLength
-      /(#{SERIALIZATION_PREFIX})?(?<name>[^\(\[]+)(\((?<nickname_str>#{NICKNAME_PREFIX}.+)\))?\s?(\[(?<location_name>[^\]]+)\])?/
+      /(#{SERIALIZATION_PREFIX})?(?<name>[^\(\[#]*[^\(\[#\s])(\s+\(#{NICKNAME_PREFIX}(?<nickname_str>.+)\))?(\s+\[(?<location_name>[^\]]+)\])?(\s+(?<hashtags_str>(#{HASHTAG_REGEX}\s*)+))?/
       # rubocop:enable Metrics/LineLength
     end
 
@@ -25,16 +26,23 @@ module Friends
     end
 
     # @param name [String] the name of the friend
-    def initialize(name:, nickname_str: nil, location_name: nil)
-      @name = name.strip
+    def initialize(
+      name:,
+      nickname_str: nil,
+      location_name: nil,
+      hashtags_str: nil
+    )
+      @name = name
       @nicknames = nickname_str &&
-                   nickname_str.split(NICKNAME_PREFIX)[1..-1].map(&:strip) ||
+                   nickname_str.split(" #{NICKNAME_PREFIX}") ||
                    []
       @location_name = location_name
+      @hashtags = hashtags_str && hashtags_str.split(/\s+/) || []
     end
 
     attr_accessor :name
     attr_accessor :location_name
+    attr_reader :hashtags
 
     # @return [String] the file serialization text for the friend
     def serialize
@@ -52,10 +60,28 @@ module Friends
 
       location_str = " [#{@location_name}]" unless @location_name.nil?
 
-      "#{@name}#{nickname_str}#{location_str}"
+      hashtag_str = " #{@hashtags.join(' ')}" unless @hashtags.empty?
+
+      "#{@name}#{nickname_str}#{location_str}#{hashtag_str}"
+    end
+
+    # Adds a hashtag, ignoring duplicates.
+    # @param hashtag [String] the hashtag to add
+    def add_hashtag(hashtag)
+      @hashtags << hashtag
+      @hashtags.uniq!
+    end
+
+    # @param hashtag [String] the hashtag to remove
+    def remove_hashtag(hashtag)
+      unless @hashtags.include? hashtag
+        raise FriendsError, "Hashtag \"#{hashtag}\" not found for \"#{name}\""
+      end
+
+      @hashtags.delete(hashtag)
     end
 
-    # Adds a nickname, avoiding duplicates and stripping surrounding whitespace.
+    # Adds a nickname, ignoring duplicates.
     # @param nickname [String] the nickname to add
     def add_nickname(nickname)
       @nicknames << nickname
@@ -63,7 +89,7 @@ module Friends
     end
 
     # @param nickname [String] the nickname to remove
-    # @return [Boolean] true if the nickname was present, false otherwise
+    # @raise [FriendsError] if the friend does not have the given nickname
     def remove_nickname(nickname)
       unless @nicknames.include? nickname
         raise FriendsError, "Nickname \"#{nickname}\" not found for \"#{name}\""

data/lib/friends/introvert.rb

@@ -116,9 +116,6 @@ module Friends
     # @raise [FriendsError] if 0 or 2+ friends match the given name
     # @return [Friend] the existing friend
     def rename_friend(old_name:, new_name:)
-      old_name.strip!
-      new_name.strip!
-
       friend = friend_with_name_in(old_name)
       @activities.each do |activity|
         activity.update_friend_name(old_name: friend.name, new_name: new_name)
@@ -133,9 +130,6 @@ module Friends
     # @raise [FriendsError] if 0 or 2+ friends match the given name
     # @return [Location] the existing location
     def rename_location(old_name:, new_name:)
-      old_name.strip!
-      new_name.strip!
-
       loc = location_with_name_in(old_name)
 
       # Update locations in activities.
@@ -159,27 +153,54 @@ module Friends
     # @return [Friend] the existing friend
     def add_nickname(name:, nickname:)
       friend = friend_with_name_in(name)
-      friend.add_nickname(nickname.strip)
+      friend.add_nickname(nickname)
+      friend
+    end
+
+    # Add a hashtag to an existing friend.
+    # @param name [String] the name of the friend
+    # @param hashtag [String] the hashtag to add to the friend
+    # @raise [FriendsError] if 0 or 2+ friends match the given name
+    # @return [Friend] the existing friend
+    def add_hashtag(name:, hashtag:)
+      friend = friend_with_name_in(name)
+      friend.add_hashtag(hashtag)
+      friend
+    end
+
+    # Remove a hashtag from an existing friend.
+    # @param name [String] the name of the friend
+    # @param hashtag [String] the hashtag to remove from the friend
+    # @raise [FriendsError] if 0 or 2+ friends match the given name
+    # @raise [FriendsError] if the friend does not have the given nickname
+    # @return [Friend] the existing friend
+    def remove_hashtag(name:, hashtag:)
+      friend = friend_with_name_in(name)
+      friend.remove_hashtag(hashtag)
       friend
     end
 
-    # Remove a nickname from an existing friend and write out the new friends
-    #   file.
+    # Remove a nickname from an existing friend.
     # @param name [String] the name of the friend
     # @param nickname [String] the nickname to remove from the friend
     # @raise [FriendsError] if 0 or 2+ friends match the given name
+    # @raise [FriendsError] if the friend does not have the given nickname
     # @return [Friend] the existing friend
     def remove_nickname(name:, nickname:)
       friend = friend_with_name_in(name)
-      friend.remove_nickname(nickname.strip)
+      friend.remove_nickname(nickname)
       friend
     end
 
     # List all friend names in the friends file.
     # @param location_name [String] the name of a location to filter by, or nil
     #   for unfiltered
+    # @param tagged [String] the name of a hashtag to filter by, or nil for
+    #   unfiltered
+    # @param verbose [Boolean] true iff we should output friend names with
+    #   nicknames, locations, and hashtags; false for names only
     # @return [Array] a list of all friend names
-    def list_friends(location_name:)
+    def list_friends(location_name:, tagged:, verbose:)
       fs = @friends
 
       # Filter by location if a name is passed.
@@ -188,7 +209,10 @@ module Friends
         fs = fs.select { |friend| friend.location_name == location.name }
       end
 
-      fs.map(&:name)
+      # Filter by hashtag if one is passed.
+      fs = fs.select { |friend| friend.hashtags.include? tagged } if tagged
+
+      verbose ? fs.map(&:to_s) : fs.map(&:name)
     end
 
     # List your favorite friends.
@@ -214,9 +238,11 @@ module Friends
     #   unfiltered
     # @param location_name [String] the name of a location to filter by, or nil
     #   for unfiltered
+    # @param tagged [String] the name of a hashtag to filter by, or nil for
+    #   unfiltered
     # @return [Array] a list of all activity text values
     # @raise [FriendsError] if 0 or 2+ friends match the given `with` text
-    def list_activities(limit:, with:, location_name:)
+    def list_activities(limit:, with:, location_name:, tagged:)
       acts = @activities
 
       # Filter by friend name if argument is passed.
@@ -231,10 +257,15 @@ module Friends
         acts = acts.select { |act| act.includes_location?(location: location) }
       end
 
+      # Filter by tag if argument is passed.
+      unless tagged.nil?
+        acts = acts.select { |act| act.includes_hashtag?(hashtag: tagged) }
+      end
+
       # If we need to, trim the list.
       acts = acts.take(limit) unless limit.nil?
 
-      acts.map(&:display_text)
+      acts.map(&:to_s)
     end
 
     # List all location names in the friends file.
@@ -243,6 +274,28 @@ module Friends
       @locations.map(&:name)
     end
 
+    # @param from [String] one of: ["activities", "friends", nil]
+    #   If not nil, limits the hashtags returned to only those from either
+    #   activities or friends.
+    # @return [Array] a sorted list of all hashtags in activity descriptions
+    def list_hashtags(from:)
+      output = Set.new
+
+      unless from == "friends" # If from is "activities" or nil.
+        @activities.each_with_object(output) do |activity, set|
+          set.merge(activity.hashtags)
+        end
+      end
+
+      unless from == "activities" # If from is "friends" or nil.
+        @friends.each_with_object(output) do |friend, set|
+          set.merge(friend.hashtags)
+        end
+      end
+
+      output.sort_by(&:downcase)
+    end
+
     # Find data points for graphing activities over time.
     # Optionally filter by a friend to see a given relationship over time.
     #

data/lib/friends/version.rb

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

data/test/activity_spec.rb

@@ -95,8 +95,8 @@ describe Friends::Activity do
     it { subject.description.must_equal description }
   end
 
-  describe "#display_text" do
-    subject { activity.display_text }
+  describe "#to_s" do
+    subject { activity.to_s }
 
     it do
       subject.
@@ -456,6 +456,40 @@ describe Friends::Activity do
     end
   end
 
+  describe "#hashtags" do
+    subject { activity.hashtags }
+
+    describe "when the activity has no hashtags" do
+      let(:activity) { Friends::Activity.new(str: "Enormous ball pit!") }
+      it { subject.must_be :empty? }
+    end
+
+    describe "when the activity has hashtags" do
+      let(:activity) { Friends::Activity.new(str: "Party! #fun #crazy #fun") }
+      it { subject.must_equal Set.new(["#fun", "#crazy"]) }
+    end
+  end
+
+  describe "#includes_hashtag?" do
+    subject { activity.includes_hashtag?(hashtag: hashtag) }
+    let(:activity) { Friends::Activity.new(str: "Enormous ball pit! #fun") }
+
+    describe "when the given hashtag is not in the activity" do
+      let(:hashtag) { "#garbage" }
+      it { subject.must_equal false }
+    end
+
+    describe "when the given word is in the activity but not as a hashtag" do
+      let(:hashtag) { "#ball" }
+      it { subject.must_equal false }
+    end
+
+    describe "when the given hashtag is in the activity" do
+      let(:hashtag) { "#fun" }
+      it { subject.must_equal true }
+    end
+  end
+
   describe "#friend_names" do
     subject { activity.friend_names }
 

data/test/friend_spec.rb

@@ -62,7 +62,7 @@ describe Friends::Friend do
 
     describe "when the nickname is present" do
       let(:friend) do
-        Friends::Friend.new(name: friend_name, nickname_str: "a.k.a. Jake")
+        Friends::Friend.new(name: friend_name, nickname_str: "Jake")
       end
 
       it "removes the nickname" do
@@ -79,6 +79,45 @@ describe Friends::Friend do
     end
   end
 
+  describe "#add_hashtag" do
+    subject { friend.add_hashtag("#college") }
+
+    it "adds the nickname" do
+      subject
+      friend.hashtags.must_include("#college")
+    end
+
+    it "does not keep duplicates" do
+      # Add the same nickname twice. Do not use `subject` because it's memoized.
+      friend.add_hashtag("#college")
+      friend.add_hashtag("#college")
+
+      friend.hashtags.must_equal ["#college"]
+    end
+  end
+
+  describe "#remove_hashtag" do
+    subject { friend.remove_hashtag("#school") }
+
+    describe "when the hashtag is present" do
+      let(:friend) do
+        Friends::Friend.new(name: friend_name, hashtags_str: "#school #work")
+      end
+
+      it "removes the nickname" do
+        friend.instance_variable_get(:@hashtags).must_equal ["#school", "#work"]
+        subject
+        friend.instance_variable_get(:@hashtags).must_equal ["#work"]
+      end
+    end
+
+    describe "when the nickname is not present" do
+      it "raises an error if the nickname is not found" do
+        proc { subject }.must_raise Friends::FriendsError
+      end
+    end
+  end
+
   describe "#n_activities" do
     subject { friend.n_activities }
 

data/test/introvert_spec.rb

@@ -34,7 +34,11 @@ describe Friends::Introvert do
   let(:args) { { filename: filename } }
   let(:introvert) { Friends::Introvert.new(args) }
   let(:friend_names) { ["George Washington Carver", "Betsy Ross"] }
-  let(:friends) { friend_names.map { |name| Friends::Friend.new(name: name) } }
+  let(:friends) do
+    friend_names.map do |name|
+      Friends::Friend.new(name: name, hashtags_str: "#test")
+    end
+  end
   let(:activities) do
     [
       Friends::Activity.new(
@@ -110,20 +114,18 @@ describe Friends::Introvert do
   end
 
   describe "#list_friends" do
-    subject { introvert.list_friends(location_name: location_name) }
-
-    describe "when no location name has been passed" do
-      let(:location_name) { nil }
-
-      it "lists the names of friends" do
-        stub_friends(friends) do
-          subject.must_equal friend_names
-        end
-      end
+    subject do
+      introvert.list_friends(
+        location_name: location_name,
+        tagged: tagged,
+        verbose: verbose
+      )
     end
 
     describe "when a location name has been passed" do
       let(:location_name) { "Atlantis" }
+      let(:tagged) { nil }
+      let(:verbose) { false }
       let(:friends) do
         [
           Friends::Friend.new(name: "Mark Watney", location_name: "Mars"),
@@ -133,7 +135,29 @@ describe Friends::Introvert do
         ]
       end
 
-      it "lists the names of friends" do
+      it "lists the names of friends in that location" do
+        stub_friends(friends) do
+          stub_locations(locations) do
+            subject.must_equal ["Aquaman", "Shark-Boy"]
+          end
+        end
+      end
+    end
+
+    describe "when a hashtag has been passed" do
+      let(:location_name) { nil }
+      let(:tagged) { "#superhero" }
+      let(:verbose) { false }
+      let(:friends) do
+        [
+          Friends::Friend.new(name: "Mark Watney"),
+          Friends::Friend.new(name: "Aquaman", hashtags_str: "#superhero"),
+          Friends::Friend.new(name: "Shark-Boy", hashtags_str: "#superhero"),
+          Friends::Friend.new(name: "Ms. Nowhere")
+        ]
+      end
+
+      it "lists the names of friends in that location" do
         stub_friends(friends) do
           stub_locations(locations) do
             subject.must_equal ["Aquaman", "Shark-Boy"]
@@ -141,6 +165,32 @@ describe Friends::Introvert do
         end
       end
     end
+
+    describe "when not verbose" do
+      let(:verbose) { false }
+      let(:location_name) { nil }
+      let(:tagged) { nil }
+      it "lists the names of friends" do
+        stub_friends(friends) do
+          subject.must_equal friend_names
+        end
+      end
+    end
+
+    describe "when verbose" do
+      let(:verbose) { true }
+      let(:location_name) { nil }
+      let(:tagged) { nil }
+      it "lists the names and details of friends" do
+        stub_friends(friends) do
+          # Just check that there's a difference between the verbose and
+          # non-verbose versions of friends (otherwise our test is useless).
+          subject.wont_equal friend_names
+
+          subject.must_equal friends.map(&:to_s)
+        end
+      end
+    end
   end
 
   describe "#add_friend" do
@@ -151,7 +201,9 @@ describe Friends::Introvert do
       it "adds the given friend" do
         stub_friends(friends) do
           subject
-          introvert.list_friends(location_name: nil).
+          introvert.
+            instance_variable_get(:@friends).
+            map(&:name).
             must_include new_friend_name
         end
       end
@@ -214,17 +266,77 @@ describe Friends::Introvert do
     end
   end
 
+  describe "#list_hashtags" do
+    subject { introvert.list_hashtags(from: from) }
+
+    let(:activities) do
+      [
+        Friends::Activity.new(str: "Lunch in the park. #picnic #food"),
+        Friends::Activity.new(str: "Fancy dinner. #food #swanky")
+      ]
+    end
+
+    let(:friends) do
+      [
+        Friends::Friend.new(name: "Grace Hopper", hashtags_str: "#coder #navy"),
+        Friends::Friend.new(name: "James Bond", hashtags_str: "#cool #swanky")
+      ]
+    end
+
+    describe "when from flag is nil" do
+      let(:from) { nil }
+      it "lists all hashtags in sorted order" do
+        stub_activities(activities) do
+          stub_friends(friends) do
+            subject.must_equal [
+              "#coder",
+              "#cool",
+              "#food",
+              "#navy",
+              "#picnic",
+              "#swanky"
+            ]
+          end
+        end
+      end
+    end
+
+    describe 'when from flag is "activities"' do
+      let(:from) { "activities" }
+      it "lists all activity hashtags in sorted order" do
+        stub_activities(activities) do
+          stub_friends(friends) do
+            subject.must_equal ["#food", "#picnic", "#swanky"]
+          end
+        end
+      end
+    end
+
+    describe 'when from flag is "friends"' do
+      let(:from) { "friends" }
+      it "lists all friend hashtags in sorted order" do
+        stub_activities(activities) do
+          stub_friends(friends) do
+            subject.must_equal ["#coder", "#cool", "#navy", "#swanky"]
+          end
+        end
+      end
+    end
+  end
+
   describe "#list_activities" do
     subject do
       introvert.list_activities(
         limit: limit,
         with: with,
-        location_name: location_name
+        location_name: location_name,
+        tagged: tagged
       )
     end
     let(:limit) { nil }
     let(:with) { nil }
     let(:location_name) { nil }
+    let(:tagged) { nil }
 
     describe "when the limit is lower than the number of activities" do
       let(:limit) { 1 }
@@ -271,7 +383,7 @@ describe Friends::Introvert do
 
       it "lists the activities" do
         stub_activities(activities) do
-          subject.must_equal activities.map(&:display_text)
+          subject.must_equal activities.map(&:to_s)
         end
       end
     end
@@ -308,7 +420,7 @@ describe Friends::Introvert do
           stub_friends(friends) do
             stub_activities(activities) do
               # Only one activity has that friend.
-              subject.must_equal activities[0..0].map(&:display_text)
+              subject.must_equal activities[0..0].map(&:to_s)
             end
           end
         end
@@ -320,7 +432,7 @@ describe Friends::Introvert do
 
       it "lists the activities" do
         stub_activities(activities) do
-          subject.must_equal activities.map(&:display_text)
+          subject.must_equal activities.map(&:to_s)
         end
       end
     end
@@ -375,13 +487,60 @@ describe Friends::Introvert do
             stub_locations(locations) do
               stub_activities(activities) do
                 # Only one activity has that friend.
-                subject.must_equal activities[0..0].map(&:display_text)
+                subject.must_equal activities[0..0].map(&:to_s)
               end
             end
           end
         end
       end
     end
+
+    describe "when not filtering by a hashtag" do
+      let(:tagged) { nil }
+
+      it "lists the activities" do
+        stub_activities(activities) do
+          subject.must_equal activities.map(&:to_s)
+        end
+      end
+    end
+
+    describe "when filtering by a hashtag" do
+      let(:activities) do
+        [
+          Friends::Activity.new(str: "Tennis after work. #exercise #tennis"),
+          Friends::Activity.new(str: "Wimbledon! #tennis"),
+          Friends::Activity.new(str: "Drinks after work. #beer")
+        ]
+      end
+
+      describe "when the hashtag ('#hashtag') is not used at all" do
+        let(:tagged) { "#garbage" }
+        it "returns no results" do
+          stub_activities(activities) do
+            subject.must_equal []
+          end
+        end
+      end
+
+      describe "when the hashtag ('#hashtag') is used once" do
+        let(:tagged) { "#beer" }
+        it "returns the activity with that hashtag" do
+          stub_activities(activities) do
+            subject.must_equal [activities.last.to_s]
+          end
+        end
+      end
+
+      describe "when the hashtag ('#hashtag') is used multiple times" do
+        let(:tagged) { "#tennis" }
+        it "returns the activities with that hashtag" do
+          stub_activities(activities) do
+            subject.must_equal activities[0..1].map(&:to_s)
+          end
+        end
+      end
+    end
   end
 
   describe "#add_activity" do
@@ -426,24 +585,6 @@ describe Friends::Introvert do
         end
       end
     end
-
-    describe "when given names with leading and trailing spaces" do
-      let(:new_name) { "    David Bowie " }
-      let(:old_name) { friend_names.last + "    " }
-      subject do
-        introvert.rename_friend(old_name: old_name, new_name: new_name)
-      end
-
-      it "correctly strips the spaces" do
-        stub_friends(friends) do
-          stub_activities(activities) do
-            subject
-            introvert.activities.first.description.must_include "David Bowie"
-            introvert.activities.last.description.must_include "David Bowie"
-          end
-        end
-      end
-    end
   end
 
   describe "#rename_location" do
@@ -498,25 +639,6 @@ describe Friends::Introvert do
         end
       end
     end
-
-    describe "when given names with leading and trailing spaces" do
-      let(:new_name) { "    Paris, France " }
-      let(:old_name) { " Paris    " }
-      subject do
-        introvert.rename_location(old_name: old_name, new_name: new_name)
-      end
-
-      it "correctly strips the spaces" do
-        stub_locations(locations) do
-          stub_activities(activities) do
-            subject
-            introvert.activities.map do |activity|
-              activity.description.include? new_name
-            end.must_equal [true, true, false]
-          end
-        end
-      end
-    end
   end
 
   describe "#set_location" do
@@ -554,8 +676,32 @@ describe Friends::Introvert do
     end
 
     it "returns the modified friend" do
-      friend = Friends::Friend.new(name: "Jeff",
-                                   nickname_str: "a.k.a. The Dude")
+      friend = Friends::Friend.new(name: "Jeff", nickname_str: "The Dude")
+      stub_friends([friend]) do
+        subject.must_equal friend
+      end
+    end
+  end
+
+  describe "#add_hashtag" do
+    subject do
+      introvert.add_hashtag(name: friend_names.first, hashtag: "#school")
+    end
+
+    it "returns the modified friend" do
+      stub_friends(friends) do
+        subject.must_equal friends.first
+      end
+    end
+  end
+
+  describe "#remove_hashtag" do
+    subject do
+      introvert.remove_hashtag(name: "Jeff", hashtag: "#school")
+    end
+
+    it "returns the modified friend" do
+      friend = Friends::Friend.new(name: "Jeff", hashtags_str: "#school")
       stub_friends([friend]) do
         subject.must_equal friend
       end

metadata

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