Add the domain coverage iterator.

Given a set of variables, for example:

    @requires a: 'one'   or 'two'
          and b: 'three' or 'four'  or 'five'
          and c: 'six'   or 'seven' or 'eight';

We are able to iterator over all domains combinations, like this:

    $iterator = new Hoa\Praspel\Iterator\Coverage\Domain(
        $model->getClause('requires')->getLocalVariabes()
    );

    foreach($iterator as $variables) {

        foreach($variables as $name => $variable)
            printf('%s: %-8s', $name, $variable->getConstantValue());

        echo "\n";
    }

It will output:

    a: one     b: three   c: six
    a: two     b: three   c: six
    a: one     b: four    c: six
    a: two     b: four    c: six
    a: one     b: five    c: six
    a: two     b: five    c: six
    a: one     b: three   c: seven
    a: two     b: three   c: seven
    a: one     b: four    c: seven
    a: two     b: four    c: seven
    a: one     b: five    c: seven
    a: two     b: five    c: seven
    a: one     b: three   c: eight
    a: two     b: three   c: eight
    a: one     b: four    c: eight
    a: two     b: four    c: eight
    a: one     b: five    c: eight
    a: two     b: five    c: eight

1 files changed, 208 insertions, 0 deletions

diff --git a/Iterator/Coverage/Domain.php b/Iterator/Coverage/Domain.php
new file mode 100644
index 0000000..ddd0932
--- /dev/null
+++ b/Iterator/Coverage/Domain.php
@@ -0,0 +1,208 @@
+<?php
+
+/**
+ * Hoa
+ *
+ *
+ * @license
+ *
+ * New BSD License
+ *
+ * Copyright © 2007-2013, Ivan Enderlin. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the Hoa nor the names of its contributors may be
+ *       used to endorse or promote products derived from this software without
+ *       specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace Hoa\Praspel\Iterator\Coverage {
+
+/**
+ * Class \Hoa\Praspel\Iterator\Coverage\Domain.
+ *
+ * Domain coverage.
+ *
+ * @author     Ivan Enderlin <ivan.enderlin@hoa-project.net>
+ * @copyright  Copyright © 2007-2013 Ivan Enderlin.
+ * @license    New BSD License
+ */
+
+class Domain implements \Iterator {
+
+    /**
+     * Variables to cover.
+     *
+     * @var \Hoa\Praspel\Iterator\Coverage\Domain array
+     */
+    protected $_variables = null;
+
+    /**
+     * Number of variables.
+     *
+     * @var \Hoa\Praspel\Iterator\Coverage\Domain int
+     */
+    protected $_max       = 0;
+
+    /**
+     * Key.
+     *
+     * @var \Hoa\Praspel\Iterator\Coverage\Domain int
+     */
+    protected $_key       = 0;
+
+    /**
+     * Current (contains all current domains).
+     *
+     * @var \Hoa\Praspel\Iterator\Coverage\Domain array
+     */
+    protected $_current   = null;
+
+    /**
+     * Whether the iterator has reached the end or not.
+     *
+     * @var \Hoa\Praspel\Iterator\Coverage\Domain bool
+     */
+    protected $_end       = false;
+
+
+
+    /**
+     * Constructor.
+     *
+     * @access  public
+     * @param   array  $variables    Variables.
+     * @return  void
+     */
+    public function __construct ( $variables ) {
+
+        foreach($variables as $variable)
+            $this->_variables[] = $variable->getDomains()->getIterator();
+
+        $this->_max = count($this->_variables) - 1;
+
+        return;
+    }
+
+    /**
+     * Get the current value.
+     *
+     * @access  public
+     * @return  array
+     */
+    public function current ( ) {
+
+        return $this->_current;
+    }
+
+    /**
+     * Prepare the current value.
+     *
+     * @access  protected
+     * @return  void
+     */
+    protected function _current ( ) {
+
+        $this->_current = array();
+
+        foreach($this->_variables as $variable) {
+
+            $current = $variable->current();
+            $this->_current[$current->getHolder()->getName()] = $current;
+        }
+
+        return;
+    }
+
+    /**
+     * Get the current key.
+     *
+     * @access  public
+     * @return  int
+     */
+    public function key ( ) {
+
+        return $this->_key;
+    }
+
+    /**
+     * Advance the internal collection pointer, and return the current value.
+     *
+     * @access  public
+     * @return  array
+     */
+    public function next ( ) {
+
+        for($i = 0; $i <= $this->_max; ++$i) {
+
+            $this->_variables[$i]->next();
+
+            if(false !== $this->_variables[$i]->valid())
+                break;
+
+            $this->_variables[$i]->rewind();
+
+            if($i === $this->_max) {
+
+                $this->_break = true;
+                break;
+            }
+        }
+
+        ++$this->_key;
+        $this->_current();
+
+        return $this->current();
+    }
+
+    /**
+     * Rewind the internal collection pointer, and return the first collection.
+     *
+     * @access  public
+     * @return  array
+     */
+    public function rewind ( ) {
+
+        $this->_break = false;
+        $this->_key   = 0;
+
+        foreach($this->_variables as $variable)
+            $variable->rewind();
+
+        $this->_current();
+
+        return $this->current();
+    }
+
+    /**
+     * Check if there is a current element after calls to the rewind() or the
+     * next() methods.
+     *
+     * @access  public
+     * @return  bool
+     */
+    public function valid ( ) {
+
+        return false === $this->_break;
+    }
+}
+
+}