faker_japanese 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa2074e5823b55f9f022b3616355a86926894d16
+  data.tar.gz: d509aa2f6ee814097be04c75ed5c89537e984efb
+SHA512:
+  metadata.gz: fa07b8360b40aeae4f10e0dbde615a34617daeca9b4a0e71f8827462048774094d502e78ade28569ff35aa20c7c70403b513f116198d58e051d766848541e7fd
+  data.tar.gz: 8638f7ebb2b7f2d3006e714ceccada9ad6078b1fc8ec70eb21558de254b8ef536dec9a3d16f4a59caf744c8abedebdcafc5fdf5600867934373f96af755c2c2d

data/.gitignore

@@ -0,0 +1,41 @@
+# System generic ignores
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Gem specific ignores
+*.gem
+*.rbc
+.bundle
+.bin
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Denis Vazhenin
+
+MIT License
+
+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.md

@@ -0,0 +1,122 @@
+# faker_japanese
+
+Faker extension to generate Japanese names.
+Provides fake first and last name in kanji,hiragana, katakana
+and romaji(name written with latin alphabet).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faker_japanese'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faker_japanese
+
+## Usage
+
+To enable faker_japanese manually use
+
+```
+require 'faker/japanese'
+```
+
+Before using, set locale to `ja`
+
+```
+Faker::Config.locale = "ja"
+```
+
+Then use `Faker::Name` as you would normally do
+
+```
+n = Faker::Name.name
+=> "吉田 順"
+```
+
+```
+ln = Faker::Name.last_name
+=> "山本"
+```
+
+```
+fn = Faker::Name.first_name
+=> "吉"
+```
+
+Along with name in kanji it is possible to get
+same values in hiragana, katakana and romaji
+
+```
+n.yomi
+=> "よしだ じゅん"
+n.kana
+=> "ヨシダ ジュン"
+n.romaji
+=> "Yoshida Jun"
+
+ln.yomi
+=> "やまもと"
+ln.kana
+=> "ヤマモト"
+ln.romaji
+=> "Yamamoto"
+
+fn.yomi
+=> "よし"
+fn.kana
+=> "ヨシ"
+fn.romaji
+=> "Yoshi"
+```
+
+## When is it useful?
+
+Currently, using only methods and localization provide by Faker
+it is not possible to reuse they values to generate other `fake` data.
+
+For example
+
+```
+Faker::Config.locale = "ja"
+ln = Faker::Name.last_name
+p ln
+=> "伊藤"
+ml = Faker::Internet.email(ln)
+p ml
+=>"@.name"
+```
+
+On the other hand, using `faker_japanese` it is possible to pass
+name in romaji to generate valid value:
+
+```
+nickname = Faker::Name.name.romaji.split.join.downcase
+=> "hayashiyori"
+freeemail = Faker::Internet.free_email(nickname)
+=> "hayashiyori@gmail.com"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Acknowledgements
+
+Idea for this work was heavily inspired by the following projects:
+- [Faker main project](https://github.com/stympy/faker)
+- [faker-ja by xiaotuanzi](https://github.com/xiaotuanzi/faker-ja)
+- [ruby-faker-japanese by tily](https://github.com/tily/ruby-faker-japanese)
+
+## License
+
+MIT License (see LICENSE.txt)

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test => :spec
+
+# Documentation
+YARD::Rake::YardocTask.new do |t|
+	t.files   = ['lib/**/*.rb']   # optional
+end
+
+# desc "Generate gem documentation (same as running 'rake yard')"
+task :doc => :yard

data/faker_japanese.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faker_japanese/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faker_japanese"
+  spec.version       = Faker::Japanese::VERSION
+  spec.authors       = ["Denis Vazhenin"]
+  spec.email         = ["denis.vazhenin@me.com"]
+  spec.description   = %q{Faker extension providing japanese names}
+  spec.summary       = %q{Faker extension for japanese names}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faker"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-expectations"
+  spec.add_development_dependency "fuubar"
+	spec.add_development_dependency "yard"
+end

data/lib/faker_japanese.rb

@@ -0,0 +1,69 @@
+require 'faker'
+
+module Faker
+	module Japanese
+		SELFDIR = File.expand_path(File.dirname(__FILE__))
+
+		class Kanji < String
+			attr_reader :yomi, :kana, :romaji
+
+			def initialize(kanji, yomi, kana, romaji)
+				super(kanji)
+				@yomi = yomi
+				@kana = kana
+				@romaji = romaji
+			end
+		end
+
+		class Base
+			class << self
+
+				# Using callback to store loaded data when subclass is created
+				def inherited(klass)
+					klass.class_variable_set "@@data", load_data(klass)
+				end
+
+				# Load fake data from yml file
+				def load_data(klass)
+					datafile = File.join(SELFDIR, 'faker_japanese',
+						'data', "#{klass.to_s.split('::').last.downcase}.yml")
+					if datafile && File.readable?(datafile)
+            data = YAML.load_file(datafile).each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+            data.inject({}) do |res, item|
+            	key, values, = item
+            	res.update(key => values.map! { |v| Kanji.new(*v) })
+            end
+					else
+						nil
+					end
+				end
+
+				# Search
+				def fetch(key)
+					val = self.class_variable_get("@@data")[key]
+					ret = val[rand(val.size)]
+				end
+
+				# Swap method if block was evaluated to true
+				def swap_method(klass, name)
+					original_method 	=klass.method(name)
+					new_method				=method(name)
+					klass.singleton_class.send :define_method, name, proc {
+						yield ? new_method.call : original_method.call
+					}
+				end
+
+				# Decide which method to use based on value of Faker::Config.locale
+				def use_japanese_method(klass, name)
+					swap_method(klass, name) do
+						Faker::Config.locale == "ja"
+					end
+				end
+
+			end # << self
+		end # Base
+	end # Japanese
+end # Faker
+
+require 'faker_japanese/version'
+require 'faker_japanese/name'

data/lib/faker_japanese/data/name.yml

@@ -0,0 +1,32 @@
+last_name:
+  - ["藤井","ふじい", "フジイ", "Fujii"]
+  - ["林", "はやし", "ハヤシ", "Hayashi"]
+  - ["伊藤", "いとう", "イトウ", "Ito"]
+  - ["加藤", "かとう", "カトウ", "Kato"]
+  - ["小林", "こばやし", "コバヤシ", "Kobayashi"]
+  - ["黒木", "くろき", "クロキ", "Kuroki"]
+  - ["佐藤", "さとう", "サトウ", "Sato"]
+  - ["鈴木", "すずき", "スズキ", "Suzuki"]
+  - ["高橋", "たかはし", "タカハシ", "Takahashi"]
+  - ["田中", "たなか", "タナカ", "Tanaka"]
+  - ["渡辺", "わたなべ", "ワタナベ", "Watanabe"]
+  - ["山田", "やまだ", "ヤマダ", "Yamada"]
+  - ["山本", "やまもと", "ヤマモト", "Yamamoto"]
+  - ["吉田", "よしだ", "ヨシダ", "Yoshida"]
+
+first_name:
+  - ["秋", "あき", "アキ", "Aki"]
+  - ["明", "あきら", "アキラ", "Akira"]
+  - ["輝", "ひかる", "ヒカル", "Hikaru"]
+  - ["裕", "ひろ", "ヒロ", "Hiro"]
+  - ["密", "ひそか", "ヒソカ", "Hisoka"]
+  - ["順", "じゅん", "ジュン", "Jun"]
+  - ["楓", "かえで", "カエデ", "Kaede"]
+  - ["琥珀", "こはく", "コハク", "Kohaku"]
+  - ["雅", "まさ", "マサ", "Masa"]
+  - ["真澄", "ますみ", "マサミ", "Masumi"]
+  - ["直樹", "なおき", "ナオキ", "Naoki"]
+  - ["亮", "りょう", "リョウ", "Ryou"]
+  - ["より", "より", "ヨリ", "Yori"]
+  - ["吉", "よし", "ヨシ", "Yoshi"]
+  - ["雪", "ゆき", "ユキ", "Yuki"]

data/lib/faker_japanese/name.rb

@@ -0,0 +1,33 @@
+module Faker
+  module Japanese
+    class Name < Base
+      class << self
+
+        # Return fake first name
+        def first_name
+          fetch(:first_name)
+        end
+
+        # Return fake last name
+        def last_name
+          fetch(:last_name)
+        end
+
+        # Return fake name, which is a string combining last and first name
+        def name
+          first_name  =fetch(:first_name)
+          last_name   =fetch(:last_name)
+          name_kanji  ="#{last_name} #{first_name}"
+          name_yomi   ="#{last_name.yomi} #{first_name.yomi}"
+          name_kana   ="#{last_name.kana} #{first_name.kana}"
+          name_romaji ="#{last_name.romaji} #{first_name.romaji}"
+          Kanji.new(name_kanji, name_yomi, name_kana, name_romaji)
+        end
+      end
+
+      use_japanese_method Faker::Name, :first_name
+      use_japanese_method Faker::Name, :last_name
+      use_japanese_method Faker::Name, :name
+    end
+  end
+end

data/lib/faker_japanese/version.rb

@@ -0,0 +1,5 @@
+module Faker
+	module Japanese
+		VERSION = "0.1.2"
+	end
+end

data/spec/lib/faker_japanese_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Faker::Japanese do
+
+  it "should use native methods when locale is not set to ja" do
+    if (Faker::Config.locale != 'ja')
+      name = Faker::Name.name
+      name.should_not be_nil
+      name.contains_cjk?.should == false
+      first_name = Faker::Name.first_name
+      first_name.should_not be_nil
+      first_name.contains_cjk?.should == false
+      last_name = Faker::Name.first_name
+      last_name.should_not be_nil
+      last_name.contains_cjk?.should == false
+    else
+      fail
+    end
+  end
+
+  it "should not use japanese method when locale is not set to ja" do
+    name = Faker::Name.name
+    expect { name.yomi }.to raise_error NoMethodError
+    expect { name.kana }.to raise_error NoMethodError
+    expect { name.romaji }.to raise_error NoMethodError
+  end
+
+  it "should use japanese method when locale is set to ja" do
+    Faker::Config.locale = 'ja'
+    if (Faker::Config.locale == 'ja')
+      first_name = Faker::Name.first_name
+      first_name.should_not be_nil
+      first_name.contains_cjk?.should == true
+      last_name = Faker::Name.last_name
+      last_name.should_not be_nil
+      last_name.contains_cjk?.should == true
+      name = Faker::Name.name
+      name.should_not be_nil
+      name.contains_cjk?.should == true
+      name.yomi.contains_cjk?.should == true
+      name.kana.contains_cjk?.should == true
+      name.romaji.contains_cjk?.should == false
+    else
+      fail
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'faker_japanese'
+
+class String
+  # Method to check if string contains cjk characters
+  def contains_cjk?
+    !!(self =~ /\p{Han}|\p{Katakana}|\p{Hiragana}|\p{Hangul}/)
+  end
+end
+
+I18n.enforce_available_locales = true
+
+RSpec.configure do |config|
+  config.failure_color = :magenta
+  config.tty = true
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: faker_japanese
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Denis Vazhenin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Faker extension providing japanese names
+email:
+- denis.vazhenin@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faker_japanese.gemspec
+- lib/faker_japanese.rb
+- lib/faker_japanese/data/name.yml
+- lib/faker_japanese/name.rb
+- lib/faker_japanese/version.rb
+- spec/lib/faker_japanese_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Faker extension for japanese names
+test_files:
+- spec/lib/faker_japanese_spec.rb
+- spec/spec_helper.rb
+has_rdoc: