wtch 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,275 @@
1
+ require 'tempfile'
2
+
3
+ class Thor
4
+ module Shell
5
+ class Basic
6
+ attr_accessor :base, :padding
7
+
8
+ # Initialize base and padding to nil.
9
+ #
10
+ def initialize #:nodoc:
11
+ @base, @padding = nil, 0
12
+ end
13
+
14
+ # Sets the output padding, not allowing less than zero values.
15
+ #
16
+ def padding=(value)
17
+ @padding = [0, value].max
18
+ end
19
+
20
+ # Ask something to the user and receives a response.
21
+ #
22
+ # ==== Example
23
+ # ask("What is your name?")
24
+ #
25
+ def ask(statement, color=nil)
26
+ say("#{statement} ", color)
27
+ $stdin.gets.strip
28
+ end
29
+
30
+ # Say (print) something to the user. If the sentence ends with a whitespace
31
+ # or tab character, a new line is not appended (print + flush). Otherwise
32
+ # are passed straight to puts (behavior got from Highline).
33
+ #
34
+ # ==== Example
35
+ # say("I know you knew that.")
36
+ #
37
+ def say(message="", color=nil, force_new_line=(message.to_s !~ /( |\t)$/))
38
+ message = message.to_s
39
+ message = set_color(message, color) if color
40
+
41
+ spaces = " " * padding
42
+
43
+ if force_new_line
44
+ $stdout.puts(spaces + message)
45
+ else
46
+ $stdout.print(spaces + message)
47
+ end
48
+ $stdout.flush
49
+ end
50
+
51
+ # Say a status with the given color and appends the message. Since this
52
+ # method is used frequently by actions, it allows nil or false to be given
53
+ # in log_status, avoiding the message from being shown. If a Symbol is
54
+ # given in log_status, it's used as the color.
55
+ #
56
+ def say_status(status, message, log_status=true)
57
+ return if quiet? || log_status == false
58
+ spaces = " " * (padding + 1)
59
+ color = log_status.is_a?(Symbol) ? log_status : :green
60
+
61
+ status = status.to_s.rjust(12)
62
+ status = set_color status, color, true if color
63
+
64
+ $stdout.puts "#{status}#{spaces}#{message}"
65
+ $stdout.flush
66
+ end
67
+
68
+ # Make a question the to user and returns true if the user replies "y" or
69
+ # "yes".
70
+ #
71
+ def yes?(statement, color=nil)
72
+ ask(statement, color) =~ is?(:yes)
73
+ end
74
+
75
+ # Make a question the to user and returns true if the user replies "n" or
76
+ # "no".
77
+ #
78
+ def no?(statement, color=nil)
79
+ !yes?(statement, color)
80
+ end
81
+
82
+ # Prints a table.
83
+ #
84
+ # ==== Parameters
85
+ # Array[Array[String, String, ...]]
86
+ #
87
+ # ==== Options
88
+ # ident<Integer>:: Indent the first column by ident value.
89
+ # colwidth<Integer>:: Force the first column to colwidth spaces wide.
90
+ #
91
+ def print_table(table, options={})
92
+ return if table.empty?
93
+
94
+ formats, ident, colwidth = [], options[:ident].to_i, options[:colwidth]
95
+ options[:truncate] = terminal_width if options[:truncate] == true
96
+
97
+ formats << "%-#{colwidth + 2}s" if colwidth
98
+ start = colwidth ? 1 : 0
99
+
100
+ start.upto(table.first.length - 2) do |i|
101
+ maxima ||= table.max{|a,b| a[i].size <=> b[i].size }[i].size
102
+ formats << "%-#{maxima + 2}s"
103
+ end
104
+
105
+ formats[0] = formats[0].insert(0, " " * ident)
106
+ formats << "%s"
107
+
108
+ table.each do |row|
109
+ sentence = ""
110
+
111
+ row.each_with_index do |column, i|
112
+ sentence << formats[i] % column.to_s
113
+ end
114
+
115
+ sentence = truncate(sentence, options[:truncate]) if options[:truncate]
116
+ $stdout.puts sentence
117
+ end
118
+ end
119
+
120
+ # Prints a long string, word-wrapping the text to the current width of the
121
+ # terminal display. Ideal for printing heredocs.
122
+ #
123
+ # ==== Parameters
124
+ # String
125
+ #
126
+ # ==== Options
127
+ # ident<Integer>:: Indent each line of the printed paragraph by ident value.
128
+ #
129
+ def print_wrapped(message, options={})
130
+ ident = options[:ident] || 0
131
+ width = terminal_width - ident
132
+ paras = message.split("\n\n")
133
+
134
+ paras.map! do |unwrapped|
135
+ unwrapped.strip.gsub(/\n/, " ").squeeze(" ").
136
+ gsub(/.{1,#{width}}(?:\s|\Z)/){($& + 5.chr).
137
+ gsub(/\n\005/,"\n").gsub(/\005/,"\n")}
138
+ end
139
+
140
+ paras.each do |para|
141
+ para.split("\n").each do |line|
142
+ $stdout.puts line.insert(0, " " * ident)
143
+ end
144
+ $stdout.puts unless para == paras.last
145
+ end
146
+ end
147
+
148
+ # Deals with file collision and returns true if the file should be
149
+ # overwriten and false otherwise. If a block is given, it uses the block
150
+ # response as the content for the diff.
151
+ #
152
+ # ==== Parameters
153
+ # destination<String>:: the destination file to solve conflicts
154
+ # block<Proc>:: an optional block that returns the value to be used in diff
155
+ #
156
+ def file_collision(destination)
157
+ return true if @always_force
158
+ options = block_given? ? "[Ynaqdh]" : "[Ynaqh]"
159
+
160
+ while true
161
+ answer = ask %[Overwrite #{destination}? (enter "h" for help) #{options}]
162
+
163
+ case answer
164
+ when is?(:yes), is?(:force), ""
165
+ return true
166
+ when is?(:no), is?(:skip)
167
+ return false
168
+ when is?(:always)
169
+ return @always_force = true
170
+ when is?(:quit)
171
+ say 'Aborting...'
172
+ raise SystemExit
173
+ when is?(:diff)
174
+ show_diff(destination, yield) if block_given?
175
+ say 'Retrying...'
176
+ else
177
+ say file_collision_help
178
+ end
179
+ end
180
+ end
181
+
182
+ # Called if something goes wrong during the execution. This is used by Thor
183
+ # internally and should not be used inside your scripts. If someone went
184
+ # wrong, you can always raise an exception. If you raise a Thor::Error, it
185
+ # will be rescued and wrapped in the method below.
186
+ #
187
+ def error(statement)
188
+ $stderr.puts statement
189
+ end
190
+
191
+ # Apply color to the given string with optional bold. Disabled in the
192
+ # Thor::Shell::Basic class.
193
+ #
194
+ def set_color(string, color, bold=false) #:nodoc:
195
+ string
196
+ end
197
+
198
+ protected
199
+
200
+ def is?(value) #:nodoc:
201
+ value = value.to_s
202
+
203
+ if value.size == 1
204
+ /\A#{value}\z/i
205
+ else
206
+ /\A(#{value}|#{value[0,1]})\z/i
207
+ end
208
+ end
209
+
210
+ def file_collision_help #:nodoc:
211
+ <<HELP
212
+ Y - yes, overwrite
213
+ n - no, do not overwrite
214
+ a - all, overwrite this and all others
215
+ q - quit, abort
216
+ d - diff, show the differences between the old and the new
217
+ h - help, show this help
218
+ HELP
219
+ end
220
+
221
+ def show_diff(destination, content) #:nodoc:
222
+ diff_cmd = ENV['THOR_DIFF'] || ENV['RAILS_DIFF'] || 'diff -u'
223
+
224
+ Tempfile.open(File.basename(destination), File.dirname(destination)) do |temp|
225
+ temp.write content
226
+ temp.rewind
227
+ system %(#{diff_cmd} "#{destination}" "#{temp.path}")
228
+ end
229
+ end
230
+
231
+ def quiet? #:nodoc:
232
+ base && base.options[:quiet]
233
+ end
234
+
235
+ # This code was copied from Rake, available under MIT-LICENSE
236
+ # Copyright (c) 2003, 2004 Jim Weirich
237
+ def terminal_width
238
+ if ENV['THOR_COLUMNS']
239
+ result = ENV['THOR_COLUMNS'].to_i
240
+ else
241
+ result = unix? ? dynamic_width : 80
242
+ end
243
+ (result < 10) ? 80 : result
244
+ rescue
245
+ 80
246
+ end
247
+
248
+ # Calculate the dynamic width of the terminal
249
+ def dynamic_width
250
+ @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
251
+ end
252
+
253
+ def dynamic_width_stty
254
+ %x{stty size 2>/dev/null}.split[1].to_i
255
+ end
256
+
257
+ def dynamic_width_tput
258
+ %x{tput cols 2>/dev/null}.to_i
259
+ end
260
+
261
+ def unix?
262
+ RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
263
+ end
264
+
265
+ def truncate(string, width)
266
+ if string.length <= width
267
+ string
268
+ else
269
+ ( string[0, width-3] || "" ) + "..."
270
+ end
271
+ end
272
+
273
+ end
274
+ end
275
+ end
@@ -0,0 +1,108 @@
1
+ require 'thor/shell/basic'
2
+
3
+ class Thor
4
+ module Shell
5
+ # Inherit from Thor::Shell::Basic and add set_color behavior. Check
6
+ # 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
+ def set_color(string, color, bold=false)
54
+ color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
55
+ bold = bold ? BOLD : ""
56
+ "#{bold}#{color}#{string}#{CLEAR}"
57
+ end
58
+
59
+ protected
60
+
61
+ # Overwrite show_diff to show diff with colors if Diff::LCS is
62
+ # available.
63
+ #
64
+ def show_diff(destination, content) #:nodoc:
65
+ if diff_lcs_loaded? && ENV['THOR_DIFF'].nil? && ENV['RAILS_DIFF'].nil?
66
+ actual = File.binread(destination).to_s.split("\n")
67
+ content = content.to_s.split("\n")
68
+
69
+ Diff::LCS.sdiff(actual, content).each do |diff|
70
+ output_diff_line(diff)
71
+ end
72
+ else
73
+ super
74
+ end
75
+ end
76
+
77
+ def output_diff_line(diff) #:nodoc:
78
+ case diff.action
79
+ when '-'
80
+ say "- #{diff.old_element.chomp}", :red, true
81
+ when '+'
82
+ say "+ #{diff.new_element.chomp}", :green, true
83
+ when '!'
84
+ say "- #{diff.old_element.chomp}", :red, true
85
+ say "+ #{diff.new_element.chomp}", :green, true
86
+ else
87
+ say " #{diff.old_element.chomp}", nil, true
88
+ end
89
+ end
90
+
91
+ # Check if Diff::LCS is loaded. If it is, use it to create pretty output
92
+ # for diff.
93
+ #
94
+ def diff_lcs_loaded? #:nodoc:
95
+ return true if defined?(Diff::LCS)
96
+ return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
97
+
98
+ @diff_lcs_loaded = begin
99
+ require 'diff/lcs'
100
+ true
101
+ rescue LoadError
102
+ false
103
+ end
104
+ end
105
+
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,121 @@
1
+ require 'thor/shell/basic'
2
+
3
+ class Thor
4
+ module Shell
5
+ # Inherit from Thor::Shell::Basic and add set_color behavior. Check
6
+ # Thor::Shell::Basic to see all available methods.
7
+ #
8
+ class HTML < Basic
9
+ # The start of an HTML bold sequence.
10
+ BOLD = "<strong>"
11
+ # The end of an HTML bold sequence.
12
+ END_BOLD = "</strong>"
13
+
14
+ # Embed in a String to clear previous color selection.
15
+ CLEAR = "</span>"
16
+
17
+ # Set the terminal's foreground HTML color to black.
18
+ BLACK = '<span style="color: black;">'
19
+ # Set the terminal's foreground HTML color to red.
20
+ RED = '<span style="color: red;">'
21
+ # Set the terminal's foreground HTML color to green.
22
+ GREEN = '<span style="color: green;">'
23
+ # Set the terminal's foreground HTML color to yellow.
24
+ YELLOW = '<span style="color: yellow;">'
25
+ # Set the terminal's foreground HTML color to blue.
26
+ BLUE = '<span style="color: blue;">'
27
+ # Set the terminal's foreground HTML color to magenta.
28
+ MAGENTA = '<span style="color: magenta;">'
29
+ # Set the terminal's foreground HTML color to cyan.
30
+ CYAN = '<span style="color: cyan;">'
31
+ # Set the terminal's foreground HTML color to white.
32
+ WHITE = '<span style="color: white;">'
33
+
34
+ # Set the terminal's background HTML color to black.
35
+ ON_BLACK = '<span style="background-color: black">'
36
+ # Set the terminal's background HTML color to red.
37
+ ON_RED = '<span style="background-color: red">'
38
+ # Set the terminal's background HTML color to green.
39
+ ON_GREEN = '<span style="background-color: green">'
40
+ # Set the terminal's background HTML color to yellow.
41
+ ON_YELLOW = '<span style="background-color: yellow">'
42
+ # Set the terminal's background HTML color to blue.
43
+ ON_BLUE = '<span style="background-color: blue">'
44
+ # Set the terminal's background HTML color to magenta.
45
+ ON_MAGENTA = '<span style="background-color: magenta">'
46
+ # Set the terminal's background HTML color to cyan.
47
+ ON_CYAN = '<span style="background-color: cyan">'
48
+ # Set the terminal's background HTML color to white.
49
+ ON_WHITE = '<span style="background-color: white">'
50
+
51
+ # Set color by using a string or one of the defined constants. If a third
52
+ # option is set to true, it also adds bold to the string. This is based
53
+ # on Highline implementation and it automatically appends CLEAR to the end
54
+ # of the returned String.
55
+ #
56
+ def set_color(string, color, bold=false)
57
+ color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
58
+ bold, end_bold = bold ? [BOLD, END_BOLD] : ['', '']
59
+ "#{bold}#{color}#{string}#{CLEAR}#{end_bold}"
60
+ end
61
+
62
+ # Ask something to the user and receives a response.
63
+ #
64
+ # ==== Example
65
+ # ask("What is your name?")
66
+ #
67
+ # TODO: Implement #ask for Thor::Shell::HTML
68
+ def ask(statement, color=nil)
69
+ raise NotImplementedError, "Implement #ask for Thor::Shell::HTML"
70
+ end
71
+
72
+ protected
73
+
74
+ # Overwrite show_diff to show diff with colors if Diff::LCS is
75
+ # available.
76
+ #
77
+ def show_diff(destination, content) #:nodoc:
78
+ if diff_lcs_loaded? && ENV['THOR_DIFF'].nil? && ENV['RAILS_DIFF'].nil?
79
+ actual = File.binread(destination).to_s.split("\n")
80
+ content = content.to_s.split("\n")
81
+
82
+ Diff::LCS.sdiff(actual, content).each do |diff|
83
+ output_diff_line(diff)
84
+ end
85
+ else
86
+ super
87
+ end
88
+ end
89
+
90
+ def output_diff_line(diff) #:nodoc:
91
+ case diff.action
92
+ when '-'
93
+ say "- #{diff.old_element.chomp}", :red, true
94
+ when '+'
95
+ say "+ #{diff.new_element.chomp}", :green, true
96
+ when '!'
97
+ say "- #{diff.old_element.chomp}", :red, true
98
+ say "+ #{diff.new_element.chomp}", :green, true
99
+ else
100
+ say " #{diff.old_element.chomp}", nil, true
101
+ end
102
+ end
103
+
104
+ # Check if Diff::LCS is loaded. If it is, use it to create pretty output
105
+ # for diff.
106
+ #
107
+ def diff_lcs_loaded? #:nodoc:
108
+ return true if defined?(Diff::LCS)
109
+ return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
110
+
111
+ @diff_lcs_loaded = begin
112
+ require 'diff/lcs'
113
+ true
114
+ rescue LoadError
115
+ false
116
+ end
117
+ end
118
+
119
+ end
120
+ end
121
+ end