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.3'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.arguments ⇒ Object

Returns the value of attribute arguments.



48
49
50
 
# File 'lib/howzit.rb', line 48

def arguments
  @arguments
end

.cli_args ⇒ Object

Returns the value of attribute cli_args.



48
49
50
 
# File 'lib/howzit.rb', line 48

def cli_args
  @cli_args
end

.named_arguments ⇒ Object

Returns the value of attribute named_arguments.



48
49
50
 
# File 'lib/howzit.rb', line 48

def named_arguments
  @named_arguments
end

Class Method Details

.buildnote ⇒ Object

Module storage for buildnote



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

def buildnote
  @buildnote ||= BuildNote.new
end

.config ⇒ Configuration

Holds a Configuration object with methods and a @settings hash

Returns:

  • (Configuration) —

    Configuration object



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

def config
  @config ||= Config.new
end

.console ⇒ Object

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



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

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

.has_read_upstream ⇒ Object 



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

def has_read_upstream
  @has_read_upstream ||= false
end

.has_read_upstream=(has_read) ⇒ Object 



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

def has_read_upstream=(has_read)
  @has_read_upstream = has_read
end

.inclusions ⇒ Object

Array for tracking inclusions and avoiding duplicates in output



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

def inclusions
  @inclusions ||= []
end

.options ⇒ Object

Module storage for Howzit::Config.options



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

def options
  config.options
end