thor 0.19.1 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a362ea0b9b3cf1f41649c522ddc312925cf1e47
-  data.tar.gz: 9267cf56eb7c014270c8077b1ed4b2c95fcaa7ea
+  metadata.gz: d79526592b82cfff9374125c0e1970b1d1c2451a
+  data.tar.gz: 89a9df6fcc69297cb7567cec0138a7be787c4197
 SHA512:
-  metadata.gz: c659d6a5020fa953ec51394089c5a49a4fae9afefc2190a088a8e481a6ac586fbe2c268a47204d66b19ca660468f1e3e87f4e5be9b509faf83fc3992b2b7eb42
-  data.tar.gz: fac520f0a428f1cf3ba627b47285c04534e11633599d82c7b15596eb76c1e1762d66b32195e8519252c58a061ccb54e37e8bfa4ba98684c6b0efc8f208cd66f4
+  metadata.gz: 2abe2eca78a2fc55f6ed8e28ac066594ebf45ab938fb434b844e7293b6001400652c79e30567a14e511ef81c024d3ac4a4de9682c385079d7f5eb1ef4390d1af
+  data.tar.gz: 366ab438925df78b9ecf8d783a3aa6d7a5a4c6eee2357c1110e7668ad9a711659b5f7967408c22d81f61860ff0be75fd69e91d475eb0a2cf61159fb2a0ac324a

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 0.19.1, release 2014-03-24
+* Fix `say` non-String break regression
+
+## 0.19.0, release 2014-03-22
+* Add support for a default to #ask
+* Avoid @namespace not initialized warning
+* Avoid private attribute? warning
+* Fix initializing with unknown options
+* Loosen required_rubygems_version for compatibility with Ubuntu 10.04
+* Shell#ask: support a noecho option for stdin
+* Shell#ask: change API to be :echo => false
+* Display a message without a stack trace for ambiguous commands
+* Make say and say_status thread safe
+* Dependency for console io version check
+* Alias --help to help on subcommands
+* Use mime-types 1.x for Ruby 1.8.7 compatibility for Ruby 1.8 only
+* Accept .tt files as templates
+* Check if numeric value is in enum
+* Use Readline for user input
+* Fix dispatching of subcommands (concerning :help and *args)
+* Fix warnings when running specs with `$VERBOSE = true`
+* Make subcommand help more consistent
+* Make the current command chain accessible in command
+
 ## 0.18.1, release 2013-03-30
 * Revert regressions found in 0.18.0
 

data/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+Pull Requests
+-------------
+Here are some reasons why a pull request may not be merged:
+
+1. It hasn’t been reviewed.
+2. It doesn’t include specs for new functionality.
+3. It doesn’t include documentation for new functionality.
+4. It changes behavior without changing the relevant documentation, comments, or specs.
+5. It changes behavior of an existing public API, breaking backward compatibility.
+6. It breaks the tests on a supported platform.
+7. It doesn’t merge cleanly (requiring Git rebasing and conflict resolution).
+
+If you would like to help in this process, you can start by evaluating open pull requests against the criteria above. For example, if a pull request does not include specs for new functionality, you can add a comment like: “If you would like this feature to be added to Thor, please add specs to ensure that it does not break in the future.” This will help move a pull request closer to being merged.
+
+Include this emoji in the top of your ticket to signal to us that you read this file: 🌈

data/README.md

@@ -21,7 +21,7 @@ utilities.  It removes the pain of parsing command line options, writing
 build tool.  The syntax is Rake-like, so it should be familiar to most Rake
 users.
 
-[rake]: https://github.com/jimweirich/rake
+[rake]: https://github.com/ruby/rake
 
 Installation
 ------------
@@ -34,6 +34,12 @@ Please see the [wiki][] for basic usage and other documentation on using Thor. Y
 [wiki]: https://github.com/erikhuda/thor/wiki
 [homepage]: http://whatisthor.com/
 
+Contributing
+------------
+If you would like to help, please read the [CONTRIBUTING][] file for suggestions.
+
+[contributing]: CONTRIBUTING.md
+
 License
 -------
 Released under the MIT License.  See the [LICENSE][] file for further details.

data/lib/thor.rb

@@ -1,7 +1,7 @@
 require "set"
 require "thor/base"
 
-class Thor # rubocop:disable ClassLength
+class Thor
   class << self
     # Allows for custom "Command" package naming.
     #
@@ -9,7 +9,7 @@ class Thor # rubocop:disable ClassLength
     # name<String>
     # options<Hash>
     #
-    def package_name(name, options = {})
+    def package_name(name, _ = {})
       @package_name = name.nil? || name == "" ? nil : name
     end
 
@@ -57,7 +57,9 @@ class Thor # rubocop:disable ClassLength
         command.usage = usage             if usage
         command.description = description if description
       else
-        @usage, @desc, @hide = usage, description, options[:hide] || false
+        @usage = usage
+        @desc = description
+        @hide = options[:hide] || false
       end
     end
 
@@ -156,6 +158,10 @@ class Thor # rubocop:disable ClassLength
     end
     alias_method :option, :method_option
 
+    def disable_class_options
+      @disable_class_options = true
+    end
+
     # Prints help information for the given command.
     #
     # ==== Parameters
@@ -170,7 +176,7 @@ class Thor # rubocop:disable ClassLength
       shell.say "Usage:"
       shell.say "  #{banner(command)}"
       shell.say
-      class_options_help(shell, nil => command.options.map { |_, o| o })
+      class_options_help(shell, nil => command.options.values)
       if command.long_description
         shell.say "Description:"
         shell.print_wrapped(command.long_description, :indent => 2)
@@ -231,8 +237,9 @@ class Thor # rubocop:disable ClassLength
 
       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
+        invoke_args = [args, opts, {:invoked_via_subcommand => true, :class_options => options}]
+        invoke_args.unshift "help" if opts.delete("--help") || opts.delete("-h")
+        invoke subcommand_class, *invoke_args
       end
     end
     alias_method :subtask, :subcommand
@@ -320,6 +327,7 @@ class Thor # rubocop:disable ClassLength
     end
 
   protected
+
     def stop_on_unknown_option #:nodoc:
       @stop_on_unknown_option ||= Set.new
     end
@@ -345,12 +353,14 @@ class Thor # rubocop:disable ClassLength
           opts.clear
         end
       else
-        args, opts = given_args, nil
+        args = given_args
+        opts = nil
         command = dynamic_command_class.new(meth)
       end
 
       opts = given_opts || opts || []
-      config.merge!(:current_command => command, :command_options => command.options)
+      config[:current_command] = command
+      config[:command_options] = command.options
 
       instance = new(args, opts, config)
       yield instance if block_given?
@@ -380,17 +390,18 @@ class Thor # rubocop:disable ClassLength
       @usage ||= nil
       @desc ||= nil
       @long_desc ||= nil
+      @disable_class_options ||= 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
+        commands[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options, @disable_class_options)
+        @usage, @desc, @long_desc, @method_options, @hide, @disable_class_options = nil
         true
       elsif all_commands[meth] || meth == "method_missing"
         true
       else
-        puts "[WARNING] Attempted to create command #{meth.inspect} without usage or description. " <<
-             "Call desc if you want this method to be available as command or declare it inside a " <<
+        puts "[WARNING] Attempted to create command #{meth.inspect} without usage or description. " \
+             "Call desc if you want this method to be available as command or declare it inside a " \
              "no_commands{} block. Invoked from #{caller[1].inspect}."
         false
       end
@@ -405,11 +416,7 @@ class Thor # rubocop:disable ClassLength
     # Retrieve the command name from given args.
     def retrieve_command_name(args) #:nodoc:
       meth = args.first.to_s unless args.empty?
-      if meth && (map[meth] || meth !~ /^\-/)
-        args.shift
-      else
-        nil
-      end
+      args.shift if meth && (map[meth] || meth !~ /^\-/)
     end
     alias_method :retrieve_task_name, :retrieve_command_name
 
@@ -421,20 +428,20 @@ class Thor # rubocop:disable ClassLength
     # +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.tr("-", "_") unless meth
 
       possibilities = find_command_possibilities(meth)
-      if possibilities.size > 1
-        fail AmbiguousTaskError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]"
-      elsif possibilities.size < 1
-        meth = meth || default_command
+      raise AmbiguousTaskError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]" if possibilities.size > 1
+
+      if possibilities.empty?
+        meth ||= default_command
       elsif map[meth]
         meth = map[meth]
       else
         meth = possibilities.first
       end
 
-      meth.to_s.gsub("-", "_") # treat foo-bar as foo_bar
+      meth.to_s.tr("-", "_") # treat foo-bar as foo_bar
     end
     alias_method :normalize_task_name, :normalize_command_name
 
@@ -470,6 +477,7 @@ class Thor # rubocop:disable ClassLength
   map HELP_MAPPINGS => :help
 
   desc "help [COMMAND]", "Describe available commands or one specific command"
+  disable_class_options
   def help(command = nil, subcommand = false)
     if command
       if self.class.subcommands.include? command

data/lib/thor/actions.rb

@@ -73,14 +73,15 @@ 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
-                      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
@@ -129,7 +130,7 @@ class Thor
 
     # Receives a file or directory and search for it in the source paths.
     #
-    def find_in_source_paths(file) # rubocop:disable MethodLength
+    def find_in_source_paths(file)
       possible_files = [file, file + TEMPLATE_EXTNAME]
       relative_root = relative_to_original_destination_root(destination_root, false)
 
@@ -146,13 +147,13 @@ class Thor
         message << "Please invoke #{self.class.name}.source_root(PATH) with the PATH containing your templates. "
       end
 
-      if source_paths.empty?
-        message << "Currently you have no source paths."
-      else
-        message << "Your current source paths are: \n#{source_paths.join("\n")}"
-      end
+      message << if source_paths.empty?
+                   "Currently you have no source paths."
+                 else
+                   "Your current source paths are: \n#{source_paths.join("\n")}"
+                 end
 
-      fail Error, message
+      raise Error, message
     end
 
     # Do something in the root or on a provided subfolder. If a relative path
@@ -214,10 +215,10 @@ class Thor
       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 = if is_uri
+        open(path, "Accept" => "application/x-thor-template", &:read)
       else
-        contents = open(path) { |io| io.read }
+        open(path, &:read)
       end
 
       instance_eval(contents, path)
@@ -250,9 +251,7 @@ class Thor
 
       say_status :run, desc, config.fetch(:verbose, true)
 
-      unless options[:pretend]
-        config[:capture] ? `#{command}` : system("#{command}")
-      end
+      !options[:pretend] && config[:capture] ? `#{command}` : system(command.to_s)
     end
 
     # Executes a ruby script (taking into account WIN32 platform quirks).
@@ -308,7 +307,7 @@ class Thor
     def _cleanup_options_and_set(options, key) #:nodoc:
       case options
       when Array
-        %w[--force -f --skip -s].each { |i| options.delete(i) }
+        %w(--force -f --skip -s).each { |i| options.delete(i) }
         options << "--#{key}"
       when Hash
         [:force, :skip, "force", "skip"].each { |i| options.delete(i) }

data/lib/thor/actions/create_file.rb

@@ -84,7 +84,7 @@ class Thor
       def force_or_skip_or_conflict(force, skip, &block)
         if force
           say_status :force, :yellow
-          block.call unless pretend?
+          yield unless pretend?
         elsif skip
           say_status :skip, :yellow
         else

data/lib/thor/actions/create_link.rb

@@ -14,7 +14,7 @@ class Thor
     #
     #   create_link "config/apache.conf", "/etc/apache.conf"
     #
-    def create_link(destination, *args, &block)
+    def create_link(destination, *args)
       config = args.last.is_a?(Hash) ? args.pop : {}
       source = args.first
       action CreateLink.new(self, destination, source, config)

data/lib/thor/actions/directory.rb

@@ -72,7 +72,7 @@ class Thor
 
     protected
 
-      def execute! # rubocop:disable MethodLength
+      def execute!
         lookup = Util.escape_globs(source)
         lookup = config[:recursive] ? File.join(lookup, "**") : lookup
         lookup = file_level_lookup(lookup)
@@ -85,7 +85,7 @@ class Thor
 
           case file_source
           when /\.empty_directory$/
-            dirname = File.dirname(file_destination).gsub(/\/\.$/, "")
+            dirname = File.dirname(file_destination).gsub(%r{/\.$}, "")
             next if dirname == given_destination
             base.empty_directory(dirname, config)
           when /#{TEMPLATE_EXTNAME}$/

data/lib/thor/actions/empty_directory.rb

@@ -32,7 +32,8 @@ class Thor
       # config<Hash>:: give :verbose => false to not log the status.
       #
       def initialize(base, destination, config = {})
-        @base, @config   = base, {:verbose => true}.merge(config)
+        @base = base
+        @config = {:verbose => true}.merge(config)
         self.destination = destination
       end
 
@@ -80,11 +81,10 @@ class Thor
       #   given_destination    #=> baz
       #
       def destination=(destination)
-        if destination
-          @given_destination = convert_encoded_instructions(destination.to_s)
-          @destination = ::File.expand_path(@given_destination, base.destination_root)
-          @relative_destination = base.relative_to_original_destination_root(@destination)
-        end
+        return unless destination
+        @given_destination = convert_encoded_instructions(destination.to_s)
+        @destination = ::File.expand_path(@given_destination, base.destination_root)
+        @relative_destination = base.relative_to_original_destination_root(@destination)
       end
 
       # Filenames in the encoded form are converted. If you have a file:
@@ -113,7 +113,7 @@ class Thor
           on_conflict_behavior(&block)
         else
           say_status :create, :green
-          block.call unless pretend?
+          yield unless pretend?
         end
 
         destination
@@ -121,7 +121,7 @@ class Thor
 
       # What to do when the destination file already exists.
       #
-      def on_conflict_behavior(&block)
+      def on_conflict_behavior
         say_status :exist, :blue
       end
 

data/lib/thor/actions/file_manipulation.rb

@@ -26,7 +26,7 @@ class Thor
 
       create_file destination, nil, config do
         content = File.binread(source)
-        content = block.call(content) if block
+        content = yield(content) if block
         content
       end
       if config[:mode] == :preserve
@@ -49,7 +49,7 @@ class Thor
     #
     #   link_file "doc/README"
     #
-    def link_file(source, *args, &block)
+    def link_file(source, *args)
       config = args.last.is_a?(Hash) ? args.pop : {}
       destination = args.first || source
       source = File.expand_path(find_in_source_paths(source.to_s))
@@ -82,7 +82,7 @@ class Thor
       render = open(source) { |input| input.binmode.read }
 
       destination ||= if block_given?
-        block.arity == 1 ? block.call(render) : block.call
+        block.arity == 1 ? yield(render) : yield
       else
         File.basename(source)
       end
@@ -110,11 +110,11 @@ class Thor
       destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/, "")
 
       source  = File.expand_path(find_in_source_paths(source.to_s))
-      context = instance_eval("binding")
+      context = config.delete(:context) || instance_eval("binding")
 
       create_file destination, nil, config do
-        content = ERB.new(::File.binread(source), nil, "-", "@output_buffer").result(context)
-        content = block.call(content) if block
+        content = CapturableERB.new(::File.binread(source), nil, "-", "@output_buffer").result(context)
+        content = yield(content) if block
         content
       end
     end
@@ -154,7 +154,7 @@ class Thor
     #
     def prepend_to_file(path, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      config.merge!(:after => /\A/)
+      config[:after] = /\A/
       insert_into_file(path, *(args << config), &block)
     end
     alias_method :prepend_file, :prepend_to_file
@@ -176,7 +176,7 @@ class Thor
     #
     def append_to_file(path, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      config.merge!(:before => /\z/)
+      config[:before] = /\z/
       insert_into_file(path, *(args << config), &block)
     end
     alias_method :append_file, :append_to_file
@@ -200,7 +200,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/)
+      config[:after] = /class #{klass}\n|class #{klass} .*\n/
       insert_into_file(path, *(args << config), &block)
     end
 
@@ -285,7 +285,7 @@ class Thor
     #
     def remove_file(path, config = {})
       return unless behavior == :invoke
-      path  = File.expand_path(path, destination_root)
+      path = File.expand_path(path, destination_root)
 
       say_status :remove, relative_to_original_destination_root(path), config.fetch(:verbose, true)
       ::FileUtils.rm_rf(path) if !options[:pretend] && File.exist?(path)
@@ -301,8 +301,8 @@ class Thor
       @output_buffer.concat(string)
     end
 
-    def capture(*args, &block)
-      with_output_buffer { block.call(*args) }
+    def capture(*args)
+      with_output_buffer { yield(*args) }
     end
 
     def with_output_buffer(buf = "") #:nodoc:
@@ -312,5 +312,16 @@ class Thor
     ensure
       self.output_buffer = old_buffer
     end
+
+    # Thor::Actions#capture depends on what kind of buffer is used in ERB.
+    # Thus CapturableERB fixes ERB to use String buffer.
+    class CapturableERB < ERB
+      def set_eoutvar(compiler, eoutvar = "_erbout")
+        compiler.put_cmd = "#{eoutvar}.concat"
+        compiler.insert_cmd = "#{eoutvar}.concat"
+        compiler.pre_cmd = ["#{eoutvar} = ''"]
+        compiler.post_cmd = [eoutvar]
+      end
+    end
   end
 end