Tebru\Gson\Internal\JsonElementWriter

Complexity

Total Complexity

40

Size/Duplication

Total Lines	345
Duplicated Lines	16.23 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	beginArray()	13	13	2
A	endArray()	0	10	2
A	beginObject()	13	13	2
A	endObject()	0	10	2
A	name()	0	10	2
A	writeInteger()	0	8	2
A	writeFloat()	0	8	2
A	writeString()	0	8	2
A	writeBoolean()	0	8	2
A	writeNull()	17	17	4
A	setSerializeNull()	0	4	1
A	jsonSerialize()	0	8	2
A	toJsonElement()	0	4	1
A	last()	0	4	1
B	push()	13	23	5
A	pop()	0	5	1
A	topIsObjectStart()	0	8	3
A	topIsObject()	0	8	2
A	topIsArray()	0	8	2

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

namespace Tebru\Gson\Internal;

use BadMethodCallException;
use JsonSerializable;
use Tebru\Gson\Element\JsonArray;
use Tebru\Gson\Element\JsonElement;
use Tebru\Gson\Element\JsonNull;
use Tebru\Gson\Element\JsonObject;
use Tebru\Gson\Element\JsonPrimitive;
use Tebru\Gson\JsonWritable;

/**
 * Class JsonElementWriter
 *
 * @author Nate Brunette <n@tebru.net>
 */
final class JsonElementWriter implements JsonWritable, JsonSerializable
{
    /**
     * True if we should serialize nulls
     *
     * @var bool
     */
    private $serializeNull = false;

    /**
     * Stack of values to be written
     *
     * @var array
     */
    private $stack = [];
    
    /**
     * Size of the stack array
     *
     * @var int
     */
    private $stackSize = 0;

    /**
     * When serializing an object, store the name that should be serialized
     *
     * @var
     */
    private $pendingName;

    /**
     * The final result that will be json encoded
     *
     * @var JsonElement
     */
    private $result;

    /**
     * Begin writing array
     *
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function beginArray(): JsonWritable

This method seems to be duplicated in your project.

    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call beginArray() before name() during object serialization');
        }

        $array = new JsonArray();
        $this->push($array);
        $this->stack[] = $array;
        $this->stackSize++;

        return $this;
    }

    /**
     * End writing array
     *
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function endArray(): JsonWritable
    {
        if (!$this->topIsArray()) {
            throw new BadMethodCallException('Cannot call endArray() if not serializing array');
        }

        $this->pop();

        return $this;
    }

    /**
     * Begin writing object
     *
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function beginObject(): JsonWritable

This method seems to be duplicated in your project.

    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call beginObject() before name() during object serialization');
        }

        $class = new JsonObject();
        $this->push($class);
        $this->stack[] = $class;
        $this->stackSize++;

        return $this;
    }

    /**
     * End writing object
     *
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function endObject(): JsonWritable
    {
        if (!$this->topIsObject()) {
            throw new BadMethodCallException('Cannot call endObject() if not serializing object');
        }

        $this->pop();

        return $this;
    }

    /**
     * Writes a property name
     *
     * @param string $name
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function name(string $name): JsonWritable
    {
        if (!$this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call name() at this point.  Either name() has already been called or object serialization has not been started');
        }

        $this->pendingName = $name;

        return $this;
    }

    /**
     * Write an integer value
     *
     * @param int $value
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function writeInteger(int $value): JsonWritable
    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call writeInteger() before name() during object serialization');
        }

        return $this->push(JsonPrimitive::create($value));
    }

    /**
     * Write a float value
     *
     * @param float $value
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function writeFloat(float $value): JsonWritable
    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call writeFloat() before name() during object serialization');
        }

        return $this->push(JsonPrimitive::create($value));
    }

    /**
     * Write a string value
     *
     * @param string $value
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function writeString(string $value): JsonWritable
    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call writeString() before name() during object serialization');
        }

        return $this->push(JsonPrimitive::create($value));
    }

    /**
     * Write a boolean value
     *
     * @param boolean $value
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function writeBoolean(bool $value): JsonWritable
    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call writeBoolean() before name() during object serialization');
        }

        return $this->push(JsonPrimitive::create($value));
    }

    /**
     * Write a null value if we are serializing nulls, otherwise
     * skip the value.  If this is a property value, that property
     * should be skippped as well.
     *
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    public function writeNull(): JsonWritable

This method seems to be duplicated in your project.

    {
        if ($this->topIsObjectStart()) {
            throw new BadMethodCallException('Cannot call writeNull() before name() during object serialization');
        }

        if ($this->serializeNull) {
            return $this->push(new JsonNull());
        }

        // if we're not serializing nulls
        if (null !== $this->pendingName) {
            $this->pendingName = null;
        }

        return $this;
    }

    /**
     * Sets whether nulls are serialized
     *
     * @param bool $serializeNull
     */
    public function setSerializeNull(bool $serializeNull): void
    {
        $this->serializeNull = $serializeNull;
    }

    /**
     * Specify data which should be serialized to JSON
     *
     * @return mixed
     */
    public function jsonSerialize()
    {
        if (null === $this->result) {
            return null;
        }

        return $this->result->jsonSerialize();
    }

    /**
     * Get the result as a json element
     *
     * @return JsonElement
     */
    public function toJsonElement(): JsonElement
    {
        return $this->result;
    }

    /**
     * Get the last index of the stack
     *
     * @return int
     */
    private function last(): int
    {
        return $this->stackSize - 1;
    }

    /**
     * Push a value to the result or current array/object
     *
     * @param JsonElement $value
     * @return JsonWritable
     * @throws \BadMethodCallException
     */
    private function push(JsonElement $value): JsonWritable
    {
        if (0 === $this->stackSize) {

This code seems to be duplicated across your project.

            if (null !== $this->result) {
                throw new BadMethodCallException('Attempting to write two different types');
            }

            $this->result = $value;

            return $this;
        }

        if (null !== $this->pendingName) {

This code seems to be duplicated across your project.

            $this->stack[$this->last()]->add($this->pendingName, $value);
            $this->pendingName = null;
        }

        if ($this->topIsArray()) {
            $this->stack[$this->last()]->addJsonElement($value);
        }

        return $this;
    }

    /**
     * Remove the last element of the stack
     */
    private function pop(): void
    {
        array_splice($this->stack, $this->last(), 1);
        $this->stackSize--;
    }

    /**
     * Returns true if an object is the top element of the stack and we haven't called name() yet
     *
     * @return bool
     */
    private function topIsObjectStart(): bool
    {
        if (0 === $this->stackSize) {
            return false;
        }

        return $this->stack[$this->last()] instanceof JsonObject && null === $this->pendingName;
    }

    /**
     * Returns true if an object is the top element of the stack
     *
     * @return bool
     */
    private function topIsObject()
    {
        if (0 === $this->stackSize) {
            return false;
        }

        return $this->stack[$this->last()] instanceof JsonObject;
    }

    /**
     * Returns true if an array is the top element of the stack
     *
     * @return bool
     */
    private function topIsArray()
    {
        if (0 === $this->stackSize) {
            return false;
        }

        return $this->stack[$this->last()] instanceof JsonArray;
    }
}