friends 0.53 → 0.54

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1be607e71eb696b1ebf8c6e46b1b561f153288ecede0c429fc93facd82a4b392
-  data.tar.gz: 2ea6de005359014425d32386306c0654eaa8349be0ebf19c957da3582a8c33f2
+  metadata.gz: 555bc2e9643af62a0c4afb4d070d59de4ef54060d553e17d9eaa563bae82f1b5
+  data.tar.gz: a4f705f276a41c147aab67333c1ffec0ccc7bbba1ab454b9a014b7affa66f017
 SHA512:
-  metadata.gz: e946dd33cd26ee1fdbe288cc2a2be9f0eb3eaae6bede1e47096c8b42d2af5da753b7d151b29fd75aa3aac5958d717a7141cac7e108e949961cd000e6af5f3451
-  data.tar.gz: 3c8e1a84fec855f17d0177de3cadd52a31bdfe51255bf77dd70dd9188be59871eec15d734e6f0b269183e330e15734653679f821d322407c6a87ca8d3f1a3b8f
+  metadata.gz: 3d8ca490b127f8a60e97e3dacd4cbc893ee33ad8959d8e3bf2c53289154a58e76714958dc29e297e74ff024ac86f3bbfb1e168e5eccc9bd37f178c6c41d903e7
+  data.tar.gz: 14159aa7682fd24ad0cab80d558b91a234eb6d5d52904828c45f6de595b281364da52080288c782b50488cf5ec40a30d36fc2c8e64a251c33924ac8d299fc0df

data/CHANGELOG.md

@@ -4,6 +4,19 @@
 making a small donation (🙏) with the **Sponsor** button at the top of this page to
 show you appreciate its continued development.
 
+## [v0.54](https://github.com/JacobEvelyn/friends/tree/v0.54) (2020-10-29)
+
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.53...v0.54)
+
+**Implemented enhancements:**
+
+- Add location nicknames [\#242](https://github.com/JacobEvelyn/friends/issues/242)
+
+**Merged pull requests:**
+
+- Add location alias [\#269](https://github.com/JacobEvelyn/friends/pull/269) ([RenCloud](https://github.com/RenCloud))
+- Update codecov requirement from ~\> 0.1.14 to ~\> 0.2.0 [\#267](https://github.com/JacobEvelyn/friends/pull/267) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
 ## [v0.53](https://github.com/JacobEvelyn/friends/tree/v0.53) (2020-07-06)
 
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.52...v0.53)
@@ -83,7 +96,7 @@ show you appreciate its continued development.
 
 **Implemented enhancements:**
 
-- Change trigger for implicit location from `moved to \_LOCATION\_` to `to \_LOCATION\_` [\#245](https://github.com/JacobEvelyn/friends/pull/245) ([shen-sat](https://github.com/shen-sat))
+- Change trigger for implicit location from `moved to _LOCATION_` to `to _LOCATION_` [\#245](https://github.com/JacobEvelyn/friends/pull/245) ([shen-sat](https://github.com/shen-sat))
 
 **Closed issues:**
 
@@ -368,7 +381,7 @@ show you appreciate its continued development.
 
 **Implemented enhancements:**
 
-- Add `--since \<date\>` and `--until \<date\>` flags, and remove extraneous months from `graph` [\#153](https://github.com/JacobEvelyn/friends/issues/153)
+- Add `--since <date>` and `--until <date>` flags, and remove extraneous months from `graph` [\#153](https://github.com/JacobEvelyn/friends/issues/153)
 - Add integration tests for bin/friends? [\#127](https://github.com/JacobEvelyn/friends/issues/127)
 
 **Merged pull requests:**

data/Gemfile

@@ -9,6 +9,6 @@ group :development, :test do
 end
 
 group :test do
-  gem "codecov", "~> 0.1.14"
+  gem "codecov", "~> 0.2.0"
   gem "simplecov"
 end

data/README.md

@@ -37,6 +37,7 @@ lots of help), and give feedback! This project is
       - [`add tag`](#add-tag)
       - [`add location`](#add-location)
       - [`add nickname`](#add-nickname)
+      - [`add alias`](#add-alias)
       - [Adding a default location](#adding-a-default-location)
     - [`clean`](#clean)
     - [`graph`](#graph)
@@ -54,6 +55,7 @@ lots of help), and give feedback! This project is
     - `remove`
       - [`remove tag`](#remove-tag)
       - [`remove nickname`](#remove-nickname)
+      - [`remove alias`](#remove-alias)
     - `rename`
       - [`rename friend`](#rename-friend)
       - [`rename location`](#rename-location)
@@ -291,11 +293,13 @@ $ friends add activity Got lunch with Earnest H and Earnest S. in the park. Man,
 Activity added: "2017-05-01: Got lunch with Earnest Hemingway and Earnest Shackleton in the park. Man, I like Earnest Hemingway but really love Earnest Shackleton."
 ```
 
-And locations will be matched as well:
+And locations or their aliases will be matched as well:
 
 ```bash
 $ friends add activity Went swimming near atlantis with George.
 Activity added: "2017-01-06: Went swimming near Atlantis with George Washington Carver."
+$ friends add activity Had lunch in nyc with George.
+Activity added: "2017-01-06: Had lunch in New York City with George Washington Carver."
 ```
 
 Tags will be colored if they're provided (though this README can't display
@@ -411,6 +415,15 @@ $ friends add nickname "Grace Hopper" "Amazing Grace"
 Nickname added: "Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace)"
 ```
 
+#### `add alias`
+
+```bash
+$ friends add alias "New York City" "NYC"
+Alias added: "New York City (a.k.a. NYC)
+$ friends add alias "New York City" "Big Apple"
+Alias added: "New York City (a.k.a. NYC a.k.a. Big Apple)"
+```
+
 #### Setting a default location
 
 When an activity includes the phrase to \_LOCATION\_ (e.g., Took a plane to \_Paris\_), all future activities that have no explicit location will be associated with that location:
@@ -876,6 +889,15 @@ $ friends remove nickname "Grace Hopper" "The Admiral"
 Nickname removed: "Grace Hopper (a.k.a. Amazing Grace)"
 ```
 
+#### `remove alias`
+
+Removes a specific alias from a location:
+
+```bash
+$ friends remove alias "New York City" "Big Apple"
+Alias removed: "New York City (a.k.a. NYC)"
+```
+
 #### `rename friend`
 
 ```bash

data/lib/friends/commands/add.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-desc "Adds a friend (or nickname), activity, note, or location"
+desc "Adds a friend (or nickname), activity, note, or location (or alias)"
 command :add do |add|
   add.desc "Adds a friend"
   add.arg_name "NAME"
@@ -40,6 +40,15 @@ command :add do |add|
     end
   end
 
+  add.desc "Adds an alias to a location"
+  add.arg_name "LOCATION ALIAS"
+  add.command :alias do |add_alias|
+    add_alias.action do |_, _, args|
+      @introvert.add_alias(name: args.first.to_s.strip, nickname: args[1].to_s.strip)
+      @dirty = true # Mark the file for cleaning.
+    end
+  end
+
   add.desc "Adds a tag to a friend"
   add.arg_name "NAME @TAG"
   add.command :tag do |add_tag|

data/lib/friends/commands/list.rb

@@ -73,8 +73,11 @@ command :list do |list|
 
   list.desc "List all locations"
   list.command :locations do |list_locations|
-    list_locations.action do
-      @introvert.list_locations
+    list_locations.switch [:verbose],
+                          negatable: false,
+                          desc: "Output location aliases"
+    list_locations.action do |_, options|
+      @introvert.list_locations(verbose: options[:verbose])
     end
   end
 

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/introvert.rb

@@ -212,6 +212,31 @@ 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"
@@ -250,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
@@ -297,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"]
@@ -429,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
 
@@ -751,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

data/lib/friends/location.rb

@@ -10,11 +10,12 @@ module Friends
     extend Serializable
 
     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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Friends
-  VERSION = "0.53"
+  VERSION = "0.54"
 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

data/test/commands/edit_spec.rb

@@ -134,6 +134,7 @@ Not cleaning file: "#{filename}" ("exit 1 #" did not exit successfully)
 - Atlantis
 - Martha's Vineyard
 - Mysterious Mountains
+- New York City (a.k.a. NYC a.k.a. NY)
 - Paris
       EXPECTED_CONTENT
     end

data/test/commands/list/locations_spec.rb

@@ -31,7 +31,21 @@ clean_describe "list locations" do
 Paris
 Atlantis
 Martha's Vineyard
+New York City
       OUTPUT
     end
+
+    describe "--verbose" do
+      subject { run_cmd("list locations --verbose") }
+
+      it "lists locations in file order with details" do
+        stdout_only <<-OUTPUT
+Paris
+Atlantis
+Martha's Vineyard
+New York City (a.k.a. NYC a.k.a. NY)
+        OUTPUT
+      end
+    end
   end
 end

data/test/commands/remove/alias_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "./test/helper"
+
+clean_describe "remove alias" do
+  subject { run_cmd("remove alias #{location_name} #{nickname}") }
+
+  let(:content) { CONTENT }
+
+  describe "when location and nickname are nil" 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 name has one match" do
+    let(:location_name) { "'New York City'" }
+
+    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 present on location" do
+      let(:nickname) { "Gotham" }
+      it "prints an error message" do
+        stderr_only 'Error: Alias "Gotham" not found for "New York City"'
+      end
+    end
+
+    describe "when alias is present on location" do
+      let(:nickname) { "'NYC'" }
+
+      it "removes alias from location" do
+        line_changed(
+          "- New York City (a.k.a. NYC a.k.a. NY)",
+          "- New York City (a.k.a. NY)"
+        )
+      end
+
+      it "removes parenthetical from file when location has no more nicknames" do
+        run_cmd("remove alias #{location_name} 'NY'")
+        line_changed(
+          "- New York City (a.k.a. NYC)",
+          "- New York City"
+        )
+      end
+
+      it "prints an output message" do
+        stdout_only 'Alias removed: "New York City (a.k.a. NY)"'
+      end
+    end
+  end
+end

data/test/commands/stats_spec.rb

@@ -42,7 +42,7 @@ Total time elapsed: 0 days
       stdout_only <<-OUTPUT
 Total activities: 5
 Total friends: 5
-Total locations: 3
+Total locations: 4
 Total notes: 4
 Total tags: 10
 Total time elapsed: 1179 days

data/test/helper.rb

@@ -48,6 +48,7 @@ CONTENT = <<-FILE
 ### Locations:
 - Atlantis
 - Martha's Vineyard
+- New York City (a.k.a. NYC a.k.a. NY)
 - Paris
 FILE
 
@@ -77,6 +78,7 @@ SCRAMBLED_CONTENT = <<-FILE
 - Paris
 - Atlantis
 - Martha's Vineyard
+- New York City (a.k.a. NYC a.k.a. NY)
 FILE
 
 # Define these methods so they can be referenced in the methods below. They'll be overridden in

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.53'
+  version: '0.54'
 platform: ruby
 authors:
 - Jacob Evelyn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -163,6 +163,7 @@ files:
 - lib/friends/version.rb
 - test/add_event_helper.rb
 - test/commands/add/activity_spec.rb
+- test/commands/add/alias_spec.rb
 - test/commands/add/friend_spec.rb
 - test/commands/add/location_spec.rb
 - test/commands/add/nickname_spec.rb
@@ -179,6 +180,7 @@ files:
 - test/commands/list/locations_spec.rb
 - test/commands/list/notes_spec.rb
 - test/commands/list/tags_spec.rb
+- test/commands/remove/alias_spec.rb
 - test/commands/remove/nickname_spec.rb
 - test/commands/remove/tag_spec.rb
 - test/commands/rename/friend_spec.rb
@@ -212,13 +214,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Spend time with the people you care about.
 test_files:
 - test/add_event_helper.rb
 - test/commands/add/activity_spec.rb
+- test/commands/add/alias_spec.rb
 - test/commands/add/friend_spec.rb
 - test/commands/add/location_spec.rb
 - test/commands/add/nickname_spec.rb
@@ -235,6 +238,7 @@ test_files:
 - test/commands/list/locations_spec.rb
 - test/commands/list/notes_spec.rb
 - test/commands/list/tags_spec.rb
+- test/commands/remove/alias_spec.rb
 - test/commands/remove/nickname_spec.rb
 - test/commands/remove/tag_spec.rb
 - test/commands/rename/friend_spec.rb