ppl 0.2.0 → 0.3.0

data/README.md

@@ -52,24 +52,19 @@ fred@example.org
 $ ppl rm dave
 ```
 
-### Rename a contact
+### Change a contact's ID
 ```bash
 $ ppl mv dave david
 ```
 
-Roadmap
--------
-
-Support for the following commands is planned.
-
-### Change a contact's email address
+### Change a contact's name
 ```bash
-$ ppl email dave david@example.org
+$ ppl name john "John Smith"
 ```
 
-### Change a contact's name
+### Change a contact's email address
 ```bash
-$ ppl name john "John Smith"
+$ ppl email dave david@example.org
 ```
 
 ### Change a contact's birthday
@@ -77,6 +72,54 @@ $ ppl name john "John Smith"
 $ ppl birthday john 1980-01-01
 ```
 
+Roadmap
+-------
+
+One of the core ideas of ppl is for it to turn your address book into a Git
+repository. In an earlier version, this was achieved using
+[Rugged](https://github.com/libgit2/rugged). This functionality will be added
+back in so that contact information can be easily synced between computers. In
+the meantime, ppl simply writes to disk.
+
+Other data about contacts will also be supported, such as:
+* Postal addresses
+* Phone numbers
+* The name of the organization to which the contact belongs
+* The position of the contact within their organization
+
+The email address handling is currently very rudimentary. The eventual plan is
+to support storage of several addresses per contact. Addresses will be able to
+be organized according to location, such as "home" or "work", and it will be
+possible to mark a particular address as "preferred" for each location.
+
+Here's a quick mockup of the sort of output `ppl show` should produce a little
+further down the road once some of these goals have been reached:
+
+    Fred Smith <fred.smith@example.org>
+
+    -- Email Addresses -------------------------------------------------------------
+
+       Home
+     * fred.smith@example.org
+       fsmith@aol.com
+
+       Work
+     * fred.smith@megacorp.com
+       fred.s.123@initrode.net
+
+    -- Postal Addresses ------------------------------------------------------------
+
+       Home
+       1 Testing Road, TestVille, Testing, CA, 12345
+
+       Work
+       30 Business Road, TestVille, Testing, CA, 23454
+
+    -- Telephone Numbers -----------------------------------------------------------
+
+       01234567891
+       09876541233
+
 Contributing
 ------------
 

data/lib/ppl/adapter/storage/disk.rb

@@ -36,5 +36,15 @@ class Ppl::Adapter::Storage::Disk < Ppl::Adapter::Storage
     return contact
   end
 
+  def save_contact(contact)
+    vcard = @vcard_adapter.encode(contact)
+
+    basename = contact.id +  ".vcf"
+    filename = File.join @path, basename
+    File.open(filename, "w") do |file|
+      file.write(vcard)
+    end
+  end
+
 end
 

data/lib/ppl/adapter/storage.rb

@@ -18,6 +18,7 @@ class Ppl::Adapter::Storage
     if contact.nil?
       raise Ppl::Error::ContactNotFound, id
     end
+    return contact
   end
 
   def save_contact(contact)

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

@@ -14,6 +14,11 @@ class Ppl::Adapter::Vcard::Vpim
         name.given    = contact.id   unless contact.id.nil?
         name.fullname = contact.name unless contact.name.nil?
       end
+
+      if !contact.email_address.nil?
+        maker.add_email(contact.email_address)
+      end
+
     end
 
     return vcard.to_s

data/lib/ppl/application/bootstrap.rb

@@ -9,6 +9,9 @@ class Ppl::Application::Bootstrap
       Ppl::Command::ContactList.new,
       Ppl::Command::ContactRename.new,
       Ppl::Command::ContactShow.new,
+      Ppl::Command::SetBirthday.new,
+      Ppl::Command::SetEmail.new,
+      Ppl::Command::SetName.new,
     ]
     commands.each do |command|
       command.storage = storage_adapter

data/lib/ppl/command/set_birthday.rb

@@ -0,0 +1,30 @@
+
+class Ppl::Command::SetBirthday < Ppl::Application::Command
+
+  def initialize
+    @name        = "birthday"
+    @description = "Change a contact's birthday"
+  end
+
+  def execute(input, output)
+
+    contact_id = input.arguments.shift
+    birthday   = input.arguments.shift
+
+    if contact_id.nil? || birthday.nil?
+      raise Ppl::Error::IncorrectUsage
+    end
+
+    birthday = Date.parse birthday
+
+    contact = @storage.require_contact(contact_id)
+
+    contact.birthday = birthday
+
+    storage.save_contact(contact)
+
+    return true
+  end
+
+end
+

data/lib/ppl/command/set_email.rb

@@ -0,0 +1,23 @@
+
+class Ppl::Command::SetEmail < Ppl::Application::Command
+
+  def initialize
+    @name        = "email"
+    @description = "Change a contact's email address"
+  end
+
+  def execute(input, output)
+
+    contact_id    = input.arguments.shift
+    email_address = input.arguments.shift
+
+    contact = @storage.require_contact(contact_id)
+    contact.email_address = email_address
+
+    storage.save_contact(contact)
+
+    return true
+  end
+
+end
+

data/lib/ppl/command/set_name.rb

@@ -0,0 +1,28 @@
+
+class Ppl::Command::SetName < Ppl::Application::Command
+
+  def initialize
+    @name        = "name"
+    @description = "Change a contact's name"
+  end
+
+  def execute(input, output)
+
+    contact_id = input.arguments.shift
+    name       = input.arguments.shift
+
+    if contact_id.nil? || name.nil?
+      raise Ppl::Error::IncorrectUsage
+    end
+
+    contact = @storage.require_contact(contact_id)
+
+    contact.name = name.dup
+
+    storage.save_contact(contact)
+
+    return true
+  end
+
+end
+

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "0.2.0"
+  Version = "0.3.0"
 
   module Adapter
   end
@@ -43,6 +43,9 @@ 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/entity/address_book"
 require "ppl/entity/contact"

data/ppl.gemspec

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

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

@@ -79,5 +79,21 @@ describe Ppl::Adapter::Storage::Disk do
 
   end
 
+  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")
+
+      @contact.id = "test"
+      @storage.save_contact(@contact)
+
+      File.read("/contacts/test.vcf").should eq "asdfg"
+    end
+
+  end
+
 end
 

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

@@ -17,6 +17,11 @@ describe Ppl::Adapter::Vcard::Vpim, "#encode" do
     @adapter.encode(@contact).should include("FN:John Doe")
   end
 
+  it "should encode the contact's email address" do
+    @contact.email_address = "john@example.org"
+    @adapter.encode(@contact).should include("EMAIL:john@example.org")
+  end
+
 end
 
 

data/spec/ppl/application/bootstrap_spec.rb

@@ -28,12 +28,21 @@ describe Ppl::Application::Bootstrap do
     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
+    end
+    it "should contain the 'email' command" do
+      @bootstrap.command_suite.find_command("email").should_not be nil
+    end
     it "should contain the 'ls' command" do
       @bootstrap.command_suite.find_command("ls").should_not be nil
     end
     it "should contain the 'mv' command" do
       @bootstrap.command_suite.find_command("mv").should_not be nil
     end
+    it "should contain the 'name' command" do
+      @bootstrap.command_suite.find_command("name").should_not be nil
+    end
     it "should contain the 'rm' command" do
       @bootstrap.command_suite.find_command("rm").should_not be nil
     end

data/spec/ppl/command/set_birthday_spec.rb

@@ -0,0 +1,50 @@
+
+describe Ppl::Command::SetBirthday do
+
+  before(:each) do
+    @input   = Ppl::Application::Input.new
+    @output  = Ppl::Application::Output.new(nil, nil)
+    @contact = Ppl::Entity::Contact.new
+    @command = Ppl::Command::SetBirthday.new
+    @storage = double(Ppl::Adapter::Storage)
+
+    @command.storage = @storage
+    @contact.id = "jim"
+  end
+
+  describe "#name" do
+    it "should be 'birthday'" do
+      @command.name.should eq "birthday"
+    end
+  end
+
+  describe "#execute" do
+
+    it "should change the contact's birthday" 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
+
+    it "should raise an error if no contact ID is given" do
+      @input.arguments = [nil, "1980-01-01"]
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+    it "should raise an error if no birthday is given" do
+      @input.arguments = ["jim"]
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+    it "should raise an error if the birthday isn't a valid date" do
+      @input.arguments = ["jim", "poiuytrewq"]
+      expect{@command.execute(@input, @output)}.to raise_error(ArgumentError)
+    end
+
+  end
+
+end
+

data/spec/ppl/command/set_email_spec.rb

@@ -0,0 +1,38 @@
+
+describe Ppl::Command::SetEmail do
+
+  before(:each) do
+    @input   = Ppl::Application::Input.new
+    @output  = Ppl::Application::Output.new(nil, nil)
+    @contact = Ppl::Entity::Contact.new
+    @command = Ppl::Command::SetEmail.new
+    @storage = double(Ppl::Adapter::Storage)
+
+    @command.storage = @storage
+    @contact.id = "jim"
+  end
+
+  describe "#name" do
+    it "should be 'email'" do
+      @command.name.should eq "email"
+    end
+  end
+
+  describe "#execute" do
+
+    it "should change the contact's email address" do
+
+      @storage.should_receive(:require_contact).and_return(@contact)
+
+      @storage.should_receive(:save_contact) do |contact|
+        contact.email_address.should eq "jim@example.org"
+      end
+
+      @input.arguments = ["jim", "jim@example.org"]
+      @command.execute(@input, @output)
+    end
+
+  end
+
+end
+

data/spec/ppl/command/set_name_spec.rb

@@ -0,0 +1,45 @@
+
+describe Ppl::Command::SetName do
+
+  before(:each) do
+    @input   = Ppl::Application::Input.new
+    @output  = Ppl::Application::Output.new(nil, nil)
+    @contact = Ppl::Entity::Contact.new
+    @command = Ppl::Command::SetName.new
+    @storage = double(Ppl::Adapter::Storage)
+
+    @command.storage = @storage
+    @contact.id = "jim"
+  end
+
+  describe "#name" do
+    it "should be 'name'" do
+      @command.name.should eq "name"
+    end
+  end
+
+  describe "#execute" do
+
+    it "should change the contact's name" do
+      @storage.should_receive(:require_contact).and_return(@contact)
+      @storage.should_receive(:save_contact) do |contact|
+        contact.name.should eq "Jim Jamieson"
+      end
+      @input.arguments = ["jim", "Jim Jamieson"]
+      @command.execute(@input, @output)
+    end
+
+    it "should raise an error if no contact ID is given" do
+      @input.arguments = [nil, "Jim Jamieson"]
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+    it "should raise an error if no name is given" do
+      @input.arguments = ["jim"]
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -44,6 +44,9 @@ files:
 - lib/ppl/command/contact_list.rb
 - lib/ppl/command/contact_rename.rb
 - lib/ppl/command/contact_show.rb
+- lib/ppl/command/set_birthday.rb
+- lib/ppl/command/set_email.rb
+- lib/ppl/command/set_name.rb
 - lib/ppl/entity/address_book.rb
 - lib/ppl/entity/contact.rb
 - lib/ppl/error/contact_not_found.rb
@@ -66,6 +69,9 @@ files:
 - spec/ppl/command/contact_list_spec.rb
 - spec/ppl/command/contact_rename_spec.rb
 - spec/ppl/command/contact_show_spec.rb
+- spec/ppl/command/set_birthday_spec.rb
+- spec/ppl/command/set_email_spec.rb
+- spec/ppl/command/set_name_spec.rb
 - spec/ppl/entity/address_book_spec.rb
 - spec/ppl/entity/contact_spec.rb
 - spec/spec_helper.rb