Merge pull request #1 from jenssegers/master

Merge back master

Author: RemiCollin

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.6
   - 7
   - 7.1
 

README.md

@@ -41,6 +41,7 @@ composer require jenssegers/mongodb
  5.2.x    | 2.3.x or 3.0.x
  5.3.x    | 3.1.x or 3.2.x
  5.4.x    | 3.2.x
+ 5.5.x    | 3.3.x
 
 And add the service provider in `config/app.php`:
 
@@ -102,6 +103,15 @@ Embedded relations now return an `Illuminate\Database\Eloquent\Collection` rathe
 $books = $user->books()->sortBy('title');
 ```
 
+Testing
+-------
+
+To run the test for this package, run:
+
+```
+docker-compose up
+```
+
 Configuration
 -------------
 
@@ -143,6 +153,18 @@ You can connect to multiple servers or replica sets with the following configura
 ],
 ```
 
+Alternatively, you can use MongoDB connection string:
+
+```php
+'mongodb' => [
+    'driver'   => 'mongodb',
+    'dsn' => env('DB_DSN'),
+    'database' => env('DB_DATABASE'),
+],
+```
+
+Please refer to MongoDB official docs for its URI format: https://docs.mongodb.com/manual/reference/connection-string/
+
 Eloquent
 --------
 
@@ -942,7 +964,7 @@ $cursor = DB::collection('users')->raw(function($collection)
 Optional: if you don't pass a closure to the raw method, the internal MongoCollection object will be accessible:
 
 ```php
-$model = User::raw()->findOne(['age' => array('$lt' => 18]));
+$model = User::raw()->findOne(['age' => array('$lt' => 18)]);
 ```
 
 The internal MongoClient and MongoDB objects can be accessed like this:

composer.json

@@ -11,17 +11,18 @@
     ],
     "license" : "MIT",
     "require": {
-        "illuminate/support": "^5.1",
-        "illuminate/container": "^5.1",
-        "illuminate/database": "^5.1",
-        "illuminate/events": "^5.1",
+        "illuminate/support": "^5.5",
+        "illuminate/container": "^5.5",
+        "illuminate/database": "^5.5",
+        "illuminate/events": "^5.5",
         "mongodb/mongodb": "^1.0.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.0|^6.0",
+        "phpunit/phpunit": "^6.0",
         "orchestra/testbench": "^3.1",
-        "mockery/mockery": "^0.9",
-        "satooshi/php-coveralls": "^1.0"
+        "mockery/mockery": "^1.0",
+        "satooshi/php-coveralls": "^2.0",
+        "doctrine/dbal": "^2.5"
     },
     "autoload": {
         "psr-0": {

docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3'
+
+services:
+
+    php:
+        build:
+            context: .
+            dockerfile: docker/Dockerfile
+        volumes:
+            - .:/code
+        working_dir: /code
+        command: docker/entrypoint.sh
+        depends_on:
+          - mysql
+          - mongodb
+
+    mysql:
+        image: mysql
+        environment:
+            MYSQL_ROOT_PASSWORD:
+            MYSQL_DATABASE: unittest
+            MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+        logging:
+            driver: none
+
+    mongodb:
+        image: mongo
+        logging:
+            driver: none

docker/Dockerfile

@@ -0,0 +1,6 @@
+FROM php:7.1-cli
+
+RUN apt-get update && \
+    apt-get install -y autoconf pkg-config libssl-dev && \
+    pecl install mongodb && docker-php-ext-enable mongodb && \
+    docker-php-ext-install -j$(nproc) pdo pdo_mysql

docker/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+sleep 3 && php ./vendor/bin/phpunit

src/Jenssegers/Mongodb/Auth/DatabaseTokenRepository.php

@@ -27,7 +27,7 @@ protected function tokenExpired($token)
             $date = $token['created_at']->toDateTime();
             $date->setTimezone(new DateTimeZone(date_default_timezone_get()));
             $token['created_at'] = $date->format('Y-m-d H:i:s');
-        } elseif (is_array($token['created_at']) and isset($token['created_at']['date'])) {
+        } elseif (is_array($token['created_at']) && isset($token['created_at']['date'])) {
             $date = new DateTime($token['created_at']['date'], new DateTimeZone(isset($token['created_at']['timezone']) ? $token['created_at']['timezone'] : 'UTC'));
             $date->setTimezone(new DateTimeZone(date_default_timezone_get()));
             $token['created_at'] = $date->format('Y-m-d H:i:s');

src/Jenssegers/Mongodb/Auth/User.php

@@ -8,7 +8,7 @@
 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Foundation\Auth\Access\Authorizable;
-use Jenssegers\Mongodb\Eloquent\Model as Model;
+use Jenssegers\Mongodb\Eloquent\Model;
 
 class User extends Model implements
     AuthenticatableContract,

src/Jenssegers/Mongodb/Connection.php

@@ -3,6 +3,8 @@
 namespace Jenssegers\Mongodb;
 
 use Illuminate\Database\Connection as BaseConnection;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
 use MongoDB\Client;
 
 class Connection extends BaseConnection
@@ -34,7 +36,7 @@ public function __construct(array $config)
         $dsn = $this->getDsn($config);
 
         // You can pass options directly to the MongoDB constructor
-        $options = array_get($config, 'options', []);
+        $options = Arr::get($config, 'options', []);
 
         // Create the connection
         $this->connection = $this->createConnection($dsn, $config, $options);
@@ -149,18 +151,43 @@ public function disconnect()
     }
 
     /**
-     * Create a DSN string from a configuration.
+     * Determine if the given configuration array has a UNIX socket value.
      *
-     * @param  array $config
+     * @param  array  $config
+     * @return bool
+     */
+    protected function hasDsnString(array $config)
+    {
+        return isset($config['dsn']) && ! empty($config['dsn']);
+    }
+
+    /**
+     * Get the DSN string for a socket configuration.
+     *
+     * @param  array  $config
      * @return string
      */
-    protected function getDsn(array $config)
+    protected function getDsnString(array $config)
     {
-        // Check if the user passed a complete dsn to the configuration.
-        if (!empty($config['dsn'])) {
-            return $config['dsn'];
+        $dsn_string = $config['dsn'];
+
+        if (Str::contains($dsn_string, 'mongodb://')) {
+            $dsn_string = Str::replaceFirst('mongodb://', '', $dsn_string);
         }
 
+        $dsn_string = rawurlencode($dsn_string);
+
+        return "mongodb://{$dsn_string}";
+    }
+
+    /**
+     * Get the DSN string for a host / port configuration.
+     *
+     * @param  array  $config
+     * @return string
+     */
+    protected function getHostDsn(array $config)
+    {
         // Treat host option as array of hosts
         $hosts = is_array($config['host']) ? $config['host'] : [$config['host']];
 
@@ -177,6 +204,19 @@ protected function getDsn(array $config)
         return 'mongodb://' . implode(',', $hosts) . ($auth_database ? '/' . $auth_database : '');
     }
 
+    /**
+     * Create a DSN string from a configuration.
+     *
+     * @param  array $config
+     * @return string
+     */
+    protected function getDsn(array $config)
+    {
+        return $this->hasDsnString($config)
+            ? $this->getDsnString($config)
+            : $this->getHostDsn($config);
+    }
+
     /**
      * @inheritdoc
      */

src/Jenssegers/Mongodb/Eloquent/Builder.php

@@ -143,6 +143,14 @@ public function decrement($column, $amount = 1, array $extra = [])
         return parent::decrement($column, $amount, $extra);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function chunkById($count, callable $callback, $column = '_id', $alias = null)
+    {
+        return parent::chunkById($count, $callback, $column, $alias);
+    }
+
     /**
      * @inheritdoc
      */
@@ -162,10 +170,18 @@ public function raw($expression = null)
 
             return $this->model->newFromBuilder((array) $results);
         } // The result is a single object.
-        elseif (is_array($results) and array_key_exists('_id', $results)) {
+        elseif (is_array($results) && array_key_exists('_id', $results)) {
             return $this->model->newFromBuilder((array) $results);
         }
 
         return $results;
     }
+
+    /**
+     * @return \Illuminate\Database\ConnectionInterface
+     */
+    public function getConnection()
+    {
+        return $this->query->getConnection();
+    }
 }

src/Jenssegers/Mongodb/Eloquent/EmbedsRelations.php

@@ -2,6 +2,7 @@
 
 namespace Jenssegers\Mongodb\Eloquent;
 
+use Illuminate\Support\Str;
 use Jenssegers\Mongodb\Relations\EmbedsMany;
 use Jenssegers\Mongodb\Relations\EmbedsOne;
 
@@ -32,7 +33,7 @@ protected function embedsMany($related, $localKey = null, $foreignKey = null, $r
         }
 
         if (is_null($foreignKey)) {
-            $foreignKey = snake_case(class_basename($this));
+            $foreignKey = Str::snake(class_basename($this));
         }
 
         $query = $this->newQuery();
@@ -67,7 +68,7 @@ protected function embedsOne($related, $localKey = null, $foreignKey = null, $re
         }
 
         if (is_null($foreignKey)) {
-            $foreignKey = snake_case(class_basename($this));
+            $foreignKey = Str::snake(class_basename($this));
         }
 
         $query = $this->newQuery();

src/Jenssegers/Mongodb/Eloquent/HybridRelations.php

@@ -214,11 +214,20 @@ public function morphTo($name = null, $type = null, $id = null)
      * @param  string $collection
      * @param  string $foreignKey
      * @param  string $otherKey
+     * @param  string $parentKey
+     * @param  string $relatedKey
      * @param  string $relation
      * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */
-    public function belongsToMany($related, $collection = null, $foreignKey = null, $otherKey = null, $relation = null)
-    {
+    public function belongsToMany(
+        $related,
+        $collection = null,
+        $foreignKey = null,
+        $otherKey = null,
+        $parentKey = null,
+        $relatedKey = null,
+        $relation = null
+    ) {
         // If no relationship name was passed, we will pull backtraces to get the
         // name of the calling function. We will use that function name as the
         // title of this relation since that is a great convention to apply.
@@ -228,7 +237,15 @@ public function belongsToMany($related, $collection = null, $foreignKey = null,
 
         // Check if it is a relation with an original model.
         if (!is_subclass_of($related, \Jenssegers\Mongodb\Eloquent\Model::class)) {
-            return parent::belongsToMany($related, $collection, $foreignKey, $otherKey, $relation);
+            return parent::belongsToMany(
+                $related,
+                $collection,
+                $foreignKey,
+                $otherKey,
+                $parentKey,
+                $relatedKey,
+                $relation
+            );
         }
 
         // First, we'll need to determine the foreign key and "other key" for the
@@ -252,7 +269,16 @@ public function belongsToMany($related, $collection = null, $foreignKey = null,
         // appropriate query constraint and entirely manages the hydrations.
         $query = $instance->newQuery();
 
-        return new BelongsToMany($query, $this, $collection, $foreignKey, $otherKey, $relation);
+        return new BelongsToMany(
+            $query,
+            $this,
+            $collection,
+            $foreignKey,
+            $otherKey,
+            $parentKey ?: $this->getKeyName(),
+            $relatedKey ?: $instance->getKeyName(),
+            $relation
+        );
     }
 
     /**
@@ -274,6 +300,10 @@ protected function guessBelongsToManyRelation()
      */
     public function newEloquentBuilder($query)
     {
-        return new EloquentBuilder($query);
+        if (is_subclass_of($this, \Jenssegers\Mongodb\Eloquent\Model::class)) {
+            return new Builder($query);
+        } else {
+            return new EloquentBuilder($query);
+        }
     }
 }