ppl 1.25.0 → 2.0.0

data/lib/ppl/service/postal_address.rb

@@ -0,0 +1,65 @@
+
+class Ppl::Service::PostalAddress
+
+  def add(contact, address_id, options)
+    address = Ppl::Entity::PostalAddress.new
+    address.id = address_id
+    update_postal_address(contact, address, options)
+    contact.postal_addresses << address
+  end
+
+  def update(contact, address_id, options)
+    address = contact.postal_addresses.find { |p| p.id == address_id }
+    update_postal_address(contact, address, options)
+    if options[:new_id]
+      move(contact, address_id, options[:new_id])
+    end
+  end
+
+  def remove(contact, address_id)
+    require_address(contact, address_id)
+    contact.postal_addresses.reject! { |pa| pa.id == address_id }
+  end
+
+  def move(contact, address_id, new_address_id)
+    address = require_address(contact, address_id)
+    id_okay = contact.postal_addresses.select { |pa| pa.id == new_address_id }.empty?
+    if id_okay
+      address.id = new_address_id
+    else
+      raise "Address '#{new_address_id}' is already in use"
+    end
+  end
+
+  private
+
+  def require_address(contact, address_id)
+    address = contact.postal_addresses.find { |p| p.id == address_id }
+    if address.nil?
+      raise Ppl::Error::PostalAddressNotFound, address_id
+    end
+    address
+  end
+
+  def update_postal_address(contact, address, options)
+    [
+      :country,
+      :locality,
+      :po_box,
+      :postal_code,
+      :region,
+      :street,
+    ].each do |property|
+      unless options[property].nil?
+        address.send("#{property.to_s}=", options[property])
+      end
+    end
+    if options[:preferred] == true
+      contact.postal_addresses.each { |pa| pa.preferred = (pa.id == address.id) }
+    elsif options[:preferred] == false
+      address.preferred = false
+    end
+  end
+
+end
+

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.25.0"
+  Version = "2.0.0"
 
   module Adapter
   end
@@ -80,6 +80,7 @@ require "ppl/entity/postal_address"
 require "ppl/error/completion_not_found"
 require "ppl/error/contact_not_found"
 require "ppl/error/incorrect_usage"
+require "ppl/error/postal_address_not_found"
 
 require "ppl/format/address_book"
 require "ppl/format/address_book/ages"
@@ -103,17 +104,20 @@ require "ppl/format/contact/nicknames"
 require "ppl/format/contact/organization"
 require "ppl/format/contact/phone_number"
 require "ppl/format/contact/postal_address"
+require "ppl/format/contact/postal_addresses"
 require "ppl/format/contact/urls"
 require "ppl/format/custom"
 require "ppl/format/custom/contact"
 require "ppl/format/custom/email_address"
 require "ppl/format/custom/phone_number"
 require "ppl/format/postal_address"
+require "ppl/format/postal_address/multi_line"
 require "ppl/format/postal_address/one_line"
 require "ppl/format/table"
 
 require "ppl/service/email_address"
 require "ppl/service/phone_number"
+require "ppl/service/postal_address"
 
 class String
   alias_method :each, :each_line

data/ppl.gemspec

@@ -2,13 +2,13 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.25.0"
-  spec.date        = "2013-04-24"
+  spec.version     = "2.0.0"
+  spec.date        = "2013-05-09"
 
   spec.required_ruby_version = ">= 1.9.3"
 
-  spec.summary     = "CLI Address Book"
-  spec.description = "CLI Address Book"
+  spec.summary     = "The command line address book"
+  spec.description = "ppl is a command-line address book using vCard & git for storage and synchronisation"
   spec.license     = "GPL-2"
 
   spec.add_dependency("colored", "1.2")

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

@@ -51,40 +51,53 @@ describe Ppl::Adapter::Vcard::GreenCard, "#encode" do
     @adapter.encode(@contact).should include("ORG:Example Ltd")
   end
 
-  it "should encode the contact's street address" do
-    @contact.postal_address = Ppl::Entity::PostalAddress.new
-    @contact.postal_address.street = "1 Testing Road"
-    @adapter.encode(@contact).should include("ADR:;;1 Testing Road;;;;")
-  end
+  describe "postal address encoding" do
 
-  it "should encode the contact's postal code" do
-    @contact.postal_address = Ppl::Entity::PostalAddress.new
-    @contact.postal_address.postal_code = "L7 8AA"
-    @adapter.encode(@contact).should include("ADR:;;;;;L7 8AA;")
-  end
+    before(:each) do
+      @address = Ppl::Entity::PostalAddress.new
+      @contact.postal_addresses << @address
+    end
 
-  it "should encode the contact's po box" do
-    @contact.postal_address = Ppl::Entity::PostalAddress.new
-    @contact.postal_address.po_box = "123456"
-    @adapter.encode(@contact).should include("ADR:123456;;;;;;")
-  end
+    it "should encode the address id" do
+      @contact.postal_addresses[0].id = "home"
+      @adapter.encode(@contact).should include("ADR;TYPE=home:;;;;;;")
+    end
 
-  it "should encode the contact's locality" do
-    @contact.postal_address = Ppl::Entity::PostalAddress.new
-    @contact.postal_address.locality = "Liverpool"
-    @adapter.encode(@contact).should include("ADR:;;;Liverpool;;;")
-  end
+    it "should encode the preferred status of the address" do
+      @contact.postal_addresses[0].preferred = true
+      @adapter.encode(@contact).should include("ADR;TYPE=pref:;;;;;;")
+    end
 
-  it "should encode the contact's country" do
-    @contact.postal_address = Ppl::Entity::PostalAddress.new
-    @contact.postal_address.country = "UK"
-    @adapter.encode(@contact).should include("ADR:;;;;;;UK")
-  end
+    it "should encode the contact's street address" do
+      @contact.postal_addresses[0].street = "1 Testing Road"
+      @adapter.encode(@contact).should include("ADR:;;1 Testing Road;;;;")
+    end
+
+    it "should encode the contact's postal code" do
+      @contact.postal_addresses[0].postal_code = "L7 8AA"
+      @adapter.encode(@contact).should include("ADR:;;;;;L7 8AA;")
+    end
+
+    it "should encode the contact's po box" do
+      @contact.postal_addresses[0].po_box = "123456"
+      @adapter.encode(@contact).should include("ADR:123456;;;;;;")
+    end
+
+    it "should encode the contact's locality" do
+      @contact.postal_addresses[0].locality = "Liverpool"
+      @adapter.encode(@contact).should include("ADR:;;;Liverpool;;;")
+    end
+
+    it "should encode the contact's country" do
+      @contact.postal_addresses[0].country = "UK"
+      @adapter.encode(@contact).should include("ADR:;;;;;;UK")
+    end
+
+    it "should encode the contact's region" do
+      @contact.postal_addresses[0].region = "South West"
+      @adapter.encode(@contact).should include("ADR:;;;;South West;;")
+    end
 
-  it "should encode the contact's region" do
-    @contact.postal_address = Ppl::Entity::PostalAddress.new
-    @contact.postal_address.region = "South West"
-    @adapter.encode(@contact).should include("ADR:;;;;South West;;")
   end
 
   it "should encode the contact's URL" do
@@ -229,76 +242,116 @@ describe Ppl::Adapter::Vcard::GreenCard, "#decode" do
     contact.organizations.first.should eq "Example Ltd"
   end
 
-  it "should decode the contact's street address" do
-    vcard = [
-      "BEGIN:VCARD",
-      "N:,test",
-      "VERSION:3.0",
-      "ADR:;;1 Testing Road;;;;",
-      "END:VCARD",
-    ].join("\n")
-    contact = @adapter.decode(vcard)
-    contact.postal_address.street.should eq "1 Testing Road"
-  end
+  describe "postal address decoding" do
+
+    it "should decode the postal address' ID" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR;TYPE=home:;;1 Testing Road;;;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].id.should eq "home"
+    end
+
+    it "should decode the postal address' ID even if it's a nonstandard type" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR;TYPE=nasa:;;1 Testing Road;;;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].id.should eq "nasa"
+    end
+
+    it "should assign the postal address a fallback ID if necessary" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:;;1 Testing Road;;;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].id.should eq "910c67f"
+    end
+
+    it "should decode the contact's street address" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:;;1 Testing Road;;;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].street.should eq "1 Testing Road"
+    end
+
+    it "should decode the contact's postal code" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:;;;;;L7 8AA;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].postal_code.should eq "L7 8AA"
+    end
+
+    it "should decode the contact's po box" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:123456;;;;;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].po_box.should eq "123456"
+    end
+
+    it "should decode the contact's locality" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:;;;Liverpool;;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].locality.should eq "Liverpool"
+    end
+
+    it "should decode the contact's region" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:;;;;South West;;",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].region.should eq "South West"
+    end
+
+    it "should decode the contact's country" do
+      vcard = [
+        "BEGIN:VCARD",
+        "N:,test",
+        "VERSION:3.0",
+        "ADR:;;;;;;UK",
+        "END:VCARD",
+      ].join("\n")
+      contact = @adapter.decode(vcard)
+      contact.postal_addresses[0].country.should eq "UK"
+    end
 
-  it "should decode the contact's postal code" do
-    vcard = [
-      "BEGIN:VCARD",
-      "N:,test",
-      "VERSION:3.0",
-      "ADR:;;;;;L7 8AA;",
-      "END:VCARD",
-    ].join("\n")
-    contact = @adapter.decode(vcard)
-    contact.postal_address.postal_code.should eq "L7 8AA"
-  end
-
-  it "should decode the contact's po box" do
-    vcard = [
-      "BEGIN:VCARD",
-      "N:,test",
-      "VERSION:3.0",
-      "ADR:123456;;;;;;",
-      "END:VCARD",
-    ].join("\n")
-    contact = @adapter.decode(vcard)
-    contact.postal_address.po_box.should eq "123456"
-  end
-
-  it "should decode the contact's locality" do
-    vcard = [
-      "BEGIN:VCARD",
-      "N:,test",
-      "VERSION:3.0",
-      "ADR:;;;Liverpool;;;",
-      "END:VCARD",
-    ].join("\n")
-    contact = @adapter.decode(vcard)
-    contact.postal_address.locality.should eq "Liverpool"
-  end
-
-  it "should decode the contact's region" do
-    vcard = [
-      "BEGIN:VCARD",
-      "N:,test",
-      "VERSION:3.0",
-      "ADR:;;;;South West;;",
-      "END:VCARD",
-    ].join("\n")
-    contact = @adapter.decode(vcard)
-    contact.postal_address.region.should eq "South West"
-  end
-
-  it "should decode the contact's country" do
-    vcard = [
-      "BEGIN:VCARD",
-      "N:,test",
-      "VERSION:3.0",
-      "ADR:;;;;;;UK",
-      "END:VCARD",
-    ].join("\n")
-    contact = @adapter.decode(vcard)
-    contact.postal_address.country.should eq "UK"
   end
 
   it "should decode the contact's URL" do

data/spec/ppl/application/bootstrap_spec.rb

@@ -389,8 +389,8 @@ describe Ppl::Application::Bootstrap do
   end
 
   describe "#format_contact_postal_addresses" do
-    it "should return a Ppl::Format::Contact::PostalAddress" do
-      @bootstrap.format_contact_postal_addresses.should be_a(Ppl::Format::Contact::PostalAddress)
+    it "should return a Ppl::Format::Contact::PostalAddresses" do
+      @bootstrap.format_contact_postal_addresses.should be_a(Ppl::Format::Contact::PostalAddresses)
     end
   end
 
@@ -407,6 +407,12 @@ describe Ppl::Application::Bootstrap do
     end
   end
 
+  describe "#format_postal_address_multi_line" do
+    it "should return a Ppl::Format::PostalAddress::MultiLine" do
+      @bootstrap.format_postal_address_multi_line.should be_a(Ppl::Format::PostalAddress::MultiLine)
+    end
+  end
+
   describe "#command_suite" do
 
     before(:each) do
@@ -553,5 +559,11 @@ describe Ppl::Application::Bootstrap do
     end
   end
 
+  describe "#postal_address_service" do
+    it "should return a Ppl::Service::PostalAddress" do
+      @bootstrap.postal_address_service.should be_a(Ppl::Service::PostalAddress)
+    end
+  end
+
 end
 

data/spec/ppl/application/shell_spec.rb

@@ -99,6 +99,14 @@ describe Ppl::Application::Shell do
       @shell.run(@input, @output)
     end
 
+    it "should handle PostalAddressNotFound errors nicely" do
+      @command.stub(:options)
+      @command.should_receive(:execute) { raise Ppl::Error::PostalAddressNotFound, "example" }
+      @router.should_receive(:route).and_return(@command)
+      @output.should_receive(:error).with("ppl: Postal address 'example' not found")
+      @shell.run(@input, @output)
+    end
+
   end
 
 end

data/spec/ppl/command/post_spec.rb

@@ -7,14 +7,22 @@ describe Ppl::Command::Post do
     @contact = Ppl::Entity::Contact.new
     @command = Ppl::Command::Post.new
     @storage = double(Ppl::Adapter::Storage)
+    @service = double(Ppl::Service::PostalAddress)
 
-    @list_format = double(Ppl::Format::Contact)
-    @show_format = double(Ppl::Format::Contact)
+    @address_book_format = double(Ppl::Format::AddressBook)
+    @contact_format = double(Ppl::Format::Contact)
+    @postal_address_format = double(Ppl::Format::PostalAddress)
 
+    @command.address_service = @service
     @command.storage     = @storage
-    @command.show_format = @show_format
-    @command.list_format = @list_format
+    @command.contact_format = @contact_format
+    @command.address_book_format = @address_book_format
+    @command.postal_address_format = @postal_address_format
     @contact.id = "jim"
+
+    @address = Ppl::Entity::PostalAddress.new
+    @address.id = "home"
+    @contact.postal_addresses << @address
   end
 
   describe "#name" do
@@ -25,84 +33,98 @@ describe Ppl::Command::Post do
 
   describe "#execute" do
 
-    it "should list all postal addresses if no contact ID is given" do
-      @storage.should_receive(:load_address_book).and_return(@address_book)
-      @list_format.should_receive(:process).and_return("all the postal addresses")
-      @output.should_receive(:line).with("all the postal addresses")
-      @input.arguments = []
-      @command.execute(@input, @output)
-    end
+    context "show address book" do
 
-    it "should show the current address if no new address is given" do
-      @storage.should_receive(:require_contact).and_return(@contact)
-      @show_format.should_receive(:process).and_return("1 Test Road")
-      @output.should_receive(:line).with("1 Test Road")
-      @input.arguments = ["jim"]
-      @command.execute(@input, @output).should eq true
-    end
+      before { @input.arguments = [] }
 
-    it "should not output anything if there's nothing to show" do
-      @storage.should_receive(:require_contact).and_return(@contact)
-      @show_format.should_receive(:process).and_return("")
-      @input.arguments = ["jim"]
-      @command.execute(@input, @output).should eq false
+      it "displays postal address information for the whole address book" do
+        @storage.should_receive(:load_address_book).and_return(@address_book)
+        @address_book_format.should_receive(:process).and_return("all the postal addresses")
+        @output.should_receive(:line).with("all the postal addresses")
+        @input.arguments = []
+        @command.execute(@input, @output)
+      end
     end
 
-  end
+    context "show contact" do
 
-  describe "#execute" do
-    
-    before(:each) do
-      @input.arguments = ["jim"]
-      @storage.should_receive(:require_contact).and_return(@contact)
-    end
+      before { @input.arguments = ["jim"] }
 
-    it "should change the contact's street address if it's given" do
-      @input.options = {:street => "1 Test Road"}
-      @storage.should_receive(:save_contact) do |contact|
-        contact.postal_address.street.should eq "1 Test Road"
+      it "shows all of a contact's postal addresses" do
+        @storage.should_receive(:require_contact).and_return(@contact)
+        @contact_format.should_receive(:process).and_return("1 Test Road")
+        @output.should_receive(:line).with("1 Test Road")
+        @command.execute(@input, @output).should eq true
       end
-      @command.execute(@input, @output)
-    end
 
-    it "should change the contact's postal code if it's given" do
-      @input.options = {:postal_code => "L7 8AA"}
-      @storage.should_receive(:save_contact) do |contact|
-        contact.postal_address.postal_code.should eq "L7 8AA"
+      it "outputs nothing if the contact has no addresses" do
+        @storage.should_receive(:require_contact).and_return(@contact)
+        @contact_format.should_receive(:process).and_return("")
+        @command.execute(@input, @output).should eq false
       end
-      @command.execute(@input, @output)
+
     end
 
-    it "should change the contact's po box if it's given" do
-      @input.options = {:po_box => "124578"}
-      @storage.should_receive(:save_contact) do |contact|
-        contact.postal_address.po_box.should eq "124578"
+    context "show postal address" do
+
+      before { @input.arguments = ["jim", "home"] }
+
+      it "shows a single postal address" do
+        @storage.should_receive(:require_contact).and_return(@contact)
+        @postal_address_format.should_receive(:process).with(@address).and_return("1 Test Road")
+        @output.should_receive(:line).with("1 Test Road")
+        @command.execute(@input, @output).should eq true
+      end
+
+      it "raises an error if there's no such address" do
+        @input.arguments[1] = "other"
+        @storage.should_receive(:require_contact).and_return(@contact)
+        expect{@command.execute(@input, @output).should eq true}.to raise_error(Ppl::Error::PostalAddressNotFound)
       end
-      @command.execute(@input, @output)
+
     end
 
-    it "should change the contact's country if it's given" do
-      @input.options = {:country => "UK"}
-      @storage.should_receive(:save_contact) do |contact|
-        contact.postal_address.country.should eq "UK"
+    context "delete postal address" do
+
+      before { @input.arguments = ["jim", "home"] }
+      before { @input.options = { :delete => true }}
+
+      it "deletes the postal address" do
+        @storage.should_receive(:require_contact).and_return(@contact)
+        @service.should_receive(:remove).with(@contact, "home")
+        @storage.should_receive(:save_contact)
+        @command.execute(@input, @output).should eq true
       end
-      @command.execute(@input, @output)
+
     end
 
-    it "should change the contact's locality if it's given" do
-      @input.options = {:locality => "Liverpool"}
-      @storage.should_receive(:save_contact) do |contact|
-        contact.postal_address.locality.should eq "Liverpool"
+    context "update postal address" do
+
+      before { @input.arguments = ["jim", "home"] }
+      before { @input.options = { :country => "New Country" }}
+
+      it "updates the postal address" do
+        @storage.should_receive(:require_contact).and_return(@contact)
+        @service.should_receive(:update).with(@contact, "home", {:country => "New Country"})
+        @storage.should_receive(:save_contact)
+        @command.execute(@input, @output).should eq true
       end
-      @command.execute(@input, @output)
+
     end
 
-    it "should change the contact's region if it's given" do
-      @input.options = {:region => "North West"}
-      @storage.should_receive(:save_contact) do |contact|
-        contact.postal_address.region.should eq "North West"
+
+    context "add postal address" do
+
+      before { @input.arguments = ["jim", "newaddress"] }
+      before { @input.options = { :street => "123 Swim St" }}
+
+      it "adds the postal address" do
+        @storage.should_receive(:require_contact).and_return(@contact)
+        @service.should_receive(:add).with(@contact, "newaddress", {:street => "123 Swim St"})
+        @storage.should_receive(:save_contact)
+        @command.execute(@input, @output).should eq true
       end
-      @command.execute(@input, @output)
+
     end
 
   end