thor 0.14.6 → 0.19.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fd71663b46487af27e6f0b6a0206f5140d0d196
+  data.tar.gz: d67e482d506417552648630f8a7bc4b1886fc06c
+SHA512:
+  metadata.gz: f15702a93adea15d623fd708962193b42bc38bf2b86dff66fe43f1078971fc38f5dedff0d6a78bd1bf9241315e83ede0c216ffedea8c452c55b57aff17d0d051
+  data.tar.gz: 1e7093648f0913e9c7e32c796ea795e819ca59331588885059bfcae9867172ea50144033c342d22c4d5c8ab628f135821bb9a0ab8645f7784c396482370b98c0

data/.document

@@ -0,0 +1,5 @@
+lib/*.rb
+lib/**/*.rb
+-
+CHANGELOG.rdoc
+LICENSE.md

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,8 +1,82 @@
-== 0.14, released 2010-07-25
-
-* Added CreateLink class and #link_file method 
+## 0.19.1, release 2014-03-24
+* Fix `say` non-String break regression
+
+## 0.19.0, release 2014-03-22
+* Add support for a default to #ask
+* Avoid @namespace not initialized warning
+* Avoid private attribute? warning
+* Fix initializing with unknown options
+* Loosen required_rubygems_version for compatibility with Ubuntu 10.04
+* Shell#ask: support a noecho option for stdin
+* Shell#ask: change API to be :echo => false
+* Display a message without a stack trace for ambiguous commands
+* Make say and say_status thread safe
+* Dependency for console io version check
+* Alias --help to help on subcommands
+* Use mime-types 1.x for Ruby 1.8.7 compatibility for Ruby 1.8 only
+* Accept .tt files as templates
+* Check if numeric value is in enum
+* Use Readline for user input
+* Fix dispatching of subcommands (concerning :help and *args)
+* Fix warnings when running specs with `$VERBOSE = true`
+* Make subcommand help more consistent
+* Make the current command chain accessible in command
+
+## 0.18.1, release 2013-03-30
+* Revert regressions found in 0.18.0
+
+## 0.18.0, release 2013-03-26
+* Remove rake2thor
+* Only display colors if output medium supports colors
+* Pass parent_options to subcommands
+* Fix non-dash-prefixed aliases
+* Make error messages more helpful
+* Rename "task" to "command"
+* Add the method to allow for custom package name
+
+## 0.17.0, release 2013-01-24
+* Add better support for tasks that accept arbitrary additional arguments (e.g. things like `bundle exec`)
+* Add #stop_on_unknown_option!
+* Only strip from stdin.gets if it wasn't ended with EOF
+* Allow "send" as a task name
+* Allow passing options as arguments after "--"
+* Autoload Thor::Group
+
+## 0.16.0, release 2012-08-14
+* Add enum to string arguments
+
+## 0.15.4, release 2012-06-29
+* Fix regression when destination root contains reserved regexp characters
+
+## 0.15.3, release 2012-06-18
+* Support strict_args_position! for backwards compatibility
+* Escape Dir glob characters in paths
+
+## 0.15.2, released 2012-05-07
+* Added print_in_columns
+* Exposed terminal_width as a public API
+
+## 0.15.1, release 2012-05-06
+* Fix Ruby 1.8 truncation bug with unicode chars
+* Fix shell delegate methods to pass their block
+* Don't output trailing spaces when printing the last column in a table
+
+## 0.15, released 2012-04-29
+* Alias method_options to options
+* Refactor say to allow multiple colors
+* Exposed error as a public API
+* Exposed file_collision as a public API
+* Exposed print_wrapped as a public API
+* Exposed set_color as a public API
+* Fix number-formatting bugs in print_table
+* Fix "indent" typo in print_table
+* Fix Errno::EPIPE when piping tasks to `head`
+* More friendly error messages
+
+## 0.14, released 2010-07-25
+* Added CreateLink class and #link_file method
 * Made Thor::Actions#run use system as default method for system calls
-* Allow use of private methods from superclass as tasks 
+* Allow use of private methods from superclass as tasks
 * Added mute(&block) method which allows to run block without any output
 * Removed config[:pretend]
 * Enabled underscores for command line switches
@@ -10,8 +84,7 @@
 * Deprecated invoke() without arguments
 * Added :only and :except to check_unknown_options
 
-== 0.13, released 2010-02-03
-
+## 0.13, released 2010-02-03
 * Added :lazy_default which is only triggered if a switch is given
 * Added Thor::Shell::HTML
 * Added subcommands
@@ -19,8 +92,7 @@
 * Added check_unknown_options! in case you want error messages to be raised in valid switches
 * run(command) should return the results of command
 
-== 0.12, released 2010-01-02
-
+## 0.12, released 2010-01-02
 * Methods generated by attr_* are automatically not marked as tasks
 * inject_into_file does not add the same content twice, unless :force is set
 * Removed rr in favor to rspec mock framework
@@ -28,53 +100,42 @@
 * [#7] Do not force white color on status
 * [#8] Yield a block with the filename on directory
 
-== 0.11, released 2009-07-01
-
+## 0.11, released 2009-07-01
 * Added a rake compatibility layer. It allows you to use spec and rdoc tasks on
   Thor classes.
-
 * BACKWARDS INCOMPATIBLE: aliases are not generated automatically anymore
   since it may cause wrong behavior in the invocation system.
-
 * thor help now show information about any class/task. All those calls are
   possible:
-  
-    thor help describe
-    thor help describe:amazing
 
+      thor help describe
+      thor help describe:amazing
   Or even with default namespaces:
 
-    thor help :spec
-
+      thor help :spec
 * Thor::Runner now invokes the default task if none is supplied:
 
-    thor describe # invokes the default task, usually help
-
+      thor describe # invokes the default task, usually help
 * Thor::Runner now works with mappings:
 
-    thor describe -h
-
+      thor describe -h
 * Added some documentation and code refactoring.
 
-== 0.9.8, released 2008-10-20
-
+## 0.9.8, released 2008-10-20
 * Fixed some tiny issues that were introduced lately.
 
-== 0.9.7, released 2008-10-13
-
+## 0.9.7, released 2008-10-13
 * Setting global method options on the initialize method works as expected:
   All other tasks will accept these global options in addition to their own.
 * Added 'group' notion to Thor task sets (class Thor); by default all tasks
   are in the 'standard' group. Running 'thor -T' will only show the standard
   tasks - adding --all will show all tasks. You can also filter on a specific
   group using the --group option: thor -T --group advanced
-  
-== 0.9.6, released 2008-09-13
 
+## 0.9.6, released 2008-09-13
 * Generic improvements
 
-== 0.9.5, released 2008-08-27
-
+## 0.9.5, released 2008-08-27
 * Improve Windows compatibility
 * Update (incorrect) README and task.thor sample file
 * Options hash is now frozen (once returned)
@@ -85,8 +146,7 @@
 * Don't write options for nil or false values. This allows, for example, turning color off when running specs.
 * Exit with the status of the spec command to help CI stuff out some.
 
-== 0.9.4, released 2008-08-13
-
+## 0.9.4, released 2008-08-13
 * Try to add Windows compatibility.
 * BACKWARDS INCOMPATIBLE: options hash is now accessed as a property in your class and is not passed as last argument anymore
 * Allow options at the beginning of the argument list as well as the end.

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/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Yehuda Katz
+Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,307 +1,47 @@
-# Thor 
+Thor
+====
 
-## Description
+[![Gem Version](http://img.shields.io/gem/v/thor.svg)][gem]
+[![Build Status](http://img.shields.io/travis/erikhuda/thor.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/erikhuda/thor.svg)][gemnasium]
+[![Code Climate](http://img.shields.io/codeclimate/github/erikhuda/thor.svg)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/erikhuda/thor.svg)][coveralls]
 
-Thor is a simple and efficient tool for building self-documenting command line utilities.  It removes the pain of parsing command line options, writing "USAGE:" banners, and can also be used as an alternative to the [Rake](http://github.com/jimweirich/rake) build tool.  The syntax is Rake-like, so it should be familiar to most Rake users. 
+[gem]: https://rubygems.org/gems/thor
+[travis]: http://travis-ci.org/erikhuda/thor
+[gemnasium]: https://gemnasium.com/erikhuda/thor
+[codeclimate]: https://codeclimate.com/github/erikhuda/thor
+[coveralls]: https://coveralls.io/r/erikhuda/thor
 
-## Installation
+Description
+-----------
+Thor is a simple and efficient tool for building self-documenting command line
+utilities.  It removes the pain of parsing command line options, writing
+"USAGE:" banners, and can also be used as an alternative to the [Rake][rake]
+build tool.  The syntax is Rake-like, so it should be familiar to most Rake
+users.
 
-$ gem install thor
+[rake]: https://github.com/ruby/rake
 
-or
+Installation
+------------
+    gem install thor
 
-$ gem install wycats-thor -s http://gems.github.com
+Usage and documentation
+-----------------------
+Please see the [wiki][] for basic usage and other documentation on using Thor. You can also checkout the [official homepage][homepage].
 
-## Usage
+[wiki]: https://github.com/erikhuda/thor/wiki
+[homepage]: http://whatisthor.com/
 
-Map options to a class.  Simply create a class with the appropriate annotations
-and have options automatically map to functions and parameters.  
+Contributing
+------------
+If you would like to help, please read the [CONTRIBUTING][] file for suggestions.
 
-Example:
+[contributing]: CONTRIBUTING.md
 
-    class App < Thor                                                 # [1]
-      map "-L" => :list                                              # [2]
-      
-      desc "install APP_NAME", "install one of the available apps"   # [3]
-      method_options :force => :boolean, :alias => :string           # [4]
-      def install(name)
-        user_alias = options[:alias]
-        if options.force?
-          # do something
-        end
-        # other code
-      end
-      
-      desc "list [SEARCH]", "list all of the available apps, limited by SEARCH"
-      def list(search="")
-        # list everything
-      end
-    end
+License
+-------
+Released under the MIT License.  See the [LICENSE][] file for further details.
 
-Thor automatically maps commands as such: 
-
-    thor app:install myname --force
-
-That gets converted to:
-
-    App.new.install("myname")
-    # with {'force' => true} as options hash
-
-1. Inherit from Thor to turn a class into an option mapper.  
-2. Map additional non-valid identifiers to specific methods.  In this case, convert -L to :list
-3. Describe the method immediately below.  The first parameter is the usage information, and the second parameter is the description.  
-4. Provide any additional options that will be available the instance method options.  
-
-## Types for <tt>method_options</tt>
-
-* :boolean - is parsed as <tt>--option</tt> or <tt>--option=true</tt>
-* :string  - is parsed as <tt>--option=VALUE</tt>
-* :numeric - is parsed as <tt>--option=N</tt>
-* :array   - is parsed as <tt>--option=one two three</tt>
-* :hash    - is parsed as <tt>--option=name:string age:integer</tt>
-
-Besides, method_option allows a default value to be given.  Examples:
-
-    method_options :force => false
-    #=> Creates a boolean option with default value false
-
-    method_options :alias => "bar"
-    #=> Creates a string option with default value "bar"
-
-    method_options :threshold => 3.0
-    #=> Creates a numeric option with default value 3.0
-
-You can also supply <tt>:option => :required</tt> to mark an option as required.  The
-type is assumed to be string.  If you want a required hash with default values
-as option, you can use <tt>method_option</tt> which uses a more declarative style:
-
-    method_option :attributes, :type => :hash, :default => {}, :required => true
-
-All arguments can be set to nil (except required arguments), by suppling a no or
-skip variant.  For example: 
-
-    thor app name --no-attributes
-
-In previous versions, aliases for options were created automatically, but now
-they should be explicit.  You can supply aliases in both short and declarative
-styles:
-
-    method_options %w( force -f ) => :boolean
-
-Or:
-
-    method_option :force, :type => :boolean, :aliases => "-f"
-
-You can supply as many aliases as you want.
-
-NOTE: Type :optional available in Thor 0.9.0 was deprecated. Use :string or :boolean instead.
-
-## Namespaces
-
-By default, your Thor tasks are invoked using Ruby namespace.  In the example
-above, tasks are invoked as:
-
-    thor app:install name --force
-
-However, you could namespace your class as:
-
-    module Sinatra
-      class App < Thor
-        # tasks
-      end
-    end
-
-And then you should invoke your tasks as:
-
-    thor sinatra:app:install name --force
-
-If desired, you can change the namespace:
-
-    module Sinatra
-      class App < Thor
-        namespace :myapp
-        # tasks
-      end
-    end
-
-And then your tasks should be invoked as:
-
-    thor myapp:install name --force
-
-## Invocations
-
-Thor comes with a invocation-dependency system as well, which allows a task to be invoked only once.  For example:
-
-    class Counter < Thor
-      desc "one", "Prints 1, 2, 3"
-      def one
-        puts 1
-        invoke :two
-        invoke :three
-      end
-      
-      desc "two", "Prints 2, 3"
-      def two
-        puts 2
-        invoke :three
-      end
-      
-      desc "three", "Prints 3"
-      def three
-        puts 3
-      end
-    end
-
-When invoking the task one:
-
-    thor counter:one
-
-The output is "1 2 3", which means that the three task was invoked only once.  
-You can even invoke tasks from another class, so be sure to check the
-[documentation](http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor.html).
-
-Notice invocations do not share the same object. I.e, Thor will instantiate Counter once to invoke the task one, then, it instantiates another to invoke the task two and another for task three. This happens to allow options and arguments to parsed again. For example, if two and three have different options and both of them were given to the command line, calling invoke makes them be parsed each time and used accordingly by each task.
-
-## Thor::Group
-
-Thor has a special class called Thor::Group.  The main difference to Thor class
-is that it invokes all tasks at once.  The example above could be rewritten in
-Thor::Group as this:
-
-    class Counter < Thor::Group
-      desc "Prints 1, 2, 3"
-      
-      def one
-        puts 1
-      end
-     
-      def two
-        puts 2
-      end
-      
-      def three
-        puts 3
-      end
-    end
-
-When invoked:
-
-    thor counter
-
-It prints "1 2 3" as well.  Notice you should describe (using the method <tt>desc</tt>)
-only the class and not each task anymore.  Thor::Group is a great tool to create
-generators, since you can define several steps which are invoked in the order they
-are defined (Thor::Group is the tool use in generators in Rails 3.0). 
-
-Besides, Thor::Group can parse arguments and options as Thor tasks: 
-
-    class Counter < Thor::Group
-      # number will be available as attr_accessor
-      argument :number, :type => :numeric, :desc => "The number to start counting"
-      desc "Prints the 'number' given upto 'number+2'"
-      
-      def one
-        puts number + 0
-      end
-      
-      def two
-        puts number + 1
-      end
-      
-      def three
-        puts number + 2
-      end
-    end
-
-The counter above expects one parameter and has the folling outputs:
-
-    thor counter 5
-    # Prints "5 6 7"
-
-    thor counter 11
-    # Prints "11 12 13"
-
-You can also give options to Thor::Group, but instead of using <tt>method_option</tt>
-and <tt>method_options</tt>, you should use <tt>class_option</tt> and <tt>class_options</tt>.
-Both argument and class_options methods are available to Thor class as well.
-
-## Actions
-
-Thor comes with several actions which helps with script and generator tasks.  You
-might be familiar with them since some came from Rails Templates.  They are:
-<tt>say</tt>, <tt>ask</tt>, <tt>yes?</tt>, <tt>no?</tt>, <tt>add_file</tt>,
-<tt>remove_file</tt>, <tt>copy_file</tt>, <tt>template</tt>, <tt>directory</tt>,
-<tt>inside</tt>, <tt>run</tt>, <tt>inject_into_file</tt> and a couple more. 
-
-To use them, you just need to include Thor::Actions in your Thor classes:
-
-    class App < Thor
-      include Thor::Actions
-      # tasks
-    end
-
-Some actions like copy file requires that a class method called source_root is
-defined in your class.  This is the directory where your templates should be
-placed.  Be sure to check the documentation on [actions](http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor/Actions.html).
-
-## Generators
-
-A great use for Thor is creating custom generators.  Combining Thor::Group,
-Thor::Actions and ERB templates makes this very easy.  Here is an example:
-
-    class Newgem < Thor::Group
-      include Thor::Actions
-
-      # Define arguments and options
-      argument :name
-      class_option :test_framework, :default => :test_unit
-
-      def self.source_root
-        File.dirname(__FILE__)
-      end
-
-      def create_lib_file
-        template('templates/newgem.tt', "#{name}/lib/#{name}.rb")
-      end
-
-      def create_test_file
-        test = options[:test_framework] == "rspec" ? :spec : :test
-        create_file "#{name}/#{test}/#{name}_#{test}.rb"
-      end
-
-      def copy_licence
-        if yes?("Use MIT license?")
-          # Make a copy of the MITLICENSE file at the source root
-          copy_file "MITLICENSE", "#{name}/MITLICENSE"
-        else
-          say "Shame on you…", :red
-        end
-      end
-    end
-
-Doing a <tt>thor -T</tt> will show how to run our generator.  It should read:
-<tt>thor newgem NAME</tt>.  This shows that we have to supply a NAME
-argument for our generator to run.
-
-The <tt>create_lib_file</tt> uses an ERB template. This is what it looks like:
-
-    class <%= name.capitalize %>
-    end
-
-The arguments that you set in your generator will automatically be passed in
-when <tt>template</tt> gets called.  Be sure to read the [documentation](http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor/Actions.html) for
-more options.
-
-Running the generator with <tt>thor newgem devise</tt> will
-create two files: "devise/lib/devise.rb", and "devise/test/devise_test.rb".  The user will then be asked (via a prompt by the <tt>yes?</tt> method) whether or not they would like to copy the MIT License.  If you want to change the test framework, you can add the option: <tt>thor newgem devise --test-framework=rspec</tt> 
-
-This will generate two files - "devise/lib/devise.rb" and "devise/spec/devise_spec.rb".
-
-## Further Reading
-
-Thor offers many scripting possibilities beyond these examples.  Be sure to read
-through the [documentation](http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor.html) and [specs](http://github.com/wycats/thor/tree/master/spec/) to get a better understanding of the options available. 
-
-## License
-
-Released under the MIT License.  See the LICENSE file for further details. 
+[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 "thor/actions/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
@@ -60,46 +59,45 @@ class Thor
       def invoke!
         invoke_with_conflict_check do
           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