Merge pull request #414 from wmde/indexof

Add StatementList::indexOf

Author: JeroenDeDauw

src/Statement/StatementList.php

@@ -282,4 +282,24 @@ public function isEmpty() {
 		return empty( $this->statements );
 	}
 
+	/**
+	 * @since 3.0
+	 *
+	 * @param Statement $statement
+	 *
+	 * @return int|bool
+	 */
+	public function getIndexByGuid( Statement $statement ) {
+		$index = 0;
+
+		foreach ( $this->statements as $s ) {
+			if ( $s->getGuid() === $statement->getGuid() ) {
+				return $index;
+			}
+			$index++;
+		}
+
+		return false;
+	}
+
 }

tests/unit/Statement/StatementListTest.php

@@ -541,4 +541,50 @@ public function testWhenNoPreferredStatements_getBestStatementsReturnsOnlyNormal
 		);
 	}
 
+	public function testGivenNotPresentStatement_getIndexByGuidReturnsFalse() {
+		$statements = new StatementList();
+
+		$this->assertFalse( $statements->getIndexByGuid( $this->getStatement( 1, 'kittens' ) ) );
+	}
+
+	public function testGivenPresentStatement_getIndexByGuidReturnsItsIndex() {
+		$statements = new StatementList( array(
+			$this->getStatement( 43, 'kittens43' ),
+			$this->getStatement( 42, 'kittens42' ),
+			$this->getStatement( 41, 'kittens41' ),
+		) );
+
+		$this->assertSame(
+			1,
+			$statements->getIndexByGuid( $this->getStatement( 42, 'kittens42' ) )
+		);
+	}
+
+	public function testGivenDoublyPresentStatement_getIndexByGuidReturnsTheFirstIndex() {
+		$statements = new StatementList( array(
+			$this->getStatement( 43, 'kittens43' ),
+			$this->getStatement( 42, 'kittens42' ),
+			$this->getStatement( 41, 'kittens41' ),
+			$this->getStatement( 42, 'kittens42' ),
+		) );
+
+		$this->assertSame(
+			1,
+			$statements->getIndexByGuid( $this->getStatement( 42, 'kittens42' ) )
+		);
+	}
+
+	public function testGivenDifferentStatementWithSameGuid_getIndexByGuidReturnsItsIndex() {
+		$statements = new StatementList( array(
+			$this->getStatement( 1, 'kittens43' ),
+			$this->getStatement( 2, 'kittens42' ),
+			$this->getStatement( 3, 'kittens41' ),
+		) );
+
+		$this->assertSame(
+			2,
+			$statements->getIndexByGuid( $this->getStatement( 42, 'kittens41' ) )
+		);
+	}
+
 }