thor 0.16.0 → 0.17.0

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--fail-fast
 --order random

data/.travis.yml

@@ -1,7 +1,8 @@
+bundler_args: --without development
 language: ruby
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ruby-head
+  - 2.0.0
 script: bundle exec thor spec

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 0.17.0, release 2013-01-24
+* Add better support for tasks that accept arbitrary additional arguments (e.g. things like `bundle exec`)
+* Add #stop_on_unknown_option!
+* Only strip from stdin.gets if it wasn't ended with EOF
+* Allow "send" as a task name
+* Allow passing options as arguments after "--"
+* Autoload Thor::Group
+
 == 0.16.0, release 2012-08-14
 * Add enum to string arguments
 

data/Gemfile

@@ -1,15 +1,19 @@
-source 'https://rubygems.org'
+source :rubygems
 
 gemspec
 
-platforms :mri_18 do
-  gem 'ruby-debug', '>= 0.10.3'
-end
-
-platforms :mri_19 do
-  gem 'ruby-debug19'
-end
+gem 'rake', '~> 0.9'
+gem 'rdoc', '~> 3.9'
 
 group :development do
   gem 'pry'
+  gem 'pry-debugger', :platforms => :mri_19
+end
+
+group :test do
+  gem 'childlabor'
+  gem 'fakeweb', '~> 1.3'
+  gem 'rspec', '~> 2.11'
+  gem 'rspec-mocks', :git => 'git://github.com/rspec/rspec-mocks.git'
+  gem 'simplecov'
 end

data/lib/thor.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'thor/base'
 
 class Thor
@@ -8,13 +9,13 @@ class Thor
     # meth<Symbol>:: name of the default task
     #
     def default_task(meth=nil)
-      case meth
-        when :none
-          @default_task = 'help'
-        when nil
-          @default_task ||= from_superclass(:default_task, 'help')
-        else
-          @default_task = meth.to_s
+      @default_task = case meth
+      when :none
+        'help'
+      when nil
+        @default_task || from_superclass(:default_task, 'help')
+      else
+        meth.to_s
       end
     end
 
@@ -210,7 +211,7 @@ class Thor
 
       define_method(subcommand) do |*args|
         args, opts = Thor::Arguments.split(args)
-        invoke subcommand_class, args, opts
+        invoke subcommand_class, args, opts, :invoked_via_subcommand => true
       end
     end
 
@@ -251,15 +252,83 @@ class Thor
       end
     end
 
+    # Stop parsing of options as soon as an unknown option or a regular
+    # argument is encountered.  All remaining arguments are passed to the task.
+    # This is useful if you have a task that can receive arbitrary additional
+    # options, and where those additional options should not be handled by
+    # Thor.
+    #
+    # ==== Example
+    #
+    # To better understand how this is useful, let's consider a task that calls
+    # an external command.  A user may want to pass arbitrary options and
+    # arguments to that command.  The task itself also accepts some options,
+    # which should be handled by Thor.
+    #
+    #   class_option "verbose",  :type => :boolean
+    #   stop_on_unknown_option! :exec
+    #   check_unknown_options!  :except => :exec
+    #
+    #   desc "exec", "Run a shell command"
+    #   def exec(*args)
+    #     puts "diagnostic output" if options[:verbose]
+    #     Kernel.exec(*args)
+    #   end
+    #
+    # Here +exec+ can be called with +--verbose+ to get diagnostic output,
+    # e.g.:
+    #
+    #   $ thor exec --verbose echo foo
+    #   diagnostic output
+    #   foo
+    #
+    # But if +--verbose+ is given after +echo+, it is passed to +echo+ instead:
+    #
+    #   $ thor exec echo --verbose foo
+    #   --verbose foo
+    #
+    # ==== Parameters
+    # Symbol ...:: A list of tasks that should be affected.
+    def stop_on_unknown_option!(*task_names)
+      @stop_on_unknown_option ||= Set.new
+      @stop_on_unknown_option.merge(task_names)
+    end
+
+    def stop_on_unknown_option?(task) #:nodoc:
+      !!@stop_on_unknown_option && @stop_on_unknown_option.include?(task.name.to_sym)
+    end
+
     protected
 
       # The method responsible for dispatching given the args.
       def dispatch(meth, given_args, given_opts, config) #:nodoc:
-        meth ||= retrieve_task_name(given_args)
-        task = all_tasks[normalize_task_name(meth)]
+        # There is an edge case when dispatching from a subcommand.
+        # A problem occurs invoking the default task. This case occurs
+        # when arguments are passed and a default task is defined, and
+        # the first given_args does not match the default task.
+        # Thor use "help" by default so we skip that case.
+        # Note the call to retrieve_task_name. It's called with
+        # given_args.dup since that method calls args.shift. Then lookup
+        # the task normally. If the first item in given_args is not
+        # a task then use the default task. The given_args will be
+        # intact later since dup was used.
+        if config[:invoked_via_subcommand] && given_args.size >= 1 && default_task != "help" && given_args.first != default_task
+          meth ||= retrieve_task_name(given_args.dup)
+          task = all_tasks[normalize_task_name(meth)]
+          task ||= all_tasks[normalize_task_name(default_task)]
+        else
+          meth ||= retrieve_task_name(given_args)
+          task = all_tasks[normalize_task_name(meth)]
+        end
 
         if task
           args, opts = Thor::Options.split(given_args)
+          if stop_on_unknown_option?(task) && !args.empty?
+            # given_args starts with a non-option, so we treat everything as
+            # ordinary arguments
+            args.concat opts
+            opts.clear
+          end
         else
           args, opts = given_args, nil
           task = Thor::DynamicTask.new(meth)

data/lib/thor/actions.rb

@@ -73,13 +73,13 @@ class Thor
     #
     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
+      when "force", "skip"
+        _cleanup_options_and_set(options, config[:behavior])
+        :invoke
+      when "revoke"
+        :revoke
+      else
+        :invoke
       end
 
       super
@@ -305,12 +305,12 @@ class Thor
 
       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)
+        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
 

data/lib/thor/actions/directory.rb

@@ -38,6 +38,7 @@ class Thor
     # destination<String>:: the relative path to the destination root.
     # config<Hash>:: give :verbose => false to not log the status.
     #                If :recursive => false, does not look for paths recursively.
+    #                If :mode => :preserve, preserve the file mode from the source.
     #
     # ==== Examples
     #
@@ -73,26 +74,44 @@ class Thor
         def execute!
           lookup = Util.escape_globs(source)
           lookup = config[:recursive] ? File.join(lookup, '**') : lookup
-          lookup = File.join(lookup, '{*,.[a-z]*}')
+          lookup = file_level_lookup(lookup)
 
-          Dir[lookup].sort.each do |file_source|
+          files(lookup).sort.each do |file_source|
             next if File.directory?(file_source)
             file_destination = File.join(given_destination, file_source.gsub(source, '.'))
             file_destination.gsub!('/./', '/')
 
             case file_source
-              when /\.empty_directory$/
-                dirname = File.dirname(file_destination).gsub(/\/\.$/, '')
-                next if dirname == given_destination
-                base.empty_directory(dirname, config)
-              when /\.tt$/
-                destination = base.template(file_source, file_destination[0..-4], config, &@block)
-              else
-                destination = base.copy_file(file_source, file_destination, config, &@block)
+            when /\.empty_directory$/
+              dirname = File.dirname(file_destination).gsub(/\/\.$/, '')
+              next if dirname == given_destination
+              base.empty_directory(dirname, config)
+            when /\.tt$/
+              destination = base.template(file_source, file_destination[0..-4], config, &@block)
+            else
+              destination = base.copy_file(file_source, file_destination, config, &@block)
             end
           end
         end
 
+        if RUBY_VERSION < '2.0'
+          def file_level_lookup(previous_lookup)
+            File.join(previous_lookup, '{*,.[a-z]*}')
+          end
+
+          def files(lookup)
+            Dir[lookup]
+          end
+        else
+          def file_level_lookup(previous_lookup)
+            File.join(previous_lookup, '*')
+          end
+
+          def files(lookup)
+            Dir.glob(lookup, File::FNM_DOTMATCH)
+          end
+        end
+
     end
   end
 end

data/lib/thor/actions/file_manipulation.rb

@@ -10,7 +10,9 @@ class Thor
     # ==== 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.
+    # config<Hash>:: give :verbose => false to not log the status, and
+    #                :mode => :preserve, to preserve the file mode from the source.
+
     #
     # ==== Examples
     #
@@ -28,6 +30,10 @@ class Thor
         content = block.call(content) if block
         content
       end
+      if config[:mode] == :preserve
+        mode = File.stat(source).mode
+        chmod(destination, mode, config)
+      end
     end
 
     # Links the file from the relative source to the relative destination. If
@@ -245,7 +251,7 @@ class Thor
     def uncomment_lines(path, flag, *args)
       flag = flag.respond_to?(:source) ? flag.source : flag
 
-      gsub_file(path, /^(\s*)#\s*(.*#{flag})/, '\1\2', *args)
+      gsub_file(path, /^(\s*)#[[:blank:]]*(.*#{flag})/, '\1\2', *args)
     end
 
     # Comment all lines matching a given regex.  It will leave the space

data/lib/thor/base.rb

@@ -10,6 +10,7 @@ require 'thor/util'
 class Thor
   autoload :Actions,    'thor/actions'
   autoload :RakeCompat, 'thor/rake_compat'
+  autoload :Group,      'thor/group'
 
   # Shortcuts for help.
   HELP_MAPPINGS       = %w(-h -? --help -D)
@@ -58,7 +59,8 @@ class Thor
       # Let Thor::Options parse the options first, so it can remove
       # declared options from the array. This will leave us with
       # a list of arguments that weren't declared.
-      opts = Thor::Options.new(parse_options, hash_options)
+      stop_on_unknown = self.class.stop_on_unknown_option? config[:current_task]
+      opts = Thor::Options.new(parse_options, hash_options, stop_on_unknown)
       self.options = opts.parse(array_options)
 
       # If unknown options are disallowed, make sure that none of the
@@ -74,7 +76,7 @@ class Thor
       to_parse += opts.remaining unless self.class.strict_args_position?(config)
 
       thor_args = Thor::Arguments.new(self.class.arguments)
-      thor_args.parse(to_parse).each { |k,v| send("#{k}=", v) }
+      thor_args.parse(to_parse).each { |k,v| __send__("#{k}=", v) }
       @args = thor_args.remaining
     end
 
@@ -142,6 +144,13 @@ class Thor
         !!check_unknown_options
       end
 
+      # If true, option parsing is suspended as soon as an unknown option or a
+      # regular argument is encountered.  All remaining arguments are passed to
+      # the task as regular arguments.
+      def stop_on_unknown_option?(task_name) #:nodoc:
+        false
+      end
+
       # If you want only strict string args (useful when cascading thor classes),
       # call strict_args_position! This is disabled by default to allow dynamic
       # invocations.
@@ -304,11 +313,11 @@ class Thor
       # name<String|Symbol>
       #
       def group(name=nil)
-        case name
-          when nil
-            @group ||= from_superclass(:group, 'standard')
-          else
-            @group = name.to_s
+        @group = case name
+        when nil
+          @group || from_superclass(:group, 'standard')
+        else
+          name.to_s
         end
       end
 
@@ -404,9 +413,9 @@ class Thor
       #   thor :my_task
       #
       def namespace(name=nil)
-        case name
+        @namespace = case name
         when nil
-          @namespace ||= Thor::Util.namespace_from_thor_class(self)
+          @namespace || Thor::Util.namespace_from_thor_class(self)
         else
           @namespace = name.to_s
         end
@@ -462,8 +471,12 @@ class Thor
         msg = "#{basename} #{task.name}"
         if arity
           required = arity < 0 ? (-1 - arity) : arity
-          msg << " requires at least #{required} argument"
-          msg << "s" if required > 1
+          if required == 0
+            msg << " should have no arguments"
+          else
+            msg << " requires at least #{required} argument"
+            msg << "s" if required > 1
+          end
         else
           msg = "call #{msg} as"
         end

data/lib/thor/core_ext/hash_with_indifferent_access.rb

@@ -45,6 +45,11 @@ class Thor
         self
       end
 
+      # Convert to a Hash with String keys.
+      def to_hash
+        Hash.new(default).merge!(self)
+      end
+
       protected
 
         def convert_key(key)

data/lib/thor/group.rb

@@ -14,11 +14,11 @@ class Thor::Group
     # description<String>:: The description for this Thor::Group.
     #
     def desc(description=nil)
-      case description
-        when nil
-          @desc ||= from_superclass(:desc, nil)
-        else
-          @desc = description
+      @desc = case description
+      when nil
+        @desc || from_superclass(:desc, nil)
+      else
+        description
       end
     end
 

data/lib/thor/parser/options.rb

@@ -5,27 +5,32 @@ class Thor
     EQ_RE       = /^(--\w+(?:-\w+)*|-[a-z])=(.*)$/i
     SHORT_SQ_RE = /^-([a-z]{2,})$/i # Allow either -x -v or -xv style for single char args
     SHORT_NUM   = /^(-[a-z])#{NUMERIC}$/i
+    OPTS_END    = '--'.freeze
 
     # Receives a hash and makes it switches.
     def self.to_switches(options)
       options.map do |key, value|
         case value
-          when true
-            "--#{key}"
-          when Array
-            "--#{key} #{value.map{ |v| v.inspect }.join(' ')}"
-          when Hash
-            "--#{key} #{value.map{ |k,v| "#{k}:#{v}" }.join(' ')}"
-          when nil, false
-            ""
-          else
-            "--#{key} #{value.inspect}"
+        when true
+          "--#{key}"
+        when Array
+          "--#{key} #{value.map{ |v| v.inspect }.join(' ')}"
+        when Hash
+          "--#{key} #{value.map{ |k,v| "#{k}:#{v}" }.join(' ')}"
+        when nil, false
+          ""
+        else
+          "--#{key} #{value.inspect}"
         end
       end.join(" ")
     end
 
     # Takes a hash of Thor::Option and a hash with defaults.
-    def initialize(hash_options={}, defaults={})
+    #
+    # If +stop_on_unknown+ is true, #parse will stop as soon as it encounters
+    # an unknown option or a regular argument.
+    def initialize(hash_options={}, defaults={}, stop_on_unknown=false)
+      @stop_on_unknown = stop_on_unknown
       options = hash_options.values
       super(options)
 
@@ -50,15 +55,30 @@ class Thor
       @extra
     end
 
+    def peek
+      return super unless @parsing_options
+
+      result = super
+      if result == OPTS_END
+        shift
+        @parsing_options = false
+        super
+      else
+        result
+      end
+    end
+
     def parse(args)
       @pile = args.dup
+      @parsing_options = true
 
       while peek
-        match, is_switch = current_is_switch?
-        shifted = shift
+        if parsing_options?
+          match, is_switch = current_is_switch?
+          shifted = shift
 
-        if is_switch
-          case shifted
+          if is_switch
+            case shifted
             when SHORT_SQ_RE
               unshift($1.split('').map { |f| "-#{f}" })
               next
@@ -67,16 +87,23 @@ class Thor
               switch = $1
             when LONG_RE, SHORT_RE
               switch = $1
+            end
+
+            switch = normalize_switch(switch)
+            option = switch_option(switch)
+            @assigns[option.human_name] = parse_peek(switch, option)
+          elsif @stop_on_unknown
+            @extra << shifted
+            @extra << shift while peek
+            break
+          elsif match
+            @extra << shifted
+            @extra << shift while peek && peek !~ /^-/
+          else
+            @extra << shifted
           end
-
-          switch = normalize_switch(switch)
-          option = switch_option(switch)
-          @assigns[option.human_name] = parse_peek(switch, option)
-        elsif match
-          @extra << shifted
-          @extra << shift while peek && peek !~ /^-/
         else
-          @extra << shifted
+          @extra << shift
         end
       end
 
@@ -95,8 +122,10 @@ class Thor
 
     protected
 
-      # Returns true if the current value in peek is a registered switch.
+      # Check if the current value in peek is a registered switch.
       #
+      # Two booleans are returned.  The first is true if the current value
+      # starts with a hyphen; the second is true if it is a registered switch.
       def current_is_switch?
         case peek
         when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM
@@ -117,6 +146,10 @@ class Thor
         end
       end
 
+      def current_is_value?
+        peek && (!parsing_options? || super)
+      end
+
       def switch?(arg)
         switch_option(normalize_switch(arg))
       end
@@ -135,6 +168,11 @@ class Thor
         (@shorts[arg] || arg).tr('_', '-')
       end
 
+      def parsing_options?
+        peek
+        @parsing_options
+      end
+
       # Parse boolean values which can be given as --foo=true, --foo or --no-foo.
       #
       def parse_boolean(switch)
@@ -156,7 +194,7 @@ class Thor
       # Parse the value at the peek analyzing if it requires an input or not.
       #
       def parse_peek(switch, option)
-        if current_is_switch_formatted? || last?
+        if parsing_options? && (current_is_switch_formatted? || last?)
           if option.boolean?
             # No problem for boolean types
           elsif no_or_skip?(switch)