friends 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0669a8ff237217895bb3647d19c2c3619c455f
-  data.tar.gz: b1df12a309fff583eef49f10c52175ec02b53cc1
+  metadata.gz: 788d17a21f2929e7936d68922b971ffcc907a8c4
+  data.tar.gz: f710eec4282c863b8e51d1d556478e3b23622aad
 SHA512:
-  metadata.gz: 885edb6c2f561e23be58f81dec6cffcc22829cab66f0a3f3e482184dfb939f2391200cf52b2d870c68d00d198356f2c8da5a4645561759cccd945f369135d06c
-  data.tar.gz: 00f795cfd5f597f83dfb9c1d0a77b04f95eca041b7a2b97ab4d15e2d03aebd908cd4c95e7ae245f779debbfaac5827de2dcf58b9a1dd32eae6e08b2dc904f35e
+  metadata.gz: b1de80c141a69d80ed9ce39f7629f0563a7bdf9efc48617036eaf410935b2b7f8b5bd4f08f60e5965462aea610f570882958024962e05fcb43e0e23509574116
+  data.tar.gz: 25b629ba4fd48f298c38ca17cb351f548001dd6320e0987a560dc29a6197605c15425f8bcd83ebe52a3cb18a871e79643b826ba4cab29e7c9ef92e8da96fed29

data/README.md

@@ -87,6 +87,14 @@ Your favorite friends:
 1. George Washington Carver (2 activities)
 2. Grace Hopper             (1)
 ```
+Graph your relationship with a friend over time:
+```
+$ friends graph "George"
+Nov 2014 |█
+Dec 2014 |
+Jan 2015 |█████
+Feb 2015 |███
+```
 
 ### Global options:
 

data/bin/friends

@@ -29,16 +29,16 @@ switch [:clean],
   desc: "Force a clean write of the friends file"
 
 desc "Lists friends or activities"
-command :list do |c|
-  c.desc "List all friends"
-  c.command :friends do |list_friends|
+command :list do |list|
+  list.desc "List all friends"
+  list.command :friends do |list_friends|
     list_friends.action do
       puts @introvert.list_friends
     end
   end
 
-  c.desc "List favorite friends"
-  c.command :favorites do |list_favorites|
+  list.desc "List favorite friends"
+  list.command :favorites do |list_favorites|
     list_favorites.flag [:limit],
       arg_name: "NUMBER",
       default_value: 10,
@@ -61,8 +61,8 @@ command :list do |c|
     end
   end
 
-  c.desc "Lists all activities"
-  c.command :activities do |list_activities|
+  list.desc "Lists all activities"
+  list.command :activities do |list_activities|
     list_activities.flag [:limit],
       arg_name: "NUMBER",
       default_value: 10,
@@ -80,19 +80,19 @@ command :list do |c|
 end
 
 desc "Adds a friend or activity"
-command :add do |c|
-  c.desc "Adds a friend"
-  c.arg_name "NAME"
-  c.command :friend do |add_friend|
+command :add do |add|
+  add.desc "Adds a friend"
+  add.arg_name "NAME"
+  add.command :friend do |add_friend|
     add_friend.action do |_, _, args|
       friend = @introvert.add_friend(name: args.first)
       @message = "Friend added: \"#{friend.name}\""
     end
   end
 
-  c.desc "Adds an activity"
-  c.arg_name "DESCRIPTION"
-  c.command :activity do |add_activity|
+  add.desc "Adds an activity"
+  add.arg_name "DESCRIPTION"
+  add.command :activity do |add_activity|
     add_activity.action do |_, _, args|
       activity = @introvert.add_activity(serialization: args.first)
       @message = "Activity added: \"#{activity.display_text}\""
@@ -100,9 +100,20 @@ command :add do |c|
   end
 end
 
+desc "Graph"
+arg_name "NAME"
+command :graph do |graph|
+  graph.action do |_, _, args|
+    data = @introvert.graph(name: args.first)
+    data.each do |month, count|
+      puts "#{month} |#{'█' * count}"
+    end
+  end
+end
+
 desc "Cleans your friends.md file"
-command :clean do |c|
-  c.action do
+command :clean do |clean|
+  clean.action do
     filename = @introvert.clean
     @message = "File cleaned: \"#{filename}\""
   end

data/lib/friends/activity.rb

@@ -89,6 +89,12 @@ module Friends
       @description = new_description
     end
 
+    # @param friend [Friend] the friend to test
+    # @return [Boolean] true iff this activity includes the given friend
+    def includes_friend?(friend:)
+      friend_names.include? friend.name
+    end
+
     # Find the names of all friends in this description.
     # @return [Array] list of all friend names in the description
     def friend_names

data/lib/friends/introvert.rb

@@ -11,6 +11,7 @@ module Friends
     DEFAULT_FILENAME = "./friends.md"
     ACTIVITIES_HEADER = "### Activities:"
     FRIENDS_HEADER = "### Friends:"
+    GRAPH_DATE_FORMAT = "%b %Y" # Used as the param for date.strftime().
 
     # @param filename [String] the name of the friends Markdown file
     def initialize(filename: DEFAULT_FILENAME)
@@ -131,18 +132,8 @@ module Friends
 
       # Filter by friend name if argument is passed.
       unless with.nil?
-        friends = friends_with_name_in(with)
-
-        case friends.size
-        when 1
-          # If exactly one friend matches, use that friend to filter.
-          acts = acts.select { |a| a.friend_names.include? friends.first.name }
-        when 0 then raise FriendsError, "No friend found for \"#{with}\""
-        else
-          raise FriendsError,
-                "More than one friend found for \"#{with}\": "\
-                  "#{friends.map(&:name).join(', ')}"
-        end
+        friend = friend_with_name_in(with)
+        acts = acts.select { |act| act.includes_friend?(friend: friend) }
       end
 
       # If we need to, trim the list.
@@ -151,6 +142,38 @@ module Friends
       acts.map(&:display_text)
     end
 
+    # Find data points for graphing a given friend's relationship over time.
+    # @param name [String] the name of the friend to use
+    # @return [Hash] with the following format:
+    #   {
+    #     "Jan 2015" => 3,  # The month and number of activities with that
+    #     "Feb 2015" => 0, # friend during that month.
+    #     "Mar 2015" => 9
+    #   }
+    #   The keys of the hash are all of the months (inclusive) between the first
+    #   and last month in which activities for the given friend have been
+    #   recorded.
+    def graph(name:)
+      friend = friend_with_name_in(name) # Find the friend by name.
+
+      # Filter out activities that don't include the given friend.
+      acts = activities.select { |act| act.includes_friend?(friend: friend) }
+
+      # Initialize the table of activities to have all of the months of that
+      # friend's activity range (including months in the middle of the range
+      # with no relevant activities).
+      act_table = {}
+      (acts.last.date..acts.first.date).each do |date|
+        act_table[date.strftime(GRAPH_DATE_FORMAT)] = 0
+      end
+
+      acts.each do |activity|
+        month = activity.date.strftime(GRAPH_DATE_FORMAT)
+        act_table[month] += 1
+      end
+      act_table
+    end
+
     # Sets the n_activities field on each friend.
     def set_n_activities!
       # Construct a hash of friend name to frequency of appearance.
@@ -233,7 +256,25 @@ module Friends
       end
     end
 
-    # @param name [String] the name of the friends to search for
+    # @param text [String] the name (or substring) of the friend to search for
+    # @return [Friend] the friend that matches
+    # @raise [FriendsError] if 0 of 2+ friends match the given text
+    def friend_with_name_in(text)
+      friends = friends_with_name_in(text)
+
+      case friends.size
+      when 1
+        # If exactly one friend matches, use that friend.
+        return friends.first
+      when 0 then raise FriendsError, "No friend found for \"#{text}\""
+      else
+        raise FriendsError,
+              "More than one friend found for \"#{text}\": "\
+                "#{friends.map(&:name).join(', ')}"
+      end
+    end
+
+    # @param text [String] the name (or substring) of the friends to search for
     # @return [Array] a list of all friends that match the given text
     def friends_with_name_in(text)
       regex = Regexp.new(text, Regexp::IGNORECASE)

data/lib/friends/version.rb

@@ -1,3 +1,3 @@
 module Friends
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/activity_spec.rb

@@ -184,6 +184,26 @@ describe Friends::Activity do
     end
   end
 
+  describe "#includes_friend?" do
+    subject { activity.includes_friend?(friend: friend) }
+
+    describe "when the given friend is in the activity" do
+      let(:friend) { friend1 }
+
+      it "returns true" do
+        subject.must_equal true
+      end
+    end
+
+    describe "when the given friend is not in the activity" do
+      let(:friend) { Friends::Friend.new(name: "Claude Debussy") }
+
+      it "returns false" do
+        subject.must_equal false
+      end
+    end
+  end
+
   describe "#friend_names" do
     subject { activity.friend_names }
 

data/test/introvert_spec.rb

@@ -14,7 +14,7 @@ describe Friends::Introvert do
           "**#{friend_names.last}**."
       ),
       Friends::Activity.new(
-        date_s: (Date.today + 1).to_s,
+        date_s: (Date.today - 1).to_s,
         description: "Called **#{friend_names.last}**."
       )
     ]
@@ -261,4 +261,77 @@ describe Friends::Introvert do
       end
     end
   end
+
+  describe "#graph" do
+    subject { introvert.graph(name: friend_name) }
+
+    describe "when friend name is invalid" do
+      let(:friend_name) { "Oscar the Grouch" }
+
+      it "raises an error" do
+        proc { subject }.must_raise Friends::FriendsError
+      end
+    end
+
+    describe "when friend name has more than one match" do
+      let(:friend_name) { "e" }
+
+      it "raises an error" do
+        introvert.stub(:friends, friends) do
+          proc { subject }.must_raise Friends::FriendsError
+        end
+      end
+    end
+
+    describe "when friend name is valid" do
+      let(:friend_name) { "George" }
+      let(:activities) do
+        [
+          Friends::Activity.new(
+            date_s: Date.today.to_s,
+            description: "Lunch with **George Washington Carver**."
+          ),
+
+          # Create another activity with a gap of over a month between it and
+          # the next activity, so we can test that we correctly return data for
+          # months in the range with no activities.
+          Friends::Activity.new(
+            date_s: (Date.today - 70).to_s,
+            description: "Called **George Washington Carver**."
+          ),
+
+          # Create an activity that doesn't involve our friend name.
+          Friends::Activity.new(
+            date_s: (Date.today - 150).to_s,
+            description: "Called **Betsy Ross** on the phone."
+          )
+        ]
+      end
+
+      it "returns a hash of months and frequencies" do
+        introvert.stub(:friends, friends) do
+          introvert.stub(:activities, activities) do
+            strftime_format = Friends::Introvert::GRAPH_DATE_FORMAT
+
+            first = activities[0]
+            second = activities[1]
+            months = (second.date..first.date).map do |date|
+              date.strftime(strftime_format)
+            end.uniq
+
+            # Make sure all of the months are in our output data set (even the
+            # months with no relevant activity). This also checks that the
+            # irrelevant activity is not in our data set.
+            subject.keys.must_equal(months)
+
+            # Check that the activities for George are recorded, and that all
+            # other months have no activities recorded.
+            subject[first.date.strftime(strftime_format)].must_equal 1
+            subject[second.date.strftime(strftime_format)].must_equal 1
+            subject.values.inject(:+).must_equal 2
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jacob Evelyn