thor 0.16.0 → 1.2.1

data/lib/thor/actions/file_manipulation.rb

@@ -1,16 +1,16 @@
-require 'erb'
-require 'open-uri'
+require "erb"
 
 class Thor
   module Actions
-
     # Copies the file from the relative source to the relative destination. If
     # the destination is not given it's assumed to be equal to the source.
     #
     # ==== Parameters
     # source<String>:: the relative path to the source root.
     # 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
+    #                :mode => :preserve, to preserve the file mode from the source.
+
     #
     # ==== Examples
     #
@@ -23,11 +23,15 @@ class Thor
       destination = args.first || source
       source = File.expand_path(find_in_source_paths(source.to_s))
 
-      create_file destination, nil, config do
+      resulting_destination = create_file destination, nil, config do
         content = File.binread(source)
-        content = block.call(content) if block
+        content = yield(content) if block
         content
       end
+      if config[:mode] == :preserve
+        mode = File.stat(source).mode
+        chmod(resulting_destination, mode, config)
+      end
     end
 
     # Links the file from the relative source to the relative destination. If
@@ -44,7 +48,7 @@ class Thor
     #
     #   link_file "doc/README"
     #
-    def link_file(source, *args, &block)
+    def link_file(source, *args)
       config = args.last.is_a?(Hash) ? args.pop : {}
       destination = args.first || source
       source = File.expand_path(find_in_source_paths(source.to_s))
@@ -56,6 +60,9 @@ class Thor
     # destination. If a block is given instead of destination, the content of
     # the url is yielded and used as location.
     #
+    # +get+ relies on open-uri, so passing application user input would provide
+    # a command injection attack vector.
+    #
     # ==== Parameters
     # source<String>:: the address of the given content.
     # destination<String>:: the relative path to the destination root.
@@ -73,11 +80,16 @@ class Thor
       config = args.last.is_a?(Hash) ? args.pop : {}
       destination = args.first
 
-      source = File.expand_path(find_in_source_paths(source.to_s)) unless source =~ /^https?\:\/\//
-      render = open(source) {|input| input.binmode.read }
+      render = if source =~ %r{^https?\://}
+        require "open-uri"
+        URI.send(:open, source) { |input| input.binmode.read }
+      else
+        source = File.expand_path(find_in_source_paths(source.to_s))
+        open(source) { |input| input.binmode.read }
+      end
 
       destination ||= if block_given?
-        block.arity == 1 ? block.call(render) : block.call
+        block.arity == 1 ? yield(render) : yield
       else
         File.basename(source)
       end
@@ -102,14 +114,22 @@ class Thor
     #
     def template(source, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      destination = args.first || source.sub(/\.tt$/, '')
+      destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/, "")
 
       source  = File.expand_path(find_in_source_paths(source.to_s))
-      context = instance_eval('binding')
+      context = config.delete(:context) || instance_eval("binding")
 
       create_file destination, nil, config do
-        content = ERB.new(::File.binread(source), nil, '-', '@output_buffer').result(context)
-        content = block.call(content) if block
+        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
+        content = capturable_erb.tap do |erb|
+          erb.filename = source
+        end.result(context)
+        content = yield(content) if block
         content
       end
     end
@@ -123,13 +143,16 @@ class Thor
     #
     # ==== Example
     #
-    #   chmod "script/*", 0755
+    #   chmod "script/server", 0755
     #
-    def chmod(path, mode, config={})
+    def chmod(path, mode, config = {})
       return unless behavior == :invoke
       path = File.expand_path(path, destination_root)
       say_status :chmod, relative_to_original_destination_root(path), config.fetch(:verbose, true)
-      FileUtils.chmod_R(mode, path) unless options[:pretend]
+      unless options[:pretend]
+        require "fileutils"
+        FileUtils.chmod_R(mode, path)
+      end
     end
 
     # Prepend text to a file. Since it depends on insert_into_file, it's reversible.
@@ -149,7 +172,7 @@ class Thor
     #
     def prepend_to_file(path, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      config.merge!(:after => /\A/)
+      config[:after] = /\A/
       insert_into_file(path, *(args << config), &block)
     end
     alias_method :prepend_file, :prepend_to_file
@@ -171,7 +194,7 @@ class Thor
     #
     def append_to_file(path, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      config.merge!(:before => /\z/)
+      config[:before] = /\z/
       insert_into_file(path, *(args << config), &block)
     end
     alias_method :append_file, :append_to_file
@@ -187,15 +210,38 @@ 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
     #
     def inject_into_class(path, klass, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      config.merge!(:after => /class #{klass}\n|class #{klass} .*\n/)
+      config[:after] = /class #{klass}\n|class #{klass} .*\n/
+      insert_into_file(path, *(args << config), &block)
+    end
+
+    # Injects text right after the module definition. Since it depends on
+    # insert_into_file, it's reversible.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # module_name<String|Class>:: the module to be manipulated
+    # data<String>:: the data to append to the class, can be also given as a block.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper", "  def help; 'help'; end\n"
+    #
+    #   inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper" do
+    #     "  def help; 'help'; end\n"
+    #   end
+    #
+    def inject_into_module(path, module_name, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      config[:after] = /module #{module_name}\n|module #{module_name} .*\n/
       insert_into_file(path, *(args << config), &block)
     end
 
@@ -205,7 +251,8 @@ class Thor
     # 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.
+    # config<Hash>:: give :verbose => false to not log the status, and
+    #                :force => true, to force the replacement regardles of runner behavior.
     #
     # ==== Example
     #
@@ -216,16 +263,17 @@ class Thor
     #   end
     #
     def gsub_file(path, flag, *args, &block)
-      return unless behavior == :invoke
       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)
 
       unless options[:pretend]
         content = File.binread(path)
         content.gsub!(flag, *args, &block)
-        File.open(path, 'wb') { |file| file.write(content) }
+        File.open(path, "wb") { |file| file.write(content) }
       end
     end
 
@@ -245,7 +293,7 @@ class Thor
     def uncomment_lines(path, flag, *args)
       flag = flag.respond_to?(:source) ? flag.source : flag
 
-      gsub_file(path, /^(\s*)#\s*(.*#{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
@@ -264,7 +312,7 @@ class Thor
     def comment_lines(path, flag, *args)
       flag = flag.respond_to?(:source) ? flag.source : flag
 
-      gsub_file(path, /^(\s*)([^#|\n]*#{flag})/, '\1# \2', *args)
+      gsub_file(path, /^(\s*)([^#\n]*#{flag})/, '\1# \2', *args)
     end
 
     # Removes a file at the given location.
@@ -278,31 +326,50 @@ class Thor
     #   remove_file 'README'
     #   remove_file 'app/controllers/application_controller.rb'
     #
-    def remove_file(path, config={})
+    def remove_file(path, config = {})
       return unless behavior == :invoke
-      path  = File.expand_path(path, destination_root)
+      path = File.expand_path(path, destination_root)
 
       say_status :remove, relative_to_original_destination_root(path), config.fetch(:verbose, true)
-      ::FileUtils.rm_rf(path) if !options[:pretend] && File.exists?(path)
+      if !options[:pretend] && (File.exist?(path) || File.symlink?(path))
+        require "fileutils"
+        ::FileUtils.rm_rf(path)
+      end
     end
-    alias :remove_dir :remove_file
+    alias_method :remove_dir, :remove_file
 
-  private
     attr_accessor :output_buffer
+    private :output_buffer, :output_buffer=
+
+  private
+
     def concat(string)
       @output_buffer.concat(string)
     end
 
-    def capture(*args, &block)
-      with_output_buffer { block.call(*args) }
+    def capture(*args)
+      with_output_buffer { yield(*args) }
     end
 
-    def with_output_buffer(buf = '') #:nodoc:
-      self.output_buffer, old_buffer = buf, output_buffer
+    def with_output_buffer(buf = "".dup) #:nodoc:
+      raise ArgumentError, "Buffer can not be a frozen object" if buf.frozen?
+      old_buffer = output_buffer
+      self.output_buffer = buf
       yield
       output_buffer
     ensure
       self.output_buffer = old_buffer
     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
+      def set_eoutvar(compiler, eoutvar = "_erbout")
+        compiler.put_cmd = "#{eoutvar}.concat"
+        compiler.insert_cmd = "#{eoutvar}.concat"
+        compiler.pre_cmd = ["#{eoutvar} = ''.dup"]
+        compiler.post_cmd = [eoutvar]
+      end
+    end
   end
 end

data/lib/thor/actions/inject_into_file.rb

@@ -1,8 +1,7 @@
-require 'thor/actions/empty_directory'
+require_relative "empty_directory"
 
 class Thor
   module Actions
-
     # Injects the given content into a file. Different from gsub_file, this
     # method is reversible.
     #
@@ -22,12 +21,14 @@ class Thor
     #     gems.split(" ").map{ |gem| "  config.gem :#{gem}" }.join("\n")
     #   end
     #
+    WARNINGS = { unchanged_no_flag: 'File unchanged! The supplied flag value not found!' }
+
     def insert_into_file(destination, *args, &block)
-      if block_given?
-        data, config = block, args.shift
-      else
-        data, config = args.shift, args.shift
-      end
+      data = block_given? ? block : args.shift
+
+      config = args.shift || {}
+      config[:after] = /\z/ unless config.key?(:before) || config.key?(:after)
+
       action InjectIntoFile.new(self, destination, data, config)
     end
     alias_method :inject_into_file, :insert_into_file
@@ -36,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)]
@@ -49,15 +50,23 @@ class Thor
       end
 
       def invoke!
-        say_status :invoke
-
         content = if @behavior == :after
           '\0' + replacement
         else
           replacement + '\0'
         end
 
-        replace!(/#{flag}/, content, config[:force])
+        if exists?
+          if replace!(/#{flag}/, content, config[:force])
+            say_status(:invoke)
+          else
+            say_status(:unchanged, warning: WARNINGS[:unchanged_no_flag], color: :red)
+          end
+        else
+          unless pretend?
+            raise Thor::Error, "The file #{ destination } does not appear to exist"
+          end
+        end
       end
 
       def revoke!
@@ -74,36 +83,37 @@ class Thor
         replace!(regexp, content, true)
       end
 
-      protected
-
-        def say_status(behavior)
-          status = if behavior == :invoke
-            if flag == /\A/
-               :prepend
-            elsif flag == /\z/
-              :append
-            else
-              :insert
-            end
+    protected
+
+      def say_status(behavior, warning: nil, color: nil)
+        status = if behavior == :invoke
+          if flag == /\A/
+            :prepend
+          elsif flag == /\z/
+            :append
           else
-            :subtract
+            :insert
           end
-
-          super(status, config[:verbose])
+        elsif warning
+          warning
+        else
+          :subtract
         end
 
-        # Adds the content to the file.
-        #
-        def replace!(regexp, string, force)
-          unless base.options[:pretend]
-            content = File.binread(destination)
-            if force || !content.include?(replacement)
-              content.gsub!(regexp, string)
-              File.open(destination, 'wb') { |file| file.write(content) }
-            end
-          end
-        end
+        super(status, (color || config[:verbose]))
+      end
+
+      # Adds the content to the file.
+      #
+      def replace!(regexp, string, force)
+        content = File.read(destination)
+        if force || !content.include?(replacement)
+          success = content.gsub!(regexp, string)
 
+          File.open(destination, "wb") { |file| file.write(content) } unless pretend?
+          success
+        end
+      end
     end
   end
 end