forgery_ja 0.0.1 → 0.1.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/*

data/.yardoc/checksums

@@ -0,0 +1,8 @@
+lib/forgery_ja/version.rb cb80b1a6ef92bef543bfdf913f12a381ded58b9f
+lib/forgery_ja/constant.rb 725f1d5eb24f6d568d7d14b69ccc6780364cc343
+lib/forgery_ja/forgery_ja.rb 4bcbfc592564edff42dc21ce66f9a914057d1593
+lib/forgery_ja/forgery_ja_api.rb a6e0908d17ff65c2ed9d63bf321126d5d555e95f
+lib/forgery_ja/forgery_ja/date.rb fdc36502d38430114900f76c3bcbdab272c1bf1a
+lib/forgery_ja/forgery_ja/name.rb 3a3b61f87f1b935399a515ab151085aa2ac53488
+lib/forgery_ja/forgery_ja/address.rb 38ab2111b036e38f5b2513f37b689121dfb96742
+lib/forgery_ja/forgery_ja/monetary.rb bbaa75332899e9b2a26ceabb61c577b319ef2a82

data/Gemfile

@@ -3,6 +3,11 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in forgery_ja.gemspec
 gem 'forgery'
 
+group :development do
+  gem 'yard'
+  gem 'rdiscount'
+end
+
 group :development, :test do
   gem 'rspec-rails'
 

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 NAMAKESUGI
+
+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/Rakefile

@@ -1,4 +1,25 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/forgery_ja/**/*.rb']
+  t.options = []
+  t.options << '--debug' << '--verbose' if $trace
+end
+
+task :default => :spec
+
+

data/lib/forgery_ja/constant.rb

@@ -8,5 +8,7 @@ class ForgeryJa
   # Define RETURN_TYPE : Half Katakana
   H_KANA = 3
   # Define RETURN_TYPE : Romaji
-  ROMA = 4  
+  ROMA = 4
+  # Define RETURN_TYPE : Array
+  ARRAY = 5
 end

data/lib/forgery_ja/forgery_ja/address.rb

@@ -1,4 +1,3 @@
 # coding: utf-8
-# Extensions Forgery::Date
 class ForgeryJa::Address < Forgery::Address
 end

data/lib/forgery_ja/forgery_ja/monetary.rb

@@ -11,7 +11,9 @@ class ForgeryJa::Monetary < Forgery::Monetary
     options[:format] % money(options)
   end
 
-  # @params Hash options
+  # Create Random number
+  #  defaut 0 to 1000
+  # @param Hash options
   # @option options [Fixnum] :max (1000) 金額の最大値
   # @option options [Fixnum] :min (0) 金額の最小値
   # @return Fixnum
@@ -23,7 +25,9 @@ class ForgeryJa::Monetary < Forgery::Monetary
   end
 
   # popularity in Japan
-  # @params Hash options
+  #   日本においてポピュラーな数値を生成します
+  #   適当実装ですので1980, 19800,などの数値になります
+  # @param Hash options
   # @option options [Fixnum] :digit (4) 金額の桁
   # @return Fixnum
   def self.popularity_money(options={})

data/lib/forgery_ja/forgery_ja/name.rb

@@ -1,49 +1,97 @@
 # encoding: utf-8
+# ForgeryJa::Name
+#   日本語の名前関連のダミーデータを生成します
+#   一部を除き引数に:to => ForgeryJa::KANA等を指定するとその指定した形式で出力されます
+# @example
+#   ForgeryJa[:name].last_name #=> "佐藤"
+#   ForgeryJa[:name].last_name(:to => ForgeryJa::KANA) #=> "サトウ"
+#   ForgeryJa[:name].last_name(:to => ForgeryJa::ARRAY) #=> ["佐藤", "さとう", "サトウ", "ｻﾄｳ", "sato"]
 class ForgeryJa::Name < Forgery::Name
   # Returns LastName in Japanese
-  # @params ret_type [Fixnum] 戻す形を指定します
-  # @example
-  #   Forgery[:name_ja].last_name #=> "佐藤"
-  #   Forgery[:name_ja].last_name(Forgery::NameJa::HIRA) #=> "さとう"
-  #   Forgery[:name_ja].last_name(Forgery::NameJa::KANA) #=> "サトウ"
-  #   Forgery[:name_ja].last_name(Forgery::NameJa::H_KANA) #=> "ｻﾄｳ" = half kana
-  #   Forgery[:name_ja].last_name(Forgery::NameJa::ROMA) #=> "sato"
-  #   Forgery[:name_ja].last_name(nil) #=> ["佐藤", "さとう", "サトウ", "ｻﾄｳ", "sato"]
-  def self.last_name(ret_type=ForgeryJa::KANJI)
-    parse(dictionaries[:last_names_ja].random, ret_type)
+  #   日本語の名字を返します
+  # * 辞書ファイル : last_names_ja
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.last_name(options={})
+    options = default_options(options)
+    parse(dictionaries[:last_names_ja].random, options[:to])
   end
 
-  def self.first_name(ret_type=ForgeryJa::KANJI)
-    parse([dictionaries[:male_first_names_ja], dictionaries[:female_first_names_ja]].random.random, ret_type)
+  # Returns FirstName in Japanese
+  #   日本語の名前を返します
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.first_name(options={})
+    options = default_options(options)
+    parse([dictionaries[:male_first_names_ja], dictionaries[:female_first_names_ja]].random.random, options[:to])
   end
 
-  def self.full_name(ret_type=ForgeryJa::KANJI)
-    "#{self.last_name(ret_type)} #{self.first_name(ret_type)}"
+  # Returns FullName in Japanese
+  #   日本語のフルネームを返します
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.full_name(options={})
+    options = default_options(options)
+    "#{self.last_name(options)} #{self.first_name(options)}"
   end
 
-  def self.male_first_name(ret_type=ForgeryJa::KANJI)
-    parse(dictionaries[:male_first_names_ja].random, ret_type)
+  # Returns Male FirstName in Japanese
+  #   日本語の男性の名前を返します
+  # * 辞書ファイル : male_first_names_ja
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.male_first_name(options={})
+    options = default_options(options)
+    parse(dictionaries[:male_first_names_ja].random, options[:to])
   end
 
-  def self.female_first_name(ret_type=ForgeryJa::KANJI)
-    parse(dictionaries[:female_first_names_ja].random, ret_type)
+  # Returns Female FirstName in Japanese
+  #   日本語の女性の名前を返します
+  # * 辞書ファイル : female_first_names_ja
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.female_first_name(options={})
+    options = default_options(options)
+    parse(dictionaries[:female_first_names_ja].random, options[:to])
   end
 
-  def self.company_name(ret_type=ForgeryJa::KANJI)
-    parse(dictionaries[:company_names_ja].random, ret_type)
+  # Returns CompanyName in Japanese
+  #   日本語の企業名を返します
+  #   利用している企業は上場企業から適当に抽出しています
+  # * 辞書ファイル : company_names_ja
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.company_name(options={})
+    options = default_options(options)
+    parse(dictionaries[:company_names_ja].random, options[:to])
   end
 
-  def self.job_title(ret_type=ForgeryJa::KANJI)
-    parse(dictionaries[:job_titles_ja].random, ret_type)
+  # Returns JobTitle in Japanese
+  #   日本語の職業名を返します
+  # * 辞書ファイル : job_titles_ja
+  # @param Hash options
+  # @option options [Fixnum] :to (ForgeryJa::KANJI) 生成する文字の種類を指定します
+  def self.job_title(options={})
+    options = default_options(options)
+    parse(dictionaries[:job_titles_ja].random, options[:to])
   end
 
+  # Returns NameTitle in Japanese
+  #   日本語の敬称名を返します
+  # * 辞書ファイル : name_titles_ja
+  # * optionの指定はできません
   def self.title
     dictionaries[:name_titles_ja].random
   end
 
   private
+  # merge option
+  def self.default_options(option)
+    {:to => ForgeryJa::KANJI}.merge(option)
+  end
+  # parse dictionaries data
   def self.parse(str, ret_type)
     strs = str.split(' ')
-    ret_type ? str[ret_type] : strs
+    ret_type ? strs[ret_type] : strs
   end
 end

data/lib/forgery_ja/forgery_ja_api.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+# ForgeryJa Api
 def ForgeryJa(forgery, method=nil, *args)
   klass = "ForgeryJa::#{forgery.to_s.camelize}".constantize
   if method

data/lib/forgery_ja/version.rb

@@ -1,3 +1,4 @@
 class ForgeryJa
-  VERSION = "0.0.1"
+  # version number
+  VERSION = "0.1.0"
 end

data/spec/forgery_ja/name_spec.rb

@@ -4,23 +4,53 @@ require 'spec_helper'
 describe ForgeryJa::Name do
   describe ".last_name" do
     context "名字(漢字)が返る" do
-      subject { ForgeryJa(:name).last_name(ForgeryJa::KANJI) }
-      it { should match /^[^あ-んa-zア-ンｱｰﾝ]+$/ }
+      subject { ForgeryJa(:name).last_name(:to => ForgeryJa::KANJI) }
+      it { should match /^[^A-Za-zｱ-ﾝｧ-ｮｯｰﾟﾞ･]+$/ }
     end
-    context "名字(ひらがな)が返る" do
-      subject { ForgeryJa(:name).last_name(ForgeryJa::HIRA) }
-      it { should.is_a?(String) }
+  end
+  describe ".first_name" do
+    context "名前(漢字)が返る" do
+      subject { ForgeryJa(:name).first_name(:to => ForgeryJa::KANJI) }
+      it { should match /^[^A-Za-zｱ-ﾝｧ-ｮｯｰﾟﾞ･]+$/ }
     end
-    context "名字(カタカナ)が返る" do
-      subject { ForgeryJa(:name).last_name(ForgeryJa::KANA) }
-      it { should.is_a?(String) }
+  end
+  describe ".male_first_name" do
+    context "名前(ひらがな)が返る" do
+      subject { ForgeryJa(:name).male_first_name(:to => ForgeryJa::HIRA) }
+      it { should match /^[あ-んが-ぼぁ-ょゎっー]+$/ }
     end
-    context "名字(半角カタカナ)が返る" do
-      subject { ForgeryJa(:name).last_name(ForgeryJa::H_KANA) }
-      it { should.is_a?(String) }
+  end
+  describe ".female_first_name" do
+    context "名前(カタカナ)が返る" do
+      subject { ForgeryJa(:name).female_first_name(:to => ForgeryJa::KANA) }
+      it { should match /^[ア-ンガ-ボァ-ョヮッー]+$/ }
     end
-    context "名字(ローマ字)が返る" do
-      subject { ForgeryJa(:name).last_name(ForgeryJa::ROMA) }
+  end
+  describe ".full_name" do
+    context "フルネーム(漢字)が返る" do
+      subject { ForgeryJa(:name).full_name(:to => ForgeryJa::KANJI) }
+      it { should match /^[^A-Za-zｱ-ﾝｧ-ｮｯｰﾟﾞ･]+ [^A-Za-zｱ-ﾝｧ-ｮｯｰﾟﾞ･]+$/ }
+    end
+    context "フルネーム(ひらがな)が返る" do
+      subject { ForgeryJa(:name).full_name(:to => ForgeryJa::HIRA) }
+      it { should match /^[あ-んが-ぼぁ-ょゎっー]+ [あ-んが-ぼぁ-ょゎっー]+$/ }
+    end
+    context "フルネーム(カタカナ)が返る" do
+      subject { ForgeryJa(:name).full_name(:to => ForgeryJa::KANA) }
+      it { should match /^[ア-ンガ-ボァ-ョヮッー]+ [ア-ンガ-ボァ-ョヮッー]+$/ }
+    end
+    context "フルネーム(半角カタカナ)が返る" do
+      subject { ForgeryJa(:name).full_name(:to => ForgeryJa::H_KANA) }
+      it { should match /^[ｱ-ﾝｧ-ｮｯｰﾟﾞ･]+ [ｱ-ﾝｧ-ｮｯｰﾟﾞ･]+$/ }
+    end
+    context "フルネーム(ローマ字)が返る" do
+      subject { ForgeryJa(:name).full_name(:to => ForgeryJa::ROMA) }
+      it { should match /^[a-zA-Z-]+ [a-zA-Z-]+$/ }
+    end
+  end
+  describe ".company_name" do
+    context "企業名が返る" do
+      subject { ForgeryJa(:name).company_name(:to => ForgeryJa::KANJI) }
       it { should.is_a?(String) }
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: forgery_ja
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - namakesugi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-05 00:00:00 +09:00
+date: 2011-06-06 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,8 +46,12 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .yardoc/checksums
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
 - Gemfile
 - Guardfile
+- MIT-LICENSE
 - README.markdown
 - Rakefile
 - forgery_ja.gemspec
@@ -67,7 +71,6 @@ files:
 - lib/forgery_ja/forgery_ja/monetary.rb
 - lib/forgery_ja/forgery_ja/name.rb
 - lib/forgery_ja/forgery_ja_api.rb
-- lib/forgery_ja/forgery_ja_railtie.rb
 - lib/forgery_ja/version.rb
 - spec/forgery_ja/address_spec.rb
 - spec/forgery_ja/date_spec.rb