ModuleRepository - Code Metrics - Inspection of "Added the ability to install bower and npm on modu..." - anomalylabs/streams-platform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#338)

unknown

created 2016-12-31 19:10 UTC

ModuleRepository A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	165
rs	10
wmc	15
lcom	1
cbo	3

9 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	all()	4	1
A	create()	10	1
A	delete()	10	2
A	install()	11	2
A	uninstall()	11	2
A	disable()	8	1
A	enabled()	8	1
B	installNpm()	29	4

<?php namespace Anomaly\Streams\Platform\Addon\Module;

use Anomaly\Streams\Platform\Addon\Module\Contract\ModuleRepositoryInterface;
use Symfony\Component\Process\Process;

/**
 * Class ModuleRepository
 *
 * @link   http://pyrocms.com/
 * @author PyroCMS, Inc. <[email protected]>
 * @author Ryan Thompson <[email protected]>
 */
class ModuleRepository implements ModuleRepositoryInterface
{

    /**
     * The module model.
     *
     * @var
     */
    protected $model;

    /**
     * Create a new ModuleRepository instance.
     *
     * @param ModuleModel $model
     */
    public function __construct(ModuleModel $model)
    {
        $this->model = $model;
    }

    /**
     * Return all modules in the database.
     *
     * @return mixed
     */
    public function all()
    {
        return $this->model->all();

    }

    /**
     * Create a module record.
     *
     * @param  Module $module
     * @return bool
     */
    public function create(Module $module)
    {
        $instance = $this->model->newInstance();

        $instance->namespace = $module->getNamespace();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $instance->installed = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $instance->enabled   = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $instance->save();
    }

    /**
     * Delete a module record.
     *
     * @param  Module      $module
     * @return ModuleModel
     */
    public function delete(Module $module)
    {
        $module = $this->model->findByNamespace($module->getNamespace());

        if ($module) {
            $module->delete();
        }

        return $module;
    }

    /**
     * Mark a module as installed.
     *
     * @param  Module $module
     * @return bool
     */
    public function install(Module $module)
    {
        if (!$module = $this->model->findByNamespaceOrNew($module->getNamespace())) {
            return false;
        }

        $module->installed = true;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $module->enabled   = true;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $module->save();
    }

    /**
     * Mark a module as uninstalled.
     *
     * @param  Module $module
     * @return bool
     */
    public function uninstall(Module $module)
    {
        if (!$module = $this->model->findByNamespace($module->getNamespace())) {
            return false;
        }

        $module->installed = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $module->enabled   = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $module->save();
    }

    /**
     * Mark a module as disabled.
     *
     * @param  Module $module
     * @return bool
     */
    public function disable(Module $module)
    {
        $module = $this->model->findByNamespace($module->getNamespace());

        $module->enabled = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $module->save();
    }

    /**
     * Mark a module as enabled.
     *
     * @param  Module $module
     * @return bool
     */
    public function enabled(Module $module)
    {
        $module = $this->model->findByNamespace($module->getNamespace());

        $module->enabled = true;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $module->save();
    }

    /**
     * Install the npm dependencies
     * @return void
     */
    public function installNpm(Module $module)
    {
        // First make sure that there's a package.json
        if(file_exists($module->getAppPath() . '/package.json')) {
            return false;
        }

        $yarnCheck = new Process('which yarn');
        $yarnCheck->run();

        // Then check to see if yarn is installed and there's a yarn.lock file
        // Either way, add the folder as a dependency to the project's package.json
        if(file_exists(base_path().'/yarn.lock') && $yarnCheck->getOutput()) {
            $addProcess = new Process('yarn add file:' . $module->getAppPath() . ' --save && yarn install');
        } else {
            $addProcess = new Process('npm install ' . $module->getAppPath() . ' --save');
        }

        // Make sure the working directory is the project's root
        $addProcess->setWorkingDirectory(base_path());

        // Make sure it doesn't timeout
        // @todo: might need to increase the timeout
        $addProcess->setTimeout(7 * 60);
        $addProcess->setIdleTimeout(7 * 60);

        // Let 'er rip!
        $addProcess->run();
    }

}


1			<?php namespace Anomaly\Streams\Platform\Addon\Module;
2
3			use Anomaly\Streams\Platform\Addon\Module\Contract\ModuleRepositoryInterface;
4			use Symfony\Component\Process\Process;
5
6			/**
7			* Class ModuleRepository
8			*
9			* @link http://pyrocms.com/
10			* @author PyroCMS, Inc. <[email protected]>
11			* @author Ryan Thompson <[email protected]>
12			*/
13			class ModuleRepository implements ModuleRepositoryInterface
14			{
15
16			/**
17			* The module model.
18			*
19			* @var
20			*/
21			protected $model;
22
23			/**
24			* Create a new ModuleRepository instance.
25			*
26			* @param ModuleModel $model
27			*/
28			public function __construct(ModuleModel $model)
29			{
30			$this->model = $model;
31			}
32
33			/**
34			* Return all modules in the database.
35			*
36			* @return mixed
37			*/
38			public function all()
39			{
40			return $this->model->all();
			0 ignored issues – show Bug Compatibility introduced 2016-07-29 19:02 UTC by Report Bug Copy Issue Report The expression `$this->model->all();` of type `Illuminate\Database\Eloq...base\Eloquent\Builder[]` adds the type `Illuminate\Database\Eloquent\Builder[]` to the return on line 40 which is incompatible with the return type declared by the interface `Anomaly\Streams\Platform...epositoryInterface::all` of type `Anomaly\Streams\Platform\Model\EloquentCollection`. Loading history...
41			}
42
43			/**
44			* Create a module record.
45			*
46			* @param Module $module
47			* @return bool
48			*/
49			public function create(Module $module)
50			{
51			$instance = $this->model->newInstance();
52
53			$instance->namespace = $module->getNamespace();
			0 ignored issues – show Documentation introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The property `namespace` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
54			$instance->installed = false;
			0 ignored issues – show Documentation introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The property `installed` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
55			$instance->enabled = false;
			0 ignored issues – show Documentation introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The property `enabled` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
56
57			return $instance->save();
58			}
59
60			/**
61			* Delete a module record.
62			*
63			* @param Module $module
64			* @return ModuleModel
65			*/
66			public function delete(Module $module)
67			{
68			$module = $this->model->findByNamespace($module->getNamespace());
69
70			if ($module) {
71			$module->delete();
72			}
73
74			return $module;
75			}
76
77			/**
78			* Mark a module as installed.
79			*
80			* @param Module $module
81			* @return bool
82			*/
83			public function install(Module $module)
84			{
85			if (!$module = $this->model->findByNamespaceOrNew($module->getNamespace())) {
86			return false;
87			}
88
89			$module->installed = true;
			0 ignored issues – show Documentation introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The property `installed` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
90			$module->enabled = true;
			0 ignored issues – show Documentation introduced 2016-12-31 18:56 UTC by Report Bug Copy Issue Report The property `enabled` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
91
92			return $module->save();
93			}
94
95			/**
96			* Mark a module as uninstalled.
97			*
98			* @param Module $module
99			* @return bool
100			*/
101			public function uninstall(Module $module)
102			{
103			if (!$module = $this->model->findByNamespace($module->getNamespace())) {
104			return false;
105			}
106
107			$module->installed = false;
			0 ignored issues – show Documentation introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The property `installed` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
108			$module->enabled = false;
			0 ignored issues – show Documentation introduced 2016-12-31 18:56 UTC by Report Bug Copy Issue Report The property `enabled` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
109
110			return $module->save();
111			}
112
113			/**
114			* Mark a module as disabled.
115			*
116			* @param Module $module
117			* @return bool
118			*/
119			public function disable(Module $module)
120			{
121			$module = $this->model->findByNamespace($module->getNamespace());
122
123			$module->enabled = false;
			0 ignored issues – show Documentation introduced 2016-12-31 18:56 UTC by Report Bug Copy Issue Report The property `enabled` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
124
125			return $module->save();
126			}
127
128			/**
129			* Mark a module as enabled.
130			*
131			* @param Module $module
132			* @return bool
133			*/
134			public function enabled(Module $module)
135			{
136			$module = $this->model->findByNamespace($module->getNamespace());
137
138			$module->enabled = true;
			0 ignored issues – show Documentation introduced 2016-12-31 18:56 UTC by Report Bug Copy Issue Report The property `enabled` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
139
140			return $module->save();
141			}
142
143			/**
144			* Install the npm dependencies
145			* @return void
146			*/
147			public function installNpm(Module $module)
148			{
149			// First make sure that there's a package.json
150			if(file_exists($module->getAppPath() . '/package.json')) {
151			return false;
152			}
153
154			$yarnCheck = new Process('which yarn');
155			$yarnCheck->run();
156
157			// Then check to see if yarn is installed and there's a yarn.lock file
158			// Either way, add the folder as a dependency to the project's package.json
159			if(file_exists(base_path().'/yarn.lock') && $yarnCheck->getOutput()) {
160			$addProcess = new Process('yarn add file:' . $module->getAppPath() . ' --save && yarn install');
161			} else {
162			$addProcess = new Process('npm install ' . $module->getAppPath() . ' --save');
163			}
164
165			// Make sure the working directory is the project's root
166			$addProcess->setWorkingDirectory(base_path());
167
168			// Make sure it doesn't timeout
169			// @todo: might need to increase the timeout
170			$addProcess->setTimeout(7 * 60);
171			$addProcess->setIdleTimeout(7 * 60);
172
173			// Let 'er rip!
174			$addProcess->run();
175			}
176
177			}
178

anomalylabs / streams-platform

Pull Request — master (#338)

ModuleRepository A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

Duplication Side-by-Side

Filter issues like