bangou 1.1 → 1.1.1

data/changelog.md

@@ -0,0 +1,19 @@
+# 1.1.1
+
+ - Added better class documentation
+
+# 1.1
+
+ - Added extension on Integer to simplify calling the interface:
+ 
+```
+89.to_j
+# => "八十九"
+
+289.to_jtext
+# => "二百八十九"
+```
+
+# 1.0
+
+Initial release

data/lib/bangou.rb

@@ -5,100 +5,123 @@ require 'extensions/integer.rb'
 class Bangou
   class OutOfRangeException < Exception; end
 
-	def self.integer_to_japanese_numerals int
+  # Convert an Integer into Japanese numerals
+  #
+  # Example:
+  #   Bangou.integer_to_japanese_numerals(89)
+  #   # => "八十九"
+  #
+  # @param [Integer] the number to convert
+  # @return [String] The Japanese numeric equivalent in kanji
+  def self.integer_to_japanese_numerals int
     convert_number(int, :numeral)
-	end
+  end
 
-	def self.integer_to_japanese_text int
+  # Convert an Integer into Sino-Japanese number
+  # spelling in hiragana or katakana
+  #
+  # Examples:
+  #   Bangou.integer_to_japanese_text(823)
+  #   # => "はっぴゃくにじゅうさん"
+  #   Bangou.integer_to_japanese_text(0)
+  #   # => "ゼロ"
+  #
+  # @param [Integer] the number to convert
+  # @return [String] The Sino-Japanese numeric equivalent in kana
+  def self.integer_to_japanese_text int
     convert_number(int, :text)
-	end
+  end
 
+  # Detect whether a given number can be processed
+  # by this class
+  #
+  # @return [Boolean]
   def self.in_range? int
     int >= 0 and int < 100000000
   end
 
   private
 
-  NUMERALS = {
-		0 => "",   1 => "一", 2 => "二",
-		3 => "三", 4 => "四", 5 => "五",
-		6 => "六", 7 => "七", 8 => "八",
-		9 => "九"
-	}
-
-	NUMERALS_TEXT = {
-		0 => "",    1 => "いち", 2 => "に",
-		3 => "さん", 4 => "よん", 5 => "ご",
-		6 => "ろく", 7 => "なな", 8 => "はち",
-		9 => "きゅう"
-	}
-
-	BASES = {
-		1    => "", 10 => "十", 100 => "百",
-		1000 => "千", 10000 => "万"
-	}
+  NUMERAL_INDEX = 0
+  TEXT_INDEX    = 1
+  RANGE_ERROR_MESSAGE = "Bangou can only process numbers between 0 and 99,999,999"
 
-	BASES_TEXT = {
-		1    => "", 10 => "じゅう", 100 => "ひゃく",
-		1000 => "せん", 10000 => "まん"
+  NUMERALS = {
+		0 => ["",""],      1 => ["一","いち"], 2 => ["二","に"],
+		3 => ["三","さん"], 4 => ["四","よん"], 5 => ["五","ご"],
+		6 => ["六","ろく"], 7 => ["七","なな"], 8 => ["八","はち"],
+		9 => ["九","きゅう"]
 	}
 
-	EXCEPTIONS_TEXT = {
-		300  => "さんびゃく", 600  => "ろっぴゃく",
-		800  => "はっぴゃく",
-		3000 => "さんぜん",   8000 => "はっせん"
-	}
+  BASES = {
+    1     => ["",""],
+    10    => ["十","じゅう"],
+    100   => ["百","ひゃく"],
+    1000  => ["千","せん"],
+    10000 => ["万","まん"]
+  }
 
-  EXCEPTIONS = {}
+  EXCEPTIONS = {
+    300  => [nil,"さんびゃく"],
+    600  => [nil,"ろっぴゃく"],
+    800  => [nil,"はっぴゃく"],
+    3000 => [nil,"さんぜん"],
+    8000 => [nil,"はっせん"]
+  }
 
   ZEROES = {
     :text    => "ゼロ",
     :numeral => "０"
   }
 
-  def self.exceptions num, format
-    format == :text ? EXCEPTIONS_TEXT[num] : EXCEPTIONS[num]
+  def self.index_for_format format
+    format == :text ? TEXT_INDEX : NUMERAL_INDEX
+  end
+
+  def self.exceptions num, base, format
+    hash_index = num * base
+    EXCEPTIONS[hash_index][index_for_format(format)] if EXCEPTIONS[hash_index]
   end
 
   def self.numerals num, format
-    format == :text ? NUMERALS_TEXT[num] : NUMERALS[num]
+    NUMERALS[num][index_for_format(format)]
   end
 
   def self.bases num, format
-    format == :text ? BASES_TEXT[num] : BASES[num]
+    BASES[num][index_for_format(format)]
   end
 
   def self.convert_number int, format
-    raise OutOfRangeException.new("Bangou can only process numbers between 0 and 99,999,999") unless in_range?(int)
+    raise OutOfRangeException.new(RANGE_ERROR_MESSAGE) unless in_range?(int)
     return ZEROES[format] if int == 0
+
     digits = int.to_s.split(//).reverse
-		digits.each_with_index.map do |digit, power|
-			hide_base_from_value = has_more_digits_before_index?(digits, power)
-			characters_for_digit_in_base(digit.to_i, 10 ** power, format, hide_base_from_value)
-		end.reverse.join
+
+    digits.each_with_index.map do |digit, power|
+      hide_base_from_value = has_more_digits_after_index?(digits, power)
+      characters_for_digit_in_base(digit.to_i, 10 ** power, format, hide_base_from_value)
+    end.reverse.join
   end
 
-  def self.strip_unneeded_characters text
-		text = text[1..-1] if text =~ /^(一).+/
-		text = text[2..-1] if text =~ /^(いち).+/
-		text
-	end
+  def self.strip_leading_ones text
+    text.sub(/^(一|いち)(.+)/,'\2')
+  end
 
-	def self.has_more_digits_before_index?(digits, index)
-		digits.size > 1 and (digits[0..index - 1] & ("1".."9").to_a).size > 0
-	end
+  def self.has_more_digits_after_index?(digits, index)
+    digits.size > 1 and (digits[0..index - 1] & ("1".."9").to_a).size > 0
+  end
 
   def self.characters_for_digit_in_base(num, base, format, hide_base_from_value)
-		if text = exceptions(num * base, format)
-			text
-		else
-			if num > 0 and base > 10000
-				text = exceptions(num * base/10000, format) || characters_for_digit_in_base(num, base/10000, format, hide_base_from_value)
-				text += bases(10000, format) unless hide_base_from_value
-			elsif num > 0
-				text = numerals(num, format) + bases(base, format)
-			end
-			strip_unneeded_characters(text)
-		end
-	end
+    return "" if num == 0
+
+    if text = exceptions(num, base, format)
+      text
+    elsif base <= 10000
+      text = numerals(num, format) + bases(base, format)
+    else
+      text  = characters_for_digit_in_base(num, base/10000, format, hide_base_from_value)
+      text += bases(10000, format) unless hide_base_from_value
+    end
+    strip_leading_ones(text)
+  end
 end

data/lib/extensions/integer.rb

@@ -1,10 +1,12 @@
 
 class Integer
 
+	# Convert integer to Japanese kanji equivalent
 	def to_j
 		Bangou.integer_to_japanese_numerals(self)
 	end
 
+	# Convert integer to Sino-Japanese kana equivalent
 	def to_jtext
 		Bangou.integer_to_japanese_text(self)
 	end

data/readme.md

@@ -2,7 +2,7 @@
 
 A Ruby library for converting between positive integers and Sino-Japanese numbers or text.
 
-[![Build Status](https://travis-ci.org/kattrali/bangou.png?branch=master)](Build Status)
+[![Build Status](https://travis-ci.org/kattrali/bangou.png?branch=master)](https://travis-ci.org/kattrali/bangou) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kattrali/bangou)
 
 ## Usage
 
@@ -37,4 +37,4 @@ Pull requests with tests accepted!
 
 ## Current Limitations
 
-Only works on numbers between 0 and 99,999,999 (otherwise throwing an OutOfRangeException).
+Only works on numbers between 0 and 99,999,999 (otherwise throwing an OutOfRangeException).

data/spec/integer_spec.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+$:.unshift(File.expand_path('../../lib',__FILE__))
+
+require 'bangou.rb'
+
+describe "Integer additions" do
+	it "adds Integer#to_j which is the kanji equivalent of a given integer" do
+		89.to_j.should.equal "八十九"
+		289.to_j.should.equal "二百八十九"
+	end
+
+	it "adds Integer#to_jtext which is the hiragana equivalent of a given integer" do
+		89.to_jtext.should.equal "はちじゅうきゅう"
+		289.to_jtext.should.equal "にひゃくはちじゅうきゅう"
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bangou
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon
@@ -34,14 +34,17 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - readme.md
+- changelog.md
 files:
 - Gemfile
-- Rakefile
 - LICENSE
+- Rakefile
+- changelog.md
 - readme.md
 - lib/bangou.rb
 - lib/extensions/integer.rb
 - spec/bangou_spec.rb
+- spec/integer_spec.rb
 homepage: http://kattrali.github.com/bangou
 licenses: []
 post_install_message: 
@@ -69,3 +72,4 @@ summary: A library for converting between positive integers and Sino-Japanese nu
   or text.
 test_files:
 - spec/bangou_spec.rb
+- spec/integer_spec.rb