Top Level Namespace
- Includes:
- RakeFileUtils
Defined Under Namespace
Modules: FileUtils, Rake, RakeFileUtils, Sys, Test Classes: CompositePublisher, HostInfo, Module, SshDirPublisher, SshFilePublisher, SshFreshDirPublisher, String, Time
Constant Summary collapse
- RAKEVERSION =
Copyright © 2003, 2004, 2005, 2006, 2007 Jim Weirich
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ++
Rake – Ruby Make
This is the main file for the Rake application. Normally it is referenced as a library via a require statement, but it can be distributed independently as an application.
'0.8.3'
- FileList =
Alias FileList to be available at the top level.
Rake::FileList
- CLEAN =
Rake::FileList["**/*~", "**/*.bak", "**/core"]
- CLOBBER =
Rake::FileList.new
- Task =
The following classes used to be in the top level namespace. Loading this file enables compatibility with older Rakefile that referenced Task from the top level.
Rake::Task
- FileTask =
Rake::FileTask
- FileCreationTask =
Rake::FileCreationTask
- RakeApp =
Rake::Application
Constants included from FileUtils
FileUtils::LN_SUPPORTED, FileUtils::RUBY
Instance Method Summary collapse
-
#desc(description) ⇒ Object
Describe the next rake task.
-
#directory(dir) ⇒ Object
Declare a set of files tasks to create the given directories on demand.
-
#file(*args, &block) ⇒ Object
Declare a file task.
-
#file_create(args, &block) ⇒ Object
Declare a file creation task.
-
#import(*fns) ⇒ Object
Import the partial Rakefiles
fn
. -
#multitask(args, &block) ⇒ Object
Declare a task that performs its prerequisites in parallel.
-
#namespace(name = nil, &block) ⇒ Object
Create a new rake namespace and use it for evaluating the given block.
-
#rule(*args, &block) ⇒ Object
Declare a rule for auto-tasks.
-
#task(*args, &block) ⇒ Object
Declare a basic task.
Methods included from RakeFileUtils
#nowrite, #verbose, #when_writing
Methods included from FileUtils
#ruby, #safe_ln, #sh, #split_all
Instance Method Details
#desc(description) ⇒ Object
Describe the next rake task.
Example:
desc "Run the Unit Tests"
task :test => [:build]
runtests
end
914 915 916 |
# File 'lib/rake.rb', line 914 def desc(description) Rake.application.last_description = description end |
#directory(dir) ⇒ Object
Declare a set of files tasks to create the given directories on demand.
Example:
directory "testdata/doc"
861 862 863 864 865 866 867 |
# File 'lib/rake.rb', line 861 def directory(dir) Rake.each_dir_parent(dir) do |d| file_create d do |t| mkdir_p t.name if ! File.exist?(t.name) end end end |
#file(*args, &block) ⇒ Object
Declare a file task.
Example:
file "config.cfg" => ["config.template"] do
open("config.cfg", "w") do |outfile|
open("config.template") do |infile|
while line = infile.gets
outfile.puts line
end
end
end
end
846 847 848 |
# File 'lib/rake.rb', line 846 def file(*args, &block) Rake::FileTask.define_task(*args, &block) end |
#file_create(args, &block) ⇒ Object
Declare a file creation task. (Mainly used for the directory command).
852 853 854 |
# File 'lib/rake.rb', line 852 def file_create(args, &block) Rake::FileCreationTask.define_task(args, &block) end |
#import(*fns) ⇒ Object
Import the partial Rakefiles fn
. Imported files are loaded after the current file is completely loaded. This allows the import statement to appear anywhere in the importing file, and yet allowing the imported files to depend on objects defined in the importing file.
A common use of the import statement is to include files containing dependency declarations.
See also the –rakelibdir command line option.
Example:
import ".depend", "my_rules"
931 932 933 934 935 |
# File 'lib/rake.rb', line 931 def import(*fns) fns.each do |fn| Rake.application.add_import(fn) end end |
#multitask(args, &block) ⇒ Object
Declare a task that performs its prerequisites in parallel. Multitasks does not guarantee that its prerequisites will execute in any given order (which is obvious when you think about it)
Example:
multitask :deploy => [:deploy_gem, :deploy_rdoc]
876 877 878 |
# File 'lib/rake.rb', line 876 def multitask(args, &block) Rake::MultiTask.define_task(args, &block) end |
#namespace(name = nil, &block) ⇒ Object
Create a new rake namespace and use it for evaluating the given block. Returns a NameSpace object that can be used to lookup tasks defined in the namespace.
E.g.
ns = namespace "nested" do
task :run
end
task_run = ns[:run] # find :run in the given namespace.
891 892 893 |
# File 'lib/rake.rb', line 891 def namespace(name=nil, &block) Rake.application.in_namespace(name, &block) end |
#rule(*args, &block) ⇒ Object
Declare a rule for auto-tasks.
Example:
rule '.o' => '.c' do |t|
sh %{cc -o #{t.name} #{t.source}}
end
902 903 904 |
# File 'lib/rake.rb', line 902 def rule(*args, &block) Rake::Task.create_rule(*args, &block) end |
#task(*args, &block) ⇒ Object
Declare a basic task.
Example:
task :clobber => [:clean] do
rm_rf "html"
end
828 829 830 |
# File 'lib/rake.rb', line 828 def task(*args, &block) Rake::Task.define_task(*args, &block) end |