ppl 1.17.2 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f013c471444b4ddf23abbcdff7ba445c44dcecd9
-  data.tar.gz: 9455d8d1e984d55adb0f4e711309c4e74ea8765d
+  metadata.gz: 6a9d02380f3d44f146c22dd0e466d98ae56ac97d
+  data.tar.gz: e85bf61f41a01927c72450f761563ad9669c5fdd
 SHA512:
-  metadata.gz: 3622e85128d613fd52f9c931ff631f63c77dfca590780d554865f206730b39b88b3168980603b47d257e2ba225d5cf4f62e10688413584cf6bf31b4a1520df90
-  data.tar.gz: 3b73edb07693aa19e74ab8066c8a16846a82cb61bda2bbc3585935c7a5b358f35fecccebbf7c6cc2cccfc823bc0a7fc423abdcb7d1fefbf56034354bd7e86ddc
+  metadata.gz: 0f325d2c01e00c070edac9f3c6066185bf13bb20c7c25f1c659534485a833e28b7b5b6c7a25b42fe016f33b417800df2567a7ae591b8736a49027cc1cdada069
+  data.tar.gz: a388cc2f1f2af9c50afa01da54ac54994c9d2b25f290a75e07bc041b8f9c4051c27697fc997bdaec46d2739c920d7d610eeb814261610c90525ac1e30b1c9cca

data/lib/ppl/application/bootstrap.rb

@@ -27,6 +27,14 @@ class Ppl::Application::Bootstrap
     bday
   end
 
+  register :command_completion do
+    completion = Ppl::Command::Completion.new
+    directory = File.dirname(File.dirname(File.dirname(File.dirname(__FILE__))))
+    directory = File.join(directory, "completions")
+    completion.completions_directory = Dir.new(directory)
+    completion
+  end
+
   register :command_email do
     email = Ppl::Command::Email.new
     email.storage = storage_adapter
@@ -162,6 +170,7 @@ class Ppl::Application::Bootstrap
     suite.add_command command_add
     suite.add_command command_age
     suite.add_command command_bday
+    suite.add_command command_completion
     suite.add_command command_email
     suite.add_command command_help
     suite.add_command command_init

data/lib/ppl/application/shell.rb

@@ -11,6 +11,8 @@ class Ppl::Application::Shell
       command = select_command(input)
       prepare_command(command, input)
       outcome = execute_command(command, input, output)
+    rescue Ppl::Error::CompletionNotFound
+      output.error("ppl: No completion function available for '#{$!}'")
     rescue Ppl::Error::ContactNotFound
       output.error("ppl: Contact '#{$!}' not found")
     rescue OptionParser::InvalidOption, OptionParser::MissingArgument, Ppl::Error::IncorrectUsage

data/lib/ppl/command/completion.rb

@@ -0,0 +1,37 @@
+
+class Ppl::Command::Completion < Ppl::Application::Command
+
+  name        "completion"
+  description "Output shell completion function"
+
+  attr_writer :completions_directory
+
+  def options(parser, options)
+    parser.banner = "usage: ppl completion <shell>"
+  end
+
+  def execute(input, output)
+    shell_name = require_shell_name(input)
+    location = require_completion_existence(shell_name)
+    output.line(File.read(location))
+  end
+
+  private
+
+  def require_shell_name(input)
+    if input.arguments.first.nil?
+      raise Ppl::Error::IncorrectUsage, "No shell specified"
+    end
+    input.arguments.shift
+  end
+
+  def require_completion_existence(shell_name)
+    path = File.join(@completions_directory.path, shell_name)
+    if !File.exists? path
+      raise Ppl::Error::CompletionNotFound, shell_name
+    end
+    path
+  end
+
+end
+

data/lib/ppl/error/completion_not_found.rb

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

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.17.2"
+  Version = "1.18.0"
 
   module Adapter
   end
@@ -63,11 +63,13 @@ require "ppl/command/shell"
 require "ppl/command/url"
 require "ppl/command/version"
 require "ppl/command/external"
+require "ppl/command/completion"
 
 require "ppl/entity/address_book"
 require "ppl/entity/contact"
 require "ppl/entity/postal_address"
 
+require "ppl/error/completion_not_found"
 require "ppl/error/contact_not_found"
 require "ppl/error/incorrect_usage"
 

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.17.2"
-  spec.date        = "2013-04-14"
+  spec.version     = "1.18.0"
+  spec.date        = "2013-04-16"
 
   spec.required_ruby_version = ">= 1.9.3"
 

data/spec/ppl/application/bootstrap_spec.rb

@@ -23,6 +23,20 @@ describe Ppl::Application::Bootstrap do
     end
   end
 
+  describe "#command_completion" do
+    it "should return a Ppl::Command::Completion" do
+      @bootstrap.command_completion.should be_a(Ppl::Command::Completion)
+    end
+    it "should inject a completions directory" do
+      Ppl::Command::Completion.stub(:new) do
+        completion = double(Ppl::Command::Completion)
+        completion.should_receive(:completions_directory=)
+        completion
+      end
+      @bootstrap.command_completion
+    end
+  end
+
   describe "#command_email" do
     it "should return a Ppl::Command::Email" do
       @bootstrap.command_email.should be_a(Ppl::Command::Email)
@@ -405,6 +419,9 @@ describe Ppl::Application::Bootstrap do
     it "should contain the 'bday' command" do
       @bootstrap.command_suite.find_command("bday").should_not be nil
     end
+    it "should contain the 'completion' command" do
+      @bootstrap.command_suite.find_command("completion").should_not be nil
+    end
     it "should contain the 'email' command" do
       @bootstrap.command_suite.find_command("email").should_not be nil
     end

data/spec/ppl/application/shell_spec.rb

@@ -91,6 +91,14 @@ describe Ppl::Application::Shell do
       @shell.run(@input, @output)
     end
 
+    it "should handle CompletionNotFound errors nicely" do
+      @command.stub(:options)
+      @command.should_receive(:execute) { raise Ppl::Error::CompletionNotFound, "example" }
+      @router.should_receive(:route).and_return(@command)
+      @output.should_receive(:error).with("ppl: No completion function available for 'example'")
+      @shell.run(@input, @output)
+    end
+
   end
 
 end

data/spec/ppl/command/completion_spec.rb

@@ -0,0 +1,47 @@
+
+describe Ppl::Command::Completion do
+
+  before(:each) do
+    @command = Ppl::Command::Completion.new
+    @input   = Ppl::Application::Input.new
+    @output  = double(Ppl::Application::Output)
+    @directory = double(Dir)
+    @command.completions_directory = @directory
+  end
+
+  describe "#name" do
+    it "should be 'completion'" do
+      @command.name.should eq "completion"
+    end
+  end
+
+  describe "#execute" do
+
+    before(:each) do
+      @directory.stub(:path).and_return("")
+      File.stub(:exists?).and_return(true)
+      File.stub(:read)
+    end
+
+    it "should raise an error if no shell is specified" do
+      @input.arguments = []
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::IncorrectUsage)
+    end
+
+    it "should raise an error if the shell is not recognised" do
+      @input.arguments = ["invalidshell"]
+      File.should_receive(:exists?).with("/invalidshell").and_return(false)
+      expect{@command.execute(@input, @output)}.to raise_error(Ppl::Error::CompletionNotFound)
+    end
+
+    it "should read the function from disk and print it to stdout" do
+      @input.arguments = ["zsh"]
+      File.should_receive(:read).and_return("completion function")
+      @output.should_receive(:line).with("completion function")
+      @command.execute(@input, @output)
+    end
+
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.17.2
+  version: 1.18.0
 platform: ruby
 authors:
 - Henry Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -177,6 +177,7 @@ files:
 - lib/ppl/command/age.rb
 - lib/ppl/command/attribute.rb
 - lib/ppl/command/bday.rb
+- lib/ppl/command/completion.rb
 - lib/ppl/command/email.rb
 - lib/ppl/command/external.rb
 - lib/ppl/command/help.rb
@@ -197,6 +198,7 @@ files:
 - lib/ppl/entity/address_book.rb
 - lib/ppl/entity/contact.rb
 - lib/ppl/entity/postal_address.rb
+- lib/ppl/error/completion_not_found.rb
 - lib/ppl/error/contact_not_found.rb
 - lib/ppl/error/incorrect_usage.rb
 - lib/ppl/format/address_book.rb
@@ -246,6 +248,7 @@ files:
 - spec/ppl/command/age_spec.rb
 - spec/ppl/command/attribute_spec.rb
 - spec/ppl/command/bday_spec.rb
+- spec/ppl/command/completion_spec.rb
 - spec/ppl/command/email_spec.rb
 - spec/ppl/command/external_spec.rb
 - spec/ppl/command/help_spec.rb