numerals_jp 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a061f27293e75c37ceba3128635cbebb21e7e61
-  data.tar.gz: f89d80120b7881490efe80e7a6521060cf94bf19
+  metadata.gz: 31aada2f9ae453c74209c7b55306c8cbec12ed0f
+  data.tar.gz: 8eec5574768243b4ace3592889d2e1ce801a5f45
 SHA512:
-  metadata.gz: 0c5a941fac1bc9b221d374af810b26302b0a3c34d5b14c8ccd572aac149b193510f89446626f2fe8a49b8bf7c80d5c86552cc22833c7c47080133511c973ad9a
-  data.tar.gz: fb54a206c2df82a5aabde5f657bdf32d7b7496e63d016bd62ace913ccfa8c5a526e48c40466fd19bc573b5b4c6a71be01d9faea92ec59910e4e2c2d151c21c49
+  metadata.gz: 982dee7f936c5e4d3eff1594a41f71b466cc9d44fa5eae9d78641f289b2da71ac3ae287f357594d2d0d7890379454120a0a53956308083da8afd5522d3b0b993
+  data.tar.gz: 0a41da6507aaa85a5226a200e91e00abe06f8732c5dd5e1ddbe5406c38dab7289eaf31b2dea37c11a826dc38c53f52febb1c82c3183cec8dbc8da8a265c61788

data/README.md

@@ -3,9 +3,9 @@
 [![Gem Version](https://badge.fury.io/rb/numerals_jp.svg)](https://badge.fury.io/rb/numerals_jp)
 [![Build Status](https://travis-ci.org/paralleltree/numerals_jp.svg?branch=master)](https://travis-ci.org/paralleltree/numerals_jp)
 
-A numerals library for japanese.
+A numerals library for Japanese
 
-This library converts between arabic numerals and japanese numerals  
+This library converts between Arabic numerals and Japanese numerals  
 which are often used(i.e., from 1 to 9,999,999,999,999,999).
 
 ## Installation
@@ -30,13 +30,13 @@ Or install it yourself as:
 require 'numerals_jp'
 ```
 
-### Convert from japanese numerals
+### Convert from Japanese numerals
 ```ruby
 "三十六".jp_to_num
 # => "36"
 ```
 
-This method just replaces japanese numerals with arabic numerals.
+This method just replaces Japanese numerals with Arabic numerals.
 
 ```ruby
 "十二月三十一日".jp_to_num
@@ -56,17 +56,18 @@ This method just replaces japanese numerals with arabic numerals.
 
 Done:
 
-  * Support converting from integer to japanese numerals.
+  * Support converting from integer to Japanese numerals.
 
 Pending:
 
-  * Support converting from japanese numerals without factor units.
-  * Support converting from arabic numerals with japanese factor units.
+  * Support converting from Japanese numerals without factor units.
+  * Support converting from Arabic numerals with Japanese factor units.
 
 ## Other Integrations
 
 [![Code Climate](https://codeclimate.com/github/paralleltree/numerals_jp/badges/gpa.svg)](https://codeclimate.com/github/paralleltree/numerals_jp)
 [![Coverage Status](https://coveralls.io/repos/paralleltree/numerals_jp/badge.svg?branch=master&service=github)](https://coveralls.io/github/paralleltree/numerals_jp?branch=master)
+[![Inline docs](http://inch-ci.org/github/paralleltree/numerals_jp.svg?branch=master)](http://inch-ci.org/github/paralleltree/numerals_jp)
 
 ## Contributing
 

data/lib/numerals_jp.rb

@@ -5,5 +5,6 @@ require "numerals_jp/integer_converter"
 require "numerals_jp/extension/string"
 require "numerals_jp/extension/integer"
 
+# Represents a root of the Gem.
 module NumeralsJp
 end

data/lib/numerals_jp/constant.rb

@@ -1,3 +1,4 @@
+# Represents common constant variables.
 module NumeralsJp::Constant
   NUMERALS = "一二三四五六七八九"
   SMALL_FACTORS = {

data/lib/numerals_jp/extension/integer.rb

@@ -1,4 +1,12 @@
+# Extensions of Integer class
 class Integer
+  # Converts positive integer which is less than 10^16 to Japanese numerals.
+  #
+  # @example
+  #   106.to_jp # => "百六"
+  #
+  # @return [String] the converted string
+  # @raise [ArgumentError] if the integer is not positive or less than 10^16
   def to_jp
     NumeralsJp::IntegerConverter.to_jp(self)
   end

data/lib/numerals_jp/extension/string.rb

@@ -1,4 +1,11 @@
+# Extensions of String class
 class String
+  # Replaces Japanese numerals with Arabic numerals in the string.
+  #
+  # @example
+  #   "三十六".jp_to_num # => "36"
+  #
+  # @return [String] the converted string
   def jp_to_num
     NumeralsJp::StringConverter.jp_to_num(self)
   end

data/lib/numerals_jp/integer_converter.rb

@@ -1,9 +1,19 @@
+# Represents conversions from Integer.
 module NumeralsJp::IntegerConverter
   include NumeralsJp::Constant
 
   module_function
+
+  # Converts positive integer which is less than 10^16 to Japanese numerals.
+  #
+  # @example
+  #   to_jp(106) # => "百六"
+  #
+  # @param i [Integer] the integer to convert
+  # @return [String] the converted string
+  # @raise [ArgumentError] if the integer is not positive or less than 10^16
   def to_jp(i)
-    raise ArgumentError.new("Argument out of range.") unless i > 0 && i < 10 ** 16
+    raise ArgumentError.new("the integer out of range") unless i > 0 && i < 10 ** 16
 
     if i < 10000
       split_digits(i, 1)
@@ -23,6 +33,16 @@ module NumeralsJp::IntegerConverter
     end
   end
 
+  # Splits the given integer into specified digits from lower digits.
+  #
+  # @example split each digit
+  #   split_digits(1234, 1) # => [4, 3, 2, 1]
+  # @example split 4 digits each
+  #   split_digits(1234567, 4) # => [4567, 123]
+  #
+  # @param i [Integer] the integer to split
+  # @param limit [Integer] the number of digits to split each
+  # @return [Array<Integer>] an Array of split integers
   def split_digits(i, limit)
     [].tap do |arr|
       while i > 0

data/lib/numerals_jp/string_converter.rb

@@ -1,3 +1,4 @@
+# Represents conversions from String.
 module NumeralsJp::StringConverter
   include NumeralsJp::Constant
 
@@ -6,6 +7,14 @@ module NumeralsJp::StringConverter
   SMALL_EXTRACT_PATTERN = /(([#{NUMERALS}])?([#{SMALL_FACTORS.keys.join}])?)/
 
   module_function
+
+  # Replaces Japanese numerals with Arabic numerals in given string.
+  #
+  # @example
+  #   jp_to_num("三十六") # => "36"
+  #
+  # @param str [String] the string to convert
+  # @return [String] the converted string
   def jp_to_num(str)
     str.gsub(DETECT_PATTERN) do |s|
       s.scan(LARGE_EXTRACT_PATTERN).map { |m|

data/lib/numerals_jp/version.rb

@@ -1,3 +1,3 @@
 module NumeralsJp
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/numerals_jp.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["paralleltree"]
   spec.email         = ["paralleltree@outlook.com"]
 
-  spec.summary       = %q{A numerals library for japanese.}
-  spec.description   = %q{Number conversion between arabic numerals and japanese numerals.}
+  spec.summary       = %q{A numerals library for Japanese}
+  spec.description   = %q{Number conversion between Arabic numerals and Japanese numerals}
   spec.homepage      = "https://github.com/paralleltree/numerals_jp"
   spec.license       = "MIT"
   spec.required_ruby_version = '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numerals_jp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - paralleltree
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Number conversion between arabic numerals and japanese numerals.
+description: Number conversion between Arabic numerals and Japanese numerals
 email:
 - paralleltree@outlook.com
 executables: []
@@ -111,5 +111,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: A numerals library for japanese.
+summary: A numerals library for Japanese
 test_files: []
+has_rdoc: