Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

[6.x] Add min, max, sum and avg methods to Stache query builder #13894

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.

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

Open
duncanmcclean wants to merge 4 commits into 6.x
base: 6.x
Choose a base branch
Loading
from aggregate-query-builder-methods
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions src/Query/Builder.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,31 @@ protected function onceWithColumns($columns, $callback)

abstract public function pluck($column, $key = null);

public function min($column)
{
return $this->pluck($column)->min();
}

public function max($column)
{
return $this->pluck($column)->max();
}

public function sum($column)
{
return $this->pluck($column)->sum();
}

public function avg($column)
{
return $this->pluck($column)->avg();
}

public function average($column)
{
return $this->avg($column);
}

public function when($value, $callback, $default = null)
{
if ($value) {
Expand Down
68 changes: 68 additions & 0 deletions tests/Data/Assets/AssetQueryBuilderTest.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,6 +715,74 @@ public function values_can_be_plucked()
'f.jpg',
], $this->container->queryAssets()->where('extension', 'jpg')->pluck('path')->all());
}

#[Test]
public function can_get_min_value()
{
Asset::find('test::a.jpg')->data(['type' => 'b', 'quantity' => 1])->save();
Asset::find('test::b.txt')->data(['type' => 'b', 'quantity' => 2])->save();
Asset::find('test::c.txt')->data(['type' => 'a', 'quantity' => 3])->save();
Asset::find('test::d.jpg')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(1, $this->container->queryAssets()->min('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, $this->container->queryAssets()->where('type', 'a')->min('quantity'));

// Assert returns null when there's no results.
$this->assertNull($this->container->queryAssets()->where('type', 'c')->min('quantity'));
}

#[Test]
public function can_get_max_value()
{
Asset::find('test::a.jpg')->data(['type' => 'b', 'quantity' => 1])->save();
Asset::find('test::b.txt')->data(['type' => 'b', 'quantity' => 2])->save();
Asset::find('test::c.txt')->data(['type' => 'a', 'quantity' => 3])->save();
Asset::find('test::d.jpg')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(4, $this->container->queryAssets()->max('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, $this->container->queryAssets()->where('type', 'a')->max('quantity'));

// Assert returns null when there's no results.
$this->assertNull($this->container->queryAssets()->where('type', 'c')->max('quantity'));
}

#[Test]
public function can_sum_values()
{
Asset::find('test::a.jpg')->data(['type' => 'b', 'quantity' => 1])->save();
Asset::find('test::b.txt')->data(['type' => 'b', 'quantity' => 2])->save();
Asset::find('test::c.txt')->data(['type' => 'a', 'quantity' => 3])->save();
Asset::find('test::d.jpg')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(10, $this->container->queryAssets()->sum('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, $this->container->queryAssets()->where('type', 'a')->sum('quantity'));

// Assert falls back to 0 when there's no results.
$this->assertEquals(0, $this->container->queryAssets()->where('type', 'c')->sum('quantity'));
}

#[Test]
public function can_get_average_value()
{
Asset::find('test::a.jpg')->data(['type' => 'b', 'quantity' => 1])->save();
Asset::find('test::b.txt')->data(['type' => 'b', 'quantity' => 2])->save();
Asset::find('test::c.txt')->data(['type' => 'a', 'quantity' => 3])->save();
Asset::find('test::d.jpg')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(2.5, $this->container->queryAssets()->average('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, $this->container->queryAssets()->where('type', 'a')->average('quantity'));

// Assert returns null when there's no results.
$this->assertNull($this->container->queryAssets()->where('type', 'c')->average('quantity'));
}
}

class CustomScope extends Scope
Expand Down
77 changes: 77 additions & 0 deletions tests/Data/Entries/EntryQueryBuilderTest.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,6 +1224,7 @@ public static function filterByStatusProvider()
];
}

#[Test]
public function values_can_be_plucked()
{
$this->createDummyCollectionAndEntries();
Expand Down Expand Up @@ -1257,6 +1258,82 @@ public function values_can_be_plucked()
], Entry::query()->where('type', 'b')->pluck('slug')->all());
}

#[Test]
public function can_get_min_value()
{
$this->createDummyCollectionAndEntries();
Entry::find('id-2')->set('type', 'b')->set('quantity', 2)->save();
Entry::find('id-3')->set('type', 'b')->set('quantity', 3)->save();
Collection::make('things')->save();
EntryFactory::id('id-4')->slug('thing-1')->collection('things')->data(['type' => 'a', 'quantity' => 4])->create();
EntryFactory::id('id-5')->slug('thing-2')->collection('things')->data(['type' => 'b', 'quantity' => 5])->create();

$this->assertEquals(2, Entry::query()->min('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(4, Entry::query()->where('type', 'a')->min('quantity'));

// Assert returns null when there's no results.
$this->assertNull(Entry::query()->where('type', 'c')->min('quantity'));
}

#[Test]
public function can_get_max_value()
{
$this->createDummyCollectionAndEntries();
Entry::find('id-2')->set('type', 'b')->set('quantity', 2)->save();
Entry::find('id-3')->set('type', 'b')->set('quantity', 3)->save();
Collection::make('things')->save();
EntryFactory::id('id-4')->slug('thing-1')->collection('things')->data(['type' => 'a', 'quantity' => 4])->create();
EntryFactory::id('id-5')->slug('thing-2')->collection('things')->data(['type' => 'b', 'quantity' => 5])->create();

$this->assertEquals(5, Entry::query()->max('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(4, Entry::query()->where('type', 'a')->max('quantity'));

// Assert returns null when there's no results.
$this->assertNull(Entry::query()->where('type', 'c')->max('quantity'));
}

#[Test]
public function can_sum_values()
{
$this->createDummyCollectionAndEntries();
Entry::find('id-2')->set('type', 'b')->set('quantity', 2)->save();
Entry::find('id-3')->set('type', 'b')->set('quantity', 3)->save();
Collection::make('things')->save();
EntryFactory::id('id-4')->slug('thing-1')->collection('things')->data(['type' => 'a', 'quantity' => 4])->create();
EntryFactory::id('id-5')->slug('thing-2')->collection('things')->data(['type' => 'b', 'quantity' => 5])->create();

$this->assertEquals(14, Entry::query()->sum('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(10, Entry::query()->where('type', 'b')->sum('quantity'));

// Assert falls back to 0 when there's no results.
$this->assertEquals(0, Entry::query()->where('type', 'c')->sum('quantity'));
}

#[Test]
public function can_get_average_value()
{
$this->createDummyCollectionAndEntries();
Entry::find('id-2')->set('type', 'b')->set('quantity', 2)->save();
Entry::find('id-3')->set('type', 'b')->set('quantity', 3)->save();
Collection::make('things')->save();
EntryFactory::id('id-4')->slug('thing-1')->collection('things')->data(['type' => 'a', 'quantity' => 4])->create();
EntryFactory::id('id-5')->slug('thing-2')->collection('things')->data(['type' => 'b', 'quantity' => 5])->create();

$this->assertEquals(3.5, Entry::query()->average('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(4, Entry::query()->where('type', 'a')->average('quantity'));

// Assert returns null when there's no results.
$this->assertNull(Entry::query()->where('type', 'c')->average('quantity'));
}

#[Test]
public function entry_can_be_found_using_first_or_fail()
{
Expand Down
72 changes: 72 additions & 0 deletions tests/Data/Taxonomies/TermQueryBuilderTest.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,6 +775,78 @@ public function terms_are_found_using_where_relation()
$this->assertCount(1, $terms);
$this->assertEquals(['c'], $terms->map->slug->all());
}

#[Test]
public function can_get_min_value()
{
Taxonomy::make('tags')->save();
Term::make('a')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 1])->save();
Term::make('b')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 2])->save();
Term::make('c')->taxonomy('tags')->data(['type' => 'a', 'quantity' => 3])->save();
Term::make('d')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(1, Term::query()->min('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, Term::query()->where('type', 'a')->min('quantity'));

// Assert returns null when there's no results.
$this->assertNull(Term::query()->where('type', 'c')->min('quantity'));
}

#[Test]
public function can_get_max_value()
{
Taxonomy::make('tags')->save();
Term::make('a')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 1])->save();
Term::make('b')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 2])->save();
Term::make('c')->taxonomy('tags')->data(['type' => 'a', 'quantity' => 3])->save();
Term::make('d')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(4, Term::query()->max('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, Term::query()->where('type', 'a')->max('quantity'));

// Assert returns null when there's no results.
$this->assertNull(Term::query()->where('type', 'c')->max('quantity'));
}

#[Test]
public function can_sum_values()
{
Taxonomy::make('tags')->save();
Term::make('a')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 1])->save();
Term::make('b')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 2])->save();
Term::make('c')->taxonomy('tags')->data(['type' => 'a', 'quantity' => 3])->save();
Term::make('d')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(10, Term::query()->sum('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, Term::query()->where('type', 'a')->sum('quantity'));

// Assert falls back to 0 when there's no results.
$this->assertEquals(0, Term::query()->where('type', 'c')->sum('quantity'));
}

#[Test]
public function can_get_average_value()
{
Taxonomy::make('tags')->save();
Term::make('a')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 1])->save();
Term::make('b')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 2])->save();
Term::make('c')->taxonomy('tags')->data(['type' => 'a', 'quantity' => 3])->save();
Term::make('d')->taxonomy('tags')->data(['type' => 'b', 'quantity' => 4])->save();

$this->assertEquals(2.5, Term::query()->average('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(3, Term::query()->where('type', 'a')->average('quantity'));

// Assert returns null when there's no results.
$this->assertNull(Term::query()->where('type', 'c')->average('quantity'));
}
}

class CustomScope extends Scope
Expand Down
64 changes: 64 additions & 0 deletions tests/Data/Users/UserQueryBuilderTest.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,70 @@ public function values_can_be_plucked()
], User::query()->where('type', 'b')->pluck('name')->all());
}

#[Test]
public function can_get_min_value()
{
User::make()->email('gandalf@precious.com')->data(['name' => 'Gandalf', 'type' => 'a', 'quantity' => 1])->save();
User::make()->email('smeagol@precious.com')->data(['name' => 'Smeagol', 'type' => 'b', 'quantity' => 2])->save();
User::make()->email('frodo@precious.com')->data(['name' => 'Frodo', 'type' => 'b', 'quantity' => 3])->save();

$this->assertEquals(1, User::query()->min('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(2, User::query()->where('type', 'b')->min('quantity'));

// Assert returns null when there's no results.
$this->assertNull(User::query()->where('type', 'c')->min('quantity'));
}

#[Test]
public function can_get_max_value()
{
User::make()->email('gandalf@precious.com')->data(['name' => 'Gandalf', 'type' => 'a', 'quantity' => 1])->save();
User::make()->email('smeagol@precious.com')->data(['name' => 'Smeagol', 'type' => 'b', 'quantity' => 2])->save();
User::make()->email('frodo@precious.com')->data(['name' => 'Frodo', 'type' => 'b', 'quantity' => 3])->save();

$this->assertEquals(3, User::query()->max('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(1, User::query()->where('type', 'a')->max('quantity'));

// Assert returns null when there's no results.
$this->assertNull(User::query()->where('type', 'c')->max('quantity'));
}

#[Test]
public function can_sum_values()
{
User::make()->email('gandalf@precious.com')->data(['name' => 'Gandalf', 'type' => 'a', 'quantity' => 1])->save();
User::make()->email('smeagol@precious.com')->data(['name' => 'Smeagol', 'type' => 'b', 'quantity' => 2])->save();
User::make()->email('frodo@precious.com')->data(['name' => 'Frodo', 'type' => 'b', 'quantity' => 3])->save();

$this->assertEquals(6, User::query()->sum('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(5, User::query()->where('type', 'b')->sum('quantity'));

// Assert falls back to 0 when there's no results.
$this->assertEquals(0, User::query()->where('type', 'c')->sum('quantity'));
}

#[Test]
public function can_get_average_value()
{
User::make()->email('gandalf@precious.com')->data(['name' => 'Gandalf', 'type' => 'a', 'quantity' => 1])->save();
User::make()->email('smeagol@precious.com')->data(['name' => 'Smeagol', 'type' => 'b', 'quantity' => 2])->save();
User::make()->email('frodo@precious.com')->data(['name' => 'Frodo', 'type' => 'b', 'quantity' => 3])->save();

$this->assertEquals(2, User::query()->average('quantity'));

// Assert only queried values are plucked.
$this->assertEquals(2.5, User::query()->where('type', 'b')->average('quantity'));

// Assert returns null when there's no results.
$this->assertNull(User::query()->where('type', 'c')->average('quantity'));
}

/** @test **/
public function users_are_found_using_scopes()
{
Expand Down

AltStyle によって変換されたページ (->オリジナル) /