Changeset 335

Timestamp:

03/02/08 15:12:12 (6 months ago)

Author:

nperriault

Message:

Clever Svg:

• refs #40: more tests
  
• added csDocument::getElementById() and csDocument::dropElementById() methods
  
• fixed csDocument::swapDepths() bug
  

Warning: breaks BC from 0.5.

Files:

• cleversvg/trunk/base/csBaseElement.class.php (modified) (2 diffs)
• cleversvg/trunk/document/csDocument.class.php (modified) (14 diffs)
• cleversvg/trunk/tests/csBaseTestCase.class.php (modified) (1 diff)
• cleversvg/trunk/tests/csDocumentTest.php (modified) (3 diffs)

cleversvg/trunk/base/csBaseElement.class.php

@@ -109 +109 @@
-  public function getDepth()
-  {
-
-
-
+
+
+
+
-    }
-    else
@@ -139 +140 @@
-   * @return string
-   */
-rotected function getElementName($embedded=
+ublic function getElementName($embedded = 
-  {
-    if ($embedded === true)

cleversvg/trunk/document/csDocument.class.php

@@ -10 +10 @@
-{
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-  /**
@@ -34 +102 @@
-   * @param  array  $attrs  Attributes array
-   */
-=
+ = 
-  {
-    $this->setWidth($width);
@@ -46 +114 @@
-   * Adds a SVG shape or group to current SVG Document at a certain depth
-   *
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-    // Add DOM id to document list, if any
-    $id = $element->getId();
-    if (!is_null($id))
-    {
+      if (in_array($id, $this->dom_ids))
+      {
+        throw new csException(
+          sprintf('Document has already an element with id "%s"', $id));
+      }
-      $this->dom_ids[] = $id;
-    }
+
+    if (is_null($element->getDepth()))
+    {
+      if (!$replace_at_depth && array_key_exists($depth, $this->elements))
+      {
+        throw new csException(
+          sprintf('Unable to add element at depth "%d", a "%s" element already'.
+                  ' exist at this index',
+                  $depth, $this->elements[$depth]->getElementName(false)));
+      }
+      elseif (!is_int($depth))
+      {
+        $depth = ++$this->maxdepth;
+      }
+    }
+    else
+    {
+      $depth = $element->getDepth();
+    }
+    $this->elements[$depth] = $element;
+  }
+
+  /**
+   * Create an svg element and returns its instance
+   *
+   * @param  string $name
+   * @return csBaseElement
+   */
+  public function createElement($name)
+  {
+    $class_name = sprintf('cs%s', ucfirst($name));
+    if (!class_exists($class_name))
+    {
+      throw new csException(sprintf('Element class "%s" does not exist',
+                                   $class_name));
+    }
+    return new $class_name;
+  }
+
+  /**
+   * Drop an element from document by its DOM id
+   *
+   * @param  string  $id
+   * @throws csException
+   */
+  public function dropElementById($id)
+  {
+    foreach ($this->getElements() as $index => $element)
+    {
+      if ($element->getId() == $id)
+      {
+        foreach ($this->dom_ids as $dom_index => $dom_id)
+        {
+          if ($dom_id == $id)
+          {
+            unset($this->dom_ids[$dom_index]);
+          }
+        }
+        unset($this->elements[$index]);
+        return;
+      }
+    }
+  }
+
+  /**
+   * Retrieve an element instance by its DOM id
+   *
+   * @param  string  $id
+   * @return csBaseElement
+   * @throw  csException
+   */
+  public function getElementById($id)
+  {
+    foreach ($this->elements as $element)
+    {
+      if ($element->getId() == $id)
+      {
+        return $element;
+      }
+    }
+    throw new csException(sprintf('No element with id "%s"', $id));
-  }
-
@@ -103 +246 @@
-   * @param  string  $content_type
-   */
-=
+ = 
-  {
-    $this->scripts[] = array($content, $type);
@@ -116 +259 @@
-   * @param  mixed   $title
-   */
-='text/css', $media=null, $title=
-
-  
-  
-  
-  
+ = 'text/css', $media = null, $title = 
+
+
+
+
+
-  }
-
@@ -132 +275 @@
-   * @param  mixed   $title
-   */
-='text/css', $alternate='no', $media=null, $title=
+ = 'text/css', $alternate = 'no', $media = null, $title = 
-  {
-    $this->external_styles[] = array('href'      => $href,
@@ -148 +291 @@
-   * TODO: implement definitions and references
-   */
-=
+ = 
-  {
-    $is_element = is_callable(array($definition, 'setId'));
@@ -241 +384 @@
-        break;
-      }
-$this->embedded === true
+true === $this->embedded
-      {
-        $dom = new DOMDocument('1.0', 'UTF-8');
@@ -263 +406 @@
-   * @param  array  $attrs    More atributes to add to <use/> tag
-   */
-=
+ = 
-  {
-    $this->used_definitions[] = array($this->getDefinition($id), $attrs);
@@ -269 +412 @@
-
-  /**
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-
@@ -359 +512 @@
-   * Standard XML attribute for identifying an XML namespace.
-   *
-
-
+
+
+
-  {
-    $this->attributes['xmlns'] = $xmlns;
@@ -413 +567 @@
-   *
-   */
-=
+ = 
-  {
-    $this->attributes['version'] = (string)$version;
@@ -433 +587 @@
-   * necessary to correctly render the content. This can be considered metadata.
-   *
+   * @param  string  $base_profile
-   */
-  public function setBaseProfile($base_profile)
@@ -446 +601 @@
-   * @return string
-   */
-=
+ = 
-  {
-    if (!is_null($embedded) && is_bool($embedded))

cleversvg/trunk/tests/csBaseTestCase.class.php

@@ -48 +48 @@
-    {
-      throw new PHPUnit_Framework_ExpectationFailedException(
-
-
+, but "%s"
+$attr_value, 
-    }
-    return true;
+  }
+
+  protected function assertNodeExists($doc, $xpath_query)
+  {
+    $result = $this->documentXpath($doc, $xpath_query);
+    return !is_null($result->item(0));
+  }
+
+  protected function assertNodeDoesNotExist($doc, $xpath_query)
+  {
+    return !$this->assertNodeExists($doc, $xpath_query);
-  }
-

cleversvg/trunk/tests/csDocumentTest.php

@@ -11 +11 @@
-{
-
+  public function testConstructor()
+  {
+    $doc = new csDocument(320, 240, 'Blah', array('baseProfile' => 'foo/bar'));
+    $this->assertAttrValueEquals($doc, '/svg:svg/@width', 320);
+    $this->assertAttrValueEquals($doc, '/svg:svg/@height', 240);
+    $this->assertTextNodeEquals($doc, '/svg:svg/svg:title', 'Blah');
+    $this->assertAttrValueEquals($doc, '/svg:svg/@baseProfile', 'foo/bar');
+  }
+
+  public function testCreateElement()
+  {
+    $doc = new csDocument(320, 240, 'Blah');
+    $this->assertType('csCircle', $doc->createElement('circle'));
+    $this->assertType('csRect', $doc->createElement('rect'));
+    $this->assertType('csLinearGradient', $doc->createElement('linearGradient'));
+  }
+
+  public function testDropElementById()
+  {
+    $doc = new csDocument(320, 240, 'Blah');
+    $c = new csCircle();
+    $c->setRadius(10);
+    $c->setStroke('red');
+    $c->setId('circle1');
+    $doc->addElement($c);
+    $this->assertNodeExists($doc, '/svg:svg/svg:circle[@id = "circle1"]');
+    $doc->dropElementById('circle1');
+    $this->assertNodeDoesNotExist($doc, '/svg:svg/svg:circle[@id = "circle1"]');
+  }
+
+  public function testHasId()
+  {
+    $doc = new csDocument(320, 240, 'Blah');
+    $c = new csCircle();
+    $c->setRadius(10);
+    $c->setStroke('red');
+    $c->setId('circle1');
+    $c2 = clone($c);
+    $c2->setId('circle2');
+    $doc->addElement($c);
+    $doc->addElement($c2);
+    $this->assertTrue($doc->hasId('circle1'));
+    $this->assertTrue($doc->hasId('circle2'));
+    $this->assertFalse($doc->hasId('jfhkjsdfh'));
+  }
+
-  public function testSetDescription()
-  {
@@ -18 +64 @@
-    $doc->setDescription('Changed description');
-    $this->assertTextNodeEquals($doc, '/svg:svg/svg:desc', 'Changed description');
+  }
+
+  /**
+   * @expectedException csException
+   *
+   */
+  public function testNoDuplicateId()
+  {
+    $doc = new csDocument(320, 240, 'Blah');
+    $c = new csCircle();
+    $c->setId('circle1');
+    $c2 = new csCircle();
+    $c2->setId('circle1');
+    $doc->addElement($c);
+    $doc->addElement($c2);
-  }
-
@@ -29 +90 @@
-  }
-
+  public function testSwapDepths()
+  {
+    $doc = new csDocument(320, 240, 'Test depths');
+    $c1 = new csCircle(160, 120, 40);
+    $c1->setDepth(20);
+    $c1->setId('c1');
+    $c2 = new csCircle(140, 100, 40);
+    $c2->setDepth(40);
+    $c2->setId('c2');
+    $doc->addElement($c1);
+    $doc->addElement($c2);
+    $doc->swapDepths('c1', 'c2');
+    $this->assertAttrValueEquals($doc, '/svg:svg/svg:circle[@id = "c1"]/@style', 'z-index: 40');
+    $this->assertAttrValueEquals($doc, '/svg:svg/svg:circle[@id = "c2"]/@style', 'z-index: 20');
+  }
+
+  public function testViewBox()
+  {
+    $doc = new csDocument();
+    $doc->setViewBox(10, 10, 320, 240);
+    $this->assertAttrValueEquals($doc, '/svg:svg/@viewBox', '10 10 320 240');
+  }
+
-  public function testToXml()
-  {