thor 0.19.4 → 1.2.1

data/lib/thor.rb

@@ -1,7 +1,7 @@
-require "set"
-require "thor/base"
+require_relative "thor/base"
 
 class Thor
+  $thor_runner ||= false
   class << self
     # Allows for custom "Command" package naming.
     #
@@ -90,9 +90,14 @@ 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, **kw)
       @map ||= from_superclass(:map, {})
 
+      if mappings && !kw.empty?
+        mappings = kw.merge!(mappings)
+      else
+        mappings ||= kw
+      end
       if mappings
         mappings.each do |key, value|
           if key.respond_to?(:each)
@@ -158,10 +163,6 @@ class Thor
     end
     alias_method :option, :method_option
 
-    def disable_class_options
-      @disable_class_options = true
-    end
-
     # Prints help information for the given command.
     #
     # ==== Parameters
@@ -174,7 +175,7 @@ class Thor
       handle_no_command_error(meth) unless command
 
       shell.say "Usage:"
-      shell.say "  #{banner(command)}"
+      shell.say "  #{banner(command).split("\n").join("\n  ")}"
       shell.say
       class_options_help(shell, nil => command.options.values)
       if command.long_description
@@ -241,6 +242,9 @@ class Thor
         invoke_args.unshift "help" if opts.delete("--help") || opts.delete("-h")
         invoke subcommand_class, *invoke_args
       end
+      subcommand_class.commands.each do |_meth, command|
+        command.ancestor_name = subcommand
+      end
     end
     alias_method :subtask, :subcommand
 
@@ -319,17 +323,36 @@ class Thor
     # ==== Parameters
     # Symbol ...:: A list of commands that should be affected.
     def stop_on_unknown_option!(*command_names)
-      stop_on_unknown_option.merge(command_names)
+      @stop_on_unknown_option = stop_on_unknown_option | command_names
     end
 
     def stop_on_unknown_option?(command) #:nodoc:
       command && stop_on_unknown_option.include?(command.name.to_sym)
     end
 
+    # Disable the check for required options for the given commands.
+    # This is useful if you have a command that does not need the required options
+    # to work, like help.
+    #
+    # ==== Parameters
+    # Symbol ...:: A list of commands that should be affected.
+    def disable_required_check!(*command_names)
+      @disable_required_check = disable_required_check | command_names
+    end
+
+    def disable_required_check?(command) #:nodoc:
+      command && disable_required_check.include?(command.name.to_sym)
+    end
+
   protected
 
     def stop_on_unknown_option #:nodoc:
-      @stop_on_unknown_option ||= Set.new
+      @stop_on_unknown_option ||= []
+    end
+
+    # help command has the required check disabled by default.
+    def disable_required_check #:nodoc:
+      @disable_required_check ||= [:help]
     end
 
     # The method responsible for dispatching given the args.
@@ -375,7 +398,9 @@ class Thor
     # the namespace should be displayed as arguments.
     #
     def banner(command, namespace = nil, subcommand = false)
-      "#{basename} #{command.formatted_usage(self, $thor_runner, subcommand)}"
+      command.formatted_usage(self, $thor_runner, subcommand).split("\n").map do |formatted_usage|
+        "#{basename} #{formatted_usage}"
+      end.join("\n")
     end
 
     def baseclass #:nodoc:
@@ -390,12 +415,12 @@ class Thor
       @usage ||= nil
       @desc ||= nil
       @long_desc ||= nil
-      @disable_class_options ||= nil
+      @hide ||= nil
 
       if @usage && @desc
         base_class = @hide ? Thor::HiddenCommand : Thor::Command
-        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
+        commands[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
+        @usage, @desc, @long_desc, @method_options, @hide = nil
         true
       elsif all_commands[meth] || meth == "method_missing"
         true
@@ -477,7 +502,6 @@ class Thor
   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/thor.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 require "thor/version"
 
 Gem::Specification.new do |spec|
-  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "bundler", ">= 1.0", "< 3"
   spec.authors = ["Yehuda Katz", "José Valim"]
   spec.description = "Thor is a toolkit for building powerful command-line interfaces."
   spec.email = "ruby-thor@googlegroups.com"
@@ -13,8 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage = "http://whatisthor.com/"
   spec.licenses = %w(MIT)
   spec.name = "thor"
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/rails/thor/issues",
+    "changelog_uri" => "https://github.com/rails/thor/releases/tag/v#{Thor::VERSION}",
+    "documentation_uri" => "http://whatisthor.com/",
+    "source_code_uri" => "https://github.com/rails/thor/tree/v#{Thor::VERSION}",
+    "wiki_uri" => "https://github.com/rails/thor/wiki",
+    "rubygems_mfa_required" => "true",
+  }
   spec.require_paths = %w(lib)
-  spec.required_ruby_version = ">= 1.8.7"
+  spec.required_ruby_version = ">= 2.0.0"
   spec.required_rubygems_version = ">= 1.3.5"
   spec.summary = spec.description
   spec.version = Thor::VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thor
 version: !ruby/object:Gem::Version
-  version: 0.19.4
+  version: 1.2.1
 platform: ruby
 authors:
 - Yehuda Katz
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Thor is a toolkit for building powerful command-line interfaces.
 email: ruby-thor@googlegroups.com
 executables:
@@ -33,7 +39,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
-- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
@@ -49,14 +54,13 @@ files:
 - lib/thor/base.rb
 - lib/thor/command.rb
 - lib/thor/core_ext/hash_with_indifferent_access.rb
-- lib/thor/core_ext/io_binary_read.rb
-- lib/thor/core_ext/ordered_hash.rb
 - lib/thor/error.rb
 - lib/thor/group.rb
 - lib/thor/invocation.rb
 - lib/thor/line_editor.rb
 - lib/thor/line_editor/basic.rb
 - lib/thor/line_editor/readline.rb
+- lib/thor/nested_context.rb
 - lib/thor/parser.rb
 - lib/thor/parser/argument.rb
 - lib/thor/parser/arguments.rb
@@ -74,7 +78,13 @@ files:
 homepage: http://whatisthor.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/rails/thor/issues
+  changelog_uri: https://github.com/rails/thor/releases/tag/v1.2.1
+  documentation_uri: http://whatisthor.com/
+  source_code_uri: https://github.com/rails/thor/tree/v1.2.1
+  wiki_uri: https://github.com/rails/thor/wiki
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -83,15 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Thor is a toolkit for building powerful command-line interfaces.

data/CHANGELOG.md

@@ -1,163 +0,0 @@
-## 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
-
-## 0.18.0, release 2013-03-26
-* Remove rake2thor
-* Only display colors if output medium supports colors
-* Pass parent_options to subcommands
-* Fix non-dash-prefixed aliases
-* Make error messages more helpful
-* Rename "task" to "command"
-* Add the method to allow for custom package name
-
-## 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
-
-## 0.15.4, release 2012-06-29
-* Fix regression when destination root contains reserved regexp characters
-
-## 0.15.3, release 2012-06-18
-* Support strict_args_position! for backwards compatibility
-* Escape Dir glob characters in paths
-
-## 0.15.2, released 2012-05-07
-* Added print_in_columns
-* Exposed terminal_width as a public API
-
-## 0.15.1, release 2012-05-06
-* Fix Ruby 1.8 truncation bug with unicode chars
-* Fix shell delegate methods to pass their block
-* Don't output trailing spaces when printing the last column in a table
-
-## 0.15, released 2012-04-29
-* Alias method_options to options
-* Refactor say to allow multiple colors
-* Exposed error as a public API
-* Exposed file_collision as a public API
-* Exposed print_wrapped as a public API
-* Exposed set_color as a public API
-* Fix number-formatting bugs in print_table
-* Fix "indent" typo in print_table
-* Fix Errno::EPIPE when piping tasks to `head`
-* More friendly error messages
-
-## 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
-* Added Thor::Shell::HTML
-* Added subcommands
-* Decoupled Thor::Group and Thor, so it's easier to vendor
-* Added check_unknown_options! in case you want error messages to be raised in valid switches
-* run(command) should return the results of command
-
-## 0.12, released 2010-01-02
-* Methods generated by attr_* are automatically not marked as tasks
-* inject_into_file does not add the same content twice, unless :force is set
-* Removed rr in favor to rspec mock framework
-* Improved output for thor -T
-* [#7] Do not force white color on status
-* [#8] Yield a block with the filename on directory
-
-## 0.11, released 2009-07-01
-* Added a rake compatibility layer. It allows you to use spec and rdoc tasks on
-  Thor classes.
-* BACKWARDS INCOMPATIBLE: aliases are not generated automatically anymore
-  since it may cause wrong behavior in the invocation system.
-* thor help now show information about any class/task. All those calls are
-  possible:
-
-      thor help describe
-      thor help describe:amazing
-  Or even with default namespaces:
-
-      thor help :spec
-* Thor::Runner now invokes the default task if none is supplied:
-
-      thor describe # invokes the default task, usually help
-* Thor::Runner now works with mappings:
-
-      thor describe -h
-* Added some documentation and code refactoring.
-
-## 0.9.8, released 2008-10-20
-* Fixed some tiny issues that were introduced lately.
-
-## 0.9.7, released 2008-10-13
-* Setting global method options on the initialize method works as expected:
-  All other tasks will accept these global options in addition to their own.
-* Added 'group' notion to Thor task sets (class Thor); by default all tasks
-  are in the 'standard' group. Running 'thor -T' will only show the standard
-  tasks - adding --all will show all tasks. You can also filter on a specific
-  group using the --group option: thor -T --group advanced
-
-## 0.9.6, released 2008-09-13
-* Generic improvements
-
-## 0.9.5, released 2008-08-27
-* Improve Windows compatibility
-* Update (incorrect) README and task.thor sample file
-* Options hash is now frozen (once returned)
-* Allow magic predicates on options object. For instance: `options.force?`
-* Add support for :numeric type
-* BACKWARDS INCOMPATIBLE: Refactor Thor::Options. You cannot access shorthand forms in options hash anymore (for instance, options[:f])
-* Allow specifying optional args with default values: method_options(:user => "mislav")
-* Don't write options for nil or false values. This allows, for example, turning color off when running specs.
-* Exit with the status of the spec command to help CI stuff out some.
-
-## 0.9.4, released 2008-08-13
-* Try to add Windows compatibility.
-* BACKWARDS INCOMPATIBLE: options hash is now accessed as a property in your class and is not passed as last argument anymore
-* Allow options at the beginning of the argument list as well as the end.
-* Make options available with symbol keys in addition to string keys.
-* Allow true to be passed to Thor#method_options to denote a boolean option.
-* If loading a thor file fails, don't give up, just print a warning and keep going.
-* Make sure that we re-raise errors if they happened further down the pipe than we care about.
-* Only delete the old file on updating when the installation of the new one is a success
-* Make it Ruby 1.8.5 compatible.
-* Don't raise an error if a boolean switch is defined multiple times.
-* Thor::Options now doesn't parse through things that look like options but aren't.
-* Add URI detection to install task, and make sure we don't append ".thor" to URIs
-* Add rake2thor to the gem binfiles.
-* Make sure local Thorfiles override system-wide ones.

data/lib/thor/core_ext/io_binary_read.rb

@@ -1,12 +0,0 @@
-class IO #:nodoc:
-  class << self
-    unless method_defined? :binread
-      def binread(file, *args)
-        raise ArgumentError, "wrong number of arguments (#{1 + args.size} for 1..3)" unless args.size < 3
-        File.open(file, "rb") do |f|
-          f.read(*args)
-        end
-      end
-    end
-  end
-end

data/lib/thor/core_ext/ordered_hash.rb

@@ -1,129 +0,0 @@
-class Thor
-  module CoreExt
-    class OrderedHash < ::Hash
-      if RUBY_VERSION < "1.9"
-        def initialize(*args, &block)
-          super
-          @keys = []
-        end
-
-        def initialize_copy(other)
-          super
-          # make a deep copy of keys
-          @keys = other.keys
-        end
-
-        def []=(key, value)
-          @keys << key unless key?(key)
-          super
-        end
-
-        def delete(key)
-          if key? key
-            index = @keys.index(key)
-            @keys.delete_at index
-          end
-          super
-        end
-
-        def delete_if
-          super
-          sync_keys!
-          self
-        end
-
-        alias_method :reject!, :delete_if
-
-        def reject(&block)
-          dup.reject!(&block)
-        end
-
-        def keys
-          @keys.dup
-        end
-
-        def values
-          @keys.map { |key| self[key] }
-        end
-
-        def to_hash
-          self
-        end
-
-        def to_a
-          @keys.map { |key| [key, self[key]] }
-        end
-
-        def each_key
-          return to_enum(:each_key) unless block_given?
-          @keys.each { |key| yield(key) }
-          self
-        end
-
-        def each_value
-          return to_enum(:each_value) unless block_given?
-          @keys.each { |key| yield(self[key]) }
-          self
-        end
-
-        def each
-          return to_enum(:each) unless block_given?
-          @keys.each { |key| yield([key, self[key]]) }
-          self
-        end
-
-        def each_pair
-          return to_enum(:each_pair) unless block_given?
-          @keys.each { |key| yield(key, self[key]) }
-          self
-        end
-
-        alias_method :select, :find_all
-
-        def clear
-          super
-          @keys.clear
-          self
-        end
-
-        def shift
-          k = @keys.first
-          v = delete(k)
-          [k, v]
-        end
-
-        def merge!(other_hash)
-          if block_given?
-            other_hash.each { |k, v| self[k] = key?(k) ? yield(k, self[k], v) : v }
-          else
-            other_hash.each { |k, v| self[k] = v }
-          end
-          self
-        end
-
-        alias_method :update, :merge!
-
-        def merge(other_hash, &block)
-          dup.merge!(other_hash, &block)
-        end
-
-        # When replacing with another hash, the initial order of our keys must come from the other hash -ordered or not.
-        def replace(other)
-          super
-          @keys = other.keys
-          self
-        end
-
-        def inspect
-          "#<#{self.class} #{super}>"
-        end
-
-        private
-
-        def sync_keys!
-          @keys.delete_if { |k| !key?(k) }
-        end
-      end
-    end
-  end
-end