Module: Tracking::CLI
Overview
Contains methods for displaying the list in a command line and parsing command line arguments.
Instance Method Summary collapse
-
#display(max = Config[:lines]) ⇒ Object
Displays part of the list in the command line.
-
#display_object(type) ⇒ Object
Displays commonly used text objects in the command line.
-
#pad(string, length, align = :left) ⇒ String
Pads tasks with whitespace to align them for display.
-
#parse ⇒ Object
Use option parser to parse command line arguments and run the selected command with its selected options.
-
#split_task(task) ⇒ Array
Word wraps tasks into multiple lines for display (based on the user’s task width setting).
Instance Method Details
#display(max = Config[:lines]) ⇒ Object
Displays part of the list in the command line
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/tracking/cli.rb', line 22 def display max=Config[:lines] display_object :top tasks = List.get max if tasks.length > 0 tasks.each_with_index do |task, task_index| current_task = (task_index + 1 == tasks.length) split_task(task.name).each_with_index do |name_line, line_index| col_1 = pad(line_index==0 ? task.start_time : nil, 5) col_2 = pad(name_line, @name_width) col_3 = pad(line_index==0 ? task.elapsed_time : nil, @elapsed_time_width) if current_task and Config[:color_current_task] col_1,col_2,col_3 = col_1.yellow,col_2.yellow,col_3.yellow end puts "| #{col_1} | #{col_2} | #{col_3} |" end end else display_object :intro end display_object :bottom # Display a warning, if needed =begin if invalid_lines > 0 warn "Error: #{invalid_lines} invalid line#{'s' if invalid_lines > 1} found in data file." end =end end |
#display_object(type) ⇒ Object
Displays commonly used text objects in the command line
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/tracking/cli.rb', line 53 def display_object type horizontal_border = "+-------+-#{'-'*@name_width}-+-#{'-'*@elapsed_time_width}-+" case type when :top puts horizontal_border if Config[:show_header] puts "| start | #{pad('task', @name_width, :center)} | #{pad('elapsed', @elapsed_time_width, :center)} |" puts horizontal_border end when :bottom puts horizontal_border when :intro intro_text = <<-EOF You haven't started any tasks yet! :( Run this to begin your first task: tracking starting some work EOF intro_text.each_line do |line| puts "| | #{pad(line.chomp, @name_width)} | #{pad(nil, @elapsed_time_width)} |" end end end |
#pad(string, length, align = :left) ⇒ String
Pads tasks with whitespace to align them for display
string (:left/:right/:center)
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/tracking/cli.rb', line 84 def pad(string, length, align=:left) if string == nil return ' ' * length elsif string.length >= length return string else difference = (length - string.length).to_f case align when :left return string + ' ' * difference when :right return ' ' * difference + string when :center return ' '*(difference/2).floor + string + ' '*(difference/2).ceil else return string end end end |
#parse ⇒ Object
Use option parser to parse command line arguments and run the selected command with its selected options
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/tracking/cli.rb', line 160 def parse #options = {} done = false OptionParser.new do |opts| # Setup version_path = File.('../../VERSION', File.dirname(__FILE__)) opts.version = File.exist?(version_path) ? File.read(version_path) : '' # Start of help text opts. = 'Usage: tracking [mode]' opts.separator ' display tasks' opts.separator ' <task description> start a new task with the given text (spaces allowed)' # Modes opts.on('-r', '--rename', 'rename the last task') do List.rename ARGV.join(' ').gsub("\t",'') display done = true return end opts.on('-d', '--delete', 'delete the last task') do List.delete display done = true return end opts.on('-c', '--clear', 'delete all tasks') do List.clear puts 'List cleared.' done = true return end opts.on('-h', '--help', 'display this help information') do puts opts done = true return end end.parse! # Basic modes (display and add) unless done if ARGV.count == 0 # Display all tasks display else # Start a new task List.add ARGV.join(' ').gsub("\t",'') display end end end |
#split_task(task) ⇒ Array
Word wraps tasks into multiple lines for display (based on the user’s task width setting)
wrapped text
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/tracking/cli.rb', line 110 def split_task task # If the task fits if task.length <= Config[:task_width] return [task] # If the task needs to be split else words = task.split(' ') split = [] line = '' words.each do |word| # If the word needs to be split if word.length > Config[:task_width] # Add the start of the word onto the first line (even if it has # already started) while line.length < Config[:task_width] line += word[0] word = word[1..-1] end split << line # Split the rest of the word up onto new lines split_word = word.scan(%r[.{1,#{Config[:task_width]}}]) split_word[0..-2].each do |word_section| split << word_section end line = split_word.last # If the word would fit on a new line elsif (line + word).length > Config[:task_width] split << line.chomp line = word # If the word can be added to this line else line += word end # Add a space to the end of the last word, if it would fit line += ' ' if line.length != Config[:task_width] end split << line return split end end |