Class: Kamaze::Project::Tools::Git::Hooks::BaseHook

Inherits:

Object

• Object
• Kamaze::Project::Tools::Git::Hooks::BaseHook

Includes:

Concern::Cli::WithExitOnFailure

Defined in:

lib/kamaze/project/tools/git/hooks/base_hook.rb,
lib/kamaze/project/tools/git/hooks/base_hook.rb

Overview

Base Hook

Direct Known Subclasses

PreCommit

Instance Attribute Summary

• #repository ⇒ Kamaze::Project::Tools::Git readonly protected

Instance Method Summary

• #failure? ⇒ Boolean (also: #failed?) included from Concern::Cli

  Denote execution is a failure.

• #initialize(repository) ⇒ BaseHook constructor

  A new instance of BaseHook.

• #retcode ⇒ Fixnum included from Concern::Cli

  Status code usable to eventually initiates the termination.

• #success? ⇒ Boolean (also: #successful?) included from Concern::Cli

  Denote execution is a success.

• #with_exit_on_failure {|Object| ... } ⇒ Object included from Concern::Cli::WithExitOnFailure protected

  Initiates termination by raising SystemExit exception depending on success of given block.

Constructor Details

#initialize(repository) ⇒ BaseHook

Returns a new instance of BaseHook.

Parameters:

• repository (Kamaze::Project::Tools::Git)

# File 'lib/kamaze/project/tools/git/hooks/base_hook.rb', line 25

def initialize(repository)
  @repository = repository
end

Instance Attribute Details

#repository ⇒ Kamaze::Project::Tools::Git (readonly, protected)

Returns:

• (Kamaze::Project::Tools::Git)

# File 'lib/kamaze/project/tools/git/hooks/base_hook.rb', line 32

def repository
  @repository
end

Instance Method Details

#failure? ⇒ Boolean Also known as: failed? Originally defined in module Concern::Cli

Denote execution is a failure.

Returns:

• (Boolean)

#retcode ⇒ Fixnum Originally defined in module Concern::Cli

Status code usable to eventually initiates the termination.

Returns:

• (Fixnum)

#success? ⇒ Boolean Also known as: successful? Originally defined in module Concern::Cli

Denote execution is a success.

Returns:

• (Boolean)

#with_exit_on_failure {|Object| ... } ⇒ Object (protected) Originally defined in module Concern::Cli::WithExitOnFailure

Initiates termination by raising SystemExit exception depending on success of given block.

Yields:

• (Object)

Yield Parameters:

• (self)

Returns:

• (Object)

Raises:

• (SystemExit)