Initial

Author: bjornvoesten

.gitignore

@@ -0,0 +1,7 @@
+.idea
+.vscode
+build
+composer.lock
+docs
+vendor
+coverage

.phpunit.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

.styleci.yml

@@ -0,0 +1 @@
+preset: laravel

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0
+
+### Added
+- Initial version
+

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Dutch Coding Company BV <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,99 @@
+# CSV Collection
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/dutchcodingcompany/csv-collection.svg?style=flat-square)](https://packagist.org/packages/dutchcodingcompany/csv-collection)
+[![Total Downloads](https://img.shields.io/packagist/dt/dutchcodingcompany/csv-collection.svg?style=flat-square)](https://packagist.org/packages/dutchcodingcompany/csv-collection)
+
+This package provides a simple but powerful way to read and write large CSV files using the power of Laravel's lazy
+collections.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require dutchcodingcompany/csv-collection
+```
+
+## Usage
+
+You may create a collection using the `new` keyword or the `make` method.
+
+```php 
+CsvCollection::make();
+```
+
+This gives you access to all [Collection](https://laravel.com/docs/8.x/collections#available-methods)
+and [Lazy Collection](https://laravel.com/docs/8.x/collections#lazy-collection-methods) methods.
+
+### Open
+
+To open a file and load it's content into a new collection you may use the `open` method on the collection.
+
+```php
+use DutchCodingCompany\CsvCollection\CsvCollection;
+
+CsvCollection::make()
+    ->open('path/to/file.csv')
+    ->count();
+```
+
+### Save
+
+To save the collection items to a file you may use the `save` method on the collection.
+
+```php
+use DutchCodingCompany\CsvCollection\CsvCollection;
+
+CsvCollection::make(static function () {
+    //
+})
+    ->save('path/to/file.csv');
+```
+
+### Options
+
+The following options are available to suit your needs:
+
+- `header`, default: `true`
+- `delimiter`, default: `,`
+- `enclosure`, default: `"`
+- `escape`, default: `\\`
+
+These options could be passed to the `open` and `save` methods, be set using the `options` method, or be set as the
+global default using the static `defaults` method.
+
+#### Header
+
+When using a header, lines will contain an associated array. Otherwise, lines will contain an indexed array.
+
+```php
+// Without header
+[
+    0 => 'John',
+    1 => 'Doe',
+]
+
+// With header
+[
+    'first_name' => 'John',
+    'last_name' => 'Doe',
+]
+```
+
+_**Note**: When saving a collection to a file the keys of the first element in the collection will be used as the header._
+
+## Testing
+
+```bash
+composer test
+```
+
+## Credits
+
+- [Bjorn Voesten](https://github.com/bjornvoesten)
+- [Dutch Coding Company](https://github.com/dutchcodingcompany)
+- [All contributors](https://github.com/dutchcodingcompany/csv-collection/graphs/contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,36 @@
+{
+  "name": "dutchcodingcompany/csv-collection",
+  "description": "Read and write large csv files using Laravel's Illuminate Collections",
+  "keywords": [
+    "dutch coding company",
+    "dcc",
+    "csv collection",
+    "csv",
+    "collection",
+    "laravel",
+    "illuminate"
+  ],
+  "scripts": {
+    "test": "./vendor/bin/phpunit ./tests"
+  },
+  "require": {
+    "php": "^7.4",
+    "illuminate/collections": "^6.0|^7.0|^8.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "*"
+  },
+  "autoload": {
+    "psr-4": {
+      "DutchCodingCompany\\CsvCollection\\": "src/",
+      "Tests\\": "tests/"
+    }
+  },
+  "config": {
+    "sort-packages": true
+  },
+  "homepage": "https://dutchcodingcompany.com",
+  "license": "MIT",
+  "minimum-stability": "dev",
+  "prefer-stable": true
+}

src/CsvCollection.php

@@ -0,0 +1,145 @@
+<?php
+
+namespace DutchCodingCompany\CsvCollection;
+
+use Illuminate\Support\LazyCollection;
+
+class CsvCollection extends LazyCollection
+{
+    /**
+     * The collection's default options.
+     *
+     * @var array
+     */
+    public static array $defaults = [
+        'delimiter' => ',',
+        'enclosure' => '"',
+        'escape' => '\\',
+        'header' => true,
+    ];
+
+    /**
+     * The collection's options.
+     *
+     * @var array
+     */
+    public array $options = [];
+
+    /**
+     * Create a new csv collection instance.
+     *
+     * @param mixed $source
+     * @return void
+     */
+    public function __construct($source = null)
+    {
+        parent::__construct($source);
+
+        $this->options(static::$defaults);
+    }
+
+    /**
+     * Load the csv file items into a new collection.
+     *
+     * @param string $file
+     * @param array $options
+     * @return static
+     */
+    public function open(string $file, array $options = []): self
+    {
+        $options = array_merge(
+            $this->options, $options
+        );
+
+        return static::make(static function () use ($file, $options) {
+            $resource = fopen($file, 'r');
+
+            $read = static fn() => fgetcsv(
+                $resource, 0,
+                $options['delimiter'],
+                $options['enclosure'],
+                $options['escape'],
+            );
+
+            $header = null;
+
+            // Loop over the rows and yield them into a generator.
+            while (($line = $read()) !== false) {
+                if (! ($options['header'])) {
+                    yield $line;
+                    continue;
+                }
+
+                if (! $header) {
+                    $header = $line;
+                    continue;
+                }
+
+                yield array_combine($header, $line);
+            }
+
+            fclose($resource);
+        });
+    }
+
+    /**
+     * Save the collection items to the csv file.
+     *
+     * @param string|null $file
+     * @param array $options
+     * @return $this
+     */
+    public function save(string $file, array $options = []): self
+    {
+        $options = array_merge(
+            $this->options, $options
+        );
+
+        $resource = fopen($file, 'w');
+
+        $write = static fn(array $line) => fputcsv(
+            $resource, $line,
+            $options['delimiter'],
+            $options['enclosure'],
+            $options['escape'],
+        );
+
+        if ($options['header']) {
+            $write(array_keys($this->first()));
+        }
+
+        $this->each($write);
+
+        fclose($resource);
+
+        return $this;
+    }
+
+    /**
+     * Set the collection's options.
+     *
+     * @param array $options
+     * @return static
+     */
+    public function options(array $options): self
+    {
+        $this->options = array_merge(
+            $this->options, $options
+        );
+
+        return $this;
+    }
+
+    /**
+     * Set the collection's default options.
+     *
+     * @param array $options
+     * @return void
+     */
+    public static function defaults(array $options): void
+    {
+        static::$defaults = array_merge(
+            static::$defaults, $options
+        );
+    }
+}