letsdrink/ouzo-goodies

Utility classes, test assertions and mocking framework extracted from Ouzo framework.

1.6.0 2016-05-23 07:22 UTC

README

###What is it

Utility classes, test assertions and mocking framework extracted from Ouzo framework. We are compatible with PHP 5.3 and later.

Build Status Coverage Status Latest Stable Version Total Downloads License

###How to use it

Couple of examples.

Fluent arrays:

$result = FluentArray::from($users)
             ->map(Functions::extractField('name'))
             ->filter(Functions::notEmpty())
             ->unique()
             ->toArray();

Fluent iterator:

$result = FluentIterator::fromArray(array(1, 2, 3))
             ->cycle()
             ->limit(10)
             ->reindex()
             ->toArray(); // array(1, 2, 3, 1, 2, 3, 1, 2, 3, 1)

Fluent functions:

$product = new Product(['name' => 'super phone']);

$function = FluentFunctions::extractField('name')
      ->removePrefix('super')
      ->prepend(' extra')
      ->append('! ')
      ->surroundWith("***");

$result = Functions::call($function, $product); //=> '*** extra phone! ***'

Extract (from Functions):

$cities = Arrays::map($users, Functions::extract()->getAddress('home')->city);

Clock:

$string = Clock::now()
    ->plusYears(1)
    ->plusMonths(2)
    ->minusDays(3)
    ->format();

Comparators:

$product1 = new Product(['name' => 'b']);
$product2 = new Product(['name' => 'c']);
$product3 = new Product(['name' => 'a']);

$result = Arrays::sort([$product1, $product2, $product3], Comparator::compareBy('name'));

Fluent assertions for arrays:

$animals = ['cat', 'dog', 'pig'];
Assert::thatArray($animals)->hasSize(3)->contains('cat');

Fluent assertions for strings:

Assert::thatString("Frodo")
     ->startsWith("Fro")
     ->endsWith("do")
     ->contains("rod")
     ->doesNotContain("fro")
     ->hasSize(5);

Mocking:

$mock = Mock::create();
Mock::when($mock)->someMethod('arg')->thenReturn('123');

$result = $mock->someMethod('arg');

$this->assertEquals('123', $result);
Mock::verify($mock)->method('arg');

Exception assertions:

$foo = new Foo();

CatchException::when($foo)->method();

CatchException::assertThat()->isInstanceOf("FooException");

This is just a taste of Ouzo. Look at the documentation for more goodies.

###Where to get it

Download from github or simply add composer dependency:

"letsdrink/ouzo-goodies": "1.6.0"

Ouzo Goodies at packagist.

###Documentation

Tutorials:

Utilities:

  • Arrays - Helper functions for arrays.
  • FluentArray - Interface for manipulating arrays in a chained fashion.
  • Iterators - Helper functions for iterators.
  • FluentIterator- Interface for manipulating iterators in a chained fashion.
  • Strings - Helper functions for strings.
  • Objects- Helper functions that can operate on any PHP object.
  • Functions - Static utility methods returning closures that can be used with Arrays and FluentArray.
  • FluentFunctions - Fluent utility for function composition.
  • Cache - General-purpose cache.
  • Path - Helper functions for path operations.
  • Clock - DateTime replacement.
  • Comparators - Sorting.

Tests:

Check out full docs at http://ouzo.readthedocs.org

###PhpStorm plugins:

For ideas, questions, discussions write to ouzo-framework@googlegroups.com.