Merge pull request #44 from MarcinOrlowski/rb-42-change-default-encoding-options

[RB-42] change default encoding options

Author: MarcinOrlowski

CHANGES.md

@@ -1,16 +1,15 @@
 # API Response Builder for Laravel 5 #
 
-
 See [compatibility docs](docs/compatibility.md) for details about backward compatibility!
 
-
 ## CHANGE LOG ##
 
 * @dev
+   * [RB-42] Default value of `encoding_options` include `JSON_UNESCAPED_UNICODE` to prevent unicode escaping
    * [RB-41] Updated documentation
 
 * v3.1.0 (2017-02-28)
-   * [RB-38] Added `encoding-options` to control data-to-json conversion.
+   * [RB-38] Added `encoding_options` to control data-to-json conversion.
    * [RB-38] Added optional encoding options args to all methods accepting `data` argument
    * [RB-34] Added option to control ExceptionHandeler behavior on debug builds
    * ExceptionHandler's debug is now added as `debug` node to make it more clear where it comes from
@@ -109,3 +108,4 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 * v1.0.0 (2016-04-11)
    * Initial public release
+

config/response_builder.php

@@ -94,16 +94,16 @@
 	| to be returned escaped, which while technically correct (ant theoretically
 	| transparent) might not be desired effects.
 	|
-	| To prevent escaping, add JSON_UNESCAPED_UNICODE:
+	| To prevent escaping, add JSON_UNESCAPED_UNICODE (default since v3.2):
 	|    JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE
 	|
-	| Default value:
+	| Laravel's value:
 	|    JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT
 	|
 	| See http://php.net/manual/en/function.json-encode.php for details
 	|
 	*/
-	'encoding_options' => JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT,
+	'encoding_options' => JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE,
 
 
 	/*

src/ResponseBuilder.php

@@ -40,11 +40,11 @@ class ResponseBuilder
 	/**
 	 * Default JSON encoding options
 	 *
-	 * 15 = JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT
+	 * 271 = JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE
 	 *
 	 * This must be as int due to const limits in PHP disallowing expressions.
 	 */
-	const DEFAULT_ENCODING_OPTIONS = 15;
+	const DEFAULT_ENCODING_OPTIONS = 271;
 
 	/**
 	 * Reads and validates "classes" config mapping

tests/InternalsTest.php

@@ -69,13 +69,14 @@ public function testMake_InvalidEncodingOptions()
 	}
 
 	/**
-	 * Tests if JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT matches const value of DEFAULT_ENODING_OPTIONS
+	 * Tests if dist's config detaults matches ResponseBuilder::DEFAULT_ENODING_OPTIONS
 	 *
 	 * @return void
 	 */
 	public function testDefaultEncodingOptionValue()
 	{
-		$this->assertEquals(JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);
+		$config_defaults = \Config::get('response_builder.encoding_options');
+		$this->assertEquals($config_defaults, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);
 	}
 
 	/**
@@ -87,7 +88,7 @@ public function testMake_DefaultEncodingOptions()
 	{
 		// source data
 		$test_string = 'ąćę';
-		$test_string_escaped = $this->escape8($test_string);
+//		$test_string_escaped = $this->escape8($test_string);
 		$data = ['test' => $test_string];
 
 		// fallback defaults in action