friends 0.11 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2611eb26561b8f7b40bdae56b727170223657de4
-  data.tar.gz: bc6d0a9247e655d9f42c439c2f576fb6dcb0c022
+  metadata.gz: b6fbeed1512a5fb14b7a89e5afebe885e48817ea
+  data.tar.gz: e4fa97ba906eb037fc70da65704aa33a456e0a99
 SHA512:
-  metadata.gz: d6b161c62dd6b7202e833b0f1a93ddb3b7effe11792b1ba333f905f007180bc9c35ebc8b4105ab873243989eda3256955a984381a0c4e754c681c231b3424b90
-  data.tar.gz: 76f47fc43841a2c225ea25122d560e46f46dd103f3907b96c66472e9d62ea8edc2d3a0932de04e67c003b841c0c020f117e17d1759000bdaf63c933061f6fe75
+  metadata.gz: 883ef235fc6d26aec8bc03ac5a72794e643f1d7d501944a5e5c587bf0451ed55320562b1188161616cd88e1c952ddfccce746d8a369cf05a080d0bd6cda5b2d3
+  data.tar.gz: 51557fe1705cf9d812087c5b7b3d5397517f48232a56668267ce8000d94301b7208b430dbf9f97c67694a50ce09f4d079b6f57e9033b084f6f10a0fe928c788b

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [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)
+
+**Implemented enhancements:**
+
+- Add examples for rename command in README [\#76](https://github.com/JacobEvelyn/friends/issues/76)
+- Add change name command [\#68](https://github.com/JacobEvelyn/friends/issues/68)
+
+**Merged pull requests:**
+
+- Update README and CONTRIBUTING docs. Closes \#76 [\#77](https://github.com/JacobEvelyn/friends/pull/77) ([JacobEvelyn](https://github.com/JacobEvelyn))
+- Add rename friend [\#75](https://github.com/JacobEvelyn/friends/pull/75) ([bloomyminded](https://github.com/bloomyminded))
+
 ## [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)
 

data/CONTRIBUTING.md

@@ -18,7 +18,8 @@ that's great as well!
 6. Make your changes. Add or modify tests if necessary!
 (Run tests with `rake test`.) Do your best to conform to
 existing style and commenting patterns.
-7. Commit your changes
+7. Update the `README.md` as necessary to include your changes.
+8. Commit your changes
 (`git commit -am "Add some feature"`). You should see
 output from
 [`overcommit`](https://github.com/brigade/overcommit) as
@@ -44,10 +45,10 @@ it runs commit hooks that looks something like this:
   how! This practice is meant to keep the code clean but
   it shouldn't be scary and it's totally fine to need
   help!
-8. Push your changes to GitHub, and open a Pull Request.
-9. Your code will be reviewed and merged as quickly as
+9. Push your changes to GitHub, and open a Pull Request.
+10. Your code will be reviewed and merged as quickly as
 possible!
-10. Check yourself out on the [contributors page](https://github.com/JacobEvelyn/friends/graphs/contributors)! Look at how cool you are!
+11. Check yourself out on the [contributors page](https://github.com/JacobEvelyn/friends/graphs/contributors)! Look at how cool you are!
 
 If you have any questions at all or get stuck on any step,
 don't hesitate to

data/README.md

@@ -82,6 +82,11 @@ And they can be removed as well:
 $ friends remove nickname "Grace Hopper" "The Admiral"
 Nickname removed: "Grace Hopper (a.k.a. Amazing Grace)"
 ```
+##### Change a friend's name:
+```
+$ friends rename friend "Grace Hopper" "Grace Brewster Murray Hopper"
+Name changed: "Grace Brewster Murray Hopper (a.k.a. Amazing Grace)"
+```
 ##### Suggest a friend to do something with:
 ```
 $ friends suggest

data/bin/friends

@@ -220,6 +220,20 @@ command :stats do |stats|
   end
 end
 
+desc "Renames a friend"
+command :rename do |rename|
+  rename.desc "Renames a friend"
+  rename.arg_name "NAME NEW_NAME"
+  rename.command :friend do |rename_friend|
+    rename_friend.action do |_, _, args|
+      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
+end
+
 # Before each command, clean up all arguments and create the global Introvert.
 pre do |global_options, _, options|
   @debug_mode = global_options[:debug]

data/lib/friends/activity.rb

@@ -124,6 +124,17 @@ module Friends
       @description.delete!("\\")
     end
 
+    # Updates a friend's old_name to their new_name
+    # @param [String] old_name
+    # @param [String] new_name
+    # @return [String] if name found in description
+    # @return [nil] if no change was made
+    def update_name(old_name:, new_name:)
+      description.gsub!(
+        Regexp.new("(?<=\\*\\*)#{old_name}(?=\\*\\*)"),
+        new_name)
+    end
+
     # @param friend [Friend] the friend to test
     # @return [Boolean] true iff this activity includes the given friend
     def includes_friend?(friend:)

data/lib/friends/friend.rb

@@ -49,6 +49,13 @@ module Friends
       @nicknames.uniq!
     end
 
+    # Renames a friend, avoiding duplicates and stripping surrounding
+    # whitespace.
+    # @param new_name [String] the friend's new name
+    def rename(new_name)
+      @name = new_name
+    end
+
     # @param nickname [String] the nickname to remove
     # @return [Boolean] true if the nickname was present, false otherwise
     def remove_nickname(nickname)

data/lib/friends/introvert.rb

@@ -75,6 +75,20 @@ module Friends
       activity # Return the added activity.
     end
 
+    # Rename an existing added friend.
+    # @param old_name [String] the name of the friend
+    # @param new_name [String] the new name of the friend
+    # @raise [FriendsError] if 0 of 2+ friends match the given name
+    # @return [Friend] the existing friend
+    def rename_friend(old_name:, new_name:)
+      friend = friend_with_name_in(old_name.strip)
+      @activities.each do |activity|
+        activity.update_name(old_name: friend.name, new_name: new_name.strip)
+      end
+      friend.rename(new_name.strip)
+      friend
+    end
+
     # Add a nickname to an existing friend and write out the new friends file.
     # @param name [String] the name of the friend
     # @param nickname [String] the nickname to add to the friend

data/lib/friends/version.rb

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

data/test/activity_spec.rb

@@ -298,4 +298,34 @@ describe Friends::Activity do
       [past_act, future_act].sort.must_equal [future_act, past_act]
     end
   end
+
+  describe "#update_name" do
+    let(:description) { "Lunch with **John Candy**." }
+    subject do
+      activity.update_name(old_name: "John Candy", new_name: "John Cleese")
+    end
+
+    it "renames the given friend in the description" do
+      subject.must_equal "Lunch with **John Cleese**."
+    end
+
+    describe "when the description contains a fragment of the old name" do
+      let(:description) { "Lunch with **John Candy** at Johnny's Diner." }
+
+      it "only replaces the name" do
+        subject.must_equal "Lunch with **John Cleese** at Johnny's Diner."
+      end
+    end
+
+    describe "when the description contains the complete old name" do
+      let(:description) { "Coffee with **John** at John's Studio." }
+      subject do
+        activity.update_name(old_name: "John", new_name: "Joe")
+      end
+
+      it "only replaces the actual name" do
+        subject.must_equal "Coffee with **Joe** at John's Studio."
+      end
+    end
+  end
 end

data/test/friend_spec.rb

@@ -30,6 +30,15 @@ describe Friends::Friend do
     it { subject.name.must_equal friend_name }
   end
 
+  describe "#rename" do
+    subject { friend }
+
+    it "renames the friend" do
+      friend.rename("Ada Lovelace")
+      subject.name.must_equal "Ada Lovelace"
+    end
+  end
+
   describe "#serialize" do
     subject { friend.serialize }
 

data/test/introvert_spec.rb

@@ -259,6 +259,41 @@ describe Friends::Introvert do
     end
   end
 
+  describe "#rename_friend" do
+    let(:new_name) { "David Bowie" }
+    subject do
+      introvert.rename_friend(old_name: friend_names.last, new_name: new_name)
+    end
+
+    it "replaces old name within activities to the new name" do
+      stub_friends(friends) do
+        stub_activities(activities) do
+          subject
+          introvert.activities.first.description.must_include new_name
+          introvert.activities.last.description.must_include new_name
+        end
+      end
+    end
+
+    describe "when given names with leading and trailing spaces" do
+      let(:new_name) { "    David Bowie " }
+      let(:old_name) { friend_names.last + "    " }
+      subject do
+        introvert.rename_friend(old_name: old_name, new_name: new_name)
+      end
+
+      it "correctly strips the spaces" do
+        stub_friends(friends) do
+          stub_activities(activities) do
+            subject
+            introvert.activities.first.description.must_include "David Bowie"
+            introvert.activities.last.description.must_include "David Bowie"
+          end
+        end
+      end
+    end
+  end
+
   describe "#add_nickname" do
     subject do
       introvert.add_nickname(name: friend_names.first, nickname: "The Dude")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli