thor 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ab2cb4ae4ac2fe79583c377aa7385d47206d1e47ac0de5090f6a02de60f603
-  data.tar.gz: 8ec9bc5cb0cb2288d8c0909aff4d05e649e48404d97ea339f9db6cf7498c05da
+  metadata.gz: f24a2dd00001feb1d7f9d68b1cf8aff06dd9f347e230846eda8662595a514ac9
+  data.tar.gz: 5fcf2e12c1a1f7112b72286f3eded990dc6f00df0ecc45a5e32465915c10b515
 SHA512:
-  metadata.gz: 0ed6c11335f2f33c1fe2f49f4552110b1fad06c59547bd06b92e49fd01fa5b5a261d5298d7fabf5ca8ff9a8708e2f2d4ecb26e330b8aa2a4e20514c2e113cb94
-  data.tar.gz: 912dfd2214bad858c184ce1a8994e1eab38acb9ccecf6aaf68f257dbfaa586fa7e427ff0e234ee5b99b738dae2539194a2d2c1943aed9bc3bfd2c527e941a12c
+  metadata.gz: 03d0bd2991357425d2ceeeaf3a538f280e9a1a2ce7d35cc210c5413744940f022602339ce721aff4bad5c51ebde0a071d533a06c7c697dee8fabbcb468671dc5
+  data.tar.gz: 1fe2bbce8f427aaa3a9a314b647796927d8dbaf52b2873c1def2d072c3fd98076abcbc50890d913f195a30835208f5f2d272d59969a89e3821f1ff6c1080d073

data/lib/thor/actions/create_file.rb

@@ -43,7 +43,8 @@ class Thor
       # Boolean:: true if it is identical, false otherwise.
       #
       def identical?
-        exists? && File.binread(destination) == render
+        # binread uses ASCII-8BIT, so to avoid false negatives, the string must use the same
+        exists? && File.binread(destination) == String.new(render).force_encoding("ASCII-8BIT")
       end
 
       # Holds the content to be added to the file.

data/lib/thor/actions/directory.rb

@@ -58,7 +58,7 @@ class Thor
       def initialize(base, source, destination = nil, config = {}, &block)
         @source = File.expand_path(Dir[Util.escape_globs(base.find_in_source_paths(source.to_s))].first)
         @block  = block
-        super(base, destination, {:recursive => true}.merge(config))
+        super(base, destination, {recursive: true}.merge(config))
       end
 
       def invoke!

data/lib/thor/actions/empty_directory.rb

@@ -33,7 +33,7 @@ class Thor
       #
       def initialize(base, destination, config = {})
         @base = base
-        @config = {:verbose => true}.merge(config)
+        @config = {verbose: true}.merge(config)
         self.destination = destination
       end
 

data/lib/thor/actions/file_manipulation.rb

@@ -66,12 +66,15 @@ class Thor
     # ==== Parameters
     # source<String>:: the address of the given content.
     # 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
+    #                :http_headers => <Hash> to add headers to an http request.
     #
     # ==== Examples
     #
     #   get "http://gist.github.com/103208", "doc/README"
     #
+    #   get "http://gist.github.com/103208", "doc/README", :http_headers => {"Content-Type" => "application/json"}
+    #
     #   get "http://gist.github.com/103208" do |content|
     #     content.split("\n").first
     #   end
@@ -82,7 +85,7 @@ class Thor
 
       render = if source =~ %r{^https?\://}
         require "open-uri"
-        URI.send(:open, source) { |input| input.binmode.read }
+        URI.send(:open, source, config.fetch(:http_headers, {})) { |input| input.binmode.read }
       else
         source = File.expand_path(find_in_source_paths(source.to_s))
         File.open(source) { |input| input.binmode.read }
@@ -120,12 +123,7 @@ class Thor
       context = config.delete(:context) || instance_eval("binding")
 
       create_file destination, nil, config do
-        match = ERB.version.match(/(\d+\.\d+\.\d+)/)
-        capturable_erb = if match && match[1] >= "2.2.0" # Ruby 2.6+
-          CapturableERB.new(::File.binread(source), :trim_mode => "-", :eoutvar => "@output_buffer")
-        else
-          CapturableERB.new(::File.binread(source), nil, "-", "@output_buffer")
-        end
+        capturable_erb = CapturableERB.new(::File.binread(source), trim_mode: "-", eoutvar: "@output_buffer")
         content = capturable_erb.tap do |erb|
           erb.filename = source
         end.result(context)

data/lib/thor/actions/inject_into_file.rb

@@ -21,7 +21,7 @@ class Thor
     #     gems.split(" ").map{ |gem| "  config.gem :#{gem}" }.join("\n")
     #   end
     #
-    WARNINGS = { unchanged_no_flag: 'File unchanged! Either the supplied flag value not found or the content has already been inserted!' }
+    WARNINGS = {unchanged_no_flag: "File unchanged! Either the supplied flag value not found or the content has already been inserted!"}
 
     def insert_into_file(destination, *args, &block)
       data = block_given? ? block : args.shift
@@ -37,7 +37,7 @@ class Thor
       attr_reader :replacement, :flag, :behavior
 
       def initialize(base, destination, data, config)
-        super(base, destination, {:verbose => true}.merge(config))
+        super(base, destination, {verbose: true}.merge(config))
 
         @behavior, @flag = if @config.key?(:after)
           [:after, @config.delete(:after)]
@@ -59,6 +59,8 @@ class Thor
         if exists?
           if replace!(/#{flag}/, content, config[:force])
             say_status(:invoke)
+          elsif replacement_present?
+            say_status(:unchanged, color: :blue)
           else
             say_status(:unchanged, warning: WARNINGS[:unchanged_no_flag], color: :red)
           end
@@ -96,6 +98,8 @@ class Thor
           end
         elsif warning
           warning
+        elsif behavior == :unchanged
+          :unchanged
         else
           :subtract
         end
@@ -103,11 +107,18 @@ class Thor
         super(status, (color || config[:verbose]))
       end
 
+      def content
+        @content ||= File.read(destination)
+      end
+
+      def replacement_present?
+        content.include?(replacement)
+      end
+
       # Adds the content to the file.
       #
       def replace!(regexp, string, force)
-        content = File.read(destination)
-        if force || !content.include?(replacement)
+        if force || !replacement_present?
           success = content.gsub!(regexp, string)
 
           File.open(destination, "wb") { |file| file.write(content) } unless pretend?

data/lib/thor/actions.rb

@@ -46,17 +46,17 @@ class Thor
       # Add runtime options that help actions execution.
       #
       def add_runtime_options!
-        class_option :force, :type => :boolean, :aliases => "-f", :group => :runtime,
-                             :desc => "Overwrite files that already exist"
+        class_option :force, type: :boolean, aliases: "-f", group: :runtime,
+                             desc: "Overwrite files that already exist"
 
-        class_option :pretend, :type => :boolean, :aliases => "-p", :group => :runtime,
-                               :desc => "Run but do not make any changes"
+        class_option :pretend, type: :boolean, aliases: "-p", group: :runtime,
+                               desc: "Run but do not make any changes"
 
-        class_option :quiet, :type => :boolean, :aliases => "-q", :group => :runtime,
-                             :desc => "Suppress status output"
+        class_option :quiet, type: :boolean, aliases: "-q", group: :runtime,
+                             desc: "Suppress status output"
 
-        class_option :skip, :type => :boolean, :aliases => "-s", :group => :runtime,
-                            :desc => "Skip files that already exist"
+        class_option :skip, type: :boolean, aliases: "-s", group: :runtime,
+                            desc: "Skip files that already exist"
       end
     end
 
@@ -113,9 +113,9 @@ class Thor
     #
     def relative_to_original_destination_root(path, remove_dot = true)
       root = @destination_stack[0]
-      if path.start_with?(root) && [File::SEPARATOR, File::ALT_SEPARATOR, nil, ''].include?(path[root.size..root.size])
+      if path.start_with?(root) && [File::SEPARATOR, File::ALT_SEPARATOR, nil, ""].include?(path[root.size..root.size])
         path = path.dup
-        path[0...root.size] = '.'
+        path[0...root.size] = "."
         remove_dot ? (path[2..-1] || "") : path
       else
         path
@@ -223,8 +223,7 @@ class Thor
 
       contents = if is_uri
         require "open-uri"
-        # for ruby 2.1-2.4
-        URI.send(:open, path, "Accept" => "application/x-thor-template", &:read)
+        URI.open(path, "Accept" => "application/x-thor-template", &:read)
       else
         File.open(path, &:read)
       end
@@ -285,7 +284,7 @@ class Thor
     #
     def run_ruby_script(command, config = {})
       return unless behavior == :invoke
-      run command, config.merge(:with => Thor::Util.ruby_command)
+      run command, config.merge(with: Thor::Util.ruby_command)
     end
 
     # Run a thor command. A hash of options can be given and it's converted to
@@ -316,7 +315,7 @@ class Thor
       args.push Thor::Options.to_switches(config)
       command = args.join(" ").strip
 
-      run command, :with => :thor, :verbose => verbose, :pretend => pretend, :capture => capture
+      run command, with: :thor, verbose: verbose, pretend: pretend, capture: capture
     end
 
   protected
@@ -324,7 +323,7 @@ class Thor
     # Allow current root to be shared between invocations.
     #
     def _shared_configuration #:nodoc:
-      super.merge!(:destination_root => destination_root)
+      super.merge!(destination_root: destination_root)
     end
 
     def _cleanup_options_and_set(options, key) #:nodoc:

data/lib/thor/base.rb

@@ -24,9 +24,9 @@ class Thor
 
   class << self
     def deprecation_warning(message) #:nodoc:
-      unless ENV['THOR_SILENCE_DEPRECATION']
+      unless ENV["THOR_SILENCE_DEPRECATION"]
         warn "Deprecation warning: #{message}\n" +
-          'You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION.'
+          "You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION."
       end
     end
   end
@@ -60,6 +60,7 @@ class Thor
 
       command_options = config.delete(:command_options) # hook for start
       parse_options = parse_options.merge(command_options) if command_options
+
       if local_options.is_a?(Array)
         array_options = local_options
         hash_options = {}
@@ -73,9 +74,24 @@ 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.
-      stop_on_unknown = self.class.stop_on_unknown_option? config[:current_command]
-      disable_required_check = self.class.disable_required_check? config[:current_command]
-      opts = Thor::Options.new(parse_options, hash_options, stop_on_unknown, disable_required_check)
+      current_command = config[:current_command]
+      stop_on_unknown = self.class.stop_on_unknown_option? current_command
+
+      # Give a relation of options.
+      # After parsing, Thor::Options check whether right relations are kept
+      relations = if current_command.nil?
+        {exclusive_option_names: [], at_least_one_option_names: []}
+      else
+        current_command.options_relation
+      end
+
+      self.class.class_exclusive_option_names.map { |n| relations[:exclusive_option_names] << n }
+      self.class.class_at_least_one_option_names.map { |n| relations[:at_least_one_option_names] << n }
+
+      disable_required_check = self.class.disable_required_check? current_command
+
+      opts = Thor::Options.new(parse_options, hash_options, stop_on_unknown, disable_required_check, relations)
+
       self.options = opts.parse(array_options)
       self.options = config[:class_options].merge(options) if config[:class_options]
 
@@ -310,9 +326,92 @@ class Thor
       # :hide::     -- If you want to hide this option from the help.
       #
       def class_option(name, options = {})
+        unless [ Symbol, String ].any? { |klass| name.is_a?(klass) }
+          raise ArgumentError, "Expected a Symbol or String, got #{name.inspect}"
+        end
         build_option(name, options, class_options)
       end
 
+      # Adds and declares option group for exclusive options in the
+      # block and arguments. You can declare options as the outside of the block.
+      #
+      # ==== Parameters
+      # Array[Thor::Option.name]
+      #
+      # ==== Examples
+      #
+      #   class_exclusive do
+      #     class_option :one
+      #     class_option :two
+      #    end
+      #
+      # Or
+      #
+      #   class_option :one
+      #   class_option :two
+      #   class_exclusive :one, :two
+      #
+      # If you give "--one" and "--two" at the same time ExclusiveArgumentsError
+      # will be raised.
+      #
+      def class_exclusive(*args, &block)
+        register_options_relation_for(:class_options,
+                                      :class_exclusive_option_names, *args, &block)
+      end
+
+      # Adds and declares option group for required at least one of options in the
+      # block and arguments. You can declare options as the outside of the block.
+      #
+      # ==== Examples
+      #
+      #   class_at_least_one do
+      #     class_option :one
+      #     class_option :two
+      #    end
+      #
+      # Or
+      #
+      #   class_option :one
+      #   class_option :two
+      #   class_at_least_one :one, :two
+      #
+      # If you do not give "--one" and "--two" AtLeastOneRequiredArgumentError
+      # will be raised.
+      #
+      # You can use class_at_least_one and class_exclusive at the same time.
+      #
+      #    class_exclusive do
+      #      class_at_least_one do
+      #        class_option :one
+      #        class_option :two
+      #      end
+      #    end
+      #
+      # Then it is required either only one of "--one" or "--two".
+      #
+      def class_at_least_one(*args, &block)
+        register_options_relation_for(:class_options,
+                                      :class_at_least_one_option_names, *args, &block)
+      end
+
+      # Returns this class exclusive options array set, looking up in the ancestors chain.
+      #
+      # ==== Returns
+      # Array[Array[Thor::Option.name]]
+      #
+      def class_exclusive_option_names
+        @class_exclusive_option_names ||= from_superclass(:class_exclusive_option_names, [])
+      end
+
+      # Returns this class at least one of required options array set, looking up in the ancestors chain.
+      #
+      # ==== Returns
+      # Array[Array[Thor::Option.name]]
+      #
+      def class_at_least_one_option_names
+        @class_at_least_one_option_names ||= from_superclass(:class_at_least_one_option_names, [])
+      end
+
       # Removes a previous defined argument. If :undefine is given, undefine
       # accessors as well.
       #
@@ -565,12 +664,12 @@ class Thor
           item.push(option.description ? "# #{option.description}" : "")
 
           list << item
-          list << ["", "# Default: #{option.default}"] if option.show_default?
-          list << ["", "# Possible values: #{option.enum.join(', ')}"] if option.enum
+          list << ["", "# Default: #{option.print_default}"] if option.show_default?
+          list << ["", "# Possible values: #{option.enum_to_s}"] if option.enum
         end
 
         shell.say(group_name ? "#{group_name} options:" : "Options:")
-        shell.print_table(list, :indent => 2)
+        shell.print_table(list, indent: 2)
         shell.say ""
       end
 
@@ -587,7 +686,7 @@ class Thor
       # options<Hash>:: Described in both class_option and method_option.
       # scope<Hash>:: Options hash that is being built up
       def build_option(name, options, scope) #:nodoc:
-        scope[name] = Thor::Option.new(name, {:check_default_type => check_default_type}.merge!(options))
+        scope[name] = Thor::Option.new(name, {check_default_type: check_default_type}.merge!(options))
       end
 
       # Receives a hash of options, parse them and add to the scope. This is a
@@ -693,6 +792,34 @@ class Thor
       def dispatch(command, given_args, given_opts, config) #:nodoc:
         raise NotImplementedError
       end
+
+      # Register a relation of options for target(method_option/class_option)
+      # by args and block.
+      def register_options_relation_for(target, relation, *args, &block) # :nodoc:
+        opt = args.pop if args.last.is_a? Hash
+        opt ||= {}
+        names = args.map{ |arg| arg.to_s }
+        names += built_option_names(target, opt, &block) if block_given?
+        command_scope_member(relation, opt) << names
+      end
+
+      # Get target(method_options or class_options) options
+      # of before and after by block evaluation.
+      def built_option_names(target, opt = {}, &block) # :nodoc:
+        before = command_scope_member(target, opt).map{ |k,v| v.name }
+        instance_eval(&block)
+        after  = command_scope_member(target, opt).map{ |k,v| v.name }
+        after - before
+      end
+
+      # Get command scope member by name.
+      def command_scope_member(name, options = {}) # :nodoc:
+        if options[:for]
+          find_and_refresh_command(options[:for]).send(name)
+        else
+          send(name)
+        end
+      end
     end
   end
 end

data/lib/thor/command.rb

@@ -1,14 +1,15 @@
 class Thor
-  class Command < Struct.new(:name, :description, :long_description, :usage, :options, :ancestor_name)
+  class Command < Struct.new(:name, :description, :long_description, :wrap_long_description, :usage, :options, :options_relation, :ancestor_name)
     FILE_REGEXP = /^#{Regexp.escape(File.dirname(__FILE__))}/
 
-    def initialize(name, description, long_description, usage, options = nil)
-      super(name.to_s, description, long_description, usage, options || {})
+    def initialize(name, description, long_description, wrap_long_description, usage, options = nil, options_relation = nil)
+      super(name.to_s, description, long_description, wrap_long_description, usage, options || {}, options_relation || {})
     end
 
     def initialize_copy(other) #:nodoc:
       super(other)
       self.options = other.options.dup if other.options
+      self.options_relation = other.options_relation.dup if other.options_relation
     end
 
     def hidden?
@@ -62,6 +63,14 @@ class Thor
       end.join("\n")
     end
 
+    def method_exclusive_option_names #:nodoc:
+      self.options_relation[:exclusive_option_names] || []
+    end
+
+    def method_at_least_one_option_names #:nodoc:
+      self.options_relation[:at_least_one_option_names] || []
+    end
+
   protected
 
     # Add usage with required arguments
@@ -127,7 +136,7 @@ class Thor
   # A dynamic command that handles method missing scenarios.
   class DynamicCommand < Command
     def initialize(name, options = nil)
-      super(name.to_s, "A dynamically-generated command", name.to_s, name.to_s, options)
+      super(name.to_s, "A dynamically-generated command", name.to_s, nil, name.to_s, options)
     end
 
     def run(instance, args = [])

data/lib/thor/core_ext/hash_with_indifferent_access.rb

@@ -38,6 +38,10 @@ class Thor
         super(convert_key(key), *args)
       end
 
+      def slice(*keys)
+        super(*keys.map{ |key| convert_key(key) })
+      end
+
       def key?(key)
         super(convert_key(key))
       end

data/lib/thor/error.rb

@@ -1,26 +1,15 @@
 class Thor
   Correctable = if defined?(DidYouMean::SpellChecker) && defined?(DidYouMean::Correctable) # rubocop:disable Naming/ConstantName
-                  # In order to support versions of Ruby that don't have keyword
-                  # arguments, we need our own spell checker class that doesn't take key
-                  # words. Even though this code wouldn't be hit because of the check
-                  # above, it's still necessary because the interpreter would otherwise be
-                  # unable to parse the file.
-                  class NoKwargSpellChecker < DidYouMean::SpellChecker # :nodoc:
-                    def initialize(dictionary)
-                      @dictionary = dictionary
-                    end
-                  end
-
-                  Module.new do
-                    def to_s
-                      super + DidYouMean.formatter.message_for(corrections)
-                    end
-
-                    def corrections
-                      @corrections ||= self.class.const_get(:SpellChecker).new(self).corrections
-                    end
-                  end
-                end
+    Module.new do
+      def to_s
+        super + DidYouMean.formatter.message_for(corrections)
+      end
+
+      def corrections
+        @corrections ||= self.class.const_get(:SpellChecker).new(self).corrections
+      end
+    end
+  end
 
   # Thor::Error is raised when it's caused by wrong usage of thor classes. Those
   # errors have their backtrace suppressed and are nicely shown to the user.
@@ -45,7 +34,7 @@ class Thor
       end
 
       def spell_checker
-        NoKwargSpellChecker.new(error.all_commands)
+        DidYouMean::SpellChecker.new(dictionary: error.all_commands)
       end
     end
 
@@ -87,7 +76,7 @@ class Thor
       end
 
       def spell_checker
-        @spell_checker ||= NoKwargSpellChecker.new(error.switches)
+        @spell_checker ||= DidYouMean::SpellChecker.new(dictionary: error.switches)
       end
     end
 
@@ -108,4 +97,10 @@ class Thor
 
   class MalformattedArgumentError < InvocationError
   end
+
+  class ExclusiveArgumentError < InvocationError
+  end
+
+  class AtLeastOneRequiredArgumentError < InvocationError
+  end
 end

data/lib/thor/invocation.rb

@@ -143,7 +143,7 @@ class Thor
 
     # Configuration values that are shared between invocations.
     def _shared_configuration #:nodoc:
-      {:invocations => @_invocations}
+      {invocations: @_invocations}
     end
 
     # This method simply retrieves the class and command to be invoked.

data/lib/thor/nested_context.rb

@@ -13,10 +13,10 @@ class Thor
     end
 
     def entered?
-      @depth > 0
+      @depth.positive?
     end
 
-    private
+  private
 
     def push
       @depth += 1

data/lib/thor/parser/argument.rb

@@ -24,6 +24,17 @@ class Thor
       validate! # Trigger specific validations
     end
 
+    def print_default
+      if @type == :array and @default.is_a?(Array)
+        @default.map { |x|
+          p = x.gsub('"','\\"')
+          "\"#{p}\""
+        }.join(" ")
+      else
+        @default
+      end
+    end
+
     def usage
       required? ? banner : "[#{banner}]"
     end
@@ -41,11 +52,19 @@ class Thor
       end
     end
 
+    def enum_to_s
+      if enum.respond_to? :join
+        enum.join(", ")
+      else
+        "#{enum.first}..#{enum.last}"
+      end
+    end
+
   protected
 
     def validate!
       raise ArgumentError, "An argument cannot be required and have default value." if required? && !default.nil?
-      raise ArgumentError, "An argument cannot have an enum other than an array." if @enum && !@enum.is_a?(Array)
+      raise ArgumentError, "An argument cannot have an enum other than an enumerable." if @enum && !@enum.is_a?(Enumerable)
     end
 
     def valid_type?(type)