ppl 0.3.0 → 0.9.0

data/lib/ppl/format/table.rb

@@ -0,0 +1,48 @@
+
+class Ppl::Format::Table
+
+  attr_accessor :columns
+  attr_accessor :rows
+
+  def initialize(columns=[])
+    @columns = columns
+    @rows    = []
+
+    @column_widths = {}
+    @columns.each { |c| @column_widths[c] = 0 }
+  end
+
+  def add_row(row={})
+    row.each do |column, value|
+      width     = sprintf("%s", value).length
+      max_width = @column_widths[column]
+      if width > max_width
+        @column_widths[column] = width
+      end
+    end
+    @rows.push(row)
+  end
+
+  def to_s
+    string = ""
+    @rows.each { |row| string += format_row(row).strip + "\n" }
+    string.strip
+  end
+
+
+  private
+
+  def format_row(row)
+    string = ""
+    @columns.each { |column| string += format_cell(row, column) }
+    return string
+  end
+
+  def format_cell(row, column)
+    width  = @column_widths[column]
+    string = sprintf("%-#{width}s  ", row[column])
+    return string
+  end
+
+end
+

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "0.3.0"
+  Version = "0.9.0"
 
   module Adapter
   end
@@ -18,7 +18,7 @@ module Ppl
   module Error
   end
 
-  module Factory
+  module Format
   end
 
 end
@@ -26,26 +26,32 @@ end
 
 require "ppl/adapter/storage"
 require "ppl/adapter/storage/disk"
+require "ppl/adapter/storage/factory"
+require "ppl/adapter/storage/git"
 require "ppl/adapter/vcard"
 require "ppl/adapter/vcard/vpim"
 
 require "ppl/application/bootstrap"
 require "ppl/application/command"
 require "ppl/application/command_suite"
+require "ppl/application/configuration"
 require "ppl/application/input"
 require "ppl/application/output"
 require "ppl/application/router"
 require "ppl/application/shell"
 
-require "ppl/command/command_list"
-require "ppl/command/contact_add"
-require "ppl/command/contact_delete"
-require "ppl/command/contact_list"
-require "ppl/command/contact_show"
-require "ppl/command/contact_rename"
-require "ppl/command/set_birthday"
-require "ppl/command/set_email"
-require "ppl/command/set_name"
+require "ppl/command/init"
+require "ppl/command/bday"
+require "ppl/command/ls"
+require "ppl/command/add"
+require "ppl/command/rm"
+require "ppl/command/help"
+require "ppl/command/show"
+require "ppl/command/mv"
+require "ppl/command/name"
+require "ppl/command/email"
+require "ppl/command/org"
+require "ppl/command/phone"
 
 require "ppl/entity/address_book"
 require "ppl/entity/contact"
@@ -53,6 +59,22 @@ require "ppl/entity/contact"
 require "ppl/error/contact_not_found"
 require "ppl/error/incorrect_usage"
 
+require "ppl/format/address_book"
+require "ppl/format/address_book/birthdays"
+require "ppl/format/address_book/email_addresses"
+require "ppl/format/address_book/names"
+require "ppl/format/address_book/one_line"
+require "ppl/format/address_book/organizations"
+require "ppl/format/address_book/phone_numbers"
+require "ppl/format/contact"
+require "ppl/format/contact/birthday"
+require "ppl/format/contact/email_address"
+require "ppl/format/contact/full"
+require "ppl/format/contact/name"
+require "ppl/format/contact/organization"
+require "ppl/format/contact/phone_number"
+require "ppl/format/table"
+
 class String
   alias_method :each, :each_line
 end

data/ppl.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "0.3.0"
+  spec.version     = "0.9.0"
   spec.date        = "2012-11-23"
 
   spec.summary     = "CLI Address Book"

data/spec/ppl/adapter/storage/disk_spec.rb

@@ -1,9 +1,35 @@
 
+describe Ppl::Adapter::Storage::Disk, "#create_address_book" do
+
+  before(:each) do
+    FakeFS.activate!
+  end
+
+  after(:each) do
+    FakeFS.deactivate!
+  end
+
+  describe "#create_address_book" do
+    it "should create the directory if it doesn't exist yet" do
+      Ppl::Adapter::Storage::Disk.create_address_book("/contacts")
+      Dir.exists?("/contacts").should eq true
+      FileUtils.rm_rf("/contacts")
+    end
+    it "should return a Ppl::Adapter::Storage::Disk" do
+      disk = Ppl::Adapter::Storage::Disk.create_address_book("/contacts")
+      FileUtils.rm_rf("/contacts")
+      disk.should be_a(Ppl::Adapter::Storage::Disk)
+    end
+  end
+
+end
+
 describe Ppl::Adapter::Storage::Disk, "#initialize" do
 
-  it "should accept a path" do
-    @storage = Ppl::Adapter::Storage::Disk.new("/tmp")
-    @storage.path.should eq "/tmp"
+  it "should accept a Dir object" do
+    directory = Dir.new("/tmp")
+    @storage = Ppl::Adapter::Storage::Disk.new(directory)
+    @storage.directory.should be directory
   end
 
 end
@@ -27,13 +53,15 @@ end
 describe Ppl::Adapter::Storage::Disk do
 
   before(:each) do
-    @storage = Ppl::Adapter::Storage::Disk.new("/contacts")
+    FakeFS.activate!
+
+    Dir.mkdir "/contacts"
+    directory = Dir.new("/contacts")
+
+    @storage = Ppl::Adapter::Storage::Disk.new(directory)
     @adapter = double(Ppl::Adapter::Vcard)
     @contact = Ppl::Entity::Contact.new
     @storage.vcard_adapter = @adapter
-
-    FakeFS.activate!
-    Dir.mkdir "/contacts"
   end
 
   after(:each) do
@@ -81,9 +109,6 @@ describe Ppl::Adapter::Storage::Disk do
 
   describe "#save_contact" do
 
-    before(:each) do
-    end
-
     it "should write the contact to disk" do
       @adapter.should_receive(:encode).with(@contact).and_return("asdfg")
 
@@ -95,5 +120,27 @@ describe Ppl::Adapter::Storage::Disk do
 
   end
 
+  describe "#delete_contact" do
+    it "should remove the the contact from the disk" do
+      FileUtils.touch "/contacts/test.vcf"
+      @contact.id = "test"
+      @storage.delete_contact(@contact)
+      File.exists?("/contacts/test.vcf").should eq false
+    end
+  end
+
+  describe "#filename_for_contact" do
+    it "should base the filename on the contact's id" do
+      @contact.id = "test"
+      @storage.filename_for_contact(@contact).should eq "/contacts/test.vcf"
+    end
+  end
+
+  describe "#filename_for_contact_id" do
+    it "should base the filename on the directory path" do
+      @storage.filename_for_contact_id("test").should eq "/contacts/test.vcf"
+    end
+  end
+
 end
 

data/spec/ppl/adapter/storage/factory_spec.rb

@@ -0,0 +1,34 @@
+
+describe Ppl::Adapter::Storage::Factory do
+
+  before(:each) do
+    FakeFS.activate!
+    Dir.mkdir "/contacts"
+
+    @factory   = Ppl::Adapter::Storage::Factory.new(nil)
+    @directory = Dir.new("/contacts")
+    @repo      = double(Rugged::Repository)
+
+    Rugged::Repository.stub(:new).and_return(@repo)
+  end
+
+  after(:each) do
+    FileUtils.rm_rf "/contacts"
+    FakeFS.deactivate!
+  end
+
+  describe "#load_adapter" do
+
+    it "should return a disk adapter by default" do
+      @factory.load_adapter(@directory).should be_a(Ppl::Adapter::Storage::Disk)
+    end
+
+    it "should return a git adapter if the directory is a git repository" do
+      Dir.mkdir "/contacts/.git"
+      @factory.load_adapter(@directory).should be_a(Ppl::Adapter::Storage::Git)
+    end
+
+  end
+
+end
+

data/spec/ppl/adapter/storage/git_spec.rb

@@ -0,0 +1,114 @@
+
+require "ostruct"
+
+describe Ppl::Adapter::Storage::Git, "#initialize" do
+
+  before(:each) do
+    FakeFS.activate!
+    Dir.mkdir "/contacts"
+
+    @disk    = double(Ppl::Adapter::Storage::Disk)
+    @contact = double(Ppl::Entity::Contact)
+    @repo    = double(Rugged::Repository)
+    @commit  = double(Rugged::Commit)
+    @vcard   = double(Ppl::Adapter::Vcard)
+
+    Rugged::Repository.stub(:new).and_return(@repo)
+
+    @disk.stub(:directory).and_return(Dir.new("/contacts"))
+    @contact.stub(:id).and_return("test")
+
+    @git = Ppl::Adapter::Storage::Git.new(@disk)
+    @git.vcard_adapter = @vcard
+  end
+
+  after(:each) do
+    FileUtils.rm_rf "/contacts"
+    FakeFS.deactivate!
+  end
+
+  describe "#initialize" do
+    it "should accept a disk storage adapter" do
+      @git.disk.should be @disk
+    end
+    it "should instantiate rugged" do
+      @git.repository.should be @repo
+    end
+  end
+
+  describe "#load_address_book" do
+
+    before(:each) do
+      @head = double(Rugged::Reference)
+
+      @files = [{:name => "test.vcf"}]
+
+      @commit.should_receive(:target)
+      @repo.should_receive(:lookup).and_return(@head)
+      @repo.should_receive(:head).and_return(@commit)
+
+      @git.stub(:load_contact) do |id|
+        contact    = Ppl::Entity::Contact.new
+        contact.id = id
+        contact
+      end
+
+    end
+
+    it "should return an address book" do
+      @head.should_receive(:tree).and_return(@files)
+      @git.load_address_book.should be_a(Ppl::Entity::AddressBook)
+    end
+
+    it "should not put anything except contacts in the address book" do
+      @files = [{:name => "poop.vcf"}, {:name => ".ppl"}]
+      @head.should_receive(:tree).and_return(@files)
+
+      address_book = @git.load_address_book
+      address_book.each do |contact|
+        contact.should be_a(Ppl::Entity::Contact)
+      end
+    end
+
+  end
+
+  describe "#load_contact" do
+
+    it "should return a contact" do
+      head        = OpenStruct.new
+      head.target = "asdfg"
+
+      @repo.should_receive(:head).and_return(head)
+      @repo.should_receive(:file_at).and_return("vcard contents")
+      @vcard.should_receive(:decode).and_return(@contact)
+      @contact.should_receive(:id=).with("test")
+
+      contact = @git.load_contact("test")
+    end
+
+  end
+
+  describe "#save_contact" do
+
+    it "should save the contact to disk" do
+      @disk.should_receive(:save_contact).with(@contact)
+      @git.stub(:add)
+      @git.stub(:commit)
+      @git.save_contact(@contact)
+    end
+
+    it "should commit the changes" do
+      @disk.should_receive(:save_contact)
+      @git.stub(:add) do |file|
+        file.should eq "test.vcf"
+      end
+      @git.stub(:commit) do |message|
+        message.should eq "save_contact(test)"
+      end
+      @git.save_contact(@contact)
+    end
+
+  end
+
+end
+

data/spec/ppl/adapter/storage_spec.rb

@@ -5,6 +5,12 @@ describe Ppl::Adapter::Storage do
     @storage = Ppl::Adapter::Storage.new
   end
 
+  describe "#create_address_book" do
+    it "should raise not implemented error" do
+      expect{Ppl::Adapter::Storage.create_address_book(nil)}.to raise_error(NotImplementedError)
+    end
+  end
+
   describe "#delete_contact" do
     it "should raise not implemented error" do
       expect{@storage.delete_contact(nil)}.to raise_error(NotImplementedError)

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

@@ -22,6 +22,16 @@ describe Ppl::Adapter::Vcard::Vpim, "#encode" do
     @adapter.encode(@contact).should include("EMAIL:john@example.org")
   end
 
+  it "should encode the contact's phone number" do
+    @contact.phone_number = "01234567890"
+    @adapter.encode(@contact).should include("TEL:01234567890")
+  end
+
+  it "should encode the contact's organization" do
+    @contact.organization = "Example Ltd"
+    @adapter.encode(@contact).should include("ORG:Example Ltd")
+  end
+
 end
 
 
@@ -78,5 +88,29 @@ describe Ppl::Adapter::Vcard::Vpim, "#decode" do
     contact.email_address.should eq "home@example.org"
   end
 
+  it "should decode the contact's phone number" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "TEL:01234567890",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    contact.phone_number.should eq "01234567890"
+  end
+
+  it "should decode the contact's organization" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "ORG:Example Ltd",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    contact.organization.should eq "Example Ltd"
+  end
+
 end
 

data/spec/ppl/application/bootstrap_spec.rb

@@ -6,6 +6,9 @@ describe Ppl::Application::Bootstrap do
   end
 
   describe "#commands" do
+    before(:each) do
+      @bootstrap.stub(:storage_adapter).and_return(Ppl::Adapter::Storage.new)
+    end
     it "should return an array" do
       @bootstrap.commands.should be_an(Array)
     end
@@ -22,18 +25,26 @@ describe Ppl::Application::Bootstrap do
   end
 
   describe "#command_suite" do
+
+    before(:each) do
+      @bootstrap.stub(:storage_adapter)
+    end
+
     it "should return a Ppl::Application::CommandSuite" do
       @bootstrap.command_suite.should be_a(Ppl::Application::CommandSuite)
     end
     it "should contain the 'add' command" do
       @bootstrap.command_suite.find_command("add").should_not be nil
     end
-    it "should contain the 'birthday' command" do
-      @bootstrap.command_suite.find_command("birthday").should_not be nil
+    it "should contain the 'bday' command" do
+      @bootstrap.command_suite.find_command("bday").should_not be nil
     end
     it "should contain the 'email' command" do
       @bootstrap.command_suite.find_command("email").should_not be nil
     end
+    it "should contain the 'init' command" do
+      @bootstrap.command_suite.find_command("init").should_not be nil
+    end
     it "should contain the 'ls' command" do
       @bootstrap.command_suite.find_command("ls").should_not be nil
     end
@@ -43,6 +54,12 @@ 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 'org' command" do
+      @bootstrap.command_suite.find_command("org").should_not be nil
+    end
+    it "should contain the 'phone' command" do
+      @bootstrap.command_suite.find_command("phone").should_not be nil
+    end
     it "should contain the 'rm' command" do
       @bootstrap.command_suite.find_command("rm").should_not be nil
     end
@@ -54,6 +71,12 @@ describe Ppl::Application::Bootstrap do
     end
   end
 
+  describe "#configuration" do
+    it "should return a Ppl::Application::Configuration" do
+      @bootstrap.configuration.should be_a(Ppl::Application::Configuration)
+    end
+  end
+
   describe "#input" do
     it "should return a Ppl::Application::Input" do
       @bootstrap.input.should be_a(Ppl::Application::Input)
@@ -67,6 +90,9 @@ describe Ppl::Application::Bootstrap do
   end
 
   describe "#router" do
+    before(:each) do
+      @bootstrap.stub(:storage_adapter)
+    end
     it "should return a Ppl::Application::Router" do
       @bootstrap.router.should be_a(Ppl::Application::Router)
     end
@@ -76,14 +102,26 @@ describe Ppl::Application::Bootstrap do
   end
 
   describe "#shell" do
+    before(:each) do
+      @bootstrap.stub(:storage_adapter)
+    end
     it "should return a Ppl::Application::Shell" do
       @bootstrap.shell.should be_a(Ppl::Application::Shell)
     end
   end
 
   describe "#storage_adapter" do
-    it "should return a Ppl::Adapter::Storage::Disk" do
-      @bootstrap.storage_adapter.should be_a(Ppl::Adapter::Storage::Disk)
+    before(:each) do
+      @config  = double(Ppl::Application::Configuration)
+      @factory = double(Ppl::Adapter::Storage::Factory)
+      @bootstrap.stub(:configuration).and_return(@config)
+      Ppl::Adapter::Storage::Factory.stub(:new).and_return(@factory)
+
+      @config.should_receive(:address_book_path).and_return("/tmp")
+      @factory.should_receive(:load_adapter).and_return(Ppl::Adapter::Storage::Disk.new(nil))
+    end
+    it "should return a Ppl::Adapter::Storage" do
+      @bootstrap.storage_adapter.should be_a(Ppl::Adapter::Storage)
     end
   end
 

data/spec/ppl/application/command_suite_spec.rb

@@ -40,5 +40,13 @@ describe Ppl::Application::CommandSuite do
     end
   end
 
+  describe "#sort_by_name" do
+    it "should sort the commands alphabetically by name" do
+      @command_suite.sort_by_name
+      @command_suite[0].name.should eq "bar"
+      @command_suite[1].name.should eq "foo"
+    end
+  end
+
 end
 

data/spec/ppl/application/configuration_spec.rb

@@ -0,0 +1,32 @@
+
+describe Ppl::Application::Configuration do
+
+  before(:each) do
+    FakeFS.activate!
+    @config = Ppl::Application::Configuration.new
+  end
+
+  after(:each) do
+    FakeFS.deactivate!
+  end
+
+  describe "#address_book_path" do
+    it "should default to the current working directory" do
+      @config.address_book_path.should eq Dir.pwd
+    end
+    it "should be configurable by the user's config file" do
+      @config.stub(:user_configuration) do
+        {"address book" => {"path" => "/contacts"}}
+      end
+      @config.address_book_path.should eq "/contacts"
+    end
+  end
+
+  describe "#aliases" do
+    it "should return a hash" do
+      @config.aliases.should be_a(Hash)
+    end
+  end
+
+end
+

data/spec/ppl/application/shell_spec.rb

@@ -30,6 +30,7 @@ describe Ppl::Application::Shell do
         .with("foo")
         .and_return(@command)
 
+      @command.should_receive(:options)
       @command
         .should_receive(:execute)
         .and_return(true)
@@ -44,6 +45,7 @@ describe Ppl::Application::Shell do
         .with("mv")
         .and_return(@command)
 
+      @command.should_receive(:options)
       @command.should_receive(:execute) do |input, output|
         input.arguments.should eq ["foo", "bar"]
       end
@@ -51,6 +53,7 @@ describe Ppl::Application::Shell do
     end
 
     it "should return false if the command throws an exception" do
+      @command.should_receive(:options)
       @command
         .should_receive(:execute)
         .and_raise(StandardError)
@@ -65,6 +68,7 @@ describe Ppl::Application::Shell do
     end
 
     it "should send exception messages to stderr" do
+      @command.should_receive(:options)
       @command.should_receive(:execute) { raise "Pool's Closed" }
       @router.should_receive(:route).and_return(@command)
 

data/spec/ppl/command/{contact_add_spec.rb → add_spec.rb}

@@ -1,8 +1,8 @@
 
-describe Ppl::Command::ContactAdd do
+describe Ppl::Command::Add do
 
   before(:each) do
-    @command = Ppl::Command::ContactAdd.new
+    @command = Ppl::Command::Add.new
     @input   = Ppl::Application::Input.new
     @storage = double(Ppl::Adapter::Storage)
 

data/spec/ppl/command/bday_spec.rb

@@ -0,0 +1,56 @@
+
+describe Ppl::Command::Bday do
+
+  before(:each) do
+    @input   = Ppl::Application::Input.new
+    @output  = Ppl::Application::Output.new(nil, nil)
+    @contact = Ppl::Entity::Contact.new
+    @command = Ppl::Command::Bday.new
+    @storage = double(Ppl::Adapter::Storage)
+    @show_format  = double(Ppl::Format::Contact)
+
+    @command.storage = @storage
+    @command.show_format  = @show_format
+    @contact.id = "jim"
+  end
+
+  describe "#name" do
+    it "should be 'bday'" do
+      @command.name.should eq "bday"
+    end
+  end
+
+  describe "#execute" do
+
+    it "should list all birthdays if no contact is specified" do
+      #@input.arguments = []
+      #@command.execute(@input, @output)
+    end
+
+    it "should raise an error if the date given isn't a valid date" do
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @input.arguments = ["jim", "poiuytrewq"]
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+    it "should show the contact's birthday if no date is given" do
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @show_format.should_receive(:process).and_return("1970-01-01")
+      @output.should_receive(:line).with("1970-01-01")
+      @input.arguments = ["jim"]
+      @command.execute(@input, @output)
+    end
+
+    it "should change the contact's birthday if a date is given" do
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @storage.should_receive(:save_contact) do |contact|
+        contact.birthday.strftime.should eq "1980-01-01"
+      end
+      @input.arguments = ["jim", "1980-01-01"]
+      @command.execute(@input, @output)
+    end
+
+  end
+
+end
+