Merge pull request #37 from cordoval/more-work-on-lib

typos and improvements

.travis.yml

@@ -11,7 +11,7 @@ matrix:
   allow_failures:
     - php: hhvm
 
-install: composer install
+install: composer install -n
 
 script:
     - bin/atoum -d tests/units

README.rst

@@ -11,7 +11,7 @@ At this moment, only one driver is **redis**, use `Symfony2` and `Bundle <https:
 Description
 -----------
 
-A timeline is a collection of action which can be represented by:
+A timeline is a collection of actions which can be represented by:
 
 - **Subject**
 - **Verb**
@@ -22,22 +22,22 @@ Example:
 +--------------+---------+--------------------------------------------------------------------+
 |   Subject    |  Verb   | Complements                                                        |
 +==============+=========+====================================================================+
-| Chuck Norris | Own     | the world (directComplement), with Vic Mc Key (indirectComplement) |
+| Chuck Norris | own     | the world (directComplement), with Vic Mc Key (indirectComplement) |
 +--------------+---------+--------------------------------------------------------------------+
 | Sheldon      | say     | Bazinga (directComplement)                                         |
 +--------------+---------+--------------------------------------------------------------------+
 
-There is two types of action list to retrieve:
+There are two types of action lists to retrieve:
 
 Timeline
 ~~~~~~~~
 
-Wall of a subject with all its actions + all actions of its **spreads**, see `spread.rst <https://github.com/stephpy/timeline/tree/master/doc/spread.rst>`_
+Stream of actions where the subject is involved + all actions of its **spreads**, see `spread.rst <https://github.com/stephpy/timeline/tree/master/doc/spread.rst>`_
 
 SubjectAction
 ~~~~~~~~~~~~~
 
-All actions of the subject.
+All actions the subject performed.
 
 Context
 ~~~~~~~
@@ -46,7 +46,7 @@ Imagine Chuck Norris has 233 friends and follow 20 companies.
 
 If we have one context, like facebook, his wall will return each action performed by his friends and companies.
 
-You can too use **Contexts** to filter timelines, for example, we can have 3 contexts:
+You can also use **Contexts** to filter timelines, for example, we can have 3 contexts:
 
 - GLOBAL: actions of his friends and companies
 - FRIEND: actions of his friends

example/basic.php

@@ -16,34 +16,34 @@
 // Push an action
 
 $actionManager = $c['action_manager'];
-$chuck         = $actionManager->findOrCreateComponent('User', 'Chuck');
-$bruceLee      = $actionManager->findOrCreateComponent('User', 'BruceLee');
+$chuck = $actionManager->findOrCreateComponent('User', 'Chuck');
+$bruceLee = $actionManager->findOrCreateComponent('User', 'BruceLee');
 
 $action = $actionManager->create($chuck, 'kick', array('directComplement' => $bruceLee));
 $actionManager->updateAction($action);
 
 // Pull a timeline of a subject
 
-$actionManager   = $c['action_manager'];
+$actionManager = $c['action_manager'];
 $timelineManager = $c['timeline_manager'];
-$chuck           = $actionManager->findOrCreateComponent('User', 'Chuck');
+$chuck = $actionManager->findOrCreateComponent('User', 'Chuck');
 
-$timeline        = $timelineManager->getTimeline($chuck);
+$timeline = $timelineManager->getTimeline($chuck);
 
 print sprintf("---- Timeline Results = (%s) -----\n", count($timeline));
 
 foreach ($timeline as $action) {
-    $subject          = $action->getSubject();
+    $subject = $action->getSubject();
     $directComplement = $action->getComponent('directComplement');
     //.....
 }
 
 // Pull actions of a subject
 
 $actionManager = $c['action_manager'];
-$chuck         = $actionManager->findOrCreateComponent('User', 'Chuck');
+$chuck = $actionManager->findOrCreateComponent('User', 'Chuck');
 
-$actions       = $actionManager->getSubjectActions($chuck);
+$actions = $actionManager->getSubjectActions($chuck);
 
 print sprintf("---- Actions Results = (%s) -----\n", count($actions));
 

src/Driver/AbstractActionManager.php

@@ -74,6 +74,7 @@ public function create($subject, $verb, array $components = array())
      * @param ActionInterface $action    action
      * @param string          $type      type
      * @param mixed           $component component
+     * @throws \Exception
      */
     public function addComponent($action, $type, $component)
     {

src/Driver/QueryBuilder/Criteria/Asserter.php

@@ -12,8 +12,8 @@ class Asserter implements CriteriaInterface
     CONST ASSERTER_NOT_LIKE            = 'NOT LIKE';
     CONST ASSERTER_LOWER_THAN          = '<';
     CONST ASSERTER_LOWER_THAN_EQUAL    = '<=';
-    CONST ASSERTER_GREATHER_THAN       = '>';
-    CONST ASSERTER_GREATHER_THAN_EQUAL = '>=';
+    CONST ASSERTER_GREATER_THAN       = '>';
+    CONST ASSERTER_GREATER_THAN_EQUAL = '>=';
 
     /**
      * @var string
@@ -109,27 +109,27 @@ public function lte($value)
     }
 
     /**
-     * greather than
+     * greater than
      *
      * @param mixed $value value
      *
-     * @return return DateTimeAsserter
+     * @return Asserter
      */
     public function gt($value)
     {
-        return $this->create(self::ASSERTER_GREATHER_THAN, $this->transform($value));
+        return $this->create(self::ASSERTER_GREATER_THAN, $this->transform($value));
     }
 
     /**
-     * greather than equal
+     * greater than equal
      *
      * @param mixed $value value
      *
-     * @return return DateTimeAsserter
+     * @return Asserter
      */
     public function gte($value)
     {
-        return $this->create(self::ASSERTER_GREATHER_THAN_EQUAL, $this->transform($value));
+        return $this->create(self::ASSERTER_GREATER_THAN_EQUAL, $this->transform($value));
     }
 
 
@@ -170,7 +170,8 @@ public function fromArray(array $data)
         list ($field, $operator, $value) = $data['value'];
 
         return $this->field($field)
-            ->create($operator, $value);
+            ->create($operator, $value)
+        ;
     }
 
     /**

src/Driver/QueryBuilder/Criteria/Operator.php

@@ -15,7 +15,7 @@ class Operator implements CriteriaInterface
     protected $type;
 
     /**
-     * @var array<CriteriaInterface>
+     * @var CriteriaInterface[]
      */
     protected $criterias = array();
 
@@ -77,7 +77,7 @@ public function getType()
     }
 
     /**
-     * @return array<CriteriaInterface>
+     * @return CriteriaInterface[]
      */
     public function getCriterias()
     {

src/Driver/QueryBuilder/QueryBuilder.php

@@ -111,7 +111,8 @@ public function createNewOperator($type, array $args)
         return $this->factory
             ->createOperator()
             ->setType($type)
-            ->setCriterias($args);
+            ->setCriterias($args)
+        ;
     }
 
     /**

src/Driver/QueryBuilder/QueryBuilderFactory.php

@@ -66,9 +66,7 @@ public function createOperator()
      */
     public function createOperatorFromArray(array $data)
     {
-        return $this->createOperator()
-            ->fromArray($data, $this)
-        ;
+        return $this->createOperator()->fromArray($data, $this);
     }
 
     /**
@@ -86,8 +84,6 @@ public function createAsserter()
      */
     public function createAsserterFromArray(array $data)
     {
-        return $this->createAsserter()
-            ->fromArray($data)
-        ;
+        return $this->createAsserter()->fromArray($data);
     }
 }

src/Driver/Redis/Pager/AbstractPager.php

@@ -37,9 +37,14 @@ public function findActionsForIds(array $ids)
 
         $datas = $this->client->hmget($this->getActionKey(), $ids);
 
-        return array_values(array_map(function($v) {
-            return unserialize($v);
-        }, $datas));
+        return array_values(
+            array_map(
+                function($v) {
+                    return unserialize($v);
+                },
+                $datas
+            )
+        );
     }
 
     /**

src/Driver/Redis/Pager/KnpSubscriber.php

@@ -18,9 +18,9 @@ public function items(ItemsEvent $event)
 
         $target = $event->target;
         $offset = $event->getOffset();
-        $limit  = $event->getLimit() - 1;
+        $limit = $event->getLimit() - 1;
 
-        $ids    = $this->client->zRevRange($target->key, $offset, ($offset + $limit));
+        $ids = $this->client->zRevRange($target->key, $offset, ($offset + $limit));
 
         $event->count = $this->client->zCard($target->key);
         $event->items = $this->actionManager->findActionsForIds($ids);

src/Driver/Redis/Pager/Pager.php

@@ -21,12 +21,12 @@ public function paginate($target, $page = 1, $limit = 10, $options = array())
         }
 
         $offset = ($page - 1) * $limit;
-        $limit  = $limit - 1; // due to redis
+        $limit = $limit - 1; // due to redis
 
-        $ids    = $this->client->zRevRange($target->key, $offset, ($offset + $limit));
+        $ids = $this->client->zRevRange($target->key, $offset, ($offset + $limit));
 
-        $this->page      = $page;
-        $this->items     = $this->findActionsForIds($ids);
+        $this->page = $page;
+        $this->items = $this->findActionsForIds($ids);
         $this->nbResults = $this->client->zCard($target->key);
         $this->lastPage  = intval(ceil($this->nbResults / ($limit + 1)));
 

src/Driver/Redis/QueryExecutor.php

@@ -23,9 +23,9 @@ public function fetch($query, $page = 1, $maxPerPage = 10)
         }
 
         $offset = ($page - 1) * $maxPerPage;
-        $maxPerPage  = $maxPerPage - 1; // due to redis
+        $maxPerPage = $maxPerPage - 1; // due to redis
 
-        $ids    = $this->client->zRevRange($query->key, $offset, ($offset + $maxPerPage));
+        $ids = $this->client->zRevRange($query->key, $offset, ($offset + $maxPerPage));
 
         return $this->findActionsForIds($ids);
     }