friends 0.37 → 0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 149a16ce90d50f7fc56732aab02d9c27c3304cf3
-  data.tar.gz: 3c45801a69f2ba00a13d2e08cdb1c25e3425eba7
+  metadata.gz: be5bfb57559485e598831f2e273f27fc57eca790
+  data.tar.gz: afbd6cd665503573e8cff620073e22617a18f810
 SHA512:
-  metadata.gz: 2de1ef2a453e3a2a0e757888abe17824ea80b7212002f0cdc9240c4ecbef4c2f5e4e564ed923af6c10425206b2920975f5344c0b247a3974c0da33b608e0b780
-  data.tar.gz: 768405774cdf4c0561f16ccf57e3611b37b5397f1e1ca195dd9837a8d001422eab17ef7ced9da59c6968becd12413f56f0b6e28ffea263f30bed36989ce33854
+  metadata.gz: 5da144c036b93a8e05bed9cc00e37167a168d6f64031c864827a6b348e7f96902a193c886ae0b3af8bd758aebefce576bcb5b931241bf0f91b3e5b539a6b3b91
+  data.tar.gz: 8d25dbdde17277d93a73fe7e9ed19472e7e29abfcd647bf7a2545346f3cabdd164bd03b88d3a4bfe8153d82522f9c0b0d267aadc923e314c892a7bece849a7f7

data/.rubocop.yml

@@ -1,5 +1,11 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.2
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: false
 
 Layout/DotPosition:
   EnforcedStyle: trailing
@@ -50,4 +56,4 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/SymbolArray:
-  EnforcedStyle: brackets
+  EnforcedStyle: brackets

data/CHANGELOG.md

@@ -14,6 +14,20 @@ making a small donation (🙏) to show you appreciate its continued development.
 
 👆 Donate with these buttons! 👆
 
+## [v0.38](https://github.com/JacobEvelyn/friends/tree/v0.38) (2018-07-24)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.37...v0.38)
+
+**Implemented enhancements:**
+
+- Give matching priority to first name-only people [\#202](https://github.com/JacobEvelyn/friends/issues/202)
+- Don't allow blank activities, friend names, tags, locations, or notes [\#198](https://github.com/JacobEvelyn/friends/issues/198)
+
+**Merged pull requests:**
+
+- Give name-matching priority to full-text matches [\#203](https://github.com/JacobEvelyn/friends/pull/203) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Prevent the addition of blank events, names, and locations [\#200](https://github.com/JacobEvelyn/friends/pull/200) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Fix Rubocop errors [\#196](https://github.com/JacobEvelyn/friends/pull/196) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Update rake requirement to ~\> 12.3 [\#194](https://github.com/JacobEvelyn/friends/pull/194) ([dependabot[bot]](https://github.com/apps/dependabot))
 
 ## [v0.37](https://github.com/JacobEvelyn/friends/tree/v0.37) (2018-02-24)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.36...v0.37)

data/bin/friends

@@ -4,7 +4,7 @@
 if ENV["TRAVIS"] == "true"
   require "simplecov"
   SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter
-  SimpleCov.command_name Process.pid
+  SimpleCov.command_name Process.pid.to_s
   SimpleCov.start
 end
 

data/friends.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "friends/version"
 
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "coveralls", "~> 0.8"
   spec.add_development_dependency "minitest", "~> 5.5"
   spec.add_development_dependency "minitest-proveit", "~> 1.0"
-  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rubocop", "~> 0.49"
   spec.add_development_dependency "simplecov", "~> 0.14"
 end

data/lib/friends/commands/add.rb

@@ -6,7 +6,7 @@ command :add do |add|
   add.arg_name "NAME"
   add.command :friend do |add_friend|
     add_friend.action do |_, _, args|
-      @introvert.add_friend(name: args.join(" "))
+      @introvert.add_friend(name: args.join(" ").strip)
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -16,7 +16,7 @@ command :add do |add|
     add.arg_name "DESCRIPTION"
     add.command event do |add_event|
       add_event.action do |_, _, args|
-        @introvert.send("add_#{event}", serialization: args.join(" "))
+        @introvert.send("add_#{event}", serialization: args.join(" ").strip)
         @dirty = true # Mark the file for cleaning.
       end
     end
@@ -26,7 +26,7 @@ command :add do |add|
   add.arg_name "LOCATION"
   add.command :location do |add_location|
     add_location.action do |_, _, args|
-      @introvert.add_location(name: args.join(" "))
+      @introvert.add_location(name: args.join(" ").strip)
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -35,7 +35,7 @@ command :add do |add|
   add.arg_name "NAME NICKNAME"
   add.command :nickname do |add_nickname|
     add_nickname.action do |_, _, args|
-      @introvert.add_nickname(name: args.first, nickname: args[1])
+      @introvert.add_nickname(name: args.first.strip, nickname: args[1].strip)
       @dirty = true # Mark the file for cleaning.
     end
   end
@@ -46,7 +46,7 @@ command :add do |add|
     add_tag.action do |_, _, args|
       @introvert.add_tag(
         name: args[0..-2].join(" "),
-        tag: Tag.convert_to_tag(args.last)
+        tag: Tag.convert_to_tag(args.last.strip)
       )
       @dirty = true # Mark the file for cleaning.
     end

data/lib/friends/event.rb

@@ -192,14 +192,16 @@ module Friends
     # more information see the comments below and the
     # introvert#set_likelihood_score! method.
     def highlight_friends(introvert:)
+      ## STEP 1
       # 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 }
+        introvert.regex_friend_map.partition { |_, arr| arr.size == 1 }.map(&:to_h)
 
+      ## STEP 2
       matched_friends = []
 
-      # First, we find all of the unambiguous matches, and make those
+      # 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
@@ -211,6 +213,36 @@ module Friends
         end
       end
 
+      ## STEP 3
+      # Now, we look through the ambiguous matches to find any where
+      # the matched text is the entire friend's name, and make those
+      # replacements too. ("Elizabeth" as a whole name should take
+      # precedence over "Elizabeth Cady Stanton" even if the latter
+      # is a better friend, because otherwise it's hard to just get
+      # your friend "Elizabeth" to match.)
+      full_name_regexes = []
+
+      ambiguous_map.each do |regex, friend_list|
+        smallest_name_friend = friend_list.min_by(&:name)
+        smallest_name = smallest_name_friend.name
+
+        # If one friend's name is contained within all of the other friend
+        # names within the regex group, we assume that that friend's name
+        # is the entire matched text (like "Elizabeth" in the above example).
+        next unless friend_list.all? { |friend| friend.name.include? smallest_name }
+
+        description_matches(regex: regex, replace: true, indicator: "**") do
+          matched_friends << smallest_name_friend
+          smallest_name
+        end
+
+        full_name_regexes << regex
+      end
+
+      # Delete all of regexes from STEP 3 substitutions.
+      full_name_regexes.each { |regex| ambiguous_map.delete(regex) }
+
+      ## STEP 4
       possible_matched_friends = []
 
       # Now, we look at regex matches that are ambiguous.
@@ -232,12 +264,13 @@ module Friends
         # 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_list.min_by do |friend|
             [-friend.likelihood_score, -friend.n_activities]
-          end.first.name
+          end.name
         end
       end
 
+      ## STEP 5
       # Lastly, we remove any backslashes, as these are used to escape friends'
       # names that we don't want to match.
       @description = @description.delete("\\")

data/lib/friends/graph.rb

@@ -4,7 +4,7 @@
 
 module Friends
   class Graph
-    DATE_FORMAT = "%b %Y".freeze # rubocop:disable Style/FormatStringToken
+    DATE_FORMAT = "%b %Y".freeze
 
     # @param activities [Array<Friends::Activity>] a list of activities to graph
     def initialize(filtered_activities:, all_activities:)
@@ -77,11 +77,11 @@ module Friends
       date.strftime(DATE_FORMAT)
     end
 
-    # @param x [Integer] the x coordinate we want to color; x >= 0
+    # @param x_coord [Integer] the x coordinate we want to color; x >= 0
     # @return [Array<Integer>] the color we should use to paint
     #   a point on the graph at the given x coordinate
-    def color(x)
-      COLORS[x % COLORS.size]
+    def color(x_coord)
+      COLORS[x_coord % COLORS.size]
     end
 
     # Originally generated by executing the code in Minitest's Pride plugin (the PrideLOL class),

data/lib/friends/introvert.rb

@@ -91,7 +91,9 @@ module Friends
       Activity.deserialize(serialization).tap do |activity|
         # If there's no description, prompt the user for one.
         if activity.description.nil? || activity.description.empty?
-          activity.description = Readline.readline(activity.to_s)
+          activity.description = Readline.readline(activity.to_s).to_s.strip
+
+          raise FriendsError, "Blank activity not added" if activity.description.empty?
         end
 
         activity.highlight_description(introvert: self)
@@ -108,7 +110,9 @@ module Friends
       Note.deserialize(serialization).tap do |note|
         # If there's no description, prompt the user for one.
         if note.description.nil? || note.description.empty?
-          note.description = Readline.readline(note.to_s)
+          note.description = Readline.readline(note.to_s).to_s.strip
+
+          raise FriendsError, "Blank note not added" if note.description.empty?
         end
 
         note.highlight_description(introvert: self)
@@ -188,6 +192,8 @@ module Friends
     # @param nickname [String] the nickname to add to the friend
     # @raise [FriendsError] if 0 or 2+ friends match the given name
     def add_nickname(name:, nickname:)
+      raise FriendsError, "Nickname cannot be blank" if nickname.empty?
+
       friend = thing_with_name_in(:friend, name)
       friend.add_nickname(nickname)
 
@@ -199,6 +205,8 @@ module Friends
     # @param tag [String] the tag to add to the friend, of the form: "@tag"
     # @raise [FriendsError] if 0 or 2+ friends match the given name
     def add_tag(name:, tag:)
+      raise FriendsError, "Tag cannot be blank" if tag == "@"
+
       friend = thing_with_name_in(:friend, name)
       friend.add_tag(tag)
 

data/lib/friends/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Friends
-  VERSION = "0.37".freeze
+  VERSION = "0.38".freeze
 end

data/test/add_event_helper.rb

@@ -51,6 +51,18 @@ def description_parsing_specs(test_stdout: true)
   describe "description parsing" do
     let(:date) { Date.today.strftime }
 
+    unless test_stdout
+      describe "when description is blank" do
+        let(:description) { "  " }
+
+        it "prints an error message" do
+          subject[:stderr].must_equal(
+            ensure_trailing_newline_unless_empty("Error: Blank #{event} not added")
+          )
+        end
+      end
+    end
+
     describe "when description includes a friend's full name (case insensitive)" do
       let(:description) { "Lunch with grace hopper." }
 
@@ -275,6 +287,35 @@ FILE
       end
     end
 
+    describe "when description has a friend's full name which is another friend's first name" do
+      let(:description) { "Hung out with Elizabeth for most of the day." }
+
+      # Make sure "Elizabeth II" is a better friend than just "Elizabeth" to
+      # ensure our result isn't due to chance.
+      let(:content) do
+        <<-FILE
+### Activities:
+- 2018-08-05: Royal picnic with **Elizabeth II**.
+
+### Notes:
+
+### Friends:
+- Elizabeth
+- Elizabeth II
+
+### Locations:
+FILE
+      end
+
+      it { line_added "- #{date}: Hung out with **Elizabeth** for most of the day." }
+      if test_stdout
+        it do
+          stdout_only "#{capitalized_event} added: \"#{date}: "\
+                      "Hung out with Elizabeth for most of the day.\""
+        end
+      end
+    end
+
     describe "when description has a name with multiple friend matches" do
       describe "when there is useful context from past activities" do
         let(:description) { "Met John + Elizabeth." }
@@ -372,6 +413,7 @@ FILE
 end
 
 def parsing_specs(event:)
+  let(:event) { event.to_s }
   let(:capitalized_event) { event.to_s.capitalize }
 
   describe "when given a date and a description in the command" do

data/test/commands/add/friend_spec.rb

@@ -7,6 +7,14 @@ clean_describe "add friend" do
 
   let(:content) { CONTENT }
 
+  describe "when friend name is blank" do
+    let(:friend_name) { "' '" }
+
+    it "prints an error message" do
+      stderr_only 'Error: Expected "[Friend Name]"'
+    end
+  end
+
   describe "when there is an existing friend with that name" do
     let(:friend_name) { "George Washington Carver" }
 

data/test/commands/add/location_spec.rb

@@ -7,6 +7,14 @@ clean_describe "add location" do
 
   let(:content) { CONTENT }
 
+  describe "when location name is blank" do
+    let(:location_name) { "' '" }
+
+    it "prints an error message" do
+      stderr_only 'Error: Expected "[Location Name]"'
+    end
+  end
+
   describe "when there is an existing location with that name" do
     let(:location_name) { "Paris" }
 

data/test/commands/add/nickname_spec.rb

@@ -29,22 +29,33 @@ clean_describe "add nickname" do
 
   describe "when friend name has one match" do
     let(:friend_name) { "George" }
-    let(:nickname) { "Georgie" }
 
-    it "adds nickname to friend" do
-      line_changed "- George Washington Carver", "- George Washington Carver (a.k.a. Georgie)"
-    end
+    describe "when nickname is blank" do
+      let(:nickname) { "' '" }
 
-    it "updates parenthetical in file when friend has existing nicknames" do
-      run_cmd("add nickname #{friend_name} 'Mr. Peanut'")
-      line_changed(
-        "- George Washington Carver (a.k.a. Mr. Peanut)",
-        "- George Washington Carver (a.k.a. Mr. Peanut a.k.a. Georgie)"
-      )
+      it "prints an error message" do
+        stderr_only "Error: Nickname cannot be blank"
+      end
     end
 
-    it "prints an output message" do
-      stdout_only 'Nickname added: "George Washington Carver (a.k.a. Georgie)"'
+    describe "when nickname is not blank" do
+      let(:nickname) { "Georgie" }
+
+      it "adds nickname to friend" do
+        line_changed "- George Washington Carver", "- George Washington Carver (a.k.a. Georgie)"
+      end
+
+      it "updates parenthetical in file when friend has existing nicknames" do
+        run_cmd("add nickname #{friend_name} 'Mr. Peanut'")
+        line_changed(
+          "- George Washington Carver (a.k.a. Mr. Peanut)",
+          "- George Washington Carver (a.k.a. Mr. Peanut a.k.a. Georgie)"
+        )
+      end
+
+      it "prints an output message" do
+        stdout_only 'Nickname added: "George Washington Carver (a.k.a. Georgie)"'
+      end
     end
   end
 end

data/test/commands/add/tag_spec.rb

@@ -29,21 +29,25 @@ clean_describe "add tag" do
 
   describe "when friend name has one match" do
     let(:friend_name) { "George" }
-    let(:tag) { "school:tuskegee-institute" }
 
-    it "adds tag to friend" do
-      line_changed(
-        "- George Washington Carver",
-        "- George Washington Carver @school:tuskegee-institute"
-      )
+    describe "when tag is blank" do
+      let(:tag) { "' '" }
+
+      it "prints an error message" do
+        stderr_only "Error: Tag cannot be blank"
+      end
     end
 
-    it "prints an output message" do
-      stdout_only 'Tag added to friend: "George Washington Carver @school:tuskegee-institute"'
+    describe "when tag is blank with an @" do
+      let(:tag) { "'@ '" }
+
+      it "prints an error message" do
+        stderr_only "Error: Tag cannot be blank"
+      end
     end
 
-    describe "when tag is passed with @" do
-      let(:tag) { "@school:tuskegee-institute" }
+    describe "when tag is not blank" do
+      let(:tag) { "school:tuskegee-institute" }
 
       it "adds tag to friend" do
         line_changed(
@@ -55,17 +59,32 @@ clean_describe "add tag" do
       it "prints an output message" do
         stdout_only 'Tag added to friend: "George Washington Carver @school:tuskegee-institute"'
       end
-    end
 
-    describe "when friend already has tags" do
-      let(:friend_name) { "Marie" }
-      let(:tag) { "school:ecole-normale-superieure" }
+      describe "when tag is passed with @" do
+        let(:tag) { "@school:tuskegee-institute" }
 
-      it "allows for multiple tags" do
-        line_changed(
-          "- Marie Curie [Atlantis] @science",
-          "- Marie Curie [Atlantis] @science @school:ecole-normale-superieure"
-        )
+        it "adds tag to friend" do
+          line_changed(
+            "- George Washington Carver",
+            "- George Washington Carver @school:tuskegee-institute"
+          )
+        end
+
+        it "prints an output message" do
+          stdout_only 'Tag added to friend: "George Washington Carver @school:tuskegee-institute"'
+        end
+      end
+
+      describe "when friend already has tags" do
+        let(:friend_name) { "Marie" }
+        let(:tag) { "school:ecole-normale-superieure" }
+
+        it "allows for multiple tags" do
+          line_changed(
+            "- Marie Curie [Atlantis] @science",
+            "- Marie Curie [Atlantis] @science @school:ecole-normale-superieure"
+          )
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.37'
+  version: '0.38'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement