ppl 0.3.0 → 0.9.0

data/.gitignore

@@ -1,2 +1,3 @@
 tmp
+_site
 

data/Gemfile

@@ -1,6 +1,8 @@
 
 source :rubygems
 
+gem "inifile", "2.0.2"
+gem "rugged", "0.17.0.b6"
 gem "vpim", "12.1.12", :git => "git://github.com/sam-github/vpim.git"
 
 group :test do

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
   specs:
     diff-lcs (1.1.3)
     fakefs (0.4.1)
+    inifile (2.0.2)
     rake (10.0.1)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
@@ -18,12 +19,15 @@ GEM
     rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)
+    rugged (0.17.0.b6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   fakefs
+  inifile (= 2.0.2)
   rake
   rspec
+  rugged (= 0.17.0.b6)
   vpim (= 12.1.12)!

data/README.md

@@ -127,9 +127,7 @@ 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).
+is test-driven.
 
 License
 -------

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

@@ -1,17 +1,26 @@
 
+require "fileutils"
+
 class Ppl::Adapter::Storage::Disk < Ppl::Adapter::Storage
 
-  attr_accessor :path
+  attr_accessor :directory
   attr_accessor :vcard_adapter
 
-  def initialize(path)
-    @path = path
+  def self.create_address_book(path)
+    if !Dir.exists? path
+      FileUtils.mkdir_p(path)
+    end
+    storage = self.new(path)
+  end
+
+  def initialize(directory)
+    @directory = directory
   end
 
   def load_address_book
     address_book = Ppl::Entity::AddressBook.new
 
-    pattern   = File.join @path, "*.vcf"
+    pattern   = File.join @directory.path, "*.vcf"
     filenames = Dir.glob pattern
 
     filenames.each do |filename|
@@ -24,7 +33,7 @@ class Ppl::Adapter::Storage::Disk < Ppl::Adapter::Storage
   end
 
   def load_contact(id)
-    filename = File.join @path, id + ".vcf"
+    filename = filename_for_contact_id(id)
     contact  = nil
     if File.exists?(filename)
       vcard   = File.read filename
@@ -39,12 +48,23 @@ class Ppl::Adapter::Storage::Disk < Ppl::Adapter::Storage
   def save_contact(contact)
     vcard = @vcard_adapter.encode(contact)
 
-    basename = contact.id +  ".vcf"
-    filename = File.join @path, basename
+    filename = filename_for_contact(contact)
     File.open(filename, "w") do |file|
       file.write(vcard)
     end
   end
 
+  def delete_contact(contact)
+    File.unlink filename_for_contact(contact)
+  end
+
+  def filename_for_contact(contact)
+    filename_for_contact_id(contact.id)
+  end
+
+  def filename_for_contact_id(id)
+    File.join(@directory.path, id + ".vcf")
+  end
+
 end
 

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

@@ -0,0 +1,26 @@
+
+class Ppl::Adapter::Storage::Factory
+
+  def initialize(vcard_adapter)
+    @vcard_adapter = vcard_adapter
+  end
+
+  def load_adapter(directory)
+    git_dir = File.join(directory.path, ".git")
+
+    disk_adapter = Ppl::Adapter::Storage::Disk.new(directory)
+    disk_adapter.vcard_adapter = @vcard_adapter
+
+    adapter = disk_adapter
+
+    if File.exists?(git_dir)
+      git_adapter = Ppl::Adapter::Storage::Git.new(disk_adapter)
+      git_adapter.vcard_adapter = @vcard_adapter
+      adapter = git_adapter
+    end
+
+    return adapter
+  end
+
+end
+

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

@@ -0,0 +1,101 @@
+
+require "rugged"
+require "socket"
+
+class Ppl::Adapter::Storage::Git < Ppl::Adapter::Storage
+
+  attr_accessor :disk
+  attr_accessor :repository
+  attr_accessor :vcard_adapter
+
+  def initialize(disk)
+    @disk = disk
+    @repository = Rugged::Repository.new(@disk.directory.path)
+  end
+
+  def self.create_address_book(path)
+    disk = Ppl::Adapter::Storage::Disk.create_address_book(path)
+    repo = Rugged::Repository.init_at(path, false)
+  end
+
+  def load_address_book
+    address_book = Ppl::Entity::AddressBook.new
+
+    head = @repository.lookup(@repository.head.target)
+    head.tree.each do |file|
+      extension = file[:name].slice(-4..-1)
+      if extension != ".vcf"
+        next
+      end
+      contact_id = file[:name].slice(0..-5)
+      contact    = load_contact(contact_id)
+      address_book.add_contact(contact)
+    end
+
+    return address_book
+  end
+
+  def load_contact(id)
+    filename = id + ".vcf"
+    target   = @repository.head.target
+    vcard    = @repository.file_at(target, filename)
+    contact  = nil
+
+    if !vcard.nil?
+      contact    = @vcard_adapter.decode(vcard)
+      contact.id = id
+    end
+
+    return contact
+  end
+
+  def save_contact(contact)
+    @disk.save_contact(contact)
+
+    add("#{contact.id}.vcf")
+    commit("save_contact(#{contact.id})")
+  end
+
+  def delete_contact(contact)
+    @repository.index.remove("#{contact.id}.vcf")
+    @repository.index.write
+    commit("remove_contact(#{contact.id})")
+    @disk.delete_contact(contact)
+  end
+
+  private
+
+  def add(file)
+    @repository.index.add(file)
+    @repository.index.write
+  end
+
+  def commit(message)
+    hash    = @repository.index.write_tree
+    tree    = @repository.lookup hash
+    parents = [ @repository.lookup( @repository.head.target ).oid ]
+
+    name = ENV['USER']
+    host = Socket.gethostname
+
+    author = {
+      :email => name + "@" + host,
+      :time  => Time.now,
+      :name  => name,
+    }
+
+    data = {
+      :author     => author,
+      :message    => message,
+      :committer  => author,
+      :tree       => tree,
+      :parents    => parents,
+      :update_ref => "HEAD",
+    }
+
+    Rugged::Commit.create(@repository, data)
+    true
+  end
+
+end
+

data/lib/ppl/adapter/storage.rb

@@ -1,6 +1,10 @@
 
 class Ppl::Adapter::Storage
 
+  def self.create_address_book(path)
+    raise NotImplementedError
+  end
+
   def delete_contact(contact)
     raise NotImplementedError
   end

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

@@ -19,6 +19,14 @@ class Ppl::Adapter::Vcard::Vpim
         maker.add_email(contact.email_address)
       end
 
+      if !contact.phone_number.nil?
+        maker.add_tel(contact.phone_number)
+      end
+
+      if !contact.organization.nil?
+        maker.org=(contact.organization)
+      end
+
     end
 
     return vcard.to_s
@@ -36,6 +44,14 @@ class Ppl::Adapter::Vcard::Vpim
       contact.email_address = email.to_s
     end
 
+    if !vcard.telephones.empty?
+      contact.phone_number = vcard.telephones.first
+    end
+
+    if !vcard.org.nil?
+      contact.organization = vcard.org.first
+    end
+
     name = nil
     name = vcard.name
 

data/lib/ppl/application/bootstrap.rb

@@ -3,15 +3,18 @@ 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,
-      Ppl::Command::SetBirthday.new,
-      Ppl::Command::SetEmail.new,
-      Ppl::Command::SetName.new,
+      Ppl::Command::Init.new,
+      Ppl::Command::Bday.new,
+      Ppl::Command::Help.new,
+      Ppl::Command::Add.new,
+      Ppl::Command::Rm.new,
+      Ppl::Command::Ls.new,
+      Ppl::Command::Mv.new,
+      Ppl::Command::Show.new,
+      Ppl::Command::Name.new,
+      Ppl::Command::Email.new,
+      Ppl::Command::Org.new,
+      Ppl::Command::Phone.new,
     ]
     commands.each do |command|
       command.storage = storage_adapter
@@ -28,6 +31,11 @@ class Ppl::Application::Bootstrap
     return suite
   end
 
+  def configuration
+    config = Ppl::Application::Configuration.new
+    return config
+  end
+
   def input
     input = Ppl::Application::Input.new(ARGV.dup)
     return input
@@ -51,7 +59,12 @@ class Ppl::Application::Bootstrap
   end
 
   def storage_adapter
-    storage = Ppl::Adapter::Storage::Disk.new(Dir.pwd)
+    config = configuration
+
+    directory = Dir.new(config.address_book_path)
+    factory   = Ppl::Adapter::Storage::Factory.new(vcard_adapter)
+    storage   = factory.load_adapter(directory)
+
     storage.vcard_adapter = vcard_adapter
     return storage
   end

data/lib/ppl/application/command.rb

@@ -9,5 +9,8 @@ class Ppl::Application::Command
     raise NotImplementedError
   end
 
+  def options(parser, options)
+  end
+
 end
 

data/lib/ppl/application/command_suite.rb

@@ -20,6 +20,14 @@ class Ppl::Application::CommandSuite
   def find_command(name)
     @commands.select { |command| command.name == name }.first
   end
+  
+  def sort_by_name
+    @commands.sort! { |a, b| a.name <=> b.name }
+  end
+
+  def [](index)
+    @commands[index]
+  end
 
 end
 

data/lib/ppl/application/configuration.rb

@@ -0,0 +1,50 @@
+
+require "inifile"
+
+class Ppl::Application::Configuration
+
+  USER_CONFIG = "~/.pplconfig"
+  REPO_CONFIG = "./.ppl/config"
+
+  def address_book_path
+    default_config = default_configuration
+    user_config    = user_configuration
+
+    path = default_config["address book"]["path"]
+    if !user_config["address book"].nil? && !user_config["address book"]["path"].nil?
+      path = File.expand_path(user_config["address book"]["path"])
+    end
+
+    return path
+  end
+
+  def aliases
+    aliases = {}
+    return aliases
+  end
+
+  private
+
+  def default_configuration
+    {
+      "address book" => {
+        "path" => Dir.pwd
+      },
+    }
+  end
+
+  def user_configuration
+    filename = File.expand_path(USER_CONFIG)
+    config   = {}
+    if File.exists?(filename)
+      config = IniFile::load(filename).to_h
+    end
+    return config
+  end
+
+  def repository_configuration
+    {}
+  end
+
+end
+

data/lib/ppl/application/output.rb

@@ -15,6 +15,7 @@ class Ppl::Application::Output
 
   def line(string)
     @stdout.puts string
+    true
   end
 
 end

data/lib/ppl/application/shell.rb

@@ -1,4 +1,6 @@
 
+require "optparse"
+
 class Ppl::Application::Shell
 
   attr_writer :router
@@ -7,7 +9,17 @@ class Ppl::Application::Shell
     outcome = false
     begin
       command = select_command(input)
+      prepare_command(command, input)
       outcome = execute_command(command, input, output)
+    rescue OptionParser::InvalidOption
+      output.error($!)
+      output.error(@optparse.to_s)
+    rescue OptionParser::MissingArgument
+      output.error($!)
+      output.error(@optparse.to_s)
+    rescue Ppl::Error::IncorrectUsage
+      output.error($!)
+      output.error(@optparse.to_s)
     rescue
       output.error("ppl: " + $!.message)
       outcome = false
@@ -22,6 +34,15 @@ class Ppl::Application::Shell
     @router.route(input.arguments.shift)
   end
 
+  def prepare_command(command, input)
+    if !command.nil?
+      @optparse = OptionParser.new do |parser|
+        command.options(parser, input.options)
+      end
+      @optparse.parse!(input.arguments)
+    end
+  end
+
   def execute_command(command, input, output)
     outcome = false
     if !command.nil?

data/lib/ppl/command/add.rb

@@ -0,0 +1,34 @@
+
+class Ppl::Command::Add < Ppl::Application::Command
+
+  def initialize
+    @name        = "add"
+    @description = "Add a new contact"
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: ppl add <contact> <name>"
+  end
+
+  def execute(input, output)
+    contact_id   = input.arguments.shift
+    contact_name = input.arguments.shift
+
+    if contact_id.nil?
+      raise Ppl::Error::IncorrectUsage, "No contact specified"
+    end
+
+    if contact_name.nil?
+      raise Ppl::Error::IncorrectUsage, "No name specified"
+    end
+
+    contact = Ppl::Entity::Contact.new
+    contact.id = contact_id.dup
+    contact.name = contact_name.dup
+
+    @storage.save_contact(contact)
+    return true
+  end
+
+end
+

data/lib/ppl/command/bday.rb

@@ -0,0 +1,72 @@
+
+class Ppl::Command::Bday < Ppl::Application::Command
+
+  attr_writer :list_format
+  attr_writer :show_format
+
+  def initialize
+    @name        = "bday"
+    @description = "List, show or change birthdays"
+    @list_format = Ppl::Format::AddressBook::Birthdays.new
+    @show_format = Ppl::Format::Contact::Birthday.new
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: ppl birthday <contact> [<date>]"
+  end
+
+  def execute(input, output)
+    action = determine_action(input)
+    send(action, input, output)
+  end
+
+
+  private
+
+  def determine_action(input)
+    if input.arguments[0].nil?
+      :list_birthdays
+    elsif input.arguments[1].nil?
+      :show_birthday
+    else
+      :set_birthday
+    end
+  end
+
+  def list_birthdays(input, output)
+    address_book  = @storage.load_address_book
+    birthday_list = @list_format.process(address_book)
+    output.line(birthday_list)
+  end
+
+  def show_birthday(input, output)
+    contact_id = input.arguments.shift
+    if contact_id.nil?
+      raise Ppl::Error::IncorrectUsage, "No contact specified"
+    end
+    contact = @storage.require_contact(contact_id)
+
+    line = @show_format.process(contact)
+    output.line(line)
+  end
+
+  def set_birthday(input, output)
+    contact_id = input.arguments.shift
+    birthday   = input.arguments.shift
+
+    if contact_id.nil?
+      raise Ppl::Error::IncorrectUsage, "No contact specified"
+    end
+    contact = @storage.require_contact(contact_id)
+
+    begin
+      date = Date.parse birthday
+    rescue ArgumentError
+      raise Ppl::Error::IncorrectUsage, "Invalid date '#{birthday}'"
+    end
+    contact.birthday = date
+    @storage.save_contact(contact)
+  end
+
+end
+

data/lib/ppl/command/email.rb

@@ -0,0 +1,55 @@
+
+class Ppl::Command::Email < Ppl::Application::Command
+
+  attr_writer :show_format
+  attr_writer :list_format
+
+  def initialize
+    @name        = "email"
+    @description = "Show or change a contact's email address"
+    @show_format = Ppl::Format::Contact::EmailAddress.new
+    @list_format = Ppl::Format::AddressBook::EmailAddresses.new
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: ppl email <contact> [<email-address>]"
+  end
+
+  def execute(input, output)
+    action = determine_action(input)
+    send(action, input, output)
+  end
+
+
+  private
+
+  def determine_action(input)
+    if input.arguments[0].nil?
+      :list_email_addresses
+    elsif input.arguments[1].nil?
+      :show_email_address
+    else
+      :set_email_address
+    end
+  end
+
+  def list_email_addresses(input, output)
+    address_book = @storage.load_address_book
+    email_list   = @list_format.process(address_book)
+    output.line(email_list)
+  end
+
+  def show_email_address(input, output)
+    contact       = @storage.require_contact(input.arguments[0])
+    email_address = @show_format.process(contact)
+    output.line(email_address)
+  end
+
+  def set_email_address(input, output)
+    contact = @storage.require_contact(input.arguments[0])
+    contact.email_address = input.arguments[1].dup
+    @storage.save_contact(contact)
+  end
+
+end
+

data/lib/ppl/command/help.rb

@@ -0,0 +1,43 @@
+
+class Ppl::Command::Help < Ppl::Application::Command
+
+  attr_accessor :command_suite
+
+  def initialize
+    @name        = "help"
+    @description = "Show a list of commands"
+  end
+
+  def execute(input, output)
+    @command_suite.sort_by_name
+    max_name_length = 0
+
+    @command_suite.each do |command|
+      name_length = command.name.length
+      if name_length > max_name_length
+        max_name_length = name_length
+      end
+    end
+
+    output.line("usage: ppl <command>")
+    output.line(nil)
+
+    @command_suite.each do |command|
+      name        = command.name
+      description = command.description
+
+      if @name == name
+        next
+      end
+
+      line = sprintf("   %-#{max_name_length}s   %s", name, description)
+
+      output.line(line)
+    end
+
+    output.line(nil)
+    return true
+  end
+
+end
+

data/lib/ppl/command/init.rb

@@ -0,0 +1,26 @@
+
+class Ppl::Command::Init < Ppl::Application::Command
+
+  def initialize
+    @name        = "init"
+    @description = "Create an empty address book"
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: ppl init [directory]"
+  end
+
+  def execute(input, output)
+
+    path = input.arguments.shift
+    if path.nil?
+      path = Dir.pwd
+    end
+
+    storage = Ppl::Adapter::Storage::Git.create_address_book(path)
+
+    return true
+  end
+
+end
+