TranslatableUnitTest::testSimilarChangeMaxDocFreq() - Code Metrics - Inspection of "Merge branch 'dev2' of github.com:gordonbanderson/..." - gordonbanderson/silverstripe-elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev2 ( 76a09a...1cd385 )

by Gordon

created 2015-12-29 09:01 UTC

testSimilarChangeMaxDocFreq() A

↳ Parent: TranslatableUnitTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	16
rs	9.4286
cc	2
eloc	12
nc	2
nop	0

<?php
use SilverStripe\Elastica\ElasticSearcher;
use Elastica\Type;
use SilverStripe\Elastica\ReindexTask;

class TranslatableUnitTest extends ElasticsearchBaseTest {
	public static $fixture_file = 'elastica/tests/lotsOfPhotos.yml';

	public static $ignoreFixtureFileFor = array('testResultsForEmptySearch');

	public function setUpOnce() {
		//Add translatable if it exists
		if(class_exists('Translatable')) {
			SiteTree::add_extension('Translatable');
		}
		parent::setUpOnce();
	}

	public function testElasticSearchForm() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$form = new \ElasticSearchForm(new \Controller(), 'TestForm');
		$fields = $form->Fields();
		$result = array();
		foreach($fields as $field) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$result[$field->getName()] = $field->Value();
		}

		$expected = array('q' => '', 'searchlocale' => 'en_US');
		$this->assertEquals($expected, $result);

	}


	public function testHighlightPassingFields() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');

		$es->setHighlightedFields(array('Title', 'Title.standard', 'Description'));

		$fields = array('Title' => 1, 'Description' => 1);
		$query = 'New Zealand';
		$paginated = $es->search($query, $fields);
		$ctr = 0;

		foreach($paginated->getList()->toArray() as $result) {
			$ctr++;

			foreach($result->SearchHighlightsByField->Description->getIterator() as $highlight) {
				$snippet = $highlight->Snippet;
				$snippet = strtolower($snippet);
				$wordFound = false;
				$lcquery = explode(' ', strtolower($query));
				foreach($lcquery as $part) {
					$bracketed = '<strong class="hl">' . $part . '</strong>';
					if(strpos($snippet, $bracketed) > 0) {
						$wordFound = true;
					}
				}
				$this->assertTrue($wordFound, 'Highlight should have been found');
			}
		}
	}


	public function testAutoCompleteGood() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title' => 1, 'Description' => 1);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$query = 'Lond';
		$results = $es->autocomplete_search($query, 'Title');
		$this->assertEquals(7, $results->getTotalItems());
		foreach($results->toArray() as $result) {
			$this->assertTrue(strpos($result->Title, $query) > 0);
		}
	}




// ---------------------

	// FIXME - this test is shardy unfortunately
	public function testMoreLikeThisSinglePhoto() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$locale = \i18n::default_locale();
		$es->setLocale($locale);
		$es->setClasses('FlickrPhotoTO');

		$fields = array('Description.standard' => 1,'Title.standard' => 1);
		$results = $es->moreLikeThis($fp, $fields, true);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$terms = $results->getList()->MoreLikeThisTerms;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

		$fieldNamesReturned = array_keys($terms);
		$fieldNames = array_keys($fields);
		sort($fieldNames);
		sort($fieldNamesReturned);

		$this->assertEquals($fieldNames, $fieldNamesReturned);

		//FIXME - this seems anomolyous, check in more detail
		$expected = array('texas');
		$this->assertEquals($expected, $terms['Title.standard']);

		$expected = array('new', 'see', 'photographs', 'information', 'resolution', 'company', 'view',
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			'high', 'collection', 'pacific', 'orleans', 'degolyer', 'southern', 'everett',
			'railroad', 'texas');

		$expected = array('collection', 'company', 'degolyer', 'everett', 'file', 'high',
			'information', 'new', 'orleans', 'pacific', 'photographs', 'railroad', 'resolution',
			'see', 'southern', 'texas', 'view');



		$actual = $terms['Description.standard'];
		sort($expected);
		sort($actual);


		$this->assertEquals($expected, $actual);
	}




	/*
	test blank fields
	test fields with no weighting (ie not associative)

	 */

	public function testSimilarGood() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
		$paginated = $es->moreLikeThis($fp, $fields, true);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$this->assertEquals(32, $paginated->getTotalItems());
		$results = $paginated->getList()->toArray();
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Railroad Station, Stockdale, Texas]", $results[0]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Railroad Station, Taft, Texas]", $results[1]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Railroad Station, Sierra Blanca, Texas]", $results[2]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Freight Station, Waxahachie, Texas]", $results[3]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Passenger Station, Waxahachie, Texas]", $results[4]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific, Tower No. 63, Mexia, Texas]", $results[5]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific, Eakin Street Yard Office, Dallas, Texas]", $results[6]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Locomotive Scrap Line, Englewood Yards, Houston, Texas]", $results[7]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific, Switchman's Tower, San Antonio, Texas]", $results[8]->Title);
		$this->assertEquals("Flash Light view in new Subterranean", $results[9]->Title);
	}


	/*
	FIXME - this is not working, not sure why.  Trying to complete coverage of ReindexTask
	 */
	public function testBulkIndexing() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		//Reset the index, so that nothing has been indexed
		$this->service->reset();

		//Number of requests indexing wise made to Elasticsearch server
		$reqs = $this->service->getIndexingRequestCtr();

		$task = new ReindexTask($this->service);

		// null request is fine as no parameters used
		$task->run(null);

		//Check that the number of indexing requests has increased by 2
		$deltaReqs = $this->service->getIndexingRequestCtr() - $reqs;
		//One call is made for each of Page and FlickrPhotoTO
		$this->assertEquals(2, $deltaReqs);

		// default installed pages plus 100 FlickrPhotoTOs
		$this->checkNumberOfIndexedDocuments(103);
	}


	// if this is not set to unbounded, zero, a conditional is triggered to add max doc freq to the request
	public function testSimilarChangeMaxDocFreq() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setMaxDocFreq(4);
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
		$paginated = $es->moreLikeThis($fp, $fields, true);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$this->assertEquals(14, $paginated->getTotalItems());
		$results = $paginated->getList()->toArray();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$this->makeCode($paginated);
	}


	public function testSimilarNullFields() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		try {
			$paginated = $es->moreLikeThis($fp, null, true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('Fields cannot be null', $e->getMessage());
		}
	}


	public function testSimilarNullItem() {
		if(!class_exists('Translatable')) {
			$this->markTestSkipped('Translatable not installed');

		}

		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 1, 'Description.standard' => 1);

		try {
			$paginated = $es->moreLikeThis(null, $fields, true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('A searchable item cannot be null', $e->getMessage());
		}
	}

	private function makeCode($paginated) {

		$results = $paginated->getList()->toArray();
		$ctr = 0;
		echo '$result = $paginated->getList()->toArray();' . "\n";
		foreach($results as $result) {
			echo '$this->assertEquals("' . $result->Title . '", $results[' . $ctr . ']->Title);' . "\n";
			$ctr++;
		}
	}

}


1			<?php
2			use SilverStripe\Elastica\ElasticSearcher;
3			use Elastica\Type;
4			use SilverStripe\Elastica\ReindexTask;
5
6			class TranslatableUnitTest extends ElasticsearchBaseTest {
7			public static $fixture_file = 'elastica/tests/lotsOfPhotos.yml';
8
9			public static $ignoreFixtureFileFor = array('testResultsForEmptySearch');
10
11			public function setUpOnce() {
12			//Add translatable if it exists
13			if(class_exists('Translatable')) {
14			SiteTree::add_extension('Translatable');
15			}
16			parent::setUpOnce();
17			}
18
19			public function testElasticSearchForm() {
20			if(!class_exists('Translatable')) {
21			$this->markTestSkipped('Translatable not installed');
			1 ignored issue – show Bug introduced 2015-12-16 06:31 UTC by Report Bug Copy Issue Report The method `markTestSkipped()` does not seem to exist on `object<TranslatableUnitTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
22			}
23
24			$form = new \ElasticSearchForm(new \Controller(), 'TestForm');
25			$fields = $form->Fields();
26			$result = array();
27			foreach($fields as $field) {
			0 ignored issues – show Bug introduced 2015-12-01 14:39 UTC by Report Bug Copy Issue Report The expression `$fields` of type `object<FieldList>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
28			$result[$field->getName()] = $field->Value();
29			}
30
31			$expected = array('q' => '', 'searchlocale' => 'en_US');
32			$this->assertEquals($expected, $result);
33
34			}
35
36
37			public function testHighlightPassingFields() {
38			if(!class_exists('Translatable')) {

gordonbanderson / silverstripe-elastica

Push — dev2 ( 76a09a...1cd385 )

testSimilarChangeMaxDocFreq() A

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like