#242

Build # #242

Build Type

push

Committed by

Commit Message

<a href="https://github.com/bovigo/vfsStream/commit/<a class=hub.com/bovigo/vfsStream/commit/f7671993b375441b013a033d8f2d14d495aef382">f7671993b<a href="https://github.com/bovigo/vfsStream/commit/f7671993b375441b013a033d8f2d14d495aef382">">Merge </a><a class="double-link" href="https://github.com/bovigo/vfsStream/commit/<a class="double-link" href="https://github.com/bovigo/vfsStream/commit/53fbb704d96b725176b4dc5dc75e0a1ea6cbe4c7">53fbb704d</a>">53fbb704d</a><a href="https://github.com/bovigo/vfsStream/commit/f7671993b375441b013a033d8f2d14d495aef382"> into 7979e9dc7">7979e9dc7</a>

Run Details

379 of 379 new or added lines in 18 files covered. (100.0%)

821 of 888 relevant lines covered (92.45%)

65.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.27

/src/internal/OpenedFile.php

<?php

declare(strict_types=1);

/**
 * This file is part of vfsStream.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package  bovigo\vfs
 */

namespace bovigo\vfs\internal;

use bovigo\vfs\content\FileContent;
use bovigo\vfs\StreamWrapper;
use bovigo\vfs\vfsFile;
use bovigo\vfs\vfsStream;
use const SEEK_CUR;
use const SEEK_END;
use const SEEK_SET;
use function strlen;
use function time;

/**
 * Decorator for vfsFile to allow multiple instances of a file to be open.
 *
 * It works by tracking and restoring the position in the file for each specific
 * instance created, even though the underlying file is shared.
 *
 * @internal
 */
class OpenedFile implements FileHandle
{
    /** @var  vfsFile */
    private $file;
    /** @var  FileContent */
    private $content;
    /** @var int */
    private $offset = 0;
    /**
     * mode the file was opened with
     *
     * @var  int
     */
    private $mode;

    public function __construct(vfsFile $file, FileContent $content, int $mode)
    {
        $this->file = $file;
        $this->content = $content;
        $this->mode = $mode;
    }

    public static function append(vfsFile $file, FileContent $content, int $mode): self
    {
        $s = new OpenedFile($file, $content, $mode);
        $s->offset = $content->size();

        return $s;
    }

    /**
     * locks file
     *
     * @see     https://github.com/mikey179/vfsStream/issues/6
     * @see     https://github.com/mikey179/vfsStream/issues/40
     *
     * @param resource|StreamWrapper $resource
     */
    public function lock($resource, int $operation): bool
    {
        return $this->file->lock($resource, $operation);
    }

    public function size(): int
    {
        return $this->file->size();
    }

    /**
     * returns status of file
     *
     * @return int[]|false
     */
    public function stat()
    {
        return $this->file->stat();
    }

    /**
     * reads the given amount of bytes from content
     *
     * Using this method changes the time when the file was last accessed.
     */
    public function read(int $count): string
    {
        if ($this->mode === Mode::WRITEONLY) {
            return '';
        }

        if ($this->file->isReadable(vfsStream::getCurrentUser(), vfsStream::getCurrentGroup()) === false) {
            return '';
        }

        $this->file->lastAccessed(time());
        $data = $this->content->read($this->offset, $count);
        $this->offset += $count;

        return $data;
    }

    /**
     * writes an amount of data
     *
     * Using this method changes the time when the file was last modified.
     *
     * @return  int     amount of written bytes
     */
    public function write(string $data): int
    {
        if ($this->mode === Mode::READONLY) {
            return 0;
        }

        if ($this->file->isWritable(vfsStream::getCurrentUser(), vfsStream::getCurrentGroup()) === false) {
            return 0;
        }

        $this->file->lastModified(time());

        $dataLength = strlen($data);
        $this->content->write($data, $this->offset, $dataLength);
        $this->offset += $dataLength;

        return $dataLength;
    }

    /**
     * Truncates a file to a given length
     *
     * @param int $size length to truncate file to
     *
     * @since   1.1.0
     */
    public function truncate(int $size): bool
    {
        if ($this->mode === Mode::READONLY) {
            return false;
        }

        if ($this->file->isWritable(vfsStream::getCurrentUser(), vfsStream::getCurrentGroup()) === false) {
            return false;
        }

        if ($this->file->type() !== Type::FILE) {
            return false;
        }

        $this->content->truncate($size);
        $this->file->lastModified(time());

        return true;
    }

    /**
     * checks whether pointer is at end of file
     */
    public function eof(): bool
    {
        return $this->content->size() <= $this->offset;
    }

    /**
     * returns the current position within the file
     *
     * @internal  since 1.3.0
     */
    public function bytesRead(): int
    {
        return $this->offset;
    }

    /**
     * seeks to the given offset
     */
    public function seek(int $offset, int $whence): bool
    {
        $newOffset = $this->offset;
        switch ($whence) {
            case SEEK_CUR:
                $newOffset += $offset;
                break;

            case SEEK_END:
                $newOffset = $this->content->size() + $offset;
                break;

            case SEEK_SET:
                $newOffset = $offset;
                break;

            default:
                return false;
        }

        if ($newOffset < 0) {
            return false;
        }

        $this->offset = $newOffset;

        return true;
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* This file is part of vfsStream.
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*
11	* @package bovigo\vfs
12	*/
13
14	namespace bovigo\vfs\internal;
15
16	use bovigo\vfs\content\FileContent;
17	use bovigo\vfs\StreamWrapper;
18	use bovigo\vfs\vfsFile;
19	use bovigo\vfs\vfsStream;
20	use const SEEK_CUR;
21	use const SEEK_END;
22	use const SEEK_SET;
23	use function strlen;
24	use function time;
25
26	/**
27	* Decorator for vfsFile to allow multiple instances of a file to be open.
28	*
29	* It works by tracking and restoring the position in the file for each specific
30	* instance created, even though the underlying file is shared.
31	*
32	* @internal
33	*/
34	class OpenedFile implements FileHandle
35	{
36	/** @var vfsFile */
37	private $file;
38	/** @var FileContent */
39	private $content;
40	/** @var int */
41	private $offset = 0;
42	/**
43	* mode the file was opened with
44	*
45	* @var int
46	*/
47	private $mode;
48
49	public function __construct(vfsFile $file, FileContent $content, int $mode)
50	{
51	$this->file = $file;	132✔
52	$this->content = $content;	132✔
53	$this->mode = $mode;	132✔
54	}	132✔
55
56	public static function append(vfsFile $file, FileContent $content, int $mode): self
57	{
58	$s = new OpenedFile($file, $content, $mode);	7✔
59	$s->offset = $content->size();	7✔
60
61	return $s;	7✔
62	}
63
64	/**
65	* locks file
66	*
67	* @see https://github.com/mikey179/vfsStream/issues/6
68	* @see https://github.com/mikey179/vfsStream/issues/40
69	*
70	* @param resource\|StreamWrapper $resource
71	*/
72	public function lock($resource, int $operation): bool
73	{
74	return $this->file->lock($resource, $operation);	115✔
75	}
76
77	public function size(): int
78	{
79	return $this->file->size();	5✔
80	}
81
82	/**
83	* returns status of file
84	*
85	* @return int[]\|false
86	*/
87	public function stat()
88	{
89	return $this->file->stat();	26✔
90	}
91
92	/**
93	* reads the given amount of bytes from content
94	*
95	* Using this method changes the time when the file was last accessed.
96	*/
97	public function read(int $count): string
98	{
99	if ($this->mode === Mode::WRITEONLY) {	31✔
100	return '';	3✔
101	}
102
103	if ($this->file->isReadable(vfsStream::getCurrentUser(), vfsStream::getCurrentGroup()) === false) {	29✔
104	return '';	×
105	}
106
107	$this->file->lastAccessed(time());	29✔
108	$data = $this->content->read($this->offset, $count);	29✔
109	$this->offset += $count;	29✔
110
111	return $data;	29✔
112	}
113
114	/**
115	* writes an amount of data
116	*
117	* Using this method changes the time when the file was last modified.
118	*
119	* @return int amount of written bytes
120	*/
121	public function write(string $data): int
122	{
123	if ($this->mode === Mode::READONLY) {	39✔
124	return 0;	1✔
125	}
126
127	if ($this->file->isWritable(vfsStream::getCurrentUser(), vfsStream::getCurrentGroup()) === false) {	38✔
128	return 0;	×
129	}
130
131	$this->file->lastModified(time());	38✔
132
133	$dataLength = strlen($data);	38✔
134	$this->content->write($data, $this->offset, $dataLength);	38✔
135	$this->offset += $dataLength;	38✔
136
137	return $dataLength;	38✔
138	}
139
140	/**
141	* Truncates a file to a given length
142	*
143	* @param int $size length to truncate file to
144	*
145	* @since 1.1.0
146	*/
147	public function truncate(int $size): bool
148	{
149	if ($this->mode === Mode::READONLY) {	6✔
150	return false;	×
151	}
152
153	if ($this->file->isWritable(vfsStream::getCurrentUser(), vfsStream::getCurrentGroup()) === false) {	6✔
154	return false;	×
155	}
156
157	if ($this->file->type() !== Type::FILE) {	6✔
158	return false;	×
159	}
160
161	$this->content->truncate($size);	6✔
162	$this->file->lastModified(time());	6✔
163
164	return true;	6✔
165	}
166
167	/**
168	* checks whether pointer is at end of file
169	*/
170	public function eof(): bool
171	{
172	return $this->content->size() <= $this->offset;	52✔
173	}
174
175	/**
176	* returns the current position within the file
177	*
178	* @internal since 1.3.0
179	*/
180	public function bytesRead(): int
181	{
182	return $this->offset;	14✔
183	}
184
185	/**
186	* seeks to the given offset
187	*/
188	public function seek(int $offset, int $whence): bool
189	{
190	$newOffset = $this->offset;	16✔
191	switch ($whence) {	16✔
192	case SEEK_CUR:
193	$newOffset += $offset;	6✔
194	break;	6✔
195
196	case SEEK_END:
197	$newOffset = $this->content->size() + $offset;	2✔
198	break;	2✔
199
200	case SEEK_SET:
201	$newOffset = $offset;	9✔
202	break;	9✔
203
204	default:
205	return false;	×
206	}
207
208	if ($newOffset < 0) {	16✔
209	return false;	×
210	}
211
212	$this->offset = $newOffset;	16✔
213
214	return true;	16✔
215	}
216	}

bovigo / vfsStream / #242

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous