thor 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49e18474eddb5dbf02c13be5b42104385928e460511272e7293cc66110d1c3d7
-  data.tar.gz: ffea33d8f08051882551af3a444fe68a77ffe0ecfe16404f2ead662364d36b5e
+  metadata.gz: e94d00b16790c1908982c0fc76113f047ef1d190cba38b28269bff4be8d29191
+  data.tar.gz: 73c43412813c252302cc88b3aa3b5deee87ba9d1db20e2d6661714a7a4e88843
 SHA512:
-  metadata.gz: bc1a58088c4c7b48166152c1f7cfc0c4dc91e9c3199e583e6085b74a2982f65c0eaa8d8b7595f8f5781c08b0f60818e4a014bb23adbdfb07fd2ded558ceef67e
-  data.tar.gz: f9a3c7f81a55d75298e3655569a86f04aa2055088058eb0a30ce5b80e05c6be7ed9c0f1840031dd266c453a4ac1454d8749849b47659d2f53f8b1221b9db2b7b
+  metadata.gz: 5071358360989a17de4daa7f141b4d4f411d5914cf2d25e2856c4f95815f6ad6ecbaaec52a5a385a96d5277005cd61fec34c9401918b62de8c767cdae36a924d
+  data.tar.gz: 49a99cc7a21d9f9f90aef59325c543c8d82e9f22cff26fecfdfd3071d82c3ead068b82818b1cbe67ba7e3235edf29b0db0f74334723cbad5cd00808997bc1147

data/README.md

@@ -2,14 +2,8 @@ Thor
 ====
 
 [![Gem Version](http://img.shields.io/gem/v/thor.svg)][gem]
-[![Build Status](http://img.shields.io/travis/erikhuda/thor.svg)][travis]
-[![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
-[codeclimate]: https://codeclimate.com/github/erikhuda/thor
-[coveralls]: https://coveralls.io/r/erikhuda/thor
 
 Description
 -----------
@@ -35,7 +29,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/erikhuda/thor/wiki
+[wiki]: https://github.com/rails/thor/wiki
 [homepage]: http://whatisthor.com/
 
 Contributing

data/lib/thor/actions/file_manipulation.rb

@@ -210,9 +210,9 @@ class Thor
     #
     # ==== Examples
     #
-    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController, "  filter_parameter :password\n"
+    #   inject_into_class "app/controllers/application_controller.rb", "ApplicationController", "  filter_parameter :password\n"
     #
-    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+    #   inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
     #     "  filter_parameter :password\n"
     #   end
     #
@@ -233,9 +233,9 @@ class Thor
     #
     # ==== Examples
     #
-    #   inject_into_module "app/helpers/application_helper.rb", ApplicationHelper, "  def help; 'help'; end\n"
+    #   inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper", "  def help; 'help'; end\n"
     #
-    #   inject_into_module "app/helpers/application_helper.rb", ApplicationHelper do
+    #   inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper" do
     #     "  def help; 'help'; end\n"
     #   end
     #
@@ -331,7 +331,7 @@ class Thor
       path = File.expand_path(path, destination_root)
 
       say_status :remove, relative_to_original_destination_root(path), config.fetch(:verbose, true)
-      if !options[:pretend] && File.exist?(path)
+      if !options[:pretend] && (File.exist?(path) || File.symlink?(path))
         require "fileutils"
         ::FileUtils.rm_rf(path)
       end

data/lib/thor/actions/inject_into_file.rb

@@ -106,12 +106,14 @@ class Thor
       # Adds the content to the file.
       #
       def replace!(regexp, string, force)
-        return if pretend?
         content = File.read(destination)
-        if force || !content.include?(replacement)
+        before, after = content.split(regexp, 2)
+        snippet = (behavior == :after ? after : before).to_s
+
+        if force || !snippet.include?(replacement)
           success = content.gsub!(regexp, string)
 
-          File.open(destination, "wb") { |file| file.write(content) }
+          File.open(destination, "wb") { |file| file.write(content) } unless pretend?
           success
         end
       end

data/lib/thor/actions.rb

@@ -161,6 +161,8 @@ class Thor
     # to the block you provide. The path is set back to the previous path when
     # the method exits.
     #
+    # Returns the value yielded by the block.
+    #
     # ==== Parameters
     # dir<String>:: the directory to move to.
     # config<Hash>:: give :verbose => true to log and use padding.
@@ -179,16 +181,18 @@ class Thor
         FileUtils.mkdir_p(destination_root)
       end
 
+      result = nil
       if pretend
         # In pretend mode, just yield down to the block
-        block.arity == 1 ? yield(destination_root) : yield
+        result = block.arity == 1 ? yield(destination_root) : yield
       else
         require "fileutils"
-        FileUtils.cd(destination_root) { block.arity == 1 ? yield(destination_root) : yield }
+        FileUtils.cd(destination_root) { result = block.arity == 1 ? yield(destination_root) : yield }
       end
 
       @destination_stack.pop
       shell.padding -= 1 if verbose
+      result
     end
 
     # Goes to the root and execute the given block.

data/lib/thor/core_ext/hash_with_indifferent_access.rb

@@ -28,6 +28,12 @@ class Thor
         super(convert_key(key))
       end
 
+      def except(*keys)
+        dup.tap do |hash|
+          keys.each { |key| hash.delete(convert_key(key)) }
+        end
+      end
+
       def fetch(key, *args)
         super(convert_key(key), *args)
       end

data/lib/thor/error.rb

@@ -102,9 +102,14 @@ class Thor
   end
 
   if Correctable
-    DidYouMean::SPELL_CHECKERS.merge!(
-      'Thor::UndefinedCommandError' => UndefinedCommandError::SpellChecker,
-      'Thor::UnknownArgumentError' => UnknownArgumentError::SpellChecker
-    )
+    if DidYouMean.respond_to?(:correct_error)
+      DidYouMean.correct_error(Thor::UndefinedCommandError, UndefinedCommandError::SpellChecker)
+      DidYouMean.correct_error(Thor::UnknownArgumentError, UnknownArgumentError::SpellChecker)
+    else
+      DidYouMean::SPELL_CHECKERS.merge!(
+        'Thor::UndefinedCommandError' => UndefinedCommandError::SpellChecker,
+        'Thor::UnknownArgumentError' => UnknownArgumentError::SpellChecker
+      )
+    end
   end
 end

data/lib/thor/parser/options.rb

@@ -45,6 +45,7 @@ class Thor
       @switches = {}
       @extra = []
       @stopped_parsing_after_extra_index = nil
+      @is_treated_as_value = false
 
       options.each do |option|
         @switches[option.switch_name] = option
@@ -74,8 +75,19 @@ class Thor
       end
     end
 
+    def shift
+      @is_treated_as_value = false
+      super
+    end
+
+    def unshift(arg, is_value: false)
+      @is_treated_as_value = is_value
+      super(arg)
+    end
+
     def parse(args) # rubocop:disable MethodLength
       @pile = args.dup
+      @is_treated_as_value = false
       @parsing_options = true
 
       while peek
@@ -88,7 +100,10 @@ class Thor
             when SHORT_SQ_RE
               unshift($1.split("").map { |f| "-#{f}" })
               next
-            when EQ_RE, SHORT_NUM
+            when EQ_RE
+              unshift($2, is_value: true)
+              switch = $1
+            when SHORT_NUM
               unshift($2)
               switch = $1
             when LONG_RE, SHORT_RE
@@ -148,6 +163,7 @@ class Thor
     # 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?
+      return [false, false] if @is_treated_as_value
       case peek
       when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM
         [true, switch?($1)]
@@ -159,6 +175,7 @@ class Thor
     end
 
     def current_is_switch_formatted?
+      return false if @is_treated_as_value
       case peek
       when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM, SHORT_SQ_RE
         true
@@ -168,6 +185,7 @@ class Thor
     end
 
     def current_is_value?
+      return true if @is_treated_as_value
       peek && (!parsing_options? || super)
     end
 

data/lib/thor/shell/basic.rb

@@ -103,6 +103,23 @@ class Thor
         stdout.flush
       end
 
+      # Say (print) an error to the user. If the sentence ends with a whitespace
+      # or tab character, a new line is not appended (print + flush). Otherwise
+      # are passed straight to puts (behavior got from Highline).
+      #
+      # ==== Example
+      # say_error("error: something went wrong")
+      #
+      def say_error(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
+        return if quiet?
+
+        buffer = prepare_message(message, *color)
+        buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")
+
+        stderr.print(buffer)
+        stderr.flush
+      end
+
       # Say a status with the given color and appends the message. Since this
       # method is used frequently by actions, it allows nil or false to be given
       # in log_status, avoiding the message from being shown. If a Symbol is
@@ -111,13 +128,14 @@ class Thor
       def say_status(status, message, log_status = true)
         return if quiet? || log_status == false
         spaces = "  " * (padding + 1)
-        color  = log_status.is_a?(Symbol) ? log_status : :green
-
         status = status.to_s.rjust(12)
+        margin = " " * status.length + spaces
+
+        color  = log_status.is_a?(Symbol) ? log_status : :green
         status = set_color status, color, true if color
 
-        buffer = "#{status}#{spaces}#{message}"
-        buffer = "#{buffer}\n" unless buffer.end_with?("\n")
+        message = message.to_s.chomp.gsub(/(?<!\A)^/, margin)
+        buffer = "#{status}#{spaces}#{message}\n"
 
         stdout.print(buffer)
         stdout.flush

data/lib/thor/shell.rb

@@ -21,7 +21,7 @@ class Thor
   end
 
   module Shell
-    SHELL_DELEGATED_METHODS = [:ask, :error, :set_color, :yes?, :no?, :say, :say_status, :print_in_columns, :print_table, :print_wrapped, :file_collision, :terminal_width]
+    SHELL_DELEGATED_METHODS = [:ask, :error, :set_color, :yes?, :no?, :say, :say_error, :say_status, :print_in_columns, :print_table, :print_wrapped, :file_collision, :terminal_width]
     attr_writer :shell
 
     autoload :Basic, File.expand_path("shell/basic", __dir__)

data/lib/thor/util.rb

@@ -211,7 +211,7 @@ class Thor
       #
       def globs_for(path)
         path = escape_globs(path)
-        ["#{path}/Thorfile", "#{path}/*.thor", "#{path}/tasks/*.thor", "#{path}/lib/tasks/*.thor"]
+        ["#{path}/Thorfile", "#{path}/*.thor", "#{path}/tasks/*.thor", "#{path}/lib/tasks/**/*.thor"]
       end
 
       # Return the path to the ruby interpreter taking into account multiple

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/thor.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |spec|
   spec.licenses = %w(MIT)
   spec.name = "thor"
   spec.metadata = {
-    "bug_tracker_uri" => "https://github.com/erikhuda/thor/issues",
-    "changelog_uri" => "https://github.com/erikhuda/thor/blob/master/CHANGELOG.md",
+    "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/erikhuda/thor/tree/v#{Thor::VERSION}",
-    "wiki_uri" => "https://github.com/erikhuda/thor/wiki"
+    "source_code_uri" => "https://github.com/rails/thor/tree/v#{Thor::VERSION}",
+    "wiki_uri" => "https://github.com/rails/thor/wiki"
   }
   spec.require_paths = %w(lib)
   spec.required_ruby_version = ">= 2.0.0"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: thor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yehuda Katz
 - José Valim
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
-- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
@@ -80,12 +79,12 @@ homepage: http://whatisthor.com/
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/erikhuda/thor/issues
-  changelog_uri: https://github.com/erikhuda/thor/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rails/thor/issues
+  changelog_uri: https://github.com/rails/thor/releases/tag/v1.2.0
   documentation_uri: http://whatisthor.com/
-  source_code_uri: https://github.com/erikhuda/thor/tree/v1.1.0
-  wiki_uri: https://github.com/erikhuda/thor/wiki
-post_install_message:
+  source_code_uri: https://github.com/rails/thor/tree/v1.2.0
+  wiki_uri: https://github.com/rails/thor/wiki
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: Thor is a toolkit for building powerful command-line interfaces.
 test_files: []

data/CHANGELOG.md

@@ -1,228 +0,0 @@
-# 1.1.0
-* Don't use ANSI colors when terminal is dumb.
-* Ensure default option/argument is not erroneously aliased.
-* Fixes a bug in the calculation of the print_wrapped method.
-* Obey `:mute` and `options[:quiet]` in `Shell#say`.
-* Support Ruby 3.0.
-* Add force option to the `gsub_file` action.
-
-# 1.0.1
-* Fix thor when `thor/base` and `thor/group` are required without `thor.rb`.
-* Handle relative source path in `create_link`.
-
-# 1.0.0
-* Drop support to Ruby 1.8 and 1.9.
-* Deprecate relying on default `exit_on_failure?`.
-  In preparation to make Thor commands exit when there is a failure we are deprecating
-  defining a command without defining what behavior is expected when there is a failure.
-
-  To fix the deprecation you need to define a class method called `exit_on_failure?` returning
-
-  `false` if you want the current behavior or `true` if you want the new behavior.
-* Deprecate defining an option with the default value using a different type as defined in the option.
-* Allow options to be repeatable. See #674.
-
-# 0.20.3
-* Support old versions of `did_you_mean`.
-
-# 0.20.2
-* Fix `did_you_mean` support.
-
-# 0.20.1
-* Support new versions of ERB.
-* Fix `check_unknown_options!` to not check the content that was not parsed, i.e. after a `--` or after the first unknown with `stop_on_unknown_option!`
-* Add `did_you_mean` support.
-
-## 0.20.0
-* Add `check_default_type!` to check if the default value of an option matches the defined type.
-  It removes the warning on usage and gives the command authors the possibility to check for programming errors.
-
-* Add `disable_required_check!` to disable check for required options in some commands.
-  It is a substitute of `disable_class_options` that was not working as intended.
-
-* Add `inject_into_module`.
-
-## 0.19.4, release 2016-11-28
-* Rename `Thor::Base#thor_reserved_word?` to `#is_thor_reserved_word?`
-
-## 0.19.3, release 2016-11-27
-* Output a warning instead of raising an exception when a default option value doesn't match its specified type
-
-## 0.19.2, release 2016-11-26
-* Fix bug with handling of colors passed to `ask` (and methods like `yes?` and `no?` which it underpins)
-* Allow numeric arguments to be negative
-* Ensure that default option values are of the specified type (e.g. you can't specify `"foo"` as the default for a numeric option), but make symbols and strings interchangeable
-* Add `Thor::Shell::Basic#indent` method for intending output
-* Fix `remove_command` for an inherited command (see #451)
-* Allow hash arguments to only have each key provided once (see #455)
-* Allow commands to disable class options, for instance for "help" commands (see #363)
-* Do not generate a negative option (`--no-no-foo`) for already negative boolean options (`--no-foo`)
-* Improve compatibility of `Thor::CoreExt::HashWithIndifferentAccess` with Ruby standard library `Hash`
-* Allow specifying a custom binding for template evaluation (e.g. `#key?` and `#fetch`)
-* Fix support for subcommand-specific "help"s
-* Use a string buffer when handling ERB for Ruby 2.3 compatibility
-* Update dependencies
-
-## 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.