Class GetText::Tools::Task
In: lib/gettext/tools/task.rb
Parent: Object

Methods

define   define   enable_description?   enable_po?   new   spec=  

Included Modules

GetText Rake::DSL

Classes and Modules

Class GetText::Tools::Task::Error
Class GetText::Tools::Task::ValidationError

Attributes

domain  [RW]  It is a required parameter.

@return [String] Text domain

enable_description  [W]  @return [Bool] @see enable_description? For details.
enable_po  [W]  @return [Bool] @see enable_po? For details.
files  [RW]  It is a required parameter.

@return [Array<String>] Files that have messages.

locales  [RW]  It is a required parameter.

@return [Array<String>] Supported locales. It is filled from 

  {#po_base_directory} by default.
mo_base_directory  [RW]  @return [String] Base directory that has generated MOs. MOs 
  are generated into
  `#{mo_base_directory}/#{locale}/LC_MESSAGES/#{domain}.mo`.
msgmerge_options  [RW]  @return [Array<String>] Command line options for merging PO with the 
  latest POT.

@see GetText::Tools::MsgMerge @see `rmsgmerge —help`

namespace_prefix  [RW]  It is useful when you have multiple domains. You can define tasks for each domains by using different namespace prefix.

It is `nil` by default. It means that tasks are defined at top level.

TODO: example

@return [String] Namespace prefix for tasks defined by this class.

package_name  [RW]  @return [String, nil] Package name for messages.
package_version  [RW]  @return [String, nil] Package version for messages.
po_base_directory  [RW] 
spec  [R]  @return [Gem::Specification, nil] Package information associated 
  with the task.
xgettext_options  [RW]  @return [Array<String>] Command line options for extracting messages 
  from sources.

@see GetText::Tools::XGetText @see `rxgettext —help`

Public Class methods

define() {|task| ...}

Define gettext related Rake tasks. Normally, use this method to define tasks because this method is a convenient API.

See accessor APIs how to configure this task.

See {define} for what task is defined.

@example Recommended usage 

  require "gettext/tools/task"
  # Recommended usage
  GetText::Tools::Task.define do |task|
    task.spec = spec
    # ...
  end
  # Low level API
  task = GetText::Tools::Task.new
  task.spec = spec
  # ...
  task.define

@yield [task] Gives the newely created task to the block. @yieldparam [GetText::Tools::Task] task The task that should be 

  configured.

@see {define} @return [void]

new(spec=nil) {|self| ...}

@param [Gem::Specification, nil] spec Package information associated 

  with the task. Some information are extracted from the spec.

@see spec= What information are extracted from the spec.

Public Instance methods

define()

Define tasks from configured parameters.

TODO: List defined Rake tasks.

enable_description?()

If it is true, each task has description. Otherwise, all tasks doesn‘t have description.

@return [Bool] @since 3.0.1

enable_po?()

If it is true, PO related tasks are defined. Otherwise, they are not defined.

This parameter is useful to manage PO written by hand.

@return [Bool] @since 3.0.1

spec=(spec)

Sets package infromation by Gem::Specification. Here is a list for information extracted from the spec: 

  * {#package_name}
  * {#package_version}
  * {#domain}
  * {#files}

@param [Gem::Specification] spec package information for the 

  i18n application.

[Validate]