ya2yaml 0.26 → 0.29.2

data/README

@@ -8,7 +8,8 @@ Ya2YAML is "yet another to_yaml". It emits YAML document with complete UTF8 supp
 
 *code*:
 
-  $KCODE = 'UTF8'
+  # encoding: UTF-8
+  $KCODE = 'UTF8' unless RUBY_VERSION >= '1.9'
   require 'ya2yaml'
   
   obj = [

data/lib/ya2yaml.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
+# encoding: UTF-8
 
-# $Id: ya2yaml.rb,v 0.26 2007-01-19 20:42:42+09 funai Exp funai $
+# $Id: ya2yaml.rb,v 0.29 2009/02/09 09:01:30 funai Exp funai $
 #
 # Author::    Akira FUNAI
 # Copyright:: Copyright (c) 2006 Akira FUNAI
@@ -8,7 +8,8 @@
 
 class Ya2YAML
 
-	def initialize(options = {})
+	def initialize(opts = {})
+		options = opts.dup
 		options[:indent_size] = 2          if options[:indent_size].to_i <= 0
 		options[:minimum_block_length] = 0 if options[:minimum_block_length].to_i <= 0
 		options.update(
@@ -23,15 +24,15 @@ class Ya2YAML
 	end
 
 	def _ya2yaml(obj)
-		throw 'set $KCODE to "UTF8".' if $KCODE != 'UTF8'
+		throw 'set $KCODE to "UTF8".' if (RUBY_VERSION < '1.9.0') && ($KCODE != 'UTF8')
 		'--- ' + emit(obj,1) + "\n"
 	end
 
 	private
 
 	def emit(obj,level)
-		case obj.class.to_s
-			when 'Array'
+		case obj
+			when Array
 				if (obj.length == 0)
 					'[]'
 				else
@@ -40,7 +41,7 @@ class Ya2YAML
 						indent + '- ' + emit(o,level + 1)
 					}.join('')
 				end
-			when 'Hash'
+			when Hash
 				if (obj.length == 0)
 					'{}'
 				else
@@ -69,17 +70,17 @@ class Ya2YAML
 						end
 					}.join('')
 				end
-			when 'NilClass'
+			when NilClass
 				'~'
-			when 'String'
+			when String
 				emit_string(obj,level)
-			when 'TrueClass','FalseClass'
+			when TrueClass,FalseClass
 				obj.to_s
-			when 'Fixnum','Bignum','Float'
+			when Fixnum,Bignum,Float
 				obj.to_s
-			when 'Date'
+			when Date
 				obj.to_s
-			when 'Time'
+			when Time
 				offset = obj.gmtoff
 				off_hm = sprintf(
 					'%+.2d:%.2d',
@@ -88,11 +89,11 @@ class Ya2YAML
 				)
 				u_sec = (obj.usec != 0) ? sprintf(".%.6d",obj.usec) : ''
 				obj.strftime("%Y-%m-%d %H:%M:%S#{u_sec} #{off_hm}")
-			when 'Symbol'
-				'!ruby/symbol ' + obj.to_s
-			when 'Range'
+			when Symbol
+				'!ruby/symbol ' + emit_string(obj.to_s,level)
+			when Range
 				'!ruby/range ' + obj.to_s
-			when 'Regexp'
+			when Regexp
 				'!ruby/regexp ' + obj.inspect
 			else
 				case
@@ -105,7 +106,7 @@ class Ya2YAML
 						# serialized as a generic object
 						object_members = {}
 						obj.instance_variables.each{|k,v|
-							object_members[k.sub(/^@/,'')] = obj.instance_variable_get(k)
+							object_members[k.to_s.sub(/^@/,'')] = obj.instance_variable_get(k)
 						}
 						'!ruby/object:' + obj.class.to_s + ' ' +
 						emit(object_members,level + 1)
@@ -183,6 +184,9 @@ class Ya2YAML
 	end
 
 	def string_type(str)
+		if str.respond_to?(:valid_encoding?) && !str.valid_encoding?
+			return false,false,false,false
+		end
 		(ucs_codes = str.unpack('U*')) rescue (
 			# ArgumentError -> binary data
 			return false,false,false,false
@@ -192,10 +196,10 @@ class Ya2YAML
 			str =~ /\A#{REX_ANY_LB}* | #{REX_ANY_LB}*\z|#{REX_ANY_LB}{2}\z/
 		)
 			# detour Syck bug
-			return true,false,is_one_line?(str),false
+			return true,false,nil,false
 		end
 		ucs_codes.each {|ucs_code|
-			return true,false,is_one_line?(str),false unless is_printable?(ucs_code)
+			return true,false,nil,false unless is_printable?(ucs_code)
 		}
 		return true,true,is_one_line?(str),is_one_plain_line?(str)
 	end
@@ -249,7 +253,9 @@ class Ya2YAML
 				when is_printable?(ucs_code)
 					c
 				when @options[:escape_as_utf8]
-					'\\x' + c.unpack('H2' * c.size).join('\\x')
+					c.respond_to?(:bytes) ?
+						c.bytes.collect {|b| '\\x%.2x' % b }.join :
+						'\\x' + c.unpack('H2' * c.size).join('\\x')
 				when ucs_code == 0x2028 || ucs_code == 0x2029
 					ESCAPE_SEQ_LB[c]
 				when ucs_code <= 0x7f

data/test/test.rb

@@ -1,17 +1,30 @@
 #!/usr/bin/env ruby
+# encoding: UTF-8
 
-# $Id: test.rb,v 1.4 2007-01-19 20:41:37+09 funai Exp funai $
+# $Id: test.rb,v 1.6 2009/02/09 09:00:57 funai Exp funai $
 
-$: << (File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 
 Dir.chdir(File.dirname(__FILE__))
 
-$KCODE = 'UTF8'
+$KCODE = 'UTF8' if RUBY_VERSION < '1.9.0'
 require 'ya2yaml'
 
 require 'yaml'
 require 'test/unit'
 
+# There's an incompatibility in how ruby handles struct dumps
+# between versions that's beyond our scope.
+# (One uses strings internally, the other symbols.)
+# This just enables tests to pass.
+class << Struct
+  alias yaml_new_without_indifferent_keys yaml_new
+  def yaml_new(klass, tag, val)
+    val.keys.each { |k, v| val[k.to_sym] = val.delete(k) }
+    yaml_new_without_indifferent_keys(klass, tag, val)
+  end
+end if RUBY_VERSION >= "1.9"
+
 class TC_Ya2YAML < Test::Unit::TestCase
 
 	@@struct_klass = Struct::new('Foo',:bar,:buz)
@@ -30,16 +43,21 @@ class TC_Ya2YAML < Test::Unit::TestCase
 	puts "test may take minutes. please wait.\n"
 
 	def setup
-		@text = ''
-		@gif  = ''
-		File.open('./t.yaml','r') {|f| @text = f.read}
-		File.open('./t.gif','r') {|f| @gif = f.read}
-
-		@struct = @@struct_klass.new('barbarbar',@@struct_klass.new('baaaar',12345))
-		@klass  = Moo.new('boobooboo',Time.new())
+		@text   = File.open('./t.yaml', 'r') { |f| f.read }
+		@gif    = File.open('./t.gif', 'rb') { |f| f.read }
+		@struct = @@struct_klass.new('barbarbar', @@struct_klass.new('baaaar', 12345))
+		@klass  = Moo.new('boobooboo', Time.local(2009,2,9,16,44,10))
 	end
 
 	def test_options
+		opt = {:syck_compatible => true}
+		'foobar'.ya2yaml(opt)
+		assert_equal(
+			{:syck_compatible => true},
+			opt,
+			'ya2yaml should not change the option hash'
+		)
+
 		[
 			[
 				{},
@@ -75,9 +93,11 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			],
 		].each {|opt,yaml|
 			y = ["\xc2\x86","a\xe2\x80\xa8b\xe2\x80\xa9c"," abc\nxyz"].ya2yaml(opt)
-#			puts y
-
-			assert_equal(y,yaml)
+			assert_equal(
+				yaml,
+				y,
+				"option #{opt.inspect} should be recognized"
+			)
 		}
 	end
 
@@ -107,8 +127,11 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			}.ya2yaml(
 				:hash_order => hash_order
 			)
-#			p y
-			assert_equal(y,yaml)
+			assert_equal(
+				yaml,
+				y,
+				'hash order should be kept when :hash_order provided'
+			)
 		}
 	end
 
@@ -129,8 +152,11 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			y = src.ya2yaml(
 				:minimum_block_length => 16
 			)
-#			p y
-			assert_equal(y,yaml)
+			assert_equal(
+				yaml,
+				y,
+				'line breaks should be normalized to fit the format.'
+			)
 		}
 	end
 
@@ -140,16 +166,23 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			[Struct.new(:foo).new(123),       "--- !ruby/struct: \n  foo: 123\n",],
 		].each {|src,yaml|
 			y = src.ya2yaml()
-			assert_equal(y,yaml)
+			assert_equal(
+				yaml,
+				y,
+				'ruby struct should be serialized properly'
+			)
 		}
 	end
 
 	def test_roundtrip_single_byte_char
 		 ("\x00".."\x7f").each {|c|
 			y = c.ya2yaml()
-#			puts y
 			r = YAML.load(y)
-			assert_equal((c == "\r" ? "\n" : c),r) # "\r" is normalized as "\n".
+			assert_equal(
+				(c == "\r" ? "\n" : c), # "\r" is normalized as "\n"
+				r,
+				'single byte characters should round-trip properly'
+			)
 		}
 	end
 
@@ -177,18 +210,19 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			0x10ffff,
 		].each {|ucs_code|
 			[-1,0,1].each {|ofs|
-				(c = [ucs_code + ofs].pack('U')) rescue next
+				(c = [ucs_code + ofs].pack('U'))
+				next unless c.valid_encoding? if c.respond_to? :valid_encoding?
 				c_hex = c.unpack('H8')
 				y = c.ya2yaml(
 					:escape_b_specific => true,
 					:escape_as_utf8    => true
 				)
-#				puts y
 				r = YAML.load(y)
 				assert_equal(
-					[c_hex,(c =~ /\xc2\x85/u ? "\n" : c)],
-					[c_hex,r]
-				) # "\N" is normalized as "\n".
+					(c == "\xc2\x85" ? "\n" : c), # "\N" is normalized as "\n"
+					r,
+					"multi byte characters #{c_hex} should round-trip properly"
+				)
 			}
 		}
 	end
@@ -254,13 +288,16 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			 '=',
 		 ].each {|c|
 		 	['','hoge'].each {|ext|
-			 	src = c.class == String ? (c + ext) : c
+				src = (c.class == String) ? (c + ext) : c
 				y = src.ya2yaml(
 					:escape_as_utf8 => true
 				)
-#				puts y
 				r = YAML.load(y)
-				assert_equal(src,r)
+				assert_equal(
+					src,
+					r,
+					'ambiguous elements should round-trip properly'
+				)
 			}
 		}
 	end
@@ -271,22 +308,39 @@ class TC_Ya2YAML < Test::Unit::TestCase
 		chars.each {|i|
 			chars.each {|j|
 				chars.each {|k|
-					chars.each {|l|
-						src = i + j + k + l
-						y =  src.ya2yaml(
-							:printable_with_syck => true,
-							:escape_b_specific   => true,
-							:escape_as_utf8      => true
-						)
-#						puts y
-						r = YAML.load(y)
-						assert_equal(src,r)
-					}
+					src = i + j + k
+					y =  src.ya2yaml(
+						:printable_with_syck => true,
+						:escape_b_specific   => true,
+						:escape_as_utf8      => true
+					)
+					r = YAML.load(y)
+					assert_equal(
+						src,
+						r,
+						'string of special characters should round-trip properly'
+					)
 				}
 			}
 		}
 	end
 
+	# patch by pawel.j.radecki at gmail.com. thanks!
+	def test_roundtrip_symbols
+		symbol1 = :"Batman: The Dark Knight - Why So Serious?!"
+		result_symbol1 = YAML.load(symbol1.ya2yaml)
+		assert_equal(symbol1,result_symbol1)
+
+		symbol2 = :"Batman: The Dark Knight - \"Why So Serious?!\""
+		result_symbol2 = YAML.load(symbol2.ya2yaml)
+		assert_equal(symbol2,result_symbol2)
+
+#		# YAML.load problem: the quotes within the symbol are lost here
+#		symbol3 = :"\"Batman: The Dark Knight - Why So Serious?!\""
+#		result_symbol3 = YAML.load(symbol3.ya2yaml)
+#		assert_equal(symbol3,result_symbol3)
+	end
+
 	def test_roundtrip_types
 		objects = [
 			[],
@@ -296,21 +350,22 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			nil,
 			'hoge',
 			"abc\nxyz\n",
-			"\xff\xff",
+			(s = "\xff\xff"),
 			true,
 			false,
 			1000,
 			1000.1,
 			-1000,
 			-1000.1,
-			Date.today(),
-			Time.new(),
+			Date.new(2009,2,9),
+			Time.local(2009,2,9,16,35,22),
 			:foo,
 			1..10,
 			/abc\nxyz/i,
 			@struct,
 			@klass,
 		]
+		s.force_encoding("BINARY") if s.respond_to? :force_encoding
 
 		objects.each {|obj|
 			src = case obj.class.to_s
@@ -337,16 +392,19 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			y = src.ya2yaml(
 				:syck_compatible => true
 			)
-#			puts y
 
 			r = YAML.load(y)
-			assert_equal(src,r)
+			assert_equal(
+				src,
+				r,
+				'types other than String should round-trip properly'
+			)
 		}
 	end
 
 	def test_roundtrip_various
 		[
-			[1,2,['c','d',[[['e']],[]],'f'],3,Time.new(),[[:foo]],nil,true,false,[],{},{[123,223]=>456},{[1]=>2,'a'=>'b','c' => [9,9,9],Time.new() => 'hoge'},],
+			[1,2,['c','d',[[['e']],[]],'f'],3,Time.local(2009,2,9,17,9),[[:foo]],nil,true,false,[],{},{[123,223]=>456},{[1]=>2,'a'=>'b','c' => [9,9,9],Time.local(2009,2,9,17,10) => 'hoge'},],
 			[],
 			{[123,223]=>456},
 			{},
@@ -370,13 +428,14 @@ class TC_Ya2YAML < Test::Unit::TestCase
 			y = src.ya2yaml(
 				:syck_compatible => true
 			)
-#			puts y
 
 			r = YAML.load(y)
-			assert_equal(src,r)
+			assert_equal(
+				src,
+				r,
+				'various types should round-trip properly'
+			)
 		}
 	end
 
 end
-
-__END__

metadata

@@ -1,33 +1,32 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: ya2yaml
 version: !ruby/object:Gem::Version 
-  version: "0.26"
-date: 2007-01-19 00:00:00 +09:00
-summary: An UTF8 safe YAML dumper.
-require_paths: 
-- lib
-email: funai.akira@gmail.com
-homepage: http://rubyforge.org/projects/ya2yaml/
-rubyforge_project: 
-description: 
-autorequire: ya2yaml
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  prerelease: false
+  segments: 
+  - 0
+  - 29
+  - 2
+  version: 0.29.2
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Akira FUNAI
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2010-05-04 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: |
+  Ya2YAML is "yet another to_yaml". It emits YAML document with complete UTF8 support (string/binary detection, "\u" escape sequences and Unicode specific line breaks).
+
+email: akira@funai.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
 files: 
 - lib/ya2yaml.rb
 - README
@@ -35,20 +34,40 @@ files:
 - test/t.gif
 - test/t.yaml
 - test/test.rb
-test_files: 
-- test/test.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/ya2yaml/
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --main
 - README
 - --charset
 - UTF8
-extra_rdoc_files: 
-- README
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      - 0
+      - 0
+      version: 0.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
-dependencies: []
-
+rubyforge_project: ya2yaml
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 1
+summary: An UTF8 safe YAML dumper.
+test_files: 
+- test/test.rb