Oxford collection + phpcs fixer cleanup.

README.md

@@ -137,6 +137,20 @@ use Coduo\PHPHumanizer\Number;
 echo Number::metricSuffix(1240000, 'pl'); // "1,24M"
 ```
 
+## Collections
+
+**Oxford**
+
+```php
+use Coduo\PHPHumanizer\Collection;
+
+echo Collection::oxford(['Michal', 'Norbert', 'Lukasz', 'Pawel'], 2); // "Michal, Norbert, and 2 others"
+echo Collection::oxford(['Michal', 'Norbert', 'Lukasz'], 2); // "Michal, Norbert, and 1 other"
+echo Collection::oxford(['Michal', 'Norbert']); // "Michal and Norbert"
+```
+
+Oxford is using translator component, so you can use whatever string format you like.
+
 ## Date time
 
 **Difference**

spec/Coduo/PHPHumanizer/Collection/FormatterSpec.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace spec\Coduo\PHPHumanizer\Collection;
+;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Symfony\Component\Translation\Translator;
+
+class FormatterSpec extends ObjectBehavior
+{
+    function let(Translator $translator)
+    {
+        $this->beConstructedWith($translator);
+        $translator->trans(
+            'only_two',
+            array('%first%' => 'Michal', '%second%' => 'Norbert'),
+            'oxford'
+        )->willReturn('Michal and Norbert');
+
+        $translator->transChoice(
+            'comma_separated_with_limit',
+            1,
+            array('%count%' => 1, "%list%" => 'Michal, Norbert'),
+            'oxford'
+        )->willReturn('Michal, Norbert and 1 more');
+
+        $translator->trans(
+            'comma_separated',
+            array("%list%" => 'Michal, Norbert', '%last%' => "Lukasz"),
+            'oxford'
+        )->willReturn('Michal, Norbert and Lukasz');
+    }
+
+    function it_formats_two_elements()
+    {
+        $this->format(array("Michal", "Norbert"), null)->shouldReturn("Michal and Norbert");
+    }
+
+    function it_formats_elements_with_limit()
+    {
+        $this->format(array("Michal", "Norbert", "Lukasz"), 2)->shouldReturn("Michal, Norbert and 1 more");
+    }
+
+    function it_formats_elements_without_limit()
+    {
+        $this->format(array("Michal", "Norbert", "Lukasz"), null)->shouldReturn("Michal, Norbert and Lukasz");
+    }
+}

spec/Coduo/PHPHumanizer/Collection/OxfordSpec.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace spec\Coduo\PHPHumanizer\Collection;
+
+use Coduo\PHPHumanizer\Collection\Formatter;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Symfony\Component\Translation\TranslatorInterface;
+
+class OxfordSpec extends ObjectBehavior
+{
+    private $formatter;
+
+    public function let(TranslatorInterface $translator)
+    {
+        $this->formatter = new Formatter(
+            $translator->getWrappedObject()
+        );
+        $this->beConstructedWith($this->formatter);
+    }
+    function it_returns_empty_string_when_collection_is_empty()
+    {
+        $this->format(array())->shouldReturn('');
+    }
+
+    function it_returns_collection_item_string_when_collection_has_one_element()
+    {
+        $this->format(array(new CollectionItem("Michal")))->shouldReturn('Michal');
+    }
+}
+
+class CollectionItem
+{
+    private $name;
+
+    public function __construct($name)
+    {
+        $this->name = $name;
+    }
+
+    public function __toString()
+    {
+        return $this->name;
+    }
+}

spec/Coduo/PHPHumanizer/CollectionSpec.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace spec\Coduo\PHPHumanizer;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class CollectionSpec extends ObjectBehavior
+{
+    function it_humanizes_collections()
+    {
+        $examples = array(
+            array(array("Michal"), null, 'Michal'),
+            array(array("Michal", "Norbert"), null, 'Michal and Norbert'),
+            array(array("Michal", "Norbert", "Lukasz"), 2, 'Michal, Norbert, and 1 other'),
+            array(array("Michal", "Norbert", "Lukasz", "Pawel"), 2, 'Michal, Norbert, and 2 others'),
+            array(array("Michal", "Norbert", "Lukasz", "Pawel"), null, 'Michal, Norbert, Lukasz, and Pawel'),
+        );
+
+        foreach ($examples as $example) {
+            $this->oxford($example[0], $example[1])->shouldReturn($example[2]);
+        }
+    }
+
+    function it_humanizes_collections_for_polish_locale()
+    {
+        $examples = array(
+            array(array("Michal"), null, 'Michal'),
+            array(array("Michal", "Norbert"), null, 'Michal i Norbert'),
+            array(array("Michal", "Norbert", "Lukasz"), 2, 'Michal, Norbert i 1 inny'),
+            array(array("Michal", "Norbert", "Lukasz", "Pawel"), 2, 'Michal, Norbert i 2 innych'),
+        );
+
+        foreach ($examples as $example) {
+            $this->oxford($example[0], $example[1], 'pl')->shouldReturn($example[2]);
+        }
+    }
+}

src/Coduo/PHPHumanizer/Collection.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Coduo\PHPHumanizer;
+
+use Coduo\PHPHumanizer\Collection\Formatter;
+use Coduo\PHPHumanizer\Collection\Oxford;
+use Coduo\PHPHumanizer\Translator\Builder;
+
+class Collection
+{
+    public static function oxford($collection, $limit = null, $locale = 'en')
+    {
+        $oxford = new Oxford(
+            new Formatter(Builder::build($locale))
+        );
+
+        return $oxford->format($collection, $limit);
+    }
+}

src/Coduo/PHPHumanizer/Collection/Formatter.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace Coduo\PHPHumanizer\Collection;
+
+use Symfony\Component\Translation\TranslatorInterface;
+
+class Formatter
+{
+    /**
+     * @var \Symfony\Component\Translation\TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * @var string
+     */
+    private $catalogue;
+
+    /**
+     * @param TranslatorInterface $translator
+     */
+    public function __construct(TranslatorInterface $translator, $catalogue = 'oxford')
+    {
+        $this->translator = $translator;
+        $this->catalogue = $catalogue;
+    }
+
+    public function format($collection, $limit = null)
+    {
+        $count = count($collection);
+
+        if (0 === $count) {
+            return '';
+        }
+
+        if (1 === $count) {
+            return (string) $collection[0];
+        }
+
+        if (2 === $count) {
+            return $this->formatOnlyTwo($collection);
+        }
+
+        if (null !== $limit) {
+            return $this->formatCommaSeparatedWithLimit($collection, $limit, $count);
+        }
+
+        return $this->formatCommaSeparated($collection, $count);
+    }
+
+    /**
+     * @param $collection
+     * @param $limit
+     * @param $count
+     *
+     * @return string
+     */
+    private function formatCommaSeparatedWithLimit($collection, $limit, $count)
+    {
+        $display = array_map(function ($element) {
+            return (string) $element;
+        }, array_slice($collection, 0, $limit));
+
+        $moreCount = $count - count($display);
+
+        return $this->translator->transChoice('comma_separated_with_limit', $moreCount, array(
+            '%list%' => implode(', ', $display),
+            '%count%' => $moreCount,
+        ), $this->catalogue);
+    }
+
+    /**
+     * @param $collection
+     * @param $count
+     *
+     * @return string
+     */
+    private function formatCommaSeparated($collection, $count)
+    {
+        $display = array_map(function ($element) {
+            return (string) $element;
+        }, array_slice($collection, 0, $count - 1));
+
+        return $this->translator->trans('comma_separated', array(
+            '%list%' => implode(', ', $display),
+            '%last%' => (string) end($collection),
+        ), $this->catalogue);
+    }
+
+    /**
+     * @param $collection
+     *
+     * @return string
+     */
+    private function formatOnlyTwo($collection)
+    {
+        return $this->translator->trans('only_two', array(
+            '%first%' => (string) $collection[0],
+            '%second%' => (string) $collection[1],
+        ), $this->catalogue);
+    }
+}

src/Coduo/PHPHumanizer/Collection/Oxford.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Coduo\PHPHumanizer\Collection;
+
+class Oxford
+{
+    /**
+     * @var Formatter
+     */
+    private $formatter;
+
+    public function __construct(Formatter $formatter)
+    {
+        $this->formatter = $formatter;
+    }
+
+    public function format($collection, $limit = null)
+    {
+        return $this->formatter->format($collection, $limit);
+    }
+}

src/Coduo/PHPHumanizer/DateTime.php

@@ -13,12 +13,14 @@ class DateTime
     public static function difference(\DateTime $fromDate, \DateTime $toDate, $locale = 'en')
     {
         $formatter = new Formatter(Builder::build($locale));
+
         return $formatter->formatDifference(new Difference($fromDate, $toDate), $locale);
     }
 
     public static function preciseDifference(\DateTime $fromDate, \DateTime $toDate, $locale = 'en')
     {
         $formatter = new PreciseFormatter(Builder::build($locale));
+
         return $formatter->formatDifference(new PreciseDifference($fromDate, $toDate), $locale);
     }
 }

src/Coduo/PHPHumanizer/DateTime/Difference.php

@@ -67,7 +67,7 @@ private function calculate()
             new Hour(),
             new Minute(),
             new Second(),
-            new JustNow()
+            new JustNow(),
         );
 
         $absoluteMilliSecondsDiff = abs($this->toDate->getTimestamp() - $this->fromDate->getTimestamp()) * 1000;
@@ -86,6 +86,7 @@ private function calculate()
     public function isPast()
     {
         $diff = $this->toDate->getTimestamp() - $this->fromDate->getTimestamp();
+
         return ($diff > 0) ? false : true;
     }
 }

src/Coduo/PHPHumanizer/DateTime/Difference/CompoundResult.php

@@ -49,5 +49,4 @@ public function getUnit()
     {
         return $this->unit;
     }
-
 }

src/Coduo/PHPHumanizer/DateTime/Formatter.php

@@ -21,7 +21,8 @@ public function __construct(TranslatorInterface $translator)
 
     /**
      * @param Difference $difference
-     * @param string $locale
+     * @param string     $locale
+     *
      * @return string
      */
     public function formatDifference(Difference $difference, $locale = 'en')

src/Coduo/PHPHumanizer/DateTime/PreciseDifference.php

@@ -4,11 +4,9 @@
 
 use Coduo\PHPHumanizer\DateTime\Unit\Day;
 use Coduo\PHPHumanizer\DateTime\Unit\Hour;
-use Coduo\PHPHumanizer\DateTime\Unit\JustNow;
 use Coduo\PHPHumanizer\DateTime\Unit\Minute;
 use Coduo\PHPHumanizer\DateTime\Unit\Month;
 use Coduo\PHPHumanizer\DateTime\Unit\Second;
-use Coduo\PHPHumanizer\DateTime\Unit\Week;
 use Coduo\PHPHumanizer\DateTime\Unit\Year;
 use Coduo\PHPHumanizer\DateTime\Difference\CompoundResult;
 
@@ -64,7 +62,6 @@ private function calculate()
         $diff = $this->fromDate->diff($this->toDate);
 
         foreach ($units as $unit) {
-
             if ($diff->{$unit->getDateIntervalSymbol()} > 0) {
                 $this->units[] = $unit;
                 $this->compoundResults[] = new CompoundResult($unit, $diff->{$unit->getDateIntervalSymbol()});
@@ -75,6 +72,7 @@ private function calculate()
     public function isPast()
     {
         $diff = $this->toDate->getTimestamp() - $this->fromDate->getTimestamp();
+
         return ($diff > 0) ? false : true;
     }
 }