friends 0.9 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd57717cc27c13b6520090e016a6ddf121aaf9b6
-  data.tar.gz: 2ab6ef28bcbc08fa2144ce1a77c7b5f1ca4c29ad
+  metadata.gz: 2611eb26561b8f7b40bdae56b727170223657de4
+  data.tar.gz: bc6d0a9247e655d9f42c439c2f576fb6dcb0c022
 SHA512:
-  metadata.gz: aa7c94b0e734e6bca501e94eafe6d4e6a40c3b00bf4c5c509b0dc8c0d08db38237cbe0027278203a8521c291513016b7d0716e312a612455478f1cf7982b8337
-  data.tar.gz: 42bd1f835bf0fe0aafbc6e843209d17e02f620626b94a4a0dc6b5cdab933a74ddac450d7c79eddda9c0f34c68426eb8e58835ea1e9b3f9dd4b342245a0449005
+  metadata.gz: d6b161c62dd6b7202e833b0f1a93ddb3b7effe11792b1ba333f905f007180bc9c35ebc8b4105ab873243989eda3256955a984381a0c4e754c681c231b3424b90
+  data.tar.gz: 76f47fc43841a2c225ea25122d560e46f46dd103f3907b96c66472e9d62ea8edc2d3a0932de04e67c003b841c0c020f117e17d1759000bdaf63c933061f6fe75

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Change Log
 
+## [v0.11](https://github.com/JacobEvelyn/friends/tree/v0.11) (2016-01-13)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.10...v0.11)
+
+**Fixed bugs:**
+
+- friends update doesn't correctly compare version numbers [\#72](https://github.com/JacobEvelyn/friends/issues/72)
+- Date gets duplicated with each new activity [\#71](https://github.com/JacobEvelyn/friends/issues/71)
+
+**Merged pull requests:**
+
+- Fix bug in comparing gem versions for update [\#74](https://github.com/JacobEvelyn/friends/pull/74) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Fix bug in how dates are deserialized [\#73](https://github.com/JacobEvelyn/friends/pull/73) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
+## [v0.10](https://github.com/JacobEvelyn/friends/tree/v0.10) (2016-01-12)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.9...v0.10)
+
+**Implemented enhancements:**
+
+- Add --debug flag for error backtraces [\#62](https://github.com/JacobEvelyn/friends/issues/62)
+
+**Fixed bugs:**
+
+- The same name is only highlighted once per description [\#35](https://github.com/JacobEvelyn/friends/issues/35)
+
+**Closed issues:**
+
+- Don't write files in middle of commands [\#60](https://github.com/JacobEvelyn/friends/issues/60)
+- Remove require\_relative from codebase [\#58](https://github.com/JacobEvelyn/friends/issues/58)
+- Cleanly separate Introvert from non-library concerns [\#57](https://github.com/JacobEvelyn/friends/issues/57)
+
+**Merged pull requests:**
+
+- Highlight multiple occurrences [\#70](https://github.com/JacobEvelyn/friends/pull/70) ([GuruKhalsa](https://github.com/GuruKhalsa))
+- Fix Travis badge \(master only\) [\#67](https://github.com/JacobEvelyn/friends/pull/67) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Move activity prompt to bin/friends [\#64](https://github.com/JacobEvelyn/friends/pull/64) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Adds the --debug flag for printing backtraces on error [\#63](https://github.com/JacobEvelyn/friends/pull/63) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Move file writes to end of command actions [\#61](https://github.com/JacobEvelyn/friends/pull/61) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Remove require\_relative from codebase [\#59](https://github.com/JacobEvelyn/friends/pull/59) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.9](https://github.com/JacobEvelyn/friends/tree/v0.9) (2016-01-07)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.8...v0.9)
 

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/friends.svg)](https://badge.fury.io/rb/friends) [![Code Climate](https://codeclimate.com/github/JacobEvelyn/friends/badges/gpa.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Test Coverage](https://codeclimate.com/github/JacobEvelyn/friends/badges/coverage.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Build Status](https://travis-ci.org/JacobEvelyn/friends.svg)](https://travis-ci.org/JacobEvelyn/friends) [![Inline docs](http://inch-ci.org/github/JacobEvelyn/friends.png)](http://inch-ci.org/github/JacobEvelyn/friends) [![ghit.me](https://ghit.me/badge.svg?repo=JacobEvelyn/friends)](https://ghit.me/repo/JacobEvelyn/friends)
+[![Gem Version](https://badge.fury.io/rb/friends.svg)](https://badge.fury.io/rb/friends) [![Code Climate](https://codeclimate.com/github/JacobEvelyn/friends/badges/gpa.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Test Coverage](https://codeclimate.com/github/JacobEvelyn/friends/badges/coverage.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Build Status](https://travis-ci.org/JacobEvelyn/friends.svg?branch=master)](https://travis-ci.org/JacobEvelyn/friends) [![Inline docs](http://inch-ci.org/github/JacobEvelyn/friends.png)](http://inch-ci.org/github/JacobEvelyn/friends) [![ghit.me](https://ghit.me/badge.svg?repo=JacobEvelyn/friends)](https://ghit.me/repo/JacobEvelyn/friends)
 
 # Friends
 

data/bin/friends

@@ -3,11 +3,12 @@
 # Todo:
 # - Split out serialization into separate repository.
 # - Add auto check for updates.
-# - Allow friends to have nicknames.
 # - Allow easy editing of most recent entry.
 
 require "gli"
 require "paint"
+require "readline"
+require "semverse"
 
 require "friends/introvert"
 require "friends/version"
@@ -31,9 +32,9 @@ flag [:filename],
   default_value: "./friends.md",
   desc: "Set the location of the friends file"
 
-switch [:clean],
+switch [:debug],
   negatable: false,
-  desc: "Force a clean write of the friends file"
+  desc: "Debug error messages with a full backtrace"
 
 desc "Updates the `friends` program"
 command :update do |update|
@@ -41,7 +42,8 @@ command :update do |update|
     search = `gem search friends`
     if match = search.match(/^friends\s\(([^\)]+)\)$/)
       remote_version = match[1]
-      if remote_version.to_r > Friends::VERSION.to_r
+      if Semverse::Version.coerce(remote_version) >
+         Semverse::Version.coerce(Friends::VERSION)
         `gem update friends && gem cleanup friends`
         if $?.success?
           puts Paint["Updated to friends #{remote_version}", :bold, :green]
@@ -116,6 +118,7 @@ command :add do |add|
     add_friend.action do |_, _, args|
       friend = @introvert.add_friend(name: args.first)
       @message = "Friend added: \"#{friend.name}\""
+      @dirty = true # Mark the file for cleaning.
     end
   end
 
@@ -124,7 +127,15 @@ command :add do |add|
   add.command :activity do |add_activity|
     add_activity.action do |_, _, args|
       activity = @introvert.add_activity(serialization: args.first)
+
+      # If there's no description, prompt the user for one.
+      if !activity.description
+        activity.description = Readline.readline(activity.display_text)
+        activity.highlight_friends(introvert: @introvert)
+      end
+
       @message = "Activity added: \"#{activity.display_text}\""
+      @dirty = true # Mark the file for cleaning.
     end
   end
 
@@ -134,6 +145,7 @@ command :add do |add|
     add_nickname.action do |_, _, args|
       friend = @introvert.add_nickname(name: args.first, nickname: args[1])
       @message = "Nickname added: \"#{friend}\""
+      @dirty = true # Mark the file for cleaning.
     end
   end
 end
@@ -146,6 +158,7 @@ command :remove do |remove|
     remove_nickname.action do |_, _, args|
       friend = @introvert.remove_nickname(name: args.first, nickname: args[1])
       @message = "Nickname removed: \"#{friend}\""
+      @dirty = true # Mark the file for cleaning.
     end
   end
 end
@@ -192,8 +205,8 @@ end
 desc "Cleans your friends.md file"
 command :clean do |clean|
   clean.action do
-    filename = @introvert.clean
-    @message = "File cleaned: \"#{filename}\""
+    @clean_command = true
+    @dirty = true # Mark the file for cleaning.
   end
 end
 
@@ -209,6 +222,8 @@ end
 
 # Before each command, clean up all arguments and create the global Introvert.
 pre do |global_options, _, options|
+  @debug_mode = global_options[:debug]
+
   final_options = global_options.merge!(options).select do |key, _|
     [:filename].include? key
   end
@@ -218,11 +233,12 @@ pre do |global_options, _, options|
 end
 
 post do |global_options|
-  # After each command, clean if requested with the --clean flag.
-  if global_options[:clean]
-    filename = @introvert.clean
-    @message = "File cleaned: \"#{filename}\""
-  end
+  # 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]
@@ -230,7 +246,11 @@ end
 
 # If an error is raised, print the message to STDERR and exit the program.
 on_error do |error|
-  abort "Error: #{error}"
+  if @debug_mode
+    raise error
+  else
+    abort "Error: #{error}"
+  end
 end
 
 # Run the program and return the exit code corresponding to its success.

data/friends.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "gli", "~> 2.12"
   spec.add_dependency "memoist", "~> 0.11"
   spec.add_dependency "paint", "~> 1.0"
+  spec.add_dependency "semverse", "~> 1.2"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"

data/lib/friends/activity.rb

@@ -83,12 +83,10 @@ module Friends
       # make those substitutions.
       regex_map.
         select { |_, arr| arr.size == 1 }.each do |regex, friend_list|
-        if match = @description.match(regex)
+        if @description.match(regex)
           friend = friend_list.first # There's only one friend in the list.
           matched_friends << friend
-          @description = "#{match.pre_match}"\
-            "**#{friend.name}**"\
-            "#{match.post_match}"
+          @description.gsub!(regex, "**#{friend.name}**")
         end
       end
 
@@ -113,19 +111,17 @@ module Friends
       # guess.
       regex_map.
         reject { |_, arr| arr.size == 1 }.each do |regex, friend_list|
-        if match = @description.match(regex)
+        if @description.match(regex)
           guessed_friend = friend_list.sort_by do |friend|
             [-friend.likelihood_score, -friend.n_activities]
           end.first
-          @description = "#{match.pre_match}"\
-            "**#{guessed_friend.name}**"\
-            "#{match.post_match}"
+          @description.gsub!(regex, "**#{guessed_friend.name}**")
         end
       end
 
       # Lastly, we remove any backslashes, as these are used to escape friends'
       # names that we don't want to match.
-      @description.gsub!("\\", "")
+      @description.delete!("\\")
     end
 
     # @param friend [Friend] the friend to test

data/lib/friends/introvert.rb

@@ -2,8 +2,6 @@
 # able to be used directly within another Ruby program, without needing to call
 # the command-line script explicitly.
 
-require "readline"
-
 require "friends/activity"
 require "friends/friend"
 require "friends/friends_error"
@@ -18,7 +16,6 @@ module Friends
     # @param filename [String] the name of the friends Markdown file
     def initialize(filename: DEFAULT_FILENAME)
       @filename = filename
-      @cleaned_file = false # Switches to true when the file is cleaned.
 
       # Read in the input file. It's easier to do this now and optimize later
       # than try to overly be clever about what we read and write.
@@ -27,10 +24,6 @@ module Friends
 
     # Write out the friends file with cleaned/sorted data.
     def clean
-      # Short-circuit if we've already cleaned the file so we don't write it
-      # twice.
-      return @filename if @cleaned_file
-
       descriptions = @activities.sort.map(&:serialize)
       names = @friends.sort.map(&:serialize)
 
@@ -43,8 +36,6 @@ module Friends
         names.each { |name| file.puts(name) }
       end
 
-      @cleaned_file = true
-
       @filename
     end
 
@@ -64,7 +55,6 @@ module Friends
       end
 
       @friends << friend
-      clean # Write a cleaned file.
 
       friend # Return the added friend.
     end
@@ -79,12 +69,8 @@ module Friends
         raise FriendsError, e
       end
 
-      # If there's no description, prompt the user for one.
-      activity.description ||= Readline.readline(activity.display_text)
-
-      activity.highlight_friends(introvert: self)
+      activity.highlight_friends(introvert: self) if activity.description
       @activities.unshift(activity)
-      clean # Write a cleaned file.
 
       activity # Return the added activity.
     end
@@ -97,9 +83,6 @@ module Friends
     def add_nickname(name:, nickname:)
       friend = friend_with_name_in(name)
       friend.add_nickname(nickname.strip)
-
-      clean # Write a cleaned file.
-
       friend
     end
 
@@ -112,9 +95,6 @@ module Friends
     def remove_nickname(name:, nickname:)
       friend = friend_with_name_in(name)
       friend.remove_nickname(nickname.strip)
-
-      clean # Write a cleaned file.
-
       friend
     end
 

data/lib/friends/version.rb

@@ -1,3 +1,3 @@
 module Friends
-  VERSION = "0.9"
+  VERSION = "0.11"
 end

data/test/activity_spec.rb

@@ -1,4 +1,4 @@
-require_relative "helper"
+require "./test/helper"
 
 describe Friends::Activity do
   let(:date) { Date.today }
@@ -174,6 +174,16 @@ describe Friends::Activity do
       end
     end
 
+    describe "when a friend's name is mentioned multiple times" do
+      let(:description) { "Dinner with Elizabeth.  Elizabeth made us pasta." }
+      it "highlights all occurrences of the friend's name" do
+        subject
+        activity.description.
+          must_equal "Dinner with **Elizabeth Cady Stanton**."\
+                     "  **Elizabeth Cady Stanton** made us pasta."
+      end
+    end
+
     describe "when there are multiple matches" do
       describe "when there is context from past activities" do
         let(:description) { "Dinner with Elizabeth and John." }

data/test/friend_spec.rb

@@ -1,4 +1,4 @@
-require_relative "helper"
+require "./test/helper"
 
 describe Friends::Friend do
   let(:friend_name) { "Jacob Evelyn" }

data/test/introvert_spec.rb

@@ -1,4 +1,4 @@
-require_relative "helper"
+require "./test/helper"
 
 describe Friends::Introvert do
   # Add readers to make internal state easier to test.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.11'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: semverse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement