thor 0.17.0 → 0.18.0

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

data/spec/actions/create_file_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/actions'
 
 describe Thor::Actions::CreateFile do

data/spec/actions/create_link_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/actions'
 require 'tempfile'
 
@@ -23,6 +23,10 @@ describe Thor::Actions::CreateLink do
     capture(:stdout) { @action.invoke! }
   end
 
+  def revoke!
+    capture(:stdout) { @action.revoke! }
+  end
+
   def silence!
     @silence = true
   end
@@ -78,4 +82,14 @@ describe Thor::Actions::CreateLink do
       expect(@action.identical?).to be_true
     end
   end
+
+  describe "#revoke!" do
+    it "removes the symbolic link of non-existent destination" do
+      create_link("doc/config.rb")
+      invoke!
+      File.delete(@tempfile.path)
+      revoke!
+      expect(File.symlink?(@action.destination)).to be_false
+    end
+  end
 end

data/spec/actions/directory_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/actions'
 
 describe Thor::Actions::Directory do
@@ -56,18 +56,31 @@ describe Thor::Actions::Directory do
     end
 
     it "copies only the first level files if recursive" do
-      invoke! ".", "tasks", :recursive => false
+      invoke! ".", "commands", :recursive => false
 
-      file = File.join(destination_root, "tasks", "group.thor")
+      file = File.join(destination_root, "commands", "group.thor")
       expect(File.exists?(file)).to be_true
 
-      file = File.join(destination_root, "tasks", "doc")
+      file = File.join(destination_root, "commands", "doc")
       expect(File.exists?(file)).to be_false
 
-      file = File.join(destination_root, "tasks", "doc", "README")
+      file = File.join(destination_root, "commands", "doc", "README")
       expect(File.exists?(file)).to be_false
     end
 
+    it "ignores files within excluding/ directories when exclude_pattern is provided" do
+      invoke! "doc", "docs", :exclude_pattern => /excluding\//
+      file = File.join(destination_root, "docs", "excluding", "rdoc.rb")
+      expect(File.exists?(file)).to be_false
+    end
+
+    it "copies and evalutes files within excluding/ directory when no exclude_pattern is present" do
+      invoke! "doc", "docs"
+      file = File.join(destination_root, "docs", "excluding", "rdoc.rb")
+      expect(File.exists?(file)).to be_true
+      expect(File.read(file)).to eq("BAR = BAR\n")
+    end
+
     it "copies files from the source relative to the current path" do
       invoker.inside "doc" do
         invoke! "."

data/spec/actions/empty_directory_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/actions'
 
 describe Thor::Actions::EmptyDirectory do

data/spec/actions/file_manipulation_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 
 class Application; end
 
@@ -52,13 +52,13 @@ describe Thor::Actions do
 
   describe "#copy_file" do
     it "copies file from source to default destination" do
-      action :copy_file, "task.thor"
-      exists_and_identical?("task.thor", "task.thor")
+      action :copy_file, "command.thor"
+      exists_and_identical?("command.thor", "command.thor")
     end
 
     it "copies file from source to the specified destination" do
-      action :copy_file, "task.thor", "foo.thor"
-      exists_and_identical?("task.thor", "foo.thor")
+      action :copy_file, "command.thor", "foo.thor"
+      exists_and_identical?("command.thor", "foo.thor")
     end
 
     it "copies file from the source relative to the current path" do
@@ -76,26 +76,26 @@ describe Thor::Actions do
     end
 
     it "logs status" do
-      expect(action(:copy_file, "task.thor")).to eq("      create  task.thor\n")
+      expect(action(:copy_file, "command.thor")).to eq("      create  command.thor\n")
     end
 
     it "accepts a block to change output" do
-      action :copy_file, "task.thor" do |content|
+      action :copy_file, "command.thor" do |content|
         "OMG" + content
       end
-      expect(File.read(File.join(destination_root, "task.thor"))).to match(/^OMG/)
+      expect(File.read(File.join(destination_root, "command.thor"))).to match(/^OMG/)
     end
   end
 
   describe "#link_file" do
     it "links file from source to default destination" do
-      action :link_file, "task.thor"
-      exists_and_identical?("task.thor", "task.thor")
+      action :link_file, "command.thor"
+      exists_and_identical?("command.thor", "command.thor")
     end
 
     it "links file from source to the specified destination" do
-      action :link_file, "task.thor", "foo.thor"
-      exists_and_identical?("task.thor", "foo.thor")
+      action :link_file, "command.thor", "foo.thor"
+      exists_and_identical?("command.thor", "foo.thor")
     end
 
     it "links file from the source relative to the current path" do
@@ -106,7 +106,7 @@ describe Thor::Actions do
     end
 
     it "logs status" do
-      expect(action(:link_file, "task.thor")).to eq("      create  task.thor\n")
+      expect(action(:link_file, "command.thor")).to eq("      create  command.thor\n")
     end
   end
 

data/spec/actions/inject_into_file_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/actions'
 
 describe Thor::Actions::InjectIntoFile do

data/spec/actions_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'helper'
 
 describe Thor::Actions do
   def runner(options={})

data/spec/base_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'helper'
 require 'thor/base'
 
 class Amazing
@@ -45,10 +45,10 @@ describe Thor::Base do
     end
   end
 
-  describe "#no_tasks" do
-    it "avoids methods being added as tasks" do
-      expect(MyScript.tasks.keys).to include("animal")
-      expect(MyScript.tasks.keys).not_to include("this_is_not_a_task")
+  describe "#no_commands" do
+    it "avoids methods being added as commands" do
+      expect(MyScript.commands.keys).to include("animal")
+      expect(MyScript.commands.keys).not_to include("this_is_not_a_command")
     end
   end
 
@@ -69,6 +69,17 @@ describe Thor::Base do
     end
   end
 
+  describe ":aliases" do
+    it "supports string aliases without a dash prefix" do
+      expect(MyCounter.start(["1", "2", "-z", "3"])[4]).to eq(3)
+    end
+
+    it "supports symbol aliases" do
+      expect(MyCounter.start(["1", "2", "-y", "3"])[5]).to eq(3)
+      expect(MyCounter.start(["1", "2", "-r", "3"])[5]).to eq(3)
+    end
+  end
+
   describe "#class_option" do
     it "sets options class wise" do
       expect(MyCounter.start(["1", "2", "--third", "3"])[2]).to eq(3)
@@ -128,7 +139,7 @@ describe Thor::Base do
 
     it "use padding in options that does not have aliases" do
       expect(@content).to match(/^  -t, \[--third/)
-      expect(@content).to match(/^      \[--fourth/)
+      expect(@content).to match(/^          \[--fourth/)
     end
 
     it "allows extra options to be given" do
@@ -182,42 +193,43 @@ describe Thor::Base do
       thorfile = File.join(File.dirname(__FILE__), "fixtures", "script.thor")
       expect(Thor::Base.subclass_files[File.expand_path(thorfile)]).to eq([
         MyScript, MyScript::AnotherScript, MyChildScript, Barn,
-        Scripts::MyScript, Scripts::MyDefaults, Scripts::ChildDefault
+        PackageNameScript, Scripts::MyScript, Scripts::MyDefaults,
+        Scripts::ChildDefault, Scripts::Arities
       ])
     end
 
     it "tracks a single subclass across multiple files" do
-      thorfile = File.join(File.dirname(__FILE__), "fixtures", "task.thor")
+      thorfile = File.join(File.dirname(__FILE__), "fixtures", "command.thor")
       expect(Thor::Base.subclass_files[File.expand_path(thorfile)]).to include(Amazing)
       expect(Thor::Base.subclass_files[File.expand_path(__FILE__)]).to include(Amazing)
     end
   end
 
-  describe "#tasks" do
-    it "returns a list with all tasks defined in this class" do
+  describe "#commands" do
+    it "returns a list with all commands defined in this class" do
       expect(MyChildScript.new).to respond_to("animal")
-      expect(MyChildScript.tasks.keys).to include("animal")
+      expect(MyChildScript.commands.keys).to include("animal")
     end
 
-    it "raises an error if a task with reserved word is defined" do
+    it "raises an error if a command with reserved word is defined" do
       expect {
         klass = Class.new(Thor::Group)
         klass.class_eval "def shell; end"
-      }.to raise_error(RuntimeError, /"shell" is a Thor reserved word and cannot be defined as task/)
+      }.to raise_error(RuntimeError, /"shell" is a Thor reserved word and cannot be defined as command/)
     end
   end
 
-  describe "#all_tasks" do
-    it "returns a list with all tasks defined in this class plus superclasses" do
+  describe "#all_commands" do
+    it "returns a list with all commands defined in this class plus superclasses" do
       expect(MyChildScript.new).to respond_to("foo")
-      expect(MyChildScript.all_tasks.keys).to include("foo")
+      expect(MyChildScript.all_commands.keys).to include("foo")
     end
   end
 
-  describe "#remove_task" do
-    it "removes the task from its tasks hash" do
-      expect(MyChildScript.tasks.keys).not_to include("bar")
-      expect(MyChildScript.tasks.keys).not_to include("boom")
+  describe "#remove_command" do
+    it "removes the command from its commands hash" do
+      expect(MyChildScript.commands.keys).not_to include("bar")
+      expect(MyChildScript.commands.keys).not_to include("boom")
     end
 
     it "undefines the method if desired" do
@@ -237,7 +249,7 @@ describe Thor::Base do
         ENV["THOR_DEBUG"] = 1
         expect {
           MyScript.start ["what", "--debug"]
-        }.to raise_error(Thor::UndefinedTaskError, 'Could not find task "what" in "my_script" namespace.')
+        }.to raise_error(Thor::UndefinedcommandError, 'Could not find command "what" in "my_script" namespace.')
       rescue
         ENV["THOR_DEBUG"] = nil
       end
@@ -263,17 +275,21 @@ describe Thor::Base do
   end
 
   describe "attr_*" do
-    it "does not add attr_reader as a task" do
+    it "does not add attr_reader as a command" do
       expect(capture(:stderr){ MyScript.start(["another_attribute"]) }).to match(/Could not find/)
     end
 
-    it "does not add attr_writer as a task" do
+    it "does not add attr_writer as a command" do
       expect(capture(:stderr){ MyScript.start(["another_attribute=", "foo"]) }).to match(/Could not find/)
     end
 
-    it "does not add attr_accessor as a task" do
+    it "does not add attr_accessor as a command" do
       expect(capture(:stderr){ MyScript.start(["some_attribute"]) }).to match(/Could not find/)
       expect(capture(:stderr){ MyScript.start(["some_attribute=", "foo"]) }).to match(/Could not find/)
     end
+
+    it "respects visibility" do
+      expect(MyScript.public_instance_methods).to_not include(:private_attribute)
+    end
   end
 end

data/spec/command_spec.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+describe Thor::Command do
+  def command(options={})
+    options.each do |key, value|
+      options[key] = Thor::Option.parse(key, value)
+    end
+
+    @command ||= Thor::Command.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", [])
+      expect(command(:bar => :required).formatted_usage(object)).to eq("foo:can_has --bar=BAR")
+    end
+
+    it "includes subcommand name within subcommand usage" do
+      object = Struct.new(:namespace, :arguments).new("main:foo", [])
+      expect(command(:bar => :required).formatted_usage(object, false, true)).to eq("foo can_has --bar=BAR")
+    end
+
+    it "removes default from namespace" do
+      object = Struct.new(:namespace, :arguments).new("default:foo", [])
+      expect(command(:bar => :required).formatted_usage(object)).to eq(":foo:can_has --bar=BAR")
+    end
+
+    it "injects arguments into usage" do
+      options = {:required => true, :type => :string}
+      object = Struct.new(:namespace, :arguments).new("foo", [Thor::Argument.new(:bar, options)])
+      expect(command(:foo => :required).formatted_usage(object)).to eq("foo:can_has BAR --foo=FOO")
+    end
+  end
+
+  describe "#dynamic" do
+    it "creates a dynamic command with the given name" do
+      expect(Thor::DynamicCommand.new('command').name).to eq('command')
+      expect(Thor::DynamicCommand.new('command').description).to eq('A dynamically-generated command')
+      expect(Thor::DynamicCommand.new('command').usage).to eq('command')
+      expect(Thor::DynamicCommand.new('command').options).to eq({})
+    end
+
+    it "does not invoke an existing method" do
+      mock = mock()
+      mock.class.should_receive(:handle_no_command_error).with("to_s")
+      Thor::DynamicCommand.new('to_s').run(mock)
+    end
+  end
+
+  describe "#dup" do
+    it "dup options hash" do
+      command = Thor::Command.new("can_has", nil, nil, nil, :foo => true, :bar => :required)
+      command.dup.options.delete(:foo)
+      expect(command.options[:foo]).to be
+    end
+  end
+
+  describe "#run" do
+    it "runs a command by calling a method in the given instance" do
+      mock = mock()
+      mock.should_receive(:can_has).and_return {|*args| args }
+      expect(command.run(mock, [1, 2, 3])).to eq([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_command_error(name)
+          name
+        end
+
+      private
+        def can_has
+          "fail"
+        end
+      end
+
+      expect(command.run(klass.new)).to eq("can_has")
+    end
+  end
+end

data/spec/core_ext/hash_with_indifferent_access_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/core_ext/hash_with_indifferent_access'
 
 describe Thor::CoreExt::HashWithIndifferentAccess do

data/spec/core_ext/ordered_hash_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'helper'
 require 'thor/core_ext/ordered_hash'
 
 describe Thor::CoreExt::OrderedHash do

data/spec/exit_condition_spec.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'helper'
 require 'thor/base'
 
 describe "Exit conditions" do
   it "exits 0, not bubble up EPIPE, if EPIPE is raised" do
     epiped = false
 
-    task = Class.new(Thor) do
+    command = Class.new(Thor) do
       desc "my_action", "testing EPIPE"
       define_method :my_action do
         epiped = true
@@ -13,7 +13,7 @@ describe "Exit conditions" do
       end
     end
 
-    expect{ task.start(["my_action"]) }.to raise_error(SystemExit)
+    expect{ command.start(["my_action"]) }.to raise_error(SystemExit)
     expect(epiped).to eq(true)
   end
 end

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

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

data/spec/fixtures/doc/COMMENTER

@@ -0,0 +1,11 @@
+__start__
+ # greenblue
+#
+# yellowblue
+#yellowred
+ #greenred
+orange
+    purple
+  ind#igo
+  # ind#igo
+__end__

data/spec/fixtures/doc/README

@@ -0,0 +1,3 @@
+__start__
+README
+__end__