friends 0.12 → 0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6fbeed1512a5fb14b7a89e5afebe885e48817ea
-  data.tar.gz: e4fa97ba906eb037fc70da65704aa33a456e0a99
+  metadata.gz: 844eb360bcc04aed352a8b3c3371117afb18f564
+  data.tar.gz: db2feb8fbf5a15232b6b5923218dc8d7cff4ded1
 SHA512:
-  metadata.gz: 883ef235fc6d26aec8bc03ac5a72794e643f1d7d501944a5e5c587bf0451ed55320562b1188161616cd88e1c952ddfccce746d8a369cf05a080d0bd6cda5b2d3
-  data.tar.gz: 51557fe1705cf9d812087c5b7b3d5397517f48232a56668267ce8000d94301b7208b430dbf9f97c67694a50ce09f4d079b6f57e9033b084f6f10a0fe928c788b
+  metadata.gz: c3eb0061ba85b5dcc7eb1fa9f7d0dc1c711834b4b128b37d789252b5293b290e95de4553f55cb57a585dee1cf077e87c7b2d8fa6e5806f7ed8520227287e3e9a
+  data.tar.gz: cac077cacd2c4a0309b5614e1952dd65b55f0c22b7d23ed619cda4c6637f282284c0c236ff1a16ed83a4fd9ecc3bcfe434755f3c46f87c241fd8073990deda7d

data/.rubocop.yml

@@ -8,7 +8,7 @@ Alias:
   Enabled: false
 
 AllCops:
-  RunRailsCops: false
+  TargetRubyVersion: 2.3
 
 AmbiguousOperator:
   Enabled: false
@@ -149,6 +149,9 @@ MethodLength:
 ModuleFunction:
   Enabled: false
 
+MutableConstant:
+  Enabled: true
+
 NegatedIf:
   Enabled: false
 
@@ -196,6 +199,9 @@ PredicateName:
 Proc:
   Enabled: false
 
+Rails:
+  Enabled: false
+
 RaiseArgs:
   Enabled: false
 
@@ -232,8 +238,11 @@ Style/MultilineBlockChain:
 VariableInterpolation:
   Enabled: false
 
-TrailingComma:
-  Enabled: false
+TrailingCommaInArguments:
+  Enabled: true
+
+TrailingCommaInLiteral:
+  Enabled: true
 
 TrivialAccessors:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [v0.13](https://github.com/JacobEvelyn/friends/tree/v0.13) (2016-01-21)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.12...v0.13)
+
+**Fixed bugs:**
+
+- Treat double names as a single name [\#80](https://github.com/JacobEvelyn/friends/issues/80)
+
+**Closed issues:**
+
+- 4 RuboCop errors prevent git commit [\#78](https://github.com/JacobEvelyn/friends/issues/78)
+
+**Merged pull requests:**
+
+- Improve handling of double-names and names within names [\#81](https://github.com/JacobEvelyn/friends/pull/81) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Update RuboCop and fix many offenses [\#79](https://github.com/JacobEvelyn/friends/pull/79) ([bloomyminded](https://github.com/bloomyminded))
+
 ## [v0.12](https://github.com/JacobEvelyn/friends/tree/v0.12) (2016-01-16)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.11...v0.12)
 

data/bin/friends

@@ -24,23 +24,25 @@ subcommand_option_handling :normal
 arguments :strict
 
 switch [:quiet],
-  negatable: false,
-  desc: "Quiet output messages"
+       negatable: false,
+       desc: "Quiet output messages"
 
 flag [:filename],
-  arg_name: "FILENAME",
-  default_value: "./friends.md",
-  desc: "Set the location of the friends file"
+     arg_name: "FILENAME",
+     default_value: "./friends.md",
+     desc: "Set the location of the friends file"
 
 switch [:debug],
-  negatable: false,
-  desc: "Debug error messages with a full backtrace"
+       negatable: false,
+       desc: "Debug error messages with a full backtrace"
 
 desc "Updates the `friends` program"
 command :update do |update|
   update.action do
     search = `gem search friends`
+    # rubocop:disable Lint/AssignmentInCondition
     if match = search.match(/^friends\s\(([^\)]+)\)$/)
+      # rubocop:enable Lint/AssignmentInCondition
       remote_version = match[1]
       if Semverse::Version.coerce(remote_version) >
          Semverse::Version.coerce(Friends::VERSION)
@@ -71,9 +73,9 @@ command :list do |list|
   list.desc "List favorite friends"
   list.command :favorites do |list_favorites|
     list_favorites.flag [:limit],
-      arg_name: "NUMBER",
-      default_value: 10,
-      desc: "The number of friends to return"
+                        arg_name: "NUMBER",
+                        default_value: 10,
+                        desc: "The number of friends to return"
 
     list_favorites.action do |_, options|
       limit = options[:limit].to_i
@@ -95,13 +97,13 @@ command :list do |list|
   list.desc "Lists all activities"
   list.command :activities do |list_activities|
     list_activities.flag [:limit],
-      arg_name: "NUMBER",
-      default_value: 10,
-      desc: "The number of activities to return"
+                         arg_name: "NUMBER",
+                         default_value: 10,
+                         desc: "The number of activities to return"
 
     list_activities.flag [:with],
-      arg_name: "NAME",
-      desc: "List only activities involving the given friend"
+                         arg_name: "NAME",
+                         desc: "List only activities involving the given friend"
 
     list_activities.action do |_, options|
       limit = options[:limit].to_i
@@ -172,7 +174,7 @@ command :graph do |graph|
 
     colors = (0...(6 * 7)).map do |n|
       n *= 1.0 / 6
-      r  = (3 * Math.sin(n           ) + 3).to_i
+      r  = (3 * Math.sin(n) + 3).to_i
       g  = (3 * Math.sin(n + 2 * PI_3) + 3).to_i
       b  = (3 * Math.sin(n + 4 * PI_3) + 3).to_i
 

data/friends.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jacob Evelyn"]
   spec.email         = ["jacobevelyn@gmail.com"]
   spec.summary       = "Spend time with the people you care about."
-  spec.description   = "Spend time with the people you care about. Introvert-tested. Extrovert-approved."
+  spec.description   = "Spend time with the people you care about. "\
+                       "Introvert-tested. Extrovert-approved."
   spec.homepage      = "https://github.com/JacobEvelyn/friends"
   spec.license       = "MIT"
 
@@ -31,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.5"
   spec.add_development_dependency "overcommit", "~> 0.30"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rubocop", "~> 0.35"
+  spec.add_development_dependency "rubocop", "~> 0.36"
 end

data/lib/friends/activity.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Activity represents an activity you've done with one or more Friends.
 
 require "memoist"
@@ -10,11 +11,14 @@ module Friends
     extend Serializable
     extend Memoist
 
-    SERIALIZATION_PREFIX = "- "
+    SERIALIZATION_PREFIX = "- ".freeze
 
     # @return [Regexp] the regex for capturing groups in deserialization
     def self.deserialization_regex
+      # Note: this regex must be on one line because whitespace is important
+      # rubocop:disable Metrics/LineLength
       /(#{SERIALIZATION_PREFIX})?((?<date_s>\d{4}-\d\d-\d\d)(:\s)?)?(?<description>.+)?/
+      # rubocop:enable Metrics/LineLength
     end
 
     # @return [Regexp] the string of what we expected during deserialization
@@ -37,7 +41,9 @@ module Friends
     def display_text
       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[2], :bold, :magenta]}"\
                         "#{match.post_match}"
@@ -61,41 +67,31 @@ module Friends
     # more information see the comments below and the
     # introvert#set_likelihood_score! method.
     def highlight_friends(introvert:)
-      friend_regexes = introvert.friend_regex_map
-
-      # Create hash mapping regex to friend. Note that because two friends may
-      # have the same regex (e.g. /John/), we need to store the names in an
-      # array since there may be more than one. We also iterate through the
-      # regexes to add the most important regexes to the hash first, so
-      # "Jacob Evelyn" takes precedence over all instances of "Jacob" (since
-      # Ruby hashes are ordered).
-      regex_map = Hash.new { |h, k| h[k] = [] }
-      while !friend_regexes.empty?
-        friend_regexes.each do |friend, regex_list|
-          regex_map[regex_list.shift] << friend
-          friend_regexes.delete(friend) if regex_list.empty?
-        end
-      end
+      # 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 regex matches with only one possibility, and
-      # make those substitutions.
-      regex_map.
-        select { |_, arr| arr.size == 1 }.each do |regex, friend_list|
-        if @description.match(regex)
+      # 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) do
           friend = friend_list.first # There's only one friend in the list.
           matched_friends << friend
-          @description.gsub!(regex, "**#{friend.name}**")
+          friend.name
         end
       end
 
       possible_matched_friends = []
 
       # Now, we look at regex matches that are ambiguous.
-      regex_map.
-        reject { |_, arr| arr.size == 1 }.each do |regex, friend_list|
-        if @description.match(regex)
+      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) do
           possible_matched_friends << friend_list
         end
       end
@@ -107,21 +103,20 @@ module Friends
         possible_matches: possible_matched_friends
       )
 
-      # Now we go through and replace all of the ambiguous matches with our best
-      # guess.
-      regex_map.
-        reject { |_, arr| arr.size == 1 }.each do |regex, friend_list|
-        if @description.match(regex)
-          guessed_friend = friend_list.sort_by do |friend|
+      # 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) do
+          friend_list.sort_by do |friend|
             [-friend.likelihood_score, -friend.n_activities]
-          end.first
-          @description.gsub!(regex, "**#{guessed_friend.name}**")
+          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.delete!("\\")
+      @description = @description.delete("\\")
     end
 
     # Updates a friend's old_name to their new_name
@@ -150,6 +145,45 @@ module Friends
 
     private
 
+    # 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 ("**") indicating it is already part of
+    #     another 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:)
+      # 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.
+        if match.pre_match.scan("**").size % 2 == 0 &&
+           match.post_match.scan("**").size % 2 == 0
+          @description = "#{match.pre_match}**#{str}**#{match.post_match}"
+        else
+          # If we're between double-asterisks 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

data/lib/friends/friend.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Friend represents a friend. You know, a real-life friend!
 
 require "friends/serializable"
@@ -6,12 +7,15 @@ module Friends
   class Friend
     extend Serializable
 
-    SERIALIZATION_PREFIX = "- "
-    NICKNAME_PREFIX = "a.k.a. "
+    SERIALIZATION_PREFIX = "- ".freeze
+    NICKNAME_PREFIX = "a.k.a. ".freeze
 
     # @return [Regexp] the regex for capturing groups in deserialization
     def self.deserialization_regex
+      # Note: this regex must be on one line because whitespace is important
+      # rubocop:disable Metrics/LineLength
       /(#{SERIALIZATION_PREFIX})?(?<name>[^\(]+)(\((?<nickname_str>#{NICKNAME_PREFIX}.+)\))?/
+      # rubocop:enable Metrics/LineLength
     end
 
     # @return [Regexp] the string of what we expected during deserialization
@@ -31,7 +35,7 @@ module Friends
 
     # @return [String] the file serialization text for the friend
     def serialize
-      "#{SERIALIZATION_PREFIX}#{to_s}"
+      "#{SERIALIZATION_PREFIX}#{self}"
     end
 
     # @return [String] a string representing the friend's name and nicknames
@@ -83,13 +87,12 @@ module Friends
       @likelihood_score || 0
     end
 
-    # @return [Array] a list of all regexes to match the name in a string, with
-    #   longer regexes first
-    #   Note: for now we only match on full names or first names
+    # @return [Array] a list of all regexes to match the name in a string
     #   Example: [
     #     /Jacob\s+Morris\s+Evelyn/,
     #     /Jacob/
     #   ]
+    # NOTE: For now we only match on full names or first names.
     def regexes_for_name
       # We generously allow any amount of whitespace between parts of a name.
       splitter = "\\s+"
@@ -100,6 +103,10 @@ module Friends
 
       # We don't want to match names that are directly touching double asterisks
       # as these are treated as sacred by our program.
+      # NOTE: Technically we don't need this check here, since we perform a more
+      # complex asterisk check in the Activity#description_matches method, but
+      # this class shouldn't need to know about the internal implementation of
+      # another class.
       no_leading_asterisks = "(?<!\\*\\*)"
       no_ending_asterisks = "(?!\\*\\*)"
 

data/lib/friends/introvert.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Introvert is the internal handler for the friends script. It is designed to be
 # able to be used directly within another Ruby program, without needing to call
 # the command-line script explicitly.
@@ -8,10 +9,10 @@ require "friends/friends_error"
 
 module Friends
   class Introvert
-    DEFAULT_FILENAME = "./friends.md"
-    ACTIVITIES_HEADER = "### Activities:"
-    FRIENDS_HEADER = "### Friends:"
-    GRAPH_DATE_FORMAT = "%b %Y" # Used as the param for date.strftime().
+    DEFAULT_FILENAME = "./friends.md".freeze
+    ACTIVITIES_HEADER = "### Activities:".freeze
+    FRIENDS_HEADER = "### Friends:".freeze
+    GRAPH_DATE_FORMAT = "%b %Y".freeze # Used as the param for date.strftime().
 
     # @param filename [String] the name of the friends Markdown file
     def initialize(filename: DEFAULT_FILENAME)
@@ -250,12 +251,15 @@ module Friends
       end
     end
 
-    # @return [Hash] mapping each friend to a list of all possible regexes for
-    #   that friend's name
-    def friend_regex_map
-      @friends.each_with_object({}) do |friend, hash|
-        hash[friend] = friend.regexes_for_name
-      end
+    # @return [Hash] of the form { /regex/ => [list of friends matching regex] }
+    #   This hash is sorted (because Ruby's hashes are ordered) by decreasing
+    #   regex key length, so the key /Jacob Evelyn/ appears before /Jacob/.
+    def regex_friend_map
+      @friends.each_with_object(Hash.new { |h, k| h[k] = [] }) do |friend, hash|
+        friend.regexes_for_name.each do |regex|
+          hash[regex] << friend
+        end
+      end.sort_by { |k, _| -k.to_s.size }.to_h
     end
 
     # Sets the likelihood_score field on each friend in `possible_matches`. This
@@ -274,13 +278,13 @@ module Friends
     #   description, for instance, is "John Deere" vs. "John Doe"
     def set_likelihood_score!(matches:, possible_matches:)
       combinations = (matches + possible_matches.flatten).
-        combination(2).
-        reject do |friend1, friend2|
-          (matches & [friend1, friend2]).size == 2 ||
-          possible_matches.any? do |group|
-            (group & [friend1, friend2]).size == 2
-          end
-        end
+                     combination(2).
+                     reject do |friend1, friend2|
+                       (matches & [friend1, friend2]).size == 2 ||
+                       possible_matches.any? do |group|
+                         (group & [friend1, friend2]).size == 2
+                       end
+                     end
 
       @activities.each do |activity|
         names = activity.friend_names

data/lib/friends/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Friends
-  VERSION = "0.12"
+  VERSION = "0.13".freeze
 end

data/test/activity_spec.rb

@@ -135,6 +135,54 @@ describe Friends::Activity do
       end
     end
 
+    describe "when one name ends another after a hyphen" do
+      let(:friend1) { Friends::Friend.new(name: "Mary-Kate Olsen") }
+      let(:friend2) { Friends::Friend.new(name: "Kate Winslet") }
+      let(:description) { "Shopping with Mary-Kate." }
+
+      it "gives precedence to the larger name" do
+        # Make sure "Kate" is a closer friend than "Mary-Kate" so we know our
+        # test result isn't due to chance.
+        friend1.n_activities = 0
+        friend2.n_activities = 10
+
+        subject
+        activity.description.must_equal "Shopping with **Mary-Kate Olsen**."
+      end
+    end
+
+    describe "when one name preceeds another before a hyphen" do
+      let(:friend1) { Friends::Friend.new(name: "Mary-Kate Olsen") }
+      let(:friend2) { Friends::Friend.new(name: "Mary Poppins") }
+      let(:description) { "Shopping with Mary-Kate." }
+
+      it "gives precedence to the larger name" do
+        # Make sure "Kate" is a closer friend than "Mary-Kate" so we know our
+        # test result isn't due to chance.
+        friend1.n_activities = 0
+        friend2.n_activities = 10
+
+        subject
+        activity.description.must_equal "Shopping with **Mary-Kate Olsen**."
+      end
+    end
+
+    describe "when one name is contained within another via a hyphen" do
+      let(:friend1) { Friends::Friend.new(name: "Mary-Jo-Kate Olsen") }
+      let(:friend2) { Friends::Friend.new(name: "Jo Stafford") }
+      let(:description) { "Shopping with Mary-Jo-Kate." }
+
+      it "gives precedence to the larger name" do
+        # Make sure "Kate" is a closer friend than "Mary-Kate" so we know our
+        # test result isn't due to chance.
+        friend1.n_activities = 0
+        friend2.n_activities = 10
+
+        subject
+        activity.description.must_equal "Shopping with **Mary-Jo-Kate Olsen**."
+      end
+    end
+
     describe "when name is at end of word" do
       let(:description) { "Field trip to the JimJohn Co." }
       it "does not match a friend" do

data/test/introvert_spec.rb

@@ -2,8 +2,10 @@ require "./test/helper"
 
 describe Friends::Introvert do
   # Add readers to make internal state easier to test.
-  class Friends::Introvert
-    attr_reader :filename, :activities, :friends
+  module Friends
+    class Introvert
+      attr_reader :filename, :activities, :friends
+    end
   end
 
   # Add helpers to set internal states for friends and activities.
@@ -318,7 +320,8 @@ describe Friends::Introvert do
     after { File.delete(filename) if File.exists?(filename) }
 
     it "returns the modified friend" do
-      friend = Friends::Friend.new(name: "Jeff", nickname_str: "a.k.a. The Dude")
+      friend = Friends::Friend.new(name: "Jeff",
+                                   nickname_str: "a.k.a. The Dude")
       stub_friends([friend]) do
         subject.must_equal friend
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.12'
+  version: '0.13'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-16 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '0.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '0.36'
 description: Spend time with the people you care about. Introvert-tested. Extrovert-approved.
 email:
 - jacobevelyn@gmail.com