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 



57
58
59
60
61
62
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 57

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:



15
16
17
18
19
20
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 15

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 



31
32
33
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 31

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

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

Returns:



36
37
38
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 36

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

#available_subcommands_extra ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 40

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 



48
49
50
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 48

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>]



53
54
55
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 53

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

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

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 64

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

#run_subcommand? ⇒ Boolean

Returns:

  • (Boolean) 


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

def run_subcommand?
  subcommand_name.present?
end

#run_with_subcommand ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 68

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) 


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

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

#run_without_subcommand ⇒ Object 



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

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

#subcommand_args ⇒ Object 



96
97
98
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 96

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

#subcommand_class ⇒ Object

Raises:



100
101
102
103
104
105
106
107
108
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 100

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 



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

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

#subcommand_program ⇒ Object 



114
115
116
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 114

def subcommand_program
  [program_name, subcommand_name]
end

#subcommand_runner ⇒ Object 



118
119
120
121
122
123
124
 
# File 'lib/eac_cli/runner_with/subcommands.rb', line 118

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

#subcommands? ⇒ Boolean

Returns:

  • (Boolean) 


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

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