thor-dleavitt 0.18.1

data/spec/helper.rb

@@ -0,0 +1,67 @@
+$TESTING=true
+
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'thor'
+require 'thor/group'
+require 'stringio'
+
+require 'rdoc'
+require 'rspec'
+require 'diff/lcs' # You need diff/lcs installed to run specs (but not to run Thor).
+require 'fakeweb'  # You need fakeweb installed to run specs (but not to run Thor).
+
+# Set shell to basic
+$0 = "thor"
+$thor_runner = true
+ARGV.clear
+Thor::Base.shell = Thor::Shell::Basic
+
+# Load fixtures
+load File.join(File.dirname(__FILE__), "fixtures", "enum.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "group.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "invoke.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "script.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "subcommand.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "command.thor")
+
+RSpec.configure do |config|
+  config.before do
+    ARGV.replace []
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+
+  def source_root
+    File.join(File.dirname(__FILE__), 'fixtures')
+  end
+
+  def destination_root
+    File.join(File.dirname(__FILE__), 'sandbox')
+  end
+
+  alias :silence :capture
+end

data/spec/invocation_spec.rb

@@ -0,0 +1,108 @@
+require 'helper'
+require 'thor/base'
+
+describe Thor::Invocation do
+  describe "#invoke" do
+    it "invokes a command inside another command" do
+      expect(capture(:stdout) { A.new.invoke(:two) }).to eq("2\n3\n")
+    end
+
+    it "invokes a command just once" do
+      expect(capture(:stdout) { A.new.invoke(:one) }).to eq("1\n2\n3\n")
+    end
+
+    it "invokes a command just once even if they belongs to different classes" do
+      expect(capture(:stdout) { Defined.new.invoke(:one) }).to eq("1\n2\n3\n4\n5\n")
+    end
+
+    it "invokes a command with arguments" do
+      expect(A.new.invoke(:five, [5])).to be_true
+      expect(A.new.invoke(:five, [7])).to be_false
+    end
+
+    it "invokes the default command if none is given to a Thor class" do
+      content = capture(:stdout) { A.new.invoke("b") }
+      expect(content).to match(/Commands/)
+      expect(content).to match(/LAST_NAME/)
+    end
+
+    it "accepts a class as argument without a command to invoke" do
+      content = capture(:stdout) { A.new.invoke(B) }
+      expect(content).to match(/Commands/)
+      expect(content).to match(/LAST_NAME/)
+    end
+
+    it "accepts a class as argument with a command to invoke" do
+      base = A.new([], :last_name => "Valim")
+      expect(base.invoke(B, :one, ["Jose"])).to eq("Valim, Jose")
+    end
+
+    it "allows customized options to be given" do
+      base = A.new([], :last_name => "Wrong")
+      expect(base.invoke(B, :one, ["Jose"], :last_name => "Valim")).to eq("Valim, Jose")
+    end
+
+    it "reparses options in the new class" do
+      expect(A.start(["invoker", "--last-name", "Valim"])).to eq("Valim, Jose")
+    end
+
+    it "shares initialize options with invoked class" do
+      expect(A.new([], :foo => :bar).invoke("b:two")).to eq({ "foo" => :bar })
+    end
+
+    it "uses default options from invoked class if no matching arguments are given" do
+      expect(A.new([]).invoke("b:four")).to eq("default")
+    end
+
+    it "overrides default options if options are passed to the invoker" do
+      expect(A.new([], { :defaulted_value => "not default"}).invoke("b:four")).to eq("not default")
+    end
+
+    it "dump configuration values to be used in the invoked class" do
+      base = A.new
+      expect(base.invoke("b:three").shell).to eq(base.shell)
+    end
+
+    it "allow extra configuration values to be given" do
+      base, shell = A.new, Thor::Base.shell.new
+      expect(base.invoke("b:three", [], {}, :shell => shell).shell).to eq(shell)
+    end
+
+    it "invokes a Thor::Group and all of its commands" do
+      expect(capture(:stdout) { A.new.invoke(:c) }).to eq("1\n2\n3\n")
+    end
+
+    it "does not invoke a Thor::Group twice" do
+      base = A.new
+      silence(:stdout){ base.invoke(:c) }
+      expect(capture(:stdout) { base.invoke(:c) }).to be_empty
+    end
+
+    it "does not invoke any of Thor::Group commands twice" do
+      base = A.new
+      silence(:stdout){ base.invoke(:c) }
+      expect(capture(:stdout) { base.invoke("c:one") }).to be_empty
+    end
+
+    it "raises Thor::UndefinedCommandError if the command can't be found" do
+      expect {
+        A.new.invoke("foo:bar")
+      }.to raise_error(Thor::UndefinedCommandError)
+    end
+
+    it "raises Thor::UndefinedCommandError if the command can't be found even if all commands were already executed" do
+      base = C.new
+      silence(:stdout){ base.invoke_all }
+
+      expect {
+        base.invoke("foo:bar")
+      }.to raise_error(Thor::UndefinedCommandError)
+    end
+
+    it "raises an error if a non Thor class is given" do
+      expect {
+        A.new.invoke(Object)
+      }.to raise_error(RuntimeError, "Expected Thor class, got Object")
+    end
+  end
+end

data/spec/parser/argument_spec.rb

@@ -0,0 +1,53 @@
+require 'helper'
+require 'thor/parser'
+
+describe Thor::Argument do
+
+  def argument(name, options={})
+    @argument ||= Thor::Argument.new(name, options)
+  end
+
+  describe "errors" do
+    it "raises an error if name is not supplied" do
+      expect {
+        argument(nil)
+      }.to raise_error(ArgumentError, "Argument name can't be nil.")
+    end
+
+    it "raises an error if type is unknown" do
+      expect {
+        argument(:command, :type => :unknown)
+      }.to raise_error(ArgumentError, "Type :unknown is not valid for arguments.")
+    end
+
+    it "raises an error if argument is required and has default values" do
+      expect {
+        argument(:command, :type => :string, :default => "bar", :required => true)
+      }.to raise_error(ArgumentError, "An argument cannot be required and have default value.")
+    end
+
+    it "raises an error if enum isn't an array" do
+      expect {
+        argument(:command, :type => :string, :enum => "bar")
+      }.to raise_error(ArgumentError, "An argument cannot have an enum other than an array.")
+    end
+  end
+
+  describe "#usage" do
+    it "returns usage for string types" do
+      expect(argument(:foo, :type => :string).usage).to eq("FOO")
+    end
+
+    it "returns usage for numeric types" do
+      expect(argument(:foo, :type => :numeric).usage).to eq("N")
+    end
+
+    it "returns usage for array types" do
+      expect(argument(:foo, :type => :array).usage).to eq("one two three")
+    end
+
+    it "returns usage for hash types" do
+      expect(argument(:foo, :type => :hash).usage).to eq("key:value")
+    end
+  end
+end

data/spec/parser/arguments_spec.rb

@@ -0,0 +1,66 @@
+require 'helper'
+require 'thor/parser'
+
+describe Thor::Arguments do
+  def create(opts={})
+    arguments = opts.map do |type, default|
+      options = {:required => default.nil?, :type => type, :default => default}
+      Thor::Argument.new(type.to_s, options)
+    end
+
+    arguments.sort!{ |a,b| b.name <=> a.name }
+    @opt = Thor::Arguments.new(arguments)
+  end
+
+  def parse(*args)
+    @opt.parse(args)
+  end
+
+  describe "#parse" do
+    it "parses arguments in the given order" do
+      create :string => nil, :numeric => nil
+      expect(parse("name", "13")["string"]).to eq("name")
+      expect(parse("name", "13")["numeric"]).to eq(13)
+    end
+
+    it "accepts hashes" do
+      create :string => nil, :hash => nil
+      expect(parse("product", "title:string", "age:integer")["string"]).to eq("product")
+      expect(parse("product", "title:string", "age:integer")["hash"]).to eq({ "title" => "string", "age" => "integer"})
+      expect(parse("product", "url:http://www.amazon.com/gp/product/123")["hash"]).to eq({ "url" => "http://www.amazon.com/gp/product/123" })
+    end
+
+    it "accepts arrays" do
+      create :string => nil, :array => nil
+      expect(parse("product", "title", "age")["string"]).to eq("product")
+      expect(parse("product", "title", "age")["array"]).to eq(%w(title age))
+    end
+
+    describe "with no inputs" do
+      it "and no arguments returns an empty hash" do
+        create
+        expect(parse).to eq({})
+      end
+
+      it "and required arguments raises an error" do
+        create :string => nil, :numeric => nil
+        expect{ parse }.to raise_error(Thor::RequiredArgumentMissingError, "No value provided for required arguments 'string', 'numeric'")
+      end
+
+      it "and default arguments returns default values" do
+        create :string => "name", :numeric => 13
+        expect(parse).to eq({ "string" => "name", "numeric" => 13 })
+      end
+    end
+
+    it "returns the input if it's already parsed" do
+      create :string => nil, :hash => nil, :array => nil, :numeric => nil
+      expect(parse("", 0, {}, [])).to eq({ "string" => "", "numeric" => 0, "hash" => {}, "array" => [] })
+    end
+
+    it "returns the default value if none is provided" do
+      create :string => "foo", :numeric => 3.0
+      expect(parse("bar")).to eq({ "string" => "bar", "numeric" => 3.0 })
+    end
+  end
+end

data/spec/parser/option_spec.rb

@@ -0,0 +1,202 @@
+require 'helper'
+require 'thor/parser'
+
+describe Thor::Option do
+  def parse(key, value)
+    Thor::Option.parse(key, value)
+  end
+
+  def option(name, options={})
+    @option ||= Thor::Option.new(name, options)
+  end
+
+  describe "#parse" do
+
+    describe "with value as a symbol" do
+      describe "and symbol is a valid type" do
+        it "has type equals to the symbol" do
+          expect(parse(:foo, :string).type).to eq(:string)
+          expect(parse(:foo, :numeric).type).to eq(:numeric)
+        end
+
+        it "has no default value" do
+          expect(parse(:foo, :string).default).to be_nil
+          expect(parse(:foo, :numeric).default).to be_nil
+        end
+      end
+
+      describe "equals to :required" do
+        it "has type equals to :string" do
+          expect(parse(:foo, :required).type).to eq(:string)
+        end
+
+        it "has no default value" do
+          expect(parse(:foo, :required).default).to be_nil
+        end
+      end
+
+      describe "and symbol is not a reserved key" do
+        it "has type equal to :string" do
+          expect(parse(:foo, :bar).type).to eq(:string)
+        end
+
+        it "has no default value" do
+          expect(parse(:foo, :bar).default).to be_nil
+        end
+      end
+    end
+
+    describe "with value as hash" do
+      it "has default type :hash" do
+        expect(parse(:foo, :a => :b).type).to eq(:hash)
+      end
+
+      it "has default value equal to the hash" do
+        expect(parse(:foo, :a => :b).default).to eq({ :a => :b })
+      end
+    end
+
+    describe "with value as array" do
+      it "has default type :array" do
+        expect(parse(:foo, [:a, :b]).type).to eq(:array)
+      end
+
+      it "has default value equal to the array" do
+        expect(parse(:foo, [:a, :b]).default).to eq([:a, :b])
+      end
+    end
+
+    describe "with value as string" do
+      it "has default type :string" do
+        expect(parse(:foo, "bar").type).to eq(:string)
+      end
+
+      it "has default value equal to the string" do
+        expect(parse(:foo, "bar").default).to eq("bar")
+      end
+    end
+
+    describe "with value as numeric" do
+      it "has default type :numeric" do
+        expect(parse(:foo, 2.0).type).to eq(:numeric)
+      end
+
+      it "has default value equal to the numeric" do
+        expect(parse(:foo, 2.0).default).to eq(2.0)
+      end
+    end
+
+    describe "with value as boolean" do
+      it "has default type :boolean" do
+        expect(parse(:foo, true).type).to eq(:boolean)
+        expect(parse(:foo, false).type).to eq(:boolean)
+      end
+
+      it "has default value equal to the boolean" do
+        expect(parse(:foo, true).default).to eq(true)
+        expect(parse(:foo, false).default).to eq(false)
+      end
+    end
+
+    describe "with key as a symbol" do
+      it "sets the name equal to the key" do
+        expect(parse(:foo, true).name).to eq("foo")
+      end
+    end
+
+    describe "with key as an array" do
+      it "sets the first items in the array to the name" do
+        expect(parse([:foo, :bar, :baz], true).name).to eq("foo")
+      end
+
+      it "sets all other items as aliases" do
+        expect(parse([:foo, :bar, :baz], true).aliases).to eq([:bar, :baz])
+      end
+    end
+  end
+
+  it "returns the switch name" do
+    expect(option("foo").switch_name).to eq("--foo")
+    expect(option("--foo").switch_name).to eq("--foo")
+  end
+
+  it "returns the human name" do
+    expect(option("foo").human_name).to eq("foo")
+    expect(option("--foo").human_name).to eq("foo")
+  end
+
+  it "converts underscores to dashes" do
+    expect(option("foo_bar").switch_name).to eq("--foo-bar")
+  end
+
+  it "can be required and have default values" do
+    option = option("foo", :required => true, :type => :string, :default => "bar")
+    expect(option.default).to eq("bar")
+    expect(option).to be_required
+  end
+
+  it "boolean options cannot be required" do
+    expect {
+      option("foo", :required => true, :type => :boolean)
+    }.to raise_error(ArgumentError, "An option cannot be boolean and required.")
+  end
+
+  it "allows type predicates" do
+    expect(parse(:foo, :string)).to be_string
+    expect(parse(:foo, :boolean)).to be_boolean
+    expect(parse(:foo, :numeric)).to be_numeric
+  end
+
+  it "raises an error on method missing" do
+    expect {
+      parse(:foo, :string).unknown?
+    }.to raise_error(NoMethodError)
+  end
+
+  describe "#usage" do
+
+    it "returns usage for string types" do
+      expect(parse(:foo, :string).usage).to eq("[--foo=FOO]")
+    end
+
+    it "returns usage for numeric types" do
+      expect(parse(:foo, :numeric).usage).to eq("[--foo=N]")
+    end
+
+    it "returns usage for array types" do
+      expect(parse(:foo, :array).usage).to eq("[--foo=one two three]")
+    end
+
+    it "returns usage for hash types" do
+      expect(parse(:foo, :hash).usage).to eq("[--foo=key:value]")
+    end
+
+    it "returns usage for boolean types" do
+      expect(parse(:foo, :boolean).usage).to eq("[--foo]")
+    end
+
+    it "does not use padding when no aliases are given" do
+      expect(parse(:foo, :boolean).usage).to eq("[--foo]")
+    end
+
+    it "uses banner when supplied" do
+      expect(option(:foo, :required => false, :type => :string, :banner => "BAR").usage).to eq("[--foo=BAR]")
+    end
+
+    it "checks when banner is an empty string" do
+      expect(option(:foo, :required => false, :type => :string, :banner => "").usage).to eq("[--foo]")
+    end
+
+    describe "with required values" do
+      it "does not show the usage between brackets" do
+        expect(parse(:foo, :required).usage).to eq("--foo=FOO")
+      end
+    end
+
+    describe "with aliases" do
+      it "does not show the usage between brackets" do
+        expect(parse([:foo, "-f", "-b"], :required).usage).to eq("-f, -b, --foo=FOO")
+      end
+    end
+  end
+end