ppl 1.5.2 → 1.5.3

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

@@ -3,6 +3,15 @@ require "vpim/vcard"
 
 class Ppl::Adapter::Vcard::Vpim
 
+  @@postal_address_property_map = {
+    :street     => :street,
+    :postalcode => :postal_code,
+    :pobox      => :po_box,
+    :country    => :country,
+    :region     => :region,
+    :locality   => :locality,
+  }
+
   def encode(contact)
     vcard = Vpim::Vcard::Maker.make2 do |maker|
       encode_birthday(contact, maker)
@@ -65,23 +74,11 @@ class Ppl::Adapter::Vcard::Vpim
   def encode_postal_address(contact, vcard_maker)
     if !contact.postal_address.nil?
       vcard_maker.add_addr do |address|
-        if !contact.postal_address.street.nil?
-          address.street = contact.postal_address.street
-        end
-        if !contact.postal_address.postal_code.nil?
-          address.postalcode = contact.postal_address.postal_code
-        end
-        if !contact.postal_address.po_box.nil?
-          address.pobox = contact.postal_address.po_box
-        end
-        if !contact.postal_address.country.nil?
-          address.country = contact.postal_address.country
-        end
-        if !contact.postal_address.region.nil?
-          address.region = contact.postal_address.region
-        end
-        if !contact.postal_address.locality.nil?
-          address.locality = contact.postal_address.locality
+        @@postal_address_property_map.each_pair do |vpim_name, ppl_name|
+          value = contact.postal_address.send(ppl_name)
+          if !value.nil?
+            address.send("#{vpim_name.to_s}=", value)
+          end
         end
       end
     end
@@ -112,12 +109,11 @@ class Ppl::Adapter::Vcard::Vpim
   def decode_postal_address(vcard, contact)
     if !vcard.address.nil?
       contact.postal_address             = Ppl::Entity::PostalAddress.new
-      contact.postal_address.street      = vcard.address.street
-      contact.postal_address.postal_code = vcard.address.postalcode
-      contact.postal_address.po_box      = vcard.address.pobox
-      contact.postal_address.locality    = vcard.address.locality
-      contact.postal_address.region      = vcard.address.region
-      contact.postal_address.country     = vcard.address.country
+      @@postal_address_property_map.each_pair do |vpim_name, ppl_name|
+        value  = vcard.address.send(vpim_name)
+        method = "#{ppl_name.to_s}="
+        contact.postal_address.send(method, value)
+      end
     end
   end
 

data/lib/ppl/application/command.rb

@@ -1,8 +1,8 @@
 
 class Ppl::Application::Command
 
-  attr_accessor :name
-  attr_accessor :description
+  @@property_values = {}
+
   attr_accessor :storage
 
   def execute(input, output)
@@ -12,5 +12,47 @@ class Ppl::Application::Command
   def options(parser, options)
   end
 
+  def self.add_property(name)
+    @@property_values[name] = {}
+    self.add_static_property_setter(name)
+    self.add_instance_property_getter(name)
+    self.add_instance_property_setter(name)
+  end
+
+
+  private
+
+  def self.add_static_property_setter(property_name)
+    define_singleton_method(property_name) do |value = nil|
+      if value.nil?
+        @@property_values[property_name][self]
+      else
+        @@property_values[property_name][self] = value
+      end
+    end
+  end
+
+  def self.add_instance_property_getter(property_name)
+    define_method(property_name) do
+      instance_variable = instance_variable_get("@#{property_name}")
+      class_variable    = @@property_values[property_name][self.class]
+      if !instance_variable.nil?
+        instance_variable
+      elsif !class_variable.nil?
+        class_variable
+      end
+    end
+  end
+
+  def self.add_instance_property_setter(property_name)
+    define_method("#{property_name}=") do |value|
+      instance_variable_set("@#{property_name}", value)
+    end
+  end
+
+  add_property :name
+  add_property :description
+
+
 end
 

data/lib/ppl/application/shell.rb

@@ -11,13 +11,9 @@ class Ppl::Application::Shell
       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
+    rescue Ppl::Error::ContactNotFound
+      output.error("ppl: Contact '#{$!}' not found")
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument, Ppl::Error::IncorrectUsage
       output.error($!)
       output.error(@optparse.to_s)
     rescue

data/lib/ppl/command/add.rb

@@ -1,10 +1,8 @@
 
 class Ppl::Command::Add < Ppl::Application::Command
 
-  def initialize
-    @name        = "add"
-    @description = "Add a new contact"
-  end
+  name        "add"
+  description "Add a new contact"
 
   def options(parser, options)
     parser.banner = "usage: ppl add <contact> <name>"

data/lib/ppl/command/bday.rb

@@ -1,12 +1,13 @@
 
 class Ppl::Command::Bday < Ppl::Application::Command
 
+  name        "bday"
+  description "List, show or change birthdays"
+
   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

data/lib/ppl/command/email.rb

@@ -1,12 +1,13 @@
 
 class Ppl::Command::Email < Ppl::Application::Command
 
+  name        "email"
+  description "Show or change a contact's email address"
+
   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::EmailAddresses.new
     @list_format = Ppl::Format::AddressBook::EmailAddresses.new
   end

data/lib/ppl/command/help.rb

@@ -1,12 +1,10 @@
 
 class Ppl::Command::Help < Ppl::Application::Command
 
-  attr_accessor :command_suite
+  name        "help"
+  description "Show a list of commands"
 
-  def initialize
-    @name        = "help"
-    @description = "Show a list of commands"
-  end
+  attr_accessor :command_suite
 
   def execute(input, output)
     @command_suite.sort_by_name
@@ -26,7 +24,7 @@ class Ppl::Command::Help < Ppl::Application::Command
       name        = command.name
       description = command.description
 
-      if @name == name
+      if self.name == name
         next
       end
 

data/lib/ppl/command/init.rb

@@ -1,10 +1,8 @@
 
 class Ppl::Command::Init < Ppl::Application::Command
 
-  def initialize
-    @name        = "init"
-    @description = "Create an empty address book"
-  end
+  name        "init"
+  description "Create an empty address book"
 
   def options(parser, options)
     parser.banner = "usage: ppl init [directory]"

data/lib/ppl/command/ls.rb

@@ -1,12 +1,12 @@
 
 class Ppl::Command::Ls < Ppl::Application::Command
 
+  name        "ls"
+  description "List all contacts"
+
   attr_writer :format
 
   def initialize
-    @name        = "ls"
-    @description = "List all contacts"
-
     @format = Ppl::Format::AddressBook::OneLine.new
   end
 

data/lib/ppl/command/mutt.rb

@@ -1,12 +1,12 @@
 
 class Ppl::Command::Mutt < Ppl::Application::Command
 
+  name        "mutt"
+  description "Integration with mutt's query_command"
+
   attr_writer :format
 
   def initialize
-    @name        = "mutt"
-    @description = "Integration with mutt's query_command"
-
     @format = Ppl::Format::AddressBook::MuttQuery.new
   end
 
@@ -15,43 +15,27 @@ class Ppl::Command::Mutt < Ppl::Application::Command
   end
 
   def execute(input, output)
-    query = input.arguments.shift
-    if query.nil?
-      raise Ppl::Error::IncorrectUsage, "You must provide a query"
-    end
-
-    address_book = @storage.load_address_book
-
-    matches = mutt_search(address_book, query)
-
-    if matches.count > 0
-
-      line = sprintf(
-        "Searching database... %d entries... %d matching:",
-        address_book.count,
-        matches.count
-      )
+    query = require_query(input)
+    matches = mutt_search(query)
+    output.line(describe_result(matches))
+    matches.count > 0
+  end
 
-      results = @format.process(matches)
 
-      output.line(line)
-      output.line(results) unless results == ""
-      true
+  private
 
-    else
-      output.line("No matches")
-      false
+  def require_query(input)
+    if input.arguments.first.nil?
+      raise Ppl::Error::IncorrectUsage, "You must provide a query"
     end
-
+    input.arguments.first
   end
 
-
-  private
-
-  def mutt_search(address_book, query)
+  def mutt_search(query)
+    @address_book = @storage.load_address_book
     matches = Ppl::Entity::AddressBook.new
 
-    address_book.each do |contact|
+    @address_book.each do |contact|
       next if contact.email_addresses.empty?
 
       matching_emails = contact.email_addresses.select do |email_address|
@@ -68,5 +52,23 @@ class Ppl::Command::Mutt < Ppl::Application::Command
     matches
   end
 
+  def describe_result(matches)
+    if matches.count > 0
+      describe_matches(matches)
+    else
+      "No matches"
+    end
+  end
+
+  def describe_matches(matches)
+    summary = sprintf(
+      "Searching address book... %d entries... %d matching:",
+      @address_book.count,
+      matches.count
+    )
+    results = @format.process(matches)
+    [summary, results].join("\n").strip
+  end
+
 end
 

data/lib/ppl/command/mv.rb

@@ -1,10 +1,8 @@
 
 class Ppl::Command::Mv < Ppl::Application::Command
 
-  def initialize
-    @name        = "mv"
-    @description = "Rename a contact"
-  end
+  name        "mv"
+  description "Rename a contact"
 
   def options(parser, options)
     parser.banner = "usage: ppl mv <contact> <new ID>"

data/lib/ppl/command/name.rb

@@ -1,12 +1,13 @@
 
 class Ppl::Command::Name < Ppl::Application::Command
 
+  name        "name"
+  description "List, show or change names"
+
   attr_writer :show_format
   attr_writer :list_format
 
   def initialize
-    @name        = "name"
-    @description = "List, show or change names"
     @show_format = Ppl::Format::Contact::Name.new
     @list_format = Ppl::Format::AddressBook::Names.new
   end

data/lib/ppl/command/org.rb

@@ -1,12 +1,13 @@
 
 class Ppl::Command::Org < Ppl::Application::Command
 
+  name        "org"
+  description "List, show or change organizations"
+
   attr_writer :show_format
   attr_writer :list_format
 
   def initialize
-    @name        = "org"
-    @description = "List, show or change organizations"
     @show_format = Ppl::Format::Contact::Organization.new
     @list_format = Ppl::Format::AddressBook::Organizations.new
   end

data/lib/ppl/command/phone.rb

@@ -1,12 +1,13 @@
 
 class Ppl::Command::Phone < Ppl::Application::Command
 
+  name        "phone"
+  description "List, show or change phone numbers"
+
   attr_writer :show_format
   attr_writer :list_format
 
   def initialize
-    @name        = "phone"
-    @description = "List, show or change phone numbers"
     @show_format = Ppl::Format::Contact::PhoneNumber.new
     @list_format = Ppl::Format::AddressBook::PhoneNumbers.new
   end

data/lib/ppl/command/post.rb

@@ -1,12 +1,13 @@
 
 class Ppl::Command::Post < Ppl::Application::Command
 
+  name        "post"
+  description "List, show or change postal addresses"
+
   attr_writer :show_format
   attr_writer :list_format
 
   def initialize
-    @name        = "post"
-    @description = "List, show or change postal addresses"
     @show_format = Ppl::Format::Contact::PostalAddress.new
     @list_format = Ppl::Format::AddressBook::PostalAddresses.new
   end

data/lib/ppl/command/rm.rb

@@ -1,10 +1,8 @@
 
 class Ppl::Command::Rm < Ppl::Application::Command
 
-  def initialize
-    @name        = "rm"
-    @description = "Delete a contact"
-  end
+  name        "rm"
+  description "Delete a contact"
 
   def options(parser, options)
     parser.banner = "usage: ppl rm <contact>"

data/lib/ppl/command/shell.rb

@@ -3,12 +3,10 @@ require "readline"
 
 class Ppl::Command::Shell < Ppl::Application::Command
 
-  attr_writer :format
+  name        "shell"
+  description "Interactive mode"
 
-  def initialize
-    @name        = "shell"
-    @description = "Interactive mode"
-  end
+  attr_writer :format
 
   def options(parser, options)
     parser.banner = "usage: ppl shell"

data/lib/ppl/command/show.rb

@@ -1,12 +1,12 @@
 
 class Ppl::Command::Show < Ppl::Application::Command
 
+  name        "show"
+  description "Display the full details of a contact"
+
   attr_writer :format
 
   def initialize
-    @name        = "show"
-    @description = "Display the full details of a contact"
-
     @format = Ppl::Format::Contact::Full.new
   end
 

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.5.2"
+  Version = "1.5.3"
 
   module Adapter
   end

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.5.2"
-  spec.date        = "2012-12-23"
+  spec.version     = "1.5.3"
+  spec.date        = "2012-12-26"
 
   spec.required_ruby_version = ">= 1.9.3"
 

data/spec/ppl/application/command_spec.rb

@@ -1,18 +1,91 @@
 
-describe Ppl::Application::Command, "#execute" do
+describe Ppl::Application::Command 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)
+  describe "#execute" do
+    it "should raise not implemented error" do
+      expect{@command.execute(nil, nil)}.to raise_error(NotImplementedError)
+    end
   end
 
-  it "should accept a storage adapter" do
-    storage = double(Ppl::Adapter::Storage)
-    @command.storage = storage
-    @command.storage.should be storage
+  describe "#storage=" do
+    it "should accept a storage adapter" do
+      storage = double(Ppl::Adapter::Storage)
+      @command.storage = storage
+      @command.storage.should be storage
+    end
+  end
+
+  describe "#add_property" do
+    it "should allow new properties to be defined" do
+      class TestCommand123 < Ppl::Application::Command
+        add_property :some_property
+      end
+    end
+
+    it "should allow properties to have values assigned to them" do
+      class TestCommand456 < Ppl::Application::Command
+        add_property :some_property
+        some_property "a value"
+      end
+      TestCommand456.some_property.should eq "a value"
+    end
+
+    it "should expose properties as instance variables too" do
+      class TestCommand789 < Ppl::Application::Command
+        add_property :some_property
+        some_property "a value"
+      end
+      instance = TestCommand789.new
+      instance.some_property.should eq "a value"
+    end
+
+    it "should allow properties to be overwritten by instance variables" do
+      class TestCommand901 < Ppl::Application::Command
+        add_property :some_property
+        some_property "a value"
+      end
+      instance = TestCommand901.new
+      instance.some_property = "different"
+      instance.some_property.should eq "different"
+    end
+  end
+
+  describe "#name=" do
+    it "should allow the name to be set as an instance variable" do
+      @command.name = "testing"
+      @command.name.should eq "testing"
+    end
+  end
+
+  describe "#description=" do
+    it "should allow the description to be set as an instance variable" do
+      @command.description = "testing"
+      @command.description.should eq "testing"
+    end
+  end
+
+  describe "#name" do
+    it "should allow the name to be set as a class variable" do
+      class TestCommand123 < Ppl::Application::Command
+        name "new_for_test"
+      end
+      command = TestCommand123.new
+      command.name.should eq "new_for_test"
+    end
+  end
+
+  describe "#desecription" do
+    it "should allow the description to be set as a class variable" do
+      class TestCommand123 < Ppl::Application::Command
+        description "desc_for_test"
+      end
+      command = TestCommand123.new
+      command.description.should eq "desc_for_test"
+    end
   end
 
 end

data/spec/ppl/application/shell_spec.rb

@@ -71,9 +71,15 @@ describe Ppl::Application::Shell do
       @command.should_receive(:options)
       @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
 
+    it "should handle ContactNotFound errors nicely" do
+      @command.stub(:options)
+      @command.should_receive(:execute) { raise Ppl::Error::ContactNotFound, "example" }
+      @router.should_receive(:route).and_return(@command)
+      @output.should_receive(:error).with("ppl: Contact 'example' not found")
       @shell.run(@input, @output)
     end
 

data/spec/ppl/command/mutt_spec.rb

@@ -26,9 +26,8 @@ describe Ppl::Command::Mutt do
     end
 
     it "should search the address book for the query" do
-      @storage.should_receive(:load_address_book).and_return(@address_book)
       @input.arguments.push "query"
-      @command.stub(:mutt_search) { |ab| [] }
+      @command.should_receive(:mutt_search).and_return([])
       @output.should_receive(:line).with("No matches")
       @command.execute(@input, @output).should eq false
     end
@@ -42,8 +41,10 @@ describe Ppl::Command::Mutt do
       @input.arguments.push "example"
 
       @storage.should_receive(:load_address_book).and_return(@address_book)
-      @output.should_receive(:line).with("Searching database... 1 entries... 1 matching:")
-      @output.should_receive(:line).with("test@example.org\tTest User")
+      @output.should_receive(:line) do |line|
+        line.should include "Searching address book... 1 entries... 1 matching:"
+        line.should include "test@example.org\tTest User"
+      end
       @command.execute(@input, @output).should eq true
     end
 
@@ -56,8 +57,10 @@ describe Ppl::Command::Mutt do
       @input.arguments.push "User"
 
       @storage.should_receive(:load_address_book).and_return(@address_book)
-      @output.should_receive(:line).with("Searching database... 1 entries... 1 matching:")
-      @output.should_receive(:line).with("test@example.org\tTest User")
+      @output.should_receive(:line) do |line|
+        line.should include "Searching address book... 1 entries... 1 matching:"
+        line.should include "test@example.org\tTest User"
+      end
       @command.execute(@input, @output).should eq true
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2012-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
-  requirement: &16217320 !ruby/object:Gem::Requirement
+  requirement: &19907800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *16217320
+  version_requirements: *19907800
 - !ruby/object:Gem::Dependency
   name: rugged
-  requirement: &16216640 !ruby/object:Gem::Requirement
+  requirement: &19907120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.17.0.b6
   type: :runtime
   prerelease: false
-  version_requirements: *16216640
+  version_requirements: *19907120
 - !ruby/object:Gem::Dependency
   name: vpim
-  requirement: &16215860 !ruby/object:Gem::Requirement
+  requirement: &19906320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,7 +43,7 @@ dependencies:
         version: '0.695'
   type: :runtime
   prerelease: false
-  version_requirements: *16215860
+  version_requirements: *19906320
 description: CLI Address Book
 email: henry@henrysmith.org
 executables: