Evoke

# Prints a friendly message to the console.
#
# This comment actually does something. The first line is used as a short
# description when `evoke help` or `evoke` is called without any arguments.
# The rest of the comment is printed, along with the first line, when
# `evoke help hello_world` is called to pull up help about this specific task.
class HelloWorld < Evoke::Task

  # The initializer of an Evoke::Task cannot have any required parameters.
  def initialize
  end

  # Called when this method is invoked on the command-line. This task would be
  # invoked using `evoke hello_world`.
  def invoke
    puts "Hello world!"
  end
end

module Math
  class Add < Evoke::Task
    # This can be used as an alternative to providing the short description in
    # the class comment.
    desc "Adds two integers and prints the result in the console"

    # All parameters come through as strings since they are read from the
    # arguments supplied on the command-line.
    def invoke(a, b)
      puts a.to_i + b.to_i
    end
  end
end

# SUPPORTED
def invoke(req, opt='optional argument'); end

# NOT SUPPORTED - errors will be raised
def invoke(opt: 'optional argument'); end
def invoke(*args); end
def invoke(&block); end

module Math
  # Adds two integers and prints the result in the console.
  #
  # Two environment variables are required to use this task: A and B.
  #
  # == Example: Adding 5 and 10.
  #
  #     evoke math/add A=5 B=10
  #
  # == Example: Adding 2 and 3.
  #
  #     evoke math/add A=2 B=3
  #
  class Add < Evoke::Task

    def initialize
      @a = ENV['A'].to_i
      @b = ENV['B'].to_i
    end

    def invoke
      puts @a + @b
    end
  end
end

# Prints the sum of two integers.
#
# This is a completely useless task that allows you to add two numbers together
# in the console using Evoke, a command-line task tool for Ruby.
#
# To use the task provide two integers via `evoke add A B`, where A and B are
# the integers. For example: `evoke add 1 5` will result in the number 6 being
# printed to the console. How completely pointless is that?
#
# This comment is displayed for this task when you run `evoke help add`.
class Add < Evoke::Task
  def invoke(a, b)
    puts a.to_i + b.to_i
  end
end

# This class comment will not be used to display help for this task because both
# the short and long descriptions are provided using #desc and #syntax.
#
# If only the #syntax method was used, the first line of this comment would
# still be used for the short description, and vice-versa. Both methods need to
# be used to completely disregard this comment.
class Add < Evoke::Task
  desc "Prints the sum of two integers."
  syntax "Provide two integers as arguments to this task."

  def invoke
    puts a.to_i + b.to_i
  end
end

# Searches the lib/evoke folder for _task.rb files and loads them.
Evoke.load_tasks('lib/evoke')

# Load the Rails environment before a task is invoked.
Evoke.before_task do |task, *args|
  require File.expand_path("../config/environment.rb", __FILE__)
end