foreman 0.85.0 → 0.86.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/foreman/cli.rb +3 -3
  4. data/lib/foreman/vendor/thor/lib/thor.rb +492 -0
  5. data/lib/foreman/vendor/thor/lib/thor/actions.rb +318 -0
  6. data/lib/foreman/vendor/thor/lib/thor/actions/create_file.rb +103 -0
  7. data/lib/foreman/vendor/thor/lib/thor/actions/create_link.rb +59 -0
  8. data/lib/foreman/vendor/thor/lib/thor/actions/directory.rb +118 -0
  9. data/lib/foreman/vendor/thor/lib/thor/actions/empty_directory.rb +135 -0
  10. data/lib/foreman/vendor/thor/lib/thor/actions/file_manipulation.rb +327 -0
  11. data/lib/foreman/vendor/thor/lib/thor/actions/inject_into_file.rb +103 -0
  12. data/lib/foreman/vendor/thor/lib/thor/base.rb +656 -0
  13. data/lib/foreman/vendor/thor/lib/thor/command.rb +133 -0
  14. data/lib/foreman/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb +85 -0
  15. data/lib/foreman/vendor/thor/lib/thor/core_ext/io_binary_read.rb +12 -0
  16. data/lib/foreman/vendor/thor/lib/thor/core_ext/ordered_hash.rb +129 -0
  17. data/lib/foreman/vendor/thor/lib/thor/error.rb +32 -0
  18. data/lib/foreman/vendor/thor/lib/thor/group.rb +281 -0
  19. data/lib/foreman/vendor/thor/lib/thor/invocation.rb +177 -0
  20. data/lib/foreman/vendor/thor/lib/thor/line_editor.rb +17 -0
  21. data/lib/foreman/vendor/thor/lib/thor/line_editor/basic.rb +35 -0
  22. data/lib/foreman/vendor/thor/lib/thor/line_editor/readline.rb +88 -0
  23. data/lib/foreman/vendor/thor/lib/thor/parser.rb +4 -0
  24. data/lib/foreman/vendor/thor/lib/thor/parser/argument.rb +70 -0
  25. data/lib/foreman/vendor/thor/lib/thor/parser/arguments.rb +175 -0
  26. data/lib/foreman/vendor/thor/lib/thor/parser/option.rb +146 -0
  27. data/lib/foreman/vendor/thor/lib/thor/parser/options.rb +220 -0
  28. data/lib/foreman/vendor/thor/lib/thor/rake_compat.rb +71 -0
  29. data/lib/foreman/vendor/thor/lib/thor/runner.rb +322 -0
  30. data/lib/foreman/vendor/thor/lib/thor/shell.rb +81 -0
  31. data/lib/foreman/vendor/thor/lib/thor/shell/basic.rb +436 -0
  32. data/lib/foreman/vendor/thor/lib/thor/shell/color.rb +149 -0
  33. data/lib/foreman/vendor/thor/lib/thor/shell/html.rb +126 -0
  34. data/lib/foreman/vendor/thor/lib/thor/util.rb +268 -0
  35. data/lib/foreman/vendor/thor/lib/thor/version.rb +3 -0
  36. data/lib/foreman/version.rb +1 -1
  37. data/man/foreman.1 +1 -1
  38. metadata +36 -19
@@ -0,0 +1,149 @@
1
+ require "foreman/vendor/thor/lib/thor/shell/basic"
2
+
3
+ class Foreman::Thor
4
+ module Shell
5
+ # Inherit from Foreman::Thor::Shell::Basic and add set_color behavior. Check
6
+ # Foreman::Thor::Shell::Basic to see all available methods.
7
+ #
8
+ class Color < Basic
9
+ # Embed in a String to clear all previous ANSI sequences.
10
+ CLEAR = "\e[0m"
11
+ # The start of an ANSI bold sequence.
12
+ BOLD = "\e[1m"
13
+
14
+ # Set the terminal's foreground ANSI color to black.
15
+ BLACK = "\e[30m"
16
+ # Set the terminal's foreground ANSI color to red.
17
+ RED = "\e[31m"
18
+ # Set the terminal's foreground ANSI color to green.
19
+ GREEN = "\e[32m"
20
+ # Set the terminal's foreground ANSI color to yellow.
21
+ YELLOW = "\e[33m"
22
+ # Set the terminal's foreground ANSI color to blue.
23
+ BLUE = "\e[34m"
24
+ # Set the terminal's foreground ANSI color to magenta.
25
+ MAGENTA = "\e[35m"
26
+ # Set the terminal's foreground ANSI color to cyan.
27
+ CYAN = "\e[36m"
28
+ # Set the terminal's foreground ANSI color to white.
29
+ WHITE = "\e[37m"
30
+
31
+ # Set the terminal's background ANSI color to black.
32
+ ON_BLACK = "\e[40m"
33
+ # Set the terminal's background ANSI color to red.
34
+ ON_RED = "\e[41m"
35
+ # Set the terminal's background ANSI color to green.
36
+ ON_GREEN = "\e[42m"
37
+ # Set the terminal's background ANSI color to yellow.
38
+ ON_YELLOW = "\e[43m"
39
+ # Set the terminal's background ANSI color to blue.
40
+ ON_BLUE = "\e[44m"
41
+ # Set the terminal's background ANSI color to magenta.
42
+ ON_MAGENTA = "\e[45m"
43
+ # Set the terminal's background ANSI color to cyan.
44
+ ON_CYAN = "\e[46m"
45
+ # Set the terminal's background ANSI color to white.
46
+ ON_WHITE = "\e[47m"
47
+
48
+ # Set color by using a string or one of the defined constants. If a third
49
+ # option is set to true, it also adds bold to the string. This is based
50
+ # on Highline implementation and it automatically appends CLEAR to the end
51
+ # of the returned String.
52
+ #
53
+ # Pass foreground, background and bold options to this method as
54
+ # symbols.
55
+ #
56
+ # Example:
57
+ #
58
+ # set_color "Hi!", :red, :on_white, :bold
59
+ #
60
+ # The available colors are:
61
+ #
62
+ # :bold
63
+ # :black
64
+ # :red
65
+ # :green
66
+ # :yellow
67
+ # :blue
68
+ # :magenta
69
+ # :cyan
70
+ # :white
71
+ # :on_black
72
+ # :on_red
73
+ # :on_green
74
+ # :on_yellow
75
+ # :on_blue
76
+ # :on_magenta
77
+ # :on_cyan
78
+ # :on_white
79
+ def set_color(string, *colors)
80
+ if colors.compact.empty? || !can_display_colors?
81
+ string
82
+ elsif colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
83
+ ansi_colors = colors.map { |color| lookup_color(color) }
84
+ "#{ansi_colors.join}#{string}#{CLEAR}"
85
+ else
86
+ # The old API was `set_color(color, bold=boolean)`. We
87
+ # continue to support the old API because you should never
88
+ # break old APIs unnecessarily :P
89
+ foreground, bold = colors
90
+ foreground = self.class.const_get(foreground.to_s.upcase) if foreground.is_a?(Symbol)
91
+
92
+ bold = bold ? BOLD : ""
93
+ "#{bold}#{foreground}#{string}#{CLEAR}"
94
+ end
95
+ end
96
+
97
+ protected
98
+
99
+ def can_display_colors?
100
+ stdout.tty?
101
+ end
102
+
103
+ # Overwrite show_diff to show diff with colors if Diff::LCS is
104
+ # available.
105
+ #
106
+ def show_diff(destination, content) #:nodoc:
107
+ if diff_lcs_loaded? && ENV["THOR_DIFF"].nil? && ENV["RAILS_DIFF"].nil?
108
+ actual = File.binread(destination).to_s.split("\n")
109
+ content = content.to_s.split("\n")
110
+
111
+ Diff::LCS.sdiff(actual, content).each do |diff|
112
+ output_diff_line(diff)
113
+ end
114
+ else
115
+ super
116
+ end
117
+ end
118
+
119
+ def output_diff_line(diff) #:nodoc:
120
+ case diff.action
121
+ when "-"
122
+ say "- #{diff.old_element.chomp}", :red, true
123
+ when "+"
124
+ say "+ #{diff.new_element.chomp}", :green, true
125
+ when "!"
126
+ say "- #{diff.old_element.chomp}", :red, true
127
+ say "+ #{diff.new_element.chomp}", :green, true
128
+ else
129
+ say " #{diff.old_element.chomp}", nil, true
130
+ end
131
+ end
132
+
133
+ # Check if Diff::LCS is loaded. If it is, use it to create pretty output
134
+ # for diff.
135
+ #
136
+ def diff_lcs_loaded? #:nodoc:
137
+ return true if defined?(Diff::LCS)
138
+ return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
139
+
140
+ @diff_lcs_loaded = begin
141
+ require "diff/lcs"
142
+ true
143
+ rescue LoadError
144
+ false
145
+ end
146
+ end
147
+ end
148
+ end
149
+ end
@@ -0,0 +1,126 @@
1
+ require "foreman/vendor/thor/lib/thor/shell/basic"
2
+
3
+ class Foreman::Thor
4
+ module Shell
5
+ # Inherit from Foreman::Thor::Shell::Basic and add set_color behavior. Check
6
+ # Foreman::Thor::Shell::Basic to see all available methods.
7
+ #
8
+ class HTML < Basic
9
+ # The start of an HTML bold sequence.
10
+ BOLD = "font-weight: bold"
11
+
12
+ # Set the terminal's foreground HTML color to black.
13
+ BLACK = "color: black"
14
+ # Set the terminal's foreground HTML color to red.
15
+ RED = "color: red"
16
+ # Set the terminal's foreground HTML color to green.
17
+ GREEN = "color: green"
18
+ # Set the terminal's foreground HTML color to yellow.
19
+ YELLOW = "color: yellow"
20
+ # Set the terminal's foreground HTML color to blue.
21
+ BLUE = "color: blue"
22
+ # Set the terminal's foreground HTML color to magenta.
23
+ MAGENTA = "color: magenta"
24
+ # Set the terminal's foreground HTML color to cyan.
25
+ CYAN = "color: cyan"
26
+ # Set the terminal's foreground HTML color to white.
27
+ WHITE = "color: white"
28
+
29
+ # Set the terminal's background HTML color to black.
30
+ ON_BLACK = "background-color: black"
31
+ # Set the terminal's background HTML color to red.
32
+ ON_RED = "background-color: red"
33
+ # Set the terminal's background HTML color to green.
34
+ ON_GREEN = "background-color: green"
35
+ # Set the terminal's background HTML color to yellow.
36
+ ON_YELLOW = "background-color: yellow"
37
+ # Set the terminal's background HTML color to blue.
38
+ ON_BLUE = "background-color: blue"
39
+ # Set the terminal's background HTML color to magenta.
40
+ ON_MAGENTA = "background-color: magenta"
41
+ # Set the terminal's background HTML color to cyan.
42
+ ON_CYAN = "background-color: cyan"
43
+ # Set the terminal's background HTML color to white.
44
+ ON_WHITE = "background-color: white"
45
+
46
+ # Set color by using a string or one of the defined constants. If a third
47
+ # option is set to true, it also adds bold to the string. This is based
48
+ # on Highline implementation and it automatically appends CLEAR to the end
49
+ # of the returned String.
50
+ #
51
+ def set_color(string, *colors)
52
+ if colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
53
+ html_colors = colors.map { |color| lookup_color(color) }
54
+ "<span style=\"#{html_colors.join('; ')};\">#{string}</span>"
55
+ else
56
+ color, bold = colors
57
+ html_color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
58
+ styles = [html_color]
59
+ styles << BOLD if bold
60
+ "<span style=\"#{styles.join('; ')};\">#{string}</span>"
61
+ end
62
+ end
63
+
64
+ # Ask something to the user and receives a response.
65
+ #
66
+ # ==== Example
67
+ # ask("What is your name?")
68
+ #
69
+ # TODO: Implement #ask for Foreman::Thor::Shell::HTML
70
+ def ask(statement, color = nil)
71
+ raise NotImplementedError, "Implement #ask for Foreman::Thor::Shell::HTML"
72
+ end
73
+
74
+ protected
75
+
76
+ def can_display_colors?
77
+ true
78
+ end
79
+
80
+ # Overwrite show_diff to show diff with colors if Diff::LCS is
81
+ # available.
82
+ #
83
+ def show_diff(destination, content) #:nodoc:
84
+ if diff_lcs_loaded? && ENV["THOR_DIFF"].nil? && ENV["RAILS_DIFF"].nil?
85
+ actual = File.binread(destination).to_s.split("\n")
86
+ content = content.to_s.split("\n")
87
+
88
+ Diff::LCS.sdiff(actual, content).each do |diff|
89
+ output_diff_line(diff)
90
+ end
91
+ else
92
+ super
93
+ end
94
+ end
95
+
96
+ def output_diff_line(diff) #:nodoc:
97
+ case diff.action
98
+ when "-"
99
+ say "- #{diff.old_element.chomp}", :red, true
100
+ when "+"
101
+ say "+ #{diff.new_element.chomp}", :green, true
102
+ when "!"
103
+ say "- #{diff.old_element.chomp}", :red, true
104
+ say "+ #{diff.new_element.chomp}", :green, true
105
+ else
106
+ say " #{diff.old_element.chomp}", nil, true
107
+ end
108
+ end
109
+
110
+ # Check if Diff::LCS is loaded. If it is, use it to create pretty output
111
+ # for diff.
112
+ #
113
+ def diff_lcs_loaded? #:nodoc:
114
+ return true if defined?(Diff::LCS)
115
+ return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
116
+
117
+ @diff_lcs_loaded = begin
118
+ require "diff/lcs"
119
+ true
120
+ rescue LoadError
121
+ false
122
+ end
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,268 @@
1
+ require "rbconfig"
2
+
3
+ class Foreman::Thor
4
+ module Sandbox #:nodoc:
5
+ end
6
+
7
+ # This module holds several utilities:
8
+ #
9
+ # 1) Methods to convert thor namespaces to constants and vice-versa.
10
+ #
11
+ # Foreman::Thor::Util.namespace_from_thor_class(Foo::Bar::Baz) #=> "foo:bar:baz"
12
+ #
13
+ # 2) Loading thor files and sandboxing:
14
+ #
15
+ # Foreman::Thor::Util.load_thorfile("~/.thor/foo")
16
+ #
17
+ module Util
18
+ class << self
19
+ # Receives a namespace and search for it in the Foreman::Thor::Base subclasses.
20
+ #
21
+ # ==== Parameters
22
+ # namespace<String>:: The namespace to search for.
23
+ #
24
+ def find_by_namespace(namespace)
25
+ namespace = "default#{namespace}" if namespace.empty? || namespace =~ /^:/
26
+ Foreman::Thor::Base.subclasses.detect { |klass| klass.namespace == namespace }
27
+ end
28
+
29
+ # Receives a constant and converts it to a Foreman::Thor namespace. Since Foreman::Thor
30
+ # commands can be added to a sandbox, this method is also responsable for
31
+ # removing the sandbox namespace.
32
+ #
33
+ # This method should not be used in general because it's used to deal with
34
+ # older versions of Foreman::Thor. On current versions, if you need to get the
35
+ # namespace from a class, just call namespace on it.
36
+ #
37
+ # ==== Parameters
38
+ # constant<Object>:: The constant to be converted to the thor path.
39
+ #
40
+ # ==== Returns
41
+ # String:: If we receive Foo::Bar::Baz it returns "foo:bar:baz"
42
+ #
43
+ def namespace_from_thor_class(constant)
44
+ constant = constant.to_s.gsub(/^Foreman::Thor::Sandbox::/, "")
45
+ constant = snake_case(constant).squeeze(":")
46
+ constant
47
+ end
48
+
49
+ # Given the contents, evaluate it inside the sandbox and returns the
50
+ # namespaces defined in the sandbox.
51
+ #
52
+ # ==== Parameters
53
+ # contents<String>
54
+ #
55
+ # ==== Returns
56
+ # Array[Object]
57
+ #
58
+ def namespaces_in_content(contents, file = __FILE__)
59
+ old_constants = Foreman::Thor::Base.subclasses.dup
60
+ Foreman::Thor::Base.subclasses.clear
61
+
62
+ load_thorfile(file, contents)
63
+
64
+ new_constants = Foreman::Thor::Base.subclasses.dup
65
+ Foreman::Thor::Base.subclasses.replace(old_constants)
66
+
67
+ new_constants.map!(&:namespace)
68
+ new_constants.compact!
69
+ new_constants
70
+ end
71
+
72
+ # Returns the thor classes declared inside the given class.
73
+ #
74
+ def thor_classes_in(klass)
75
+ stringfied_constants = klass.constants.map(&:to_s)
76
+ Foreman::Thor::Base.subclasses.select do |subclass|
77
+ next unless subclass.name
78
+ stringfied_constants.include?(subclass.name.gsub("#{klass.name}::", ""))
79
+ end
80
+ end
81
+
82
+ # Receives a string and convert it to snake case. SnakeCase returns snake_case.
83
+ #
84
+ # ==== Parameters
85
+ # String
86
+ #
87
+ # ==== Returns
88
+ # String
89
+ #
90
+ def snake_case(str)
91
+ return str.downcase if str =~ /^[A-Z_]+$/
92
+ str.gsub(/\B[A-Z]/, '_\&').squeeze("_") =~ /_*(.*)/
93
+ $+.downcase
94
+ end
95
+
96
+ # Receives a string and convert it to camel case. camel_case returns CamelCase.
97
+ #
98
+ # ==== Parameters
99
+ # String
100
+ #
101
+ # ==== Returns
102
+ # String
103
+ #
104
+ def camel_case(str)
105
+ return str if str !~ /_/ && str =~ /[A-Z]+.*/
106
+ str.split("_").map(&:capitalize).join
107
+ end
108
+
109
+ # Receives a namespace and tries to retrieve a Foreman::Thor or Foreman::Thor::Group class
110
+ # from it. It first searches for a class using the all the given namespace,
111
+ # if it's not found, removes the highest entry and searches for the class
112
+ # again. If found, returns the highest entry as the class name.
113
+ #
114
+ # ==== Examples
115
+ #
116
+ # class Foo::Bar < Foreman::Thor
117
+ # def baz
118
+ # end
119
+ # end
120
+ #
121
+ # class Baz::Foo < Foreman::Thor::Group
122
+ # end
123
+ #
124
+ # Foreman::Thor::Util.namespace_to_thor_class("foo:bar") #=> Foo::Bar, nil # will invoke default command
125
+ # Foreman::Thor::Util.namespace_to_thor_class("baz:foo") #=> Baz::Foo, nil
126
+ # Foreman::Thor::Util.namespace_to_thor_class("foo:bar:baz") #=> Foo::Bar, "baz"
127
+ #
128
+ # ==== Parameters
129
+ # namespace<String>
130
+ #
131
+ def find_class_and_command_by_namespace(namespace, fallback = true)
132
+ if namespace.include?(":") # look for a namespaced command
133
+ pieces = namespace.split(":")
134
+ command = pieces.pop
135
+ klass = Foreman::Thor::Util.find_by_namespace(pieces.join(":"))
136
+ end
137
+ unless klass # look for a Foreman::Thor::Group with the right name
138
+ klass = Foreman::Thor::Util.find_by_namespace(namespace)
139
+ command = nil
140
+ end
141
+ if !klass && fallback # try a command in the default namespace
142
+ command = namespace
143
+ klass = Foreman::Thor::Util.find_by_namespace("")
144
+ end
145
+ [klass, command]
146
+ end
147
+ alias_method :find_class_and_task_by_namespace, :find_class_and_command_by_namespace
148
+
149
+ # Receives a path and load the thor file in the path. The file is evaluated
150
+ # inside the sandbox to avoid namespacing conflicts.
151
+ #
152
+ def load_thorfile(path, content = nil, debug = false)
153
+ content ||= File.binread(path)
154
+
155
+ begin
156
+ Foreman::Thor::Sandbox.class_eval(content, path)
157
+ rescue StandardError => e
158
+ $stderr.puts("WARNING: unable to load thorfile #{path.inspect}: #{e.message}")
159
+ if debug
160
+ $stderr.puts(*e.backtrace)
161
+ else
162
+ $stderr.puts(e.backtrace.first)
163
+ end
164
+ end
165
+ end
166
+
167
+ def user_home
168
+ @@user_home ||= if ENV["HOME"]
169
+ ENV["HOME"]
170
+ elsif ENV["USERPROFILE"]
171
+ ENV["USERPROFILE"]
172
+ elsif ENV["HOMEDRIVE"] && ENV["HOMEPATH"]
173
+ File.join(ENV["HOMEDRIVE"], ENV["HOMEPATH"])
174
+ elsif ENV["APPDATA"]
175
+ ENV["APPDATA"]
176
+ else
177
+ begin
178
+ File.expand_path("~")
179
+ rescue
180
+ if File::ALT_SEPARATOR
181
+ "C:/"
182
+ else
183
+ "/"
184
+ end
185
+ end
186
+ end
187
+ end
188
+
189
+ # Returns the root where thor files are located, depending on the OS.
190
+ #
191
+ def thor_root
192
+ File.join(user_home, ".thor").tr('\\', "/")
193
+ end
194
+
195
+ # Returns the files in the thor root. On Windows thor_root will be something
196
+ # like this:
197
+ #
198
+ # C:\Documents and Settings\james\.thor
199
+ #
200
+ # If we don't #gsub the \ character, Dir.glob will fail.
201
+ #
202
+ def thor_root_glob
203
+ files = Dir["#{escape_globs(thor_root)}/*"]
204
+
205
+ files.map! do |file|
206
+ File.directory?(file) ? File.join(file, "main.thor") : file
207
+ end
208
+ end
209
+
210
+ # Where to look for Foreman::Thor files.
211
+ #
212
+ def globs_for(path)
213
+ path = escape_globs(path)
214
+ ["#{path}/Foreman::Thorfile", "#{path}/*.thor", "#{path}/tasks/*.thor", "#{path}/lib/tasks/*.thor"]
215
+ end
216
+
217
+ # Return the path to the ruby interpreter taking into account multiple
218
+ # installations and windows extensions.
219
+ #
220
+ def ruby_command
221
+ @ruby_command ||= begin
222
+ ruby_name = RbConfig::CONFIG["ruby_install_name"]
223
+ ruby = File.join(RbConfig::CONFIG["bindir"], ruby_name)
224
+ ruby << RbConfig::CONFIG["EXEEXT"]
225
+
226
+ # avoid using different name than ruby (on platforms supporting links)
227
+ if ruby_name != "ruby" && File.respond_to?(:readlink)
228
+ begin
229
+ alternate_ruby = File.join(RbConfig::CONFIG["bindir"], "ruby")
230
+ alternate_ruby << RbConfig::CONFIG["EXEEXT"]
231
+
232
+ # ruby is a symlink
233
+ if File.symlink? alternate_ruby
234
+ linked_ruby = File.readlink alternate_ruby
235
+
236
+ # symlink points to 'ruby_install_name'
237
+ ruby = alternate_ruby if linked_ruby == ruby_name || linked_ruby == ruby
238
+ end
239
+ rescue NotImplementedError # rubocop:disable HandleExceptions
240
+ # just ignore on windows
241
+ end
242
+ end
243
+
244
+ # escape string in case path to ruby executable contain spaces.
245
+ ruby.sub!(/.*\s.*/m, '"\&"')
246
+ ruby
247
+ end
248
+ end
249
+
250
+ # Returns a string that has had any glob characters escaped.
251
+ # The glob characters are `* ? { } [ ]`.
252
+ #
253
+ # ==== Examples
254
+ #
255
+ # Foreman::Thor::Util.escape_globs('[apps]') # => '\[apps\]'
256
+ #
257
+ # ==== Parameters
258
+ # String
259
+ #
260
+ # ==== Returns
261
+ # String
262
+ #
263
+ def escape_globs(path)
264
+ path.to_s.gsub(/[*?{}\[\]]/, '\\\\\\&')
265
+ end
266
+ end
267
+ end
268
+ end