RFC8259 8259

data/spec/RFC8259_spec.rb

@@ -0,0 +1,305 @@
+#! /your/favourite/path/to/rspec
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014 Urabe, Shyouhei.  All rights reserved.
+#
+# Redistribution  and  use  in  source   and  binary  forms,  with  or  without
+# modification, are  permitted provided that the following  conditions are met:
+#
+#     - Redistributions  of source  code must  retain the  above copyright
+#       notice, this list of conditions and the following disclaimer.
+#
+#     - Redistributions in binary form  must reproduce the above copyright
+#       notice, this  list of conditions  and the following  disclaimer in
+#       the  documentation  and/or   other  materials  provided  with  the
+#       distribution.
+#
+#     - Neither the name of Internet  Society, IETF or IETF Trust, nor the
+#       names of specific contributors, may  be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
+# AND ANY  EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT LIMITED  TO, THE
+# IMPLIED WARRANTIES  OF MERCHANTABILITY AND  FITNESS FOR A  PARTICULAR PURPOSE
+# ARE  DISCLAIMED. IN NO  EVENT SHALL  THE COPYRIGHT  OWNER OR  CONTRIBUTORS BE
+# LIABLE  FOR   ANY  DIRECT,  INDIRECT,  INCIDENTAL,   SPECIAL,  EXEMPLARY,  OR
+# CONSEQUENTIAL  DAMAGES  (INCLUDING,  BUT   NOT  LIMITED  TO,  PROCUREMENT  OF
+# SUBSTITUTE  GOODS OR SERVICES;  LOSS OF  USE, DATA,  OR PROFITS;  OR BUSINESS
+# INTERRUPTION)  HOWEVER CAUSED  AND ON  ANY  THEORY OF  LIABILITY, WHETHER  IN
+# CONTRACT,  STRICT  LIABILITY, OR  TORT  (INCLUDING  NEGLIGENCE OR  OTHERWISE)
+# ARISING IN ANY  WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF  ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require_relative 'spec_helper'
+require 'pathname'
+
+describe RFC8259 do
+	this_dir = Pathname.new __dir__
+
+	describe '.load' do
+		the_dir = this_dir + 'acceptance/valid'
+		the_dir.find do |f|
+			case f.extname when '.json'
+				it "should accept: #{f.basename}" do
+					expect do
+						f.open encoding: Encoding::UTF_8 do |fp|
+							RFC8259.load fp
+						end
+					end.to_not raise_exception
+				end
+			end
+		end
+
+		the_dir = this_dir + 'acceptance/invalid'
+		the_dir.find do |f|
+			case f.extname when '.txt'
+				it "should reject: #{f.basename}" do
+					expect do
+						f.open do |fp|
+							RFC8259.load fp
+						end
+					end.to raise_exception
+				end
+			end
+		end
+
+		[
+		 Encoding::UTF_16BE,
+		 Encoding::UTF_16LE,
+		 Encoding::UTF_32BE,
+		 Encoding::UTF_32LE,
+		].each do |enc|
+			the_dir = this_dir + 'acceptance'
+			the_dir.find do |f|
+				case f.extname when '.json', '.txt'
+					it "should reject: #{enc}-encoded #{f.basename}" do
+						expect do
+							f.open "rb", external_encoding: Encoding::UTF_8, internal_encoding: enc do |fp|
+								RFC8259.load fp
+							end
+						end.to raise_exception(Encoding::CompatibilityError)
+					end
+				end
+			end
+		end
+	end
+
+	describe '.dump' do
+		the_dir = this_dir + 'acceptance/valid'
+		the_dir.find do |f|
+			case f.extname when '.json'
+				it "should round-trip: #{f.basename}" do
+					str1 = f.read encoding: Encoding::UTF_8
+					obj  = RFC8259.load str1
+					str2 = RFC8259.dump obj
+					# not interested in indents
+					expect(str2.gsub(/\s+/, '')).to eq(str1.gsub(/\s+/, ''))
+				end
+			end
+		end
+
+		context 'from something outside JSON world' do
+			{
+				false             => 'false',
+				true              => 'true',
+				nil               => 'null',
+				0                 => '0',
+				0.5               => '0.5', # 0.5 has no error
+				'foo'             => '"foo"',
+				"\"\\\/\b\f\n\r\t"=> '"\"\\\/\b\f\n\r\t"',
+				"\xED\xBA\xAD".force_encoding('utf-8')        => '"\\uDEAD"', # invalid UTF8 to be valid escaped UTF8
+				'foo'.encode('utf-32le')              => '"foo"',
+				"\xDE\xAD".force_encoding('utf-16be') => '"\\uDEAD"',
+				[]                => '[ ]',
+				[0]               => '[ 0 ]',
+				[0,1]             => '[ 0, 1 ]',
+				{}                => '{ }',
+				{'1'=>1}          => '{ "1": 1 }',
+				{''=>''}          => '{ "": "" }',
+				(0.0/0.0)         => false,
+				(1.0/0.0)         => false,
+				BigDecimal("NaN") => false,
+				//                => false,
+				0..1              => false,
+				{{}=>{}}          => false,
+				{[]=>[]}          => false,
+				{1=>1}            => false,
+				{nil=>nil}        => false,
+				Object.new        => false,
+				Class.new         => false,
+				Proc.new {}       => false,
+			}.each_pair do |src, expected|
+				if expected
+					it { expect(RFC8259.dump src).to eq(expected) }
+				else
+					it { expect{RFC8259.dump src}.to raise_exception }
+				end
+			end
+
+			it 'raises for loops' do
+				expect do
+					RFC8259.dump [].tap {|i| i << i }
+				end.to raise_exception(Errno::ELOOP)
+			end
+		end
+	end
+
+	context 'versus', skip: true do
+		the_dir     = this_dir + 'acceptance/valid'
+		the_targets = Array.new
+		the_dir.find do |f|
+			case f.extname when '.json'
+				begin
+					f.open 'r:utf-8' do |fp|
+						RFC8259.load fp, plain:true
+					end
+				rescue RuntimeError
+					# there are cases JSON can't be represented in PORO
+					# we ignore them here.
+				else
+					the_targets.push f
+				end
+			end
+		end
+		the_dir      = this_dir + 'acceptance/invalid'
+		the_invalids = Array.new
+		the_dir.find do |f|
+			case f.extname when '.txt'
+				the_invalids.push f
+			end
+		end
+
+		require 'json'
+		require 'oj'
+		require 'yajl'
+		targets = {
+			JSON => {
+				load: -> str {
+					JSON.parse str
+				},
+				dump: -> obj {
+					begin
+						ret = JSON.generate obj
+					rescue
+						raise "JSON (not us) failed: #{$!.inspect}"
+					else
+						unless ret.valid_encoding?
+							raise "JSON (not us) is broken: generated #{ret.dump}"
+						end
+						return ret
+					end
+				},
+			},
+
+			Oj   => {
+				load: -> str {
+					Oj.load str
+				},
+				dump: -> obj {
+					begin
+						ret = Oj.dump obj
+					rescue
+						raise "Oj (not us) failed: #{$!.inspect}"
+					else
+						unless ret.valid_encoding?
+							raise "Oj (not us) is broken: generated #{ret.dump}"
+						end
+						return ret
+					end
+				},
+			},
+
+			Yajl => {
+				load: -> str {
+					Yajl::Parser.parse str, allow_comments: false, symbolize_keys: false
+				},
+				dump: -> obj {
+					begin
+						ret = Yajl::Encoder.encode obj
+					rescue
+						raise "Yajl (not us) failed: #{$!.inspect}"
+					else
+						unless ret.valid_encoding?
+							raise "Yajl (not us) is broken: generated #{ret.dump}"
+						end
+						return ret
+					end
+				},
+			},
+		}
+
+		targets.each_pair do |klass, howto|
+			describe klass do
+				the_invalids.each do |f|
+					it "should reject: #{f.basename}" do
+						begin
+							theirs = f.open 'r:utf-8' do |fp|
+								howto[:load].(fp.read)
+							end
+						rescue
+							# ok
+						else
+							pending "#{klass} (not us) failed to reject: #{theirs.inspect}"
+						end
+					end
+				end
+
+				the_targets.each do |f|
+					context f.basename do
+						before :all do
+							str   = f.open 'r:utf-8' do |fp| fp.read end
+							@ours = RFC8259.load str, plain: true
+							begin
+								@theirs = howto[:load].(str)
+							rescue
+								pending "#{klass} (not us) failed to accept: #{$!.inspect}"
+							end
+							# JSON.load sometimes generates Infinity and that's not JSONable
+							case @theirs when Array
+								case @theirs[0] when Float
+									if @theirs[0].infinite?
+										pending "#{klass} (not us) generates non-JSONables: #{@theirs.inspect}"
+									end
+								end
+							end
+						end
+
+						it "compare load" do
+							if @ours != @theirs
+								pending "They load differently: \n#{@ours.inspect} versus \n#{@theirs.inspect}"
+							end
+						end
+
+						it "compare dump ours" do
+							ours   = RFC8259.dump @ours
+							theirs = howto[:dump].(@ours) rescue pending($!.message)
+							if ours.gsub(/\s+/, '') != theirs.gsub(/\s+/, '')
+								pending "They dump differently: \n#{ours.dump} versus \n#{theirs.dump}"
+							end
+						end
+
+						it "compare dump theirs" do
+							ours   = RFC8259.dump @theirs
+							theirs = (howto[:dump].(@theirs) rescue pending($!.message))
+							if ours.gsub(/\s+/, '') != theirs.gsub(/\s+/, '')
+								pending "They dump differently: \n#{ours.dump} versus \n#{theirs.dump}"
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end
+
+# 
+# Local Variables:
+# mode: ruby
+# coding: utf-8-unix
+# indent-tabs-mode: t
+# tab-width: 3
+# ruby-indent-level: 3
+# fill-column: 79
+# default-justification: full
+# End:

data/spec/acceptance/README.txt

@@ -0,0 +1,66 @@
+This directory contains various  JSON and quasi-JSON texts.  The files
+under "valid"  directory are  believed to be  valid JSON  texts, while
+those under "invalid"  are believed to be invalid.   And the author of
+this library believe  that there is no instance  of text that exhibits
+Russell's paradox -like  behaviour, where one cannot say  if that text
+(if any) is valid or invalid.
+
+All  files  under this  directory,  including  this  file itself,  are
+written  by  me,  Urabe  Shyouhei <shyouhei@ruby-lang.org>.   You  can
+safely copy & paste them to your project to test your own JSON parser.
+
+I repeat the license of this  project below, just in case you separate
+this test suite form the library.
+
+----------------------------------------------------------------------
+
+Copyright (c) 2014 Urabe, Shyouhei.  All rights reserved.
+
+Redistribution and  use in  source and binary  forms, with  or without
+modification, are permitted provided that the following conditions are
+met:
+
+  - Redistributions  of source  code must  retain the  above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  - Redistributions in binary form  must reproduce the above copyright
+    notice, this  list of conditions  and the following  disclaimer in
+    the  documentation  and/or   other  materials  provided  with  the
+    distribution.
+
+  - Neither the name of Internet  Society, IETF or IETF Trust, nor the
+    names of specific contributors, may  be used to endorse or promote
+    products derived from this software without specific prior written
+    permission.
+
+THIS SOFTWARE  IS PROVIDED BY  THE COPYRIGHT HOLDERS  AND CONTRIBUTORS
+“AS IS”  AND ANY EXPRESS  OR IMPLIED WARRANTIES, INCLUDING,  BUT NOT
+LIMITED TO, THE IMPLIED  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE  ARE DISCLAIMED. IN NO EVENT  SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES (INCLUDING,  BUT  NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE  GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS  INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF  LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY,  OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING  IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+----------------------------------------------------------------------
+
+P.S.  For those who copy & paste the test cases to your own parser:
+
+  - In convenience  for your own  parser, most (not all)  files starts
+    with '[' and ends with ']'.  This is because that should also pass
+    older JSON spec (RFC4627).
+
+  - RFC7159 requests us, with using the strongest word (“MUST”) that
+    all the valid examples are to  be accepted.  On the other hand the
+    RFC _allows_ you to extend  the grammar to, say, accept JavaScript
+    comments  and so  on.  So  failure in  parsing valid  examples are
+    fatal, but accepting invalid examples might not.
+
+  - RFC7159 tells  no so much  about semantics.  For instance  it does
+    not define object equality.  It does not even define the character
+    set  of  parsed JSON  strings  (it  DOES  define the  encoding  of
+    generated JSON text themselves though).
+

data/spec/acceptance/invalid/0001-ws/0001-verical-tab.txt

@@ -0,0 +1 @@
+[]

data/spec/acceptance/invalid/0001-ws/0003-space-in-number-1.txt

@@ -0,0 +1 @@
+[- 1]

data/spec/acceptance/invalid/0001-ws/0004-space-in-number-2.txt

@@ -0,0 +1 @@
+[-0 .1]

data/spec/acceptance/invalid/0001-ws/0005-space-in-number-3.txt

@@ -0,0 +1 @@
+[-0. 1]

data/spec/acceptance/invalid/0001-ws/0006-space-in-number-4.txt

@@ -0,0 +1 @@
+[-0.1 e1]

data/spec/acceptance/invalid/0001-ws/0007-space-in-number-5.txt

@@ -0,0 +1 @@
+[-0.1e -1]

data/spec/acceptance/invalid/0001-ws/0008-space-in-number-6.txt

@@ -0,0 +1 @@
+[-0.1e- 1]

data/spec/acceptance/invalid/0001-ws/0009-space-in-literal.txt

@@ -0,0 +1 @@
+[ f a l s e ]

data/spec/acceptance/invalid/0001-ws/0010-Unicode-LINE_SEPARATOR.txt

@@ -0,0 +1 @@
+["Here you are U+0208 ->",
"<- (might be invisible in github) and is invalid"]

data/spec/acceptance/invalid/0002-comments/0001-C-style.txt

@@ -0,0 +1 @@
+[/* comments are invalid in JSON */]

data/spec/acceptance/invalid/0002-comments/0002-C-plusplus-style.txt

@@ -0,0 +1,2 @@
+[// comments are invalid in JSON
+]

data/spec/acceptance/invalid/0002-comments/0003-sh-style.txt

@@ -0,0 +1,2 @@
+[# comments are invalid in JSON
+]

data/spec/acceptance/invalid/0002-comments/0004-python-docstring.txt

@@ -0,0 +1,3 @@
+["""
+comments are invalid in JSON
+"""]

data/spec/acceptance/invalid/0002-comments/0005-SQL-style.txt

@@ -0,0 +1,2 @@
+[-- comments are invalid in JSON
+]

data/spec/acceptance/invalid/0002-comments/0006-BASIC-style.txt

@@ -0,0 +1,2 @@
+[' comments are invalid in JSON
+]

data/spec/acceptance/invalid/0003-literals/0001-FALSE.txt

@@ -0,0 +1 @@
+[FALSE]

data/spec/acceptance/invalid/0003-literals/0002-NULL.txt

@@ -0,0 +1 @@
+[NULL]

data/spec/acceptance/invalid/0003-literals/0003-TRUE.txt

@@ -0,0 +1 @@
+[TRUE]

data/spec/acceptance/invalid/0003-literals/0004-NUL.txt

@@ -0,0 +1 @@
+[NUL]

data/spec/acceptance/invalid/0003-literals/0005-nil.txt

@@ -0,0 +1 @@
+[nil]

data/spec/acceptance/invalid/0003-literals/0006-undef.txt

@@ -0,0 +1 @@
+[undef]

data/spec/acceptance/invalid/0003-literals/0007-modifier.txt

@@ -0,0 +1 @@
+[JSON::false]

data/spec/acceptance/invalid/0003-literals/0008-undefined.txt

@@ -0,0 +1 @@
+[undefined]

data/spec/acceptance/invalid/0004-numbers/0001-omit-zero.txt

@@ -0,0 +1 @@
+[.1]