wijet-thor 0.14.6

data/spec/rake_compat_spec.rb

@@ -0,0 +1,68 @@
+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 "sets the rakefile application" do
+    ["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.should be
+  end
+
+  it "uses rake tasks descriptions on thor" do
+    ThorTask.tasks["cool"].description.should == "Say it's cool"
+  end
+
+  it "gets usage from rake tasks name" do
+    ThorTask.tasks["cool"].usage.should == "cool"
+  end
+
+  it "uses non namespaced name as description if non is available" do
+    ThorTask::HiperMega.tasks["super"].description.should == "super"
+  end
+
+  it "converts namespaces to classes" do
+    ThorTask.const_get(:HiperMega).should == ThorTask::HiperMega
+  end
+
+  it "does not add tasks from higher namespaces in lowers namespaces" do
+    ThorTask.tasks["super"].should_not be
+  end
+
+  it "invoking the thor task invokes the rake task" do
+    capture(:stdout) do
+      ThorTask.start ["cool"]
+    end.should == "COOL\n"
+
+    capture(:stdout) do
+      ThorTask::HiperMega.start ["super"]
+    end.should == "HIPER MEGA SUPER\n"
+  end
+end

data/spec/register_spec.rb

@@ -0,0 +1,104 @@
+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 $thor_runner is false" do
+    it "includes the plugin's subcommand name in subcommand's help" do
+      begin
+        $thor_runner = false
+        help_output = capture(:stdout) { BoringVendorProvidedCLI.start(%w[exciting]) }
+        help_output.should include('thor exciting_plugin_c_l_i fireworks')
+      ensure
+        $thor_runner = true
+      end
+    end
+  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

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