HasDataSource::getDataSource() - Code Metrics - Inspection of "V2.0" - level23/druid-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

by Teye

created 2022-07-13 11:44 UTC

HasDataSource::getDataSource() A

↳ Parent: HasDataSource

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes

Metric	Value
eloc	13
c	0
b	0
f	0
dl	0
loc	17
ccs	10
cts	10
cp	1
rs	9.8333
cc	4
nc	4
nop	1
crap	4

<?php
declare(strict_types=1);

namespace Level23\Druid\Concerns;

use Closure;
use InvalidArgumentException;
use Level23\Druid\DruidClient;
use Level23\Druid\Types\JoinType;
filter:
    dependency_paths: ["lib/*"]
use Level23\Druid\Queries\QueryBuilder;
use Level23\Druid\DataSources\JoinDataSource;
use Level23\Druid\DataSources\TableDataSource;
use Level23\Druid\DataSources\QueryDataSource;
use Level23\Druid\DataSources\UnionDataSource;
use Level23\Druid\DataSources\LookupDataSource;
use Level23\Druid\DataSources\InlineDataSource;
use Level23\Druid\DataSources\DataSourceInterface;

trait HasDataSource
{
    protected DruidClient $client;

    protected DataSourceInterface $dataSource;

    /**
     * Alias method from "dataSource"
     *
     * @param string|DataSourceInterface $dataSource
     *
     * @return self
     */
    public function from($dataSource): self
    {
        return $this->dataSource($dataSource);
    }

    /**
     * Update/set the dataSource
     *
     * @param string|DataSourceInterface $dataSource
     *
     * @return self
     */
    public function dataSource($dataSource): self
    {
        if (is_string($dataSource)) {
            $this->dataSource = new TableDataSource($dataSource);
        } else {
            $this->dataSource = $dataSource;
        }

        return $this;
    }

    /**
     * @param string|DataSourceInterface|\Closure $dataSourceOrClosure
     * @param string                              $as
     * @param string                              $condition
     * @param string                              $joinType
     *
     * @return self
     */
    public function join($dataSourceOrClosure, string $as, string $condition, string $joinType = JoinType::INNER): self
    {
        if ($this->dataSource instanceof TableDataSource && $this->dataSource->dataSourceName == '') {

            throw new InvalidArgumentException('You first have to define your "from" dataSource before you can join!');
        }

        if (substr($as, -1) != '.') {
            $as .= '.';
        }

        $this->dataSource = new JoinDataSource(
            $this->dataSource,
            $this->getDataSource($dataSourceOrClosure),
            $as,
            $condition,
            $joinType
        );

        return $this;
    }

    /**
     * Join a lookup dataSource. Lookup datasources correspond to Druid's key-value lookup objects.
     *
     * Lookup datasources are key-value oriented and always have exactly two columns: k (the key) and v (the value),
     * and both are always strings.
     *
     * @param string $lookupName The name of the lookup dataSource.
     * @param string $as         The alias name as the dataSource will be used in the query.
     * @param string $condition  The condition how the match will be made.
     * @param string $joinType   The join type to use. This can be INNER or LEFT.
     *
     * @return self
     */
    public function joinLookup(
        string $lookupName,
        string $as,
        string $condition,
        string $joinType = JoinType::INNER
    ): self {
        $lookupDataSource = new LookupDataSource($lookupName);

        return $this->join($lookupDataSource, $as, $condition, $joinType);
    }

    /**
     * @param string|DataSourceInterface|\Closure $dataSourceOrClosure
     * @param string                              $as
     * @param string                              $condition
     *
     * @return self
     */
    public function leftJoin($dataSourceOrClosure, string $as, string $condition): self
    {
        return $this->join($dataSourceOrClosure, $as, $condition, JoinType::LEFT);
    }

    /**
     * @param string|DataSourceInterface|\Closure $dataSourceOrClosure
     * @param string                              $as
     * @param string                              $condition
     *
     * @return self
     */
    public function innerJoin($dataSourceOrClosure, string $as, string $condition): self
    {
        return $this->join($dataSourceOrClosure, $as, $condition);
    }

    /**
     * Inline datasources allow you to query a small amount of data that is embedded in the query itself.
     * They are useful when you want to write a query on a small amount of data without loading it first.
     * They are also useful as inputs into a join.
     *
     * Each row is an array that must be exactly as long as the list of columnNames. The first element in
     * each row corresponds to the first column in columnNames, and so on.
     *
     * @param string[]        $columnNames
     * @param array<scalar[]> $rows
     */
    public function fromInline(array $columnNames, array $rows): self
    {
        $this->dataSource = new InlineDataSource($columnNames, $rows);

        return $this;
    }

    /**
     * Unions allow you to treat two or more tables as a single datasource.
     *
     * With the native union datasource, the tables do not need to have identical schemas. If they do not
     * fully match up, then columns that exist in one table but not another will be treated as if they contained all
     * null values in the tables where they do not exist.
     *
     * @param string|string[] $dataSources
     * @param bool            $append When true, we will append the current used dataSource in the union.
     *
     * @return $this
     * @see https://druid.apache.org/docs/latest/querying/datasource.html#union
     */
    public function union($dataSources, bool $append = true): self
    {
        $dataSources = (array)$dataSources;

        if ($append) {
            if (!$this->dataSource instanceof TableDataSource) {
                throw new InvalidArgumentException('We can only union an table dataSource! You currently are using a ' . get_class($this->dataSource));
            }

            $dataSources[] = $this->dataSource->dataSourceName;

        }

        $this->dataSource = new UnionDataSource($dataSources);

        return $this;
    }

    /**
     * @param string|DataSourceInterface|\Closure $dataSourceOrClosure
     *
     * @return DataSourceInterface
     * @throws InvalidArgumentException
     */
    protected function getDataSource($dataSourceOrClosure)
    {
        if (is_string($dataSourceOrClosure)) {
            return new TableDataSource($dataSourceOrClosure);
        } elseif ($dataSourceOrClosure instanceof DataSourceInterface) {
            return $dataSourceOrClosure;
        } elseif ($dataSourceOrClosure instanceof Closure) {


            $builder = new QueryBuilder($this->client);
            call_user_func($dataSourceOrClosure, $builder);

            return new QueryDataSource($builder->getQuery());
        } else {
            throw new InvalidArgumentException(
                'Invalid dataSource given! This can either be a string (dataSource name),  ' .
                'an object which implements the DataSourceInterface, or a Closure function which allows ' .
                'you to build a sub-query.'
            );
        }
    }
}

1		<?php
2		declare(strict_types=1);
3
4		namespace Level23\Druid\Concerns;
5
6		use Closure;
7		use InvalidArgumentException;
8		use Level23\Druid\DruidClient;
9		use Level23\Druid\Types\JoinType;
		0 ignored issues – show Bug introduced 2022-07-13 11:40 UTC by Report Bug Copy Issue Report The type `Level23\Druid\Types\JoinType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10		use Level23\Druid\Queries\QueryBuilder;
11		use Level23\Druid\DataSources\JoinDataSource;
12		use Level23\Druid\DataSources\TableDataSource;
13		use Level23\Druid\DataSources\QueryDataSource;
14		use Level23\Druid\DataSources\UnionDataSource;
15		use Level23\Druid\DataSources\LookupDataSource;
16		use Level23\Druid\DataSources\InlineDataSource;
17		use Level23\Druid\DataSources\DataSourceInterface;
18
19		trait HasDataSource
20		{
21		protected DruidClient $client;
22
23		protected DataSourceInterface $dataSource;
24
25		/**
26		* Alias method from "dataSource"
27		*
28		* @param string\|DataSourceInterface $dataSource
29		*
30		* @return self
31		*/
32	2	public function from($dataSource): self
33		{
34	2	return $this->dataSource($dataSource);
35		}
36
37		/**
38		* Update/set the dataSource
39		*
40		* @param string\|DataSourceInterface $dataSource
41		*
42		* @return self
43		*/
44	32	public function dataSource($dataSource): self
45		{
46	32	if (is_string($dataSource)) {
47	30	$this->dataSource = new TableDataSource($dataSource);
48		} else {
49	4	$this->dataSource = $dataSource;
50		}
51
52	32	return $this;
53		}
54
55		/**
56		* @param string\|DataSourceInterface\|\Closure $dataSourceOrClosure
57		* @param string $as
58		* @param string $condition
59		* @param string $joinType
60		*
61		* @return self
62		*/
63	5	public function join($dataSourceOrClosure, string $as, string $condition, string $joinType = JoinType::INNER): self
64		{
65	5	if ($this->dataSource instanceof TableDataSource && $this->dataSource->dataSourceName == '') {
		0 ignored issues – show Bug introduced 2022-07-13 11:40 UTC by Report Bug Copy Issue Report Accessing `dataSourceName` on the interface `Level23\Druid\DataSources\DataSourceInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
66	1	throw new InvalidArgumentException('You first have to define your "from" dataSource before you can join!');
67		}
68
69	4	if (substr($as, -1) != '.') {
70	4	$as .= '.';
71		}
72
73	4	$this->dataSource = new JoinDataSource(
74	4	$this->dataSource,
75	4	$this->getDataSource($dataSourceOrClosure),
76		$as,
77		$condition,
78		$joinType
79		);
80
81	3	return $this;
82		}
83
84		/**
85		* Join a lookup dataSource. Lookup datasources correspond to Druid's key-value lookup objects.
86		*
87		* Lookup datasources are key-value oriented and always have exactly two columns: k (the key) and v (the value),
88		* and both are always strings.
89		*
90		* @param string $lookupName The name of the lookup dataSource.
91		* @param string $as The alias name as the dataSource will be used in the query.
92		* @param string $condition The condition how the match will be made.
93		* @param string $joinType The join type to use. This can be INNER or LEFT.
94		*
95		* @return self
96		*/
97	1	public function joinLookup(
98		string $lookupName,
99		string $as,
100		string $condition,
101		string $joinType = JoinType::INNER
102		): self {
103	1	$lookupDataSource = new LookupDataSource($lookupName);
104
105	1	return $this->join($lookupDataSource, $as, $condition, $joinType);
106		}
107
108		/**
109		* @param string\|DataSourceInterface\|\Closure $dataSourceOrClosure
110		* @param string $as
111		* @param string $condition
112		*
113		* @return self
114		*/
115	1	public function leftJoin($dataSourceOrClosure, string $as, string $condition): self
116		{
117	1	return $this->join($dataSourceOrClosure, $as, $condition, JoinType::LEFT);
118		}
119
120		/**
121		* @param string\|DataSourceInterface\|\Closure $dataSourceOrClosure
122		* @param string $as
123		* @param string $condition
124		*
125		* @return self
126		*/
127	1	public function innerJoin($dataSourceOrClosure, string $as, string $condition): self
128		{
129	1	return $this->join($dataSourceOrClosure, $as, $condition);
130		}
131
132		/**
133		* Inline datasources allow you to query a small amount of data that is embedded in the query itself.
134		* They are useful when you want to write a query on a small amount of data without loading it first.
135		* They are also useful as inputs into a join.
136		*
137		* Each row is an array that must be exactly as long as the list of columnNames. The first element in
138		* each row corresponds to the first column in columnNames, and so on.
139		*
140		* @param string[] $columnNames
141		* @param array<scalar[]> $rows
142		*/
143	1	public function fromInline(array $columnNames, array $rows): self
144		{
145	1	$this->dataSource = new InlineDataSource($columnNames, $rows);
146
147	1	return $this;
148		}
149
150		/**
151		* Unions allow you to treat two or more tables as a single datasource.
152		*
153		* With the native union datasource, the tables do not need to have identical schemas. If they do not
154		* fully match up, then columns that exist in one table but not another will be treated as if they contained all
155		* null values in the tables where they do not exist.
156		*
157		* @param string\|string[] $dataSources
158		* @param bool $append When true, we will append the current used dataSource in the union.
159		*
160		* @return $this
161		* @see https://druid.apache.org/docs/latest/querying/datasource.html#union
162		*/
163	3	public function union($dataSources, bool $append = true): self
164		{
165	3	$dataSources = (array)$dataSources;
166
167	3	if ($append) {
168	2	if (!$this->dataSource instanceof TableDataSource) {
169	1	throw new InvalidArgumentException('We can only union an table dataSource! You currently are using a ' . get_class($this->dataSource));
170		}
171
172	1	$dataSources[] = $this->dataSource->dataSourceName;
		0 ignored issues – show Bug introduced 2022-07-13 11:40 UTC by Report Bug Copy Issue Report Accessing `dataSourceName` on the interface `Level23\Druid\DataSources\DataSourceInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
173		}
174
175	2	$this->dataSource = new UnionDataSource($dataSources);
176
177	2	return $this;
178		}
179
180		/**
181		* @param string\|DataSourceInterface\|\Closure $dataSourceOrClosure
182		*
183		* @return DataSourceInterface
184		* @throws InvalidArgumentException
185		*/
186	4	protected function getDataSource($dataSourceOrClosure)
187		{
188	4	if (is_string($dataSourceOrClosure)) {
189	1	return new TableDataSource($dataSourceOrClosure);
190	3	} elseif ($dataSourceOrClosure instanceof DataSourceInterface) {
191	1	return $dataSourceOrClosure;
192	2	} elseif ($dataSourceOrClosure instanceof Closure) {
		0 ignored issues – show introduced 2022-07-13 11:40 UTC by Report Bug Copy Issue Report `$dataSourceOrClosure` is always a sub-type of `Closure`. Loading history...
193
194	1	$builder = new QueryBuilder($this->client);
195	1	call_user_func($dataSourceOrClosure, $builder);
196
197	1	return new QueryDataSource($builder->getQuery());
198		} else {
199	1	throw new InvalidArgumentException(
200		'Invalid dataSource given! This can either be a string (dataSource name), ' .
201		'an object which implements the DataSourceInterface, or a Closure function which allows ' .
202		'you to build a sub-query.'
203		);
204		}
205		}
206		}

level23 / druid-client

Pull Request — master (#38)

HasDataSource::getDataSource() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like