neatjson 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b69e23425f7658f7d0c5c0ec2c4a4b53992b9120
-  data.tar.gz: 1df4af5d7e34063d68a0321e4d5dfa30a1f3fbfa
+  metadata.gz: 2f7545da8e38d691cb0449295f34cdd8ea014d84
+  data.tar.gz: 3e10ff207247a397dc9c2efcea6375056995468e
 SHA512:
-  metadata.gz: ef1109ed0d1348e7e196e92129d12bc714918804e36b9ba754598ae1f543b9b6f3c6438aaa59baa56251d98d1989cb94fb9b6f8ecbe257a410800bb2ad82cc32
-  data.tar.gz: 9a4425fb526aabe6614b054cf9fd08f8ea9b7e6a9e18386386479aa85727d62000ba9f42321427e31652ba30df2e27b3514a2f963f0ec461c725f62c61dbebc2
+  metadata.gz: 2f9665339a7d3e524e798f40f555e76fa63eb1fd3daa443f76f66928d39165351fb77ee21ac0472950f5d5722b8f567a56d0b9529573f4772302bcdde5a52e19
+  data.tar.gz: b6a833def30e44660707afe2a3616340051c32775b460b4cea85fc5c1d9b373b868f71218ab473459ab87b40e067eff8d1a6ef53cd7415c251f1b4106ba15859

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,175 @@
+# NeatJSON
+
+[![Gem Version](https://badge.fury.io/rb/neatjson.svg)](http://badge.fury.io/rb/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:1)
+#=> {
+#=>   "a":[42.0,17.0],
+#=>   "b":42.0,
+#=>   "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 numbers; use `false` to keep numeric 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`   — Number of spaces to put before colons. Default: `0`
+* `:after_colon`    — Number of spaces to put after colons. 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.
+* Option for `around_colon` to only apply to multi-line objects.
+* Detect circular references.
+* Possibly allow illegal JSON values like `NaN` or `Infinity`.
+* Possibly allow "JSON5" output (legal identifiers unquoted, etc.)
+
+## HISTORY
+
+* **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/neatjson.gemspec

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'date'
+Gem::Specification.new do |s|
+	s.name        = "neatjson"
+	s.version     = "0.3.3"
+	s.date        = Date.today.iso8601
+	s.authors     = ["Gavin Kistner"]
+	s.email       = "gavin@phrogz.net"
+	s.homepage    = "http://github.com/Phrogz/NeatJSON"
+	s.summary     = "Pretty, powerful, flexible JSON generation."
+	s.description = "Generate JSON strings from Ruby objects with flexible formatting options. The most important feature is that it can behave like pp, keeping arrays and objects on a single line when they fit."
+	s.license     = "MIT license (MIT)"
+	s.files       = Dir.glob("{lib,test}/**/*") + ['LICENSE.txt', 'README.md', '.yardopts', __FILE__]
+	s.has_rdoc = 'yard'
+end

data/test/test_neatjson.rb

@@ -0,0 +1,138 @@
+require 'minitest/autorun'
+require '../lib/neatjson'
+
+class Dummy
+	def to_json(*a)
+		{a:1}.to_json(*a)
+	end
+end
+
+class Flexi
+	def to_json(*a)
+		JSON.neat_generate({a:1},*a)
+	end
+end
+
+class TestFlexiJSON < Minitest::Unit::TestCase
+	def test_booleans
+		assert_equal "true",       JSON.neat_generate(true)
+		assert_equal "false",      JSON.neat_generate(false)
+		assert_equal "null",       JSON.neat_generate(nil)
+	end
+
+	def test_numbers
+		assert_equal "5",          JSON.neat_generate(5)
+		assert_equal "4.2",        JSON.neat_generate(4.2)
+		assert_equal "4.20",       JSON.neat_generate(4.2,  decimals:2)
+		assert_equal "4.20",       JSON.neat_generate(4.199,decimals:2)
+		assert_equal "4.20",       JSON.neat_generate(4.204,decimals:2)
+
+		assert_equal "4",          JSON.neat_generate(4.2, decimals:0)
+		assert_equal "5",          JSON.neat_generate(4.9, decimals:0)
+		assert_equal "-2",         JSON.neat_generate(-1.9,decimals:0)
+		assert_equal "-2",         JSON.neat_generate(-2.4,decimals:0)
+
+		assert_equal "1.0e+23",    JSON.neat_generate(1e23)
+		assert_equal "1.0e-09",    JSON.neat_generate(1e-9)
+	end
+
+	def test_strings
+		assert_equal '"foo"',      JSON.neat_generate('foo')
+		assert_equal '"foo"',      JSON.neat_generate(:foo)
+		assert_equal '"foo\nbar"', JSON.neat_generate("foo\nbar")
+	end
+
+	def test_arrays
+		@a1 = [1,2,3,4,[5,6,7,[8,9,10],11,12]]
+		assert_equal "[1,2,3,4,[5,6,7,[8,9,10],11,12]]", JSON.neat_generate(@a1)
+		assert_equal "[\n  1,\n  2,\n  3,\n  4,\n  [5,6,7,[8,9,10],11,12]\n]", JSON.neat_generate(@a1,wrap:30)
+		assert_equal "[\n  1,\n  2,\n  3,\n  4,\n  [\n    5,\n    6,\n    7,\n    [8,9,10],\n    11,\n    12\n  ]\n]", JSON.neat_generate(@a1,wrap:20)
+		assert_equal "[\n  1,\n  2,\n  3,\n  4,\n  [\n    5,\n    6,\n    7,\n    [\n      8,\n      9,\n      10\n    ],\n    11,\n    12\n  ]\n]", JSON.neat_generate(@a1,wrap:true)
+		assert_equal "[\n\t1,\n\t2,\n\t3,\n\t4,\n\t[\n\t\t5,\n\t\t6,\n\t\t7,\n\t\t[\n\t\t\t8,\n\t\t\t9,\n\t\t\t10\n\t\t],\n\t\t11,\n\t\t12\n\t]\n]", JSON.neat_generate(@a1,wrap:true,indent:"\t")
+		assert_equal "[1,2,3,4,[5,6,7,[8,9,10],11,12]]", JSON.neat_generate(@a1,array_padding:0)
+		assert_equal "[ 1,2,3,4,[ 5,6,7,[ 8,9,10 ],11,12 ] ]", JSON.neat_generate(@a1,array_padding:1)
+		assert_equal "[  1,2,3,4,[  5,6,7,[  8,9,10  ],11,12  ]  ]", JSON.neat_generate(@a1,array_padding:2)
+		assert_equal "[1, 2, 3, 4, [5, 6, 7, [8, 9, 10], 11, 12]]", JSON.neat_generate(@a1,after_comma:1)
+		assert_equal "[ 1, 2, 3, 4, [ 5, 6, 7, [ 8, 9, 10 ], 11, 12 ] ]", JSON.neat_generate(@a1,after_comma:1,array_padding:1)
+		assert_equal "[1,\n 2,\n 3,\n 4,\n [5,\n  6,\n  7,\n  [8,\n   9,\n   10],\n  11,\n  12]]", JSON.neat_generate(@a1,short:true,wrap:true)
+		assert_equal "[1,\n 2,\n 3,\n 4,\n [5,\n  6,\n  7,\n  [8,\n   9,\n   10],\n  11,\n  12]]", JSON.neat_generate(@a1,short:true,wrap:true,after_comma:1)
+		assert_equal "[ 1,\n  2,\n  3,\n  4,\n  [ 5,\n    6,\n    7,\n    [ 8,\n      9,\n      10 ],\n    11,\n    12 ] ]", JSON.neat_generate(@a1,short:true,wrap:true,array_padding:1)
+
+		@a2 = [1,2,3]
+		assert_equal "[1,2,3]",     JSON.neat_generate(@a2)
+		assert_equal "[1 ,2 ,3]",   JSON.neat_generate(@a2,before_comma:1)
+		assert_equal "[1 , 2 , 3]", JSON.neat_generate(@a2,around_comma:1)
+	end
+
+	def test_hashes
+		@h1 = {b:1,a:2}
+		assert_equal '{"b":1,"a":2}', JSON.neat_generate(@h1)
+		assert_equal '{"a":2,"b":1}', JSON.neat_generate(@h1,sorted:true)
+
+		assert_equal '{"a":2, "b":1}',       JSON.neat_generate(@h1,sorted:true,after_comma:1)
+		assert_equal '{"a" :2,"b" :1}',      JSON.neat_generate(@h1,sorted:true,before_colon:1)
+		assert_equal '{"a": 2,"b": 1}',      JSON.neat_generate(@h1,sorted:true,after_colon:1)
+		assert_equal '{"a" : 2,"b" : 1}',    JSON.neat_generate(@h1,sorted:true,before_colon:1,after_colon:1)
+		assert_equal '{"a" : 2, "b" : 1}',   JSON.neat_generate(@h1,sorted:true,before_colon:1,after_colon:1,after_comma:1)
+		assert_equal '{ "a" : 2, "b" : 1 }', JSON.neat_generate(@h1,sorted:true,before_colon:1,after_colon:1,after_comma:1,padding:1)
+		assert_equal '{ "a" : 2, "b" : 1 }', JSON.neat_generate(@h1,sorted:true,around_colon:1,after_comma:1,object_padding:1)
+		assert_equal '{"a" : 2, "b" : 1}',   JSON.neat_generate(@h1,sorted:true,before_colon:1,after_colon:1,after_comma:1,array_padding:1)
+		assert_equal '{  "a"  :  2, "b"  :  1  }', JSON.neat_generate(@h1,sorted:true,around_colon:2,after_comma:1,padding:2)
+		assert_equal '{  "a":2, "b":1  }', JSON.neat_generate(@h1,sorted:true,after_comma:1,padding:2)
+
+		@h2 = {b:1,aaa:2,cc:3}
+		assert_equal %Q{{\n  "b":1,\n  "aaa":2,\n  "cc":3\n}},    JSON.neat_generate(@h2,wrap:true)
+		assert_equal %Q{{\n  "b"  :1,\n  "aaa":2,\n  "cc" :3\n}}, JSON.neat_generate(@h2,wrap:true,aligned:true)
+		assert_equal %Q{{"b":1,"aaa":2,"cc":3}},                  JSON.neat_generate(@h2,aligned:true)
+		assert_equal %Q{{\n  "aaa":2,\n  "b"  :1,\n  "cc" :3\n}}, JSON.neat_generate(@h2,wrap:true,aligned:true,sorted:true)
+
+		@h3 = {a:1}
+		assert_equal '{"a":1}', JSON.neat_generate(@h3)
+		assert_equal "{\n  \"a\":1\n}", JSON.neat_generate(@h3,wrap:true)
+
+		@h4 = { b:17, a:42 }
+		assert_equal "{\"a\":42,\n \"b\":17}", JSON.neat_generate(@h4,wrap:10,sorted:true,short:true)
+	end
+
+	def test_mixed
+		a = [1,{a:2},3]
+		assert_equal '[1,{"a":2},3]', JSON.neat_generate(a)
+		assert_equal '[ 1,{ "a":2 },3 ]', JSON.neat_generate(a,padding:1)
+		assert_equal '[ 1, { "a":2 }, 3 ]', JSON.neat_generate(a,padding:1,after_comma:1)
+		assert_equal %Q{[\n  1,\n  {\n    "a":2\n  },\n  3\n]}, JSON.neat_generate(a,wrap:true)
+		assert_equal %Q{[\n  1,\n  {"a":2},\n  3\n]}, JSON.neat_generate(a,wrap:10)
+
+		a = [1,{a:2,b:3},4]
+		assert_equal "[1,\n {\"a\":2,\n  \"b\":3},\n 4]", JSON.neat_generate(a,wrap:0,short:true)
+
+		h = {a:1,b:[2,3,4],c:3}
+		assert_equal '{"a":1,"b":[2,3,4],"c":3}', JSON.neat_generate(h)
+		assert_equal %Q{{\n  "a":1,\n  "b":[2,3,4],\n  "c":3\n}}, JSON.neat_generate(h,wrap:10)
+		assert_equal %Q{{\n  "a":1,\n  "b":[\n    2,\n    3,\n    4\n  ],\n  "c":3\n}}, JSON.neat_generate(h,wrap:true)
+
+		h = {hooo:42,whee:%w[yaaa oooo booy],zoop:"whoop"}
+		assert_equal <<-ENDFORMAT.chomp, JSON.neat_generate(h,wrap:20,short:true)
+{"hooo":42,
+ "whee":["yaaa",
+         "oooo",
+         "booy"],
+ "zoop":"whoop"}
+		ENDFORMAT
+
+		h = { a:[ {x:"foo",y:"jim"}, {x:"bar",y:"jam"} ] }
+		assert_equal <<-ENDFORMAT.chomp, JSON.neat_generate(h,wrap:true,short:true)
+{"a":[{"x":"foo",
+       "y":"jim"},
+      {"x":"bar",
+       "y":"jam"}]}
+		ENDFORMAT
+	end
+
+	def test_custom
+		assert_equal '{  "a":1}', JSON.neat_generate(Dummy.new)
+		assert_equal '{  "a":1}', JSON.neat_generate(Dummy.new,wrap:true)
+		assert_equal '{"a":1}',   JSON.neat_generate(Dummy.new,indent:'')
+		assert_equal '{"a":1}',   JSON.neat_generate(Flexi.new)
+		assert_equal "{\n  \"a\":1\n}", JSON.neat_generate(Flexi.new,wrap:true)
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neatjson
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Gavin Kistner
@@ -10,13 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-04-16 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: Generate JSON strings from Ruby objects with flexible formatting options.
+  The most important feature is that it can behave like pp, keeping arrays and objects
+  on a single line when they fit.
 email: gavin@phrogz.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/neatjson.rb
+- test/test_neatjson.rb
+- LICENSE.txt
+- README.md
+- .yardopts
+- neatjson.gemspec
 homepage: http://github.com/Phrogz/NeatJSON
 licenses:
 - MIT license (MIT)
@@ -37,9 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Pretty, powerful, flexible JSON generation.
 test_files: []
-has_rdoc: yard