neatjson 0.6.2 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 600101c05a890e9aaf85cee5981faf1e8766fe00
-  data.tar.gz: 7e930b2089416b74b216e8ef16d19403f60abfff
+  metadata.gz: d8936fb4141535e1b7ff27991e518e2aa402c592
+  data.tar.gz: 9c7eb711499583c719c168cf3f29f443ec900082
 SHA512:
-  metadata.gz: a52b419bcd49ea08a13562ba167f9a087fe498f5ca7bbd5804be7ea8a1d02f6880f4f3da8b2a1732ec0211014d8acae32b2238101314be5b7275d0c8022eb820
-  data.tar.gz: 898b7829d5f7ef031821dedde48f50cdb5364228de69d8406fe315b1aec5b88cab4df21f4ef489d6af6ae93c7d0d8fe0ec1f3b6ae8cdfa9ad8c544b524c07ee7
+  metadata.gz: 3e4a1047b1cffdcaa584779dd0e5368d7353ee08272734855ac8249e500734b8bbe6d76cdcb316e2dadde9753b88e58ecb633753cbfca0ab06590aa6847a4ca6
+  data.tar.gz: 075950b5e26facacbb8c4b8aeda3b310c8e5cc705578e5e952254f29323ea2fd5c5c5945f011988937848f96104f53df3bf607e7b9a907dc6e3c2d1c7383e64e

data/README.md

@@ -1,194 +1,199 @@
-# NeatJSON
-
-[![Gem Version](https://badge.fury.io/rb/neatjson.svg)](http://badge.fury.io/rb/neatjson)
-[![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/neatjson?type=total&color=brightgreen)](https://rubygems.org/gems/neatjson)
-
-Pretty-print your JSON in Ruby with more power than is provided by `JSON.pretty_generate`. In particular, like Ruby's `pp` (pretty print), NeatJSON will keep objects on one line if they fit, but break them over multiple lines if needed.
-
-Here's an excerpt (from a much larger JSON):
-
-~~~ json
-{
-  "navigation.createroute.poi":[
-    {"text":"Lay in a course to the Hilton","params":{"poi":"Hilton"}},
-    {"text":"Take me to the airport","params":{"poi":"airport"}},
-    {"text":"Let's go to IHOP","params":{"poi":"IHOP"}},
-    {"text":"Show me how to get to The Med","params":{"poi":"The Med"}},
-    {"text":"Create a route to Arby's","params":{"poi":"Arby's"}},
-    {
-      "text":"Go to the Hilton by the Airport",
-      "params":{"poi":"Hilton","location":"Airport"}
-    },
-    {
-      "text":"Take me to the Fry's in Fresno",
-      "params":{"poi":"Fry's","location":"Fresno"}
-    }
-  ],
-  "navigation.eta":[
-    {"text":"When will we get there?"},
-    {"text":"When will I arrive?"},
-    {"text":"What time will I get to the destination?"},
-    {"text":"What time will I reach the destination?"},
-    {"text":"What time will it be when I arrive?"}
-  ]
-}
-~~~
-
-## Installation
-
-`gem install neatjson`
-
-## Examples
-
-~~~ ruby
-require 'neatjson'
-
-o = { b:42.005, a:[42,17], longer:true, str:"yes
-please" }
-
-puts JSON.neat_generate(o)
-#=> {"b":42.005,"a":[42,17],"longer":true,"str":"yes\nplease"}
-
-puts JSON.neat_generate(o,sorted:true)
-#=> {"a":[42,17],"b":42.005,"longer":true,"str":"yes\nplease"}
-
-puts JSON.neat_generate(o,sorted:true,padding:1,after_comma:1)
-#=> { "a":[ 42, 17 ], "b":42.005, "longer":true, "str":"yes\nplease" }
-
-puts JSON.neat_generate(o,sorted:true,wrap:40)
-#=> {
-#=>   "a":[42,17],
-#=>   "b":42.005,
-#=>   "longer":true,
-#=>   "str":"yes\nplease"
-#=> }
-
-puts JSON.neat_generate(o,sorted:true,wrap:40,decimals:2)
-#=> {
-#=>   "a":[42,17],
-#=>   "b":42.01,
-#=>   "longer":true,
-#=>   "str":"yes\nplease"
-#=> }
-
-puts JSON.neat_generate(o,sorted:true,wrap:40,aligned:true)
-#=> {
-#=>   "a"     :[42,17],
-#=>   "b"     :42.005,
-#=>   "longer":true,
-#=>   "str"   :"yes\nplease"
-#=> }
-
-puts JSON.neat_generate(o,sorted:true,wrap:40,aligned:true,around_colon:1)
-#=> {
-#=>   "a"      : [42,17],
-#=>   "b"      : 42.005,
-#=>   "longer" : true,
-#=>   "str"    : "yes\nplease"
-#=> }
-
-puts JSON.neat_generate(o,sorted:true,wrap:40,aligned:true,around_colon:1,short:true)
-#=> {"a"      : [42,17],
-#=>  "b"      : 42.005,
-#=>  "longer" : true,
-#=>  "str"    : "yes\nplease"}
-
-a = [1,2,[3,4,[5]]]
-puts JSON.neat_generate(a)
-#=> [1,2,[3,4,[5]]]
-
-puts JSON.pretty_generate(a) # oof!
-#=> [
-#=>   1,
-#=>   2,
-#=>   [
-#=>     3,
-#=>     4,
-#=>     [
-#=>       5
-#=>     ]
-#=>   ]
-#=> ]
-
-puts JSON.neat_generate( a, wrap:true, short:true )
-#=> [1,
-#=>  2,
-#=>  [3,
-#=>   4,
-#=>   [5]]]
-~~~
-
-## Options
-You may pass any of the following option symbols to `neat_generate`:
-
-* `:wrap`           — The maximum line width before wrapping. Use `false` to never wrap, or `true` (or `-1`) to always wrap. Default: `80`
-* `:indent`         — Whitespace used to indent each level when wrapping. Default: `"  "` (two spaces)
-* `:short`          — Keep the output 'short' when wrapping? This puts opening brackets on the same line as the first value, and closing brackets on the same line as the last. Default: `false`
-  * _This causes the `:indent` option to be ignored, instead basing indentation on array and object padding._
-* `:sorted`         — Sort the keys for objects to be in alphabetical order? Default: `false`
-* `:aligned`        — When wrapping objects, line up the colons (per object)? Default: `false`
-* `:decimals`       — Decimal precision to use for non-integer numbers; use `false` to keep float values precise. Default: `false`
-* `:array_padding`  — Number of spaces to put inside brackets for arrays. Default: `0`
-* `:object_padding` — Number of spaces to put inside braces for objects.  Default: `0`
-* `:padding`        — Shorthand to set both `:array_padding` and `:object_padding`. Default: `0`
-* `:before_comma`   — Number of spaces to put before commas (for both arrays and objects). Default: `0`
-* `:after_comma`    — Number of spaces to put after commas (for both arrays and objects). Default: `0`
-* `:around_comma`   — Shorthand to set both `:before_comma` and `:after_comma`. Default: `0`
-* `:before_colon_1` — Number of spaces before a colon when the object is on one line. Default: `0`
-* `:after_colon_1`  — Number of spaces after a colon when the object is on one line. Default: `0`
-* `:before_colon_n` — Number of spaces before a colon when the object is on multiple lines. Default: `0`
-* `:after_colon_n`  — Number of spaces after a colon when the object is on multiple lines. Default: `0`
-* `:before_colon`   — Shorthand to set both `:before_colon_1` and `:before_colon_n`. Default: `0`
-* `:after_colon`    — Shorthand to set both `:after_colon_1` and `:after_colon_n`. Default: `0`
-* `:around_colon`   — Shorthand to set both `:before_colon` and `:after_colon`. Default: `0`
-
-
-## License & Contact
-
-NeatJSON is copyright ©2015 by Gavin Kistner and is released under
-the [MIT License](http://www.opensource.org/licenses/mit-license.php).
-See the LICENSE.txt file for more details.
-
-For bugs or feature requests please open [issues on GitHub][1].
-For other communication you can [email the author directly](mailto:!@phrogz.net?subject=NeatJSON).
-
-## TODO (aka Known Limitations)
-
-* Figure out the best way to play with custom objects that use `to_json` for their representation.
-* Detect circular references.
-* Possibly allow illegal JSON values like `NaN` or `Infinity`.
-* Possibly allow "JSON5" output (legal identifiers unquoted, etc.)
-
-## HISTORY
-
-* **v0.6.1** - October 12th, 2015
-  * Fix handling of nested empty objects and arrays. (Would cause a runtime error in many cases.)
-    * _This change causes empty arrays in a tight wrapping scenario to appear on a single line where they would previously take up three lines._
-
-* **v0.6** - April 26th, 2015
-  * Added `before_colon_1` and `before_colon_n` to distinguish between single-line and multi-line objects.
-
-* **v0.5** - April 19th, 2015
-  * Do not format integers (or floats that equal their integer) using `decimals` option.
-  * Make `neatJSON()` JavaScript available to Node.js as well as web browsers.
-  * Add (Node-based) testing for the JavaScript version.
-
-* **v0.4** - April 18th, 2015
-  * Add JavaScript version with online runner.
-
-* **v0.3.2** - April 16th, 2015
-  * Force YARD to use Markdown for documentation.
-
-* **v0.3.1** - April 16th, 2015
-  * Remove some debugging code accidentally left in.
-
-* **v0.3** - April 16th, 2015
-  * Fix another bug with `short:true` and wrapping array values inside objects.
-
-* **v0.2** - April 16th, 2015
-  * Fix bug with `short:true` and wrapping values inside objects.
-
-* **v0.1** - April 15th, 2015
-  * Initial release.
-
-[1]: https://github.com/Phrogz/NeatJSON/issues
+# NeatJSON
+
+[![Gem Version](https://badge.fury.io/rb/neatjson.svg)](http://badge.fury.io/rb/neatjson)
+[![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/neatjson?type=total&color=brightgreen)](https://rubygems.org/gems/neatjson)
+
+Pretty-print your JSON in Ruby with more power than is provided by `JSON.pretty_generate`. In particular, like Ruby's `pp` (pretty print), NeatJSON will keep objects on one line if they fit, but break them over multiple lines if needed.
+
+Here's an excerpt (from a much larger JSON):
+
+~~~ json
+{
+  "navigation.createroute.poi":[
+    {"text":"Lay in a course to the Hilton","params":{"poi":"Hilton"}},
+    {"text":"Take me to the airport","params":{"poi":"airport"}},
+    {"text":"Let's go to IHOP","params":{"poi":"IHOP"}},
+    {"text":"Show me how to get to The Med","params":{"poi":"The Med"}},
+    {"text":"Create a route to Arby's","params":{"poi":"Arby's"}},
+    {
+      "text":"Go to the Hilton by the Airport",
+      "params":{"poi":"Hilton","location":"Airport"}
+    },
+    {
+      "text":"Take me to the Fry's in Fresno",
+      "params":{"poi":"Fry's","location":"Fresno"}
+    }
+  ],
+  "navigation.eta":[
+    {"text":"When will we get there?"},
+    {"text":"When will I arrive?"},
+    {"text":"What time will I get to the destination?"},
+    {"text":"What time will I reach the destination?"},
+    {"text":"What time will it be when I arrive?"}
+  ]
+}
+~~~
+
+## Installation
+
+`gem install neatjson`
+
+## Examples
+
+~~~ ruby
+require 'neatjson'
+
+o = { b:42.005, a:[42,17], longer:true, str:"yes
+please" }
+
+puts JSON.neat_generate(o)
+#=> {"b":42.005,"a":[42,17],"longer":true,"str":"yes\nplease"}
+
+puts JSON.neat_generate(o,sorted:true)
+#=> {"a":[42,17],"b":42.005,"longer":true,"str":"yes\nplease"}
+
+puts JSON.neat_generate(o,sorted:true,padding:1,after_comma:1)
+#=> { "a":[ 42, 17 ], "b":42.005, "longer":true, "str":"yes\nplease" }
+
+puts JSON.neat_generate(o,sorted:true,wrap:40)
+#=> {
+#=>   "a":[42,17],
+#=>   "b":42.005,
+#=>   "longer":true,
+#=>   "str":"yes\nplease"
+#=> }
+
+puts JSON.neat_generate(o,sorted:true,wrap:40,decimals:2)
+#=> {
+#=>   "a":[42,17],
+#=>   "b":42.01,
+#=>   "longer":true,
+#=>   "str":"yes\nplease"
+#=> }
+
+puts JSON.neat_generate(o,sorted:true,wrap:40,aligned:true)
+#=> {
+#=>   "a"     :[42,17],
+#=>   "b"     :42.005,
+#=>   "longer":true,
+#=>   "str"   :"yes\nplease"
+#=> }
+
+puts JSON.neat_generate(o,sorted:true,wrap:40,aligned:true,around_colon:1)
+#=> {
+#=>   "a"      : [42,17],
+#=>   "b"      : 42.005,
+#=>   "longer" : true,
+#=>   "str"    : "yes\nplease"
+#=> }
+
+puts JSON.neat_generate(o,sorted:true,wrap:40,aligned:true,around_colon:1,short:true)
+#=> {"a"      : [42,17],
+#=>  "b"      : 42.005,
+#=>  "longer" : true,
+#=>  "str"    : "yes\nplease"}
+
+a = [1,2,[3,4,[5]]]
+puts JSON.neat_generate(a)
+#=> [1,2,[3,4,[5]]]
+
+puts JSON.pretty_generate(a) # oof!
+#=> [
+#=>   1,
+#=>   2,
+#=>   [
+#=>     3,
+#=>     4,
+#=>     [
+#=>       5
+#=>     ]
+#=>   ]
+#=> ]
+
+puts JSON.neat_generate( a, wrap:true, short:true )
+#=> [1,
+#=>  2,
+#=>  [3,
+#=>   4,
+#=>   [5]]]
+~~~
+
+## Options
+You may pass any of the following option symbols to `neat_generate`:
+
+* `:wrap`           — The maximum line width before wrapping. Use `false` to never wrap, or `true` (or `-1`) to always wrap. Default: `80`
+* `:indent`         — Whitespace used to indent each level when wrapping. Default: `"  "` (two spaces)
+* `:indent_last`    — Indent the closing bracket/brace for arrays and objects? Default: `false`
+* `:short`          — Keep the output 'short' when wrapping? This puts opening brackets on the same line as the first value, and closing brackets on the same line as the last. Default: `false`
+  * _This causes the `:indent` and `:indent_last` options to be ignored, instead basing indentation on array and object padding._
+* `:sorted`         — Sort the keys for objects to be in alphabetical order? Default: `false`
+* `:aligned`        — When wrapping objects, line up the colons (per object)? Default: `false`
+* `:decimals`       — Decimal precision to use for non-integer numbers; use `false` to keep float values precise. Default: `false`
+* `:array_padding`  — Number of spaces to put inside brackets for arrays. Default: `0`
+* `:object_padding` — Number of spaces to put inside braces for objects.  Default: `0`
+* `:padding`        — Shorthand to set both `:array_padding` and `:object_padding`. Default: `0`
+* `:before_comma`   — Number of spaces to put before commas (for both arrays and objects). Default: `0`
+* `:after_comma`    — Number of spaces to put after commas (for both arrays and objects). Default: `0`
+* `:around_comma`   — Shorthand to set both `:before_comma` and `:after_comma`. Default: `0`
+* `:before_colon_1` — Number of spaces before a colon when the object is on one line. Default: `0`
+* `:after_colon_1`  — Number of spaces after a colon when the object is on one line. Default: `0`
+* `:before_colon_n` — Number of spaces before a colon when the object is on multiple lines. Default: `0`
+* `:after_colon_n`  — Number of spaces after a colon when the object is on multiple lines. Default: `0`
+* `:before_colon`   — Shorthand to set both `:before_colon_1` and `:before_colon_n`. Default: `0`
+* `:after_colon`    — Shorthand to set both `:after_colon_1` and `:after_colon_n`. Default: `0`
+* `:around_colon`   — Shorthand to set both `:before_colon` and `:after_colon`. Default: `0`
+
+
+## License & Contact
+
+NeatJSON is copyright ©2015 by Gavin Kistner and is released under
+the [MIT License](http://www.opensource.org/licenses/mit-license.php).
+See the LICENSE.txt file for more details.
+
+For bugs or feature requests please open [issues on GitHub][1].
+For other communication you can [email the author directly](mailto:!@phrogz.net?subject=NeatJSON).
+
+## TODO (aka Known Limitations)
+
+* Figure out the best way to play with custom objects that use `to_json` for their representation.
+* Detect circular references.
+* Possibly allow illegal JSON values like `NaN` or `Infinity`.
+* Possibly allow "JSON5" output (legal identifiers unquoted, etc.)
+
+## HISTORY
+
+* **v0.6.2** - February 8th, 2016
+  * Use memoization to avoid performance stalls when wrapping deeply-nested objects/arrays.  
+    _Thanks @chroche_
+
+* **v0.6.1** - October 12th, 2015
+  * Fix handling of nested empty objects and arrays. (Would cause a runtime error in many cases.)
+    * _This change causes empty arrays in a tight wrapping scenario to appear on a single line where they would previously take up three lines._
+
+* **v0.6** - April 26th, 2015
+  * Added `before_colon_1` and `before_colon_n` to distinguish between single-line and multi-line objects.
+
+* **v0.5** - April 19th, 2015
+  * Do not format integers (or floats that equal their integer) using `decimals` option.
+  * Make `neatJSON()` JavaScript available to Node.js as well as web browsers.
+  * Add (Node-based) testing for the JavaScript version.
+
+* **v0.4** - April 18th, 2015
+  * Add JavaScript version with online runner.
+
+* **v0.3.2** - April 16th, 2015
+  * Force YARD to use Markdown for documentation.
+
+* **v0.3.1** - April 16th, 2015
+  * Remove some debugging code accidentally left in.
+
+* **v0.3** - April 16th, 2015
+  * Fix another bug with `short:true` and wrapping array values inside objects.
+
+* **v0.2** - April 16th, 2015
+  * Fix bug with `short:true` and wrapping values inside objects.
+
+* **v0.1** - April 15th, 2015
+  * Initial release.
+
+[1]: https://github.com/Phrogz/NeatJSON/issues

data/lib/neatjson.rb

@@ -6,27 +6,28 @@ module JSON
 	# @author Gavin Kistner <!@phrogz.net>
 	# @param object [Object] the object to serialize
 	# @param opts [Hash] the formatting options
-	# @option opts [Integer] :wrap       (80)    The maximum line width before wrapping. Use `false` to never wrap, or `true` to always wrap.
-	# @option opts [String]  :indent     ("  ")  Whitespace used to indent each level when wrapping (without the :short option).
-	# @option opts [Boolean] :short      (false) Keep the output 'short' when wrapping, putting opening brackets on the same line as the first value, and closing brackets on the same line as the last item.
-	# @option opts [Boolean] :sorted     (false) Sort the keys for objects to be in alphabetical order.
-	# @option opts [Boolean] :aligned    (false) When wrapping objects, align the colons (only per object).
-	# @option opts [Integer] :decimals    (null) Decimal precision to use for floats; omit to keep numberic values precise.
-	# @option opts [Integer] :padding        (0) Number of spaces to put inside brackets/braces for both arrays and objects.
-	# @option opts [Integer] :array_padding  (0) Number of spaces to put inside brackets for arrays. Overrides `:padding`.
-	# @option opts [Integer] :object_padding (0) Number of spaces to put inside braces for objects. Overrides `:padding`.
-	# @option opts [Integer] :around_comma   (0) Number of spaces to put before/after commas (for both arrays and objects).
-	# @option opts [Integer] :before_comma   (0) Number of spaces to put before commas (for both arrays and objects).
-	# @option opts [Integer] :after_comma    (0) Number of spaces to put after commas (for both arrays and objects).
-	# @option opts [Integer] :around_colon   (0) Number of spaces to put before/after colons (for objects).
-	# @option opts [Integer] :before_colon   (0) Number of spaces to put before colons (for objects).
-	# @option opts [Integer] :after_colon    (0) Number of spaces to put after colons (for objects).
-	# @option opts [Integer] :around_colon_1 (0) Number of spaces to put before/after colons for single-line objects.
-	# @option opts [Integer] :before_colon_1 (0) Number of spaces to put before colons for single-line objects.
-	# @option opts [Integer] :after_colon_1  (0) Number of spaces to put after colons for single-line objects.
-	# @option opts [Integer] :around_colon_n (0) Number of spaces to put before/after colons for multi-line objects.
-	# @option opts [Integer] :before_colon_n (0) Number of spaces to put before colons for multi-line objects.
-	# @option opts [Integer] :after_colon_n  (0) Number of spaces to put after colons for multi-line objects.
+	# @option opts [Integer] :wrap        (80)    The maximum line width before wrapping. Use `false` to never wrap, or `true` to always wrap.
+	# @option opts [String]  :indent      ("  ")  Whitespace used to indent each level when wrapping (without the :short option).
+	# @option opts [Boolean] :indent_last (false) Indent the closing bracket for arrays and objects (without the :short option).
+	# @option opts [Boolean] :short       (false) Keep the output 'short' when wrapping, putting opening brackets on the same line as the first value, and closing brackets on the same line as the last item.
+	# @option opts [Boolean] :sorted      (false) Sort the keys for objects to be in alphabetical order.
+	# @option opts [Boolean] :aligned     (false) When wrapping objects, align the colons (only per object).
+	# @option opts [Integer] :decimals     (null) Decimal precision to use for floats; omit to keep numberic values precise.
+	# @option opts [Integer] :padding         (0) Number of spaces to put inside brackets/braces for both arrays and objects.
+	# @option opts [Integer] :array_padding   (0) Number of spaces to put inside brackets for arrays. Overrides `:padding`.
+	# @option opts [Integer] :object_padding  (0) Number of spaces to put inside braces for objects. Overrides `:padding`.
+	# @option opts [Integer] :around_comma    (0) Number of spaces to put before/after commas (for both arrays and objects).
+	# @option opts [Integer] :before_comma    (0) Number of spaces to put before commas (for both arrays and objects).
+	# @option opts [Integer] :after_comma     (0) Number of spaces to put after commas (for both arrays and objects).
+	# @option opts [Integer] :around_colon    (0) Number of spaces to put before/after colons (for objects).
+	# @option opts [Integer] :before_colon    (0) Number of spaces to put before colons (for objects).
+	# @option opts [Integer] :after_colon     (0) Number of spaces to put after colons (for objects).
+	# @option opts [Integer] :around_colon_1  (0) Number of spaces to put before/after colons for single-line objects.
+	# @option opts [Integer] :before_colon_1  (0) Number of spaces to put before colons for single-line objects.
+	# @option opts [Integer] :after_colon_1   (0) Number of spaces to put after colons for single-line objects.
+	# @option opts [Integer] :around_colon_n  (0) Number of spaces to put before/after colons for multi-line objects.
+	# @option opts [Integer] :before_colon_n  (0) Number of spaces to put before colons for multi-line objects.
+	# @option opts [Integer] :after_colon_n   (0) Number of spaces to put after colons for multi-line objects.
 	# @return [String] the JSON representation of the object.
 	def self.neat_generate(object,opts={})
 		opts[:wrap] = 80 unless opts.key?(:wrap)
@@ -80,7 +81,7 @@ module JSON
 						pieces.join ",\n"
 					else
 						indent2 = "#{indent}#{opts[:indent]}"
-						"#{indent}[\n#{o.map{ |v| build[ v, indent2 ] }.join ",\n"}\n#{indent}]"
+						"#{indent}[\n#{o.map{ |v| build[ v, indent2 ] }.join ",\n"}\n#{opts[:indent_last] ? indent2 : indent}]"
 					end
 
 				when Hash
@@ -126,7 +127,7 @@ module JSON
 									one_line
 								end
 							end
-							"#{indent}{\n#{keyvals.join(",\n")}\n#{indent}}"
+							"#{indent}{\n#{keyvals.join(",\n")}\n#{opts[:indent_last] ? indent2 : indent}}"
 						end
 					end