1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
|
#!/usr/bin/env ruby
#--
# Copyright (c) 2003, 2004 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.
RAKEVERSION = '0.5.3'
require 'rbconfig'
require 'ftools'
require 'getoptlong'
require 'fileutils'
$last_comment = nil
$show_tasks = nil
$show_prereqs = nil
$trace = nil
$dryrun = nil
$silent = false
# Some objects are dupable, some are not. So we define a version of
# dup (called rake_dup) that returns self on the handful of classes
# that are not dupable.
module Kernel
# Duplicate an object if it can be duplicated. If it can not be
# cloned or duplicated, then just return the original object.
def rake_dup()
dup
end
end
[NilClass, FalseClass, TrueClass, Fixnum, Symbol].each do |clazz|
clazz.class_eval {
# Duplicate an object if it can be duplicated. If it can not be
# cloned or duplicated, then just return the original object.
def rake_dup() self end
}
end
######################################################################
# User defined methods to be added to String.
#
class String
unless instance_methods.include? "ext"
# Replace the file extension with +newext+. If there is no
# extenson on the string, append the new extension to the end. If
# the new extension is not given, or is the empty string, remove
# any existing extension.
#
# +ext+ is a user added method for the String class.
def ext(newext='')
return self.dup if ['.', '..'].include? self
if newext != ''
newext = (newext =~ /^\./) ? newext : ("." + newext)
end
dup.sub!(%r(([^/\\])\.[^./\\]*$)) { $1 + newext } || self + newext
end
end
end
######################################################################
module Rake
class << self
# Current Rake Application
def application
@application ||= RakeApp.new
end
def application=(app)
fail "RakeApp already exists" if defined?(@application)
@application = app
end
end
module Cloneable
def clone
sibling = self.class.new
instance_variables.each do |ivar|
value = self.instance_variable_get(ivar)
sibling.instance_variable_set(ivar, value.rake_dup)
end
sibling
end
alias dup clone
end
end
######################################################################
# A Task is the basic unit of work in a Rakefile. Tasks have
# associated actions (possibly more than one) and a list of
# prerequisites. When invoked, a task will first ensure that all of
# its prerequisites have an opportunity to run and then it will
# execute its own actions.
#
# Tasks are not usually created directly using the new method, but
# rather use the +file+ and +task+ convenience methods.
#
class Task
TASKS = Hash.new
RULES = Array.new
# List of prerequisites for a task.
attr_reader :prerequisites
# Comment for this task.
attr_accessor :comment
# Source dependency for rule synthesized tasks. Nil if task was not
# sythesized from a rule.
attr_accessor :source
# Create a task named +task_name+ with no actions or prerequisites..
# use +enhance+ to add actions and prerequisites.
def initialize(task_name)
@name = task_name
@prerequisites = FileList[]
@actions = []
@already_invoked = false
@comment = nil
end
# Enhance a task with prerequisites or actions. Returns self.
def enhance(deps=nil, &block)
@prerequisites |= deps if deps
@actions << block if block_given?
self
end
# Name of the task.
def name
@name.to_s
end
# Invoke the task if it is needed. Prerequites are invoked first.
def invoke
if $trace
puts "** Invoke #{name} #{format_trace_flags}"
end
return if @already_invoked
@already_invoked = true
@prerequisites.each { |n| Task[n].invoke }
execute if needed?
end
# Format the trace flags for display.
def format_trace_flags
flags = []
flags << "first_time" unless @already_invoked
flags << "not_needed" unless needed?
flags.empty? ? "" : "(" + flags.join(", ") + ")"
end
private :format_trace_flags
# Execute the actions associated with this task.
def execute
if $dryrun
puts "** Execute (dry run) #{name}"
return
end
if $trace
puts "** Execute #{name}"
end
self.class.enhance_with_matching_rule(name) if @actions.empty?
@actions.each { |act| result = act.call(self) }
end
# Is this task needed?
def needed?
true
end
# Timestamp for this task. Basic tasks return the current time for
# their time stamp. Other tasks can be more sophisticated.
def timestamp
@prerequisites.collect { |p| Task[p].timestamp }.max || Time.now
end
# Add a comment to the task. If a comment alread exists, separate
# the new comment with " / ".
def add_comment(comment)
return if ! $last_comment
if @comment
@comment << " / "
else
@comment = ''
end
@comment << $last_comment
$last_comment = nil
end
# Rake Module Methods ----------------------------------------------
class << self
# Clear the task list. This cause rake to immediately forget all
# the tasks that have been assigned. (Normally used in the unit
# tests.)
def clear
TASKS.clear
RULES.clear
end
# List of all defined tasks.
def tasks
TASKS.keys.sort.collect { |tn| Task[tn] }
end
# Return a task with the given name. If the task is not currently
# known, try to synthesize one from the defined rules. If no
# rules are found, but an existing file matches the task name,
# assume it is a file task with no dependencies or actions.
def [](task_name)
task_name = task_name.to_s
if task = TASKS[task_name]
return task
end
if task = enhance_with_matching_rule(task_name)
return task
end
if File.exist?(task_name)
return FileTask.define_task(task_name)
end
fail "Don't know how to build task '#{task_name}'"
end
# TRUE if the task name is already defined.
def task_defined?(task_name)
task_name = task_name.to_s
TASKS[task_name]
end
# Define a task given +args+ and an option block. If a rule with
# the given name already exists, the prerequisites and actions are
# added to the existing task. Returns the defined task.
def define_task(args, &block)
task_name, deps = resolve_args(args)
deps = [deps] if (Symbol === deps) || (String === deps)
deps = deps.collect {|d| d.to_s }
t = lookup(task_name)
t.add_comment($last_comment)
t.enhance(deps, &block)
end
# Define a rule for synthesizing tasks.
def create_rule(args, &block)
pattern, deps = resolve_args(args)
fail "Too many dependents specified in rule #{pattern}: #{deps.inspect}" if deps.size > 1
pattern = Regexp.new(Regexp.quote(pattern) + '$') if String === pattern
RULES << [pattern, deps, block]
end
# Lookup a task. Return an existing task if found, otherwise
# create a task of the current type.
def lookup(task_name)
name = task_name.to_s
TASKS[name] ||= self.new(task_name)
end
# If a rule can be found that matches the task name, enhance the
# task with the prerequisites and actions from the rule. Set the
# source attribute of the task appropriately for the rule. Return
# the enhanced task or nil of no rule was found.
def enhance_with_matching_rule(task_name, level=0)
fail Rake::RuleRecursionOverflowError,
"Rule Recursion Too Deep" if level >= 16
RULES.each do |pattern, extensions, block|
if md = pattern.match(task_name)
ext = extensions.first
case ext
when String
source = task_name.sub(/\.[^.]*$/, ext)
when Proc
source = ext.call(task_name)
else
fail "Don't know how to handle rule dependent: #{ext.inspect}"
end
if File.exist?(source) || Task.task_defined?(source)
task = FileTask.define_task({task_name => [source]}, &block)
task.source = source
return task
elsif parent = enhance_with_matching_rule(source, level+1)
task = FileTask.define_task({task_name => [parent.name]}, &block)
task.source = parent.name
return task
end
end
end
nil
rescue Rake::RuleRecursionOverflowError => ex
ex.add_target(task_name)
fail ex
end
private
# Resolve the arguments for a task/rule.
def resolve_args(args)
case args
when Hash
fail "Too Many Task Names: #{args.keys.join(' ')}" if args.size > 1
fail "No Task Name Given" if args.size < 1
task_name = args.keys[0]
deps = args[task_name]
deps = [deps] if (String===deps) || (Regexp===deps) || (Proc===deps)
else
task_name = args
deps = []
end
[task_name, deps]
end
end
end
######################################################################
# A FileTask is a task that includes time based dependencies. If any
# of a FileTask's prerequisites have a timestamp that is later than
# the file represented by this task, then the file must be rebuilt
# (using the supplied actions).
#
class FileTask < Task
# Is this file task needed? Yes if it doesn't exist, or if its time
# stamp is out of date.
def needed?
return true unless File.exist?(name)
latest_prereq = @prerequisites.collect{|n| Task[n].timestamp}.max
return false if latest_prereq.nil?
timestamp < latest_prereq
rescue Errno::ENOENT => ex # one of the prereqs does not exist
raise unless $dryrun or $trace
true
end
# Time stamp for file task.
def timestamp
File.mtime(name.to_s)
end
end
######################################################################
# Task Definition Functions ...
# Declare a basic task.
#
# Example:
# task :clobber => [:clean] do
# rm_rf "html"
# end
#
def task(args, &block)
Task.define_task(args, &block)
end
# 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
#
def file(args, &block)
FileTask.define_task(args, &block)
end
# Declare a set of files tasks to create the given directories on
# demand.
#
# Example:
# directory "testdata/doc"
#
def directory(dir)
while dir != '.' && dir != '/'
file dir do |t|
mkdir_p t.name if ! File.exist?(t.name)
end
dir = File.dirname(dir)
end
end
# Declare a rule for auto-tasks.
#
# Example:
# rule '.o' => '.c' do |t|
# sh %{cc -o #{t.name} #{t.source}}
# end
#
def rule(args, &block)
Task.create_rule(args, &block)
end
# Describe the next rake task.
#
# Example:
# desc "Run the Unit Tests"
# task :test => [:build]
# runtests
# end
#
def desc(comment)
$last_comment = comment
end
# Import the partial Rakekfile +fn+.
#
# Example:
# import ".depend"
#
def import(fn)
Rake.application.add_import(fn)
end
######################################################################
# This a FileUtils extension that defines several additional commands
# to be added to the FileUtils utility functions.
#
module FileUtils
RUBY = Config::CONFIG['ruby_install_name']
OPT_TABLE['sh'] = %w(noop verbose)
OPT_TABLE['ruby'] = %w(noop verbose)
# Run the system command +cmd+. If multiple arguments are given
# the command is not run with the shell (same semantics as
# Kernel::exec and Kernel::system).
#
# Example:
# sh %{ls -ltr}
#
# sh 'ls', 'file with spaces'
#
# # check exit status after command runs
# sh %{grep pattern file} do |ok, res|
# if ! ok
# puts "pattern not found (status = #{res.exitstatus})"
# end
# end
#
def sh(*cmd, &block)
if Hash === cmd.last then
options = cmd.pop
else
options = {}
end
unless block_given?
show_command = cmd.join(" ")
show_command = show_command[0,42] + "..." if show_command.length > 45
block = lambda { |ok, status|
ok or fail "Command failed with status (#{status.exitstatus}): [#{show_command}]"
}
end
fu_check_options options, :noop, :verbose
fu_output_message cmd.join(" ") if options[:verbose]
unless options[:noop]
res = system(*cmd)
block.call(res, $?)
end
end
# Run a Ruby interpreter with the given arguments.
#
# Example:
# ruby %{-pe '$_.upcase!' <README}
#
def ruby(*args,&block)
if Hash === args.last
options = args.pop
else
options = {}
end
if args.length > 1 then
sh(*([RUBY] + args + [options]), &block)
else
sh("#{RUBY} #{args}", options, &block)
end
end
LN_SUPPORTED = [true]
# Attempt to do a normal file link, but fall back to a copy if the
# link fails.
def safe_ln(*args)
unless LN_SUPPORTED[0]
cp(*args)
else
begin
ln(*args)
rescue Errno::EOPNOTSUPP
LN_SUPPORTED[0] = false
cp(*args)
end
end
end
# Split a file path into individual directory names.
#
# Example:
# split_all("a/b/c") => ['a', 'b', 'c']
#
def split_all(path)
head, tail = File.split(path)
return [tail] if head == '.' || tail == '/'
return [head, tail] if head == '/'
return split_all(head) + [tail]
end
end
######################################################################
# RakeFileUtils provides a custom version of the FileUtils methods
# that respond to the <tt>verbose</tt> and <tt>nowrite</tt> commands.
#
module RakeFileUtils
include FileUtils
$fileutils_output = $stderr
$fileutils_label = ''
$fileutils_verbose = true
$fileutils_nowrite = false
FileUtils::OPT_TABLE.each do |name, opts|
next unless opts.include?('verbose')
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}( *args, &block )
super(*fu_merge_option(args,
:verbose => $fileutils_verbose,
:noop => $fileutils_nowrite),
&block)
end
EOS
end
# Get/set the verbose flag controlling output from the FileUtils
# utilities. If verbose is true, then the utility method is echoed
# to standard output.
#
# Examples:
# verbose # return the current value of the verbose flag
# verbose(v) # set the verbose flag to _v_.
# verbose(v) { code } # Execute code with the verbose flag set temporarily to _v_.
# # Return to the original value when code is done.
def verbose(value=nil)
oldvalue = $fileutils_verbose
$fileutils_verbose = value unless value.nil?
if block_given?
begin
yield
ensure
$fileutils_verbose = oldvalue
end
end
$fileutils_verbose
end
# Get/set the nowrite flag controlling output from the FileUtils
# utilities. If verbose is true, then the utility method is echoed
# to standard output.
#
# Examples:
# nowrite # return the current value of the nowrite flag
# nowrite(v) # set the nowrite flag to _v_.
# nowrite(v) { code } # Execute code with the nowrite flag set temporarily to _v_.
# # Return to the original value when code is done.
def nowrite(value=nil)
oldvalue = $fileutils_nowrite
$fileutils_nowrite = value unless value.nil?
if block_given?
begin
yield
ensure
$fileutils_nowrite = oldvalue
end
end
oldvalue
end
# Use this function to prevent protentially destructive ruby code
# from running when the :nowrite flag is set.
#
# Example:
#
# when_writing("Building Project") do
# project.build
# end
#
# The following code will build the project under normal conditions.
# If the nowrite(true) flag is set, then the example will print:
# DRYRUN: Building Project
# instead of actually building the project.
#
def when_writing(msg=nil)
if $fileutils_nowrite
puts "DRYRUN: #{msg}" if msg
else
yield
end
end
# Merge the given options with the default values.
def fu_merge_option(args, defaults)
if Hash === args.last
defaults.update(args.last)
args.pop
end
args.push defaults
args
end
private :fu_merge_option
extend self
end
######################################################################
# Include the FileUtils file manipulation functions in the top level
# module, but mark them private so that they don't unintentionally
# define methods on other objects.
file_utils_methods = (FileUtils.methods - Object.methods)
include RakeFileUtils
file_utils_methods.each do |name|
private name.to_sym
end
file_utils_methods = nil
######################################################################
module Rake
class RuleRecursionOverflowError < StandardError
def initialize(*args)
super
@targets = []
end
def add_target(target)
@targets << target
end
def message
super + ": [" + @targets.reverse.join(' => ') + "]"
end
end
####################################################################
# A FileList is essentially an array with a few helper methods
# defined to make file manipulation a bit easier.
#
# FileLists are lazy. When given a list of glob patterns for
# possible files to be included in the file list, instead of
# searching the file structures to find the files, a FileList holds
# the pattern for latter use.
#
# This allows us to define a number of FileList to match any number of
# files, but only search out the actual files when then FileList
# itself is actually used. The key is that the first time an
# element of the FileList/Array is requested, the pending patterns
# are resolved into a real list of file names.
#
class FileList
include Cloneable
# == Method Delegation
#
# The lazy evaluation magic of FileLists happens by implementing
# all the array specific methods to call +resolve+ before
# delegating the heavy lifting to an embedded array object
# (@items).
#
# In addition, there are two kinds of delegation calls. The
# regular kind delegates to the @items array and returns the
# result directly. Well, almost directly. It checks if the
# returned value is the @items object itself, and if so will
# return the FileList object instead.
#
# The second kind of delegation call is used in methods that
# normally return a new Array object. We want to capture the
# return value of these methods and wrap them in a new FileList
# object. We enumerate these methods in the +SPECIAL_RETURN+ list
# below.
# List of array methods (that are not in +Object+) that need to be
# delegated.
ARRAY_METHODS = Array.instance_methods - Object.instance_methods
# List of additional methods that must be delegated.
MUST_DEFINE = %w[to_a inspect]
# List of methods that should not be delegated here (we define
# special versions of them explicitly below).
MUST_NOT_DEFINE = %w[to_a to_ary partition *]
# List of delegated methods that return new array values which
# need wrapping.
SPECIAL_RETURN = %w[
map collect sort sort_by select find_all reject grep
compact flatten uniq values_at
+ - & |
]
DELEGATING_METHODS = (ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE).sort.uniq
# Now do the delegation.
DELEGATING_METHODS.each_with_index do |sym, i|
if SPECIAL_RETURN.include?(sym)
ln = __LINE__+1
class_eval %{
def #{sym}(*args, &block)
resolve if @pending
result = @items.send(:#{sym}, *args, &block)
FileList.new.import(result)
end
}, __FILE__, ln
else
ln = __LINE__+1
class_eval %{
def #{sym}(*args, &block)
resolve if @pending
result = @items.send(:#{sym}, *args, &block)
result.object_id == @items.object_id ? self : result
end
}, __FILE__, ln
end
end
# Create a file list from the globbable patterns given. If you
# wish to perform multiple includes or excludes at object build
# time, use the "yield self" pattern.
#
# Example:
# file_list = FileList.new['lib/**/*.rb', 'test/test*.rb']
#
# pkg_files = FileList.new['lib/**/*'] do |fl|
# fl.exclude(/\bCVS\b/)
# end
#
def initialize(*patterns)
@pending_add = []
@pending = false
@exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
@exclude_re = nil
@items = []
patterns.each { |pattern| include(pattern) }
yield self if block_given?
end
# Add file names defined by glob patterns to the file list. If an
# array is given, add each element of the array.
#
# Example:
# file_list.include("*.java", "*.cfg")
# file_list.include %w( math.c lib.h *.o )
#
def include(*filenames)
# TODO: check for pending
filenames.each do |fn| @pending_add << fn end
@pending = true
self
end
alias :add :include
# Register a list of file name patterns that should be excluded
# from the list. Patterns may be regular expressions, glob
# patterns or regular strings.
#
# Note that glob patterns are expanded against the file system.
# If a file is explicitly added to a file list, but does not exist
# in the file system, then an glob pattern in the exclude list
# will not exclude the file.
#
# Examples:
# FileList['a.c', 'b.c'].exclude("a.c") => ['b.c']
# FileList['a.c', 'b.c'].exclude(/^a/) => ['b.c']
#
# If "a.c" is a file, then ...
# FileList['a.c', 'b.c'].exclude("a.*") => ['b.c']
#
# If "a.c" is not a file, then ...
# FileList['a.c', 'b.c'].exclude("a.*") => ['a.c', 'b.c']
#
def exclude(*patterns)
patterns.each do |pat| @exclude_patterns << pat end
if ! @pending
calculate_exclude_regexp
reject! { |fn| fn =~ @exclude_re }
end
self
end
# Clear all the exclude patterns so that we exclude nothing.
def clear_exclude
@exclude_patterns = []
calculate_exclude_regexp if ! @pending
end
# Define equality.
def ==(array)
to_ary == array
end
# Return the internal array object.
def to_a
resolve
@items
end
# Return the internal array object.
def to_ary
resolve
@items
end
# Redefine * to return either a string or a new file list.
def *(other)
result = @items * other
case result
when Array
FileList.new.import(result)
else
result
end
end
# Resolve all the pending adds now.
def resolve
if @pending
@pending = false
@pending_add.each do |fn| resolve_add(fn) end
@pending_add = []
resolve_exclude
end
self
end
def calculate_exclude_regexp
ignores = []
@exclude_patterns.each do |pat|
case pat
when Regexp
ignores << pat
when /[*.]/
Dir[pat].each do |p| ignores << p end
else
ignores << Regexp.quote(pat)
end
end
if ignores.empty?
@exclude_re = /^$/
else
re_str = ignores.collect { |p| "(" + p.to_s + ")" }.join("|")
@exclude_re = Regexp.new(re_str)
end
end
def resolve_add(fn)
case fn
when Array
fn.each { |f| self.resolve_add(f) }
when %r{[*?]}
add_matching(fn)
else
self << fn
end
end
def resolve_exclude
@exclude_patterns.each do |pat|
case pat
when Regexp
reject! { |fn| fn =~ pat }
when /[*.]/
reject_list = Dir[pat]
reject! { |fn| reject_list.include?(fn) }
else
reject! { |fn| fn == pat }
end
end
self
end
# Return a new FileList with the results of running +sub+ against
# each element of the oringal list.
#
# Example:
# FileList['a.c', 'b.c'].sub(/\.c$/, '.o') => ['a.o', 'b.o']
#
def sub(pat, rep)
inject(FileList.new) { |res, fn| res << fn.sub(pat,rep) }
end
# Return a new FileList with the results of running +gsub+ against
# each element of the original list.
#
# Example:
# FileList['lib/test/file', 'x/y'].gsub(/\//, "\\")
# => ['lib\\test\\file', 'x\\y']
#
def gsub(pat, rep)
inject(FileList.new) { |res, fn| res << fn.gsub(pat,rep) }
end
# Same as +sub+ except that the oringal file list is modified.
def sub!(pat, rep)
each_with_index { |fn, i| self[i] = fn.sub(pat,rep) }
self
end
# Same as +gsub+ except that the original file list is modified.
def gsub!(pat, rep)
each_with_index { |fn, i| self[i] = fn.gsub(pat,rep) }
self
end
# Return a new array with <tt>String#ext</tt> method applied to
# each member of the array.
#
# This method is a shortcut for:
#
# array.collect { |item| item.ext(newext) }
#
# +ext+ is a user added method for the Array class.
def ext(newext='')
collect { |fn| fn.ext(newext) }
end
# FileList version of partition. Needed because the nested arrays
# should be FileLists in this version.
def partition(&block) # :nodoc:
resolve
result = @items.partition(&block)
[
FileList.new.import(result[0]),
FileList.new.import(result[1]),
]
end
# Convert a FileList to a string by joining all elements with a space.
def to_s
resolve if @pending
self.join(' ')
end
# Add matching glob patterns.
def add_matching(pattern)
Dir[pattern].each do |fn|
self << fn unless exclude?(fn)
end
end
private :add_matching
# Should the given file name be excluded?
def exclude?(fn)
calculate_exclude_regexp unless @exclude_re
fn =~ @exclude_re
end
DEFAULT_IGNORE_PATTERNS = [
/(^|[\/\\])CVS([\/\\]|$)/,
/\.bak$/,
/~$/,
/(^|[\/\\])core$/
]
@exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
def import(array)
@items = array
self
end
class << self
# Create a new file list including the files listed. Similar to:
#
# FileList.new(*args)
def [](*args)
new(*args)
end
# Set the ignore patterns back to the default value. The
# default patterns will ignore files
# * containing "CVS" in the file path
# * ending with ".bak"
# * ending with "~"
# * named "core"
#
# Note that file names beginning with "." are automatically
# ignored by Ruby's glob patterns and are not specifically
# listed in the ignore patterns.
def select_default_ignore_patterns
@exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
end
# Clear the ignore patterns.
def clear_ignore_patterns
@exclude_patterns = [ /^$/ ]
end
end
end
end
# Alias FileList to be available at the top level.
FileList = Rake::FileList
######################################################################
module Rake
# Default Rakefile loader used by +import+.
class DefaultLoader
def load(fn)
Kernel.load fn
end
end
end
######################################################################
# Rake main application object. When invoking +rake+ from the command
# line, a RakeApp object is created and run.
#
class RakeApp
RAKEFILES = ['rakefile', 'Rakefile', 'rakefile.rb', 'Rakefile.rb']
OPTIONS = [
['--dry-run', '-n', GetoptLong::NO_ARGUMENT,
"Do a dry run without executing actions."],
['--help', '-H', GetoptLong::NO_ARGUMENT,
"Display this help message."],
['--libdir', '-I', GetoptLong::REQUIRED_ARGUMENT,
"Include LIBDIR in the search path for required modules."],
['--nosearch', '-N', GetoptLong::NO_ARGUMENT,
"Do not search parent directories for the Rakefile."],
['--prereqs', '-P', GetoptLong::NO_ARGUMENT,
"Display the tasks and dependencies, then exit."],
['--quiet', '-q', GetoptLong::NO_ARGUMENT,
"Do not log messages to standard output."],
['--rakefile', '-f', GetoptLong::REQUIRED_ARGUMENT,
"Use FILE as the rakefile."],
['--require', '-r', GetoptLong::REQUIRED_ARGUMENT,
"Require MODULE before executing rakefile."],
['--silent', '-s', GetoptLong::NO_ARGUMENT,
"Like --quiet, but also suppresses the 'in directory' announcement."],
['--tasks', '-T', GetoptLong::NO_ARGUMENT,
"Display the tasks and dependencies, then exit."],
['--trace', '-t', GetoptLong::NO_ARGUMENT,
"Turn on invoke/execute tracing, enable full backtrace."],
['--usage', '-h', GetoptLong::NO_ARGUMENT,
"Display usage."],
['--verbose', '-v', GetoptLong::NO_ARGUMENT,
"Log message to standard output (default)."],
['--version', '-V', GetoptLong::NO_ARGUMENT,
"Display the program version."],
]
# Create a RakeApp object.
def initialize
@rakefile = nil
@pending_imports = []
@imported = []
@nosearch = false
@loaders = {}
@default_loader = Rake::DefaultLoader.new
Rake.application = self
end
# True if one of the files in RAKEFILES is in the current directory.
# If a match is found, it is copied into @rakefile.
def have_rakefile
RAKEFILES.each do |fn|
if File.exist?(fn)
@rakefile = fn
return true
end
end
return false
end
# Display the program usage line.
def usage
puts "rake [-f rakefile] {options} targets..."
end
# Display the rake command line help.
def help
usage
puts
puts "Options are ..."
puts
OPTIONS.sort.each do |long, short, mode, desc|
if mode == GetoptLong::REQUIRED_ARGUMENT
if desc =~ /\b([A-Z]{2,})\b/
long = long + "=#{$1}"
end
end
printf " %-20s (%s)\n", long, short
printf " %s\n", desc
end
end
# Display the tasks and dependencies.
def display_tasks_and_comments
width = Task.tasks.select { |t|
t.comment
}.collect { |t|
t.name.length
}.max
Task.tasks.each do |t|
if t.comment
printf "rake %-#{width}s # %s\n", t.name, t.comment
end
end
end
# Display the tasks and prerequisites
def display_prerequisites
Task.tasks.each do |t|
puts "rake #{t.name}"
t.prerequisites.each { |pre| puts " #{pre}" }
end
end
# Return a list of the command line options supported by the
# program.
def command_line_options
OPTIONS.collect { |lst| lst[0..-2] }
end
# Do the option defined by +opt+ and +value+.
def do_option(opt, value)
case opt
when '--dry-run'
verbose(true)
nowrite(true)
$dryrun = true
$trace = true
when '--help'
help
exit
when '--libdir'
$:.push(value)
when '--nosearch'
@nosearch = true
when '--prereqs'
$show_prereqs = true
when '--quiet'
verbose(false)
when '--rakefile'
RAKEFILES.clear
RAKEFILES << value
when '--require'
require value
when '--silent'
verbose(false)
$silent = true
when '--tasks'
$show_tasks = true
when '--trace'
$trace = true
verbose(true)
when '--usage'
usage
exit
when '--verbose'
verbose(true)
when '--version'
puts "rake, version #{RAKEVERSION}"
exit
else
fail "Unknown option: #{opt}"
end
end
# Read and handle the command line options.
def handle_options
opts = GetoptLong.new(*command_line_options)
opts.each { |opt, value| do_option(opt, value) }
end
def load_rakefile
here = Dir.pwd
while ! have_rakefile
Dir.chdir("..")
if Dir.pwd == here || @nosearch
fail "No Rakefile found (looking for: #{RAKEFILES.join(', ')})"
end
here = Dir.pwd
end
puts "(in #{Dir.pwd})" unless $silent
$rakefile = @rakefile
load @rakefile
load_imports
end
# Collect the list of tasks on the command line. If no tasks are
# give, return a list containing only the default task.
# Environmental assignments are processed at this time as well.
def collect_tasks
tasks = []
ARGV.each do |arg|
if arg =~ /^(\w+)=(.*)$/
ENV[$1] = $2
else
tasks << arg
end
end
tasks.push("default") if tasks.size == 0
tasks
end
# Add a file to the list of files to be imported.
def add_import(fn)
@pending_imports << fn
end
# Load the pending list of imported files.
def load_imports
while fn = @pending_imports.shift
next if @imported.member?(fn)
Task[fn].invoke if Task.task_defined?(fn)
ext = File.extname(fn)
loader = @loaders[ext] || @default_loader
loader.load(fn)
@imported << fn
end
end
# Add a loader to handle imported files ending in the extension
# +ext+.
def add_loader(ext, loader)
ext = ".#{ext}" unless ext =~ /^\./
@loaders[ext] = loader
end
# Run the +rake+ application.
def run
handle_options
begin
tasks = collect_tasks
load_rakefile
if $show_tasks
display_tasks_and_comments
elsif $show_prereqs
display_prerequisites
else
tasks.each { |task_name| Task[task_name].invoke }
end
rescue Exception => ex
puts "rake aborted!"
puts ex.message
if $trace
puts ex.backtrace.join("\n")
else
puts ex.backtrace.find {|str| str =~ /#{@rakefile}/ } || ""
end
exit(1)
end
end
end
if __FILE__ == $0 then
RakeApp.new.run
end
|