Module: EacCli::RunnerWith::Subcommands

Defined in:
lib/eac_cli/runner_with/subcommands.rb,
lib/eac_cli/runner_with/subcommands/definition_concern.rb

Defined Under Namespace

Modules: DefinitionConcern

Constant Summary collapse

EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME = 
:extra_available_subcommands

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *arguments, &block) ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 54

def method_missing(method_name, *arguments, &block)
  return run_with_subcommand(*arguments, &block) if
  run_with_subcommand_alias_run?(method_name)

  super
end

Class Method Details

.subcommands_from_module(a_module) ⇒ Hash<String, EacCli::Runner>

Returns:



12
13
14
15
16
17
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 12

def subcommands_from_module(a_module)
  a_module.constants
    .map { |name| [name.to_s.underscore.gsub('_', '-'), a_module.const_get(name)] }
    .select { |c| runner?(c[1]) }
    .to_h.with_indifferent_access
end

Instance Method Details

#available_subcommands ⇒ Object 



28
29
30
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 28

def available_subcommands
  @available_subcommands ||= available_subcommands_auto.merge(available_subcommands_extra)
end

#available_subcommands_auto ⇒ Hash<String, EacCli::Runner>

Returns:



33
34
35
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 33

def available_subcommands_auto
  ::EacCli::RunnerWith::Subcommands.subcommands_from_module(self.class)
end

#available_subcommands_extra ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 37

def available_subcommands_extra
  if respond_to?(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME, true)
    send(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME)
  else
    {}
  end
end

#available_subcommands_to_s ⇒ Object 



45
46
47
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 45

def available_subcommands_to_s
  available_subcommands.keys.sort.join(', ')
end

#help_extra_text ⇒ Hash<String, Enumerable<String>]

Returns Hash<String, Enumerable<String>].

Returns:

  • (Hash<String, Enumerable<String>]) —

    Hash<String, Enumerable<String>]



50
51
52
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 50

def help_extra_text
  help_list_section('Subcommands', available_subcommands.keys.sort)
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 61

def respond_to_missing?(method_name, include_private = false)
  run_with_subcommand_alias_run?(method_name) || super
end

#run_subcommand? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 85

def run_subcommand?
  subcommand_name.present?
end

#run_with_subcommand ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 65

def run_with_subcommand
  if run_subcommand?
    if subcommand_runner.respond_to?(:run_run)
      subcommand_runner.run_run
    else
      subcommand_runner.run
    end
  else
    run_without_subcommand
  end
end

#run_with_subcommand_alias_run?(method_name) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 77

def run_with_subcommand_alias_run?(method_name)
  subcommands? && method_name.to_sym == :run
end

#run_without_subcommand ⇒ Object 



81
82
83
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 81

def run_without_subcommand
  "Method #{__method__} should be overrided in #{self.class.name}"
end

#subcommand_args ⇒ Object 



93
94
95
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 93

def subcommand_args
  parsed.fetch(::EacCli::Definition::SUBCOMMAND_ARGS_ARG)
end

#subcommand_class ⇒ Object

Raises:



97
98
99
100
101
102
103
104
105
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 97

def subcommand_class
  available_subcommands[subcommand_name].if_present { |v| return v }

  raise(::EacCli::Parser::Error.new(
          self.class.runner_definition, runner_context.argv,
          "Subcommand \"#{subcommand_name}\" not found " \
          "(Available: #{available_subcommands_to_s})"
        ))
end

#subcommand_name ⇒ Object 



107
108
109
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 107

def subcommand_name
  parsed.fetch(::EacCli::Definition::SUBCOMMAND_NAME_ARG)
end

#subcommand_program ⇒ Object 



111
112
113
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 111

def subcommand_program
  [program_name, subcommand_name]
end

#subcommand_runner ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 115

def subcommand_runner
  @subcommand_runner ||= subcommand_class.create(
    argv: subcommand_args,
    program_name: subcommand_program,
    parent: self
  )
end

#subcommands? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 89

def subcommands?
  self.class.runner_definition.subcommands?
end