msd-fretboard 0.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/COPYING +340 -0
  2. data/bin/fb +11 -0
  3. data/lib/ansicolor.rb +20 -0
  4. data/lib/fretboard.rb +321 -0
  5. metadata +56 -0
data/COPYING ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ <signature of Ty Coon>, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
340
+
data/bin/fb ADDED
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/ruby -w
2
+ #
3
+ # fb -- command line program providing drills for learning the guitar
4
+ # fretboard
5
+ #
6
+
7
+ require 'fretboard'
8
+
9
+ opts = Fretboard::parse_args(ARGV)
10
+ f = Fretboard.new(opts)
11
+ f.run
data/lib/ansicolor.rb ADDED
@@ -0,0 +1,20 @@
1
+ class AnsiColor
2
+ def green(s)
3
+ "\e[32m#{s}\e[0m"
4
+ end
5
+
6
+ def red(s)
7
+ "\e[31m#{s}\e[0m"
8
+ end
9
+ end
10
+
11
+ class NoColor
12
+ def green(s)
13
+ s
14
+ end
15
+
16
+ def red(s)
17
+ s
18
+ end
19
+ end
20
+
data/lib/fretboard.rb ADDED
@@ -0,0 +1,321 @@
1
+ #!/usr/bin/ruby -w
2
+ #
3
+ # Fretboard -- class to be used to learn the guitar fretboard
4
+ #
5
+ # == Synopsis
6
+ # This program provides configurable drilling sessions for learning
7
+ # the notes on the guitar fretboard. Currently, the range of frets
8
+ # is constrained to only the first twelve. Also, only the standard
9
+ # EADGBE tuning is supported by default but is easily changed in the
10
+ # code.
11
+ #
12
+ # == Examples
13
+ # The following command invocation drills the user on only the first
14
+ # two strings (E and B):
15
+ # fretboard -s 1:2
16
+ #
17
+ # The following command invocation constrains drilling to strings
18
+ # 3 and 4 for only frets 7 through 12:
19
+ # fretboard -s 3:4 -f 7:12
20
+ #
21
+ # == Usage
22
+ # See Options below.
23
+ #
24
+ # For help use: fretboard --help
25
+ #
26
+ # == Options
27
+ # -h, --help Display help message
28
+ # -t, --timeout SECONDS Set timeout on user response
29
+ # -f MIN[:MAX] Set fret number(s) to drill
30
+ # (default 0-12)
31
+ # -s MIN[:MAX] Set string number(s) to drill
32
+ # (default 1-6)
33
+ # -d, --display [flat|sharp] Show fretboard
34
+ # -l, --log LOGFILE Log session score to LOGFILE
35
+ # -v, --version Show version
36
+ # -c, --[no-]color Display ANSI color codes
37
+ #
38
+ #
39
+ # == Author
40
+ # Mark DeWandel
41
+ #
42
+ # == Copyright
43
+ # Copyright (c) 2009 Mark DeWandel. Licensed under the GPL:
44
+ # http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
45
+
46
+ require 'optparse'
47
+ require 'timeout'
48
+ require 'pp'
49
+ require 'lib/ansicolor'
50
+
51
+ # Fretboard class for learning the guitar fretboard.
52
+ class Fretboard
53
+ FRETS = 12
54
+ STRINGS = 6
55
+ VERSION = '0.0.5'
56
+
57
+ def self.display_version
58
+ puts "#{File.basename(__FILE__)} version #{VERSION}"
59
+ end
60
+
61
+ def self.parse_args(args)
62
+ options = Hash.new
63
+
64
+ op = OptionParser.new do |opts|
65
+ opts.on("-t SECONDS", "--timeout SECONDS",
66
+ "Set timeout on prompt") do |opt|
67
+ options[:timeout] = opt.to_i
68
+ end
69
+
70
+ opts.on("-f MIN[:MAX]", "--fret MIN[:MAX]",
71
+ "Set fret number(s) to drill (default 0-12)") do |opt|
72
+ o = opt.split(":")
73
+ o.each { |s| s.strip! }
74
+ options[:fret] = o
75
+ end
76
+
77
+ opts.on("-s MIN[:MAX]", "--string MIN[:MAX]",
78
+ "Set string number(s) on which to drill",
79
+ "(default 1-6)") do |opt|
80
+ o = opt.split(":")
81
+ o.each { |s| s.strip! }
82
+ options[:string] = o
83
+ end
84
+
85
+ opts.on("-d [0|1]", "--display [FLAT|SHARP]", "Show fretboard") do |opt|
86
+ options[:show_fretboard] = opt
87
+ end
88
+
89
+ opts.on("-l LOGFILE", "--log LOGFILE", "Log score to LOGFILE") do |opt|
90
+ options[:logfile] = opt
91
+ end
92
+
93
+ opts.on("-c", "--[no-]color", "Display ANSI color codes") do |opt|
94
+ options[:color] = opt
95
+ end
96
+
97
+ opts.on("-v", "--version", "Show version") do
98
+ display_version
99
+ exit 0
100
+ end
101
+ end
102
+
103
+ begin
104
+ op.parse!(args)
105
+ rescue OptionParser::ParseError => e
106
+ puts e
107
+ exit 1
108
+ end
109
+ options
110
+ end
111
+
112
+ def initialize(args)
113
+ @timeout = args[:timeout] || 0
114
+
115
+ # Default is to show ANSI color codes
116
+ if args.has_key?(:color)
117
+ if args[:color]
118
+ @show_color = AnsiColor.new
119
+ else
120
+ @show_color = NoColor.new
121
+ end
122
+ else
123
+ @show_color = AnsiColor.new
124
+ end
125
+
126
+ if args.has_key?(:fret)
127
+ a = args[:fret]
128
+ @first_fret = a[0].to_i
129
+ @last_fret = a.size == 2 ? a[1].to_i : @first_fret
130
+ else
131
+ @first_fret = 0
132
+ @last_fret = FRETS
133
+ end
134
+
135
+ if @first_fret < 0 || @first_fret > FRETS ||
136
+ @last_fret < 0 || @last_fret > FRETS ||
137
+ @first_fret > @last_fret
138
+ raise ArgumentError, "Invalid FRET value/range specified"
139
+ end
140
+
141
+ if args.has_key?(:string)
142
+ a = args[:string]
143
+ @first_string = a[0].to_i
144
+ @last_string = a.size == 2 ? a[1].to_i : @first_string
145
+ else
146
+ @first_string = 1
147
+ @last_string = STRINGS
148
+ end
149
+
150
+ if @first_string < 1 || @first_string > STRINGS ||
151
+ @last_string < 1 || @last_string > STRINGS ||
152
+ @first_string > @last_string
153
+ raise ArgumentError, "Invalid STRING value/range specified"
154
+ end
155
+
156
+ @logfile = nil
157
+ if args.has_key?(:logfile)
158
+ @logfile = File.open(args[:logfile], "a")
159
+ end
160
+
161
+ @frets=(0..FRETS)
162
+ @strings=(0..STRINGS-1)
163
+
164
+ scale_sharps = %w(A A# B C C# D D# E F F# G G#)
165
+ scale_flats = %w(A Bb B C Db D Eb E F Gb G Ab)
166
+ accidentals = [1, 4, 6, 9, 11]
167
+
168
+ # This is for the standard EADGBE tuning
169
+ scale_index = [7, 2, 10, 5, 0, 7]
170
+
171
+ @fretboard = []
172
+
173
+ #
174
+ # Fretboard is an array of strings indexed by fret number
175
+ #
176
+ row = []
177
+ @frets.each do |i|
178
+ @strings.each do |j|
179
+ s = (scale_index[j] + i) % 12
180
+
181
+ # For positions which contain accidentals, represent both
182
+ # sharps and flats for the given string and fret with a
183
+ # subarray.
184
+ if accidentals.include?(s)
185
+ row[j] = [scale_sharps[s], scale_flats[s]]
186
+ else
187
+ row[j] = scale_sharps[s]
188
+ end
189
+ s = (s == scale_sharps.size - 1) ? 0 : s + 1
190
+ end
191
+ @fretboard << row
192
+ row = []
193
+ end
194
+
195
+ if args.has_key?(:show_fretboard)
196
+ self.display(args[:show_fretboard] == "sharp" ? true : false)
197
+ end
198
+
199
+ # Select random fret and string numbers from within the specified
200
+ # ranges
201
+ @fret_max = @last_fret - @first_fret + 1
202
+ @string_max = @last_string - @first_string + 1
203
+
204
+ rescue => e
205
+ puts "Error: " + e
206
+ exit 1
207
+ end
208
+
209
+ # Display an ASCII chart of the guitar fretboard
210
+ def display(sharps = true)
211
+ nut = " ===============================\n"
212
+ pos = " %2d | %-2s | %-2s | %-2s | %-2s | %-2s | %-2s |\n"
213
+ fret = " +-----------------------------+\n"
214
+
215
+ @fretboard.each_with_index do |row, i|
216
+ r = *row.reverse
217
+ r.each_with_index do |e, j|
218
+ if r[j].is_a?(Array)
219
+ slot = sharps ? 0 : 1
220
+ r[j, 1] = r[j][slot]
221
+ end
222
+ end
223
+ if i == 0
224
+ printf(pos, i, *r)
225
+ puts nut
226
+ next
227
+ end
228
+ printf(pos, i, *r)
229
+ puts fret
230
+ end
231
+ end
232
+
233
+ # Return string representation of Fretboard instance.
234
+ def to_s
235
+ str = ""
236
+ @frets.each_with_index do |f, i|
237
+ str << "#{i}: " + @fretboard[f].reverse.inspect + "\n"
238
+ end
239
+ str
240
+ end
241
+ alias :inspect :to_s
242
+
243
+ # Private version of +gets+ which respects optional timeout.
244
+ def gets
245
+ s = ""
246
+ timed_out = false
247
+ begin
248
+ Timeout::timeout(@timeout) do
249
+ s = $stdin.gets
250
+ exit if s == nil
251
+ s.chomp!
252
+ end
253
+ rescue Timeout::Error
254
+ timed_out = true
255
+ end
256
+ [s, timed_out]
257
+ end
258
+
259
+ # Run the main query loop for the fretboard trainer.
260
+ def run
261
+ i = 1
262
+ errors = 0
263
+
264
+ at_exit do
265
+ puts "\n\nYou missed #{errors} out of #{i}.\n\n"
266
+ if @logfile
267
+ t = Time.now
268
+ @logfile.puts "[#{t}] String #{@first_string}:#{@last_string}, " +
269
+ "Fret #{@first_fret}:#{@last_fret} -- Missed #{errors} out of #{i}"
270
+ end
271
+ end
272
+
273
+ # Skip stack traceback on ctrl-c
274
+ trap("SIGINT") { exit }
275
+
276
+ loop do
277
+ s = @first_string + rand(@string_max)
278
+ f = @first_fret + rand(@fret_max)
279
+ printf("\n[#{i}] String #{s}, fret #{f}\n")
280
+ printf("? ")
281
+ $stdout.flush
282
+ ans, timed_out = gets
283
+ ans = ans.chomp.downcase
284
+ note = @fretboard[f][s-1]
285
+ correct = false
286
+
287
+ if note.is_a?(Array)
288
+ puts " #{note[0]} / #{note[1]}"
289
+ if ans == note[0].downcase || ans.downcase == note[1].downcase
290
+ correct = true
291
+ end
292
+ else
293
+ puts " #{@fretboard[f][s-1]}"
294
+ if ans.upcase == @fretboard[f][s-1].to_s
295
+ correct = true
296
+ end
297
+ end
298
+
299
+ if correct
300
+ puts @show_color.green("Correct.")
301
+ else
302
+ errors += 1
303
+ puts @show_color.red("Incorrect.") + (timed_out ? " [Timeout]" : "")
304
+ if timed_out
305
+ printf("\nContinue? ")
306
+ $stdin.gets
307
+ end
308
+ end
309
+
310
+ i += 1
311
+ end
312
+ end
313
+
314
+ private :gets
315
+ end
316
+
317
+ if $0 == __FILE__
318
+ opts = Fretboard::parse_args(ARGV)
319
+ f = Fretboard.new(opts)
320
+ f.run
321
+ end
metadata ADDED
@@ -0,0 +1,56 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: msd-fretboard
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.5
5
+ platform: ruby
6
+ authors:
7
+ - Mark DeWandel
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-02-13 00:00:00 -08:00
13
+ default_executable:
14
+ dependencies: []
15
+
16
+ description:
17
+ email: mark.dewandel@gmail.com
18
+ executables:
19
+ - fb
20
+ extensions: []
21
+
22
+ extra_rdoc_files: []
23
+
24
+ files:
25
+ - COPYING
26
+ - bin/fb
27
+ - lib/ansicolor.rb
28
+ - lib/fretboard.rb
29
+ has_rdoc: false
30
+ homepage:
31
+ post_install_message:
32
+ rdoc_options: []
33
+
34
+ require_paths:
35
+ - lib
36
+ required_ruby_version: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: "0"
41
+ version:
42
+ required_rubygems_version: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: "0"
47
+ version:
48
+ requirements: []
49
+
50
+ rubyforge_project:
51
+ rubygems_version: 1.2.0
52
+ signing_key:
53
+ specification_version: 2
54
+ summary: Program for learning the guitar fretboard
55
+ test_files: []
56
+