tabtab 0.9.0 → 0.9.1

data/History.txt

@@ -1,4 +1,11 @@
-== 0.0.1 2008-11-12
+== 0.91 2008-12-29
+
+* Uses ENV['COMP_LINE'] for full current line if available
+* New completions: rubyforge, rake
+* Bugs fixed:
+  * Only install completions from latest version of each gem
+
+== 0.9.0 2008-11-12
 
 * 1 major enhancement:
   * Initial release

data/Manifest.txt

@@ -21,7 +21,6 @@ features/steps/env.rb
 features/steps/gems.rb
 features/steps/shells.rb
 lib/dev_definitions/gem.rb
-lib/dev_definitions/rake.rb
 lib/dev_definitions/script-generate.rb
 lib/dev_definitions/script-server.rb
 lib/install_tabtab/cli.rb
@@ -44,6 +43,7 @@ lib/tabtab_definitions/cucumber.rb
 lib/tabtab_definitions/github.rb
 lib/tabtab_definitions/newgem.rb
 lib/tabtab_definitions/rails.rb
+lib/tabtab_definitions/rake.rb
 lib/tabtab_definitions/rubyforge.rb
 script/console
 script/destroy

data/README.rdoc

@@ -12,7 +12,7 @@ of a command-line application or a target file or folder. Its possible to
 provide your own completions for applications: git comes with bash shell completions,
 and the fish shell includes a library of completions for many applications.
 
-== QUICK START/TRIAL ME:
+=== Quick Start/Trial Me:
 
 The tabtab gem comes with some pre-defined completions for some popular applications
 that benefit from completions: rails, newgem, cucumber, github (and its alias gh).
@@ -25,12 +25,14 @@ It takes 2 minutes to trial this project and see if you like it:
     
     rails -d TABTAB
     
+    sudo gem install defunkt-github -s http://gems.github.com
     cd project/hosted/on/github/with/contributors/like/rails/or/rspec
+
     github TABTAB
     gh netTAB feTAB
     gh netTAB web TABTAB
 
-It just works.
+It just works. Flags. Commands. Intelligent values. Aliases. Ooh yeah.
 
 Now, add 'source ~/.tabtab.bash' to your .bash_profile so you have this awesomeness in all your
 terminal shells.
@@ -343,6 +345,60 @@ please let me know. I have some cucumber scenarios ready and waiting for your he
 Currently, tabtab works with the bash shell, though it is designed to be
 shell agnostic.
 
+== KNOWN ISSUES/LIMITATIONS & ARCHITECTURE OVERVIEW:
+
+Pride and ego mean this section goes at the bottom of the readme... this section includes the known
+issues and limitations of TabTab due to current architectural decisions, the aim of being
+shell agnostic whilst initially only implementing TabTab for bash, and DSL challenges in
+attempting to support all possible command-line app APIs with a sexy, small DSL for describing
+auto-completions.
+
+=== Cannot support rake/sake/cap colon-separated completions
+
+This will be fixed soon. I only just discovered this deficiency. 
+
+Auto-completion for rake/sake/cap - when I get it working - will allow you to tab
+through the namespacing across the colons. E.g. 'rake db:test:' and tabtab will show
+all the tasks within this namespace. That's what it should do. That's what all the 
+current implementations of auto-completion do before tabtab. But with tabtab (currently)
+it can't do it. I suck. But here's the reason and the fix.
+
+To fix it requires rewriting the guts of the tabtab application to use $COMP_LINE 
+environment variable instead of the current, previous token. 
+
+Currently tabtab works by passing the current and previous token in the current command
+line string around. But bash isn't coping with colon's correctly. If you tabtab after
+a colon it just ignores the characters before it.
+
+So, I'll abandon the whole mechanism of (current, previous) tokens and use the $COMP_LINE
+variable and manually parse it into tokens via the Shellwords.shellwords function.
+
+=== Nested intelligent lists
+
+Some applications may want to have multiple auto-completed values in a row, with the 2nd value's list
+being dependent upon the value of the first. For example, the 'rubyforge add_release' command takes
+four more arguments: group_id, package_id, release_name, userfile. The first two - group_id and package_id -
+are from known lists of values. The values available for package_id are dependent upon the group_id value.
+This is a nested list, and currently TabTab probably can't do them.
+
+Currently intelligent, dynamic lists of completable values are defined via 'default' blocks - either blocks 
+passed to #flag or #command calls, or via #default calls. I guess to support nested lists you'd need
+nested default blocks. Not sure. 
+
+Or perhaps we need specific syntax to support commands with 2+ arguments.
+
+    TabTab::Definition.register('rubyforge') do |c|
+      c.command(:add_release, 1) { list_of_rubyforge_group_names }
+      c.command(:add_release, 2) { |group_id| list_of_rubyforge_package_names_in(group_id) }
+    end
+   
+In this pseudo code we redefine the :add_release command for each nested argument. The 2nd+ argument
+is passed the completed values from the previous arguments of the command so they
+can filter their lists as appropriate. Might work.
+
+Of course, the second argument (1, 2, ...) would be optional and only required if you were trying
+to describe a nested list of interdependent values.
+
 == SOURCE:
 
 The source for this project is at http://github.com/drnic/tabtab
@@ -354,11 +410,21 @@ Using git, you can clone the project, run its tests and install it:
     rake
     rake install_gem
 
-== SPONSOR
+== ACKNOWLEDGEMENT and SPONSOR
+
+I wrote most of this at Railscamp #4 in Adelaide, between 13th and 17th of November 2008. Railscamps
+are so awesome. They are a conference without the conference part. Coding, lightning talks, alcohol,
+and guitar hero. Thanks to all the people I demo'd tabtab during its development, for their thoughts
+on the final DSL, and finally for helping give TabTab a name.
+
+After Railscamp, I kept coding tabtab instead of doing proper work. Therefore this project has
+a sponsor:
 
 * Mocra - the premier iPhone/Rails consultancy
 * http://mocra.com
 
+Like TabTab? Don't donate money, just hire us for your next Rails or iPhone party.
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -1,4 +1,4 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+%w[rubygems rake rake/clean fileutils newgem].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/tabtab'
 
 # Generate all the Rake tasks

data/lib/install_tabtab/cli.rb

@@ -79,7 +79,7 @@ module InstallTabTab
     end
     
     def find_gems_with_definition_files
-      Gem.all_load_paths.inject([]) do |mem, path|
+      Gem.latest_load_paths.inject([]) do |mem, path|
         root = path.gsub(/(lib|bin)$/,'')
         mem << root unless mem.include?(root)
         mem
@@ -87,14 +87,14 @@ module InstallTabTab
         common_file = Dir[File.join(path, "**", "tabtab_definitions.rb")].reject { |tabtab_path| tabtab_path =~ /(spec|test)/ }.first
         gem_name = nil
         unless common_file.nil? || common_file.empty?
-          gem_name = common_file.match(/\/([^\/]*)-\d+.\d+.\d+\/lib\//)[1]
+          gem_name = common_file.match(/\/([^\/]*)-\d+(\.\d+)+\/lib\//)[1]
           TabTab::Definition.clear
           load common_file
           mem << { :gem_name => gem_name, :app_names => TabTab::Definition.app_names }
         end
         files = Dir[File.join(path, "**", "tabtab_definitions", "**", "*.rb")].reject { |tabtab_path| tabtab_path =~ /(spec|test)/ }
         if files && files.size > 0
-          gem_path, gem_name = files.first.match(/^(.*\/([^\/]*)-\d+.\d+.\d+)/)[1..2]
+          gem_path, gem_name = files.first.match(/^(.*\/([^\/]*)-\d+(\.\d+)+)/)[1..2]
           files.each do |file|
             TabTab::Definition.clear
             load file

data/lib/tabtab.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module TabTab
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end
 
 require 'tabtab/local_config'

data/lib/tabtab/cli.rb

@@ -16,11 +16,7 @@ module TabTab
     
     def execute(stdout, arguments=[])
       @stdout = stdout
-      # require "shellwords"
-      # @full_line = ENV['COMP_LINE']
-      # @full_line_argv = Shellwords.shellwords(@full_line)
-      @app_name, @current_token, @previous_token = arguments[-3..-1]
-      parse_options(arguments[0..-4])
+      extract_tokens_and_parse_options(arguments)
       load_global_config
       if options[:external]
         process_external
@@ -33,6 +29,22 @@ module TabTab
       end
     end
     
+    # parses the incoming tokens either via ENV['COMP_LINE'] or tokens from ARGV
+    def extract_tokens_and_parse_options(arguments)
+      if ENV['COMP_LINE']
+        require "shellwords"
+        line  = ENV['COMP_LINE']
+        words = Shellwords.shellwords(line)
+        words << "" if line.split("")[-1] == " "
+        @app_name = words[0]
+        @previous_token, @current_token = words[-2..-1]
+        parse_options(arguments)
+      else
+        @app_name, @current_token, @previous_token = arguments[-3..-1]
+        parse_options(arguments[0..-4])
+      end
+    end
+    
     def parse_options(arguments)
       @options = {}
       OptionParser.new do |opts|

data/lib/tabtab/definitions/base.rb

@@ -106,7 +106,7 @@ class TabTab::Definition::Base
   def yield_definition_block
     if definition_block.nil?
       return
-    elsif definition_block.arity == -1
+    elsif definition_block.arity == -1 || definition_block.arity == 0
       # these blocks return a result/do lots of work - don't run them now
     elsif definition_block.arity == 1
       definition_block.call self

data/lib/tabtab/definitions/default.rb

@@ -15,10 +15,10 @@ module TabTab::Definition
     end
     
     def yield_result_block
-      if definition_block.arity == -1
+      if definition_block.arity == -1 || definition_block.arity == 0
         definition_block.call
       elsif definition_block.arity == 1
-        definition_block.call(parent.current_token)
+        definition_block.call(self)
       else
         raise TabTab::Definition::InvalidDefinitionBlockArguments
       end

data/lib/tabtab_definitions/rake.rb

@@ -0,0 +1,20 @@
+TabTab::Definition.register('rake', :import => true) do |c|
+  def rake_silent_tasks
+    # TODO cache per directory
+    `rake --silent --tasks`
+  end
+  # c.cache :rake_silent_tasks, :per => :folder
+  
+  c.default do |cmd|
+    next [] if cmd.current_token.nil? # TODO why are these blocks invoked twice? (1st on setup, 2nd for parsing)
+    tasks = (rake_silent_tasks.split("\n")[1..-1] || []).map { |line| line.split[1] }
+    if cmd.current_token =~ /^([-\w:]+:)/
+      upto_last_colon = Regexp.escape($1)
+      tasks = tasks.select { |task| /^#{Regexp.escape cmd.current_token}/ =~ task }
+      tasks.map! { |task| task.gsub(/#{Regexp.escape upto_last_colon}/, '')  }
+    end
+    tasks
+  end
+  c.flags :silence, :s
+  c.flags :trace, :t
+end

data/lib/tabtab_definitions/rubyforge.rb

@@ -1,17 +1,29 @@
 TabTab::Definition.register('rubyforge', :import => true) do |c|
+  def groups
+    require "yaml"
+    config = YAML.load(File.read(File.expand_path("~/.rubyforge/auto-config.yml")))
+    config["group_ids"].keys
+  end
+
   def projects
-    []
+    require "yaml"
+    config = YAML.load(File.read(File.expand_path("~/.rubyforge/auto-config.yml")))
+    config["project_ids"].keys
   end
+
   c.command :setup
+  c.command :help
   c.command(:config) { projects }
   c.command :names
   c.command :login do |login|
     login.flag :username
     login.flag :password
   end
-  c.command :create_package
-  c.command :add_release
-  c.command :add_file
-  c.command :delete_package
+  # TODO - need nesting of default blocks: rubyforge create_package group_id package_name
+  # This will probably require access to $COMP_LINE
+  c.command(:create_package) { groups }
+  c.command(:add_release) { groups }
+  c.command(:add_file) { groups }
+  c.command(:delete_package) { groups }
 end
 

data/spec/fixtures/gems/multi_app/multi_app.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dr Nic Williams"]
-  s.date = %q{2008-11-23}
+  s.date = %q{2008-12-29}
   s.default_executable = %q{test_app}
   s.description = %q{Multiple CLI apps + in-built autocompletions}
   s.email = ["drnicwilliams@gmail.com"]
@@ -25,14 +25,14 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
     else
-      s.add_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
       s.add_dependency(%q<hoe>, [">= 1.8.0"])
     end
   else
-    s.add_dependency(%q<newgem>, [">= 1.1.0"])
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
     s.add_dependency(%q<hoe>, [">= 1.8.0"])
   end
 end

data/spec/fixtures/gems/my_app/my_app.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dr Nic Williams"]
-  s.date = %q{2008-11-23}
+  s.date = %q{2008-12-29}
   s.default_executable = %q{test_app}
   s.description = %q{Simple CLI app + in-built autocompletions}
   s.email = ["drnicwilliams@gmail.com"]
@@ -25,14 +25,14 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
     else
-      s.add_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
       s.add_dependency(%q<hoe>, [">= 1.8.0"])
     end
   else
-    s.add_dependency(%q<newgem>, [">= 1.1.0"])
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
     s.add_dependency(%q<hoe>, [">= 1.8.0"])
   end
 end

data/spec/install_tabtab_cli_spec.rb

@@ -6,7 +6,7 @@ describe InstallTabTab::CLI, "with --development CLI flag" do
     ENV['HOME'] = '/tmp/some/home'
     dev_bin = File.expand_path(File.dirname(__FILE__) + "/../bin/tabtab")
     @cli = InstallTabTab::CLI.new
-    Gem.expects(:all_load_paths).returns([])
+    Gem.expects(:latest_load_paths).returns([])
     @cli.expects(:config).returns({"external" => %w[test_app]}).at_least(2)
     File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
       expects(:<<).with("complete -o default -C '#{dev_bin} --external' test_app\n")
@@ -24,7 +24,7 @@ describe InstallTabTab::CLI, "with --external app flag" do
   before(:each) do
     ENV['HOME'] = '/tmp/some/home'
     @cli = InstallTabTab::CLI.new
-    Gem.expects(:all_load_paths).returns([])
+    Gem.expects(:latest_load_paths).returns([])
     @stdout_io = StringIO.new
   end
   
@@ -74,7 +74,7 @@ describe InstallTabTab::CLI, "with --gem GEM_NAME app flag" do
     TabTab::Definition.clear
     @cli = InstallTabTab::CLI.new
     @cli.expects(:config).returns({}).at_least(1)
-    Gem.expects(:all_load_paths).returns(['/gems/gem_with_tabtabs-1.0.0/lib'])
+    Gem.expects(:latest_load_paths).returns(['/gems/gem_with_tabtabs-1.0.0/lib'])
     Dir.expects(:[]).with('/gems/gem_with_tabtabs-1.0.0/**/tabtab_definitions/**/*.rb').returns([])
     Dir.expects(:[]).with('/gems/gem_with_tabtabs-1.0.0/**/tabtab_definitions.rb').returns(['/gems/gem_with_tabtabs-1.0.0/lib/tabtab_definitions.rb'])
     @cli.expects(:load).with('/gems/gem_with_tabtabs-1.0.0/lib/tabtab_definitions.rb').returns(true)
@@ -98,7 +98,7 @@ describe InstallTabTab::CLI, "with --gem GEM_NAME/PATH flag" do
     TabTab::Definition.clear
     @cli = InstallTabTab::CLI.new
     @cli.expects(:config).returns({}).at_least(1)
-    Gem.expects(:all_load_paths).returns(['/gems/gem_with_tabtabs-1.0.0/lib'])
+    Gem.expects(:latest_load_paths).returns(['/gems/gem_with_tabtabs-1.0.0/lib'])
     Dir.expects(:[]).with('/gems/gem_with_tabtabs-1.0.0/**/tabtab_definitions.rb').returns([])
     Dir.expects(:[]).with('/gems/gem_with_tabtabs-1.0.0/**/tabtab_definitions/**/*.rb').returns(['/gems/gem_with_tabtabs-1.0.0/lib/tabtab_definitions/tabtabbed_app.rb'])
     @cli.expects(:load).with('/gems/gem_with_tabtabs-1.0.0/lib/tabtab_definitions/tabtabbed_app.rb').returns(true)
@@ -123,7 +123,7 @@ describe InstallTabTab::CLI, "with --file FILE_NAME app flag" do
     ENV['HOME'] = '/tmp/some/home'
     @cli = InstallTabTab::CLI.new
     @cli.expects(:config).returns({'file' => {'/path/to/definition.rb' => 'some_app'}}).at_least(2)
-    Gem.expects(:all_load_paths).returns([])
+    Gem.expects(:latest_load_paths).returns([])
     File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
       expects(:<<).with("complete -o default -C 'tabtab --file /path/to/definition.rb' some_app\n")
       expects(:close)

data/spec/tabtab_cli_spec.rb

@@ -143,3 +143,44 @@ describe TabTab::CLI, "--file flag" do
   end
 end
 
+describe TabTab::CLI, "extracting tokens using ENV['COMP_LINE'] via extract_tokens_and_parse_options" do
+  describe "with no tokens" do
+    before(:each) do
+      ENV['COMP_LINE'] = "myapp "
+      @cli = TabTab::CLI.new
+      @cli.extract_tokens_and_parse_options([])
+    end
+
+    it "should setup app_name" do
+      @cli.app_name.should == "myapp"
+    end
+    
+    it "should setup current_token" do
+      @cli.current_token.should == ""
+    end
+    
+    it "should setup previous_token" do
+      @cli.previous_token.should == "myapp"
+    end
+  end
+
+  describe "mid-way through a token" do
+    before(:each) do
+      ENV['COMP_LINE'] = "rake db:"
+      @cli = TabTab::CLI.new
+      @cli.extract_tokens_and_parse_options([])
+    end
+
+    it "should setup app_name" do
+      @cli.app_name.should == "rake"
+    end
+    
+    it "should setup current_token" do
+      @cli.current_token.should == "db:"
+    end
+    
+    it "should setup previous_token" do
+      @cli.previous_token.should == "rake"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tabtab
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-23 00:00:00 +10:00
+date: 2008-12-29 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.0
+        version: 1.2.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
@@ -83,7 +83,6 @@ files:
 - features/steps/gems.rb
 - features/steps/shells.rb
 - lib/dev_definitions/gem.rb
-- lib/dev_definitions/rake.rb
 - lib/dev_definitions/script-generate.rb
 - lib/dev_definitions/script-server.rb
 - lib/install_tabtab/cli.rb
@@ -106,6 +105,7 @@ files:
 - lib/tabtab_definitions/github.rb
 - lib/tabtab_definitions/newgem.rb
 - lib/tabtab_definitions/rails.rb
+- lib/tabtab_definitions/rake.rb
 - lib/tabtab_definitions/rubyforge.rb
 - script/console
 - script/destroy

data/lib/dev_definitions/rake.rb

@@ -1,23 +0,0 @@
-TabTab::Definition.register('rake', :import => true) do |c|
-  def rake_silent_tasks
-    if File.exists?(dotcache = File.join(File.expand_path('~'), ".raketabs-#{Dir.pwd.hash}"))
-      File.read(dotcache)
-    else
-      tasks = `rake --silent --tasks`
-      File.open(dotcache, 'w') { |f| f.puts tasks }
-      tasks
-    end
-  end
-  
-  c.default do |current|
-    tasks = (rake_silent_tasks.split("\n")[1..-1] || []).map { |line| line.split[1] }
-    if current =~ /^([-\w:]+:)/
-      upto_last_colon = $1
-      p upto_last_colon
-      tasks = tasks.map { |t| (t =~ /^#{Regexp.escape upto_last_colon}([-\w:]+)$/) ? "#{$1}" : t }
-    end
-    tasks
-  end
-  c.flags :silence, :s
-  c.flags :trace, :t
-end