elliottcable-echoe 3.1.2 → 3.1.3
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +3 -1
- data/Manifest +1 -93
- data/Rakefile +1 -2
- data/echoe.gemspec +7 -7
- data/lib/echoe.rb +50 -22
- data/lib/echoe/net.rb +7 -0
- data/lib/echoe/platform.rb +27 -25
- data/vendor/rake/lib/rake/contrib/sshpublisher.rb +0 -4
- metadata +7 -96
- data/vendor/rake/CHANGES +0 -400
- data/vendor/rake/README +0 -285
- data/vendor/rake/Rakefile +0 -418
- data/vendor/rake/TODO +0 -20
- data/vendor/rake/bin/rake +0 -31
- data/vendor/rake/doc/example/Rakefile1 +0 -38
- data/vendor/rake/doc/example/Rakefile2 +0 -35
- data/vendor/rake/doc/example/a.c +0 -6
- data/vendor/rake/doc/example/b.c +0 -6
- data/vendor/rake/doc/example/main.c +0 -11
- data/vendor/rake/doc/glossary.rdoc +0 -51
- data/vendor/rake/doc/jamis.rb +0 -591
- data/vendor/rake/doc/proto_rake.rdoc +0 -127
- data/vendor/rake/doc/rake.1.gz +0 -0
- data/vendor/rake/doc/rakefile.rdoc +0 -534
- data/vendor/rake/doc/rational.rdoc +0 -151
- data/vendor/rake/doc/release_notes/rake-0.4.14.rdoc +0 -23
- data/vendor/rake/doc/release_notes/rake-0.4.15.rdoc +0 -35
- data/vendor/rake/doc/release_notes/rake-0.5.0.rdoc +0 -53
- data/vendor/rake/doc/release_notes/rake-0.5.3.rdoc +0 -78
- data/vendor/rake/doc/release_notes/rake-0.5.4.rdoc +0 -46
- data/vendor/rake/doc/release_notes/rake-0.6.0.rdoc +0 -141
- data/vendor/rake/doc/release_notes/rake-0.7.0.rdoc +0 -119
- data/vendor/rake/doc/release_notes/rake-0.7.1.rdoc +0 -59
- data/vendor/rake/doc/release_notes/rake-0.7.2.rdoc +0 -121
- data/vendor/rake/doc/release_notes/rake-0.7.3.rdoc +0 -47
- data/vendor/rake/doc/release_notes/rake-0.8.0.rdoc +0 -114
- data/vendor/rake/doc/release_notes/rake-0.8.2.rdoc +0 -165
- data/vendor/rake/doc/release_notes/rake-0.8.3.rdoc +0 -112
- data/vendor/rake/install.rb +0 -88
- data/vendor/rake/lib/rake.rb +0 -2468
- data/vendor/rake/lib/rake/classic_namespace.rb +0 -8
- data/vendor/rake/lib/rake/clean.rb +0 -33
- data/vendor/rake/lib/rake/gempackagetask.rb +0 -103
- data/vendor/rake/lib/rake/loaders/makefile.rb +0 -35
- data/vendor/rake/lib/rake/packagetask.rb +0 -185
- data/vendor/rake/lib/rake/rake_test_loader.rb +0 -5
- data/vendor/rake/lib/rake/rdoctask.rb +0 -147
- data/vendor/rake/lib/rake/ruby182_test_unit_fix.rb +0 -23
- data/vendor/rake/lib/rake/runtest.rb +0 -23
- data/vendor/rake/lib/rake/tasklib.rb +0 -23
- data/vendor/rake/lib/rake/testtask.rb +0 -161
- data/vendor/rake/lib/rake/win32.rb +0 -54
- data/vendor/rake/test/capture_stdout.rb +0 -26
- data/vendor/rake/test/check_expansion.rb +0 -5
- data/vendor/rake/test/contrib/test_sys.rb +0 -47
- data/vendor/rake/test/data/chains/Rakefile +0 -15
- data/vendor/rake/test/data/default/Rakefile +0 -19
- data/vendor/rake/test/data/dryrun/Rakefile +0 -22
- data/vendor/rake/test/data/file_creation_task/Rakefile +0 -33
- data/vendor/rake/test/data/imports/Rakefile +0 -19
- data/vendor/rake/test/data/imports/deps.mf +0 -1
- data/vendor/rake/test/data/multidesc/Rakefile +0 -17
- data/vendor/rake/test/data/namespace/Rakefile +0 -57
- data/vendor/rake/test/data/rakelib/test1.rb +0 -3
- data/vendor/rake/test/data/rbext/rakefile.rb +0 -3
- data/vendor/rake/test/data/sample.mf +0 -12
- data/vendor/rake/test/data/statusreturn/Rakefile +0 -8
- data/vendor/rake/test/data/unittest/Rakefile +0 -1
- data/vendor/rake/test/filecreation.rb +0 -32
- data/vendor/rake/test/functional.rb +0 -15
- data/vendor/rake/test/in_environment.rb +0 -30
- data/vendor/rake/test/rake_test_setup.rb +0 -10
- data/vendor/rake/test/reqfile.rb +0 -3
- data/vendor/rake/test/reqfile2.rb +0 -3
- data/vendor/rake/test/session_functional.rb +0 -337
- data/vendor/rake/test/shellcommand.rb +0 -3
- data/vendor/rake/test/test_application.rb +0 -694
- data/vendor/rake/test/test_clean.rb +0 -14
- data/vendor/rake/test/test_definitions.rb +0 -82
- data/vendor/rake/test/test_earlytime.rb +0 -35
- data/vendor/rake/test/test_extension.rb +0 -63
- data/vendor/rake/test/test_file_creation_task.rb +0 -62
- data/vendor/rake/test/test_file_task.rb +0 -139
- data/vendor/rake/test/test_filelist.rb +0 -618
- data/vendor/rake/test/test_fileutils.rb +0 -250
- data/vendor/rake/test/test_ftp.rb +0 -59
- data/vendor/rake/test/test_invocation_chain.rb +0 -75
- data/vendor/rake/test/test_makefile_loader.rb +0 -25
- data/vendor/rake/test/test_multitask.rb +0 -45
- data/vendor/rake/test/test_namespace.rb +0 -36
- data/vendor/rake/test/test_package_task.rb +0 -116
- data/vendor/rake/test/test_pathmap.rb +0 -209
- data/vendor/rake/test/test_rake.rb +0 -41
- data/vendor/rake/test/test_require.rb +0 -33
- data/vendor/rake/test/test_rules.rb +0 -347
- data/vendor/rake/test/test_task_arguments.rb +0 -89
- data/vendor/rake/test/test_task_manager.rb +0 -170
- data/vendor/rake/test/test_tasklib.rb +0 -12
- data/vendor/rake/test/test_tasks.rb +0 -371
- data/vendor/rake/test/test_test_task.rb +0 -75
- data/vendor/rake/test/test_top_level_functions.rb +0 -84
- data/vendor/rake/test/test_win32.rb +0 -57
@@ -1,8 +0,0 @@
|
|
1
|
-
# The following classes used to be in the top level namespace.
|
2
|
-
# Loading this file enables compatibility with older Rakefile that
|
3
|
-
# referenced Task from the top level.
|
4
|
-
|
5
|
-
Task = Rake::Task
|
6
|
-
FileTask = Rake::FileTask
|
7
|
-
FileCreationTask = Rake::FileCreationTask
|
8
|
-
RakeApp = Rake::Application
|
@@ -1,33 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
# The 'rake/clean' file defines two file lists (CLEAN and CLOBBER) and
|
4
|
-
# two rake tasks (:clean and :clobber).
|
5
|
-
#
|
6
|
-
# [:clean] Clean up the project by deleting scratch files and backup
|
7
|
-
# files. Add files to the CLEAN file list to have the :clean
|
8
|
-
# target handle them.
|
9
|
-
#
|
10
|
-
# [:clobber] Clobber all generated and non-source files in a project.
|
11
|
-
# The task depends on :clean, so all the clean files will
|
12
|
-
# be deleted as well as files in the CLOBBER file list.
|
13
|
-
# The intent of this task is to return a project to its
|
14
|
-
# pristine, just unpacked state.
|
15
|
-
|
16
|
-
require 'rake'
|
17
|
-
|
18
|
-
CLEAN = Rake::FileList["**/*~", "**/*.bak", "**/core"]
|
19
|
-
CLEAN.clear_exclude.exclude { |fn|
|
20
|
-
fn.pathmap("%f") == 'core' && File.directory?(fn)
|
21
|
-
}
|
22
|
-
|
23
|
-
desc "Remove any temporary products."
|
24
|
-
task :clean do
|
25
|
-
CLEAN.each { |fn| rm_r fn rescue nil }
|
26
|
-
end
|
27
|
-
|
28
|
-
CLOBBER = Rake::FileList.new
|
29
|
-
|
30
|
-
desc "Remove any generated file."
|
31
|
-
task :clobber => [:clean] do
|
32
|
-
CLOBBER.each { |fn| rm_r fn rescue nil }
|
33
|
-
end
|
@@ -1,103 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
# Define a package task library to aid in the definition of GEM
|
4
|
-
# packages.
|
5
|
-
|
6
|
-
require 'rubygems'
|
7
|
-
require 'rake'
|
8
|
-
require 'rake/packagetask'
|
9
|
-
require 'rubygems/user_interaction'
|
10
|
-
require 'rubygems/builder'
|
11
|
-
|
12
|
-
begin
|
13
|
-
Gem.manage_gems
|
14
|
-
rescue NoMethodError => ex
|
15
|
-
# Using rubygems prior to 0.6.1
|
16
|
-
end
|
17
|
-
|
18
|
-
module Rake
|
19
|
-
|
20
|
-
# Create a package based upon a Gem spec. Gem packages, as well as
|
21
|
-
# zip files and tar/gzipped packages can be produced by this task.
|
22
|
-
#
|
23
|
-
# In addition to the Rake targets generated by PackageTask, a
|
24
|
-
# GemPackageTask will also generate the following tasks:
|
25
|
-
#
|
26
|
-
# [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.gem"</b>]
|
27
|
-
# Create a Ruby GEM package with the given name and version.
|
28
|
-
#
|
29
|
-
# Example using a Ruby GEM spec:
|
30
|
-
#
|
31
|
-
# require 'rubygems'
|
32
|
-
#
|
33
|
-
# spec = Gem::Specification.new do |s|
|
34
|
-
# s.platform = Gem::Platform::RUBY
|
35
|
-
# s.summary = "Ruby based make-like utility."
|
36
|
-
# s.name = 'rake'
|
37
|
-
# s.version = PKG_VERSION
|
38
|
-
# s.requirements << 'none'
|
39
|
-
# s.require_path = 'lib'
|
40
|
-
# s.autorequire = 'rake'
|
41
|
-
# s.files = PKG_FILES
|
42
|
-
# s.description = <<EOF
|
43
|
-
# Rake is a Make-like program implemented in Ruby. Tasks
|
44
|
-
# and dependencies are specified in standard Ruby syntax.
|
45
|
-
# EOF
|
46
|
-
# end
|
47
|
-
#
|
48
|
-
# Rake::GemPackageTask.new(spec) do |pkg|
|
49
|
-
# pkg.need_zip = true
|
50
|
-
# pkg.need_tar = true
|
51
|
-
# end
|
52
|
-
#
|
53
|
-
class GemPackageTask < PackageTask
|
54
|
-
# Ruby GEM spec containing the metadata for this package. The
|
55
|
-
# name, version and package_files are automatically determined
|
56
|
-
# from the GEM spec and don't need to be explicitly provided.
|
57
|
-
attr_accessor :gem_spec
|
58
|
-
|
59
|
-
# Create a GEM Package task library. Automatically define the gem
|
60
|
-
# if a block is given. If no block is supplied, then +define+
|
61
|
-
# needs to be called to define the task.
|
62
|
-
def initialize(gem_spec)
|
63
|
-
init(gem_spec)
|
64
|
-
yield self if block_given?
|
65
|
-
define if block_given?
|
66
|
-
end
|
67
|
-
|
68
|
-
# Initialization tasks without the "yield self" or define
|
69
|
-
# operations.
|
70
|
-
def init(gem)
|
71
|
-
super(gem.name, gem.version)
|
72
|
-
@gem_spec = gem
|
73
|
-
@package_files += gem_spec.files if gem_spec.files
|
74
|
-
end
|
75
|
-
|
76
|
-
# Create the Rake tasks and actions specified by this
|
77
|
-
# GemPackageTask. (+define+ is automatically called if a block is
|
78
|
-
# given to +new+).
|
79
|
-
def define
|
80
|
-
super
|
81
|
-
task :package => [:gem]
|
82
|
-
desc "Build the gem file #{gem_file}"
|
83
|
-
task :gem => ["#{package_dir}/#{gem_file}"]
|
84
|
-
file "#{package_dir}/#{gem_file}" => [package_dir] + @gem_spec.files do
|
85
|
-
when_writing("Creating GEM") {
|
86
|
-
Gem::Builder.new(gem_spec).build
|
87
|
-
verbose(true) {
|
88
|
-
mv gem_file, "#{package_dir}/#{gem_file}"
|
89
|
-
}
|
90
|
-
}
|
91
|
-
end
|
92
|
-
end
|
93
|
-
|
94
|
-
def gem_file
|
95
|
-
if @gem_spec.platform == Gem::Platform::RUBY
|
96
|
-
"#{package_name}.gem"
|
97
|
-
else
|
98
|
-
"#{package_name}-#{@gem_spec.platform}.gem"
|
99
|
-
end
|
100
|
-
end
|
101
|
-
|
102
|
-
end
|
103
|
-
end
|
@@ -1,35 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
module Rake
|
4
|
-
|
5
|
-
# Makefile loader to be used with the import file loader.
|
6
|
-
class MakefileLoader
|
7
|
-
|
8
|
-
# Load the makefile dependencies in +fn+.
|
9
|
-
def load(fn)
|
10
|
-
open(fn) do |mf|
|
11
|
-
lines = mf.read
|
12
|
-
lines.gsub!(/#[^\n]*\n/m, "")
|
13
|
-
lines.gsub!(/\\\n/, ' ')
|
14
|
-
lines.split("\n").each do |line|
|
15
|
-
process_line(line)
|
16
|
-
end
|
17
|
-
end
|
18
|
-
end
|
19
|
-
|
20
|
-
private
|
21
|
-
|
22
|
-
# Process one logical line of makefile data.
|
23
|
-
def process_line(line)
|
24
|
-
file_tasks, args = line.split(':')
|
25
|
-
return if args.nil?
|
26
|
-
dependents = args.split
|
27
|
-
file_tasks.strip.split.each do |file_task|
|
28
|
-
file file_task => dependents
|
29
|
-
end
|
30
|
-
end
|
31
|
-
end
|
32
|
-
|
33
|
-
# Install the handler
|
34
|
-
Rake.application.add_loader('mf', MakefileLoader.new)
|
35
|
-
end
|
@@ -1,185 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
# Define a package task libarary to aid in the definition of
|
4
|
-
# redistributable package files.
|
5
|
-
|
6
|
-
require 'rake'
|
7
|
-
require 'rake/tasklib'
|
8
|
-
|
9
|
-
module Rake
|
10
|
-
|
11
|
-
# Create a packaging task that will package the project into
|
12
|
-
# distributable files (e.g zip archive or tar files).
|
13
|
-
#
|
14
|
-
# The PackageTask will create the following targets:
|
15
|
-
#
|
16
|
-
# [<b>:package</b>]
|
17
|
-
# Create all the requested package files.
|
18
|
-
#
|
19
|
-
# [<b>:clobber_package</b>]
|
20
|
-
# Delete all the package files. This target is automatically
|
21
|
-
# added to the main clobber target.
|
22
|
-
#
|
23
|
-
# [<b>:repackage</b>]
|
24
|
-
# Rebuild the package files from scratch, even if they are not out
|
25
|
-
# of date.
|
26
|
-
#
|
27
|
-
# [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</b>]
|
28
|
-
# Create a gzipped tar package (if <em>need_tar</em> is true).
|
29
|
-
#
|
30
|
-
# [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.gz"</b>]
|
31
|
-
# Create a gzipped tar package (if <em>need_tar_gz</em> is true).
|
32
|
-
#
|
33
|
-
# [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.bz2"</b>]
|
34
|
-
# Create a bzip2'd tar package (if <em>need_tar_bz2</em> is true).
|
35
|
-
#
|
36
|
-
# [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</b>]
|
37
|
-
# Create a zip package archive (if <em>need_zip</em> is true).
|
38
|
-
#
|
39
|
-
# Example:
|
40
|
-
#
|
41
|
-
# Rake::PackageTask.new("rake", "1.2.3") do |p|
|
42
|
-
# p.need_tar = true
|
43
|
-
# p.package_files.include("lib/**/*.rb")
|
44
|
-
# end
|
45
|
-
#
|
46
|
-
class PackageTask < TaskLib
|
47
|
-
# Name of the package (from the GEM Spec).
|
48
|
-
attr_accessor :name
|
49
|
-
|
50
|
-
# Version of the package (e.g. '1.3.2').
|
51
|
-
attr_accessor :version
|
52
|
-
|
53
|
-
# Directory used to store the package files (default is 'pkg').
|
54
|
-
attr_accessor :package_dir
|
55
|
-
|
56
|
-
# True if a gzipped tar file (tgz) should be produced (default is false).
|
57
|
-
attr_accessor :need_tar
|
58
|
-
|
59
|
-
# True if a gzipped tar file (tar.gz) should be produced (default is false).
|
60
|
-
attr_accessor :need_tar_gz
|
61
|
-
|
62
|
-
# True if a bzip2'd tar file (tar.bz2) should be produced (default is false).
|
63
|
-
attr_accessor :need_tar_bz2
|
64
|
-
|
65
|
-
# True if a zip file should be produced (default is false)
|
66
|
-
attr_accessor :need_zip
|
67
|
-
|
68
|
-
# List of files to be included in the package.
|
69
|
-
attr_accessor :package_files
|
70
|
-
|
71
|
-
# Tar command for gzipped or bzip2ed archives. The default is 'tar'.
|
72
|
-
attr_accessor :tar_command
|
73
|
-
|
74
|
-
# Zip command for zipped archives. The default is 'zip'.
|
75
|
-
attr_accessor :zip_command
|
76
|
-
|
77
|
-
# Create a Package Task with the given name and version.
|
78
|
-
def initialize(name=nil, version=nil)
|
79
|
-
init(name, version)
|
80
|
-
yield self if block_given?
|
81
|
-
define unless name.nil?
|
82
|
-
end
|
83
|
-
|
84
|
-
# Initialization that bypasses the "yield self" and "define" step.
|
85
|
-
def init(name, version)
|
86
|
-
@name = name
|
87
|
-
@version = version
|
88
|
-
@package_files = Rake::FileList.new
|
89
|
-
@package_dir = 'pkg'
|
90
|
-
@need_tar = false
|
91
|
-
@need_tar_gz = false
|
92
|
-
@need_tar_bz2 = false
|
93
|
-
@need_zip = false
|
94
|
-
@tar_command = 'tar'
|
95
|
-
@zip_command = 'zip'
|
96
|
-
end
|
97
|
-
|
98
|
-
# Create the tasks defined by this task library.
|
99
|
-
def define
|
100
|
-
fail "Version required (or :noversion)" if @version.nil?
|
101
|
-
@version = nil if :noversion == @version
|
102
|
-
|
103
|
-
desc "Build all the packages"
|
104
|
-
task :package
|
105
|
-
|
106
|
-
desc "Force a rebuild of the package files"
|
107
|
-
task :repackage => [:clobber_package, :package]
|
108
|
-
|
109
|
-
desc "Remove package products"
|
110
|
-
task :clobber_package do
|
111
|
-
rm_r package_dir rescue nil
|
112
|
-
end
|
113
|
-
|
114
|
-
task :clobber => [:clobber_package]
|
115
|
-
|
116
|
-
[
|
117
|
-
[need_tar, tgz_file, "z"],
|
118
|
-
[need_tar_gz, tar_gz_file, "z"],
|
119
|
-
[need_tar_bz2, tar_bz2_file, "j"]
|
120
|
-
].each do |(need, file, flag)|
|
121
|
-
if need
|
122
|
-
task :package => ["#{package_dir}/#{file}"]
|
123
|
-
file "#{package_dir}/#{file}" => [package_dir_path] + package_files do
|
124
|
-
chdir(package_dir) do
|
125
|
-
sh %{env}
|
126
|
-
sh %{#{@tar_command} #{flag}cvf #{file} #{package_name}}
|
127
|
-
end
|
128
|
-
end
|
129
|
-
end
|
130
|
-
end
|
131
|
-
|
132
|
-
if need_zip
|
133
|
-
task :package => ["#{package_dir}/#{zip_file}"]
|
134
|
-
file "#{package_dir}/#{zip_file}" => [package_dir_path] + package_files do
|
135
|
-
chdir(package_dir) do
|
136
|
-
sh %{#{@zip_command} -r #{zip_file} #{package_name}}
|
137
|
-
end
|
138
|
-
end
|
139
|
-
end
|
140
|
-
|
141
|
-
directory package_dir
|
142
|
-
|
143
|
-
file package_dir_path => @package_files do
|
144
|
-
mkdir_p package_dir rescue nil
|
145
|
-
@package_files.each do |fn|
|
146
|
-
f = File.join(package_dir_path, fn)
|
147
|
-
fdir = File.dirname(f)
|
148
|
-
mkdir_p(fdir) if !File.exist?(fdir)
|
149
|
-
if File.directory?(fn)
|
150
|
-
mkdir_p(f)
|
151
|
-
else
|
152
|
-
rm_f f
|
153
|
-
safe_ln(fn, f)
|
154
|
-
end
|
155
|
-
end
|
156
|
-
end
|
157
|
-
self
|
158
|
-
end
|
159
|
-
|
160
|
-
def package_name
|
161
|
-
@version ? "#{@name}-#{@version}" : @name
|
162
|
-
end
|
163
|
-
|
164
|
-
def package_dir_path
|
165
|
-
"#{package_dir}/#{package_name}"
|
166
|
-
end
|
167
|
-
|
168
|
-
def tgz_file
|
169
|
-
"#{package_name}.tgz"
|
170
|
-
end
|
171
|
-
|
172
|
-
def tar_gz_file
|
173
|
-
"#{package_name}.tar.gz"
|
174
|
-
end
|
175
|
-
|
176
|
-
def tar_bz2_file
|
177
|
-
"#{package_name}.tar.bz2"
|
178
|
-
end
|
179
|
-
|
180
|
-
def zip_file
|
181
|
-
"#{package_name}.zip"
|
182
|
-
end
|
183
|
-
end
|
184
|
-
|
185
|
-
end
|
@@ -1,147 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
require 'rake'
|
4
|
-
require 'rake/tasklib'
|
5
|
-
|
6
|
-
module Rake
|
7
|
-
|
8
|
-
# Create a documentation task that will generate the RDoc files for
|
9
|
-
# a project.
|
10
|
-
#
|
11
|
-
# The RDocTask will create the following targets:
|
12
|
-
#
|
13
|
-
# [<b><em>rdoc</em></b>]
|
14
|
-
# Main task for this RDOC task.
|
15
|
-
#
|
16
|
-
# [<b>:clobber_<em>rdoc</em></b>]
|
17
|
-
# Delete all the rdoc files. This target is automatically
|
18
|
-
# added to the main clobber target.
|
19
|
-
#
|
20
|
-
# [<b>:re<em>rdoc</em></b>]
|
21
|
-
# Rebuild the rdoc files from scratch, even if they are not out
|
22
|
-
# of date.
|
23
|
-
#
|
24
|
-
# Simple Example:
|
25
|
-
#
|
26
|
-
# Rake::RDocTask.new do |rd|
|
27
|
-
# rd.main = "README.rdoc"
|
28
|
-
# rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
|
29
|
-
# end
|
30
|
-
#
|
31
|
-
# You may wish to give the task a different name, such as if you are
|
32
|
-
# generating two sets of documentation. For instance, if you want to have a
|
33
|
-
# development set of documentation including private methods:
|
34
|
-
#
|
35
|
-
# Rake::RDocTask.new(:rdoc_dev) do |rd|
|
36
|
-
# rd.main = "README.doc"
|
37
|
-
# rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
|
38
|
-
# rd.options << "--all"
|
39
|
-
# end
|
40
|
-
#
|
41
|
-
# The tasks would then be named :<em>rdoc_dev</em>, :clobber_<em>rdoc_dev</em>, and
|
42
|
-
# :re<em>rdoc_dev</em>.
|
43
|
-
#
|
44
|
-
class RDocTask < TaskLib
|
45
|
-
# Name of the main, top level task. (default is :rdoc)
|
46
|
-
attr_accessor :name
|
47
|
-
|
48
|
-
# Name of directory to receive the html output files. (default is "html")
|
49
|
-
attr_accessor :rdoc_dir
|
50
|
-
|
51
|
-
# Title of RDoc documentation. (default is none)
|
52
|
-
attr_accessor :title
|
53
|
-
|
54
|
-
# Name of file to be used as the main, top level file of the
|
55
|
-
# RDoc. (default is none)
|
56
|
-
attr_accessor :main
|
57
|
-
|
58
|
-
# Name of template to be used by rdoc. (defaults to rdoc's default)
|
59
|
-
attr_accessor :template
|
60
|
-
|
61
|
-
# List of files to be included in the rdoc generation. (default is [])
|
62
|
-
attr_accessor :rdoc_files
|
63
|
-
|
64
|
-
# List of options to be passed rdoc. (default is [])
|
65
|
-
attr_accessor :options
|
66
|
-
|
67
|
-
# Run the rdoc process as an external shell (default is false)
|
68
|
-
attr_accessor :external
|
69
|
-
|
70
|
-
# Create an RDoc task named <em>rdoc</em>. Default task name is +rdoc+.
|
71
|
-
def initialize(name=:rdoc) # :yield: self
|
72
|
-
@name = name
|
73
|
-
@rdoc_files = Rake::FileList.new
|
74
|
-
@rdoc_dir = 'html'
|
75
|
-
@main = nil
|
76
|
-
@title = nil
|
77
|
-
@template = nil
|
78
|
-
@external = false
|
79
|
-
@options = []
|
80
|
-
yield self if block_given?
|
81
|
-
define
|
82
|
-
end
|
83
|
-
|
84
|
-
# Create the tasks defined by this task lib.
|
85
|
-
def define
|
86
|
-
if name.to_s != "rdoc"
|
87
|
-
desc "Build the RDOC HTML Files"
|
88
|
-
end
|
89
|
-
|
90
|
-
desc "Build the #{name} HTML Files"
|
91
|
-
task name
|
92
|
-
|
93
|
-
desc "Force a rebuild of the RDOC files"
|
94
|
-
task "re#{name}" => ["clobber_#{name}", name]
|
95
|
-
|
96
|
-
desc "Remove rdoc products"
|
97
|
-
task "clobber_#{name}" do
|
98
|
-
rm_r rdoc_dir rescue nil
|
99
|
-
end
|
100
|
-
|
101
|
-
task :clobber => ["clobber_#{name}"]
|
102
|
-
|
103
|
-
directory @rdoc_dir
|
104
|
-
task name => [rdoc_target]
|
105
|
-
file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
|
106
|
-
rm_r @rdoc_dir rescue nil
|
107
|
-
args = option_list + @rdoc_files
|
108
|
-
if @external
|
109
|
-
argstring = args.join(' ')
|
110
|
-
sh %{ruby -Ivendor vender/rd #{argstring}}
|
111
|
-
else
|
112
|
-
require 'rdoc/rdoc'
|
113
|
-
RDoc::RDoc.new.document(args)
|
114
|
-
end
|
115
|
-
end
|
116
|
-
self
|
117
|
-
end
|
118
|
-
|
119
|
-
def option_list
|
120
|
-
result = @options.dup
|
121
|
-
result << "-o" << @rdoc_dir
|
122
|
-
result << "--main" << quote(main) if main
|
123
|
-
result << "--title" << quote(title) if title
|
124
|
-
result << "-T" << quote(template) if template
|
125
|
-
result
|
126
|
-
end
|
127
|
-
|
128
|
-
def quote(str)
|
129
|
-
if @external
|
130
|
-
"'#{str}'"
|
131
|
-
else
|
132
|
-
str
|
133
|
-
end
|
134
|
-
end
|
135
|
-
|
136
|
-
def option_string
|
137
|
-
option_list.join(' ')
|
138
|
-
end
|
139
|
-
|
140
|
-
private
|
141
|
-
|
142
|
-
def rdoc_target
|
143
|
-
"#{rdoc_dir}/index.html"
|
144
|
-
end
|
145
|
-
|
146
|
-
end
|
147
|
-
end
|