Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update collector keys #826

Merged
merged 1 commit into from
Apr 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
115 changes: 111 additions & 4 deletions baseline.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,123 @@
<code>isset($classLikeNode-&gt;namespacedName)</code>
</RedundantConditionGivenDocblockType>
</file>
<file src="src/Collector/ClassNameCollector.php">
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'ClassNameCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/ClassNameRegexCollector.php">
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'ClassNameRegexCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/DirectoryCollector.php">
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'ClassNameCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/ExtendsCollector.php">
<MixedAssignment occurrences="1">
<code>$configuration['value']</code>
</MixedAssignment>
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'ExtendsCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/FunctionNameCollector.php">
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'FunctionNameCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/ImplementsCollector.php">
<MixedAssignment occurrences="1">
<code>$configuration['value']</code>
</MixedAssignment>
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'ImplementsCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/InheritanceLevelCollector.php">
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'InheritanceLevelCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/InheritsCollector.php">
<MixedAssignment occurrences="1">
<code>$configuration['value']</code>
</MixedAssignment>
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'InheritsCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/LayerCollector.php">
<PossiblyUndefinedArrayOffset occurrences="1">
<code>$configuration['value']</code>
</PossiblyUndefinedArrayOffset>
<TooManyArguments occurrences="2">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'LayerCollector should use the "value" key from this version')</code>
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'LayerCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="2">
<code>trigger_deprecation</code>
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/MethodCollector.php">
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'MethodCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/SuperglobalCollector.php">
<RedundantCastGivenDocblockType occurrences="1">
<code>(string) $name</code>
</RedundantCastGivenDocblockType>
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'SuperglobalCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Collector/UsesCollector.php">
<MixedAssignment occurrences="1">
<code>$configuration['value']</code>
</MixedAssignment>
<TooManyArguments occurrences="1">
<code>trigger_deprecation('qossmic/deptrac', '0.20.0', 'UsesCollector should use the "value" key from this version')</code>
</TooManyArguments>
<UnusedFunctionCall occurrences="1">
<code>trigger_deprecation</code>
</UnusedFunctionCall>
</file>
<file src="src/Configuration/Configuration.php">
<MixedPropertyTypeCoercion occurrences="2">
<code>(array) $options['exclude_files']</code>
<code>(array) $options['formatters']</code>
</MixedPropertyTypeCoercion>
<RedundantCastGivenDocblockType occurrences="2">
<code>(array) $rules</code>
<code>(bool) $options['ignore_uncovered_internal_classes']</code>
Expand Down
30 changes: 15 additions & 15 deletions docs/collectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ parameters:
- type: bool
must:
- type: className
regex: .*Foo\\.*
value: .*Foo\\.*
- type: className
regex: .*\\Asset.*
value: .*\\Asset.*
must_not:
- type: className
regex: .*Assetic.*
value: .*Assetic.*
```

Every class contains `Foo\` AND `\Asset` and NOT `Assetic`, will become a part
Expand All @@ -39,7 +39,7 @@ parameters:
- name: Controller
collectors:
- type: className
regex: .*Controller.*
value: .*Controller.*
```

Every class name that matches the regular expression becomes a part of the
Expand All @@ -58,7 +58,7 @@ parameters:
- name: Controller
collectors:
- type: classNameRegex
regex: '#.*Controller.*#'
value: '#.*Controller.*#'
```

Every class name that matches the regular expression becomes a part of the
Expand All @@ -76,7 +76,7 @@ parameters:
- name: Controller
collectors:
- type: directory
regex: src/Controller/.*
value: src/Controller/.*
```

Every file path that matches the regular expression `src/Controller/.*` becomes
Expand All @@ -94,7 +94,7 @@ parameters:
- name: Foo
collectors:
- type: extends
extends: 'App\SomeClass'
value: 'App\SomeClass'
```

## `functionName` Collector
Expand All @@ -109,7 +109,7 @@ parameters:
- name: Foo
collectors:
- type: functionName
regex: .*array_.*
value: .*array_.*
```

## `implements` Collector
Expand All @@ -123,7 +123,7 @@ parameters:
- name: Foo
collectors:
- type: implements
implements: 'App\SomeInterface'
value: 'App\SomeInterface'
```

## `inherits` Collector
Expand All @@ -138,7 +138,7 @@ parameters:
- name: Foo
collectors:
- type: inherits
inherits: 'App\SomeInterface'
value: 'App\SomeInterface'
```

## `layer` Collector
Expand All @@ -154,13 +154,13 @@ parameters:
- name: SubDomain
collectors:
- type: directory
regex: src/Domain/Subdomain/.*
value: src/Domain/Subdomain/.*
- name: Domain
collectors:
- type: bool
must:
- type: directory
regex: src/Domain/.*
value: src/Domain/.*
must_not:
- type: layer
layer: SubDomain
Expand All @@ -177,7 +177,7 @@ parameters:
- name: Foo services
collectors:
- type: method
name: .*foo
value: .*foo
```

Every class having a method that matches the regular expression `.*foo`,
Expand All @@ -194,7 +194,7 @@ parameters:
- name: Foo
collectors:
- type: superglobal
names:
value:
- _POST
- _GET
```
Expand All @@ -210,7 +210,7 @@ parameters:
- name: Foo
collectors:
- type: uses
uses: 'App\SomeTrait'
value: 'App\SomeTrait'
```

## Custom Collectors
Expand Down
10 changes: 5 additions & 5 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ parameters:
collectors:
-
type: className
regex: .*MyNamespace\\Models\\.*
value: .*MyNamespace\\Models\\.*
-
name: Controller
collectors:
-
type: className
regex: .*MyNamespace\\.*Controller.*
value: .*MyNamespace\\.*Controller.*
ruleset: [ ]
```

Expand Down Expand Up @@ -142,19 +142,19 @@ parameters:
collectors:
-
type: className
regex: .*MyNamespace\\.*Controller.*
value: .*MyNamespace\\.*Controller.*
-
name: Repository
collectors:
-
type: className
regex: .*MyNamespace\\.*Repository.*
value: .*MyNamespace\\.*Repository.*
-
name: Service
collectors:
-
type: className
regex: .*MyNamespace\\.*Service.*
value: .*MyNamespace\\.*Service.*
ruleset:
Controller:
- Service
Expand Down
4 changes: 2 additions & 2 deletions docs/depfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ parameters:
collectors:
-
type: className
regex: .*Controller.*
value: .*Controller.*
```

#### `name`
Expand Down Expand Up @@ -271,5 +271,5 @@ parameters:
collectors:
-
type: implements
implements: '%Project%\SomeInterface'
value: '%Project%\SomeInterface'
```
6 changes: 3 additions & 3 deletions docs/examples/ControllerServiceRepository1.depfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ parameters:
- name: Controller
collectors:
- type: className
regex: .*MyNamespace\\.*Controller.*
value: .*MyNamespace\\.*Controller.*
- name: Repository
collectors:
- type: className
regex: .*MyNamespace\\.*Repository.*
value: .*MyNamespace\\.*Repository.*
- name: Service
collectors:
- type: className
regex: .*MyNamespace\\.*Service.*
value: .*MyNamespace\\.*Service.*
ruleset:
Controller:
- Service
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/DirectoryLayer.depfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ parameters:
- name: Controller
collectors:
- type: className
regex: .*Controller.*
value: .*Controller.*
- name: Layer1
collectors:
- type: directory
regex: ./examples/Layer1/.*
value: ./examples/Layer1/.*
- name: Layer2
collectors:
- type: directory
regex: ./examples/Layer2/.*
value: ./examples/Layer2/.*
ruleset:
Controller:
- Layer1
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/Fixture.depfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ parameters:
- name: Models
collectors:
- type: className
regex: .*MyNamespace\\Models\\.*
value: .*MyNamespace\\Models\\.*
- name: Controller
collectors:
- type: className
regex: .*MyNamespace\\.*Controller.*
value: .*MyNamespace\\.*Controller.*
ruleset: []
4 changes: 2 additions & 2 deletions docs/examples/MethodNames1.depfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ parameters:
- name: SomeA
collectors:
- type: method
name: SomeA
value: SomeA
- name: SomeB
collectors:
- type: method
name: SomeB
value: SomeB
ruleset: []
4 changes: 2 additions & 2 deletions docs/examples/ModelController1.depfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ parameters:
- name: Models
collectors:
- type: className
regex: .*MyNamespace\\Models\\.*
value: .*MyNamespace\\Models\\.*
- name: Controller
collectors:
- type: className
regex: .*MyNamespace\\.*Controller.*
value: .*MyNamespace\\.*Controller.*
ruleset: []
4 changes: 2 additions & 2 deletions docs/examples/ModelController2.depfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ parameters:
- name: Models
collectors:
- type: className
regex: .*MyNamespace\\Models\\.*
value: .*MyNamespace\\Models\\.*
- name: Controller
collectors:
- type: className
regex: .*MyNamespace\\.*Controller.*
value: .*MyNamespace\\.*Controller.*
ruleset: []