ppl 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c8a86000f8071b266624cd2cb96c4ea0da0294a
-  data.tar.gz: f0a2f09b185c73029847e11b010cc81f5fe97d7d
+  metadata.gz: 2f33a5e4b27cd115dbac2ce3532e4fc81e93635e
+  data.tar.gz: 1eef11f3f8784fa687c211b9343fe45e914c2cb2
 SHA512:
-  metadata.gz: eb44a9bf6207db1a1073b47f2e7fe22787b4f05e9d04987faabc473de6372ee35db3ae04c3b5bffa85817b4bd5fe8b5c060ce071faa231dbba14dc7752dae5f1
-  data.tar.gz: 487f408c4610193bbb135d0016cee82555ab0445b64645da7c072eb351d1ea32084173886eaecf44e41a9563f4276865f843348fe4ecce614a082daa619a29a8
+  metadata.gz: 19c1da0a40163b4e3b37f9ae01ef70b590b312b2dc381cdb5ba35f776261f85fda799736c0e5d0694a4f7d67e3a85f232f7ab961b95f8a2e15fd3f1f72e1ffe1
+  data.tar.gz: 4798e2a97cdb5daf366d821e8b736d187798ef238a00329aae88d66149379cfad1207d98c8bf4f432099e4756617802c61a307458518876340dfbc386ace4973

data/Rakefile

@@ -40,3 +40,9 @@ task :enable_config do
   end
 end
 
+task :feature, :feature_name do |task, params|
+  Rake::Task["disable_config"].invoke
+  system "bundle exec cucumber features/#{params[:feature_name]}.feature"
+  Rake::Task["enable_config"].invoke
+end
+

data/features/email.feature

@@ -1,6 +1,13 @@
 
 Feature: ppl email
 
+  Scenario: Add a preferred email address to a contact
+    Given I am in an address book with a blank contact called bob
+    And I run "ppl email bob --preferred bob@example.org"
+    Then it should succeed
+    And bob should have 1 email address
+    And the 1st email address should be "*  bob@example.org"
+
   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"
@@ -8,9 +15,39 @@ Feature: ppl email
     And bob should have 1 email address
     And the 1st email address should be "bob@example.org"
 
-  Scenario: Remove an email address from a contact
+  Scenario: Add a second email address to a contact
+    Given I am in the same address book as before
+    And I run "ppl email bob rob@testing.com"
+    Then it should succeed
+    And bob should have 2 email addresses
+    And the 1st email address should be "bob@example.org"
+    And the 2nd email address should be "rob@testing.com"
+
+  Scenario: Set an existing email address as the preferred address
+    Given I am in the same address book as before
+    And I run "ppl email bob --preferred rob@testing.com"
+    Then it should succeed
+    And bob should have 2 email addresses
+    And "rob@testing.com" should be the favourite email address
+
+  Scenario: Choose a different preferred email address
+    Given I am in the same address book as before
+    And I run "ppl email bob --preferred bob@example.org"
+    Then it should succeed
+    And bob should have 2 email addresses
+    And "bob@example.org" should be the favourite email address
+
+  Scenario: Remove the preferred flag from an email address
+    Given I am in the same address book as before
+    And I run "ppl email bob --not-preferred bob@example.org"
+    Then it should succeed
+    And bob should have 2 email addresses
+    And there should be no favourite email address
+
+  Scenario: Remove email addresses from a contact
     Given I am in the same address book as before
     And I run "ppl email bob --delete bob@example.org"
+    And I run "ppl email bob --d rob@testing.com"
     Then it should succeed
     And bob should have 0 email addresses
 

data/features/phone.feature

@@ -1,6 +1,13 @@
 
 Feature: ppl phone
 
+  Scenario: Add a preferred phone number with a type
+    Given I am in an address book with a blank contact called bob
+    And I run "ppl phone bob 123 --type cell --preferred"
+    Then it should succeed
+    And bob should have 1 phone number
+    And the 1st phone number should be "*  123  (cell)"
+
   Scenario: Add a phone number to a contact
     Given I am in an address book with a blank contact called bob
     And I run "ppl phone bob 01234567890"
@@ -22,6 +29,20 @@ Feature: ppl phone
     And bob should have 1 phone number
     And the 1st phone number should be "01234567890"
 
+  Scenario: Set an existing phone number as the preferred number
+    Given I am in the same address book as before
+    And I run "ppl phone bob 01234567890 --preferred"
+    Then it should succeed
+    And bob should have 1 phone number
+    And "01234567890" should be the preferred phone number
+
+  Scenario: Remove the preferred flag from a phone number
+    Given I am in the same address book as before
+    And I run "ppl phone bob -P 01234567890"
+    Then it should succeed
+    And bob should have 1 phone number
+    And there should be no preferred phone number
+
   Scenario: Remove a phone number from a contact
     Given I am in the same address book as before
     And I run "ppl phone bob --delete 01234567890"

data/features/step_definitions/ppl_steps.rb

@@ -60,7 +60,7 @@ And /^its name should be "([^"]+)"$/ do |name|
 end
 
 Then(/^the (\d+).. email address should be "([^"]+)"$/) do |nth, address|
-  @email_addresses[nth.to_i - 1].should eq address
+  @email_addresses[nth.to_i - 1].strip.should eq address
 end
 
 Then /^running "ppl ([^"]+)" should output (\d+) lines?$/ do |command, lines|
@@ -88,6 +88,36 @@ Then(/^the (\d+).. URL should be "([^"]+)"$/) do |nth, url|
   @urls[nth.to_i - 1].should eq url
 end
 
+And /^"([^"]+)" should be the favourite email address$/ do |email_address|
+  @email_addresses.should include "*  #{email_address}"
+  @email_addresses.each do |line|
+    if line.include? "*"
+      line.should eq "*  #{email_address}"
+    end
+  end
+end
+
+And /^"([^"]+)" should be the preferred phone number$/ do |phone_number|
+  @phone_numbers.should include "*  #{phone_number}"
+  @phone_numbers.each do |line|
+    if line.include? "*"
+      line.should eq "*  #{phone_number}"
+    end
+  end
+end
+
+And /^there should be no favourite email address$/ do
+  @email_addresses.each do |line|
+    line.should_not include "*"
+  end
+end
+
+And /^there should be no preferred phone number$/ do
+  @phone_numbers.each do |line|
+    line.should_not include "*"
+  end
+end
+
 Then /^(bob)'s birthday should be "([^"]+)"$/ do |id, birthday|
   ppl("bday #{id}").should eq birthday
 end

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

@@ -58,7 +58,9 @@ class Ppl::Adapter::Vcard::GreenCard
 
   def encode_email_addresses(contact, vcard_maker)
     contact.email_addresses.each do |email_address|
-      vcard_maker.add_email(email_address)
+      vcard_maker.add_email(email_address.address) do |vcard_email|
+        vcard_email.preferred = email_address.preferred
+      end
     end
   end
 
@@ -66,6 +68,7 @@ class Ppl::Adapter::Vcard::GreenCard
     contact.phone_numbers.each do |phone_number|
       vcard_maker.add_tel(phone_number.number) do |tel|
         tel.location = phone_number.type
+        tel.preferred = phone_number.preferred
       end
     end
   end
@@ -117,7 +120,9 @@ class Ppl::Adapter::Vcard::GreenCard
 
   def decode_email_addresses(vcard, contact)
     vcard.emails.each do |email|
-      contact.email_addresses.push(email.to_s)
+      email_address = Ppl::Entity::EmailAddress.new(email.to_s)
+      email_address.preferred = email.preferred
+      contact.email_addresses << email_address
     end
   end
 
@@ -137,6 +142,7 @@ class Ppl::Adapter::Vcard::GreenCard
       phone_number = Ppl::Entity::PhoneNumber.new
       phone_number.number = tel.to_s
       phone_number.type = (tel.location | tel.nonstandard).join
+      phone_number.preferred = tel.preferred
       contact.phone_numbers << phone_number
     end
   end

data/lib/ppl/application/bootstrap.rb

@@ -37,6 +37,7 @@ class Ppl::Application::Bootstrap
 
   register :command_email do
     email = Ppl::Command::Email.new
+    email.email_service = email_service
     email.storage = storage_adapter
     email.list_format = format_address_book_email_addresses
     email.show_format = format_contact_email_addresses
@@ -101,6 +102,7 @@ class Ppl::Application::Bootstrap
 
   register :command_phone do
     phone = Ppl::Command::Phone.new
+    phone.phone_service = phone_service
     phone.storage = storage_adapter
     phone.list_format = format_address_book_phone_numbers
     phone.show_format = format_contact_phone_numbers
@@ -349,5 +351,17 @@ class Ppl::Application::Bootstrap
     Ppl::Adapter::EmailScraper::Mail.new
   end
 
+  register :email_service do
+    email_service = Ppl::Service::EmailAddress.new
+    email_service.storage = storage_adapter
+    email_service
+  end
+
+  register :phone_service do
+    phone_service = Ppl::Service::PhoneNumber.new
+    phone_service.storage = storage_adapter
+    phone_service
+  end
+
 end
 

data/lib/ppl/command/email.rb

@@ -1,18 +1,72 @@
 
-class Ppl::Command::Email < Ppl::Command::Attribute
+class Ppl::Command::Email < Ppl::Application::Command
 
   name        "email"
   description "Show or change a contact's email address"
 
-  def initialize
-    @attribute = :email_addresses
-  end
+  attr_writer :email_service
+  attr_writer :list_format
+  attr_writer :show_format
 
   def options(parser, options)
     parser.banner = "usage: ppl email <contact> [<email-address>]"
     parser.on("-d", "--delete", "delete email address") do
       options[:delete] = true
     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)
+    action = determine_action(input)
+    send(action, input, output)
+    true
+  end
+
+  private
+
+  def determine_action(input)
+    if input.arguments.length < 1
+      :list_address_book_email_addresses
+    elsif input.arguments.length < 2
+      :show_contact_email_addresses
+    elsif input.options[:delete]
+      :remove_email_address_from_contact
+    else
+      :update_contact_email_addresses
+    end
+  end
+
+  def list_address_book_email_addresses(input, output)
+    address_book = @storage.load_address_book
+    output.line(@list_format.process(address_book))
+  end
+
+  def show_contact_email_addresses(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    output.line(@show_format.process(contact))
+  end
+
+  def remove_email_address_from_contact(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    @email_service.remove(contact, input.arguments[1])
+  end
+
+  def update_contact_email_addresses(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    if new_email_address?(contact, input.arguments[1])
+      @email_service.add(contact, input.arguments[1], input.options)
+    else
+      @email_service.update(contact, input.arguments[1], input.options)
+    end
+  end
+
+  def new_email_address?(contact, email_address)
+    (contact.email_addresses.select { |ea| ea.address == email_address }).empty?
   end
 
 end

data/lib/ppl/command/mutt.rb

@@ -62,9 +62,9 @@ class Ppl::Command::Mutt < Ppl::Application::Command
   def match_by_email_address(contact, query)
     matches = contact.email_addresses.select do |email_address|
       if @options[:ignore_case]
-        email_address.downcase.include? query.downcase
+        email_address.address.downcase.include? query.downcase
       else
-        email_address.include? query
+        email_address.address.include? query
       end
     end
     if matches.length > 0

data/lib/ppl/command/phone.rb

@@ -1,61 +1,76 @@
 
-class Ppl::Command::Phone < Ppl::Command::Attribute
+class Ppl::Command::Phone < Ppl::Application::Command
 
   name        "phone"
   description "List, show or change phone numbers"
 
-  def initialize
-    @attribute = :phone_numbers
-  end
+  attr_writer :phone_service
+  attr_writer :list_format
+  attr_writer :show_format
 
   def options(parser, options)
     parser.banner = "usage: ppl phone <contact> [<number>]"
     parser.on("-d", "--delete", "delete phone number") do
       options[:delete] = true
     end
-    parser.on("-t", "--type <type>") do |type|
+    parser.on("-t", "--type <type>", "set the phone number's type") do |type|
       options[:type] = type
     end
+    parser.on("-p", "--preferred", "mark phone number as preferred") do
+      options[:preferred] = true
+    end
+    parser.on("-P", "--not-preferred", "mark phone number as not preferred") do
+      options[:preferred] = false
+    end
+  end
+
+  def execute(input, output)
+    action = determine_action(input)
+    send(action, input, output)
+    true
   end
 
-  def add_attribute(input, output)
-    contact = @storage.require_contact(input.arguments.shift)
-    if new_number?(contact, input.arguments[0])
-      add_new_number(contact, input)
+  private
+
+  def determine_action(input)
+    if input.arguments.length < 1
+      :list_address_book_phone_numbers
+    elsif input.arguments.length < 2
+      :show_contact_phone_numbers
+    elsif input.options[:delete]
+      :remove_phone_number_from_contact
     else
-      update_existing_number(contact, input)
+      :update_contact_phone_numbers
     end
-    @storage.save_contact(contact)
-    true
   end
 
-  def remove_attribute(input, output)
-    contact = @storage.require_contact(input.arguments[0])
-    contact.phone_numbers.select! { |pn| pn.number != input.arguments[1] }
-    @storage.save_contact(contact)
+  def list_address_book_phone_numbers(input, output)
+    address_book = @storage.load_address_book
+    output.line(@list_format.process(address_book))
   end
 
-  def new_number?(contact, input_number)
-    matching_numbers = contact.phone_numbers.select do |pn|
-      pn.number == input_number
-    end
-    matching_numbers.length < 1
+  def show_contact_phone_numbers(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    output.line(@show_format.process(contact))
   end
 
-  def add_new_number(contact, input)
-    phone_number = Ppl::Entity::PhoneNumber.new
-    phone_number.number = input.arguments[0]
-    phone_number.type = input.options[:type]
-    contact.phone_numbers << phone_number
+  def remove_phone_number_from_contact(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    @phone_service.remove(contact, input.arguments[1])
   end
 
-  def update_existing_number(contact, input)
-    contact.phone_numbers.each do |pn|
-      if pn.number == input.arguments[0]
-        pn.type = input.options[:type]
-      end
+  def update_contact_phone_numbers(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    if new_phone_number?(contact, input.arguments[1])
+      @phone_service.add(contact, input.arguments[1], input.options)
+    else
+      @phone_service.update(contact, input.arguments[1], input.options)
     end
   end
 
+  def new_phone_number?(contact, number)
+    (contact.phone_numbers.select { |pn| pn.number == number }).empty?
+  end
+
 end
 

data/lib/ppl/entity/email_address.rb

@@ -0,0 +1,13 @@
+
+class Ppl::Entity::EmailAddress
+
+  attr_accessor :address
+  attr_accessor :preferred
+
+  def initialize(address = nil)
+    @address = address
+    @preferred = false
+  end
+
+end
+

data/lib/ppl/entity/phone_number.rb

@@ -3,9 +3,11 @@ class Ppl::Entity::PhoneNumber
 
   attr_accessor :number
   attr_accessor :type
+  attr_accessor :preferred
 
   def initialize(number = nil, type = nil)
     @number = number
+    @preferred = false
     @type = type
   end
 

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

@@ -18,10 +18,13 @@ class Ppl::Format::AddressBook::EmailAddresses < Ppl::Format::AddressBook
   def add_row(contact)
     @table.add_row({
       :id              => sprintf("%s:", contact.id),
-      :email_addresses => contact.email_addresses.join(", "),
+      :email_addresses => stringify_email_addresses(contact.email_addresses),
     })
   end
 
+  def stringify_email_addresses(email_addresses)
+    email_addresses.map { |em| em.address }.join(", ")
+  end
 
 end
 

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

@@ -23,7 +23,7 @@ class Ppl::Format::AddressBook::MuttQuery < Ppl::Format::AddressBook
 
   def add_email_address(email_address, name)
     @table.add_row({
-      :email => email_address,
+      :email => email_address.address,
       :name  => name,
     })
   end

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

@@ -20,7 +20,7 @@ class Ppl::Format::AddressBook::OneLine < Ppl::Format::AddressBook
     email = nil
 
     if !contact.email_addresses.empty?
-      email = sprintf("<%s>", contact.email_addresses.first)
+      email = sprintf("<%s>", choose_email_address(contact).address)
     end
 
     @table.add_row({
@@ -30,5 +30,14 @@ class Ppl::Format::AddressBook::OneLine < Ppl::Format::AddressBook
     })
   end
 
+  def choose_email_address(contact)
+    preferred = contact.email_addresses.find { |e| e.preferred }
+    if preferred.nil?
+      contact.email_addresses.first
+    else
+      preferred
+    end
+  end
+
 end
 

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

@@ -1,30 +1,20 @@
 
 class Ppl::Format::Contact::EmailAddresses < Ppl::Format::Contact
 
-  attr_writer :color_adapter
-  attr_writer :colors
+  attr_writer :table
 
   def initialize(colors={})
-    @colors = colors
-    @color_adapter = Ppl::Adapter::Color::Colored.new
+    @table = Ppl::Format::Table.new([:star, :email_addresses], colors)
   end
 
   def process(contact)
-    lines = []
     contact.email_addresses.each do |email_address|
-      lines.push email_address
-    end
-    colorize_output(lines.join("\n"))
-  end
-
-  private
-
-  def colorize_output(string)
-    if @colors["email_addresses"]
-      @color_adapter.colorize(string, @colors["email_addresses"])
-    else
-      string
+      @table.add_row({
+        :star            => email_address.preferred ? "*" : " ",
+        :email_addresses => email_address.address,
+      })
     end
+    @table.to_s
   end
 
 end

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

@@ -1,9 +1,13 @@
 
 class Ppl::Format::Contact::Full < Ppl::Format::Contact
 
+  attr_writer :email_address_format
+  attr_writer :phone_number_format
   attr_writer :postal_address_format
 
   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
   end
 
@@ -37,12 +41,22 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
     if !contact.name.nil?
       line += contact.name
     end
-    if !contact.email_addresses.empty?
-      line += " <#{contact.email_addresses.first}>"
+    email_address = choose_first_line_address(contact)
+    unless email_address.nil?
+      line += " <#{email_address.address}>"
     end
     return line
   end
 
+  def choose_first_line_address(contact)
+    preferred = contact.email_addresses.find { |e| e.preferred }
+    if preferred.nil?
+      contact.email_addresses.first
+    else
+      preferred
+    end
+  end
+
   def vitals(contact)
     vitals = []
     if !contact.birthday.nil?
@@ -60,16 +74,18 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
   end
 
   def format_email_addresses(contact)
-    push_list("Email Addresses", contact.email_addresses)
+    unless contact.email_addresses.empty?
+      @lines << ""
+      @lines << "Email Addresses:"
+      @lines << @email_address_format.process(contact)
+    end
   end
 
   def format_phone_numbers(contact)
     unless contact.phone_numbers.empty?
       @lines << ""
       @lines << "Phone Numbers"
-      contact.phone_numbers.each do |pn|
-        @lines << "  #{pn.number}"
-      end
+      @lines << @phone_number_format.process(contact)
     end
   end
 
@@ -86,12 +102,15 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
     push_list("URLs", contact.urls)
   end
 
-  def push_list(label, list)
+  def push_list(label, list, property = nil)
     return if list.empty?
     @lines.push("")
     @lines.push("#{label}:")
     if list.kind_of?(Array)
-      list.each { |item| @lines.push("  #{item}") }
+      list.each do |item|
+        string = property.nil? ? item : item.send(property)
+        @lines << "  #{string}"
+      end
     else
       @lines.push("  #{list}")
     end

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

@@ -4,7 +4,7 @@ class Ppl::Format::Contact::PhoneNumber < Ppl::Format::Contact
   attr_writer :table
 
   def initialize(colors={})
-    @table = Ppl::Format::Table.new([:phone_numbers, :type], colors)
+    @table = Ppl::Format::Table.new([:star, :phone_numbers, :type], colors)
   end
 
   def process(contact)
@@ -16,11 +16,16 @@ class Ppl::Format::Contact::PhoneNumber < Ppl::Format::Contact
 
   def add_row(phone_number)
     @table.add_row({
+      :star          => format_star(phone_number),
       :phone_numbers => phone_number.number,
       :type          => format_type(phone_number.type),
     })
   end
 
+  def format_star(phone_number)
+    phone_number.preferred ? "*" : " "
+  end
+
   def format_type(type)
     unless type.nil? || type == ""
       "(#{type})"

data/lib/ppl/format/table.rb

@@ -34,8 +34,8 @@ class Ppl::Format::Table
 
   def to_s
     string = ""
-    @rows.each { |row| string += format_row(row).strip + "\n" }
-    string.strip
+    @rows.each { |row| string += format_row(row).rstrip + "\n" }
+    string.rstrip
   end
 
   def disable_colors!