ppl 0.0.5 → 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+-c
+

data/.travis.yml

@@ -0,0 +1,5 @@
+
+language: ruby
+rvm: "1.9.3"
+script: bundle exec rspec spec
+

data/Gemfile

@@ -1,7 +1,11 @@
 
-gem 'active_support'
-
-gem "colored", "~> 1.2"
+source :rubygems
 
 gem "vpim", "12.1.12", :git => "git://github.com/sam-github/vpim.git"
 
+group :test do
+  gem "fakefs"
+  gem "rake"
+  gem "rspec"
+end
+

data/Gemfile.lock

@@ -1,9 +1,3 @@
-GIT
-  remote: git://github.com/defunkt/colored.git
-  revision: 829bde0f8832406be1cacc5c99c49d976e05ccfc
-  specs:
-    colored (1.2)
-
 GIT
   remote: git://github.com/sam-github/vpim.git
   revision: 6753a367cda64e53eab745414cedc130d2f149c8
@@ -11,11 +5,25 @@ GIT
     vpim (12.1.12)
 
 GEM
+  remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.3)
+    fakefs (0.4.1)
+    rake (10.0.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  colored (~> 1.2)!
+  fakefs
+  rake
+  rspec
   vpim (= 12.1.12)!

data/README.md

@@ -11,49 +11,50 @@ like "people". You might be interested in ppl if:
 * You want ownership of your address book data back from the cloud
 * You prefer to keep your data stored in an open format
 
+ppl is in an incomplete state right now, and is in active development. Stay
+tuned.
 
-Usage
------
+[![Build Status](https://secure.travis-ci.org/h2s/ppl.png)](http://travis-ci.org/h2s/ppl)
 
-### Add a contact
+Installation
+------------
 
 ```bash
-$ ppl add adam "Adam Brown"
+$ sudo gem install ppl
 ```
 
+Usage
+-----
+
 ### List all contacts
 
 ```bash
-$ ppl list
-fred       Fred Smith   fred.smith@example.org
-dave       Dave Jones   dave.jones@example.org
-joe        Joe Bloggs   joe.bloggs@example.org
+$ ppl ls
+dave: dave@example.org
+fred: fred@example.org
+john: john@example.org
 ```
 
-### Show a single contact
+### Add a contact
+```bash
+$ ppl add paul "Paul Baker"
+```
 
+### Show a contact
 ```bash
 $ ppl show fred
 Fred Smith
-fred.simth@example.org
-    
-Birthday      1980-01-01
-Cellphone     01189998819991197253
-````
-
-### List upcoming birthdays
-
-```bash
-$ ppl birthdays
-fred      Fred Smith 1980-01-01  99 days
-dave      Dave Jones 1980-01-02  100 days
-joe       Joe Bloggs 1980-01-03  101 days
+fred@example.org
 ```
 
 ### Delete a contact
+```bash
+$ ppl rm dave
+```
 
+### Rename a contact
 ```bash
-$ ppl rm workadam
+$ ppl mv dave david
 ```
 
 Roadmap
@@ -61,22 +62,34 @@ Roadmap
 
 Support for the following commands is planned.
 
-### Update a contact
+### Change a contact's email address
 ```bash
-$ ppl set adam --email=adam.brown@example.com
+$ ppl email dave david@example.org
 ```
 
-### Rename a contact
+### Change a contact's name
 ```bash
-$ ppl mv adam workadam
+$ ppl name john "John Smith"
 ```
 
-In a highly optimistic version of the future, I plan to integrate Git.
-Any commands that modify the address book will also commit their changes.
-Then this will be posisble:
+### Change a contact's birthday
 ```bash
-$ ppl sync
-Pulling latest changes from all remotes...
-Pushing local changes to all remotes...
-Done
+$ ppl birthday john 1980-01-01
 ```
+
+Contributing
+------------
+
+Bug reports, fixes, and additional features are encouraged. The project uses
+[Github issues](https://github.com/h2s/ppl/issues) to track bug reports.
+
+If you'd like to contribute code, please just bear in mind that ppl development
+is test-driven and attempts to follow the "Object Mentor school of clean code"
+as described in the book [Clean
+Code](http://books.google.co.uk/books?id=_i6bDeoCQzsC).
+
+License
+-------
+
+ppl is licensed under the GNU GENERAL PUBLIC LICENSE Version 2.
+

data/bin/ppl

@@ -5,12 +5,13 @@ require "pathname"
 bin_file = Pathname.new(__FILE__).realpath
 $:.unshift File.expand_path("../../lib", bin_file)
 
-require "ppl/cli"
+require "ppl"
 
-class String
-    alias_method :each, :each_line
-end
+bootstrap = Ppl::Application::Bootstrap.new
+input  = bootstrap.input
+output = bootstrap.output
+shell  = bootstrap.shell
+
+exit(shell.run(input, output))
 
-cli = Ppl::CLI.new
-cli.run ARGV
 

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

@@ -0,0 +1,40 @@
+
+class Ppl::Adapter::Storage::Disk < Ppl::Adapter::Storage
+
+  attr_accessor :path
+  attr_accessor :vcard_adapter
+
+  def initialize(path)
+    @path = path
+  end
+
+  def load_address_book
+    address_book = Ppl::Entity::AddressBook.new
+
+    pattern   = File.join @path, "*.vcf"
+    filenames = Dir.glob pattern
+
+    filenames.each do |filename|
+      contact_id = File.basename(filename).slice(0..-5)
+      contact    = load_contact(contact_id)
+      address_book.add_contact(contact)
+    end
+
+    return address_book
+  end
+
+  def load_contact(id)
+    filename = File.join @path, id + ".vcf"
+    contact  = nil
+    if File.exists?(filename)
+      vcard   = File.read filename
+      contact = @vcard_adapter.decode(vcard)
+      if !contact.nil? && contact.is_a?(Ppl::Entity::Contact)
+        contact.id = id
+      end
+    end
+    return contact
+  end
+
+end
+

data/lib/ppl/adapter/storage.rb

@@ -0,0 +1,28 @@
+
+class Ppl::Adapter::Storage
+
+  def delete_contact(contact)
+    raise NotImplementedError
+  end
+
+  def load_address_book
+    raise NotImplementedError
+  end
+
+  def load_contact(id)
+    raise NotImplementedError
+  end
+
+  def require_contact(id)
+    contact = load_contact(id)
+    if contact.nil?
+      raise Ppl::Error::ContactNotFound, id
+    end
+  end
+
+  def save_contact(contact)
+    raise NotImplementedError
+  end
+
+end
+

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

@@ -0,0 +1,45 @@
+
+require "vpim/vcard"
+
+class Ppl::Adapter::Vcard::Vpim
+
+  def encode(contact)
+    vcard = Vpim::Vcard::Maker.make2 do |maker|
+
+      if !contact.birthday.nil?
+        maker.birthday = contact.birthday
+      end
+
+      maker.add_name do |name|
+        name.given    = contact.id   unless contact.id.nil?
+        name.fullname = contact.name unless contact.name.nil?
+      end
+    end
+
+    return vcard.to_s
+  end
+
+  def decode(string)
+    vcard   = Vpim::Vcard.decode(string).first
+    contact = Ppl::Entity::Contact.new
+
+    if !vcard.birthday.nil?
+      contact.birthday = vcard.birthday
+    end
+
+    vcard.emails.each do |email|
+      contact.email_address = email.to_s
+    end
+
+    name = nil
+    name = vcard.name
+
+    if !name.nil?
+      contact.name = name.fullname
+    end
+
+    return contact
+  end
+
+end
+

data/lib/ppl/adapter/vcard.rb

@@ -0,0 +1,13 @@
+
+class Ppl::Adapter::Vcard
+
+  def encode(contact)
+    raise NotImplementedError
+  end
+
+  def decode(string)
+    raise NotImplementedError
+  end
+
+end
+

data/lib/ppl/application/bootstrap.rb

@@ -0,0 +1,62 @@
+
+class Ppl::Application::Bootstrap
+
+  def commands
+    commands = [
+      Ppl::Command::CommandList.new,
+      Ppl::Command::ContactAdd.new,
+      Ppl::Command::ContactDelete.new,
+      Ppl::Command::ContactList.new,
+      Ppl::Command::ContactRename.new,
+      Ppl::Command::ContactShow.new,
+    ]
+    commands.each do |command|
+      command.storage = storage_adapter
+    end
+    return commands
+  end
+
+  def command_suite
+    suite = Ppl::Application::CommandSuite.new
+    commands.each do |command|
+      suite.add_command(command)
+    end
+    suite.find_command("help").command_suite = suite
+    return suite
+  end
+
+  def input
+    input = Ppl::Application::Input.new(ARGV.dup)
+    return input
+  end
+
+  def output
+    output = Ppl::Application::Output.new($stdout, $stderr)
+    return output
+  end
+
+  def router
+    router = Ppl::Application::Router.new(command_suite)
+    router.default = "help"
+    return router
+  end
+
+  def shell
+    shell = Ppl::Application::Shell.new
+    shell.router = router
+    return shell
+  end
+
+  def storage_adapter
+    storage = Ppl::Adapter::Storage::Disk.new(Dir.pwd)
+    storage.vcard_adapter = vcard_adapter
+    return storage
+  end
+
+  def vcard_adapter
+    vcard = Ppl::Adapter::Vcard::Vpim.new
+    return vcard
+  end
+
+end
+

data/lib/ppl/application/command.rb

@@ -0,0 +1,13 @@
+
+class Ppl::Application::Command
+
+  attr_accessor :name
+  attr_accessor :description
+  attr_accessor :storage
+
+  def execute(input, output)
+    raise NotImplementedError
+  end
+
+end
+

data/lib/ppl/application/command_suite.rb

@@ -0,0 +1,25 @@
+
+require "enumerator"
+
+class Ppl::Application::CommandSuite
+
+  include Enumerable
+
+  def initialize
+    @commands = []
+  end
+
+  def add_command(command)
+    @commands.push command
+  end
+
+  def each
+    @commands.each { |command| yield command }
+  end
+
+  def find_command(name)
+    @commands.select { |command| command.name == name }.first
+  end
+
+end
+

data/lib/ppl/application/input.rb

@@ -0,0 +1,13 @@
+
+class Ppl::Application::Input
+
+  attr_accessor :arguments
+  attr_accessor :options
+
+  def initialize(arguments=[])
+    @arguments = arguments
+    @options   = {}
+  end
+
+end
+

data/lib/ppl/application/output.rb

@@ -0,0 +1,21 @@
+
+class Ppl::Application::Output
+
+  attr_accessor :stdout
+  attr_accessor :stderr
+
+  def initialize(stdout, stderr)
+    @stdout = stdout
+    @stderr = stderr
+  end
+
+  def error(string)
+    @stderr.puts string
+  end
+
+  def line(string)
+    @stdout.puts string
+  end
+
+end
+

data/lib/ppl/application/router.rb

@@ -0,0 +1,19 @@
+
+class Ppl::Application::Router
+
+  attr_accessor :default
+
+  def initialize(command_suite)
+    @command_suite = command_suite
+  end
+
+  def route(argument)
+    command = @command_suite.find_command(argument)
+    if command.nil? && !@default.nil?
+      command = @command_suite.find_command(@default)
+    end
+    return command
+  end
+
+end
+

data/lib/ppl/application/shell.rb

@@ -0,0 +1,34 @@
+
+class Ppl::Application::Shell
+
+  attr_writer :router
+
+  def run(input, output)
+    outcome = false
+    begin
+      command = select_command(input)
+      outcome = execute_command(command, input, output)
+    rescue
+      output.error("ppl: " + $!.message)
+      outcome = false
+    end
+    return outcome
+  end
+
+
+  private
+
+  def select_command(input)
+    @router.route(input.arguments.shift)
+  end
+
+  def execute_command(command, input, output)
+    outcome = false
+    if !command.nil?
+      outcome = command.execute(input, output)
+    end
+    return outcome
+  end
+
+end
+

data/lib/ppl/command/command_list.rb

@@ -0,0 +1,21 @@
+
+class Ppl::Command::CommandList < Ppl::Application::Command
+
+  attr_accessor :command_suite
+
+  def initialize
+    @name        = "help"
+    @description = "Show a list of commands"
+  end
+
+  def execute(input, output)
+    @command_suite.each do |command|
+      name        = command.name
+      description = command.description
+      output.line("#{name}: #{description}")
+    end
+    return true
+  end
+
+end
+

data/lib/ppl/command/contact_add.rb

@@ -0,0 +1,26 @@
+
+class Ppl::Command::ContactAdd < Ppl::Application::Command
+
+  def initialize
+    @name        = "add"
+    @description = "Add a new contact"
+  end
+
+  def execute(input, output)
+    contact_id   = input.arguments.shift
+    contact_name = input.arguments.shift
+
+    if contact_id.nil? || contact_name.nil?
+      raise Ppl::Error::IncorrectUsage
+    end
+
+    contact = Ppl::Entity::Contact.new
+    contact.id = contact_id
+    contact.name = contact_name
+
+    @storage.save_contact(contact)
+    return true
+  end
+
+end
+

data/lib/ppl/command/contact_delete.rb

@@ -0,0 +1,16 @@
+
+class Ppl::Command::ContactDelete < Ppl::Application::Command
+
+  def initialize
+    @name        = "rm"
+    @description = "Delete a contact"
+  end
+
+  def execute(input, output)
+    contact_id = input.arguments.first
+    contact    = @storage.require_contact(contact_id)
+    @storage.delete_contact(contact)
+  end
+
+end
+

data/lib/ppl/command/contact_list.rb

@@ -0,0 +1,24 @@
+
+class Ppl::Command::ContactList < Ppl::Application::Command
+
+  def initialize
+    @name        = "ls"
+    @description = "List all contacts"
+  end
+
+  def execute(input, output)
+    address_book = @storage.load_address_book
+
+    address_book.each do |contact|
+      line = sprintf("%s: %s",
+        contact.id,
+        contact.email_address
+      )
+      output.line(line)
+    end
+
+    return true
+  end
+
+end
+

data/lib/ppl/command/contact_rename.rb

@@ -0,0 +1,23 @@
+
+class Ppl::Command::ContactRename < Ppl::Application::Command
+
+  def initialize
+    @name        = "mv"
+    @description = "Rename a contact"
+  end
+
+  def execute(input, output)
+    old_id  = input.arguments.shift
+    new_id  = input.arguments.shift
+    contact = @storage.require_contact(old_id)
+
+    @storage.delete_contact(contact)
+
+    contact.id = new_id
+    @storage.save_contact(contact)
+
+    return true
+  end
+
+end
+

data/lib/ppl/command/contact_show.rb

@@ -0,0 +1,20 @@
+
+class Ppl::Command::ContactShow < Ppl::Application::Command
+
+  def initialize
+    @name        = "show"
+    @description = "Display the full details of a contact"
+  end
+
+  def execute(input, output)
+    contact_id  = input.arguments.shift
+    contact     = @storage.require_contact(contact_id)
+
+    output.line(contact.name)
+    output.line(contact.email_address)
+
+    return true
+  end
+
+end
+

data/lib/ppl/entity/address_book.rb

@@ -0,0 +1,21 @@
+
+require "enumerator"
+
+class Ppl::Entity::AddressBook
+
+  include Enumerable
+
+  def initialize
+    @contacts = []
+  end
+
+  def add_contact(contact)
+    @contacts.push contact
+  end
+
+  def each
+    @contacts.each { |contact| yield contact }
+  end
+
+end
+