Open clue opened 10 years ago
Build systems in general must cd
to the directory containing the build file so that any file references within the file itself are resolved predictably and consistently; rake
and make
certainly both perform a chdir
.
If implemented, this feature should either be a) behind a command-line flag or b) set within the Phakefile itself (e.g. a leading comment like // phake-nochdir
.
rake and make certainly both perform a chdir
Alright, admittedly I have little experience with relative paths in either make or rake, and a quick search didn't turn up many results either. So you can confirm this is actually the case?
My assumption was that all paths are relative to the current working directory (as with normal (php) scripts), whereas you're suggesting that they should be relative to the file they're defined in, right? This shouldn't show any obvious effects if you're running phake from the folder where your Phakefile is located, but it differs if you're running if from a sub-folder (say "demo/" in the above example).
Personally, I'm okay with it either way, it's just that latter case was unexpected. So if we keep it that way, we should probably address a few things instead:
chdir()
is only applied if you do not explicitly pass in a phakefile, whereas it is not applied if you pass one.Application::get_original_working_directory()
?) in case you need to resolve a file relative to the current working directory (see above example for passing in relative paths as arguments).I've tested the behaviour across make
and rake
:
make
in fact only searches the cwd for a makefile, and does follow up with a recursive search of parent directories. If a Makefile
path is provided explicitly via the -f
option, the working directory is unchanged.rake
will chdir
to the Rakefile
's directory when it is found implicitly. When the -f
option is used, the working directory is again unchanged.Thanks for taking the time to confirm this!
When the -f option is used, the working directory is again unchanged.
So in other words, using relative paths is unpredictable as it depends on several factors not in control of the Phakefile author? If that is actually the case, I'm even more tempted to say that using chdir()
is a bad idea and should be avoided.
In PHP, one usually works around this issue by using paths like require __DIR__ . '/myfile.php'
instead. This makes it explicit on when to use relative and when to use absolute paths. Some quick searches seem to indicated this is applicable to rake/ruby as well?
If so, it's probably easier (and safer) to refrain from trying to work around relative paths as per the original patch.
Also, this would open up a few possibilities like
phake -f http://mycorporation.local/Phakefile.php
__DIR__
looks like phar:///my/path/to/phake.phar/example
and there's no way to fake a chdir()
within a phar archive)
This is done in order to preserve relative path passed as arguments, as they're relative to the current working directory.
Consider the directory structure:
Consider I have a task named
test
which accepts a single argumentfile
:project/
, I expect to be able to runphake test file=demo/example.txt
project/demo
, I expect to be able to runphake test file=example.txt
Open for discussion: