thor 0.16.0 → 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30e79d2b0a96e87c8e6348467db577c6ad1e9acbbbac5d375417bc3e5a2b7698
+  data.tar.gz: 701f1ab842da90e599b96bd00d90481d716eb29e39e0283b5ff527c2033fc742
+SHA512:
+  metadata.gz: 73b1ac80575d4422204cd8072950b5594739db3b6f3fde0f2f04359d51b1d4428524d25b9a3003ae9ec3f6be615cf635f3057bbc65558e6a17ba490ff045988b
+  data.tar.gz: eb7761a5e6f3674cb3231398145978b0eb53a6fa2c10e4cb9e99d8d523988efcefc8cae5dd163b8a3d6ead7424422d58b92311c200790ad6e2416e3f9757a90e

data/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+Pull Requests
+-------------
+Here are some reasons why a pull request may not be merged:
+
+1. It hasn’t been reviewed.
+2. It doesn’t include specs for new functionality.
+3. It doesn’t include documentation for new functionality.
+4. It changes behavior without changing the relevant documentation, comments, or specs.
+5. It changes behavior of an existing public API, breaking backward compatibility.
+6. It breaks the tests on a supported platform.
+7. It doesn’t merge cleanly (requiring Git rebasing and conflict resolution).
+
+If you would like to help in this process, you can start by evaluating open pull requests against the criteria above. For example, if a pull request does not include specs for new functionality, you can add a comment like: “If you would like this feature to be added to Thor, please add specs to ensure that it does not break in the future.” This will help move a pull request closer to being merged.
+
+Include this emoji in the top of your ticket to signal to us that you read this file: 🌈

data/README.md

@@ -1,8 +1,10 @@
-[![Build Status](https://secure.travis-ci.org/wycats/thor.png?branch=master)](http://travis-ci.org/wycats/thor)
-
 Thor
 ====
 
+[![Gem Version](http://img.shields.io/gem/v/thor.svg)][gem]
+
+[gem]: https://rubygems.org/gems/thor
+
 Description
 -----------
 Thor is a simple and efficient tool for building self-documenting command line
@@ -11,7 +13,13 @@ utilities.  It removes the pain of parsing command line options, writing
 build tool.  The syntax is Rake-like, so it should be familiar to most Rake
 users.
 
-[rake]: https://github.com/jimweirich/rake
+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
+vector.
+
+[rake]: https://github.com/ruby/rake
+[open-uri]: https://ruby-doc.org/stdlib-2.5.1/libdoc/open-uri/rdoc/index.html
 
 Installation
 ------------
@@ -19,10 +27,19 @@ Installation
 
 Usage and documentation
 -----------------------
-Please see [the wiki](https://github.com/wycats/thor/wiki) for basic usage and other documentation on using Thor.
+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/rails/thor/wiki
+[homepage]: http://whatisthor.com/
+
+Contributing
+------------
+If you would like to help, please read the [CONTRIBUTING][] file for suggestions.
+
+[contributing]: CONTRIBUTING.md
 
 License
 -------
-Released under the MIT License.  See the [LICENSE][license] file for further details.
+Released under the MIT License.  See the [LICENSE][] file for further details.
 
-[license]: https://github.com/wycats/thor/blob/master/LICENSE.md
+[license]: LICENSE.md

data/bin/thor

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # -*- mode: ruby -*-
 
-require 'thor/runner'
+require "thor/runner"
 $thor_runner = true
 Thor::Runner.start

data/lib/thor/actions/create_file.rb

@@ -1,8 +1,7 @@
-require 'thor/actions/empty_directory'
+require_relative "empty_directory"
 
 class Thor
   module Actions
-
     # Create a new file relative to the destination root with the given data,
     # which is the return value of a block or a data string.
     #
@@ -25,7 +24,7 @@ class Thor
       data = args.first
       action CreateFile.new(self, destination, block || data.to_s, config)
     end
-    alias :add_file :create_file
+    alias_method :add_file, :create_file
 
     # CreateFile is a subset of Template, which instead of rendering a file with
     # ERB, it gets the content from the user.
@@ -33,7 +32,7 @@ class Thor
     class CreateFile < EmptyDirectory #:nodoc:
       attr_reader :data
 
-      def initialize(base, destination, data, config={})
+      def initialize(base, destination, data, config = {})
         @data = data
         super(base, destination, config)
       end
@@ -59,47 +58,47 @@ class Thor
 
       def invoke!
         invoke_with_conflict_check do
+          require "fileutils"
           FileUtils.mkdir_p(File.dirname(destination))
-          File.open(destination, 'wb') { |f| f.write render }
+          File.open(destination, "wb") { |f| f.write render }
         end
         given_destination
       end
 
-      protected
-
-        # Now on conflict we check if the file is identical or not.
-        #
-        def on_conflict_behavior(&block)
-          if identical?
-            say_status :identical, :blue
-          else
-            options = base.options.merge(config)
-            force_or_skip_or_conflict(options[:force], options[:skip], &block)
-          end
-        end
+    protected
 
-        # If force is true, run the action, otherwise check if it's not being
-        # skipped. If both are false, show the file_collision menu, if the menu
-        # returns true, force it, otherwise skip.
-        #
-        def force_or_skip_or_conflict(force, skip, &block)
-          if force
-            say_status :force, :yellow
-            block.call unless pretend?
-          elsif skip
-            say_status :skip, :yellow
-          else
-            say_status :conflict, :red
-            force_or_skip_or_conflict(force_on_collision?, true, &block)
-          end
+      # Now on conflict we check if the file is identical or not.
+      #
+      def on_conflict_behavior(&block)
+        if identical?
+          say_status :identical, :blue
+        else
+          options = base.options.merge(config)
+          force_or_skip_or_conflict(options[:force], options[:skip], &block)
         end
+      end
 
-        # Shows the file collision menu to the user and gets the result.
-        #
-        def force_on_collision?
-          base.shell.file_collision(destination){ render }
+      # If force is true, run the action, otherwise check if it's not being
+      # skipped. If both are false, show the file_collision menu, if the menu
+      # returns true, force it, otherwise skip.
+      #
+      def force_or_skip_or_conflict(force, skip, &block)
+        if force
+          say_status :force, :yellow
+          yield unless pretend?
+        elsif skip
+          say_status :skip, :yellow
+        else
+          say_status :conflict, :red
+          force_or_skip_or_conflict(force_on_collision?, true, &block)
         end
+      end
 
+      # Shows the file collision menu to the user and gets the result.
+      #
+      def force_on_collision?
+        base.shell.file_collision(destination) { render }
+      end
     end
   end
 end

data/lib/thor/actions/create_link.rb

@@ -1,8 +1,7 @@
-require 'thor/actions/create_file'
+require_relative "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.
@@ -34,11 +33,13 @@ class Thor
       # Boolean:: true if it is identical, false otherwise.
       #
       def identical?
-        exists? && File.identical?(render, destination)
+        source = File.expand_path(render, File.dirname(destination))
+        exists? && File.identical?(source, destination)
       end
 
       def invoke!
         invoke_with_conflict_check do
+          require "fileutils"
           FileUtils.mkdir_p(File.dirname(destination))
           # Create a symlink by default
           config[:symbolic] = true if config[:symbolic].nil?
@@ -52,6 +53,9 @@ class Thor
         given_destination
       end
 
+      def exists?
+        super || File.symlink?(destination)
+      end
     end
   end
 end

data/lib/thor/actions/directory.rb

@@ -1,4 +1,4 @@
-require 'thor/actions/empty_directory'
+require_relative "empty_directory"
 
 class Thor
   module Actions
@@ -38,6 +38,8 @@ class Thor
     # 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
     #
@@ -53,10 +55,10 @@ class Thor
     class Directory < EmptyDirectory #:nodoc:
       attr_reader :source
 
-      def initialize(base, source, destination=nil, config={}, &block)
-        @source = File.expand_path(base.find_in_source_paths(source.to_s))
+      def initialize(base, source, destination = nil, config = {}, &block)
+        @source = File.expand_path(Dir[Util.escape_globs(base.find_in_source_paths(source.to_s))].first)
         @block  = block
-        super(base, destination, { :recursive => true }.merge(config))
+        super(base, destination, {:recursive => true}.merge(config))
       end
 
       def invoke!
@@ -68,31 +70,39 @@ class Thor
         execute!
       end
 
-      protected
+    protected
 
-        def execute!
-          lookup = Util.escape_globs(source)
-          lookup = config[:recursive] ? File.join(lookup, '**') : lookup
-          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
+
+      def file_level_lookup(previous_lookup)
+        File.join(previous_lookup, "*")
+      end
 
+      def files(lookup)
+        Dir.glob(lookup, File::FNM_DOTMATCH)
+      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,111 +43,101 @@ class Thor
       # Boolean:: true if the file exists, false otherwise.
       #
       def exists?
-        ::File.exists?(destination)
+        ::File.exist?(destination)
       end
 
       def invoke!
         invoke_with_conflict_check do
+          require "fileutils"
           ::FileUtils.mkdir_p(destination)
         end
       end
 
       def revoke!
         say_status :remove, :red
+        require "fileutils"
         ::FileUtils.rm_rf(destination) if !pretend? && exists?
         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:
-        #
-        #   %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 by %-string SHOULD be public. Otherwise you
-        # get the exception with the corresponding error message.
-        #
-        def convert_encoded_instructions(filename)
-          filename.gsub(/%(.*?)%/) do |initial_string|
-            call_public_method($1.strip) or initial_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
 
-        # Calls `base`'s public method `sym`.
-        # Returns:: result of `base.sym` or `nil` if `sym` wasn't found in
-        #  `base`
-        # Raises::  Thor::PrivateMethodEncodedError if `sym` references
-        #  a private method.
-        def call_public_method(sym)
-          if base.respond_to?(sym)
-            base.send(sym)
-          elsif base.respond_to?(sym, true)
-            raise Thor::PrivateMethodEncodedError,
-              "Method #{base.class}##{sym} should be public, not private"
-          else
-            nil
-          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
+          yield unless pretend?
+          say_status :create, :green
         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
-        end
+        destination
+      rescue Errno::EISDIR, Errno::EEXIST
+        on_file_clash_behavior
+      end
 
-        # What to do when the destination file already exists.
-        #
-        def on_conflict_behavior(&block)
-          say_status :exist, :blue
-        end
+      def on_file_clash_behavior
+        say_status :file_clash, :red
+      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