<?php

/*
 * Copyright (C) 2015 Julien Fastré <julien.fastre@champs-libres.coop>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace Chill\CustomFieldsBundle\Tests;

use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Chill\CustomFieldsBundle\Entity\CustomField;
use Chill\CustomFieldsBundle\CustomFields\CustomFieldChoice;

/**
 * This class cover the test of CustomFieldChoice.
 * 
 * Function currently covered: 
 * 
 * - deserialize
 *
 * @author Julien Fastré <julien.fastre@champs-libres.coop>
 */
class CustomFieldsChoiceTest extends KernelTestCase
{
    
    /**
     *
     * @var \Chill\CustomFieldsBundle\Service\CustomFieldProvider
     */
    private $cfProvider;
    
    /**
     *
     * @var \Chill\CustomFieldsBundle\CustomFields\CustomFieldChoice
     */
    private $cfChoice;
    
    public function setUp()
    {
        static::bootKernel();
        
        $this->cfProvider = static::$kernel->getContainer()
                ->get('chill.custom_field.provider');
        $this->cfChoice = $this->cfProvider->getCustomFieldByType('choice');
    }
    
    public function tearDown()
    {
        parent::tearDown();
    }
    
    /**
     * 
     * @param array $options
     * @return CustomField
     */
    private function generateCustomField($options)
    {
        return (new CustomField())
            ->setActive(true)
            ->setSlug('slug')
            ->setOptions($options)
            ->setType('choice')
                ;
    }
    
    /////////////////////////////////////////
    //
    // test function deserialize 
    //
    ////////////////////////////////////////
    
    /**
     * Test if the representation of the data is deserialized to a single text.
     * 
     * If the value is in _other, the _other value should not be returned.
     * 
     * @param type $data
     * @dataProvider serializedRepresentationDataProvider
     */
    public function testDeserializeSingleChoiceWithoutOther($data)
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => false,
            CustomFieldChoice::MULTIPLE => false
        ));
        
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame('my-value', $deserialized);
    }
    
    
    public function testDeserializeSingleChoiceWithoutOtherDataIsNull()
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => false,
            CustomFieldChoice::MULTIPLE => false
        ));
        
        $deserialized = $this->cfChoice->deserialize(null, $customField);
        $this->assertSame(null, $deserialized);
        
        $deserialized = $this->cfChoice->deserialize('', $customField);
        $this->assertSame('', $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array(null), $customField);
        $this->assertSame(null, $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array('_other' => null, '_choices' => null), $customField);
        $this->assertSame(null, $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array('_other' => null, '_choices' => ''), $customField);
        $this->assertSame('', $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array(null), $customField);
        $this->assertSame(null, $deserialized);
    }
    
    /**
     * Test if the representation of the data is deserialized to a single text
     * with an "allow_other" field.
     * 
     * If the value is in _other, the _other value should be in the _other field.
     * 
     * @param type $data
     * @dataProvider serializedRepresentationDataProvider
     */
    public function testDeserializeSingleChoiceWithOther($data)
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => true,
            CustomFieldChoice::MULTIPLE => false
        ));
        
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('_other' => '', '_choices' => 'my-value'), $deserialized);
    }
    
    /**
     * Other cases : 
     * 
     *  - Test if the selected value is '_other
     * - Test with null data
     * 
     * @param type $data
     */
    public function testDeserializeSingleChoiceWithOtherOtherCases()
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => true,
            CustomFieldChoice::MULTIPLE => false
        ));
        
        // from a single to a single
        $data = array('_other' => 'something', '_choices' => '_other');
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array('_other' => 'something', '_choices' => '_other'), $deserialized);
        
        
        // from a multiple to a single
        $data = array('_other' => 'something', '_choices' => array('some', '_other'));
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array('_other' => 'something', '_choices' => '_other'), $deserialized);
        
        //test with null data
        //from a single to a single :
        $data = array('_other' => 'something', '_choices' => null);
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array('_other' => 'something', '_choices' => null), $deserialized);
        
        $data = array('_other' => 'something', '_choices' => '');
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array('_other' => 'something', '_choices' => ''), $deserialized);
        
        // from a multiple to a signle
        $data = array('_other' => 'something', '_choices' => array());
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array('_other' => 'something', '_choices' => ''), $deserialized);
        
        $data = array('_other' => 'something', '_choices' => array(''));
        $deserialized = $this->cfChoice->deserialize($data, $customField);    
        $this->assertSame(array('_other' => 'something', '_choices' => ''), $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array('_other' => null, '_choices' => null), $customField);
        $this->assertSame(array('_other' => '', '_choices' => null), $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array('_other' => null, '_choices' => ''), $customField);
        $this->assertSame(array('_other' => '', '_choices' => ''), $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array(null), $customField);
        $this->assertSame(array('_other' => '', '_choices' => null), $deserialized);
        
    }
    
    /**
     * Test if the representation of the data is deserialized to an array text
     * with an "allow_other" field.
     * 
     * This test does not covers the case when the selected value is `_other`
     * 
     * @param type $data
     * @dataProvider serializedRepresentationDataProvider
     */
    public function testDeserializeMultipleChoiceWithOther($data)
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => true,
            CustomFieldChoice::MULTIPLE => true
        ));
        
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('_other' => '', '_choices' => array('my-value')), 
                $deserialized);
    }
    
    /**
     * Test if the representation of the data is deserialized to an array text
     * with an "allow_other" field.
     * 
     * This test covers :
     * - the case when the selected value is `_other`
     * - result is null
     * 
     * @param type $data
     */
    public function testDeserializeMultipleChoiceWithOtherOtherCases()
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => true,
            CustomFieldChoice::MULTIPLE => true
        ));
        
        // selected value is _other
        // from single to multiple
        $data = array('_other' => 'something', '_choices' => '_other');
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('_other' => 'something', '_choices' => array('_other')), 
                $deserialized);
        
        // from multiple to multiple
        $data = array('_other' => 'something', '_choices' => array('_other', 'something'));
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('_other' => 'something', '_choices' => array('_other', 'something')), 
                $deserialized);
        
        // test with null value
        // from single to multiple
        $data = array('_other' => '', '_choices' => '');
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('_other' => '', '_choices' => array('')), 
                $deserialized);
        
        // from multiple to multiple
        $data = array('_other' => '', '_choices' => array());
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('_other' => '', '_choices' => array()), 
                $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array('_other' => null, '_choices' => null), $customField);
        $this->assertSame(array('_other' => '', '_choices' => array(null)), $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array('_other' => null, '_choices' => ''), $customField);
        $this->assertSame(array('_other' => '', '_choices' => array('')), $deserialized);
        
        $deserialized = $this->cfChoice->deserialize(array(null), $customField);
        $this->assertSame(array('_other' => '', '_choices' => array(null)), $deserialized);
    }
    
    /**
     * Test if the representation of the data is deserialized to an array text
     * **without** an "allow_other" field.
     * 
     * 
     * @param type $data
     * @dataProvider serializedRepresentationDataProvider
     */
    public function testDeserializeMultipleChoiceWithoutOther($data)
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => false,
            CustomFieldChoice::MULTIPLE => true
        ));
        
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        
        $this->assertSame(array('my-value'), $deserialized);
    }
    
    /**
     * Test if the representation of the data is deserialized to an array text
     * **without** an "allow_other" field.
     * 
     * Covered cases :
     * - NULL values
     * 
     * 
     * @param type $data
     */
    public function testDeserializeMultipleChoiceWithoutOtherOtherCases()
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => false,
            CustomFieldChoice::MULTIPLE => true
        ));
        
        // from single to multiple
        $data = 'my-value';
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array('my-value'), $deserialized);
        
        // from multiple to multiple
        $data = array('my-value');
        $deserialized = $this->cfChoice->deserialize($data, $customField); 
        $this->assertSame(array('my-value'), $deserialized);
        
        // from multiple
        $data = array(null);
        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $this->assertSame(array(null), $deserialized);
        
        $data = array('_other' => null, '_choices' => array(null));
        $deserialized = $this->cfChoice->deserialize($data, $customField); 
        $this->assertSame(array(null), $deserialized);
        
        //from single
        $data = array('_other' => null, '_choices' => null);
        $deserialized = $this->cfChoice->deserialize($data, $customField); 
        $this->assertSame(array(null), $deserialized);
    }
    
    public function serializedRepresentationDataProvider()
    {
        return array(
            array(
                // multiple => false, allow_other => false
                'my-value' 
            ),
            array(
                // multiple => true, allow_ther => false
                array('my-value')
            ),
            array(
                // multiple => false, allow_other => true, current value not in other
                array('_other' => '', '_choices' => 'my-value')
            ),
            array(
                // multiple => true, allow_other => true, current value not in other
                array('_other' => '', '_choices'=> array('my-value'))
            ),
        );
    }
    
    
    
    /////////////////////////////////////////
    //
    // test function isEmptyValue 
    //
    ////////////////////////////////////////
    
    /**
     * test the not empty with the not-empty data provider
     * 
     * @param mixed $data
     * @dataProvider serializedRepresentationDataProvider
     */
    public function testIsEmptyValueNotEmpty($data)
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => false,
            CustomFieldChoice::MULTIPLE => true
        ));

        $deserialized = $this->cfChoice->deserialize($data, $customField);
        $isEmpty = $this->cfChoice->isEmptyValue($deserialized, $customField);
        
        $this->assertFalse($isEmpty);
    }
    
    /**
     * 
     * @dataProvider emptyDataProvider
     * @param mixed $data deserialized data
     */
    public function testIsEmptyValueEmpty($data)
    {
        $customField = $this->generateCustomField(array(
            CustomFieldChoice::ALLOW_OTHER => false,
            CustomFieldChoice::MULTIPLE => true
        ));
        
        $isEmpty = $this->cfChoice->isEmptyValue($data, $customField);
        
        $this->assertTrue($isEmpty);
    }
    
    /**
     * provide empty data in different possible representations.
     * Those data are supposed to be deserialized.
     * 
     * @return array
     */
    public function emptyDataProvider()
    {
        return array(
            // 0
            array(
                // signle
                ''
            ),
            // 1
            array(
                // single
                null
            ),
            // 2
            array(
                // signle with allow other
                array('_other' => 'something', '_choices' => '')
            ),
            // 3
            array(
                // multiple
                array()
            ),
            // 4
            array(
                // multiple with allow other
                array('_other' => 'something', '_choices' => array())
            ),
            // 5
             array(
                // multiple with allow other
                array('_other' => '', '_choices' => array())
            ),
            // 6
            array(
                // empty
                array('_other' => null, '_choices' => null)
            ),
            // 7
            array(
                // empty
                array(null)
            )
        );
    }
    
}