friends 0.49 → 0.54

data/lib/friends/commands/remove.rb

@@ -11,6 +11,15 @@ command :remove do |remove|
     end
   end
 
+  remove.desc "Removes an alias from a location"
+  remove.arg_name "LOCATION ALIAS"
+  remove.command :alias do |remove_alias|
+    remove_alias.action do |_, _, args|
+      @introvert.remove_alias(name: args.first.to_s.strip, nickname: args[1].to_s.strip)
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
+
   remove.desc "Removes a tag from a friend"
   remove.arg_name "NAME @TAG"
   remove.command :tag do |remove_tag|

data/lib/friends/commands/update.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "friends/post_install_message"
+require "friends/sem_ver_comparator"
 
 desc "Updates the `friends` program"
 command :update do |update|
@@ -9,8 +10,7 @@ command :update do |update|
     if match = `gem search friends`.match(/^friends\s\(([^\)]+)\)$/)
       # rubocop:enable Lint/AssignmentInCondition
       remote_version = match[1]
-      if Semverse::Version.coerce(remote_version) >
-         Semverse::Version.coerce(Friends::VERSION)
+      if Friends::SemVerComparator.greater?(remote_version, Friends::VERSION)
         `gem update friends && gem cleanup friends`
 
         unless global_options[:quiet]

data/lib/friends/event.rb

@@ -14,8 +14,8 @@ module Friends
   class Event
     extend Serializable
 
-    SERIALIZATION_PREFIX = "- ".freeze
-    DATE_PARTITION = ": ".freeze
+    SERIALIZATION_PREFIX = "- "
+    DATE_PARTITION = ": "
 
     # @return [Regexp] the regex for capturing groups in deserialization
     def self.deserialization_regex

data/lib/friends/friend.rb

@@ -10,13 +10,13 @@ module Friends
   class Friend
     extend Serializable
 
-    SERIALIZATION_PREFIX = "- ".freeze
-    NICKNAME_PREFIX = "a.k.a. ".freeze
+    SERIALIZATION_PREFIX = "- "
+    NICKNAME_PREFIX = "a.k.a. "
 
     # @return [Regexp] the regex for capturing groups in deserialization
     def self.deserialization_regex
       # Note: this regex must be on one line because whitespace is important
-      /(#{SERIALIZATION_PREFIX})?(?<name>[^\(\[@]*[^\(\[@\s])(\s+\(#{NICKNAME_PREFIX}(?<nickname_str>.+)\))?(\s+\[(?<location_name>[^\]]+)\])?(\s+(?<tags_str>(#{TAG_REGEX}\s*)+))?/ # rubocop:disable Metrics/LineLength
+      /(#{SERIALIZATION_PREFIX})?(?<name>[^\(\[@]*[^\(\[@\s])(\s+\(#{NICKNAME_PREFIX}(?<nickname_str>.+)\))?(\s+\[(?<location_name>[^\]]+)\])?(\s+(?<tags_str>(#{TAG_REGEX}\s*)+))?/ # rubocop:disable Layout/LineLength
     end
 
     # @return [Regexp] the string of what we expected during deserialization
@@ -32,11 +32,9 @@ module Friends
       tags_str: nil
     )
       @name = name
-      @nicknames = nickname_str &&
-                   nickname_str.split(" #{NICKNAME_PREFIX}") ||
-                   []
+      @nicknames = nickname_str&.split(" #{NICKNAME_PREFIX}") || []
       @location_name = location_name
-      @tags = tags_str && tags_str.split(/\s+/) || []
+      @tags = tags_str&.split(/\s+/) || []
     end
 
     attr_accessor :name

data/lib/friends/graph.rb

@@ -4,7 +4,7 @@
 
 module Friends
   class Graph
-    DATE_FORMAT = "%b %Y".freeze
+    DATE_FORMAT = "%b %Y"
     SCALED_SIZE = 20
 
     # @param filtered_activities [Array<Friends::Activity>] a list of activities to highlight in

data/lib/friends/introvert.rb

@@ -16,10 +16,10 @@ require "friends/friends_error"
 
 module Friends
   class Introvert
-    ACTIVITIES_HEADER = "### Activities:".freeze
-    NOTES_HEADER = "### Notes:".freeze
-    FRIENDS_HEADER = "### Friends:".freeze
-    LOCATIONS_HEADER = "### Locations:".freeze
+    ACTIVITIES_HEADER = "### Activities:"
+    NOTES_HEADER = "### Notes:"
+    FRIENDS_HEADER = "### Friends:"
+    LOCATIONS_HEADER = "### Locations:"
 
     # @param filename [String] the name of the friends Markdown file
     def initialize(filename:)
@@ -203,6 +203,7 @@ module Friends
     # @param nickname [String] the nickname to add to the friend
     # @raise [FriendsError] if 0 or 2+ friends match the given name
     def add_nickname(name:, nickname:)
+      raise FriendsError, "Expected \"[Friend Name]\" \"[Nickname]\"" if name.empty?
       raise FriendsError, "Nickname cannot be blank" if nickname.empty?
 
       friend = thing_with_name_in(:friend, name)
@@ -211,11 +212,37 @@ module Friends
       @output << "Nickname added: \"#{friend}\""
     end
 
+    # Add an alias to an existing location.
+    # @param name [String] the name of the location
+    # @param nickname [String] the alias to add to the location
+    # @raise [FriendsError] if 0 or 2+ locations match the given name
+    # @raise [FriendsError] if the alias is already taken
+    def add_alias(name:, nickname:)
+      raise FriendsError, "Expected \"[Location Name]\" \"[Alias]\"" if name.empty?
+      raise FriendsError, "Alias cannot be blank" if nickname.empty?
+
+      collision = @locations.find do |loc|
+        loc.name.casecmp(nickname).zero? || loc.aliases.any? { |a| a.casecmp(nickname).zero? }
+      end
+
+      if collision
+        raise FriendsError,
+              "The location alias \"#{nickname}\" is already taken by "\
+              "\"#{collision}\""
+      end
+
+      location = thing_with_name_in(:location, name)
+      location.add_alias(nickname)
+
+      @output << "Alias added: \"#{location}\""
+    end
+
     # Add a tag to an existing friend.
     # @param name [String] the name of 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
     def add_tag(name:, tag:)
+      raise FriendsError, "Expected \"[Friend Name]\" \"[Tag]\"" if name.empty?
       raise FriendsError, "Tag cannot be blank" if tag == "@"
 
       friend = thing_with_name_in(:friend, name)
@@ -248,6 +275,21 @@ module Friends
       @output << "Nickname removed: \"#{friend}\""
     end
 
+    # Remove an alias from an existing location.
+    # @param name [String] the name of the location
+    # @param nickname [String] the alias to remove from the location
+    # @raise [FriendsError] if 0 or 2+ locations match the given name
+    # @raise [FriendsError] if the location does not have the given alias
+    def remove_alias(name:, nickname:)
+      raise FriendsError, "Expected \"[Location Name]\" \"[Alias]\"" if name.empty?
+      raise FriendsError, "Alias cannot be blank" if nickname.empty?
+
+      location = thing_with_name_in(:location, name)
+      location.remove_alias(nickname)
+
+      @output << "Alias removed: \"#{location}\""
+    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
@@ -295,8 +337,8 @@ module Friends
     end
 
     # List all location names in the friends file.
-    def list_locations
-      @locations.each { |location| @output << location.name }
+    def list_locations(verbose:)
+      (verbose ? @locations.map(&:to_s) : @locations.map(&:name)).each { |line| @output << line }
     end
 
     # @param from [Array] containing any of: ["activities", "friends", "notes"]
@@ -427,16 +469,16 @@ module Friends
     #
     # The returned hash uses the following format:
     #   {
-    #     /regex/ => [list of friends matching regex]
+    #     /regex/ => location
     #   }
     #
     # This hash is sorted (because Ruby's hashes are ordered) by decreasing
     # regex key length, so the key /Paris, France/ appears before /Paris/.
     #
-    # @return [Hash{Regexp => Array<Friends::Location>}]
+    # @return [Hash{Regexp => location}]
     def regex_location_map
       @locations.each_with_object({}) do |location, hash|
-        hash[location.regex_for_name] = location
+        location.regexes_for_name.each { |regex| hash[regex] = location }
       end.sort_by { |k, _| -k.to_s.size }.to_h
     end
 
@@ -725,8 +767,8 @@ module Friends
 
       begin
         instance_variable_get("@#{stage.id}") << stage.klass.deserialize(line)
-      rescue StandardError => ex
-        bad_line(ex, line_num)
+      rescue StandardError => e
+        bad_line(e, line_num)
       end
 
       state
@@ -749,11 +791,7 @@ module Friends
     # @raise [FriendsError] if 0 or 2+ friends match the given text
     def thing_with_name_in(type, text)
       things = instance_variable_get("@#{type}s").select do |thing|
-        if type == :friend
-          thing.regexes_for_name.any? { |regex| regex.match(text) }
-        else
-          thing.regex_for_name.match(text)
-        end
+        thing.regexes_for_name.any? { |regex| regex.match(text) }
       end
 
       # If there's more than one match with fuzzy regexes but exactly one thing
@@ -808,7 +846,7 @@ module Friends
           a.default_location && a.default_location != activity.default_location
         end
 
-        str += " to #{Paint[(later_activity.date if later_activity) || 'present', :bold]}"
+        str += " to #{Paint[later_activity&.date || 'present', :bold]}"
       end
 
       str += " already" if earlier_activity_with_default_location != activity

data/lib/friends/location.rb

@@ -9,12 +9,13 @@ module Friends
   class Location
     extend Serializable
 
-    SERIALIZATION_PREFIX = "- ".freeze
+    SERIALIZATION_PREFIX = "- "
+    ALIAS_PREFIX = "a.k.a. "
 
     # @return [Regexp] the regex for capturing groups in deserialization
     def self.deserialization_regex
       # Note: this regex must be on one line because whitespace is important
-      /(#{SERIALIZATION_PREFIX})?(?<name>.+)/
+      /(#{SERIALIZATION_PREFIX})?(?<name>[^\(]*[^\(\s])(\s+\(#{ALIAS_PREFIX}(?<alias_str>.+)\))?/
     end
 
     # @return [Regexp] the string of what we expected during deserialization
@@ -23,21 +24,52 @@ module Friends
     end
 
     # @param name [String] the name of the location
-    def initialize(name:)
+    def initialize(name:, alias_str: nil)
       @name = name
+      @aliases = alias_str&.split(" #{ALIAS_PREFIX}") || []
     end
 
     attr_accessor :name
+    attr_reader :aliases
 
     # @return [String] the file serialization text for the location
     def serialize
-      "#{SERIALIZATION_PREFIX}#{@name}"
+      Paint.unpaint("#{SERIALIZATION_PREFIX}#{self}")
     end
 
-    # @return [Regexp] the regex used to match this location's name in an
-    #   activity description
-    def regex_for_name
-      Friends::RegexBuilder.regex(@name)
+    # @return [String] a string representing the location's name and aliases
+    def to_s
+      unless @aliases.empty?
+        alias_str = " (" +
+                    @aliases.map do |nickname|
+                      "#{ALIAS_PREFIX}#{Paint[nickname, :bold, :yellow]}"
+                    end.join(" ") + ")"
+      end
+
+      "#{Paint[@name, :bold]}#{alias_str}"
+    end
+
+    # Add an alias, ignoring duplicates.
+    # @param nickname [String] the alias to add
+    def add_alias(nickname)
+      @aliases << nickname
+      @aliases.uniq!
+    end
+
+    # @param nickname [String] the alias to remove
+    # @raise [FriendsError] if the location does not have the given alias
+    def remove_alias(nickname)
+      unless @aliases.include? nickname
+        raise FriendsError, "Alias \"#{nickname}\" not found for \"#{name}\""
+      end
+
+      @aliases.delete(nickname)
+    end
+
+    # @return [Array] a list of all regexes to match the name in a string
+    # NOTE: Only full names and aliases
+    def regexes_for_name
+      [name, *@aliases].map { |str| Friends::RegexBuilder.regex(str) }
     end
 
     # The number of activities this location is in. This is for internal use

data/lib/friends/post_install_message.rb

@@ -3,6 +3,5 @@
 module Friends
   POST_INSTALL_MESSAGE = "\nfriends is a volunteer project. If you find it useful, please "\
                          "consider making a small donation:\n\n\t"\
-                         "https://github.com/JacobEvelyn/friends#contributing-its-encouraged\n\n".
-                         freeze
+                         "https://github.com/JacobEvelyn/friends#contributing-its-encouraged\n\n"
 end

data/lib/friends/regex_builder.rb

@@ -6,26 +6,26 @@ module Friends
   class RegexBuilder
     # We don't want to match strings that are "escaped" with a leading
     # backslash.
-    NO_LEADING_BACKSLASH = "(?<!\\\\)".freeze
+    NO_LEADING_BACKSLASH = "(?<!\\\\)"
 
     # We don't want to match strings that are directly touching double asterisks
     # as these are treated as sacred by our program.
-    NO_LEADING_ASTERISKS = "(?<!\\*\\*)".freeze
-    NO_TRAILING_ASTERISKS = "(?!\\*\\*)".freeze
+    NO_LEADING_ASTERISKS = "(?<!\\*\\*)"
+    NO_TRAILING_ASTERISKS = "(?!\\*\\*)"
 
     # We don't want to match strings that are directly touching underscores
     # as these are treated as sacred by our program.
-    NO_LEADING_UNDERSCORES = "(?<!_)".freeze
-    NO_TRAILING_UNDERSCORES = "(?!_)".freeze
+    NO_LEADING_UNDERSCORES = "(?<!_)"
+    NO_TRAILING_UNDERSCORES = "(?!_)"
 
     # We don't want to match strings that are part of other words.
-    NO_LEADING_ALPHABETICALS = "(?<![A-z])".freeze
-    NO_TRAILING_ALPHABETICALS = "(?![A-z])".freeze
+    NO_LEADING_ALPHABETICALS = "(?<![A-z])"
+    NO_TRAILING_ALPHABETICALS = "(?![A-z])"
 
     # We ignore case within the regex as opposed to globally to allow consumers
     # of this API the ability to pass in strings that turn off this modifier
     # with the "(?-i)" string.
-    IGNORE_CASE = "(?i)".freeze
+    IGNORE_CASE = "(?i)"
 
     def self.regex(str)
       Regexp.new(

data/lib/friends/sem_ver_comparator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Friends
+  module SemVerComparator
+    SEPARATOR = "."
+    NUMBER_REGEX = /\d+/.freeze
+
+    def self.greater?(version_a, version_b)
+      version_a.split(SEPARATOR).zip(version_b.split(SEPARATOR)) do |a, b|
+        a_num = a&.[](NUMBER_REGEX)&.to_i
+        b_num = b&.[](NUMBER_REGEX)&.to_i
+        return false if a_num.nil?
+        return true if b_num.nil? || a_num > b_num
+        return false if a_num < b_num
+      end
+
+      false
+    end
+  end
+end

data/lib/friends/serializable.rb

@@ -26,7 +26,7 @@ module Serializable
            reduce(:merge).
            reject { |_, v| v.nil? }
 
-    new(args)
+    new(**args)
   end
 
   class SerializationError < StandardError

data/lib/friends/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Friends
-  VERSION = "0.49".freeze
+  VERSION = "0.54"
 end

data/test/add_event_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def date_parsing_specs(test_stdout: true)
   describe "date parsing" do
     let(:description) { "Test." }
@@ -123,7 +125,7 @@ def description_parsing_specs(test_stdout: true)
 
         it { line_added "- #{date}: Met **Grace Hopper**, and others, at 12." }
         if test_stdout
-          it { stdout_only "#{capitalized_event} added: \"#{date}: Met Grace Hopper, and others, at 12.\"" } # rubocop:disable Metrics/LineLength
+          it { stdout_only "#{capitalized_event} added: \"#{date}: Met Grace Hopper, and others, at 12.\"" } # rubocop:disable Layout/LineLength
         end
       end
 
@@ -132,7 +134,7 @@ def description_parsing_specs(test_stdout: true)
 
         it { line_added "- #{date}: Met **Grace Hopper**, King James, and others at 12." }
         if test_stdout
-          it { stdout_only "#{capitalized_event} added: \"#{date}: Met Grace Hopper, King James, and others at 12.\"" } # rubocop:disable Metrics/LineLength
+          it { stdout_only "#{capitalized_event} added: \"#{date}: Met Grace Hopper, King James, and others at 12.\"" } # rubocop:disable Layout/LineLength
         end
       end
 
@@ -141,7 +143,7 @@ def description_parsing_specs(test_stdout: true)
 
         it { line_added "- #{date}: Met someone—**Grace Hopper**?! At 12." }
         if test_stdout
-          it { stdout_only "#{capitalized_event} added: \"#{date}: Met someone—Grace Hopper?! At 12.\"" } # rubocop:disable Metrics/LineLength
+          it { stdout_only "#{capitalized_event} added: \"#{date}: Met someone—Grace Hopper?! At 12.\"" } # rubocop:disable Layout/LineLength
         end
       end
 
@@ -150,7 +152,7 @@ def description_parsing_specs(test_stdout: true)
 
         it { line_added "- #{date}: Met someone {**Grace Hopper**}—at 12." }
         if test_stdout
-          it { stdout_only "#{capitalized_event} added: \"#{date}: Met someone {Grace Hopper}—at 12.\"" } # rubocop:disable Metrics/LineLength
+          it { stdout_only "#{capitalized_event} added: \"#{date}: Met someone {Grace Hopper}—at 12.\"" } # rubocop:disable Layout/LineLength
         end
       end
 

data/test/commands/add/alias_spec.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "./test/helper"
+
+clean_describe "add alias" do
+  subject { run_cmd("add alias #{location_name} #{nickname}") }
+
+  let(:content) { CONTENT }
+
+  describe "when location name and alias are blank" do
+    let(:location_name) { nil }
+    let(:nickname) { nil }
+
+    it "prints an error message" do
+      stderr_only 'Error: Expected "[Location Name]" "[Alias]"'
+    end
+  end
+
+  describe "when location name has no matches" do
+    let(:location_name) { "Garbage" }
+    let(:nickname) { "Big Apple Pie" }
+
+    it "prints an error message" do
+      stderr_only 'Error: No location found for "Garbage"'
+    end
+  end
+
+  describe "when location alias has more than one match" do
+    let(:location_name) { "'New York City'" }
+    let(:nickname) { "'Big Apple'" }
+    before do
+      run_cmd("add location Manhattan")
+      run_cmd("add alias Manhattan 'Big Apple'")
+    end
+
+    it "prints an error message" do
+      stderr_only "Error: The location alias "\
+                  '"Big Apple" is already taken by "Manhattan (a.k.a. Big Apple)"'
+    end
+  end
+
+  describe "when location name has one match" do
+    let(:location_name) { "'New York City'" }
+
+    describe "when alias is blank" do
+      let(:nickname) { "' '" }
+
+      it "prints an error message" do
+        stderr_only "Error: Alias cannot be blank"
+      end
+    end
+
+    describe "when alias is nil" do
+      let(:nickname) { nil }
+
+      it "prints an error message" do
+        stderr_only "Error: Alias cannot be blank"
+      end
+    end
+
+    describe "when alias is not blank" do
+      let(:nickname) { "'Big Apple'" }
+
+      it "adds alias to location" do
+        line_changed "- New York City (a.k.a. NYC a.k.a. NY)",
+                     "- New York City (a.k.a. NYC a.k.a. NY a.k.a. Big Apple)"
+      end
+
+      it "prints an output message" do
+        stdout_only 'Alias added: "New York City (a.k.a. NYC a.k.a. NY a.k.a. Big Apple)"'
+      end
+    end
+  end
+end