tabtab 0.9.0

data/spec/external_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TabTab::Completions::External, "extract verbose help output" do
+  before(:each) do
+    options_str = <<-EOS.gsub(/^    /, '')
+    Options are ...
+        -C, --classic-namespace          Put Task and FileTask in the top level namespace
+        -D, --describe [PATTERN]         Describe the tasks (matching optional PATTERN), then exit.
+        -e, --execute CODE               Execute some Ruby code and exit.
+        -p, --execute-print CODE         Execute some Ruby code, print the result, then exit.
+        -P, --prereqs                    Display the tasks and dependencies, then exit.
+            --rakelib
+        -G, --no-system, --nosystem      Use standard project Rakefile search paths, ignore system wide rakefiles.
+        -h, -H, --help                   Display this help message.
+
+    Options:
+        -r, --ruby=path                  Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).
+                                         Default: /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
+        -d, --database=name              Preconfigure for selected database (options: mysql/oracle/postgresql/sqlite2/sqlite3/frontbase/ibm_db).
+                                         Default: sqlite3
+        -f, --freeze                     Freeze Rails in vendor/rails from the gems generating the skeleton
+                                         Default: false
+
+     Options:
+         -b=BIN_NAME[,BIN_NAME2]          Should --ignore inline option
+             --bin-name                   Default: -x
+    EOS
+    @options = TabTab::Completions::External.new('app_name').extract(options_str)
+  end
+  
+  it "should find all options" do
+    long_options  = %w[--bin-name --classic-namespace --database --describe --execute] +
+                    %w[--execute-print --freeze --help --no-system --nosystem --prereqs --rakelib --ruby]
+    short_options = %w[ -C -D -G -H -P -b -d -e -f -h -p -r]
+    expected      = long_options + short_options
+    @options.should == expected
+  end
+end

data/spec/fixtures/bin/test_app

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+if ARGV.include?('-h') || ARGV.include?('--help')
+  puts <<-EOS
+  Options:
+     -h, --help         Shows this help
+     -x, --extra        Does extra stuff
+  EOS
+else
+  puts "This is a friendly app. Use -h or --help to see options"
+end

data/spec/fixtures/gems/multi_app/History.txt

@@ -0,0 +1,2 @@
+require "rubygems"
+

data/spec/fixtures/gems/multi_app/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+Rakefile
+bin/test_app
+lib/multi_app.rb
+lib/tabtab_definitions/some_app.rb
+multi_app.gemspec

data/spec/fixtures/gems/multi_app/Rakefile

@@ -0,0 +1,25 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/multi_app'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('multi_app', MultiApp::VERSION) do |p|
+  p.developer('Dr Nic Williams', 'drnicwilliams@gmail.com')
+  p.summary        = "Multiple CLI apps + in-built autocompletions"
+  p.description    = "Multiple CLI apps + in-built autocompletions"
+  p.changes        = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  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 }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/spec/fixtures/gems/multi_app/bin/test_app

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+if ARGV.include?('-h') || ARGV.include?('--help')
+  puts <<-EOS
+  Options:
+     -h, --help         Shows this help
+     -x, --extra        Does extra stuff
+  EOS
+else
+  puts "This is a friendly app. Use -h or --help to see options"
+end

data/spec/fixtures/gems/multi_app/lib/multi_app.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module MultiApp
+  VERSION = '0.0.1'
+end

data/spec/fixtures/gems/multi_app/lib/tabtab_definitions/some_app.rb

@@ -0,0 +1,5 @@
+TabTab::Definition.register('test_app') do |c|
+  c.flags :help, :h, "help"
+  c.flags :extra, :x
+end
+

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

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{multi_app}
+  s.version = "0.0.1"
+
+  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.default_executable = %q{test_app}
+  s.description = %q{Multiple CLI apps + in-built autocompletions}
+  s.email = ["drnicwilliams@gmail.com"]
+  s.executables = ["test_app"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["History.txt", "Manifest.txt", "Rakefile", "bin/test_app", "lib/multi_app.rb", "lib/tabtab_definitions/some_app.rb", "multi_app.gemspec"]
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{multi_app}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Multiple CLI apps + in-built autocompletions}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.1.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/spec/fixtures/gems/my_app/History.txt

@@ -0,0 +1,2 @@
+require "rubygems"
+

data/spec/fixtures/gems/my_app/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+Rakefile
+bin/test_app
+lib/my_app.rb
+lib/tabtab_definitions.rb
+my_app.gemspec

data/spec/fixtures/gems/my_app/Rakefile

@@ -0,0 +1,25 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/my_app'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('my_app', MyApp::VERSION) do |p|
+  p.developer('Dr Nic Williams', 'drnicwilliams@gmail.com')
+  p.summary        = "Simple CLI app + in-built autocompletions"
+  p.description    = "Simple CLI app + in-built autocompletions"
+  p.changes        = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  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 }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/spec/fixtures/gems/my_app/bin/test_app

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+if ARGV.include?('-h') || ARGV.include?('--help')
+  puts <<-EOS
+  Options:
+     -h, --help         Shows this help
+     -x, --extra        Does extra stuff
+  EOS
+else
+  puts "This is a friendly app. Use -h or --help to see options"
+end

data/spec/fixtures/gems/my_app/lib/my_app.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module MyApp
+  VERSION = '0.0.1'
+end

data/spec/fixtures/gems/my_app/lib/tabtab_definitions.rb

@@ -0,0 +1,5 @@
+TabTab::Definition.register('test_app') do |c|
+  c.flags :help, :h, "help"
+  c.flags :extra, :x
+end
+

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

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{my_app}
+  s.version = "0.0.1"
+
+  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.default_executable = %q{test_app}
+  s.description = %q{Simple CLI app + in-built autocompletions}
+  s.email = ["drnicwilliams@gmail.com"]
+  s.executables = ["test_app"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["History.txt", "Manifest.txt", "Rakefile", "bin/test_app", "lib/my_app.rb", "lib/tabtab_definitions.rb", "my_app.gemspec"]
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{my_app}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simple CLI app + in-built autocompletions}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.1.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.1.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/spec/framework_testing_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "tabtab/framework_testing"
+
+describe TabTab::FrameworkTesting, "can be auto-completed with simple flag" do
+  before(:each) do
+    @definitions = TabTab::Definition::Root.named('myapp') do |c|
+      c.flags :flag, :f
+    end
+  end
+  
+  it "should allow 'myapp --flag'" do
+    'myapp --flag'.should be_autocompletable_from(@definitions)
+  end
+end
+
+describe TabTab::FrameworkTesting, "can be auto-completed with simple command" do
+  before(:each) do
+    @definitions = TabTab::Definition::Root.named('myapp') do |c|
+      c.command :run
+      c.command :stop
+    end
+  end
+  
+  %w[run stop].each do |cmd|
+    it "should allow 'myapp #{cmd}'" do
+      "myapp #{cmd}".should be_autocompletable_from(@definitions)
+    end
+  end
+end
+
+describe TabTab::FrameworkTesting, "can be auto-completed with command and an argument" do
+  before(:each) do
+    @definitions = TabTab::Definition::Root.named('myapp') do |c|
+      c.command :run do
+        %w[aaaa bbbb cccc]
+      end
+      c.command :stop do |stop|
+        stop.default do
+          %w[aaaa bbbb cccc]
+        end
+      end
+    end
+  end
+  
+  it "should allow 'myapp run'" do
+    'myapp run'.should be_autocompletable_from(@definitions)
+  end
+
+  %w[run stop].each do |cmd|
+    it "should allow 'myapp #{cmd} bbbb'" do
+      "myapp #{cmd} bbbb".should be_autocompletable_from(@definitions)
+    end
+  end
+  
+end

data/spec/install_tabtab_cli_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'install_tabtab/cli'
+
+describe InstallTabTab::CLI, "with --development CLI flag" do
+  before(:each) 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([])
+    @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")
+      expects(:close)
+    end)
+    @stdout_io = StringIO.new
+  end
+  
+  it "should point to local dev bin/tabtab instead of global tabtab CLI" do
+    @cli.execute(@stdout_io, ['--development'])
+  end
+end
+
+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([])
+    @stdout_io = StringIO.new
+  end
+  
+  it "should create a home file .tabtab.bash" do
+    @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 'tabtab --external' test_app\n")
+      expects(:close)
+    end)
+    @cli.execute(@stdout_io, [])
+  end
+
+  it "should create a home file .tabtab.bash for alternate help flag" do
+    @cli.expects(:config).returns({"external" => [{"-h" => "test_app"}]}).at_least(2)
+    File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
+      expects(:<<).with("complete -o default -C 'tabtab --external' test_app\n")
+      expects(:close)
+    end)
+    @cli.execute(@stdout_io, [])
+  end
+
+  it "should create a home file .tabtab.bash for an alias" do
+    @cli.expects(:config).returns({"external" => %w[test_app], "alias" => { "test" => "test_app" }}).at_least(2)
+    File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
+      expects(:<<).with("complete -o default -C 'tabtab --external' test_app\n")
+      expects(:<<).with("complete -o default -C 'tabtab --external --alias test_app' test\n")
+      expects(:close)
+    end)
+    @cli.execute(@stdout_io, [])
+  end
+
+  it "should create a home file .tabtab.bash for several aliases" do
+    @cli.expects(:config).returns({"external" => %w[test_app], "aliases" => { "test" => "test_app", "t" => "test_app" }}).at_least(2)
+    File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
+      expects(:<<).with("complete -o default -C 'tabtab --external' test_app\n")
+      expects(:<<).with("complete -o default -C 'tabtab --external --alias test_app' test\n")
+      expects(:<<).with("complete -o default -C 'tabtab --external --alias test_app' t\n")
+      expects(:close)
+    end)
+    @cli.execute(@stdout_io, [])
+  end
+
+end
+
+describe InstallTabTab::CLI, "with --gem GEM_NAME app flag" do
+  before(:each) 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'])
+    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)
+    TabTab::Definition.expects(:app_names).returns(%w[tabtabbed_app another_app])
+    File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
+      expects(:<<).with("complete -o default -C 'tabtab --gem gem_with_tabtabs' tabtabbed_app\n")
+      expects(:<<).with("complete -o default -C 'tabtab --gem gem_with_tabtabs' another_app\n")
+      expects(:close)
+    end)
+    @stdout_io = StringIO.new
+  end
+  
+  it "should create a home file .tabtab.bash" do
+    @cli.execute(@stdout_io, [])
+  end
+
+end
+
+describe InstallTabTab::CLI, "with --gem GEM_NAME/PATH flag" do
+  before(:each) 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'])
+    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)
+    TabTab::Definition.expects(:clear).at_least(1)
+    TabTab::Definition.expects(:app_names).returns(%w[tabtabbed_app another_app])
+    File.expects(:open).with('/tmp/some/home/.tabtab.bash', 'w').returns(mock do
+      expects(:<<).with("complete -o default -C 'tabtab --gem gem_with_tabtabs/lib/tabtab_definitions/tabtabbed_app.rb' tabtabbed_app\n")
+      expects(:<<).with("complete -o default -C 'tabtab --gem gem_with_tabtabs/lib/tabtab_definitions/tabtabbed_app.rb' another_app\n")
+      expects(:close)
+    end)
+    @stdout_io = StringIO.new
+  end
+  
+  it "should create a home file .tabtab.bash" do
+    @cli.execute(@stdout_io, [])
+  end
+
+end
+
+describe InstallTabTab::CLI, "with --file FILE_NAME app flag" do
+  before(:each) 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([])
+    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)
+    end)
+    @stdout_io = StringIO.new
+  end
+  
+  it "should create a home file .tabtab.bash" do
+    @cli.execute(@stdout_io, [])
+  end
+
+end
+