Builder::getOptions() - Code Metrics - Inspection of "✨ Adapters" - LaraCrafts/laravel-url-shortener - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

by Choraimy

created 2019-09-28 10:08 UTC

Builder::getOptions() A

↳ Parent: Builder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10

<?php

namespace LaraCrafts\UrlShortener;

use GuzzleHttp\Psr7\Uri;
use InvalidArgumentException;
use LaraCrafts\UrlShortener\Concerns\CustomDomains;
use LaraCrafts\UrlShortener\Concerns\CustomSuffixes;
use LaraCrafts\UrlShortener\Concerns\ToPromise;
use LaraCrafts\UrlShortener\Concerns\ToString;
use LaraCrafts\UrlShortener\Concerns\ToUri;
use LaraCrafts\UrlShortener\Contracts\Client;
use LaraCrafts\UrlShortener\Contracts\UnsupportedOperationException;
use Psr\Http\Message\UriInterface;

class Builder
{
    protected $client;
    protected $options;
    protected $uri;

    /**
     * Create a new shortening builder instance.
     *
     * @param \LaraCrafts\UrlShortener\Contracts\Client $client
     * @param \Psr\Http\Message\UriInterface|string $uri
     * @param array $options
     * @return void
     */
    public function __construct(Client $client, $uri, array $options)
    {
        $this->client = $client;
        $this->options = $options;
        $this->uri = $this->parseUri($uri);
    }

    /**
     * Get the shortened URI asynchronously.
     *
     * @return \GuzzleHttp\Promise\PromiseInterface
     */
    public function async()
    {
        $driver = $this->getClient()->driver();
        $promise = null;


        if ($driver instanceof ToPromise) {
            $promise = $driver->toPromise($this->uri, $this->options);
        } else {
            throw new UnsupportedOperationException('Async URL shortening is not supported');
        }

        return $promise->then(function ($uri) {
            return $this->parseUri($uri);
        });
    }

    /**
     * Set the domain to shorten to.
     *
     * @param string $domain
     * @return $this
     */
    public function domain(string $domain)
    {
        $driver = $this->getClient()->driver();

        if (!$driver instanceof CustomDomains) {
            throw new UnsupportedOperationException('Applying a custom domain is not supported');
        }

        $driver->withDomain($this, $domain);

        return $this;
    }

    /**
     * Get the shortened URI.
     *
     * @return \Psr\Http\Message\UriInterface
     */
    public function get()
    {
        $driver = $this->getClient()->driver();

        if ($driver instanceof ToUri) {
            $uri = $driver->toUri($this->uri, $this->options);
        } elseif ($driver instanceof ToString) {
            $uri = $driver->toString($this->uri, $this->options);
        } elseif ($driver instanceof ToPromise) {
            $uri = $driver->toPromise($this->uri, $this->options)->wait();
        } else {
            throw new UnsupportedOperationException('URL shortening is not supported');
        }

        return $this->parseUri($uri);
    }

    /**
     * Get the client.
     *
     * @return \LaraCrafts\UrlShortener\Contracts\Client
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * Get the options.
     *
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Get the URI.
     *
     * @return \Psr\Http\Message\UriInterface
     */
    public function getUri()
    {
        return $this->uri;
    }

    /**
     * Parse the given URI.
     *
     * @param \Psr\Http\Message\UriInterface|string $uri
     * @return \Psr\Http\Message\UriInterface
     */
    protected function parseUri($uri)
    {
        if ($uri instanceof UriInterface) {
            return $uri;
        }

        if (is_string($uri) || (is_object($uri) && method_exists($uri, '__toString'))) {

            return new Uri((string)$uri);
        }

        throw new InvalidArgumentException('URI must be a string or UriInterface');
    }

    /**
     * Set the suffix to shorten to.
     *
     * @param string $suffix
     * @return $this
     */
    public function to(string $suffix)
    {
        $driver = $this->getClient()->driver();

        if (!$driver instanceof CustomSuffixes) {
            throw new UnsupportedOperationException('Applying a custom suffix is not supported');
        }

        $driver->withSuffix($this, $suffix);

        return $this;
    }

    /**
     * Add a piece of data to the builder.
     *
     * @param array|string $key
     * @param mixed|null $value
     * @return $this
     */
    public function with($key, $value = null)
    {
        if (is_array($key)) {
            $this->options = array_merge($this->options, $key);
        } else {
            $this->options[$key] = $value;
        }

        return $this;
    }

    /**
     * Get the shortened URI as a string.
     *
     * @return string
     */
    public function __toString()
    {
        return (string)$this->get();
    }
}


1			<?php
2
3			namespace LaraCrafts\UrlShortener;
4
5			use GuzzleHttp\Psr7\Uri;
6			use InvalidArgumentException;
7			use LaraCrafts\UrlShortener\Concerns\CustomDomains;
8			use LaraCrafts\UrlShortener\Concerns\CustomSuffixes;
9			use LaraCrafts\UrlShortener\Concerns\ToPromise;
10			use LaraCrafts\UrlShortener\Concerns\ToString;
11			use LaraCrafts\UrlShortener\Concerns\ToUri;
12			use LaraCrafts\UrlShortener\Contracts\Client;
13			use LaraCrafts\UrlShortener\Contracts\UnsupportedOperationException;
14			use Psr\Http\Message\UriInterface;
15
16			class Builder
17			{
18			protected $client;
19			protected $options;
20			protected $uri;
21
22			/**
23			* Create a new shortening builder instance.
24			*
25			* @param \LaraCrafts\UrlShortener\Contracts\Client $client
26			* @param \Psr\Http\Message\UriInterface\|string $uri
27			* @param array $options
28			* @return void
29			*/
30			public function __construct(Client $client, $uri, array $options)
31			{
32			$this->client = $client;
33			$this->options = $options;
34			$this->uri = $this->parseUri($uri);
35			}
36
37			/**
38			* Get the shortened URI asynchronously.
39			*
40			* @return \GuzzleHttp\Promise\PromiseInterface
41			*/
42			public function async()
43			{
44			$driver = $this->getClient()->driver();
45			$promise = null;
			0 ignored issues – show Unused Code introduced 2019-09-20 18:00 UTC by Report Bug Copy Issue Report The assignment to `$promise` is dead and can be removed. Loading history...
46
47			if ($driver instanceof ToPromise) {
48			$promise = $driver->toPromise($this->uri, $this->options);
49			} else {
50			throw new UnsupportedOperationException('Async URL shortening is not supported');
51			}
52
53			return $promise->then(function ($uri) {
54			return $this->parseUri($uri);
55			});
56			}
57
58			/**
59			* Set the domain to shorten to.
60			*
61			* @param string $domain
62			* @return $this
63			*/
64			public function domain(string $domain)
65			{
66			$driver = $this->getClient()->driver();
67
68			if (!$driver instanceof CustomDomains) {
69			throw new UnsupportedOperationException('Applying a custom domain is not supported');
70			}
71
72			$driver->withDomain($this, $domain);
73
74			return $this;
75			}
76
77			/**
78			* Get the shortened URI.
79			*
80			* @return \Psr\Http\Message\UriInterface
81			*/
82			public function get()
83			{
84			$driver = $this->getClient()->driver();
85
86			if ($driver instanceof ToUri) {
87			$uri = $driver->toUri($this->uri, $this->options);
88			} elseif ($driver instanceof ToString) {
89			$uri = $driver->toString($this->uri, $this->options);
90			} elseif ($driver instanceof ToPromise) {
91			$uri = $driver->toPromise($this->uri, $this->options)->wait();
92			} else {
93			throw new UnsupportedOperationException('URL shortening is not supported');
94			}
95
96			return $this->parseUri($uri);
97			}
98
99			/**
100			* Get the client.
101			*
102			* @return \LaraCrafts\UrlShortener\Contracts\Client
103			*/
104			public function getClient()
105			{
106			return $this->client;
107			}
108
109			/**
110			* Get the options.
111			*
112			* @return array
113			*/
114			public function getOptions()
115			{
116			return $this->options;
117			}
118
119			/**
120			* Get the URI.
121			*
122			* @return \Psr\Http\Message\UriInterface
123			*/
124			public function getUri()
125			{
126			return $this->uri;
127			}
128
129			/**
130			* Parse the given URI.
131			*
132			* @param \Psr\Http\Message\UriInterface\|string $uri
133			* @return \Psr\Http\Message\UriInterface
134			*/
135			protected function parseUri($uri)
136			{
137			if ($uri instanceof UriInterface) {
138			return $uri;
139			}
140
141			if (is_string($uri) \|\| (is_object($uri) && method_exists($uri, '__toString'))) {
			0 ignored issues – show introduced 2019-09-20 18:00 UTC by Report Bug Copy Issue Report The condition `is_string($uri)` is always `true`. Loading history...
142			return new Uri((string)$uri);
143			}
144
145			throw new InvalidArgumentException('URI must be a string or UriInterface');
146			}
147
148			/**
149			* Set the suffix to shorten to.
150			*
151			* @param string $suffix
152			* @return $this
153			*/
154			public function to(string $suffix)
155			{
156			$driver = $this->getClient()->driver();
157
158			if (!$driver instanceof CustomSuffixes) {
159			throw new UnsupportedOperationException('Applying a custom suffix is not supported');
160			}
161
162			$driver->withSuffix($this, $suffix);
163
164			return $this;
165			}
166
167			/**
168			* Add a piece of data to the builder.
169			*
170			* @param array\|string $key
171			* @param mixed\|null $value
172			* @return $this
173			*/
174			public function with($key, $value = null)
175			{
176			if (is_array($key)) {
177			$this->options = array_merge($this->options, $key);
178			} else {
179			$this->options[$key] = $value;
180			}
181
182			return $this;
183			}
184
185			/**
186			* Get the shortened URI as a string.
187			*
188			* @return string
189			*/
190			public function __toString()
191			{
192			return (string)$this->get();
193			}
194			}
195

LaraCrafts / laravel-url-shortener

GitHub Access Token became invalid

Pull Request — master (#38)

Builder::getOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like