friends 0.0.1 → 0.0.2

data/test/friend_spec.rb

@@ -1,11 +1,46 @@
 require_relative "helper"
 
 describe Friends::Friend do
-  describe "#name" do
-    subject { Friends::Friend.new(name: "Jacob") }
+  let(:name) { "Jacob Evelyn" }
+  let(:friend) { Friends::Friend.new(name: name) }
 
-    it "returns name" do
-      subject.name.must_equal "Jacob"
+  describe ".deserialize" do
+    subject { Friends::Friend.deserialize(serialized_str) }
+
+    describe "when string is well-formed" do
+      let(:serialized_str) do
+        "#{Friends::Friend::SERIALIZATION_PREFIX}#{name}"
+      end
+
+      it "creates a friend with the correct name" do
+        subject.name.must_equal name
+      end
+    end
+
+    describe "when string is malformed" do
+      let(:serialized_str) { "" }
+
+      it { proc { subject }.must_raise Serializable::SerializationError }
+    end
+  end
+
+  describe "#new" do
+    subject { friend }
+
+    it { subject.name.must_equal name }
+  end
+
+  describe "#serialize" do
+    subject { friend.serialize }
+
+    it { subject.must_equal "#{Friends::Friend::SERIALIZATION_PREFIX}#{name}" }
+  end
+
+  describe "#<=>" do
+    it "sorts alphabetically" do
+      aaron = Friends::Friend.new(name: "Aaron")
+      zeke = Friends::Friend.new(name: "Zeke")
+      [zeke, aaron].sort.must_equal [aaron, zeke]
     end
   end
 end

data/test/helper.rb

@@ -1,7 +1,7 @@
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
-require "friends"
-
 require "minitest/autorun"
 require "minitest/pride"
+
+require "friends"

data/test/introvert_spec.rb

@@ -0,0 +1,213 @@
+require_relative "helper"
+
+describe Friends::Introvert do
+  let(:filename) { "test/tmp/friends.md" }
+  let(:args) { { filename: filename } }
+  let(:introvert) { Friends::Introvert.new(args) }
+  let(:friend_names) { ["George Washington Carver", "Betsy Ross"] }
+  let(:friends) { friend_names.map { |name| Friends::Friend.new(name: name) } }
+  let(:activities) do
+    [
+      Friends::Activity.new(
+        date_s: Date.today.to_s,
+        description: "Lunch with **#{friend_names.first}** and "\
+          "**#{friend_names.last}**."
+      ),
+      Friends::Activity.new(
+        date_s: (Date.today + 1).to_s,
+        description: "Called **#{friend_names.last}**."
+      )
+    ]
+  end
+
+  describe "#new" do
+    it "accepts all arguments" do
+      introvert # Build a new introvert.
+
+      # Check passed values.
+      introvert.filename.must_equal filename
+    end
+
+    it "has sane defaults" do
+      args.clear # Pass no arguments to the initializer.
+      introvert # Build a new introvert.
+
+      # Check default values.
+      introvert.filename.must_equal Friends::Introvert::DEFAULT_FILENAME
+    end
+  end
+
+  describe "#clean" do
+    subject { introvert.clean }
+
+    # Delete the file that is created each time.
+    after { File.delete(filename) }
+
+    it "writes cleaned file" do
+      sorted_friends = friends.sort
+      unsorted_friends = sorted_friends.reverse
+      sorted_activities = activities.sort
+      unsorted_activities = sorted_activities.reverse
+
+      serialized_names = sorted_friends.map(&:serialize)
+      name_output = serialized_names.join("\n")
+
+      serialized_descriptions = sorted_activities.map(&:serialize)
+      descriptions_output = serialized_descriptions.join("\n")
+
+      expected_output =
+        "#{Friends::Introvert::ACTIVITIES_HEADER}\n#{descriptions_output}\n\n"\
+        "#{Friends::Introvert::FRIENDS_HEADER}\n#{name_output}\n"
+
+      # Read the input as unsorted, and make sure we get sorted output.
+      introvert.stub(:friends, unsorted_friends) do
+        introvert.stub(:activities, unsorted_activities) do
+          subject
+          File.read(filename).must_equal expected_output
+        end
+      end
+    end
+
+    it { subject.must_equal filename }
+  end
+
+  describe "#list_friends" do
+    subject { introvert.list_friends }
+
+    it "lists the names of friends" do
+      introvert.stub(:friends, friends) do
+        subject.must_equal friend_names
+      end
+    end
+  end
+
+  describe "#add_friend" do
+    let(:new_friend_name) { "Jacob Evelyn" }
+    subject { introvert.add_friend(name: new_friend_name) }
+
+    describe "when there is no existing friend with that name" do
+      it "adds the given friend" do
+        introvert.stub(:friends, friends) do
+          subject
+          introvert.list_friends.must_include new_friend_name
+        end
+      end
+
+      it "returns the friend added" do
+        introvert.stub(:friends, friends) do
+          subject.name.must_equal new_friend_name
+        end
+      end
+    end
+
+    describe "when there is an existing friend with that name" do
+      let(:new_friend_name) { friend_names.first }
+
+      it "raises an error" do
+        introvert.stub(:friends, friends) do
+          proc { subject }.must_raise Friends::FriendsError
+        end
+      end
+    end
+  end
+
+  describe "#list_activities" do
+    subject { introvert.list_activities(with: with) }
+
+    describe "when not filtering by a friend" do
+      let(:with) { nil }
+
+      it "lists the activities" do
+        introvert.stub(:activities, activities) do
+          subject.must_equal activities.map(&:display_text)
+        end
+      end
+    end
+
+    describe "when filtering by part of a friend's name" do
+      let(:with) { "george" }
+
+      describe "when there is more than one friend match" do
+        let(:friend_names) { ["George Washington Carver", "Boy George"] }
+
+        it "raises an error" do
+          introvert.stub(:friends, friends) do
+            introvert.stub(:activities, activities) do
+              proc { subject }.must_raise Friends::FriendsError
+            end
+          end
+        end
+      end
+
+      describe "when there are no friend matches" do
+        let(:friend_names) { ["Joe"] }
+
+        it "raises an error" do
+          introvert.stub(:friends, friends) do
+            introvert.stub(:activities, activities) do
+              proc { subject }.must_raise Friends::FriendsError
+            end
+          end
+        end
+      end
+
+      describe "when there is exactly one friend match" do
+        it "filters the activities by that friend" do
+          introvert.stub(:friends, friends) do
+            introvert.stub(:activities, activities) do
+              # Only one activity has that friend.
+              subject.must_equal activities[0..0].map(&:display_text)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe "#add_activity" do
+    let(:activity_serialization) { "2014-01-01: Snorkeling with Betsy." }
+    let(:activity_description) { "Snorkeling with **Betsy Ross**." }
+    subject { introvert.add_activity(serialization: activity_serialization) }
+
+    it "adds the given activity" do
+      introvert.stub(:friends, friends) do
+        subject
+        introvert.activities.last.description.must_equal activity_description
+      end
+    end
+
+    it "returns the activity added" do
+      introvert.stub(:friends, friends) do
+        subject.description.must_equal activity_description
+      end
+    end
+  end
+
+  describe "#list_favorites" do
+    subject { introvert.list_favorites(limit: limit) }
+
+    describe "when limit is nil" do
+      let(:limit) { nil }
+
+      it "returns all friends in order of favoritism" do
+        introvert.stub(:friends, friends) do
+          introvert.stub(:activities, activities) do
+            subject.must_equal ["Betsy Ross", "George Washington Carver"]
+          end
+        end
+      end
+    end
+
+    describe "when there are more friends than favorites requested" do
+      let(:limit) { 1 }
+
+      it "returns the number of favorites requested" do
+        introvert.stub(:friends, friends) do
+          introvert.stub(:activities, activities) do
+            subject.must_equal ["Betsy Ross"]
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-24 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +70,16 @@ dependencies:
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 description: Spend time with the people you care about. Introvert-tested. Extrovert-approved.
 email:
 - jacobevelyn@gmail.com
@@ -87,13 +101,18 @@ files:
 - friends.gemspec
 - friends.md
 - lib/friends.rb
-- lib/friends/extrovert.rb
+- lib/friends/activity.rb
 - lib/friends/friend.rb
+- lib/friends/friends_error.rb
 - lib/friends/introvert.rb
+- lib/friends/serializable.rb
 - lib/friends/version.rb
+- test/activity_spec.rb
 - test/friend_spec.rb
 - test/helper.rb
-homepage: ''
+- test/introvert_spec.rb
+- test/tmp/.keep
+homepage: https://github.com/JacobEvelyn/friends
 licenses:
 - MIT
 metadata: {}
@@ -118,5 +137,8 @@ signing_key:
 specification_version: 4
 summary: Spend time with the people you care about.
 test_files:
+- test/activity_spec.rb
 - test/friend_spec.rb
 - test/helper.rb
+- test/introvert_spec.rb
+- test/tmp/.keep

data/lib/friends/extrovert.rb

@@ -1,29 +0,0 @@
-# Extrovert is the public interface for the friends script. It interacts with
-# an Introvert for backend computations.
-
-require "friends/introvert"
-
-require "thor"
-
-module Friends
-  class Extrovert < Thor
-    def initialize(*args)
-      super
-      @introvert = Introvert.new
-    end
-
-    attr_reader :introvert
-
-    class_option :verbose, type: :boolean
-
-    desc "clean", "Cleans your friends.md file"
-    def clean
-      introvert.clean
-    end
-
-    desc "list", "List all friends"
-    def list
-      puts introvert.friends.map(&:name)
-    end
-  end
-end