json-streamer 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 928cc40a89ddc3be04f541abaed833e0fa89757a
-  data.tar.gz: ed5bc1ab4c5b00a6369b76a0e008d86ff7000bb1
+  metadata.gz: 3c35a9dba96aa722b2fb6cb9077110e878b021a6
+  data.tar.gz: 88ccd53d4b71d5c4ae77a4dbc7ce269c727f7a0a
 SHA512:
-  metadata.gz: afaba7db14dea5fe606b04711adcd3c9d04521f4ae4a7c9dc65f1d91debecc7b41c76a733f10c6d3e4bcb95f4690c5379d4ab9ac9d028f0d9ebf835353268298
-  data.tar.gz: a31a925947007fba4c4367e3869276f3d818294dc1afaee66f877e7153d034848bb2a87d45d151025570c7576b958e45efc49511d32def4fbd39510b40303bcf
+  metadata.gz: '09599f0613fae47060a80144e95ff2ef2aecee3bc6e7beb53580185f702d8606fe5b5ffa9665462a1cd3eae7739a77e7cfa6284a5e0fc26a12bc5a3142d625c0'
+  data.tar.gz: 2a8bba6340930503cdd41d4702403a6d4f3d235fcc691a95bf81d14590a92d67be0239308a563df3158d72544251c1a03c0ba9248a03379b0cc849df6244ef80

data/README.md

@@ -47,18 +47,25 @@ Or install it yourself as:
 
 ```ruby
 require 'json/streamer'
+```
+
+### v1.1.3 API
+
+Check the unit tests for more examples ([spec/streamer_spec.rb](spec/json/streamer/json_streamer_spec.rb)).
+
+#### Passing IO upfront
 
+```ruby
 file_stream = File.open('data.json', 'r')
+chunk_size = 500 # defaults to 1000
 
-# Get a JsonStreamer object that will parse file_stream by chunks of 500
-# Default chunk size in 1000
-streamer = Json::Streamer::JsonStreamer.new(file_stream, 500)
+streamer = Json::Streamer.parser(file_io: file_stream, chunk_size: chunk_size)
 ```
 
 #### Get objects based on nesting level
 
 ```ruby
-# Level zero will give you the full JSON, first level will give you data within full JSON object, etc.
+# Level zero yields the full JSON, first level yields data within the JSON 1-by-1, etc.
 streamer.get(nesting_level:1) do |object|
     p object
 end
@@ -109,7 +116,7 @@ Output:
 {"desired_key" : "value3"}
 ```
 
-#### Skip values if you'd only like to get objects and arrays
+#### Skip values
 
 ```ruby
 streamer.get(nesting_level:1, yield_values:false) do |object|
@@ -130,12 +137,12 @@ Output:
 {}
 ```
 
-#### EventMachine-style input (since 1.1.0)
+#### Passing IO later (EventMachine-style)
 
 ```ruby
 # Get a JsonStreamer object that provides access to the parser
 # but does not start processing immediately
-streamer = Json::Streamer::JsonStreamer.new
+streamer = Json::Streamer.parser
 
 streamer.get(nesting_level:1) do |object|
     p object
@@ -146,11 +153,23 @@ Then later in your EventMachine handler:
 
 ```ruby
 def receive_data(data)
-    streamer.parser << data
+    streamer << data
 end
 ```
 
-Check the unit tests for more examples ([spec/streamer_spec.rb](spec/streamer_spec.rb)).
+### Legacy API (pre-v1.1.3)
+
+This functionality is deprecated but kept for compatibility reasons.
+
+```ruby
+# Same as Json::Streamer.parser
+streamer = Json::Streamer::JsonStreamer.new
+```
+
+```ruby
+# Same as streamer << data
+streamer.parser << data
+```
 
 ## Feedback
 
@@ -160,17 +179,20 @@ I can only tailor this project to fit use-cases I know about - which are usually
 
 Please let me know if you make use of this project so that I can prioritize further efforts.
 
-## Development
+## Conventions
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+This gem is developed using the following conventions:
+- [Bundler's guide for developing a gem](http://bundler.io/v1.14/guides/creating_gem.html)
+- [Better Specs](http://www.betterspecs.org/)
+- [Semantic versioning](http://semver.org/)
+- [RubyGems' guide on gem naming](http://guides.rubygems.org/name-your-gem/)
+- [RFC memo about key words used to Indicate Requirement Levels](https://tools.ietf.org/html/rfc2119)
+- [Bundler improvements](https://github.com/thisismydesign/bundler-improvements)
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/thisismydesign/json-streamer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/json/streamer.rb

@@ -2,6 +2,8 @@ require_relative "streamer/json_streamer"
 
 module Json
   module Streamer
-    
+    def self.parser(file_io: nil, chunk_size: 1000)
+      JsonStreamer.new(file_io, chunk_size)
+    end
   end
 end

data/lib/json/streamer/json_streamer.rb

@@ -22,8 +22,12 @@ module Json
         @parser.key {|k| key(k)}
       end
 
+      def <<(data)
+        @parser << data
+      end
+
       # Callbacks containing `yield` have to be defined in the method called via block otherwise yield won't work
-      def get(nesting_level:-1, key:nil, yield_values:true)
+      def get(nesting_level: -1, key: nil, yield_values: true)
         @yield_level = nesting_level
         @yield_key = key
         @yield_values = yield_values

data/lib/json/streamer/version.rb

@@ -1,5 +1,5 @@
 module Json
   module Streamer
-    VERSION = "1.1.2"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-streamer
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - thisismydesign
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler