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/run_report.rb,
lib/howzit/stringutils.rb,
lib/howzit/console_logger.rb

Overview

Primary module for this gem.

Defined Under Namespace

Modules: Color, Prompt, RunReport, StringUtils, Util Classes: BuildNote, Config, ConsoleLogger, Task, Topic

Constant Summary collapse

VERSION =

Current Howzit version.

'2.1.25'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.arguments ⇒ Object

Returns the value of attribute arguments.



53
54
55
 
# File 'lib/howzit.rb', line 53

def arguments
  @arguments
end

.cli_args ⇒ Object

Returns the value of attribute cli_args.



53
54
55
 
# File 'lib/howzit.rb', line 53

def cli_args
  @cli_args
end

.has_read_upstream ⇒ Object 



100
101
102
 
# File 'lib/howzit.rb', line 100

def has_read_upstream
  @has_read_upstream ||= false
end

.multi_topic_run ⇒ Object

Returns the value of attribute multi_topic_run.



53
54
55
 
# File 'lib/howzit.rb', line 53

def multi_topic_run
  @multi_topic_run
end

.named_arguments ⇒ Object

Returns the value of attribute named_arguments.



53
54
55
 
# File 'lib/howzit.rb', line 53

def named_arguments
  @named_arguments
end

.run_log ⇒ Object

Returns the value of attribute run_log.



53
54
55
 
# File 'lib/howzit.rb', line 53

def run_log
  @run_log
end

Class Method Details

.buildnote(file = nil) ⇒ Object

Module storage for buildnote



81
82
83
 
# File 'lib/howzit.rb', line 81

def buildnote(file = nil)
  @buildnote ||= BuildNote.new(file: file)
end

.config ⇒ Configuration

Holds a Configuration object with methods and a @settings hash

Returns:

  • (Configuration) —

    Configuration object



60
61
62
 
# File 'lib/howzit.rb', line 60

def config
  @config ||= Config.new
end

.console ⇒ Object

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



88
89
90
 
# File 'lib/howzit.rb', line 88

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

.inclusions ⇒ Object

Array for tracking inclusions and avoiding duplicates in output



67
68
69
 
# File 'lib/howzit.rb', line 67

def inclusions
  @inclusions ||= []
end

.options ⇒ Object

Module storage for Howzit::Config.options



74
75
76
 
# File 'lib/howzit.rb', line 74

def options
  config.options
end