CS Fix

dvdoug · Sep 10, 2022 · eca8d7b · eca8d7b
1 parent 13079d4
commit eca8d7b
Show file tree

Hide file tree

Showing 34 changed files with 117 additions and 68 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -29,6 +29,9 @@
  'separate' => 'none',
  'header' => "Box packing (3D bin packing, knapsack problem).\n\n@author Doug Wright",
  ],
+ 'phpdoc_line_span' => true,
+ 'phpdoc_to_comment' => false,
+ 'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'none'],
  ]
 )
  ->setRiskyAllowed(true)

diff --git a/features/bootstrap/InfalliblePackerContext.php b/features/bootstrap/InfalliblePackerContext.php
@@ -16,10 +16,14 @@
  */
 class InfalliblePackerContext extends PackerContext
 {
- /** @var string */
+ /**
+ * @var string
+ */
  protected $packerClass = InfalliblePacker::class;
 
- /** @var ItemList */
+ /**
+ * @var ItemList
+ */
  protected $unpackedItemList;
 
  /**

diff --git a/features/bootstrap/PackerContext.php b/features/bootstrap/PackerContext.php
@@ -26,22 +26,34 @@
  */
 class PackerContext implements Context
 {
- /** @var Box */
+ /**
+ * @var Box
+ */
  protected $box;
 
- /** @var BoxList */
+ /**
+ * @var BoxList
+ */
  protected $boxList;
 
- /** @var ItemList */
+ /**
+ * @var ItemList
+ */
  protected $itemList;
 
- /** @var PackedBox */
+ /**
+ * @var PackedBox
+ */
  protected $packedBox;
 
- /** @var PackedBoxList */
+ /**
+ * @var PackedBoxList
+ */
  protected $packedBoxList;
 
- /** @var string */
+ /**
+ * @var string
+ */
  protected $packerClass = Packer::class;
 
  /**

diff --git a/src/BoxList.php b/src/BoxList.php
@@ -11,6 +11,7 @@
 use ArrayIterator;
 use IteratorAggregate;
 use Traversable;
+
 use function usort;
 
 /**
@@ -48,8 +49,6 @@ public function __construct(?BoxSorter $sorter = null)
  * Do a bulk create.
  *
  * @param Box[] $boxes
- *
- * @return BoxList
  */
  public static function fromArray(array $boxes, bool $preSorted = false): self
  {

diff --git a/src/ItemList.php b/src/ItemList.php
@@ -8,22 +8,24 @@
 
 namespace DVDoug\BoxPacker;
 
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Traversable;
+
 use function array_key_last;
 use function array_pop;
 use function array_reverse;
 use function array_slice;
-use ArrayIterator;
 use function count;
-use Countable;
 use function current;
 use function end;
-use IteratorAggregate;
 use function key;
-use const PHP_VERSION_ID;
 use function prev;
-use Traversable;
 use function usort;
 
+use const PHP_VERSION_ID;
+
 /**
  * List of items to be packed, ordered by volume.
  *
@@ -65,8 +67,7 @@ public function __construct(?ItemSorter $sorter = null)
  /**
  * Do a bulk create.
  *
- * @param Item[] $items
- * @return ItemList
+ * @param Item[] $items
  */
  public static function fromArray(array $items, bool $preSorted = false): self
  {
@@ -155,7 +156,6 @@ public function top(): Item
 
  /**
  * @internal
- * @return ItemList
  */
  public function topN(int $n): self
  {

diff --git a/src/LayerPacker.php b/src/LayerPacker.php
@@ -8,12 +8,13 @@
 
 namespace DVDoug\BoxPacker;
 
-use function array_merge;
-use function iterator_to_array;
-use function max;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+
+use function array_merge;
+use function iterator_to_array;
+use function max;
 use function sort;
 
 /**

diff --git a/src/NoBoxesAvailableException.php b/src/NoBoxesAvailableException.php
@@ -17,7 +17,9 @@
  */
 class NoBoxesAvailableException extends RuntimeException
 {
- /** @var Item */
+ /**
+ * @var Item
+ */
  public $item;
 
  /**

diff --git a/src/OrientatedItem.php b/src/OrientatedItem.php
@@ -8,10 +8,11 @@
 
 namespace DVDoug\BoxPacker;
 
-use function atan;
 use JsonSerializable;
-use function min;
 use ReturnTypeWillChange;
+
+use function atan;
+use function min;
 use function sort;
 
 /**

diff --git a/src/OrientatedItemFactory.php b/src/OrientatedItemFactory.php
@@ -8,11 +8,12 @@
 
 namespace DVDoug\BoxPacker;
 
-use function array_filter;
-use function count;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;
+
+use function array_filter;
+use function count;
 use function usort;
 
 /**
@@ -25,7 +26,9 @@ class OrientatedItemFactory implements LoggerAwareInterface
 {
  use LoggerAwareTrait;
 
- /** @var Box */
+ /**
+ * @var Box
+ */
  protected $box;
 
  /**

diff --git a/src/OrientatedItemSorter.php b/src/OrientatedItemSorter.php
@@ -8,11 +8,13 @@
 
 namespace DVDoug\BoxPacker;
 
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
+
 use function max;
 use function min;
+
 use const PHP_INT_MAX;
-use Psr\Log\LoggerAwareInterface;
-use Psr\Log\LoggerAwareTrait;
 
 /**
  * Figure out best choice of orientations for an item and a given context.

diff --git a/src/PackedBox.php b/src/PackedBox.php
@@ -8,10 +8,11 @@
 
 namespace DVDoug\BoxPacker;
 
-use function iterator_to_array;
 use JsonSerializable;
-use function max;
 use ReturnTypeWillChange;
+
+use function iterator_to_array;
+use function max;
 use function round;
 
 /**

diff --git a/src/PackedBoxList.php b/src/PackedBoxList.php
@@ -9,15 +9,16 @@
 namespace DVDoug\BoxPacker;
 
 use ArrayIterator;
-use function count;
 use Countable;
 use IteratorAggregate;
 use JsonSerializable;
-use function reset;
 use ReturnTypeWillChange;
-use function round;
 use Traversable;
 
+use function count;
+use function reset;
+use function round;
+
 /**
  * List of packed boxes.
  *

diff --git a/src/PackedItem.php b/src/PackedItem.php
@@ -107,9 +107,6 @@ public function getVolume(): int
  return $this->width * $this->length * $this->depth;
  }
 
- /**
- * @return PackedItem
- */
  public static function fromOrientatedItem(OrientatedItem $orientatedItem, int $x, int $y, int $z): self
  {
  return new static(

diff --git a/src/PackedItemList.php b/src/PackedItemList.php
@@ -8,12 +8,13 @@
 
 namespace DVDoug\BoxPacker;
 
-use function array_map;
 use ArrayIterator;
-use function count;
 use Countable;
 use IteratorAggregate;
 use Traversable;
+
+use function array_map;
+use function count;
 use function usort;
 
 /**

diff --git a/src/PackedLayer.php b/src/PackedLayer.php
@@ -10,6 +10,7 @@
 
 use function max;
 use function min;
+
 use const PHP_INT_MAX;
 
 /**

diff --git a/src/Packer.php b/src/Packer.php
@@ -8,16 +8,18 @@
 
 namespace DVDoug\BoxPacker;
 
-use function array_merge;
-use function count;
-use const PHP_INT_MAX;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\LogLevel;
 use Psr\Log\NullLogger;
 use SplObjectStorage;
+
+use function array_merge;
+use function count;
 use function usort;
 
+use const PHP_INT_MAX;
+
 /**
  * Actual packer.
  *

diff --git a/src/VolumePacker.php b/src/VolumePacker.php
@@ -8,12 +8,13 @@
 
 namespace DVDoug\BoxPacker;
 
-use function array_map;
-use function count;
-use function max;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+
+use function array_map;
+use function count;
+use function max;
 use function reset;
 use function usort;
 

diff --git a/src/WeightRedistributor.php b/src/WeightRedistributor.php
@@ -8,17 +8,18 @@
 
 namespace DVDoug\BoxPacker;
 
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
+use Psr\Log\LogLevel;
+use Psr\Log\NullLogger;
+use SplObjectStorage;
+
 use function array_filter;
 use function array_map;
 use function array_merge;
 use function array_sum;
 use function count;
 use function iterator_to_array;
-use Psr\Log\LoggerAwareInterface;
-use Psr\Log\LoggerAwareTrait;
-use Psr\Log\LogLevel;
-use Psr\Log\NullLogger;
-use SplObjectStorage;
 use function usort;
 
 /**

diff --git a/tests/BoxListTest.php b/tests/BoxListTest.php
@@ -9,9 +9,10 @@
 namespace DVDoug\BoxPacker;
 
 use DVDoug\BoxPacker\Test\TestBox;
-use function iterator_to_array;
 use PHPUnit\Framework\TestCase;
 
+use function iterator_to_array;
+
 /**
  * @covers \DVDoug\BoxPacker\BoxList
  */

diff --git a/tests/EfficiencyTest.php b/tests/EfficiencyTest.php
@@ -10,10 +10,11 @@
 
 use DVDoug\BoxPacker\Test\TestBox;
 use DVDoug\BoxPacker\Test\TestItem;
+use PHPUnit\Framework\TestCase;
+
 use function fclose;
 use function fgetcsv;
 use function fopen;
-use PHPUnit\Framework\TestCase;
 
 /**
  * @coversNothing

diff --git a/tests/InfalliblePackerTest.php b/tests/InfalliblePackerTest.php
@@ -11,9 +11,10 @@
 use DVDoug\BoxPacker\Test\LimitedSupplyTestBox;
 use DVDoug\BoxPacker\Test\TestBox;
 use DVDoug\BoxPacker\Test\TestItem;
-use function iterator_to_array;
 use PHPUnit\Framework\TestCase;
 
+use function iterator_to_array;
+
 class InfalliblePackerTest extends TestCase
 {
  public function testTooLargeItemsHandled(): void

diff --git a/tests/ItemListTest.php b/tests/ItemListTest.php
@@ -9,9 +9,10 @@
 namespace DVDoug\BoxPacker;
 
 use DVDoug\BoxPacker\Test\TestItem;
-use function iterator_to_array;
 use PHPUnit\Framework\TestCase;
 
+use function iterator_to_array;
+
 /**
  * @covers \DVDoug\BoxPacker\ItemList
  */