thor 0.18.1 → 0.19.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e171d5182116b3c46ec1cf9207ca4e95c9412a6
+  data.tar.gz: dec1d983eca1b3b1eefe3102dee412ef4305c609
+SHA512:
+  metadata.gz: 496ebeb3755de7ad56efab9b8686a3b84f22d8c9592b891a8a9434939d49015b2b36d315c22258b51496b482f65a7b591acf4275484209a37787b67642ff7ac4
+  data.tar.gz: 195addb56fb393d916eecd4b8cdeb64536c6fa50b5d413a89c39f6b6838e0b137946acae37f48804208c041f8432fa759eaa1c455c21fa13662eb365980fae53

data/README.md

@@ -1,12 +1,18 @@
-[![Gem Version](https://badge.fury.io/rb/thor.png)](https://rubygems.org/gems/thor)
-[![Build Status](https://secure.travis-ci.org/wycats/thor.png?branch=master)](http://travis-ci.org/wycats/thor)
-[![Dependency Status](https://gemnasium.com/wycats/thor.png?travis)](https://gemnasium.com/wycats/thor)
-[![Code Climate](https://codeclimate.com/github/wycats/thor.png)](https://codeclimate.com/github/wycats/thor)
-[![Coverage Status](https://coveralls.io/repos/wycats/thor/badge.png?branch=master)](https://coveralls.io/r/wycats/thor)
-
 Thor
 ====
 
+[![Gem Version](http://img.shields.io/gem/v/thor.svg)][gem]
+[![Build Status](http://img.shields.io/travis/erikhuda/thor.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/erikhuda/thor.svg)][gemnasium]
+[![Code Climate](http://img.shields.io/codeclimate/github/erikhuda/thor.svg)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/erikhuda/thor.svg)][coveralls]
+
+[gem]: https://rubygems.org/gems/thor
+[travis]: http://travis-ci.org/erikhuda/thor
+[gemnasium]: https://gemnasium.com/erikhuda/thor
+[codeclimate]: https://codeclimate.com/github/erikhuda/thor
+[coveralls]: https://coveralls.io/r/erikhuda/thor
+
 Description
 -----------
 Thor is a simple and efficient tool for building self-documenting command line
@@ -25,7 +31,7 @@ Usage and documentation
 -----------------------
 Please see the [wiki][] for basic usage and other documentation on using Thor. You can also checkout the [official homepage][homepage].
 
-[wiki]: https://github.com/wycats/thor/wiki
+[wiki]: https://github.com/erikhuda/thor/wiki
 [homepage]: http://whatisthor.com/
 
 License

data/Thorfile

@@ -1,8 +1,7 @@
-# encoding: utf-8
-$:.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
-require 'bundler'
-require 'thor/rake_compat'
+require "bundler"
+require "thor/rake_compat"
 
 class Default < Thor
   include Thor::RakeCompat
@@ -25,6 +24,6 @@ class Default < Thor
 
   desc "spec", "Run RSpec code examples"
   def spec
-    exec "rspec --color --format=documentation spec"
+    exec "rspec spec"
   end
 end

data/bin/thor

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # -*- mode: ruby -*-
 
-require 'thor/runner'
+require "thor/runner"
 $thor_runner = true
 Thor::Runner.start

data/lib/thor.rb

@@ -1,7 +1,7 @@
-require 'set'
-require 'thor/base'
+require "set"
+require "thor/base"
 
-class Thor
+class Thor # rubocop:disable ClassLength
   class << self
     # Allows for custom "Command" package naming.
     #
@@ -9,8 +9,8 @@ class Thor
     # name<String>
     # options<Hash>
     #
-    def package_name(name, options={})
-      @package_name = name.nil? || name == '' ? nil : name
+    def package_name(name, options = {})
+      @package_name = name.nil? || name == "" ? nil : name
     end
 
     # Sets the default command when thor is executed without an explicit command to be called.
@@ -18,17 +18,14 @@ class Thor
     # ==== Parameters
     # meth<Symbol>:: name of the default command
     #
-    def default_command(meth=nil)
-      @default_command = case meth
-      when :none
-        'help'
-      when nil
-        @default_command || from_superclass(:default_command, 'help')
+    def default_command(meth = nil)
+      if meth
+        @default_command = meth == :none ? "help" : meth.to_s
       else
-        meth.to_s
+        @default_command ||= from_superclass(:default_command, "help")
       end
     end
-    alias default_task default_command
+    alias_method :default_task, :default_command
 
     # Registers another Thor subclass as a command.
     #
@@ -37,7 +34,7 @@ class Thor
     # 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={})
+    def register(klass, subcommand_name, usage, description, options = {})
       if klass <= Thor::Group
         desc usage, description, options
         define_method(subcommand_name) { |*args| invoke(klass, args) }
@@ -54,7 +51,7 @@ class Thor
     # description<String>
     # options<String>
     #
-    def desc(usage, description, options={})
+    def desc(usage, description, options = {})
       if options[:for]
         command = find_and_refresh_command(options[:for])
         command.usage = usage             if usage
@@ -69,7 +66,7 @@ class Thor
     # ==== Parameters
     # long description<String>
     #
-    def long_desc(long_description, options={})
+    def long_desc(long_description, options = {})
       if options[:for]
         command = find_and_refresh_command(options[:for])
         command.long_description = long_description if long_description
@@ -91,13 +88,13 @@ class Thor
     # ==== Parameters
     # Hash[String|Array => Symbol]:: Maps the string or the strings in the array to the given command.
     #
-    def map(mappings=nil)
+    def map(mappings = nil)
       @map ||= from_superclass(:map, {})
 
       if mappings
         mappings.each do |key, value|
           if key.respond_to?(:each)
-            key.each {|subkey| @map[subkey] = value}
+            key.each { |subkey| @map[subkey] = value }
           else
             @map[key] = value
           end
@@ -114,13 +111,13 @@ class Thor
     # is the type of the option. Can be :string, :array, :hash, :boolean, :numeric
     # or :required (string). If you give a value, the type of the value is used.
     #
-    def method_options(options=nil)
+    def method_options(options = nil)
       @method_options ||= {}
       build_options(options, @method_options) if options
       @method_options
     end
 
-    alias options method_options
+    alias_method :options, :method_options
 
     # Adds an option to the set of method options. If :for is given as option,
     # it allows you to change the options from a previous defined command.
@@ -148,7 +145,7 @@ class Thor
     # :banner   - String to show on usage notes.
     # :hide     - If you want to hide this option from the help.
     #
-    def method_option(name, options={})
+    def method_option(name, options = {})
       scope = if options[:for]
         find_and_refresh_command(options[:for]).options
       else
@@ -157,7 +154,7 @@ class Thor
 
       build_option(name, options, scope)
     end
-    alias option method_option
+    alias_method :option, :method_option
 
     # Prints help information for the given command.
     #
@@ -181,7 +178,7 @@ class Thor
         shell.say command.description
       end
     end
-    alias task_help command_help
+    alias_method :task_help, :command_help
 
     # Prints help information for this class.
     #
@@ -193,9 +190,9 @@ class Thor
       Thor::Util.thor_classes_in(self).each do |klass|
         list += klass.printable_commands(false)
       end
-      list.sort!{ |a,b| a[0] <=> b[0] }
+      list.sort! { |a, b| a[0] <=> b[0] }
 
-      if @package_name
+      if defined?(@package_name) && @package_name
         shell.say "#{@package_name} commands:"
       else
         shell.say "Commands:"
@@ -212,34 +209,40 @@ class Thor
         next if command.hidden?
         item = []
         item << banner(command, false, subcommand)
-        item << (command.description ? "# #{command.description.gsub(/\s+/m,' ')}" : "")
+        item << (command.description ? "# #{command.description.gsub(/\s+/m, ' ')}" : "")
         item
       end.compact
     end
-    alias printable_tasks printable_commands
+    alias_method :printable_tasks, :printable_commands
 
     def subcommands
       @subcommands ||= from_superclass(:subcommands, [])
     end
-    alias subtasks subcommands
+    alias_method :subtasks, :subcommands
+
+    def subcommand_classes
+      @subcommand_classes ||= {}
+    end
 
     def subcommand(subcommand, subcommand_class)
-      self.subcommands << subcommand.to_s
+      subcommands << subcommand.to_s
       subcommand_class.subcommand_help subcommand
+      subcommand_classes[subcommand.to_s] = subcommand_class
 
       define_method(subcommand) do |*args|
         args, opts = Thor::Arguments.split(args)
+        args.unshift("help") if opts.include? "--help" or opts.include? "-h"
         invoke subcommand_class, args, opts, :invoked_via_subcommand => true, :class_options => options
       end
     end
-    alias subtask subcommand
+    alias_method :subtask, :subcommand
 
     # Extend check unknown options to accept a hash of conditions.
     #
     # === Parameters
     # options<Hash>: A hash containing :only and/or :except keys
-    def check_unknown_options!(options={})
-      @check_unknown_options ||= Hash.new
+    def check_unknown_options!(options = {})
+      @check_unknown_options ||= {}
       options.each do |key, value|
         if value
           @check_unknown_options[key] = Array(value)
@@ -309,35 +312,28 @@ class Thor
     # ==== Parameters
     # Symbol ...:: A list of commands that should be affected.
     def stop_on_unknown_option!(*command_names)
-      @stop_on_unknown_option ||= Set.new
-      @stop_on_unknown_option.merge(command_names)
+      stop_on_unknown_option.merge(command_names)
     end
 
     def stop_on_unknown_option?(command) #:nodoc:
-      !!@stop_on_unknown_option && @stop_on_unknown_option.include?(command.name.to_sym)
+      command && stop_on_unknown_option.include?(command.name.to_sym)
     end
 
   protected
+    def stop_on_unknown_option #:nodoc:
+      @stop_on_unknown_option ||= Set.new
+    end
 
     # The method responsible for dispatching given the args.
-    def dispatch(meth, given_args, given_opts, config) #:nodoc:
-      # There is an edge case when dispatching from a subcommand.
-      # A problem occurs invoking the default command. This case occurs
-      # when arguments are passed and a default command is defined, and
-      # the first given_args does not match the default command.
-      # Thor use "help" by default so we skip that case.
-      # Note the call to retrieve_command_name. It's called with
-      # given_args.dup since that method calls args.shift. Then lookup
-      # the command normally. If the first item in given_args is not
-      # a command then use the default command. The given_args will be
-      # intact later since dup was used.
-      if config[:invoked_via_subcommand] && given_args.size >= 1 && default_command != "help" && given_args.first != default_command
-        meth ||= retrieve_command_name(given_args.dup)
-        command = all_commands[normalize_command_name(meth)]
-        command ||= all_commands[normalize_command_name(default_command)]
-      else
-        meth ||= retrieve_command_name(given_args)
-        command = all_commands[normalize_command_name(meth)]
+    def dispatch(meth, given_args, given_opts, config) #:nodoc: # rubocop:disable MethodLength
+      meth ||= retrieve_command_name(given_args)
+      command = all_commands[normalize_command_name(meth)]
+
+      if !command && config[:invoked_via_subcommand]
+        # We're a subcommand and our first argument didn't match any of our
+        # commands. So we put it back and call our default command.
+        given_args.unshift(meth)
+        command = all_commands[normalize_command_name(default_command)]
       end
 
       if command
@@ -350,7 +346,7 @@ class Thor
         end
       else
         args, opts = given_args, nil
-        command = Thor::DynamicCommand.new(meth)
+        command = dynamic_command_class.new(meth)
       end
 
       opts = given_opts || opts || []
@@ -376,13 +372,21 @@ class Thor
       Thor
     end
 
+    def dynamic_command_class #:nodoc:
+      Thor::DynamicCommand
+    end
+
     def create_command(meth) #:nodoc:
+      @usage ||= nil
+      @desc ||= nil
+      @long_desc ||= nil
+
       if @usage && @desc
         base_class = @hide ? Thor::HiddenCommand : Thor::Command
         commands[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
         @usage, @desc, @long_desc, @method_options, @hide = nil
         true
-      elsif self.all_commands[meth] || meth == "method_missing"
+      elsif all_commands[meth] || meth == "method_missing"
         true
       else
         puts "[WARNING] Attempted to create command #{meth.inspect} without usage or description. " <<
@@ -391,7 +395,7 @@ class Thor
         false
       end
     end
-    alias create_task create_command
+    alias_method :create_task, :create_command
 
     def initialize_added #:nodoc:
       class_options.merge!(method_options)
@@ -407,7 +411,7 @@ class Thor
         nil
       end
     end
-    alias retrieve_task_name retrieve_command_name
+    alias_method :retrieve_task_name, :retrieve_command_name
 
     # receives a (possibly nil) command name and returns a name that is in
     # the commands hash. In addition to normalizing aliases, this logic
@@ -417,11 +421,11 @@ class Thor
     # +normalize_command_name+ also converts names like +animal-prison+
     # into +animal_prison+.
     def normalize_command_name(meth) #:nodoc:
-      return default_command.to_s.gsub('-', '_') unless meth
+      return default_command.to_s.gsub("-", "_") unless meth
 
       possibilities = find_command_possibilities(meth)
       if possibilities.size > 1
-        raise ArgumentError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]"
+        fail AmbiguousTaskError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]"
       elsif possibilities.size < 1
         meth = meth || default_command
       elsif map[meth]
@@ -430,9 +434,9 @@ class Thor
         meth = possibilities.first
       end
 
-      meth.to_s.gsub('-','_') # treat foo-bar as foo_bar
+      meth.to_s.gsub("-", "_") # treat foo-bar as foo_bar
     end
-    alias normalize_task_name normalize_command_name
+    alias_method :normalize_task_name, :normalize_command_name
 
     # this is the logic that takes the command name passed in by the user
     # and determines whether it is an unambiguous substrings of a command or
@@ -450,16 +454,15 @@ class Thor
         possibilities
       end
     end
-    alias find_task_possibilities find_command_possibilities
+    alias_method :find_task_possibilities, :find_command_possibilities
 
     def subcommand_help(cmd)
       desc "help [COMMAND]", "Describe subcommands or one specific subcommand"
-      class_eval <<-RUBY
+      class_eval "
         def help(command = nil, subcommand = true); super; end
-      RUBY
+"
     end
-    alias subtask_help subcommand_help
-
+    alias_method :subtask_help, :subcommand_help
   end
 
   include Thor::Base
@@ -468,6 +471,14 @@ class Thor
 
   desc "help [COMMAND]", "Describe available commands or one specific command"
   def help(command = nil, subcommand = false)
-    command ? self.class.command_help(shell, command) : self.class.help(shell, subcommand)
+    if command
+      if self.class.subcommands.include? command
+        self.class.subcommand_classes[command].help(shell, true)
+      else
+        self.class.command_help(shell, command)
+      end
+    else
+      self.class.help(shell, subcommand)
+    end
   end
 end

data/lib/thor/actions.rb

@@ -1,12 +1,12 @@
-require 'fileutils'
-require 'uri'
-require 'thor/core_ext/io_binary_read'
-require 'thor/actions/create_file'
-require 'thor/actions/create_link'
-require 'thor/actions/directory'
-require 'thor/actions/empty_directory'
-require 'thor/actions/file_manipulation'
-require 'thor/actions/inject_into_file'
+require "fileutils"
+require "uri"
+require "thor/core_ext/io_binary_read"
+require "thor/actions/create_file"
+require "thor/actions/create_link"
+require "thor/actions/directory"
+require "thor/actions/empty_directory"
+require "thor/actions/file_manipulation"
+require "thor/actions/inject_into_file"
 
 class Thor
   module Actions
@@ -26,9 +26,9 @@ class Thor
       end
 
       # Stores and return the source root for this class
-      def source_root(path=nil)
+      def source_root(path = nil)
         @_source_root = path if path
-        @_source_root
+        @_source_root ||= nil
       end
 
       # Returns the source paths in the following order:
@@ -39,8 +39,8 @@ class Thor
       #
       def source_paths_for_search
         paths = []
-        paths += self.source_paths
-        paths << self.source_root if self.source_root
+        paths += source_paths
+        paths << source_root if source_root
         paths += from_superclass(:source_paths, [])
         paths
       end
@@ -71,17 +71,16 @@ class Thor
     #
     # destination_root<String>:: The root directory needed for some actions.
     #
-    def initialize(args=[], options={}, config={})
+    def initialize(args = [], options = {}, config = {})
       self.behavior = case config[:behavior].to_s
-      when "force", "skip"
-        _cleanup_options_and_set(options, config[:behavior])
-        :invoke
-      when "revoke"
-        :revoke
-      else
-        :invoke
-      end
-
+                      when "force", "skip"
+                        _cleanup_options_and_set(options, config[:behavior])
+                        :invoke
+                      when "revoke"
+                        :revoke
+                      else
+                        :invoke
+                      end
       super
       self.destination_root = config[:destination_root]
     end
@@ -107,16 +106,16 @@ class Thor
     #
     def destination_root=(root)
       @destination_stack ||= []
-      @destination_stack[0] = File.expand_path(root || '')
+      @destination_stack[0] = File.expand_path(root || "")
     end
 
     # Returns the given path relative to the absolute root (ie, root where
     # the script started).
     #
-    def relative_to_original_destination_root(path, remove_dot=true)
+    def relative_to_original_destination_root(path, remove_dot = true)
       path = path.dup
-      if path.gsub!(@destination_stack[0], '.')
-        remove_dot ? (path[2..-1] || '') : path
+      if path.gsub!(@destination_stack[0], ".")
+        remove_dot ? (path[2..-1] || "") : path
       else
         path
       end
@@ -130,12 +129,15 @@ class Thor
 
     # Receives a file or directory and search for it in the source paths.
     #
-    def find_in_source_paths(file)
+    def find_in_source_paths(file) # rubocop:disable MethodLength
+      possible_files = [file, file + TEMPLATE_EXTNAME]
       relative_root = relative_to_original_destination_root(destination_root, false)
 
       source_paths.each do |source|
-        source_file = File.expand_path(file, File.join(source, relative_root))
-        return source_file if File.exists?(source_file)
+        possible_files.each do |f|
+          source_file = File.expand_path(f, File.join(source, relative_root))
+          return source_file if File.exist?(source_file)
+        end
       end
 
       message = "Could not find #{file.inspect} in any of your source paths. "
@@ -150,7 +152,7 @@ class Thor
         message << "Your current source paths are: \n#{source_paths.join("\n")}"
       end
 
-      raise Error, message
+      fail Error, message
     end
 
     # Do something in the root or on a provided subfolder. If a relative path
@@ -162,7 +164,7 @@ class Thor
     # dir<String>:: the directory to move to.
     # config<Hash>:: give :verbose => true to log and use padding.
     #
-    def inside(dir='', config={}, &block)
+    def inside(dir = "", config = {}, &block)
       verbose = config.fetch(:verbose, false)
       pretend = options[:pretend]
 
@@ -204,18 +206,18 @@ class Thor
     #
     #   apply "recipes/jquery.rb"
     #
-    def apply(path, config={})
+    def apply(path, config = {})
       verbose = config.fetch(:verbose, true)
-      is_uri  = path =~ /^https?\:\/\//
+      is_uri  = path =~ %r{^https?\://}
       path    = find_in_source_paths(path) unless is_uri
 
       say_status :apply, path, verbose
       shell.padding += 1 if verbose
 
       if is_uri
-        contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
+        contents = open(path, "Accept" => "application/x-thor-template") { |io| io.read }
       else
-        contents = open(path) {|io| io.read }
+        contents = open(path) { |io| io.read }
       end
 
       instance_eval(contents, path)
@@ -227,7 +229,7 @@ class Thor
     # ==== Parameters
     # command<String>:: the command to be executed.
     # 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.
+    #                to append an executable to command execution.
     #
     # ==== Example
     #
@@ -235,7 +237,7 @@ class Thor
     #     run('ln -s ~/edge rails')
     #   end
     #
-    def run(command, config={})
+    def run(command, config = {})
       return unless behavior == :invoke
 
       destination = relative_to_original_destination_root(destination_root, false)
@@ -259,7 +261,7 @@ class Thor
     # command<String>:: the command to be executed.
     # config<Hash>:: give :verbose => false to not log the status.
     #
-    def run_ruby_script(command, config={})
+    def run_ruby_script(command, config = {})
       return unless behavior == :invoke
       run command, config.merge(:with => Thor::Util.ruby_command)
     end
@@ -290,29 +292,28 @@ class Thor
 
       args.unshift(command)
       args.push Thor::Options.to_switches(config)
-      command = args.join(' ').strip
+      command = args.join(" ").strip
 
       run command, :with => :thor, :verbose => verbose, :pretend => pretend, :capture => capture
     end
 
-    protected
+  protected
 
-      # Allow current root to be shared between invocations.
-      #
-      def _shared_configuration #:nodoc:
-        super.merge!(:destination_root => self.destination_root)
-      end
+    # Allow current root to be shared between invocations.
+    #
+    def _shared_configuration #:nodoc:
+      super.merge!(:destination_root => destination_root)
+    end
 
-      def _cleanup_options_and_set(options, key) #:nodoc:
-        case options
-        when Array
-          %w(--force -f --skip -s).each { |i| options.delete(i) }
-          options << "--#{key}"
-        when Hash
-          [:force, :skip, "force", "skip"].each { |i| options.delete(i) }
-          options.merge!(key => true)
-        end
+    def _cleanup_options_and_set(options, key) #:nodoc:
+      case options
+      when Array
+        %w[--force -f --skip -s].each { |i| options.delete(i) }
+        options << "--#{key}"
+      when Hash
+        [:force, :skip, "force", "skip"].each { |i| options.delete(i) }
+        options.merge!(key => true)
       end
-
+    end
   end
 end