thor 0.18.1 → 0.19.0

data/lib/thor/shell/html.rb

@@ -1,4 +1,4 @@
-require 'thor/shell/basic'
+require "thor/shell/basic"
 
 class Thor
   module Shell
@@ -10,38 +10,38 @@ class Thor
       BOLD       = "font-weight: bold"
 
       # Set the terminal's foreground HTML color to black.
-      BLACK      = 'color: black'
+      BLACK      = "color: black"
       # Set the terminal's foreground HTML color to red.
-      RED        = 'color: red'
+      RED        = "color: red"
       # Set the terminal's foreground HTML color to green.
-      GREEN      = 'color: green'
+      GREEN      = "color: green"
       # Set the terminal's foreground HTML color to yellow.
-      YELLOW     = 'color: yellow'
+      YELLOW     = "color: yellow"
       # Set the terminal's foreground HTML color to blue.
-      BLUE       = 'color: blue'
+      BLUE       = "color: blue"
       # Set the terminal's foreground HTML color to magenta.
-      MAGENTA    = 'color: magenta'
+      MAGENTA    = "color: magenta"
       # Set the terminal's foreground HTML color to cyan.
-      CYAN       = 'color: cyan'
+      CYAN       = "color: cyan"
       # Set the terminal's foreground HTML color to white.
-      WHITE      = 'color: white'
+      WHITE      = "color: white"
 
       # Set the terminal's background HTML color to black.
-      ON_BLACK   = 'background-color: black'
+      ON_BLACK   = "background-color: black"
       # Set the terminal's background HTML color to red.
-      ON_RED     = 'background-color: red'
+      ON_RED     = "background-color: red"
       # Set the terminal's background HTML color to green.
-      ON_GREEN   = 'background-color: green'
+      ON_GREEN   = "background-color: green"
       # Set the terminal's background HTML color to yellow.
-      ON_YELLOW  = 'background-color: yellow'
+      ON_YELLOW  = "background-color: yellow"
       # Set the terminal's background HTML color to blue.
-      ON_BLUE    = 'background-color: blue'
+      ON_BLUE    = "background-color: blue"
       # Set the terminal's background HTML color to magenta.
-      ON_MAGENTA = 'background-color: magenta'
+      ON_MAGENTA = "background-color: magenta"
       # Set the terminal's background HTML color to cyan.
-      ON_CYAN    = 'background-color: cyan'
+      ON_CYAN    = "background-color: cyan"
       # Set the terminal's background HTML color to white.
-      ON_WHITE   = 'background-color: white'
+      ON_WHITE   = "background-color: white"
 
       # Set color by using a string or one of the defined constants. If a third
       # option is set to true, it also adds bold to the string. This is based
@@ -67,61 +67,60 @@ class Thor
       # ask("What is your name?")
       #
       # TODO: Implement #ask for Thor::Shell::HTML
-      def ask(statement, color=nil)
-        raise NotImplementedError, "Implement #ask for Thor::Shell::HTML"
+      def ask(statement, color = nil)
+        fail NotImplementedError, "Implement #ask for Thor::Shell::HTML"
       end
 
-      protected
+    protected
 
-        def can_display_colors?
-          true
-        end
+      def can_display_colors?
+        true
+      end
 
-        # Overwrite show_diff to show diff with colors if Diff::LCS is
-        # available.
-        #
-        def show_diff(destination, content) #:nodoc:
-          if diff_lcs_loaded? && ENV['THOR_DIFF'].nil? && ENV['RAILS_DIFF'].nil?
-            actual  = File.binread(destination).to_s.split("\n")
-            content = content.to_s.split("\n")
+      # Overwrite show_diff to show diff with colors if Diff::LCS is
+      # available.
+      #
+      def show_diff(destination, content) #:nodoc:
+        if diff_lcs_loaded? && ENV["THOR_DIFF"].nil? && ENV["RAILS_DIFF"].nil?
+          actual  = File.binread(destination).to_s.split("\n")
+          content = content.to_s.split("\n")
 
-            Diff::LCS.sdiff(actual, content).each do |diff|
-              output_diff_line(diff)
-            end
-          else
-            super
+          Diff::LCS.sdiff(actual, content).each do |diff|
+            output_diff_line(diff)
           end
+        else
+          super
         end
+      end
 
-        def output_diff_line(diff) #:nodoc:
-          case diff.action
-          when '-'
-            say "- #{diff.old_element.chomp}", :red, true
-          when '+'
-            say "+ #{diff.new_element.chomp}", :green, true
-          when '!'
-            say "- #{diff.old_element.chomp}", :red, true
-            say "+ #{diff.new_element.chomp}", :green, true
-          else
-            say "  #{diff.old_element.chomp}", nil, true
-          end
+      def output_diff_line(diff) #:nodoc:
+        case diff.action
+        when "-"
+          say "- #{diff.old_element.chomp}", :red, true
+        when "+"
+          say "+ #{diff.new_element.chomp}", :green, true
+        when "!"
+          say "- #{diff.old_element.chomp}", :red, true
+          say "+ #{diff.new_element.chomp}", :green, true
+        else
+          say "  #{diff.old_element.chomp}", nil, true
         end
+      end
 
-        # Check if Diff::LCS is loaded. If it is, use it to create pretty output
-        # for diff.
-        #
-        def diff_lcs_loaded? #:nodoc:
-          return true  if defined?(Diff::LCS)
-          return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
+      # Check if Diff::LCS is loaded. If it is, use it to create pretty output
+      # for diff.
+      #
+      def diff_lcs_loaded? #:nodoc:
+        return true  if defined?(Diff::LCS)
+        return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
 
-          @diff_lcs_loaded = begin
-            require 'diff/lcs'
-            true
-          rescue LoadError
-            false
-          end
+        @diff_lcs_loaded = begin
+          require "diff/lcs"
+          true
+        rescue LoadError
+          false
         end
-
+      end
     end
   end
 end

data/lib/thor/util.rb

@@ -1,4 +1,4 @@
-require 'rbconfig'
+require "rbconfig"
 
 class Thor
   module Sandbox #:nodoc:
@@ -15,9 +15,7 @@ class Thor
   #   Thor::Util.load_thorfile("~/.thor/foo")
   #
   module Util
-
     class << self
-
       # Receives a namespace and search for it in the Thor::Base subclasses.
       #
       # ==== Parameters
@@ -25,7 +23,7 @@ class Thor
       #
       def find_by_namespace(namespace)
         namespace = "default#{namespace}" if namespace.empty? || namespace =~ /^:/
-        Thor::Base.subclasses.find { |klass| klass.namespace == namespace }
+        Thor::Base.subclasses.detect { |klass| klass.namespace == namespace }
       end
 
       # Receives a constant and converts it to a Thor namespace. Since Thor
@@ -57,7 +55,7 @@ class Thor
       # ==== Returns
       # Array[Object]
       #
-      def namespaces_in_content(contents, file=__FILE__)
+      def namespaces_in_content(contents, file = __FILE__)
         old_constants = Thor::Base.subclasses.dup
         Thor::Base.subclasses.clear
 
@@ -66,7 +64,7 @@ class Thor
         new_constants = Thor::Base.subclasses.dup
         Thor::Base.subclasses.replace(old_constants)
 
-        new_constants.map!{ |c| c.namespace }
+        new_constants.map! { |c| c.namespace }
         new_constants.compact!
         new_constants
       end
@@ -77,7 +75,7 @@ class Thor
         stringfied_constants = klass.constants.map { |c| c.to_s }
         Thor::Base.subclasses.select do |subclass|
           next unless subclass.name
-          stringfied_constants.include?(subclass.name.gsub("#{klass.name}::", ''))
+          stringfied_constants.include?(subclass.name.gsub("#{klass.name}::", ""))
         end
       end
 
@@ -91,8 +89,8 @@ class Thor
       #
       def snake_case(str)
         return str.downcase if str =~ /^[A-Z_]+$/
-        str.gsub(/\B[A-Z]/, '_\&').squeeze('_') =~ /_*(.*)/
-        return $+.downcase
+        str.gsub(/\B[A-Z]/, '_\&').squeeze("_") =~ /_*(.*)/
+        $+.downcase
       end
 
       # Receives a string and convert it to camel case. camel_case returns CamelCase.
@@ -105,7 +103,7 @@ class Thor
       #
       def camel_case(str)
         return str if str !~ /_/ && str =~ /[A-Z]+.*/
-        str.split('_').map { |i| i.capitalize }.join
+        str.split("_").map { |i| i.capitalize }.join
       end
 
       # Receives a namespace and tries to retrieve a Thor or Thor::Group class
@@ -131,7 +129,7 @@ class Thor
       # namespace<String>
       #
       def find_class_and_command_by_namespace(namespace, fallback = true)
-        if namespace.include?(?:) # look for a namespaced command
+        if namespace.include?(":") # look for a namespaced command
           pieces  = namespace.split(":")
           command = pieces.pop
           klass   = Thor::Util.find_by_namespace(pieces.join(":"))
@@ -141,21 +139,21 @@ class Thor
         end
         if !klass && fallback # try a command in the default namespace
           command = namespace
-          klass   = Thor::Util.find_by_namespace('')
+          klass   = Thor::Util.find_by_namespace("")
         end
-        return klass, command
+        [klass, command]
       end
-      alias find_class_and_task_by_namespace find_class_and_command_by_namespace
+      alias_method :find_class_and_task_by_namespace, :find_class_and_command_by_namespace
 
       # Receives a path and load the thor file in the path. The file is evaluated
       # inside the sandbox to avoid namespacing conflicts.
       #
-      def load_thorfile(path, content=nil, debug=false)
+      def load_thorfile(path, content = nil, debug = false)
         content ||= File.binread(path)
 
         begin
           Thor::Sandbox.class_eval(content, path)
-        rescue Exception => e
+        rescue StandardError => e
           $stderr.puts("WARNING: unable to load thorfile #{path.inspect}: #{e.message}")
           if debug
             $stderr.puts(*e.backtrace)
@@ -165,7 +163,7 @@ class Thor
         end
       end
 
-      def user_home
+      def user_home # rubocop:disable MethodLength
         @@user_home ||= if ENV["HOME"]
           ENV["HOME"]
         elsif ENV["USERPROFILE"]
@@ -190,7 +188,7 @@ class Thor
       # Returns the root where thor files are located, depending on the OS.
       #
       def thor_root
-        File.join(user_home, ".thor").gsub(/\\/, '/')
+        File.join(user_home, ".thor").gsub(/\\/, "/")
       end
 
       # Returns the files in the thor root. On Windows thor_root will be something
@@ -218,17 +216,17 @@ class Thor
       # Return the path to the ruby interpreter taking into account multiple
       # installations and windows extensions.
       #
-      def ruby_command
+      def ruby_command # rubocop:disable MethodLength
         @ruby_command ||= begin
-          ruby_name = RbConfig::CONFIG['ruby_install_name']
-          ruby = File.join(RbConfig::CONFIG['bindir'], ruby_name)
-          ruby << RbConfig::CONFIG['EXEEXT']
+          ruby_name = RbConfig::CONFIG["ruby_install_name"]
+          ruby = File.join(RbConfig::CONFIG["bindir"], ruby_name)
+          ruby << RbConfig::CONFIG["EXEEXT"]
 
           # avoid using different name than ruby (on platforms supporting links)
-          if ruby_name != 'ruby' && File.respond_to?(:readlink)
+          if ruby_name != "ruby" && File.respond_to?(:readlink)
             begin
-              alternate_ruby = File.join(RbConfig::CONFIG['bindir'], 'ruby')
-              alternate_ruby << RbConfig::CONFIG['EXEEXT']
+              alternate_ruby = File.join(RbConfig::CONFIG["bindir"], "ruby")
+              alternate_ruby << RbConfig::CONFIG["EXEEXT"]
 
               # ruby is a symlink
               if File.symlink? alternate_ruby
@@ -237,7 +235,7 @@ class Thor
                 # symlink points to 'ruby_install_name'
                 ruby = alternate_ruby if linked_ruby == ruby_name || linked_ruby == ruby
               end
-            rescue NotImplementedError
+            rescue NotImplementedError # rubocop:disable HandleExceptions
               # just ignore on windows
             end
           end
@@ -264,7 +262,6 @@ class Thor
       def escape_globs(path)
         path.to_s.gsub(/[*?{}\[\]]/, '\\\\\\&')
       end
-
     end
   end
 end

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.18.1"
+  VERSION = "0.19.0"
 end

data/spec/actions/create_file_spec.rb

@@ -1,17 +1,17 @@
-require 'helper'
-require 'thor/actions'
+require "helper"
+require "thor/actions"
 
 describe Thor::Actions::CreateFile do
   before do
+    @silence = false
     ::FileUtils.rm_rf(destination_root)
   end
 
-  def create_file(destination=nil, config={}, options={})
-    @base = MyCounter.new([1, 2], options, { :destination_root => destination_root })
-    @base.stub!(:file_name).and_return('rdoc')
+  def create_file(destination = nil, config = {}, options = {})
+    @base = MyCounter.new([1, 2], options, :destination_root => destination_root)
+    allow(@base).to receive(:file_name).and_return("rdoc")
 
-    @action = Thor::Actions::CreateFile.new(@base, destination, "CONFIGURATION",
-                                            { :verbose => !@silence }.merge(config))
+    @action = Thor::Actions::CreateFile.new(@base, destination, "CONFIGURATION", {:verbose => !@silence}.merge(config))
   end
 
   def invoke!
@@ -30,13 +30,13 @@ describe Thor::Actions::CreateFile do
     it "creates a file" do
       create_file("doc/config.rb")
       invoke!
-      expect(File.exists?(File.join(destination_root, "doc/config.rb"))).to be_true
+      expect(File.exist?(File.join(destination_root, "doc/config.rb"))).to be true
     end
 
     it "does not create a file if pretending" do
       create_file("doc/config.rb", {}, :pretend => true)
       invoke!
-      expect(File.exists?(File.join(destination_root, "doc/config.rb"))).to be_false
+      expect(File.exist?(File.join(destination_root, "doc/config.rb"))).to be false
     end
 
     it "shows created status to the user" do
@@ -59,7 +59,7 @@ describe Thor::Actions::CreateFile do
     it "converts encoded instructions" do
       create_file("doc/%file_name%.rb.tt")
       invoke!
-      expect(File.exists?(File.join(destination_root, "doc/rdoc.rb.tt"))).to be_true
+      expect(File.exist?(File.join(destination_root, "doc/rdoc.rb.tt"))).to be true
     end
 
     describe "when file exists" do
@@ -78,7 +78,7 @@ describe Thor::Actions::CreateFile do
 
       describe "and is not identical" do
         before do
-          File.open(File.join(destination_root, 'doc/config.rb'), 'w'){ |f| f.write("FOO = 3") }
+          File.open(File.join(destination_root, "doc/config.rb"), "w") { |f| f.write("FOO = 3") }
         end
 
         it "shows forced status to the user if force is given" do
@@ -101,34 +101,32 @@ describe Thor::Actions::CreateFile do
           expect(invoke!).to eq("        skip  doc/config.rb\n")
         end
 
-        it "shows conflict status to ther user" do
+        it "shows conflict status to the user" do
+          file = File.join(destination_root, "doc/config.rb")
           expect(create_file("doc/config.rb")).not_to be_identical
-          $stdin.should_receive(:gets).and_return('s')
-          file = File.join(destination_root, 'doc/config.rb')
+          expect(Thor::LineEditor).to receive(:readline).with("Overwrite #{file}? (enter \"h\" for help) [Ynaqdh] ", anything).and_return("s")
 
           content = invoke!
           expect(content).to match(/conflict  doc\/config\.rb/)
-          expect(content).to match(/Overwrite #{file}\? \(enter "h" for help\) \[Ynaqdh\]/)
           expect(content).to match(/skip  doc\/config\.rb/)
         end
 
         it "creates the file if the file collision menu returns true" do
           create_file("doc/config.rb")
-          $stdin.should_receive(:gets).and_return('y')
+          expect(Thor::LineEditor).to receive(:readline).and_return("y")
           expect(invoke!).to match(/force  doc\/config\.rb/)
         end
 
         it "skips the file if the file collision menu returns false" do
           create_file("doc/config.rb")
-          $stdin.should_receive(:gets).and_return('n')
+          expect(Thor::LineEditor).to receive(:readline).and_return("n")
           expect(invoke!).to match(/skip  doc\/config\.rb/)
         end
 
         it "executes the block given to show file content" do
           create_file("doc/config.rb")
-          $stdin.should_receive(:gets).and_return('d')
-          $stdin.should_receive(:gets).and_return('n')
-          @base.shell.should_receive(:system).with(/diff -u/)
+          expect(Thor::LineEditor).to receive(:readline).and_return("d", "n")
+          expect(@base.shell).to receive(:system).with(/diff -u/)
           invoke!
         end
       end
@@ -140,31 +138,31 @@ describe Thor::Actions::CreateFile do
       create_file("doc/config.rb")
       invoke!
       revoke!
-      expect(File.exists?(@action.destination)).to be_false
+      expect(File.exist?(@action.destination)).to be false
     end
 
     it "does not raise an error if the file does not exist" do
       create_file("doc/config.rb")
       revoke!
-      expect(File.exists?(@action.destination)).to be_false
+      expect(File.exist?(@action.destination)).to be false
     end
   end
 
   describe "#exists?" do
     it "returns true if the destination file exists" do
       create_file("doc/config.rb")
-      expect(@action.exists?).to be_false
+      expect(@action.exists?).to be false
       invoke!
-      expect(@action.exists?).to be_true
+      expect(@action.exists?).to be true
     end
   end
 
   describe "#identical?" do
-    it "returns true if the destination file and is identical" do
+    it "returns true if the destination file exists and is identical" do
       create_file("doc/config.rb")
-      expect(@action.identical?).to be_false
+      expect(@action.identical?).to be false
       invoke!
-      expect(@action.identical?).to be_true
+      expect(@action.identical?).to be true
     end
   end
 end