wijet-thor 0.14.6

data/spec/shell/color_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Thor::Shell::Color do
+  def shell
+    @shell ||= Thor::Shell::Color.new
+  end
+
+  describe "#say" do
+    it "set the color if specified" do
+      $stdout.should_receive(:puts).with("\e[32mWow! Now we have colors!\e[0m")
+      shell.say "Wow! Now we have colors!", :green
+    end
+
+    it "does not use a new line even with colors" do
+      $stdout.should_receive(:print).with("\e[32mWow! Now we have colors! \e[0m")
+      shell.say "Wow! Now we have colors! ", :green
+    end
+  end
+
+  describe "#say_status" do
+    it "uses color to say status" do
+      $stdout.should_receive(:puts).with("\e[1m\e[31m    conflict\e[0m  README")
+      shell.say_status :conflict, "README", :red
+    end
+  end
+
+  describe "#file_collision" do
+    describe "when a block is given" do
+      it "invokes the diff command" do
+        $stdout.stub!(:print)
+        $stdin.should_receive(:gets).and_return('d')
+        $stdin.should_receive(:gets).and_return('n')
+
+        output = capture(:stdout){ shell.file_collision('spec/fixtures/doc/README'){ "README\nEND\n" } }
+        output.should =~ /\e\[31m\- __start__\e\[0m/
+        output.should =~ /^  README/
+        output.should =~ /\e\[32m\+ END\e\[0m/
+      end
+    end
+  end
+end

data/spec/shell/html_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Thor::Shell::HTML do
+  def shell
+    @shell ||= Thor::Shell::HTML.new
+  end
+
+  describe "#say" do
+    it "set the color if specified" do
+      $stdout.should_receive(:puts).with('<span style="color: green;">Wow! Now we have colors!</span>')
+      shell.say "Wow! Now we have colors!", :green
+    end
+
+    it "does not use a new line even with colors" do
+      $stdout.should_receive(:print).with('<span style="color: green;">Wow! Now we have colors! </span>')
+      shell.say "Wow! Now we have colors! ", :green
+    end
+  end
+
+  describe "#say_status" do
+    it "uses color to say status" do
+      $stdout.should_receive(:puts).with('<strong><span style="color: red;">    conflict</span></strong>  README')
+      shell.say_status :conflict, "README", :red
+    end
+  end
+
+end

data/spec/shell_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Thor::Shell do
+  def shell
+    @shell ||= Thor::Base.shell.new
+  end
+
+  describe "#initialize" do
+    it "sets shell value" do
+      base = MyCounter.new [1, 2], { }, :shell => shell
+      base.shell.should == shell
+    end
+
+    it "sets the base value on the shell if an accessor is available" do
+      base = MyCounter.new [1, 2], { }, :shell => shell
+      shell.base.should == base
+    end
+  end
+
+  describe "#shell" do
+    it "returns the shell in use" do
+      MyCounter.new([1,2]).shell.should be_kind_of(Thor::Base.shell)
+    end
+
+    it "uses $THOR_SHELL" do
+      class Thor::Shell::TestShell < Thor::Shell::Basic; end
+
+      Thor::Base.shell.should == shell.class
+      ENV['THOR_SHELL'] = 'TestShell'
+      Thor::Base.shell = nil
+      Thor::Base.shell.should == Thor::Shell::TestShell
+      ENV['THOR_SHELL'] = ''
+      Thor::Base.shell = shell.class
+      Thor::Base.shell.should == shell.class
+    end
+  end
+
+  describe "with_padding" do
+    it "uses padding for inside block outputs" do
+      base = MyCounter.new([1,2])
+      base.with_padding do
+        capture(:stdout){ base.say_status :padding, "cool" }.strip.should == "padding    cool"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+$TESTING=true
+
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Libraries', 'lib'
+  add_group 'Specs', 'spec'
+end
+
+$:.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", "task.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "group.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "script.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "invoke.thor")
+
+RSpec.configure do |config|
+  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/task_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Thor::Task do
+  def task(options={})
+    options.each do |key, value|
+      options[key] = Thor::Option.parse(key, value)
+    end
+
+    @task ||= Thor::Task.new(:can_has, "I can has cheezburger", "I can has cheezburger\nLots and lots of it", "can_has", options)
+  end
+
+  describe "#formatted_usage" do
+    it "includes namespace within usage" do
+      Object.stub!(:namespace).and_return("foo")
+      Object.stub!(:arguments).and_return([])
+      task(:bar => :required).formatted_usage(Object).should == "foo:can_has --bar=BAR"
+    end
+
+    it "includes subcommand name within subcommand usage" do
+      object = Struct.new(:namespace, :arguments).new("main:foo", [])
+      task(:bar => :required).formatted_usage(object, false, true).should == "foo can_has --bar=BAR"
+    end
+
+    it "removes default from namespace" do
+      Object.stub!(:namespace).and_return("default:foo")
+      Object.stub!(:arguments).and_return([])
+      task(:bar => :required).formatted_usage(Object).should == ":foo:can_has --bar=BAR"
+    end
+
+    it "injects arguments into usage" do
+      Object.stub!(:namespace).and_return("foo")
+      Object.stub!(:arguments).and_return([ Thor::Argument.new(:bar, nil, true, :string) ])
+      task(:foo => :required).formatted_usage(Object).should == "foo:can_has BAR --foo=FOO"
+    end
+  end
+
+  describe "#dynamic" do
+    it "creates a dynamic task with the given name" do
+      Thor::DynamicTask.new('task').name.should == 'task'
+      Thor::DynamicTask.new('task').description.should == 'A dynamically-generated task'
+      Thor::DynamicTask.new('task').usage.should == 'task'
+      Thor::DynamicTask.new('task').options.should == {}
+    end
+
+    it "does not invoke an existing method" do
+      mock = mock()
+      mock.class.should_receive(:handle_no_task_error).with("to_s")
+      Thor::DynamicTask.new('to_s').run(mock)
+    end
+  end
+
+  describe "#dup" do
+    it "dup options hash" do
+      task = Thor::Task.new("can_has", nil, nil, nil, :foo => true, :bar => :required)
+      task.dup.options.delete(:foo)
+      task.options[:foo].should_not be_nil
+    end
+  end
+
+  describe "#run" do
+    it "runs a task by calling a method in the given instance" do
+      mock = mock()
+      mock.should_receive(:send).with("can_has", 1, 2, 3)
+      task.run(mock, [1, 2, 3])
+    end
+
+    it "raises an error if the method to be invoked is private" do
+      mock = mock()
+      mock.should_receive(:private_methods).and_return(['can_has'])
+      mock.class.should_receive(:handle_no_task_error).with("can_has")
+      task.run(mock)
+    end
+  end
+end

data/spec/thor_spec.rb

@@ -0,0 +1,334 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Thor do
+  describe "#method_option" do
+    it "sets options to the next method to be invoked" do
+      args = ["foo", "bar", "--force"]
+      arg, options = MyScript.start(args)
+      options.should == { "force" => true }
+    end
+
+    describe ":lazy_default" do
+      it "is absent when option is not specified" do
+        arg, options = MyScript.start(["with_optional"])
+        options.should == {}
+      end
+
+      it "sets a default that can be overridden for strings" do
+        arg, options = MyScript.start(["with_optional", "--lazy"])
+        options.should == { "lazy" => "yes" }
+
+        arg, options = MyScript.start(["with_optional", "--lazy", "yesyes!"])
+        options.should == { "lazy" => "yesyes!" }
+      end
+
+      it "sets a default that can be overridden for numerics" do
+        arg, options = MyScript.start(["with_optional", "--lazy-numeric"])
+        options.should == { "lazy_numeric" => 42 }
+
+        arg, options = MyScript.start(["with_optional", "--lazy-numeric", 20000])
+        options.should == { "lazy_numeric" => 20000 }
+      end
+
+      it "sets a default that can be overridden for arrays" do
+        arg, options = MyScript.start(["with_optional", "--lazy-array"])
+        options.should == { "lazy_array" => %w[eat at joes] }
+
+        arg, options = MyScript.start(["with_optional", "--lazy-array", "hello", "there"])
+        options.should == { "lazy_array" => %w[hello there] }
+      end
+
+      it "sets a default that can be overridden for hashes" do
+        arg, options = MyScript.start(["with_optional", "--lazy-hash"])
+        options.should == { "lazy_hash" => {'swedish' => 'meatballs'} }
+
+        arg, options = MyScript.start(["with_optional", "--lazy-hash", "polish:sausage"])
+        options.should == { "lazy_hash" => {'polish' => 'sausage'} }
+      end
+    end
+
+    describe "when :for is supplied" do
+      it "updates an already defined task" do
+        args, options = MyChildScript.start(["animal", "horse", "--other=fish"])
+        options[:other].should == "fish"
+      end
+
+      describe "and the target is on the parent class" do
+        it "updates an already defined task" do
+          args = ["example_default_task", "my_param", "--new-option=verified"]
+          options = Scripts::MyScript.start(args)
+          options[:new_option].should == "verified"
+        end
+
+        it "adds a task to the tasks list if the updated task is on the parent class" do
+          Scripts::MyScript.tasks["example_default_task"].should_not be_nil
+        end
+
+        it "clones the parent task" do
+          Scripts::MyScript.tasks["example_default_task"].should_not == MyChildScript.tasks["example_default_task"]
+        end
+      end
+    end
+  end
+
+  describe "#default_task" do
+    it "sets a default task" do
+      MyScript.default_task.should == "example_default_task"
+    end
+
+    it "invokes the default task if no command is specified" do
+      MyScript.start([]).should == "default task"
+    end
+
+    it "invokes the default task if no command is specified even if switches are given" do
+      MyScript.start(["--with", "option"]).should == {"with"=>"option"}
+    end
+
+    it "inherits the default task from parent" do
+      MyChildScript.default_task.should == "example_default_task"
+    end
+  end
+
+  describe "#map" do
+    it "calls the alias of a method if one is provided" do
+      MyScript.start(["-T", "fish"]).should == ["fish"]
+    end
+
+    it "calls the alias of a method if several are provided via .map" do
+      MyScript.start(["-f", "fish"]).should == ["fish", {}]
+      MyScript.start(["--foo", "fish"]).should == ["fish", {}]
+    end
+
+    it "inherits all mappings from parent" do
+      MyChildScript.default_task.should == "example_default_task"
+    end
+  end
+
+  describe "#desc" do
+    it "provides description for a task" do
+      content = capture(:stdout) { MyScript.start(["help"]) }
+      content.should =~ /thor my_script:zoo\s+# zoo around/m
+    end
+
+    it "provides no namespace if $thor_runner is false" do
+      begin
+        $thor_runner = false
+        content = capture(:stdout) { MyScript.start(["help"]) }
+        content.should =~ /thor zoo\s+# zoo around/m
+      ensure
+        $thor_runner = true
+      end
+    end
+
+    describe "when :for is supplied" do
+      it "overwrites a previous defined task" do
+        capture(:stdout) { MyChildScript.start(["help"]) }.should =~ /animal KIND \s+# fish around/m
+      end
+    end
+
+    describe "when :hide is supplied" do
+      it "does not show the task in help" do
+        capture(:stdout) { MyScript.start(["help"]) }.should_not =~ /this is hidden/m
+      end
+
+      it "but the task is still invokcable not show the task in help" do
+        MyScript.start(["hidden", "yesyes"]).should == ["yesyes"]
+      end
+    end
+  end
+
+  describe "#method_options" do
+    it "sets default options if called before an initializer" do
+      options = MyChildScript.class_options
+      options[:force].type.should == :boolean
+      options[:param].type.should == :numeric
+    end
+
+    it "overwrites default options if called on the method scope" do
+      args = ["zoo", "--force", "--param", "feathers"]
+      options = MyChildScript.start(args)
+      options.should == { "force" => true, "param" => "feathers" }
+    end
+
+    it "allows default options to be merged with method options" do
+      args = ["animal", "bird", "--force", "--param", "1.0", "--other", "tweets"]
+      arg, options = MyChildScript.start(args)
+      arg.should == 'bird'
+      options.should == { "force"=>true, "param"=>1.0, "other"=>"tweets" }
+    end
+  end
+
+  describe "#start" do
+    it "calls a no-param method when no params are passed" do
+      MyScript.start(["zoo"]).should == true
+    end
+
+    it "calls a single-param method when a single param is passed" do
+      MyScript.start(["animal", "fish"]).should == ["fish"]
+    end
+
+    it "does not set options in attributes" do
+      MyScript.start(["with_optional", "--all"]).should == [nil, { "all" => true }]
+    end
+
+    it "raises an error if a required param is not provided" do
+      capture(:stderr) { MyScript.start(["animal"]) }.strip.should == '"animal" was called incorrectly. Call as "thor my_script:animal TYPE".'
+    end
+
+    it "raises an error if the invoked task does not exist" do
+      capture(:stderr) { Amazing.start(["animal"]) }.strip.should == 'Could not find task "animal" in "amazing" namespace.'
+    end
+
+    it "calls method_missing if an unknown method is passed in" do
+      MyScript.start(["unk", "hello"]).should == [:unk, ["hello"]]
+    end
+
+    it "does not call a private method no matter what" do
+      capture(:stderr) { MyScript.start(["what"]) }.strip.should == 'Could not find task "what" in "my_script" namespace.'
+    end
+
+    it "uses task default options" do
+      options = MyChildScript.start(["animal", "fish"]).last
+      options.should == { "other" => "method default" }
+    end
+
+    it "raises when an exception happens within the task call" do
+      lambda { MyScript.start(["call_myself_with_wrong_arity"]) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "#subcommand" do
+    it "maps a given subcommand to another Thor subclass" do
+      barn_help = capture(:stdout){ Scripts::MyDefaults.start(["barn"]) }
+      barn_help.should include("barn help [COMMAND]  # Describe subcommands or one specific subcommand")
+    end
+
+    it "passes commands to subcommand classes" do
+      capture(:stdout){ Scripts::MyDefaults.start(["barn", "open"]) }.strip.should == "Open sesame!"
+    end
+
+    it "passes arguments to subcommand classes" do
+      capture(:stdout){ Scripts::MyDefaults.start(["barn", "open", "shotgun"]) }.strip.should == "That's going to leave a mark."
+    end
+
+    it "ignores unknown options (the subcommand class will handle them)" do
+      capture(:stdout){ Scripts::MyDefaults.start(["barn", "paint", "blue", "--coats", "4"])}.strip.should == "4 coats of blue paint"
+    end
+  end
+
+  describe "#help" do
+    def shell
+      @shell ||= Thor::Base.shell.new
+    end
+
+    describe "on general" do
+      before(:each) do
+        @content = capture(:stdout){ MyScript.help(shell) }
+      end
+
+      it "provides useful help info for the help method itself" do
+        @content.should =~ /help \[TASK\]\s+# Describe available tasks/
+      end
+
+      it "provides useful help info for a method with params" do
+        @content.should =~ /animal TYPE\s+# horse around/
+      end
+
+      it "uses the maximum terminal size to show tasks" do
+        @shell.should_receive(:terminal_width).and_return(80)
+        content = capture(:stdout){ MyScript.help(shell) }
+        content.should =~ /aaa\.\.\.$/
+      end
+
+      it "provides description for tasks from classes in the same namespace" do
+        @content.should =~ /baz\s+# do some bazing/
+      end
+
+      it "shows superclass tasks" do
+        content = capture(:stdout){ MyChildScript.help(shell) }
+        content.should =~ /foo BAR \s+# do some fooing/
+      end
+
+      it "shows class options information" do
+        content = capture(:stdout){ MyChildScript.help(shell) }
+        content.should =~ /Options\:/
+        content.should =~ /\[\-\-param=N\]/
+      end
+
+      it "injects class arguments into default usage" do
+        content = capture(:stdout){ Scripts::MyScript.help(shell) }
+        content.should =~ /zoo ACCESSOR \-\-param\=PARAM/
+      end
+    end
+
+    describe "for a specific task" do
+      it "provides full help info when talking about a specific task" do
+        capture(:stdout) { MyScript.task_help(shell, "foo") }.should == <<-END
+Usage:
+  thor my_script:foo BAR
+
+Options:
+  [--force]  # Force to do some fooing
+
+do some fooing
+  This is more info!
+  Everyone likes more info!
+END
+      end
+
+      it "raises an error if the task can't be found" do
+        lambda {
+          MyScript.task_help(shell, "unknown")
+        }.should raise_error(Thor::UndefinedTaskError, 'Could not find task "unknown" in "my_script" namespace.')
+      end
+
+      it "normalizes names before claiming they don't exist" do
+        capture(:stdout) { MyScript.task_help(shell, "name-with-dashes") }.should =~ /thor my_script:name-with-dashes/
+      end
+
+      it "uses the long description if it exists" do
+        capture(:stdout) { MyScript.task_help(shell, "long_description") }.should == <<-HELP
+Usage:
+  thor my_script:long_description
+
+Description:
+  This is a really really really long description. Here you go. So very long.
+
+  It even has two paragraphs.
+HELP
+      end
+
+      it "doesn't assign the long description to the next task without one" do
+        capture(:stdout) do
+          MyScript.task_help(shell, "name_with_dashes")
+        end.should_not =~ /so very long/i
+      end
+    end
+
+    describe "instance method" do
+      it "calls the class method" do
+        capture(:stdout){ MyScript.start(["help"]) }.should =~ /Tasks:/
+      end
+
+      it "calls the class method" do
+        capture(:stdout){ MyScript.start(["help", "foo"]) }.should =~ /Usage:/
+      end
+    end
+  end
+
+  describe "when creating tasks" do
+    it "prints a warning if a public method is created without description or usage" do
+      capture(:stdout) {
+        klass = Class.new(Thor)
+        klass.class_eval "def hello_from_thor; end"
+      }.should =~ /\[WARNING\] Attempted to create task "hello_from_thor" without usage or description/
+    end
+
+    it "does not print if overwriting a previous task" do
+      capture(:stdout) {
+        klass = Class.new(Thor)
+        klass.class_eval "def help; end"
+      }.should be_empty
+    end
+  end
+end