jsonseq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b144f33248f3ccd78a6b98186e784495fedb0360
+  data.tar.gz: 501a8853494e00a3cce9f0879b70e82c67ef1954
+SHA512:
+  metadata.gz: 58de576b8bde2111ead891cc97cd4a6bb4e5473ab5fa4449d98b6c34ae03811593691c26e0c88d49b7d291ebc25a6bc989df0477975a998ea8561f87b500bdb2
+  data.tar.gz: f522886c6a8eb61199dd470e0101f30933106c1329e3a93148583a863ea0e074fe880a98b824e7695af65e438d29f08ba88b7b65afecabf188de40614d7f6464

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/README.md

@@ -0,0 +1,109 @@
+# JSONSEQ
+
+JSONSEQ implements reader and writer of JSON Text Sequence defined in [RFC 7464](https://tools.ietf.org/html/rfc7464).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonseq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonseq
+
+## Usage
+
+### Reading JSON Text Sequence
+
+Use `JSONSEQ::Reader` to read sequence of JSON objects.
+
+```ruby
+require "jsonseq"
+
+reader = JSONSEQ::Reader.new(io: io)
+
+result = reader.read
+object = reader.read_object
+```
+
+`JSONSEQ::Reader#read` tries to read one object from given IO and returns one of:
+
+* `JSONSEQ::Reader::JSONObject`
+* `JSONSEQ::Reader::ParsingError`
+* `JSONSEQ::Reader::MaybeTruncated`
+* `JSONSEQ::Reader::EndOfFile`
+
+`JSONSEQ::Reader#read_object` tries to read one object from given IO, and returns if successfully read one JSON object.
+When reached to end of file, returns `nil`.
+Note that `read_object` returns `nil` also when it reads `null`.
+
+It also provides `#each` and `#each_object`.
+
+```ruby
+reader.each do |result|
+  case result
+  when JSONSEQ::Reader::JSONObject
+    # ...
+  end
+end
+```
+
+### Writing JSON Text Sequence
+
+Use `JSONSEQ::Writer` to write sequence of JSON objects.
+
+```ruby
+require "jsonseq"
+
+writer = JSONSEQ::Writer.new(io: io)
+
+writer << [1,2,3]
+writer.write nil
+```
+
+It tries to `flush` given IO when it writes an object.
+
+### Customizing JSON encoding/decoding
+
+You can pass `encoder:` and `decoder:` option.
+
+```ruby
+JSONSEQ::Reader.new(io: io, decoder: -> (object) { JSON.parse(object, allow_nan: true) })
+JSONSEQ::Writer.new(io: io, encoder: -> (object) { JSON.pretty_generate(object) })
+```
+
+## Incompatibility
+
+### `JSONSEQ::Reader` accepts a sequence without the first *record separator*
+
+The following input looks like invalid because it does not start with `"\x1E"` (*record separator*).
+
+```
+[1,2,3]
+\x1E{}
+```
+
+However, `JSONSEQ::Reader` accepts that input.
+
+### IO character encoding
+
+RFC 7464 defines the format on UTF-8 encoded stream.
+However, this library is implemented without considering IO encoding.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/soutaro/jsonseq.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsonseq"
+
+# 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/jsonseq.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonseq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonseq"
+  spec.version       = JSONSEQ::VERSION
+  spec.authors       = ["Soutaro Matsumoto"]
+  spec.email         = ["matsumoto@soutaro.com"]
+
+  spec.summary       = %q{Read/write JSON Text Sequence.}
+  spec.description   = %q{Read/write JSON text sequence based on RFC7464.}
+  spec.homepage      = "https://github.com/soutaro/jsonseq"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/jsonseq/reader.rb

@@ -0,0 +1,117 @@
+module JSONSEQ
+  class Reader
+    DEFAULT_DECODER = -> (string) { JSON.parse(string) }
+
+    class JSONObject
+      attr_reader :object
+
+      def initialize(object:)
+        @object = object
+      end
+    end
+
+    class EndOfFile
+    end
+
+    class ParsingError
+      attr_reader :source
+      attr_reader :exception
+
+      def initialize(source:, exception:)
+        @source = source
+        @exception = exception
+      end
+    end
+
+    class MaybeTruncated
+      attr_reader :source
+      attr_reader :object
+
+      def initialize(source:, object:)
+        @source = source
+        @object = object
+      end
+    end
+
+    attr_reader :io
+    attr_reader :decoder
+
+    def initialize(io:, decoder: DEFAULT_DECODER)
+      @io = io
+      @decoder = decoder
+    end
+
+    def read
+      begin
+        source = io.readline(RS).chomp(RS)
+      end while source == ""
+
+      object = decode_string(source)
+
+      case object
+      when Numeric, TrueClass, FalseClass, nil
+        if truncated?(source)
+          MaybeTruncated.new(source: source, object: object)
+        else
+          JSONObject.new(object: object)
+        end
+      when ParsingError
+        object
+      else
+        JSONObject.new(object: object)
+      end
+    rescue EOFError
+      EndOfFile.new
+    end
+
+    def each
+      if block_given?
+        while true
+          object = read
+          yield object
+          return if object.is_a?(EndOfFile)
+        end
+      else
+        enum_for :each
+      end
+    end
+
+    def read_object
+      value = read
+      case value
+      when MaybeTruncated, ParsingError
+        read_object
+      when EndOfFile
+        nil
+      when JSONObject
+        value.object
+      else
+        raise "Unexpected value: #{value}"
+      end
+    end
+
+    def each_object
+      if block_given?
+        each do |value|
+          if value.is_a?(JSONObject)
+            yield value.object
+          end
+        end
+      else
+        enum_for :each_object
+      end
+    end
+
+    private
+
+    def decode_string(string)
+      decoder[string]
+    rescue => exn
+      ParsingError.new(source: string, exception: exn)
+    end
+
+    def truncated?(string)
+      !string.end_with?(LF, "\x20", "\x09", "\x0d")
+    end
+  end
+end

data/lib/jsonseq/version.rb

@@ -0,0 +1,3 @@
+module JSONSEQ
+  VERSION = "0.1.0"
+end

data/lib/jsonseq/writer.rb

@@ -0,0 +1,22 @@
+module JSONSEQ
+  class Writer
+    DEFAULT_ENCODER = -> (object) { JSON.dump(object) }
+
+    attr_reader :io
+    attr_reader :encoder
+
+    def initialize(io:, encoder: DEFAULT_ENCODER)
+      @io = io
+      @encoder = encoder
+    end
+
+    def <<(object)
+      io.write RS
+      io.write encoder[object]
+      io.write LF
+      io.flush
+    end
+
+    alias write <<
+  end
+end

data/lib/jsonseq.rb

@@ -0,0 +1,10 @@
+require "jsonseq/version"
+
+module JSONSEQ
+  RS = "\x1E"
+  LF = "\x0A"
+end
+
+require "json"
+require "jsonseq/writer"
+require "jsonseq/reader"

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: jsonseq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Read/write JSON text sequence based on RFC7464.
+email:
+- matsumoto@soutaro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonseq.gemspec
+- lib/jsonseq.rb
+- lib/jsonseq/reader.rb
+- lib/jsonseq/version.rb
+- lib/jsonseq/writer.rb
+homepage: https://github.com/soutaro/jsonseq
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Read/write JSON Text Sequence.
+test_files: []