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

Overview

Primary module for this gem.

Defined Under Namespace

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

Constant Summary collapse

VERSION =

Current Howzit version.

'2.1.16'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.argumentsObject

Returns the value of attribute arguments.



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

def arguments
  @arguments
end

.cli_argsObject

Returns the value of attribute cli_args.



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

def cli_args
  @cli_args
end

.has_read_upstreamObject



91
92
93
# File 'lib/howzit.rb', line 91

def has_read_upstream
  @has_read_upstream ||= false
end

.named_argumentsObject

Returns the value of attribute named_arguments.



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

def named_arguments
  @named_arguments
end

Class Method Details

.buildnote(file = nil) ⇒ Object

Module storage for buildnote



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

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

.configConfiguration

Holds a Configuration object with methods and a @settings hash

Returns:

  • (Configuration)

    Configuration object



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

def config
  @config ||= Config.new
end

.consoleObject

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



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

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

.inclusionsObject

Array for tracking inclusions and avoiding duplicates in output



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

def inclusions
  @inclusions ||= []
end

.optionsObject

Module storage for Howzit::Config.options



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

def options
  config.options
end