SluggableTrait::needsSlugging() - Code Metrics - Inspection of "add function findBySlugOrNew" - cviebrock/eloquent-sluggable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#254)

unknown

created 2016-05-11 20:57 UTC

SluggableTrait::needsSlugging() A

↳ Parent: SluggableTrait

Complexity

Conditions	4
Paths	4

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	8
Bugs	3	Features	0

Metric	Value
c	8
b	3
f	0
dl	0
loc	16
rs	9.2
cc	4
eloc	9
nc	4
nop	0

<?php namespace Cviebrock\EloquentSluggable;

use Cocur\Slugify\Slugify;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;

/**
 * Class SluggableTrait
 *
 * @package Cviebrock\EloquentSluggable
 */
trait SluggableTrait
{
    /**
     * Determines whether the model needs slugging.
     *
     * @return bool
     */
    protected function needsSlugging()
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];
        $on_update = $config['on_update'];

        if (empty($this->attributes[$save_to])) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return true;
        }

        if ($this->isDirty($save_to)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return false;
        }

        return (!$this->exists || $on_update);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Get the source string for the slug.
     *
     * @return string
     */
    protected function getSlugSource()
    {
        $config = $this->getSluggableConfig();
        $from = $config['build_from'];

        if (is_null($from)) {
            return $this->__toString();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        $source = array_map([$this, 'generateSource'], (array)$from);

        return join($source, ' ');
    }

    /**
     * Get value for slug.
     *
     * @param string $key
     * @return string|null
     */
    protected function generateSource($key)
    {
        if (isset($this->{$key})) {
            return $this->{$key};
        }

        $object = $this;
        foreach (explode('.', $key) as $segment) {
            if (!is_object($object) || !$tmp = $object->{$segment}) {
                return null;
            }

            $object = $object->{$segment};
        }

        return $object;
    }

    /**
     * Generate a slug from the given source string.
     *
     * @param string $source
     * @return string
     * @throws \UnexpectedValueException
     */
    protected function generateSlug($source)
    {
        $config = $this->getSluggableConfig();
        $separator = $config['separator'];
        $method = $config['method'];
        $max_length = $config['max_length'];

        if (empty($source)) {
            $slug = null;
        } elseif ($method === null) {
            $slugEngine = $this->getSlugEngine();
            $slug = $slugEngine->slugify($source, $separator);
        } elseif (is_callable($method)) {
            $slug = call_user_func($method, $source, $separator);
        } else {
            throw new \UnexpectedValueException('Sluggable method is not callable or null.');
        }

        if (is_string($slug) && $max_length) {
            $slug = substr($slug, 0, $max_length);
        }

        return $slug;
    }

    /**
     * Return a class that has a `slugify()` method, used to convert
     * strings into slugs.
     *
     * @return Slugify
     */
    protected function getSlugEngine()
    {
        return new Slugify();
    }

    /**
     * Checks that the given slug is not a reserved word.
     *
     * @param string $slug
     * @return string
     * @throws \UnexpectedValueException
     */
    protected function validateSlug($slug)
    {
        $config = $this->getSluggableConfig();
        $reserved = $config['reserved'];

        if ($reserved === null) {
            return $slug;
        }

        // check for reserved names
        if ($reserved instanceof \Closure) {
            $reserved = $reserved($this);
        }

        if (is_array($reserved)) {
            if (in_array($slug, $reserved)) {
                return $slug . $config['separator'] . '1';
            }

            return $slug;
        }

        throw new \UnexpectedValueException('Sluggable reserved is not null, an array, or a closure that returns null/array.');
    }

    /**
     * Checks if the slug should be unique, and makes it so if needed.
     *
     * @param string $slug
     * @return string
     */
    protected function makeSlugUnique($slug)
    {
        $config = $this->getSluggableConfig();
        if (!$config['unique']) {
            return $slug;
        }

        $separator = $config['separator'];

        // find all models where the slug is like the current one
        $list = $this->getExistingSlugs($slug);

        // if ...
        // 	a) the list is empty
        // 	b) our slug isn't in the list
        // 	c) our slug is in the list and it's for our model
        // ... we are okay
        if (
          count($list) === 0 ||
          !in_array($slug, $list) ||
          (array_key_exists($this->getKey(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
              $list) && $list[$this->getKey()] === $slug)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        ) {
            return $slug;
        }

        $suffix = $this->generateSuffix($slug, $list);

        return $slug . $separator . $suffix;
    }

    /**
     * Generate a unique suffix for the given slug (and list of existing, "similar" slugs.
     *
     * @param string $slug
     * @param array $list
     *
     * @return string
     */
    protected function generateSuffix($slug, $list)
    {
        $config = $this->getSluggableConfig();
        $separator = $config['separator'];
        $len = strlen($slug . $separator);

        // If the slug already exists, but belongs to
        // our model, return the current suffix.
        if ($this->id === array_search($this->slug, $list)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $suffix = explode($separator, $this->slug);
class MyClass { }

$x = new MyClass();
$x->foo = true;

            return end($suffix);
        }

        array_walk($list, function (&$value, $key) use ($len) {

            $value = intval(substr($value, $len));
        });

        // find the highest increment
        rsort($list);

        return reset($list) + 1;
    }

    /**
     * Get all existing slugs that are similar to the given slug.
     *
     * @param string $slug
     * @return array
     */
    protected function getExistingSlugs($slug)
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];
        $include_trashed = $config['include_trashed'];

        $instance = new static;

        //check for direct match or something that has a separator followed by a suffix
        $query = $instance->where(function ($query) use (
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
          $save_to,
          $config,
          $slug
        ) {
            $query->where($save_to, $slug);
            $query->orWhere($save_to, 'LIKE',
              $slug . $config['separator'] . '%');
        });

        // include trashed models if required
        if ($include_trashed && $this->usesSoftDeleting()) {
            $query = $query->withTrashed();
        }

        // get a list of all matching slugs
        $list = $query->lists($save_to, $this->getKeyName());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Laravel 5.0/5.1 check
        return $list instanceof Collection ? $list->all() : $list;
    }

    /**
     * Does this model use softDeleting?
     *
     * @return bool
     */
    protected function usesSoftDeleting()
    {
        return method_exists($this, 'BootSoftDeletes');
    }

    /**
     * Set the slug manually.
     *
     * @param string $slug
     */
    protected function setSlug($slug)
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];
        $this->setAttribute($save_to, $slug);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Get the current slug.
     *
     * @return mixed
     */
    public function getSlug()
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];

        return $this->getAttribute($save_to);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Manually slug the current model.
     *
     * @param bool $force
     * @return $this
     */
    public function sluggify($force = false)
    {
        if ($this->fireModelEvent('slugging') === false) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return $this;
        }

        if ($force || $this->needsSlugging()) {
            $source = $this->getSlugSource();
            $slug = $this->generateSlug($source);

            $slug = $this->validateSlug($slug);
            $slug = $this->makeSlugUnique($slug);

            $this->setSlug($slug);

            $this->fireModelEvent('slugged');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this;
    }

    /**
     * Force slugging of current model.
     *
     * @return SluggableTrait

     */
    public function resluggify()
    {
        return $this->sluggify(true);
    }

    /**
     * Generate a unique slug for a given string.
     *
     * @param  string $fromString
     * @return string
     */
    public static function createSlug($fromString)
    {
        $model = new self();
        $slug = $model->generateSlug($fromString);
        $slug = $model->validateSlug($slug);

        return $model->makeSlugUnique($slug);
    }

    /**
     * Query scope for finding a model by its slug.
     *
     * @param $scope
     * @param $slug
     * @return mixed
     */
    public function scopeWhereSlug($scope, $slug)
    {
        $config = $this->getSluggableConfig();

        return $scope->where($config['save_to'], $slug);
    }

    /**
     * Find a model by slug.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model|null
     */
    public static function findBySlug($slug, array $columns = ['*'])
    {
        return self::whereSlug($slug)->first($columns);

    }

    /**
     * Find a model by slug or fail.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model
     */
    public static function findBySlugOrFail($slug, array $columns = ['*'])
    {
        return self::whereSlug($slug)->firstOrFail($columns);

    }

    /**
     * Get the default configuration and merge in any model-specific overrides.
     *
     * @return array
     */
    protected function getSluggableConfig()
    {
        $defaults = app('config')->get('sluggable');
        if (property_exists($this, 'sluggable')) {
            return array_merge($defaults, $this->sluggable);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        return $defaults;
    }

    /**
     * Simple find by Id if it's numeric or slug if not. Fail if not found.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Support\Collection
     */
    public static function findBySlugOrIdOrFail($slug, array $columns = ['*'])

    {
        if (!$result = self::findBySlug($slug, $columns)) {
            return self::findOrFail((int)$slug, $columns);
        }

        return $result;
    }

    /**
     * Simple find by Id if it's numeric or slug if not.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Support\Collection|null
     */
    public static function findBySlugOrId($slug, array $columns = ['*'])

    {
        if (!$result = self::findBySlug($slug, $columns)) {
            return self::find($slug, $columns);
        }

        return $result;
    }

    /**
     * Find a model by slug or create new instance of model.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model
     */
    public static function findBySlugOrNew($slug, array $columns = ['*'])
    {
        $model =  self::findBySlug($slug,$columns);

        if(is_null($model)){
            return (new self);
        }
        return $model;
    }
}


1			<?php namespace Cviebrock\EloquentSluggable;
2
3			use Cocur\Slugify\Slugify;
4			use Illuminate\Database\Eloquent\Model;
5			use Illuminate\Support\Collection;
6
7			/**
8			* Class SluggableTrait
9			*
10			* @package Cviebrock\EloquentSluggable
11			*/
12			trait SluggableTrait
13			{
14			/**
15			* Determines whether the model needs slugging.
16			*
17			* @return bool
18			*/
19			protected function needsSlugging()
20			{
21			$config = $this->getSluggableConfig();
22			$save_to = $config['save_to'];
23			$on_update = $config['on_update'];
24
25			if (empty($this->attributes[$save_to])) {
			0 ignored issues – show Bug introduced 2016-04-15 19:51 UTC by Report Bug Copy Issue Report The property `attributes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26			return true;
27			}
28
29			if ($this->isDirty($save_to)) {
			0 ignored issues – show Bug introduced 2016-04-15 19:51 UTC by Report Bug Copy Issue Report It seems like `isDirty()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
30			return false;
31			}
32
33			return (!$this->exists \|\| $on_update);
			0 ignored issues – show Bug introduced 2016-04-15 19:51 UTC by Report Bug Copy Issue Report The property `exists` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
34			}
35
36			/**
37			* Get the source string for the slug.

cviebrock / eloquent-sluggable

Pull Request — master (#254)

SluggableTrait::needsSlugging() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like