ppl 1.25.0 → 2.0.0

data/spec/ppl/entity/contact_spec.rb

@@ -24,6 +24,12 @@ describe Ppl::Entity::Contact do
     end
   end
 
+  describe "#postal_addresses" do
+    it "should return an array" do
+      @contact.postal_addresses.should be_a(Array)
+    end
+  end
+
   describe "#birthday" do
     it "should return a value" do
       @contact.birthday.should eq nil
@@ -36,16 +42,6 @@ describe Ppl::Entity::Contact do
     end
   end
 
-  describe "#has_email_address?" do
-    it "should know if the contact has the given email address" do
-      @contact.email_addresses.push "test@example.org"
-      @contact.has_email_address?("test@example.org").should eq true
-    end
-    it "should know if the contact lacks the given email address" do
-      @contact.has_email_address?("test@example.org").should eq false
-    end
-  end
-
   describe "#urls" do
     it "should return an array" do
       @contact.urls.should be_a(Array)
@@ -80,5 +76,39 @@ describe Ppl::Entity::Contact do
     end
   end
 
+  describe "#preferred_email_address" do
+
+    before(:each) do
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new
+    end
+
+    it "returns nil if there's no preferred address" do
+      @contact.preferred_email_address.should eq nil
+    end
+
+    it "returns the preferred email address" do
+      @contact.email_addresses[0].preferred = true
+      @contact.preferred_email_address.should be_a(Ppl::Entity::EmailAddress)
+    end
+
+  end
+
+  describe "#preferred_phone_number" do
+
+    before(:each) do
+      @contact.phone_numbers << Ppl::Entity::PhoneNumber.new
+    end
+
+    it "returns nil if there's no preferred number" do
+      @contact.preferred_phone_number.should eq nil
+    end
+
+    it "returns the preferred phone number" do
+      @contact.phone_numbers[0].preferred = true
+      @contact.preferred_phone_number.should be_a(Ppl::Entity::PhoneNumber)
+    end
+
+  end
+
 end
 

data/spec/ppl/entity/postal_address_spec.rb

@@ -5,6 +5,12 @@ describe Ppl::Entity::PostalAddress do
     @address = Ppl::Entity::PostalAddress.new
   end
 
+  describe "#preferred" do
+    it "should be false by default" do
+      @address.preferred.should eq false
+    end
+  end
+
   describe "#street" do
     it "should return a value" do
       @address.street.should be nil

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

@@ -3,7 +3,7 @@ describe Ppl::Format::AddressBook::PostalAddresses do
   describe "#initialize" do
     it "should pass the colors through to the table" do
       colors = {"id" => "blue"}
-      Ppl::Format::Table.should_receive(:new).with([:id, :postal_address], colors)
+      Ppl::Format::Table.should_receive(:new).with([:id, :address_ids], colors)
       format = Ppl::Format::AddressBook::PostalAddresses.new(colors)
     end
   end
@@ -18,8 +18,9 @@ describe Ppl::Format::AddressBook::PostalAddresses do
     @address      = Ppl::Entity::PostalAddress.new
     @table        = double(Ppl::Format::Table)
 
+    @address.id = "home"
     @contact.id = "test"
-    @contact.postal_address = @address
+    @contact.postal_addresses << @address
     @format.table = @table
 
     @address_book.contacts.push(@contact)
@@ -27,19 +28,10 @@ describe Ppl::Format::AddressBook::PostalAddresses do
 
   describe "#process" do
 
-    it "should at least show the contact's id" do
+    it "shows the contact's and address' IDs" do
       @table.should_receive(:add_row).with({
-        :id             => "test:",
-        :postal_address => "",
-      })
-      @format.process(@address_book)
-    end
-
-    it "should show the postal address if it's available" do
-      @address.street = "1 Test Road"
-      @table.should_receive(:add_row).with({
-        :id             => "test:",
-        :postal_address => "1 Test Road",
+        :id          => "test:",
+        :address_ids => "home",
       })
       @format.process(@address_book)
     end

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

@@ -64,7 +64,7 @@ describe Ppl::Format::Contact::Full do
     end
 
     it "should show their postal address if available" do
-      @contact.postal_address = @address
+      @contact.postal_addresses << @address
       @postal_address_format.should_receive(:process).and_return("")
       @format.process(@contact)
     end

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

@@ -0,0 +1,36 @@
+
+describe Ppl::Format::Contact::PostalAddresses do
+  describe "#initialize" do
+    it "should pass the colors through to the table" do
+      colors = {"address_id" => "blue"}
+      Ppl::Format::Table.should_receive(:new).with([:star, :address_id, :address_text], colors)
+      format = Ppl::Format::Contact::PostalAddresses.new(colors)
+    end
+  end
+end
+
+describe Ppl::Format::Contact::PostalAddresses do
+
+  before(:each) do
+    @format  = Ppl::Format::Contact::PostalAddresses.new
+    @contact = Ppl::Entity::Contact.new
+    @address = Ppl::Entity::PostalAddress.new
+    @table   = double(Ppl::Format::Table)
+    @pa_fmt  = double(Ppl::Format::PostalAddress)
+    @format.table = @table
+    @format.postal_address_format = @pa_fmt
+  end
+
+  describe "#process" do
+
+    it "passes each postal address to the postal address formatter" do
+      @contact.postal_addresses << @address
+      @pa_fmt.should_receive(:process).with(@address, @table)
+      @table.should_receive(:to_s)
+      @format.process(@contact)
+    end
+
+  end
+
+end
+

data/spec/ppl/format/postal_address/multi_line_spec.rb

@@ -0,0 +1,57 @@
+
+describe Ppl::Format::PostalAddress::MultiLine do
+
+  before(:each) do
+    @format  = Ppl::Format::PostalAddress::MultiLine.new
+    @address = Ppl::Entity::PostalAddress.new
+  end
+
+  describe "#process" do
+
+    context "all address attributes contain a value" do
+
+      before(:each) do
+        @address.id = "home"
+        @address.street = "123 Happy Lane"
+        @address.country = "United Kingdom"
+        @address.locality = "Bristol"
+        @address.po_box = "12345"
+        @address.postal_code = "BS1 1SB"
+        @address.region = "A very nice region indeed"
+      end
+
+      it "outputs each address attribute on its own line" do
+        @lines = @format.process(@address).split "\n"
+        @lines[0].should eq "123 Happy Lane"
+        @lines[1].should eq "Bristol"
+        @lines[2].should eq "A very nice region indeed"
+        @lines[3].should eq "United Kingdom"
+        @lines[4].should eq "12345"
+        @lines[5].should eq "BS1 1SB"
+      end
+
+    end
+
+    context "some empty address attributes" do
+
+      before(:each) do
+        @address.id = "home"
+        @address.street = "123 Happy Lane"
+        @address.country = "United Kingdom"
+        @address.locality = "Bristol"
+      end
+
+      it "doesn't output superfluous blank lines" do
+        @lines = @format.process(@address).split "\n"
+        @lines.length.should eq 3
+        @lines[0].should eq "123 Happy Lane"
+        @lines[1].should eq "Bristol"
+        @lines[2].should eq "United Kingdom"
+      end
+
+    end
+
+  end
+
+end
+

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

@@ -3,39 +3,53 @@ describe Ppl::Format::PostalAddress::OneLine do
 
   before(:each) do
     @format  = Ppl::Format::PostalAddress::OneLine.new
+    @table   = double(Ppl::Format::Table)
     @address = Ppl::Entity::PostalAddress.new
   end
 
   describe "#process" do
 
-    it "should include the country if available" do
-      @address.country = "UK"
-      @format.process(@address).should include "UK"
+    before(:each) do
+      @address.id = "home"
+      @address.street = "123 Happy Lane"
+      @address.country = "United Kingdom"
     end
 
-    it "should include the locality if available" do
-      @address.locality = "Liverpool"
-      @format.process(@address).should include "Liverpool"
+    after(:each) do
+      @format.process(@address, @table)
     end
 
-    it "should include the street if available" do
-      @address.street = "1 Test Road"
-      @format.process(@address).should include "1 Test Road"
+    it "inserts a blank 'star' column" do
+      @table.should_receive(:add_row) { |r| r[:star].should eq " " }
     end
 
-    it "should include the po box if available" do
-      @address.po_box = "123456"
-      @format.process(@address).should include "123456"
+    it "marks preferred addresses with a star" do
+      @address.preferred = true
+      @table.should_receive(:add_row) { |r| r[:star].should eq "*" }
     end
 
-    it "should include the postal code if available" do
-      @address.postal_code = "L1 9AA"
-      @format.process(@address).should include "L1 9AA"
+    it "puts the ID in its own column" do
+      @table.should_receive(:add_row) { |r| r[:address_id].should eq "home" }
     end
 
-    it "should include the region if available" do
-      @address.region = "Merseyside"
-      @format.process(@address).should include "Merseyside"
+    it "concatenates the rest of the address in its own column" do
+      @address.country = nil
+      @table.should_receive(:add_row) do |row|
+        row[:address_text].should eq "123 Happy Lane"
+      end
+    end
+
+    it "separates address elements with commas" do
+      @table.should_receive(:add_row) do |row|
+        row[:address_text].should eq "123 Happy Lane, United Kingdom"
+      end
+    end
+
+    it "prunes elements that are empty" do
+      @address.country = ""
+      @table.should_receive(:add_row) do |row|
+        row[:address_text].should eq "123 Happy Lane"
+      end
     end
 
   end

data/spec/ppl/service/postal_address_spec.rb

@@ -0,0 +1,152 @@
+
+describe Ppl::Service::PostalAddress do
+
+  before(:each) do
+    @service = Ppl::Service::PostalAddress.new
+    @contact = Ppl::Entity::Contact.new
+    @address = Ppl::Entity::PostalAddress.new
+  end
+
+  describe "#add" do
+
+    before(:each) do
+      @service.add(@contact, "home", {
+        :country     => "United Kingdom",
+        :locality    => "Bristol",
+        :street      => "1 Broad Mead",
+        :po_box      => "550011",
+        :postal_code => "BS1 1SB",
+        :region      => "South West",
+      })
+      @address = @contact.postal_addresses.first
+    end
+
+    it "adds one postal address to the contact" do
+      @contact.postal_addresses.length.should eq 1
+    end
+
+    it "sets the country of the new address" do
+      @address.country.should eq "United Kingdom"
+    end
+    it "sets the locality of the new address" do
+      @address.locality.should eq "Bristol"
+    end
+    it "sets the street of the new address" do
+      @address.street.should eq "1 Broad Mead"
+    end
+    it "sets the PO box of the new address" do
+      @address.po_box.should eq "550011"
+    end
+    it "sets the postal code of the new address" do
+      @address.postal_code.should eq "BS1 1SB"
+    end
+    it "sets the region of the new address" do
+      @address.region.should eq "South West"
+    end
+  end
+
+
+  describe "#update" do
+
+    before(:each) do
+      @address.id = "home"
+      @contact.postal_addresses << @address
+      @service.update(@contact, "home", {
+        :country     => "United Kingdom",
+        :locality    => "Bristol",
+        :street      => "1 Broad Mead",
+        :po_box      => "550011",
+        :postal_code => "BS1 1SB",
+        :region      => "South West",
+      })
+    end
+
+    it "doesn't change the number of addresses owned by the contact" do
+      @contact.postal_addresses.length.should eq 1
+    end
+    it "sets the country of the new address" do
+      @address.country.should eq "United Kingdom"
+    end
+    it "sets the locality of the new address" do
+      @address.locality.should eq "Bristol"
+    end
+    it "sets the street of the new address" do
+      @address.street.should eq "1 Broad Mead"
+    end
+    it "sets the PO box of the new address" do
+      @address.po_box.should eq "550011"
+    end
+    it "sets the postal code of the new address" do
+      @address.postal_code.should eq "BS1 1SB"
+    end
+    it "sets the region of the new address" do
+      @address.region.should eq "South West"
+    end
+  end
+
+
+  describe "#update" do
+
+    before(:each) do
+      @address.id = "home"
+      @contact.postal_addresses << @address
+    end
+
+    it "allows addresses to be moved" do
+      @service.should_receive(:move)
+      @service.update(@contact, "home", {:new_id => "work"})
+    end
+
+    it "sets addresses as preferred" do
+      second_address = Ppl::Entity::PostalAddress.new
+      second_address.id = "other"
+      second_address.preferred = true
+      @contact.postal_addresses << second_address
+      @service.update(@contact, "home", {:preferred => true})
+      @address.preferred.should eq true
+      second_address.preferred.should eq false
+    end
+
+    it "sets addresses as not preferred" do
+      @address.preferred = true
+      @service.update(@contact, "home", {:preferred => false})
+      @address.preferred.should eq false
+    end
+
+  end
+
+  describe "#move" do
+    before(:each) do
+      @address.id = "home"
+      @contact.postal_addresses << @address
+      other_address = Ppl::Entity::PostalAddress.new
+      other_address.id = "other"
+      @contact.postal_addresses << other_address
+    end
+    it "raises an error if the new ID is already in use" do
+      expect{@service.move(@contact, "home", "other")}.to raise_error
+    end
+    it "moves the address to the new ID" do
+      @service.move(@contact, "home", "available")
+      @address.id.should eq "available"
+    end
+  end
+
+  describe "#remove" do
+    before(:each) do
+      @address.id = "home"
+      @contact.postal_addresses << @address
+      @service.remove(@contact, "home")
+    end
+
+    it "removes the specified address" do
+      @contact.postal_addresses.length.should eq 0
+    end
+
+    it "raises an error if there is no such address" do
+      expect{@service.remove(@contact, "home")}.to raise_error(Ppl::Error::PostalAddressNotFound)
+    end
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Henry Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -150,7 +150,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: CLI Address Book
+description: ppl is a command-line address book using vCard & git for storage and
+  synchronisation
 email: henry@henrysmith.org
 executables:
 - ppl
@@ -177,6 +178,7 @@ files:
 - features/nick.feature
 - features/org.feature
 - features/phone.feature
+- features/post.feature
 - features/rm.feature
 - features/step_definitions/address_book_steps.rb
 - features/step_definitions/cwd_steps.rb
@@ -232,6 +234,7 @@ files:
 - lib/ppl/error/completion_not_found.rb
 - lib/ppl/error/contact_not_found.rb
 - lib/ppl/error/incorrect_usage.rb
+- lib/ppl/error/postal_address_not_found.rb
 - lib/ppl/format/address_book.rb
 - lib/ppl/format/address_book/ages.rb
 - lib/ppl/format/address_book/birthdays.rb
@@ -254,16 +257,19 @@ files:
 - lib/ppl/format/contact/organization.rb
 - lib/ppl/format/contact/phone_number.rb
 - lib/ppl/format/contact/postal_address.rb
+- lib/ppl/format/contact/postal_addresses.rb
 - lib/ppl/format/contact/urls.rb
 - lib/ppl/format/custom.rb
 - lib/ppl/format/custom/contact.rb
 - lib/ppl/format/custom/email_address.rb
 - lib/ppl/format/custom/phone_number.rb
 - lib/ppl/format/postal_address.rb
+- lib/ppl/format/postal_address/multi_line.rb
 - lib/ppl/format/postal_address/one_line.rb
 - lib/ppl/format/table.rb
 - lib/ppl/service/email_address.rb
 - lib/ppl/service/phone_number.rb
+- lib/ppl/service/postal_address.rb
 - ppl.gemspec
 - spec/ppl/adapter/color/colored_spec.rb
 - spec/ppl/adapter/color_spec.rb
@@ -332,17 +338,20 @@ files:
 - spec/ppl/format/contact/organization_spec.rb
 - spec/ppl/format/contact/phone_number_spec.rb
 - spec/ppl/format/contact/postal_address_spec.rb
+- spec/ppl/format/contact/postal_addresses_spec.rb
 - spec/ppl/format/contact/urls_spec.rb
 - spec/ppl/format/contact_spec.rb
 - spec/ppl/format/custom/contact_spec.rb
 - spec/ppl/format/custom/email_address_spec.rb
 - spec/ppl/format/custom/phone_number_spec.rb
 - spec/ppl/format/custom_spec.rb
+- spec/ppl/format/postal_address/multi_line_spec.rb
 - spec/ppl/format/postal_address/one_line_spec.rb
 - spec/ppl/format/postal_address_spec.rb
 - spec/ppl/format/table_spec.rb
 - spec/ppl/service/email_address_spec.rb
 - spec/ppl/service/phone_number_spec.rb
+- spec/ppl/service/postal_address_spec.rb
 - spec/spec_helper.rb
 homepage: http://ppladdressbook.org
 licenses:
@@ -367,5 +376,5 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: CLI Address Book
+summary: The command line address book
 test_files: []