Changeset 368

Timestamp:

05/18/08 17:21:02 (8 months ago)

Author:

bender

Message:

#247 - New task: Import

Files:

• branches/2.4/classes/phing/Project.php (modified) (2 diffs)
• branches/2.4/classes/phing/parser/Location.php (modified) (1 diff)
• branches/2.4/classes/phing/parser/PhingXMLContext.php (added)
• branches/2.4/classes/phing/parser/ProjectConfigurator.php (modified) (5 diffs)
• branches/2.4/classes/phing/parser/ProjectHandler.php (modified) (2 diffs)
• branches/2.4/classes/phing/parser/TargetHandler.php (modified) (3 diffs)
• branches/2.4/classes/phing/tasks/defaults.properties (modified) (1 diff)
• branches/2.4/classes/phing/tasks/system/ImportTask.php (added)
• branches/2.4/docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html (modified) (1 diff)
• branches/2.4/test/classes/phing/tasks/ImportTaskTest.php (added)
• branches/2.4/test/etc/tasks/importing.xml (added)
• branches/2.4/test/etc/tasks/imports (added)
• branches/2.4/test/etc/tasks/imports/imported.properties (added)
• branches/2.4/test/etc/tasks/imports/imported.xml (added)
• branches/2.4/test/etc/tasks/imports/importedImport.xml (added)
• branches/2.4/test/run-tests.php (modified) (1 diff)

branches/2.4/classes/phing/Project.php

@@ -536 +536 @@
-            $this->log("  +User datatype: $typeName ($typeClass)", Project::MSG_DEBUG);
-        } else {
-name ($c
+typeName ($typeC
-        }
-    }
@@ -556 +556 @@
-        $target->setProject($this);
-        $this->targets[$targetName] = $target;
+
+        $ctx = $this->getReference("phing.parsing.context");
+        $current = $ctx->getConfigurator()->getCurrentTargets();
+        $current[$targetName] = $target;
-    }
-

branches/2.4/classes/phing/parser/Location.php

@@ -70 +70 @@
-        return (string) $buf;
-    }
+
+    function __toString () {
+      return $this->toString();
+    }
-}

branches/2.4/classes/phing/parser/ProjectConfigurator.php

@@ -25 +25 @@
-include_once 'phing/system/lang/FileNotFoundException.php';
-include_once 'phing/system/io/PhingFile.php';
+include_once 'phing/parser/PhingXMLContext.php';
+include_once 'phing/IntrospectionHelper.php';
-
-/**
@@ -45 +47 @@
-    public $buildFile;
-    public $buildFileParent;
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /**
-     * Static call to ProjectConfigurator. Use this to configure a
@@ -72 +91 @@
-        $this->buildFile = new PhingFile($buildFile->getAbsolutePath());
-        $this->buildFileParent = new PhingFile($this->buildFile->getParent());
+        $this->currentTargets = array();
+        $this->parseEndTarget = new Target();
+    }
+
+    /**
+     * find out the build file
+     * @return  the build file to which the xml context belongs
+     */
+    public function getBuildFile() {
+        return $this->buildFile;
+    }
+
+    /**
+     * find out the parent build file of this build file
+     * @return the parent build file of this build file
+     */
+    public function getBuildFileParent() {
+        return $this->buildFileParent;
+    }
+
+    /**
+     * find out the current project name
+     * @return current project name
+     */
+    public function getCurrentProjectName() {
+        return $this->currentProjectName;
+    }
+
+    /**
+     * set the name of the current project
+     * @param name name of the current project
+     */
+    public function setCurrentProjectName($name) {
+        $this->currentProjectName = $name;
+    }
+
+    /**
+     * tells whether the project tag is being ignored
+     * @return whether the project tag is being ignored
+     */
+    public function isIgnoringProjectTag() {
+        return $this->ignoreProjectTag;
+    }
+
+    /**
+     *  sets the flag to ignore the project tag
+     * @param flag to ignore the project tag
+     */
+    public function setIgnoreProjectTag($flag) {
+        $this->ignoreProjectTag = $flag;
+    }
+
+    public function &getCurrentTargets () {
+      return $this->currentTargets;
+    }
+
+    public function isParsing () {
+      return $this->isParsing;
-    }
-
@@ -83 +160 @@
-     */
-    protected function parse() {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            $reader = new BufferedReader(new FileReader($this->buildFile));
-            $parser = new ExpatParser($reader);
@@ -91 +187 @@
-            $parser->parse();
-            $reader->close();
+
+            // mark parse phase as completed
+            $this->isParsing = false;
+            // execute delayed tasks
+            $this->parseEndTarget->main();
+            // pop this action from the global stack
+            $ctx->endConfigure();
-        } catch (Exception $exc) {
-            throw new BuildException("Error reading project file", $exc);
-        }
+    }
+
+    /**
+     * Delay execution of a task until after the current parse phase has 
+     * completed.
+     *
+     * @param Task $task Task to execute after parse
+     */
+    public function delayTaskUntilParseEnd ($task) {
+      $this->parseEndTarget->addTask($task);
-    }
-

branches/2.4/classes/phing/parser/ProjectHandler.php

@@ -90 +90 @@
-            }
-        }
-
-
+
+
+
+
+
+
-        }
-        $project->setDefaultTarget($def);
-
-
+
+
+
+
+
+
+
+
-            $project->setName($name);
-            $project->addReference($name, $project);
-        }
-
-
+
+
+
-            $project->addReference($id, $project);
-
-
-
+  
+
+  
-            $project->setDescription($desc);
-
+  
-
-
+  
-            $project->setBasedir($project->getProperty("project.basedir"));
-
+  
-            if ($baseDir === null) {
-  
+
-            } else {
-  
-  
-  
-    
-  
-    
-  
+
+
+
+
+
+
+
-            }
+          }
-        }
-    }
@@ -150 +162 @@
-        }
-    }
+
+    static function canonicalName ($name) {
+      return preg_replace('/\W/', '_', strtolower($name));
+    }
-}
-

branches/2.4/classes/phing/parser/TargetHandler.php

@@ -109 +109 @@
-        $project = $this->configurator->project;
-
+        // check to see if this target is a dup within the same file
+        if (isset($this->configurator->getCurrentTargets[$name])) {
+          throw new BuildException("Duplicate target: $targetName",  
+              $this->parser->getLocation());
+        }
+
-        $this->target = new Target();
-        $this->target->setName($name);
@@ -114 +120 @@
-        $this->target->setUnless($unlessCond);
-        $this->target->setDescription($description);
-
-        $project->addTarget($name, $this->target);
-
-        if ($id !== null && $id !== "") {
-            $project->addReference($id, $this->target);
-        }
-        // take care of dependencies
-        if (strlen($depends) > 0) {
@@ -125 +125 @@
-        }
-
+        $usedTarget = false;
+        // check to see if target with same name is already defined
+        $projectTargets = $project->getTargets();
+        if (isset($projectTargets[$name])) {
+          $project->log("Already defined in main or a previous import, " .
+            "ignore {$name}", Project::MSG_VERBOSE);
+        } else {
+          $project->addTarget($name, $this->target);
+          if ($id !== null && $id !== "") {
+            $project->addReference($id, $this->target);
+          }
+          $usedTarget = true;
+        }
+
+        if ($this->configurator->isIgnoringProjectTag() && 
+            $this->configurator->getCurrentProjectName() != null && 
+            strlen($this->configurator->getCurrentProjectName()) != 0) {
+          // In an impored file (and not completely
+          // ignoring the project tag)
+          $newName = $this->configurator->getCurrentProjectName() . "." . $name;
+          if ($usedTarget) {
+            // clone needs to make target->children a shared reference
+            $newTarget = clone $this->target;
+          } else {
+            $newTarget = $this->target;
+          }
+          $newTarget->setName($newName);
+          $ct = $this->configurator->getCurrentTargets();
+          $ct[$newName] = $newTarget;
+          $project->addTarget($newName, $newTarget);
+        }
-    }
-

branches/2.4/classes/phing/tasks/defaults.properties

@@ -41 +41 @@
-if=phing.tasks.system.IfTask
-warn=phing.tasks.system.WarnTask
+import=phing.tasks.system.ImportTask
-
-; "Core" contributed tasks

branches/2.4/docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html

@@ -901 +901 @@
-</if>
-</pre>
+
+<h2><a name="ImportTask"></a>ImportTask</h2>
+<p>Imports another build file into the current project.</p>
+<p>On execution it will read another Phing file into the same Project. 
+Functionally it is nearly the same as copy and pasting the imported file onto 
+the end of the importing file.</p>
+<h3>Target Overriding</h3>
+<p>If a target in the main file is also present in at least one of the imported files, the one from the main file takes precedence.</p>
+
+<p>So if I import for example a <em>docs/build.xml</em> file named 
+<strong>builddocs</strong>, that contains a "<strong>docs</strong>" target, I 
+can redefine it in my main buildfile and that is the one that will be called. 
+This makes it easy to keep the same target name, so that the overriding target 
+is still called by any other targets--in either the main or imported 
+buildfile(s)--for which it is a dependency, with a different implementation. 
+The target from <em>docs/build.xml</em> is made available by the name 
+"<strong>builddocs.docs</strong>". This enables the new implementation to call 
+the old target, thus enhancing it with tasks called before or after it.</p>
+<h3>Special Properties</h3>
+<p>Imported files are treated as they are present in the main buildfile. This makes it easy to understand, but it makes it impossible for them to reference files and resources relative to their path. Because of this, for every imported file, Phing adds a property that contains the path to the imported buildfile. With this path, the imported buildfile can keep resources and be able to reference them relative to its position.</p>
+
+<p>So if I import for example a <em>docs/build.xml</em> file named <strong>builddocs</strong>, I can get its path as <strong>phing.file.builddocs</strong>, similarly to the <strong>phing.file</strong> property of the main buildfile.</p>
+
+<p>Note that "builddocs" is not the filename, but the name attribute present in the imported project tag.</p>
+
+<p>If import file does not have a name attribute, the phing.file.projectname property will not be set.</p>
+<h3>Resolving Files Against the Imported File</h3>
+<p>Suppose your main build file called <code>importing.xml</code> imports a build file <code>imported.xml</code>, located anywhere on the file system, and <code>imported.xml</code> reads a set of properties from <code>imported.properties</code>:
+<pre>
+&lt;!-- importing.xml --&gt;
+&lt;project name=&quot;importing&quot; basedir=&quot;.&quot; default=&quot;...&quot;&gt;
+  &lt;import file=&quot;${path_to_imported}/imported.xml&quot;/&gt;
+&lt;/project&gt;
+
+&lt;!-- imported.xml --&gt;
+&lt;project name=&quot;imported&quot; basedir=&quot;.&quot; default=&quot;...&quot;&gt;
+  &lt;property file=&quot;imported.properties&quot;/&gt;
+&lt;/project&gt;
+</pre>
+
+<p>This snippet however will resolve <code>imported.properties</code> against the basedir of <code>importing.xml</code>, because the basedir of <code>imported.xml</code> is ignored by Phing. The right way to use <code>imported.properties</code> is:
+<pre>
+&lt;!-- imported.xml --&gt;
+&lt;project name=&quot;imported&quot; basedir=&quot;.&quot; default=&quot;...&quot;&gt;
+  &lt;php function=&quot;dirname&quot; returnProperty=&quot;imported.basedir&quot;&gt;
+    &lt;param value=&quot;${phing.file.imported}&quot;/&gt;
+  &lt;/php&gt;
+  &lt;property file=&quot;${imported.basedir}/imported.properties&quot;/&gt;
+&lt;/project&gt;
+</pre>
+<p>As explained above <code>${phing.file.imported}</code> stores the path of the build script, that defines the project called <strong>imported</strong>, (in short it stores the path to <em>imported.xml</em>) and &lt;php function="dirname"&gt; takes its directory. This technique also allows <em>imported.xml</em> to be used as a standalone file (without being imported in other project).</p>
+<h3>Example</h3>
+<pre>
+&lt;import file=&quot;path/to/build.xml&quot;/&gt;
+&lt;import file=&quot;path/to/build.xml&quot; optional=&quot;true&quot;/&gt;
+</pre>
+<h3>Attributes</h3>
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Description</th>
+      <th>Default</th>
+      <th>Required</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>file</td>
+      <td>String</td>
+      <td>The file to import.</td>
+      <td>n/a</td>
+      <td>Yes</td>
+    </tr>
+    <tr>
+      <td>optional</td>
+      <td>Boolean</td>
+      <td>If true, do not stop the build if the file does not exist.</td>
+      <td>false</td>
+      <td>No</td>
+    </tr>
+  </tbody>
+</table>
-
-<h2><a name="IncludePathTask"></a>IncludePathTask</h2>

branches/2.4/test/run-tests.php

@@ -72 +72 @@
-
-
+include_once 'phing/tasks/ImportTaskTest.php';
+$tasksSuite->addTestSuite(new ReflectionClass('ImportTaskTest'));
- 
-$suite = new PHPUnit2_Framework_TestSuite('Phing Tests');