SIL\Tests\LanguageTargetLinksCacheTest

Complexity

Total Complexity

13

Size/Duplication

Total Lines	337
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	8
Bugs	0	Features	2

12 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	6	1
B	testDeleteLanguageTargetLinks()	0	31	1
B	testDeletePageLanguageForMatchedTarget()	0	40	1
B	testNoLanguageTargetLinksDeleteForNonMatchedTarget()	0	34	1
B	testUpdatePageLanguageToCache()	0	29	2
A	testCanConstruct()	0	15	1
B	testRoundtrip()	0	40	1
B	testTryToGetLanguageTargetLinksForUnknownLanguageCode()	0	24	1
A	testTryToGetLanguageTargetLinksFromEmptyLinksCache()	0	21	1
B	testTryToGetLanguageTargetLinksForNullLanguageCode()	0	25	1
A	testTryToGetLanguageTargetLinksFromCacheOnNullLinkReference()	0	21	1
A	pageLanguageCacheStrategyProvider()	0	9	1

<?php

namespace SIL\Tests;

use SIL\LanguageTargetLinksCache;
use SIL\InterlanguageLink;
use SIL\CacheKeyProvider;
use SMW\DIWikiPage;
use Onoi\Cache\CacheFactory;
use HashBagOStuff;
use Title;

/**
 * @covers \SIL\LanguageTargetLinksCache
 * @group semantic-interlanguage-links
 *
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class LanguageTargetLinksCacheTest extends \PHPUnit_Framework_TestCase {

	private $cache;
	private $cacheKeyProvider;

	protected function setUp() {
		parent::setUp();

		$this->cache = CacheFactory::getInstance()->newMediaWikiCache( new HashBagOStuff() );
		$this->cacheKeyProvider = new CacheKeyProvider( 'foo' );
	}

	public function testCanConstruct() {

		$cache = $this->getMockBuilder( '\Onoi\Cache\Cache' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$cacheKeyProvider = $this->getMockBuilder( '\SIL\CacheKeyProvider' )
			->disableOriginalConstructor()
			->getMock();

		$this->assertInstanceOf(
			'\SIL\LanguageTargetLinksCache',
			new LanguageTargetLinksCache( $cache, $cacheKeyProvider )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testRoundtrip( $pageLanguageCacheStrategy ) {

		$interlanguageLink = new InterlanguageLink( 'en', 'Foo' );

		$languageTargetLinks = array(
			'bo' => 'Bar',
			'en' => Title::newFromText( 'Foo' )
		);

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$this->assertEquals(
			'bo',
			$instance->getPageLanguageFromCache( Title::newFromText( 'Bar' ) )
		);

		$this->assertEquals(
			$languageTargetLinks,
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);

		$linkReferences = array();

		$instance->deleteLanguageTargetLinksFromCache( $linkReferences );
		$instance->deletePageLanguageForTargetFromCache( Title::newFromText( 'Bar' ) );

		$this->assertFalse(
			$instance->getPageLanguageFromCache( Title::newFromText( 'Bar' ) )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testTryToGetLanguageTargetLinksForUnknownLanguageCode( $pageLanguageCacheStrategy ) {

		$interlanguageLink = new InterlanguageLink( 'en', 'Foo' );

		$languageTargetLinks = array(
			'bo' => 'Bar'
		);

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$this->assertFalse(
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testTryToGetLanguageTargetLinksForNullLanguageCode( $pageLanguageCacheStrategy ) {

		$interlanguageLink = new InterlanguageLink( null, 'Foo' );

		$languageTargetLinks = array(
			'bo' => 'Bar'
		);

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$this->assertEquals(
			$languageTargetLinks,
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testTryToGetLanguageTargetLinksFromEmptyLinksCache( $pageLanguageCacheStrategy ) {

		$interlanguageLink = new InterlanguageLink( 'en', 'Foo' );
		$languageTargetLinks = array();

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$this->assertFalse(
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testDeleteLanguageTargetLinks( $pageLanguageCacheStrategy ) {

		$interlanguageLink = new InterlanguageLink( 'en', 'Foo' );

		$languageTargetLinks = array(
			'bo' => 'Help:Bar',
			'en' => Title::newFromText( 'Foo' )
		);

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$linkReferences = array(
			new DIWikiPage( 'Foo', NS_MAIN )
		);

		$instance->deleteLanguageTargetLinksFromCache( $linkReferences );

		$this->assertFalse(
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testDeletePageLanguageForMatchedTarget( $pageLanguageCacheStrategy ) {

		$helpNS = $GLOBALS['wgContLang']->getNsText( NS_HELP );

		$title = Title::newFromText( 'Bar', NS_HELP );
		$interlanguageLink = new InterlanguageLink( 'en', 'Foo' );

		$languageTargetLinks = array(
			'bo' => "$helpNS:Bar",
			'en' => Title::newFromText( 'Foo' )
		);

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$this->assertEquals(
			'bo',
			$instance->getPageLanguageFromCache( $title )
		);

		$instance->deletePageLanguageForTargetFromCache( $title );

		$this->assertFalse(
			$instance->getPageLanguageFromCache( $title )
		);

		$this->assertEquals(
			'en',
			$instance->getPageLanguageFromCache( Title::newFromText( 'Foo' ) )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testNoLanguageTargetLinksDeleteForNonMatchedTarget( $pageLanguageCacheStrategy ) {

		$interlanguageLink = new InterlanguageLink( 'en', 'Foo' );

		$languageTargetLinks = array(
			'bo' => 'Bar',
			'en' => Title::newFromText( 'Foo' )
		);

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->saveLanguageTargetLinksToCache(
			$interlanguageLink,
			$languageTargetLinks
		);

		$linkReferences = array(
			new DIWikiPage( 'canNotBeMatched', NS_MAIN ),
			Title::newFromText( 'invalidMatch' ),
			'invalidMatch'
		);

		$instance->deleteLanguageTargetLinksFromCache( $linkReferences );

		$this->assertEquals(
			$languageTargetLinks,
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);
	}

	/**
	 * @dataProvider pageLanguageCacheStrategyProvider
	 */
	public function testUpdatePageLanguageToCache( $pageLanguageCacheStrategy ) {

		$id = 'foo:sil:page:';
		$data = 'bo';

		if ( $pageLanguageCacheStrategy === 'blob' ) {
			$id = 'foo:sil:blob:';
			$data = array( 'foo:sil:page:ddc35f88fa71b6ef142ae61f35364653' => 'bo' );
		}

		$title = Title::newFromText( 'Bar', NS_MAIN );

		$cache = $this->getMockBuilder( '\Onoi\Cache\Cache' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$cache->expects( $this->once() )
			->method( 'save' )
			->with(
				$this->stringContains( $id ) ,
				$this->equalTo( $data ) );

		$cacheKeyProvider = $this->cacheKeyProvider;

		$instance = new LanguageTargetLinksCache( $cache, $cacheKeyProvider );
		$instance->setPageLanguageCacheStrategy( $pageLanguageCacheStrategy );

		$instance->updatePageLanguageToCache( $title, 'bo' );
	}

	public function testTryToGetLanguageTargetLinksFromCacheOnNullLinkReference() {

		$interlanguageLink = $this->getMockBuilder( '\SIL\InterlanguageLink' )
			->disableOriginalConstructor()
			->getMock();

		$interlanguageLink->expects( $this->once() )
			->method( 'getLinkReference' );

		// Can occur on an invalid title
		// $interlanguageLink = new InterlanguageLink( 'en', '<>Foo' );

		$instance = new LanguageTargetLinksCache(
			$this->cache,
			$this->cacheKeyProvider
		);

		$this->assertFalse(
			$instance->getLanguageTargetLinksFromCache( $interlanguageLink )
		);
	}

	public function pageLanguageCacheStrategyProvider() {

		$provider = array(
			array( 'blob' ),
			array( 'non-blob' )
		);

		return $provider;
	}

}