Skip to content
This repository has been archived by the owner on Sep 20, 2021. It is now read-only.

Issues #41 Add errors when assert operators. #59

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions Test/Unit/Visitor/Asserter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<?php

/**
* Hoa
*
*
* @license
*
* New BSD License
*
* Copyright © 2007-2015, 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\Ruler\Test\Unit\Model;

use Hoa\Test;
use Hoa\Ruler as LUT;

/**
* Class \Hoa\Ruler\Test\Unit\Model\Asserter.
*
* Test suite of the asserter object of the visitor.
*
* @author Alexis von Glasow <[email protected]>
* @copyright Copyright © 2007-2015 Alexis von Glasow.
* @license New BSD License
*/

class Asserter extends Test\Unit\Suite {

public function case_keep_errors ( ) {
$this
->given(
$ruler = new LUT(),
$fExecuted = false,
$asserter = $ruler->getDefaultAsserter(),
$asserter->setOperator(
'f',
function ( $a = false ) use ( &$fExecuted ) {

$fExecuted = true;

return $a;
}
),
$rule = 'f(false)'
)
->when($result = $ruler->assert($rule, new LUT\Context()))
->then
->boolean($result)
->isFalse()
->boolean($fExecuted)
->isTrue()
->boolean($asserter->hasError())
->isTrue()
->array($asserter->getErrors())
->isNotEmpty()
->hasKey('f')
;
}
}

44 changes: 44 additions & 0 deletions Visitor/Asserter.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,13 @@ class Asserter implements Visitor\Visit {
*/
protected $_operators = [];

/**
* List of errors.
*
* @var \Hoa\Ruler\Visitor\Asserter array
*/
protected $errors = [];



/**
Expand Down Expand Up @@ -159,6 +166,10 @@ protected function visitOperator ( Ruler\Model\Operator $element, &$handle = nul
$value = $argument->accept($this, $handle, $eldnah);
$arguments[] = $value;

// Add operators name and their values in errors lists
if (false === $value)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why false means a failed computation?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the first assumption, generally when something is false, this come from an error. But you're right sometimes we want to have false as a correct value. This is also the reason why the operator not exist. I see this in two way first is to found if this operator is used (not operator) and invert the condition. But sometimes the value which should be used to raise an error could be other than "false". So the second way should be to add the false value in operator to identify from which value you can add an error for this operator.

What do you think ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about letting the operator to register an error somewhere instead?

$asserter->setOperator(
    'in',
    function ( ) use ($asserter) {
        // …
        $asserter->addError(…);
        return …;
    }
);

$this->errors[$element->getName()] = $element->getArguments();

if($element::LAZY_BREAK === $element->shouldBreakLazyEvaluation($value))
break;
}
Expand Down Expand Up @@ -487,4 +498,37 @@ public function getOperators ( ) {

return $this->_operators;
}

/**
* Get all errors.
*
* @access public
* @return array
*/
public function getErrors ( ) {

return $this->errors;
}

/**
* The evaluation of operators has it raised errors.
*
* @access public
* @return boolean
*/
public function hasError ( ) {

return !empty($this->errors);
}

/**
* Reset all errors raised
*
* @access public
* @return void
*/
public function resetErrors ( ) {

$this->errors = [];
}
}