Class Bee::Task::Package
In: lib/bee_task.rb
Parent: Bee::Util::MethodInfoBase

Base class for task package. Provides methods to print output using the build formatter and a method to check task parameters. Furthermore, this base class extends MethodInfoBase which provides methods comments, for autodocumentation purpose.

Methods

check_parameters   filter_files   gets   new   print   puts  

Included Modules

Bee::Util::BuildErrorMixin

Public Class methods

Constructor.

  • build: the build we are running.

Protected Instance methods

Check task parameters. Raise a RuntimeError with explanation message if a mandatory parameter is missing or an unknown parameter was found.

  • params: task parameters as a Hash.
  • description: parameters description as a Hash with following keys: :mandatory telling if the parameter is mandatory (true or false), :type which is the class name of the parameter and :default for default value.

Utility method to find and filter files.

  • root: root directory for files to search.
  • includes: list of globs for files to include in search.
  • excludes: list of globs for files to exclude from search.
  • dotmatch: tells if joker matches dot files.

Return: the list of found files (no directories included).

Prompts the user for a string. Return the user input string.

Print text on the console.

Puts text on the console.

  • text: text to puts.

[Validate]