module SimpleCommander::UI
User Interaction¶ ↑
Commander's user interaction module mixes in common methods which extend HighLine's functionality such as a password method rather than calling ask directly.
Public Instance Methods
Execute apple script.
# File lib/simple_commander/user_interaction.rb, line 191 def applescript(script) %x`osascript -e "#{ script.gsub('"', '\"') }"` end
Prompt an editor for input. Optionally supply initial input which is written to the editor.
preferred_editor can be hinted.
Examples¶ ↑
ask_editor # => prompts EDITOR with no input ask_editor('foo') # => prompts EDITOR with default text of 'foo' ask_editor('foo', 'mate -w') # => prompts TextMate with default text of 'foo'
# File lib/simple_commander/user_interaction.rb, line 258 def ask_editor(input = nil, preferred_editor = nil) editor = available_editor preferred_editor program = SimpleCommander::Runner.instance.program(:name).downcase rescue 'commander' tmpfile = Tempfile.new program begin tmpfile.write input if input tmpfile.close system("#{editor} #{tmpfile.path.shellescape}") ? IO.read(tmpfile.path) : nil ensure tmpfile.unlink end end
Find an editor available in path. Optionally supply the preferred editor. Returns the name as a string, nil if none is available.
# File lib/simple_commander/user_interaction.rb, line 239 def available_editor(preferred = nil) [preferred, ENV['EDITOR'], 'mate -w', 'vim', 'vi', 'emacs', 'nano', 'pico'] .compact .find { |name| system("hash #{name.split.first} 2>&-") } end
Choose from a set array of choices.
# File lib/simple_commander/user_interaction.rb, line 41 def choose(message = nil, *choices, &block) say message if message super(*choices, &block) end
'Say' something using the specified color
Examples¶ ↑
color 'I am blue', :blue color 'I am bold', :bold color 'White on Red', :white, :on_red
Notes¶ ↑
You may use: * color: black blue cyan green magenta red white yellow * style: blink bold clear underline * highligh: on_<color>
# File lib/simple_commander/user_interaction.rb, line 115 def color(*args) say $terminal.color(*args) end
Converse with speech recognition.
Currently a “poorman's” DSL to utilize applescript and the MacOS speech recognition server.
Examples¶ ↑
case converse 'What is the best food?', :cookies => 'Cookies', :unknown => 'Nothing' when :cookies speak 'o.m.g. you are awesome!' else case converse 'That is lame, shall I convince you cookies are the best?', :yes => 'Ok', :no => 'No', :maybe => 'Maybe another time' when :yes speak 'Well you see, cookies are just fantastic.' else speak 'Ok then, bye.' end end
Notes¶ ↑
-
MacOS only
# File lib/simple_commander/user_interaction.rb, line 166 def converse(prompt, responses = {}) i, commands = 0, responses.map { |_key, value| value.inspect }.join(',') statement = responses.inject '' do |inner_statement, (key, value)| inner_statement << ( (i += 1) == 1 ? %Q(if response is "#{value}" then\n) : %Q(else if response is "#{value}" then\n) ) << %Q(do shell script "echo '#{key}'"\n) end applescript( %Q( tell application "SpeechRecognitionServer" set response to listen for {#{commands}} with prompt "#{prompt}" #{statement} end if end tell ), ).strip.to_sym end
Enable paging of output after called.
# File lib/simple_commander/user_interaction.rb, line 274 def enable_paging return unless $stdout.tty? return unless Process.respond_to? :fork read, write = IO.pipe # Kernel.fork is not supported on all platforms and configurations. # As of Ruby 1.9, `Process.respond_to? :fork` should return false on # configurations that don't support it, but versions before 1.9 don't # seem to do this reliably and instead raise a NotImplementedError # (which is rescued below). if Kernel.fork $stdin.reopen read write.close read.close Kernel.select [$stdin] ENV['LESS'] = 'FSRX' unless ENV.key? 'LESS' pager = ENV['PAGER'] || 'less' exec pager rescue exec '/bin/sh', '-c', pager else # subprocess $stdout.reopen write $stderr.reopen write if $stderr.tty? write.close read.close end rescue NotImplementedError ensure write.close if write && !write.closed? read.close if read && !read.closed? end
Normalize IO streams, allowing for redirection of input
and/or
output
, for example:
$ foo # => read from terminal I/O $ foo in # => read from 'in' file, output to terminal output stream $ foo in out # => read from 'in' file, output to 'out' file $ foo < in > out # => equivalent to above (essentially)
Optionally a block
may be supplied, in which case IO will be
reset once the block has executed.
Examples¶ ↑
command :foo do |c| c.syntax = 'foo [input] [output]' c.when_called do |args, options| # or io(args.shift, args.shift) io *args str = $stdin.gets puts 'input was: ' + str.inspect end end
# File lib/simple_commander/user_interaction.rb, line 220 def io(input = nil, output = nil, &block) $stdin = File.new(input) if input $stdout = File.new(output, 'r+') if output return unless block yield reset_io end
'Log' an action to the terminal. This is typically used for verbose output regarding actions performed. For example:
create path/to/file.rb remove path/to/old_file.rb remove path/to/old_file2.rb
# File lib/simple_commander/user_interaction.rb, line 55 def log(action, *args) say format('%15s %s', action, args.join(' ')) end
Ask the user for a password. Specify a custom message other than 'Password: ' or override the default mask of '*'.
# File lib/simple_commander/user_interaction.rb, line 32 def password(message = 'Password: ', mask = '*') pass = ask(message) { |q| q.echo = mask } pass = password message, mask if pass.nil? || pass.empty? pass end
Output progress while iterating arr.
Examples¶ ↑
uris = %w( http://vision-media.ca http://google.com ) progress uris, :format => "Remaining: :time_remaining" do |uri| res = open uri end
# File lib/simple_commander/user_interaction.rb, line 317 def progress(arr, options = {}) bar = ProgressBar.new arr.length, options bar.show arr.each { |v| bar.increment yield(v) } end
Reset IO to initial constant streams.
# File lib/simple_commander/user_interaction.rb, line 231 def reset_io $stdin, $stdout = STDIN, STDOUT end
Speak message using voice at a speaking rate of rate
Voice defaults to 'Alex', which is one of the better voices. Speaking rate defaults to 175 words per minute
Examples¶ ↑
speak 'What is your favorite food? ' food = ask 'favorite food?: ' speak "Wow, I like #{food} too. We have so much in common." speak "I like #{food} as well!", "Victoria", 190
Notes¶ ↑
-
MacOS only
# File lib/simple_commander/user_interaction.rb, line 137 def speak(message, voice = :Alex, rate = 175) Thread.new { applescript "say #{message.inspect} using #{voice.to_s.inspect} speaking rate #{rate}" } end