ppl 1.23.0 → 1.24.0

data/lib/ppl/service/email_address.rb

@@ -0,0 +1,37 @@
+
+class Ppl::Service::EmailAddress
+
+  attr_writer :storage
+
+  def add(contact, address, options)
+    email_address = Ppl::Entity::EmailAddress.new(address)
+    contact.email_addresses << email_address
+    update_email_address(contact, email_address, options)
+    @storage.save_contact(contact)
+  end
+
+  def update(contact, address, options)
+    email_address = contact.email_addresses.find { |e| e.address == address }
+    update_email_address(contact, email_address, options)
+    @storage.save_contact(contact)
+  end
+
+  def remove(contact, address)
+    contact.email_addresses.select! do |email_address|
+      email_address.address != address
+    end
+    @storage.save_contact(contact)
+  end
+
+  private
+
+  def update_email_address(contact, email_address, options)
+    if options[:preferred] == true
+      contact.email_addresses.each { |e| e.preferred = (e.address == email_address.address) }
+    elsif options[:preferred] == false
+      email_address.preferred = false
+    end
+  end
+
+end
+

data/lib/ppl/service/phone_number.rb

@@ -0,0 +1,40 @@
+
+class Ppl::Service::PhoneNumber
+
+  attr_writer :storage
+
+  def add(contact, number, options)
+    phone_number = Ppl::Entity::PhoneNumber.new(number)
+    contact.phone_numbers << phone_number
+    update_phone_number(contact, phone_number, options)
+    @storage.save_contact(contact)
+  end
+
+  def update(contact, number, options)
+    matching_numbers = contact.phone_numbers.select { |p| p.number == number }
+    matching_numbers.each { |mn| update_phone_number(contact, mn, options) }
+    @storage.save_contact(contact)
+  end
+
+  def remove(contact, number)
+    contact.phone_numbers.select! do |phone_number|
+      phone_number.number != number
+    end
+    @storage.save_contact(contact)
+  end
+
+  private
+
+  def update_phone_number(contact, phone_number, options)
+    if options[:type]
+      phone_number.type = options[:type]
+    end
+    if options[:preferred] == true
+      contact.phone_numbers.each { |p| p.preferred = (p.number == phone_number.number) }
+    elsif options[:preferred] == false
+      phone_number.preferred = false
+    end
+  end
+
+end
+

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.23.0"
+  Version = "1.24.0"
 
   module Adapter
   end
@@ -21,6 +21,9 @@ module Ppl
   module Format
   end
 
+  module Service
+  end
+
 end
 
 
@@ -70,6 +73,7 @@ require "ppl/command/scrape"
 
 require "ppl/entity/address_book"
 require "ppl/entity/contact"
+require "ppl/entity/email_address"
 require "ppl/entity/phone_number"
 require "ppl/entity/postal_address"
 
@@ -104,6 +108,9 @@ require "ppl/format/postal_address"
 require "ppl/format/postal_address/one_line"
 require "ppl/format/table"
 
+require "ppl/service/email_address"
+require "ppl/service/phone_number"
+
 class String
   alias_method :each, :each_line
 end

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.23.0"
-  spec.date        = "2013-04-21"
+  spec.version     = "1.24.0"
+  spec.date        = "2013-04-23"
 
   spec.required_ruby_version = ">= 1.9.3"
 

data/spec/ppl/adapter/vcard/greencard_spec.rb

@@ -19,15 +19,28 @@ describe Ppl::Adapter::Vcard::GreenCard, "#encode" do
   end
 
   it "should encode the contact's email address" do
-    @contact.email_addresses = ["john@example.org"]
+    @contact.email_addresses << Ppl::Entity::EmailAddress.new("john@example.org")
     @adapter.encode(@contact).should include("EMAIL:john@example.org")
   end
 
+  it "should encode the contact's preferred email address as such" do
+    email_address = Ppl::Entity::EmailAddress.new("john@example.org")
+    email_address.preferred = true
+    @contact.email_addresses << email_address
+    @adapter.encode(@contact).should include("EMAIL;TYPE=pref:john@example.org")
+  end
+
   it "should encode the contact's phone number" do
     @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("01234567890")
     @adapter.encode(@contact).should include("TEL:01234567890")
   end
 
+  it "should encode the contact's preferred phone number as such" do
+    @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("01234567890")
+    @contact.phone_numbers[0].preferred = true
+    @adapter.encode(@contact).should include("TEL;TYPE=pref:01234567890")
+  end
+
   it "should encode the contact's phone number's type" do
     @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("01234567890", "cell")
     @adapter.encode(@contact).should include("TEL;TYPE=cell:01234567890")
@@ -137,7 +150,19 @@ describe Ppl::Adapter::Vcard::GreenCard, "#decode" do
       "END:VCARD",
     ].join("\n")
     contact = @adapter.decode(vcard)
-    contact.email_addresses.first.should eq "home@example.org"
+    contact.email_addresses.first.address.should eq "home@example.org"
+  end
+
+  it "should mark preferred email addresses as such" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "EMAIL;PREF:home@example.org",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    contact.email_addresses.first.preferred.should eq true
   end
 
   it "should decode the contact's phone number" do
@@ -153,6 +178,19 @@ describe Ppl::Adapter::Vcard::GreenCard, "#decode" do
     phone_number.number.should eq "01234567890"
   end
 
+  it "should mark preferred phone numbers as such" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "TEL;TYPE=pref:01234567890",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    phone_number = contact.phone_numbers.first
+    phone_number.preferred.should eq true
+  end
+
   it "should decode the contact's phone number's type" do
     vcard = [
       "BEGIN:VCARD",

data/spec/ppl/command/email_spec.rb

@@ -11,5 +11,63 @@ describe Ppl::Command::Email do
     end
   end
 
+  describe "#execute" do
+
+    before(:each) do
+      @contact = Ppl::Entity::Contact.new
+      @service = double(Ppl::Service::EmailAddress)
+      @storage = double(Ppl::Adapter::Storage)
+      @input = Ppl::Application::Input.new
+      @output = double(Ppl::Application::Output)
+      @list_format = double(Ppl::Format::AddressBook)
+      @show_format = double(Ppl::Format::Contact)
+      @storage.stub(:require_contact).and_return(@contact)
+      @storage.stub(:save_contact)
+      @command.storage = @storage
+      @command.email_service = @service
+      @command.list_format = @list_format
+      @command.show_format = @show_format
+    end
+
+    it "should list all email addresses by default" do
+      @storage.should_receive(:load_address_book).and_return(@address_book)
+      @list_format.should_receive(:process).and_return("imagine this is a list")
+      @output.should_receive(:line).with("imagine this is a list")
+      @command.execute(@input, @output)
+    end
+
+    it "should show a single contact's addresses if one is specified" do
+      @input.arguments << "jdoe"
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @show_format.should_receive(:process).and_return("imagine this is a list")
+      @output.should_receive(:line).with("imagine this is a list")
+      @command.execute(@input, @output)
+    end
+    
+    it "should delegate to the service layer to add a new email address" do
+      @input.arguments = ["jdoe", "jdoe@example.org"]
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @service.should_receive(:add).with(@contact, "jdoe@example.org", @input.options)
+      @command.execute(@input, @output)
+    end
+
+    it "should delegate to the service layer to update an existing address" do
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("jdoe@example.org")
+      @input.arguments = ["jdoe", "jdoe@example.org"]
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @service.should_receive(:update).with(@contact, "jdoe@example.org", {})
+      @command.execute(@input, @output)
+    end
+
+    it "should delegate to the service layer to remove an email address" do
+      @input.arguments = ["jdoe", "jdoe@example.org"]
+      @input.options[:delete] = true
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @service.should_receive(:remove).with(@contact, "jdoe@example.org")
+      @command.execute(@input, @output)
+    end
+
+  end
+
 end
 

data/spec/ppl/command/mutt_spec.rb

@@ -37,7 +37,7 @@ describe Ppl::Command::Mutt do
     it "should return email address matches" do
 
       @contact.name = "Test User"
-      @contact.email_addresses.push "test@example.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("test@example.org")
       @address_book.contacts.push(@contact)
 
       @input.arguments.push "example"
@@ -55,13 +55,13 @@ describe Ppl::Command::Mutt do
       @input.arguments.push "prova"
       @contact.name = "Test User"
 
-      @contact.email_addresses.push "test@test.org"
-      @contact.email_addresses.push "prova@prova.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("test@test.org")
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("prova@prova.org")
       @address_book.contacts.push(@contact)
       @storage.stub(:load_address_book).and_return(@address_book)
       @format.should_receive(:process) do |address_book|
         address_book.contacts[0].email_addresses.length.should eq 1
-        address_book.contacts[0].email_addresses[0].should eq "prova@prova.org"
+        address_book.contacts[0].email_addresses[0].address.should eq "prova@prova.org"
       end
       @output.stub(:line)
       @command.execute(@input, @output)
@@ -70,7 +70,7 @@ describe Ppl::Command::Mutt do
     it "should return name matches" do
 
       @contact.name = "Test User"
-      @contact.email_addresses.push "test@example.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("test@example.org")
       @address_book.contacts.push(@contact)
 
       @input.arguments.push "User"
@@ -89,8 +89,8 @@ describe Ppl::Command::Mutt do
       @input.arguments.push "org"
 
       @contact.name = "Test User"
-      @contact.email_addresses.push "test@test.org"
-      @contact.email_addresses.push "prova@prova.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("test@test.org")
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("prova@prova.org")
       @address_book.contacts << @contact
 
       @storage.stub(:load_address_book).and_return(@address_book)
@@ -109,8 +109,8 @@ describe Ppl::Command::Mutt do
     before(:each) do
       @input.options[:ignore_case] = true
       @contact.name = "Joe Schmoe"
-      @contact.email_addresses.push "joe@somewhere.com"
-      @contact.email_addresses.push "LOUD@SHOUTING.COM"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("joe@somewhere.com")
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("LOUD@SHOUTING.COM")
       @address_book.contacts << @contact
       @storage.stub(:load_address_book).and_return(@address_book)
       @output.stub(:line)
@@ -128,7 +128,7 @@ describe Ppl::Command::Mutt do
       @input.arguments.push "loud"
       @format.should_receive(:process) do |address_book|
         address_book.contacts[0].email_addresses.length.should eq 1
-        address_book.contacts[0].email_addresses[0].should eq "LOUD@SHOUTING.COM"
+        address_book.contacts[0].email_addresses[0].address.should eq "LOUD@SHOUTING.COM"
       end
       @command.execute(@input, @output)
     end

data/spec/ppl/command/phone_spec.rb

@@ -15,51 +15,55 @@ describe Ppl::Command::Phone do
 
     before(:each) do
       @contact = Ppl::Entity::Contact.new
+      @service = double(Ppl::Service::PhoneNumber)
       @storage = double(Ppl::Adapter::Storage)
+      @list_format = double(Ppl::Format::AddressBook)
+      @show_format = double(Ppl::Format::Contact)
       @input = Ppl::Application::Input.new
-      @input.arguments = ["jdoe", "01234567"]
+      @output = double(Ppl::Application::Output)
       @storage.stub(:require_contact).and_return(@contact)
       @storage.stub(:save_contact)
+      @command.phone_service = @service
       @command.storage = @storage
+      @command.list_format = @list_format
+      @command.show_format = @show_format
     end
 
-    it "should save phone numbers as instances of Ppl::Entity::PhoneNumber" do
-      @storage.should_receive(:save_contact) do |c|
-        c.phone_numbers.first.should be_a(Ppl::Entity::PhoneNumber)
-      end
+    it "should list all phone numbers by default" do
+      @storage.should_receive(:load_address_book).and_return(@address_book)
+      @list_format.should_receive(:process)
+      @output.should_receive(:line)
       @command.execute(@input, @output)
     end
 
-    it "should save the given number as an attribute of the PhoneNumber" do
-      @storage.should_receive(:save_contact) do |c|
-        c.phone_numbers.first.number.should eq "01234567"
-      end
+    it "should show a single contact's numbers if one is specified" do
+      @input.arguments << "jdoe"
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @show_format.should_receive(:process)
+      @output.should_receive(:line)
       @command.execute(@input, @output)
     end
 
-    it "should save the given type alongside the number" do
-      @input.options[:type] = "cell"
-      @storage.should_receive(:save_contact) do |c|
-        c.phone_numbers.first.type.should eq "cell"
-      end
+    it "should delegate to the service layer to remove a phone number" do
+      @input.arguments = ["jdoe", "01234567890"]
+      @input.options[:delete] = true
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @service.should_receive(:remove).with(@contact, "01234567890")
       @command.execute(@input, @output)
     end
 
-    it "shouldn't duplicate the number if the contact already has it" do
-      @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("01234567")
-      @storage.should_receive(:save_contact) do |c|
-        c.phone_numbers.length.should eq 1
-      end
+    it "should delegate to the service layer to add a new phone number" do
+      @input.arguments = ["jdoe", "98776332"]
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @service.should_receive(:add).with(@contact, "98776332", @input.options)
       @command.execute(@input, @output)
     end
 
-    it "should delete the given number from the contact" do
-      @input.arguments = ["jdoe", "01234567"]
-      @input.options[:delete] = "true"
-      @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("01234567")
-      @storage.should_receive(:save_contact) do |c|
-        c.phone_numbers.length.should eq 0
-      end
+    it "should delegate to the service layer to update an existing number" do
+      @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("012345678")
+      @input.arguments = ["jdoe", "012345678"]
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @service.should_receive(:update).with(@contact, "012345678", {})
       @command.execute(@input, @output)
     end
 

data/spec/ppl/entity/email_address_spec.rb

@@ -0,0 +1,28 @@
+
+describe Ppl::Entity::EmailAddress do
+
+  before(:each) do
+    @email_address = Ppl::Entity::EmailAddress.new
+  end
+
+  describe "#address" do
+    it "should return a value" do
+      @email_address.address.should eq nil
+    end
+  end
+
+  describe "#preferred" do
+    it "should be false by default" do
+      @email_address.preferred.should eq false
+    end
+  end
+
+  describe "#initialize" do
+    it "should accept an address" do
+      email = Ppl::Entity::EmailAddress.new("bob@example.org")
+      email.address.should eq "bob@example.org"
+    end
+  end
+
+end
+

data/spec/ppl/entity/phone_number_spec.rb

@@ -11,6 +11,12 @@ describe Ppl::Entity::PhoneNumber do
     end
   end
 
+  describe "#preferred" do
+    it "should be false by default" do
+      @phone_number.preferred.should eq false
+    end
+  end
+
   describe "#type" do
     it "should return a value" do
       @phone_number.type.should eq nil

data/spec/ppl/format/address_book/email_addresses_spec.rb

@@ -34,7 +34,7 @@ describe Ppl::Format::AddressBook::EmailAddresses do
     end
 
     it "should show an email address if it's available" do
-      @contact.email_addresses.push "jdoe@example.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("jdoe@example.org")
       @table.should_receive(:add_row).with({
         :id              => "test:",
         :email_addresses => "jdoe@example.org",

data/spec/ppl/format/address_book/mutt_query_spec.rb

@@ -7,7 +7,7 @@ describe Ppl::Format::AddressBook::MuttQuery do
     @contact      = Ppl::Entity::Contact.new
     @table        = double(Ppl::Format::Table)
 
-    @contact.email_addresses.push "test@example.org"
+    @contact.email_addresses << Ppl::Entity::EmailAddress.new("test@example.org")
     @contact.name = "Test Contact"
 
     @format.table = @table
@@ -25,7 +25,7 @@ describe Ppl::Format::AddressBook::MuttQuery do
     end
 
     it "should list all of each contact's email addresses" do
-      @contact.email_addresses.push "test2@example.com"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("test2@example.com")
       @table.should_receive(:add_row).with({
         :email => "test@example.org",
         :name  => "Test Contact",

data/spec/ppl/format/address_book/one_line_spec.rb

@@ -36,7 +36,7 @@ describe Ppl::Format::AddressBook::OneLine do
 
     it "should show all the info if it's available" do
       @contact.name = "John Doe"
-      @contact.email_addresses.push "jdoe@example.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("jdoe@example.org")
       @table.should_receive(:add_row).with({
         :id    => "test:",
         :name  => "John Doe",
@@ -45,6 +45,16 @@ describe Ppl::Format::AddressBook::OneLine do
       @format.process(@address_book)
     end
 
+    it "should show all the info if it's available" do
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("jdoe@example.org")
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("fred@testtest.es")
+      @contact.email_addresses[1].preferred = true
+      @table.should_receive(:add_row) do |row|
+        row[:email].should eq "<fred@testtest.es>"
+      end
+      @format.process(@address_book)
+    end
+
   end
 
 end

data/spec/ppl/format/contact/email_addresses_spec.rb

@@ -1,28 +1,42 @@
 
+describe Ppl::Format::Contact::EmailAddresses do
+  describe "#initialize" do
+    it "should pass the colors through to the table" do
+      colors = {"id" => "blue"}
+      Ppl::Format::Table.should_receive(:new).with([:star, :email_addresses], colors)
+      format = Ppl::Format::Contact::EmailAddresses.new(colors)
+    end
+  end
+end
+
 describe Ppl::Format::Contact::EmailAddresses do
 
   before(:each) do
     @format  = Ppl::Format::Contact::EmailAddresses.new
     @contact = Ppl::Entity::Contact.new
-    @color   = double(Ppl::Adapter::Color)
-    @format.color_adapter = @color
+    @email   = Ppl::Entity::EmailAddress.new("test@example.org")
+    @table   = double(Ppl::Format::Table)
+    @format.table = @table
+    @contact.email_addresses << @email
   end
 
   describe "#process" do
 
-    it "should return an empty string if the contact lacks an email address" do
-      @format.process(Ppl::Entity::Contact.new).should eq ""
-    end
-
-    it "should return the contact's email address if it is set" do
-      @contact.email_addresses.push "jdoe@example.org"
-      @format.process(@contact).should eq "jdoe@example.org"
+    it "should pass each email address to the table" do
+      @table.should_receive(:add_row).with({
+        :star            => " ",
+        :email_addresses => "test@example.org",
+      })
+      @format.process(@contact)
     end
 
-    it "should colorize the string if configured to do so" do
-      @format.colors = { "email_addresses" => "blue" }
-      @color.should_receive(:colorize).and_return("email addresses in blue")
-      @format.process(@contact).should eq "email addresses in blue"
+    it "should mark the preferred email with a star" do
+      @email.preferred = true
+      @table.should_receive(:add_row).with({
+        :star            => "*",
+        :email_addresses => "test@example.org",
+      })
+      @format.process(@contact)
     end
 
   end

data/spec/ppl/format/contact/full_spec.rb

@@ -6,8 +6,14 @@ describe Ppl::Format::Contact::Full do
     @contact = Ppl::Entity::Contact.new
     @address = Ppl::Entity::PostalAddress.new
 
+    @email_address_format = double(Ppl::Format::Contact)
+    @phone_number_format = double(Ppl::Format::Contact)
     @postal_address_format = double(Ppl::Format::Contact)
+    @format.email_address_format = @email_address_format
+    @format.phone_number_format = @phone_number_format
     @format.postal_address_format = @postal_address_format
+
+    @email_address_format.stub(:process)
   end
 
   describe "#process" do
@@ -23,27 +29,33 @@ describe Ppl::Format::Contact::Full do
 
     it "should include their email address in brackets" do
       @contact.name = "John Doe"
-      @contact.email_addresses.push "john@example.org"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("john@example.org")
       @format.process(@contact).should include "John Doe <john@example.org>"
     end
 
-    it "should show all their email addresses" do
-      @contact.email_addresses.push "john@example.org"
-      @contact.email_addresses.push "john@example.com"
-      @contact.email_addresses.push "john@example.net"
-      @format.process(@contact).should include "john@example.org"
-      @format.process(@contact).should include "john@example.com"
-      @format.process(@contact).should include "john@example.net"
+    it "should include their preferred email address in brackets" do
+      @contact.name = "John Doe"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("john@example.org")
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("fred@testtest.es")
+      @contact.email_addresses[1].preferred = true
+      @format.process(@contact).should include "John Doe <fred@testtest.es>"
     end
 
-    it "should show their birthday if available" do
-      @contact.birthday = Date.parse("1980-01-01")
-      @format.process(@contact).should include "1980-01-01"
+    it "should invoke the email address formatter if there are any addresses" do
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("john@example.net")
+      @email_address_format.should_receive(:process).with(@contact)
+      @format.process(@contact)
     end
 
-    it "should show their phone number if available" do
+    it "should invoke the phone number formatter if there are any numbers" do
       @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("01234567890")
-      @format.process(@contact).should include "01234567890"
+      @phone_number_format.should_receive(:process).with(@contact)
+      @format.process(@contact)
+    end
+
+    it "should show their birthday if available" do
+      @contact.birthday = Date.parse("1980-01-01")
+      @format.process(@contact).should include "1980-01-01"
     end
 
     it "should show all their organizations" do