Module: EacCli::RunnerWith::Help

Defined in:
lib/eac_cli/runner_with/help.rb,
lib/eac_cli/runner_with/help/layout.rb,
lib/eac_cli/runner_with/help/builder.rb,
lib/eac_cli/runner_with/help/builder/alternative.rb

Defined Under Namespace

Modules: Layout Classes: Builder

Instance Method Summary collapse

Instance Method Details

#help_join_sections(*sections) ⇒ String

Parameters:

  • items (Enumerable<String>)

Returns:

  • (String) 


30
31
32
 
# File 'lib/eac_cli/runner_with/help.rb', line 30

def help_join_sections(*sections)
  ::EacCli::RunnerWith::Help::Layout.join_sections(*sections)
end

#help_list_section(title, items) ⇒ String

Parameters:

  • items (Enumerable<String>)

Returns:

  • (String) 


24
25
26
 
# File 'lib/eac_cli/runner_with/help.rb', line 24

def help_list_section(title, items)
  ::EacCli::RunnerWith::Help::Layout.list_section(title, items)
end

#help_run ⇒ Object

Raises:



34
35
36
37
38
39
 
# File 'lib/eac_cli/runner_with/help.rb', line 34

def help_run
  return unless show_help?

  puts help_text
  raise ::EacCli::Runner::Exit
end

#help_text ⇒ String

Returns:

  • (String) 


42
43
44
 
# File 'lib/eac_cli/runner_with/help.rb', line 42

def help_text
  ::EacCli::RunnerWith::Help::Builder.new(self).to_s
end

#show_help? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/eac_cli/runner_with/help.rb', line 46

def show_help?
  parsed.help? && !if_respond(:run_subcommand?, false)
end