Class | Hoe |
In: |
lib/hoe.rb
|
Parent: | Object |
hoe - a tool to help rake
Hoe is a simple rake/rubygems helper for project Rakefiles. It generates all the usual tasks for projects including rdoc generation, testing, packaging, and deployment.
Use this as a minimal starting point:
require 'hoe' Hoe.new("project_name", '1.0.0') do |p| p.rubyforge_name = "rf_project" # add other details here end # add other tasks here
VERSION | = | '1.2.1' | ||
PREFIX | = | ENV['PREFIX'] || ruby_prefix | Used to specify a custom install location (for rake install). | |
RUBY_DEBUG | = | ENV['RUBY_DEBUG'] | Used to add extra flags to RUBY_FLAGS. | |
RUBY_FLAGS | = | ENV['RUBY_FLAGS'] || default_ruby_flags | Used to specify flags to ruby [has smart default]. | |
FILTER | = | ENV['FILTER'] | Used to add flags to test_unit (e.g., -n test_borked). |
author | [RW] | Recommended: The author(s) of the package. (can be array) Really. Set this or we‘ll tease you. |
changes | [RW] | Recommended: A description of the release‘s latest changes. |
clean_globs | [RW] | Optional: An array of file patterns to delete on clean. |
description | [RW] | Recommended: A description of the project. |
[RW] | Recommended: The author‘s email address(es). (can be array) | |
extra_deps | [RW] | Optional: An array of rubygem dependencies. |
name | [RW] | MANDATORY: The name of the release. |
need_tar | [RW] | Optional: Should package create a tarball? [default: true] |
need_zip | [RW] | Optional: Should package create a zipfile? [default: false] |
rdoc_pattern | [RW] | Optional: A regexp to match documentation files against the manifest. |
remote_rdoc_dir | [RW] | Optional: Name of RDoc destination directory on Rubyforge. [default: name] |
rsync_args | [RW] | Optional: Flags for RDoc rsync. [default: "-av —delete"] |
rubyforge_name | [RW] | Optional: The name of the rubyforge project. [default: name.downcase] |
spec_extras | [RW] | Optional: A hash of extra values to set in the gemspec. Value may be a proc. |
summary | [RW] | Recommended: A short summary of the project. |
test_globs | [RW] | Optional: An array of test file patterns [default: test/**/test_*.rb] |
url | [RW] | Recommended: The url(s) of the project. (can be array) |
version | [RW] | MANDATORY: The version. Don‘t hardcode! use a constant in the project. |