faker_japanese 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 615d434fc9df6d5efc6854d6fed05da60c4730a1
-  data.tar.gz: 6f7dfc69bac1e5f59b7422a2703ec2df1cd082ba
+  metadata.gz: 8450642b98b063f988190c9243f2e0f528cdc299
+  data.tar.gz: da99c48b06cbc3cdb44f2362b0cad757550aae24
 SHA512:
-  metadata.gz: e5bcac73f68372afaa3e195678c3803efb5266e52f413bfab6151401f21ce2c3a30d4817610041d99e5fc7cb1c15d2142ffbf2e4ec922082577826341025c454
-  data.tar.gz: 83866a82166aee3dd95a42db6b26b9b30623f75eb372a3a22b8edea2b17aa1ffa2b639da512bdb618d0330d8130c5c51f1974e657b31a2692bef56fb6099a70c
+  metadata.gz: 77ff0c53aa7530567eb7641d62b6e3c1d2eb8aca39045a7aaf52c1ab649fd84f5a1deaf2fe65d0eaf1e1ce498593d0f67f3f7a9dfbedc094fdddfdb0350f0b1d
+  data.tar.gz: ef3ba64114b11511a469790e3c033214471f5a9bdd9d66bb073d6d36ab1b542f303b622292b796ea752b2bb0d8d9a4a820d91a59698c7f94c10c2d7c737a1c31

data/.gitignore

@@ -4,7 +4,8 @@
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*
@@ -39,3 +40,12 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+# Intellij IDEA
+.idea
+.idea_modules
+*.iml
+*.ipr
+*.iws
+*.sc
+.history

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - spec/**/*
+    - exe/*
+
+#inherit_from: .rubocop_todo.yml
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.1
+  - 2.2.1
+  - ruby-head
+
+cache: bundler
+
+before_install:
+  - gem install bundler -v '1.8.6'
+
+script: bundle exec rake test
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/README.md

@@ -1,5 +1,8 @@
 # faker_japanese
 
+[![Build Status](https://travis-ci.org/denvazh/faker_japanese.svg?branch=master)](https://travis-ci.org/denvazh/faker_japanese)
+[![Coverage Status](https://coveralls.io/repos/denvazh/faker_japanese/badge.svg?branch=master&service=github)](https://coveralls.io/github/denvazh/faker_japanese?branch=master)
+
 Faker extension to generate Japanese names.
 Provides fake first and last names in kanji, hiragana, katakana and romaji (name written with latin alphabet).
 It has now around 1500 last names and around 260 first names for both genders.

data/Rakefile

@@ -1,15 +1,31 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new
-task :default => :spec
-task :test => :spec
+task test: :spec
+
+# Testing with rspec
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w(--color --format documentation)
+end
+task test: :spec
+
+# Use RuboCop to check for code/style offenses
+desc 'Run RuboCop to validate/lint code'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
 
 # Documentation
+desc "Generate gem documentation (same as running 'rake yard')"
 YARD::Rake::YardocTask.new do |t|
-	t.files   = ['lib/**/*.rb']   # optional
+  t.files = %w(lib/**/*.rb)
+  t.stats_options = %w(--list-undoc --compact)
 end
+task doc: :yard
 
-# desc "Generate gem documentation (same as running 'rake yard')"
-task :doc => :yard
+# Default Rake task
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'faker_japanese'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# Use Pry by default
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faker_japanese.gemspec

@@ -4,24 +4,34 @@ $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.name = 'faker_japanese'
+  spec.version = Faker::Japanese::VERSION
+  spec.authors = ['Denis Vazhenin']
+  spec.email = ['denis.vazhenin@me.com']
+  spec.description = 'Faker extension providing japanese names'
+  spec.summary = '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.bindir = 'exe'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables = spec.files.grep(%r{^exe/}) { |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"
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'rspec-expectations', '~> 3.2.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.2.1'
+  spec.add_development_dependency 'awesome_print', '~> 1.6.1'
+  spec.add_development_dependency 'looksee', '~> 3.1.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'yard', '~> 0.8.7.6'
+  spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_runtime_dependency 'faker'
 end

data/lib/faker/japanese.rb

@@ -0,0 +1 @@
+require_relative '../faker_japanese'

data/lib/faker_japanese.rb

@@ -1,68 +1,101 @@
 require 'faker'
+require 'yaml'
 
+# Faker
 module Faker
-	module Japanese
-		SELFDIR = File.expand_path(File.dirname(__FILE__))
+  # Japanese localization for Faker
+  module Japanese
+    # Location on the disk of this script
+    SELFDIR = File.expand_path(File.dirname(__FILE__))
 
-		class Kanji < String
-			attr_reader :yomi, :kana, :romaji
+    # Kanji string
+    class Kanji < String
+      attr_reader :yomi, :kana, :romaji
 
-			def initialize(kanji, yomi, kana, romaji)
-				super(kanji)
-				@yomi = yomi
-				@kana = kana
-				@romaji = romaji
-			end
-		end
+      # Create new Kanji string instance
+      # @param [String] kanji string in kanji from
+      # @param [String] yomi string with hiragana readings
+      # @param [String] kana string with katakana readings
+      # @param [String] romaji romanized string
+      def initialize(kanji, yomi, kana, romaji)
+        super(kanji)
+        @yomi = yomi
+        @kana = kana
+        @romaji = romaji
+      end
+    end
 
-		class Base
-			class << self
+    # Faker Base class
+    class Base
+      class << self
+        # Using callback to store loaded data when subclass is created
+        # @param [Class] klass class name
+        def inherited(klass)
+          fail("#{klass} should be Class") unless klass.is_a? Class
+          klass.class_variable_set '@@data', load_data(klass)
+        end
 
-				# Using callback to store loaded data when subclass is created
-				def inherited(klass)
-					klass.class_variable_set "@@data", load_data(klass)
-				end
+        # Convert full class name to lower case string with class name only
+        # @param [Class] klass class name
+        # @return [String]
+        def demodulize(klass)
+          klass.to_s.split('::').last.downcase
+        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
+        # Load yml file with minor pre-processing
+        # @param [String] filepath full path to the file
+        # @return [Hash]
+        def load_raw_yaml(filepath)
+          return nil unless filepath && File.readable?(filepath)
+          YAML.load_file(filepath).each_with_object({}) do |(k, v), h|
+            h[k.to_sym] = v
+          end
+        end
 
-				# Search
-				def fetch(key)
-					val = self.class_variable_get("@@data")[key]
-					ret = val[rand(val.size)]
-				end
+        # Created dictionary with loaded data
+        # @param [Module] klass class name
+        def load_data(klass)
+          datafile = File.join(SELFDIR,
+                               'faker_japanese',
+                               'data', "#{demodulize(klass)}.yml")
+          data = load_raw_yaml(datafile)
+          return data if data.nil?
+          data.inject({}) do |res, item|
+            key, values = item
+            res.update(key => values.map! { |v| Kanji.new(*v) })
+          end
+          data
+        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
+        # Fetch random value from name dictionary
+        # @param [String] key in the @@data
+        # @return [Kanji]
+        def fetch(key)
+          val = class_variable_get('@@data')[key]
+          val[rand(val.size)]
+        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
+        # Swap method if block was evaluated to true
+        # @param [Class] klass name of the class
+        # @param [Symbol] name method name
+        def swap_method(klass, name)
+          original_method = klass.method(name)
+          new_method = method(name)
+          proc = proc { yield ? new_method.call : original_method.call }
+          klass.singleton_class.send(:define_method, name, proc)
+        end
 
-			end # << self
-		end # Base
-	end # Japanese
+        # Decide which method to use based on value of Faker::Config.locale
+        # @param [Class] klass name of the class
+        # @param [Symbol] name method name
+        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'

data/lib/faker_japanese/name.rb

@@ -1,26 +1,30 @@
 module Faker
+  # Japanese localization for Faker
   module Japanese
+    # Name localization
     class Name < Base
       class << self
-
-        # Return fake first name
+        # Fake first name
+        # @return [Kanji]
         def first_name
           fetch(:first_name)
         end
 
-        # Return fake last name
+        # Fake last name
+        # @return [Kanji]
         def last_name
           fetch(:last_name)
         end
 
-        # Return fake name, which is a string combining last and first name
+        # Fake full name
+        # @return [Kanji] 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}"
+          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

data/lib/faker_japanese/version.rb

@@ -1,5 +1,7 @@
 module Faker
-	module Japanese
-		VERSION = "0.2.0"
-	end
+  # Japanese localization for Faker
+  module Japanese
+    # Current version
+    VERSION = '0.2.1'
+  end
 end

metadata

@@ -1,59 +1,143 @@
 --- !ruby/object:Gem::Specification
 name: faker_japanese
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Denis Vazhenin
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: looksee
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-expectations
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,13 +179,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -116,18 +200,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - faker_japanese.gemspec
+- lib/faker/japanese.rb
 - 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
@@ -152,7 +238,5 @@ 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
+test_files: []
 has_rdoc: 

data/.rspec

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

data/spec/lib/faker_japanese_spec.rb

@@ -1,48 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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