Module: Howzit

Defined in:
lib/howzit.rb,
lib/howzit/task.rb,
lib/howzit/util.rb,
lib/howzit/topic.rb,
lib/howzit/colors.rb,
lib/howzit/config.rb,
lib/howzit/prompt.rb,
lib/howzit/version.rb,
lib/howzit/buildnote.rb,
lib/howzit/directive.rb,
lib/howzit/run_report.rb,
lib/howzit/script_comm.rb,
lib/howzit/stringutils.rb,
lib/howzit/console_logger.rb,
lib/howzit/script_support.rb,
lib/howzit/condition_evaluator.rb,
lib/howzit/conditional_content.rb

Overview

Primary module for this gem.

Defined Under Namespace

Modules: Color, ConditionEvaluator, ConditionalContent, Prompt, RunReport, ScriptComm, ScriptSupport, StringUtils, Util Classes: BuildNote, Config, ConsoleLogger, Directive, Task, Topic

Constant Summary collapse

VERSION =

Current Howzit version.

'2.1.40'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.arguments ⇒ Object

Returns the value of attribute arguments.



63
64
65
 
# File 'lib/howzit.rb', line 63

def arguments
  @arguments
end

.cli_args ⇒ Object

Returns the value of attribute cli_args.



63
64
65
 
# File 'lib/howzit.rb', line 63

def cli_args
  @cli_args
end

.has_read_upstream ⇒ Object 



116
117
118
 
# File 'lib/howzit.rb', line 116

def has_read_upstream
  @has_read_upstream ||= false
end

.multi_topic_run ⇒ Object

Returns the value of attribute multi_topic_run.



63
64
65
 
# File 'lib/howzit.rb', line 63

def multi_topic_run
  @multi_topic_run
end

.named_arguments ⇒ Object

Returns the value of attribute named_arguments.



63
64
65
 
# File 'lib/howzit.rb', line 63

def named_arguments
  @named_arguments
end

.run_log ⇒ Object

Returns the value of attribute run_log.



63
64
65
 
# File 'lib/howzit.rb', line 63

def run_log
  @run_log
end

Class Method Details

.buildnote(file = nil) ⇒ Object

Module storage for buildnote



91
92
93
94
95
96
97
98
99
 
# File 'lib/howzit.rb', line 91

def buildnote(file = nil)
  # If a specific file is requested, always create a new instance
  # Otherwise, use cached instance if available
  if file
    BuildNote.new(file: file)
  else
    @buildnote ||= BuildNote.new(file: file)
  end
end

.config ⇒ Configuration

Holds a Configuration object with methods and a @settings hash

Returns:

  • (Configuration) —

    Configuration object



70
71
72
 
# File 'lib/howzit.rb', line 70

def config
  @config ||= Config.new
end

.console ⇒ Object

Convenience method for logging with Howzit.console.warn, etc.



104
105
106
 
# File 'lib/howzit.rb', line 104

def console
  @console ||= Howzit::ConsoleLogger.new(options[:log_level])
end

.inclusions ⇒ Object

Array for tracking inclusions and avoiding duplicates in output



77
78
79
 
# File 'lib/howzit.rb', line 77

def inclusions
  @inclusions ||= []
end

.options ⇒ Object

Module storage for Howzit::Config.options



84
85
86
 
# File 'lib/howzit.rb', line 84

def options
  config.options
end