#24 rename package to `roave/backward-compatibility-check` #50

Ocramius · 2018-04-27T11:28:04Z

Fixes #24

…Roave\ApiCompare\DetectChanges\BCBreak`

… `__invoke` The verb is already on the class name This also has the nice side-effect that all `BCBreak` detectors are now composible functions 👍

…d with an empty `Changes`, avoid merging

…red approach

…, which is type-safe

…d do

…ges::empty()`

…fter renames)

… empty set of changes is given

…ved for shell built-ins misuse

…bility`

…e command

Ocramius · 2018-04-27T11:34:42Z

.travis.yml

@@ -34,6 +34,10 @@ jobs:
      php: 7.2
      script: vendor/bin/infection

+    - stage: Verify BC Breaks
+      php: 7.2
+      script: bin/roave-backward-compatibility-check --from=master --to=HEAD


Note: this will fail for now, as this patch does indeed lead to BC breaks (namespace changes)

Ocramius · 2018-04-27T11:35:42Z

README.md

@@ -1,66 +1,54 @@
-# API Compare Tool
+# Roave Backward Compatibility Check


Overall, I aimed at a few things:

cut to the point in the docs

moved docs for the CLI command into the CLI command itself

made the roave bit obnoxiously repetitive: I like throwing free time at OSS, but people can indeed type roave a few times.

Ocramius · 2018-04-27T11:36:45Z

src/Changes.php

-        $instance          = self::new();
-        $instance->changes = $changes;
-        return $instance;
+        if ($empty) {


I found (via Kcachegrind) that this was really trashing memory and CPU on this side (together with fromArray() and mergeWith())

Ocramius · 2018-04-27T11:38:10Z

src/Changes.php

-        $new            = clone $this;
-        $new->changes[] = $change;
-        return $new;
+        if (! $other->changes) {


Looked useless at first, but saves us from loads of instantiations

Ocramius · 2018-04-27T11:39:12Z

src/DetectChanges/BCBreak/MethodBased/MethodBased.php

+
+interface MethodBased
+{
+    public function __invoke(ReflectionMethod $fromMethod, ReflectionMethod $toMethod) : Changes;


All checkers are now functional interfaces - didn't like the repeated name, nor the compare() wording, and settled with using just the wording from the class name

asgrim · 2018-04-27T11:35:39Z

.travis.yml

@@ -34,6 +34,10 @@ jobs:
      php: 7.2
      script: vendor/bin/infection

+    - stage: Verify BC Breaks
+      php: 7.2
+      script: bin/roave-backward-compatibility-check --from=master --to=HEAD


Note: this also therefore fixes #26

asgrim · 2018-04-27T12:07:25Z

Build failures were due to BC breaks indeed, so merging.

Ocramius added 20 commits April 27, 2018 10:43

#24 renamed package to roave/backward-compatibility-check

96586a9

#24 renamed Roave\ApiCompare\Comparator\BackwardsCompatibility to `…

e119e62

…Roave\ApiCompare\DetectChanges\BCBreak`

#24 renamed all compare() methods on all BC break detectors to just…

62eeb33

… `__invoke` The verb is already on the class name This also has the nice side-effect that all `BCBreak` detectors are now composible functions 👍

#24 renamed Changes::new() to Changes::empty()

4ead51c

#24 minor performance optimisation: if Changes#mergeWith() is merge…

2bca1ac

…d with an empty `Changes`, avoid merging

#24 removed Changes#withAddedChange(), as mergeWith is the prefer…

ecd9ed9

…red approach

#24 renamed Changes::fromArray() in favour of Changes::fromList()…

b416323

…, which is type-safe

#24 avoid greedy usage of array_merge() where a splat operator woul…

d59ee07

…d do

#24 performance/memory optimisation: avoid trashing memory with `Chan…

4c4ba88

…ges::empty()`

#24 corrected exclude-pattern entries in the phpcs config (forgot a…

692de1d

…fter renames)

#24 verifying that Changes#mergeWith() avoids copy-on-write when an…

9c0053b

… empty set of changes is given

#24 changed command name and description

ef30d0b

#24 renamed command class to match command name

fb19272

#24 using 1 as exit code for failed checks - exit code 2 is reser…

9e897d1

…ved for shell built-ins misuse

#24 renamed package from Roave\ApiCompare to `Roave\BackwardCompati…

ba589c2

…bility`

#24 added binary to composer binary paths

c7f98d8

#24 added BC verification to the travis build

4f95a2c

#24 added a success/failure message at the end of the execution of th…

2dcfd7f

…e command

#24 improved CLI command documentation by dcumenting all options

e539096

#24 moved most docs to the CLI command itself: --help is our friend!

2c8fe42

Ocramius added the enhancement label Apr 27, 2018

Ocramius added this to the 0.0.1 milestone Apr 27, 2018

Ocramius assigned asgrim Apr 27, 2018

Ocramius commented Apr 27, 2018

View reviewed changes

#24 using exit code 3 instead of 1 for when BC breaks are detected

ea02a5d

asgrim approved these changes Apr 27, 2018

View reviewed changes

asgrim merged commit 4b9138b into master Apr 27, 2018

asgrim deleted the feature/#24-rename-package branch April 27, 2018 12:07

This was referenced Apr 27, 2018

Run the bin/api-compare script in the CI build #26

Closed

Colourise Symfony\Console text output #16

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#24 rename package to `roave/backward-compatibility-check` #50

#24 rename package to `roave/backward-compatibility-check` #50

Ocramius commented Apr 27, 2018

Ocramius Apr 27, 2018

Ocramius Apr 27, 2018

Ocramius Apr 27, 2018

Ocramius Apr 27, 2018

Ocramius Apr 27, 2018

asgrim Apr 27, 2018

asgrim commented Apr 27, 2018

		@@ -1,66 +1,54 @@
		# API Compare Tool
		# Roave Backward Compatibility Check

#24 rename package to roave/backward-compatibility-check #50

#24 rename package to roave/backward-compatibility-check #50

Conversation

Ocramius commented Apr 27, 2018

Ocramius Apr 27, 2018

Choose a reason for hiding this comment

Ocramius Apr 27, 2018

Choose a reason for hiding this comment

Ocramius Apr 27, 2018

Choose a reason for hiding this comment

Ocramius Apr 27, 2018

Choose a reason for hiding this comment

Ocramius Apr 27, 2018

Choose a reason for hiding this comment

asgrim Apr 27, 2018

Choose a reason for hiding this comment

asgrim commented Apr 27, 2018

#24 rename package to `roave/backward-compatibility-check` #50

#24 rename package to `roave/backward-compatibility-check` #50