thor 0.14.6 → 0.19.4

data/lib/thor/actions/create_link.rb

@@ -1,8 +1,7 @@
-require 'thor/actions/create_file'
+require "thor/actions/create_file"
 
 class Thor
   module Actions
-
     # Create a new file relative to the destination root from the given source.
     #
     # ==== Parameters
@@ -15,12 +14,12 @@ class Thor
     #
     #   create_link "config/apache.conf", "/etc/apache.conf"
     #
-    def create_link(destination, *args, &block)
+    def create_link(destination, *args)
       config = args.last.is_a?(Hash) ? args.pop : {}
       source = args.first
       action CreateLink.new(self, destination, source, config)
     end
-    alias :add_link :create_link
+    alias_method :add_link, :create_link
 
     # CreateLink is a subset of CreateFile, which instead of taking a block of
     # data, just takes a source string from the user.
@@ -41,7 +40,7 @@ class Thor
         invoke_with_conflict_check do
           FileUtils.mkdir_p(File.dirname(destination))
           # Create a symlink by default
-          config[:symbolic] ||= true
+          config[:symbolic] = true if config[:symbolic].nil?
           File.unlink(destination) if exists?
           if config[:symbolic]
             File.symlink(render, destination)
@@ -52,6 +51,9 @@ class Thor
         given_destination
       end
 
+      def exists?
+        super || File.symlink?(destination)
+      end
     end
   end
 end

data/lib/thor/actions/directory.rb

@@ -1,14 +1,14 @@
-require 'thor/actions/empty_directory'
+require "thor/actions/empty_directory"
 
 class Thor
   module Actions
-
     # Copies recursively the files from source directory to root directory.
     # If any of the files finishes with .tt, it's considered to be a template
     # and is placed in the destination without the extension .tt. If any
     # empty directory is found, it's copied and all .empty_directory files are
-    # ignored. Remember that file paths can also be encoded, let's suppose a doc
-    # directory with the following files:
+    # ignored. If any file name is wrapped within % signs, the text within
+    # the % signs will be executed as a method and replaced with the returned
+    # value. Let's suppose a doc directory with the following files:
     #
     #   doc/
     #     components/.empty_directory
@@ -29,11 +29,17 @@ class Thor
     #     rdoc.rb
     #     blog.rb
     #
+    # <b>Encoded path note:</b> Since Thor internals use Object#respond_to? to check if it can
+    # expand %something%, this `something` should be a public method in the class calling
+    # #directory. If a method is private, Thor stack raises PrivateMethodEncodedError.
+    #
     # ==== 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.
     #                If :recursive => false, does not look for paths recursively.
+    #                If :mode => :preserve, preserve the file mode from the source.
+    #                If :exclude_pattern => /regexp/, prevents copying files that match that regexp.
     #
     # ==== Examples
     #
@@ -49,10 +55,10 @@ class Thor
     class Directory < EmptyDirectory #:nodoc:
       attr_reader :source
 
-      def initialize(base, source, destination=nil, config={}, &block)
+      def initialize(base, source, destination = nil, config = {}, &block)
         @source = File.expand_path(base.find_in_source_paths(source.to_s))
         @block  = block
-        super(base, destination, { :recursive => true }.merge(config))
+        super(base, destination, {:recursive => true}.merge(config))
       end
 
       def invoke!
@@ -64,30 +70,49 @@ class Thor
         execute!
       end
 
-      protected
+    protected
 
-        def execute!
-          lookup = config[:recursive] ? File.join(source, '**') : source
-          lookup = File.join(lookup, '{*,.[a-z]*}')
+      def execute!
+        lookup = Util.escape_globs(source)
+        lookup = config[:recursive] ? File.join(lookup, "**") : lookup
+        lookup = file_level_lookup(lookup)
 
-          Dir[lookup].sort.each do |file_source|
-            next if File.directory?(file_source)
-            file_destination = File.join(given_destination, file_source.gsub(source, '.'))
-            file_destination.gsub!('/./', '/')
+        files(lookup).sort.each do |file_source|
+          next if File.directory?(file_source)
+          next if config[:exclude_pattern] && file_source.match(config[:exclude_pattern])
+          file_destination = File.join(given_destination, file_source.gsub(source, "."))
+          file_destination.gsub!("/./", "/")
 
-            case file_source
-              when /\.empty_directory$/
-                dirname = File.dirname(file_destination).gsub(/\/\.$/, '')
-                next if dirname == given_destination
-                base.empty_directory(dirname, config)
-              when /\.tt$/
-                destination = base.template(file_source, file_destination[0..-4], config, &@block)
-              else
-                destination = base.copy_file(file_source, file_destination, config, &@block)
-            end
+          case file_source
+          when /\.empty_directory$/
+            dirname = File.dirname(file_destination).gsub(%r{/\.$}, "")
+            next if dirname == given_destination
+            base.empty_directory(dirname, config)
+          when /#{TEMPLATE_EXTNAME}$/
+            base.template(file_source, file_destination[0..-4], config, &@block)
+          else
+            base.copy_file(file_source, file_destination, config, &@block)
           end
         end
+      end
+
+      if RUBY_VERSION < "2.0"
+        def file_level_lookup(previous_lookup)
+          File.join(previous_lookup, "{*,.[a-z]*}")
+        end
 
+        def files(lookup)
+          Dir[lookup]
+        end
+      else
+        def file_level_lookup(previous_lookup)
+          File.join(previous_lookup, "*")
+        end
+
+        def files(lookup)
+          Dir.glob(lookup, File::FNM_DOTMATCH)
+        end
+      end
     end
   end
 end

data/lib/thor/actions/empty_directory.rb

@@ -1,6 +1,5 @@
 class Thor
   module Actions
-
     # Creates an empty directory.
     #
     # ==== Parameters
@@ -11,7 +10,7 @@ class Thor
     #
     #   empty_directory "doc"
     #
-    def empty_directory(destination, config={})
+    def empty_directory(destination, config = {})
       action EmptyDirectory.new(self, destination, config)
     end
 
@@ -32,8 +31,9 @@ class Thor
       # destination<String>:: Relative path to the destination of this file
       # config<Hash>:: give :verbose => false to not log the status.
       #
-      def initialize(base, destination, config={})
-        @base, @config   = base, { :verbose => true }.merge(config)
+      def initialize(base, destination, config = {})
+        @base = base
+        @config = {:verbose => true}.merge(config)
         self.destination = destination
       end
 
@@ -43,7 +43,7 @@ class Thor
       # Boolean:: true if the file exists, false otherwise.
       #
       def exists?
-        ::File.exists?(destination)
+        ::File.exist?(destination)
       end
 
       def invoke!
@@ -58,77 +58,78 @@ class Thor
         given_destination
       end
 
-      protected
+    protected
 
-        # Shortcut for pretend.
-        #
-        def pretend?
-          base.options[:pretend]
-        end
+      # Shortcut for pretend.
+      #
+      def pretend?
+        base.options[:pretend]
+      end
 
-        # Sets the absolute destination value from a relative destination value.
-        # It also stores the given and relative destination. Let's suppose our
-        # script is being executed on "dest", it sets the destination root to
-        # "dest". The destination, given_destination and relative_destination
-        # are related in the following way:
-        #
-        #   inside "bar" do
-        #     empty_directory "baz"
-        #   end
-        #
-        #   destination          #=> dest/bar/baz
-        #   relative_destination #=> bar/baz
-        #   given_destination    #=> baz
-        #
-        def destination=(destination)
-          if destination
-            @given_destination = convert_encoded_instructions(destination.to_s)
-            @destination = ::File.expand_path(@given_destination, base.destination_root)
-            @relative_destination = base.relative_to_original_destination_root(@destination)
-          end
-        end
+      # Sets the absolute destination value from a relative destination value.
+      # It also stores the given and relative destination. Let's suppose our
+      # script is being executed on "dest", it sets the destination root to
+      # "dest". The destination, given_destination and relative_destination
+      # are related in the following way:
+      #
+      #   inside "bar" do
+      #     empty_directory "baz"
+      #   end
+      #
+      #   destination          #=> dest/bar/baz
+      #   relative_destination #=> bar/baz
+      #   given_destination    #=> baz
+      #
+      def destination=(destination)
+        return unless destination
+        @given_destination = convert_encoded_instructions(destination.to_s)
+        @destination = ::File.expand_path(@given_destination, base.destination_root)
+        @relative_destination = base.relative_to_original_destination_root(@destination)
+      end
 
-        # Filenames in the encoded form are converted. If you have a file:
-        #
-        #   %class_name%.rb
-        #
-        # It gets the class name from the base and replace it:
-        #
-        #   user.rb
-        #
-        def convert_encoded_instructions(filename)
-          filename.gsub(/%(.*?)%/) do |string|
-            instruction = $1.strip
-            base.respond_to?(instruction) ? base.send(instruction) : string
-          end
+      # Filenames in the encoded form are converted. If you have a file:
+      #
+      #   %file_name%.rb
+      #
+      # It calls #file_name from the base and replaces %-string with the
+      # return value (should be String) of #file_name:
+      #
+      #   user.rb
+      #
+      # The method referenced can be either public or private.
+      #
+      def convert_encoded_instructions(filename)
+        filename.gsub(/%(.*?)%/) do |initial_string|
+          method = $1.strip
+          base.respond_to?(method, true) ? base.send(method) : initial_string
         end
+      end
 
-        # Receives a hash of options and just execute the block if some
-        # conditions are met.
-        #
-        def invoke_with_conflict_check(&block)
-          if exists?
-            on_conflict_behavior(&block)
-          else
-            say_status :create, :green
-            block.call unless pretend?
-          end
-
-          destination
+      # Receives a hash of options and just execute the block if some
+      # conditions are met.
+      #
+      def invoke_with_conflict_check(&block)
+        if exists?
+          on_conflict_behavior(&block)
+        else
+          say_status :create, :green
+          yield unless pretend?
         end
 
-        # What to do when the destination file already exists.
-        #
-        def on_conflict_behavior(&block)
-          say_status :exist, :blue
-        end
+        destination
+      end
 
-        # Shortcut to say_status shell method.
-        #
-        def say_status(status, color)
-          base.shell.say_status status, relative_destination, color if config[:verbose]
-        end
+      # What to do when the destination file already exists.
+      #
+      def on_conflict_behavior
+        say_status :exist, :blue
+      end
 
+      # Shortcut to say_status shell method.
+      #
+      def say_status(status, color)
+        base.shell.say_status status, relative_destination, color if config[:verbose]
+      end
     end
   end
 end

data/lib/thor/actions/file_manipulation.rb

@@ -1,16 +1,17 @@
-require 'erb'
-require 'open-uri'
+require "erb"
+require "open-uri"
 
 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
     #
@@ -25,9 +26,13 @@ class Thor
 
       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(destination, mode, config)
+      end
     end
 
     # Links the file from the relative source to the relative destination. If
@@ -44,7 +49,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))
@@ -73,11 +78,11 @@ 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 }
+      source = File.expand_path(find_in_source_paths(source.to_s)) unless source =~ %r{^https?\://}
+      render = open(source) { |input| input.binmode.read }
 
       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 +107,14 @@ class Thor
     #
     def template(source, *args, &block)
       config = args.last.is_a?(Hash) ? args.pop : {}
-      destination = args.first || source
+      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
+        content = CapturableERB.new(::File.binread(source), nil, "-", "@output_buffer").result(context)
+        content = yield(content) if block
         content
       end
     end
@@ -123,9 +128,9 @@ 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)
@@ -149,7 +154,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 +176,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,7 +192,7 @@ class Thor
     #
     # ==== Examples
     #
-    #   inject_into_class "app/controllers/application_controller.rb", "  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
     #     "  filter_parameter :password\n"
@@ -195,7 +200,7 @@ class Thor
     #
     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
 
@@ -225,10 +230,48 @@ class Thor
       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
 
+    # 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.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # flag<Regexp|String>:: the regexp or string used to decide which lines to uncomment
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Example
+    #
+    #   uncomment_lines 'config/initializers/session_store.rb', /active_record/
+    #
+    def uncomment_lines(path, flag, *args)
+      flag = flag.respond_to?(:source) ? flag.source : flag
+
+      gsub_file(path, /^(\s*)#[[:blank:]]*(.*#{flag})/, '\1\2', *args)
+    end
+
+    # Comment all lines matching a given regex.  It will leave the space
+    # which existed before the beginning of the line in tact and will insert
+    # a single space after the comment hash.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # flag<Regexp|String>:: the regexp or string used to decide which lines to comment
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Example
+    #
+    #   comment_lines 'config/initializers/session_store.rb', /cookie_store/
+    #
+    def comment_lines(path, flag, *args)
+      flag = flag.respond_to?(:source) ? flag.source : flag
+
+      gsub_file(path, /^(\s*)([^#|\n]*#{flag})/, '\1# \2', *args)
+    end
+
     # Removes a file at the given location.
     #
     # ==== Parameters
@@ -240,31 +283,45 @@ 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)
+      ::FileUtils.rm_rf(path) if !options[:pretend] && File.exist?(path)
     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:
+    def with_output_buffer(buf = "") #:nodoc:
       self.output_buffer, old_buffer = buf, output_buffer
       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} = ''"]
+        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 "thor/actions/empty_directory"
 
 class Thor
   module Actions
-
     # Injects the given content into a file. Different from gsub_file, this
     # method is reversible.
     #
@@ -23,11 +22,8 @@ class Thor
     #   end
     #
     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
       action InjectIntoFile.new(self, destination, data, config)
     end
     alias_method :inject_into_file, :insert_into_file
@@ -36,7 +32,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)]
@@ -74,36 +70,34 @@ class Thor
         replace!(regexp, content, true)
       end
 
-      protected
+    protected
 
-        def say_status(behavior)
-          status = if behavior == :invoke
-            if flag == /\A/
-               :prepend
-            elsif flag == /\z/
-              :append
-            else
-              :insert
-            end
+      def say_status(behavior)
+        status = if behavior == :invoke
+          if flag == /\A/
+            :prepend
+          elsif flag == /\z/
+            :append
           else
-            :subtract
+            :insert
           end
-
-          super(status, config[:verbose])
+        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, config[:verbose])
+      end
 
+      # Adds the content to the file.
+      #
+      def replace!(regexp, string, force)
+        return if 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
   end
 end