thor 0.9.9 → 0.11.5

data/spec/rake_compat_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'thor/rake_compat'
+require 'rake/tasklib'
+
+class RakeTask < Rake::TaskLib
+  def initialize
+    define
+  end
+  
+  def define
+    desc "Say it's cool"
+    task :cool do
+      puts "COOL"
+    end
+
+    namespace :hiper_mega do
+      task :super do
+        puts "HIPER MEGA SUPER"
+      end
+    end
+  end
+end
+
+class ThorTask < Thor
+  include Thor::RakeCompat
+  RakeTask.new
+end
+
+describe Thor::RakeCompat do
+  it "adds rake tasks to thor classes too" do
+    task = ThorTask.tasks["cool"]
+    task.must be
+  end
+
+  it "uses rake tasks descriptions on thor" do
+    ThorTask.tasks["cool"].description.must == "Say it's cool"
+  end
+
+  it "gets usage from rake tasks name" do
+    ThorTask.tasks["cool"].usage.must == "cool"
+  end
+
+  it "uses non namespaced name as description if non is available" do
+    ThorTask::HiperMega.tasks["super"].description.must == "super"
+  end
+
+  it "converts namespaces to classes" do
+    ThorTask.const_get(:HiperMega).must == ThorTask::HiperMega
+  end
+
+  it "does not add tasks from higher namespaces in lowers namespaces" do
+    ThorTask.tasks["super"].must_not be
+  end
+
+  it "invoking the thor task invokes the rake task" do
+    capture(:stdout) do
+      ThorTask.start ["cool"]
+    end.must == "COOL\n"
+
+    capture(:stdout) do
+      ThorTask::HiperMega.start ["super"]
+    end.must == "HIPER MEGA SUPER\n"
+  end
+end

data/spec/runner_spec.rb

@@ -0,0 +1,204 @@
+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"]) }.must =~ /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.must =~ /List the available thor tasks/
+      content.must_not =~ /help \[TASK\]/
+    end
+
+    it "shows information about a specific Thor class" do
+      content = capture(:stdout){ Thor::Runner.start(["help", "my_script"]) }
+      content.must =~ /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.must =~ /zoo around/
+      content.must_not =~ /help \[TASK\]/
+    end
+
+    it "shows information about a specific Thor group class" do
+      content = capture(:stdout){ Thor::Runner.start(["help", "my_counter"]) }
+      content.must =~ /my_counter N \[N\]/
+    end
+
+    it "raises error if a class/task cannot be found" do
+      content = capture(:stderr){ Thor::Runner.start(["help", "unknown"]) }
+      content.must =~ /could not find Thor class or task 'unknown'/
+    end
+  end
+
+  describe "#start" do
+    it "invokes a task from Thor::Runner" do
+      ARGV.replace ["list"]
+      capture(:stdout){ Thor::Runner.start }.must =~ /my_counter N \[N\]/
+    end
+
+    it "invokes a task from a specific Thor class" do
+      ARGV.replace ["my_script:zoo"]
+      Thor::Runner.start.must 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.must == "default task"
+    end
+
+    it "forwads arguments to the invoked task" do
+      ARGV.replace ["my_script:animal", "horse"]
+      Thor::Runner.start.must == ["horse"]
+    end
+
+    it "invokes tasks through shortcuts" do
+      ARGV.replace ["my_script", "-T", "horse"]
+      Thor::Runner.start.must == ["horse"]
+    end
+
+    it "invokes a Thor::Group" do
+      ARGV.replace ["my_counter", "1", "2", "--third", "3"]
+      Thor::Runner.start.must == [1, 2, 3]
+    end
+
+    it "raises an error if class/task can't be found" do
+      ARGV.replace ["unknown"]
+      capture(:stderr){ Thor::Runner.start }.must =~ /could not find Thor class or task 'unknown'/
+    end
+
+    it "does not swallow NoMethodErrors that occur inside the called method" do
+      ARGV.replace ["my_script:call_unexistent_method"]
+      lambda { Thor::Runner.start }.must raise_error(NoMethodError)
+    end
+
+    it "does not swallow Thor::Group ArgumentError" do
+      ARGV.replace ["whiny_generator"]
+      lambda { Thor::Runner.start }.must raise_error(ArgumentError, /Are you sure it has arity equals to 0\?/)
+    end
+
+    it "does not swallow Thor ArgumentError" do
+      ARGV.replace ["my_script:animal"]
+      capture(:stderr) { Thor::Runner.start }.must =~ /'animal' was called incorrectly\. Call as '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",
+          :constants => ["Amazing"]
+        }
+      }
+
+      # Stub load and save to avoid thor.yaml from being overwritten
+      stub(YAML).load_file { @original_yaml }
+      stub(File).exists?(File.join(Thor::Util.thor_root, "thor.yml")){ true }
+      stub(File).open(File.join(Thor::Util.thor_root, "thor.yml"), "w")
+    end
+
+    describe "list" do
+      it "gives a list of the available tasks" do
+        ARGV.replace ["list"]
+        content = capture(:stdout) { Thor::Runner.start }
+        content.must =~ /amazing:describe NAME \[\-\-forcefully\]\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 }.must =~ /my_counter N \[N\]/
+      end
+
+      it "can filter a list of the available tasks by --group" do
+        ARGV.replace ["list", "--group", "standard"]
+        capture(:stdout) { Thor::Runner.start }.must =~ /amazing:describe NAME/
+        ARGV.replace []
+        capture(:stdout) { Thor::Runner.start }.must_not =~ /my_script:animal TYPE/
+        ARGV.replace ["list", "--group", "script"]
+        capture(:stdout) { Thor::Runner.start }.must =~ /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.must =~ /amazing:describe NAME/
+        content.must =~ /my_script:animal TYPE/
+      end
+
+      it "doesn't list superclass tasks in the subclass" do
+        ARGV.replace ["list"]
+        capture(:stdout) { Thor::Runner.start }.must_not =~ /amazing:help/
+      end
+
+      it "presents tasks in the default namespace with an empty namespace" do
+        ARGV.replace ["list"]
+        capture(:stdout) { Thor::Runner.start }.must =~ /^:test\s+# prints 'test'/m
+      end
+
+      it "runs tasks with an empty namespace from the default namespace" do
+        ARGV.replace [":test"]
+        capture(:stdout) { Thor::Runner.start }.must == "test\n"
+      end
+
+      it "updates the yaml file when invoked" do
+        capture(:stdout) { Thor::Runner.start(["list"]) }
+        @original_yaml["random"][:namespaces].must == ["amazing"]
+      end
+    end
+
+    describe "update" do
+      it "updates existing thor files" do
+        mock.instance_of(Thor::Runner).install(@original_yaml["random"][:location]) { true }
+        stub(File).delete(File.join(Thor::Util.thor_root, @original_yaml["random"][:filename]))
+        silence(:stdout) { Thor::Runner.start(["update", "random"]) }
+      end
+    end
+
+    describe "uninstall" do
+      before(:each) do
+        stub.instance_of(Thor::Runner).save_yaml(anything)
+        stub(File).delete(anything)
+        stub(@original_yaml).delete(anything)
+      end
+
+      it "uninstalls existing thor modules" do
+        silence(:stdout) { Thor::Runner.start(["uninstall", "random"]) }
+      end
+    end
+
+    describe "installed" do
+      before(:each) do
+        stub(Dir).[](anything) { [] }
+      end
+
+      it "displays the modules installed in a pretty way" do
+        stdout = capture(:stdout) { Thor::Runner.start(["installed"]) }
+
+        stdout.must =~ /random\s*amazing/
+        stdout.must =~ /amazing:describe NAME \[\-\-forcefully\]\s+# say that someone is amazing/m
+        stdout.must =~ /amazing:hello\s+# say hello/m
+      end
+    end
+
+    describe "install" do
+      it "installs thor files" do
+        ARGV.replace ["install", @location]
+
+        # Stubs for the file system interactions
+        stub.instance_of(Thor::Base.shell).no? { false }
+        stub(FileUtils).mkdir_p
+        stub(FileUtils).touch
+
+        mock(File).open(File.join(Thor::Util.thor_root, Digest::MD5.hexdigest(@location + "random")), "w")
+        silence(:stdout) { Thor::Runner.start }
+      end
+    end
+  end
+end

data/spec/shell/basic_spec.rb

@@ -0,0 +1,206 @@
+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.must == 10
+
+      shell.padding = -1
+      shell.padding.must == 0
+    end
+  end
+
+  describe "#ask" do
+    it "prints a message to the user and gets the response" do
+      mock($stdout).print("Should I overwrite it? ")
+      mock($stdin).gets{ "Sure" }
+      shell.ask("Should I overwrite it?").must == "Sure"
+    end
+  end
+
+  describe "#yes?" do
+    it "asks the user and returns true if the user replies yes" do
+      mock($stdout).print("Should I overwrite it? ")
+      mock($stdin).gets{ "y" }
+      shell.yes?("Should I overwrite it?").must be_true
+
+      mock($stdout).print("Should I overwrite it? ")
+      mock($stdin).gets{ "n" }
+      shell.yes?("Should I overwrite it?").must_not be_true
+    end
+  end
+
+  describe "#no?" do
+    it "asks the user and returns true if the user replies no" do
+      mock($stdout).print("Should I overwrite it? ")
+      mock($stdin).gets{ "n" }
+      shell.no?("Should I overwrite it?").must be_true
+
+      mock($stdout).print("Should I overwrite it? ")
+      mock($stdin).gets{ "Yes" }
+      shell.no?("Should I overwrite it?").must be_false
+    end
+  end
+
+  describe "#say" do
+    it "prints a message to the user" do
+      mock($stdout).puts("Running...")
+      shell.say("Running...")
+    end
+
+    it "prints a message to the user without new line if it ends with a whitespace" do
+      mock($stdout).print("Running... ")
+      shell.say("Running... ")
+    end
+  end
+
+  describe "#say_status" do
+    it "prints a message to the user with status" do
+      mock($stdout).puts("      create  ~/.thor/task.thor")
+      shell.say_status(:create, "~/.thor/task.thor")
+    end
+
+    it "always use new line" do
+      mock($stdout).puts("      create  ")
+      shell.say_status(:create, "")
+    end
+
+    it "does not print a message if base is set to quiet" do
+      base = MyCounter.new [1,2]
+      mock(base).options { Hash.new(:quiet => true) }
+
+      dont_allow($stdout).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
+      dont_allow($stdout).puts
+      shell.say_status(:created, "~/.thor/task.thor", false)
+    end
+
+    it "uses padding to set messages left margin" do
+      shell.padding = 2
+      mock($stdout).puts("      create      ~/.thor/task.thor")
+      shell.say_status(:create, "~/.thor/task.thor")
+    end
+  end
+
+  describe "#print_list" do
+    before(:each) do
+      @list = ["abc", "#123", "first three"]
+    end
+
+    it "prints a list" do
+      content = capture(:stdout){ shell.print_list(@list) }
+      content.must == <<-LIST
+abc
+#123
+first three
+LIST
+    end
+
+    it "prints a list inline" do
+      content = capture(:stdout){ shell.print_list(@list, :mode => :inline) }
+      content.must == <<-LIST
+abc, #123, and first three
+LIST
+    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.must == <<-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.must == <<-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
+      mock($stdout).print('Overwrite foo? (enter "h" for help) [Ynaqh] ')
+      mock($stdin).gets{ 'n' }
+      shell.file_collision('foo')
+    end
+
+    it "returns false if the user choose no" do
+      stub($stdout).print
+      mock($stdin).gets{ 'n' }
+      shell.file_collision('foo').must be_false
+    end
+
+    it "returns true if the user choose yes" do
+      stub($stdout).print
+      mock($stdin).gets{ 'y' }
+      shell.file_collision('foo').must be_true
+    end
+
+    it "shows help usage if the user choose help" do
+      stub($stdout).print
+      mock($stdin).gets{ 'h' }
+      mock($stdin).gets{ 'n' }
+      help = capture(:stdout){ shell.file_collision('foo') }
+      help.must =~ /h \- help, show this help/
+    end
+
+    it "quits if the user choose quit" do
+      stub($stdout).print
+      mock($stdout).puts('Aborting...')
+      mock($stdin).gets{ 'q' }
+
+      lambda {
+        shell.file_collision('foo')
+      }.must raise_error(SystemExit)
+    end
+
+    it "always returns true if the user choose always" do
+      mock($stdout).print('Overwrite foo? (enter "h" for help) [Ynaqh] ')
+      mock($stdin).gets{ 'a' }
+
+      shell.file_collision('foo').must be_true
+
+      dont_allow($stdout).print
+      shell.file_collision('foo').must be_true
+    end
+
+    describe "when a block is given" do
+      it "displays diff options to the user" do
+        mock($stdout).print('Overwrite foo? (enter "h" for help) [Ynaqdh] ')
+        mock($stdin).gets{ 's' }
+        shell.file_collision('foo'){ }
+      end
+
+      it "invokes the diff command" do
+        stub($stdout).print
+        mock($stdin).gets{ 'd' }
+        mock($stdin).gets{ 'n' }
+        mock(shell).system(/diff -u/)
+        capture(:stdout){ shell.file_collision('foo'){ } }
+      end
+    end
+  end
+end