ppl 0.0.2 → 0.0.4

data/Gemfile

@@ -1,4 +1,6 @@
 
+gem 'active_support'
+
 gem "colored", "~> 1.2"
 
 gem "vpim", "12.1.12", :git => "git://github.com/sam-github/vpim.git"

data/README.md

@@ -1,6 +1,6 @@
      _____  _____  __
     |  _  ||  _  ||  |
-    |   __||   __||  |
+    |   __||   __||  |__
     |__|   |__|   |_____|
 
 
@@ -11,23 +11,70 @@ 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
 
-The Plan
---------
 
-ppl's command-line interface is based on those of Git and Heroku. For example:
+Usage
+-----
 
+### List all contacts
 
-    $ ppl list
-    fred       Fred Smith   fred.smith@example.org
-    dave       Dave Jones   dave.jones@example.org
-    joe        Joe Bloggs   joe.bloggs@example.org
+```bash
+$ ppl list
+fred       Fred Smith   fred.smith@example.org
+dave       Dave Jones   dave.jones@example.org
+joe        Joe Bloggs   joe.bloggs@example.org
+```
 
-Or...
+### Show a single contact
 
-    $ ppl show fred
-    Fred Smith
-    fred.simth@example.org
+```bash
+$ ppl show fred
+Fred Smith
+fred.simth@example.org
     
-    Birthday      1980-01-01
-    Cellphone     01189998819991197253
+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
+```
+
+Roadmap
+-------
+
+Support for the following commands is planned.
+
+### Add a contact
+```bash
+$ ppl add adam --email=adam.brown@example.org --birthday=1980-01-04
+```
+
+### Update a contact
+```bash
+$ ppl set adam --email=adam.brown@example.com
+```
+
+### Rename a contact
+```bash
+$ ppl mv adam workadam
+```
+
+### Delete a contact
+```bash
+$ ppl rm workadam
+```
+
+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:
+```bash
+$ ppl sync
+Pulling latest changes from all remotes...
+Pushing local changes to all remotes...
+Done
+```

data/lib/ppl/address_book.rb

@@ -0,0 +1,42 @@
+
+require "vpim/vcard"
+require "enumerator"
+
+class Ppl::Address_Book
+
+  include Enumerable
+
+  def initialize(path)
+    @path = path
+  end
+
+  def contact(id)
+    filename = File.join @path, id + ".vcard"
+    vcard    = IO.read filename
+    vcard    = Vpim::Vcard.decode(vcard).first
+    contact  = Ppl::Contact.new(id, vcard)
+  end
+
+  def contacts
+    pattern   = File.join @path, "*.vcard"
+    filenames = Dir.glob pattern
+    contacts  = []
+
+    filenames.each do |filename|
+      id = File.basename(filename).slice(0..-7)
+      contacts.push self.contact(id);
+    end
+    contacts
+
+  end
+
+  def each
+    self.contacts.each { |c| yield c }
+  end
+
+  def with_birthday
+    self.find_all { |contact| contact.birthday.nil? == false }
+  end
+
+end
+

data/lib/ppl/cli.rb

@@ -5,7 +5,13 @@ require "ppl/command"
 class Ppl::CLI
 
   def self.start(*args)
-    command = args.shift.strip
+
+    command = args.shift
+    if command
+      command = command.strip
+    else
+      command = "help"
+    end
 
     Ppl::Command.load
     Ppl::Command.run(command, args)

data/lib/ppl/command/base.rb

@@ -1,4 +1,8 @@
 
+require "vpim/vcard"
+require "colored"
+
+
 class Ppl::Command::Base
 
 
@@ -9,8 +13,17 @@ class Ppl::Command::Base
   def initialize(arguments=[], options={})
     @arguments = arguments
     @options   = options
+
+    @address_book = Ppl::Address_Book.new(@options[:path])
+  end
+
+
+  def name
   end
 
 
+  def summary
+  end
+
 end
 

data/lib/ppl/command/birthdays.rb

@@ -0,0 +1,27 @@
+
+class Ppl::Command::Birthdays < Ppl::Command::Base
+
+  def name
+    "birthdays"
+  end
+
+  def summary
+    "Show a list of upcoming birthdays"
+  end
+
+  def index
+    today = Date.today
+
+    @address_book.with_birthday.each do |contact|
+      puts(
+        sprintf("%-20s", contact.id)       +
+        sprintf("%-20s", contact.name)     +
+        sprintf("%-20s", contact.birthday) +
+        sprintf("%d days", contact.until_birthday(today))
+      )
+    end
+
+  end
+
+end
+

data/lib/ppl/command/help.rb

@@ -0,0 +1,29 @@
+
+class Ppl::Command::Help < Ppl::Command::Base
+
+  def name
+    "help"
+  end
+
+  def summary
+    "Show a list of available commands"
+  end
+
+  def index
+
+    puts
+    Ppl::Command.constants.each do |constant|
+      if constant.to_s != "Base"
+        command = Ppl::Command.const_get(constant).new(@arguments, @options)
+        puts(
+          sprintf(" %-10s", command.name) +
+          sprintf("%s", command.summary)
+        )
+      end
+    end
+    puts
+
+  end
+
+end
+

data/lib/ppl/command/list.rb

@@ -1,29 +1,22 @@
 
-require "vpim/vcard"
-require "colored"
-
 class Ppl::Command::List < Ppl::Command::Base
 
-  def index
-
-    pattern  = @options[:path] + "/*.vcard"
-    contacts = Dir.glob pattern
-
-    contacts.each do |filename|
-
-      id = File.basename(filename).slice(0..-7)
+  def name
+    "list"
+  end
 
-      vcard = IO.read filename
-      vcard = Vpim::Vcard.decode(vcard).first
+  def summary
+    "Show a list of all contacts"
+  end
 
+  def index
+    @address_book.each do |contact|
       puts(
-        sprintf("%-20s", id).red +
-        sprintf("%-20s", vcard.name.fullname).yellow +
-        sprintf("%-20s", vcard.email).blue
+        sprintf("%-20s", contact.id).red +
+        sprintf("%-20s", contact.name).yellow +
+        sprintf("%-20s", contact.email).blue
       )
-
     end
-
   end
 
 end

data/lib/ppl/command/show.rb

@@ -0,0 +1,25 @@
+
+require "ppl/command/base"
+
+class Ppl::Command::Show < Ppl::Command::Base
+
+  def name
+    "show"
+  end
+
+  def summary
+    "Show full details of a single contact"
+  end
+
+  def index
+    contact = @address_book.contact @arguments.first
+
+    puts contact.name.yellow
+    contact.emails.each do |email|
+      puts email.blue
+    end
+
+  end
+
+end
+

data/lib/ppl/command.rb

@@ -14,7 +14,10 @@ module Ppl
         :path => "/home/h2s/doc/contacts"
       }
 
+      klass = command.capitalize
+
       command = Ppl::Command::List.new(arguments, options)
+      command = Ppl::Command.const_get(klass).new(arguments, options)
       command.send("index")
     end
 

data/lib/ppl/contact.rb

@@ -0,0 +1,38 @@
+
+require "active_support/core_ext/time/calculations.rb"
+
+class Ppl::Contact
+
+  attr_reader :id
+
+  def initialize(id, vcard)
+    @id    = id
+    @vcard = vcard
+  end
+
+  def birthday
+    @vcard.birthday
+  end
+
+  def until_birthday(now)
+    birthday = self.birthday.dup
+    while birthday < now
+      birthday = birthday.advance :years => 1
+    end
+    birthday - now
+  end
+
+  def email
+    @vcard.emails.first
+  end
+
+  def emails
+    @vcard.emails
+  end
+
+  def name
+    @vcard.name.fullname
+  end
+
+end
+

data/lib/ppl.rb

@@ -2,3 +2,6 @@
 module Ppl
 end
 
+require "ppl/address_book"
+require "ppl/contact"
+

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "0.0.2"
-  spec.date        = "2012-11-10"
+  spec.version     = "0.0.4"
+  spec.date        = "2012-11-11"
 
   spec.summary     = "CLI Address Book"
   spec.description = "Command-line driven address book"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies: []
 description: Command-line driven address book
 email: henry@henrysmith.org
@@ -18,17 +18,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- COPYING.txt
+- COPYING
 - Gemfile
 - Gemfile.lock
 - README.md
 - bin/ppl
 - lib/ppl.rb
+- lib/ppl/address_book.rb
 - lib/ppl/cli.rb
 - lib/ppl/command.rb
 - lib/ppl/command/base.rb
+- lib/ppl/command/birthdays.rb
+- lib/ppl/command/help.rb
 - lib/ppl/command/list.rb
 - lib/ppl/command/show.rb
+- lib/ppl/contact.rb
 - lib/ppl/ppl.rb
 - ppl.gemspec
 homepage: https://github.com/h2s/ppl