millisami-thor 0.14.6

data/spec/runner_spec.rb

@@ -0,0 +1,210 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+require 'thor/runner'
+
+describe Thor::Runner do
+  describe "#help" do
+    it "shows information about Thor::Runner itself" do
+      capture(:stdout){ Thor::Runner.start(["help"]) }.should =~ /List the available thor tasks/
+    end
+
+    it "shows information about an specific Thor::Runner task" do
+      content = capture(:stdout){ Thor::Runner.start(["help", "list"]) }
+      content.should =~ /List the available thor tasks/
+      content.should_not =~ /help \[TASK\]/
+    end
+
+    it "shows information about a specific Thor class" do
+      content = capture(:stdout){ Thor::Runner.start(["help", "my_script"]) }
+      content.should =~ /zoo\s+# zoo around/m
+    end
+
+    it "shows information about an specific task from an specific Thor class" do
+      content = capture(:stdout){ Thor::Runner.start(["help", "my_script:zoo"]) }
+      content.should =~ /zoo around/
+      content.should_not =~ /help \[TASK\]/
+    end
+
+    it "shows information about a specific Thor group class" do
+      content = capture(:stdout){ Thor::Runner.start(["help", "my_counter"]) }
+      content.should =~ /my_counter N/
+    end
+
+    it "raises error if a class/task cannot be found" do
+      content = capture(:stderr){ Thor::Runner.start(["help", "unknown"]) }
+      content.strip.should == 'Could not find task "unknown" in "default" namespace.'
+    end
+  end
+
+  describe "#start" do
+    it "invokes a task from Thor::Runner" do
+      ARGV.replace ["list"]
+      capture(:stdout){ Thor::Runner.start }.should =~ /my_counter N/
+    end
+
+    it "invokes a task from a specific Thor class" do
+      ARGV.replace ["my_script:zoo"]
+      Thor::Runner.start.should be_true
+    end
+
+    it "invokes the default task from a specific Thor class if none is specified" do
+      ARGV.replace ["my_script"]
+      Thor::Runner.start.should == "default task"
+    end
+
+    it "forwads arguments to the invoked task" do
+      ARGV.replace ["my_script:animal", "horse"]
+      Thor::Runner.start.should == ["horse"]
+    end
+
+    it "invokes tasks through shortcuts" do
+      ARGV.replace ["my_script", "-T", "horse"]
+      Thor::Runner.start.should == ["horse"]
+    end
+
+    it "invokes a Thor::Group" do
+      ARGV.replace ["my_counter", "1", "2", "--third", "3"]
+      Thor::Runner.start.should == [1, 2, 3]
+    end
+
+    it "raises an error if class/task can't be found" do
+      ARGV.replace ["unknown"]
+      content = capture(:stderr){ Thor::Runner.start }
+      content.strip.should == 'Could not find task "unknown" in "default" namespace.'
+    end
+
+    it "does not swallow NoMethodErrors that occur inside the called method" do
+      ARGV.replace ["my_script:call_unexistent_method"]
+      lambda { Thor::Runner.start }.should raise_error(NoMethodError)
+    end
+
+    it "does not swallow Thor::Group InvocationError" do
+      ARGV.replace ["whiny_generator"]
+      lambda { Thor::Runner.start }.should raise_error(ArgumentError, /Are you sure it has arity equals to 0\?/)
+    end
+
+    it "does not swallow Thor InvocationError" do
+      ARGV.replace ["my_script:animal"]
+      content = capture(:stderr) { Thor::Runner.start }
+      content.strip.should == '"animal" was called incorrectly. Call as "thor my_script:animal TYPE".'
+    end
+  end
+
+  describe "tasks" do
+    before(:each) do
+      @location = "#{File.dirname(__FILE__)}/fixtures/task.thor"
+      @original_yaml = {
+        "random" => {
+          :location  => @location,
+          :filename  => "4a33b894ffce85d7b412fc1b36f88fe0",
+          :namespaces => ["amazing"]
+        }
+      }
+
+      root_file = File.join(Thor::Util.thor_root, "thor.yml")
+
+      # Stub load and save to avoid thor.yaml from being overwritten
+      YAML.stub!(:load_file).and_return(@original_yaml)
+      File.stub!(:exists?).with(root_file).and_return(true)
+      File.stub!(:open).with(root_file, "w")
+    end
+
+    describe "list" do
+      it "gives a list of the available tasks" do
+        ARGV.replace ["list"]
+        content = capture(:stdout) { Thor::Runner.start }
+        content.should =~ /amazing:describe NAME\s+# say that someone is amazing/m
+      end
+
+      it "gives a list of the available Thor::Group classes" do
+        ARGV.replace ["list"]
+        capture(:stdout) { Thor::Runner.start }.should =~ /my_counter N/
+      end
+
+      it "can filter a list of the available tasks by --group" do
+        ARGV.replace ["list", "--group", "standard"]
+        capture(:stdout) { Thor::Runner.start }.should =~ /amazing:describe NAME/
+        ARGV.replace []
+        capture(:stdout) { Thor::Runner.start }.should_not =~ /my_script:animal TYPE/
+        ARGV.replace ["list", "--group", "script"]
+        capture(:stdout) { Thor::Runner.start }.should =~ /my_script:animal TYPE/
+      end
+
+      it "can skip all filters to show all tasks using --all" do
+        ARGV.replace ["list", "--all"]
+        content = capture(:stdout) { Thor::Runner.start }
+        content.should =~ /amazing:describe NAME/
+        content.should =~ /my_script:animal TYPE/
+      end
+
+      it "doesn't list superclass tasks in the subclass" do
+        ARGV.replace ["list"]
+        capture(:stdout) { Thor::Runner.start }.should_not =~ /amazing:help/
+      end
+
+      it "presents tasks in the default namespace with an empty namespace" do
+        ARGV.replace ["list"]
+        capture(:stdout) { Thor::Runner.start }.should =~ /^thor :cow\s+# prints 'moo'/m
+      end
+
+      it "runs tasks with an empty namespace from the default namespace" do
+        ARGV.replace [":task_conflict"]
+        capture(:stdout) { Thor::Runner.start }.should == "task\n"
+      end
+
+      it "runs groups even when there is a task with the same name" do
+        ARGV.replace ["task_conflict"]
+        capture(:stdout) { Thor::Runner.start }.should == "group\n"
+      end
+
+      it "runs tasks with no colon in the default namespace" do
+        ARGV.replace ["cow"]
+        capture(:stdout) { Thor::Runner.start }.should == "moo\n"
+      end
+    end
+
+    describe "uninstall" do
+      before(:each) do
+        path = File.join(Thor::Util.thor_root, @original_yaml["random"][:filename])
+        FileUtils.should_receive(:rm_rf).with(path)
+      end
+
+      it "uninstalls existing thor modules" do
+        silence(:stdout) { Thor::Runner.start(["uninstall", "random"]) }
+      end
+    end
+
+    describe "installed" do
+      before(:each) do
+        Dir.should_receive(:[]).and_return([])
+      end
+
+      it "displays the modules installed in a pretty way" do
+        stdout = capture(:stdout) { Thor::Runner.start(["installed"]) }
+        stdout.should =~ /random\s*amazing/
+        stdout.should =~ /amazing:describe NAME\s+# say that someone is amazing/m
+      end
+    end
+
+    describe "install/update" do
+      before(:each) do
+        FileUtils.stub!(:mkdir_p)
+        FileUtils.stub!(:touch)
+        $stdin.stub!(:gets).and_return("Y")
+
+        path = File.join(Thor::Util.thor_root, Digest::MD5.hexdigest(@location + "random"))
+        File.should_receive(:open).with(path, "w")
+      end
+
+      it "updates existing thor files" do
+        path = File.join(Thor::Util.thor_root, @original_yaml["random"][:filename])
+        File.should_receive(:delete).with(path)
+        silence(:stdout) { Thor::Runner.start(["update", "random"]) }
+      end
+
+      it "installs thor files" do
+        ARGV.replace ["install", @location]
+        silence(:stdout) { Thor::Runner.start }
+      end
+    end
+  end
+end

data/spec/shell/basic_spec.rb

@@ -0,0 +1,223 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Thor::Shell::Basic do
+  def shell
+    @shell ||= Thor::Shell::Basic.new
+  end
+
+  describe "#padding" do
+    it "cannot be set to below zero" do
+      shell.padding = 10
+      shell.padding.should == 10
+
+      shell.padding = -1
+      shell.padding.should == 0
+    end
+  end
+
+  describe "#ask" do
+    it "prints a message to the user and gets the response" do
+      $stdout.should_receive(:print).with("Should I overwrite it? ")
+      $stdin.should_receive(:gets).and_return('Sure')
+      shell.ask("Should I overwrite it?").should == "Sure"
+    end
+  end
+
+  describe "#yes?" do
+    it "asks the user and returns true if the user replies yes" do
+      $stdout.should_receive(:print).with("Should I overwrite it? ")
+        $stdin.should_receive(:gets).and_return('y')
+      shell.yes?("Should I overwrite it?").should === true
+
+      $stdout.should_receive(:print).with("Should I overwrite it? ")
+        $stdin.should_receive(:gets).and_return('n')
+      shell.yes?("Should I overwrite it?").should_not === true
+    end
+  end
+
+  describe "#no?" do
+    it "asks the user and returns true if the user replies no" do
+      $stdout.should_receive(:print).with("Should I overwrite it? ")
+        $stdin.should_receive(:gets).and_return('n')
+      shell.no?("Should I overwrite it?").should === true
+
+      $stdout.should_receive(:print).with("Should I overwrite it? ")
+        $stdin.should_receive(:gets).and_return('Yes')
+      shell.no?("Should I overwrite it?").should === false
+    end
+  end
+
+  describe "#say" do
+    it "prints a message to the user" do
+      $stdout.should_receive(:puts).with("Running...")
+      shell.say("Running...")
+    end
+
+    it "prints a message to the user without new line if it ends with a whitespace" do
+      $stdout.should_receive(:print).with("Running... ")
+      shell.say("Running... ")
+    end
+
+    it "prints a message to the user without new line" do
+      $stdout.should_receive(:print).with("Running...")
+      shell.say("Running...", nil, false)
+    end
+  end
+
+  describe "#say_status" do
+    it "prints a message to the user with status" do
+      $stdout.should_receive(:puts).with("      create  ~/.thor/task.thor")
+      shell.say_status(:create, "~/.thor/task.thor")
+    end
+
+    it "always use new line" do
+      $stdout.should_receive(:puts).with("      create  ")
+      shell.say_status(:create, "")
+    end
+
+    it "does not print a message if base is muted" do
+      shell.should_receive(:mute?).and_return(true)
+      $stdout.should_not_receive(:puts)
+
+      shell.mute do
+        shell.say_status(:created, "~/.thor/task.thor")
+      end
+    end
+
+    it "does not print a message if base is set to quiet" do
+      base = MyCounter.new [1,2]
+      base.should_receive(:options).and_return(:quiet => true)
+
+      $stdout.should_not_receive(:puts)
+      shell.base = base
+      shell.say_status(:created, "~/.thor/task.thor")
+    end
+
+    it "does not print a message if log status is set to false" do
+      $stdout.should_not_receive(:puts)
+      shell.say_status(:created, "~/.thor/task.thor", false)
+    end
+
+    it "uses padding to set messages left margin" do
+      shell.padding = 2
+      $stdout.should_receive(:puts).with("      create      ~/.thor/task.thor")
+      shell.say_status(:create, "~/.thor/task.thor")
+    end
+  end
+
+  describe "#print_table" do
+    before(:each) do
+      @table = []
+      @table << ["abc", "#123", "first three"]
+      @table << ["", "#0", "empty"]
+      @table << ["xyz", "#786", "last three"]
+    end
+
+    it "prints a table" do
+      content = capture(:stdout){ shell.print_table(@table) }
+      content.should == <<-TABLE
+abc  #123  first three
+     #0    empty
+xyz  #786  last three
+TABLE
+    end
+
+    it "prints a table with identation" do
+      content = capture(:stdout){ shell.print_table(@table, :ident => 2) }
+      content.should == <<-TABLE
+  abc  #123  first three
+       #0    empty
+  xyz  #786  last three
+TABLE
+    end
+
+    it "uses maximum terminal width" do
+      shell.should_receive(:terminal_width).and_return(20)
+      content = capture(:stdout){ shell.print_table(@table, :ident => 2, :truncate => true) }
+      content.should == <<-TABLE
+  abc  #123  firs...
+       #0    empty
+  xyz  #786  last...
+TABLE
+    end
+
+    it "honors the colwidth option" do
+      content = capture(:stdout){ shell.print_table(@table, :colwidth => 10)}
+      content.should == <<-TABLE
+abc         #123  first three
+            #0    empty
+xyz         #786  last three
+TABLE
+    end
+  end
+
+  describe "#file_collision" do
+    it "shows a menu with options" do
+      $stdout.should_receive(:print).with('Overwrite foo? (enter "h" for help) [Ynaqh] ')
+      $stdin.should_receive(:gets).and_return('n')
+      shell.file_collision('foo')
+    end
+
+    it "returns true if the user choose default option" do
+      $stdout.stub!(:print)
+      $stdin.should_receive(:gets).and_return('')
+      shell.file_collision('foo').should be_true
+    end
+
+    it "returns false if the user choose no" do
+      $stdout.stub!(:print)
+      $stdin.should_receive(:gets).and_return('n')
+      shell.file_collision('foo').should be_false
+    end
+
+    it "returns true if the user choose yes" do
+      $stdout.stub!(:print)
+      $stdin.should_receive(:gets).and_return('y')
+      shell.file_collision('foo').should be_true
+    end
+
+    it "shows help usage if the user choose help" do
+      $stdout.stub!(:print)
+      $stdin.should_receive(:gets).and_return('h')
+      $stdin.should_receive(:gets).and_return('n')
+      help = capture(:stdout){ shell.file_collision('foo') }
+      help.should =~ /h \- help, show this help/
+    end
+
+    it "quits if the user choose quit" do
+      $stdout.stub!(:print)
+      $stdout.should_receive(:puts).with('Aborting...')
+      $stdin.should_receive(:gets).and_return('q')
+
+      lambda {
+        shell.file_collision('foo')
+      }.should raise_error(SystemExit)
+    end
+
+    it "always returns true if the user choose always" do
+      $stdout.should_receive(:print).with('Overwrite foo? (enter "h" for help) [Ynaqh] ')
+      $stdin.should_receive(:gets).and_return('a')
+
+      shell.file_collision('foo').should be_true
+
+      $stdout.should_not_receive(:print)
+      shell.file_collision('foo').should be_true
+    end
+
+    describe "when a block is given" do
+      it "displays diff options to the user" do
+        $stdout.should_receive(:print).with('Overwrite foo? (enter "h" for help) [Ynaqdh] ')
+        $stdin.should_receive(:gets).and_return('s')
+        shell.file_collision('foo'){ }
+      end
+
+      it "invokes the diff command" do
+        $stdout.stub!(:print)
+        $stdin.should_receive(:gets).and_return('d')
+        $stdin.should_receive(:gets).and_return('n')
+        shell.should_receive(:system).with(/diff -u/)
+        capture(:stdout){ shell.file_collision('foo'){ } }
+      end
+    end
+  end
+end

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 = Struct.new(:namespace, :arguments).new("foo", [])
+      task(:bar => :required).formatted_usage(object).should == "foo:can_has --bar=BAR"
+    end
+
+    it "removes default from namespace" do
+      object = Struct.new(:namespace, :arguments).new("default:foo", [])
+      task(:bar => :required).formatted_usage(object).should == ":foo:can_has --bar=BAR"
+    end
+
+    it "injects arguments into usage" do
+      object = Struct.new(:namespace, :arguments).new("foo", [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_cmd(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 be
+    end
+  end
+
+  describe "#run_cmd" do
+    it "runs a task by calling a method in the given instance" do
+      mock = mock()
+      mock.should_receive(:can_has).and_return {|*args| args }
+      task.run_cmd(mock, [1, 2, 3]).should == [1, 2, 3]
+    end
+
+    it "raises an error if the method to be invoked is private" do
+      klass = Class.new do
+        def self.handle_no_task_error(name)
+          name
+        end
+
+      private
+        def can_has
+          "fail"
+        end
+      end
+
+      task.run_cmd(klass.new).should == "can_has"
+    end
+  end
+end