ppl 1.7.0 → 1.8.0

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.7.0"
+  Version = "1.8.0"
 
   module Adapter
   end
@@ -55,6 +55,7 @@ require "ppl/command/phone"
 require "ppl/command/mutt"
 require "ppl/command/post"
 require "ppl/command/shell"
+require "ppl/command/url"
 
 require "ppl/entity/address_book"
 require "ppl/entity/contact"
@@ -72,6 +73,7 @@ require "ppl/format/address_book/one_line"
 require "ppl/format/address_book/organizations"
 require "ppl/format/address_book/phone_numbers"
 require "ppl/format/address_book/postal_addresses"
+require "ppl/format/address_book/urls"
 require "ppl/format/contact"
 require "ppl/format/contact/birthday"
 require "ppl/format/contact/email_addresses"
@@ -80,6 +82,7 @@ require "ppl/format/contact/name"
 require "ppl/format/contact/organization"
 require "ppl/format/contact/phone_number"
 require "ppl/format/contact/postal_address"
+require "ppl/format/contact/urls"
 require "ppl/format/postal_address"
 require "ppl/format/postal_address/one_line"
 require "ppl/format/table"

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

@@ -20,6 +20,7 @@ class Ppl::Adapter::Vcard::Vpim
       encode_phone_number(contact, maker)
       encode_organization(contact, maker)
       encode_postal_address(contact, maker)
+      encode_urls(contact, maker)
     end
     vcard.to_s
   end
@@ -33,6 +34,7 @@ class Ppl::Adapter::Vcard::Vpim
     decode_postal_address(vcard, contact)
     decode_organization(vcard, contact)
     decode_name(vcard, contact)
+    decode_urls(vcard, contact)
     return contact
   end
 
@@ -83,6 +85,10 @@ class Ppl::Adapter::Vcard::Vpim
     end
   end
 
+  def encode_urls(contact, vcard_maker)
+    contact.urls.each { |url| vcard_maker.add_url(url) }
+  end
+
   def decode_birthday(vcard, contact)
     contact.birthday = vcard.birthday unless vcard.birthday.nil?
   end
@@ -122,5 +128,9 @@ class Ppl::Adapter::Vcard::Vpim
     end
   end
 
+  def decode_urls(vcard, contact)
+    vcard.urls.each { |url| contact.urls.push(url.uri) }
+  end
+
 end
 

data/lib/ppl/application/bootstrap.rb

@@ -18,6 +18,7 @@ class Ppl::Application::Bootstrap
       Ppl::Command::Phone.new,
       Ppl::Command::Post.new,
       Ppl::Command::Shell.new,
+      Ppl::Command::Url.new,
     ]
     commands.each do |command|
       command.storage = storage_adapter

data/lib/ppl/command/url.rb

@@ -0,0 +1,82 @@
+
+class Ppl::Command::Url < Ppl::Application::Command
+
+  name        "url"
+  description "List, show or change URLs"
+
+  attr_writer :show_format
+  attr_writer :list_format
+
+  def initialize
+    @show_format = Ppl::Format::Contact::Urls.new
+    @list_format = Ppl::Format::AddressBook::Urls.new
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: ppl url <contact> [<url>]"
+    parser.on("-d", "--delete", "delete url") do
+      options[:delete] = true
+    end
+  end
+
+  def execute(input, output)
+    action = determine_action(input)
+    send(action, input, output)
+  end
+
+
+  private
+
+  def determine_action(input)
+    if input.arguments[0].nil?
+      :list_urls
+    elsif input.arguments[1].nil?
+      :show_urls
+    elsif input.options[:delete]
+      :delete_url
+    else
+      :set_url
+    end
+  end
+
+  def list_urls(input, output)
+    address_book = @storage.load_address_book
+    url_list     = @list_format.process(address_book)
+    output.line(url_list)
+  end
+
+  def show_urls(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    urls    = @show_format.process(contact)
+    if urls != ""
+      output.line(urls)
+      true
+    else
+      false
+    end
+  end
+
+  def delete_url(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    old_url = input.arguments[1].dup
+    contact.urls.delete(old_url) do
+      message = sprintf("%s has no such url %s", contact.id, old_url)
+      raise Ppl::Error::IncorrectUsage, message
+    end
+    @storage.save_contact(contact)
+  end
+
+  def set_url(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    new_url = input.arguments[1].dup
+    if contact.urls.include?(new_url)
+      message = sprintf("%s already has url %s", contact.id, new_url)
+      raise Ppl::Error::IncorrectUsage, message
+    else
+      contact.urls.push(new_url)
+    end
+    @storage.save_contact(contact)
+  end
+
+end
+

data/lib/ppl/entity/contact.rb

@@ -8,9 +8,11 @@ class Ppl::Entity::Contact
   attr_accessor :phone_number
   attr_accessor :organization
   attr_accessor :postal_address
+  attr_accessor :urls
 
   def initialize
     @email_addresses = []
+    @urls = []
   end
 
   def set_postal_address

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

@@ -0,0 +1,34 @@
+
+class Ppl::Format::AddressBook::Urls < Ppl::Format::AddressBook
+
+  attr_writer :table
+
+  def initialize
+    @table = Ppl::Format::Table.new([:id, :urls])
+  end
+
+  def process(address_book)
+    address_book.each { |contact| add_row(contact) }
+    @table.to_s
+  end
+
+
+  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,
+    })
+  end
+
+
+end
+

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

@@ -24,6 +24,7 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
     format_email_addresses(contact)
     format_phone_numbers(contact)
     format_postal_addresses(contact)
+    format_urls(contact)
 
     return @lines.join("\n")
   end
@@ -80,5 +81,13 @@ class Ppl::Format::Contact::Full < Ppl::Format::Contact
     end
   end
 
+  def format_urls(contact)
+    if !contact.urls.empty?
+      @lines.push("")
+      @lines.push("URLs:")
+      contact.urls.each { |url| @lines.push("  " + url) }
+    end
+  end
+
 end
 

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

@@ -0,0 +1,13 @@
+
+class Ppl::Format::Contact::Urls < Ppl::Format::Contact
+
+  def process(contact)
+    lines = []
+    contact.urls.each do |url|
+      lines.push url
+    end
+    lines.join("\n")
+  end
+
+end
+

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.7.0"
-  spec.date        = "2012-12-29"
+  spec.version     = "1.8.0"
+  spec.date        = "2013-01-05"
 
   spec.required_ruby_version = ">= 1.9.3"
 

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

@@ -68,6 +68,11 @@ describe Ppl::Adapter::Vcard::Vpim, "#encode" do
     @adapter.encode(@contact).should include("ADR:;;;;South West;;")
   end
 
+  it "should encode the contact's URL" do
+    @contact.urls.push "http://google.com"
+    @adapter.encode(@contact).should include("URL:http://google.com")
+  end
+
 end
 
 
@@ -220,5 +225,17 @@ describe Ppl::Adapter::Vcard::Vpim, "#decode" do
     contact.postal_address.country.should eq "UK"
   end
 
+  it "should decode the contact's URL" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "URL:http://google.com",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    contact.urls.first.should eq "http://google.com"
+  end
+
 end
 

data/spec/ppl/application/bootstrap_spec.rb

@@ -78,6 +78,9 @@ describe Ppl::Application::Bootstrap do
     it "should contain the 'shell' command" do
       @bootstrap.command_suite.find_command("shell").should_not be nil
     end
+    it "should contain the 'url' command" do
+      @bootstrap.command_suite.find_command("url").should_not be nil
+    end
   end
 
   describe "#configuration" do

data/spec/ppl/command/url_spec.rb

@@ -0,0 +1,91 @@
+
+describe Ppl::Command::Url do
+
+  before(:each) do
+    @command = Ppl::Command::Url.new
+    @input   = Ppl::Application::Input.new
+    @output  = Ppl::Application::Output.new(nil, nil)
+    @contact = Ppl::Entity::Contact.new
+    @storage = double(Ppl::Adapter::Storage)
+
+    @list_format = double(Ppl::Format::Contact)
+    @show_format = double(Ppl::Format::Contact)
+
+    @command.storage     = @storage
+    @command.show_format = @show_format
+    @command.list_format = @list_format
+    @contact.id = "jim"
+  end
+
+  describe "#name" do
+    it "should be 'url'" do
+      @command.name.should eq "url"
+    end
+  end
+
+  describe "#execute" do
+
+    it "should list all URLs 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 URLs")
+      @output.should_receive(:line).with("all the URLs")
+      @input.arguments = []
+      @command.execute(@input, @output)
+    end
+
+    it "should show the current URLs if no new URL is given" do
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @show_format.should_receive(:process).and_return("http://example.org/~jdoe")
+      @output.should_receive(:line).with("http://example.org/~jdoe")
+      @input.arguments = ["jim"]
+      @command.execute(@input, @output).should eq true
+    end
+
+    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
+    end
+
+    it "should delete the given URL from the contact if requested" do
+      @contact.urls.push("http://example.org/~jdoe")
+      @contact.urls.push("http://example.com/~jdoe")
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @storage.should_receive(:save_contact) do |contact|
+        contact.urls.should eq ["http://example.com/~jdoe"]
+      end
+      @input.arguments = ["jim", "http://example.org/~jdoe"]
+      @input.options   = { :delete => true }
+      @command.execute(@input, @output)
+    end
+
+    it "should raise an error when deleting a non-existent URL" do
+      @contact.urls.push("http://example.org/~jdoe")
+      @contact.urls.push("http://example.com/~jdoe")
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @input.arguments = ["jim", "http://example.net/~jdoe"]
+      @input.options   = { :delete => true }
+      expect{@command.execute(@input, nil)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+    it "should add the given URL to the contact if it's new" do
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @storage.should_receive(:save_contact) do |contact|
+        contact.urls.first.should eq "http://example.org/~jdoe"
+      end
+      @input.arguments = ["jim", "http://example.org/~jdoe"]
+      @command.execute(@input, @output)
+    end
+
+    it "should raise an error if the user is adding a duplicate address" do
+      @contact.urls.push "http://example.org/~jdoe"
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @input.arguments = ["jim", "http://example.org/~jdoe"]
+      expect{@command.execute(@input, nil)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+  end
+
+end
+

data/spec/ppl/entity/contact_spec.rb

@@ -46,5 +46,11 @@ describe Ppl::Entity::Contact do
     end
   end
 
+  describe "#urls" do
+    it "should return an array" do
+      @contact.urls.should be_a(Array)
+    end
+  end
+
 end
 

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

@@ -0,0 +1,38 @@
+
+describe Ppl::Format::AddressBook::Urls do
+
+  before(:each) do
+    @format       = Ppl::Format::AddressBook::Urls.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.add_contact(@contact)
+  end
+
+  describe "#process" do
+
+    it "should at least show the contact's id" do
+      @table.should_receive(:add_row).with({
+        :id   => "test:",
+        :urls => nil,
+      })
+      @format.process(@address_book)
+    end
+
+    it "should show a URL if it's available" do
+      @contact.urls.push "http://example.org/~jdoe"
+      @table.should_receive(:add_row).with({
+        :id   => "test:",
+        :urls => "http://example.org/~jdoe",
+      })
+      @format.process(@address_book)
+    end
+
+  end
+
+end
+

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

@@ -57,6 +57,11 @@ describe Ppl::Format::Contact::Full do
       @format.process(@contact)
     end
 
+    it "should show all their URLs" do
+      @contact.urls.push "http://example.org"
+      @format.process(@contact).should include "http://example.org"
+    end
+
   end
 
 end

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

@@ -0,0 +1,23 @@
+
+describe Ppl::Format::Contact::Urls do
+
+  before(:each) do
+    @format  = Ppl::Format::Contact::Urls.new
+    @contact = Ppl::Entity::Contact.new
+  end
+
+  describe "#process" do
+
+    it "should return an empty string if the contact lacks a URL" do
+      @format.process(Ppl::Entity::Contact.new).should eq ""
+    end
+
+    it "should return the contact's URL if one is set" do
+      @contact.urls.push "http://example.org/~jdoe"
+      @format.process(@contact).should eq "http://example.org/~jdoe"
+    end
+
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-29 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
-  requirement: &7003600 !ruby/object:Gem::Requirement
+  requirement: &20369960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *7003600
+  version_requirements: *20369960
 - !ruby/object:Gem::Dependency
   name: rugged
-  requirement: &7002340 !ruby/object:Gem::Requirement
+  requirement: &20352640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.17.0.b6
   type: :runtime
   prerelease: false
-  version_requirements: *7002340
+  version_requirements: *20352640
 - !ruby/object:Gem::Dependency
   name: vpim
-  requirement: &7001560 !ruby/object:Gem::Requirement
+  requirement: &20351880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,7 +43,7 @@ dependencies:
         version: '0.695'
   type: :runtime
   prerelease: false
-  version_requirements: *7001560
+  version_requirements: *20351880
 description: CLI Address Book
 email: henry@henrysmith.org
 executables:
@@ -89,6 +89,7 @@ files:
 - lib/ppl/command/rm.rb
 - lib/ppl/command/shell.rb
 - lib/ppl/command/show.rb
+- lib/ppl/command/url.rb
 - lib/ppl/entity/address_book.rb
 - lib/ppl/entity/contact.rb
 - lib/ppl/entity/postal_address.rb
@@ -103,6 +104,7 @@ files:
 - lib/ppl/format/address_book/organizations.rb
 - lib/ppl/format/address_book/phone_numbers.rb
 - lib/ppl/format/address_book/postal_addresses.rb
+- lib/ppl/format/address_book/urls.rb
 - lib/ppl/format/contact.rb
 - lib/ppl/format/contact/birthday.rb
 - lib/ppl/format/contact/email_addresses.rb
@@ -111,6 +113,7 @@ 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/urls.rb
 - lib/ppl/format/postal_address.rb
 - lib/ppl/format/postal_address/one_line.rb
 - lib/ppl/format/table.rb
@@ -144,6 +147,7 @@ files:
 - spec/ppl/command/rm_spec.rb
 - spec/ppl/command/shell_spec.rb
 - spec/ppl/command/show_spec.rb
+- spec/ppl/command/url_spec.rb
 - spec/ppl/entity/address_book_spec.rb
 - spec/ppl/entity/contact_spec.rb
 - spec/ppl/entity/postal_address_spec.rb
@@ -155,6 +159,7 @@ files:
 - spec/ppl/format/address_book/organizations_spec.rb
 - spec/ppl/format/address_book/phone_numbers_spec.rb
 - spec/ppl/format/address_book/postal_addresses_spec.rb
+- spec/ppl/format/address_book/urls_spec.rb
 - spec/ppl/format/address_book_spec.rb
 - spec/ppl/format/contact/birthday_spec.rb
 - spec/ppl/format/contact/email_addresses_spec.rb
@@ -163,6 +168,7 @@ 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/urls_spec.rb
 - spec/ppl/format/contact_spec.rb
 - spec/ppl/format/postal_address/one_line_spec.rb
 - spec/ppl/format/postal_address_spec.rb