yaml_waml 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+MIT-LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/History.txt

@@ -0,0 +1,17 @@
+=== Version 0.2.0
+
+2008-09-02.
+
+- Applied patch from OHASHI Hideya: YAML.dump support.
+
+=== Version 0.1.2
+
+2008-09-02.
+
+- gemized in http://gems.github.com/
+
+=== Version 0.1.1
+
+2007-01-05.
+
+- initial release.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Akira Ikeda, KAKUTANI Shintaro
+
+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.rdoc

@@ -0,0 +1,77 @@
+= YamlWaml
+
+YamlWaml is for 'YAML WorkAround for Multibyte Language'.
+
+This Rails plugin originated by the blog entry written by Akira Ikeda.
+
+(*) http://d.hatena.ne.jp/Rommy/20061229/1167406811
+
+== Install
+
+=== Installing the gem manually
+
+ gem sources -a http://gems.github.com
+ gem install kakutani-yaml_waml
+
+in ruby code ...
+
+ require 'rubygems'
+ gem 'kakutani-yaml_waml'
+ ...
+ require 'yaml_waml'
+
+=== 2.1.0 <= rails w/ gem dependencies
+
+ Rails::Initializer.run do |config|
+   config.gem 'kakutani-yaml_waml', :version => '~> 0.1.1', :lib => 'yaml_waml',
+     :source => 'http://gems.github.com'
+ end
+
+=== 2.1.0 <= rails
+
+* script/plugin install git://github.com/kakutani/yaml_waml.git
+
+=== rails <= 2.0.2
+
+* script/plugin install http://yaml-waml.googlecode.com/svn/plugins/yaml_waml
+
+== Repositories
+
+== Git
+
+* git://github.com/kakutani/yaml_waml.git
+
+== SVN repository (obsoleted)
+
+* http://yaml-waml.googlecode.com/svn/plugins/yaml_waml
+
+It will not maintain anymore.
+
+== License
+
+MIT License
+
+== Running the specs
+
+In order to run YamlWaml's full suite of specs (rake pre_commit),
+you must install the following gems:
+
+* rspec	 		# Tests plugin behaviour
+* rake          # Runs the build script
+* rcov          # Verifies that the code is 100% covered by specs
+
+== Web Site
+
+* http://github.com/kakutani/yaml_waml/
+
+== Authors
+
+Akira Ikeda(pinpon.ikeda at gmail.com), http://d.hatena.ne.jp/Rommy
+
+Adapted by KAKUTANI Shintaro(shintaro at kakutani.com), http://kakutani.com
+
+Thaks for pathes from followings:
+
+* OHASHI Hideya (handling StringIO), http://github.com/ohac
+* Nobuhiro IMAI (DRYied, handling IO), http://github.com/no6v
+* Keiji Yoshimi (benchmark script and some advices), http://github.com/walf443

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+gem 'rspec', '>= 1.1.4'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+task :pre_commit => [:spec, 'coverage:verify']
+
+desc 'Run all specs under spec/**/*_spec.rb'
+Spec::Rake::SpecTask.new(:spec => 'coverage:clean') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c", "--diff"]
+  t.rcov = true
+  t.rcov_opts = ["--include-file", "lib\/*\.rb", "--exclude", "spec\/"]
+end
+
+desc 'Generate documentation for the yaml_waml plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'YamlWaml'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :coverage do
+  desc "Delete aggregate coverage data."
+  task(:clean) { rm_f "coverage" }
+
+  desc "verify coverage threshold via RCov"
+  RCov::VerifyTask.new(:verify => :spec) do |t|
+    t.threshold = 100.0 # Make sure you have rcov 0.7 or higher!
+    t.index_html = 'coverage/index.html'
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yaml_waml"
+    gem.summary = "'to_yaml' workaround for multibyte UTF-8 string."
+    gem.description = "Plugin gem to workaround for fixing output result of 'to_yaml' method treats multibyte UTF-8 string(such as japanese) as binary. "
+    gem.has_rdoc = false
+    gem.email = "shintaro@kakutani.com"
+    gem.homepage = "http://github.com/kakutani/yaml_waml"
+    gem.authors = ["KAKUTANI Shintaro", "Akira Ikeda"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/benchmark/huge_yaml_dump.rb

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+require 'benchmark'
+require 'yaml'
+
+class String
+  def is_binary_data?
+    false
+  end
+end
+
+data = [ "あいうえお漢字" * 10000, "__BBBBBBBBBBBBBBB__", "あいうえお" * 10000 ]
+
+yaml_str = data.to_yaml
+Benchmark.bm do |x|
+  x.report('original yaml_waml') {
+    yaml_str.gsub(/\\x(\w{2})/) {
+      [ Regexp.last_match.captures.first.to_i(16)].pack("C")
+    }
+  }
+
+  x.report('using $1') {
+    yaml_str.gsub(/\\x(\w{2})/) {
+      [ $1.to_i(16) ].pack("C")
+    }
+  }
+
+  x.report('using $1 w/ H2') {
+    yaml_str.gsub(/\\x(\w{2})/){
+      [$1].pack("H2")
+    }
+  }
+
+  x.report('with memoize') {
+    memoize_of = {}
+    yaml_str.gsub(/\\x(\w{2})/) {|s|
+      memoize_of[s] ||= [ Regexp.last_match.captures.first.to_i(16)].pack("C")
+    }
+  }
+
+  x.report('with memoize and $1') {
+    memoize_of = {}
+    yaml_str.gsub(/\\x(\w{2})/) {|s|
+      memoize_of[s] ||= [ $1.to_i(16) ].pack("C")
+    }
+  }
+
+  x.report('with symbol table ') {
+    memoize_of = {}
+    chars = %w( 0 1 2 3 4 5 6 7 8 9 A B C D E F )
+    chars.each do |char1|
+      chars.each do |char2|
+        val = char1 + char2
+        memoize_of["\\x#{val}"] = [ val.to_i(16) ].pack("C")
+      end
+    end
+    yaml_str.gsub(/\\x\w{2}/) {|s|
+      memoize_of[s]
+    }
+  }
+
+  x.report('packing  multi chars') {
+    regex = /\\x/
+    # 100は結構てきとう。無条件に大きすぎると返って遅くなりそうな気がするので適当なサイズにしておく
+    yaml_str.gsub(/(?:\\x(\w{2})){0,100}/) {|s|
+      s.split(regex).compact.map {|s| s.to_i(16) }.pack("C*").gsub("\0", '')
+    }
+  }
+
+end
+
+# result on my environment( MacBook Pro Intel Core Duo 2.5 GHz, 4GB), result is like that
+#                         user     system      total        real
+# original yaml_waml     1.700000   0.030000   1.730000 (  2.460140)
+# using $1               1.430000   0.020000   1.450000 (  2.030178)
+# using $1 w/ H2         1.160000   0.010000   1.170000 (  1.476650)
+# with memoize           0.770000   0.010000   0.780000 (  0.972146)
+# with memoize and $1    0.780000   0.010000   0.790000 (  0.973506)
+# with symbol table      0.770000   0.010000   0.780000 (  1.102112)
+# packing  multi chars   0.740000   0.010000   0.750000 (  0.908722)

data/init.rb

@@ -0,0 +1 @@
+require 'yaml_waml'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/yaml_waml.rb

@@ -0,0 +1,35 @@
+require "yaml"
+
+class String
+  def is_binary_data?
+    false
+  end
+end
+
+module YamlWaml
+  def decode(orig_yamled)
+    yamled_str = case orig_yamled
+                 when String then orig_yamled
+                 when StringIO then orig_yamled.string
+                 else return orig_yamled
+                 end
+    yamled_str.gsub!(/\\x(\w{2})/){[$1].pack("H2")}
+    return yamled_str
+  end
+  module_function :decode
+end
+
+ObjectSpace.each_object(Class) do |klass|
+  klass.class_eval do
+    if method_defined?(:to_yaml) && !method_defined?(:to_yaml_with_decode)
+      def to_yaml_with_decode(*args)
+        io = args.shift if IO === args.first
+        yamled_str = YamlWaml.decode(to_yaml_without_decode(*args))
+        io.write(yamled_str) if io
+        return yamled_str
+      end
+      alias_method :to_yaml_without_decode, :to_yaml
+      alias_method :to_yaml, :to_yaml_with_decode
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/yaml_waml'

data/spec/to_yaml_spec.rb

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+require File.dirname(__FILE__) + "/spec_helper"
+BLANK = " "
+describe YAML, "#to_yaml" do
+  describe "Japanese text" do
+    it "String should output string" do
+      "あ".to_yaml.should == <<-EXPECTED
+--- "あ"
+    EXPECTED
+    end
+
+    it "Array-ed string should output string" do
+      ['あ','い'].to_yaml.should == <<-EXPECTED
+---#{BLANK}
+- "あ"
+- "い"
+    EXPECTED
+    end
+
+    it "Hash-ed string should output string" do
+      {'日本語' => ['出力']}.to_yaml.should == <<-EXPECTED
+---#{BLANK}
+"日本語":#{BLANK}
+- "出力"
+    EXPECTED
+    end
+
+    it "mixed Array should output string" do
+      actual = [["あ", "い"], {"う" => ["え"]}, Struct.new(:name).new("お")]
+      actual.to_yaml.should == <<-EXPECTED
+---#{BLANK}
+- - "あ"
+  - "い"
+- "う":#{BLANK}
+  - "え"
+- !ruby/struct:#{BLANK}
+  name: "お"
+    EXPECTED
+    end
+  end
+end
+
+describe YAML, ".dump" do
+  it "should output yaml string" do
+    YAML.dump("あ").should == <<-EXPECTED
+--- "あ"
+    EXPECTED
+  end
+
+  it "should be StringIO-friendly" do
+    actual = [["あ", "い"], {"う" => ["え"]}, Struct.new(:name).new("お")]
+    io = StringIO.new
+    YAML.dump(actual, io)
+    io.string.should == <<-EXPECTED
+---#{BLANK}
+- - "あ"
+  - "い"
+- "う":#{BLANK}
+  - "え"
+- !ruby/struct:#{BLANK}
+  name: "お"
+    EXPECTED
+  end
+
+
+  require 'fileutils'
+
+  TEST_FILEPATH = File.expand_path("to_yaml_io.txt", File.dirname(__FILE__))
+  before(:all) do
+    FileUtils.touch(TEST_FILEPATH)
+  end
+
+  after(:all) do
+    FileUtils.rm(TEST_FILEPATH)
+  end
+
+  it "should be IO-friendly" do
+    actual = [["や", "む"], {"る" => ["わ", "む"]}, "る"]
+    File.open(TEST_FILEPATH, 'w') do |f|
+        YAML.dump(actual, f)
+    end
+    yamled_str = File.read(TEST_FILEPATH)
+    yamled_str.should == <<-EXPECTED
+---#{BLANK}
+- - "や"
+  - "む"
+- "る":#{BLANK}
+  - "わ"
+  - "む"
+- "る"
+      EXPECTED
+  end
+end

data/tasks/yaml_waml_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :yaml_waml do
+#   # Task goes here
+# end

data/yaml_waml.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yaml_waml}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["KAKUTANI Shintaro", "Akira Ikeda"]
+  s.date = %q{2009-10-20}
+  s.description = %q{Plugin gem to workaround for fixing output result of 'to_yaml' method treats multibyte UTF-8 string(such as japanese) as binary. }
+  s.email = %q{shintaro@kakutani.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.txt",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "benchmark/huge_yaml_dump.rb",
+     "init.rb",
+     "install.rb",
+     "lib/yaml_waml.rb",
+     "spec/spec_helper.rb",
+     "spec/to_yaml_spec.rb",
+     "tasks/yaml_waml_tasks.rake",
+     "yaml_waml.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kakutani/yaml_waml}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{'to_yaml' workaround for multibyte UTF-8 string.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/to_yaml_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: yaml_waml
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- KAKUTANI Shintaro
+- Akira Ikeda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-20 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: "Plugin gem to workaround for fixing output result of 'to_yaml' method treats multibyte UTF-8 string(such as japanese) as binary. "
+email: shintaro@kakutani.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- History.txt
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- benchmark/huge_yaml_dump.rb
+- init.rb
+- install.rb
+- lib/yaml_waml.rb
+- spec/spec_helper.rb
+- spec/to_yaml_spec.rb
+- tasks/yaml_waml_tasks.rake
+- yaml_waml.gemspec
+has_rdoc: true
+homepage: http://github.com/kakutani/yaml_waml
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "'to_yaml' workaround for multibyte UTF-8 string."
+test_files: 
+- spec/spec_helper.rb
+- spec/to_yaml_spec.rb