module Kamaze::Project::Concern::Cli

Concern for CLI

This module provides base methods focused on “retcode“.

Public Class Methods

included(base) click to toggle source
# File lib/kamaze/project/concern/cli.rb, line 21
    def included(base)
      base.class_eval <<-"ACCESSORS", __FILE__, __LINE__ + 1
        protected

        attr_writer :retcode
      ACCESSORS
    end

Public Instance Methods

failed?()
Alias for: failure?
failure?() click to toggle source

Denote execution is a failure.

@return [Boolean]

# File lib/kamaze/project/concern/cli.rb, line 48
def failure?
  !success?
end
Also aliased as: failed?
retcode() click to toggle source

Status code usable to eventually initiates the termination.

@return [Fixnum]

# File lib/kamaze/project/concern/cli.rb, line 33
def retcode
  @retcode || Errno::NOERROR::Errno
end
success?() click to toggle source

Denote execution is a success.

@return [Boolean]

# File lib/kamaze/project/concern/cli.rb, line 40
def success?
  # noinspection RubyResolve
  Errno::NOERROR::Errno == retcode
end
Also aliased as: successful?
successful?()
Alias for: success?