friends 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 014d82e8189c2cf8442af3e9058d56dbfdfb0fd3
-  data.tar.gz: a4a10982b5139cbe3b800aea6f984e32763beea9
+  metadata.gz: a63257ad72fd3c60181fca07b37ebba7833e2d00
+  data.tar.gz: 41fd48ad81de9249985c62979b112f03f9e90bdf
 SHA512:
-  metadata.gz: ac424ae74a5b3640c9374d4c7a9691d8e5305be1afba2a97f5714dfb662ffa2ea50238c6e30beb54ce48132dc610d8371229d9250a92e349772a5840ea1c9cf1
-  data.tar.gz: 8df418e8482b5d27eeb6823d870cabe1b818931628283e64c74cdb6d8ade3a78ed0371a2bf16415d08cc3e45492cd92ba88db78e0ec227ea138e69ff42c51cd7
+  metadata.gz: bb6b46934923c9973dd04c8eec66b03a455cddbec686e6d6d0b5c353fb624c99cb7dc2f3e95688e742b6e14f5709b11b0bbe30fa0587e219133ea5b156df1516
+  data.tar.gz: 15bab42fc57ad1ce636223cf1595ee0d4cee6390d1be162b68bf1b6701fea611781984ecc999e7d475e21e5498b7aa7fa8c3a47c398918c4e2f67bb42cb71429

data/README.md

@@ -60,6 +60,18 @@ Or get an **interactive prompt** by just typing `friends add activity`, with or
 $ friends add activity 2015-11-01
 2015-11-01: <type description here>
 ```
+You can escape the names of friends you don't want `friends` to match with a backslash:
+```
+$ friends add activity "2015-11-01: Grace and I went to \Marie's Diner. \George had to cancel at the last minute."
+Activity added: "2015-11-01: Grace Hopper and I went to Marie's Diner. George had to cancel at the last minute."
+```
+##### Suggest a friend to do something with:
+```
+$ friends suggest
+Distant friend: Marie Curie
+Moderate friend: Grace Hopper
+Close friend: George Washington Carver
+```
 ##### List the activities you've recorded:
 ```
 $ friends list activities
@@ -104,6 +116,11 @@ George Washington Carver
 Grace Hopper
 Marie Curie
 ```
+##### Update to the latest version:
+```
+$ friends update
+Updated to friends 0.3
+```
 ### Global options:
 
 ##### --quiet

data/bin/friends

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
 
 # Todo:
-# - Create file if none exists.
 # - Split out serialization into separate repository.
 # - Add auto check for updates.
 # - Allow friends to have nicknames.
 # - Allow easy editing of most recent entry.
-# - Allow escape char to prevent automatching. ("\Zane wasn't there.")
 
 require "gli"
 require "paint"
@@ -37,6 +35,27 @@ switch [:clean],
   negatable: false,
   desc: "Force a clean write of the friends file"
 
+command :update do |update|
+  update.action do
+    search = `gem search friends`
+    if match = search.match(/^friends\s\(([^\)]+)\)$/)
+      remote_version = match[1]
+      if remote_version.to_r > Friends::VERSION.to_r
+        `gem update friends && gem cleanup friends`
+        if $?.success?
+          puts Paint["Updated to friends #{remote_version}", :bold, :green]
+        else
+          puts Paint[
+            "Error updating to friends version #{remote_version}", :bold, :red
+          ]
+        end
+      else
+        puts Paint["Already up-to-date (#{Friends::VERSION})", :bold, :green]
+      end
+    end
+  end
+end
+
 desc "Lists friends or activities"
 command :list do |list|
   list.desc "List all friends"

data/friends.md

@@ -1,4 +1,5 @@
 ### Activities:
+- 2015-11-01: **Grace Hopper** and I went to Marie's Diner. George had to cancel at the last minute.
 - 2015-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**.
 - 2014-12-31: Celebrated the new year with **Marie Curie**.
 - 2014-11-15: Talked to **George Washington Carver** on the phone for an hour.

data/lib/friends/activity.rb

@@ -122,6 +122,10 @@ module Friends
             "#{match.post_match}"
         end
       end
+
+      # Lastly, we remove any backslashes, as these are used to escape friends'
+      # names that we don't want to match.
+      @description.gsub!("\\", "")
     end
 
     # @param friend [Friend] the friend to test

data/lib/friends/friend.rb

@@ -58,6 +58,10 @@ module Friends
       # We generously allow any amount of whitespace between parts of a name.
       splitter = "\\s+"
 
+      # We don't want to match names that are "escaped" with a leading
+      # backslash.
+      no_leading_backslash = "(?<!\\\\)"
+
       # We don't want to match names that are directly touching double asterisks
       # as these are treated as sacred by our program.
       no_leading_asterisks = "(?<!\\*\\*)"
@@ -72,6 +76,7 @@ module Friends
 
       [chunks, [chunks.first]].map do |words|
         Regexp.new(
+          no_leading_backslash +
           no_leading_asterisks +
           no_leading_alphabeticals +
           words.join(splitter) +

data/lib/friends/version.rb

@@ -1,3 +1,3 @@
 module Friends
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/test/activity_spec.rb

@@ -140,6 +140,16 @@ describe Friends::Activity do
       end
     end
 
+    describe "when name is escaped with a backslash" do
+      # We have to use two backslashes here because that's how Ruby encodes one.
+      let(:description) { "Dinner with \\Elizabeth Cady Stanton." }
+      it "does not match a friend and removes the backslash" do
+        subject
+        # No match found.
+        activity.description.must_equal "Dinner with Elizabeth Cady Stanton."
+      end
+    end
+
     describe "when name has leading asterisks" do
       let(:description) { "Dinner with **Elizabeth Cady Stanton." }
       it "does not match a friend" do

data/test/friend_spec.rb

@@ -71,8 +71,8 @@ describe Friends::Friend do
 
     it "generates appropriate regexes" do
       subject.must_equal [
-        /(?<!\*\*)(?<![A-z])Jacob\s+Evelyn(?![A-z])(?!\*\*)/i,
-        /(?<!\*\*)(?<![A-z])Jacob(?![A-z])(?!\*\*)/i
+        /(?<!\\)(?<!\*\*)(?<![A-z])Jacob\s+Evelyn(?![A-z])(?!\*\*)/i,
+        /(?<!\\)(?<!\*\*)(?<![A-z])Jacob(?![A-z])(?!\*\*)/i
       ]
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli