body 0.1.0.pre1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/COPYING ADDED
@@ -0,0 +1,3 @@
1
+ skeleton is copyrighted free software by Popdevelop <contact@popdevelop.com>.
2
+ You can redistribute it and/or modify it under either the terms of the GPL
3
+ version 2 (see the file GPL).
data/GPL 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
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 Library 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
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/Gemfile ADDED
@@ -0,0 +1,13 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ # Add dependencies to develop your gem here.
7
+ # Include everything needed to run rake, tests, features, etc.
8
+ group :development do
9
+ gem "shoulda", ">= 0"
10
+ gem "bundler", "~> 1.0.0"
11
+ gem "jeweler", "~> 1.6.4"
12
+ gem "rcov", ">= 0"
13
+ end
@@ -0,0 +1,20 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ git (1.2.5)
5
+ jeweler (1.6.4)
6
+ bundler (~> 1.0)
7
+ git (>= 1.2.5)
8
+ rake
9
+ rake (0.9.2)
10
+ rcov (0.9.10)
11
+ shoulda (2.11.3)
12
+
13
+ PLATFORMS
14
+ ruby
15
+
16
+ DEPENDENCIES
17
+ bundler (~> 1.0.0)
18
+ jeweler (~> 1.6.4)
19
+ rcov
20
+ shoulda
@@ -0,0 +1,165 @@
1
+ = KNOWN_ISSUES.rdoc - Known issues and bugs in skeleton
2
+ Copyright:: Copyright (C) 2011 Sebastian Wallin, Johan Brissmyr, Johan Gyllenspetz, Joel Larsson <contact@popdevelop.com>
3
+ License:: The Ruby License
4
+
5
+ = Known issues and bugs in skeleton
6
+
7
+ Below are known issues and bugs in skeleton. Patches to fix them are welcome.
8
+ We hope they will be fixed in the future.
9
+
10
+ Items marked with (WONT_FIX) tags would not be fixed within BioRuby because
11
+ they are not BioRuby's issues and/or it is very difficult to fix them.
12
+
13
+ == 1. Ruby version specific issues
14
+
15
+ === Ruby 1.9.1 or later
16
+
17
+ Some classes/modules/methods still may not work or may return incorrect
18
+ results in Ruby 1.9.1, especially those not covered by the unit tests.
19
+
20
+ ==== String encodings
21
+
22
+ Currently, BioRuby do not care string encodings. In some cases,
23
+ Encoding::CompatibilityError or "ArgumentError: invalid byte sequence in
24
+ (encoding name)" may be raised.
25
+
26
+ === End-of-life Ruby versions
27
+
28
+ ==== Ruby 1.9.0
29
+
30
+ (WONT_FIX) Ruby 1.9.0 is NOT supported because it isn't a stable release.
31
+ Use Ruby 1.9.1 or later.
32
+
33
+ ==== Ruby 1.8.5 or earlier
34
+
35
+ (WONT_FIX) Problems observed only with Ruby 1.8.5 or earlier will not be
36
+ fixed. Note that Ruby 1.8.5 or earlier is no longer supported, as described
37
+ in README.rdoc.
38
+
39
+ ==== Ruby 1.8.2 or earlier
40
+
41
+ (WONT_FIX) In some cases, temporary files and directories may not be
42
+ removed because of the lack of FileUtils.remove_entry_secure.
43
+
44
+ === Issues about SOAP/WSDL
45
+
46
+ SOAP4R (SOAP and WSDL implementation) is no longer bundled with Ruby 1.9.
47
+ In addition, because of the API changes in recent SOAP4R, some
48
+ classes/modules using SOAP4R may not work.
49
+
50
+ === Problem with REXML DoS vulnerability patch before 09-Nov-2008
51
+
52
+ (WONT_FIX) If you have applied a patch taken from
53
+ http://www.ruby-lang.org/en/news/2008/08/23/dos-vulnerability-in-rexml/
54
+ before 09 Nov 2008 12:40 +0900, because of the bug in the patch,
55
+ parsing of Blast XML results with REXML parser may fail. The bug is already
56
+ fixed and new patch is available on the above URL. Note that some Linux
57
+ distributions would have incorporated the patch in their manners, and may
58
+ have the same problem.
59
+
60
+ === RubyGems 0.8.11 or earlier
61
+
62
+ (WONT_FIX) With very old version of RubyGems, use 'require_gem' which was
63
+ deprecated in RubyGems 0.9.0 and removed in RubyGems 1.0.1.
64
+
65
+ #!/usr/bin/env ruby
66
+ require 'rubygems'
67
+ require_gem 'bio'
68
+
69
+ == 2. OS and/or architecture-dependent issues
70
+
71
+ === Microsoft Windows
72
+
73
+ ==== Text mode issues
74
+
75
+ Following 4 tests failed on mswin32 (and maybe on mingw32 and bccwin32)
76
+ because of the conversion of line feed codes in the text mode.
77
+
78
+ * test_ended_pos and test_start_pos in test/unit/bio/io/test_flatfile.rb
79
+ * test_pos in test/unit/bio/io/flatfile/test_buffer.rb
80
+ * test_entry_pos in test/unit/bio/appl/blast/test_rpsblast.rb
81
+
82
+ This indicates that br_bioflat.rb and Bio::FlatFileIndex may create
83
+ incorrect indexes on mswin32, mingw32, and bccwin32. In addition,
84
+ Bio::FlatFile may return incorrect data.
85
+
86
+ ==== String escaping of command-line arguments
87
+
88
+ After BioRuby 1.4.1, in Ruby 1.9.X running on Windows, escaping of
89
+ command-line arguments are processed by the Ruby interpreter. Before BioRuby
90
+ 1.4.0, the escaping is executed in Bio::Command#escape_shell_windows, and
91
+ the behavior is different from the Ruby interpreter's one.
92
+
93
+ Curreltly, due to the change, test/functional/bio/test_command.rb may fail
94
+ on Windows with Ruby 1.9.X.
95
+
96
+ ==== Windows 95/98/98SE/ME
97
+
98
+ (WONT_FIX) Some methods that call external programs may not work in
99
+ Windows 95/98/98SE/ME because of the limitation of COMMAND.COM.
100
+
101
+ === OpenVMS, BeOS, OS/2, djgpp, Windows CE
102
+
103
+ (WONT_FIX) BioRuby may not work on these platforms.
104
+
105
+ == 3. Known issues and bugs in BioRuby
106
+
107
+ === Bio::Ensembl
108
+
109
+ Due to the renewal of Ensembl web site, Bio::Ensembl does not work for
110
+ the latest Ensembl. For a workaround, use an archive server. For example,
111
+ "jul2008.archive.ensembl.org" seems to be the last server before the renewal.
112
+ human = Bio::Ensembl.new("Homo_sapiens", "jul2008.archive.ensembl.org")
113
+
114
+ Alternatively, consider using Ruby Ensembl API.
115
+ * http://github.com/jandot/ruby-ensembl-api
116
+
117
+ === Bio::DBGET and sample/dbget
118
+
119
+ (WONT_FIX) Because the DBGET service have not been publically available for
120
+ a long time, we give up support for Bio::DBGET and sample/dbget. Instead,
121
+ using Bio::TogoWS or Bio::KEGG::API is recommended.
122
+
123
+ === Bio::NCBI::SOAP
124
+
125
+ It seems that Bio::NCBI::SOAP (in lib/bio/io/ncbisoap.rb) does not work
126
+ correctly, even running on Ruby 1.8.x. Instead, use Bio::NCBI::REST.
127
+
128
+ === Bio::KEGG::Taxonomy and sample/demo_kegg_taxonomy.rb
129
+
130
+ Bio::KEGG::Taxonomy fails to parse current KEGG taxonomy data file probably
131
+ because of the growth of the data size.
132
+
133
+ === Bio::SPTR
134
+
135
+ Bio::SPTR should be updated to follow UniProtKB format changes described
136
+ in http://www.uniprot.org/docs/sp_news.htm .
137
+
138
+ == 4. Compatibility issues with other libraries/extensions
139
+
140
+ === ActiveRecord
141
+
142
+ BioSQL support uses ActiveRecord, but the author of the document does not
143
+ know which version is suitable.
144
+
145
+ === Ruby on Rails
146
+
147
+ BioRuby Shell on Web uses Ruby on Rails, but the author of the document does
148
+ not know which version is suitable.
149
+
150
+ == 5. Historical descriptions
151
+
152
+ === CVS
153
+
154
+ For historical purposes: the anonymous CVS was provided at
155
+
156
+ * http://cvs.bioruby.org/
157
+
158
+ and could be obtained by the following procedure.
159
+
160
+ % cvs -d :pserver:cvs@code.open-bio.org:/home/repository/bioruby login
161
+ CVS password: cvs (login with a password 'cvs' for the first time)
162
+ % cvs -d :pserver:cvs@code.open-bio.org:/home/repository/bioruby co bioruby
163
+
164
+ These may be closed without any prior notice.
165
+
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2011 Joel Larsson
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,95 @@
1
+ --
2
+ = README.rdoc - README for skeleton
3
+ Copyright:: Copyright (C) 2011 Sebastian Wallin, Johan Brissmyr, Johan Gyllenspetz, Joel Larsson <contact@popdevelop.com>
4
+ License:: The Ruby License
5
+ * The above statement is limited to this file. See below about Skeleton's
6
+ copyright and license.
7
+ ++
8
+
9
+ = Skeleton
10
+
11
+ Copyright (C) 2011 Sebastian Wallin, Johan Brissmyr, Johan Gyllenspetz, Joel Larsson <contact@popdevelop.com>
12
+
13
+ Skeleton is an open source Ruby library for developing...
14
+
15
+ == FOR MORE INFORMATION
16
+
17
+ === Documents in this distribution
18
+
19
+ ==== General information
20
+
21
+ README.rdoc:: This file. General information and installation procedure.
22
+ RELEASE_NOTES.rdoc:: News and important changes in this release.
23
+
24
+ Issues are tracked on github at http://github.com/popdevelop/skeleton
25
+
26
+ ==== Tutorials, Examples and other useful information
27
+
28
+ examples/:: Examples directory
29
+
30
+ ==== skeleton development
31
+
32
+ README_DEV.rdoc:: Information for developers that want to contribute to the project, including coding styles and documentation guidelines.
33
+
34
+ === websites
35
+
36
+ Authors website, day to day blog posts from our team
37
+ * http://popdevelop.com
38
+
39
+ Github, here you will find links to related resources including downloads, issue tracking, documentation etc.
40
+ * http://github.com/popdevelop
41
+
42
+ === git
43
+
44
+ If you need the latest development version, this is provided at
45
+
46
+ * http://github.com/popdevelop/skeleton
47
+
48
+ and can be obtained by the following procedure:
49
+
50
+ % git clone git://github.com/podevelop/skeleton.git
51
+
52
+ == REQUIREMENTS
53
+
54
+ * Ruby 1.8.6 or later (except Ruby 1.9.0) -- http://www.ruby-lang.org/
55
+ * Ruby 1.8.7-p352 or later is recommended.
56
+
57
+ == INSTALL
58
+
59
+ === INSTALL by using RubyGems (recommended)
60
+
61
+ gem install skeleton
62
+
63
+ === INSTALL without RubyGems
64
+
65
+ == USAGE
66
+
67
+ You can load all skeleton classes just by requiring 'skeleton.rb'. All the
68
+ skeleton classes and modules are located under the module name 'skeleton' to
69
+ separate the name space.
70
+
71
+ #!/usr/bin/env ruby
72
+ require 'skeleton'
73
+
74
+ You can also read other documentation in the 'doc' directory.
75
+
76
+ doc/
77
+
78
+ === RubyGems on Ruby 1.8.x
79
+
80
+ With RubyGems on Ruby 1.8.x, you may need to load 'rubygems' library before
81
+ using 'skeleton'. This may not be needed, depending on settings of Ruby.
82
+
83
+ #!/usr/bin/env ruby
84
+ require 'rubygems'
85
+ require 'skeleton'
86
+
87
+ == LICENSE
88
+
89
+ skeleton can be freely distributed under the same terms as Ruby.
90
+ See the file COPYING.
91
+
92
+ == CONTACT
93
+
94
+ Current staff of the skeleton project can be reached by sending e-mail
95
+ to <contact@popdevelop.com>.
@@ -0,0 +1,60 @@
1
+ = README.DEV
2
+
3
+ Copyright (C) 2011 Sebastian Wallin, Johan Brissmyr, Johan Gyllenspetz, Joel Larsson <contact@popdevelop.com>
4
+
5
+ = HOW TO CONTRIBUTE TO THE skeleton PROJECT?
6
+
7
+ There are many possible ways to contribute to the skeleton project,
8
+ such as:
9
+
10
+ * Send a bug report or write a bug fix patch
11
+ * Add and correct documentation
12
+ * Develop code for new features, etc.
13
+
14
+ All of these are welcome! However, this document describes the last option,
15
+ how to contribute your code to the skeleton distribution.
16
+
17
+ == Git
18
+
19
+ skeleton is now under git source control at http://github.com/popdevelop/skeleton.
20
+ There are two basic ways to contribute: with patches or pull requests.
21
+
22
+ = CODING STYLE
23
+
24
+ Please follow these guidelines, http://www.caliban.org/ruby/rubyguide.shtml#style
25
+
26
+ == Indentation must not include evil tabs
27
+
28
+ * Use 2 spaces for indentation.
29
+
30
+ == Documentation should be written in the RDoc format in the source code
31
+
32
+ The RDoc format is becoming the popular standard for Ruby documentation.
33
+
34
+ Additional tutorial documentation and working examples are encouraged
35
+ with your contribution. You may use the header part of the file for
36
+ this purpose as demonstrated in the previous section.
37
+
38
+ == Standard documentation
39
+
40
+ Each file should start with a header, which covers the following topics:
41
+ * copyright
42
+ * license
43
+ * description of the file (_not_ the classes; see below)
44
+ * any references, if appropriate
45
+
46
+ == Testing code should use 'test/unit'
47
+
48
+ Unit tests should come with your modules by which you can assure what
49
+ you meant to do with each method. The test code is useful to make
50
+ maintenance easy and ensure stability.
51
+
52
+ = NAMESPACE
53
+
54
+ Your module should be located under the top-level module skeleton and put under
55
+ the 'skeleton/lib/skeleton' directory. The class/module names and the
56
+ file names should be short and descriptive.
57
+
58
+ = MAINTENANCE
59
+
60
+ Finally, please maintain the code you've contributed.
@@ -0,0 +1,26 @@
1
+ = skeleton x.x.x RELEASE NOTES
2
+
3
+ Copyright:: Copyright (C) 2011 Sebastian Wallin, Johan Brissmyr, Johan Gyllenspetz, Joel Larsson <contact@popdevelop.com>
4
+ License:: The Ruby License
5
+
6
+ == New features
7
+
8
+ === New classes skeleton::fixme::fixme
9
+
10
+ === New classes skeleton::fixme::fixme
11
+
12
+ == Bug fixes
13
+
14
+ === skeleton:fixme
15
+
16
+ * First release, no bug fixes
17
+
18
+ == Incompatible changes
19
+
20
+ === skeleton:fixme
21
+
22
+ * First release, everything is compatible
23
+
24
+ == Known issues
25
+
26
+ Know issues are added and updated in the file KNOWN_ISSUES.rdoc::
@@ -0,0 +1,55 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ require './lib/body/version.rb'
6
+ begin
7
+ Bundler.setup(:default, :development)
8
+ rescue Bundler::BundlerError => e
9
+ $stderr.puts e.message
10
+ $stderr.puts "Run `bundle install` to install missing gems"
11
+ exit e.status_code
12
+ end
13
+ require 'rake'
14
+
15
+ require 'jeweler'
16
+ Jeweler::Tasks.new do |gem|
17
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
18
+ gem.name = "body"
19
+ gem.homepage = "http://github.com/tilljoel/body"
20
+ gem.license = "MIT"
21
+ gem.summary = %Q{testgem skeleton}
22
+ gem.description = %Q{longer description of your gem}
23
+ gem.email = "tilljoel@gmail.com"
24
+ gem.authors = ["Joel Larsson"]
25
+ gem.version = Body::Version::STRING
26
+ # dependencies defined in Gemfile
27
+ end
28
+ Jeweler::RubygemsDotOrgTasks.new
29
+
30
+ require 'rake/testtask'
31
+ Rake::TestTask.new(:test) do |test|
32
+ test.libs << 'lib' << 'test'
33
+ test.pattern = 'test/**/test_*.rb'
34
+ test.verbose = true
35
+ end
36
+
37
+ require 'rcov/rcovtask'
38
+ Rcov::RcovTask.new do |test|
39
+ test.libs << 'test'
40
+ test.pattern = 'test/**/test_*.rb'
41
+ test.verbose = true
42
+ test.rcov_opts << '--exclude "gems/*"'
43
+ end
44
+
45
+ task :default => :test
46
+
47
+ require 'rake/rdoctask'
48
+ Rake::RDocTask.new do |rdoc|
49
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
50
+
51
+ rdoc.rdoc_dir = 'rdoc'
52
+ rdoc.title = "body #{version}"
53
+ rdoc.rdoc_files.include('README*')
54
+ rdoc.rdoc_files.include('lib/**/*.rb')
55
+ end
@@ -0,0 +1,35 @@
1
+ require "body/version"
2
+ #require 'body/base'
3
+
4
+ module Body
5
+
6
+ # Document the responsibility of the class
7
+ #
8
+ # == Heading
9
+ #
10
+ # Formating the class description
11
+ #
12
+ # == Formatting
13
+ #
14
+ # Embody +parameters+ or +options+ in Teletype Text tags. You can also use
15
+ # *bold* or *italics* but must use HTML tags for <b>multiple words</b>,
16
+ # <i>like this</i> and <tt>like this</tt>.
17
+ class Arm
18
+ # Swings the arm, return
19
+ #
20
+ # === Params
21
+ #
22
+ # +speed+:: speed to swing with
23
+ # ==== Examples
24
+ #
25
+ # arm = Arm.new()
26
+ # arm.swing(10)
27
+ def swing(speed=10)
28
+ puts "Swining with speed #{speed}"
29
+ return speed
30
+ end
31
+
32
+ end
33
+
34
+ end
35
+
@@ -0,0 +1,10 @@
1
+ class Body
2
+ module Version
3
+ MAJOR = 0
4
+ MINOR = 1
5
+ PATCH = 0
6
+ BUILD = 'pre1'
7
+
8
+ STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
9
+ end
10
+ end
@@ -0,0 +1,18 @@
1
+ require 'rubygems'
2
+ require 'bundler'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ $stderr.puts e.message
7
+ $stderr.puts "Run `bundle install` to install missing gems"
8
+ exit e.status_code
9
+ end
10
+ require 'test/unit'
11
+ require 'shoulda'
12
+
13
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
14
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
15
+ require 'body'
16
+
17
+ class Test::Unit::TestCase
18
+ end
@@ -0,0 +1,7 @@
1
+ require 'helper'
2
+
3
+ class TestBody < Test::Unit::TestCase
4
+ should "probably rename this file and start testing for real" do
5
+ flunk "hey buddy, you should probably rename this file and start testing for real"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,144 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: body
3
+ version: !ruby/object:Gem::Version
4
+ hash: 1923831995
5
+ prerelease: 6
6
+ segments:
7
+ - 0
8
+ - 1
9
+ - 0
10
+ - pre
11
+ - 1
12
+ version: 0.1.0.pre1
13
+ platform: ruby
14
+ authors:
15
+ - Joel Larsson
16
+ autorequire:
17
+ bindir: bin
18
+ cert_chain: []
19
+
20
+ date: 2011-10-07 00:00:00 Z
21
+ dependencies:
22
+ - !ruby/object:Gem::Dependency
23
+ name: shoulda
24
+ prerelease: false
25
+ version_requirements: &id001 !ruby/object:Gem::Requirement
26
+ none: false
27
+ requirements:
28
+ - - ">="
29
+ - !ruby/object:Gem::Version
30
+ hash: 3
31
+ segments:
32
+ - 0
33
+ version: "0"
34
+ type: :development
35
+ requirement: *id001
36
+ - !ruby/object:Gem::Dependency
37
+ name: bundler
38
+ prerelease: false
39
+ version_requirements: &id002 !ruby/object:Gem::Requirement
40
+ none: false
41
+ requirements:
42
+ - - ~>
43
+ - !ruby/object:Gem::Version
44
+ hash: 23
45
+ segments:
46
+ - 1
47
+ - 0
48
+ - 0
49
+ version: 1.0.0
50
+ type: :development
51
+ requirement: *id002
52
+ - !ruby/object:Gem::Dependency
53
+ name: jeweler
54
+ prerelease: false
55
+ version_requirements: &id003 !ruby/object:Gem::Requirement
56
+ none: false
57
+ requirements:
58
+ - - ~>
59
+ - !ruby/object:Gem::Version
60
+ hash: 7
61
+ segments:
62
+ - 1
63
+ - 6
64
+ - 4
65
+ version: 1.6.4
66
+ type: :development
67
+ requirement: *id003
68
+ - !ruby/object:Gem::Dependency
69
+ name: rcov
70
+ prerelease: false
71
+ version_requirements: &id004 !ruby/object:Gem::Requirement
72
+ none: false
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ hash: 3
77
+ segments:
78
+ - 0
79
+ version: "0"
80
+ type: :development
81
+ requirement: *id004
82
+ description: longer description of your gem
83
+ email: tilljoel@gmail.com
84
+ executables: []
85
+
86
+ extensions: []
87
+
88
+ extra_rdoc_files:
89
+ - LICENSE.txt
90
+ - README.rdoc
91
+ - README_DEV.rdoc
92
+ files:
93
+ - .document
94
+ - COPYING
95
+ - GPL
96
+ - Gemfile
97
+ - Gemfile.lock
98
+ - KNOWN_ISSUES.rdoc
99
+ - LICENSE.txt
100
+ - README.rdoc
101
+ - README_DEV.rdoc
102
+ - RELEASE_NOTES.rdoc
103
+ - Rakefile
104
+ - lib/body.rb
105
+ - lib/body/version.rb
106
+ - test/helper.rb
107
+ - test/test_body.rb
108
+ homepage: http://github.com/tilljoel/body
109
+ licenses:
110
+ - MIT
111
+ post_install_message:
112
+ rdoc_options: []
113
+
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ none: false
118
+ requirements:
119
+ - - ">="
120
+ - !ruby/object:Gem::Version
121
+ hash: 3
122
+ segments:
123
+ - 0
124
+ version: "0"
125
+ required_rubygems_version: !ruby/object:Gem::Requirement
126
+ none: false
127
+ requirements:
128
+ - - ">"
129
+ - !ruby/object:Gem::Version
130
+ hash: 25
131
+ segments:
132
+ - 1
133
+ - 3
134
+ - 1
135
+ version: 1.3.1
136
+ requirements: []
137
+
138
+ rubyforge_project:
139
+ rubygems_version: 1.8.6
140
+ signing_key:
141
+ specification_version: 3
142
+ summary: testgem skeleton
143
+ test_files: []
144
+