prompt 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -2,14 +2,21 @@
 
 This is updated when a new version is pushed to http://rubygems.org
 
-## 0.1.0 (Mar 8, 2011)
+## 0.2.0 (Mar 17, 2012)
+
+* Exit immediately on Ctrl-C
+* Tab completing a `*param` will now include the completions for the following word
+  if the `*param` has already been matched at least once
+* [BUG] Use the cached parameter values, when available
+
+## 0.1.0 (Mar 8, 2012)
 
 * DSL change: `desc` was renamed to `group`
 * Tab completion will now list only the completions for the current word, instead of
   the whole command.  This makes it behave like bash and works much better with `*params`
 * Hitting ENTER with an empty line will no longer print a Command Not Found error
 
-## 0.0.3 (Feb 22, 2011)
+## 0.0.3 (Feb 22, 2012)
 
 * DSL change: `variable` & `dynamic_variable` were renamed to `param`
 * A glob parameter (e.g. `*param`) will now return its matches as an array of strings
@@ -17,7 +24,7 @@ This is updated when a new version is pushed to http://rubygems.org
 * Dynamic variables are cached until the next command is run
 * Added LICENSE.txt
 
-## 0.0.2 (Feb 17, 2011)
+## 0.0.2 (Feb 17, 2012)
 
 * Allow the command prompt to be changed while it's running
 * Quoted strings will now match to a single `:param`
@@ -25,6 +32,6 @@ This is updated when a new version is pushed to http://rubygems.org
 * [BUG] Don't memoize Command#regex.  This prevented dynamic variables
   from working correctly after the values changed
 
-## 0.0.1 (Feb 16, 2011)
+## 0.0.1 (Feb 16, 2012)
 
 * Initial release

data/examples/file_manager

@@ -39,7 +39,9 @@ command "pwd", "Print current directory" do
 end
 
 param :file, "File" do
-  Dir.entries(@pwd)
+  Dir.entries(@pwd).select do |e|
+    File.file?(File.join(@pwd, e))
+  end
 end
 
 command "cp *file :dir", "Copy one or more files to dest" do |files, dir|

data/lib/prompt/application.rb

@@ -35,7 +35,7 @@ module Prompt
     def completions line_starting_with, word_starting_with
       args = Console.split(line_starting_with)
       last_idx = index_of_last_word(line_starting_with)
-      all_expansions(args[0,last_idx], word_starting_with)
+      all_completions(args[0,last_idx], word_starting_with)
     end
 
     private
@@ -58,9 +58,9 @@ module Prompt
       @command_groups.map(&:commands).flatten(1)
     end
 
-    def all_expansions(args, partial_arg)
+    def all_completions(args, partial_arg)
       commands.select { |c| c.could_match? args }.map do |c|
-        c.expansions(args.length, partial_arg)
+        c.completions(args.length, partial_arg)
       end.flatten(1)
     end
 

data/lib/prompt/command.rb

@@ -46,22 +46,21 @@ module Prompt
 
     def clear_cached_values
       @parameters.each do |p|
-        p.clear_cached_value if p.respond_to?(:clear_cached_value)
+        p.clear_cached_values if p.respond_to?(:clear_cached_values)
       end
     end
 
-    def expansions(word_idx, starting_with)
-      # TODO - combine glob parameters with any that follow
-      word = @words[0..word_idx].find { |w| w.kind_of? MultiMatcher }
-      word = word || @words[word_idx]
-
+    def completions(word_idx, starting_with)
+      idx = @words[0...word_idx].find_index { |w| w.kind_of? MultiMatcher } || word_idx
+      word = @words[idx]
       return [] if word.nil?
 
-      case word
-      when Matcher 
-        word.parameter.expansions(starting_with)
-      when String
-        word.start_with?(starting_with) ? [word] : []
+      next_word = @words[idx+1]
+
+      if idx < word_idx and next_word
+        completions_for(word, starting_with) + completions_for(next_word, starting_with)
+      else
+        completions_for(word, starting_with)
       end
     end
 
@@ -96,5 +95,14 @@ module Prompt
       end
     end
 
+    def completions_for(word, starting_with)
+      case word
+      when Matcher
+        word.parameter.completions(starting_with)
+      when String
+        word.start_with?(starting_with) ? [word] : []
+      end
+    end
+
   end
 end

data/lib/prompt/console/console_module.rb

@@ -21,6 +21,8 @@ module Prompt
         save_history history_file if history_file
       end
 
+      trap('INT') { puts; exit }
+
       Readline.completion_proc = CompletionProc
 
       load_history history_file if history_file

data/lib/prompt/parameter.rb

@@ -12,12 +12,12 @@ module Prompt
     end
 
     def clear_cached_values
-      @cached_value = nil
+      @cached_values = nil
     end
 
-    def expansions(starting_with = "")
+    def completions(starting_with = "")
       all = if @proc
-        @cached_value = @proc.call
+        @cached_values ||= @proc.call
       else
         @values
       end

data/lib/prompt/prompt_module.rb

@@ -1,5 +1,5 @@
 module Prompt
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 
   class << self
 

data/spec/prompt/command_spec.rb

@@ -115,51 +115,75 @@ describe Prompt::Command do
     end
   end
 
-  describe "#expansions" do
+  describe "#completions" do
 
     it "expands correctly with no parameters" do
       c = Command.new ["one"]
-      c.expansions(0, "").should == ["one"]
-      c.expansions(0, "on").should == ["one"]
-      c.expansions(0, "z").should == []
-      c.expansions(1, "").should == []
+      c.completions(0, "").should == ["one"]
+      c.completions(0, "on").should == ["one"]
+      c.completions(0, "z").should == []
+      c.completions(1, "").should == []
 
       c = Command.new ["help", "-v"]
-      c.expansions(0, "").should == ["help"]
-      c.expansions(0, "he").should == ["help"]
-      c.expansions(0, "z").should == []
-      c.expansions(1, "").should == ["-v"]
-      c.expansions(1, "-v").should == ["-v"]
-      c.expansions(1, "z").should == []
+      c.completions(0, "").should == ["help"]
+      c.completions(0, "he").should == ["help"]
+      c.completions(0, "z").should == []
+      c.completions(1, "").should == ["-v"]
+      c.completions(1, "-v").should == ["-v"]
+      c.completions(1, "z").should == []
     end
 
     it "expands correctly with undefined parameters" do
       c = Command.new(["go", matcher(:dir)])
-      c.expansions(0, "").should == ["go"]
-      c.expansions(0, "g").should == ["go"]
-      c.expansions(0, "go").should == ["go"]
-      c.expansions(1, "").should == []
+      c.completions(0, "").should == ["go"]
+      c.completions(0, "g").should == ["go"]
+      c.completions(0, "go").should == ["go"]
+      c.completions(1, "").should == []
     end
 
     it "expands correctly with defined parameters" do
       dir = Parameter.new(:dir, "", DIRECTIONS)
       c = Command.new(["go", matcher(dir)])
-      c.expansions(1, "").should == DIRECTIONS
+      c.completions(1, "").should == DIRECTIONS
 
       speed = Parameter.new(:speed, "", SPEEDS)
       c = Command.new(["go", matcher(dir), matcher(speed)])
-      c.expansions(2, "").should == SPEEDS
-      c.expansions(2, "slow").should == SPEEDS
-      c.expansions(2, "slowe").should == ["slower"]
+      c.completions(2, "").should == SPEEDS
+      c.completions(2, "slow").should == SPEEDS
+      c.completions(2, "slowe").should == ["slower"]
     end
 
     it "expands correctly if parameter values have spaces" do
       speed = Parameter.new(:speed, "", ["fast", "very fast"])
       c = Command.new(["go", matcher(speed)])
-      c.expansions(1, "").should == ['fast', 'very fast']
-      c.expansions(1, "f").should == ['fast']
-      c.expansions(1, "v").should == ['very fast']
+      c.completions(1, "").should == ['fast', 'very fast']
+      c.completions(1, "f").should == ['fast']
+      c.completions(1, "v").should == ['very fast']
     end
+
+    it "expands correctly when *param is followed by :param" do
+      speed = Parameter.new(:speed, "", SPEEDS)
+      dir = Parameter.new(:dir, "", DIRECTIONS)
+      c = Command.new [multi_matcher(speed), matcher(dir)]
+      c.completions(0, "").should == SPEEDS
+      c.completions(1, "").should == (SPEEDS + DIRECTIONS)
+      c.completions(2, "").should == (SPEEDS + DIRECTIONS)
+      c.completions(1, "s").should == (SPEEDS + DIRECTIONS).grep(/^s/)
+    end
+
+    it "caches dynamic parameters" do
+      year = Parameter.new(:year, "", "") do
+        Range.new(1, 100).to_a.map &:to_s
+      end
+      c = Command.new [matcher(year)]
+      Range.should_receive(:new).once.and_return(["42"])
+      c.completions(0, "").should == ["42"]
+      c.completions(0, "").should == ["42"] # this time it should be cached
+      c.clear_cached_values
+      Range.should_receive(:new).once.and_return(["44"])
+      c.completions(0, "").should == ["44"]
+    end
+
   end
 
   describe "#usage" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prompt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000 Z
+date: 2012-03-17 00:00:00.000000000 Z
 dependencies: []
 description: Prompt makes it easy to build slick command-line applications with Tab
   Completion, Command History, and Built-in Help