json-streamer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdffaa800a206cbb2aecd8d6386b0f2dc7759cb3
+  data.tar.gz: ee433030988de4475141e342fffce3344b7b16d9
+SHA512:
+  metadata.gz: 9195c29ee40264ad8579eed344182181e4d70c8abf677789ec2bd4deabc4fe31330ec4f69eec07abb9e33778f8753f8f38c67390d07dd5146c43df2e4bfe0f33
+  data.tar.gz: 37d8bf0ade2f73b28645f63c0f9c3a8427bce49b55b99a72b90e1d51fadd06ffd883cc7c2af9931538c7812bc53c47ab5b964f02e379309d82de032868baf959

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at csapagyi@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json-streamer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Csaba Apagyi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Json::Streamer
+
+Utility to support JSON streaming allowing you to get objects based on various criteria.
+Useful for e.g. streaming objects from a JSON array.
+
+This gem will basically spare you the need to define you own callbacks when parsing JSON stream.
+Streaming is useful for
+- big files that not fit in the memory (or you'd rather avoid the risk)
+- files read in chunks (e.g. arriving over network)
+- cases where you expect some issue with the file (e.g. losing connection to source, invalid data at some point) but would like to get as much data as possible anyway
+
+Regarding performance:
+The gem uses JSON::Stream's events in the background. It was chosen because it's a pure Ruby parser.
+A similar implementation can be done using the ~10 times faster Yajl::FFI gem that is dependent on the native YAJL library.
+I did not measure the performance of my implementation on top of these libraries.
+
+I do not recommend this or any of the gems mentioned above if you don't need streaming.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-streamer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-streamer
+
+## Usage
+
+```ruby
+require 'json/streamer'
+
+# 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)
+```
+
+```ruby
+# Get objects based on nesting level
+# First level will give you the full JSON, second level will give you objects within full JSON object, etc.
+streamer.get_objects_from_level(2)
+```
+
+Getting second level objects on the JSON below will yield you 2 empty objects
+
+```json
+{
+    "object1": {},
+    "object2": {}
+}
+```
+
+Check the unit tests for more examples.
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/csapagyi/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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json/streamer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json-streamer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json/streamer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-streamer"
+  spec.version       = Json::Streamer::VERSION
+  spec.authors       = ["Csaba Apagyi"]
+  spec.email         = ["csapagyi@users.noreply.github.com"]
+
+  spec.summary       = %q{Utility to support JSON streaming allowing you to get objects based on various criteria}
+  spec.description   = %q{Useful for e.g. streaming objects from a JSON array.}
+  spec.homepage      = "https://github.com/csapagyi/json-streamer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "json-stream"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "ndhash"
+end

data/lib/json/streamer.rb

@@ -0,0 +1,96 @@
+require "json/streamer/version"
+require "json/stream"
+
+module Json
+  module Streamer
+    class JsonStreamer
+      def initialize(file_io, chunk_size = 1000)
+        @parser = JSON::Stream::Parser.new
+
+        @file_io = file_io
+        @chunk_size = chunk_size
+
+        @object_nesting_level = 0
+        @current_key = nil
+        @aggregator = {}
+        @temp_aggregator_keys = {}
+
+        @parser.start_object {start_object}
+        @parser.start_array {start_array}
+        @parser.key {|k| key(k)}
+        @parser.value {|v| value(v)}
+
+      end
+
+      def get_objects_from_level(yield_nesting_level)
+        @yield_nesting_level = yield_nesting_level
+
+        # Callback containing yield has be defined in the method called via block
+        @parser.end_object do
+          if @object_nesting_level.eql? @yield_nesting_level
+            yield @aggregator[@object_nesting_level].clone
+            # TODO probably can be faster than reject!{true}
+            @aggregator[@object_nesting_level].reject!{true}
+          else
+            merge_up
+          end
+
+          @object_nesting_level -= 1
+        end
+
+        @parser.end_array do
+          if @object_nesting_level.eql? @yield_nesting_level
+            yield @aggregator[@object_nesting_level].clone
+            # TODO probably can be faster than reject!{true}
+            @aggregator[@object_nesting_level].reject!{true}
+          else
+            merge_up
+          end
+
+          @object_nesting_level -= 1
+        end
+
+        @file_io.each(@chunk_size) do |chunk|
+          @parser << chunk
+        end
+      end
+
+      def start_object
+        @temp_aggregator_keys[@object_nesting_level] = @current_key
+        @object_nesting_level += 1
+        @aggregator[@object_nesting_level] = {}
+      end
+
+      def start_array
+        @temp_aggregator_keys[@object_nesting_level] = @current_key
+        @object_nesting_level += 1
+        @aggregator[@object_nesting_level] = []
+      end
+
+      def key k
+        @current_key = k
+      end
+
+      def value v
+        if @aggregator[@object_nesting_level].kind_of? Array
+          @aggregator[@object_nesting_level] << v
+        else
+          @aggregator[@object_nesting_level][@current_key] = v
+        end
+      end
+
+      def merge_up
+        return if @object_nesting_level == 1
+        previous_object_nesting_level = @object_nesting_level - 1
+        if @aggregator[previous_object_nesting_level].kind_of? Array
+          @aggregator[previous_object_nesting_level] << @aggregator[@object_nesting_level]
+        else
+          @aggregator[previous_object_nesting_level][@temp_aggregator_keys[previous_object_nesting_level]] = @aggregator[@object_nesting_level]
+        end
+
+        @aggregator.delete(@object_nesting_level)
+        @aggregator
+      end
+    end
+  end
+end

data/lib/json/streamer/version.rb

@@ -0,0 +1,5 @@
+module Json
+  module Streamer
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: json-streamer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Csaba Apagyi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: json-stream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ndhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Useful for e.g. streaming objects from a JSON array.
+email:
+- csapagyi@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json-streamer.gemspec
+- lib/json/streamer.rb
+- lib/json/streamer/version.rb
+homepage: https://github.com/csapagyi/json-streamer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Utility to support JSON streaming allowing you to get objects based on various
+  criteria
+test_files: []