RFC7159 7159

data/lib/RFC7159/true.rb

@@ -0,0 +1,79 @@
+#! /your/favourite/path/to/ruby
+# -*- 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.
+
+# The true, as defined in RFC7159 section 3.
+class RFC7159::True < RFC7159::Value
+
+	# Parse the AST from parser, and convert into corrsponding value.
+	# @param  [Array] ast      the AST, generated by the parser
+	# @return [self]           evaluated instance
+	# @raise  [ArgumentError]  malformed input
+	def self.from_ast ast
+		raise ArgumentError "garbage included: #{ast.inspect}" if ast.length > 1
+		raise ArgumentError "not a false: #{ast.inspect}" if ast[0] != :true
+		return new
+	end
+
+	# convert to Ruby's true
+	# @return [true] the ruby counter part.
+	def plain_old_ruby_object
+		return true
+	end
+
+	# JSON gem compat
+	# @return [::String] JSONified string representation
+	def to_json
+		return 'true'
+	end
+
+	# Equality.   All true  instances are  equal  each other,  plus a  TrueClass
+	# instance is also equal to this.
+	def == other
+		case other when TrueClass, self.class
+			true
+		else
+			false
+		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/lib/RFC7159/value.rb

@@ -0,0 +1,96 @@
+#! /your/favourite/path/to/ruby
+# -*- 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.
+
+# @abstract
+# The Values, as described in RFC7159 section 3.
+#
+# >   value = false / null / true / object / array / number / string
+class RFC7159::Value
+
+	# Parse the AST from parser, and convert into corrsponding values.
+	# @param  [::Array] ast    the AST, generated by the parser
+	# @return [Value]          evaluated instance
+	# @raise  [ArgumentError]  malformed input
+	#
+	# @note the input MUST be a  tree.  No cyclic lists, nor even direct-acycric
+	#   graphs  are  allowed by  definition.   Such  input can  cause  undefined
+	#   behaviour.
+	def self.from_ast ast
+		klass = case ast.first
+				  when :false  then RFC7159::False
+				  when :null   then RFC7159::Null
+				  when :true   then RFC7159::True
+				  when :object then RFC7159::Object
+				  when :array  then RFC7159::Array
+				  when :number then RFC7159::Number
+				  when :string then RFC7159::String
+				  end
+		return klass.from_ast ast
+	end
+
+	# convert to Ruby's value
+	def plain_old_ruby_object
+		raise RuntimeError, 'abstruct method called'
+	end
+
+	# @return [::String] the class in string
+	def inspect
+		sprintf "#<%p>", self.class
+	end
+
+	# For pretty print (require 'pp' beforehand)
+	# @param [PP] pp the pp
+	def pretty_print pp
+		pp.object_group self do end # nothing
+	end
+end
+
+# *WARN* order matters, do not move below.
+require_relative 'false'
+require_relative 'null'
+require_relative 'true'
+require_relative 'object'
+require_relative 'array'
+require_relative 'number'
+require_relative 'string'
+
+# 
+# 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/lib/RFC7159/version.rb

@@ -0,0 +1,48 @@
+#! /your/favourite/path/to/ruby
+# -*- 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 '../RFC7159'
+
+# The version
+RFC7159::VERSION = 7159
+
+# 
+# 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/RFC7159_spec.rb

@@ -0,0 +1,275 @@
+#! /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 RFC7159 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 'r:utf-8' do |fp|
+							RFC7159.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 'r:utf-8' do |fp|
+							RFC7159.load fp
+						end
+					end.to raise_exception
+				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.open 'r:utf-8' do |fp| fp.read end
+					obj  = RFC7159.load str1
+					str2 = RFC7159.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"',
+				"\u{dead}"        => '"\\uDEAD"', # invalid UTF8 to be valid escaped UTF8
+				[]                => '[]',
+				[0]               => '[0]',
+				{}                => '{}',
+				{'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(RFC7159.dump src).to eq(expected) }
+				else
+					it { expect{RFC7159.dump src}.to raise_exception }
+				end
+			end
+		end
+	end
+
+	context 'versus' 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|
+						RFC7159.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 = RFC7159.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   = RFC7159.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   = RFC7159.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: