thor 0.18.1 → 0.19.0

data/spec/sandbox/application.rb

@@ -0,0 +1,2 @@
+class Application < Base
+end

data/spec/sandbox/app{1}/README

@@ -0,0 +1,3 @@
+__start__
+README
+__end__

data/spec/sandbox/bundle/execute.rb

@@ -0,0 +1,6 @@
+class Execute < Thor
+  desc "ls", "Execute ls"
+  def ls
+    system "ls"
+  end
+end

data/spec/sandbox/bundle/main.thor

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'execute')

data/spec/sandbox/command.thor

@@ -0,0 +1,10 @@
+# module: random
+
+class Amazing < Thor
+  desc "describe NAME", "say that someone is amazing"
+  method_options :forcefully => :boolean
+  def describe(name, opts)
+    ret = "#{name} is amazing"
+    puts opts["forcefully"] ? ret.upcase : ret
+  end
+end

data/spec/sandbox/doc/%file_name%.rb.tt

@@ -0,0 +1 @@
+FOO = <%= "FOO" %>

data/spec/sandbox/doc/COMMENTER

@@ -0,0 +1,11 @@
+__start__
+ # greenblue
+#
+# yellowblue
+#yellowred
+ #greenred
+orange
+    purple
+  ind#igo
+  # ind#igo
+__end__

data/spec/sandbox/doc/README

@@ -0,0 +1,3 @@
+__start__
+README
+__end__

data/spec/sandbox/doc/block_helper.rb

@@ -0,0 +1,3 @@
+<% world do -%>
+Hello
+<% end -%>

data/spec/sandbox/doc/config.rb

@@ -0,0 +1 @@
+class <%= @klass %>; end

data/spec/sandbox/doc/config.yaml.tt

@@ -0,0 +1 @@
+--- Hi from yaml

data/spec/sandbox/doc/excluding/%file_name%.rb.tt

@@ -0,0 +1 @@
+BAR = <%= "BAR" %>

data/spec/sandbox/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/sandbox/group.thor

@@ -0,0 +1,128 @@
+class MyCounter < Thor::Group
+  include Thor::Actions
+  add_runtime_options!
+
+  def self.get_from_super
+    from_superclass(:get_from_super, 13)
+  end
+
+  source_root File.expand_path(File.dirname(__FILE__))
+  source_paths << File.expand_path("broken", File.dirname(__FILE__))
+
+  argument :first,       :type => :numeric
+  argument :second,      :type => :numeric, :default => 2
+
+  class_option :third,    :type => :numeric, :desc => "The third argument", :default => 3,
+                          :banner => "THREE", :aliases => "-t"
+  class_option :fourth,   :type => :numeric, :desc => "The fourth argument"
+  class_option :simple,   :type => :numeric, :aliases => 'z'
+  class_option :symbolic, :type => :numeric, :aliases => [:y, :r]
+
+  desc <<-FOO
+Description:
+  This generator runs three commands: one, two and three.
+FOO
+
+  def one
+    first
+  end
+
+  def two
+    second
+  end
+
+  def three
+    options[:third]
+  end
+
+  def four
+    options[:fourth]
+  end
+
+  def five
+    options[:simple]
+  end
+
+  def six
+    options[:symbolic]
+  end
+
+  def self.inherited(base)
+    super
+    base.source_paths.unshift(File.expand_path(File.join(File.dirname(__FILE__), "doc")))
+  end
+
+  no_commands do
+    def world(&block)
+      result = capture(&block)
+      concat(result.strip + " world!")
+    end
+  end
+end
+
+class ClearCounter < MyCounter
+  remove_argument :first, :second, :undefine => true
+  remove_class_option :third
+
+  def self.source_root
+    File.expand_path(File.join(File.dirname(__FILE__), "bundle"))
+  end
+end
+
+class BrokenCounter < MyCounter
+  namespace "app:broken:counter"
+  class_option :fail, :type => :boolean, :default => false
+
+  class << self
+    undef_method :source_root
+  end
+
+  def one
+    options[:first]
+  end
+
+  def four
+    respond_to?(:fail)
+  end
+
+  def five
+    options[:fail] ? this_method_does_not_exist : 5
+  end
+end
+
+class WhinyGenerator < Thor::Group
+  include Thor::Actions
+
+  def self.source_root
+    File.expand_path(File.dirname(__FILE__))
+  end
+
+  def wrong_arity(required)
+  end
+end
+
+class CommandConflict < Thor::Group
+  desc "A group with the same name as a default command"
+  def group
+    puts "group"
+  end
+end
+
+class ParentGroup < Thor::Group
+private
+  def foo
+    "foo"
+  end
+
+  def baz(name = 'baz')
+    name
+  end
+end
+
+class ChildGroup < ParentGroup
+  def bar
+    "bar"
+  end
+
+  public_command :foo, :baz
+end

data/spec/sandbox/invoke.thor

@@ -0,0 +1,131 @@
+class A < Thor
+  include Thor::Actions
+
+  desc "one", "invoke one"
+  def one
+    p 1
+    invoke :two
+    invoke :three
+  end
+
+  desc "two", "invoke two"
+  def two
+    p 2
+    invoke :three
+  end
+
+  desc "three", "invoke three"
+  def three
+    p 3
+  end
+
+  desc "four", "invoke four"
+  def four
+    p 4
+    invoke "defined:five"
+  end
+
+  desc "five N", "check if number is equal 5"
+  def five(number)
+    number == 5
+  end
+
+  desc "invoker", "invoke a b command"
+  def invoker(*args)
+    invoke :b, :one, ["Jose"]
+  end
+end
+
+class B < Thor
+  class_option :last_name, :type => :string
+
+  desc "one FIRST_NAME", "invoke one"
+  def one(first_name)
+    "#{options.last_name}, #{first_name}"
+  end
+
+  desc "two", "invoke two"
+  def two
+    options
+  end
+
+  desc "three", "invoke three"
+  def three
+    self
+  end
+
+  desc "four", "invoke four"
+  option :defaulted_value, :type => :string, :default => 'default'
+  def four
+    options.defaulted_value
+  end
+end
+
+class C < Thor::Group
+  include Thor::Actions
+
+  def one
+    p 1
+  end
+
+  def two
+    p 2
+  end
+
+  def three
+    p 3
+  end
+end
+
+class Defined < Thor::Group
+  class_option :unused, :type => :boolean, :desc => "This option has no use"
+
+  def one
+    p 1
+    invoke "a:two"
+    invoke "a:three"
+    invoke "a:four"
+    invoke "defined:five"
+  end
+
+  def five
+    p 5
+  end
+
+  def print_status
+    say_status :finished, :counting
+  end
+end
+
+class E < Thor::Group
+  invoke Defined
+end
+
+class F < Thor::Group
+  invoke "b:one" do |instance, klass, command|
+    instance.invoke klass, command, [ "Jose" ], :last_name => "Valim"
+  end
+end
+
+class G < Thor::Group
+  class_option :invoked, :type => :string, :default => "defined"
+  invoke_from_option :invoked
+end
+
+class H < Thor::Group
+  class_option :defined, :type => :boolean, :default => true
+  invoke_from_option :defined
+end
+
+class I < Thor
+  desc "two", "Two"
+  def two
+    current_command_chain
+  end
+end
+
+class J < Thor
+  desc "i", "I"
+  subcommand :one, I
+end
+

data/spec/sandbox/preserve/script.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exit 0

data/spec/sandbox/script.thor

@@ -0,0 +1,220 @@
+class MyScript < Thor
+  check_unknown_options! :except => :with_optional
+
+  attr_accessor :some_attribute
+  attr_writer :another_attribute
+  attr_reader :another_attribute
+
+  private
+  attr_reader :private_attribute
+
+  public
+  group :script
+  default_command :example_default_command
+
+  map "-T" => :animal, ["-f", "--foo"] => :foo
+
+  map "animal_prison" => "zoo"
+
+  desc "zoo", "zoo around"
+  def zoo
+    true
+  end
+
+  desc "animal TYPE", "horse around"
+
+  no_commands do
+    def this_is_not_a_command
+    end
+  end
+
+  def animal(type)
+    [type]
+  end
+
+  map "hid" => "hidden"
+
+  desc "hidden TYPE", "this is hidden", :hide => true
+  def hidden(type)
+    [type]
+  end
+
+  map "fu" => "zoo"
+
+  desc "foo BAR", <<END
+do some fooing
+  This is more info!
+  Everyone likes more info!
+END
+  method_option :force, :type => :boolean, :desc => "Force to do some fooing"
+  def foo(bar)
+    [bar, options]
+  end
+
+  desc "example_default_command", "example!"
+  method_options :with => :string
+  def example_default_command
+    options.empty? ? "default command" : options
+  end
+
+  desc "call_myself_with_wrong_arity", "get the right error"
+  def call_myself_with_wrong_arity
+    call_myself_with_wrong_arity(4)
+  end
+
+  desc "call_unexistent_method", "Call unexistent method inside a command"
+  def call_unexistent_method
+    boom!
+  end
+
+  desc "long_description", "a" * 80
+  long_desc <<-D
+    This is a really really really long description.
+    Here you go. So very long.
+
+    It even has two paragraphs.
+  D
+  def long_description
+  end
+
+  desc "name-with-dashes", "Ensure normalization of command names"
+  def name_with_dashes
+  end
+
+  method_options :all => :boolean
+  method_option :lazy, :lazy_default => "yes"
+  method_option :lazy_numeric, :type => :numeric, :lazy_default => 42
+  method_option :lazy_array,   :type => :array,   :lazy_default => %w[eat at joes]
+  method_option :lazy_hash,    :type => :hash,    :lazy_default => {'swedish' => 'meatballs'}
+  desc "with_optional NAME", "invoke with optional name"
+  def with_optional(name=nil, *args)
+    [name, options, args]
+  end
+
+  class AnotherScript < Thor
+    desc "baz", "do some bazing"
+    def baz
+    end
+  end
+
+  desc "send", "send as a command name"
+  def send
+    true
+  end
+
+  private
+
+    def method_missing(meth, *args)
+      if meth == :boom!
+        super
+      else
+        [meth, args]
+      end
+    end
+
+    desc "what", "what"
+    def what
+    end
+end
+
+class MyChildScript < MyScript
+  remove_command :bar
+
+  method_options :force => :boolean, :param => :numeric
+  def initialize(*args)
+    super
+  end
+
+  desc "zoo", "zoo around"
+  method_options :param => :required
+  def zoo
+    options
+  end
+
+  desc "animal TYPE", "horse around"
+  def animal(type)
+    [type, options]
+  end
+  method_option :other, :type => :string, :default => "method default", :for => :animal
+  desc "animal KIND", "fish around", :for => :animal
+
+  desc "boom", "explodes everything"
+  def boom
+  end
+
+  remove_command :boom, :undefine => true
+end
+
+class Barn < Thor
+  desc "open [ITEM]", "open the barn door"
+  def open(item = nil)
+    if item == "shotgun"
+      puts "That's going to leave a mark."
+    else
+      puts "Open sesame!"
+    end
+  end
+
+  desc "paint [COLOR]", "paint the barn"
+  method_option :coats, :type => :numeric, :default => 2, :desc => 'how many coats of paint'
+  def paint(color='red')
+    puts "#{options[:coats]} coats of #{color} paint"
+  end
+end
+
+class PackageNameScript < Thor
+  package_name "Baboon"
+end
+
+module Scripts
+  class MyScript < MyChildScript
+    argument :accessor, :type => :string
+    class_options :force => :boolean
+    method_option :new_option, :type => :string, :for => :example_default_command
+
+    def zoo
+      self.accessor
+    end
+  end
+
+  class MyDefaults < Thor
+    check_unknown_options!
+
+    namespace :default
+    desc "cow", "prints 'moo'"
+    def cow
+      puts "moo"
+    end
+
+    desc "command_conflict", "only gets called when prepended with a colon"
+    def command_conflict
+      puts "command"
+    end
+
+    desc "barn", "commands to manage the barn"
+    subcommand "barn", Barn
+  end
+
+  class ChildDefault < Thor
+    namespace "default:child"
+  end
+
+  class Arities < Thor
+    desc "zero_args", "takes zero args"
+    def zero_args
+    end
+
+    desc "one_arg ARG", "takes one arg"
+    def one_arg(arg)
+    end
+
+    desc "two_args ARG1 ARG2", "takes two args"
+    def two_args(arg1, arg2)
+    end
+
+    desc "optional_arg [ARG]", "takes an optional arg"
+    def optional_arg(arg='default')
+    end
+  end
+end
+