Class: SugarCane::Menu

Inherits:
Object
  • Object
show all
Defined in:
lib/sugarcane/menu.rb

Overview

Produces a ncurses menu that the user can navigate with:

J/  K: Move up/down
    Q: Quit
Enter: Open violation in text editor

Constructor Parameters:

checks: like ones produced from style_check.rb or doc_check.rb
opts: command-line parsed options applied to each check
height: the maximum number of items that can be in the menu

Constant Summary collapse

TITLE = 
"___ _   _  __ _  __ _ _ __ ___ __ _ _ __   ___\n / __| | | |/ _` |/ _` | '__/ __/ _` | '_ \\ / _ \\\n \\__ \\ |_| | (_| | (_| | | | (_| (_| | | | |  __/\n |___/\\__,_|\\__, |\\__,_|_|  \\___\\__,_|_| |_|\\___|\n          |___/\n"
KEY_C =

Don’t trust ncursew keys as they don’t always work

99
KEY_Q = 
113
KEY_X = 
120
KEY_J = 
106
KEY_K = 
107
KEY_W = 
119
KEY_S = 
115
KEY_O = 
111
KEY_UP = 
259
KEY_DOWN = 
258
KEY_ENTER = 
13
KEY_SPACE = 
32

Instance Method Summary collapse

Constructor Details

#initialize(checks, options, height = 30) ⇒ Menu

Returns a new instance of Menu.



38
39
40
41
42
43
 
# File 'lib/sugarcane/menu.rb', line 38

def initialize(checks, options, height = 30)
  @checks = checks
  @options = options
  @height = height
  check_violations
end

Instance Method Details

#check_violations ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/sugarcane/menu.rb', line 211

def check_violations
  violations = @checks.
    map {|check| check.new(@options).violations }.
    flatten
  @data = violations
  @height = [@data.size,@height].min
  @size = @data.size
  @min_position = 0
  @max_position = @height - 1
  @data_position ||= 0
  @menu_position ||= 0
  if @data_position > @size - 1
    @data_position = @size - 1
  end
  return violations
end

#clean_up ⇒ Object 



168
169
170
171
172
173
174
175
 
# File 'lib/sugarcane/menu.rb', line 168

def clean_up
  Ncurses.stdscr.clear
  Ncurses.stdscr.refresh
  Ncurses.echo
  Ncurses.nocbreak
  Ncurses.nl
  Ncurses.endwin
end

#draw_fix_window(window) ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'lib/sugarcane/menu.rb', line 138

def draw_fix_window(window)
  window.clear
  window.border(*([0]*8))
  window.move(1, 1)
  line = "Violations left: #{@data.size}"
  window.addstr(line)
  window.refresh
end

#draw_menu(menu, active_index = nil) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/sugarcane/menu.rb', line 89

def draw_menu(menu, active_index=nil)
  Ncurses.stdscr.border(*([0]*8))
  Ncurses.stdscr.refresh
  menu.clear
  menu.border(*([0]*8))
  @height.times do |i|
    menu.move(i + 1, 1)
    position = i + @data_position - @menu_position
    file = @data[position][:file]
    if @data[position][:line]
      line = " #{@data[position][:line]}: "
    else
      line = " "
    end
    desc = @data[position][:menu_description] || ""
    if desc.length > Ncurses.COLS - 10
      desc << "..."
    end
    if i == active_index
      style = Ncurses::A_STANDOUT
      menu.attrset(style)
      menu.addstr(file)
      menu.addstr(line)
      menu.addstr(desc)
      menu.attrset(Ncurses::A_NORMAL)
    else
      menu.attrset(Ncurses.COLOR_PAIR(2))
      menu.addstr(file)
      menu.attrset(Ncurses.COLOR_PAIR(3))
      menu.addstr(line)
      menu.attrset(Ncurses.COLOR_PAIR(4))
      menu.addstr(desc)
      # menu.attrset(Ncurses.COLOR_PAIR(1))
      menu.attrset(Ncurses::A_NORMAL)
    end
  end
  menu.refresh
  Ncurses.keypad(menu, true)
end

#draw_title_window(window) ⇒ Object 



129
130
131
132
133
134
135
136
 
# File 'lib/sugarcane/menu.rb', line 129

def draw_title_window(window)
  window.clear
  # window.border(*([0]*8))
  window.attrset(Ncurses.COLOR_PAIR(5))
  window.addstr(TITLE)
  window.attrset(Ncurses.COLOR_PAIR(1))
  window.refresh
end

#edit_file(file, line) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/sugarcane/menu.rb', line 177

def edit_file(file, line)
  if @options[:editor]
    system("#{@options[:editor]} +#{line} #{file}")
  # If someone purchased sublime, they probably want to use it
  elsif program_exist? "subl"
    system("subl #{file}:#{line}")
  elsif ENV['VISUAL']
    system("#{ENV['VISUAL']} +#{line} #{file}")
  elsif program_exist? "vim"
    system("vim +#{line} #{file}")
  elsif program_exist? "gedit"
    system("gedit +#{line} #{file}")
  elsif program_exist? "nano"
    system("nano +#{line} #{file}")
  elsif program_exist? "geany"
    system("geany +#{line} #{file}")
  else
    # :(
    system("notepad.exe #{file}")
  end
end

#init_ncurses ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/sugarcane/menu.rb', line 147

def init_ncurses
  Ncurses.cbreak
  Ncurses.start_color
  Ncurses.noecho
  Ncurses.nonl
  Ncurses.curs_set(0)

  if Ncurses.has_colors?
    @background_color = Ncurses::COLOR_BLACK
    Ncurses.init_pair(1, Ncurses::COLOR_WHITE, @background_color)
    Ncurses.init_pair(2, Ncurses::COLOR_BLUE, @background_color)
    Ncurses.init_pair(3, Ncurses::COLOR_CYAN, @background_color)
    Ncurses.init_pair(4, Ncurses::COLOR_RED, @background_color)
    Ncurses.init_pair(5, Ncurses::COLOR_GREEN, @background_color)
  end

  @title_window = Ncurses::WINDOW.new(5, Ncurses.COLS - 2,2,1)
  @menu = Ncurses::WINDOW.new(@height + 2, Ncurses.COLS - 2,7,1)
  @fix_window = Ncurses::WINDOW.new(3, Ncurses.COLS - 2,@height+9,1)
end

#program_exist?(command) ⇒ Boolean

Allegedly cross-platform way to determine if an executable is in PATH

Returns:

  • (Boolean) 


200
201
202
203
204
205
206
207
208
209
 
# File 'lib/sugarcane/menu.rb', line 200

def program_exist?(command)
  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
  ENV['PATH'].split(::File::PATH_SEPARATOR).each do |path|
    exts.each { |ext|
      exe = ::File.join(path, "#{command}#{ext}")
      return exe if ::File.executable? exe
    }
  end
  return nil
end

#run ⇒ Object 



45
46
47
48
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
 
# File 'lib/sugarcane/menu.rb', line 45

def run
  if @data.nil? or @data.empty?
    return nil
  end
  begin
    # can't go in separate function because redeclares constants
    Ncurses.initscr
    init_ncurses
    draw_menu(@menu, @menu_position)
    draw_fix_window(@fix_window)
    draw_title_window(@title_window)
    while ch = @menu.wgetch
      case ch
      when KEY_K, KEY_W, KEY_UP
        # draw menu, 'move up'
        @menu_position -= 1 unless @menu_position == @min_position
        @data_position -= 1 unless @data_position == 0
      when KEY_J, KEY_S, KEY_DOWN
        # draw_info 'move down'
        @menu_position += 1 unless @menu_position == @max_position
        @data_position += 1 unless @data_position == @size - 1
      when KEY_O, KEY_ENTER, KEY_SPACE
        clean_up
        selected = @data[@data_position]
        edit_file(selected[:file], selected[:line])
        init_ncurses
        check_violations
      when KEY_Q, KEY_X
        clean_up
        break
      end
      # For cycling through the options but is buggy
      # @data_position = @size - 1 if @data_position < 0
      # @data_position = 0 if @data_position > @size - 1
      draw_menu(@menu, @menu_position)
      draw_fix_window(@fix_window)
      draw_title_window(@title_window)
    end
    return @data[@data_position]
  ensure
    clean_up
  end
end