json-emitter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fb1f58b4cbaa70be670062103c939cad985a21b709862771989851795a425c8
-  data.tar.gz: 58aa111fa70c53090f33ccf8103086a0615ea0e4ac5cfca1b5d42f6047c43107
+  metadata.gz: d39d9a362efddd2cb39412926290328feb042228099e2b737d6d8450fad28cdd
+  data.tar.gz: ff8a418af3119910c46d78320e8b4dcac3cd6c0282202e1bae970c56fadf3e12
 SHA512:
-  metadata.gz: 309af9a8b1e04ba28ee14f5a583d70852fc23db51ec6eaa5d14d0590f42381ef1fe502909b5449880fedff08bc4e6920112651ff7ce0f6480ff3c71de5ca7e8c
-  data.tar.gz: 15276de4e33f4d8506736aef13c090ba4c7dcc42a301cecbbf216be58f3e9e514a339f1acfb34ed389f8dbd7c18d92c420477ab47cd90448e461b380cb1c6433
+  metadata.gz: b5cc83b5e2018d7f9b05f98f3cbfa9ab3f45176ff96e121f4336303466abdfb1836db673c5b567ae3579de7cdf9bf3d95b7879488ef35a25d34422d11177c1ed
+  data.tar.gz: 33cc0cf57bedd84fda214c19859a32289c31d08e5e1d587d55485e73b5dab81030cd4fc12b14ed0c6e8234238821492fc694e603ad4d7ee8193f479de867ad6c

data/README.md

@@ -50,11 +50,6 @@ File.open("/tmp/foo.json", "w+") { |file|
 stream.each { |json_chunk|
   ...
 }
-
-# this will buffer the JSON into roughly 8k chunks
-stream.buffered(8).each { |json_8k_chunk|
-  ...
-}
 ```
 
 # HTTP Chunked Transfer (a.k.a streaming)
@@ -90,7 +85,7 @@ get :orders do
 
   stream JsonEmitter.array(enumerator) { |order|
     ApiV1::Entities::Order.new(order)
-  }.buffered(16)
+  }
 end
 ```
 
@@ -104,7 +99,7 @@ app = ->(env) {
 
   stream = JsonEmitter.array(enumerator) { |order|
     order.to_h
-  }.buffered(16)
+  }
 
   [200, {"Content-Type" => "application/json"}, stream]
 }

data/lib/json-emitter/buffered_stream.rb

@@ -23,6 +23,15 @@ module JsonEmitter
                      end
     end
 
+    #
+    # Returns an unbuffered version of the stream.
+    #
+    # @return [JsonEmitter::Stream]
+    #
+    def unbuffered
+      Stream.new(@enum)
+    end
+
     #
     # Write the stream to the specified IO object.
     #

data/lib/json-emitter/stream.rb

@@ -1,7 +1,7 @@
 module JsonEmitter
   #
   # Represents a stream of JSON to be generated and yielded. It can be treated like any Enumerable.
-  # The size of the yielded strings can vary from 1 to 1000's. If that's a problem, call JsonEmitter::Stream.buffer.
+  # Unlike UnbufferedStream, the size of the yielded strings can vary from 1 to 1000's.
   #
   class Stream
     include Enumerable
@@ -15,17 +15,6 @@ module JsonEmitter
       @enum = enum
     end
 
-    #
-    # Returns a new stream that will buffer the output. You can perform the same "write" or "each" operations
-    # on the new stream, but the chunks of output will be (roughly) uniform in size.
-    #
-    # @param buffer_size [Integer] The buffer size in kb. This is a size *hint*, not a hard limit.
-    # @return [JsonEmitter::BufferedStream]
-    #
-    def buffered(buffer_size = 16, unit: :kb)
-      BufferedStream.new(@enum, buffer_size, unit: unit)
-    end
-
     #
     # Write the stream to the specified IO object.
     #

data/lib/json-emitter/version.rb

@@ -1,4 +1,4 @@
 module JsonEmitter
   # Library version
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/json-emitter.rb

@@ -12,8 +12,8 @@ require 'json-emitter/buffered_stream'
 # Primitive values will be serialized to JSON using MultiJson.dump. MultiJson finds and uses the most efficient
 # JSON generator you have on your system (e.g. oj) and falls back to the stdlib JSON library.
 #
-# The emitter can be used to output to anything (files, network sockets, etc), and the output can optionally be
-# buffered. This works very well with so-called "HTTP chunked responses" in Rack/Rails/Sinatra/Grape/etc.
+# The emitter can be used to output to anything (files, network sockets, etc). It works very well with so-called
+# "HTTP chunked responses" in Rack/Rails/Sinatra/Grape/etc.
 #
 module JsonEmitter
   class << self
@@ -47,17 +47,15 @@ module JsonEmitter
   #     # do something with each json chunk
   #   end
   #
-  #   # if you need the outputted chunks to be (roughly) equal in size, call "buffered"
-  #   # and pass in the buffer size in kb.
-  #   buffered_stream = stream.buffered(16)
-  #
   # @param enum [Enumerable] Something that can be enumerated over, like an Array or Enumerator. Each element should be something that can be rendered as JSON (e.g. a number, string, boolean, Array, or Hash).
+  # @param buffer_size [Integer] The buffer size in kb. This is a size *hint*, not a hard limit.
+  # @param unit [Symbol] :bytes | :kb (default) | :mb
   # @yield If a block is given, it will be yielded each value in the array. The return value from the block will be converted to JSON instead of the original value.
-  # @return [JsonEmitter::Stream]
+  # @return [JsonEmitter::BufferedStream]
   #
-  def self.array(enum, &mapper)
+  def self.array(enum, buffer_size: 16, buffer_unit: :kb, &mapper)
     emitter = Emitter.new.array(enum, &mapper)
-    Stream.new(emitter)
+    BufferedStream.new(emitter, buffer_size, unit: buffer_unit)
   end
 
   #
@@ -93,16 +91,14 @@ module JsonEmitter
   #     # do something with each json chunk
   #   end
   #
-  #   # if you need the outputted chunks to be (roughly) equal in size, call "buffered"
-  #   # and pass in the buffer size in kb.
-  #   buffered_stream = stream.buffered(16)
-  #
   # @param hash [Hash] Keys should be Strings or Symbols and values should be any JSON-compatible value like a number, string, boolean, Array, or Hash.
-  # @return [JsonEmitter::Stream]
+  # @param buffer_size [Integer] The buffer size in kb. This is a size *hint*, not a hard limit.
+  # @param unit [Symbol] :bytes | :kb (default) | :mb
+  # @return [JsonEmitter::BufferedStream]
   #
-  def self.object(hash)
+  def self.object(hash, buffer_size: 16, buffer_unit: :kb)
     emitter = Emitter.new.object(hash)
-    Stream.new(emitter)
+    BufferedStream.new(emitter, buffer_size, unit: buffer_unit)
   end
 
   # Wrap the enumeration in a Proc. It will be passed a callback which it must call to continue.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-emitter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jordan Hollinger