tjson 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a874be0629fb8b05f091435d8589d5d789a44865
-  data.tar.gz: 55d8f97a15fbcab3fd4022a8639d0d386e59e511
+  metadata.gz: 3062690d7f47d6c5294c379941cc4638495879a6
+  data.tar.gz: 7ff998fe639a348f1c4b3a15a8003c8246764014
 SHA512:
-  metadata.gz: e3146a94f973371a2d2091449282393eabffeed605279bd2c8876c27d6a4a430d4a986ffb1f417cf10ccdc9b5431916dccd5ad18a04bc232d1e38bff19132388
-  data.tar.gz: c7b0f974840341d988c36d0ddc0160f57850951ecc1d0055643968e90c360c9d2aeb675cd9373d0f88d3b2c2b44fc5ff4104a3ea85cb38221d37b68a07752740
+  metadata.gz: 5d6c02ed1b8bc9b78b79d6008ea9bc58d9f4ac82769a7ab6fd7e5c6acaad4ccdfb2259bb9e9dfaad7d19cae1e32b82834eefd7e9c10259259a4048f347867311
+  data.tar.gz: bbaf0cc3b31ba54a020a9fd8985201040f3e64832d7d1bc53c648ebff667bfd3372ded56e7ce56adf90d9b088bae9cc7e58890f2d0e4e70aea2634293888dfa9

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.3.0 (2016-11-06)
+
+* Add `TJSON.pretty_generate`
+
 ## 0.2.0 (2016-11-06)
 
 * Complete rewrite to support new postfix syntax

data/README.md

@@ -55,10 +55,27 @@ The following describes how TJSON types map onto Ruby types during parsing:
 To generate TJSON from Ruby objects, use the `TJSON.generate` method:
 
 ```ruby
->> puts TJSON.generate({"foo" => "bar"})
+puts TJSON.generate({"foo" => "bar"})
 {"foo:s:"bar"}
 ```
 
+For better formatting, use the `TJSON.pretty_generate` method:
+
+```ruby
+puts TJSON.pretty_generate({"array-example" => [{"string-example" => "foobar", "binary-example" => "BINARY".encode(Encoding::BINARY), "float-example" => 0.42, "int-example" => 42, "timestamp-example" => Time.now}]})
+{
+  "array-example:A<O>": [
+    {
+      "string-example:s": "foobar",
+      "binary-example:b64": "QklOQVJZ",
+      "float-example:f": 0.42,
+      "int-example:i": "42",
+      "timestamp-example:t": "2016-11-06T22:27:34Z"
+    }
+  ]
+}
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tjson/tjson-ruby

data/lib/tjson.rb

@@ -59,12 +59,21 @@ module TJSON
     object
   end
 
-  # Generate TJSON from a Ruby Hash or Array
+  # Generate TJSON from a Ruby Hash (TJSON only allows objects as toplevel values)
   #
-  # @param obj [Array, Hash] Ruby Hash or Array to serialize as TJSON
+  # @param obj [Hash] Ruby Hash to serialize as TJSON
   # @return [String] serialized TJSON
   def self.generate(obj)
     raise TypeError, "toplevel type must be a Hash" unless obj.is_a?(Hash)
     JSON.generate(TJSON::DataType.generate(obj))
   end
+
+  # Generate TJSON from a Ruby Hash (TJSON only allows objects as toplevel values)
+  #
+  # @param obj [Hash] Ruby Hash to serialize as TJSON
+  # @return [String] serialized TJSON
+  def self.pretty_generate(obj)
+    raise TypeError, "toplevel type must be a Hash" unless obj.is_a?(Hash)
+    JSON.pretty_generate(TJSON::DataType.generate(obj))
+  end
 end

data/lib/tjson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TJSON
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tjson
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tony Arcieri