tabtab 0.9.0

data/Rakefile

@@ -0,0 +1,25 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/tabtab'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('tabtab', TabTab::VERSION) do |p|
+  p.developer('Dr Nic Williams', 'drnicwilliams@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['cucumber', ">= 0.1.8"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+remove_task :default
+task :default => [:spec, :features]

data/bin/install_tabtab

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-11-13.
+#  Copyright (c) 2008. All rights reserved.
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/tabtab")
+
+require "install_tabtab/cli"
+
+InstallTabTab::CLI.execute(STDOUT, ARGV)

data/bin/tabtab

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-11-14.
+#  Copyright (c) 2008. All rights reserved.
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/tabtab")
+
+require "tabtab/cli"
+
+TabTab::CLI.execute(STDOUT, ARGV)

data/examples/tabtab.sh

@@ -0,0 +1,7 @@
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --external" curl
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --gem my_app" test_app
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --file /Users/drnic/Documents/ruby/gems/tabtab/spec/fixtures/gems/my_app/lib/tabtab_definitions/github.rb" github 
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --file /Users/drnic/Documents/ruby/gems/tabtab/spec/fixtures/gems/my_app/lib/tabtab_definitions/rails.rb" rails
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --file /Users/drnic/Documents/ruby/gems/tabtab/spec/fixtures/gems/my_app/lib/tabtab_definitions/script-server.rb" script/server
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --file /Users/drnic/Documents/ruby/gems/tabtab/spec/fixtures/gems/my_app/lib/tabtab_definitions/gem.rb" gem
+complete -o default -C "/Users/drnic/gems/tabtab/bin/tabtab --file /Users/drnic/Documents/ruby/gems/tabtab/spec/fixtures/gems/my_app/lib/tabtab_definitions/rake.rb" rake

data/features/aliases_for_completions.feature

@@ -0,0 +1,23 @@
+Feature: User can reuse completions for their own aliases
+  In order to minimize cost of duplicating definitions
+  As a command line user that defines aliases
+  I want the tabtab completions for the unaliased application to work for my alias
+
+  Scenario: Add alias for existing completions
+    Given a .tabtab.yml config file
+    And alias 'test_alias' to existing 'test_app'
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.bash' is created
+    And contents of home file '.tabtab.bash' does match /test_alias/
+    And contents of home file '.tabtab.bash' does match /--file /path/to/file.rb --alias test_app/
+
+  Scenario: An alias maps directly to an app name, that has an existing tabtab definition
+    Given a file 'my_definitions.rb' containing completion definitions
+    When run local executable 'tabtab' with arguments '--file my_definitions.rb --alias test_app test "" test'
+    Then I should see a full list of options for 'test_app'
+  
+  Scenario: An alias maps to an app name plus arguments
+    Given a file 'my_definitions.rb' containing completion definitions
+    When run local executable 'tabtab' with arguments '--file my_definitions.rb --alias "test_app -x" test "" test'
+    Then oneday I should see a full list of options for 'test_app'
+  

data/features/development.feature

@@ -0,0 +1,19 @@
+Feature: Development processes of newgem itself (rake tasks)
+
+  As a Newgem maintainer or contributor
+  I want rake tasks to maintain and release the gem
+  So that I can spend time on the tests and code, and not excessive time on maintenance processes
+    
+  Scenario: Generate RubyGem
+    Given this project is active project folder
+    And 'pkg' folder is deleted
+    When task 'rake gem' is invoked
+    Then project folder 'pkg' is created
+    And project file with name matching 'pkg/*.gem' is created else you should run "rake manifest" to fix this
+    And gem spec key 'rdoc_options' contains /--mainREADME.rdoc/
+
+  Scenario: Generate .tabtab.bash using dev tabtab CLI instead of gem version
+    Given a .tabtab.yml config file
+    When run local executable 'install_tabtab' with arguments '--development'
+    Then home file '.tabtab.bash' is created
+    And contents of home file '.tabtab.bash' does match /bin\/tabtab/

data/features/different_shells_installation.feature

@@ -0,0 +1,26 @@
+Feature: Can install tabtab autocompletions for multiple shells
+  In order to minimize cost of having autocompletion scripts for my personal shell
+  As a Unix command line user
+  I want any tabtab completion definition to work on my shell
+
+  Scenario: I use bash shell
+    Given a bash shell
+    And a .tabtab.yml config file
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.bash' is created
+    Then external completions are ready to be installed for applications: rails, test_app
+  
+  Scenario: I use fish shell
+    Given a fish shell
+    And a .tabtab.yml config file
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.fish' is created
+    Then external completions are ready to be installed for applications: rails, test_app
+
+  Scenario: I use ksh shell
+    Given a ksh shell
+    And a .tabtab.yml config file
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.ksh' is created
+    Then external completions are ready to be installed for applications: rails, test_app
+

data/features/discovered_gem_app_completions.feature

@@ -0,0 +1,37 @@
+Feature: Discover completions config script in installed RubyGems
+  In order to minimize cost of using completions
+  As a user of RubyGems that contain completions config scripts
+  I want RubyGems executables to be automatically enabled with auto-completions for my shell
+  
+  Scenario: Find and add completions for rubygems' executables via tabtab_definitions.rb file
+    Given a user's RubyGems gem cache
+    And a RubyGem 'my_app' with autocompletions
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.bash' is created
+    Then gem completions are ready to be installed for applications test_app in gem my_app
+
+  Scenario: Find and add completions for rubygems' executables via tabtab_definitions/ folder
+    Given a user's RubyGems gem cache
+    And a RubyGem 'multi_app' with autocompletions
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.bash' is created
+    Then gem completions are ready to be installed for application test_app in gem multi_app in file lib/tabtab_definitions/some_app.rb
+  
+  Scenario: Activate auto-completions for gem-based app, determine options and return all
+    Given a user's RubyGems gem cache
+    And a RubyGem 'my_app' with autocompletions
+    When run local executable 'tabtab' with arguments '--gem my_app test_app "" test_app'
+    Then I should see a full list of options for 'test_app'
+
+  Scenario: Activate auto-completions for gem-based app, determine partial options and return all
+    Given a user's RubyGems gem cache
+    And a RubyGem 'my_app' with autocompletions
+    When run local executable 'tabtab' with arguments '--gem my_app test_app -- test_app'
+    Then I should not see any short form flags
+
+  Scenario: Activate many auto-completions for gem-based app within tabtab_definitions folder
+    Given a user's RubyGems gem cache
+    And a RubyGem 'multi_app' with autocompletions
+    When run local executable 'tabtab' with arguments '--gem multi_app/lib/tabtab_definitions/some_app.rb test_app "" test_app'
+    Then I should see a full list of options for 'test_app'
+

data/features/external_app_completions.feature

@@ -0,0 +1,24 @@
+Feature: Autocompletions for any 3rd-party application's options
+  In order to minimise costs
+  As a command-line application user
+  I want auto-completions for the command-line applications I use
+  
+  Scenario: Install configured list of applications into bash completions
+    Given a .tabtab.yml config file
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.bash' is created
+    And external completions are ready to be installed for applications: rails, test_app
+  
+  Scenario: Activate auto-completions for app, determine options and return all
+    Given a .tabtab.yml config file
+    And env variable $PATH includes fixture executables folder
+    When run local executable 'tabtab' with arguments '--external test_app "" test_app'
+    Then I should see a full list of options for 'test_app'
+  
+  Scenario: Activate auto-completions for app, determine partial options and return all
+    Given a .tabtab.yml config file
+    And env variable $PATH includes fixture executables folder
+    When run local executable 'tabtab' with arguments '--external test_app -- test_app'
+    Then I should not see any short form flags
+
+  

data/features/file_completions.feature

@@ -0,0 +1,17 @@
+Feature: Autocompletions for app via an explicit definition file
+  In order to minimise costs
+  As a command-line application user
+  I want my own autocompletions for an app, rather than those given by default
+  
+  Scenario: Add completions within explicit files
+    Given a .tabtab.yml config file
+    When run local executable 'install_tabtab' with arguments ''
+    Then home file '.tabtab.bash' is created
+    Then file completions are ready to be installed for applications test_app in file /path/to/file.rb
+  
+  Scenario: Trigger autocompletions where the definition is in a specific file
+    Given a file 'my_definitions.rb' containing completion definitions
+    When run local executable 'tabtab' with arguments '--file my_definitions.rb test_app "" test_app'
+    Then I should see a full list of options for 'test_app'
+  
+  

data/features/hide_short_flags.feature

@@ -0,0 +1,19 @@
+Feature: Do not display short flags (-p) within lists of completions options
+  In order to reduce cost of scanning through lists of completion options
+  As a tabtab user
+  I want to be able to disable short flags and never see them
+
+  Scenario: Explicitly disable short flags via the config file for definitions
+    Given a .tabtab.yml config file
+    And a file 'my_definitions.rb' containing completion definitions
+    And disable short flags
+    When run local executable 'tabtab' with arguments '--file my_definitions.rb test_app "" test_app'
+    Then I should not see any short form flags
+  
+  Scenario: Explicitly disable short flags via the config file for externals
+    Given a .tabtab.yml config file
+    And disable short flags
+    And env variable $PATH includes fixture executables folder
+    When run local executable 'tabtab' with arguments '--external test_app "" test_app'
+    Then I should not see any short form flags
+

data/features/steps/cli.rb

@@ -0,0 +1,63 @@
+Given %r{^a .tabtab.yml config file} do
+  Given "a safe folder"
+  in_home_folder do
+    config = { 
+      'external' => %w[rails test_app],
+      'files' => { 
+        '/path/to/file.rb' => 'test_app' 
+      }
+    }
+    File.open('.tabtab.yml', 'w') do |f|
+      f << config.to_yaml
+    end
+  end
+end
+
+Given /^a file '(.*)' containing completion definitions$/ do |file|
+  Given "a safe folder"
+  in_project_folder do
+    File.open(file, "w") do |f|
+      f << <<-RUBY.gsub(/^        /,'')
+        TabTab::Definition.register('test_app') do |c|
+          c.flags :help, :h, "help"
+          c.flags :extra, :x
+        end
+      RUBY
+    end
+  end
+end
+
+Then %r{^external completions are ready to be installed for applications: (.*)$} do |app_list|
+  in_home_folder do
+    contents = File.read(".tabtab.bash")
+    app_list.split(/,\s*/).each do |app|
+      contents.should =~ /complete -o default -C 'tabtab --external' #{app}/
+    end
+  end
+end
+
+Then %r{^gem completions are ready to be installed for applications (.*) in gem (.*)$} do |app_list, gem_name|
+  in_home_folder do
+    contents = File.read(".tabtab.bash")
+    app_list.split(/,\s*/).each do |app|
+      contents.should =~ /complete -o default -C 'tabtab --gem #{gem_name}' #{app}/
+    end
+  end
+end
+
+Then %r{^gem completions are ready to be installed for application (.*) in gem (.*) in file (.*)$} do |app_name, gem_name, path|
+  in_home_folder do
+    contents = File.read(".tabtab.bash")
+    contents.should =~ %r{complete -o default -C 'tabtab --gem #{gem_name}/#{path}' #{app_name}}
+  end
+end
+
+Then %r{^file completions are ready to be installed for applications (.*) in file (.*)$} do |app_list, file_name|
+  in_home_folder do
+    contents = File.read(".tabtab.bash")
+    app_list.split(/,\s*/).each do |app|
+      contents.should =~ /complete -o default -C 'tabtab --file #{file_name}' #{app}/
+    end
+  end
+end
+

data/features/steps/common.rb

@@ -0,0 +1,211 @@
+def in_project_folder(&block)
+  project_folder = @active_project_folder || @tmp_root
+  FileUtils.chdir(project_folder, &block)
+end
+
+def in_home_folder(&block)
+  FileUtils.chdir(@home_path, &block)
+end
+
+Given %r{^a safe folder} do
+  unless @have_created_safe_folder
+    FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+    FileUtils.mkdir_p @tmp_root
+    FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home"))
+    @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+    Given "env variable $HOME set to '#{@home_path}'"
+    @have_created_safe_folder = true
+  end
+end
+
+Given %r{^this project is active project folder} do
+  Given "a safe folder"
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given %r{^env variable \$([\w_]+) set to '(.*)'} do |env_var, value|
+  ENV[env_var] = value
+end
+
+def force_local_lib_override(project_name = @project_name)
+  rakefile = File.read(File.join(project_name, 'Rakefile'))
+  File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+    f << "$:.unshift('#{@lib_path}')\n"
+    f << rakefile
+  end
+end
+
+def setup_active_project_folder project_name
+  @active_project_folder = File.join(@tmp_root, project_name)
+  @project_name = project_name
+end
+
+Given %r{'(.*)' folder is deleted} do |folder|
+  in_project_folder do
+    FileUtils.rm_rf folder
+  end
+end
+
+When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
+  FileUtils.chdir(@active_project_folder) do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES)
+  end
+end
+
+When %r{run project executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{run local executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  @stderr = File.expand_path(File.join(@tmp_root, "executable.err"))
+  bin_executable = File.expand_path("bin/#{executable}")
+  in_project_folder do
+    system "ruby #{bin_executable} #{arguments} > #{@stdout} 2> #{@stderr}"
+  end
+end
+
+When %r{^task 'rake (.*)' is invoked$} do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  in_project_folder do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then %r{^project folder '(.*)' is created} do |folder|
+  in_project_folder do
+    File.should be_exists(folder)
+  end
+end
+
+Then %r{^home folder '(.*)' is created} do |folder|
+  in_home_folder do
+    File.should be_exists(folder)
+  end
+end
+
+Then %r{^home file '(.*)' (is|is not) created} do |file, is|
+  in_home_folder do
+    if is == 'is'
+      File.should be_exists(file)
+    else
+      File.should_not be_exists(file)
+    end
+  end
+end
+
+Then %r{^project file with name matching '(.*)' is created} do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then %r{^home file with name matching '(.*)' is created} do |pattern|
+  in_home_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then %r{^output same as contents of '(.*)'$} do |file|
+  expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file))
+  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  actual_output.should == expected_output
+end
+
+Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator|
+  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then %r{help options '(.*)' and '(.*)' are displayed} do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then %r{^output (does|does not) match \/(.*)\/} do |does, regex|
+  actual_output = File.read(@stdout)
+  (does == 'does') ?
+    actual_output.should(match(/#{regex}/)) :
+    actual_output.should_not(match(/#{regex}/)) 
+end
+
+Then %r{^contents of file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then %r{^contents of home file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex|
+  in_home_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then %r{^all (\d+) tests pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^all (\d+) examples pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^yaml file '(.*)' contains (\{.*\})} do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then %r{^Rakefile can display tasks successfully} do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then %r{^task 'rake (.*)' is executed successfully} do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then %r{^gem spec key '(.*)' contains \/(.*)\/} do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end