thor 0.12.0 → 0.13.0

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
@@ -65,13 +65,19 @@ describe Thor::Actions do
       runner.inside("doc") do
         action :copy_file, "README"
       end
-
       exists_and_identical?("doc/README", "doc/README")
     end
 
     it "logs status" do
       action(:copy_file, "task.thor").must == "      create  task.thor\n"
     end
+
+    it "accepts a block to change output" do
+      action :copy_file, "task.thor" do |content|
+        "OMG" + content
+      end
+      File.read(File.join(destination_root, "task.thor")).must =~ /^OMG/
+    end
   end
 
   describe "#get" do
@@ -117,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
@@ -126,6 +132,13 @@ describe Thor::Actions do
     it "logs status" do
       capture(:stdout){ runner.template("doc/config.rb") }.must == "      create  doc/config.rb\n"
     end
+
+    it "accepts a block to change output" do
+      action :template, "doc/config.rb" do |content|
+        "OMG" + content
+      end
+      File.read(File.join(destination_root, "doc/config.rb")).must =~ /^OMG/
+    end
   end
 
   describe "when changing existent files" do
@@ -166,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
@@ -192,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
@@ -208,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
@@ -228,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
@@ -242,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

@@ -134,7 +134,7 @@ describe Thor::Base do
     it "allows extra options to be given" do
       hash = { "Foo" => B.class_options.values }
 
-      content = capture(:stdout) { MyCounter.send(:class_options_help, Thor::Base.shell.new, nil, hash) }
+      content = capture(:stdout) { MyCounter.send(:class_options_help, Thor::Base.shell.new, hash) }
       content.must =~ /Foo options\:/
       content.must =~ /--last-name=LAST_NAME/
     end
@@ -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/bundle/main.thor

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'execute')

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

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

data/spec/fixtures/doc/README

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

data/spec/fixtures/group.thor

@@ -0,0 +1,83 @@
+class MyCounter < Thor::Group
+  include Thor::Actions
+  add_runtime_options!
+
+  def self.get_from_super
+    from_superclass(:get_from_super, 13)
+  end
+
+  def self.source_root
+    File.expand_path(File.dirname(__FILE__))
+  end
+  source_paths << File.expand_path("broken", File.dirname(__FILE__))
+
+  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"
+
+  desc <<-FOO
+Description:
+  This generator run three tasks: one, two and three.
+FOO
+
+  def one
+    first
+  end
+
+  def two
+    second
+  end
+
+  def three
+    options[:third]
+  end
+
+  def self.inherited(base)
+    super
+    base.source_paths.unshift(File.expand_path(File.join(File.dirname(__FILE__), "doc")))
+  end
+end
+
+class ClearCounter < MyCounter
+  remove_argument :first, :second, :undefine => true
+  remove_class_option :third
+
+  def self.source_root
+    File.expand_path(File.join(File.dirname(__FILE__), "bundle"))
+  end
+end
+
+class BrokenCounter < MyCounter
+  namespace "app:broken:counter"
+  class_option :fail, :type => :boolean, :default => false
+
+  class << self
+    undef_method :source_root
+  end
+
+  def one
+    options[:first]
+  end
+
+  def four
+    respond_to?(:fail)
+  end
+
+  def five
+    options[:fail] ? this_method_does_not_exist : 5
+  end
+end
+
+class WhinyGenerator < Thor::Group
+  include Thor::Actions
+
+  def self.source_root
+    File.expand_path(File.dirname(__FILE__))
+  end
+
+  def wrong_arity(required)
+  end
+end

data/spec/fixtures/invoke.thor

@@ -0,0 +1,112 @@
+class A < Thor
+  include Thor::Actions
+
+  desc "one", "invoke one"
+  def one
+    p 1
+    invoke :two
+    invoke :three
+  end
+
+  desc "two", "invoke two"
+  def two
+    p 2
+    invoke :three
+  end
+
+  desc "three", "invoke three"
+  def three
+    p 3
+  end
+
+  desc "four", "invoke four"
+  def four
+    p 4
+    invoke "defined:five"
+  end
+
+  desc "five N", "check if number is equal 5"
+  def five(number)
+    number == 5
+  end
+
+  desc "invoker", "invoke a b task"
+  def invoker(*args)
+    invoke :b, :one, ["Jose"]
+  end
+end
+
+class B < Thor
+  class_option :last_name, :type => :string
+
+  desc "one FIRST_NAME", "invoke one"
+  def one(first_name)
+    "#{options.last_name}, #{first_name}"
+  end
+
+  desc "two", "invoke two"
+  def two
+    options
+  end
+
+  desc "three", "invoke three"
+  def three
+    self
+  end
+end
+
+class C < Thor::Group
+  include Thor::Actions
+
+  def one
+    p 1
+  end
+
+  def two
+    p 2
+  end
+
+  def three
+    p 3
+  end
+end
+
+class Defined < Thor::Group
+  class_option :unused, :type => :boolean, :desc => "This option has no use"
+
+  def one
+    p 1
+    invoke "a:two"
+    invoke "a:three"
+    invoke "a:four"
+    invoke "defined:five"
+  end
+
+  def five
+    p 5
+  end
+
+  def print_status
+    say_status :finished, :counting
+  end
+end
+
+class E < Thor::Group
+  invoke Defined
+end
+
+class F < Thor::Group
+  invoke "b:one" do |instance, klass, task|
+    instance.invoke klass, task, [ "Jose" ], :last_name => "Valim"
+  end
+end
+
+class G < Thor::Group
+  class_option :invoked, :type => :string, :default => "defined"
+  invoke_from_option :invoked
+end
+
+class H < Thor::Group
+  class_option :defined, :type => :boolean, :default => true
+  invoke_from_option :defined
+end

data/spec/fixtures/script.thor

@@ -0,0 +1,134 @@
+class MyScript < Thor
+  attr_accessor :some_attribute
+  attr_writer :another_attribute
+  attr_reader :another_attribute
+
+  group :script
+  default_task :example_default_task
+
+  map "-T" => :animal, ["-f", "--foo"] => :foo
+
+  desc "zoo", "zoo around"
+  def zoo
+    true
+  end
+
+  desc "animal TYPE", "horse around"
+
+  no_tasks do
+    def this_is_not_a_task
+    end
+  end
+
+  def animal(type)
+    [type]
+  end
+
+  desc "foo BAR", <<END
+do some fooing
+  This is more info!
+  Everyone likes more info!
+END
+  method_option :force, :type => :boolean, :desc => "Force to do some fooing"
+  def foo(bar)
+    [bar, options]
+  end
+
+  desc "example_default_task", "example!"
+  def example_default_task
+    options.empty? ? "default task" : options
+  end
+
+  desc "call_myself_with_wrong_arity", "get the right error"
+  def call_myself_with_wrong_arity
+    call_myself_with_wrong_arity(4)
+  end
+
+  desc "call_unexistent_method", "Call unexistent method inside a task"
+  def call_unexistent_method
+    boom!
+  end
+
+  desc "long_description", "a" * 80
+  def long_description
+  end
+
+  method_options :all => :boolean
+  desc "with_optional NAME", "invoke with optional name"
+  def with_optional(name=nil)
+    [ name, options ]
+  end
+
+  class AnotherScript < Thor
+    desc "baz", "do some bazing"
+    def baz
+    end
+  end
+
+  private
+
+    def method_missing(meth, *args)
+      if meth == :boom!
+        super
+      else
+        [meth, args]
+      end
+    end
+
+    desc "what", "what"
+    def what
+    end
+end
+
+class MyChildScript < MyScript
+  remove_task :bar
+
+  method_options :force => :boolean, :param => :numeric
+  def initialize(*args)
+    super
+  end
+
+  desc "zoo", "zoo around"
+  method_options :param => :required
+  def zoo
+    options
+  end
+
+  desc "animal TYPE", "horse around"
+  def animal(type)
+    [type, options]
+  end
+  method_option :other, :type => :string, :default => "method default", :for => :animal
+  desc "animal KIND", "fish around", :for => :animal
+
+  desc "boom", "explodes everything"
+  def boom
+  end
+
+  remove_task :boom, :undefine => true
+end
+
+module Scripts
+  class MyScript < MyChildScript
+    argument :accessor, :type => :string
+    class_options :force => :boolean
+    method_option :new_option, :type => :string, :for => :example_default_task
+
+    def zoo
+      self.accessor
+    end
+  end
+
+  class MyDefaults < Thor
+    namespace :default
+    desc "test", "prints 'test'"
+    def test
+      puts "test"
+    end
+  end
+
+  class ChildDefault < Thor
+    namespace "default:child"
+  end
+end
+

data/spec/fixtures/task.thor

@@ -0,0 +1,10 @@
+# module: random
+
+class Amazing < Thor
+  desc "describe NAME", "say that someone is amazing"
+  method_options :forcefully => :boolean
+  def describe(name, opts)
+    ret = "#{name} is amazing"
+    puts opts["forcefully"] ? ret.upcase : ret
+  end
+end

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