friends 0.54 → 0.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 555bc2e9643af62a0c4afb4d070d59de4ef54060d553e17d9eaa563bae82f1b5
-  data.tar.gz: a4f705f276a41c147aab67333c1ffec0ccc7bbba1ab454b9a014b7affa66f017
+  metadata.gz: 04bb70e6973e141306240dba6c4c8f0d26322ad9e795c70b9407b36fa243386d
+  data.tar.gz: 4495b8c22adc4274ca870c81c5112d0ef616a2bf804e168cf469cdbfafee6a99
 SHA512:
-  metadata.gz: 3d8ca490b127f8a60e97e3dacd4cbc893ee33ad8959d8e3bf2c53289154a58e76714958dc29e297e74ff024ac86f3bbfb1e168e5eccc9bd37f178c6c41d903e7
-  data.tar.gz: 14159aa7682fd24ad0cab80d558b91a234eb6d5d52904828c45f6de595b281364da52080288c782b50488cf5ec40a30d36fc2c8e64a251c33924ac8d299fc0df
+  metadata.gz: 8e2638a0504eca66dc731052edaa2c86c070222571509187165a08eaff29a57f89c69aa00ee7b2ca1bd633cc783fbeb7f880767151ec7b6de737938b5dea875e
+  data.tar.gz: 16c2a9a1ba086507060dc53cc1a76ef4789195bf8152a45a80a8f453027ee7c494921b7ec30c26ebcebb89c0a3c8653a63a9de6d258273d62d7b3cd474201a3f

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -8,9 +8,9 @@ merge this change:
 - [ ] The code in these changes works correctly.
 - [ ] Code has tests as appropriate.
 - [ ] Code has been reviewed by @JacobEvelyn.
-- [ ] All tests pass on Travis CI.
+- [ ] All tests pass on GitHub.
 - [ ] Code coverage remains high.
-- [ ] Rubocop reports no issues on Travis CI.
+- [ ] RuboCop reports no issues on GitHub.
 - [ ] The `README.md` file is updated as appropriate.
 
 Don't worry—this list will get checked off in no time!

data/.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: Main
+on:
+  pull_request:
+    branches:
+    - main
+  push:
+    branches:
+    - main
+jobs:
+  ci:
+    name: CI
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    # Conditionally configure bundler via environment variables as advised
+    #   * https://github.com/ruby/setup-ruby#bundle-config
+    - name: Set code coverage environment variable
+      run: echo "CODE_COVERAGE=true" >> $GITHUB_ENV
+      if: matrix.ruby == 3.0
+
+    # Use 'bundler-cache: true' instead of actions/cache as advised:
+    #   * https://github.com/actions/cache/blob/main/examples.md#ruby---bundler
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - run: bundle exec rake test
+
+    - run: bundle exec rubocop
+      if: matrix.ruby == 3.0

data/CHANGELOG.md

@@ -4,6 +4,25 @@
 making a small donation (🙏) with the **Sponsor** button at the top of this page to
 show you appreciate its continued development.
 
+## [v0.55](https://github.com/JacobEvelyn/friends/tree/v0.55) (2021-07-25)
+
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.54...v0.55)
+
+**Implemented enhancements:**
+
+- Add --sort flag to list friends/locations [\#276](https://github.com/JacobEvelyn/friends/pull/276) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
+**Closed issues:**
+
+- Add tests for Ruby 3.0 [\#279](https://github.com/JacobEvelyn/friends/issues/279)
+- Switch from Travis to GitHub Actions [\#277](https://github.com/JacobEvelyn/friends/issues/277)
+- Add new list command to log any activity or note related to specified friend [\#270](https://github.com/JacobEvelyn/friends/issues/270)
+- Replace `favorites` commands with more flexible `--sort` options [\#247](https://github.com/JacobEvelyn/friends/issues/247)
+
+**Merged pull requests:**
+
+- Move CI from Travis to GitHub Actions [\#278](https://github.com/JacobEvelyn/friends/pull/278) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [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)

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/friends.svg)](https://badge.fury.io/rb/friends)
 [![Code Coverage](https://codecov.io/gh/JacobEvelyn/friends/branch/main/graph/badge.svg)](https://codecov.io/gh/JacobEvelyn/friends)
-[![Build Status](https://travis-ci.com/JacobEvelyn/friends.svg?branch=main)](https://travis-ci.com/JacobEvelyn/friends)
+[![Tests](https://github.com/JacobEvelyn/friends/workflows/Main/badge.svg)](https://github.com/JacobEvelyn/friends/actions?query=workflow%3AMain)
 [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=JacobEvelyn/friends&bust=1)](http://clayallsopp.github.io/readme-score?url=JacobEvelyn/friends)
 [![Inline docs](http://inch-ci.org/github/JacobEvelyn/friends.png)](http://inch-ci.org/github/JacobEvelyn/friends)
 [![Gem](https://img.shields.io/gem/dt/friends.svg)](https://rubygems.org/gems/friends)
@@ -32,22 +32,19 @@ lots of help), and give feedback! This project is
   - [Command reference](#command-reference)
     - `add`
       - [`add activity`](#add-activity)
+        - [Setting a default location](#setting-a-default-location)
       - [`add note`](#add-note)
       - [`add friend`](#add-friend)
       - [`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)
     - [`help`](#help)
     - `list`
       - [`list activities`](#list-activities)
       - [`list notes`](#list-notes)
-      - `list favorite`
-        - [`list favorite friends`](#list-favorite-friends)
-        - [`list favorite locations`](#list-favorite-locations)
       - [`list friends`](#list-friends)
       - [`list tags`](#list-tags)
       - [`list locations`](#list-locations)
@@ -354,6 +351,27 @@ This is really handy for when you have an activity involving a friend or locatio
 you can't remember if you've already added. Just use the signifiers and
 they'll be added if necessary!
 
+##### 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:
+
+```bash
+$ friends add activity Took a plane to Paris
+Activity added: "2020-01-04: Took a plane to Paris"
+Default location set to: "Paris"
+$ friends add activity Ate lunch at a charming café
+Activity added: "2020-01-04: Ate lunch at a charming café"
+$ friends add activity Left the city to go to Chamonix
+Activity added: "2020-01-04: Left the city to go to Chamonix"
+Default location set to: "Chamonix"
+```
+
+```bash
+$ friends list activities --in Paris
+2019-01-04: Ate lunch at a charming café
+2019-01-04: Took a plane to Paris
+```
+
 #### `add note`
 
 Notes can be added exactly like activities, either on one line:
@@ -410,7 +428,7 @@ Location added: "Atlantis"
 
 ```bash
 $ friends add nickname "Grace Hopper" "The Admiral"
-Nickname added: "Grace Hopper (a.k.a. The Admiral)
+Nickname added: "Grace Hopper (a.k.a. The Admiral)"
 $ friends add nickname "Grace Hopper" "Amazing Grace"
 Nickname added: "Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace)"
 ```
@@ -419,32 +437,11 @@ Nickname added: "Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace)"
 
 ```bash
 $ friends add alias "New York City" "NYC"
-Alias added: "New York City (a.k.a. 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:
-
-```bash
-$ friends add activity Took a plane to Paris
-Activity added: "2020-01-04: Took a plane to Paris"
-Default location set to: "Paris"
-$ friends add activity Ate lunch at a charming café
-Activity added: "2020-01-04: Ate lunch at a charming café"
-$ friends add activity Left the city to go to Chamonix
-Activity added: "2020-01-04: Left the city to go to Chamonix"
-Default location set to: "Chamonix"
-```
-
-```bash
-$ friends list activities --in Paris
-2019-01-04: Ate lunch at a charming café
-2019-01-04: Took a plane to Paris
-```
-
 #### `clean`
 
 Reads and re-writes the `friends.md` file:
@@ -711,39 +708,42 @@ $ friends list notes --tagged school --with Marie
 2015-06-06: Marie Curie just got accepted into a PhD program in Paris. @school
 ```
 
-#### `list favorite friends`
+#### `list friends`
 
-Lists your "favorite" friends (by total number of activities):
+Lists all of your friends in alphabetical order:
 
 ```bash
-$ friends list favorite friends
-Your favorite friends:
-1. George Washington Carver (2 activities)
-2. Grace Hopper             (1)
-3. Marie Curie              (0)
+$ friends list friends
+George Washington Carver
+Grace Hopper
+Marie Curie
 ```
 
-#### `list favorite locations`
-
-Lists your "favorite" locations (by total number of activities):
+Or you can choose to sort by number of activities:
 
 ```bash
-$ friends list favorite locations
-Your favorite locations:
-1. Atlantis (2 activities)
-2. Paris    (1)
-3. London   (0)
+$ friends list friends --sort n-activities
+2 activities: George Washington Carver
+2 activities: Grace Hopper
+1 activity: Marie Curie
 ```
 
-#### `list friends`
+Or by most recent activity:
 
-Lists all of your friends in alphabetical order:
+```bash
+$ friends list friends --sort recency               
+7 days ago: Grace Hopper
+308 days ago: George Washington Carver
+312 days ago: Marie Curie
+```
+
+And you can reverse the sorting at any time:
 
 ```bash
-$ friends list friends
-George Washington Carver
-Grace Hopper
-Marie Curie
+$ friends list friends --sort n-activities --reverse
+1 activity: Marie Curie
+2 activities: Grace Hopper
+2 activities: George Washington Carver
 ```
 
 You can also include friend nicknames, locations, and tags:
@@ -836,6 +836,42 @@ New York City
 Paris
 ```
 
+Or you can choose to sort by number of activities:
+
+```bash
+$ friends list locations --sort n-activities
+1 activity: New York City
+1 activity: Paris
+0 activities: Atlantis
+```
+
+Or by most recent activity:
+
+```bash
+$ friends list locations --sort recency  
+N/A days ago: Atlantis
+7 days ago: New York City
+312 days ago: Paris
+```
+
+And you can reverse the sorting at any time:
+
+```bash
+$ friends list friends --sort n-activities --reverse
+0 activities: Atlantis
+1 activity: Paris
+1 activity: New York City
+```
+
+You can also include location aliases:
+
+```bash
+$ friends list locations --verbose
+Atlantis
+New York City (a.k.a. NYC)
+Paris
+```
+
 #### Advanced searching
 
 Since `friends` is a command-line program, we can easily support

data/bin/friends

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-if ENV["TRAVIS"] == "true" && ENV["CODE_COVERAGE"] == "true"
+if ENV["CI"] == "true" && ENV["CODE_COVERAGE"] == "true"
   require "simplecov"
   SimpleCov.print_error_status = false
   SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter

data/lib/friends/commands/list.rb

@@ -19,11 +19,23 @@ command :list do |list|
                         negatable: false,
                         desc: "Output friend nicknames, locations, and tags"
 
+    list_friends.flag :sort,
+                      default_value: "alphabetical",
+                      arg_name: "ATTRIBUTE",
+                      must_match: %w[alphabetical n-activities recency],
+                      desc: "Sort output by one of: alphabetical, n-activities, recency"
+
+    list_friends.switch :reverse,
+                        negatable: false,
+                        desc: "Reverse the sort order"
+
     list_friends.action do |_, options|
       @introvert.list_friends(
         location_name: options[:in],
         tagged: options[:tagged],
-        verbose: options[:verbose]
+        verbose: options[:verbose],
+        sort: options[:sort],
+        reverse: options[:reverse]
       )
     end
   end
@@ -76,8 +88,23 @@ command :list do |list|
     list_locations.switch [:verbose],
                           negatable: false,
                           desc: "Output location aliases"
+
+    list_locations.flag :sort,
+                        default_value: "alphabetical",
+                        arg_name: "ATTRIBUTE",
+                        must_match: %w[alphabetical n-activities recency],
+                        desc: "Sort output by one of: alphabetical, n-activities, recency"
+
+    list_locations.switch :reverse,
+                          negatable: false,
+                          desc: "Reverse the sort order"
+
     list_locations.action do |_, options|
-      @introvert.list_locations(verbose: options[:verbose])
+      @introvert.list_locations(
+        verbose: options[:verbose],
+        sort: options[:sort],
+        reverse: options[:reverse]
+      )
     end
   end
 
@@ -92,21 +119,4 @@ command :list do |list|
       @introvert.list_tags(from: options[:from])
     end
   end
-
-  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.action do
-        @introvert.list_favorite_friends
-      end
-    end
-
-    list_favorite.desc "List favorite locations"
-    list_favorite.command :locations do |list_favorite_locations|
-      list_favorite_locations.action do
-        @introvert.list_favorite_locations
-      end
-    end
-  end
 end

data/lib/friends/introvert.rb

@@ -297,7 +297,11 @@ module Friends
     #   unfiltered
     # @param verbose [Boolean] true iff we should output friend names with
     #   nicknames, locations, and tags; false for names only
-    def list_friends(location_name:, tagged:, verbose:)
+    # @param sort [String] one of:
+    #   ["alphabetical", "n-activities", "recency"]
+    # @param reverse [Boolean] true iff we should reverse the sorted order of
+    #   our output
+    def list_friends(location_name:, tagged:, verbose:, sort:, reverse:)
       fs = @friends
 
       # Filter by location if a name is passed.
@@ -313,18 +317,11 @@ module Friends
         end
       end
 
-      (verbose ? fs.map(&:to_s) : fs.map(&:name)).each { |line| @output << line }
+      list_things(type: :friend, arr: fs, verbose: verbose, sort: sort, reverse: reverse)
     end
 
-    # List your favorite friends.
-    def list_favorite_friends
-      list_favorite_things(:friend)
-    end
-
-    # List your favorite friends.
-    def list_favorite_locations
-      list_favorite_things(:location)
-    end
+    NA_STR = "N/A"
+    private_constant :NA_STR
 
     # See `list_events` for all of the parameters we can pass.
     def list_activities(**args)
@@ -337,8 +334,14 @@ module Friends
     end
 
     # List all location names in the friends file.
-    def list_locations(verbose:)
-      (verbose ? @locations.map(&:to_s) : @locations.map(&:name)).each { |line| @output << line }
+    # @param verbose [Boolean] true iff we should output location names with
+    #   aliases; false for names only
+    # @param sort [String] one of:
+    #   ["alphabetical", "n-activities", "recency"]
+    # @param reverse [Boolean] true iff we should reverse the sorted order of
+    #   our output
+    def list_locations(verbose:, sort:, reverse:)
+      list_things(type: :location, verbose: verbose, sort: sort, reverse: reverse)
     end
 
     # @param from [Array] containing any of: ["activities", "friends", "notes"]
@@ -537,6 +540,49 @@ module Friends
 
     private
 
+    # List either friends or activities
+    # @param arr [Array<Friend|Activity>] a filtered list to print
+    # @param verbose [Boolean] true iff we should output names with
+    #   aliases/nicknames/etc.; false for names only
+    # @param sort [String] one of:
+    #   ["alphabetical", "n-activities", "recency"]
+    # @param reverse [Boolean] true iff we should reverse the sorted order of
+    #   our output
+    def list_things(type:, arr: instance_variable_get("@#{type}s"), verbose:, sort:, reverse:)
+      case sort
+      when "alphabetical"
+        arr = stable_sort(arr) # In case the input file was not already sorted.
+      when "n-activities"
+        arr = stable_sort_by(arr) { |thing| -thing.n_activities }
+      when "recency"
+        today = Date.today
+
+        most_recent_activity_by_thing = @activities.each_with_object({}) do |activity, output|
+          activity.send("#{type}_names").each do |thing_name|
+            output[thing_name] = (today - activity.date).to_i unless output.key?(thing_name)
+          end
+        end
+
+        arr = stable_sort_by(arr) do |thing|
+          most_recent_activity_by_thing[thing.name] || -Float::INFINITY
+        end
+      end
+
+      (reverse ? arr.reverse : arr).each do |thing|
+        case sort
+        when "n-activities"
+          prefix = "#{Paint[thing.n_activities, :bold, :red]} "\
+                   "activit#{thing.n_activities == 1 ? 'y' : 'ies'}: "
+        when "recency"
+          n_days = most_recent_activity_by_thing[thing.name] || NA_STR
+          prefix = "#{Paint[n_days, :bold, :red]} "\
+                   "day#{'s' unless n_days == 1} ago: "
+        end
+
+        @output << "#{prefix}#{verbose ? thing.to_s : thing.name}"
+      end
+    end
+
     # @param from [Array] containing any of: ["activities", "friends", "notes"]
     #   If not empty, limits the tags returned to only those from either
     #   activities, notes, or friends.
@@ -586,6 +632,13 @@ module Friends
       arr.sort_by.with_index { |x, idx| [x, idx] }
     end
 
+    # @param arr [Array] an unsorted array
+    # @param &block [block] used to return a value for each element's sort position
+    # @return [Array] a stably-sorted array
+    def stable_sort_by(arr)
+      arr.sort_by.with_index { |x, idx| [yield(x), idx] }
+    end
+
     # Filter activities by friend, location and tag
     # @param events [Array<Event>] the base events to list, either @activities or @notes
     # @param with [Array<String>] the names of friends to filter by, or empty for
@@ -628,49 +681,6 @@ module Friends
       events
     end
 
-    # @param type [Symbol] one of: [:friend, :location]
-    # @raise [ArgumentError] if type is not one of: [:friend, :location]
-    def list_favorite_things(type)
-      unless [:friend, :location].include? type
-        raise ArgumentError, "Type must be either :friend or :location"
-      end
-
-      # Sort the results, with the most favorite thing first.
-      results = instance_variable_get("@#{type}s").sort_by do |thing|
-        -thing.n_activities
-      end
-
-      @output << "Your favorite #{type}s:"
-
-      max_str_size = results.map(&:name).map(&:size).max
-
-      grouped_results = results.group_by(&:n_activities)
-
-      rank = 1
-      first = true
-      data = grouped_results.each.with_object([]) do |(n_activities, things), arr|
-        things.each do |thing|
-          name = thing.name.ljust(max_str_size)
-          if first
-            label = n_activities == 1 ? " activity" : " activities"
-            first = false
-          end
-          str = "#{name} (#{n_activities}#{label})"
-
-          arr << [rank, str]
-        end
-        rank += things.size
-      end
-
-      # We need to use `data.last.first` instead of `rank` to determine the size
-      # of the numbering prefix because `rank` will simply be the size of all
-      # elements, which may be too large if the last element in the list is a tie.
-      num_str_size = data.last.first.to_s.size + 1 unless data.empty?
-      data.each do |ranking, str|
-        @output << "#{"#{ranking}.".ljust(num_str_size)} #{str}"
-      end
-    end
-
     # Sets the n_activities field on each thing.
     # @param type [Symbol] one of: [:friend, :location]
     # @raise [ArgumentError] if `type` is not one of: [:friend, :location]

data/lib/friends/version.rb

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

data/test/commands/list/friends_spec.rb

@@ -26,26 +26,26 @@ clean_describe "list friends" do
     # only reads from the (usually-sorted) file.
     let(:content) { SCRAMBLED_CONTENT }
 
-    it "lists friends in file order" do
+    it "lists friends in alphabetical order" do
       stdout_only <<-OUTPUT
 George Washington Carver
-Marie Curie
 Grace Hopper
-Stanislav Petrov
+Marie Curie
 Norman Borlaug
+Stanislav Petrov
       OUTPUT
     end
 
     describe "--verbose" do
       subject { run_cmd("list friends --verbose") }
 
-      it "lists friends in file order with details" do
+      it "lists friends in sorted order with details" do
         stdout_only <<-OUTPUT
 George Washington Carver
-Marie Curie [Atlantis] @science
 Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] @navy @science
-Stanislav Petrov (a.k.a. Stan) @doesnt-trust-computers @doesnt-trust-computers:military-uses
+Marie Curie [Atlantis] @science
 Norman Borlaug (a.k.a. Norm) @science @science:outdoors @science:outdoors:agronomy
+Stanislav Petrov (a.k.a. Stan) @doesnt-trust-computers @doesnt-trust-computers:military-uses
         OUTPUT
       end
     end
@@ -73,8 +73,8 @@ Norman Borlaug (a.k.a. Norm) @science @science:outdoors @science:outdoors:agrono
 
       it "matches tag case-insensitively" do
         stdout_only <<-OUTPUT
-Marie Curie
 Grace Hopper
+Marie Curie
 Norman Borlaug
         OUTPUT
       end
@@ -114,5 +114,99 @@ Stanislav Petrov
         end
       end
     end
+
+    describe "--sort" do
+      subject { run_cmd("list friends --sort #{sort} #{reverse}") }
+
+      let(:reverse) { nil }
+
+      # Use scrambled content to differentiate between output that is sorted and output that
+      # only reads from the (usually-sorted) file.
+      let(:content) { SCRAMBLED_CONTENT }
+
+      describe "alphabetical" do
+        let(:sort) { "alphabetical" }
+
+        it "lists friends in sorted order" do
+          stdout_only <<-OUTPUT
+George Washington Carver
+Grace Hopper
+Marie Curie
+Norman Borlaug
+Stanislav Petrov
+          OUTPUT
+        end
+
+        describe "--reverse" do
+          let(:reverse) { "--reverse" }
+
+          it "lists friends in reverse order" do
+            stdout_only <<-OUTPUT
+Stanislav Petrov
+Norman Borlaug
+Marie Curie
+Grace Hopper
+George Washington Carver
+            OUTPUT
+          end
+        end
+      end
+
+      describe "n-activities" do
+        let(:sort) { "n-activities" }
+
+        it "lists friends in sorted order" do
+          stdout_only <<-OUTPUT
+3 activities: George Washington Carver
+2 activities: Grace Hopper
+1 activity: Marie Curie
+1 activity: Norman Borlaug
+0 activities: Stanislav Petrov
+          OUTPUT
+        end
+
+        describe "--reverse" do
+          let(:reverse) { "--reverse" }
+
+          it "lists friends in reverse order" do
+            stdout_only <<-OUTPUT
+0 activities: Stanislav Petrov
+1 activity: Norman Borlaug
+1 activity: Marie Curie
+2 activities: Grace Hopper
+3 activities: George Washington Carver
+            OUTPUT
+          end
+        end
+      end
+
+      describe "recency" do
+        let(:sort) { "recency" }
+
+        it "lists friends in sorted order" do
+          stdout_only_regexes [
+            "N/A days ago: Stanislav Petrov",
+            /\d+ days ago: George Washington Carver/,
+            /\d+ days ago: Norman Borlaug/,
+            /\d+ days ago: Grace Hopper/,
+            /\d+ days ago: Marie Curie/
+          ]
+        end
+
+        describe "--reverse" do
+          let(:reverse) { "--reverse" }
+
+          it "lists friends in reverse order" do
+            stdout_only_regexes [
+              /\d+ days ago: Marie Curie/,
+              /\d+ days ago: Grace Hopper/,
+              /\d+ days ago: Norman Borlaug/,
+              /\d+ days ago: George Washington Carver/,
+              "N/A days ago: Stanislav Petrov"
+            ]
+          end
+        end
+      end
+    end
   end
 end

data/test/commands/list/locations_spec.rb

@@ -26,24 +26,112 @@ clean_describe "list locations" do
     # only reads from the (usually-sorted) file.
     let(:content) { SCRAMBLED_CONTENT }
 
-    it "lists locations in file order" do
+    it "lists locations in alphabetical" do
       stdout_only <<-OUTPUT
-Paris
 Atlantis
 Martha's Vineyard
 New York City
+Paris
       OUTPUT
     end
 
+    describe "--sort" do
+      subject { run_cmd("list locations --sort #{sort} #{reverse}") }
+
+      let(:reverse) { nil }
+
+      # Use scrambled content to differentiate between output that is sorted and output that
+      # only reads from the (usually-sorted) file.
+      let(:content) { SCRAMBLED_CONTENT }
+
+      describe "alphabetical" do
+        let(:sort) { "alphabetical" }
+
+        it "lists locations in sorted order" do
+          stdout_only <<-OUTPUT
+Atlantis
+Martha's Vineyard
+New York City
+Paris
+          OUTPUT
+        end
+
+        describe "--reverse" do
+          let(:reverse) { "--reverse" }
+
+          it "lists locations in reverse order" do
+            stdout_only <<-OUTPUT
+Paris
+New York City
+Martha's Vineyard
+Atlantis
+            OUTPUT
+          end
+        end
+      end
+
+      describe "n-activities" do
+        let(:sort) { "n-activities" }
+
+        it "lists locations in sorted order" do
+          stdout_only <<-OUTPUT
+1 activity: Paris
+1 activity: Atlantis
+1 activity: Martha's Vineyard
+0 activities: New York City
+          OUTPUT
+        end
+
+        describe "--reverse" do
+          let(:reverse) { "--reverse" }
+
+          it "lists locations in reverse order" do
+            stdout_only <<-OUTPUT
+0 activities: New York City
+1 activity: Martha's Vineyard
+1 activity: Atlantis
+1 activity: Paris
+            OUTPUT
+          end
+        end
+      end
+
+      describe "recency" do
+        let(:sort) { "recency" }
+
+        it "lists locations in sorted order" do
+          stdout_only_regexes [
+            "N/A days ago: New York City",
+            /\d+ days ago: Atlantis/,
+            /\d+ days ago: Martha's Vineyard/,
+            /\d+ days ago: Paris/
+          ]
+        end
+
+        describe "--reverse" do
+          let(:reverse) { "--reverse" }
+
+          it "lists locations in reverse order" do
+            stdout_only_regexes [
+              /\d+ days ago: Paris/,
+              /\d+ days ago: Martha's Vineyard/,
+              /\d+ days ago: Atlantis/,
+              "N/A days ago: New York City"
+            ]
+          end
+        end
+      end
+    end
+
     describe "--verbose" do
       subject { run_cmd("list locations --verbose") }
 
-      it "lists locations in file order with details" do
+      it "lists locations in alphabetical order with details" do
         stdout_only <<-OUTPUT
-Paris
 Atlantis
 Martha's Vineyard
 New York City (a.k.a. NYC a.k.a. NY)
+Paris
         OUTPUT
       end
     end

data/test/default_file_spec.rb

@@ -4,7 +4,7 @@ require "./test/helper"
 
 # Since this touches the ~/friends.md file instead of a temp
 # one, we only want to run it on our CI servers.
-if ENV["TRAVIS"] == "true"
+if ENV["CI"] == "true"
   describe "default filename behavior" do
     let(:filename) { File.expand_path("~/friends.md") }
 

data/test/helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-if ENV["TRAVIS"] == "true" && ENV["CODE_COVERAGE"] == "true"
+if ENV["CI"] == "true" && ENV["CODE_COVERAGE"] == "true"
   require "simplecov"
   require "codecov"
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
@@ -121,6 +121,17 @@ def stderr_only(expected)
   value(subject[:status]).must_be :>, 0
 end
 
+def stdout_only_regexes(regexes)
+  puts subject[:stderr] unless subject[:stderr] == ""
+  lines = subject[:stdout].split("\n")
+  regexes.each_with_index do |regex, index|
+    value(lines[index]).must_match regex
+  end
+  assert_nil(lines[regexes.size])
+  value(subject[:stderr]).must_equal ""
+  value(subject[:status]).must_equal 0
+end
+
 def file_equals(expected)
   subject
   value(File.read(filename)).must_equal expected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.54'
+  version: '0.55'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -120,10 +120,10 @@ files:
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -174,8 +174,6 @@ files:
 - test/commands/graph_spec.rb
 - test/commands/help_spec.rb
 - test/commands/list/activities_spec.rb
-- test/commands/list/favorite/friends_spec.rb
-- test/commands/list/favorite/locations_spec.rb
 - test/commands/list/friends_spec.rb
 - test/commands/list/locations_spec.rb
 - test/commands/list/notes_spec.rb
@@ -232,8 +230,6 @@ test_files:
 - test/commands/graph_spec.rb
 - test/commands/help_spec.rb
 - test/commands/list/activities_spec.rb
-- test/commands/list/favorite/friends_spec.rb
-- test/commands/list/favorite/locations_spec.rb
 - test/commands/list/friends_spec.rb
 - test/commands/list/locations_spec.rb
 - test/commands/list/notes_spec.rb

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6 # 2.7 is tested below
-gemfile: Gemfile.old # The latest Ruby version uses Gemfile below
-script:
-  - bundle exec rake test
-matrix:
-  include:
-    - rvm: 2.7
-      gemfile: Gemfile
-      script:
-        - bundle exec rake test
-        - bundle exec rubocop
-      env:
-        - CODE_COVERAGE=true
-branches:
-  only:
-    - main # Always run on the main branch
-notifications:
-  email: false

data/test/commands/list/favorite/friends_spec.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require "./test/helper"
-
-clean_describe "list favorite friends" do
-  subject { run_cmd("list favorite friends") }
-
-  describe "when file does not exist" do
-    let(:content) { nil }
-
-    it "prints a no-data message" do
-      stdout_only "Your favorite friends:"
-    end
-  end
-
-  describe "when file is empty" do
-    let(:content) { "" }
-
-    it "prints a no-data message" do
-      stdout_only "Your favorite friends:"
-    end
-  end
-
-  describe "when file has content" do
-    let(:content) do
-      <<-FILE
-### Activities:
-- 2017-01-01: Did some math with **Grace Hopper**.
-- 2015-11-01: **Grace Hopper** and I went to _Martha's Vineyard_. George had to cancel at the last minute.
-- 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
-FILE
-    end
-
-    it "lists friends in order of decreasing activity" do
-      stdout_only <<-OUTPUT
-Your favorite friends:
-1. Grace Hopper             (3 activities)
-2. George Washington Carver (2)
-3. Marie Curie              (1)
-      OUTPUT
-    end
-
-    describe "when friends are tied for the same number of activities" do
-      let(:content) do
-        <<-FILE
-### Activities:
-- 2017-01-01: Did something with **Friend A**.
-- 2017-01-01: Did something with **Friend A**.
-- 2017-01-01: Did something with **Friend B**.
-- 2017-01-01: Did something with **Friend B**.
-- 2017-01-01: Did something with **Friend C**.
-- 2017-01-01: Did something with **Friend D**.
-- 2017-01-01: Did something with **Friend E**.
-- 2017-01-01: Did something with **Friend F**.
-- 2017-01-01: Did something with **Friend G**.
-- 2017-01-01: Did something with **Friend H**.
-- 2017-01-01: Did something with **Friend I**.
-- 2017-01-01: Did something with **Friend J**.
-
-### Friends:
-- Friend A
-- Friend B
-- Friend C
-- Friend D
-- Friend E
-- Friend F
-- Friend G
-- Friend H
-- Friend I
-- Friend J
-FILE
-      end
-
-      it "uses tied ranks" do
-        value(subject[:stderr]).must_equal ""
-        value(subject[:status]).must_equal 0
-
-        lines = subject[:stdout].split("\n")
-        value(lines[1]).must_match(/1\. Friend (A|B)/)
-        value(lines[2]).must_match(/1\. Friend (A|B)/)
-        value(lines[3]).must_include "3. Friend"
-      end
-
-      it "only uses the word 'activities' for the first item, even when a tie" do
-        value(subject[:stderr]).must_equal ""
-        value(subject[:status]).must_equal 0
-
-        lines = subject[:stdout].split("\n")
-        value(lines[1]).must_include "activities"
-        value(lines[2]).wont_include "activities"
-      end
-
-      it "indents based on the highest rank number, not the number of friends" do
-        value(subject[:stderr]).must_equal ""
-        value(subject[:status]).must_equal 0
-
-        # Since there are 10 friends, a naive implementation would pad our output
-        # assuming the (numerically) highest rank is "10." but since the highest
-        # rank is a tie, we never display a double-digit rank, so we don't need to
-        # pad our output for double digits.
-        lines = subject[:stdout].split("\n")
-        value(lines.last).must_include "3. Friend"
-      end
-    end
-  end
-end

data/test/commands/list/favorite/locations_spec.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-require "./test/helper"
-
-clean_describe "list favorite locations" do
-  subject { run_cmd("list favorite locations") }
-
-  describe "when file does not exist" do
-    let(:content) { nil }
-
-    it "prints a no-data message" do
-      stdout_only "Your favorite locations:"
-    end
-  end
-
-  describe "when file is empty" do
-    let(:content) { "" }
-
-    it "prints a no-data message" do
-      stdout_only "Your favorite locations:"
-    end
-  end
-
-  describe "when file has content" do
-    let(:content) do
-      <<-FILE
-### Activities:
-- 2017-01-01: **Grace Hopper** and I went to _Martha's Vineyard_ for breakfast.
-- 2015-11-01: **Grace Hopper** and I went to _Martha's Vineyard_. George had to cancel at the last minute.
-- 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
-
-### Locations:
-- Atlantis
-- Martha's Vineyard
-- Paris
-FILE
-    end
-
-    it "lists locations in order of decreasing activity" do
-      stdout_only <<-OUTPUT
-Your favorite locations:
-1. Martha's Vineyard (2 activities)
-2. Paris             (1)
-3. Atlantis          (0)
-      OUTPUT
-    end
-
-    describe "when locations are tied for the same number of activities" do
-      let(:content) do
-        <<-FILE
-### Activities:
-- 2017-01-01: Did something in _Location A_.
-- 2017-01-01: Did something in _Location A_.
-- 2017-01-01: Did something in _Location B_.
-- 2017-01-01: Did something in _Location B_.
-- 2017-01-01: Did something in _Location C_.
-- 2017-01-01: Did something in _Location D_.
-- 2017-01-01: Did something in _Location E_.
-- 2017-01-01: Did something in _Location F_.
-- 2017-01-01: Did something in _Location G_.
-- 2017-01-01: Did something in _Location H_.
-- 2017-01-01: Did something in _Location I_.
-- 2017-01-01: Did something in _Location J_.
-
-### Locations:
-- Location A
-- Location B
-- Location C
-- Location D
-- Location E
-- Location F
-- Location G
-- Location H
-- Location I
-- Location J
-FILE
-      end
-
-      it "uses tied ranks" do
-        value(subject[:stderr]).must_equal ""
-        value(subject[:status]).must_equal 0
-
-        lines = subject[:stdout].split("\n")
-        value(lines[1]).must_match(/1\. Location (A|B)/)
-        value(lines[2]).must_match(/1\. Location (A|B)/)
-        value(lines[3]).must_include "3. Location"
-      end
-
-      it "only uses the word 'activities' for the first item, even when a tie" do
-        value(subject[:stderr]).must_equal ""
-        value(subject[:status]).must_equal 0
-
-        lines = subject[:stdout].split("\n")
-        value(lines[1]).must_include "activities"
-        value(lines[2]).wont_include "activities"
-      end
-
-      it "indents based on the highest rank number, not the number of locations" do
-        value(subject[:stderr]).must_equal ""
-        value(subject[:status]).must_equal 0
-
-        # Since there are 10 friends, a naive implementation would pad our output
-        # assuming the (numerically) highest rank is "10." but since the highest
-        # rank is a tie, we never display a double-digit rank, so we don't need to
-        # pad our output for double digits.
-        lines = subject[:stdout].split("\n")
-        value(lines.last).must_include "3. Location"
-      end
-    end
-
-    describe "when implied locations are set" do
-      let(:content) do
-        <<-FILE
-### Activities:
-- 2015-01-30: Went to a museum with **George Washington Carver**.
-- 2015-01-29: Moved to _Paris_.
-- 2015-01-01: Got lunch with **Grace Hopper** and **George Washington Carver**. @food
-- 2014-12-31: Celebrated the new year in _Paris_ with **Marie Curie**. @partying @food
-- 2014-12-30: Went to _Atlantis_.
-- 2014-12-29: Talked to **George Washington Carver** on the phone for an hour.
-
-### Friends:
-- George Washington Carver
-- Marie Curie [Atlantis] @science
-- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] @navy @science
-
-### Locations:
-- Atlantis
-- Paris
-        FILE
-      end
-
-      it "lists locations in order of decreasing activity" do
-        stdout_only <<-OUTPUT
-Your favorite locations:
-1. Paris    (3 activities)
-2. Atlantis (2)
-        OUTPUT
-      end
-    end
-  end
-end