thor 0.14.4 → 0.14.5

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 0.14, released 2010-07-25
+* Added CreateLink class and #link_file method 
+* Made Thor::Actions#run use system as default method for system calls
+* Allow use of private methods from superclass as tasks 
+* Added mute(&block) method which allows to run block without any output
+* Removed config[:pretend]
+* Enabled underscores for command line switches
+* Added Thor::Base.basename which is used by both Thor.banner and Thor::Group.banner
+* Deprecated invoke() without arguments
+* Added :only and :except to check_unknown_options
+
 == 0.13, released 2010-02-03
 
 * Added :lazy_default which is only triggered if a switch is given

data/Thorfile

@@ -1,70 +1,24 @@
 # enconding: utf-8
-
-require File.join(File.dirname(__FILE__), "lib", "thor", "version")
-require 'rubygems'
 require 'thor/rake_compat'
-require 'spec/rake/spectask'
-begin
-  require 'rdoc/task'
-rescue LoadError
-end
-
-GEM_NAME = 'thor'
-EXTRA_RDOC_FILES = ["README.md", "LICENSE", "CHANGELOG.rdoc", "Thorfile"]
 
 class Default < Thor
   include Thor::RakeCompat
 
-  Spec::Rake::SpecTask.new(:spec) do |t|
-    t.libs << 'lib'
-    t.spec_opts = ['--options', "spec/spec.opts"]
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
 
-  Spec::Rake::SpecTask.new(:rcov) do |t|
-    t.libs << 'lib'
-    t.spec_opts = ['--options', "spec/spec.opts"]
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.rcov = true
-    t.rcov_dir = "rcov"
-  end
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
 
+  require 'rdoc/task'
   if defined?(RDoc)
     RDoc::Task.new do |rdoc|
-      rdoc.main     = "README.rdoc"
-      rdoc.rdoc_dir = "rdoc"
-      rdoc.title    = GEM_NAME
-      rdoc.rdoc_files.include(*EXTRA_RDOC_FILES)
+      rdoc.main     = 'README.md'
+      rdoc.rdoc_dir = 'rdoc'
+      rdoc.title    = 'thor'
+      rdoc.rdoc_files.include('README.md', 'LICENSE', 'CHANGELOG.rdoc', 'Thorfile')
       rdoc.rdoc_files.include('lib/**/*.rb')
       rdoc.options << '--line-numbers' << '--inline-source'
     end
   end
-
-  begin
-    require 'jeweler'
-    Jeweler::Tasks.new do |s|
-      s.name = GEM_NAME
-      s.version = Thor::VERSION.dup
-      s.rubyforge_project = "textmate"
-      s.platform = Gem::Platform::RUBY
-      s.summary = "A scripting framework that replaces rake, sake and rubigen"
-      s.email = "ruby-thor@googlegroups.com"
-      s.homepage = "http://yehudakatz.com"
-      s.description = "A scripting framework that replaces rake, sake and rubigen"
-      s.authors = ['Yehuda Katz', 'José Valim']
-      s.has_rdoc = true
-      s.extra_rdoc_files = EXTRA_RDOC_FILES
-      s.require_path = 'lib'
-      s.bindir = "bin"
-      s.executables = %w( thor rake2thor )
-      s.files = s.extra_rdoc_files + Dir.glob("{bin,lib}/**/*")
-      s.test_files.include 'spec/**/*'
-      s.test_files.include 'spec/fixtures/doc/components/.empty_directory'
-      s.test_files.exclude 'spec/sandbox/**/*'
-    end
-
-    Jeweler::GemcutterTasks.new
-  rescue LoadError
-    puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
-  end
 end

data/lib/thor.rb

@@ -18,6 +18,23 @@ class Thor
       end
     end
 
+    # Registers another Thor subclass as a command.
+    #
+    # ==== Parameters
+    # klass<Class>:: Thor subclass to register
+    # command<String>:: Subcommand name to use
+    # usage<String>:: Short usage for the subcommand
+    # description<String>:: Description for the subcommand
+    def register(klass, subcommand_name, usage, description, options={})
+      if klass <= Thor::Group
+        desc usage, description, options
+        define_method(subcommand_name) { invoke klass }
+      else
+        desc usage, description, options
+        subcommand subcommand_name, klass
+      end
+    end
+
     # Defines the usage and the description of the next task.
     #
     # ==== Parameters

data/lib/thor/actions.rb

@@ -168,7 +168,7 @@ class Thor
       if !File.exist?(destination_root) && !pretend
         FileUtils.mkdir_p(destination_root)
       end
-      
+
       if pretend
         # In pretend mode, just yield down to the block
         block.arity == 1 ? yield(destination_root) : yield
@@ -220,7 +220,7 @@ class Thor
     #
     # ==== Parameters
     # command<String>:: the command to be executed.
-    # config<Hash>:: give :verbose => false to not log the status. Specify :with
+    # config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output. Specify :with
     #                to append an executable to command executation.
     #
     # ==== Example
@@ -241,7 +241,10 @@ class Thor
       end
 
       say_status :run, desc, config.fetch(:verbose, true)
-      `#{command}` unless options[:pretend]
+
+      unless options[:pretend]
+        config[:capture] ? `#{command}` : system("#{command}")
+      end
     end
 
     # Executes a ruby script (taking into account WIN32 platform quirks).
@@ -261,8 +264,9 @@ class Thor
     # ==== Parameters
     # task<String>:: the task to be invoked
     # args<Array>:: arguments to the task
-    # config<Hash>:: give :verbose => false to not log the status. Other options
-    #                are given as parameter to Thor.
+    # config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output.
+    #                Other options are given as parameter to Thor.
+    #
     #
     # ==== Examples
     #
@@ -276,12 +280,13 @@ class Thor
       config  = args.last.is_a?(Hash) ? args.pop : {}
       verbose = config.key?(:verbose) ? config.delete(:verbose) : true
       pretend = config.key?(:pretend) ? config.delete(:pretend) : false
+      capture = config.key?(:capture) ? config.delete(:capture) : false
 
       args.unshift task
       args.push Thor::Options.to_switches(config)
       command = args.join(' ').strip
 
-      run command, :with => :thor, :verbose => verbose, :pretend => pretend
+      run command, :with => :thor, :verbose => verbose, :pretend => pretend, :capture => capture
     end
 
     protected

data/lib/thor/actions/create_file.rb

@@ -18,7 +18,7 @@ class Thor
     #     "vhost.name = #{hostname}"
     #   end
     #
-    #   create_file "config/apach.conf", "your apache config"
+    #   create_file "config/apache.conf", "your apache config"
     #
     def create_file(destination, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
@@ -27,7 +27,7 @@ class Thor
     end
     alias :add_file :create_file
 
-    # AddFile is a subset of Template, which instead of rendering a file with
+    # CreateFile is a subset of Template, which instead of rendering a file with
     # ERB, it gets the content from the user.
     #
     class CreateFile < EmptyDirectory #:nodoc:

data/lib/thor/actions/create_link.rb

@@ -0,0 +1,57 @@
+require 'thor/actions/empty_directory'
+
+class Thor
+  module Actions
+
+    # Create a new file relative to the destination root from the given source.
+    #
+    # ==== Parameters
+    # destination<String>:: the relative path to the destination root.
+    # source<String|NilClass>:: the relative path to the source root.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #   :: give :symbolic => false for hard link.
+    #
+    # ==== Examples
+    #
+    #   create_link "config/apache.conf", "/etc/apache.conf"
+    #
+    def create_link(destination, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      source = args.first
+      action CreateLink.new(self, destination, source, config)
+    end
+    alias :add_link :create_link
+
+    # CreateLink is a subset of CreateFile, which instead of taking a block of
+    # data, just takes a source string from the user.
+    #
+    class CreateLink < CreateFile #:nodoc:
+      attr_reader :data
+
+      # Checks if the content of the file at the destination is identical to the rendered result.
+      #
+      # ==== Returns
+      # Boolean:: true if it is identical, false otherwise.
+      #
+      def identical?
+        exists? && File.identical?(render, destination)
+      end
+
+      def invoke!
+        invoke_with_conflict_check do
+          FileUtils.mkdir_p(File.dirname(destination))
+          # Create a symlink by default
+          config[:symbolic] ||= true
+          File.unlink(destination) if exists?
+          if config[:symbolic]
+            File.symlink(render, destination)
+          else
+            File.link(render, destination)
+          end
+        end
+        given_destination
+      end
+
+    end
+  end
+end

data/lib/thor/actions/file_manipulation.rb

@@ -30,6 +30,28 @@ class Thor
       end
     end
 
+    # Links the file from the relative source to the relative destination. If
+    # the destination is not given it's assumed to be equal to the source.
+    #
+    # ==== Parameters
+    # source<String>:: the relative path to the source root.
+    # destination<String>:: the relative path to the destination root.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   link_file "README", "doc/README"
+    #
+    #   link_file "doc/README"
+    #
+    def link_file(source, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      destination = args.first || source
+      source = File.expand_path(find_in_source_paths(source.to_s))
+
+      create_link destination, source, config
+    end
+
     # Gets the content at the given address and places it at the given relative
     # destination. If a block is given instead of destination, the content of
     # the url is yielded and used as location.
@@ -110,7 +132,7 @@ class Thor
       FileUtils.chmod_R(mode, path) unless options[:pretend]
     end
 
-    # Prepend text to a file. Since it depends on inject_into_file, it's reversible.
+    # Prepend text to a file. Since it depends on insert_into_file, it's reversible.
     #
     # ==== Parameters
     # path<String>:: path of the file to be changed
@@ -119,19 +141,20 @@ class Thor
     #
     # ==== Example
     #
-    #   prepend_file 'config/environments/test.rb', 'config.gem "rspec"'
+    #   prepend_to_file 'config/environments/test.rb', 'config.gem "rspec"'
     #
-    #   prepend_file 'config/environments/test.rb' do
+    #   prepend_to_file 'config/environments/test.rb' do
     #     'config.gem "rspec"'
     #   end
     #
-    def prepend_file(path, *args, &block)
+    def prepend_to_file(path, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
       config.merge!(:after => /\A/)
-      inject_into_file(path, *(args << config), &block)
+      insert_into_file(path, *(args << config), &block)
     end
+    alias_method :prepend_file, :prepend_to_file
 
-    # Append text to a file. Since it depends on inject_into_file, it's reversible.
+    # Append text to a file. Since it depends on insert_into_file, it's reversible.
     #
     # ==== Parameters
     # path<String>:: path of the file to be changed
@@ -140,20 +163,21 @@ class Thor
     #
     # ==== Example
     #
-    #   append_file 'config/environments/test.rb', 'config.gem "rspec"'
+    #   append_to_file 'config/environments/test.rb', 'config.gem "rspec"'
     #
-    #   append_file 'config/environments/test.rb' do
+    #   append_to_file 'config/environments/test.rb' do
     #     'config.gem "rspec"'
     #   end
     #
-    def append_file(path, *args, &block)
+    def append_to_file(path, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
       config.merge!(:before => /\z/)
-      inject_into_file(path, *(args << config), &block)
+      insert_into_file(path, *(args << config), &block)
     end
+    alias_method :append_file, :append_to_file
 
     # Injects text right after the class definition. Since it depends on
-    # inject_into_file, it's reversible.
+    # insert_into_file, it's reversible.
     #
     # ==== Parameters
     # path<String>:: path of the file to be changed
@@ -172,7 +196,7 @@ class Thor
     def inject_into_class(path, klass, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
       config.merge!(:after => /class #{klass}\n|class #{klass} .*\n/)
-      inject_into_file(path, *(args << config), &block)
+      insert_into_file(path, *(args << config), &block)
     end
 
     # Run a regular expression replacement on a file.

data/lib/thor/actions/inject_into_file.rb

@@ -10,19 +10,19 @@ class Thor
     # destination<String>:: Relative path to the destination root
     # data<String>:: Data to add to the file. Can be given as a block.
     # config<Hash>:: give :verbose => false to not log the status and the flag
-    #                for injection (:after or :before) or :force => true for 
+    #                for injection (:after or :before) or :force => true for
     #                insert two or more times the same content.
-    # 
+    #
     # ==== Examples
     #
-    #   inject_into_file "config/environment.rb", "config.gem :thor", :after => "Rails::Initializer.run do |config|\n"
+    #   insert_into_file "config/environment.rb", "config.gem :thor", :after => "Rails::Initializer.run do |config|\n"
     #
-    #   inject_into_file "config/environment.rb", :after => "Rails::Initializer.run do |config|\n" do
+    #   insert_into_file "config/environment.rb", :after => "Rails::Initializer.run do |config|\n" do
     #     gems = ask "Which gems would you like to add?"
     #     gems.split(" ").map{ |gem| "  config.gem :#{gem}" }.join("\n")
     #   end
     #
-    def inject_into_file(destination, *args, &block)
+    def insert_into_file(destination, *args, &block)
       if block_given?
         data, config = block, args.shift
       else
@@ -30,6 +30,7 @@ class Thor
       end
       action InjectIntoFile.new(self, destination, data, config)
     end
+    alias_method :inject_into_file, :insert_into_file
 
     class InjectIntoFile < EmptyDirectory #:nodoc:
       attr_reader :replacement, :flag, :behavior
@@ -76,12 +77,16 @@ class Thor
       protected
 
         def say_status(behavior)
-          status = if flag == /\A/
-            behavior == :invoke ? :prepend : :unprepend
-          elsif flag == /\z/
-            behavior == :invoke ? :append : :unappend
+          status = if behavior == :invoke
+            if flag == /\A/
+               :prepend
+            elsif flag == /\z/
+              :append
+            else
+              :insert
+            end
           else
-            behavior == :invoke ? :inject : :deinject
+            :subtract
           end
 
           super(status, config[:verbose])

data/lib/thor/parser/option.rb

@@ -37,7 +37,7 @@ class Thor
     # string (--foo=value) or booleans (just --foo).
     #
     # By default all options are optional, unless :required is given.
-    # 
+    #
     def self.parse(key, value)
       if key.is_a?(Array)
         name, *aliases = key

data/lib/thor/task.rb

@@ -111,4 +111,4 @@ class Thor
       end
     end
   end
-end
+end

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.14.4".freeze
+  VERSION = "0.14.5".freeze
 end

data/spec/actions/create_file_spec.rb

@@ -30,36 +30,36 @@ describe Thor::Actions::CreateFile do
     it "creates a file" do
       create_file("doc/config.rb")
       invoke!
-      File.exists?(File.join(destination_root, "doc/config.rb")).must be_true
+      File.exists?(File.join(destination_root, "doc/config.rb")).should be_true
     end
 
     it "does not create a file if pretending" do
       create_file("doc/config.rb", {}, :pretend => true)
       invoke!
-      File.exists?(File.join(destination_root, "doc/config.rb")).must be_false
+      File.exists?(File.join(destination_root, "doc/config.rb")).should be_false
     end
 
     it "shows created status to the user" do
       create_file("doc/config.rb")
-      invoke!.must == "      create  doc/config.rb\n"
+      invoke!.should == "      create  doc/config.rb\n"
     end
 
     it "does not show any information if log status is false" do
       silence!
       create_file("doc/config.rb")
-      invoke!.must be_empty
+      invoke!.should be_empty
     end
 
     it "returns the given destination" do
       capture(:stdout) do
-        create_file("doc/config.rb").invoke!.must == "doc/config.rb"
+        create_file("doc/config.rb").invoke!.should == "doc/config.rb"
       end
     end
 
     it "converts encoded instructions" do
       create_file("doc/%file_name%.rb.tt")
       invoke!
-      File.exists?(File.join(destination_root, "doc/rdoc.rb.tt")).must be_true
+      File.exists?(File.join(destination_root, "doc/rdoc.rb.tt")).should be_true
     end
 
     describe "when file exists" do
@@ -72,7 +72,7 @@ describe Thor::Actions::CreateFile do
         it "shows identical status" do
           create_file("doc/config.rb")
           invoke!
-          invoke!.must == "   identical  doc/config.rb\n"
+          invoke!.should == "   identical  doc/config.rb\n"
         end
       end
 
@@ -82,46 +82,46 @@ describe Thor::Actions::CreateFile do
         end
 
         it "shows forced status to the user if force is given" do
-          create_file("doc/config.rb", {}, :force => true).must_not be_identical
-          invoke!.must == "       force  doc/config.rb\n"
+          create_file("doc/config.rb", {}, :force => true).should_not be_identical
+          invoke!.should == "       force  doc/config.rb\n"
         end
 
         it "shows skipped status to the user if skip is given" do
-          create_file("doc/config.rb", {}, :skip => true).must_not be_identical
-          invoke!.must == "        skip  doc/config.rb\n"
+          create_file("doc/config.rb", {}, :skip => true).should_not be_identical
+          invoke!.should == "        skip  doc/config.rb\n"
         end
 
         it "shows forced status to the user if force is configured" do
-          create_file("doc/config.rb", :force => true).must_not be_identical
-          invoke!.must == "       force  doc/config.rb\n"
+          create_file("doc/config.rb", :force => true).should_not be_identical
+          invoke!.should == "       force  doc/config.rb\n"
         end
 
         it "shows skipped status to the user if skip is configured" do
-          create_file("doc/config.rb", :skip => true).must_not be_identical
-          invoke!.must == "        skip  doc/config.rb\n"
+          create_file("doc/config.rb", :skip => true).should_not be_identical
+          invoke!.should == "        skip  doc/config.rb\n"
         end
 
         it "shows conflict status to ther user" do
-          create_file("doc/config.rb").must_not be_identical
+          create_file("doc/config.rb").should_not be_identical
           $stdin.should_receive(:gets).and_return('s')
           file = File.join(destination_root, 'doc/config.rb')
 
           content = invoke!
-          content.must =~ /conflict  doc\/config\.rb/
-          content.must =~ /Overwrite #{file}\? \(enter "h" for help\) \[Ynaqdh\]/
-          content.must =~ /skip  doc\/config\.rb/
+          content.should =~ /conflict  doc\/config\.rb/
+          content.should =~ /Overwrite #{file}\? \(enter "h" for help\) \[Ynaqdh\]/
+          content.should =~ /skip  doc\/config\.rb/
         end
 
         it "creates the file if the file collision menu returns true" do
           create_file("doc/config.rb")
           $stdin.should_receive(:gets).and_return('y')
-          invoke!.must =~ /force  doc\/config\.rb/
+          invoke!.should =~ /force  doc\/config\.rb/
         end
 
         it "skips the file if the file collision menu returns false" do
           create_file("doc/config.rb")
           $stdin.should_receive(:gets).and_return('n')
-          invoke!.must =~ /skip  doc\/config\.rb/
+          invoke!.should =~ /skip  doc\/config\.rb/
         end
 
         it "executes the block given to show file content" do
@@ -140,31 +140,31 @@ describe Thor::Actions::CreateFile do
       create_file("doc/config.rb")
       invoke!
       revoke!
-      File.exists?(@action.destination).must be_false
+      File.exists?(@action.destination).should be_false
     end
 
     it "does not raise an error if the file does not exist" do
       create_file("doc/config.rb")
       revoke!
-      File.exists?(@action.destination).must be_false
+      File.exists?(@action.destination).should be_false
     end
   end
 
   describe "#exists?" do
     it "returns true if the destination file exists" do
       create_file("doc/config.rb")
-      @action.exists?.must be_false
+      @action.exists?.should be_false
       invoke!
-      @action.exists?.must be_true
+      @action.exists?.should be_true
     end
   end
 
   describe "#identical?" do
     it "returns true if the destination file and is identical" do
       create_file("doc/config.rb")
-      @action.identical?.must be_false
+      @action.identical?.should be_false
       invoke!
-      @action.identical?.must be_true
+      @action.identical?.should be_true
     end
   end
 end