jsonl 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 289abad3416cd6ca81bd909b3af37471f14f5349
-  data.tar.gz: cdb34dab34bf5a8ab8cc3c5f52759f51202ddb6a
+  metadata.gz: c5f7d70cfded69042f7cbe8de1d6d14212f1ebb9
+  data.tar.gz: 8bca489cefcdcd01ef32e0a3f1d36cfb48bb6c5a
 SHA512:
-  metadata.gz: fa4fe025ce3f75279df4798e637d0897e68f27e4e341a2d713b61f2e72e7f524c739f37187c274238acaadf3f10046ee70e747362c209453724c20bbe00a1b3a
-  data.tar.gz: ce82b2fbed6941c2b2267c8f4bcefd1727cd7fec23d3a39532c554e914737cd4cf367c4f2c8663d3bcc1b508dd0b5f688ece7a5db383bb1dc4cd6f8b518b869a
+  metadata.gz: 5b64b0c1440aed50e2266923e446989fbaeca5b3bc2e93255870ab79ea64603ba5d1ed3c155d7dabd0d0c5c5b9e38287d93c87bb00bb6214565861e3fec8bf81
+  data.tar.gz: f60b828f378e39efc903cba0e30cef162480b74e444d0df770e5e60fe65a3916c3b07383f989c5da992dca3336c0c45db01237b0ddd160e8ec3812bf5e9d4e6f

data/lib/jsonl.rb

@@ -4,6 +4,18 @@ require 'json'
 module JSONL
   module_function
 
+  # Generate a string formatted as JSONL from an array.
+  #
+  # ==== Attributes
+  #
+  # * +objs+ - an array consists of objects
+  # * +opts+ - options passes to `JSON.generate`
+  #
+  # ==== Exapmles
+  #
+  #   users = User.all.map(&:attributes) #=> [{"id"=>1, "name"=>"Gilbert", ...}, {"id"=>2, "name"=>"Alexa", ...}, ...]
+  #   generated = JSONL.generate(users)
+  #
   def generate(objs, opts = nil)
     unless objs.is_a?(Array)
       raise TypeError, "can't generate from #{objs.class}"
@@ -16,6 +28,18 @@ module JSONL
     generated.join("\n")
   end
 
+  # Parse JSONL string and return as an array.
+  #
+  # ==== Attributes
+  #
+  # * +source+ - a string formatted as JSONL
+  # * +opts+ - options passes to `JSON.parse`
+  #
+  # ==== Examples
+  #
+  #   source = File.read('source.jsonl')
+  #   parsed = JSONL.parse(source)
+  #
   def parse(source, opts = {})
     parsed = []
     source.each_line do |line|

data/lib/jsonl/version.rb

@@ -1,3 +1,3 @@
 module JSONL
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonl
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - kami-zh