ppl 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f33a5e4b27cd115dbac2ce3532e4fc81e93635e
-  data.tar.gz: 1eef11f3f8784fa687c211b9343fe45e914c2cb2
+  metadata.gz: 3438ed54b9c4ab282ccc9a9389511777516fee7a
+  data.tar.gz: 63d86817042ebf3a768294d394bfc3c77ff60a01
 SHA512:
-  metadata.gz: 19c1da0a40163b4e3b37f9ae01ef70b590b312b2dc381cdb5ba35f776261f85fda799736c0e5d0694a4f7d67e3a85f232f7ab961b95f8a2e15fd3f1f72e1ffe1
-  data.tar.gz: 4798e2a97cdb5daf366d821e8b736d187798ef238a00329aae88d66149379cfad1207d98c8bf4f432099e4756617802c61a307458518876340dfbc386ace4973
+  metadata.gz: c789b838676b6d9cd50f0bcd6c0060fdd87287ed3f0dd6088c11ba5a9cd995e0306eb488bc40e2f81fe9c3c7ad91a5206f6cc586cae9f93c09d21f783ff1fec6
+  data.tar.gz: f48891ad62cc516d9a69a73ccfe84080b086017d8d307683e4934563786d18163f7e2b5c93ee17b2fbefae67c5485598cefbf8846fb001a5756b9f594da22f55

data/completions/bash

@@ -211,7 +211,7 @@ __ppl_commands()
 
 __ppl_contact_ids()
 {
-  ppl nick --no-color | cut -d ':' -f 1
+  ppl ls --format "%i"
 }
 
 __ppl_contact_email_addresses()

data/lib/ppl/application/bootstrap.rb

@@ -41,6 +41,7 @@ class Ppl::Application::Bootstrap
     email.storage = storage_adapter
     email.list_format = format_address_book_email_addresses
     email.show_format = format_contact_email_addresses
+    email.custom_format = format_email_address_custom
     email
   end
 
@@ -59,7 +60,8 @@ class Ppl::Application::Bootstrap
   register :command_ls do
     ls = Ppl::Command::Ls.new
     ls.storage = storage_adapter
-    ls.format = format_address_book_one_line
+    ls.default_format = format_address_book_one_line
+    ls.custom_format = format_contact_custom
     ls
   end
 
@@ -278,6 +280,18 @@ class Ppl::Application::Bootstrap
     Ppl::Format::Contact::Birthday.new(colors)
   end
 
+  register :format_contact_custom do
+    custom = Ppl::Format::Custom::Contact.new
+    custom.preset_formats = configuration.pretty
+    custom
+  end
+
+  register :format_email_address_custom do
+    custom = Ppl::Format::Custom::EmailAddress.new
+    custom.preset_formats = configuration.pretty
+    custom
+  end
+
   register :format_contact_email_addresses do
     colors = configuration.command_colors("email")
     Ppl::Format::Contact::EmailAddresses.new(colors)

data/lib/ppl/application/configuration.rb

@@ -44,6 +44,10 @@ class Ppl::Application::Configuration
     result = config[search]
   end
 
+  def pretty
+    user_configuration["pretty"]
+  end
+
   private
 
   def default_configuration

data/lib/ppl/command/email.rb

@@ -7,6 +7,7 @@ class Ppl::Command::Email < Ppl::Application::Command
   attr_writer :email_service
   attr_writer :list_format
   attr_writer :show_format
+  attr_writer :custom_format
 
   def options(parser, options)
     parser.banner = "usage: ppl email <contact> [<email-address>]"
@@ -19,6 +20,9 @@ class Ppl::Command::Email < Ppl::Application::Command
     parser.on("-P", "--not-preferred", "mark address as not preferred") do
       options[:preferred] = false
     end
+    parser.on("--format <format>", "specify a custom output format") do |f|
+      options[:format] = f
+    end
   end
 
   def execute(input, output)
@@ -48,7 +52,7 @@ class Ppl::Command::Email < Ppl::Application::Command
 
   def show_contact_email_addresses(input, output)
     contact = @storage.require_contact(input.arguments[0])
-    output.line(@show_format.process(contact))
+    output.line(format_contact(contact, input.options))
   end
 
   def remove_email_address_from_contact(input, output)
@@ -69,5 +73,14 @@ class Ppl::Command::Email < Ppl::Application::Command
     (contact.email_addresses.select { |ea| ea.address == email_address }).empty?
   end
 
+  def format_contact(contact, options)
+    if options[:format].nil?
+      @show_format.process(contact)
+    else
+      @custom_format.format = options[:format]
+      contact.email_addresses.map { |e| @custom_format.process(e) }.join("\n")
+    end
+  end
+
 end
 

data/lib/ppl/command/ls.rb

@@ -4,17 +4,47 @@ class Ppl::Command::Ls < Ppl::Application::Command
   name        "ls"
   description "List all contacts"
 
-  attr_writer :format
+  attr_writer :default_format
+  attr_writer :custom_format
 
   def options(parser, options)
     parser.banner = "usage: ppl ls"
+    parser.on("--format <format>", "specify a custom output format") do |format|
+      options[:format] = format
+    end
+    parser.on("--pretty <format>", "specify a custom output format") do |pretty|
+      options[:pretty] = pretty
+    end
   end
 
   def execute(input, output)
     address_book = @storage.load_address_book
-    formatted    = @format.process(address_book)
+    formatted    = format_address_book(address_book, input.options)
     output.line(formatted)
-    return true
+    true
+  end
+
+  private
+
+  def format_address_book(address_book, options)
+    if custom_formatting? options
+      use_custom_format(address_book, options)
+    else
+      @default_format.process(address_book)
+    end
+  end
+
+  def custom_formatting?(options)
+    options[:pretty] || options[:format]
+  end
+
+  def use_custom_format(address_book, options)
+    if !options[:pretty].nil?
+      @custom_format.use_preset options[:pretty]
+    elsif !options[:format].nil?
+      @custom_format.format = options[:format]
+    end
+    address_book.contacts.map { |c| @custom_format.process(c) }.join("\n")
   end
 
 end

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

@@ -0,0 +1,55 @@
+
+class Ppl::Format::Custom::Contact < Ppl::Format::Custom
+
+  format :n do |anything|
+    "\n"
+  end
+
+  format :i do |contact|
+    contact.id
+  end
+
+  format :N do |contact|
+    contact.name
+  end
+
+  format :a do |contact|
+    contact.age(Date.today)
+  end
+
+  format :b do |contact|
+    unless contact.birthday.nil?
+      contact.birthday.strftime("%Y-%m-%d")
+    end
+  end
+
+  format :k do |contact|
+    contact.nicknames.first
+  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
+    end
+  end
+
+  format :o do |contact|
+    contact.organizations.first
+  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
+    end
+  end
+
+end
+

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

@@ -0,0 +1,15 @@
+
+class Ppl::Format::Custom::EmailAddress < Ppl::Format::Custom
+
+  format :a do |email_adddress|
+    email_adddress.address
+  end
+
+  format :f do |email_adddress|
+    if email_adddress.preferred
+      "*"
+    end
+  end
+
+end
+

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

@@ -0,0 +1,19 @@
+
+class Ppl::Format::Custom::PhoneNumber < Ppl::Format::Custom
+
+  format :n do |phone_number|
+    phone_number.number
+  end
+
+  format :t do |phone_number|
+    phone_number.type
+  end
+
+  format :f do |phone_number|
+    if phone_number.preferred
+      "*"
+    end
+  end
+
+end
+

data/lib/ppl/format/custom.rb

@@ -0,0 +1,61 @@
+
+class Ppl::Format::Custom
+
+  attr_accessor :format
+  attr_accessor :preset_formats
+
+  def self.format(symbol, &block)
+    @format_blocks ||= {}
+    @format_blocks[symbol] = block
+  end
+
+  def self.process(key, object)
+    if @format_blocks[key]
+      @format_blocks[key][object]
+    else
+      key
+    end
+  end
+
+  def initialize(format = nil)
+    @format = format
+  end
+
+  def process(object)
+    @object = object
+    string_pieces = @format.scan(/[^%]+|%-?\d*./)
+    string_pieces.map(&method(:process_piece)).join
+  end
+
+  def use_preset(format_name)
+    @format = @preset_formats[format_name]
+  end
+
+  private
+
+  def process_piece(string)
+    matches = string.scan(/^%(-?\d+)?([a-z])$/i)
+    if !matches.empty?
+      output = generate_output(matches[0][1].to_sym)
+      pad_output(output, matches[0][0].to_i)
+    else
+      string
+    end
+  end
+
+  def generate_output(symbol)
+    self.class.process(symbol, @object)
+  end
+
+  def pad_output(output, padding)
+    if padding > 0
+      output.to_s.rjust(padding, " ")
+    elsif padding < 0
+      output.to_s.ljust(padding.abs, " ")
+    else
+      output
+    end
+  end
+
+end
+

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.24.0"
+  Version = "1.25.0"
 
   module Adapter
   end
@@ -104,6 +104,10 @@ 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/custom"
+require "ppl/format/custom/contact"
+require "ppl/format/custom/email_address"
+require "ppl/format/custom/phone_number"
 require "ppl/format/postal_address"
 require "ppl/format/postal_address/one_line"
 require "ppl/format/table"

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.24.0"
-  spec.date        = "2013-04-23"
+  spec.version     = "1.25.0"
+  spec.date        = "2013-04-24"
 
   spec.required_ruby_version = ">= 1.9.3"
 

data/spec/ppl/command/email_spec.rb

@@ -21,12 +21,14 @@ describe Ppl::Command::Email do
       @output = double(Ppl::Application::Output)
       @list_format = double(Ppl::Format::AddressBook)
       @show_format = double(Ppl::Format::Contact)
+      @custom_format = double(Ppl::Format::Custom)
       @storage.stub(:require_contact).and_return(@contact)
       @storage.stub(:save_contact)
       @command.storage = @storage
       @command.email_service = @service
       @command.list_format = @list_format
       @command.show_format = @show_format
+      @command.custom_format = @custom_format
     end
 
     it "should list all email addresses by default" do
@@ -43,6 +45,17 @@ describe Ppl::Command::Email do
       @output.should_receive(:line).with("imagine this is a list")
       @command.execute(@input, @output)
     end
+
+    it "should output addresses in a custom format if one is given" do
+      @input.arguments << "jdoe"
+      @input.options[:format] = "%e"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("jdoe@example.org")
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @custom_format.should_receive(:format=).with("%e")
+      @custom_format.should_receive(:process).and_return("")
+      @output.should_receive(:line).with("")
+      @command.execute(@input, @output)
+    end
     
     it "should delegate to the service layer to add a new email address" do
       @input.arguments = ["jdoe", "jdoe@example.org"]

data/spec/ppl/command/ls_spec.rb

@@ -7,10 +7,12 @@ describe Ppl::Command::Ls do
     @output  = double(Ppl::Application::Output)
     @storage = double(Ppl::Adapter::Storage)
     @format  = double(Ppl::Format::AddressBook)
+    @custom  = double(Ppl::Format::Custom)
     @address_book = double(Ppl::Entity::AddressBook)
 
-    @command.format   = @format
-    @command.storage  = @storage
+    @command.custom_format  = @custom
+    @command.default_format = @format
+    @command.storage        = @storage
   end
 
   describe "#name" do
@@ -20,12 +22,36 @@ describe Ppl::Command::Ls do
   end
 
   describe "#execute" do
-    it "should show the list of contacts in the address book" do
+
+    before(:each) do
       @storage.should_receive(:load_address_book).and_return(@address_book)
+    end
+
+    after(:each) do
+      @command.execute(@input, @output)
+    end
+
+    it "should show the list of contacts in the address book" do
       @format.should_receive(:process).and_return("list of contacts")
       @output.should_receive(:line).with("list of contacts")
-      @command.execute(@input, @output)
     end
+
+    it "should let the user specify a preset pretty format" do
+      @input.options[:pretty] = "test"
+      @address_book.should_receive(:contacts).and_return([1])
+      @custom.should_receive(:use_preset).with("test")
+      @custom.should_receive(:process).and_return("list of contacts")
+      @output.should_receive(:line).with("list of contacts")
+    end
+
+    it "should let the user specify a custom format" do
+      @input.options[:format] = "%n"
+      @address_book.should_receive(:contacts).and_return([1])
+      @custom.should_receive(:format=).with("%n")
+      @custom.should_receive(:process).and_return("list of contacts")
+      @output.should_receive(:line).with("list of contacts")
+    end
+
   end
 
 end

data/spec/ppl/format/custom/contact_spec.rb

@@ -0,0 +1,102 @@
+
+describe Ppl::Format::Custom::Contact do
+
+  before(:each) do
+    @format = Ppl::Format::Custom::Contact.new
+    @contact = Ppl::Entity::Contact.new
+  end
+
+  describe "%n" do
+    it "should be replaced with a newlines" do
+      @format.format = "%n"
+      @format.process(@contact).should eq "\n"
+    end
+  end
+
+  describe "%i" do
+    it "should output the contact's ID" do
+      @contact.id = "test"
+      @format.format = "%i"
+      @format.process(@contact).should eq "test"
+    end
+  end
+
+  describe "%N" do
+    it "should output the contact's name" do
+      @contact.name = "John Doe"
+      @format.format = "%N"
+      @format.process(@contact).should eq "John Doe"
+    end
+  end
+
+  describe "%k" do
+    it "should output the contact's nickname" do
+      @contact.nicknames << "Johnny"
+      @format.format = "%k"
+      @format.process(@contact).should eq "Johnny"
+    end
+  end
+
+  describe "%a" do
+    it "should output the contact's age" do
+      @contact.birthday = Date.parse("2000-01-01")
+      Date.stub(:today).and_return(Date.parse("2010-01-02"))
+      @format.format = "%a"
+      @format.process(@contact).should eq "10"
+    end
+  end
+
+  describe "%b" do
+    it "should output the contact's birthday" do
+      @contact.birthday = Date.parse("1985-06-07")
+      @format.format = "%b"
+      @format.process(@contact).should eq "1985-06-07"
+    end
+    it "should cause no errors if there's no birthday" do
+      @contact.birthday = nil
+      @format.format = "%b"
+      @format.process(@contact).should eq ""
+    end
+  end
+
+  describe "%e" do
+    before(:each) do
+      @format.format = "%e"
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("a@example.org")
+      @contact.email_addresses << Ppl::Entity::EmailAddress.new("b@example.org")
+    end
+    it "should output the first email address" do
+      @format.process(@contact).should eq "a@example.org"
+    end
+    it "should output the preferred email address" do
+      @contact.email_addresses[1].preferred = true
+      @format.process(@contact).should eq "b@example.org"
+    end
+  end
+
+  describe "%p" do
+    before(:each) do
+      @format.format = "%p"
+      @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("0123456789")
+      @contact.phone_numbers << Ppl::Entity::PhoneNumber.new("1098765432")
+    end
+    it "should output the first phone number" do
+      @format.process(@contact).should eq "0123456789"
+    end
+    it "should output the preferred phone number" do
+      @contact.phone_numbers[1].preferred = true
+      @format.process(@contact).should eq "1098765432"
+    end
+  end
+
+  describe "%o" do
+    it "should output the contact's organization" do
+      @contact.organizations << "WTF Inc"
+      @format.format = "%o"
+      @format.process(@contact).should eq "WTF Inc"
+    end
+  end
+
+end
+
+

data/spec/ppl/format/custom/email_address_spec.rb

@@ -0,0 +1,33 @@
+
+describe Ppl::Format::Custom::EmailAddress do
+
+  before(:each) do
+    @format = Ppl::Format::Custom::EmailAddress.new
+    @address = Ppl::Entity::EmailAddress.new
+  end
+
+  describe "%a" do
+    it "should output the address" do
+      @address.address = "test@example.org"
+      @format.format = "<%a>"
+      @format.process(@address).should eq "<test@example.org>"
+    end
+  end
+
+  describe "%f" do
+    before(:each) do
+      @format.format = "%f"
+    end
+    it "should output a star if the address is preferred" do
+      @address.preferred = true
+      @format.process(@address).should eq "*"
+    end
+    it "should output nothing if the address is not preferred" do
+      @address.preferred = false
+      @format.process(@address).should eq ""
+    end
+  end
+
+end
+
+

data/spec/ppl/format/custom/phone_number_spec.rb

@@ -0,0 +1,41 @@
+
+describe Ppl::Format::Custom::PhoneNumber do
+
+  before(:each) do
+    @format = Ppl::Format::Custom::PhoneNumber.new
+    @number = Ppl::Entity::PhoneNumber.new
+  end
+
+  describe "%n" do
+    it "should output the number itself" do
+      @number.number = "1234567890"
+      @format.format = "tel: %n"
+      @format.process(@number).should eq "tel: 1234567890"
+    end
+  end
+
+  describe "%t" do
+    it "should output the type of the number" do
+      @number.type = "cell"
+      @format.format = "(%t)"
+      @format.process(@number).should eq "(cell)"
+    end
+  end
+
+  describe "%f" do
+    before(:each) do
+      @format.format = "%f"
+    end
+    it "should output a star if the number is preferred" do
+      @number.preferred = true
+      @format.process(@number).should eq "*"
+    end
+    it "should output nothing if the number is not preferred" do
+      @number.preferred = false
+      @format.process(@number).should eq ""
+    end
+  end
+
+end
+
+

data/spec/ppl/format/custom_spec.rb

@@ -0,0 +1,50 @@
+
+describe "Ppl::Format::Custom" do
+
+  describe "::format" do
+    it "should accept a symbol and a block" do
+      Ppl::Format::Custom::format :N do |h| h[:name] end
+    end
+  end
+
+  describe "::process" do
+    it "should use the block passed to ::format to process the object" do
+      Ppl::Format::Custom::process(:N, {:name => "jdoe"}).should eq "jdoe"
+    end
+  end
+
+  describe "#initialize" do
+    it "should accept a format string" do
+      Ppl::Format::Custom.new("%N").format.should eq "%N"
+    end
+  end
+
+  describe "#process" do
+    it "should convert the given object into a string based on the format" do
+      custom = Ppl::Format::Custom.new("%N %N %N")
+      object = { :name => "jdoe" }
+      custom.process(object).should eq "jdoe jdoe jdoe"
+    end
+    it "should pad with leading spaces if a positive width is given" do
+      custom = Ppl::Format::Custom.new("%10N")
+      object = { :name => "jdoe" }
+      custom.process(object).should eq "      jdoe"
+    end
+    it "should pad with trailing spaces if a negative width is given" do
+      custom = Ppl::Format::Custom.new("%-10N")
+      object = { :name => "jdoe" }
+      custom.process(object).should eq "jdoe      "
+    end
+  end
+
+  describe "#use_preset" do
+    it "should set the format string to the preset with the given name" do
+      custom = Ppl::Format::Custom.new
+      custom.preset_formats = { "example" => "%N (%N)" }
+      custom.use_preset "example"
+      custom.process({:name => "a"}).should eq "a (a)"
+    end
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Henry Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -255,6 +255,10 @@ files:
 - lib/ppl/format/contact/phone_number.rb
 - lib/ppl/format/contact/postal_address.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/one_line.rb
 - lib/ppl/format/table.rb
@@ -330,6 +334,10 @@ files:
 - spec/ppl/format/contact/postal_address_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/one_line_spec.rb
 - spec/ppl/format/postal_address_spec.rb
 - spec/ppl/format/table_spec.rb