Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Makes phpcollection/phpcollection redundant #189

Merged
merged 6 commits into from
Nov 20, 2022
Merged

Makes phpcollection/phpcollection redundant #189

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6ce9b4
Fixes #188
jurgenhaas Nov 17, 2022
e2f5737
Fixes #188
jurgenhaas Nov 17, 2022
a66f4c6
Fixes #188
jurgenhaas Nov 17, 2022
6fee242
Fixes #188
jurgenhaas Nov 17, 2022
801a195
Fixes #188
jurgenhaas Nov 17, 2022
adee7d9
Fixes #188
jurgenhaas Nov 17, 2022
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
Prev Previous commit
Next Next commit
Fixes #188
  • Loading branch information
@jurgenhaas
jurgenhaas committed Nov 17, 2022
commit 6fee2425c2f9258cb6d7c43b701a72b65d8072df
6 changes: 3 additions & 3 deletions src/GitElephant/Sequence/AbstractCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

abstract class AbstractCollection
{
public function contains($searchedElem)
public function contains($searchedElem): bool
{
foreach ($this as $elem) {
if ($elem === $searchedElem) {
Expand All @@ -35,13 +35,13 @@ public function contains($searchedElem)
return false;
}

public function find($callable)
public function find($callable): LazyOption
{
$self = $this;

return new LazyOption(function () use ($callable, $self) {
foreach ($self as $elem) {
if (call_user_func($callable, $elem) === true) {
if ($callable($elem) === true) {
return new Some($elem);
}
}
Expand Down
103 changes: 52 additions & 51 deletions src/GitElephant/Sequence/AbstractSequence.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,51 +49,52 @@ public function addSequence(SequenceInterface $seq)
$this->addAll($seq->all());
}

public function indexOf($searchedElement)
public function indexOf($elem)
{
foreach ($this->elements as $i => $element) {
if ($searchedElement === $element) {
if ($elem === $element) {
return $i;
}
}

return -1;
}

public function lastIndexOf($searchedElement)
public function lastIndexOf($elem): int
{
for ($i = count($this->elements) - 1; $i >= 0; $i--) {
if ($this->elements[$i] === $searchedElement) {
if ($this->elements[$i] === $elem) {
return $i;
}
}

return -1;
}

public function reverse()
public function reverse(): CollectionInterface
{
return $this->createNew(array_reverse($this->elements));
}

public function isDefinedAt($index)
public function isDefinedAt(int $index): bool
{
return isset($this->elements[$index]);
}

/**
* Returns a filtered sequence.
*
* @param callable $callable receives the element and must return true (= keep) or false (= remove).
* @param callable $callable receives the element and must return true (=
* keep) or false (= remove).
*
* @return AbstractSequence
* @return CollectionInterface
*/
public function filter($callable)
public function filter(callable $callable): CollectionInterface
{
return $this->filterInternal($callable, true);
}

public function map($callable)
public function map(callable $callable): CollectionInterface
{
$newElements = [];
foreach ($this->elements as $i => $element) {
Expand All @@ -106,20 +107,21 @@ public function map($callable)
/**
* Returns a filtered sequence.
*
* @param callable $callable receives the element and must return true (= remove) or false (= keep).
* @param callable $callable receives the element and must return true (=
* remove) or false (= keep).
*
* @return AbstractSequence
* @return CollectionInterface
*/
public function filterNot($callable)
public function filterNot(callable $callable): CollectionInterface
{
return $this->filterInternal($callable, false);
}

private function filterInternal($callable, $booleanKeep)
private function filterInternal($callable, $booleanKeep): CollectionInterface
{
$newElements = [];
foreach ($this->elements as $element) {
if ($booleanKeep !== call_user_func($callable, $element)) {
if ($booleanKeep !== $callable($element)) {
continue;
}

Expand All @@ -133,7 +135,7 @@ public function foldLeft($initialValue, $callable)
{
$value = $initialValue;
foreach ($this->elements as $elem) {
$value = call_user_func($callable, $value, $elem);
$value = $callable($value, $elem);
}

return $value;
Expand All @@ -143,7 +145,7 @@ public function foldRight($initialValue, $callable)
{
$value = $initialValue;
foreach (array_reverse($this->elements) as $elem) {
$value = call_user_func($callable, $elem, $value);
$value = $callable($elem, $value);
}

return $value;
Expand All @@ -154,23 +156,24 @@ public function foldRight($initialValue, $callable)
*
* @param callable $callable
*
* @return integer the index, or -1 if the predicate is not true for any element.
* @return integer the index, or -1 if the predicate is not true for any
* element.
*/
public function indexWhere($callable)
public function indexWhere(callable $callable): int
{
foreach ($this->elements as $i => $element) {
if (call_user_func($callable, $element) === true) {
if ($callable($element) === true) {
return $i;
}
}

return -1;
}

public function lastIndexWhere($callable)
public function lastIndexWhere(callable $callable): int
{
for ($i = count($this->elements) - 1; $i >= 0; $i--) {
if (call_user_func($callable, $this->elements[$i]) === true) {
if ($callable($this->elements[$i]) === true) {
return $i;
}
}
Expand All @@ -196,7 +199,7 @@ public function first()
return new Some(reset($this->elements));
}

public function indices()
public function indices(): array
{
return array_keys($this->elements);
}
Expand All @@ -205,10 +208,8 @@ public function indices()
* Returns an element based on its index (0-based).
*
* @param integer $index
*
* @return T
*/
public function get($index)
public function get(int $index)
{
if (!isset($this->elements[$index])) {
throw new OutOfBoundsException(sprintf('The index "%s" does not exist in this sequence.', $index));
Expand All @@ -222,11 +223,9 @@ public function get($index)
*
* @param int $index
*
* @return T
*
* @throws \OutOfBoundsException If there is no element at the given index.
*/
public function remove($index)
public function remove(int $index)
{
if (!isset($this->elements[$index])) {
throw new OutOfBoundsException(sprintf('The index "%d" is not in the interval [0, %d).', $index, count($this->elements)));
Expand All @@ -243,9 +242,9 @@ public function remove($index)
* Updates the element at the given index (0-based).
*
* @param integer $index
* @param T $value
* @param mixed $value
*/
public function update($index, $value)
public function update(int $index, $value): void
{
if (!isset($this->elements[$index])) {
throw new \InvalidArgumentException(sprintf('There is no element at index "%d".', $index));
Expand All @@ -254,29 +253,29 @@ public function update($index, $value)
$this->elements[$index] = $value;
}

public function isEmpty()
public function isEmpty(): bool
{
return empty($this->elements);
}

public function all()
public function all(): array
{
return $this->elements;
}

public function add($newElement)
public function add($elem): void
{
$this->elements[] = $newElement;
$this->elements[] = $elem;
}

public function addAll(array $addedElements)
public function addAll(array $elements): void
{
foreach ($addedElements as $newElement) {
foreach ($elements as $newElement) {
$this->elements[] = $newElement;
}
}

public function take($number)
public function take(int $number): CollectionInterface
{
if ($number <= 0) {
throw new \InvalidArgumentException(sprintf('$number must be greater than 0, but got %d.', $number));
Expand All @@ -288,26 +287,27 @@ public function take($number)
/**
* Extracts element from the head while the passed callable returns true.
*
* @param callable $callable receives elements of this sequence as first argument, and returns true/false.
* @param callable $callable receives elements of this sequence as first
* argument, and returns true/false.
*
* @return Sequence
* @return CollectionInterface
*/
public function takeWhile($callable)
public function takeWhile(callable $callable): CollectionInterface
{
$newElements = [];

for ($i = 0,$c = count($this->elements); $i < $c; $i++) {
if (call_user_func($callable, $this->elements[$i]) !== true) {
foreach ($this->elements as $i => $iValue) {
if ($callable($this->elements[$i]) !== true) {
break;
}

$newElements[] = $this->elements[$i];
$newElements[] = $iValue;
}

return $this->createNew($newElements);
}

public function drop($number)
public function drop(int $number): CollectionInterface
{
if ($number <= 0) {
throw new \InvalidArgumentException(sprintf('The number must be greater than 0, but got %d.', $number));
Expand All @@ -316,7 +316,7 @@ public function drop($number)
return $this->createNew(array_slice($this->elements, $number));
}

public function dropRight($number)
public function dropRight(int $number): CollectionInterface
{
if ($number <= 0) {
throw new \InvalidArgumentException(sprintf('The number must be greater than 0, but got %d.', $number));
Expand All @@ -325,18 +325,19 @@ public function dropRight($number)
return $this->createNew(array_slice($this->elements, 0, -1 * $number));
}

public function dropWhile($callable)
public function dropWhile(callable $callable): CollectionInterface
{
for ($i = 0,$c = count($this->elements); $i < $c; $i++) {
if (true !== call_user_func($callable, $this->elements[$i])) {
$i = 0;
foreach ($this->elements as $i => $iValue) {
if (true !== $callable($this->elements[$i])) {
break;
}
}

return $this->createNew(array_slice($this->elements, $i));
}

public function exists($callable)
public function exists($callable): bool
{
foreach ($this as $elem) {
if ($callable($elem) === true) {
Expand All @@ -357,7 +358,7 @@ public function getIterator(): \ArrayIterator
return new \ArrayIterator($this->elements ?: []);
}

protected function createNew(array $elements)
protected function createNew(array $elements): CollectionInterface
{
return new static($elements);
}
Expand Down
Loading