ppl 0.0.5 → 0.2.0

data/lib/ppl/entity/contact.rb

@@ -0,0 +1,10 @@
+
+class Ppl::Entity::Contact
+
+  attr_accessor :id
+  attr_accessor :name
+  attr_accessor :email_address
+  attr_accessor :birthday
+
+end
+

data/lib/ppl/error/contact_not_found.rb

@@ -0,0 +1,4 @@
+
+class Ppl::Error::ContactNotFound < StandardError
+end
+

data/lib/ppl/error/incorrect_usage.rb

@@ -0,0 +1,4 @@
+
+class Ppl::Error::IncorrectUsage < StandardError
+end
+

data/lib/ppl.rb

@@ -1,16 +1,56 @@
 
 module Ppl
+
+  Version = "0.2.0"
+
+  module Adapter
+  end
+
+  module Application
+  end
+
+  module Command
+  end
+
+  module Entity
+  end
+
+  module Error
+  end
+
+  module Factory
+  end
+
 end
 
-require "ppl/address_book"
-require "ppl/contact"
-require "ppl/cli"
-require "ppl/command"
-require "ppl/command/add"
-require "ppl/command/birthdays"
-require "ppl/command/help"
-require "ppl/command/list"
-require "ppl/command/rm"
-require "ppl/command/set"
-require "ppl/command/show"
+
+require "ppl/adapter/storage"
+require "ppl/adapter/storage/disk"
+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/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/entity/address_book"
+require "ppl/entity/contact"
+
+require "ppl/error/contact_not_found"
+require "ppl/error/incorrect_usage"
+
+class String
+  alias_method :each, :each_line
+end
 

data/ppl.gemspec

@@ -2,11 +2,11 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "0.0.5"
-  spec.date        = "2012-11-13"
+  spec.version     = "0.2.0"
+  spec.date        = "2012-11-23"
 
   spec.summary     = "CLI Address Book"
-  spec.description = "Command-line driven address book"
+  spec.description = "CLI Address Book"
   spec.license     = "GPL-2"
 
   spec.authors     = ["Henry Smith"]

data/spec/ppl/adapter/output_spec.rb

@@ -0,0 +1,43 @@
+
+describe Ppl::Application::Output, "#initialize" do
+
+  it "should accept stdout" do
+    stdout = Object.new
+    @output = Ppl::Application::Output.new(stdout, nil)
+    @output.stdout.should be stdout
+  end
+
+  it "should accept stderr" do
+    stderr = Object.new
+    @output = Ppl::Application::Output.new(nil, stderr)
+    @output.stderr.should be stderr
+  end
+
+end
+
+describe Ppl::Application::Output do
+
+  before(:each) do
+    @stderr = double(IO)
+    @stdout = double(IO)
+    @output = Ppl::Application::Output.new(@stdout, @stderr)
+  end
+
+  describe "#error" do
+    it "should delegate to stderr's puts method" do
+      string = "COMPUTER OVER. VIRUS = VERY YES"
+      @stderr.should_receive(:puts).with(string)
+      @output.error(string)
+    end
+  end
+
+  describe "#line" do
+    it "should delegate to stdout's puts method" do
+      string = "The quick brown fox"
+      @stdout.should_receive(:puts).with(string)
+      @output.line(string)
+    end
+  end
+
+end
+

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

@@ -0,0 +1,83 @@
+
+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"
+  end
+
+end
+
+describe Ppl::Adapter::Storage::Disk do
+
+  before(:each) do
+    @storage = Ppl::Adapter::Storage::Disk.new(nil)
+  end
+
+  describe "#vcard_adapter=" do
+    it "should accept a vcard adapter" do
+      adapter = double(Ppl::Adapter::Vcard)
+      @storage.vcard_adapter = adapter
+      @storage.vcard_adapter.should be adapter
+    end
+  end
+
+end
+
+describe Ppl::Adapter::Storage::Disk do
+
+  before(:each) do
+    @storage = Ppl::Adapter::Storage::Disk.new("/contacts")
+    @adapter = double(Ppl::Adapter::Vcard)
+    @contact = Ppl::Entity::Contact.new
+    @storage.vcard_adapter = @adapter
+
+    FakeFS.activate!
+    Dir.mkdir "/contacts"
+  end
+
+  after(:each) do
+    FileUtils.rm_rf "/contacts"
+    FakeFS.deactivate!
+  end
+
+  describe "#load_address_book" do
+
+    it "should return a Ppl::Entity::AddressBook" do
+      @storage.load_address_book.should be_a(Ppl::Entity::AddressBook)
+    end
+
+    it "should fill the address book with the contacts in the directory" do
+      FileUtils.touch "/contacts/one.vcf"
+      FileUtils.touch "/contacts/two.vcf"
+
+      @adapter.should_receive(:decode).twice
+
+      address_book = @storage.load_address_book
+      address_book.count.should eq 2
+    end
+
+  end
+
+  describe "#load_contact" do
+
+    it "should return nil if the given contact doesn't exist" do
+      @storage.load_contact("xyz").should be nil
+    end
+
+    it "should return a Ppl::Entity::Contact" do
+      FileUtils.touch "/contacts/one.vcf"
+      @adapter.should_receive(:decode).once.and_return(@contact)
+      @storage.load_contact("one").should be_a(Ppl::Entity::Contact)
+    end
+
+    it "should populate the contact's id" do
+      FileUtils.touch "/contacts/one.vcf"
+      @adapter.should_receive(:decode).once.and_return(@contact)
+      @storage.load_contact("one").id.should eq "one"
+    end
+
+  end
+
+end
+

data/spec/ppl/adapter/storage_spec.rb

@@ -0,0 +1,46 @@
+
+describe Ppl::Adapter::Storage do
+
+  before(:each) do
+    @storage = Ppl::Adapter::Storage.new
+  end
+
+  describe "#delete_contact" do
+    it "should raise not implemented error" do
+      expect{@storage.delete_contact(nil)}.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#load_address_book" do
+    it "should raise not implemented error" do
+      expect{@storage.load_address_book}.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#load_contact" do
+    it "should raise not implemented error" do
+      expect{@storage.load_contact(nil)}.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#require_contact" do
+
+    it "should raise Ppl::Error::ContactNotFound if load fails" do
+      @storage.stub(:load_contact) do |id| end
+      expect{@storage.require_contact("joe")}.to raise_error(Ppl::Error::ContactNotFound)
+    end
+
+    it "should return the loaded contact" do
+      @storage.stub(:load_contact) do |id| Object.new end
+      @storage.require_contact("joe").should be_an(Object)
+    end
+  end
+
+  describe "#save_contact" do
+    it "should raise not implemented error" do
+      expect{@storage.save_contact(nil)}.to raise_error(NotImplementedError)
+    end
+  end
+
+end
+

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

@@ -0,0 +1,77 @@
+
+describe Ppl::Adapter::Vcard::Vpim, "#encode" do
+
+  before(:each) do
+    @adapter = Ppl::Adapter::Vcard::Vpim.new
+    @contact = Ppl::Entity::Contact.new
+    @contact.id = "test"
+  end
+
+  it "should encode the contact's birthday" do
+    @contact.birthday = Date.parse "2000-01-01"
+    @adapter.encode(@contact).should include("BDAY:20000101")
+  end
+
+  it "should encode the contact's name" do
+    @contact.name = "John Doe"
+    @adapter.encode(@contact).should include("FN:John Doe")
+  end
+
+end
+
+
+describe Ppl::Adapter::Vcard::Vpim, "#decode" do
+
+  before(:each) do
+    @adapter = Ppl::Adapter::Vcard::Vpim.new
+  end
+
+  it "should return a Ppl::Entity::Contact" do
+    vcard = [
+      "BEGIN:VCARD",
+      "VERSION:3.0",
+      "N:,test",
+      "END:VCARD",
+    ].join("\n")
+    @adapter.decode(vcard).should be_a(Ppl::Entity::Contact)
+  end
+
+  it "should decode the contact's birthday" do
+    vcard = [
+      "BEGIN:VCARD",
+      "VERSION:3.0",
+      "N:,test",
+      "BDAY:20120102",
+      "END:VCARD",
+    ].join("\n")
+    @adapter.decode(vcard).birthday.strftime('%Y-%m-%d').should eq "2012-01-02"
+  end
+
+  it "should decode the contact's name" do
+
+    vcard = [
+      "BEGIN:VCARD",
+      "VERSION:3.0",
+      "N:,test",
+      "FN:John Doe",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+
+    contact.name.should eq "John Doe"
+  end
+
+  it "should decode the contact's email address" do
+    vcard = [
+      "BEGIN:VCARD",
+      "N:,test",
+      "VERSION:3.0",
+      "EMAIL;TYPE=home:home@example.org",
+      "END:VCARD",
+    ].join("\n")
+    contact = @adapter.decode(vcard)
+    contact.email_address.should eq "home@example.org"
+  end
+
+end
+

data/spec/ppl/adapter/vcard_spec.rb

@@ -0,0 +1,24 @@
+
+describe Ppl::Adapter::Vcard, "#encode" do
+
+  describe "#encode" do
+    before(:each) do
+      @adapter = Ppl::Adapter::Vcard.new
+    end
+    it "should raise not implemented error" do
+      expect{@adapter.encode(nil)}.to raise_error(NotImplementedError)
+    end
+  end
+
+
+  describe "#decode" do
+    before(:each) do
+      @adapter = Ppl::Adapter::Vcard.new
+    end
+    it "should raise not implemented error" do
+      expect{@adapter.decode(nil)}.to raise_error(NotImplementedError)
+    end
+  end
+
+end
+

data/spec/ppl/application/bootstrap_spec.rb

@@ -0,0 +1,88 @@
+
+describe Ppl::Application::Bootstrap do
+
+  before(:each) do
+    @bootstrap = Ppl::Application::Bootstrap.new
+  end
+
+  describe "#commands" do
+    it "should return an array" do
+      @bootstrap.commands.should be_an(Array)
+    end
+    it "should return commands" do
+      @bootstrap.commands.each do |command|
+        command.should be_a(Ppl::Application::Command)
+      end
+    end
+    it "should inject a storage adapter into each command" do
+      @bootstrap.commands.each do |command|
+        command.storage.should be_a(Ppl::Adapter::Storage)
+      end
+    end
+  end
+
+  describe "#command_suite" do
+    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 '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 'rm' command" do
+      @bootstrap.command_suite.find_command("rm").should_not be nil
+    end
+    it "should contain the 'show' command" do
+      @bootstrap.command_suite.find_command("show").should_not be nil
+    end
+    it "should contain the 'help' command" do
+      @bootstrap.command_suite.find_command("help").should_not be nil
+    end
+  end
+
+  describe "#input" do
+    it "should return a Ppl::Application::Input" do
+      @bootstrap.input.should be_a(Ppl::Application::Input)
+    end
+  end
+
+  describe "#output" do
+    it "should return a Ppl::Application::Output" do
+      @bootstrap.output.should be_a(Ppl::Application::Output)
+    end
+  end
+
+  describe "#router" do
+    it "should return a Ppl::Application::Router" do
+      @bootstrap.router.should be_a(Ppl::Application::Router)
+    end
+    it "should set the 'help' command as the default" do
+      @bootstrap.router.default.should eq "help"
+    end
+  end
+
+  describe "#shell" do
+    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)
+    end
+  end
+
+  describe "#vcard_adapter" do
+    it "should return a Ppl::Adapter::Vcard::Vpim" do
+      @bootstrap.vcard_adapter.should be_a(Ppl::Adapter::Vcard::Vpim)
+    end
+  end
+
+end
+

data/spec/ppl/application/command_spec.rb

@@ -0,0 +1,19 @@
+
+describe Ppl::Application::Command, "#execute" do
+
+  before(:each) do
+    @command = Ppl::Application::Command.new
+  end
+
+  it "should raise not implemented error" do
+    expect{@command.execute(nil, nil)}.to raise_error(NotImplementedError)
+  end
+
+  it "should accept a storage adapter" do
+    storage = double(Ppl::Adapter::Storage)
+    @command.storage = storage
+    @command.storage.should be storage
+  end
+
+end
+

data/spec/ppl/application/command_suite_spec.rb

@@ -0,0 +1,44 @@
+
+describe Ppl::Application::CommandSuite do
+
+  before(:each) do
+    @command_suite = Ppl::Application::CommandSuite.new
+
+    @foo_command      = Ppl::Application::Command.new
+    @foo_command.name = "foo"
+
+    @bar_command      = Ppl::Application::Command.new
+    @bar_command.name = "bar"
+
+    @command_suite.add_command(@foo_command)
+    @command_suite.add_command(@bar_command)
+  end
+
+  describe "#add_command" do
+    it "should accept a command" do
+      @command_suite.add_command(Ppl::Application::Command.new)
+      @command_suite.count.should be 3
+    end
+  end
+
+  describe "#find_command" do
+    it "should find a command matching the given name" do
+      @command_suite.find_command("foo").should be @foo_command
+    end
+    it "should return nil if no commands match the given name" do
+      @command_suite.find_command("baz").should be nil
+    end
+  end
+
+  describe "#each" do
+    it "should yield commands" do
+      @command_suite
+        .should_receive(:each)
+        .and_yield(@foo_command)
+        .and_yield(@bar_command)
+      @command_suite.each do |c| end
+    end
+  end
+
+end
+

data/spec/ppl/application/input_spec.rb

@@ -0,0 +1,21 @@
+
+describe Ppl::Application::Input do
+
+  before(:each) do
+    @input = Ppl::Application::Input.new
+  end
+
+  describe "#arguments" do
+    it "should be an array" do
+      @input.arguments.should be_an(Array)
+    end
+  end
+
+  describe "#options" do
+    it "should be a hash" do
+      @input.options.should be_a(Hash)
+    end
+  end
+
+end
+

data/spec/ppl/application/router_spec.rb

@@ -0,0 +1,43 @@
+
+describe Ppl::Application::Router do
+
+  before(:each) do
+    @suite  = Ppl::Application::CommandSuite.new
+    @router = Ppl::Application::Router.new(@suite)
+
+    @cmd_one = Ppl::Application::Command.new
+    @cmd_one.name = "one"
+
+    @cmd_two = Ppl::Application::Command.new
+    @cmd_two.name = "two"
+
+    @suite.add_command(@cmd_one)
+    @suite.add_command(@cmd_two)
+  end
+
+  describe "#default=" do
+    it "should accept the name of the default command" do
+      @router.default = "one"
+      @router.default.should eq "one"
+    end
+  end
+
+  describe "#route" do
+
+    it "should return the command whose name matches the given argument" do
+      @router.route("two").should be @cmd_two
+    end
+
+    it "should return nil if no matching command can be found" do
+      @router.route("three").should be nil
+    end
+
+    it "should fall back to the default command if the given one isn't found" do
+      @router.default = "one"
+      @router.route("three").should be @cmd_one
+    end
+
+  end
+
+end
+

data/spec/ppl/application/shell_spec.rb

@@ -0,0 +1,79 @@
+
+describe Ppl::Application::Shell do
+
+  before(:each) do
+    @shell  = Ppl::Application::Shell.new
+    @input  = Ppl::Application::Input.new
+    @output = double(Ppl::Application::Output)
+
+    @router  = double(Ppl::Application::Router)
+    @command = double(Ppl::Application::Command)
+
+    @shell.router = @router
+  end
+
+  describe "#run" do
+
+    it "should return false if the given command isn't found" do
+      @input.arguments = ["foo"]
+      @router
+        .should_receive(:route)
+        .with("foo")
+        .and_return(nil)
+      @shell.run(@input, @output).should eq false
+    end
+
+    it "should execute the given command" do
+      @input.arguments = ["foo"]
+      @router
+        .should_receive(:route)
+        .with("foo")
+        .and_return(@command)
+
+      @command
+        .should_receive(:execute)
+        .and_return(true)
+
+      @shell.run(@input, @output).should eq true
+    end
+
+    it "should not pass the command name in the input to the command itself" do
+      @input.arguments = ["mv", "foo", "bar"]
+      @router
+        .should_receive(:route)
+        .with("mv")
+        .and_return(@command)
+
+      @command.should_receive(:execute) do |input, output|
+        input.arguments.should eq ["foo", "bar"]
+      end
+      @shell.run(@input, @output)
+    end
+
+    it "should return false if the command throws an exception" do
+      @command
+        .should_receive(:execute)
+        .and_raise(StandardError)
+
+      @router
+        .should_receive(:route)
+        .and_return(@command)
+
+      @output.should_receive(:error)
+
+      @shell.run(@input, @output)
+    end
+
+    it "should send exception messages to stderr" do
+      @command.should_receive(:execute) { raise "Pool's Closed" }
+      @router.should_receive(:route).and_return(@command)
+
+      @output.should_receive(:error).with("ppl: Pool's Closed")
+
+      @shell.run(@input, @output)
+    end
+
+  end
+
+end
+