thor 0.9.9 → 0.11.5

metadata

@@ -1,53 +1,72 @@
 --- !ruby/object:Gem::Specification 
 name: thor
 version: !ruby/object:Gem::Version 
-  version: 0.9.9
+  version: 0.11.5
 platform: ruby
 authors: 
 - Yehuda Katz
+- "Jos\xC3\xA9 Valim"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-12-15 00:00:00 -08:00
+date: 2009-08-05 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: A gem that maps options to a class
-email: wycats@gmail.com
+description: A scripting framework that replaces rake, sake and rubigen
+email: ruby-thor@googlegroups.com
 executables: 
 - thor
 - rake2thor
 extensions: []
 
 extra_rdoc_files: 
-- README.markdown
-- LICENSE
 - CHANGELOG.rdoc
-files: 
-- README.markdown
 - LICENSE
+- README.rdoc
+- Thorfile
+- VERSION
+files: 
 - CHANGELOG.rdoc
-- Rakefile
+- LICENSE
+- README.rdoc
+- Thorfile
+- VERSION
 - bin/rake2thor
 - bin/thor
-- lib/thor
+- lib/thor.rb
+- lib/thor/actions.rb
+- lib/thor/actions/create_file.rb
+- lib/thor/actions/directory.rb
+- lib/thor/actions/empty_directory.rb
+- lib/thor/actions/file_manipulation.rb
+- lib/thor/actions/inject_into_file.rb
+- lib/thor/base.rb
+- lib/thor/core_ext/hash_with_indifferent_access.rb
+- lib/thor/core_ext/ordered_hash.rb
 - lib/thor/error.rb
-- lib/thor/options.rb
-- lib/thor/ordered_hash.rb
+- lib/thor/group.rb
+- lib/thor/invocation.rb
+- lib/thor/parser.rb
+- lib/thor/parser/argument.rb
+- lib/thor/parser/arguments.rb
+- lib/thor/parser/option.rb
+- lib/thor/parser/options.rb
+- lib/thor/rake_compat.rb
 - lib/thor/runner.rb
+- lib/thor/shell.rb
+- lib/thor/shell/basic.rb
+- lib/thor/shell/color.rb
 - lib/thor/task.rb
-- lib/thor/task_hash.rb
-- lib/thor/tasks
-- lib/thor/tasks/package.rb
-- lib/thor/tasks.rb
 - lib/thor/util.rb
-- lib/thor.rb
 has_rdoc: true
 homepage: http://yehudakatz.com
-post_install_message: 
-rdoc_options: []
+licenses: []
 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -64,10 +83,35 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: thor
-rubygems_version: 1.3.1
+rubyforge_project: textmate
+rubygems_version: 1.3.2
 signing_key: 
-specification_version: 2
-summary: A gem that maps options to a class
-test_files: []
-
+specification_version: 3
+summary: A scripting framework that replaces rake, sake and rubigen
+test_files: 
+- spec/rake_compat_spec.rb
+- spec/actions/directory_spec.rb
+- spec/actions/empty_directory_spec.rb
+- spec/actions/create_file_spec.rb
+- spec/actions/inject_into_file_spec.rb
+- spec/actions/file_manipulation_spec.rb
+- spec/shell_spec.rb
+- spec/invocation_spec.rb
+- spec/base_spec.rb
+- spec/task_spec.rb
+- spec/spec_helper.rb
+- spec/actions_spec.rb
+- spec/shell/basic_spec.rb
+- spec/shell/color_spec.rb
+- spec/group_spec.rb
+- spec/thor_spec.rb
+- spec/fixtures/doc/config.rb
+- spec/fixtures/bundle/execute.rb
+- spec/util_spec.rb
+- spec/parser/argument_spec.rb
+- spec/parser/option_spec.rb
+- spec/parser/options_spec.rb
+- spec/parser/arguments_spec.rb
+- spec/runner_spec.rb
+- spec/core_ext/ordered_hash_spec.rb
+- spec/core_ext/hash_with_indifferent_access_spec.rb

data/README.markdown

@@ -1,76 +0,0 @@
-thor
-====
-
-Map options to a class. Simply create a class with the appropriate annotations, and have options automatically map
-to functions and parameters.
-
-Example:
-
-    class MyApp < Thor                                                # [1]
-      map "-L" => :list                                               # [2]
-                                                                    
-      desc "install APP_NAME", "install one of the available apps"    # [3]
-      method_options :force => :boolean, :alias => :optional          # [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
-    
-Thor automatically maps commands as such:
-
-    app install myname --force
-    
-That gets converted to:
-
-    MyApp.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. These will be marshaled from `--` and `-` params.
-    In this case, a `--force` and a `-f` option is added.
-    
-Types for `method_options`
---------------------------
-
-<dl>
-  <dt><code>:boolean</code></dt>
-    <dd>true if the option is passed</dd>
-  <dt><code>true</code></dt>
-    <dd>same as <code>:boolean</code></dd>
-  <dt><code>:required</code></dt>
-    <dd>the value for this option MUST be provided</dd>
-  <dt><code>:optional</code></dt>
-    <dd>the value for this option MAY be provided</dd>
-  <dt><code>:numeric</code></dt>
-    <dd>the value MAY be provided, but MUST be in numeric form</dd>
-  <dt>a String or Numeric</dt>
-    <dd>same as <code>:optional</code>, but fall back to the given object as default value</dd>
-</dl>
-
-In case of unsatisfied requirements, `Thor::Options::Error` is raised.
-
-Examples of option parsing:
-
-    # let's say this is how we defined options for a method:
-    method_options(:force => :boolean, :retries => :numeric)
-    
-    # here is how the following command-line invocations would be parsed:
-    
-    command -f --retries 5    # => {'force' => true, 'retries' => 5}
-    command --force -r=5      # => {'force' => true, 'retries' => 5}
-    command -fr 5             # => {'force' => true, 'retries' => 5}
-    command --retries=5       # => {'retries' => 5}
-    command -r5               # => {'retries' => 5}

data/Rakefile

@@ -1,6 +0,0 @@
-task :default => :install
-
-desc "install the gem locally"
-task :install do
-  sh %{ruby "#{File.dirname(__FILE__)}/bin/thor" :install}
-end

data/lib/thor/options.rb

@@ -1,242 +0,0 @@
-# This is a modified version of Daniel Berger's Getopt::Long class,
-# licensed under Ruby's license.
-
-class Thor
-  class Options
-    class Error < StandardError; end
-    
-    # simple Hash with indifferent access
-    class Hash < ::Hash
-      def initialize(hash)
-        super()
-        update hash
-      end
-      
-      def [](key)
-        super convert_key(key)
-      end
-      
-      def values_at(*indices)
-        indices.collect { |key| self[convert_key(key)] }
-      end
-      
-      protected
-        def convert_key(key)
-          key.kind_of?(Symbol) ? key.to_s : key
-        end
-        
-        # Magic predicates. For instance:
-        #   options.force? # => !!options['force']
-        def method_missing(method, *args, &block)
-          method.to_s =~ /^(\w+)\?$/ ? !!self[$1] : super
-        end
-    end
-
-    NUMERIC     = /(\d*\.\d+|\d+)/
-    LONG_RE     = /^(--\w+[-\w+]*)$/
-    SHORT_RE    = /^(-[a-z])$/i
-    EQ_RE       = /^(--\w+[-\w+]*|-[a-z])=(.*)$/i
-    SHORT_SQ_RE = /^-([a-z]{2,})$/i # Allow either -x -v or -xv style for single char args
-    SHORT_NUM   = /^(-[a-z])#{NUMERIC}$/i
-    
-    attr_reader :leading_non_opts, :trailing_non_opts
-    
-    def non_opts
-      leading_non_opts + trailing_non_opts
-    end
-
-    # Takes an array of switches. Each array consists of up to three
-    # elements that indicate the name and type of switch. Returns a hash
-    # containing each switch name, minus the '-', as a key. The value
-    # for each key depends on the type of switch and/or the value provided
-    # by the user.
-    #
-    # The long switch _must_ be provided. The short switch defaults to the
-    # first letter of the short switch. The default type is :boolean.
-    #
-    # Example:
-    #
-    #   opts = Thor::Options.new(
-    #      "--debug" => true,
-    #      ["--verbose", "-v"] => true,
-    #      ["--level", "-l"] => :numeric
-    #   ).parse(args)
-    #
-    def initialize(switches)
-      @defaults = {}
-      @shorts = {}
-      
-      @leading_non_opts, @trailing_non_opts = [], []
-
-      @switches = switches.inject({}) do |mem, (name, type)|
-        if name.is_a?(Array)
-          name, *shorts = name
-        else
-          name = name.to_s
-          shorts = []
-        end
-        # we need both nice and dasherized form of switch name
-        if name.index('-') == 0
-          nice_name = undasherize name
-        else
-          nice_name = name
-          name = dasherize name
-        end
-        # if there are no shortcuts specified, generate one using the first character
-        shorts << "-" + nice_name[0,1] if shorts.empty? and nice_name.length > 1
-        shorts.each { |short| @shorts[short] = name }
-        
-        # normalize type
-        case type
-        when TrueClass then type = :boolean
-        when String
-          @defaults[nice_name] = type
-          type = :optional
-        when Numeric
-          @defaults[nice_name] = type
-          type = :numeric
-        end
-        
-        mem[name] = type
-        mem
-      end
-      
-      # remove shortcuts that happen to coincide with any of the main switches
-      @shorts.keys.each do |short|
-        @shorts.delete(short) if @switches.key?(short)
-      end
-    end
-
-    def parse(args, skip_leading_non_opts = true)
-      @args = args
-      # start with Thor::Options::Hash pre-filled with defaults
-      hash = Hash.new @defaults
-      
-      @leading_non_opts = []
-      if skip_leading_non_opts
-        @leading_non_opts << shift until current_is_option? || @args.empty?
-      end
-
-      while current_is_option?
-        case shift
-        when SHORT_SQ_RE
-          unshift $1.split('').map { |f| "-#{f}" }
-          next
-        when EQ_RE, SHORT_NUM
-          unshift $2
-          switch = $1
-        when LONG_RE, SHORT_RE
-          switch = $1
-        end
-        
-        switch    = normalize_switch(switch)
-        nice_name = undasherize(switch)
-        type      = switch_type(switch)
-        
-        case type
-        when :required
-          assert_value!(switch)
-          raise Error, "cannot pass switch '#{peek}' as an argument" if valid?(peek)
-          hash[nice_name] = shift
-        when :optional
-          hash[nice_name] = peek.nil? || valid?(peek) || shift
-        when :boolean
-          hash[nice_name] = true
-        when :numeric
-          assert_value!(switch)
-          unless peek =~ NUMERIC and $& == peek
-            raise Error, "expected numeric value for '#{switch}'; got #{peek.inspect}"
-          end
-          hash[nice_name] = $&.index('.') ? shift.to_f : shift.to_i
-        end
-      end
-      
-      @trailing_non_opts = @args
-
-      check_required! hash
-      hash.freeze
-      hash
-    end
-    
-    def formatted_usage
-      return "" if @switches.empty?
-      @switches.map do |opt, type|
-        case type
-        when :boolean
-          "[#{opt}]"
-        when :required
-          opt + "=" + opt.gsub(/\-/, "").upcase
-        else
-          sample = @defaults[undasherize(opt)]
-          sample ||= case type
-            when :optional then undasherize(opt).gsub(/\-/, "_").upcase
-            when :numeric  then "N"
-            end
-          "[" + opt + "=" + sample.to_s + "]"
-        end
-      end.join(" ")
-    end
-    
-    alias :to_s :formatted_usage
-
-    private
-    
-    def assert_value!(switch)
-      raise Error, "no value provided for argument '#{switch}'" if peek.nil?
-    end
-    
-    def undasherize(str)
-      str.sub(/^-{1,2}/, '')
-    end
-    
-    def dasherize(str)
-      (str.length > 1 ? "--" : "-") + str
-    end
-    
-    def peek
-      @args.first
-    end
-
-    def shift
-      @args.shift
-    end
-
-    def unshift(arg)
-      unless arg.kind_of?(Array)
-        @args.unshift(arg)
-      else
-        @args = arg + @args
-      end
-    end
-    
-    def valid?(arg)
-      @switches.key?(arg) or @shorts.key?(arg)
-    end
-
-    def current_is_option?
-      case peek
-      when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM
-        valid?($1)
-      when SHORT_SQ_RE
-        $1.split('').any? { |f| valid?("-#{f}") }
-      end
-    end
-    
-    def normalize_switch(switch)
-      @shorts.key?(switch) ? @shorts[switch] : switch
-    end
-    
-    def switch_type(switch)
-      @switches[switch]
-    end
-    
-    def check_required!(hash)
-      for name, type in @switches
-        if type == :required and !hash[undasherize(name)]
-          raise Error, "no value provided for required argument '#{name}'"
-        end
-      end
-    end
-    
-  end
-end