thor 0.17.0 → 0.18.0

data/spec/fixtures/doc/block_helper.rb

@@ -0,0 +1,3 @@
+<% world do -%>
+Hello
+<% end -%>

data/spec/fixtures/doc/config.rb

@@ -0,0 +1 @@
+class <%= @klass %>; end

data/spec/fixtures/doc/config.yaml.tt

@@ -0,0 +1 @@
+--- Hi from yaml

data/spec/fixtures/doc/excluding/%file_name%.rb.tt

@@ -0,0 +1 @@
+BAR = <%= "BAR" %>

data/spec/fixtures/group.thor

@@ -9,16 +9,18 @@ class MyCounter < Thor::Group
   source_root File.expand_path(File.dirname(__FILE__))
   source_paths << File.expand_path("broken", File.dirname(__FILE__))
 
-  argument :first,     :type => :numeric
-  argument :second,    :type => :numeric, :default => 2
+  argument :first,       :type => :numeric
+  argument :second,      :type => :numeric, :default => 2
 
-  class_option :third,  :type => :numeric, :desc => "The third argument", :default => 3,
-                        :banner => "THREE", :aliases => "-t"
-  class_option :fourth, :type => :numeric, :desc => "The fourth argument"
+  class_option :third,    :type => :numeric, :desc => "The third argument", :default => 3,
+                          :banner => "THREE", :aliases => "-t"
+  class_option :fourth,   :type => :numeric, :desc => "The fourth argument"
+  class_option :simple,   :type => :numeric, :aliases => 'z'
+  class_option :symbolic, :type => :numeric, :aliases => [:y, :r]
 
   desc <<-FOO
 Description:
-  This generator runs three tasks: one, two and three.
+  This generator runs three commands: one, two and three.
 FOO
 
   def one
@@ -33,12 +35,24 @@ FOO
     options[:third]
   end
 
+  def four
+    options[:fourth]
+  end
+
+  def five
+    options[:simple]
+  end
+
+  def six
+    options[:symbolic]
+  end
+
   def self.inherited(base)
     super
     base.source_paths.unshift(File.expand_path(File.join(File.dirname(__FILE__), "doc")))
   end
 
-  no_tasks do
+  no_commands do
     def world(&block)
       result = capture(&block)
       concat(result.strip + " world!")
@@ -87,8 +101,8 @@ class WhinyGenerator < Thor::Group
   end
 end
 
-class TaskConflict < Thor::Group
-  desc "A group with the same name as a default task"
+class CommandConflict < Thor::Group
+  desc "A group with the same name as a default command"
   def group
     puts "group"
   end
@@ -110,5 +124,5 @@ class ChildGroup < ParentGroup
     "bar"
   end
 
-  public_task :foo, :baz
+  public_command :foo, :baz
 end

data/spec/fixtures/invoke.thor

@@ -30,7 +30,7 @@ class A < Thor
     number == 5
   end
 
-  desc "invoker", "invoke a b task"
+  desc "invoker", "invoke a b command"
   def invoker(*args)
     invoke :b, :one, ["Jose"]
   end
@@ -96,8 +96,8 @@ class E < Thor::Group
 end
 
 class F < Thor::Group
-  invoke "b:one" do |instance, klass, task|
-    instance.invoke klass, task, [ "Jose" ], :last_name => "Valim"
+  invoke "b:one" do |instance, klass, command|
+    instance.invoke klass, command, [ "Jose" ], :last_name => "Valim"
   end
 end
 

data/spec/fixtures/script.thor

@@ -5,8 +5,12 @@ class MyScript < Thor
   attr_writer :another_attribute
   attr_reader :another_attribute
 
+  private
+  attr_reader :private_attribute
+
+  public
   group :script
-  default_task :example_default_task
+  default_command :example_default_command
 
   map "-T" => :animal, ["-f", "--foo"] => :foo
 
@@ -19,8 +23,8 @@ class MyScript < Thor
 
   desc "animal TYPE", "horse around"
 
-  no_tasks do
-    def this_is_not_a_task
+  no_commands do
+    def this_is_not_a_command
     end
   end
 
@@ -47,10 +51,10 @@ END
     [bar, options]
   end
 
-  desc "example_default_task", "example!"
+  desc "example_default_command", "example!"
   method_options :with => :string
-  def example_default_task
-    options.empty? ? "default task" : options
+  def example_default_command
+    options.empty? ? "default command" : options
   end
 
   desc "call_myself_with_wrong_arity", "get the right error"
@@ -58,7 +62,7 @@ END
     call_myself_with_wrong_arity(4)
   end
 
-  desc "call_unexistent_method", "Call unexistent method inside a task"
+  desc "call_unexistent_method", "Call unexistent method inside a command"
   def call_unexistent_method
     boom!
   end
@@ -73,7 +77,7 @@ END
   def long_description
   end
 
-  desc "name-with-dashes", "Ensure normalization of task names"
+  desc "name-with-dashes", "Ensure normalization of command names"
   def name_with_dashes
   end
 
@@ -93,7 +97,7 @@ END
     end
   end
 
-  desc "send", "send as a task name"
+  desc "send", "send as a command name"
   def send
     true
   end
@@ -114,7 +118,7 @@ END
 end
 
 class MyChildScript < MyScript
-  remove_task :bar
+  remove_command :bar
 
   method_options :force => :boolean, :param => :numeric
   def initialize(*args)
@@ -138,7 +142,7 @@ class MyChildScript < MyScript
   def boom
   end
 
-  remove_task :boom, :undefine => true
+  remove_command :boom, :undefine => true
 end
 
 class Barn < Thor
@@ -156,14 +160,17 @@ class Barn < Thor
   def paint(color='red')
     puts "#{options[:coats]} coats of #{color} paint"
   end
+end
 
+class PackageNameScript < Thor
+  package_name "Baboon"
 end
 
 module Scripts
   class MyScript < MyChildScript
     argument :accessor, :type => :string
     class_options :force => :boolean
-    method_option :new_option, :type => :string, :for => :example_default_task
+    method_option :new_option, :type => :string, :for => :example_default_command
 
     def zoo
       self.accessor
@@ -179,9 +186,9 @@ module Scripts
       puts "moo"
     end
 
-    desc "task_conflict", "only gets called when prepended with a colon"
-    def task_conflict
-      puts "task"
+    desc "command_conflict", "only gets called when prepended with a colon"
+    def command_conflict
+      puts "command"
     end
 
     desc "barn", "commands to manage the barn"
@@ -191,5 +198,23 @@ module Scripts
   class ChildDefault < Thor
     namespace "default:child"
   end
+
+  class Arities < Thor
+    desc "zero_args", "takes zero args"
+    def zero_args
+    end
+
+    desc "one_arg ARG", "takes one arg"
+    def one_arg(arg)
+    end
+
+    desc "two_args ARG1 ARG2", "takes two args"
+    def two_args(arg1, arg2)
+    end
+
+    desc "optional_arg [ARG]", "takes an optional arg"
+    def optional_arg(arg='default')
+    end
+  end
 end
 

data/spec/fixtures/subcommand.thor

@@ -0,0 +1,17 @@
+module TestSubcommands
+
+  class Subcommand < Thor
+    desc "print_opt", "My method"
+    def print_opt
+      print options["opt"]
+    end
+  end
+
+  class Parent < Thor
+    class_option "opt"
+
+    desc "sub", "My subcommand"
+    subcommand "sub", Subcommand
+  end
+
+end

data/spec/group_spec.rb

@@ -1,24 +1,24 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'helper'
 
 describe Thor::Group do
-  describe "task" do
-    it "allows to use private methods from parent class as tasks" do
+  describe "command" do
+    it "allows to use private methods from parent class as commands" do
       expect(ChildGroup.start).to eq(["bar", "foo", "baz"])
       expect(ChildGroup.new.baz("bar")).to eq("bar")
     end
   end
 
   describe "#start" do
-    it "invokes all the tasks under the Thor group" do
-      expect(MyCounter.start(["1", "2", "--third", "3"])).to eq([ 1, 2, 3 ])
+    it "invokes all the commands under the Thor group" do
+      expect(MyCounter.start(["1", "2", "--third", "3"])).to eq([ 1, 2, 3, nil, nil, nil ])
     end
 
     it "uses argument default value" do
-      expect(MyCounter.start(["1", "--third", "3"])).to eq([ 1, 2, 3 ])
+      expect(MyCounter.start(["1", "--third", "3"])).to eq([ 1, 2, 3, nil, nil, nil ])
     end
 
-    it "invokes all the tasks in the Thor group and his parents" do
-      expect(BrokenCounter.start(["1", "2", "--third", "3"])).to eq([ nil, 2, 3, false, 5 ])
+    it "invokes all the commands in the Thor group and its parents" do
+      expect(BrokenCounter.start(["1", "2", "--third", "3"])).to eq([ nil, 2, 3, false, 5, nil ])
     end
 
     it "raises an error if a required argument is added after a non-required" do
@@ -27,11 +27,11 @@ describe Thor::Group do
       }.to raise_error(ArgumentError, 'You cannot have "foo" as required argument after the non-required argument "second".')
     end
 
-    it "raises when an exception happens within the task call" do
+    it "raises when an exception happens within the command call" do
       expect{ BrokenCounter.start(["1", "2", "--fail"]) }.to raise_error
     end
 
-    it "raises an error when a Thor group task expects arguments" do
+    it "raises an error when a Thor group command expects arguments" do
       expect{ WhinyGenerator.start }.to raise_error(ArgumentError, /thor wrong_arity takes 1 argument, but it should not/)
     end
 
@@ -43,11 +43,11 @@ describe Thor::Group do
 
   describe "#desc" do
     it "sets the description for a given class" do
-      expect(MyCounter.desc).to eq("Description:\n  This generator runs three tasks: one, two and three.\n")
+      expect(MyCounter.desc).to eq("Description:\n  This generator runs three commands: one, two and three.\n")
     end
 
     it "can be inherited" do
-      expect(BrokenCounter.desc).to eq("Description:\n  This generator runs three tasks: one, two and three.\n")
+      expect(BrokenCounter.desc).to eq("Description:\n  This generator runs three commands: one, two and three.\n")
     end
 
     it "can be nil" do
@@ -66,7 +66,7 @@ describe Thor::Group do
 
     it "shows description" do
       expect(@content).to match(/Description:/)
-      expect(@content).to match(/This generator runs three tasks: one, two and three./)
+      expect(@content).to match(/This generator runs three commands: one, two and three./)
     end
 
     it "shows options information" do

data/spec/{spec_helper.rb → helper.rb}

@@ -1,10 +1,13 @@
 $TESTING=true
 
 require 'simplecov'
-SimpleCov.start do
-  add_group 'Libraries', 'lib'
-  add_group 'Specs', 'spec'
-end
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
 
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'thor'
@@ -23,11 +26,12 @@ 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", "enum.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")
-load File.join(File.dirname(__FILE__), "fixtures", "enum.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "script.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "subcommand.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "command.thor")
 
 RSpec.configure do |config|
   config.before do

data/spec/invocation_spec.rb

@@ -1,38 +1,38 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'helper'
 require 'thor/base'
 
 describe Thor::Invocation do
   describe "#invoke" do
-    it "invokes a task inside another task" do
+    it "invokes a command inside another command" do
       expect(capture(:stdout) { A.new.invoke(:two) }).to eq("2\n3\n")
     end
 
-    it "invokes a task just once" do
+    it "invokes a command just once" do
       expect(capture(:stdout) { A.new.invoke(:one) }).to eq("1\n2\n3\n")
     end
 
-    it "invokes a task just once even if they belongs to different classes" do
+    it "invokes a command just once even if they belongs to different classes" do
       expect(capture(:stdout) { Defined.new.invoke(:one) }).to eq("1\n2\n3\n4\n5\n")
     end
 
-    it "invokes a task with arguments" do
+    it "invokes a command with arguments" do
       expect(A.new.invoke(:five, [5])).to be_true
       expect(A.new.invoke(:five, [7])).to be_false
     end
 
-    it "invokes the default task if none is given to a Thor class" do
+    it "invokes the default command if none is given to a Thor class" do
       content = capture(:stdout) { A.new.invoke("b") }
-      expect(content).to match(/Tasks/)
+      expect(content).to match(/Commands/)
       expect(content).to match(/LAST_NAME/)
     end
 
-    it "accepts a class as argument without a task to invoke" do
+    it "accepts a class as argument without a command to invoke" do
       content = capture(:stdout) { A.new.invoke(B) }
-      expect(content).to match(/Tasks/)
+      expect(content).to match(/Commands/)
       expect(content).to match(/LAST_NAME/)
     end
 
-    it "accepts a class as argument with a task to invoke" do
+    it "accepts a class as argument with a command to invoke" do
       base = A.new([], :last_name => "Valim")
       expect(base.invoke(B, :one, ["Jose"])).to eq("Valim, Jose")
     end
@@ -60,7 +60,7 @@ describe Thor::Invocation do
       expect(base.invoke("b:three", [], {}, :shell => shell).shell).to eq(shell)
     end
 
-    it "invokes a Thor::Group and all of its tasks" do
+    it "invokes a Thor::Group and all of its commands" do
       expect(capture(:stdout) { A.new.invoke(:c) }).to eq("1\n2\n3\n")
     end
 
@@ -70,25 +70,25 @@ describe Thor::Invocation do
       expect(capture(:stdout) { base.invoke(:c) }).to be_empty
     end
 
-    it "does not invoke any of Thor::Group tasks twice" do
+    it "does not invoke any of Thor::Group commands twice" do
       base = A.new
       silence(:stdout){ base.invoke(:c) }
       expect(capture(:stdout) { base.invoke("c:one") }).to be_empty
     end
 
-    it "raises Thor::UndefinedTaskError if the task can't be found" do
+    it "raises Thor::UndefinedcommandError if the command can't be found" do
       expect {
         A.new.invoke("foo:bar")
-      }.to raise_error(Thor::UndefinedTaskError)
+      }.to raise_error(Thor::UndefinedCommandError)
     end
 
-    it "raises Thor::UndefinedTaskError if the task can't be found even if all tasks where already executed" do
+    it "raises Thor::UndefinedcommandError if the command can't be found even if all commands were already executed" do
       base = C.new
       silence(:stdout){ base.invoke_all }
 
       expect {
         base.invoke("foo:bar")
-      }.to raise_error(Thor::UndefinedTaskError)
+      }.to raise_error(Thor::UndefinedCommandError)
     end
 
     it "raises an error if a non Thor class is given" do

data/spec/parser/argument_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/parser'
 
 describe Thor::Argument do
@@ -16,19 +16,19 @@ describe Thor::Argument do
 
     it "raises an error if type is unknown" do
       expect {
-        argument(:task, :type => :unknown)
+        argument(:command, :type => :unknown)
       }.to raise_error(ArgumentError, "Type :unknown is not valid for arguments.")
     end
 
     it "raises an error if argument is required and have default values" do
       expect {
-        argument(:task, :type => :string, :default => "bar", :required => true)
+        argument(:command, :type => :string, :default => "bar", :required => true)
       }.to raise_error(ArgumentError, "An argument cannot be required and have default value.")
     end
 
     it "raises an error if enum isn't an array" do
       expect {
-        argument(:task, :type => :string, :enum => "bar")
+        argument(:command, :type => :string, :enum => "bar")
       }.to raise_error(ArgumentError, "An argument cannot have an enum other than an array.")
     end
   end