From cfa916632bb5497fc6ee5b0e6f142b26c3f42b06 Mon Sep 17 00:00:00 2001 From: billz Date: Wed, 28 Feb 2024 19:27:10 +0100 Subject: [PATCH] Replace external dependencies w/ native DotEnv class --- .gitignore | 1 + composer.json | 1 - includes/restapi.php | 16 +- installers/common.sh | 2 +- src/Dotenv/Dotenv.php | 267 ----------- src/Dotenv/Exception/ExceptionInterface.php | 12 - .../Exception/InvalidEncodingException.php | 12 - src/Dotenv/Exception/InvalidFileException.php | 12 - src/Dotenv/Exception/InvalidPathException.php | 12 - src/Dotenv/Exception/ValidationException.php | 12 - src/Dotenv/Loader/Loader.php | 47 -- src/Dotenv/Loader/LoaderInterface.php | 20 - src/Dotenv/Loader/Resolver.php | 65 --- src/Dotenv/Parser/Entry.php | 59 --- src/Dotenv/Parser/EntryParser.php | 300 ------------ src/Dotenv/Parser/Lexer.php | 58 --- src/Dotenv/Parser/Lines.php | 127 ----- src/Dotenv/Parser/Parser.php | 53 --- src/Dotenv/Parser/ParserInterface.php | 19 - src/Dotenv/Parser/Value.php | 88 ---- .../Repository/Adapter/AdapterInterface.php | 15 - .../Repository/Adapter/ApacheAdapter.php | 89 ---- .../Repository/Adapter/ArrayAdapter.php | 80 ---- .../Repository/Adapter/EnvConstAdapter.php | 89 ---- .../Repository/Adapter/GuardedWriter.php | 85 ---- .../Repository/Adapter/ImmutableWriter.php | 110 ----- src/Dotenv/Repository/Adapter/MultiReader.php | 48 -- src/Dotenv/Repository/Adapter/MultiWriter.php | 64 --- .../Repository/Adapter/PutenvAdapter.php | 91 ---- .../Repository/Adapter/ReaderInterface.php | 17 - .../Repository/Adapter/ReplacingWriter.php | 104 ----- .../Repository/Adapter/ServerConstAdapter.php | 89 ---- .../Repository/Adapter/WriterInterface.php | 27 -- src/Dotenv/Repository/AdapterRepository.php | 107 ----- src/Dotenv/Repository/RepositoryBuilder.php | 272 ----------- src/Dotenv/Repository/RepositoryInterface.php | 51 -- src/Dotenv/Store/File/Paths.php | 44 -- src/Dotenv/Store/File/Reader.php | 81 ---- src/Dotenv/Store/FileStore.php | 72 --- src/Dotenv/Store/StoreBuilder.php | 141 ------ src/Dotenv/Store/StoreInterface.php | 17 - src/Dotenv/Store/StringStore.php | 37 -- src/Dotenv/Util/Regex.php | 112 ----- src/Dotenv/Util/Str.php | 98 ---- src/Dotenv/Validator.php | 209 --------- src/GrahamCampbell/ResultType/Error.php | 121 ----- src/GrahamCampbell/ResultType/Result.php | 69 --- src/GrahamCampbell/ResultType/Success.php | 120 ----- src/PhpOption/LazyOption.php | 175 ------- src/PhpOption/None.php | 136 ------ src/PhpOption/Option.php | 434 ------------------ src/PhpOption/Some.php | 169 ------- 52 files changed, 11 insertions(+), 4545 deletions(-) delete mode 100644 src/Dotenv/Dotenv.php delete mode 100644 src/Dotenv/Exception/ExceptionInterface.php delete mode 100644 src/Dotenv/Exception/InvalidEncodingException.php delete mode 100644 src/Dotenv/Exception/InvalidFileException.php delete mode 100644 src/Dotenv/Exception/InvalidPathException.php delete mode 100644 src/Dotenv/Exception/ValidationException.php delete mode 100644 src/Dotenv/Loader/Loader.php delete mode 100644 src/Dotenv/Loader/LoaderInterface.php delete mode 100644 src/Dotenv/Loader/Resolver.php delete mode 100644 src/Dotenv/Parser/Entry.php delete mode 100644 src/Dotenv/Parser/EntryParser.php delete mode 100644 src/Dotenv/Parser/Lexer.php delete mode 100644 src/Dotenv/Parser/Lines.php delete mode 100644 src/Dotenv/Parser/Parser.php delete mode 100644 src/Dotenv/Parser/ParserInterface.php delete mode 100644 src/Dotenv/Parser/Value.php delete mode 100644 src/Dotenv/Repository/Adapter/AdapterInterface.php delete mode 100644 src/Dotenv/Repository/Adapter/ApacheAdapter.php delete mode 100644 src/Dotenv/Repository/Adapter/ArrayAdapter.php delete mode 100644 src/Dotenv/Repository/Adapter/EnvConstAdapter.php delete mode 100644 src/Dotenv/Repository/Adapter/GuardedWriter.php delete mode 100644 src/Dotenv/Repository/Adapter/ImmutableWriter.php delete mode 100644 src/Dotenv/Repository/Adapter/MultiReader.php delete mode 100644 src/Dotenv/Repository/Adapter/MultiWriter.php delete mode 100644 src/Dotenv/Repository/Adapter/PutenvAdapter.php delete mode 100644 src/Dotenv/Repository/Adapter/ReaderInterface.php delete mode 100644 src/Dotenv/Repository/Adapter/ReplacingWriter.php delete mode 100644 src/Dotenv/Repository/Adapter/ServerConstAdapter.php delete mode 100644 src/Dotenv/Repository/Adapter/WriterInterface.php delete mode 100644 src/Dotenv/Repository/AdapterRepository.php delete mode 100644 src/Dotenv/Repository/RepositoryBuilder.php delete mode 100644 src/Dotenv/Repository/RepositoryInterface.php delete mode 100644 src/Dotenv/Store/File/Paths.php delete mode 100644 src/Dotenv/Store/File/Reader.php delete mode 100644 src/Dotenv/Store/FileStore.php delete mode 100644 src/Dotenv/Store/StoreBuilder.php delete mode 100644 src/Dotenv/Store/StoreInterface.php delete mode 100644 src/Dotenv/Store/StringStore.php delete mode 100644 src/Dotenv/Util/Regex.php delete mode 100644 src/Dotenv/Util/Str.php delete mode 100644 src/Dotenv/Validator.php delete mode 100644 src/GrahamCampbell/ResultType/Error.php delete mode 100644 src/GrahamCampbell/ResultType/Result.php delete mode 100644 src/GrahamCampbell/ResultType/Success.php delete mode 100644 src/PhpOption/LazyOption.php delete mode 100644 src/PhpOption/None.php delete mode 100644 src/PhpOption/Option.php delete mode 100644 src/PhpOption/Some.php diff --git a/.gitignore b/.gitignore index a2a77b49..245d6fa4 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ yarn-error.log includes/config.php rootCA.pem vendor +.env diff --git a/composer.json b/composer.json index 7ffa2737..ad52f66b 100644 --- a/composer.json +++ b/composer.json @@ -14,7 +14,6 @@ ], "require": { "php": "^8.2", - "vlucas/phpdotenv": "^5.6", "phpoption/phpoption": "^1.9", "ext-mbstring": "*" }, diff --git a/includes/restapi.php b/includes/restapi.php index 3a2b100c..015c0cb1 100644 --- a/includes/restapi.php +++ b/includes/restapi.php @@ -3,10 +3,6 @@ require_once 'includes/functions.php'; require_once 'config.php'; -$env = dirname(__DIR__, 1); -$dotenv = Dotenv\Dotenv::createImmutable($env); -$dotenv->safeLoad(); - /** * Handler for RestAPI settings */ @@ -15,6 +11,10 @@ function DisplayRestAPI() // initialize status object $status = new \RaspAP\Messages\StatusMessage; + // create instance of DotEnv + $dotenv = new \RaspAP\DotEnv\DotEnv; + $dotenv->load(); + // set defaults $apiKey = $_ENV['RASPAP_API_KEY']; @@ -25,7 +25,7 @@ function DisplayRestAPI() if (strlen($apiKey) == 0) { $status->addMessage('Please enter a valid API key', 'danger'); } else { - $return = saveAPISettings($status, $apiKey); + $return = saveAPISettings($status, $apiKey, $dotenv); } } } elseif (isset($_POST['StartRestAPIservice'])) { @@ -57,12 +57,14 @@ function DisplayRestAPI() * Saves RestAPI settings * * @param object status + * @param object dotenv * @param string $apiKey */ -function saveAPISettings($status, $apiKey) +function saveAPISettings($status, $apiKey, $dotenv) { $status->addMessage('Saving API key', 'info'); - // TODO: update API key. location defined from constant + $dotenv->set('RASPAP_API_KEY', $apiKey); return $status; } + diff --git a/installers/common.sh b/installers/common.sh index 72c66dc1..2d05213d 100755 --- a/installers/common.sh +++ b/installers/common.sh @@ -250,7 +250,7 @@ function _install_dependencies() { # Set dconf-set-selections echo iptables-persistent iptables-persistent/autosave_v4 boolean true | sudo debconf-set-selections echo iptables-persistent iptables-persistent/autosave_v6 boolean true | sudo debconf-set-selections - sudo apt-get install -y lighttpd git hostapd dnsmasq iptables-persistent $php_package $dhcpcd_package $iw_package $rsync_package $network_tools vnstat qrencode jq isoquery php-mbstring || _install_status 1 "Unable to install dependencies" + sudo apt-get install -y lighttpd git hostapd dnsmasq iptables-persistent $php_package $dhcpcd_package $iw_package $rsync_package $network_tools vnstat qrencode jq isoquery || _install_status 1 "Unable to install dependencies" _install_status 0 } diff --git a/src/Dotenv/Dotenv.php b/src/Dotenv/Dotenv.php deleted file mode 100644 index 0460ced2..00000000 --- a/src/Dotenv/Dotenv.php +++ /dev/null @@ -1,267 +0,0 @@ -store = $store; - $this->parser = $parser; - $this->loader = $loader; - $this->repository = $repository; - } - - /** - * Create a new dotenv instance. - * - * @param \Dotenv\Repository\RepositoryInterface $repository - * @param string|string[] $paths - * @param string|string[]|null $names - * @param bool $shortCircuit - * @param string|null $fileEncoding - * - * @return \Dotenv\Dotenv - */ - public static function create(RepositoryInterface $repository, $paths, $names = null, bool $shortCircuit = true, string $fileEncoding = null) - { - $builder = $names === null ? StoreBuilder::createWithDefaultName() : StoreBuilder::createWithNoNames(); - - foreach ((array) $paths as $path) { - $builder = $builder->addPath($path); - } - - foreach ((array) $names as $name) { - $builder = $builder->addName($name); - } - - if ($shortCircuit) { - $builder = $builder->shortCircuit(); - } - - return new self($builder->fileEncoding($fileEncoding)->make(), new Parser(), new Loader(), $repository); - } - - /** - * Create a new mutable dotenv instance with default repository. - * - * @param string|string[] $paths - * @param string|string[]|null $names - * @param bool $shortCircuit - * @param string|null $fileEncoding - * - * @return \Dotenv\Dotenv - */ - public static function createMutable($paths, $names = null, bool $shortCircuit = true, string $fileEncoding = null) - { - $repository = RepositoryBuilder::createWithDefaultAdapters()->make(); - - return self::create($repository, $paths, $names, $shortCircuit, $fileEncoding); - } - - /** - * Create a new mutable dotenv instance with default repository with the putenv adapter. - * - * @param string|string[] $paths - * @param string|string[]|null $names - * @param bool $shortCircuit - * @param string|null $fileEncoding - * - * @return \Dotenv\Dotenv - */ - public static function createUnsafeMutable($paths, $names = null, bool $shortCircuit = true, string $fileEncoding = null) - { - $repository = RepositoryBuilder::createWithDefaultAdapters() - ->addAdapter(PutenvAdapter::class) - ->make(); - - return self::create($repository, $paths, $names, $shortCircuit, $fileEncoding); - } - - /** - * Create a new immutable dotenv instance with default repository. - * - * @param string|string[] $paths - * @param string|string[]|null $names - * @param bool $shortCircuit - * @param string|null $fileEncoding - * - * @return \Dotenv\Dotenv - */ - public static function createImmutable($paths, $names = null, bool $shortCircuit = true, string $fileEncoding = null) - { - $repository = RepositoryBuilder::createWithDefaultAdapters()->immutable()->make(); - - return self::create($repository, $paths, $names, $shortCircuit, $fileEncoding); - } - - /** - * Create a new immutable dotenv instance with default repository with the putenv adapter. - * - * @param string|string[] $paths - * @param string|string[]|null $names - * @param bool $shortCircuit - * @param string|null $fileEncoding - * - * @return \Dotenv\Dotenv - */ - public static function createUnsafeImmutable($paths, $names = null, bool $shortCircuit = true, string $fileEncoding = null) - { - $repository = RepositoryBuilder::createWithDefaultAdapters() - ->addAdapter(PutenvAdapter::class) - ->immutable() - ->make(); - - return self::create($repository, $paths, $names, $shortCircuit, $fileEncoding); - } - - /** - * Create a new dotenv instance with an array backed repository. - * - * @param string|string[] $paths - * @param string|string[]|null $names - * @param bool $shortCircuit - * @param string|null $fileEncoding - * - * @return \Dotenv\Dotenv - */ - public static function createArrayBacked($paths, $names = null, bool $shortCircuit = true, string $fileEncoding = null) - { - $repository = RepositoryBuilder::createWithNoAdapters()->addAdapter(ArrayAdapter::class)->make(); - - return self::create($repository, $paths, $names, $shortCircuit, $fileEncoding); - } - - /** - * Parse the given content and resolve nested variables. - * - * This method behaves just like load(), only without mutating your actual - * environment. We do this by using an array backed repository. - * - * @param string $content - * - * @throws \Dotenv\Exception\InvalidFileException - * - * @return array - */ - public static function parse(string $content) - { - $repository = RepositoryBuilder::createWithNoAdapters()->addAdapter(ArrayAdapter::class)->make(); - - $phpdotenv = new self(new StringStore($content), new Parser(), new Loader(), $repository); - - return $phpdotenv->load(); - } - - /** - * Read and load environment file(s). - * - * @throws \Dotenv\Exception\InvalidPathException|\Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidFileException - * - * @return array - */ - public function load() - { - $entries = $this->parser->parse($this->store->read()); - - return $this->loader->load($this->repository, $entries); - } - - /** - * Read and load environment file(s), silently failing if no files can be read. - * - * @throws \Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidFileException - * - * @return array - */ - public function safeLoad() - { - try { - return $this->load(); - } catch (InvalidPathException $e) { - // suppressing exception - return []; - } - } - - /** - * Required ensures that the specified variables exist, and returns a new validator object. - * - * @param string|string[] $variables - * - * @return \Dotenv\Validator - */ - public function required($variables) - { - return (new Validator($this->repository, (array) $variables))->required(); - } - - /** - * Returns a new validator object that won't check if the specified variables exist. - * - * @param string|string[] $variables - * - * @return \Dotenv\Validator - */ - public function ifPresent($variables) - { - return new Validator($this->repository, (array) $variables); - } -} diff --git a/src/Dotenv/Exception/ExceptionInterface.php b/src/Dotenv/Exception/ExceptionInterface.php deleted file mode 100644 index 1e80f531..00000000 --- a/src/Dotenv/Exception/ExceptionInterface.php +++ /dev/null @@ -1,12 +0,0 @@ - - */ - public function load(RepositoryInterface $repository, array $entries) - { - return \array_reduce($entries, static function (array $vars, Entry $entry) use ($repository) { - $name = $entry->getName(); - - $value = $entry->getValue()->map(static function (Value $value) use ($repository) { - return Resolver::resolve($repository, $value); - }); - - if ($value->isDefined()) { - $inner = $value->get(); - if ($repository->set($name, $inner)) { - return \array_merge($vars, [$name => $inner]); - } - } else { - if ($repository->clear($name)) { - return \array_merge($vars, [$name => null]); - } - } - - return $vars; - }, []); - } -} diff --git a/src/Dotenv/Loader/LoaderInterface.php b/src/Dotenv/Loader/LoaderInterface.php deleted file mode 100644 index 275d98e8..00000000 --- a/src/Dotenv/Loader/LoaderInterface.php +++ /dev/null @@ -1,20 +0,0 @@ - - */ - public function load(RepositoryInterface $repository, array $entries); -} diff --git a/src/Dotenv/Loader/Resolver.php b/src/Dotenv/Loader/Resolver.php deleted file mode 100644 index 36d7a4b9..00000000 --- a/src/Dotenv/Loader/Resolver.php +++ /dev/null @@ -1,65 +0,0 @@ -getVars(), static function (string $s, int $i) use ($repository) { - return Str::substr($s, 0, $i).self::resolveVariable($repository, Str::substr($s, $i)); - }, $value->getChars()); - } - - /** - * Resolve a single nested variable. - * - * @param \Dotenv\Repository\RepositoryInterface $repository - * @param string $str - * - * @return string - */ - private static function resolveVariable(RepositoryInterface $repository, string $str) - { - return Regex::replaceCallback( - '/\A\${([a-zA-Z0-9_.]+)}/', - static function (array $matches) use ($repository) { - return Option::fromValue($repository->get($matches[1])) - ->getOrElse($matches[0]); - }, - $str, - 1 - )->success()->getOrElse($str); - } -} diff --git a/src/Dotenv/Parser/Entry.php b/src/Dotenv/Parser/Entry.php deleted file mode 100644 index 7570f587..00000000 --- a/src/Dotenv/Parser/Entry.php +++ /dev/null @@ -1,59 +0,0 @@ -name = $name; - $this->value = $value; - } - - /** - * Get the entry name. - * - * @return string - */ - public function getName() - { - return $this->name; - } - - /** - * Get the entry value. - * - * @return \PhpOption\Option<\Dotenv\Parser\Value> - */ - public function getValue() - { - /** @var \PhpOption\Option<\Dotenv\Parser\Value> */ - return Option::fromValue($this->value); - } -} diff --git a/src/Dotenv/Parser/EntryParser.php b/src/Dotenv/Parser/EntryParser.php deleted file mode 100644 index e286840a..00000000 --- a/src/Dotenv/Parser/EntryParser.php +++ /dev/null @@ -1,300 +0,0 @@ - - */ - public static function parse(string $entry) - { - return self::splitStringIntoParts($entry)->flatMap(static function (array $parts) { - [$name, $value] = $parts; - - return self::parseName($name)->flatMap(static function (string $name) use ($value) { - /** @var Result */ - $parsedValue = $value === null ? Success::create(null) : self::parseValue($value); - - return $parsedValue->map(static function (?Value $value) use ($name) { - return new Entry($name, $value); - }); - }); - }); - } - - /** - * Split the compound string into parts. - * - * @param string $line - * - * @return \GrahamCampbell\ResultType\Result - */ - private static function splitStringIntoParts(string $line) - { - /** @var array{string,string|null} */ - $result = Str::pos($line, '=')->map(static function () use ($line) { - return \array_map('trim', \explode('=', $line, 2)); - })->getOrElse([$line, null]); - - if ($result[0] === '') { - /** @var \GrahamCampbell\ResultType\Result */ - return Error::create(self::getErrorMessage('an unexpected equals', $line)); - } - - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create($result); - } - - /** - * Parse the given variable name. - * - * That is, strip the optional quotes and leading "export" from the - * variable name. We wrap the answer in a result type. - * - * @param string $name - * - * @return \GrahamCampbell\ResultType\Result - */ - private static function parseName(string $name) - { - if (Str::len($name) > 8 && Str::substr($name, 0, 6) === 'export' && \ctype_space(Str::substr($name, 6, 1))) { - $name = \ltrim(Str::substr($name, 6)); - } - - if (self::isQuotedName($name)) { - $name = Str::substr($name, 1, -1); - } - - if (!self::isValidName($name)) { - /** @var \GrahamCampbell\ResultType\Result */ - return Error::create(self::getErrorMessage('an invalid name', $name)); - } - - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create($name); - } - - /** - * Is the given variable name quoted? - * - * @param string $name - * - * @return bool - */ - private static function isQuotedName(string $name) - { - if (Str::len($name) < 3) { - return false; - } - - $first = Str::substr($name, 0, 1); - $last = Str::substr($name, -1, 1); - - return ($first === '"' && $last === '"') || ($first === '\'' && $last === '\''); - } - - /** - * Is the given variable name valid? - * - * @param string $name - * - * @return bool - */ - private static function isValidName(string $name) - { - return Regex::matches('~(*UTF8)\A[\p{Ll}\p{Lu}\p{M}\p{N}_.]+\z~', $name)->success()->getOrElse(false); - } - - /** - * Parse the given variable value. - * - * This has the effect of stripping quotes and comments, dealing with - * special characters, and locating nested variables, but not resolving - * them. Formally, we run a finite state automaton with an output tape: a - * transducer. We wrap the answer in a result type. - * - * @param string $value - * - * @return \GrahamCampbell\ResultType\Result<\Dotenv\Parser\Value,string> - */ - private static function parseValue(string $value) - { - if (\trim($value) === '') { - /** @var \GrahamCampbell\ResultType\Result<\Dotenv\Parser\Value,string> */ - return Success::create(Value::blank()); - } - - return \array_reduce(\iterator_to_array(Lexer::lex($value)), static function (Result $data, string $token) { - return $data->flatMap(static function (array $data) use ($token) { - return self::processToken($data[1], $token)->map(static function (array $val) use ($data) { - return [$data[0]->append($val[0], $val[1]), $val[2]]; - }); - }); - }, Success::create([Value::blank(), self::INITIAL_STATE]))->flatMap(static function (array $result) { - /** @psalm-suppress DocblockTypeContradiction */ - if (in_array($result[1], self::REJECT_STATES, true)) { - /** @var \GrahamCampbell\ResultType\Result<\Dotenv\Parser\Value,string> */ - return Error::create('a missing closing quote'); - } - - /** @var \GrahamCampbell\ResultType\Result<\Dotenv\Parser\Value,string> */ - return Success::create($result[0]); - })->mapError(static function (string $err) use ($value) { - return self::getErrorMessage($err, $value); - }); - } - - /** - * Process the given token. - * - * @param int $state - * @param string $token - * - * @return \GrahamCampbell\ResultType\Result - */ - private static function processToken(int $state, string $token) - { - switch ($state) { - case self::INITIAL_STATE: - if ($token === '\'') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::SINGLE_QUOTED_STATE]); - } elseif ($token === '"') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::DOUBLE_QUOTED_STATE]); - } elseif ($token === '#') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::COMMENT_STATE]); - } elseif ($token === '$') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, true, self::UNQUOTED_STATE]); - } else { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, false, self::UNQUOTED_STATE]); - } - case self::UNQUOTED_STATE: - if ($token === '#') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::COMMENT_STATE]); - } elseif (\ctype_space($token)) { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::WHITESPACE_STATE]); - } elseif ($token === '$') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, true, self::UNQUOTED_STATE]); - } else { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, false, self::UNQUOTED_STATE]); - } - case self::SINGLE_QUOTED_STATE: - if ($token === '\'') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::WHITESPACE_STATE]); - } else { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, false, self::SINGLE_QUOTED_STATE]); - } - case self::DOUBLE_QUOTED_STATE: - if ($token === '"') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::WHITESPACE_STATE]); - } elseif ($token === '\\') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::ESCAPE_SEQUENCE_STATE]); - } elseif ($token === '$') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, true, self::DOUBLE_QUOTED_STATE]); - } else { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, false, self::DOUBLE_QUOTED_STATE]); - } - case self::ESCAPE_SEQUENCE_STATE: - if ($token === '"' || $token === '\\') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, false, self::DOUBLE_QUOTED_STATE]); - } elseif ($token === '$') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([$token, false, self::DOUBLE_QUOTED_STATE]); - } else { - $first = Str::substr($token, 0, 1); - if (\in_array($first, ['f', 'n', 'r', 't', 'v'], true)) { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create([\stripcslashes('\\'.$first).Str::substr($token, 1), false, self::DOUBLE_QUOTED_STATE]); - } else { - /** @var \GrahamCampbell\ResultType\Result */ - return Error::create('an unexpected escape sequence'); - } - } - case self::WHITESPACE_STATE: - if ($token === '#') { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::COMMENT_STATE]); - } elseif (!\ctype_space($token)) { - /** @var \GrahamCampbell\ResultType\Result */ - return Error::create('unexpected whitespace'); - } else { - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::WHITESPACE_STATE]); - } - case self::COMMENT_STATE: - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create(['', false, self::COMMENT_STATE]); - default: - throw new \Error('Parser entered invalid state.'); - } - } - - /** - * Generate a friendly error message. - * - * @param string $cause - * @param string $subject - * - * @return string - */ - private static function getErrorMessage(string $cause, string $subject) - { - return \sprintf( - 'Encountered %s at [%s].', - $cause, - \strtok($subject, "\n") - ); - } -} diff --git a/src/Dotenv/Parser/Lexer.php b/src/Dotenv/Parser/Lexer.php deleted file mode 100644 index 981af24f..00000000 --- a/src/Dotenv/Parser/Lexer.php +++ /dev/null @@ -1,58 +0,0 @@ - - */ - public static function lex(string $content) - { - static $regex; - - if ($regex === null) { - $regex = '(('.\implode(')|(', self::PATTERNS).'))A'; - } - - $offset = 0; - - while (isset($content[$offset])) { - if (!\preg_match($regex, $content, $matches, 0, $offset)) { - throw new \Error(\sprintf('Lexer encountered unexpected character [%s].', $content[$offset])); - } - - $offset += \strlen($matches[0]); - - yield $matches[0]; - } - } -} diff --git a/src/Dotenv/Parser/Lines.php b/src/Dotenv/Parser/Lines.php deleted file mode 100644 index 64979932..00000000 --- a/src/Dotenv/Parser/Lines.php +++ /dev/null @@ -1,127 +0,0 @@ -map(static function () use ($line) { - return self::looksLikeMultilineStop($line, true) === false; - })->getOrElse(false); - } - - /** - * Determine if the given line can be the start of a multiline variable. - * - * @param string $line - * @param bool $started - * - * @return bool - */ - private static function looksLikeMultilineStop(string $line, bool $started) - { - if ($line === '"') { - return true; - } - - return Regex::occurrences('/(?=([^\\\\]"))/', \str_replace('\\\\', '', $line))->map(static function (int $count) use ($started) { - return $started ? $count > 1 : $count >= 1; - })->success()->getOrElse(false); - } - - /** - * Determine if the line in the file is a comment or whitespace. - * - * @param string $line - * - * @return bool - */ - private static function isCommentOrWhitespace(string $line) - { - $line = \trim($line); - - return $line === '' || (isset($line[0]) && $line[0] === '#'); - } -} diff --git a/src/Dotenv/Parser/Parser.php b/src/Dotenv/Parser/Parser.php deleted file mode 100644 index 2d30dfd6..00000000 --- a/src/Dotenv/Parser/Parser.php +++ /dev/null @@ -1,53 +0,0 @@ -mapError(static function () { - return 'Could not split into separate lines.'; - })->flatMap(static function (array $lines) { - return self::process(Lines::process($lines)); - })->mapError(static function (string $error) { - throw new InvalidFileException(\sprintf('Failed to parse dotenv file. %s', $error)); - })->success()->get(); - } - - /** - * Convert the raw entries into proper entries. - * - * @param string[] $entries - * - * @return \GrahamCampbell\ResultType\Result<\Dotenv\Parser\Entry[],string> - */ - private static function process(array $entries) - { - /** @var \GrahamCampbell\ResultType\Result<\Dotenv\Parser\Entry[],string> */ - return \array_reduce($entries, static function (Result $result, string $raw) { - return $result->flatMap(static function (array $entries) use ($raw) { - return EntryParser::parse($raw)->map(static function (Entry $entry) use ($entries) { - /** @var \Dotenv\Parser\Entry[] */ - return \array_merge($entries, [$entry]); - }); - }); - }, Success::create([])); - } -} diff --git a/src/Dotenv/Parser/ParserInterface.php b/src/Dotenv/Parser/ParserInterface.php deleted file mode 100644 index 17cc42ad..00000000 --- a/src/Dotenv/Parser/ParserInterface.php +++ /dev/null @@ -1,19 +0,0 @@ -chars = $chars; - $this->vars = $vars; - } - - /** - * Create an empty value instance. - * - * @return \Dotenv\Parser\Value - */ - public static function blank() - { - return new self('', []); - } - - /** - * Create a new value instance, appending the characters. - * - * @param string $chars - * @param bool $var - * - * @return \Dotenv\Parser\Value - */ - public function append(string $chars, bool $var) - { - return new self( - $this->chars.$chars, - $var ? \array_merge($this->vars, [Str::len($this->chars)]) : $this->vars - ); - } - - /** - * Get the string representation of the parsed value. - * - * @return string - */ - public function getChars() - { - return $this->chars; - } - - /** - * Get the locations of the variables in the value. - * - * @return int[] - */ - public function getVars() - { - $vars = $this->vars; - - \rsort($vars); - - return $vars; - } -} diff --git a/src/Dotenv/Repository/Adapter/AdapterInterface.php b/src/Dotenv/Repository/Adapter/AdapterInterface.php deleted file mode 100644 index 5604398a..00000000 --- a/src/Dotenv/Repository/Adapter/AdapterInterface.php +++ /dev/null @@ -1,15 +0,0 @@ - - */ - public static function create(); -} diff --git a/src/Dotenv/Repository/Adapter/ApacheAdapter.php b/src/Dotenv/Repository/Adapter/ApacheAdapter.php deleted file mode 100644 index af0aae11..00000000 --- a/src/Dotenv/Repository/Adapter/ApacheAdapter.php +++ /dev/null @@ -1,89 +0,0 @@ - - */ - public static function create() - { - if (self::isSupported()) { - /** @var \PhpOption\Option */ - return Some::create(new self()); - } - - return None::create(); - } - - /** - * Determines if the adapter is supported. - * - * This happens if PHP is running as an Apache module. - * - * @return bool - */ - private static function isSupported() - { - return \function_exists('apache_getenv') && \function_exists('apache_setenv'); - } - - /** - * Read an environment variable, if it exists. - * - * @param non-empty-string $name - * - * @return \PhpOption\Option - */ - public function read(string $name) - { - /** @var \PhpOption\Option */ - return Option::fromValue(apache_getenv($name))->filter(static function ($value) { - return \is_string($value) && $value !== ''; - }); - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - return apache_setenv($name, $value); - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - return apache_setenv($name, ''); - } -} diff --git a/src/Dotenv/Repository/Adapter/ArrayAdapter.php b/src/Dotenv/Repository/Adapter/ArrayAdapter.php deleted file mode 100644 index df64cf6d..00000000 --- a/src/Dotenv/Repository/Adapter/ArrayAdapter.php +++ /dev/null @@ -1,80 +0,0 @@ - - */ - private $variables; - - /** - * Create a new array adapter instance. - * - * @return void - */ - private function __construct() - { - $this->variables = []; - } - - /** - * Create a new instance of the adapter, if it is available. - * - * @return \PhpOption\Option<\Dotenv\Repository\Adapter\AdapterInterface> - */ - public static function create() - { - /** @var \PhpOption\Option */ - return Some::create(new self()); - } - - /** - * Read an environment variable, if it exists. - * - * @param non-empty-string $name - * - * @return \PhpOption\Option - */ - public function read(string $name) - { - return Option::fromArraysValue($this->variables, $name); - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - $this->variables[$name] = $value; - - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - unset($this->variables[$name]); - - return true; - } -} diff --git a/src/Dotenv/Repository/Adapter/EnvConstAdapter.php b/src/Dotenv/Repository/Adapter/EnvConstAdapter.php deleted file mode 100644 index 9eb19477..00000000 --- a/src/Dotenv/Repository/Adapter/EnvConstAdapter.php +++ /dev/null @@ -1,89 +0,0 @@ - - */ - public static function create() - { - /** @var \PhpOption\Option */ - return Some::create(new self()); - } - - /** - * Read an environment variable, if it exists. - * - * @param non-empty-string $name - * - * @return \PhpOption\Option - */ - public function read(string $name) - { - /** @var \PhpOption\Option */ - return Option::fromArraysValue($_ENV, $name) - ->filter(static function ($value) { - return \is_scalar($value); - }) - ->map(static function ($value) { - if ($value === false) { - return 'false'; - } - - if ($value === true) { - return 'true'; - } - - /** @psalm-suppress PossiblyInvalidCast */ - return (string) $value; - }); - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - $_ENV[$name] = $value; - - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - unset($_ENV[$name]); - - return true; - } -} diff --git a/src/Dotenv/Repository/Adapter/GuardedWriter.php b/src/Dotenv/Repository/Adapter/GuardedWriter.php deleted file mode 100644 index fed8b9ba..00000000 --- a/src/Dotenv/Repository/Adapter/GuardedWriter.php +++ /dev/null @@ -1,85 +0,0 @@ -writer = $writer; - $this->allowList = $allowList; - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - // Don't set non-allowed variables - if (!$this->isAllowed($name)) { - return false; - } - - // Set the value on the inner writer - return $this->writer->write($name, $value); - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - // Don't clear non-allowed variables - if (!$this->isAllowed($name)) { - return false; - } - - // Set the value on the inner writer - return $this->writer->delete($name); - } - - /** - * Determine if the given variable is allowed. - * - * @param non-empty-string $name - * - * @return bool - */ - private function isAllowed(string $name) - { - return \in_array($name, $this->allowList, true); - } -} diff --git a/src/Dotenv/Repository/Adapter/ImmutableWriter.php b/src/Dotenv/Repository/Adapter/ImmutableWriter.php deleted file mode 100644 index 399e6f9b..00000000 --- a/src/Dotenv/Repository/Adapter/ImmutableWriter.php +++ /dev/null @@ -1,110 +0,0 @@ - - */ - private $loaded; - - /** - * Create a new immutable writer instance. - * - * @param \Dotenv\Repository\Adapter\WriterInterface $writer - * @param \Dotenv\Repository\Adapter\ReaderInterface $reader - * - * @return void - */ - public function __construct(WriterInterface $writer, ReaderInterface $reader) - { - $this->writer = $writer; - $this->reader = $reader; - $this->loaded = []; - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - // Don't overwrite existing environment variables - // Ruby's dotenv does this with `ENV[key] ||= value` - if ($this->isExternallyDefined($name)) { - return false; - } - - // Set the value on the inner writer - if (!$this->writer->write($name, $value)) { - return false; - } - - // Record that we have loaded the variable - $this->loaded[$name] = ''; - - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - // Don't clear existing environment variables - if ($this->isExternallyDefined($name)) { - return false; - } - - // Clear the value on the inner writer - if (!$this->writer->delete($name)) { - return false; - } - - // Leave the variable as fair game - unset($this->loaded[$name]); - - return true; - } - - /** - * Determine if the given variable is externally defined. - * - * That is, is it an "existing" variable. - * - * @param non-empty-string $name - * - * @return bool - */ - private function isExternallyDefined(string $name) - { - return $this->reader->read($name)->isDefined() && !isset($this->loaded[$name]); - } -} diff --git a/src/Dotenv/Repository/Adapter/MultiReader.php b/src/Dotenv/Repository/Adapter/MultiReader.php deleted file mode 100644 index 0cfda6f6..00000000 --- a/src/Dotenv/Repository/Adapter/MultiReader.php +++ /dev/null @@ -1,48 +0,0 @@ -readers = $readers; - } - - /** - * Read an environment variable, if it exists. - * - * @param non-empty-string $name - * - * @return \PhpOption\Option - */ - public function read(string $name) - { - foreach ($this->readers as $reader) { - $result = $reader->read($name); - if ($result->isDefined()) { - return $result; - } - } - - return None::create(); - } -} diff --git a/src/Dotenv/Repository/Adapter/MultiWriter.php b/src/Dotenv/Repository/Adapter/MultiWriter.php deleted file mode 100644 index 15a9d8fd..00000000 --- a/src/Dotenv/Repository/Adapter/MultiWriter.php +++ /dev/null @@ -1,64 +0,0 @@ -writers = $writers; - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - foreach ($this->writers as $writers) { - if (!$writers->write($name, $value)) { - return false; - } - } - - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - foreach ($this->writers as $writers) { - if (!$writers->delete($name)) { - return false; - } - } - - return true; - } -} diff --git a/src/Dotenv/Repository/Adapter/PutenvAdapter.php b/src/Dotenv/Repository/Adapter/PutenvAdapter.php deleted file mode 100644 index 6d017cdb..00000000 --- a/src/Dotenv/Repository/Adapter/PutenvAdapter.php +++ /dev/null @@ -1,91 +0,0 @@ - - */ - public static function create() - { - if (self::isSupported()) { - /** @var \PhpOption\Option */ - return Some::create(new self()); - } - - return None::create(); - } - - /** - * Determines if the adapter is supported. - * - * @return bool - */ - private static function isSupported() - { - return \function_exists('getenv') && \function_exists('putenv'); - } - - /** - * Read an environment variable, if it exists. - * - * @param non-empty-string $name - * - * @return \PhpOption\Option - */ - public function read(string $name) - { - /** @var \PhpOption\Option */ - return Option::fromValue(\getenv($name), false)->filter(static function ($value) { - return \is_string($value); - }); - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - \putenv("$name=$value"); - - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - \putenv($name); - - return true; - } -} diff --git a/src/Dotenv/Repository/Adapter/ReaderInterface.php b/src/Dotenv/Repository/Adapter/ReaderInterface.php deleted file mode 100644 index 306a63fc..00000000 --- a/src/Dotenv/Repository/Adapter/ReaderInterface.php +++ /dev/null @@ -1,17 +0,0 @@ - - */ - public function read(string $name); -} diff --git a/src/Dotenv/Repository/Adapter/ReplacingWriter.php b/src/Dotenv/Repository/Adapter/ReplacingWriter.php deleted file mode 100644 index 98c0f041..00000000 --- a/src/Dotenv/Repository/Adapter/ReplacingWriter.php +++ /dev/null @@ -1,104 +0,0 @@ - - */ - private $seen; - - /** - * Create a new replacement writer instance. - * - * @param \Dotenv\Repository\Adapter\WriterInterface $writer - * @param \Dotenv\Repository\Adapter\ReaderInterface $reader - * - * @return void - */ - public function __construct(WriterInterface $writer, ReaderInterface $reader) - { - $this->writer = $writer; - $this->reader = $reader; - $this->seen = []; - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - if ($this->exists($name)) { - return $this->writer->write($name, $value); - } - - // succeed if nothing to do - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - if ($this->exists($name)) { - return $this->writer->delete($name); - } - - // succeed if nothing to do - return true; - } - - /** - * Does the given environment variable exist. - * - * Returns true if it currently exists, or existed at any point in the past - * that we are aware of. - * - * @param non-empty-string $name - * - * @return bool - */ - private function exists(string $name) - { - if (isset($this->seen[$name])) { - return true; - } - - if ($this->reader->read($name)->isDefined()) { - $this->seen[$name] = ''; - - return true; - } - - return false; - } -} diff --git a/src/Dotenv/Repository/Adapter/ServerConstAdapter.php b/src/Dotenv/Repository/Adapter/ServerConstAdapter.php deleted file mode 100644 index f93b6e5e..00000000 --- a/src/Dotenv/Repository/Adapter/ServerConstAdapter.php +++ /dev/null @@ -1,89 +0,0 @@ - - */ - public static function create() - { - /** @var \PhpOption\Option */ - return Some::create(new self()); - } - - /** - * Read an environment variable, if it exists. - * - * @param non-empty-string $name - * - * @return \PhpOption\Option - */ - public function read(string $name) - { - /** @var \PhpOption\Option */ - return Option::fromArraysValue($_SERVER, $name) - ->filter(static function ($value) { - return \is_scalar($value); - }) - ->map(static function ($value) { - if ($value === false) { - return 'false'; - } - - if ($value === true) { - return 'true'; - } - - /** @psalm-suppress PossiblyInvalidCast */ - return (string) $value; - }); - } - - /** - * Write to an environment variable, if possible. - * - * @param non-empty-string $name - * @param string $value - * - * @return bool - */ - public function write(string $name, string $value) - { - $_SERVER[$name] = $value; - - return true; - } - - /** - * Delete an environment variable, if possible. - * - * @param non-empty-string $name - * - * @return bool - */ - public function delete(string $name) - { - unset($_SERVER[$name]); - - return true; - } -} diff --git a/src/Dotenv/Repository/Adapter/WriterInterface.php b/src/Dotenv/Repository/Adapter/WriterInterface.php deleted file mode 100644 index 4cb3d61f..00000000 --- a/src/Dotenv/Repository/Adapter/WriterInterface.php +++ /dev/null @@ -1,27 +0,0 @@ -reader = $reader; - $this->writer = $writer; - } - - /** - * Determine if the given environment variable is defined. - * - * @param string $name - * - * @return bool - */ - public function has(string $name) - { - return '' !== $name && $this->reader->read($name)->isDefined(); - } - - /** - * Get an environment variable. - * - * @param string $name - * - * @throws \InvalidArgumentException - * - * @return string|null - */ - public function get(string $name) - { - if ('' === $name) { - throw new InvalidArgumentException('Expected name to be a non-empty string.'); - } - - return $this->reader->read($name)->getOrElse(null); - } - - /** - * Set an environment variable. - * - * @param string $name - * @param string $value - * - * @throws \InvalidArgumentException - * - * @return bool - */ - public function set(string $name, string $value) - { - if ('' === $name) { - throw new InvalidArgumentException('Expected name to be a non-empty string.'); - } - - return $this->writer->write($name, $value); - } - - /** - * Clear an environment variable. - * - * @param string $name - * - * @throws \InvalidArgumentException - * - * @return bool - */ - public function clear(string $name) - { - if ('' === $name) { - throw new InvalidArgumentException('Expected name to be a non-empty string.'); - } - - return $this->writer->delete($name); - } -} diff --git a/src/Dotenv/Repository/RepositoryBuilder.php b/src/Dotenv/Repository/RepositoryBuilder.php deleted file mode 100644 index a042f9a1..00000000 --- a/src/Dotenv/Repository/RepositoryBuilder.php +++ /dev/null @@ -1,272 +0,0 @@ -readers = $readers; - $this->writers = $writers; - $this->immutable = $immutable; - $this->allowList = $allowList; - } - - /** - * Create a new repository builder instance with no adapters added. - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public static function createWithNoAdapters() - { - return new self(); - } - - /** - * Create a new repository builder instance with the default adapters added. - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public static function createWithDefaultAdapters() - { - $adapters = \iterator_to_array(self::defaultAdapters()); - - return new self($adapters, $adapters); - } - - /** - * Return the array of default adapters. - * - * @return \Generator<\Dotenv\Repository\Adapter\AdapterInterface> - */ - private static function defaultAdapters() - { - foreach (self::DEFAULT_ADAPTERS as $adapter) { - $instance = $adapter::create(); - if ($instance->isDefined()) { - yield $instance->get(); - } - } - } - - /** - * Determine if the given name if of an adapterclass. - * - * @param string $name - * - * @return bool - */ - private static function isAnAdapterClass(string $name) - { - if (!\class_exists($name)) { - return false; - } - - return (new ReflectionClass($name))->implementsInterface(AdapterInterface::class); - } - - /** - * Creates a repository builder with the given reader added. - * - * Accepts either a reader instance, or a class-string for an adapter. If - * the adapter is not supported, then we silently skip adding it. - * - * @param \Dotenv\Repository\Adapter\ReaderInterface|string $reader - * - * @throws \InvalidArgumentException - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public function addReader($reader) - { - if (!(\is_string($reader) && self::isAnAdapterClass($reader)) && !($reader instanceof ReaderInterface)) { - throw new InvalidArgumentException( - \sprintf( - 'Expected either an instance of %s or a class-string implementing %s', - ReaderInterface::class, - AdapterInterface::class - ) - ); - } - - $optional = Some::create($reader)->flatMap(static function ($reader) { - return \is_string($reader) ? $reader::create() : Some::create($reader); - }); - - $readers = \array_merge($this->readers, \iterator_to_array($optional)); - - return new self($readers, $this->writers, $this->immutable, $this->allowList); - } - - /** - * Creates a repository builder with the given writer added. - * - * Accepts either a writer instance, or a class-string for an adapter. If - * the adapter is not supported, then we silently skip adding it. - * - * @param \Dotenv\Repository\Adapter\WriterInterface|string $writer - * - * @throws \InvalidArgumentException - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public function addWriter($writer) - { - if (!(\is_string($writer) && self::isAnAdapterClass($writer)) && !($writer instanceof WriterInterface)) { - throw new InvalidArgumentException( - \sprintf( - 'Expected either an instance of %s or a class-string implementing %s', - WriterInterface::class, - AdapterInterface::class - ) - ); - } - - $optional = Some::create($writer)->flatMap(static function ($writer) { - return \is_string($writer) ? $writer::create() : Some::create($writer); - }); - - $writers = \array_merge($this->writers, \iterator_to_array($optional)); - - return new self($this->readers, $writers, $this->immutable, $this->allowList); - } - - /** - * Creates a repository builder with the given adapter added. - * - * Accepts either an adapter instance, or a class-string for an adapter. If - * the adapter is not supported, then we silently skip adding it. We will - * add the adapter as both a reader and a writer. - * - * @param \Dotenv\Repository\Adapter\WriterInterface|string $adapter - * - * @throws \InvalidArgumentException - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public function addAdapter($adapter) - { - if (!(\is_string($adapter) && self::isAnAdapterClass($adapter)) && !($adapter instanceof AdapterInterface)) { - throw new InvalidArgumentException( - \sprintf( - 'Expected either an instance of %s or a class-string implementing %s', - WriterInterface::class, - AdapterInterface::class - ) - ); - } - - $optional = Some::create($adapter)->flatMap(static function ($adapter) { - return \is_string($adapter) ? $adapter::create() : Some::create($adapter); - }); - - $readers = \array_merge($this->readers, \iterator_to_array($optional)); - $writers = \array_merge($this->writers, \iterator_to_array($optional)); - - return new self($readers, $writers, $this->immutable, $this->allowList); - } - - /** - * Creates a repository builder with mutability enabled. - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public function immutable() - { - return new self($this->readers, $this->writers, true, $this->allowList); - } - - /** - * Creates a repository builder with the given allow list. - * - * @param string[]|null $allowList - * - * @return \Dotenv\Repository\RepositoryBuilder - */ - public function allowList(array $allowList = null) - { - return new self($this->readers, $this->writers, $this->immutable, $allowList); - } - - /** - * Creates a new repository instance. - * - * @return \Dotenv\Repository\RepositoryInterface - */ - public function make() - { - $reader = new MultiReader($this->readers); - $writer = new MultiWriter($this->writers); - - if ($this->immutable) { - $writer = new ImmutableWriter($writer, $reader); - } - - if ($this->allowList !== null) { - $writer = new GuardedWriter($writer, $this->allowList); - } - - return new AdapterRepository($reader, $writer); - } -} diff --git a/src/Dotenv/Repository/RepositoryInterface.php b/src/Dotenv/Repository/RepositoryInterface.php deleted file mode 100644 index d9b18a40..00000000 --- a/src/Dotenv/Repository/RepositoryInterface.php +++ /dev/null @@ -1,51 +0,0 @@ - - */ - public static function read(array $filePaths, bool $shortCircuit = true, string $fileEncoding = null) - { - $output = []; - - foreach ($filePaths as $filePath) { - $content = self::readFromFile($filePath, $fileEncoding); - if ($content->isDefined()) { - $output[$filePath] = $content->get(); - if ($shortCircuit) { - break; - } - } - } - - return $output; - } - - /** - * Read the given file. - * - * @param string $path - * @param string|null $encoding - * - * @throws \Dotenv\Exception\InvalidEncodingException - * - * @return \PhpOption\Option - */ - private static function readFromFile(string $path, string $encoding = null) - { - /** @var Option */ - $content = Option::fromValue(@\file_get_contents($path), false); - - return $content->flatMap(static function (string $content) use ($encoding) { - return Str::utf8($content, $encoding)->mapError(static function (string $error) { - throw new InvalidEncodingException($error); - })->success(); - }); - } -} diff --git a/src/Dotenv/Store/FileStore.php b/src/Dotenv/Store/FileStore.php deleted file mode 100644 index 43f6135c..00000000 --- a/src/Dotenv/Store/FileStore.php +++ /dev/null @@ -1,72 +0,0 @@ -filePaths = $filePaths; - $this->shortCircuit = $shortCircuit; - $this->fileEncoding = $fileEncoding; - } - - /** - * Read the content of the environment file(s). - * - * @throws \Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidPathException - * - * @return string - */ - public function read() - { - if ($this->filePaths === []) { - throw new InvalidPathException('At least one environment file path must be provided.'); - } - - $contents = Reader::read($this->filePaths, $this->shortCircuit, $this->fileEncoding); - - if (\count($contents) > 0) { - return \implode("\n", $contents); - } - - throw new InvalidPathException( - \sprintf('Unable to read any of the environment file(s) at [%s].', \implode(', ', $this->filePaths)) - ); - } -} diff --git a/src/Dotenv/Store/StoreBuilder.php b/src/Dotenv/Store/StoreBuilder.php deleted file mode 100644 index 304117fc..00000000 --- a/src/Dotenv/Store/StoreBuilder.php +++ /dev/null @@ -1,141 +0,0 @@ -paths = $paths; - $this->names = $names; - $this->shortCircuit = $shortCircuit; - $this->fileEncoding = $fileEncoding; - } - - /** - * Create a new store builder instance with no names. - * - * @return \Dotenv\Store\StoreBuilder - */ - public static function createWithNoNames() - { - return new self(); - } - - /** - * Create a new store builder instance with the default name. - * - * @return \Dotenv\Store\StoreBuilder - */ - public static function createWithDefaultName() - { - return new self([], [self::DEFAULT_NAME]); - } - - /** - * Creates a store builder with the given path added. - * - * @param string $path - * - * @return \Dotenv\Store\StoreBuilder - */ - public function addPath(string $path) - { - return new self(\array_merge($this->paths, [$path]), $this->names, $this->shortCircuit, $this->fileEncoding); - } - - /** - * Creates a store builder with the given name added. - * - * @param string $name - * - * @return \Dotenv\Store\StoreBuilder - */ - public function addName(string $name) - { - return new self($this->paths, \array_merge($this->names, [$name]), $this->shortCircuit, $this->fileEncoding); - } - - /** - * Creates a store builder with short circuit mode enabled. - * - * @return \Dotenv\Store\StoreBuilder - */ - public function shortCircuit() - { - return new self($this->paths, $this->names, true, $this->fileEncoding); - } - - /** - * Creates a store builder with the specified file encoding. - * - * @param string|null $fileEncoding - * - * @return \Dotenv\Store\StoreBuilder - */ - public function fileEncoding(string $fileEncoding = null) - { - return new self($this->paths, $this->names, $this->shortCircuit, $fileEncoding); - } - - /** - * Creates a new store instance. - * - * @return \Dotenv\Store\StoreInterface - */ - public function make() - { - return new FileStore( - Paths::filePaths($this->paths, $this->names), - $this->shortCircuit, - $this->fileEncoding - ); - } -} diff --git a/src/Dotenv/Store/StoreInterface.php b/src/Dotenv/Store/StoreInterface.php deleted file mode 100644 index 6f5b9862..00000000 --- a/src/Dotenv/Store/StoreInterface.php +++ /dev/null @@ -1,17 +0,0 @@ -content = $content; - } - - /** - * Read the content of the environment file(s). - * - * @return string - */ - public function read() - { - return $this->content; - } -} diff --git a/src/Dotenv/Util/Regex.php b/src/Dotenv/Util/Regex.php deleted file mode 100644 index 52c15780..00000000 --- a/src/Dotenv/Util/Regex.php +++ /dev/null @@ -1,112 +0,0 @@ - - */ - public static function matches(string $pattern, string $subject) - { - return self::pregAndWrap(static function (string $subject) use ($pattern) { - return @\preg_match($pattern, $subject) === 1; - }, $subject); - } - - /** - * Perform a preg match all, wrapping up the result. - * - * @param string $pattern - * @param string $subject - * - * @return \GrahamCampbell\ResultType\Result - */ - public static function occurrences(string $pattern, string $subject) - { - return self::pregAndWrap(static function (string $subject) use ($pattern) { - return (int) @\preg_match_all($pattern, $subject); - }, $subject); - } - - /** - * Perform a preg replace callback, wrapping up the result. - * - * @param string $pattern - * @param callable $callback - * @param string $subject - * @param int|null $limit - * - * @return \GrahamCampbell\ResultType\Result - */ - public static function replaceCallback(string $pattern, callable $callback, string $subject, int $limit = null) - { - return self::pregAndWrap(static function (string $subject) use ($pattern, $callback, $limit) { - return (string) @\preg_replace_callback($pattern, $callback, $subject, $limit ?? -1); - }, $subject); - } - - /** - * Perform a preg split, wrapping up the result. - * - * @param string $pattern - * @param string $subject - * - * @return \GrahamCampbell\ResultType\Result - */ - public static function split(string $pattern, string $subject) - { - return self::pregAndWrap(static function (string $subject) use ($pattern) { - /** @var string[] */ - return (array) @\preg_split($pattern, $subject); - }, $subject); - } - - /** - * Perform a preg operation, wrapping up the result. - * - * @template V - * - * @param callable(string):V $operation - * @param string $subject - * - * @return \GrahamCampbell\ResultType\Result - */ - private static function pregAndWrap(callable $operation, string $subject) - { - $result = $operation($subject); - - if (\preg_last_error() !== \PREG_NO_ERROR) { - /** @var \GrahamCampbell\ResultType\Result */ - return Error::create(\preg_last_error_msg()); - } - - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create($result); - } -} diff --git a/src/Dotenv/Util/Str.php b/src/Dotenv/Util/Str.php deleted file mode 100644 index 087e236a..00000000 --- a/src/Dotenv/Util/Str.php +++ /dev/null @@ -1,98 +0,0 @@ - - */ - public static function utf8(string $input, string $encoding = null) - { - if ($encoding !== null && !\in_array($encoding, \mb_list_encodings(), true)) { - /** @var \GrahamCampbell\ResultType\Result */ - return Error::create( - \sprintf('Illegal character encoding [%s] specified.', $encoding) - ); - } - $converted = $encoding === null ? - @\mb_convert_encoding($input, 'UTF-8') : - @\mb_convert_encoding($input, 'UTF-8', $encoding); - /** - * this is for support UTF-8 with BOM encoding - * @see https://en.wikipedia.org/wiki/Byte_order_mark - * @see https://github.com/vlucas/phpdotenv/issues/500 - */ - if (\substr($converted, 0, 3) == "\xEF\xBB\xBF") { - $converted = \substr($converted, 3); - } - /** @var \GrahamCampbell\ResultType\Result */ - return Success::create($converted); - } - - /** - * Search for a given substring of the input. - * - * @param string $haystack - * @param string $needle - * - * @return \PhpOption\Option - */ - public static function pos(string $haystack, string $needle) - { - /** @var \PhpOption\Option */ - return Option::fromValue(\mb_strpos($haystack, $needle, 0, 'UTF-8'), false); - } - - /** - * Grab the specified substring of the input. - * - * @param string $input - * @param int $start - * @param int|null $length - * - * @return string - */ - public static function substr(string $input, int $start, int $length = null) - { - return \mb_substr($input, $start, $length, 'UTF-8'); - } - - /** - * Compute the length of the given string. - * - * @param string $input - * - * @return int - */ - public static function len(string $input) - { - return \mb_strlen($input, 'UTF-8'); - } -} diff --git a/src/Dotenv/Validator.php b/src/Dotenv/Validator.php deleted file mode 100644 index 0c04ab62..00000000 --- a/src/Dotenv/Validator.php +++ /dev/null @@ -1,209 +0,0 @@ -repository = $repository; - $this->variables = $variables; - } - - /** - * Assert that each variable is present. - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function required() - { - return $this->assert( - static function (?string $value) { - return $value !== null; - }, - 'is missing' - ); - } - - /** - * Assert that each variable is not empty. - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function notEmpty() - { - return $this->assertNullable( - static function (string $value) { - return Str::len(\trim($value)) > 0; - }, - 'is empty' - ); - } - - /** - * Assert that each specified variable is an integer. - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function isInteger() - { - return $this->assertNullable( - static function (string $value) { - return \ctype_digit($value); - }, - 'is not an integer' - ); - } - - /** - * Assert that each specified variable is a boolean. - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function isBoolean() - { - return $this->assertNullable( - static function (string $value) { - if ($value === '') { - return false; - } - - return \filter_var($value, \FILTER_VALIDATE_BOOLEAN, \FILTER_NULL_ON_FAILURE) !== null; - }, - 'is not a boolean' - ); - } - - /** - * Assert that each variable is amongst the given choices. - * - * @param string[] $choices - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function allowedValues(array $choices) - { - return $this->assertNullable( - static function (string $value) use ($choices) { - return \in_array($value, $choices, true); - }, - \sprintf('is not one of [%s]', \implode(', ', $choices)) - ); - } - - /** - * Assert that each variable matches the given regular expression. - * - * @param string $regex - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function allowedRegexValues(string $regex) - { - return $this->assertNullable( - static function (string $value) use ($regex) { - return Regex::matches($regex, $value)->success()->getOrElse(false); - }, - \sprintf('does not match "%s"', $regex) - ); - } - - /** - * Assert that the callback returns true for each variable. - * - * @param callable(?string):bool $callback - * @param string $message - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function assert(callable $callback, string $message) - { - $failing = []; - - foreach ($this->variables as $variable) { - if ($callback($this->repository->get($variable)) === false) { - $failing[] = \sprintf('%s %s', $variable, $message); - } - } - - if (\count($failing) > 0) { - throw new ValidationException(\sprintf( - 'One or more environment variables failed assertions: %s.', - \implode(', ', $failing) - )); - } - - return $this; - } - - /** - * Assert that the callback returns true for each variable. - * - * Skip checking null variable values. - * - * @param callable(string):bool $callback - * @param string $message - * - * @throws \Dotenv\Exception\ValidationException - * - * @return \Dotenv\Validator - */ - public function assertNullable(callable $callback, string $message) - { - return $this->assert( - static function (?string $value) use ($callback) { - if ($value === null) { - return true; - } - - return $callback($value); - }, - $message - ); - } -} diff --git a/src/GrahamCampbell/ResultType/Error.php b/src/GrahamCampbell/ResultType/Error.php deleted file mode 100644 index 2c37c3e2..00000000 --- a/src/GrahamCampbell/ResultType/Error.php +++ /dev/null @@ -1,121 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace GrahamCampbell\ResultType; - -use PhpOption\None; -use PhpOption\Some; - -/** - * @template T - * @template E - * - * @extends \GrahamCampbell\ResultType\Result - */ -final class Error extends Result -{ - /** - * @var E - */ - private $value; - - /** - * Internal constructor for an error value. - * - * @param E $value - * - * @return void - */ - private function __construct($value) - { - $this->value = $value; - } - - /** - * Create a new error value. - * - * @template F - * - * @param F $value - * - * @return \GrahamCampbell\ResultType\Result - */ - public static function create($value) - { - return new self($value); - } - - /** - * Get the success option value. - * - * @return \PhpOption\Option - */ - public function success() - { - return None::create(); - } - - /** - * Map over the success value. - * - * @template S - * - * @param callable(T):S $f - * - * @return \GrahamCampbell\ResultType\Result - */ - public function map(callable $f) - { - return self::create($this->value); - } - - /** - * Flat map over the success value. - * - * @template S - * @template F - * - * @param callable(T):\GrahamCampbell\ResultType\Result $f - * - * @return \GrahamCampbell\ResultType\Result - */ - public function flatMap(callable $f) - { - /** @var \GrahamCampbell\ResultType\Result */ - return self::create($this->value); - } - - /** - * Get the error option value. - * - * @return \PhpOption\Option - */ - public function error() - { - return Some::create($this->value); - } - - /** - * Map over the error value. - * - * @template F - * - * @param callable(E):F $f - * - * @return \GrahamCampbell\ResultType\Result - */ - public function mapError(callable $f) - { - return self::create($f($this->value)); - } -} diff --git a/src/GrahamCampbell/ResultType/Result.php b/src/GrahamCampbell/ResultType/Result.php deleted file mode 100644 index 8c67bcdd..00000000 --- a/src/GrahamCampbell/ResultType/Result.php +++ /dev/null @@ -1,69 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace GrahamCampbell\ResultType; - -/** - * @template T - * @template E - */ -abstract class Result -{ - /** - * Get the success option value. - * - * @return \PhpOption\Option - */ - abstract public function success(); - - /** - * Map over the success value. - * - * @template S - * - * @param callable(T):S $f - * - * @return \GrahamCampbell\ResultType\Result - */ - abstract public function map(callable $f); - - /** - * Flat map over the success value. - * - * @template S - * @template F - * - * @param callable(T):\GrahamCampbell\ResultType\Result $f - * - * @return \GrahamCampbell\ResultType\Result - */ - abstract public function flatMap(callable $f); - - /** - * Get the error option value. - * - * @return \PhpOption\Option - */ - abstract public function error(); - - /** - * Map over the error value. - * - * @template F - * - * @param callable(E):F $f - * - * @return \GrahamCampbell\ResultType\Result - */ - abstract public function mapError(callable $f); -} diff --git a/src/GrahamCampbell/ResultType/Success.php b/src/GrahamCampbell/ResultType/Success.php deleted file mode 100644 index 27cd85ee..00000000 --- a/src/GrahamCampbell/ResultType/Success.php +++ /dev/null @@ -1,120 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace GrahamCampbell\ResultType; - -use PhpOption\None; -use PhpOption\Some; - -/** - * @template T - * @template E - * - * @extends \GrahamCampbell\ResultType\Result - */ -final class Success extends Result -{ - /** - * @var T - */ - private $value; - - /** - * Internal constructor for a success value. - * - * @param T $value - * - * @return void - */ - private function __construct($value) - { - $this->value = $value; - } - - /** - * Create a new error value. - * - * @template S - * - * @param S $value - * - * @return \GrahamCampbell\ResultType\Result - */ - public static function create($value) - { - return new self($value); - } - - /** - * Get the success option value. - * - * @return \PhpOption\Option - */ - public function success() - { - return Some::create($this->value); - } - - /** - * Map over the success value. - * - * @template S - * - * @param callable(T):S $f - * - * @return \GrahamCampbell\ResultType\Result - */ - public function map(callable $f) - { - return self::create($f($this->value)); - } - - /** - * Flat map over the success value. - * - * @template S - * @template F - * - * @param callable(T):\GrahamCampbell\ResultType\Result $f - * - * @return \GrahamCampbell\ResultType\Result - */ - public function flatMap(callable $f) - { - return $f($this->value); - } - - /** - * Get the error option value. - * - * @return \PhpOption\Option - */ - public function error() - { - return None::create(); - } - - /** - * Map over the error value. - * - * @template F - * - * @param callable(E):F $f - * - * @return \GrahamCampbell\ResultType\Result - */ - public function mapError(callable $f) - { - return self::create($this->value); - } -} diff --git a/src/PhpOption/LazyOption.php b/src/PhpOption/LazyOption.php deleted file mode 100644 index 9cb77c86..00000000 --- a/src/PhpOption/LazyOption.php +++ /dev/null @@ -1,175 +0,0 @@ - - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace PhpOption; - -use Traversable; - -/** - * @template T - * - * @extends Option - */ -final class LazyOption extends Option -{ - /** @var callable(mixed...):(Option) */ - private $callback; - - /** @var array */ - private $arguments; - - /** @var Option|null */ - private $option; - - /** - * @template S - * @param callable(mixed...):(Option) $callback - * @param array $arguments - * - * @return LazyOption - */ - public static function create($callback, array $arguments = []): self - { - return new self($callback, $arguments); - } - - /** - * @param callable(mixed...):(Option) $callback - * @param array $arguments - */ - public function __construct($callback, array $arguments = []) - { - if (!is_callable($callback)) { - throw new \InvalidArgumentException('Invalid callback given'); - } - - $this->callback = $callback; - $this->arguments = $arguments; - } - - public function isDefined(): bool - { - return $this->option()->isDefined(); - } - - public function isEmpty(): bool - { - return $this->option()->isEmpty(); - } - - public function get() - { - return $this->option()->get(); - } - - public function getOrElse($default) - { - return $this->option()->getOrElse($default); - } - - public function getOrCall($callable) - { - return $this->option()->getOrCall($callable); - } - - public function getOrThrow(\Exception $ex) - { - return $this->option()->getOrThrow($ex); - } - - public function orElse(Option $else) - { - return $this->option()->orElse($else); - } - - public function ifDefined($callable) - { - $this->option()->forAll($callable); - } - - public function forAll($callable) - { - return $this->option()->forAll($callable); - } - - public function map($callable) - { - return $this->option()->map($callable); - } - - public function flatMap($callable) - { - return $this->option()->flatMap($callable); - } - - public function filter($callable) - { - return $this->option()->filter($callable); - } - - public function filterNot($callable) - { - return $this->option()->filterNot($callable); - } - - public function select($value) - { - return $this->option()->select($value); - } - - public function reject($value) - { - return $this->option()->reject($value); - } - - /** - * @return Traversable - */ - public function getIterator(): Traversable - { - return $this->option()->getIterator(); - } - - public function foldLeft($initialValue, $callable) - { - return $this->option()->foldLeft($initialValue, $callable); - } - - public function foldRight($initialValue, $callable) - { - return $this->option()->foldRight($initialValue, $callable); - } - - /** - * @return Option - */ - private function option(): Option - { - if (null === $this->option) { - /** @var mixed */ - $option = call_user_func_array($this->callback, $this->arguments); - if ($option instanceof Option) { - $this->option = $option; - } else { - throw new \RuntimeException(sprintf('Expected instance of %s', Option::class)); - } - } - - return $this->option; - } -} diff --git a/src/PhpOption/None.php b/src/PhpOption/None.php deleted file mode 100644 index 4b85d22d..00000000 --- a/src/PhpOption/None.php +++ /dev/null @@ -1,136 +0,0 @@ - - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace PhpOption; - -use EmptyIterator; - -/** - * @extends Option - */ -final class None extends Option -{ - /** @var None|null */ - private static $instance; - - /** - * @return None - */ - public static function create(): self - { - if (null === self::$instance) { - self::$instance = new self(); - } - - return self::$instance; - } - - public function get() - { - throw new \RuntimeException('None has no value.'); - } - - public function getOrCall($callable) - { - return $callable(); - } - - public function getOrElse($default) - { - return $default; - } - - public function getOrThrow(\Exception $ex) - { - throw $ex; - } - - public function isEmpty(): bool - { - return true; - } - - public function isDefined(): bool - { - return false; - } - - public function orElse(Option $else) - { - return $else; - } - - public function ifDefined($callable) - { - // Just do nothing in that case. - } - - public function forAll($callable) - { - return $this; - } - - public function map($callable) - { - return $this; - } - - public function flatMap($callable) - { - return $this; - } - - public function filter($callable) - { - return $this; - } - - public function filterNot($callable) - { - return $this; - } - - public function select($value) - { - return $this; - } - - public function reject($value) - { - return $this; - } - - public function getIterator(): EmptyIterator - { - return new EmptyIterator(); - } - - public function foldLeft($initialValue, $callable) - { - return $initialValue; - } - - public function foldRight($initialValue, $callable) - { - return $initialValue; - } - - private function __construct() - { - } -} diff --git a/src/PhpOption/Option.php b/src/PhpOption/Option.php deleted file mode 100644 index 172924cf..00000000 --- a/src/PhpOption/Option.php +++ /dev/null @@ -1,434 +0,0 @@ - - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace PhpOption; - -use ArrayAccess; -use IteratorAggregate; - -/** - * @template T - * - * @implements IteratorAggregate - */ -abstract class Option implements IteratorAggregate -{ - /** - * Creates an option given a return value. - * - * This is intended for consuming existing APIs and allows you to easily - * convert them to an option. By default, we treat ``null`` as the None - * case, and everything else as Some. - * - * @template S - * - * @param S $value The actual return value. - * @param S $noneValue The value which should be considered "None"; null by - * default. - * - * @return Option - */ - public static function fromValue($value, $noneValue = null) - { - if ($value === $noneValue) { - return None::create(); - } - - return new Some($value); - } - - /** - * Creates an option from an array's value. - * - * If the key does not exist in the array, the array is not actually an - * array, or the array's value at the given key is null, None is returned. - * Otherwise, Some is returned wrapping the value at the given key. - * - * @template S - * - * @param array|ArrayAccess|null $array A potential array or \ArrayAccess value. - * @param string $key The key to check. - * - * @return Option - */ - public static function fromArraysValue($array, $key) - { - if (!(is_array($array) || $array instanceof ArrayAccess) || !isset($array[$key])) { - return None::create(); - } - - return new Some($array[$key]); - } - - /** - * Creates a lazy-option with the given callback. - * - * This is also a helper constructor for lazy-consuming existing APIs where - * the return value is not yet an option. By default, we treat ``null`` as - * None case, and everything else as Some. - * - * @template S - * - * @param callable $callback The callback to evaluate. - * @param array $arguments The arguments for the callback. - * @param S $noneValue The value which should be considered "None"; - * null by default. - * - * @return LazyOption - */ - public static function fromReturn($callback, array $arguments = [], $noneValue = null) - { - return new LazyOption(static function () use ($callback, $arguments, $noneValue) { - /** @var mixed */ - $return = call_user_func_array($callback, $arguments); - - if ($return === $noneValue) { - return None::create(); - } - - return new Some($return); - }); - } - - /** - * Option factory, which creates new option based on passed value. - * - * If value is already an option, it simply returns. If value is callable, - * LazyOption with passed callback created and returned. If Option - * returned from callback, it returns directly. On other case value passed - * to Option::fromValue() method. - * - * @template S - * - * @param Option|callable|S $value - * @param S $noneValue Used when $value is mixed or - * callable, for None-check. - * - * @return Option|LazyOption - */ - public static function ensure($value, $noneValue = null) - { - if ($value instanceof self) { - return $value; - } elseif (is_callable($value)) { - return new LazyOption(static function () use ($value, $noneValue) { - /** @var mixed */ - $return = $value(); - - if ($return instanceof self) { - return $return; - } else { - return self::fromValue($return, $noneValue); - } - }); - } else { - return self::fromValue($value, $noneValue); - } - } - - /** - * Lift a function so that it accepts Option as parameters. - * - * We return a new closure that wraps the original callback. If any of the - * parameters passed to the lifted function is empty, the function will - * return a value of None. Otherwise, we will pass all parameters to the - * original callback and return the value inside a new Option, unless an - * Option is returned from the function, in which case, we use that. - * - * @template S - * - * @param callable $callback - * @param mixed $noneValue - * - * @return callable - */ - public static function lift($callback, $noneValue = null) - { - return static function () use ($callback, $noneValue) { - /** @var array */ - $args = func_get_args(); - - $reduced_args = array_reduce( - $args, - /** @param bool $status */ - static function ($status, self $o) { - return $o->isEmpty() ? true : $status; - }, - false - ); - // if at least one parameter is empty, return None - if ($reduced_args) { - return None::create(); - } - - $args = array_map( - /** @return T */ - static function (self $o) { - // it is safe to do so because the fold above checked - // that all arguments are of type Some - /** @var T */ - return $o->get(); - }, - $args - ); - - return self::ensure(call_user_func_array($callback, $args), $noneValue); - }; - } - - /** - * Returns the value if available, or throws an exception otherwise. - * - * @throws \RuntimeException If value is not available. - * - * @return T - */ - abstract public function get(); - - /** - * Returns the value if available, or the default value if not. - * - * @template S - * - * @param S $default - * - * @return T|S - */ - abstract public function getOrElse($default); - - /** - * Returns the value if available, or the results of the callable. - * - * This is preferable over ``getOrElse`` if the computation of the default - * value is expensive. - * - * @template S - * - * @param callable():S $callable - * - * @return T|S - */ - abstract public function getOrCall($callable); - - /** - * Returns the value if available, or throws the passed exception. - * - * @param \Exception $ex - * - * @return T - */ - abstract public function getOrThrow(\Exception $ex); - - /** - * Returns true if no value is available, false otherwise. - * - * @return bool - */ - abstract public function isEmpty(); - - /** - * Returns true if a value is available, false otherwise. - * - * @return bool - */ - abstract public function isDefined(); - - /** - * Returns this option if non-empty, or the passed option otherwise. - * - * This can be used to try multiple alternatives, and is especially useful - * with lazy evaluating options: - * - * ```php - * $repo->findSomething() - * ->orElse(new LazyOption(array($repo, 'findSomethingElse'))) - * ->orElse(new LazyOption(array($repo, 'createSomething'))); - * ``` - * - * @param Option $else - * - * @return Option - */ - abstract public function orElse(self $else); - - /** - * This is similar to map() below except that the return value has no meaning; - * the passed callable is simply executed if the option is non-empty, and - * ignored if the option is empty. - * - * In all cases, the return value of the callable is discarded. - * - * ```php - * $comment->getMaybeFile()->ifDefined(function($file) { - * // Do something with $file here. - * }); - * ``` - * - * If you're looking for something like ``ifEmpty``, you can use ``getOrCall`` - * and ``getOrElse`` in these cases. - * - * @deprecated Use forAll() instead. - * - * @param callable(T):mixed $callable - * - * @return void - */ - abstract public function ifDefined($callable); - - /** - * This is similar to map() except that the return value of the callable has no meaning. - * - * The passed callable is simply executed if the option is non-empty, and ignored if the - * option is empty. This method is preferred for callables with side-effects, while map() - * is intended for callables without side-effects. - * - * @param callable(T):mixed $callable - * - * @return Option - */ - abstract public function forAll($callable); - - /** - * Applies the callable to the value of the option if it is non-empty, - * and returns the return value of the callable wrapped in Some(). - * - * If the option is empty, then the callable is not applied. - * - * ```php - * (new Some("foo"))->map('strtoupper')->get(); // "FOO" - * ``` - * - * @template S - * - * @param callable(T):S $callable - * - * @return Option - */ - abstract public function map($callable); - - /** - * Applies the callable to the value of the option if it is non-empty, and - * returns the return value of the callable directly. - * - * In contrast to ``map``, the return value of the callable is expected to - * be an Option itself; it is not automatically wrapped in Some(). - * - * @template S - * - * @param callable(T):Option $callable must return an Option - * - * @return Option - */ - abstract public function flatMap($callable); - - /** - * If the option is empty, it is returned immediately without applying the callable. - * - * If the option is non-empty, the callable is applied, and if it returns true, - * the option itself is returned; otherwise, None is returned. - * - * @param callable(T):bool $callable - * - * @return Option - */ - abstract public function filter($callable); - - /** - * If the option is empty, it is returned immediately without applying the callable. - * - * If the option is non-empty, the callable is applied, and if it returns false, - * the option itself is returned; otherwise, None is returned. - * - * @param callable(T):bool $callable - * - * @return Option - */ - abstract public function filterNot($callable); - - /** - * If the option is empty, it is returned immediately. - * - * If the option is non-empty, and its value does not equal the passed value - * (via a shallow comparison ===), then None is returned. Otherwise, the - * Option is returned. - * - * In other words, this will filter all but the passed value. - * - * @param T $value - * - * @return Option - */ - abstract public function select($value); - - /** - * If the option is empty, it is returned immediately. - * - * If the option is non-empty, and its value does equal the passed value (via - * a shallow comparison ===), then None is returned; otherwise, the Option is - * returned. - * - * In other words, this will let all values through except the passed value. - * - * @param T $value - * - * @return Option - */ - abstract public function reject($value); - - /** - * Binary operator for the initial value and the option's value. - * - * If empty, the initial value is returned. If non-empty, the callable - * receives the initial value and the option's value as arguments. - * - * ```php - * - * $some = new Some(5); - * $none = None::create(); - * $result = $some->foldLeft(1, function($a, $b) { return $a + $b; }); // int(6) - * $result = $none->foldLeft(1, function($a, $b) { return $a + $b; }); // int(1) - * - * // This can be used instead of something like the following: - * $option = Option::fromValue($integerOrNull); - * $result = 1; - * if ( ! $option->isEmpty()) { - * $result += $option->get(); - * } - * ``` - * - * @template S - * - * @param S $initialValue - * @param callable(S, T):S $callable - * - * @return S - */ - abstract public function foldLeft($initialValue, $callable); - - /** - * foldLeft() but with reversed arguments for the callable. - * - * @template S - * - * @param S $initialValue - * @param callable(T, S):S $callable - * - * @return S - */ - abstract public function foldRight($initialValue, $callable); -} diff --git a/src/PhpOption/Some.php b/src/PhpOption/Some.php deleted file mode 100644 index 032632ea..00000000 --- a/src/PhpOption/Some.php +++ /dev/null @@ -1,169 +0,0 @@ - - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace PhpOption; - -use ArrayIterator; - -/** - * @template T - * - * @extends Option - */ -final class Some extends Option -{ - /** @var T */ - private $value; - - /** - * @param T $value - */ - public function __construct($value) - { - $this->value = $value; - } - - /** - * @template U - * - * @param U $value - * - * @return Some - */ - public static function create($value): self - { - return new self($value); - } - - public function isDefined(): bool - { - return true; - } - - public function isEmpty(): bool - { - return false; - } - - public function get() - { - return $this->value; - } - - public function getOrElse($default) - { - return $this->value; - } - - public function getOrCall($callable) - { - return $this->value; - } - - public function getOrThrow(\Exception $ex) - { - return $this->value; - } - - public function orElse(Option $else) - { - return $this; - } - - public function ifDefined($callable) - { - $this->forAll($callable); - } - - public function forAll($callable) - { - $callable($this->value); - - return $this; - } - - public function map($callable) - { - return new self($callable($this->value)); - } - - public function flatMap($callable) - { - /** @var mixed */ - $rs = $callable($this->value); - if (!$rs instanceof Option) { - throw new \RuntimeException('Callables passed to flatMap() must return an Option. Maybe you should use map() instead?'); - } - - return $rs; - } - - public function filter($callable) - { - if (true === $callable($this->value)) { - return $this; - } - - return None::create(); - } - - public function filterNot($callable) - { - if (false === $callable($this->value)) { - return $this; - } - - return None::create(); - } - - public function select($value) - { - if ($this->value === $value) { - return $this; - } - - return None::create(); - } - - public function reject($value) - { - if ($this->value === $value) { - return None::create(); - } - - return $this; - } - - /** - * @return ArrayIterator - */ - public function getIterator(): ArrayIterator - { - return new ArrayIterator([$this->value]); - } - - public function foldLeft($initialValue, $callable) - { - return $callable($initialValue, $this->value); - } - - public function foldRight($initialValue, $callable) - { - return $callable($this->value, $initialValue); - } -}