Class: Foreman::Thor::Runner

Inherits:
Foreman::Thor show all
Defined in:
lib/foreman/vendor/thor/lib/thor/runner.rb

Overview

:nodoc: # rubocop:disable ClassLength

Constant Summary

Constants inherited from Foreman::Thor

AmbiguousTaskError, DynamicTask, HELP_MAPPINGS, HiddenTask, TEMPLATE_EXTNAME, THOR_RESERVED_WORDS, Task, UndefinedTaskError, VERSION

Instance Attribute Summary

Attributes included from Base

#args, #options, #parent_options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Foreman::Thor

check_unknown_options!, check_unknown_options?, command_help, default_command, desc, disable_class_options, help, long_desc, map, method_option, method_options, package_name, printable_commands, register, stop_on_unknown_option!, stop_on_unknown_option?, subcommand, subcommand_classes, subcommands

Methods included from Base

included, #initialize, register_klass_file, subclass_files, subclasses

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args) ⇒ Object

If a command is not found on Foreman::Thor::Runner, method missing is invoked and Foreman::Thor::Runner is then responsible for finding the command in all classes.



38
39
40
41
42
43
44
45
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 38

def method_missing(meth, *args)
  meth = meth.to_s
  initialize_thorfiles(meth)
  klass, command = Foreman::Thor::Util.find_class_and_command_by_namespace(meth)
  self.class.handle_no_command_error(command, false) if klass.nil?
  args.unshift(command) if command
  klass.start(args, :shell => shell)
end

Class Method Details



14
15
16
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 14

def self.banner(command, all = false, subcommand = false)
  "thor " + command.formatted_usage(self, all, subcommand)
end

.exit_on_failure? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 18

def self.exit_on_failure?
  true
end

Instance Method Details

#help(meth = nil) ⇒ Object

Override Foreman::Thor#help so it can give information about any class and any method.



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 24

def help(meth = nil)
  if meth && !respond_to?(meth)
    initialize_thorfiles(meth)
    klass, command = Foreman::Thor::Util.find_class_and_command_by_namespace(meth)
    self.class.handle_no_command_error(command, false) if klass.nil?
    klass.start(["-h", command].compact, :shell => shell)
  else
    super
  end
end

#install(name) ⇒ Object

rubocop:disable MethodLength



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 49

def install(name) # rubocop:disable MethodLength
  initialize_thorfiles

  # If a directory name is provided as the argument, look for a 'main.thor'
  # command in said directory.
  begin
    if File.directory?(File.expand_path(name))
      base = File.join(name, "main.thor")
      package = :directory
      contents = open(base, &:read)
    else
      base = name
      package = :file
      contents = open(name, &:read)
    end
  rescue OpenURI::HTTPError
    raise Error, "Error opening URI '#{name}'"
  rescue Errno::ENOENT
    raise Error, "Error opening file '#{name}'"
  end

  say "Your Foreman::Thorfile contains:"
  say contents

  unless options["force"]
    return false if no?("Do you wish to continue [y/N]?")
  end

  as = options["as"] || begin
    first_line = contents.split("\n")[0]
    (match = first_line.match(/\s*#\s*module:\s*([^\n]*)/)) ? match[1].strip : nil
  end

  unless as
    basename = File.basename(name)
    as = ask("Please specify a name for #{name} in the system repository [#{basename}]:")
    as = basename if as.empty?
  end

  location = if options[:relative] || name =~ %r{^https?://}
    name
  else
    File.expand_path(name)
  end

  thor_yaml[as] = {
    :filename   => Digest::MD5.hexdigest(name + as),
    :location   => location,
    :namespaces => Foreman::Thor::Util.namespaces_in_content(contents, base)
  }

  save_yaml(thor_yaml)
  say "Storing thor file in your system repository"
  destination = File.join(thor_root, thor_yaml[as][:filename])

  if package == :file
    File.open(destination, "w") { |f| f.puts contents }
  else
    FileUtils.cp_r(name, destination)
  end

  thor_yaml[as][:filename] # Indicate success
end

#installed ⇒ Object 



156
157
158
159
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 156

def installed
  initialize_thorfiles(nil, true)
  display_klasses(true, options["internal"])
end

#list(search = "") ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 163

def list(search = "")
  initialize_thorfiles

  search = ".*#{search}" if options["substring"]
  search = /^#{search}.*/i
  group  = options[:group] || "standard"

  klasses = Foreman::Thor::Base.subclasses.select do |k|
    (options[:all] || k.group == group) && k.namespace =~ search
  end

  display_klasses(false, false, klasses)
end

#uninstall(name) ⇒ Object

Raises:



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 120

def uninstall(name)
  raise Error, "Can't find module '#{name}'" unless thor_yaml[name]
  say "Uninstalling #{name}."
  FileUtils.rm_rf(File.join(thor_root, (thor_yaml[name][:filename]).to_s))

  thor_yaml.delete(name)
  save_yaml(thor_yaml)

  puts "Done."
end

#update(name) ⇒ Object

Raises:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 132

def update(name)
  raise Error, "Can't find module '#{name}'" if !thor_yaml[name] || !thor_yaml[name][:location]

  say "Updating '#{name}' from #{thor_yaml[name][:location]}"

  old_filename = thor_yaml[name][:filename]
  self.options = options.merge("as" => name)

  if File.directory? File.expand_path(name)
    FileUtils.rm_rf(File.join(thor_root, old_filename))

    thor_yaml.delete(old_filename)
    save_yaml(thor_yaml)

    filename = install(name)
  else
    filename = install(thor_yaml[name][:location])
  end

  File.delete(File.join(thor_root, old_filename)) unless filename == old_filename
end

#version ⇒ Object 



114
115
116
117
 
# File 'lib/foreman/vendor/thor/lib/thor/runner.rb', line 114

def version
  require "foreman/vendor/thor/lib/thor/version"
  say "Foreman::Thor #{Foreman::Thor::VERSION}"
end