thor 0.15.4 → 0.16.0

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 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
 

data/lib/thor.rb

@@ -321,7 +321,7 @@ class Thor
 
       # receives a (possibly nil) task name and returns a name that is in
       # the tasks hash. In addition to normalizing aliases, this logic
-      # will determine if a shortened command is an unambiguous prefix of
+      # will determine if a shortened command is an unambiguous substring of
       # a task or alias.
       #
       # +normalize_task_name+ also converts names like +animal-prison+
@@ -344,7 +344,7 @@ class Thor
       end
 
       # this is the logic that takes the task name passed in by the user
-      # and determines whether it is an unambiguous prefix of a task or
+      # and determines whether it is an unambiguous substrings of a task or
       # alias name.
       def find_task_possibilities(meth)
         len = meth.to_s.length

data/lib/thor/base.rb

@@ -508,6 +508,7 @@ class Thor
 
               list << item
               list << [ "", "# Default: #{option.default}" ] if option.show_default?
+              list << [ "", "# Possible values: #{option.enum.join(', ')}" ] if option.enum
             end
           end
 

data/lib/thor/parser/argument.rb

@@ -2,7 +2,7 @@ class Thor
   class Argument #:nodoc:
     VALID_TYPES = [ :numeric, :hash, :array, :string ]
 
-    attr_reader :name, :description, :required, :type, :default, :banner
+    attr_reader :name, :description, :enum, :required, :type, :default, :banner
     alias :human_name :name
 
     def initialize(name, options={})
@@ -19,6 +19,7 @@ class Thor
       @type        = (type || :string).to_sym
       @default     = options[:default]
       @banner      = options[:banner] || default_banner
+      @enum        = options[:enum]
 
       validate! # Trigger specific validations
     end
@@ -43,7 +44,11 @@ class Thor
     protected
 
       def validate!
-        raise ArgumentError, "An argument cannot be required and have default value." if required? && !default.nil?
+        if required? && !default.nil?
+          raise ArgumentError, "An argument cannot be required and have default value."
+        elsif @enum && !@enum.is_a?(Array)
+          raise ArgumentError, "An argument cannot have an enum other than an array."
+        end
       end
 
       def valid_type?(type)

data/lib/thor/parser/arguments.rb

@@ -144,7 +144,13 @@ class Thor
         if no_or_skip?(name)
           nil
         else
-          shift
+          value = shift
+          if @switches.is_a?(Hash) && switch = @switches[name]
+            if switch.enum && !switch.enum.include?(value)
+              raise MalformattedArgumentError, "Expected '#{name}' to be one of #{switch.enum.join(', ')}; got #{value}"
+            end
+          end
+          value
         end
       end
 

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.15.4"
+  VERSION = "0.16.0"
 end

data/spec/base_spec.rb

@@ -138,6 +138,11 @@ describe Thor::Base do
       content.should =~ /Foo options\:/
       content.should =~ /--last-name=LAST_NAME/
     end
+
+    it "displays choices for enums" do
+      content = capture(:stdout) { Enum.help(Thor::Base.shell.new) }
+      content.should =~ /Possible values\: apple, banana/
+    end
   end
 
   describe "#namespace" do

data/spec/fixtures/enum.thor

@@ -0,0 +1,10 @@
+class Enum < Thor::Group
+  include Thor::Actions
+
+  desc "snack"
+  class_option "fruit", :aliases => "-f", :type => :string, :enum => %w(apple banana)
+  def snack
+    puts options['fruit']
+  end
+
+end

data/spec/parser/argument_spec.rb

@@ -25,6 +25,12 @@ describe Thor::Argument do
         argument(:task, :type => :string, :default => "bar", :required => true)
       }.should raise_error(ArgumentError, "An argument cannot be required and have default value.")
     end
+
+    it "raises an error if enum isn't an array" do
+      lambda {
+        argument(:task, :type => :string, :enum => "bar")
+      }.should raise_error(ArgumentError, "An argument cannot have an enum other than an array.")
+    end
   end
 
   describe "#usage" do

data/spec/spec_helper.rb

@@ -27,6 +27,7 @@ load File.join(File.dirname(__FILE__), "fixtures", "task.thor")
 load File.join(File.dirname(__FILE__), "fixtures", "group.thor")
 load File.join(File.dirname(__FILE__), "fixtures", "script.thor")
 load File.join(File.dirname(__FILE__), "fixtures", "invoke.thor")
+load File.join(File.dirname(__FILE__), "fixtures", "enum.thor")
 
 RSpec.configure do |config|
   config.before do

data/thor.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   s.extra_rdoc_files = ['CHANGELOG.rdoc', 'LICENSE.md', 'README.md', 'Thorfile']
   s.files = `git ls-files`.split("\n")
-  s.homepage = 'http://github.com/wycats/thor'
+  s.homepage = 'http://whatisthor.com/'
   s.name = 'thor'
   s.rdoc_options = ['--charset=UTF-8']
   s.require_paths = ['lib']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thor
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.16.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2165788460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2165788460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2165787960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +38,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *2165787960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2165787500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2165787500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2165787040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +70,15 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *2165787040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165802940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +86,15 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *2165802940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2165802480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +102,15 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2165802480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: childlabor
-  requirement: &2165802100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +118,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165802100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A scripting framework that replaces rake, sake and rubigen
 email: ruby-thor@googlegroups.com
 executables:
@@ -164,6 +199,7 @@ files:
 - spec/fixtures/doc/components/.empty_directory
 - spec/fixtures/doc/config.rb
 - spec/fixtures/doc/config.yaml.tt
+- spec/fixtures/enum.thor
 - spec/fixtures/group.thor
 - spec/fixtures/invoke.thor
 - spec/fixtures/path with spaces
@@ -187,7 +223,7 @@ files:
 - spec/thor_spec.rb
 - spec/util_spec.rb
 - thor.gemspec
-homepage: http://github.com/wycats/thor
+homepage: http://whatisthor.com/
 licenses: []
 post_install_message: 
 rdoc_options:
@@ -208,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A scripting framework that replaces rake, sake and rubigen
@@ -235,6 +271,7 @@ test_files:
 - spec/fixtures/doc/components/.empty_directory
 - spec/fixtures/doc/config.rb
 - spec/fixtures/doc/config.yaml.tt
+- spec/fixtures/enum.thor
 - spec/fixtures/group.thor
 - spec/fixtures/invoke.thor
 - spec/fixtures/path with spaces