ppl 1.10.0 → 1.11.0

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

@@ -18,6 +18,7 @@ class Ppl::Adapter::Vcard::Vpim
       encode_name(contact, maker)
       encode_email_addresses(contact, maker)
       encode_phone_numbers(contact, maker)
+      encode_nicknames(contact, maker)
       encode_organizations(contact, maker)
       encode_postal_address(contact, maker)
       encode_urls(contact, maker)
@@ -32,6 +33,7 @@ class Ppl::Adapter::Vcard::Vpim
     decode_email_addresses(vcard, contact)
     decode_phone_numbers(vcard, contact)
     decode_postal_address(vcard, contact)
+    decode_nicknames(vcard, contact)
     decode_organizations(vcard, contact)
     decode_name(vcard, contact)
     decode_urls(vcard, contact)
@@ -89,6 +91,10 @@ class Ppl::Adapter::Vcard::Vpim
     contact.urls.each { |url| vcard_maker.add_url(url) }
   end
 
+  def encode_nicknames(contact, vcard_maker)
+    vcard_maker.nickname = contact.nicknames
+  end
+
   def decode_birthday(vcard, contact)
     contact.birthday = vcard.birthday unless vcard.birthday.nil?
   end
@@ -132,5 +138,15 @@ class Ppl::Adapter::Vcard::Vpim
     vcard.urls.each { |url| contact.urls.push(url.uri) }
   end
 
+  def decode_nicknames(vcard, contact)
+    # There appears to be a minor vpim bug here: vpim allows us to save an array
+    # of nicknames but sees it as one big single nickname when decoding. This
+    # code is here to work around that issue by "finishing the job".
+    nicknames = vcard.nicknames.first
+    if !nicknames.nil?
+      nicknames.split(";").each{ |nickname| contact.nicknames.push(nickname) }
+    end
+  end
+
 end
 

data/lib/ppl/application/bootstrap.rb

@@ -13,6 +13,7 @@ class Ppl::Application::Bootstrap
       Ppl::Command::Mv.new,
       Ppl::Command::Show.new,
       Ppl::Command::Name.new,
+      Ppl::Command::Nick.new,
       Ppl::Command::Email.new,
       Ppl::Command::Org.new,
       Ppl::Command::Phone.new,

data/lib/ppl/command/nick.rb

@@ -0,0 +1,21 @@
+
+class Ppl::Command::Nick < Ppl::Command::Attribute
+
+  name        "nick"
+  description "List, show or change nicknames"
+
+  def initialize
+    @attribute   = :nicknames
+    @show_format = Ppl::Format::Contact::Nicknames.new
+    @list_format = Ppl::Format::AddressBook::Nicknames.new
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: ppl nick <contact> [<nickname>]"
+    parser.on("-d", "--delete", "delete nickname") do
+      options[:delete] = true
+    end
+  end
+
+end
+

data/lib/ppl/entity/contact.rb

@@ -3,6 +3,7 @@ class Ppl::Entity::Contact
 
   attr_accessor :id
   attr_accessor :name
+  attr_accessor :nicknames
   attr_accessor :email_addresses
   attr_accessor :birthday
   attr_accessor :phone_numbers
@@ -12,6 +13,7 @@ class Ppl::Entity::Contact
 
   def initialize
     @email_addresses = []
+    @nicknames = []
     @organizations = []
     @phone_numbers = []
     @urls = []

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

@@ -16,15 +16,12 @@ class Ppl::Format::AddressBook::Birthdays < Ppl::Format::AddressBook
   private
 
   def add_row(contact)
-    id       = sprintf("%s:", contact.id)
     birthday = nil
-
     if !contact.birthday.nil?
       birthday = contact.birthday.strftime("%Y-%m-%d")
     end
-
     @table.add_row({
-      :id       => id,
+      :id       => sprintf("%s:", contact.id),
       :birthday => birthday,
     })
   end

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

@@ -4,7 +4,7 @@ class Ppl::Format::AddressBook::EmailAddresses < Ppl::Format::AddressBook
   attr_writer :table
 
   def initialize
-    @table = Ppl::Format::Table.new([:id, :email_addresses])
+    @table = Ppl::Format::Table.new([:contact_id, :email_addresses])
   end
 
   def process(address_book)
@@ -16,16 +16,9 @@ class Ppl::Format::AddressBook::EmailAddresses < Ppl::Format::AddressBook
   private
 
   def add_row(contact)
-    id = sprintf("%s:", contact.id)
-    email_addresses = nil
-
-    if !contact.email_addresses.empty?
-      email_addresses = contact.email_addresses.join(", ")
-    end
-
     @table.add_row({
-      :id            => id,
-      :email_addresses => email_addresses,
+      :contact_id      => sprintf("%s:", contact.id),
+      :email_addresses => contact.email_addresses.join(", "),
     })
   end
 

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

@@ -0,0 +1,27 @@
+
+class Ppl::Format::AddressBook::Nicknames < Ppl::Format::AddressBook
+
+  attr_writer :table
+
+  def initialize
+    @table = Ppl::Format::Table.new([:id, :nicknames])
+  end
+
+  def process(address_book)
+    address_book.contacts.each { |contact| add_row(contact) }
+    @table.to_s
+  end
+
+
+  private
+
+  def add_row(contact)
+    @table.add_row({
+      :id        => sprintf("%s:", contact.id),
+      :nicknames => contact.nicknames.join(", "),
+    })
+  end
+
+
+end
+

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

@@ -16,16 +16,9 @@ class Ppl::Format::AddressBook::Urls < Ppl::Format::AddressBook
   private
 
   def add_row(contact)
-    id   = sprintf("%s:", contact.id)
-    urls = nil
-
-    if !contact.urls.empty?
-      urls = contact.urls.join(", ")
-    end
-
     @table.add_row({
-      :id   => id,
-      :urls => urls,
+      :id   => sprintf("%s:", contact.id),
+      :urls => contact.urls.join(", "),
     })
   end
 

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

@@ -0,0 +1,9 @@
+
+class Ppl::Format::Contact::Nicknames < Ppl::Format::Contact
+
+  def process(contact)
+    contact.nicknames.join("\n")
+  end
+
+end
+

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.10.0"
+  Version = "1.11.0"
 
   module Adapter
   end
@@ -50,6 +50,7 @@ require "ppl/command/help"
 require "ppl/command/show"
 require "ppl/command/mv"
 require "ppl/command/name"
+require "ppl/command/nick"
 require "ppl/command/email"
 require "ppl/command/org"
 require "ppl/command/phone"
@@ -72,6 +73,7 @@ require "ppl/format/address_book/email_addresses"
 require "ppl/format/address_book/mutt_query"
 require "ppl/format/address_book/names"
 require "ppl/format/address_book/one_line"
+require "ppl/format/address_book/nicknames"
 require "ppl/format/address_book/organizations"
 require "ppl/format/address_book/phone_numbers"
 require "ppl/format/address_book/postal_addresses"
@@ -81,6 +83,7 @@ require "ppl/format/contact/birthday"
 require "ppl/format/contact/email_addresses"
 require "ppl/format/contact/full"
 require "ppl/format/contact/name"
+require "ppl/format/contact/nicknames"
 require "ppl/format/contact/organization"
 require "ppl/format/contact/phone_number"
 require "ppl/format/contact/postal_address"

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.10.0"
-  spec.date        = "2013-01-10"
+  spec.version     = "1.11.0"
+  spec.date        = "2013-01-20"
 
   spec.required_ruby_version = ">= 1.9.3"
 

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

@@ -73,6 +73,11 @@ describe Ppl::Adapter::Vcard::Vpim, "#encode" do
     @adapter.encode(@contact).should include("URL:http://google.com")
   end
 
+  it "should encode the contact's nickname" do
+    @contact.nicknames.push "Sleepy"
+    @adapter.encode(@contact).should include("NICKNAME:Sleepy")
+  end
+
 end
 
 
@@ -237,5 +242,17 @@ describe Ppl::Adapter::Vcard::Vpim, "#decode" do
     contact.urls.first.should eq "http://google.com"
   end
 
+  it "should decode the contact's nickame" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "NICKNAME:Happy;Cheerful",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    contact.nicknames.first.should eq "Happy"
+  end
+
 end
 

data/spec/ppl/application/bootstrap_spec.rb

@@ -57,6 +57,9 @@ describe Ppl::Application::Bootstrap do
     it "should contain the 'name' command" do
       @bootstrap.command_suite.find_command("name").should_not be nil
     end
+    it "should contain the 'nick' command" do
+      @bootstrap.command_suite.find_command("nick").should_not be nil
+    end
     it "should contain the 'org' command" do
       @bootstrap.command_suite.find_command("org").should_not be nil
     end

data/spec/ppl/command/nick_spec.rb

@@ -0,0 +1,15 @@
+
+describe Ppl::Command::Nick do
+
+  before(:each) do
+    @command = Ppl::Command::Nick.new
+  end
+
+  describe "#name" do
+    it "should be 'nick'" do
+      @command.name.should eq "nick"
+    end
+  end
+
+end
+

data/spec/ppl/entity/contact_spec.rb

@@ -52,6 +52,12 @@ describe Ppl::Entity::Contact do
     end
   end
 
+  describe "#nicknames" do
+    it "should return an array" do
+      @contact.nicknames.should be_a(Array)
+    end
+  end
+
   describe "#organizations" do
     it "should return an array" do
       @contact.organizations.should be_a(Array)

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

@@ -17,8 +17,8 @@ describe Ppl::Format::AddressBook::EmailAddresses do
 
     it "should at least show the contact's id" do
       @table.should_receive(:add_row).with({
-        :id              => "test:",
-        :email_addresses => nil,
+        :contact_id      => "test:",
+        :email_addresses => "",
       })
       @format.process(@address_book)
     end
@@ -26,7 +26,7 @@ describe Ppl::Format::AddressBook::EmailAddresses do
     it "should show an email address if it's available" do
       @contact.email_addresses.push "jdoe@example.org"
       @table.should_receive(:add_row).with({
-        :id              => "test:",
+        :contact_id      => "test:",
         :email_addresses => "jdoe@example.org",
       })
       @format.process(@address_book)

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

@@ -0,0 +1,38 @@
+
+describe Ppl::Format::AddressBook::Nicknames do
+
+  before(:each) do
+    @format       = Ppl::Format::AddressBook::Nicknames.new
+    @address_book = Ppl::Entity::AddressBook.new
+    @contact      = Ppl::Entity::Contact.new
+    @table        = double(Ppl::Format::Table)
+
+    @contact.id = "test"
+    @format.table = @table
+
+    @address_book.contacts.push(@contact)
+  end
+
+  describe "#process" do
+
+    it "should at least show the contact's id" do
+      @table.should_receive(:add_row).with({
+        :id        => "test:",
+        :nicknames => "",
+      })
+      @format.process(@address_book)
+    end
+
+    it "should show a nickname if it's available" do
+      @contact.nicknames.push("Stupid")
+      @table.should_receive(:add_row).with({
+        :id        => "test:",
+        :nicknames => "Stupid",
+      })
+      @format.process(@address_book)
+    end
+
+  end
+
+end
+

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

@@ -18,7 +18,7 @@ describe Ppl::Format::AddressBook::Urls do
     it "should at least show the contact's id" do
       @table.should_receive(:add_row).with({
         :id   => "test:",
-        :urls => nil,
+        :urls => "",
       })
       @format.process(@address_book)
     end

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

@@ -0,0 +1,23 @@
+
+describe Ppl::Format::Contact::Nicknames do
+
+  before(:each) do
+    @format  = Ppl::Format::Contact::Nicknames.new
+    @contact = Ppl::Entity::Contact.new
+  end
+
+  describe "#process" do
+
+    it "should return an empty string if the contact lacks a nickname" do
+      @format.process(Ppl::Entity::Contact.new).should eq ""
+    end
+
+    it "should return the contact's nickname if one is set" do
+      @contact.nicknames.push("Dopey")
+      @format.process(@contact).should eq "Dopey"
+    end
+
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
-  requirement: &3232880 !ruby/object:Gem::Requirement
+  requirement: &12830980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *3232880
+  version_requirements: *12830980
 - !ruby/object:Gem::Dependency
   name: rugged
-  requirement: &3230760 !ruby/object:Gem::Requirement
+  requirement: &12830520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.17.0.b6
   type: :runtime
   prerelease: false
-  version_requirements: *3230760
+  version_requirements: *12830520
 - !ruby/object:Gem::Dependency
   name: vpim
-  requirement: &3228280 !ruby/object:Gem::Requirement
+  requirement: &12830060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,7 +43,7 @@ dependencies:
         version: '0.695'
   type: :runtime
   prerelease: false
-  version_requirements: *3228280
+  version_requirements: *12830060
 description: CLI Address Book
 email: henry@henrysmith.org
 executables:
@@ -84,6 +84,7 @@ files:
 - lib/ppl/command/mutt.rb
 - lib/ppl/command/mv.rb
 - lib/ppl/command/name.rb
+- lib/ppl/command/nick.rb
 - lib/ppl/command/org.rb
 - lib/ppl/command/phone.rb
 - lib/ppl/command/post.rb
@@ -102,6 +103,7 @@ files:
 - lib/ppl/format/address_book/email_addresses.rb
 - lib/ppl/format/address_book/mutt_query.rb
 - lib/ppl/format/address_book/names.rb
+- lib/ppl/format/address_book/nicknames.rb
 - lib/ppl/format/address_book/one_line.rb
 - lib/ppl/format/address_book/organizations.rb
 - lib/ppl/format/address_book/phone_numbers.rb
@@ -112,6 +114,7 @@ files:
 - lib/ppl/format/contact/email_addresses.rb
 - lib/ppl/format/contact/full.rb
 - lib/ppl/format/contact/name.rb
+- lib/ppl/format/contact/nicknames.rb
 - lib/ppl/format/contact/organization.rb
 - lib/ppl/format/contact/phone_number.rb
 - lib/ppl/format/contact/postal_address.rb
@@ -144,6 +147,7 @@ files:
 - spec/ppl/command/mutt_spec.rb
 - spec/ppl/command/mv_spec.rb
 - spec/ppl/command/name_spec.rb
+- spec/ppl/command/nick_spec.rb
 - spec/ppl/command/org_spec.rb
 - spec/ppl/command/phone_spec.rb
 - spec/ppl/command/post_spec.rb
@@ -159,6 +163,7 @@ files:
 - spec/ppl/format/address_book/email_addresses_spec.rb
 - spec/ppl/format/address_book/mutt_query_spec.rb
 - spec/ppl/format/address_book/names_spec.rb
+- spec/ppl/format/address_book/nicknames_spec.rb
 - spec/ppl/format/address_book/one_line_spec.rb
 - spec/ppl/format/address_book/organizations_spec.rb
 - spec/ppl/format/address_book/phone_numbers_spec.rb
@@ -169,6 +174,7 @@ files:
 - spec/ppl/format/contact/email_addresses_spec.rb
 - spec/ppl/format/contact/full_spec.rb
 - spec/ppl/format/contact/name_spec.rb
+- spec/ppl/format/contact/nicknames_spec.rb
 - spec/ppl/format/contact/organization_spec.rb
 - spec/ppl/format/contact/phone_number_spec.rb
 - spec/ppl/format/contact/postal_address_spec.rb