neatjson 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c99029c0e8a8363d4ab6bd23f896d1fedcc974c4
-  data.tar.gz: 3333be532eb6cd3727112ab8a1545f112c59355a
+  metadata.gz: f556263adaff6b70e7bfd65cf52dcc2062762d12
+  data.tar.gz: 5779d4d99498f69d6725e976def3027b8e31d1f1
 SHA512:
-  metadata.gz: 419059cab47ec8ac138eaebbd010fb73743c42c044ebc57248ede55633023a53a010a3dc5eb402fc2756d006dd7982297e6b8921b41f56fe56950d782aad04a8
-  data.tar.gz: d0fb8d4847415517f6ec0a5007c68a100abacb0d46010ea549e38df1a8e407caf92f4dbaa1c716d6b6b53fb31d884f83379dd84a0f7a64076258492711ecaad1
+  metadata.gz: 0a241006728605936eaeab0f932b701a881d920c14d5f753e0781848f38b180224e218ea05c19c6c448d501b82830ea039f9721dde892ca9ae506f014c758731
+  data.tar.gz: e9b96893f587a3003d5949567322ece126e19015775948d4b0e525a8e07533b68795703c2569b3ab7fc1e95cf0260b6a88baa15ed4ba2bcba32d9e70a98669e6

data/README.md

@@ -3,9 +3,22 @@
 [![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.
+Pretty-print your JSON in Ruby or JavaScript with more power than is provided by `JSON.pretty_generate` (Ruby) or `JSON.stringify` (JS). For example, like Ruby's `pp` (pretty print), NeatJSON can 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):
+**Features (all optional):**
+
+* Keep values on one line, with variable wrap width.
+* Format numeric values to specified precision.
+* Sort object keys to be in alphabetical order.
+* Arbitrary whitespace (or really, any string) for indentation.
+* "Short" wrapping uses fewer lines, indentation based on values. (See last example below.)
+* Indent final closing bracket/brace for each array/object.
+* Adjust number of spaces inside array/object braces.
+* Adjust number of spaces before/after commas and colons (adjustable for single-line vs. multi-line )
+* Line up the values for an object across lines.
+* [Online webpage](http://phrogz.net/JS/NeatJSON) for conversions and experimenting with options.
+
+Here's a short example of output showing the power of proper wrapping:
 
 ~~~ json
 {
@@ -36,7 +49,9 @@ Here's an excerpt (from a much larger JSON):
 
 ## Installation
 
-`gem install neatjson`
+* Ruby: `gem install neatjson`
+* JavaScript: Clone the GitHub repo and copy `javascript/neatjson.js`
+  * _Sorry, no NodeJS package yet._
 
 ## Examples
 
@@ -116,6 +131,22 @@ puts JSON.neat_generate( a, wrap:true, short:true )
 #=>  [3,
 #=>   4,
 #=>   [5]]]
+
+data = ["foo","bar",{dogs:42,piggies:{color:'pink', tasty:true},
+        barn:{jimmy:[1,2,3,4,5],jammy:3.141592653,hot:"pajammy"},cats:7}]
+
+opts = { short:true, wrap:60, decimals:3, sort:true, aligned:true,
+         padding:1, after_comma:1, around_colon_n:1 }
+
+puts JSON.neat_generate( data, opts )
+#=> [ "foo",
+#=>   "bar",
+#=>   { "barn"    : { "hot"   : "pajammy",
+#=>                   "jammy" : 3.142,
+#=>                   "jimmy" : [ 1, 2, 3, 4, 5 ] },
+#=>     "cats"    : 7,
+#=>     "dogs"    : 42,
+#=>     "piggies" : { "color":"pink", "tasty":true } } ]
 ~~~
 
 ## Options
@@ -126,7 +157,8 @@ You may pass any of the following option symbols to `neat_generate`:
 * `: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._
-* `:sort`           — Sort the keys for objects to be in alphabetical order (`true`), or supply a lambda for customized sort order. Default: `false`
+* `:sort`           — Sort objects' keys in alphabetical order (`true`), or supply a lambda for custom sorting. Default: `false`
+  * If you supply a lambda to the `sort` option, it will be passed three values: the (string) name of the key, the associated value, and the object being sorted, e.g. `{ sort:->(key,value,hash){ Float(value) rescue Float::MAX } }`
 * `: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`
@@ -143,13 +175,7 @@ You may pass any of the following option symbols to `neat_generate`:
 * `: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`
 
-If you supply a lambda to the `sort` option, it will be passed three values:
-
-* The string name of the object key.
-* The associated value.
-* The object being sorted.
-
-For example:
+You may omit the 'value' and/or 'object' parameters in your `sort` lambda if desired. For example:
 
 ~~~ ruby
 # Ruby sorting examples
@@ -161,7 +187,7 @@ JSON.neat_generate obj, sort:true                              # sort by key nam
 JSON.neat_generate obj, sort:->(k){ k }                        # sort by key name (long way)
 #=> {"a":2,"b":2,"c":3,"d":1,"e":3,"f":3}
 
-JSON.neat_generate obj, sort:->(k,v){ [-v,k] }                 # sort by descending value, ascending key
+JSON.neat_generate obj, sort:->(k,v){ [-v,k] }                 # sort by descending value, then by ascending key
 #=> {"c":3,"e":3,"f":3,"a":2,"b":2,"d":1}
 
 JSON.neat_generate obj, sort:->(k,v,h){ h.values.count(v) }    # sort by count of keys with same value
@@ -208,6 +234,12 @@ For other communication you can [email the author directly](mailto:!@phrogz.net?
 
 ## HISTORY
 
+* **v0.8.2** - December 16th, 2016
+  * Fix issue #22: Sorting keys on multi-line object does not work without "short" [JS only]
+  * Update online interface to support tabs as well as spaces.
+  * Update online interface to use a textarea for the output (easier to select and copy).
+  * Update online interface turn off spell checking for input and output.
+
 * **v0.8.1** - April 22nd, 2016
   * Make NeatJSON work with [Opal](http://opalrb.org) (by removing all in-place string mutations)
 

data/neatjson.gemspec

@@ -2,7 +2,7 @@
 require 'date'
 Gem::Specification.new do |s|
 	s.name          = "neatjson"
-	s.version       = "0.8.1"
+	s.version       = "0.8.2"
 	s.date          = Date.today.iso8601
 	s.authors       = ["Gavin Kistner"]
 	s.email         = "gavin@phrogz.net"

data/test/test_neatjson.js

@@ -4,7 +4,9 @@ var count=0, pass=0;
 require('./tests.js').tests.forEach(function(valTest){
 	var value = valTest.value;
 	valTest.tests.forEach(function(test){
-		var cmd = "neatJSON("+JSON.stringify(value)+(test.opts?","+JSON.stringify(test.opts):'')+")";
+		var cmdOpts = test.opts ? JSON.parse(JSON.stringify(test.opts)) : '';
+		if (test.opts && typeof test.opts.sort==='function') cmdOpts.sort = test.opts.sort+'';
+		var cmd = "neatJSON("+JSON.stringify(value)+(test.opts?","+JSON.stringify(cmdOpts):'')+")";
 		try{
 			if (test.opts){
 				var opts = {};
@@ -22,7 +24,7 @@ require('./tests.js').tests.forEach(function(valTest){
 				console.log('ACTUAL');
 				console.log(json,"\n");
 			}
-		} catch (e){
+		} catch(e) {
 			console.log("Error running "+cmd);
 			console.log(e.stack);
 			console.log("")

data/test/tests.js

@@ -98,6 +98,9 @@ exports.tests = [
 
 	{value:{ b:17, a:42 }, tests:[
 		{ json:"{\"a\":42,\n \"b\":17}", opts:{wrap:10,sorted:true,short:true} },
+		{ json:"{\"a\":42,\n \"b\":17}", opts:{wrap:10,sort:true,  short:true} },
+		{ json:"{\n  \"a\":42,\n  \"b\":17\n}", opts:{wrap:1,sorted:true} },
+		{ json:"{\n  \"a\":42,\n  \"b\":17\n}", opts:{wrap:1,sort:true} },
 		{ json:"{\"a\":42,\"b\":17}",    opts:{wrap:false,sort:function(k){     return k              } } },
 		{ json:"{\"b\":17,\"a\":42}",    opts:{wrap:false,sort:function(k,v){   return v              } } },
 		{ json:"{\"a\":42,\"b\":17}",    opts:{wrap:false,sort:function(k,v){   return -v             } } },

data/test/tests.rb

@@ -93,7 +93,10 @@ TESTS = [
 	]},
 
 	{value:{ b:17, a:42 }, tests:[
-		{ json:"{\"a\":42,\n \"b\":17}", opts:{wrap:10,sort:true,short:true} },
+		{ json:"{\"a\":42,\n \"b\":17}", opts:{wrap:10,sorted:true,short:true} },
+		{ json:"{\"a\":42,\n \"b\":17}", opts:{wrap:10,sort:true,  short:true} },
+		{ json:"{\n  \"a\":42,\n  \"b\":17\n}", opts:{wrap:1,sorted:true} },
+		{ json:"{\n  \"a\":42,\n  \"b\":17\n}", opts:{wrap:1,sort:true} },
 		{ json:"{\"a\":42,\"b\":17}", opts:{wrap:false,sort:->(k){   k } } },
 		{ json:"{\"b\":17,\"a\":42}", opts:{wrap:false,sort:->(k,v){ v } } },
 		{ json:"{\"a\":42,\"b\":17}", opts:{wrap:false,sort:->(k,v){ -v } } },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neatjson
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Gavin Kistner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies: []
 description: 'Generate JSON strings from Ruby objects with flexible formatting options.
   Key features: keep arrays and objects on a single line when they fit; format floats