friends 0.23 → 0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 560b5f5b4af9d8762ecb97f2a0ffdbb0cd8be02e
-  data.tar.gz: 39338ddbdffe9c8c712bed9e5078d0cfc5c8877a
+  metadata.gz: 6d3011809caabfa111b478a57a39b562a260ada1
+  data.tar.gz: 8a3d2a2b250ea85c44950a2bffbe3142940d2481
 SHA512:
-  metadata.gz: d2349672e223cec6d4f08df3ffce8209b8190540eb51862c72354d9a36144c813232bc18327a8d04c0da0d62ad1101f1a0931858f029e8e9cf1c94ea433c7ae0
-  data.tar.gz: 3c833ed0d247ea59064335482a182b9ffbb094b172e5388370161baba6992e0f7f125d41fb967628b14e581b252039e17c7fbb3cac9a800fc0c9cf6945983e37
+  metadata.gz: 6e3df7a84a7b2033a093de24ce0728961857db8cb99b0d34da1d661fc541a7c0df4386452717894dc3c7c515c9b62ad6e8653f3e27277d50b0a194e526afa8e0
+  data.tar.gz: 9c61b1fd7eb6796462f32afaa756b3a11bf2510567d36fedbd40df2fa61043062ec8f01d540d6c47bba04156bdac9bac74b680351779d0f5b814ed53e4bd0791

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [v0.24](https://github.com/JacobEvelyn/friends/tree/v0.24) (2016-05-17)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.23...v0.24)
+
+**Implemented enhancements:**
+
+- Change \#hashtags to @tags [\#122](https://github.com/JacobEvelyn/friends/issues/122)
+
+**Fixed bugs:**
+
+- Uninitialized constant Friends::Activity::Set when graphing by tag [\#133](https://github.com/JacobEvelyn/friends/issues/133)
+
+**Merged pull requests:**
+
+- Change tags to `@tag` format, auto-migrate old tags, and fix set loading issue [\#134](https://github.com/JacobEvelyn/friends/pull/134) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.23](https://github.com/JacobEvelyn/friends/tree/v0.23) (2016-05-16)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.22...v0.23)
 

data/README.md

@@ -17,7 +17,7 @@ Extrovert-approved.
     - `add`
       - [`add activity`](#add-activity)
       - [`add friend`](#add-friend)
-      - [`add hashtag`](#add-hashtag)
+      - [`add tag`](#add-tag)
       - [`add location`](#add-location)
       - [`add nickname`](#add-nickname)
     - [`clean`](#clean)
@@ -29,10 +29,10 @@ Extrovert-approved.
         - [`list favorite friends`](#list-favorite-friends)
         - [`list favorite locations`](#list-favorite-locations)
       - [`list friends`](#list-friends)
-      - [`list hashtags`](#list-hashtags)
+      - [`list tags`](#list-tags)
       - [`list locations`](#list-locations)
     - `remove`
-      - [`remove hashtag`](#remove-hashtag)
+      - [`remove tag`](#remove-tag)
       - [`remove nickname`](#remove-nickname)
     - `rename`
       - [`rename friend`](#rename-friend)
@@ -88,13 +88,13 @@ Easy, huh?
 
 - **Activities**: The things you do. Each activity has a date associated with
   it. Activities may optionally contain any number of *friends*, *locations*,
-  and *hashtags*.
+  and *tags*.
 - **Friends**: The people you do *activities* with. Each friend has a name and,
   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`)
+- **Tags**: A way to categorize your *activities* with tags of your
+  choosing. (Examples: `@exercise`, `@school`)
 
 The `friends.md` Markdown file that stores all of your data contains:
 
@@ -209,7 +209,7 @@ You can also use the first initial of a last name instead of the whole thing.
 them) based on whether you're in the middle of a sentence or not:
 
 ```bash
-$ friends add activity "Got lunch with Earnest H and Earnest S. in the park. Man, I like Earnest H. but really love Earnest S."
+$ friends add activity Got lunch with Earnest H and Earnest S. in the park. Man, I like Earnest H. but really love Earnest S.
 Activity added: "2016-05-01: Got lunch with Earnest Hemingway and Earnest Shackleton in the park. Man, I like Earnest Hemingway but really love Earnest Shackleton."
 ```
 
@@ -220,12 +220,12 @@ $ 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
+Tags 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"
+$ 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:
@@ -263,11 +263,11 @@ $ friends add friend Grace Hopper
 Friend added: "Grace Hopper"
 ```
 
-#### `add hashtag`
+#### `add tag`
 
 ```bash
-$ friends add hashtag "Grace Hopper" science
-Hashtag added to friend: "Grace Hopper #science
+$ friends add tag "Grace Hopper" science
+Tag added to friend: "Grace Hopper @science"
 ```
 
 #### `add location`
@@ -338,7 +338,7 @@ Jan 2015 |█████
 Feb 2015 |███
 ```
 
-Or graph only activities with a certain hashtag:
+Or graph only activities with a certain tag:
 
 ```bash
 $ friends graph --tagged food
@@ -400,8 +400,8 @@ Lists recent activities:
 
 ```bash
 $ friends list activities
-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
+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.
 ```
 
@@ -409,15 +409,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. #food
-2014-12-31: Celebrated the new year with Marie Curie in New York City. #partying
+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. #food
+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.
 ```
 
@@ -425,21 +425,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. #partying
+2014-12-31: Celebrated the new year with Marie Curie in New York City. @partying
 ```
 
-Or by hashtag:
+Or by tag:
 
 ```bash
 $ friends list activities --tagged food
-2015-01-04: Got lunch with Grace Hopper and George Washington Carver. #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
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver. @food
 ```
 
 #### `list favorite friends`
@@ -495,13 +495,13 @@ Grace Hopper
 Marie Curie
 ```
 
-You can also include friend nicknames, locations, and hashtags:
+You can also include friend nicknames, locations, and tags:
 
 ```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
+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:
@@ -511,7 +511,7 @@ $ friends list friends --in Paris
 Marie Curie
 ```
 
-And you can also filter your friends by hashtag:
+And you can also filter your friends by tag:
 
 ```bash
 $ friends list friends --tagged science
@@ -519,33 +519,33 @@ Grace Hopper
 Marie Curie
 ```
 
-#### `list hashtags`
+#### `list tags`
 
-Lists all hashtags you've used, in alphabetical order:
+Lists all tags you've used, in alphabetical order:
 
 ```bash
-$ friends list hashtags
-#dancing
-#food
-#school
-#swanky
+$ friends list tags
+@dancing
+@food
+@school
+@swanky
 ```
 
-You can limit this to only hashtags from activities:
+You can limit this to only tags from activities:
 
 ```bash
-$ friends list hashtags --from activities
-#dancing
-#food
-#swanky
+$ friends list tags --from activities
+@dancing
+@food
+@swanky
 ```
 
-Or only hashtags from friends:
+Or only tags from friends:
 
 ```bash
-$ friends list hashtags --from friends
-#school
-#swanky
+$ friends list tags --from friends
+@school
+@swanky
 ```
 
 #### `list locations`
@@ -559,13 +559,13 @@ New York City
 Paris
 ```
 
-#### `remove hashtag`
+#### `remove tag`
 
-Removes a specific hashtag from a friend:
+Removes a specific tag from a friend:
 
 ```bash
-$ friends remove hashtag "Grace Hopper" fun
-Hashtag removed from friend: "Grace Hopper (a.k.a. Amazing Grace) #OtherHashtag"
+$ friends remove tag "Grace Hopper" fun
+Tag removed from friend: "Grace Hopper (a.k.a. Amazing Grace) @OtherTag"
 ```
 
 #### `remove nickname`

data/bin/friends

@@ -19,21 +19,21 @@ 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
+class Tag
+  # @param str [String] of the form "tag" or "@tag"
+  # @return [String] the string, with whitespace stripped and a tag
   #   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)
+  def self.convert_to_tag(str)
     str = str.strip
-    !str.empty? && str[0] == "#" ? str : "##{str}"
+    !str.empty? && str[0] == "@" ? str : "@#{str}"
   end
 end
 
-accept(Hashtag) do |value|
-  Hashtag.convert_to_hashtag(value)
+accept(Tag) do |value|
+  Tag.convert_to_tag(value)
 end
 
 class Stripped; end
@@ -97,13 +97,13 @@ command :list do |list|
                       type: Stripped
 
     list_friends.flag [:tagged],
-                      arg_name: "HASHTAG",
-                      desc: "List only friends with the given hashtag",
-                      type: Hashtag
+                      arg_name: "@TAG",
+                      desc: "List only friends with the given tag",
+                      type: Tag
 
     list_friends.switch [:verbose],
                         negatable: false,
-                        desc: "Output friend nicknames, locations, and hashtags"
+                        desc: "Output friend nicknames, locations, and tags"
 
     list_friends.action do |_, options|
       puts @introvert.list_friends(
@@ -133,9 +133,9 @@ command :list do |list|
                          type: Stripped
 
     list_activities.flag [:tagged],
-                         arg_name: "HASHTAG",
-                         desc: "List only activities with the given hashtag",
-                         type: Hashtag
+                         arg_name: "@TAG",
+                         desc: "List only activities with the given tag",
+                         type: Tag
 
     list_activities.action do |_, options|
       puts @introvert.list_activities(
@@ -154,14 +154,14 @@ command :list do |list|
     end
   end
 
-  list.desc "List all hashtags used"
-  list.command :hashtags do |list_hashtags|
-    list_hashtags.flag [:from],
+  list.desc "List all tags used"
+  list.command :tags do |list_tags|
+    list_tags.flag [:from],
                        arg_name: '"activities" or "friends" (default: both)',
-                       desc: "List only hashtags from activities or friends "\
+                       desc: "List only tags from activities or friends "\
                              "instead of both"
-    list_hashtags.action do |_, options|
-      puts @introvert.list_hashtags(from: options[:from])
+    list_tags.action do |_, options|
+      puts @introvert.list_tags(from: options[:from])
     end
   end
 
@@ -266,15 +266,15 @@ command :add do |add|
     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(
+  add.desc "Adds a tag to a friend"
+  add.arg_name "NAME @TAG"
+  add.command :tag do |add_tag|
+    add_tag.action do |_, _, args|
+      friend = @introvert.add_tag(
         name: args.first,
-        hashtag: Hashtag.convert_to_hashtag(args[1])
+        tag: Tag.convert_to_tag(args[1])
       )
-      @message = "Hashtag added to friend: \"#{friend}\""
+      @message = "Tag added to friend: \"#{friend}\""
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -305,15 +305,15 @@ command :remove do |remove|
     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(
+  remove.desc "Removes a tag from a friend"
+  remove.arg_name "NAME @TAG"
+  remove.command :tag do |remove_tag|
+    remove_tag.action do |_, _, args|
+      friend = @introvert.remove_tag(
         name: args.first,
-        hashtag: Hashtag.convert_to_hashtag(args[1])
+        tag: Tag.convert_to_tag(args[1])
       )
-      @message = "Hashtag removed from friend: \"#{friend}\""
+      @message = "Tag removed from friend: \"#{friend}\""
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -332,9 +332,9 @@ command :graph do |graph|
              type: Stripped
 
   graph.flag [:tagged],
-             arg_name: "HASHTAG",
-             desc: "Graph activities with the given hashtag",
-             type: Hashtag
+             arg_name: "@TAG",
+             desc: "Graph activities with the given tag",
+             type: Tag
 
   graph.action do |_, options|
     # This math is taken from Minitest's Pride plugin (the PrideLOL class).

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. #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
+- 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] #navy #science
-- Marie Curie [Atlantis] #science
+- 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

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

data/lib/friends/activity.rb

@@ -5,6 +5,7 @@
 require "chronic"
 require "memoist"
 require "paint"
+require "set"
 
 require "friends/serializable"
 
@@ -71,7 +72,7 @@ module Friends
       end
 
       description_s = description_s.
-                      gsub(HASHTAG_REGEX, Paint['\0', :bold, :cyan])
+                      gsub(TAG_REGEX, Paint['\0', :bold, :cyan])
 
       "#{date_s}: #{description_s}"
     end
@@ -118,25 +119,25 @@ module Friends
 
     # @param location [Location] the location to test
     # @return [Boolean] true iff this activity includes the given location
-    def includes_location?(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:)
+    def includes_friend?(friend)
       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
+    # @param tag [String] the tag to test, of the form "@tag"
+    # @return [Boolean] true iff this activity includes the given tag
+    def includes_tag?(tag)
+      tags.include? tag
     end
 
-    # @return [Set] all hashtags in this activity (including the "#")
-    def hashtags
-      Set.new(@description.scan(HASHTAG_REGEX))
+    # @return [Set] all tags in this activity (including the "@")
+    def tags
+      Set.new(@description.scan(TAG_REGEX))
     end
 
     # Find the names of all friends in this description.

data/lib/friends/friend.rb

@@ -17,7 +17,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>[^\(\[#]*[^\(\[#\s])(\s+\(#{NICKNAME_PREFIX}(?<nickname_str>.+)\))?(\s+\[(?<location_name>[^\]]+)\])?(\s+(?<hashtags_str>(#{HASHTAG_REGEX}\s*)+))?/
+      /(#{SERIALIZATION_PREFIX})?(?<name>[^\(\[#]*[^\(\[#\s])(\s+\(#{NICKNAME_PREFIX}(?<nickname_str>.+)\))?(\s+\[(?<location_name>[^\]]+)\])?(\s+(?<tags_str>(#{TAG_REGEX}\s*)+))?/
       # rubocop:enable Metrics/LineLength
     end
 
@@ -31,19 +31,19 @@ module Friends
       name:,
       nickname_str: nil,
       location_name: nil,
-      hashtags_str: nil
+      tags_str: nil
     )
       @name = name
       @nicknames = nickname_str &&
                    nickname_str.split(" #{NICKNAME_PREFIX}") ||
                    []
       @location_name = location_name
-      @hashtags = hashtags_str && hashtags_str.split(/\s+/) || []
+      @tags = tags_str && tags_str.split(/\s+/) || []
     end
 
     attr_accessor :name
     attr_accessor :location_name
-    attr_reader :hashtags
+    attr_reader :tags
 
     # @return [String] the file serialization text for the friend
     def serialize
@@ -61,25 +61,25 @@ module Friends
 
       location_str = " [#{@location_name}]" unless @location_name.nil?
 
-      hashtag_str = " #{@hashtags.join(' ')}" unless @hashtags.empty?
+      tag_str = " #{@tags.join(' ')}" unless @tags.empty?
 
-      "#{@name}#{nickname_str}#{location_str}#{hashtag_str}"
+      "#{@name}#{nickname_str}#{location_str}#{tag_str}"
     end
 
-    # Adds a hashtag, ignoring duplicates.
-    # @param hashtag [String] the hashtag to add
-    def add_hashtag(hashtag)
-      @hashtags << hashtag
-      @hashtags.uniq!
+    # Adds a tag, ignoring duplicates.
+    # @param tag [String] the tag to add, of the format: "@tag"
+    def add_tag(tag)
+      @tags << tag
+      @tags.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}\""
+    # @param tag [String] the tag to remove, of the format: "@tag"
+    def remove_tag(tag)
+      unless @tags.include? tag
+        raise FriendsError, "Tag \"#{tag}\" not found for \"#{name}\""
       end
 
-      @hashtags.delete(hashtag)
+      @tags.delete(tag)
     end
 
     # Adds a nickname, ignoring duplicates.

data/lib/friends/introvert.rb

@@ -4,6 +4,8 @@
 # able to be used directly within another Ruby program, without needing to call
 # the command-line script explicitly.
 
+require "set"
+
 require "friends/activity"
 require "friends/friend"
 require "friends/graph"
@@ -158,26 +160,26 @@ module Friends
       friend
     end
 
-    # Add a hashtag to an existing friend.
+    # Add a tag to an existing friend.
     # @param name [String] the name of the friend
-    # @param hashtag [String] the hashtag to add to the friend
+    # @param tag [String] the tag to add to the friend, of the form: "@tag"
     # @raise [FriendsError] if 0 or 2+ friends match the given name
     # @return [Friend] the existing friend
-    def add_hashtag(name:, hashtag:)
+    def add_tag(name:, tag:)
       friend = friend_with_name_in(name)
-      friend.add_hashtag(hashtag)
+      friend.add_tag(tag)
       friend
     end
 
-    # Remove a hashtag from an existing friend.
+    # Remove a tag from an existing friend.
     # @param name [String] the name of the friend
-    # @param hashtag [String] the hashtag to remove from the friend
+    # @param tag [String] the tag to remove from the friend, of the form: "@tag"
     # @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:)
+    def remove_tag(name:, tag:)
       friend = friend_with_name_in(name)
-      friend.remove_hashtag(hashtag)
+      friend.remove_tag(tag)
       friend
     end
 
@@ -196,10 +198,10 @@ module Friends
     # 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 tagged [String] the name of a tag to filter by (of the form:
+    #   "@tag"), or nil for unfiltered
     # @param verbose [Boolean] true iff we should output friend names with
-    #   nicknames, locations, and hashtags; false for names only
+    #   nicknames, locations, and tags; false for names only
     # @return [Array] a list of all friend names
     def list_friends(location_name:, tagged:, verbose:)
       fs = @friends
@@ -210,8 +212,8 @@ module Friends
         fs = fs.select { |friend| friend.location_name == location.name }
       end
 
-      # Filter by hashtag if one is passed.
-      fs = fs.select { |friend| friend.hashtags.include? tagged } if tagged
+      # Filter by tag if one is passed.
+      fs = fs.select { |friend| friend.tags.include? tagged } if tagged
 
       verbose ? fs.map(&:to_s) : fs.map(&:name)
     end
@@ -239,10 +241,10 @@ 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
+    # @param tagged [String] the name of a tag to filter by (of the form:
+    #   "@tag"), or nil for unfiltered
     # @return [Array] a list of all activity text values
-    # @raise [FriendsError] if friend, location or hashtag cannot be found or
+    # @raise [FriendsError] if friend, location or tag cannot be found or
     #   is ambiguous
     def list_activities(limit:, with:, location_name:, tagged:)
       acts = filtered_activities(
@@ -264,21 +266,21 @@ module Friends
     end
 
     # @param from [String] one of: ["activities", "friends", nil]
-    #   If not nil, limits the hashtags returned to only those from either
+    #   If not nil, limits the tags returned to only those from either
     #   activities or friends.
-    # @return [Array] a sorted list of all hashtags in activity descriptions
-    def list_hashtags(from:)
+    # @return [Array] a sorted list of all tags in activity descriptions
+    def list_tags(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)
+          set.merge(activity.tags)
         end
       end
 
       unless from == "activities" # If from is "friends" or nil.
         @friends.each_with_object(output) do |friend, set|
-          set.merge(friend.hashtags)
+          set.merge(friend.tags)
         end
       end
 
@@ -286,7 +288,7 @@ module Friends
     end
 
     # Find data points for graphing activities over time.
-    # Optionally filter by friend, location and hashtag
+    # Optionally filter by friend, location and tag
     #
     # The returned hash uses the following format:
     #   {
@@ -301,10 +303,10 @@ 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
+    # @param tagged [String] the name of a tag to filter by (of the form:
+    #   "@tag"), or nil for unfiltered
     # @return [Hash{String => Integer}]
-    # @raise [FriendsError] if friend, location or hashtag cannot be found or
+    # @raise [FriendsError] if friend, location or tag cannot be found or
     #   is ambiguous
     def graph(with:, location_name:, tagged:)
       # There is no point trying to graph no activities
@@ -463,15 +465,15 @@ module Friends
 
     private
 
-    # Filter activities by friend, location and hashtag
+    # Filter activities by friend, location and tag
     # @param with [String] the name of a friend to filter by, or nil for
     #   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
+    # @param tagged [String] the name of a tag to filter by, or nil for
     #   unfiltered
     # @return [Array] an array of activities
-    # @raise [FriendsError] if friend, location or hashtag cannot be found or
+    # @raise [FriendsError] if friend, location or tag cannot be found or
     #   is ambiguous
     def filtered_activities(with:, location_name:, tagged:)
       acts = @activities
@@ -479,18 +481,18 @@ module Friends
       # Filter by friend name if argument is passed.
       unless with.nil?
         friend = friend_with_name_in(with)
-        acts = acts.select { |act| act.includes_friend?(friend: friend) }
+        acts = acts.select { |act| act.includes_friend?(friend) }
       end
 
       # Filter by location name if argument is passed.
       unless location_name.nil?
         location = location_with_name_in(location_name)
-        acts = acts.select { |act| act.includes_location?(location: location) }
+        acts = acts.select { |act| act.includes_location?(location) }
       end
 
       # Filter by tag if argument is passed.
       unless tagged.nil?
-        acts = acts.select { |act| act.includes_hashtag?(hashtag: tagged) }
+        acts = acts.select { |act| act.includes_tag?(tagged) }
       end
 
       acts
@@ -567,6 +569,15 @@ module Friends
         # Parse the line and update the parsing state.
         state = parse_line!(line, line_num: line_num, state: state)
       end
+
+      # Migrate old tag format (#tag) into new tag format (@tag). This code will
+      # be removed in the 1.0 release.
+      unless @friends.any? { |f| f.tags.any? } ||
+             @activities.any? { |a| a.tags.any? }
+        contents = File.read(@filename)
+        File.write(@filename, contents.gsub(/#(\p{Alnum}+)/, "@\\1"))
+        read_file
+      end
     end
 
     # Parse the given line, adding to the various internal data structures as

data/lib/friends/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Friends
-  VERSION = "0.23"
+  VERSION = "0.24"
 end

data/test/activity_spec.rb

@@ -430,7 +430,7 @@ describe Friends::Activity do
   end
 
   describe "#includes_location?" do
-    subject { activity.includes_location?(location: loc) }
+    subject { activity.includes_location?(loc) }
     let(:loc) { Friends::Location.new(name: "Atlantis") }
 
     describe "when the given location is in the activity" do
@@ -445,7 +445,7 @@ describe Friends::Activity do
   end
 
   describe "#includes_friend?" do
-    subject { activity.includes_friend?(friend: friend) }
+    subject { activity.includes_friend?(friend) }
 
     describe "when the given friend is in the activity" do
       let(:friend) { friend1 }
@@ -458,36 +458,36 @@ describe Friends::Activity do
     end
   end
 
-  describe "#hashtags" do
-    subject { activity.hashtags }
+  describe "#tags" do
+    subject { activity.tags }
 
-    describe "when the activity has no hashtags" do
+    describe "when the activity has no tags" 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"]) }
+    describe "when the activity has tags" 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 "#includes_tag?" do
+    subject { activity.includes_tag?(tag) }
+    let(:activity) { Friends::Activity.new(str: "Enormous ball pit! @fun") }
 
-    describe "when the given hashtag is not in the activity" do
-      let(:hashtag) { "#garbage" }
+    describe "when the given tag is not in the activity" do
+      let(:tag) { "@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" }
+    describe "when the given word is in the activity but not as a tag" do
+      let(:tag) { "@ball" }
       it { subject.must_equal false }
     end
 
-    describe "when the given hashtag is in the activity" do
-      let(:hashtag) { "#fun" }
+    describe "when the given tag is in the activity" do
+      let(:tag) { "@fun" }
       it { subject.must_equal true }
     end
   end

data/test/friend_spec.rb

@@ -81,35 +81,35 @@ describe Friends::Friend do
     end
   end
 
-  describe "#add_hashtag" do
-    subject { friend.add_hashtag("#college") }
+  describe "#add_tag" do
+    subject { friend.add_tag("@college") }
 
     it "adds the nickname" do
       subject
-      friend.hashtags.must_include("#college")
+      friend.tags.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.add_tag("@college")
+      friend.add_tag("@college")
 
-      friend.hashtags.must_equal ["#college"]
+      friend.tags.must_equal ["@college"]
     end
   end
 
-  describe "#remove_hashtag" do
-    subject { friend.remove_hashtag("#school") }
+  describe "@remove_tag" do
+    subject { friend.remove_tag("@school") }
 
-    describe "when the hashtag is present" do
+    describe "when the tag is present" do
       let(:friend) do
-        Friends::Friend.new(name: friend_name, hashtags_str: "#school #work")
+        Friends::Friend.new(name: friend_name, tags_str: "@school @work")
       end
 
       it "removes the nickname" do
-        friend.instance_variable_get(:@hashtags).must_equal ["#school", "#work"]
+        friend.instance_variable_get(:@tags).must_equal ["@school", "@work"]
         subject
-        friend.instance_variable_get(:@hashtags).must_equal ["#work"]
+        friend.instance_variable_get(:@tags).must_equal ["@work"]
       end
     end
 

data/test/introvert_spec.rb

@@ -38,7 +38,7 @@ describe Friends::Introvert do
   let(:friend_names) { ["George Washington Carver", "Betsy Ross"] }
   let(:friends) do
     friend_names.map do |name|
-      Friends::Friend.new(name: name, hashtags_str: "#test")
+      Friends::Friend.new(name: name, tags_str: "@test")
     end
   end
   let(:activities) do
@@ -146,15 +146,15 @@ describe Friends::Introvert do
       end
     end
 
-    describe "when a hashtag has been passed" do
+    describe "when a tag has been passed" do
       let(:location_name) { nil }
-      let(:tagged) { "#superhero" }
+      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: "Aquaman", tags_str: "@superhero"),
+          Friends::Friend.new(name: "Shark-Boy", tags_str: "@superhero"),
           Friends::Friend.new(name: "Ms. Nowhere")
         ]
       end
@@ -268,35 +268,35 @@ describe Friends::Introvert do
     end
   end
 
-  describe "#list_hashtags" do
-    subject { introvert.list_hashtags(from: from) }
+  describe "#list_tags" do
+    subject { introvert.list_tags(from: from) }
 
     let(:activities) do
       [
-        Friends::Activity.new(str: "Lunch in the park. #picnic #food"),
-        Friends::Activity.new(str: "Fancy dinner. #food #swanky")
+        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")
+        Friends::Friend.new(name: "Grace Hopper", tags_str: "@coder @navy"),
+        Friends::Friend.new(name: "James Bond", tags_str: "@cool @swanky")
       ]
     end
 
     describe "when from flag is nil" do
       let(:from) { nil }
-      it "lists all hashtags in sorted order" do
+      it "lists all tags in sorted order" do
         stub_activities(activities) do
           stub_friends(friends) do
             subject.must_equal [
-              "#coder",
-              "#cool",
-              "#food",
-              "#navy",
-              "#picnic",
-              "#swanky"
+              "@coder",
+              "@cool",
+              "@food",
+              "@navy",
+              "@picnic",
+              "@swanky"
             ]
           end
         end
@@ -305,10 +305,10 @@ describe Friends::Introvert do
 
     describe 'when from flag is "activities"' do
       let(:from) { "activities" }
-      it "lists all activity hashtags in sorted order" do
+      it "lists all activity tags in sorted order" do
         stub_activities(activities) do
           stub_friends(friends) do
-            subject.must_equal ["#food", "#picnic", "#swanky"]
+            subject.must_equal ["@food", "@picnic", "@swanky"]
           end
         end
       end
@@ -316,10 +316,10 @@ describe Friends::Introvert do
 
     describe 'when from flag is "friends"' do
       let(:from) { "friends" }
-      it "lists all friend hashtags in sorted order" do
+      it "lists all friend tags in sorted order" do
         stub_activities(activities) do
           stub_friends(friends) do
-            subject.must_equal ["#coder", "#cool", "#navy", "#swanky"]
+            subject.must_equal ["@coder", "@cool", "@navy", "@swanky"]
           end
         end
       end
@@ -497,7 +497,7 @@ describe Friends::Introvert do
       end
     end
 
-    describe "when not filtering by a hashtag" do
+    describe "when not filtering by a tag" do
       let(:tagged) { nil }
 
       it "lists the activities" do
@@ -507,17 +507,17 @@ describe Friends::Introvert do
       end
     end
 
-    describe "when filtering by a hashtag" do
+    describe "when filtering by a tag" 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")
+          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" }
+      describe "when the tag ('@tag') is not used at all" do
+        let(:tagged) { "@garbage" }
         it "returns no results" do
           stub_activities(activities) do
             subject.must_equal []
@@ -525,18 +525,18 @@ describe Friends::Introvert do
         end
       end
 
-      describe "when the hashtag ('#hashtag') is used once" do
-        let(:tagged) { "#beer" }
-        it "returns the activity with that hashtag" do
+      describe "when the tag ('@tag') is used once" do
+        let(:tagged) { "@beer" }
+        it "returns the activity with that tag" 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
+      describe "when the tag ('@tag') is used multiple times" do
+        let(:tagged) { "@tennis" }
+        it "returns the activities with that tag" do
           stub_activities(activities) do
             subject.must_equal activities[0..1].map(&:to_s)
           end
@@ -685,9 +685,9 @@ describe Friends::Introvert do
     end
   end
 
-  describe "#add_hashtag" do
+  describe "#add_tag" do
     subject do
-      introvert.add_hashtag(name: friend_names.first, hashtag: "#school")
+      introvert.add_tag(name: friend_names.first, tag: "@school")
     end
 
     it "returns the modified friend" do
@@ -697,13 +697,13 @@ describe Friends::Introvert do
     end
   end
 
-  describe "#remove_hashtag" do
+  describe "#remove_tag" do
     subject do
-      introvert.remove_hashtag(name: "Jeff", hashtag: "#school")
+      introvert.remove_tag(name: "Jeff", tag: "@school")
     end
 
     it "returns the modified friend" do
-      friend = Friends::Friend.new(name: "Jeff", hashtags_str: "#school")
+      friend = Friends::Friend.new(name: "Jeff", tags_str: "@school")
       stub_friends([friend]) do
         subject.must_equal friend
       end
@@ -820,18 +820,18 @@ describe Friends::Introvert do
 
     let(:activities) do
       [
-        # With a friend
+        # In a location
         Friends::Activity.new(
           str: "2016-01-01: \
             At _The Eiffel Tower_ with **George Washington Carver**."
         ),
 
-        # In a location
+        # Tagged
         Friends::Activity.new(
-          str: "2016-01-01: Called **George Washington Carver**. #phone"
+          str: "2016-01-01: Called **George Washington Carver**. @phone"
         ),
 
-        # Tagged with a hashtag
+        # With a friend
         Friends::Activity.new(
           str: "2016-01-01: Hung out with **Betsy Ross**."
         )
@@ -894,10 +894,10 @@ describe Friends::Introvert do
       end
     end
 
-    describe "Filtering by hashtag" do
-      let(:tagged) { "#phone" }
+    describe "Filtering by tag" do
+      let(:tagged) { "@phone" }
 
-      it "graphs activities tagged with a hashtag" do
+      it "graphs tagged activities" do
         stub_activities(activities) do
           subject.must_equal("Jan 2016" => 1)
         end

metadata

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