Using Rake to Build Gem

ruby-talk
1

Hello all,

I'm using Rake to build a gem for my Ruby application and I was wondering if
there's a way to exclude certain files and/or directories from rdoc
generation.

···

--
Thanks!
Bryan

2

Bryan Richardson wrote:

Hello all,

I'm using Rake to build a gem for my Ruby application and I was

wondering if

there's a way to exclude certain files and/or directories from rdoc
generation.

Here's an example from the Rakefile I use for one of my projects:
~ g.files = FileList['lib/**/*.rb', '[A-Z]*',
'test/**/*'].exclude('smtp_tls.rb').to_a

#exclude from Rake's FileList makes sure that 'smtp_tls.rb' isn't used.

AFAIK, #exclude can use an Array, too, if you want to exclude multiple
files (I don't know about globs, though).

- --
Phillip Gawlowski
Twitter: twitter.com/cynicalryan

~ "To make a bad day worse, spend it wishing for the impossible." -Calvin

3

Take a look at Mr Bones. It provides a skeleton for Ruby projects, and it is not viral -- you won't have to include Mr Bones as a dependency to use your gem. The project skeleton has a collection of rake tasks for managing your project including building a gem. You can explicitly include or exclude files for rdoc generation ...

PROJ.rdoc.exclude = %w[^some/dir/ \.tmp$]
PROJ.rdoc.include = %w[\.txt$]

the syntax here is just an array of regexp snippets specifying the file types you want to ignore or include.

http://bones.rubyforge.org/

If you just want the rake tasks and Rakefile, create a throw away project using the "bones" command line. Copy the "tasks" folder and the Rakefile to your project.

Blessings,
TwP

···

On Apr 17, 2008, at 8:50 AM, Bryan Richardson wrote:

Hello all,

I'm using Rake to build a gem for my Ruby application and I was wondering if
there's a way to exclude certain files and/or directories from rdoc
generation.