thor 0.12.2 → 0.13.0

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.12.2".freeze
+  VERSION = "0.13.0".freeze
 end

data/lib/thor.rb

@@ -1,7 +1,6 @@
 require 'thor/base'
-require 'thor/group'
-require 'thor/actions'
 
+# TODO: Update thor to allow for git-style CLI (git bisect run)
 class Thor
   class << self
     # Sets the default task when thor is executed without an explicit task to be called.
@@ -139,51 +138,47 @@ class Thor
       end
     end
 
-    # Prints help information. If a task name is given, it shows information
-    # only about the specific task.
+    # Prints help information for the given task.
     #
     # ==== Parameters
-    # meth<String>:: An optional task name to print usage information about.
-    #
-    # ==== Options
-    # namespace:: When true, shows the namespace in the output before the usage.
-    # skip_inherited:: When true, does not show tasks from superclass.
-    #
-    def help(shell, options={})
-      if options[:task]
-        task = all_tasks[options[:task]]
-        raise UndefinedTaskError, "task '#{options[:task]}' could not be found in namespace '#{self.namespace}'" unless task
-
-        shell.say "Usage:"
-        shell.say "  #{banner(task)}"
-        shell.say
-        class_options_help(shell, nil => task.options.map { |_, o| o })
-        shell.say task.description
-      else
-        list = printable_tasks(!options[:short])
-
-        Thor::Util.thor_classes_in(self).each do |klass|
-          list += klass.printable_tasks(false)
-        end
-
-        list.sort!{ |a,b| a[0] <=> b[0] }
+    # shell<Thor::Shell>
+    # task_name<String>
+    #
+    def task_help(shell, task_name)
+      task = all_tasks[task_name]
+      raise UndefinedTaskError, "task '#{task_name}' could not be found in namespace '#{self.namespace}'" unless task
+
+      shell.say "Usage:"
+      shell.say "  #{banner(task)}"
+      shell.say
+      class_options_help(shell, nil => task.options.map { |_, o| o })
+      shell.say task.description
+    end
 
-        if options[:short]
-          shell.print_table(list, :truncate => true)
-        else
-          shell.say "Tasks:"
-          shell.print_table(list, :ident => 2, :truncate => true)
-          shell.say
-          class_options_help(shell)
-        end
+    # Prints help information for this class.
+    #
+    # ==== Parameters
+    # shell<Thor::Shell>
+    #
+    def help(shell)
+      list = printable_tasks
+      Thor::Util.thor_classes_in(self).each do |klass|
+        list += klass.printable_tasks(false)
       end
+      list.sort!{ |a,b| a[0] <=> b[0] }
+
+      shell.say "Tasks:"
+      shell.print_table(list, :ident => 2, :truncate => true)
+      shell.say
+      class_options_help(shell)
     end
 
+    # Returns tasks ready to be printed.
     def printable_tasks(all=true)
       (all ? all_tasks : tasks).map do |_, task|
         item = []
         item << banner(task)
-        item << "# #{task.description}" if task.description
+        item << (task.description ? "# #{task.description.gsub(/\s+/m,' ')}" : "")
         item
       end
     end
@@ -196,7 +191,8 @@ class Thor
       # the namespace should be displayed as arguments.
       #
       def banner(task)
-        "thor " + task.formatted_usage(self)
+        base = $thor_runner ? "thor" : File.basename($0.split(" ").first)
+        "#{base} #{task.formatted_usage(self, base == "thor")}"
       end
 
       def baseclass #:nodoc:
@@ -239,6 +235,6 @@ class Thor
 
   desc "help [TASK]", "Describe available tasks or one specific task"
   def help(task=nil)
-    self.class.help(shell, :task => task)
+    task ? self.class.task_help(shell, task) : self.class.help(shell)
   end
 end

data/spec/actions/create_file_spec.rb

@@ -8,7 +8,7 @@ describe Thor::Actions::CreateFile do
 
   def create_file(destination=nil, config={}, options={})
     @base = MyCounter.new([1,2], options, { :destination_root => destination_root })
-    stub(@base).file_name { 'rdoc' }
+    @base.stub!(:file_name).and_return('rdoc')
 
     @action = Thor::Actions::CreateFile.new(@base, destination, "CONFIGURATION",
                                             { :verbose => !@silence }.merge(config))
@@ -103,7 +103,7 @@ describe Thor::Actions::CreateFile do
 
         it "shows conflict status to ther user" do
           create_file("doc/config.rb").must_not be_identical
-          mock($stdin).gets{ 's' }
+          $stdin.should_receive(:gets).and_return('s')
           file = File.join(destination_root, 'doc/config.rb')
 
           content = invoke!
@@ -114,21 +114,21 @@ describe Thor::Actions::CreateFile do
 
         it "creates the file if the file collision menu returns true" do
           create_file("doc/config.rb")
-          mock($stdin).gets{ 'y' }
+          $stdin.should_receive(:gets).and_return('y')
           invoke!.must =~ /force  doc\/config\.rb/
         end
 
         it "skips the file if the file collision menu returns false" do
           create_file("doc/config.rb")
-          mock($stdin).gets{ 'n' }
+          $stdin.should_receive(:gets).and_return('n')
           invoke!.must =~ /skip  doc\/config\.rb/
         end
 
         it "executes the block given to show file content" do
           create_file("doc/config.rb")
-          mock($stdin).gets{ 'd' }
-          mock($stdin).gets{ 'n' }
-          mock(@base.shell).system(/diff -u/)
+          $stdin.should_receive(:gets).and_return('d')
+          $stdin.should_receive(:gets).and_return('n')
+          @base.shell.should_receive(:system).with(/diff -u/)
           invoke!
         end
       end

data/spec/actions/directory_spec.rb

@@ -4,7 +4,7 @@ require 'thor/actions'
 describe Thor::Actions::Directory do
   before(:each) do
     ::FileUtils.rm_rf(destination_root)
-    stub(invoker).file_name{ "rdoc" }
+    invoker.stub!(:file_name).and_return("rdoc")
   end
 
   def invoker

data/spec/actions/file_manipulation_spec.rb

@@ -29,23 +29,23 @@ describe Thor::Actions do
 
   describe "#chmod" do
     it "executes the command given" do
-      mock(FileUtils).chmod_R(0755, file)
+      FileUtils.should_receive(:chmod_R).with(0755, file)
       action :chmod, "foo", 0755
     end
 
     it "does not execute the command if pretending given" do
-      dont_allow(FileUtils).chmod_R(0755, file)
+      FileUtils.should_not_receive(:chmod_R)
       runner(:pretend => true)
       action :chmod, "foo", 0755
     end
 
     it "logs status" do
-      mock(FileUtils).chmod_R(0755, file)
+      FileUtils.should_receive(:chmod_R).with(0755, file)
       action(:chmod, "foo", 0755).must == "       chmod  foo\n"
     end
 
     it "does not log status if required" do
-      mock(FileUtils).chmod_R(0755, file)
+      FileUtils.should_receive(:chmod_R).with(0755, file)
       action(:chmod, "foo", 0755, :verbose => false).must be_empty
     end
   end
@@ -123,7 +123,7 @@ describe Thor::Actions do
     end
 
     it "converts enconded instructions" do
-      mock(runner).file_name{ "rdoc" }
+      runner.should_receive(:file_name).and_return("rdoc")
       action :template, "doc/%file_name%.rb.tt"
       file = File.join(destination_root, "doc/rdoc.rb.tt")
       File.exists?(file).must be_true
@@ -179,18 +179,18 @@ describe Thor::Actions do
     describe "#gsub_file" do
       it "replaces the content in the file" do
         action :gsub_file, "doc/README", "__start__", "START"
-        File.open(file).read.must == "START\nREADME\n__end__\n"
+        File.binread(file).must == "START\nREADME\n__end__\n"
       end
 
       it "does not replace if pretending" do
         runner(:pretend => true)
         action :gsub_file, "doc/README", "__start__", "START"
-        File.open(file).read.must == "__start__\nREADME\n__end__\n"
+        File.binread(file).must == "__start__\nREADME\n__end__\n"
       end
 
       it "accepts a block" do
         action(:gsub_file, "doc/README", "__start__"){ |match| match.gsub('__', '').upcase  }
-        File.open(file).read.must == "START\nREADME\n__end__\n"
+        File.binread(file).must == "START\nREADME\n__end__\n"
       end
 
       it "logs status" do
@@ -205,12 +205,12 @@ describe Thor::Actions do
     describe "#append_file" do
       it "appends content to the file" do
         action :append_file, "doc/README", "END\n"
-        File.open(file).read.must == "__start__\nREADME\n__end__\nEND\n"
+        File.binread(file).must == "__start__\nREADME\n__end__\nEND\n"
       end
 
       it "accepts a block" do
         action(:append_file, "doc/README"){ "END\n" }
-        File.open(file).read.must == "__start__\nREADME\n__end__\nEND\n"
+        File.binread(file).must == "__start__\nREADME\n__end__\nEND\n"
       end
 
       it "logs status" do
@@ -221,12 +221,12 @@ describe Thor::Actions do
     describe "#prepend_file" do
       it "prepends content to the file" do
         action :prepend_file, "doc/README", "START\n"
-        File.open(file).read.must == "START\n__start__\nREADME\n__end__\n"
+        File.binread(file).must == "START\n__start__\nREADME\n__end__\n"
       end
 
       it "accepts a block" do
         action(:prepend_file, "doc/README"){ "START\n" }
-        File.open(file).read.must == "START\n__start__\nREADME\n__end__\n"
+        File.binread(file).must == "START\n__start__\nREADME\n__end__\n"
       end
 
       it "logs status" do
@@ -241,12 +241,12 @@ describe Thor::Actions do
 
       it "appends content to a class" do
         action :inject_into_class, "application.rb", Application, "  filter_parameters :password\n"
-        File.open(file).read.must == "class Application < Base\n  filter_parameters :password\nend\n"
+        File.binread(file).must == "class Application < Base\n  filter_parameters :password\nend\n"
       end
 
       it "accepts a block" do
         action(:inject_into_class, "application.rb", Application){ "  filter_parameters :password\n" }
-        File.open(file).read.must == "class Application < Base\n  filter_parameters :password\nend\n"
+        File.binread(file).must == "class Application < Base\n  filter_parameters :password\nend\n"
       end
 
       it "logs status" do
@@ -255,7 +255,7 @@ describe Thor::Actions do
 
       it "does not append if class name does not match" do
         action :inject_into_class, "application.rb", "App", "  filter_parameters :password\n"
-        File.open(file).read.must == "class Application < Base\nend\n"
+        File.binread(file).must == "class Application < Base\nend\n"
       end
     end
   end

data/spec/actions/inject_into_file_spec.rb

@@ -55,6 +55,35 @@ describe Thor::Actions::InjectIntoFile do
       invoke! "doc/README", "\nmore content", :after => "__start__"
       File.read(file).must == "__start__\nREADME\n__end__\n"
     end
+
+    it "does not change the file if already include content" do
+      invoke! "doc/README", :before => "__end__" do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\n__end__\n"
+
+      invoke! "doc/README", :before => "__end__" do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\n__end__\n"
+    end
+
+    it "does change the file if already include content and :force == true" do
+      invoke! "doc/README", :before => "__end__" do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\n__end__\n"
+
+      invoke! "doc/README", :before => "__end__", :force => true do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\nmore content\n__end__\n"
+    end
+
   end
 
   describe "#revoke!" do

data/spec/actions_spec.rb

@@ -55,9 +55,10 @@ describe Thor::Actions do
       end
 
       it "does not use the current directory if one is given" do
+        root = File.expand_path("/")
         base = MyCounter.new([1])
-        base.destination_root = "/"
-        base.destination_root.must == "/"
+        base.destination_root = root
+        base.destination_root.must == root
       end
 
       it "uses the current directory if none is given" do
@@ -194,7 +195,7 @@ describe Thor::Actions do
       @template.instance_eval "def read; self; end" # Make the string respond to read
 
       @file = "http://gist.github.com/103208.txt"
-      mock(runner).open(@file){ @template }
+      runner.should_receive(:open).and_return(@template)
     end
 
     it "opens a file and executes its content in the instance binding" do
@@ -219,7 +220,7 @@ describe Thor::Actions do
 
   describe "#run" do
     before(:each) do
-      mock(runner).system("ls")
+      runner.should_receive(:system).with("ls")
     end
 
     it "executes the command given" do
@@ -235,15 +236,15 @@ describe Thor::Actions do
     end
 
     it "accepts a color as status" do
-      mock(runner.shell).say_status(:run, 'ls from "."', :yellow)
+      runner.shell.should_receive(:say_status).with(:run, 'ls from "."', :yellow)
       action :run, "ls", :verbose => :yellow
     end
   end
 
   describe "#run_ruby_script" do
     before(:each) do
-      stub(Thor::Util).ruby_command{ "/opt/jruby" }
-      mock(runner).system("/opt/jruby script.rb")
+      Thor::Util.stub!(:ruby_command).and_return("/opt/jruby")
+      runner.should_receive(:system).with("/opt/jruby script.rb")
     end
 
     it "executes the ruby script" do
@@ -261,30 +262,30 @@ describe Thor::Actions do
 
   describe "#thor" do
     it "executes the thor command" do
-      mock(runner).system("thor list")
+      runner.should_receive(:system).with("thor list")
       action :thor, :list, :verbose => true
     end
 
     it "converts extra arguments to command arguments" do
-      mock(runner).system("thor list foo bar")
+      runner.should_receive(:system).with("thor list foo bar")
       action :thor, :list, "foo", "bar"
     end
 
     it "converts options hash to switches" do
-      mock(runner).system("thor list foo bar --foo")
+      runner.should_receive(:system).with("thor list foo bar --foo")
       action :thor, :list, "foo", "bar", :foo => true
 
-      mock(runner).system("thor list --foo 1 2 3")
+      runner.should_receive(:system).with("thor list --foo 1 2 3")
       action :thor, :list, :foo => [1,2,3]
     end
 
     it "logs status" do
-      mock(runner).system("thor list")
+      runner.should_receive(:system).with("thor list")
       action(:thor, :list).must == "         run  thor list from \".\"\n"
     end
 
     it "does not log status if required" do
-      mock(runner).system("thor list --foo 1 2 3")
+      runner.should_receive(:system).with("thor list --foo 1 2 3")
       action(:thor, :list, :foo => [1,2,3], :verbose => false).must be_empty
     end
   end

data/spec/base_spec.rb

@@ -233,4 +233,19 @@ describe Thor::Base do
       }.must raise_error(Thor::UndefinedTaskError, /the 'what' task of MyScript is private/)
     end
   end
+
+  describe "attr_*" do
+    it "should not add attr_reader as a task" do
+      capture(:stderr){ MyScript.start(["another_attribute"]) }.must =~ /could not find/
+    end
+
+    it "should not add attr_writer as a task" do
+      capture(:stderr){ MyScript.start(["another_attribute=", "foo"]) }.must =~ /could not find/
+    end
+
+    it "should not add attr_accessor as a task" do
+      capture(:stderr){ MyScript.start(["some_attribute"]) }.must =~ /could not find/
+      capture(:stderr){ MyScript.start(["some_attribute=", "foo"]) }.must =~ /could not find/
+    end
+  end
 end

data/spec/fixtures/script.thor

@@ -1,4 +1,8 @@
 class MyScript < Thor
+  attr_accessor :some_attribute
+  attr_writer :another_attribute
+  attr_reader :another_attribute
+
   group :script
   default_task :example_default_task
 

data/spec/group_spec.rb

@@ -29,7 +29,7 @@ describe Thor::Group do
     end
 
     it "invokes help message if any of the shortcuts is given" do
-      stub(MyCounter).help
+      MyCounter.should_receive(:help)
       MyCounter.start(["-h"])
     end
   end
@@ -66,12 +66,6 @@ describe Thor::Group do
       @content.must =~ /Options/
       @content.must =~ /\[\-\-third=THREE\]/
     end
-
-    it "shows only usage if a short help is required" do
-      content = capture(:stdout){ MyCounter.help(Thor::Base.shell.new, :short => true) }
-      content.must =~ /my_counter N \[N\]/
-      content.must_not =~ /Options/
-    end
   end
 
   describe "#invoke" do

data/spec/runner_spec.rb

@@ -26,11 +26,11 @@ describe Thor::Runner do
 
     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\]/
+      content.must =~ /my_counter N/
     end
 
     it "raises error if a class/task cannot be found" do
-      mock(Thor::Runner).exit(1)
+      Thor::Runner.should_receive(:exit).with(1)
       content = capture(:stderr){ Thor::Runner.start(["help", "unknown"]) }
       content.must =~ /could not find Thor class or task 'unknown'/
     end
@@ -39,7 +39,7 @@ describe Thor::Runner do
   describe "#start" do
     it "invokes a task from Thor::Runner" do
       ARGV.replace ["list"]
-      capture(:stdout){ Thor::Runner.start }.must =~ /my_counter N \[N\]/
+      capture(:stdout){ Thor::Runner.start }.must =~ /my_counter N/
     end
 
     it "invokes a task from a specific Thor class" do
@@ -68,7 +68,7 @@ describe Thor::Runner do
     end
 
     it "raises an error if class/task can't be found" do
-      mock(Thor::Runner).exit(1)
+      Thor::Runner.should_receive(:exit).with(1)
       ARGV.replace ["unknown"]
       capture(:stderr){ Thor::Runner.start }.must =~ /could not find Thor class or task 'unknown'/
     end
@@ -96,14 +96,16 @@ describe Thor::Runner do
         "random" => {
           :location  => @location,
           :filename  => "4a33b894ffce85d7b412fc1b36f88fe0",
-          :constants => ["Amazing"]
+          :namespaces => ["amazing"]
         }
       }
 
+      root_file = File.join(Thor::Util.thor_root, "thor.yml")
+
       # 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")
+      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
@@ -115,7 +117,7 @@ describe Thor::Runner do
 
       it "gives a list of the available Thor::Group classes" do
         ARGV.replace ["list"]
-        capture(:stdout) { Thor::Runner.start }.must =~ /my_counter N \[N\]/
+        capture(:stdout) { Thor::Runner.start }.must =~ /my_counter N/
       end
 
       it "can filter a list of the available tasks by --group" do
@@ -148,26 +150,12 @@ describe Thor::Runner 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)
+        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
@@ -177,7 +165,7 @@ describe Thor::Runner do
 
     describe "installed" do
       before(:each) do
-        stub(Dir).[](anything) { [] }
+        Dir.should_receive(:[]).and_return([])
       end
 
       it "displays the modules installed in a pretty way" do
@@ -187,16 +175,24 @@ describe Thor::Runner do
       end
     end
 
-    describe "install" do
-      it "installs thor files" do
-        ARGV.replace ["install", @location]
+    describe "install/update" do
+      before(:each) do
+        FileUtils.stub!(:mkdir_p)
+        FileUtils.stub!(:touch)
+        $stdin.stub!(:gets).and_return("Y")
 
-        # Stubs for the file system interactions
-        stub.instance_of(Thor::Base.shell).no? { false }
-        stub(FileUtils).mkdir_p
-        stub(FileUtils).touch
+        path = File.join(Thor::Util.thor_root, Digest::MD5.hexdigest(@location + "random"))
+        File.should_receive(:open).with(path, "w")
+      end
 
-        mock(File).open(File.join(Thor::Util.thor_root, Digest::MD5.hexdigest(@location + "random")), "w")
+      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