madrona-rad 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. data/History.txt +75 -0
  2. data/License.txt +282 -0
  3. data/Manifest.txt +47 -0
  4. data/README.rdoc +51 -0
  5. data/Rakefile +139 -0
  6. data/bin/rad +197 -0
  7. data/lib/libraries/SWSerLCDpa/SWSerLCDpa.cpp +267 -0
  8. data/lib/libraries/SWSerLCDpa/SWSerLCDpa.h +64 -0
  9. data/lib/libraries/SWSerLCDsf/SWSerLCDsf.cpp +254 -0
  10. data/lib/libraries/SWSerLCDsf/SWSerLCDsf.h +57 -0
  11. data/lib/libraries/Servo/Servo.cpp +152 -0
  12. data/lib/libraries/Servo/Servo.h +33 -0
  13. data/lib/libraries/Servo/keywords.txt +25 -0
  14. data/lib/plugins/debounce.rb +116 -0
  15. data/lib/plugins/debug_output_to_lcd.rb +71 -0
  16. data/lib/plugins/input_output_state.rb +84 -0
  17. data/lib/plugins/mem_test.rb +37 -0
  18. data/lib/plugins/servo_pulse.rb +31 -0
  19. data/lib/plugins/servo_setup.rb +86 -0
  20. data/lib/plugins/smoother.rb +54 -0
  21. data/lib/plugins/spark_fun_serial_lcd.rb +100 -0
  22. data/lib/rad/arduino_plugin.rb +202 -0
  23. data/lib/rad/arduino_sketch.rb +952 -0
  24. data/lib/rad/generators/makefile/makefile.erb +243 -0
  25. data/lib/rad/generators/makefile/makefile.rb +39 -0
  26. data/lib/rad/init.rb +12 -0
  27. data/lib/rad/rad_processor.rb +66 -0
  28. data/lib/rad/rad_rewriter.rb +94 -0
  29. data/lib/rad/tasks/build_and_make.rake +159 -0
  30. data/lib/rad/tasks/rad.rb +2 -0
  31. data/lib/rad/todo.txt +13 -0
  32. data/lib/rad/version.rb +9 -0
  33. data/lib/rad.rb +5 -0
  34. data/scripts/txt2html +67 -0
  35. data/setup.rb +1585 -0
  36. data/spec/models/arduino_sketch_spec.rb +82 -0
  37. data/spec/models/spec_helper.rb +2 -0
  38. data/spec/spec.opts +1 -0
  39. data/website/examples/assembler_test.rb.html +73 -0
  40. data/website/examples/gps_reader.rb.html +39 -0
  41. data/website/examples/hello_world.rb.html +38 -0
  42. data/website/examples/serial_motor.rb.html +41 -0
  43. data/website/index.html +177 -0
  44. data/website/index.txt +64 -0
  45. data/website/javascripts/rounded_corners_lite.inc.js +285 -0
  46. data/website/stylesheets/screen.css +169 -0
  47. data/website/template.rhtml +48 -0
  48. metadata +120 -0
data/History.txt ADDED
@@ -0,0 +1,75 @@
1
+ == 0.2.2 2008-04-27
2
+ * 2ish updates:
3
+ - updated makefile template and cli to expect arduino-0011
4
+ - applied David Michael's patch for longs
5
+
6
+ == 0.2.1 2008-04-02
7
+ * 6ish updates:
8
+ - applied Brian Riley's SWSerLCDpa patch
9
+ - experimental libraries system in vendor/libraries
10
+ - fixed require 'yaml' bug in makefile.rb
11
+ - enhancements to the rad command: can set project config.
12
+ - added first significant documentation
13
+ - added examples directory to the website
14
+
15
+ == 0.2.0 2008-03-15
16
+ * 8ish updates, some major:
17
+ * fixed regular serial support
18
+ * class method for writing functions in assembler
19
+ * applied Scott Windsor's patch for software serial support
20
+ * added support for HIGH/LOW/ON/OFF constants
21
+ * add an option for skipping the reset prompt on rake make:upload
22
+ * changed default arduino location to be more realistic
23
+ * put screencasts #1 and #2 on rad.rubyforge.org
24
+ * put google analytics on rad.rubyforge.org
25
+
26
+ == 0.1.1 2007-10-29
27
+ * 2 major fixes:
28
+ * explicitly specify path to arduino avr tools (this was broken on systems that didn't have the avr toolchain installed, oops)
29
+ * add explicit path to avrdude.conf in the upload make target
30
+
31
+ == 0.1.0 2007-10-28
32
+ * 4ish major updates:
33
+ * Arduino interop has been updated, and consequently now requires Arduino 0010:
34
+ * new Makefile imported, with new configuration items (see below)
35
+ * main() function added to C++ output
36
+ * make:upload rake task has been updated
37
+ * C++ generation has been changed to produce a more readable output
38
+ * configuration file changes:
39
+ * hardware
40
+ * fixed typo in serial_port key
41
+ * added mcu key to specify atmega8/atmega168. Defaults to atmega168
42
+ * changed serial_port to /dev/tty.usbserial*, which will pick the first device that matches that blob
43
+ * software
44
+ * updated arduino_root for 0010
45
+ * 2 major enhancement:
46
+ * gem should now correctly install RubyToC
47
+ * can now enable internal pull-up resistors on input pins by passing the :pullup => true parameter to input_pin
48
+ * 2 minor enhancements:
49
+ * cleanups in makefile.rb
50
+ * serial_print_str method added; can now send strings over the serial port
51
+
52
+ == 0.0.4 2007-07-24
53
+
54
+ * 1 major enhancement:
55
+ * serial_begin class method
56
+
57
+ == 0.0.3 2007-07-23
58
+
59
+ * 1 major enhancement:
60
+ * bug fix in blink helper method
61
+
62
+ == 0.0.2 2007-07-23
63
+
64
+ * 1 major enhancement:
65
+ * blink helper method
66
+
67
+ == 0.0.1 2007-07-22
68
+
69
+ * 1 major enhancement:
70
+ * Initial release
71
+ * most features of the Arduino software library functional
72
+ * experimental implementation of the serial interface
73
+ * complete rake-based build, compile, and upload cycle
74
+
75
+
data/License.txt ADDED
@@ -0,0 +1,282 @@
1
+
2
+ GNU GENERAL PUBLIC LICENSE
3
+ Version 2, June 1991
4
+
5
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
6
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
7
+ Everyone is permitted to copy and distribute verbatim copies
8
+ of this license document, but changing it is not allowed.
9
+
10
+ Preamble
11
+
12
+ The licenses for most software are designed to take away your
13
+ freedom to share and change it. By contrast, the GNU General Public
14
+ License is intended to guarantee your freedom to share and change free
15
+ software--to make sure the software is free for all its users. This
16
+ General Public License applies to most of the Free Software
17
+ Foundation's software and to any other program whose authors commit to
18
+ using it. (Some other Free Software Foundation software is covered by
19
+ the GNU Library General Public License instead.) You can apply it to
20
+ your programs, too.
21
+
22
+ When we speak of free software, we are referring to freedom, not
23
+ price. Our General Public Licenses are designed to make sure that you
24
+ have the freedom to distribute copies of free software (and charge for
25
+ this service if you wish), that you receive source code or can get it
26
+ if you want it, that you can change the software or use pieces of it
27
+ in new free programs; and that you know you can do these things.
28
+
29
+ To protect your rights, we need to make restrictions that forbid
30
+ anyone to deny you these rights or to ask you to surrender the rights.
31
+ These restrictions translate to certain responsibilities for you if you
32
+ distribute copies of the software, or if you modify it.
33
+
34
+ For example, if you distribute copies of such a program, whether
35
+ gratis or for a fee, you must give the recipients all the rights that
36
+ you have. You must make sure that they, too, receive or can get the
37
+ source code. And you must show them these terms so they know their
38
+ rights.
39
+
40
+ We protect your rights with two steps: (1) copyright the software, and
41
+ (2) offer you this license which gives you legal permission to copy,
42
+ distribute and/or modify the software.
43
+
44
+ Also, for each author's protection and ours, we want to make certain
45
+ that everyone understands that there is no warranty for this free
46
+ software. If the software is modified by someone else and passed on, we
47
+ want its recipients to know that what they have is not the original, so
48
+ that any problems introduced by others will not reflect on the original
49
+ authors' reputations.
50
+
51
+ Finally, any free program is threatened constantly by software
52
+ patents. We wish to avoid the danger that redistributors of a free
53
+ program will individually obtain patent licenses, in effect making the
54
+ program proprietary. To prevent this, we have made it clear that any
55
+ patent must be licensed for everyone's free use or not licensed at all.
56
+
57
+ The precise terms and conditions for copying, distribution and
58
+ modification follow.
59
+
60
+ GNU GENERAL PUBLIC LICENSE
61
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
62
+
63
+ 0. This License applies to any program or other work which contains
64
+ a notice placed by the copyright holder saying it may be distributed
65
+ under the terms of this General Public License. The "Program", below,
66
+ refers to any such program or work, and a "work based on the Program"
67
+ means either the Program or any derivative work under copyright law:
68
+ that is to say, a work containing the Program or a portion of it,
69
+ either verbatim or with modifications and/or translated into another
70
+ language. (Hereinafter, translation is included without limitation in
71
+ the term "modification".) Each licensee is addressed as "you".
72
+
73
+ Activities other than copying, distribution and modification are not
74
+ covered by this License; they are outside its scope. The act of
75
+ running the Program is not restricted, and the output from the Program
76
+ is covered only if its contents constitute a work based on the
77
+ Program (independent of having been made by running the Program).
78
+ Whether that is true depends on what the Program does.
79
+
80
+ 1. You may copy and distribute verbatim copies of the Program's
81
+ source code as you receive it, in any medium, provided that you
82
+ conspicuously and appropriately publish on each copy an appropriate
83
+ copyright notice and disclaimer of warranty; keep intact all the
84
+ notices that refer to this License and to the absence of any warranty;
85
+ and give any other recipients of the Program a copy of this License
86
+ along with the Program.
87
+
88
+ You may charge a fee for the physical act of transferring a copy, and
89
+ you may at your option offer warranty protection in exchange for a fee.
90
+
91
+ 2. You may modify your copy or copies of the Program or any portion
92
+ of it, thus forming a work based on the Program, and copy and
93
+ distribute such modifications or work under the terms of Section 1
94
+ above, provided that you also meet all of these conditions:
95
+
96
+ a) You must cause the modified files to carry prominent notices
97
+ stating that you changed the files and the date of any change.
98
+
99
+ b) You must cause any work that you distribute or publish, that in
100
+ whole or in part contains or is derived from the Program or any
101
+ part thereof, to be licensed as a whole at no charge to all third
102
+ parties under the terms of this License.
103
+
104
+ c) If the modified program normally reads commands interactively
105
+ when run, you must cause it, when started running for such
106
+ interactive use in the most ordinary way, to print or display an
107
+ announcement including an appropriate copyright notice and a
108
+ notice that there is no warranty (or else, saying that you provide
109
+ a warranty) and that users may redistribute the program under
110
+ these conditions, and telling the user how to view a copy of this
111
+ License. (Exception: if the Program itself is interactive but
112
+ does not normally print such an announcement, your work based on
113
+ the Program is not required to print an announcement.)
114
+
115
+ These requirements apply to the modified work as a whole. If
116
+ identifiable sections of that work are not derived from the Program,
117
+ and can be reasonably considered independent and separate works in
118
+ themselves, then this License, and its terms, do not apply to those
119
+ sections when you distribute them as separate works. But when you
120
+ distribute the same sections as part of a whole which is a work based
121
+ on the Program, the distribution of the whole must be on the terms of
122
+ this License, whose permissions for other licensees extend to the
123
+ entire whole, and thus to each and every part regardless of who wrote it.
124
+
125
+ Thus, it is not the intent of this section to claim rights or contest
126
+ your rights to work written entirely by you; rather, the intent is to
127
+ exercise the right to control the distribution of derivative or
128
+ collective works based on the Program.
129
+
130
+ In addition, mere aggregation of another work not based on the Program
131
+ with the Program (or with a work based on the Program) on a volume of
132
+ a storage or distribution medium does not bring the other work under
133
+ the scope of this License.
134
+
135
+ 3. You may copy and distribute the Program (or a work based on it,
136
+ under Section 2) in object code or executable form under the terms of
137
+ Sections 1 and 2 above provided that you also do one of the following:
138
+
139
+ a) Accompany it with the complete corresponding machine-readable
140
+ source code, which must be distributed under the terms of Sections
141
+ 1 and 2 above on a medium customarily used for software interchange; or,
142
+
143
+ b) Accompany it with a written offer, valid for at least three
144
+ years, to give any third party, for a charge no more than your
145
+ cost of physically performing source distribution, a complete
146
+ machine-readable copy of the corresponding source code, to be
147
+ distributed under the terms of Sections 1 and 2 above on a medium
148
+ customarily used for software interchange; or,
149
+
150
+ c) Accompany it with the information you received as to the offer
151
+ to distribute corresponding source code. (This alternative is
152
+ allowed only for noncommercial distribution and only if you
153
+ received the program in object code or executable form with such
154
+ an offer, in accord with Subsection b above.)
155
+
156
+ The source code for a work means the preferred form of the work for
157
+ making modifications to it. For an executable work, complete source
158
+ code means all the source code for all modules it contains, plus any
159
+ associated interface definition files, plus the scripts used to
160
+ control compilation and installation of the executable. However, as a
161
+ special exception, the source code distributed need not include
162
+ anything that is normally distributed (in either source or binary
163
+ form) with the major components (compiler, kernel, and so on) of the
164
+ operating system on which the executable runs, unless that component
165
+ itself accompanies the executable.
166
+
167
+ If distribution of executable or object code is made by offering
168
+ access to copy from a designated place, then offering equivalent
169
+ access to copy the source code from the same place counts as
170
+ distribution of the source code, even though third parties are not
171
+ compelled to copy the source along with the object code.
172
+
173
+ 4. You may not copy, modify, sublicense, or distribute the Program
174
+ except as expressly provided under this License. Any attempt
175
+ otherwise to copy, modify, sublicense or distribute the Program is
176
+ void, and will automatically terminate your rights under this License.
177
+ However, parties who have received copies, or rights, from you under
178
+ this License will not have their licenses terminated so long as such
179
+ parties remain in full compliance.
180
+
181
+ 5. You are not required to accept this License, since you have not
182
+ signed it. However, nothing else grants you permission to modify or
183
+ distribute the Program or its derivative works. These actions are
184
+ prohibited by law if you do not accept this License. Therefore, by
185
+ modifying or distributing the Program (or any work based on the
186
+ Program), you indicate your acceptance of this License to do so, and
187
+ all its terms and conditions for copying, distributing or modifying
188
+ the Program or works based on it.
189
+
190
+ 6. Each time you redistribute the Program (or any work based on the
191
+ Program), the recipient automatically receives a license from the
192
+ original licensor to copy, distribute or modify the Program subject to
193
+ these terms and conditions. You may not impose any further
194
+ restrictions on the recipients' exercise of the rights granted herein.
195
+ You are not responsible for enforcing compliance by third parties to
196
+ this License.
197
+
198
+ 7. If, as a consequence of a court judgment or allegation of patent
199
+ infringement or for any other reason (not limited to patent issues),
200
+ conditions are imposed on you (whether by court order, agreement or
201
+ otherwise) that contradict the conditions of this License, they do not
202
+ excuse you from the conditions of this License. If you cannot
203
+ distribute so as to satisfy simultaneously your obligations under this
204
+ License and any other pertinent obligations, then as a consequence you
205
+ may not distribute the Program at all. For example, if a patent
206
+ license would not permit royalty-free redistribution of the Program by
207
+ all those who receive copies directly or indirectly through you, then
208
+ the only way you could satisfy both it and this License would be to
209
+ refrain entirely from distribution of the Program.
210
+
211
+ If any portion of this section is held invalid or unenforceable under
212
+ any particular circumstance, the balance of the section is intended to
213
+ apply and the section as a whole is intended to apply in other
214
+ circumstances.
215
+
216
+ It is not the purpose of this section to induce you to infringe any
217
+ patents or other property right claims or to contest validity of any
218
+ such claims; this section has the sole purpose of protecting the
219
+ integrity of the free software distribution system, which is
220
+ implemented by public license practices. Many people have made
221
+ generous contributions to the wide range of software distributed
222
+ through that system in reliance on consistent application of that
223
+ system; it is up to the author/donor to decide if he or she is willing
224
+ to distribute software through any other system and a licensee cannot
225
+ impose that choice.
226
+
227
+ This section is intended to make thoroughly clear what is believed to
228
+ be a consequence of the rest of this License.
229
+
230
+ 8. If the distribution and/or use of the Program is restricted in
231
+ certain countries either by patents or by copyrighted interfaces, the
232
+ original copyright holder who places the Program under this License
233
+ may add an explicit geographical distribution limitation excluding
234
+ those countries, so that distribution is permitted only in or among
235
+ countries not thus excluded. In such case, this License incorporates
236
+ the limitation as if written in the body of this License.
237
+
238
+ 9. The Free Software Foundation may publish revised and/or new versions
239
+ of the General Public License from time to time. Such new versions will
240
+ be similar in spirit to the present version, but may differ in detail to
241
+ address new problems or concerns.
242
+
243
+ Each version is given a distinguishing version number. If the Program
244
+ specifies a version number of this License which applies to it and "any
245
+ later version", you have the option of following the terms and conditions
246
+ either of that version or of any later version published by the Free
247
+ Software Foundation. If the Program does not specify a version number of
248
+ this License, you may choose any version ever published by the Free Software
249
+ Foundation.
250
+
251
+ 10. If you wish to incorporate parts of the Program into other free
252
+ programs whose distribution conditions are different, write to the author
253
+ to ask for permission. For software which is copyrighted by the Free
254
+ Software Foundation, write to the Free Software Foundation; we sometimes
255
+ make exceptions for this. Our decision will be guided by the two goals
256
+ of preserving the free status of all derivatives of our free software and
257
+ of promoting the sharing and reuse of software generally.
258
+
259
+ NO WARRANTY
260
+
261
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
262
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
263
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
264
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
265
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
266
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
267
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
268
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
269
+ REPAIR OR CORRECTION.
270
+
271
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
272
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
273
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
274
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
275
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
276
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
277
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
278
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
279
+ POSSIBILITY OF SUCH DAMAGES.
280
+
281
+
282
+
data/Manifest.txt ADDED
@@ -0,0 +1,47 @@
1
+ History.txt
2
+ License.txt
3
+ Manifest.txt
4
+ README.rdoc
5
+ Rakefile
6
+ bin/rad
7
+ lib/libraries/Servo/keywords.txt
8
+ lib/libraries/Servo/Servo.cpp
9
+ lib/libraries/Servo/Servo.h
10
+ lib/libraries/SWSerLCDpa/SWSerLCDpa.cpp
11
+ lib/libraries/SWSerLCDpa/SWSerLCDpa.h
12
+ lib/libraries/SWSerLCDsf/SWSerLCDsf.cpp
13
+ lib/libraries/SWSerLCDsf/SWSerLCDsf.h
14
+ lib/plugins/debounce.rb
15
+ lib/plugins/debug_output_to_lcd.rb
16
+ lib/plugins/input_output_state.rb
17
+ lib/plugins/mem_test.rb
18
+ lib/plugins/servo_pulse.rb
19
+ lib/plugins/servo_setup.rb
20
+ lib/plugins/smoother.rb
21
+ lib/plugins/spark_fun_serial_lcd.rb
22
+ lib/rad.rb
23
+ lib/rad/arduino_sketch.rb
24
+ lib/rad/arduino_plugin.rb
25
+ lib/rad/rad_processor.rb
26
+ lib/rad/rad_rewriter.rb
27
+ lib/rad/init.rb
28
+ lib/rad/todo.txt
29
+ lib/rad/tasks/build_and_make.rake
30
+ lib/rad/tasks/rad.rb
31
+ lib/rad/version.rb
32
+ lib/rad/generators/makefile/makefile.erb
33
+ lib/rad/generators/makefile/makefile.rb
34
+ scripts/txt2html
35
+ setup.rb
36
+ spec/models/spec_helper.rb
37
+ spec/models/arduino_sketch_spec.rb
38
+ spec/spec.opts
39
+ website/index.html
40
+ website/index.txt
41
+ website/javascripts/rounded_corners_lite.inc.js
42
+ website/stylesheets/screen.css
43
+ website/template.rhtml
44
+ website/examples/assembler_test.rb.html
45
+ website/examples/gps_reader.rb.html
46
+ website/examples/hello_world.rb.html
47
+ website/examples/serial_motor.rb.html
data/README.rdoc ADDED
@@ -0,0 +1,51 @@
1
+ =Welcome to RAD (Ruby Arduino Development)
2
+
3
+ RAD is a framework for programming the Arduino physcial computing platform using Ruby. RAD converts Ruby scripts written using a set of Rails-like conventions and helpers into C source code which can be compiled and run on the Arduino microcontroller. It also provides a set of Rake tasks for automating the compilation and upload process.
4
+
5
+ For a full introduction see http://rad.rubyforge.org
6
+
7
+ ==Documentation
8
+
9
+ The main documentation is here: ArduinoSketch.
10
+
11
+ See also the Arduino Software reference: http://www.arduino.cc/en/Reference/HomePage
12
+
13
+ ==Examples
14
+
15
+ See the examples directory for lots of examples of RAD in action: http://rad.rubyforge.org/examples
16
+ Madrona Fork Screencast is here: http://www.vimeo.com/1272402
17
+ Occasional commentary here: http://senplicity.wordpress.com/
18
+
19
+ ==Getting Started
20
+
21
+ To install the madrona fork gem:
22
+
23
+ $ Update to RubyGems 1.2.0 before proceeding!!
24
+ $ gem sources -a http://gems.github.com (you only have to do this once)
25
+ $ sudo gem install madrona-rad
26
+
27
+ To install the original rad:
28
+
29
+ $ sudo gem install rad
30
+
31
+ Run the rad command to create a new project:
32
+
33
+ $ rad my_project
34
+
35
+ Write a sketch that will blink a single LED every 500ms:
36
+
37
+ class MyProject < ArduinoSketch
38
+ output_pin 13, :as => led
39
+
40
+ def loop
41
+ blink led, 500
42
+ end
43
+ end
44
+
45
+ Attach your Arduino and use rake to complile and upload your sketch:
46
+
47
+ $ rake make:upload
48
+
49
+ ==Get Involved
50
+
51
+ Cheers? Jeers? Wanna help out? Contact Greg Borenstein: greg [dot] borenstein [at] gmail [dot] com
data/Rakefile ADDED
@@ -0,0 +1,139 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+ require 'rake/clean'
4
+ require 'rake/testtask'
5
+ require 'rake/packagetask'
6
+ require 'rake/gempackagetask'
7
+ require 'rake/rdoctask'
8
+ require 'rake/contrib/rubyforgepublisher'
9
+ require 'fileutils'
10
+ require 'hoe'
11
+ begin
12
+ require 'spec/rake/spectask'
13
+ rescue LoadError
14
+ puts 'To use rspec for testing you must install rspec gem:'
15
+ puts '$ sudo gem install rspec'
16
+ exit
17
+ end
18
+
19
+ include FileUtils
20
+ require File.join(File.dirname(__FILE__), 'lib', 'rad', 'version')
21
+
22
+ BIN = "rad"
23
+ AUTHOR = 'Greg Borenstein' # can also be an array of Authors
24
+ EMAIL = "greg@mfdz.com"
25
+ DESCRIPTION = "A framework for programming the Arduino physcial computing platform using Ruby. RAD converts Ruby scripts written using a set of Rails-like conventions and helpers into C source code which can be compiled and run on the Arduino microcontroller."
26
+ GEM_NAME = 'rad' # what ppl will type to install your gem
27
+
28
+ @config_file = "~/.rubyforge/user-config.yml"
29
+ @config = nil
30
+ def rubyforge_username
31
+ unless @config
32
+ begin
33
+ @config = YAML.load(File.read(File.expand_path(@config_file)))
34
+ rescue
35
+ puts <<-EOS
36
+ ERROR: No rubyforge config file found: #{@config_file}"
37
+ Run 'rubyforge setup' to prepare your env for access to Rubyforge
38
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
39
+ EOS
40
+ exit
41
+ end
42
+ end
43
+ @rubyforge_username ||= @config["username"]
44
+ end
45
+
46
+ RUBYFORGE_PROJECT = 'rad' # The unix name for your project
47
+ HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
48
+ DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
49
+
50
+ NAME = "rad"
51
+ REV = nil
52
+ # UNCOMMENT IF REQUIRED:
53
+ # REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
54
+ VERS = Rad::VERSION::STRING + (REV ? ".#{REV}" : "")
55
+ CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
56
+ RDOC_OPTS = ['--quiet', '--title', 'rad documentation',
57
+ "--opname", "index.html",
58
+ "--line-numbers",
59
+ "--main", "README",
60
+ "--inline-source"]
61
+
62
+ class Hoe
63
+ def extra_deps
64
+ @extra_deps.reject { |x| Array(x).first == 'hoe' }
65
+ end
66
+ end
67
+
68
+ # Generate all the Rake tasks
69
+ # Run 'rake -T' to see list of generated tasks (from gem root directory)
70
+ hoe = Hoe.new(GEM_NAME, VERS) do |p|
71
+ p.author = AUTHOR
72
+ p.description = DESCRIPTION
73
+ p.email = EMAIL
74
+ p.summary = DESCRIPTION
75
+ p.url = HOMEPATH
76
+ p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
77
+ p.test_globs = ["test/**/test_*.rb"]
78
+ p.clean_globs |= CLEAN #An array of file patterns to delete on clean.
79
+
80
+ # == Optional
81
+ p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
82
+ p.extra_deps = [ ['RubyToC', '>= 1.0.0'] ]
83
+ #p.spec_extras = {} # A hash of extra values to set in the gemspec.
84
+ end
85
+
86
+ CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
87
+ PATH = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
88
+ hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
89
+
90
+ desc 'Generate website files'
91
+ task :website_generate do
92
+ Dir['website/**/*.txt'].each do |txt|
93
+ sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
94
+ end
95
+ end
96
+
97
+ desc 'Upload website files to rubyforge'
98
+ task :website_upload do
99
+ host = "#{rubyforge_username}@rubyforge.org"
100
+ remote_dir = "/var/www/gforge-projects/#{PATH}/"
101
+ local_dir = 'website'
102
+ sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
103
+ end
104
+
105
+ desc 'Generate and upload website files'
106
+ task :website => [:website_generate, :website_upload, :publish_docs]
107
+
108
+ desc 'Release the website and new gem version'
109
+ task :deploy => [:check_version, :website, :release] do
110
+ puts "Remember to create SVN tag:"
111
+ puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
112
+ "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
113
+ puts "Suggested comment:"
114
+ puts "Tagging release #{CHANGES}"
115
+ end
116
+
117
+ desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
118
+ task :local_deploy => [:website_generate, :install_gem]
119
+
120
+ task :check_version do
121
+ unless ENV['VERSION']
122
+ puts 'Must pass a VERSION=x.y.z release version'
123
+ exit
124
+ end
125
+ unless ENV['VERSION'] == VERS
126
+ puts "Please update your version.rb to match the release version, currently #{VERS}"
127
+ exit
128
+ end
129
+ end
130
+
131
+ desc "Run the specs under spec/models"
132
+ Spec::Rake::SpecTask.new do |t|
133
+ t.spec_opts = ['--options', "spec/spec.opts"]
134
+ t.spec_files = FileList['spec/models/*_spec.rb']
135
+ end
136
+
137
+ desc "Default task is to run specs"
138
+ task :default => :spec
139
+