ppl 1.25.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3438ed54b9c4ab282ccc9a9389511777516fee7a
-  data.tar.gz: 63d86817042ebf3a768294d394bfc3c77ff60a01
+  metadata.gz: ae020954e5c508fd1ea28a2bfb193fbb6393252d
+  data.tar.gz: 9d5b69c1e111f93bf92451dfcb4bc448de214393
 SHA512:
-  metadata.gz: c789b838676b6d9cd50f0bcd6c0060fdd87287ed3f0dd6088c11ba5a9cd995e0306eb488bc40e2f81fe9c3c7ad91a5206f6cc586cae9f93c09d21f783ff1fec6
-  data.tar.gz: f48891ad62cc516d9a69a73ccfe84080b086017d8d307683e4934563786d18163f7e2b5c93ee17b2fbefae67c5485598cefbf8846fb001a5756b9f594da22f55
+  metadata.gz: 1fae903da342d62e76058b006313c3bad706a4faa509fb3792177bc5eb0e2803c2993f11d491f820503dceea8b1b1bd6905e4183aaeaef8f8d5809bdc03427fe
+  data.tar.gz: ad1fd41a18934622b4d78f6f59c79b13513f0242c2f50ae33fb68bc7d50909233fd19ab5fa037594b03270831cfe16b172c7429a9501c9594d28df5f9f7c7bd5

data/features/email.feature

@@ -8,6 +8,16 @@ Feature: ppl email
     And bob should have 1 email address
     And the 1st email address should be "*  bob@example.org"
 
+  Scenario: Custom output with %a
+    Given I am in the same address book as before
+    Then running "ppl email bob --format '%a'" should output 1 line
+    And the 1st line should be "bob@example.org"
+
+  Scenario: Custom output with %f
+    Given I am in the same address book as before
+    Then running "ppl email bob --format '%f'" should output 1 line
+    And the 1st line should be "*"
+
   Scenario: Add an email address to a contact
     Given I am in an address book with a blank contact called bob
     And I run "ppl email bob bob@example.org"

data/features/ls.feature

@@ -8,3 +8,18 @@ Feature: ppl ls
     Then running "ppl ls" should output 1 line
     And the 1st line should be "bob:  Robert Testing  <bob@example.org>"
 
+  Scenario: Custom output with %i
+    Given I am in the same address book as before
+    Then running "ppl ls --format '%i'" should output 1 line
+    And the 1st line should be "bob"
+
+  Scenario: Custom output with %N
+    Given I am in the same address book as before
+    Then running "ppl ls --format '%N'" should output 1 line
+    And the 1st line should be "Robert Testing"
+
+  Scenario: Custom output with %e
+    Given I am in the same address book as before
+    Then running "ppl ls --format '%e'" should output 1 line
+    And the 1st line should be "bob@example.org"
+

data/features/post.feature

@@ -0,0 +1,24 @@
+
+Feature: ppl post
+
+  Scenario: Add a home postal address to a contact
+    Given I am in an address book with a blank contact called bob
+    And I run "ppl post bob home --street '1234 Testing Avenue' --postal-code 'AB1 2CD'"
+    Then it should succeed
+    And bob should have 1 postal address
+    And the 1st postal address should be "home  1234 Testing Avenue, AB1 2CD"
+
+  Scenario: Add a work postal address to a contact
+    Given I am in the same address book as before
+    And I run "ppl post bob work --street '987 Working Road' --postal-code 'EF3 4GH'"
+    Then it should succeed
+    And bob should have 2 postal addresses
+    And the 2nd postal address should be "   work  987 Working Road, EF3 4GH"
+
+  Scenario: Mark an existing postal address as preferred
+    Given I am in the same address book as before
+    And I run "ppl post bob work --preferred"
+    Then it should succeed
+    And bob should have 2 postal addresses
+    And "work" should be the preferred postal address
+

data/features/step_definitions/ppl_steps.rb

@@ -46,6 +46,11 @@ Then /^(bob) should have (\d+) phone numbers?$/ do |name, number|
   @phone_numbers.length.should eq number.to_i
 end
 
+Then /^(bob) should have (\d+) postal addresse?s?$/ do |name, number|
+  @postal_addresses = ppl("post #{name}").split("\n")
+  @postal_addresses.length.should eq number.to_i
+end
+
 Then /^(bob) should have (\d+) URLs?$/ do |name, number|
   @urls = ppl("url #{name}").split("\n")
   @urls.length.should eq number.to_i
@@ -84,6 +89,10 @@ Then(/^the (\d+).. phone number should be "([^"]+)"$/) do |nth, phone_number|
   @phone_numbers[nth.to_i - 1].should eq phone_number
 end
 
+Then(/^the (\d+).. postal address should be "([^"]+)"$/) do |nth, address|
+  @postal_addresses[nth.to_i - 1].should eq address
+end
+
 Then(/^the (\d+).. URL should be "([^"]+)"$/) do |nth, url|
   @urls[nth.to_i - 1].should eq url
 end
@@ -106,6 +115,14 @@ And /^"([^"]+)" should be the preferred phone number$/ do |phone_number|
   end
 end
 
+And /^"([^"]+)" should be the preferred postal address$/ do |postal_address|
+  @postal_addresses.each do |line|
+    if line.include? "*"
+      line.should include "*  #{postal_address}"
+    end
+  end
+end
+
 And /^there should be no favourite email address$/ do
   @email_addresses.each do |line|
     line.should_not include "*"

data/lib/ppl/adapter/vcard/greencard.rb

@@ -1,5 +1,6 @@
 
 require "greencard/vcard"
+require "digest/sha1"
 
 class Ppl::Adapter::Vcard::GreenCard
 
@@ -10,6 +11,7 @@ class Ppl::Adapter::Vcard::GreenCard
     :country    => :country,
     :region     => :region,
     :locality   => :locality,
+    :preferred  => :preferred,
   }
 
   def encode(contact)
@@ -20,7 +22,7 @@ class Ppl::Adapter::Vcard::GreenCard
       encode_phone_numbers(contact, maker)
       encode_nicknames(contact, maker)
       encode_organizations(contact, maker)
-      encode_postal_address(contact, maker)
+      encode_postal_addresses(contact, maker)
       encode_urls(contact, maker)
     end
     vcard.to_s
@@ -32,7 +34,7 @@ class Ppl::Adapter::Vcard::GreenCard
     decode_birthday(vcard, contact)
     decode_email_addresses(vcard, contact)
     decode_phone_numbers(vcard, contact)
-    decode_postal_address(vcard, contact)
+    decode_postal_addresses(vcard, contact)
     decode_nicknames(vcard, contact)
     decode_organizations(vcard, contact)
     decode_name(vcard, contact)
@@ -79,15 +81,20 @@ class Ppl::Adapter::Vcard::GreenCard
     end
   end
 
-  def encode_postal_address(contact, vcard_maker)
-    if !contact.postal_address.nil?
-      vcard_maker.add_addr do |address|
-        @@postal_address_property_map.each_pair do |vpim_name, ppl_name|
-          value = contact.postal_address.send(ppl_name)
-          if !value.nil?
-            address.send("#{vpim_name.to_s}=", value)
-          end
-        end
+  def encode_postal_addresses(contact, vcard_maker)
+    contact.postal_addresses.each do |postal_address|
+      vcard_maker.add_addr do |vcard_address|
+        encode_postal_address(postal_address, vcard_address)
+      end
+    end
+  end
+
+  def encode_postal_address(ppl_address, vcard_address)
+    vcard_address.location = ppl_address.id
+    @@postal_address_property_map.each_pair do |vpim_name, ppl_name|
+      value = ppl_address.send(ppl_name)
+      if !value.nil?
+        vcard_address.send("#{vpim_name.to_s}=", value)
       end
     end
   end
@@ -126,15 +133,38 @@ class Ppl::Adapter::Vcard::GreenCard
     end
   end
 
-  def decode_postal_address(vcard, contact)
-    if !vcard.address.nil?
-      contact.postal_address             = Ppl::Entity::PostalAddress.new
-      @@postal_address_property_map.each_pair do |vpim_name, ppl_name|
-        value  = vcard.address.send(vpim_name)
-        method = "#{ppl_name.to_s}="
-        contact.postal_address.send(method, value)
-      end
+  def decode_postal_addresses(vcard, contact)
+    vcard.addresses.each do |vcard_address|
+      postal_address = decode_postal_address(vcard_address)
+      contact.postal_addresses << postal_address
+    end
+  end
+
+  def decode_postal_address(vcard_address)
+    postal_address = Ppl::Entity::PostalAddress.new
+    postal_address.id = determine_postal_address_id(vcard_address)
+    @@postal_address_property_map.each_pair do |vpim_name, ppl_name|
+      value  = vcard_address.send(vpim_name)
+      method = "#{ppl_name.to_s}="
+      postal_address.send(method, value)
+    end
+    postal_address
+  end
+
+  def determine_postal_address_id(vcard_address)
+    id = (vcard_address.location | vcard_address.nonstandard).join
+    if id == ""
+      id = Digest::SHA1.hexdigest([
+        vcard_address.country,
+        vcard_address.delivery,
+        vcard_address.locality,
+        vcard_address.pobox,
+        vcard_address.postalcode,
+        vcard_address.region,
+        vcard_address.street,
+      ].join)[0..6]
     end
+    id
   end
 
   def decode_phone_numbers(vcard, contact)

data/lib/ppl/application/bootstrap.rb

@@ -114,8 +114,10 @@ class Ppl::Application::Bootstrap
   register :command_post do
     post = Ppl::Command::Post.new
     post.storage = storage_adapter
-    post.list_format = format_address_book_postal_addresses
-    post.show_format = format_contact_postal_addresses
+    post.address_book_format = format_address_book_postal_addresses
+    post.contact_format = format_contact_postal_addresses
+    post.postal_address_format = format_postal_address_multi_line
+    post.address_service = postal_address_service
     post
   end
 
@@ -318,7 +320,7 @@ class Ppl::Application::Bootstrap
   end
 
   register :format_contact_postal_addresses do
-    Ppl::Format::Contact::PostalAddress.new
+    Ppl::Format::Contact::PostalAddresses.new
   end
 
   register :format_contact_urls do
@@ -326,6 +328,10 @@ class Ppl::Application::Bootstrap
     Ppl::Format::Contact::Urls.new(colors)
   end
 
+  register :format_postal_address_multi_line do
+    Ppl::Format::PostalAddress::MultiLine.new
+  end
+
   register :input do
     Ppl::Application::Input.new(ARGV.dup)
   end
@@ -377,5 +383,9 @@ class Ppl::Application::Bootstrap
     phone_service
   end
 
+  register :postal_address_service do
+    Ppl::Service::PostalAddress.new
+  end
+
 end
 

data/lib/ppl/application/shell.rb

@@ -15,6 +15,8 @@ class Ppl::Application::Shell
       output.error("ppl: No completion function available for '#{$!}'")
     rescue Ppl::Error::ContactNotFound
       output.error("ppl: Contact '#{$!}' not found")
+    rescue Ppl::Error::PostalAddressNotFound
+      output.error("ppl: Postal address '#{$!}' not found")
     rescue OptionParser::InvalidOption, OptionParser::MissingArgument, Ppl::Error::IncorrectUsage
       output.error($!)
       output.error(@optparse.to_s)

data/lib/ppl/command/post.rb

@@ -4,8 +4,10 @@ class Ppl::Command::Post < Ppl::Application::Command
   name        "post"
   description "List, show or change postal addresses"
 
-  attr_writer :show_format
-  attr_writer :list_format
+  attr_writer :address_service
+  attr_writer :contact_format
+  attr_writer :address_book_format
+  attr_writer :postal_address_format
 
   def options(parser, options)
     parser.banner = "usage: ppl post <contact> [address]"
@@ -29,6 +31,20 @@ class Ppl::Command::Post < Ppl::Application::Command
       options[:country] = country
     end
 
+    parser.on("-d", "--delete") do
+      options[:delete] = true
+    end
+    parser.on("-m", "--move <new-id>") do |new_id|
+      options[:new_id] = new_id
+    end
+
+    parser.on("-p", "--preferred", "mark address as preferred") do
+      options[:preferred] = true
+    end
+    parser.on("-P", "--not-preferred", "mark address as not preferred") do
+      options[:preferred] = false
+    end
+
   end
 
   def execute(input, output)
@@ -40,24 +56,35 @@ class Ppl::Command::Post < Ppl::Application::Command
   private
 
   def determine_action(input)
-    if input.arguments[0].nil?
-      :list_postal_addresses
+    if input.arguments.length < 1
+      :list_address_book_postal_addresses
+    elsif input.arguments.length < 2
+      :show_contact_postal_addresses
+    elsif input.options[:delete]
+      :delete_postal_address
     elsif input.options.empty?
       :show_postal_address
+    elsif existing_address?(input)
+      :update_postal_address
     else
-      :set_postal_address
+      :create_postal_address
     end
   end
 
-  def list_postal_addresses(input, output)
+  def existing_address?(input)
+    @contact = @storage.require_contact(input.arguments[0])
+    !@contact.postal_addresses.find { |p| p.id == input.arguments[1] }.nil?
+  end
+
+  def list_address_book_postal_addresses(input, output)
     address_book = @storage.load_address_book
-    address_list = @list_format.process(address_book)
+    address_list = @address_book_format.process(address_book)
     output.line(address_list)
   end
 
-  def show_postal_address(input, output)
+  def show_contact_postal_addresses(input, output)
     contact = @storage.require_contact(input.arguments[0])
-    address = @show_format.process(contact)
+    address = @contact_format.process(contact)
     if address != ""
       output.line(address)
       true
@@ -66,17 +93,34 @@ class Ppl::Command::Post < Ppl::Application::Command
     end
   end
 
-  def set_postal_address(input, output)
+  def show_postal_address(input, output)
     contact = @storage.require_contact(input.arguments[0])
-
-    [:country, :locality, :region, :po_box, :postal_code, :street].each do |property|
-      next if input.options[property].nil?
-      contact.set_postal_address do |address|
-        address.send("#{property.to_s}=", input.options[property])
-      end
+    address = contact.postal_addresses.find { |pa| pa.id == input.arguments[1] }
+    if address.nil?
+      raise Ppl::Error::PostalAddressNotFound, input.arguments[1]
     end
+    display = @postal_address_format.process(address)
+    output.line(display)
+    true
+  end
 
+  def delete_postal_address(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    @address_service.remove(contact, input.arguments[1])
     @storage.save_contact(contact)
+    true
+  end
+
+  def update_postal_address(input, output)
+    @address_service.update(@contact, input.arguments[1], input.options)
+    @storage.save_contact(@contact)
+    true
+  end
+
+  def create_postal_address(input, output)
+    @address_service.add(@contact, input.arguments[1], input.options)
+    @storage.save_contact(@contact)
+    true
   end
 
 end

data/lib/ppl/entity/contact.rb

@@ -9,6 +9,7 @@ class Ppl::Entity::Contact
   attr_accessor :phone_numbers
   attr_accessor :organizations
   attr_accessor :postal_address
+  attr_accessor :postal_addresses
   attr_accessor :urls
 
   def initialize
@@ -16,6 +17,7 @@ class Ppl::Entity::Contact
     @nicknames = []
     @organizations = []
     @phone_numbers = []
+    @postal_addresses = []
     @urls = []
   end
 
@@ -26,10 +28,6 @@ class Ppl::Entity::Contact
     yield @postal_address
   end
 
-  def has_email_address?(email_address)
-    @email_addresses.include? email_address
-  end
-
   def age(on_date)
     if @birthday.nil?
       nil
@@ -39,5 +37,13 @@ class Ppl::Entity::Contact
     end
   end
 
+  def preferred_email_address
+    @email_addresses.find { |e| e.preferred }
+  end
+
+  def preferred_phone_number
+    @phone_numbers.find { |p| p.preferred }
+  end
+
 end
 

data/lib/ppl/entity/postal_address.rb

@@ -1,6 +1,8 @@
 
 class Ppl::Entity::PostalAddress
 
+  attr_accessor :id
+  attr_accessor :preferred
   attr_accessor :country
   attr_accessor :locality
   attr_accessor :street
@@ -8,5 +10,9 @@ class Ppl::Entity::PostalAddress
   attr_accessor :postal_code
   attr_accessor :region
 
+  def initialize
+    @preferred = false
+  end
+
 end
 

data/lib/ppl/error/postal_address_not_found.rb

@@ -0,0 +1,4 @@
+
+class Ppl::Error::PostalAddressNotFound < StandardError
+end
+

data/lib/ppl/format/address_book/postal_addresses.rb

@@ -4,7 +4,7 @@ class Ppl::Format::AddressBook::PostalAddresses < Ppl::Format::AddressBook
   attr_writer :table
 
   def initialize(colors={})
-    @table = Ppl::Format::Table.new([:id, :postal_address], colors)
+    @table = Ppl::Format::Table.new([:id, :address_ids], colors)
   end
 
   def process(address_book)
@@ -12,30 +12,17 @@ class Ppl::Format::AddressBook::PostalAddresses < Ppl::Format::AddressBook
     @table.to_s
   end
 
-
   private
 
   def add_row(contact)
-    postal_address = nil
-    if !contact.postal_address.nil?
-      postal_address = format_postal_address(contact.postal_address)
-    end
     @table.add_row({
-      :id             => sprintf("%s:", contact.id),
-      :postal_address => postal_address,
+      :id          => sprintf("%s:", contact.id),
+      :address_ids => format_address_ids(contact.postal_addresses),
     })
   end
 
-  def format_postal_address(postal_address)
-    pieces = [
-      postal_address.street,
-      postal_address.locality,
-      postal_address.region,
-      postal_address.country,
-      postal_address.postal_code,
-      postal_address.po_box,
-    ].select { |property| property != "" && !property.nil? }
-    pieces.join(", ")
+  def format_address_ids(postal_addresses)
+    postal_addresses.map { |pa| pa.id }.join(", ")
   end
 
 end

data/lib/ppl/format/contact/full.rb

@@ -8,7 +8,7 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
   def initialize
     @email_address_format = Ppl::Format::Contact::EmailAddresses.new
     @phone_number_format = Ppl::Format::Contact::PhoneNumber.new
-    @postal_address_format = Ppl::Format::PostalAddress::OneLine.new
+    @postal_address_format = Ppl::Format::Contact::PostalAddresses.new
   end
 
   def process(contact)
@@ -90,11 +90,10 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
   end
 
   def format_postal_addresses(contact)
-    if !contact.postal_address.nil?
-      push_list(
-        "Postal Address",
-        @postal_address_format.process(contact.postal_address)
-      )
+    unless contact.postal_addresses.empty?
+      @lines << ""
+      @lines << "Postal Addresses"
+      @lines << @postal_address_format.process(contact)
     end
   end
 

data/lib/ppl/format/contact/postal_addresses.rb

@@ -0,0 +1,26 @@
+
+class Ppl::Format::Contact::PostalAddresses < Ppl::Format::Contact
+
+  attr_writer :table
+  attr_writer :postal_address_format
+
+  def initialize(colors={})
+    @table = Ppl::Format::Table.new([:star, :address_id, :address_text], colors)
+    @postal_address_format = Ppl::Format::PostalAddress::OneLine.new
+  end
+
+  def process(contact)
+    contact.postal_addresses.each do |postal_address|
+      format_postal_address(postal_address)
+    end
+    @table.to_s
+  end
+
+  private
+
+  def format_postal_address(postal_address)
+    @postal_address_format.process(postal_address, @table)
+  end
+
+end
+

data/lib/ppl/format/custom/contact.rb

@@ -28,12 +28,10 @@ class Ppl::Format::Custom::Contact < Ppl::Format::Custom
   end
 
   format :e do |contact|
-    preferred = contact.email_addresses.find { |e| e.preferred }
-    first = contact.email_addresses.first
-    if !preferred.nil?
-      preferred.address
-    elsif !first.nil?
-      first.address
+    if !contact.preferred_email_address.nil?
+      contact.preferred_email_address.address
+    elsif !contact.email_addresses.first.nil?
+      contact.email_addresses.first.address
     end
   end
 
@@ -42,12 +40,10 @@ class Ppl::Format::Custom::Contact < Ppl::Format::Custom
   end
 
   format :p do |contact|
-    preferred = contact.phone_numbers.find { |p| p.preferred }
-    first = contact.phone_numbers.first
-    if !preferred.nil?
-      preferred.number
-    elsif !first.nil?
-      first.number
+    if !contact.preferred_phone_number.nil?
+      contact.preferred_phone_number.number
+    elsif !contact.phone_numbers.first.nil?
+      contact.phone_numbers.first.number
     end
   end
 

data/lib/ppl/format/postal_address/multi_line.rb

@@ -0,0 +1,16 @@
+
+class Ppl::Format::PostalAddress::MultiLine < Ppl::Format::AddressBook
+
+  def process(postal_address)
+    lines = []
+    lines << postal_address.street
+    lines << postal_address.locality
+    lines << postal_address.region
+    lines << postal_address.country
+    lines << postal_address.po_box
+    lines << postal_address.postal_code
+    lines.compact.reject(&:empty?).join "\n"
+  end
+
+end
+

data/lib/ppl/format/postal_address/one_line.rb

@@ -1,17 +1,29 @@
 
 class Ppl::Format::PostalAddress::OneLine < Ppl::Format::AddressBook
 
-  def process(postal_address)
-    pieces = []
+  def process(postal_address, table)
+    table.add_row({
+      :star         => format_star(postal_address),
+      :address_id   => postal_address.id,
+      :address_text => format_address_text(postal_address),
+    })
+  end
+
+  private
 
-    pieces.push(postal_address.street)      unless postal_address.street.nil?
-    pieces.push(postal_address.locality)    unless postal_address.locality.nil?
-    pieces.push(postal_address.region)      unless postal_address.region.nil?
-    pieces.push(postal_address.country)     unless postal_address.country.nil?
-    pieces.push(postal_address.postal_code) unless postal_address.postal_code.nil?
-    pieces.push(postal_address.po_box)      unless postal_address.po_box.nil?
+  def format_star(postal_address)
+    postal_address.preferred ? "*" : " "
+  end
 
-    pieces.join(", ")
+  def format_address_text(postal_address)
+    [
+      postal_address.street,
+      postal_address.locality,
+      postal_address.region,
+      postal_address.country,
+      postal_address.postal_code,
+      postal_address.po_box,
+    ].compact.reject(&:empty?).join(", ")
   end
 
 end