thor 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f24a2dd00001feb1d7f9d68b1cf8aff06dd9f347e230846eda8662595a514ac9
-  data.tar.gz: 5fcf2e12c1a1f7112b72286f3eded990dc6f00df0ecc45a5e32465915c10b515
+  metadata.gz: 50c78a27ef16cfc96930bc60d8637e86acd69c94b932cc745bb2ed5c3e1605c8
+  data.tar.gz: 00b8a88f938047a55fe3ffadb6bd019666d82813ff584209a338bd8e6d3f16a7
 SHA512:
-  metadata.gz: 03d0bd2991357425d2ceeeaf3a538f280e9a1a2ce7d35cc210c5413744940f022602339ce721aff4bad5c51ebde0a071d533a06c7c697dee8fabbcb468671dc5
-  data.tar.gz: 1fe2bbce8f427aaa3a9a314b647796927d8dbaf52b2873c1def2d072c3fd98076abcbc50890d913f195a30835208f5f2d272d59969a89e3821f1ff6c1080d073
+  metadata.gz: 86fb64f2b698f06f5c7a0bd14523338802b374ae3d42879d71f94d542598216595176ce744b9ea84196d87657ec4cdaa9f73954ad15124b89109ee87a304eadc
+  data.tar.gz: 81f3b4ce1bca3d43efe2aecf00c88372b6673e3a82706e75ef018cc17badf3b3f2a267fe926b86225b112bbe1bd6e0257115327aa006984c89d8ddc434b88d56

data/README.md

@@ -15,7 +15,7 @@ users.
 
 Please note: Thor, by design, is a system tool created to allow seamless file and url
 access, which should not receive application user input. It relies on [open-uri][open-uri],
-which combined with application user input would provide a command injection attack
+which, combined with application user input, would provide a command injection attack
 vector.
 
 [rake]: https://github.com/ruby/rake
@@ -27,7 +27,7 @@ Installation
 
 Usage and documentation
 -----------------------
-Please see the [wiki][] for basic usage and other documentation on using Thor. You can also checkout the [official homepage][homepage].
+Please see the [wiki][] for basic usage and other documentation on using Thor. You can also check out the [official homepage][homepage].
 
 [wiki]: https://github.com/rails/thor/wiki
 [homepage]: http://whatisthor.com/

data/lib/thor/actions/file_manipulation.rb

@@ -10,7 +10,6 @@ class Thor
     # destination<String>:: the relative path to the destination root.
     # config<Hash>:: give :verbose => false to not log the status, and
     #                :mode => :preserve, to preserve the file mode from the source.
-
     #
     # ==== Examples
     #
@@ -243,6 +242,35 @@ class Thor
       insert_into_file(path, *(args << config), &block)
     end
 
+    # Run a regular expression replacement on a file, raising an error if the
+    # contents of the file are not changed.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # flag<Regexp|String>:: the regexp or string to be replaced
+    # replacement<String>:: the replacement, can be also given as a block
+    # config<Hash>:: give :verbose => false to not log the status, and
+    #                :force => true, to force the replacement regardless of runner behavior.
+    #
+    # ==== Example
+    #
+    #   gsub_file! 'app/controllers/application_controller.rb', /#\s*(filter_parameter_logging :password)/, '\1'
+    #
+    #   gsub_file! 'README', /rake/, :green do |match|
+    #     match << " no more. Use thor!"
+    #   end
+    #
+    def gsub_file!(path, flag, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+
+      return unless behavior == :invoke || config.fetch(:force, false)
+
+      path = File.expand_path(path, destination_root)
+      say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true)
+
+      actually_gsub_file(path, flag, args, true, &block) unless options[:pretend]
+    end
+
     # Run a regular expression replacement on a file.
     #
     # ==== Parameters
@@ -268,16 +296,11 @@ class Thor
       path = File.expand_path(path, destination_root)
       say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true)
 
-      unless options[:pretend]
-        content = File.binread(path)
-        content.gsub!(flag, *args, &block)
-        File.open(path, "wb") { |file| file.write(content) }
-      end
+      actually_gsub_file(path, flag, args, false, &block) unless options[:pretend]
     end
 
-    # Uncomment all lines matching a given regex.  It will leave the space
-    # which existed before the comment hash in tact but will remove any spacing
-    # between the comment hash and the beginning of the line.
+    # Uncomment all lines matching a given regex. Preserves indentation before
+    # the comment hash and removes the hash and any immediate following space.
     #
     # ==== Parameters
     # path<String>:: path of the file to be changed
@@ -291,7 +314,7 @@ class Thor
     def uncomment_lines(path, flag, *args)
       flag = flag.respond_to?(:source) ? flag.source : flag
 
-      gsub_file(path, /^(\s*)#[[:blank:]]*(.*#{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
@@ -350,7 +373,7 @@ class Thor
     end
 
     def with_output_buffer(buf = "".dup) #:nodoc:
-      raise ArgumentError, "Buffer can not be a frozen object" if buf.frozen?
+      raise ArgumentError, "Buffer cannot be a frozen object" if buf.frozen?
       old_buffer = output_buffer
       self.output_buffer = buf
       yield
@@ -359,6 +382,17 @@ class Thor
       self.output_buffer = old_buffer
     end
 
+    def actually_gsub_file(path, flag, args, error_on_no_change, &block)
+      content = File.binread(path)
+      success = content.gsub!(flag, *args, &block)
+
+      if success.nil? && error_on_no_change
+        raise Thor::Error, "The content of #{path} did not change"
+      end
+
+      File.open(path, "wb") { |file| file.write(content) }
+    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

data/lib/thor/group.rb

@@ -211,6 +211,17 @@ class Thor::Group
       raise error, msg
     end
 
+    # Checks if a specified command exists.
+    #
+    # ==== Parameters
+    # command_name<String>:: The name of the command to check for existence.
+    #
+    # ==== Returns
+    # Boolean:: +true+ if the command exists, +false+ otherwise.
+    def command_exists?(command_name) #:nodoc:
+      commands.keys.include?(command_name)
+    end
+
   protected
 
     # The method responsible for dispatching given the args.

data/lib/thor/parser/argument.rb

@@ -26,10 +26,7 @@ class Thor
 
     def print_default
       if @type == :array and @default.is_a?(Array)
-        @default.map { |x|
-          p = x.gsub('"','\\"')
-          "\"#{p}\""
-        }.join(" ")
+        @default.map(&:dump).join(" ")
       else
         @default
       end

data/lib/thor/parser/option.rb

@@ -89,8 +89,8 @@ class Thor
 
       sample = "[#{sample}]".dup unless required?
 
-      if boolean?
-        sample << ", [#{dasherize('no-' + human_name)}]" unless (name == "force") || name.match(/\Ano[\-_]/)
+      if boolean? && name != "force" && !name.match(/\A(no|skip)[\-_]/)
+        sample << ", [#{dasherize('no-' + human_name)}], [#{dasherize('skip-' + human_name)}]"
       end
 
       aliases_for_usage.ljust(padding) + sample

data/lib/thor/parser/options.rb

@@ -144,7 +144,7 @@ class Thor
     def check_exclusive!
       opts = @assigns.keys
       # When option A and B are exclusive, if A and B are given at the same time,
-      # the diffrence of argument array size will decrease.
+      # the difference of argument array size will decrease.
       found = @exclusives.find{ |ex| (ex - opts).size < ex.size - 1 }
       if found
         names = names_to_switch_names(found & opts).map{|n| "'#{n}'"}
@@ -250,7 +250,8 @@ class Thor
       @parsing_options
     end
 
-    # Parse boolean values which can be given as --foo=true, --foo or --no-foo.
+    # Parse boolean values which can be given as --foo=true or --foo for true values, or
+    # --foo=false, --no-foo or --skip-foo for false values.
     #
     def parse_boolean(switch)
       if current_is_value?

data/lib/thor/runner.rb

@@ -1,7 +1,6 @@
 require_relative "../thor"
 require_relative "group"
 
-require "yaml"
 require "digest/sha2"
 require "pathname"
 
@@ -195,6 +194,7 @@ private
   def thor_yaml
     @thor_yaml ||= begin
       yaml_file = File.join(thor_root, "thor.yml")
+      require "yaml"
       yaml = YAML.load_file(yaml_file) if File.exist?(yaml_file)
       yaml || {}
     end

data/lib/thor/shell/basic.rb

@@ -67,15 +67,15 @@ class Thor
       # Readline.
       #
       # ==== Example
-      # ask("What is your name?")
+      #   ask("What is your name?")
       #
-      # ask("What is the planet furthest from the sun?", :default => "Pluto")
+      #   ask("What is the planet furthest from the sun?", :default => "Neptune")
       #
-      # ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"])
+      #   ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"])
       #
-      # ask("What is your password?", :echo => false)
+      #   ask("What is your password?", :echo => false)
       #
-      # ask("Where should the file be saved?", :path => true)
+      #   ask("Where should the file be saved?", :path => true)
       #
       def ask(statement, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
@@ -93,7 +93,7 @@ class Thor
       # are passed straight to puts (behavior got from Highline).
       #
       # ==== Example
-      # say("I know you knew that.")
+      #   say("I know you knew that.")
       #
       def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
         return if quiet?
@@ -110,7 +110,7 @@ class Thor
       # are passed straight to puts (behavior got from Highline).
       #
       # ==== Example
-      # say_error("error: something went wrong")
+      #   say_error("error: something went wrong")
       #
       def say_error(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
         return if quiet?
@@ -143,14 +143,14 @@ class Thor
         stdout.flush
       end
 
-      # Make a question the to user and returns true if the user replies "y" or
+      # Asks the user a question and returns true if the user replies "y" or
       # "yes".
       #
       def yes?(statement, color = nil)
         !!(ask(statement, color, add_to_history: false) =~ is?(:yes))
       end
 
-      # Make a question the to user and returns true if the user replies "n" or
+      # Asks the user a question and returns true if the user replies "n" or
       # "no".
       #
       def no?(statement, color = nil)
@@ -314,7 +314,7 @@ class Thor
         diff_cmd = ENV["THOR_DIFF"] || ENV["RAILS_DIFF"] || "diff -u"
 
         require "tempfile"
-        Tempfile.open(File.basename(destination), File.dirname(destination)) do |temp|
+        Tempfile.open(File.basename(destination), File.dirname(destination), binmode: true) do |temp|
           temp.write content
           temp.rewind
           system %(#{diff_cmd} "#{destination}" "#{temp.path}")
@@ -372,16 +372,12 @@ class Thor
         Tempfile.open([File.basename(destination), File.extname(destination)], File.dirname(destination)) do |temp|
           temp.write content
           temp.rewind
-          system %(#{merge_tool} "#{temp.path}" "#{destination}")
+          system(merge_tool, temp.path, destination)
         end
       end
 
       def merge_tool #:nodoc:
-        @merge_tool ||= ENV["THOR_MERGE"] || git_merge_tool
-      end
-
-      def git_merge_tool #:nodoc:
-        `git config merge.tool`.rstrip rescue ""
+        @merge_tool ||= ENV["THOR_MERGE"] || "git difftool --no-index"
       end
     end
   end

data/lib/thor/shell/html.rb

@@ -67,7 +67,7 @@ class Thor
       # Ask something to the user and receives a response.
       #
       # ==== Example
-      # ask("What is your name?")
+      #   ask("What is your name?")
       #
       # TODO: Implement #ask for Thor::Shell::HTML
       def ask(statement, color = nil)

data/lib/thor/shell/table_printer.rb

@@ -102,33 +102,17 @@ class Thor
 
       def truncate(string)
         return string unless @truncate
-        as_unicode do
-          chars = string.chars.to_a
-          if chars.length <= @truncate
-            chars.join
-          else
-            chars[0, @truncate - 3 - @indent].join + "..."
-          end
+        chars = string.chars.to_a
+        if chars.length <= @truncate
+          chars.join
+        else
+          chars[0, @truncate - 3 - @indent].join + "..."
         end
       end
 
       def indentation
         " " * @indent
       end
-
-      if "".respond_to?(:encode)
-        def as_unicode
-          yield
-        end
-      else
-        def as_unicode
-          old = $KCODE # rubocop:disable Style/GlobalVars
-          $KCODE = "U" # rubocop:disable Style/GlobalVars
-          yield
-        ensure
-          $KCODE = old # rubocop:disable Style/GlobalVars
-        end
-      end
     end
   end
 end

data/lib/thor/util.rb

@@ -133,7 +133,7 @@ class Thor
           *pieces, command  = namespace.split(":")
           namespace = pieces.join(":")
           namespace = "default" if namespace.empty?
-          klass = Thor::Base.subclasses.detect { |thor| thor.namespace == namespace && thor.commands.keys.include?(command) }
+          klass = Thor::Base.subclasses.detect { |thor| thor.namespace == namespace && thor.command_exists?(command) }
         end
         unless klass # look for a Thor::Group with the right name
           klass = Thor::Util.find_by_namespace(namespace)

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/thor.rb

@@ -439,6 +439,17 @@ class Thor
       command && disable_required_check.include?(command.name.to_sym)
     end
 
+    # Checks if a specified command exists.
+    #
+    # ==== Parameters
+    # command_name<String>:: The name of the command to check for existence.
+    #
+    # ==== Returns
+    # Boolean:: +true+ if the command exists, +false+ otherwise.
+    def command_exists?(command_name) #:nodoc:
+      commands.keys.include?(normalize_command_name(command_name))
+    end
+
   protected
 
     # Returns this class exclusive options array set.

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thor
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Yehuda Katz
 - José Valim
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,12 +84,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/thor/issues
-  changelog_uri: https://github.com/rails/thor/releases/tag/v1.3.0
+  changelog_uri: https://github.com/rails/thor/releases/tag/v1.4.0
   documentation_uri: http://whatisthor.com/
-  source_code_uri: https://github.com/rails/thor/tree/v1.3.0
+  source_code_uri: https://github.com/rails/thor/tree/v1.4.0
   wiki_uri: https://github.com/rails/thor/wiki
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.4.21
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Thor is a toolkit for building powerful command-line interfaces.
 test_files: []