Merge branch 'release/1.0.0'

Author: sebastiaanluca

CHANGELOG.md

@@ -6,6 +6,26 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ## Unreleased
 
+## 1.0.0 (2018-07-22)
+
 ### Added
 
--
+- rand_bool helper
+- str_wrap helper
+_ is\_assoc\_array helper
+- array_expand helper
+- array_without helper
+- array\_pull\_value helper
+- array\_pull\_values helper
+- array_hash helper
+- object_hash helper
+- has\_public\_method helper
+- carbon helper
+- create\_temporary\_file helper
+- sss helper
+- ddd helper
+- sss_if helper
+- ddd_if helper
+- Constants trait
+- ProvidesClassInfo trait
+- MethodHelper class

README.md

@@ -1,20 +1,14 @@
-<p align="center">
+# An extensive set of PHP helper functions and classes
+
 <a href="https://packagist.org/packages/sebastiaanluca/php-helpers"><img src="https://poser.pugx.org/sebastiaanluca/php-helpers/version" alt="Latest stable release"></img></a>
 <a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="Software license"></img></a>
 <a href="https://travis-ci.org/sebastiaanluca/php-helpers"><img src="https://img.shields.io/travis/sebastiaanluca/php-helpers/master.svg" alt="Build status"></img></a>
 <a href="https://packagist.org/packages/sebastiaanluca/php-helpers"><img src="https://img.shields.io/packagist/dt/sebastiaanluca/php-helpers.svg" alt="Total downloads"></img></a>
-</p>
 
-<p align="center">
 <a href="https://blog.sebastiaanluca.com"><img src="https://img.shields.io/badge/link-blog-lightgrey.svg" alt="Read my blog"></img></a>
 <a href="https://packagist.org/packages/sebastiaanluca"><img src="https://img.shields.io/badge/link-other_packages-lightgrey.svg" alt="View my other packages and projects"></img></a>
 <a href="https://twitter.com/sebastiaanluca"><img src="https://img.shields.io/twitter/follow/sebastiaanluca.svg?style=social" alt="Follow @sebastiaanluca on Twitter"></img></a>
 <a href="https://twitter.com/intent/tweet?text=Check%20out%20this%20extensive%20set%20of%20generic%20PHP%20helper%20functions%20and%20classes!%20Via%20@sebastiaanluca%20https://github.com/sebastiaanluca/php-helpers"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" alt="Share this package on Twitter"></img></a>
-</p>
-
-# PHP Helpers
-
-**An extensive set of PHP helper functions and classes.**
 
 ## Table of contents
 
@@ -32,7 +26,7 @@
     - [object_hash](#object_hash)
     - [has\_public\_method](#has_public_method)
     - [carbon](#carbon)
-    - [create\_temporary\_file](#create_temporary_file)
+    - [temporary_file](#temporary_file)
 - [Debug global helper functions](#debug-global-helper-functions)
     - [sss](#sss)
     - [ddd](#ddd)
@@ -273,7 +267,7 @@ Carbon\Carbon {
 */
 ```
 
-### create\_temporary\_file
+### temporary_file
 
 Create a temporary file.
 
@@ -284,7 +278,7 @@ The temporary file is readable and writeable by default. The file is automatical
 See [](http://php.net/manual/en/function.tmpfile.php) for more information.
 
 ```php
-create_temporary_file();
+temporary_file();
 
 /*
 [
@@ -576,7 +570,6 @@ If you discover any security related issues, please email [hello@sebastiaanluca.
 ## Credits
 
 - [Sebastiaan Luca][link-github-profile]
-- Logo by [Vitor Caneco](https://github.com/caneco)
 - [All Contributors][link-contributors]
 
 ## About

src/Classes/Constants.php

@@ -23,7 +23,7 @@ public static function constants() : array
      */
     public static function keys() : array
     {
-        return array_keys(static::all());
+        return array_keys(static::constants());
     }
 
     /**
@@ -33,6 +33,6 @@ public static function keys() : array
      */
     public static function values() : array
     {
-        return array_values(static::all());
+        return array_values(static::constants());
     }
 }

src/Classes/MethodHelper.php

@@ -25,8 +25,8 @@ public static function hasMethodOfType($object, $method, $type) : bool
 
         try {
             $reflection = new ReflectionMethod($object, $method);
-            // FIXME
-            $type = 'is' . studly_case($type);
+
+            $type = 'is' . ucfirst($type);
 
             return $reflection->{$type}();
         } catch (ReflectionException $exception) {

src/Functions/generic.php

@@ -2,6 +2,7 @@
 
 use Carbon\Carbon;
 use SebastiaanLuca\PhpHelpers\Classes\MethodHelper;
+use SebastiaanLuca\PhpHelpers\InternalHelpers;
 
 if (! function_exists('rand_bool')) {
     /**
@@ -64,8 +65,7 @@ function array_expand(array $array) : array
         $expanded = [];
 
         foreach ($array as $key => $value) {
-            // FIXME
-            array_set($expanded, $key, $value);
+            InternalHelpers::arraySet($expanded, $key, $value);
         }
 
         return $expanded;
@@ -83,8 +83,9 @@ function array_expand(array $array) : array
      */
     function array_without(array $array, $values) : array
     {
-        // FIXME
-        return array_values(array_diff($array, array_wrap($values)));
+        $values = ! is_array($values) ? [$values] : $values;
+
+        return array_values(array_diff($array, $values));
     }
 }
 
@@ -185,7 +186,7 @@ function carbon($timeString = null) : Carbon
     }
 }
 
-if (! function_exists('create_temporary_file')) {
+if (! function_exists('temporary_file')) {
     /**
      * Create a temporary file.
      *
@@ -197,7 +198,7 @@ function carbon($timeString = null) : Carbon
      *
      * @return array An array with  a `file` and `path` key.
      */
-    function create_temporary_file() : array
+    function temporary_file() : array
     {
         $file = tmpfile();
         $path = stream_get_meta_data($file)['uri'];

src/InternalHelpers.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SebastiaanLuca\PhpHelpers;
+
+class InternalHelpers
+{
+    /**
+     * Set an array item to a given value using "dot" notation.
+     *
+     * If no key is given to the method, the entire array will be replaced.
+     *
+     * @param array $array
+     * @param string $key
+     * @param mixed $value
+     *
+     * @return array
+     */
+    public static function arraySet(array &$array, string $key, $value) : array
+    {
+        $keys = explode('.', $key);
+
+        while (count($keys) > 1) {
+            $key = array_shift($keys);
+
+            // If the key doesn't exist at this depth, we will just create an empty array
+            // to hold the next value, allowing us to create the arrays to hold final
+            // values at the correct depth. Then we'll keep digging into the array.
+            if (! isset($array[$key]) || ! is_array($array[$key])) {
+                $array[$key] = [];
+            }
+
+            $array = &$array[$key];
+        }
+
+        $array[array_shift($keys)] = $value;
+
+        return $array;
+    }
+}

tests/Unit/Functions/GenericHelpersTest.php

@@ -118,17 +118,9 @@ public function object_hash generate an object hash() : void
     /**
      * @test
      */
-    public function carbonize creates a carbon instance from a string() : void
+    public function carbon creates a carbon instance from a string() : void
     {
-        $this->assertEquals(new Carbon('tomorrow'), carbonize('tomorrow'));
-    }
-
-    /**
-     * @test
-     */
-    public function take creates a pipe item() : void
-    {
-        $this->assertInstanceOf(Item::class, take('value'));
+        $this->assertEquals(new Carbon('tomorrow'), carbon('tomorrow'));
     }
 
     /**
@@ -154,9 +146,9 @@ public function myMethod()
     /**
      * @test
      */
-    public function create_temporary_file creates a temporary file and returns its pointer and full path() : void
+    public function temporary_file creates a temporary file and returns its pointer and full path() : void
     {
-        $file = create_temporary_file();
+        $file = temporary_file();
 
         $this->assertArrayHasKey('file', $file);
         $this->assertArrayHasKey('path', $file);
@@ -170,9 +162,9 @@ public function create_temporary_file creates a temporary file and returns
     /**
      * @test
      */
-    public function the file created by create_temporary_file is automatically deleted when it goes out of scope() : void
+    public function the file created by temporary_file is automatically deleted when it goes out of scope() : void
     {
-        $file = create_temporary_file();
+        $file = temporary_file();
 
         $path = $file['path'];