excavator 0.0.1

data/test/unit/namespace_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+context "Namespace" do
+  include Excavator
+
+  setup do
+    @namespace = Namespace.new
+  end
+
+  test "add command to namespace" do
+    cmd = MiniTest::Mock.new
+    cmd.expect(:name, :cmd)
+    @namespace << cmd
+    assert_equal cmd.object_id, @namespace.command(:cmd).object_id
+  end
+
+  test "add namespace to namespace" do
+    ns = Namespace.new("child")
+    @namespace << ns
+    assert_equal ns, @namespace.namespace(:child)
+  end
+
+  test "add namespace to namespace creates a connection" do
+    ns = Namespace.new("child")
+    @namespace << ns
+    assert_equal ns.parent, @namespace
+  end
+
+  test "#fullname" do
+    assert_equal "", @namespace.full_name
+
+    ns1 = Namespace.new("first")
+    @namespace << ns1
+    assert_equal "first", ns1.full_name
+
+    ns2 = Namespace.new("second")
+    ns1 << ns2
+    assert_equal "first:second", ns2.full_name
+  end
+
+  test "#commands_and_descriptions returns names and description" do
+    cmd = MiniTest::Mock.new
+    cmd.expect(:name, "command")
+    cmd.expect(:desc, "command description")
+    @namespace << cmd
+
+    ns1 = Namespace.new("first")
+    @namespace << ns1
+
+    inner_cmd = MiniTest::Mock.new
+    inner_cmd.expect(:name, "inner_command")
+    inner_cmd.expect(:desc, "inner command description")
+    ns1 << inner_cmd
+
+    expected = [
+      ["command", "command description"],
+      ["first:inner_command", "inner command description"]
+    ]
+    assert_equal expected, @namespace.commands_and_descriptions
+  end
+end

data/test/unit/param_parser_test.rb

@@ -0,0 +1,128 @@
+require 'test_helper'
+
+context "ParamParser" do
+  include Excavator
+
+  setup do
+    @parser = ParamParser.new
+    @parser.name = "test-command"
+  end
+
+  test "parses params into a hash using long switches" do
+    @parser.build(
+      :params => [ Param.new(:region), Param.new(:size) ]
+    )
+
+    hash = @parser.parse!(["--region", "us-east-1", "--size", "large"])
+    assert_equal({:region => "us-east-1", :size => "large"}, hash)
+  end
+
+  test "automatically assigns short switches via param name's first char" do
+    param = Param.new(:region)
+    @parser.build(:params => [param])
+    hash = @parser.parse!(["-r", "us-east-1"])
+    assert_equal({:region => "us-east-1"}, hash)
+  end
+
+  test "automatically detects short switch collisions" do
+    param1 = Param.new(:region)
+    param2 = Param.new(:rate)
+    @parser.build(:params => [param1, param2])
+
+    hash = @parser.parse!(["-r", "region", "-a", "rate"])
+    assert_equal({:region => "region", :rate => "rate"}, hash)
+  end
+
+  test "use given short switch if specified" do
+    param = Param.new(:region, :short => "n")
+    @parser.build(:params => [param])
+    hash = @parser.parse!(["-n", "us-east-1"])
+    assert_equal({:region => "us-east-1"}, hash)
+  end
+
+  test "no switch is given if all possible switches are used" do
+    param1 = Param.new(:abc)
+    param2 = Param.new(:bcd)
+    param3 = Param.new(:aabb) # No switch available
+    @parser.build(:params => [param1, param2, param3])
+
+    assert_nil param3.short
+  end
+
+  test "sets up defaults" do
+    param = Param.new(:region, :default => "us-east-1")
+    @parser.build(:params => [param])
+    hash = @parser.parse!([])
+    assert_equal({:region => "us-east-1"}, hash)
+  end
+
+  test "params can be optional" do
+    param = Param.new(:region, :optional => true)
+    @parser.build(:params => [param])
+    hash = @parser.parse!([])
+    assert_equal({}, hash)
+  end
+
+  test "pass parsed params in" do
+    param1 = Param.new(:region)
+    param2 = Param.new(:server)
+    @parser.build(:params => [param1, param2])
+    hash = @parser.parse!([{:region => 'us-west', :server => '111'}])
+
+    assert_equal({:region => 'us-west', :server => '111'}, hash)
+  end
+
+  test "#usage" do
+    required_param = Param.new(
+      :server_id, :desc => "Server instance id"
+    )
+    param_with_default = Param.new(
+      :image, :desc => "Image to use", :default => "ami-test"
+    )
+    optional_param = Param.new(
+      :region, :optional => true, :desc => "A region to use"
+    )
+    @parser.build(
+      :params => [ optional_param, required_param, param_with_default ],
+      :name => "test-command",
+      :desc => "test description"
+    )
+
+    assert_equal <<-USAGE, @parser.usage
+test description
+
+USAGE: test-command [options]
+
+REQUIRED:
+    -s, --server_id=SERVER_ID        Server instance id
+
+OPTIONAL:
+    -r, --region=REGION              A region to use
+    -i, --image=IMAGE                Image to use
+                                     Defaults to: ami-test
+
+    -h, --help                       This message.
+    USAGE
+  end
+
+  test "raises error when required params are missing" do
+    param = Param.new(:region)
+    @parser.build(:params => [param])
+
+    assert_raises MissingParamsError do
+      @parser.parse!([])
+    end
+  end
+
+  test "MissingParam error has all the missing attributes" do
+    param1 = Param.new(:arg1)
+    param2 = Param.new(:arg2)
+    @parser.build(:params => [param1, param2])
+
+    exception = assert_raises MissingParamsError do
+      @parser.parse!([])
+    end
+
+    assert_equal [:arg1, :arg2], exception.params
+  end
+end

data/test/unit/runner_test.rb

@@ -0,0 +1,107 @@
+require 'test_helper'
+
+context "Runner" do
+  setup do
+    @runner = Excavator::Runner.new
+  end
+
+  test "default namespace" do
+    assert_equal :default, @runner.namespace.name
+  end
+
+  test "default namespace has no parent" do
+    assert_nil @runner.namespace.parent
+  end
+
+  test "#current_namespace returns namespaced command scope" do
+    first_namespace = nil
+    second_namespace = nil
+    @runner.in_namespace(:first) do
+      first_namespace = @runner.current_namespace
+      @runner.in_namespace(:second) do
+        second_namespace = @runner.current_namespace
+      end
+    end
+
+    assert_equal :first, first_namespace.name
+    assert_equal :second, second_namespace.name
+  end
+
+  test "#last_command keeps track of the last command" do
+    cmd1 = @runner.last_command
+    cmd2 = @runner.last_command
+    assert_equal cmd1.object_id, cmd2.object_id
+  end
+
+  test "#clear_last_command! does what it's name says" do
+    cmd1 = @runner.last_command
+    @runner.clear_last_command!
+    cmd2 = @runner.last_command
+
+    refute_equal cmd1.object_id, cmd2.object_id
+  end
+
+  test "add namespace" do
+    ns = Excavator::Namespace.new(:servers)
+    @runner.current_namespace << ns
+    assert_equal ns, @runner.current_namespace.namespace(:servers)
+  end
+
+  test "add a command to the runner" do
+    cmd = MiniTest::Mock.new
+    cmd.expect(:name, :server)
+    @runner.current_namespace << cmd
+    assert_equal cmd.object_id, @runner.find_command(:server).object_id
+  end
+
+  test "add command and namespace with the same name" do
+    ns = Excavator::Namespace.new(:server)
+    cmd = MiniTest::Mock.new
+    cmd.expect(:name, :server)
+
+    @runner.current_namespace << ns
+    @runner.current_namespace << cmd
+
+    assert_equal cmd.object_id, @runner.find_command("server").object_id
+    assert ns, @runner.current_namespace.namespace(:server)
+  end
+end
+
+
+context "Loading excavator commands from files (Runner#run)" do
+  setup do
+    Excavator.reset!
+    Excavator.runner.command_paths = [
+      basedir.join("test", "fixtures", "commands")
+    ]
+  end
+
+  test "execute a command" do
+    out, error = capture_io do
+      Excavator.runner.run("test")
+    end
+    assert_match /test command/, out
+  end
+
+  test "2-level namespace command" do
+    out, error = capture_io do
+      Excavator.runner.run("first:second:third")
+    end
+    assert_match /third/, out
+  end
+
+  test "execute command with default argument" do
+    out, error = capture_io do
+      Excavator.runner.run("command_with_arg")
+    end
+    assert_match /west/, out
+  end
+
+  test "execute command overriding default argument" do
+    out, error = capture_io do
+      Excavator.runner.run("command_with_arg", "-r", "east")
+    end
+    assert_match /east/, out
+  end
+end
+

data/test/unit/table_view_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+context "TableView" do
+  include Excavator
+
+  test "prints table title" do
+    table_view = TableView.new do |t|
+      t.title "Table View"
+    end
+
+    out, error = capture_io { puts table_view }
+    assert_match /^Table View$/, out
+  end
+
+  test "prints out headers" do
+    table_view = TableView.new do |t|
+      t.header "header1"
+      t.header "header2"
+    end
+
+    out, error = capture_io do
+      puts table_view
+    end
+
+    assert_match /^header1 \| header2$/, out
+  end
+
+  test "prints data aligned to headers" do
+    table_view = TableView.new do |t|
+      t.header :name
+      t.header :url
+
+      t.record "Google", "http://www.google.com"
+    end
+
+    out, error = capture_io { puts table_view }
+    lines = out.split("\n")
+
+    assert_match /^name\s\s \| url\s{18}$/, lines[0]
+    assert_match %r{Google \| http://www\.google\.com}, lines[1]
+  end
+
+  test "changing divider" do
+    table_view = TableView.new do |t|
+      t.header :name
+      t.header :url
+      t.divider "\t"
+    end
+
+    out, error = capture_io { puts table_view }
+    assert_match /^name\turl$/, out
+  end
+
+  test "complains when adding a record with not enough values" do
+    assert_raises TableView::InvalidDataForHeaders do
+      table_view = TableView.new do |t|
+        t.header :name
+        t.record 1, 2
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: excavator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Bui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70321668148280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70321668148280
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70321668147020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321668147020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70321668145740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321668145740
+description: ! 'Excavator is a scripting framework for writing multi-command executables
+  for the
+
+  unix environment.
+
+'
+email:
+- peter@paydrotalks.com
+executables:
+- excavator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/excavator
+- excavator.gemspec
+- lib/excavator.rb
+- lib/excavator/command.rb
+- lib/excavator/dsl.rb
+- lib/excavator/environment.rb
+- lib/excavator/namespace.rb
+- lib/excavator/param.rb
+- lib/excavator/param_parser.rb
+- lib/excavator/runner.rb
+- lib/excavator/table_view.rb
+- lib/excavator/version.rb
+- test/fixtures/commands/test.rb
+- test/test_helper.rb
+- test/unit/command_test.rb
+- test/unit/dsl_test.rb
+- test/unit/environment_test.rb
+- test/unit/namespace_test.rb
+- test/unit/param_parser_test.rb
+- test/unit/runner_test.rb
+- test/unit/table_view_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A scripting framework for *nix systems.
+test_files:
+- test/fixtures/commands/test.rb
+- test/test_helper.rb
+- test/unit/command_test.rb
+- test/unit/dsl_test.rb
+- test/unit/environment_test.rb
+- test/unit/namespace_test.rb
+- test/unit/param_parser_test.rb
+- test/unit/runner_test.rb
+- test/unit/table_view_test.rb
+has_rdoc: