thor 0.14.4 → 0.14.5

data/spec/parser/options_spec.rb

@@ -20,133 +20,133 @@ describe Thor::Options do
 
   describe "#to_switches" do
     it "turns true values into a flag" do
-      Thor::Options.to_switches(:color => true).must == "--color"
+      Thor::Options.to_switches(:color => true).should == "--color"
     end
 
     it "ignores nil" do
-      Thor::Options.to_switches(:color => nil).must == ""
+      Thor::Options.to_switches(:color => nil).should == ""
     end
 
     it "ignores false" do
-      Thor::Options.to_switches(:color => false).must == ""
+      Thor::Options.to_switches(:color => false).should == ""
     end
 
     it "writes --name value for anything else" do
-      Thor::Options.to_switches(:format => "specdoc").must == '--format "specdoc"'
+      Thor::Options.to_switches(:format => "specdoc").should == '--format "specdoc"'
     end
 
     it "joins several values" do
       switches = Thor::Options.to_switches(:color => true, :foo => "bar").split(' ').sort
-      switches.must == ['"bar"', "--color", "--foo"]
+      switches.should == ['"bar"', "--color", "--foo"]
     end
 
     it "accepts arrays" do
-      Thor::Options.to_switches(:count => [1,2,3]).must == "--count 1 2 3"
+      Thor::Options.to_switches(:count => [1,2,3]).should == "--count 1 2 3"
     end
 
     it "accepts hashes" do
-      Thor::Options.to_switches(:count => {:a => :b}).must == "--count a:b"
+      Thor::Options.to_switches(:count => {:a => :b}).should == "--count a:b"
     end
-    
+
     it "accepts underscored options" do
-      Thor::Options.to_switches(:under_score_option => "foo bar").must == '--under_score_option "foo bar"'
+      Thor::Options.to_switches(:under_score_option => "foo bar").should == '--under_score_option "foo bar"'
     end
-    
+
   end
 
   describe "#parse" do
     it "allows multiple aliases for a given switch" do
       create ["--foo", "--bar", "--baz"] => :string
-      parse("--foo", "12")["foo"].must == "12"
-      parse("--bar", "12")["foo"].must == "12"
-      parse("--baz", "12")["foo"].must == "12"
+      parse("--foo", "12")["foo"].should == "12"
+      parse("--bar", "12")["foo"].should == "12"
+      parse("--baz", "12")["foo"].should == "12"
     end
 
     it "allows custom short names" do
       create "-f" => :string
-      parse("-f", "12").must == {"f" => "12"}
+      parse("-f", "12").should == {"f" => "12"}
     end
 
     it "allows custom short-name aliases" do
       create ["--bar", "-f"] => :string
-      parse("-f", "12").must == {"bar" => "12"}
+      parse("-f", "12").should == {"bar" => "12"}
     end
 
     it "accepts conjoined short switches" do
       create ["--foo", "-f"] => true, ["--bar", "-b"] => true, ["--app", "-a"] => true
       opts = parse("-fba")
-      opts["foo"].must be_true
-      opts["bar"].must be_true
-      opts["app"].must be_true
+      opts["foo"].should be_true
+      opts["bar"].should be_true
+      opts["app"].should be_true
     end
 
     it "accepts conjoined short switches with input" do
       create ["--foo", "-f"] => true, ["--bar", "-b"] => true, ["--app", "-a"] => :required
       opts = parse "-fba", "12"
-      opts["foo"].must be_true
-      opts["bar"].must be_true
-      opts["app"].must == "12"
+      opts["foo"].should be_true
+      opts["bar"].should be_true
+      opts["app"].should == "12"
     end
 
     it "returns the default value if none is provided" do
       create :foo => "baz", :bar => :required
-      parse("--bar", "boom")["foo"].must == "baz"
+      parse("--bar", "boom")["foo"].should == "baz"
     end
 
     it "returns the default value from defaults hash to required arguments" do
       create Hash[:bar => :required], Hash[:bar => "baz"]
-      parse["bar"].must == "baz"
+      parse["bar"].should == "baz"
     end
 
     it "gives higher priority to defaults given in the hash" do
       create Hash[:bar => true], Hash[:bar => false]
-      parse["bar"].must == false
+      parse["bar"].should == false
     end
 
     it "raises an error for unknown switches" do
       create :foo => "baz", :bar => :required
       parse("--bar", "baz", "--baz", "unknown")
-      lambda { check_unknown! }.must raise_error(Thor::UnknownArgumentError, "Unknown switches '--baz'")
+      lambda { check_unknown! }.should raise_error(Thor::UnknownArgumentError, "Unknown switches '--baz'")
     end
-    
+
     it "skips leading non-switches" do
       create(:foo => "baz")
-      
-      parse("asdf", "--foo", "bar").must == {"foo" => "bar"}
+
+      parse("asdf", "--foo", "bar").should == {"foo" => "bar"}
     end
 
     it "correctly recognizes things that look kind of like options, but aren't, as not options" do
       create(:foo => "baz")
-      parse("--asdf---asdf", "baz", "--foo", "--asdf---dsf--asdf").must == {"foo" => "--asdf---dsf--asdf"}
+      parse("--asdf---asdf", "baz", "--foo", "--asdf---dsf--asdf").should == {"foo" => "--asdf---dsf--asdf"}
       check_unknown!
     end
-    
+
     it "excepts underscores in commandline args hash for boolean" do
       create :foo_bar => :boolean
-      parse("--foo_bar")["foo_bar"].must == true
-      parse("--no_foo_bar")["foo_bar"].must == false
+      parse("--foo_bar")["foo_bar"].should == true
+      parse("--no_foo_bar")["foo_bar"].should == false
     end
-    
+
     it "excepts underscores in commandline args hash for strings" do
       create :foo_bar => :string, :baz_foo => :string
-      parse("--foo_bar", "baz")["foo_bar"].must == "baz"
-      parse("--baz_foo", "foo bar")["baz_foo"].must == "foo bar"
+      parse("--foo_bar", "baz")["foo_bar"].should == "baz"
+      parse("--baz_foo", "foo bar")["baz_foo"].should == "foo bar"
     end
 
     describe "with no input" do
       it "and no switches returns an empty hash" do
         create({})
-        parse.must == {}
+        parse.should == {}
       end
 
       it "and several switches returns an empty hash" do
         create "--foo" => :boolean, "--bar" => :string
-        parse.must == {}
+        parse.should == {}
       end
 
       it "and a required switch raises an error" do
         create "--foo" => :required
-        lambda { parse }.must raise_error(Thor::RequiredArgumentMissingError, "No value provided for required options '--foo'")
+        lambda { parse }.should raise_error(Thor::RequiredArgumentMissingError, "No value provided for required options '--foo'")
       end
     end
 
@@ -156,20 +156,20 @@ describe Thor::Options do
       end
 
       it "raises an error if the required switch has no argument" do
-        lambda { parse("--foo") }.must raise_error(Thor::MalformattedArgumentError)
+        lambda { parse("--foo") }.should raise_error(Thor::MalformattedArgumentError)
       end
 
       it "raises an error if the required switch isn't given" do
-        lambda { parse("--bar") }.must raise_error(Thor::RequiredArgumentMissingError)
+        lambda { parse("--bar") }.should raise_error(Thor::RequiredArgumentMissingError)
       end
 
       it "raises an error if the required switch is set to nil" do
-        lambda { parse("--no-foo") }.must raise_error(Thor::RequiredArgumentMissingError)
+        lambda { parse("--no-foo") }.should raise_error(Thor::RequiredArgumentMissingError)
       end
 
       it "does not raises an error if the required option has a default value" do
         create :foo => Thor::Option.new("foo", nil, true, :string, "baz"), :bar => :boolean
-        lambda { parse("--bar") }.must_not raise_error
+        lambda { parse("--bar") }.should_not raise_error
       end
     end
 
@@ -179,43 +179,43 @@ describe Thor::Options do
       end
 
       it "accepts a switch <value> assignment" do
-        parse("--foo", "12")["foo"].must == "12"
+        parse("--foo", "12")["foo"].should == "12"
       end
 
       it "accepts a switch=<value> assignment" do
-        parse("-f=12")["foo"].must == "12"
-        parse("--foo=12")["foo"].must == "12"
-        parse("--foo=bar=baz")["foo"].must == "bar=baz"
+        parse("-f=12")["foo"].should == "12"
+        parse("--foo=12")["foo"].should == "12"
+        parse("--foo=bar=baz")["foo"].should == "bar=baz"
       end
-      
+
       it "must accept underscores switch=value assignment" do
         create :foo_bar => :required
-        parse("--foo_bar=http://example.com/under_score/")["foo_bar"].must == "http://example.com/under_score/"
+        parse("--foo_bar=http://example.com/under_score/")["foo_bar"].should == "http://example.com/under_score/"
       end
 
       it "accepts a --no-switch format" do
         create "--foo" => "bar"
-        parse("--no-foo")["foo"].must be_nil
+        parse("--no-foo")["foo"].should be_nil
       end
 
       it "does not consume an argument for --no-switch format" do
         create "--cheese" => :string
-        parse('burger', '--no-cheese', 'fries')["cheese"].must be_nil
+        parse('burger', '--no-cheese', 'fries')["cheese"].should be_nil
       end
 
       it "accepts a --switch format on non required types" do
         create "--foo" => :string
-        parse("--foo")["foo"].must == "foo"
+        parse("--foo")["foo"].should == "foo"
       end
-      
+
       it "accepts a --switch format on non required types with default values" do
         create "--baz" => :string, "--foo" => "bar"
-        parse("--baz", "bang", "--foo")["foo"].must == "bar"
+        parse("--baz", "bang", "--foo")["foo"].should == "bar"
       end
 
       it "overwrites earlier values with later values" do
-        parse("--foo=bar", "--foo", "12")["foo"].must == "12"
-        parse("--foo", "12", "--foo", "13")["foo"].must == "13"
+        parse("--foo=bar", "--foo", "12")["foo"].should == "12"
+        parse("--foo", "12", "--foo", "13")["foo"].should == "13"
       end
     end
 
@@ -225,38 +225,38 @@ describe Thor::Options do
       end
 
       it "accepts --opt assignment" do
-        parse("--foo")["foo"].must == true
-        parse("--foo", "--bar")["foo"].must == true
+        parse("--foo")["foo"].should == true
+        parse("--foo", "--bar")["foo"].should == true
       end
 
       it "accepts --opt=value assignment" do
-        parse("--foo=true")["foo"].must == true
-        parse("--foo=false")["foo"].must == false
+        parse("--foo=true")["foo"].should == true
+        parse("--foo=false")["foo"].should == false
       end
 
       it "accepts --[no-]opt variant, setting false for value" do
-        parse("--no-foo")["foo"].must == false
+        parse("--no-foo")["foo"].should == false
       end
 
       it "accepts --[skip-]opt variant, setting false for value" do
-        parse("--skip-foo")["foo"].must == false
+        parse("--skip-foo")["foo"].should == false
       end
 
       it "will prefer 'no-opt' variant over inverting 'opt' if explicitly set" do
         create "--no-foo" => true
-        parse("--no-foo")["no-foo"].must == true
+        parse("--no-foo")["no-foo"].should == true
       end
 
       it "will prefer 'skip-opt' variant over inverting 'opt' if explicitly set" do
         create "--skip-foo" => true
-        parse("--skip-foo")["skip-foo"].must == true
+        parse("--skip-foo")["skip-foo"].should == true
       end
 
       it "accepts inputs in the human name format" do
         create :foo_bar => :boolean
-        parse("--foo-bar")["foo_bar"].must == true
-        parse("--no-foo-bar")["foo_bar"].must == false
-        parse("--skip-foo-bar")["foo_bar"].must == false
+        parse("--foo-bar")["foo_bar"].should == true
+        parse("--no-foo-bar")["foo_bar"].should == false
+        parse("--skip-foo-bar")["foo_bar"].should == false
       end
     end
 
@@ -266,15 +266,15 @@ describe Thor::Options do
       end
 
       it "accepts a switch=<value> assignment" do
-        parse("--attributes=name:string", "age:integer")["attributes"].must == {"name" => "string", "age" => "integer"}
+        parse("--attributes=name:string", "age:integer")["attributes"].should == {"name" => "string", "age" => "integer"}
       end
 
       it "accepts a switch <value> assignment" do
-        parse("--attributes", "name:string", "age:integer")["attributes"].must == {"name" => "string", "age" => "integer"}
+        parse("--attributes", "name:string", "age:integer")["attributes"].should == {"name" => "string", "age" => "integer"}
       end
 
       it "must not mix values with other switches" do
-        parse("--attributes", "name:string", "age:integer", "--baz", "cool")["attributes"].must == {"name" => "string", "age" => "integer"}
+        parse("--attributes", "name:string", "age:integer", "--baz", "cool")["attributes"].should == {"name" => "string", "age" => "integer"}
       end
     end
 
@@ -284,15 +284,15 @@ describe Thor::Options do
       end
 
       it "accepts a switch=<value> assignment" do
-        parse("--attributes=a", "b", "c")["attributes"].must == ["a", "b", "c"]
+        parse("--attributes=a", "b", "c")["attributes"].should == ["a", "b", "c"]
       end
 
       it "accepts a switch <value> assignment" do
-        parse("--attributes", "a", "b", "c")["attributes"].must == ["a", "b", "c"]
+        parse("--attributes", "a", "b", "c")["attributes"].should == ["a", "b", "c"]
       end
 
       it "must not mix values with other switches" do
-        parse("--attributes", "a", "b", "c", "--baz", "cool")["attributes"].must == ["a", "b", "c"]
+        parse("--attributes", "a", "b", "c", "--baz", "cool")["attributes"].should == ["a", "b", "c"]
       end
     end
 
@@ -302,15 +302,15 @@ describe Thor::Options do
       end
 
       it "accepts a -nXY assignment" do
-        parse("-n12")["n"].must == 12
+        parse("-n12")["n"].should == 12
       end
 
       it "converts values to numeric types" do
-        parse("-n", "3", "-m", ".5").must == {"n" => 3, "m" => 0.5}
+        parse("-n", "3", "-m", ".5").should == {"n" => 3, "m" => 0.5}
       end
 
       it "raises error when value isn't numeric" do
-        lambda { parse("-n", "foo") }.must raise_error(Thor::MalformattedArgumentError,
+        lambda { parse("-n", "foo") }.should raise_error(Thor::MalformattedArgumentError,
           "Expected numeric value for '-n'; got \"foo\"")
       end
     end

data/spec/rake_compat_spec.rb

@@ -6,7 +6,7 @@ class RakeTask < Rake::TaskLib
   def initialize
     define
   end
-  
+
   def define
     desc "Say it's cool"
     task :cool do
@@ -28,41 +28,41 @@ end
 
 describe Thor::RakeCompat do
   it "sets the rakefile application" do
-    ["rake_compat_spec.rb", "Thorfile"].must include(Rake.application.rakefile)
+    ["rake_compat_spec.rb", "Thorfile"].should include(Rake.application.rakefile)
   end
 
   it "adds rake tasks to thor classes too" do
     task = ThorTask.tasks["cool"]
-    task.must be
+    task.should be
   end
 
   it "uses rake tasks descriptions on thor" do
-    ThorTask.tasks["cool"].description.must == "Say it's cool"
+    ThorTask.tasks["cool"].description.should == "Say it's cool"
   end
 
   it "gets usage from rake tasks name" do
-    ThorTask.tasks["cool"].usage.must == "cool"
+    ThorTask.tasks["cool"].usage.should == "cool"
   end
 
   it "uses non namespaced name as description if non is available" do
-    ThorTask::HiperMega.tasks["super"].description.must == "super"
+    ThorTask::HiperMega.tasks["super"].description.should == "super"
   end
 
   it "converts namespaces to classes" do
-    ThorTask.const_get(:HiperMega).must == ThorTask::HiperMega
+    ThorTask.const_get(:HiperMega).should == ThorTask::HiperMega
   end
 
   it "does not add tasks from higher namespaces in lowers namespaces" do
-    ThorTask.tasks["super"].must_not be
+    ThorTask.tasks["super"].should_not be
   end
 
   it "invoking the thor task invokes the rake task" do
     capture(:stdout) do
       ThorTask.start ["cool"]
-    end.must == "COOL\n"
+    end.should == "COOL\n"
 
     capture(:stdout) do
       ThorTask::HiperMega.start ["super"]
-    end.must == "HIPER MEGA SUPER\n"
+    end.should == "HIPER MEGA SUPER\n"
   end
 end

data/spec/register_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class BoringVendorProvidedCLI < Thor
+  desc "boring", "do boring stuff"
+  def boring
+    puts "bored. <yawn>"
+  end
+end
+
+class ExcitingPluginCLI < Thor
+  desc "hooray", "say hooray!"
+  def hooray
+    puts "hooray!"
+  end
+
+  desc "fireworks", "exciting fireworks!"
+  def fireworks
+    puts "kaboom!"
+  end
+end
+
+class SuperSecretPlugin < Thor
+  default_task :squirrel
+
+  desc "squirrel", "All of secret squirrel's secrets"
+  def squirrel
+    puts "I love nuts"
+  end
+end
+
+class GroupPlugin < Thor::Group
+  desc "part one"
+  def part_one
+    puts "part one"
+  end
+
+  desc "part two"
+  def part_two
+    puts "part two"
+  end
+end
+
+
+BoringVendorProvidedCLI.register(
+  ExcitingPluginCLI,
+  "exciting",
+  "do exciting things",
+  "Various non-boring actions")
+
+BoringVendorProvidedCLI.register(
+  SuperSecretPlugin,
+  "secret",
+  "secret stuff",
+  "Nothing to see here. Move along.",
+  :hide => true)
+
+BoringVendorProvidedCLI.register(
+  GroupPlugin,
+  'groupwork',
+  "Do a bunch of things in a row",
+  "purple monkey dishwasher")
+
+describe ".register-ing a Thor subclass" do
+  it "registers the plugin as a subcommand" do
+    fireworks_output = capture(:stdout) { BoringVendorProvidedCLI.start(%w[exciting fireworks]) }
+    fireworks_output.should == "kaboom!\n"
+  end
+
+  it "includes the plugin's usage in the help" do
+    help_output = capture(:stdout) { BoringVendorProvidedCLI.start(%w[help]) }
+    help_output.should include('do exciting things')
+  end
+
+  context "when hidden" do
+    it "omits the hidden plugin's usage from the help" do
+      help_output = capture(:stdout) { BoringVendorProvidedCLI.start(%w[help]) }
+      help_output.should_not include('secret stuff')
+    end
+
+    it "registers the plugin as a subcommand" do
+      secret_output = capture(:stdout) { BoringVendorProvidedCLI.start(%w[secret squirrel]) }
+      secret_output.should == "I love nuts\n"
+    end
+  end
+end
+
+describe ".register-ing a Thor::Group subclass" do
+  it "registers the group as a single command" do
+    group_output = capture(:stdout) { BoringVendorProvidedCLI.start(%w[groupwork]) }
+    group_output.should == "part one\npart two\n"
+  end
+end