friends 0.34 → 0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8288b02c441d46ce2481d4a39f8ea457519a6e7
-  data.tar.gz: 551632c785ec6d2447adf65d56ab4fa0aac16a49
+  metadata.gz: 850118ba419db4de89e23cd279ea57d0e9c7305b
+  data.tar.gz: a4440dc2489f1756eaaa22ff395909d85abbf471
 SHA512:
-  metadata.gz: 9fc27186b237b3a244d88e5c85cc019bfce8ae51a1b74becae9c103d33fa777429c247ae3070b3da288104299856475ab1e67e376a5b4bdb719f62f9550f6b8d
-  data.tar.gz: 3206d0662d64b42f8c8ce5e2fb5bc8ad9a95dda27b4d07541798fc27a177f0d7d5c343bfbf540357f891a6bf954e2b09acf38aa8a09d71988b84d480a92d8944
+  metadata.gz: 643172f6f2be216b21bbc47e43fb17ee712c3d2e9ba092cff0cec4657e29391739712c9d3bb6b6d6811fabf8a77626c91a43cba7bb7e86a1e33b3d6326183ffb
+  data.tar.gz: a64b0fc7a57e929af581457a3eeb2be21184dd60da9056ad91aa72068274fa602d13613f1faae2b86125bfd8c1e43d0d536bd3d35a1232873b32b76d215fd631

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+`friends` is a volunteer project. If you find it useful, please consider
+making a small donation to show me you appreciate its continued development.
+
+[![Donate via OpenCollective](https://opencollective.com/friends/contributors/badge.svg)](https://opencollective.com/friends)
+[![Support via Patreon](https://img.shields.io/badge/support-Patreon-green.svg)](https://www.patreon.com/jacobevelyn)
+[![Donate via Liberapay](https://img.shields.io/badge/donate-Liberapay-green.svg)](https://liberapay.com/jacobevelyn/donate)
+[![Donate via PayPal](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=jacobevelyn%40gmail%2ecom&lc=US&item_name=Development%20of%20JacobEvelyn%2ffriends%20%28GitHub%20repository%29&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)
+[![Flattr this](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=jacobevelyn&url=https://github.com/JacobEvelyn/friends&title=friends&tags=github&category=software)
+[![Donate bitcoin](https://img.shields.io/badge/donate-Bitcoin-green.svg)](https://nrobinson2000.github.io/donate-bitcoin?address=1CFu6gWpmS89EnitPPdYssZhFMRWx5qhW4&amount=10&name=support-friends-development)
+
+## [v0.35](https://github.com/JacobEvelyn/friends/tree/v0.35) (2018-01-14)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.34...v0.35)
+
+**Implemented enhancements:**
+
+- Add notes [\#175](https://github.com/JacobEvelyn/friends/issues/175)
+
+**Merged pull requests:**
+
+- Add ability to add notes [\#187](https://github.com/JacobEvelyn/friends/pull/187) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.34](https://github.com/JacobEvelyn/friends/tree/v0.34) (2018-01-10)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.33...v0.34)
 

data/README.md

@@ -10,11 +10,11 @@
 making a small donation to show me you appreciate its continued development.
 
 [![Donate via OpenCollective](https://opencollective.com/friends/contributors/badge.svg)](https://opencollective.com/friends)
-[![Support via Patreon](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/jacobevelyn)
-[![Donate via Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/jacobevelyn/donate)
-[![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=jacobevelyn%40gmail%2ecom&lc=US&item_name=Development%20of%20JacobEvelyn%2ffriends%20%28GitHub%20repository%29&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)
+[![Support via Patreon](https://img.shields.io/badge/support-Patreon-green.svg)](https://www.patreon.com/jacobevelyn)
+[![Donate via Liberapay](https://img.shields.io/badge/donate-Liberapay-green.svg)](https://liberapay.com/jacobevelyn/donate)
+[![Donate via PayPal](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=jacobevelyn%40gmail%2ecom&lc=US&item_name=Development%20of%20JacobEvelyn%2ffriends%20%28GitHub%20repository%29&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)
 [![Flattr this](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=jacobevelyn&url=https://github.com/JacobEvelyn/friends&title=friends&tags=github&category=software)
-[![Donate bitcoin](https://img.shields.io/badge/donate-bitcoin-green.svg)](https://nrobinson2000.github.io/donate-bitcoin?address=1CFu6gWpmS89EnitPPdYssZhFMRWx5qhW4&amount=10&name=support-friends-development)
+[![Donate bitcoin](https://img.shields.io/badge/donate-Bitcoin-green.svg)](https://nrobinson2000.github.io/donate-bitcoin?address=1CFu6gWpmS89EnitPPdYssZhFMRWx5qhW4&amount=10&name=support-friends-development)
 
 # `friends`
 
@@ -37,6 +37,7 @@ lots of help), and give feedback!**
   * [Command reference](#command-reference)
     * `add`
       * [`add activity`](#add-activity)
+      * [`add note`](#add-note)
       * [`add friend`](#add-friend)
       * [`add tag`](#add-tag)
       * [`add location`](#add-location)
@@ -46,6 +47,7 @@ lots of help), and give feedback!**
     * [`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)
@@ -116,6 +118,8 @@ Easy, huh?
   `Marie's Diner`)
 * **Tags**: A way to categorize your _activities_ with tags of your
   choosing. (Examples: `@exercise`, `@school`)
+* **Notes**: Any additional information you want to record about a _friend_
+  or _location_. (Example: `John and Jane got engaged.`)
 
 The `friends.md` Markdown file that stores all of your data contains:
 
@@ -123,31 +127,36 @@ The `friends.md` Markdown file that stores all of your data contains:
 
 ```markdown
 ### Locations:
-
-* Atlantis
-* Marie's Diner
-* Paris
+- Atlantis
+- Marie's Diner
+- Paris
 ```
 
 * an alphabetical list of all friends and their nicknames and locations:
 
 ```markdown
 ### Friends:
-
-* George Washington Carver
-* Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris]
-* Marie Curie [Atlantis]
+- George Washington Carver
+- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris]
+- Marie Curie [Atlantis]
 ```
 
-* and an ordered list of all activities:
+* an ordered list of all activities:
 
 ```markdown
 ### Activities:
+- 2018-11-01: **Grace Hopper** and I went to _Marie's Diner_. George had to cancel at the last minute.
+- 2018-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**.
+- 2017-12-31: Celebrated the new year in _Paris_ with **Marie Curie**.
+- 2017-11-15: Talked to **George Washington Carver** on the phone for an hour.
+```
 
-* 2018-11-01: **Grace Hopper** and I went to _Marie's Diner_. George had to cancel at the last minute.
-* 2018-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**.
-* 2017-12-31: Celebrated the new year in _Paris_ with **Marie Curie**.
-* 2017-11-15: Talked to **George Washington Carver** on the phone for an hour.
+* and an ordered list of all notes:
+
+```markdown
+### Notes:
+- 2018-06-15: **Grace Hopper** found out she's getting a big Naval Academy building named after her. @navy
+- 2017-06-06: **Marie Curie** just got accepted into a PhD program in _Paris_. @school
 ```
 
 See the example
@@ -163,7 +172,7 @@ These flags are:
 
 * `--colorless`: Disable output colorization and other effects.
 * `--debug`: Debug error messages with a full backtrace.
-* `--filename`: Set the location of the friends file to use (default: ./friends.md).
+* `--filename`: Set the location of the friends file to use (default: `./friends.md`).
 
 ```bash
 $ friends --filename ./test/tmp/friends.md clean
@@ -304,6 +313,24 @@ $ friends add activity "2018-11-01: Grace and I went to \Marie's Diner. \George
 Activity added: "2018-11-01: Grace Hopper and I went to Marie's Diner. George had to cancel at the last minute."
 ```
 
+#### `add note`
+
+Notes can be added exactly like activities, either on one line:
+
+```bash
+$ friends add note Yesterday: Marie got accepted into a PhD program
+Note added: "2017-12-31: Marie Curie got accepted into a PhD program"
+```
+
+Or with a prompt:
+
+```bash
+$ friends add note last Monday
+2017-03-07: <type description here>
+```
+
+And just like with `add activity`, dates, friends, locations, nicknames, and tags will all be intelligently matched.
+
 #### `add friend`
 
 ```bash
@@ -559,6 +586,16 @@ $ friends list activities --tagged food --with Grace --with George
 2018-01-04: Got lunch with Grace Hopper and George Washington Carver. @food
 ```
 
+#### `list notes`
+
+You can list notes the same way you list activities:
+
+```bash
+$ friends list notes --tagged school --with Marie
+2017-03-12: Marie Curie completed her PhD in record time. @school
+2015-06-06: Marie Curie just got accepted into a PhD program in Paris. @school
+```
+
 #### `list favorite friends`
 
 Lists your "favorite" friends (by total number of activities):
@@ -672,6 +709,25 @@ $ friends list tags --from friends
 @swanky
 ```
 
+Or only tags from notes:
+
+```bash
+$ friends list tags --from notes
+@navy
+@school
+```
+
+Or only tags from two out of three:
+
+```bash
+$ friends list tags --from activities --from friends
+@dancing
+@food
+@navy
+@school
+@swanky
+```
+
 #### `list locations`
 
 Lists all of the locations you've added, in alphabetical order::
@@ -732,7 +788,10 @@ Gives you your lifetime usage stats:
 $ friends stats
 Total activities: 4
 Total friends: 3
-Total time elapsed: 5 days
+Total locations: 3
+Total notes: 4
+Total tags: 5
+Total time elapsed: 848 days
 ```
 
 #### `suggest`
@@ -780,7 +839,7 @@ A big big thanks to all of this project's lovely
 [contributors](https://github.com/JacobEvelyn/friends/graphs/contributors)!
 
 Another way to contribute is to make a donation (see the buttons at the top
-of this `README`!
+of this `README`)!
 
 ## Code of Conduct
 

data/RELEASING.md

@@ -3,13 +3,14 @@
 These are steps for the maintainer to take to release a new version of this gem.
 
 1. On the `master` branch, update the `VERSION` constant in
-`lib/friends/version.rb`.
+   `lib/friends/version.rb`.
 2. Commit the change (`git add -A && git commit -m 'Bump to vX.X'`).
 3. Add a tag (`git tag -am "vX.X" vX.X`).
 4. `git push && git push --tags`
 5. `CHANGELOG_GITHUB_TOKEN=... github_changelog_generator`
-6. Confirm the `CHANGELOG` looks good with `git diff`
-7. `git add -A && git commit -m 'Update CHANGELOG for vX.X'`
-8. `git push`
-9. `gem build friends.gemspec && gem push *.gem && rm *.gem`
-10. Celebrate!
+6. Confirm the `CHANGELOG` looks correct with `git diff`
+7. Copy-paste the donation info from the `README` to the `CHANGELOG`.
+8. `git add -A && git commit -m 'Update CHANGELOG for vX.X'`
+9. `git push`
+10. `gem build friends.gemspec && gem push *.gem && rm *.gem`
+11. Celebrate!

data/friends.md

@@ -4,6 +4,10 @@
 - 2017-12-31: Celebrated the new year in _Paris_ with **Marie Curie**. @partying
 - 2017-11-15: Talked to **George Washington Carver** on the phone for an hour.
 
+### Notes:
+- 2018-06-15: **Grace Hopper** found out she's getting a big Naval Academy building named after her. @navy
+- 2017-06-06: **Marie Curie** just got accepted into a PhD program in _Paris_. @school
+
 ### Friends:
 - George Washington Carver
 - Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] @navy @science

data/lib/friends/activity.rb

@@ -1,302 +1,15 @@
 # frozen_string_literal: true
 
-# Activity represents an activity you've done with one or more Friends.
+# Activity represents an activity you've done, usually
+# with one or more friends.
 
-require "chronic"
-require "paint"
-require "set"
-
-require "friends/serializable"
+require "friends/event"
 
 module Friends
-  class Activity
-    extend Serializable
-
-    SERIALIZATION_PREFIX = "- ".freeze
-    DATE_PARTITION = ": ".freeze
-
-    # @return [Regexp] the regex for capturing groups in deserialization
-    def self.deserialization_regex
-      /(#{SERIALIZATION_PREFIX})?(?<str>.+)?/
-    end
-
+  class Activity < Event
     # @return [Regexp] the string of what we expected during deserialization
     def self.deserialization_expectation
       "[YYYY-MM-DD]: [Activity]"
     end
-
-    # @param str [String] the text of the activity, of one of the formats:
-    #   "<date>: <description>"
-    #   "<date>" (Program will prompt for description.)
-    #   "<description>" (The current date will be used by default.)
-    # @return [Activity] the new activity
-    def initialize(str: "")
-      # Partition lets us parse "Today" and "Today: I awoke." identically.
-      date_s, _, description = str.partition(DATE_PARTITION)
-
-      time = if date_s =~ /^\d{4}-\d{2}-\d{2}$/
-               Time.parse(date_s)
-             else
-               # If the user inputed a non YYYY-MM-DD format, asssume
-               # it is in the past.
-               past_time = Chronic.parse(date_s, context: :past)
-
-               # If there's no year, Chronic will sometimes parse the date
-               # as being the next occurrence of that date in the future.
-               # Instead, we want to subtract one year to make it the last
-               # occurrence of the date in the past.
-               # NOTE: This is a hacky workaround for the fact that
-               # Chronic's `context: :past` doesn't actually work. We should
-               # remove this when that behavior is fixed.
-               if past_time && past_time > Time.now
-                 Time.local(past_time.year - 1, past_time.month, past_time.day)
-               else
-                 past_time
-               end
-             end
-
-      if time
-        @date = time.to_date
-        @description = description
-      else
-        # If the user didn't input a date, we fall back to the current date.
-        @date = Date.today
-        @description = str # Use str in case DATE_PARTITION occurred naturally.
-      end
-    end
-
-    attr_reader :date
-    attr_accessor :description
-
-    # @return [String] the command-line display text for the activity
-    def to_s
-      date_s = Paint[date, :bold]
-      description_s = description.to_s
-      # rubocop:disable Lint/AssignmentInCondition
-      while match = description_s.match(/\*\*([^\*]+)\*\*/)
-        # rubocop:enable Lint/AssignmentInCondition
-        description_s = "#{match.pre_match}"\
-                        "#{Paint[match[1], :bold, :magenta]}"\
-                        "#{match.post_match}"
-      end
-
-      # rubocop:disable Lint/AssignmentInCondition
-      while match = description_s.match(/_([^_]+)_/)
-        # rubocop:enable Lint/AssignmentInCondition
-        description_s = "#{match.pre_match}"\
-                        "#{Paint[match[1], :bold, :yellow]}"\
-                        "#{match.post_match}"
-      end
-
-      description_s = description_s.
-                      gsub(TAG_REGEX, Paint['\0', :bold, :cyan])
-
-      "#{date_s}: #{description_s}"
-    end
-
-    # @return [String] the file serialization text for the activity
-    def serialize
-      "#{SERIALIZATION_PREFIX}#{date}: #{description}"
-    end
-
-    # Modify the description to turn inputted friend names
-    # (e.g. "Jacob" or "Jacob Evelyn") into full asterisk'd names
-    # (e.g. "**Jacob Evelyn**") and inputted location names (e.g. "Atlantis")
-    # into full underscore'd names (e.g. "_Atlantis_").
-    # @param introvert [Introvert] used to access internal data structures to
-    #   perform object matching
-    def highlight_description(introvert:)
-      highlight_locations(introvert: introvert)
-      highlight_friends(introvert: introvert)
-    end
-
-    # Updates a friend's old_name to their new_name
-    # @param [String] old_name
-    # @param [String] new_name
-    # @return [String] if name found in description
-    # @return [nil] if no change was made
-    def update_friend_name(old_name:, new_name:)
-      @description = @description.gsub(
-        Regexp.new("(?<=\\*\\*)#{old_name}(?=\\*\\*)"),
-        new_name
-      )
-    end
-
-    # Updates a location's old_name to their new_name
-    # @param [String] old_name
-    # @param [String] new_name
-    # @return [String] if name found in description
-    # @return [nil] if no change was made
-    def update_location_name(old_name:, new_name:)
-      @description = @description.gsub(
-        Regexp.new("(?<=_)#{old_name}(?=_)"),
-        new_name
-      )
-    end
-
-    # @param location [Location] the location to test
-    # @return [Boolean] true iff this activity includes the given location
-    def includes_location?(location)
-      @description.scan(/(?<=_)[^_]+(?=_)/).include? location.name
-    end
-
-    # @param friend [Friend] the friend to test
-    # @return [Boolean] true iff this activity includes the given friend
-    def includes_friend?(friend)
-      friend_names.include? friend.name
-    end
-
-    # @param tag [String] the tag to test, of the form "@tag"
-    # @return [Boolean] true iff this activity includes the given tag
-    def includes_tag?(tag)
-      tags.include? tag
-    end
-
-    # @return [Set] all tags in this activity (including the "@")
-    def tags
-      Set.new(@description.scan(TAG_REGEX))
-    end
-
-    # Find the names of all friends in this description.
-    # @return [Array] list of all friend names in the description
-    def friend_names
-      @_friend_names ||= @description.scan(/(?<=\*\*)\w[^\*]*(?=\*\*)/).uniq
-    end
-
-    # Find the names of all locations in this description.
-    # @return [Array] list of all location names in the description
-    def location_names
-      @_location_names ||= @description.scan(/(?<=_)\w[^_]*(?=_)/).uniq
-    end
-
-    private
-
-    # Modify the description to turn inputted location names (e.g. "Atlantis")
-    # into full underscore'd names (e.g. "_Atlantis_").
-    # @param introvert [Introvert] used to access internal data structures to
-    #   perform location matching
-    def highlight_locations(introvert:)
-      introvert.regex_location_map.each do |regex, location|
-        # If we find a match, replace all instances of the matching text with
-        # the location's name. We use single-underscores to indicate locations.
-        description_matches(regex: regex, replace: true, indicator: "_") do
-          location.name
-        end
-      end
-    end
-
-    # Modify the description to turn inputted friend names
-    # (e.g. "Jacob" or "Jacob Evelyn") into full asterisk'd names
-    # (e.g. "**Jacob Evelyn**")
-    # @param introvert [Introvert] used to access internal data structures to
-    #   perform friend matching
-    # NOTE: When a friend name matches more than one friend, this method chooses
-    # a friend based on a best-guess algorithm that looks at which friends do
-    # activities together and which friends are stronger than others. For
-    # more information see the comments below and the
-    # introvert#set_likelihood_score! method.
-    def highlight_friends(introvert:)
-      # Split the regex friend map into two maps: one for names with only one
-      # friend match and another for ambiguous names
-      definite_map, ambiguous_map =
-        introvert.regex_friend_map.partition { |_, arr| arr.size == 1 }
-
-      matched_friends = []
-
-      # First, we find all of the unambiguous matches, and make those
-      # substitutions.
-      definite_map.each do |regex, friend_list|
-        # If we find a match, add the friend to the matched list and replace all
-        # instances of the matching text with the friend's name.
-        description_matches(regex: regex, replace: true, indicator: "**") do
-          friend = friend_list.first # There's only one friend in the list.
-          matched_friends << friend
-          friend.name
-        end
-      end
-
-      possible_matched_friends = []
-
-      # Now, we look at regex matches that are ambiguous.
-      ambiguous_map.each do |regex, friend_list|
-        # If we find a match, add the friend to the possible-match list.
-        description_matches(regex: regex, replace: false, indicator: "**") do
-          possible_matched_friends << friend_list
-        end
-      end
-
-      # Now, we compute the likelihood of each friend in the possible-match set.
-      introvert.set_likelihood_score!(
-        matches: matched_friends,
-        possible_matches: possible_matched_friends
-      )
-
-      # Now we replace all of the ambiguous matches with our best guesses.
-      ambiguous_map.each do |regex, friend_list|
-        # If we find a match, take the most likely and replace all instances of
-        # the matching text with that friend's name.
-        description_matches(regex: regex, replace: true, indicator: "**") do
-          friend_list.sort_by do |friend|
-            [-friend.likelihood_score, -friend.n_activities]
-          end.first.name
-        end
-      end
-
-      # Lastly, we remove any backslashes, as these are used to escape friends'
-      # names that we don't want to match.
-      @description = @description.delete("\\")
-    end
-
-    # This method accepts a block, and tests a regex on the @description
-    # instance variable.
-    # - If the regex does not match, the block is not executed.
-    # - If the regex matches, the block is executed exactly once, and:
-    #   - If `replace` is true, all of the regex's matches are replaced by the
-    #     return value of the block, EXCEPT when the matched text is between a
-    #     set of double-asterisks ("**") or single-underscores ("_") indicating
-    #     it is already part of another location or friend's matched name.
-    #   - If `replace` is not true, we do not modify @description.
-    # @param regex [Regexp] the regex to test against @description
-    # @param replace [Boolean] true iff we should replace regex matches with the
-    #   yielded block's result in @description
-    def description_matches(regex:, replace:, indicator:)
-      # rubocop:disable Lint/AssignmentInCondition
-      return unless match = @description.match(regex) # Abort if no match.
-      # rubocop:enable Lint/AssignmentInCondition
-      str = yield # It's important to execute the block even if not replacing.
-      return unless replace # Only continue if we want to replace text.
-
-      position = 0 # Prevent infinite looping by tracking last match position.
-      loop do
-        # Only make a replacement if we're not between a set of "**"s or "_"s.
-        if (match.pre_match.scan("**").size % 2).zero? &&
-           (match.post_match.scan("**").size % 2).zero? &&
-           (match.pre_match.scan("_").size % 2).zero? &&
-           (match.post_match.scan("_").size % 2).zero?
-          @description = [
-            match.pre_match,
-            indicator,
-            str,
-            indicator,
-            match.post_match
-          ].join
-        else
-          # If we're between double-asterisks or single-underscores we're
-          # already part of a name, so we don't make a substitution. We update
-          # `position` to avoid infinite looping.
-          position = match.end(0)
-        end
-
-        # Exit when there are no more matches.
-        # rubocop:disable Lint/AssignmentInCondition
-        break unless match = @description.match(regex, position)
-        # rubocop:enable Lint/AssignmentInCondition
-      end
-    end
-
-    # Default sorting for an array of activities is reverse-date.
-    def <=>(other)
-      other.date <=> date
-    end
   end
 end