friends 0.18 → 0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cafcf4ae0c7862e767cfa66d62f82358aa4427dd
-  data.tar.gz: ce713e78e33183b58d1dfe8a0a4ee56434bef476
+  metadata.gz: 4ba2ca1e570ce12bae59bd92e45eed450b15859d
+  data.tar.gz: f29a32cae219ae83c7cbc925d1493894d76409cb
 SHA512:
-  metadata.gz: abe895385b3b8fead89b0d05693b8c8ccce448a3a0af2af65bb0eb0441cc22e4b25d8de0d62b2318572053d5db977ec69dd33b90003017b89bd7349124baa0e1
-  data.tar.gz: 26ccbf5fe8b0178a8473ed8c7b541bed990cc9d65644760cd21a642a00a4b840048c1a3cde58e87c619d3ee5554e660342b4fce81bc7a012ea29bdff3c631509
+  metadata.gz: 264af4e8b7d6956401c9a7e6babecb6a8e8b6dc154de383394aef7890c2262685ea90c24c1d525d03802ecb1a028ffbc445cd4306fa91c5badbf044389667d1e
+  data.tar.gz: 674aa75753fc7aedc6f50bbb54956ecd91f6df2d8930d886f5f018e08d9c89b0db2e4f5aa74c014b45b35c6d429809d6fbdb7982598b52b66b0636f377136d3a

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [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)
+
+**Implemented enhancements:**
+
+- Add command to list favorite locations [\#108](https://github.com/JacobEvelyn/friends/issues/108)
+
+**Merged pull requests:**
+
+- Add `list favorite locations` command [\#115](https://github.com/JacobEvelyn/friends/pull/115) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.18](https://github.com/JacobEvelyn/friends/tree/v0.18) (2016-05-02)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.17...v0.18)
 

data/README.md

@@ -14,7 +14,7 @@ Extrovert-approved.
   - [Global flags](#global-flags)
   - [Syncing across multiple machines](#syncing-across-multiple-machines)
   - [Command reference](#command-reference)
-    - [`add`](#add)
+    - `add`
       - [`add activity`](#add-activity)
       - [`add friend`](#add-friend)
       - [`add location`](#add-location)
@@ -22,13 +22,15 @@ Extrovert-approved.
     - [`clean`](#clean)
     - [`graph`](#graph)
     - [`help`](#help)
-    - [`list`](#list)
+    - `list`
       - [`list activities`](#list-activities)
-      - [`list favorites`](#list-favorites)
+      - `list favorite`
+        - [`list favorite friends`](#list-favorite-friends)
+        - [`list favorite locations`](#list-favorite-locations)
       - [`list friends`](#list-friends)
       - [`list locations`](#list-locations)
     - [`remove nickname`](#remove-nickname)
-    - [`rename`](#rename)
+    - `rename`
       - [`rename friend`](#rename-friend)
       - [`rename location`](#rename-location)
     - [`set location`](#set)
@@ -177,9 +179,7 @@ alias friends="friends --filename '~/Dropbox/friends.md'"
 
 *Note that the command-line output is colored, which this README cannot show.
 
-#### `add`
-
-##### `add activity`
+#### `add activity`
 
 ```bash
 $ friends add activity "Got lunch with Grace and George."
@@ -240,21 +240,21 @@ $ friends add activity "2015-11-01: Grace and I went to \Marie's Diner. \George
 Activity added: "2015-11-01: Grace Hopper and I went to Marie's Diner. George had to cancel at the last minute."
 ```
 
-##### `add friend`
+#### `add friend`
 
 ```bash
 $ friends add friend "Grace Hopper"
 Friend added: "Grace Hopper"
 ```
 
-##### `add location`
+#### `add location`
 
 ```
 $ friends add location Atlantis
 Location added: "Atlantis"
 ```
 
-##### `add nickname`
+#### `add nickname`
 
 ```bash
 $ friends add nickname "Grace Hopper" "The Admiral"
@@ -344,9 +344,7 @@ $ friends help list
 $ friends help list activities
 ```
 
-#### `list`
-
-##### `list activities`
+#### `list activities`
 
 Lists recent activities:
 
@@ -380,12 +378,12 @@ $ friends list activities --in "New York"
 2014-12-31: Celebrated the new year with Marie Curie in New York City.
 ```
 
-##### `list favorites`
+#### `list favorite friends`
 
 Lists your "favorite" friends (by total number of activities):
 
 ```bash
-$ friends list favorites
+$ friends list favorite friends
 Your favorite friends:
 1. George Washington Carver (2 activities)
 2. Grace Hopper             (1)
@@ -395,13 +393,34 @@ Your favorite friends:
 You can specify a number of favorites to show:
 
 ```bash
-$ friends list favorites --limit 2
+$ friends list favorite friends --limit 2
 Your favorite friends:
 1. George Washington Carver (2 activities)
 2. Grace Hopper             (1)
 ```
 
-##### `list friends`
+#### `list favorite locations`
+
+Lists your "favorite" locations (by total number of activities):
+
+```bash
+$ friends list favorite locations
+Your favorite locations:
+1. Atlantis (2 activities)
+2. Paris    (1)
+3. London   (1)
+```
+
+You can specify a number of favorites to show:
+
+```bash
+$ friends list favorite locations --limit 2
+Your favorite locations:
+1. Atlantis (2 activities)
+2. Paris    (1)
+```
+
+#### `list friends`
 
 Lists all of your friends:
 
@@ -419,7 +438,7 @@ $ friends list friends --in Paris
 Marie Curie
 ```
 
-##### `list locations`
+#### `list locations`
 
 Lists all of the locations you've added:
 
@@ -439,16 +458,14 @@ $ friends remove nickname "Grace Hopper" "The Admiral"
 Nickname removed: "Grace Hopper (a.k.a. Amazing Grace)"
 ```
 
-#### `rename`
-
-##### `rename friend`
+#### `rename friend`
 
 ```bash
 $ friends rename friend "Grace Hopper" "Grace Brewster Murray Hopper"
 Name changed: "Grace Brewster Murray Hopper (a.k.a. Amazing Grace)"
 ```
 
-##### `rename location`
+#### `rename location`
 
 ```bash
 $ friends rename location Paris "Paris, France"

data/bin/friends

@@ -79,25 +79,52 @@ command :list do |list|
     end
   end
 
-  list.desc "List favorite friends"
-  list.command :favorites do |list_favorites|
-    list_favorites.flag [:limit],
-                        arg_name: "NUMBER",
-                        default_value: 10,
-                        desc: "The number of friends to return"
-
-    list_favorites.action do |_, options|
-      limit = options[:limit].to_i
-      favorites = @introvert.list_favorites(limit: limit)
+  list.desc "List favorite friends and locations"
+  list.command :favorite do |list_favorite|
+    list_favorite.desc "List favorite friends"
+    list_favorite.command :friends do |list_favorite_friends|
+      list_favorite_friends.flag [:limit],
+                                 arg_name: "NUMBER",
+                                 default_value: 10,
+                                 desc: "The number of friends to return"
+
+      list_favorite_friends.action do |_, options|
+        limit = options[:limit].to_i
+        favorites = @introvert.list_favorite_friends(limit: limit)
+
+        if limit == 1
+          puts "Your best friend is #{favorites.first}"
+        else
+          puts "Your favorite friends:"
 
-      if limit == 1
-        puts "Your best friend is #{favorites.first}"
-      else
-        puts "Your favorite friends:"
+          num_str_size = favorites.size.to_s.size + 1
+          favorites.each.with_index(1) do |name, rank|
+            puts "#{"#{rank}.".ljust(num_str_size)} #{name}"
+          end
+        end
+      end
+    end
+
+    list_favorite.desc "List favorite locations"
+    list_favorite.command :locations do |list_favorite_locations|
+      list_favorite_locations.flag [:limit],
+                                   arg_name: "NUMBER",
+                                   default_value: 10,
+                                   desc: "The number of locations to return"
+
+      list_favorite_locations.action do |_, options|
+        limit = options[:limit].to_i
+        favorites = @introvert.list_favorite_locations(limit: limit)
+
+        if limit == 1
+          puts "Your favorite location is #{favorites.first}"
+        else
+          puts "Your favorite locations:"
 
-        num_str_size = favorites.size.to_s.size + 1
-        favorites.each.with_index(1) do |name, rank|
-          puts "#{"#{rank}.".ljust(num_str_size)} #{name}"
+          num_str_size = favorites.size.to_s.size + 1
+          favorites.each.with_index(1) do |name, rank|
+            puts "#{"#{rank}.".ljust(num_str_size)} #{name}"
+          end
         end
       end
     end

data/lib/friends/activity.rb

@@ -127,6 +127,13 @@ module Friends
     end
     memoize :friend_names
 
+    # Find the names of all locations in this description.
+    # @return [Array] list of all location names in the description
+    def location_names
+      @description.scan(/(?<=_)\w[^_]*(?=_)/).uniq
+    end
+    memoize :location_names
+
     private
 
     # Modify the description to turn inputted location names (e.g. "Atlantis")
@@ -184,7 +191,7 @@ module Friends
       end
 
       # Now, we compute the likelihood of each friend in the possible-match set.
-      introvert.set_n_activities!
+      introvert.set_friend_n_activities!
       introvert.set_likelihood_score!(
         matches: matched_friends,
         possible_matches: possible_matched_friends

data/lib/friends/introvert.rb

@@ -192,29 +192,19 @@ module Friends
     end
 
     # List your favorite friends.
-    # @param limit [Integer] the number of favorite friends to return, or nil
-    #   for no limit
+    # @param limit [Integer] the number of favorite friends to return
     # @return [Array] a list of the favorite friends' names and activity
     #   counts
-    def list_favorites(limit:)
-      if !limit.nil? && limit < 1
-        raise FriendsError, "Favorites limit must be positive or unlimited"
-      end
-
-      set_n_activities! # Set n_activities for all friends.
-
-      # Sort the results, with the most favorite friend first.
-      results = @friends.sort_by { |friend| -friend.n_activities }
-
-      # If we need to, trim the list.
-      results = results.take(limit) unless limit.nil?
+    def list_favorite_friends(limit:)
+      list_favorite_things(:friend, limit: limit)
+    end
 
-      max_str_size = results.map(&:name).map(&:size).max
-      results.map.with_index(0) do |friend, index|
-        name = friend.name.ljust(max_str_size)
-        parenthetical = "(#{friend.n_activities}#{' activities' if index == 0})"
-        "#{name} #{parenthetical}"
-      end
+    # List your favorite friends.
+    # @param limit [Integer] the number of favorite locations to return
+    # @return [Array] a list of the favorite locations' names and activity
+    #   counts
+    def list_favorite_locations(limit:)
+      list_favorite_things(:location, limit: limit)
     end
 
     # List all activity details.
@@ -306,7 +296,7 @@ module Friends
     #   for unfiltered
     # @return [Hash{String => Array<String>}]
     def suggest(location_name:)
-      set_n_activities! # Set n_activities for all friends.
+      set_friend_n_activities! # Set n_activities for all friends.
 
       # Filter our friends by location if necessary.
       fs = @friends
@@ -338,20 +328,8 @@ module Friends
     ###################################################################
 
     # Sets the n_activities field on each friend.
-    def set_n_activities!
-      # Construct a hash of friend name to frequency of appearance.
-      freq_table = Hash.new { |h, k| h[k] = 0 }
-      @activities.each do |activity|
-        activity.friend_names.each do |friend_name|
-          freq_table[friend_name] += 1
-        end
-      end
-
-      # Remove names that are not in the friends list.
-      freq_table.each do |name, count|
-        friend = friend_with_exact_name(name)
-        friend.n_activities = count if friend # Do nothing if name not valid.
-      end
+    def set_friend_n_activities!
+      set_n_activities!(:friend)
     end
 
     # Get a regex friend map.
@@ -445,6 +423,59 @@ module Friends
 
     private
 
+    # @param type [Symbol] one of: [:friend, :location]
+    # @param limit [Integer] the number of favorite things to return
+    # @return [Array] a list of the favorite things' names and activity counts
+    def list_favorite_things(type, limit:)
+      unless [:friend, :location].include? type
+        raise FriendsError, "Type must be either :friend or :location"
+      end
+
+      if limit < 1
+        raise FriendsError, "Favorites limit must be positive"
+      end
+
+      send("set_n_activities!", type) # Set n_activities for all things.
+
+      # Sort the results, with the most favorite thing first.
+      results = instance_variable_get("@#{type}s").sort_by do |thing|
+        -thing.n_activities
+      end.take(limit) # Trim the list.
+
+      max_str_size = results.map(&:name).map(&:size).max
+      results.map.with_index(0) do |thing, index|
+        name = thing.name.ljust(max_str_size)
+        n = thing.n_activities
+        if index == 0
+          label = n == 1 ? " activity" : " activities"
+        end
+        parenthetical = "(#{n}#{label})"
+        "#{name} #{parenthetical}"
+      end
+    end
+
+    # Sets the n_activities field on each thing.
+    # @param type [Symbol] one of: [:friend, :location]
+    def set_n_activities!(type)
+      unless [:friend, :location].include? type
+        raise FriendsError, "Type must be either :friend or :location"
+      end
+
+      # Construct a hash of location name to frequency of appearance.
+      freq_table = Hash.new { |h, k| h[k] = 0 }
+      @activities.each do |activity|
+        activity.send("#{type}_names").each do |thing_name|
+          freq_table[thing_name] += 1
+        end
+      end
+
+      # Remove names that are not in the locations list.
+      freq_table.each do |name, count|
+        thing = send("#{type}_with_exact_name", name)
+        thing.n_activities = count if thing # Do nothing if name isn't valid.
+      end
+    end
+
     # Process the friends.md file and store its contents in internal data
     # structures.
     def read_file
@@ -541,6 +572,19 @@ module Friends
       end
     end
 
+    # @param name [String] the name of the location to search for
+    # @return [Location] the location whose name exactly matches the argument
+    # @raise [FriendsError] if more than one location has the given name
+    def location_with_exact_name(name)
+      results = @locations.select { |location| location.name == name }
+
+      case results.size
+      when 0 then nil
+      when 1 then results.first
+      else raise FriendsError, "More than one location named #{name}"
+      end
+    end
+
     # @param text [String] the name (or substring) of the location to search for
     # @return [Location] the location that matches
     # @raise [FriendsError] if 0 or 2+ location match the given text

data/lib/friends/location.rb

@@ -39,6 +39,13 @@ module Friends
       Friends::RegexBuilder.regex(@name)
     end
 
+    # The number of activities this location is in. This is for internal use
+    # only and is set by the Introvert as needed.
+    attr_writer :n_activities
+    def n_activities
+      @n_activities || 0
+    end
+
     private
 
     # Default sorting for an array of locations is alphabetical.

data/lib/friends/version.rb

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

data/test/introvert_spec.rb

@@ -562,31 +562,34 @@ describe Friends::Introvert do
     end
   end
 
-  describe "#list_favorites" do
-    subject { introvert.list_favorites(limit: limit) }
+  describe "#list_favorite_friends" do
+    subject { introvert.list_favorite_friends(limit: limit) }
 
-    describe "when limit is nil" do
-      let(:limit) { nil }
+    describe "when there are more friends than favorites requested" do
+      let(:limit) { 1 }
 
-      it "returns all friends in order of favoritism with activity counts" do
+      it "returns the number of favorites requested" do
         stub_friends(friends) do
           stub_activities(activities) do
-            subject.must_equal [
-              "Betsy Ross               (2 activities)",
-              "George Washington Carver (1)"
-            ]
+            subject.must_equal ["Betsy Ross (2 activities)"]
           end
         end
       end
     end
+  end
 
-    describe "when there are more friends than favorites requested" do
+  describe "#list_favorite_locations" do
+    subject { introvert.list_favorite_locations(limit: limit) }
+
+    describe "when there are more locations than favorites requested" do
       let(:limit) { 1 }
 
       it "returns the number of favorites requested" do
-        stub_friends(friends) do
-          stub_activities(activities) do
-            subject.must_equal ["Betsy Ross (2 activities)"]
+        stub_locations(locations) do
+          stub_activities(
+            [Friends::Activity.new(str: "Swimming in _Atlantis_.")]
+          ) do
+            subject.must_equal ["Atlantis (1 activity)"]
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.18'
+  version: '0.19'
 platform: ruby
 authors:
 - Jacob Evelyn