Major refactoring performed

Author: remorhaz

.travis.yml

@@ -1,17 +1,24 @@
 language: php
 
-php:
-  - '7.1'
-  - '7.2'
-  - '7.3'
+matrix:
+  include:
+    - php: '7.3'
+      env: XDEBUG=YES
+    - php: '7.4snapshot'
+      env: XDEBUG=NO
 
-before_script:
+install:
+  - mkdir -p ./build/logs
   - composer self-update
   - composer install --prefer-source --no-interaction
+  - vendor/bin/phing
 
-script: vendor/bin/phpunit --coverage-clover=build/logs/clover.xml --coverage-xml=build/logs/coverage-xml --log-junit=build/logs/phpunit.junit.xml
+script:
+  - vendor/bin/phpcs -sp --report-junit=build/logs/phpcs.xml
+  - if [ "$XDEBUG" == "YES" ]; then vendor/bin/phpunit --coverage-clover=build/logs/clover.xml --coverage-xml=build/logs/coverage-xml --log-junit=build/logs/phpunit.junit.xml; else vendor/bin/phpunit; fi
+  - if [ "$XDEBUG" == "YES" ]; then vendor/bin/infection --coverage=build/logs --threads=4  --no-progress; fi
 
 after_success:
-  - bash <(curl -s https://codecov.io/bash -s "build/logs")
-  - wget https://scrutinizer-ci.com/ocular.phar
-  - php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
+  - if [ "$XDEBUG" == "YES" ]; then bash <(curl -s https://codecov.io/bash -s "build/logs"); fi
+  - if [ "$XDEBUG" == "YES" ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [ "$XDEBUG" == "YES" ]; then php ocular.phar code-coverage:upload --access-token=$SCRUTINIZER_TOKEN --format=php-clover build/logs/clover.xml; fi

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Implementation totally refactored.

README.md

@@ -9,15 +9,8 @@
 This library implements [RFC6902](https://tools.ietf.org/html/rfc6902)-compliant JSON patch tool.
 
 ## Requirements
-* PHP 7.1+
-
-## Features
-* Supports PHP 7.1
-* No PHP extensions required
-* Throws SPL exceptions
-
-# License
-PHP JSON Patch is licensed under MIT license.
+- PHP 7.3+
+- [Internationalization functions](https://www.php.net/manual/en/book.intl.php) (ext-intl) - required by [`remorhaz/php-json-data`](https://github.com/remorhaz/php-json-data) to compare Unicode strings.
 
 # Installation
 You will need [composer](https://getcomposer.org) to perform install.
@@ -48,7 +41,7 @@ To apply JSON Patch to the JSON document you need just 4 simple steps:
 
 use Remorhaz\JSON\Data\Reference\Selector;
 use Remorhaz\JSON\Data\Reference\Writer;
-use Remorhaz\JSON\Patch\Patch;
+use Remorhaz\JSON\Patch\Processor\Processor;
 
 // Setting up document.
 $data = (object) ['a' => (object) ['b' => 'c', 'd' => 'e']];
@@ -61,4 +54,8 @@ $patchData = [
 $patchSelector = new Selector($patchData);
 
 // Applying the patch.
-(new Patch($dataWriter))->apply($patchSelector); // $data->a->f property is added and set to 'g'
+(new Processor($dataWriter))->apply($patchSelector); // $data->a->f property is added and set to 'g'
+```
+
+# License
+PHP JSON Patch is licensed under MIT license.

composer.json

@@ -1,7 +1,11 @@
 {
   "name": "remorhaz/php-json-patch",
   "description": "JSON Patch (RFC-6902) PHP implementation",
-  "keywords": ["json", "json patch", "RFC6902"],
+  "keywords": [
+    "json",
+    "json patch",
+    "RFC6902"
+  ],
   "homepage": "https://github.com/remorhaz/php-json-patch",
   "license": "MIT",
   "authors": [
@@ -13,12 +17,14 @@
   ],
   "require": {
     "php": "^7.3",
+    "ext-intl": "*",
     "remorhaz/php-json-data": "^0.5.2",
-    "remorhaz/php-json-pointer": "^0.6.0"
+    "remorhaz/php-json-pointer": "dev-master"
   },
   "require-dev": {
     "phpunit/phpunit": "^8.4.3",
-    "infection/infection": "^0.14.2"
+    "infection/infection": "^0.14.2",
+    "squizlabs/php_codesniffer": "^3.5.2"
   },
   "autoload": {
     "psr-4": {
@@ -29,5 +35,18 @@
     "psr-4": {
       "Remorhaz\\JSON\\Test\\Patch\\": "tests/"
     }
+  },
+  "scripts": {
+    "phpcs": [
+      "vendor/bin/phpcs"
+    ],
+    "test": [
+      "vendor/bin/phpunit --coverage-xml=build/log/coverage-xml --log-junit=build/log/phpunit.junit.xml"
+    ],
+    "infection": [
+      "@test",
+      "mkdir -p build/log/infection",
+      "vendor/bin/infection --threads=4 --coverage=build/log --no-progress"
+    ]
   }
 }

docker-compose.yml

@@ -8,3 +8,10 @@ services:
     volumes:
       - .:/app
     working_dir: /app
+  php-7.4:
+    build:
+      context: .
+      dockerfile: php-7.4.Dockerfile
+    volumes:
+      - .:/app
+    working_dir: /app

infection.json.dist

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "directories": [
+      "src"
+    ]
+  },
+  "timeout": 10,
+  "logs": {
+    "text": "build/logs/infection/infection.log",
+    "summary": "build/logs/infection/summary.log",
+    "perMutator": "build/logs/infection/per-mutator.md",
+    "badge": {
+      "branch": "master"
+    }
+  }
+}

php-7.4.Dockerfile

@@ -0,0 +1,16 @@
+FROM php:7.4-rc-cli
+
+RUN apt-get update &&  apt-get install -y \
+    zip \
+    git \
+    libicu-dev && \
+    pecl install xdebug && \
+    docker-php-ext-enable xdebug && \
+    docker-php-ext-configure intl --enable-intl && \
+    docker-php-ext-install intl
+
+ENV COMPOSER_ALLOW_SUPERUSER=1 \
+    COMPOSER_PROCESS_TIMEOUT=1200
+
+RUN curl --silent --show-error https://getcomposer.org/installer | php -- \
+    --install-dir=/usr/bin --filename=composer

phpcs.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<ruleset name="PHP JSONPath">
+    <description>The coding standards for PHP JSONPath library.</description>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <arg name="colors"/>
+
+    <rule ref="PSR2">
+    </rule>
+
+    <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
+        <exclude-pattern>*/tests/*Test.php</exclude-pattern>
+    </rule>
+</ruleset>

phpunit.xml

@@ -1,20 +1,19 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <phpunit
-    bootstrap="vendor/autoload.php"
-    colors="true">
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.4/phpunit.xsd"
+        forceCoversAnnotation="true"
+        colors="true"
+        defaultTestSuite="unit">
     <testsuites>
-        <testsuite name="Full Test Suite">
+        <testsuite name="unit">
             <directory>tests/</directory>
         </testsuite>
     </testsuites>
     <filter>
         <whitelist
-            addUncoveredFilesFromWhitelist="true"
-            processUncoveredFilesFromWhitelist="true">
+                processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">src/</directory>
         </whitelist>
     </filter>
-    <logging>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
 </phpunit>

src/Exception/ExceptionInterface.php

@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace Remorhaz\JSON\Patch\Exception;
+
+use Throwable;
+
+interface ExceptionInterface extends Throwable
+{
+}

src/Operation/AddOperation.php

@@ -0,0 +1,35 @@
+<?php
+declare(strict_types=1);
+
+namespace Remorhaz\JSON\Patch\Operation;
+
+use Remorhaz\JSON\Data\Value\NodeValueInterface;
+use Remorhaz\JSON\Pointer\Processor\ProcessorInterface as PointerProcessorInterface;
+use Remorhaz\JSON\Pointer\Query\QueryInterface as PointerQueryInterface;
+
+final class AddOperation implements OperationInterface
+{
+
+    private $index;
+
+    private $pathPointer;
+
+    private $value;
+
+    public function __construct(
+        int $index,
+        PointerQueryInterface $pathPointer,
+        NodeValueInterface $value
+    ) {
+        $this->index = $index;
+        $this->pathPointer = $pathPointer;
+        $this->value = $value;
+    }
+
+    public function apply(NodeValueInterface $input, PointerProcessorInterface $pointerProcessor): NodeValueInterface
+    {
+        return $pointerProcessor
+            ->add($this->pathPointer, $input, $this->value)
+            ->get();
+    }
+}

src/Operation/CopyOperation.php

@@ -0,0 +1,37 @@
+<?php
+declare(strict_types=1);
+
+namespace Remorhaz\JSON\Patch\Operation;
+
+use Remorhaz\JSON\Data\Value\NodeValueInterface;
+use Remorhaz\JSON\Pointer\Processor\ProcessorInterface as PointerProcessorInterface;
+use Remorhaz\JSON\Pointer\Query\QueryInterface as PointerQueryInterface;
+
+final class CopyOperation implements OperationInterface
+{
+
+    private $index;
+
+    private $pathPointer;
+
+    private $fromPointer;
+
+    public function __construct(
+        int $index,
+        PointerQueryInterface $pathPointer,
+        PointerQueryInterface $fromPointer
+    ) {
+        $this->index = $index;
+        $this->pathPointer = $pathPointer;
+        $this->fromPointer = $fromPointer;
+    }
+
+    public function apply(NodeValueInterface $input, PointerProcessorInterface $pointerProcessor): NodeValueInterface
+    {
+        $selectResult = $pointerProcessor->select($this->fromPointer, $input);
+
+        return $pointerProcessor
+            ->add($this->pathPointer, $input, $selectResult->get())
+            ->get();
+    }
+}

src/Operation/Exception/ExceptionInterface.php

@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace Remorhaz\JSON\Patch\Operation\Exception;
+
+use Remorhaz\JSON\Patch\Exception\ExceptionInterface as PatchExceptionInterface;
+
+interface ExceptionInterface extends PatchExceptionInterface
+{
+}

src/Operation/Exception/InvalidOperationCodeException.php

@@ -0,0 +1,36 @@
+<?php
+declare(strict_types=1);
+
+namespace Remorhaz\JSON\Patch\Operation\Exception;
+
+use Throwable;
+use UnexpectedValueException;
+
+final class InvalidOperationCodeException extends UnexpectedValueException implements ExceptionInterface
+{
+
+    private $index;
+
+    private $operationCode;
+
+    public function __construct(int $index, $operationCode, Throwable $previous = null)
+    {
+        $this->index = $index;
+        $this->operationCode = $operationCode;
+        parent::__construct(
+            "Operation #{$this->index}: operation code in 'op' property must be a string",
+            0,
+            $previous
+        );
+    }
+
+    public function getIndex(): int
+    {
+        return $this->index;
+    }
+
+    public function getOperationCode()
+    {
+        return $this->operationCode;
+    }
+}

src/Operation/Exception/InvalidPathException.php

@@ -0,0 +1,44 @@
+<?php
+declare(strict_types=1);
+
+namespace Remorhaz\JSON\Patch\Operation\Exception;
+
+use Throwable;
+use UnexpectedValueException;
+
+final class InvalidPathException extends UnexpectedValueException implements ExceptionInterface
+{
+
+    private $index;
+
+    private $property;
+
+    private $path;
+
+    public function __construct(int $index, string $property, $path, Throwable $previous = null)
+    {
+        $this->index = $index;
+        $this->property = $property;
+        $this->path = $path;
+        parent::__construct(
+            "Operation #{$this->index}: JSON pointer in '{$this->property}' property must be a string",
+            0,
+            $previous
+        );
+    }
+
+    public function getIndex(): int
+    {
+        return $this->index;
+    }
+
+    public function getProperty(): string
+    {
+        return $this->property;
+    }
+
+    public function getPath()
+    {
+        return $this->path;
+    }
+}