friends 0.35 → 0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850118ba419db4de89e23cd279ea57d0e9c7305b
-  data.tar.gz: a4440dc2489f1756eaaa22ff395909d85abbf471
+  metadata.gz: 7c26333d51f189dc3c73e8619857ef1d18ebb85f
+  data.tar.gz: 1444055713076b43e7cc0cb20b9da27af110a1f4
 SHA512:
-  metadata.gz: 643172f6f2be216b21bbc47e43fb17ee712c3d2e9ba092cff0cec4657e29391739712c9d3bb6b6d6811fabf8a77626c91a43cba7bb7e86a1e33b3d6326183ffb
-  data.tar.gz: a64b0fc7a57e929af581457a3eeb2be21184dd60da9056ad91aa72068274fa602d13613f1faae2b86125bfd8c1e43d0d536bd3d35a1232873b32b76d215fd631
+  metadata.gz: ace38cd9bb2fa074acc3f320626f90720b9e21cadc424704f042621e662ffe785875189c0d5dd08632b7c6446bb3f8789a91697a00c0539a98a7a0e56b6fc5be
+  data.tar.gz: 6910fb55ba8ab0de491e7c083c2f70674fe4df76194a6f8b3cbfc77987ab1b935776f09ef61b26b29aa1cb5e0828f21a4ba2b0144cd3f6ff92ce14562eb04e44

data/.rubocop.yml

@@ -13,6 +13,9 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/BlockNesting:
+  Enabled: false
+
 Metrics/ClassLength:
   Enabled: false
 

data/CHANGELOG.md

@@ -10,6 +10,26 @@ making a small donation to show me you appreciate its continued development.
 [![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.36](https://github.com/JacobEvelyn/friends/tree/v0.36) (2018-01-17)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.35...v0.36)
+
+**Implemented enhancements:**
+
+- Parse friends.md and generate lists of friends/locations from the activities [\#182](https://github.com/JacobEvelyn/friends/issues/182)
+
+**Fixed bugs:**
+
+- `rename friend` and `rename location` do not correctly update existing notes [\#189](https://github.com/JacobEvelyn/friends/issues/189)
+
+**Closed issues:**
+
+- Add `grep` examples to the README [\#183](https://github.com/JacobEvelyn/friends/issues/183)
+
+**Merged pull requests:**
+
+- Add ability to add new friends and locations from events [\#190](https://github.com/JacobEvelyn/friends/pull/190) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Add advanced search \(grep\) examples to README [\#188](https://github.com/JacobEvelyn/friends/pull/188) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [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)
 

data/README.md

@@ -54,6 +54,7 @@ lots of help), and give feedback!**
       * [`list friends`](#list-friends)
       * [`list tags`](#list-tags)
       * [`list locations`](#list-locations)
+      * [Advanced searching](#advanced-searching)
     * `remove`
       * [`remove tag`](#remove-tag)
       * [`remove nickname`](#remove-nickname)
@@ -313,6 +314,22 @@ $ 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."
 ```
 
+And if an activity contains friends or locations you haven't yet added, you can simply
+denote them with the signifiers found in the `friends.md` file (`**`s around friends,
+and `_`s around locations), and `friends` will automatically add the friends or locations
+that are missing:
+
+```bash
+$ friends add activity "2018-11-01: I got to meet **Oprah Winfrey** in _Chicago_ today."
+Activity added: "2018-11-01: I got to meet Oprah Winfrey in Chicago today."
+Friend added: "Oprah Winfrey"
+Location added: "Chicago"
+```
+
+This is really handy for when you have an activity involving a friend or location that
+you can't remember if you've already added. Just use the signifiers and
+they'll be added if necessary!
+
 #### `add note`
 
 Notes can be added exactly like activities, either on one line:
@@ -329,7 +346,20 @@ $ 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.
+And just like with `add activity`, dates, friends, locations, nicknames, and tags will all be
+intelligently matched. In addition, as with `add activity` you can use the `**`/`_` signifiers
+around friend and location names and they'll be added if necessary:
+
+```bash
+$ friends add note "2018-11-01: **Oprah Winfrey** grew up in _Chicago_."
+Activity added: "2018-11-01: Oprah Winfrey grew up in Chicago."
+Friend added: "Oprah Winfrey"
+Location added: "Chicago"
+```
+
+This is really handy for when you have a note involving a friend or location that
+you can't remember if you've already added. Just use the signifiers and
+they'll be added if necessary!
 
 #### `add friend`
 
@@ -371,7 +401,9 @@ File cleaned: "./friends.md"
 ```
 
 This command is useful after manual editing of the file, for re-ordering its
-contents.
+contents and adding any missing friends or locations that are found in
+activities or notes. Note that `friends clean` is automatically called after
+the editor in `friends edit` is closed.
 
 #### `edit`
 
@@ -379,16 +411,42 @@ Allows you to manually edit the file:
 
 ```bash
 $ friends edit
-Opening "./friends.md" in vim
+Opening "./friends.md" with "vim"
 ```
 
-The file is opened with the command specified by the `$EDITOR` environment
+The file is opened with the command specified by the `EDITOR` environment
 variable, falling back to `vim` if it is not set:
 
 ```bash
-$ export EDITOR=atom
+$ export EDITOR='atom --wait'
 $ friends edit
-Opening "./friends.md" in atom
+Opening "./friends.md" with "atom --wait"
+```
+
+Note that when setting your own `EDITOR` value, if you like to use
+an editor like Atom, VS Code, or Sublime Text, you should first make
+sure you have the command-line tool for your editor (`atom`, `code`,
+or `subl`) installed correctly so you can open your editor from the
+command line. Then, when setting `EDITOR`, make sure to use the
+`--wait` flag (as in the example above), which will allow `friends`
+to be able to run the `clean` command (see below).
+
+After the editor has been closed, `friends` will automatically run the
+`clean` command to re-organize the file and add any friends or locations
+you've referenced in activities or notes that have not been added to the
+file. This means that, similar to the `add activity` and `add note`
+commands, you can add lines like:
+
+```markdown
+- 2018-01-01: I just met **Oprah Winfrey** in _Chicago_!
+```
+
+And if that friend or location isn't already present it'll be added:
+
+```bash
+Friend added: "Oprah Winfrey"
+Location added: "Chicago"
+File cleaned: "./friends.md\"
 ```
 
 #### `graph`
@@ -739,6 +797,41 @@ New York City
 Paris
 ```
 
+#### Advanced searching
+
+Since `friends` is a command-line program, we can easily support
+more complex searching by piping the output of a `list` command
+through a command-line tool like `grep`.
+
+For instance, to see all of the notes containing the string `PhD`:
+
+```bash
+$ friends list notes | grep PhD
+2017-07-01: Marie Curie just got accepted into a PhD program.
+2017-06-10: John Doe is finishing his PhD.
+2013-06-10: John Doe is just starting his PhD.
+```
+
+And you can combine this with the normal filter options provided
+by `friends`, like this:
+
+```bash
+$ friends list notes --with John --since 'January 1st 2015' | grep PhD
+2017-06-10: John Doe is finishing his PhD.
+```
+
+Note that `grep` has some handy flags, like `--ignore-case`/`-i`, and
+`--color=always`, to help customize your search:
+
+```bash
+$ friends list notes --with John --since 'January 1st 2015' | grep -i PhD
+2017-06-10: John Doe is finishing his PhD.
+2016-06-01: I think John Doe is hoping to finish his phD about a year from now.
+```
+
+These `grep` flags might be slightly different depending on which version of
+`grep` you have installed.
+
 #### `remove tag`
 
 Removes a specific tag from a friend:
@@ -764,6 +857,8 @@ $ friends rename friend "Grace Hopper" "Grace Brewster Murray Hopper"
 Name changed: "Grace Brewster Murray Hopper (a.k.a. Amazing Grace)"
 ```
 
+This will update that friend's name in all notes and activities.
+
 #### `rename location`
 
 ```bash
@@ -771,6 +866,8 @@ $ friends rename location Paris "Paris, France"
 Location renamed: "Paris, France"
 ```
 
+This will update that location's name in all notes and activities.
+
 #### `set location`
 
 Sets a friend's location:

data/bin/friends

@@ -72,34 +72,30 @@ switch [:colorless],
 commands_from "friends/commands"
 
 # Before each command, clean up all arguments and create the global Introvert.
-pre do |global_options, cmd, options|
+pre do |global_options, cmd|
   # If the --colorless flag is passed, don't do any fancy painting.
   Paint.mode = 0 if global_options[:colorless]
 
   @debug_mode = global_options[:debug]
 
-  final_options = global_options.merge!(options).select do |key, _|
-    [:filename].include? key
-  end
-
   # If we're updating the friends program we don't need to read the friends file
   # but we don't skip this block entirely because we might still want to enable
-  # debug mode.
-  @introvert = Friends::Introvert.new(final_options) unless cmd.name == :update
+  # debug mode. If we're in a `friends edit` command we wait to initialize the
+  # @introvert until the command block when the system call has exited
+  # successfully.
+  unless [:update, :edit].include? cmd.name
+    @introvert = Friends::Introvert.new(
+      filename: global_options[:filename],
+      quiet: global_options[:quiet]
+    )
+  end
 
   true # Continue executing the command.
 end
 
-post do |global_options|
+post do
   # After each command, clean the file if we have modifications to make.
-  filename = @introvert.clean if @dirty
-
-  # This is a special-case piece of code that lets us print a message that
-  # includes the filename when `friends clean` is called.
-  @message = "File cleaned: \"#{filename}\"" if @clean_command
-
-  # Print the output message (if there is one) unless --quiet is passed.
-  puts @message unless @message.nil? || global_options[:quiet]
+  @introvert.clean(clean_command: @clean_command) if @dirty
 end
 
 # If an error is raised, print the message to STDERR and exit the program.

data/lib/friends/commands/add.rb

@@ -6,8 +6,7 @@ command :add do |add|
   add.arg_name "NAME"
   add.command :friend do |add_friend|
     add_friend.action do |_, _, args|
-      friend = @introvert.add_friend(name: args.join(" "))
-      @message = "Friend added: \"#{friend.name}\""
+      @introvert.add_friend(name: args.join(" "))
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -17,15 +16,7 @@ command :add do |add|
     add.arg_name "DESCRIPTION"
     add.command event do |add_event|
       add_event.action do |_, _, args|
-        event_obj = @introvert.send("add_#{event}", serialization: args.join(" "))
-
-        # If there's no description, prompt the user for one.
-        if event_obj.description.nil? || event_obj.description.empty?
-          event_obj.description = Readline.readline(event_obj.to_s)
-          event_obj.highlight_description(introvert: @introvert)
-        end
-
-        @message = "#{event.to_s.capitalize} added: \"#{event_obj}\""
+        @introvert.send("add_#{event}", serialization: args.join(" "))
         @dirty = true # Mark the file for cleaning.
       end
     end
@@ -35,8 +26,7 @@ command :add do |add|
   add.arg_name "LOCATION"
   add.command :location do |add_location|
     add_location.action do |_, _, args|
-      location = @introvert.add_location(name: args.join(" "))
-      @message = "Location added: \"#{location.name}\""
+      @introvert.add_location(name: args.join(" "))
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -45,8 +35,7 @@ command :add do |add|
   add.arg_name "NAME NICKNAME"
   add.command :nickname do |add_nickname|
     add_nickname.action do |_, _, args|
-      friend = @introvert.add_nickname(name: args.first, nickname: args[1])
-      @message = "Nickname added: \"#{friend}\""
+      @introvert.add_nickname(name: args.first, nickname: args[1])
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -55,11 +44,10 @@ command :add do |add|
   add.arg_name "NAME @TAG"
   add.command :tag do |add_tag|
     add_tag.action do |_, _, args|
-      friend = @introvert.add_tag(
+      @introvert.add_tag(
         name: args[0..-2].join(" "),
         tag: Tag.convert_to_tag(args.last)
       )
-      @message = "Tag added to friend: \"#{friend}\""
       @dirty = true # Mark the file for cleaning.
     end
   end

data/lib/friends/commands/edit.rb

@@ -6,7 +6,18 @@ command :edit do |edit|
     editor = ENV["EDITOR"] || "vim"
     filename = global_options[:filename]
 
-    puts "Opening \"#{filename}\" in #{editor}" unless global_options[:quiet]
-    Kernel.exec "#{editor} #{filename}"
+    puts "Opening \"#{filename}\" with \"#{editor}\"" unless global_options[:quiet]
+
+    # Mark the file for cleaning once the editor was closed correctly.
+    if Kernel.system("#{editor} #{filename}")
+      @introvert = Friends::Introvert.new(
+        filename: global_options[:filename],
+        quiet: global_options[:quiet]
+      )
+      @clean_command = true
+      @dirty = true
+    elsif !global_options[:quiet]
+      puts "Not cleaning file: \"#{filename}\" (\"#{editor}\" did not exit successfully)"
+    end
   end
 end

data/lib/friends/commands/list.rb

@@ -20,7 +20,7 @@ command :list do |list|
                         desc: "Output friend nicknames, locations, and tags"
 
     list_friends.action do |_, options|
-      puts @introvert.list_friends(
+      @introvert.list_friends(
         location_name: options[:in],
         tagged: options[:tagged],
         verbose: options[:verbose]
@@ -65,7 +65,7 @@ command :list do |list|
                        type: InputDate
 
       list_events.action do |_, options|
-        puts @introvert.send(
+        @introvert.send(
           "list_#{events}",
           limit: options[:limit],
           with: options[:with],
@@ -81,7 +81,7 @@ command :list do |list|
   list.desc "List all locations"
   list.command :locations do |list_locations|
     list_locations.action do
-      puts @introvert.list_locations
+      @introvert.list_locations
     end
   end
 
@@ -93,7 +93,7 @@ command :list do |list|
                          "all three",
                    multiple: true
     list_tags.action do |_, options|
-      puts @introvert.list_tags(from: options[:from])
+      @introvert.list_tags(from: options[:from])
     end
   end
 

data/lib/friends/commands/remove.rb

@@ -6,8 +6,7 @@ command :remove do |remove|
   remove.arg_name "NAME NICKNAME"
   remove.command :nickname do |remove_nickname|
     remove_nickname.action do |_, _, args|
-      friend = @introvert.remove_nickname(name: args.first, nickname: args[1])
-      @message = "Nickname removed: \"#{friend}\""
+      @introvert.remove_nickname(name: args.first, nickname: args[1])
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -16,11 +15,10 @@ command :remove do |remove|
   remove.arg_name "NAME @TAG"
   remove.command :tag do |remove_tag|
     remove_tag.action do |_, _, args|
-      friend = @introvert.remove_tag(
+      @introvert.remove_tag(
         name: args[0..-2].join(" "),
         tag: Tag.convert_to_tag(args.last)
       )
-      @message = "Tag removed from friend: \"#{friend}\""
       @dirty = true # Mark the file for cleaning.
     end
   end

data/lib/friends/commands/rename.rb

@@ -6,11 +6,10 @@ command :rename do |rename|
   rename.arg_name "NAME NEW_NAME"
   rename.command :friend do |rename_friend|
     rename_friend.action do |_, _, args|
-      friend = @introvert.rename_friend(
+      @introvert.rename_friend(
         old_name: args.first,
         new_name: args[1]
       )
-      @message = "Name changed: \"#{friend}\""
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -19,11 +18,10 @@ command :rename do |rename|
   rename.arg_name "NAME NEW_NAME"
   rename.command :location do |rename_location|
     rename_location.action do |_, _, args|
-      location = @introvert.rename_location(
+      @introvert.rename_location(
         old_name: args.first,
         new_name: args[1]
       )
-      @message = "Location renamed: \"#{location.name}\""
       @dirty = true # Mark the file for cleaning.
     end
   end

data/lib/friends/commands/set.rb

@@ -6,8 +6,7 @@ command :set do |set|
   set.arg_name "NAME LOCATION"
   set.command :location do |set_location|
     set_location.action do |_, _, args|
-      friend = @introvert.set_location(name: args.first, location_name: args[1])
-      @message = "#{friend.name}'s location set to: #{friend.location_name}"
+      @introvert.set_location(name: args.first, location_name: args[1])
       @dirty = true # Mark the file for cleaning.
     end
   end

data/lib/friends/commands/stats.rb

@@ -3,12 +3,6 @@
 desc "List all stats"
 command :stats do |stats|
   stats.action do
-    puts "Total activities: #{@introvert.total_activities}"
-    puts "Total friends: #{@introvert.total_friends}"
-    puts "Total locations: #{@introvert.total_locations}"
-    puts "Total notes: #{@introvert.total_notes}"
-    puts "Total tags: #{@introvert.total_tags}"
-    days = @introvert.elapsed_days
-    puts "Total time elapsed: #{days} day#{'s' if days != 1}"
+    @introvert.stats
   end
 end