chinese_numbers_characters_converter 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3110644b1a58124ca1bdafb1abf3b4605f3b24fe
-  data.tar.gz: 36f270e1cec9217fd8c49ccaabd7b6dd09907807
+SHA256:
+  metadata.gz: 6dcea4637ba07d9b2924bbb04b4391e5b9891befe4a95801cf7b74e31f807b8c
+  data.tar.gz: 9ade796d8df232030ff33ed1fb39c337c4b189261df10a54a4ff06e59b76e121
 SHA512:
-  metadata.gz: 5d70a0fc599bbdfd9275a529e0c5fcbf05dc1e6841006b618b75674c253e1b8f2a7b3d18a1a46fec7a84df02673fcd6856f7e32118d86a85d72a0d52fc1c3d1f
-  data.tar.gz: 8058f2521195f6b882dc64e6a1045faa10e63d3003242417e2222d08ad0db15f0e7446a4b535341ee867724ec05253944930b585ffa3641c3c0b04eb1b93e880
+  metadata.gz: 76776616ef8e76b25823863312fc2ef49ef4a2b176c2d65a64cbedff1c56e0995ef5aca788081ec145c600b707655a61ca850e44f78d79dc028c221388440f9c
+  data.tar.gz: 3cce8c0ec575afcc263ee3855d642dc10a076a4df8dcc16e02b604337c2ad0ac96ce02dd91355140650ea5cbd3b50582433d47ee3ff4bfcf812ef65ab7763f43

data/README.md

@@ -1,15 +1,14 @@
-# ChineseNumbersCharactersConverter
+# ChineseNumber
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chinese_numbers_characters_converter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Convert integers to Traditional Chinese financial numerals, such as the
+uppercase characters commonly used on Taiwan banking and accounting documents.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'chinese_numbers_characters_converter'
+gem 'chinese_number'
 ```
 
 And then execute:
@@ -18,13 +17,60 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install chinese_numbers_characters_converter
+    $ gem install chinese_number
 
 ## Usage
 
-ChineseNumbersCharactersConverter::Converter.run(2131231)
+```ruby
+require 'chinese_number'
+
+ChineseNumber.convert(2_131_231)
+# => "貳佰壹拾參萬壹仟貳佰參拾壹元整"
+
+ChineseNumber.convert('0010001')
+# => "壹萬零壹元整"
+```
+
+`nil` returns `nil`. Non-integer input raises `ArgumentError`.
+
+## Ruby on Rails
 
-It returns, example: 貳佰壹拾參萬壹仟貳佰參拾壹元整
+Add the gem to your Rails application's `Gemfile`:
+
+```ruby
+gem 'chinese_number'
+```
+
+Then install it:
+
+```bash
+bundle install
+```
+
+Rails loads gems from the bundle automatically, so you can call it from models,
+controllers, helpers, jobs, or views:
+
+```ruby
+ChineseNumber.convert(10_001)
+# => "壹萬零壹元整"
+```
+
+Example controller usage:
+
+```ruby
+class InvoicesController < ApplicationController
+  def show
+    @invoice = Invoice.find(params[:id])
+    @total_in_chinese = ChineseNumber.convert(@invoice.total_cents / 100)
+  end
+end
+```
+
+Example view usage:
+
+```erb
+<%= ChineseNumber.convert(@invoice.total_amount) %>
+```
 
 ## Development
 
@@ -34,10 +80,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chinese_numbers_characters_converter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jct808/chinese_number. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/chinese_number/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChineseNumber
+  VERSION = "1.3.0"
+end

data/lib/chinese_number.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "chinese_number/version"
+
+module ChineseNumber
+  def self.convert(input_num)
+    Converter.run(input_num)
+  end
+
+  class Converter
+    NUMBERS = %w[零 壹 貳 參 肆 伍 陸 柒 捌 玖].freeze
+    DIGIT_UNITS = ["", "拾", "佰", "仟"].freeze
+    SECTION_UNITS = ["", "萬", "億", "兆", "京"].freeze
+    INTEGER_PATTERN = /\A[+-]?\d+\z/.freeze
+
+    def self.run(input_num)
+      return unless input_num
+
+      normalized = normalize(input_num)
+      sign = normalized.delete_prefix!("-") ? "負" : ""
+      normalized.delete_prefix!("+")
+      normalized = normalized.sub(/\A0+/, "")
+
+      return "#{sign}零元整" if normalized.empty?
+
+      groups = normalized.reverse.scan(/\d{1,4}/).map { |group| group.reverse.to_i }
+      raise ArgumentError, "number is too large to convert" if groups.length > SECTION_UNITS.length
+
+      converted_groups = groups.each_with_index.map do |group, index|
+        next if group.zero?
+
+        group_to_chinese(group) + SECTION_UNITS[index]
+      end
+
+      result = []
+      pending_zero = false
+
+      converted_groups.reverse.each_with_index do |group, index|
+        original_group = groups.reverse[index]
+
+        if group
+          result << NUMBERS[0] if pending_zero || (index.positive? && original_group < 1000)
+          result << group
+          pending_zero = false
+        elsif result.any?
+          pending_zero = true
+        end
+      end
+
+      "#{sign}#{result.join}元整"
+    end
+
+    def self.normalize(input_num)
+      normalized = input_num.to_s.strip
+      raise ArgumentError, "input must be an integer" unless normalized.match?(INTEGER_PATTERN)
+
+      normalized
+    end
+    private_class_method :normalize
+
+    def self.group_to_chinese(group)
+      result = []
+      pending_zero = false
+
+      group.digits.each_with_index.reverse_each do |digit, index|
+        if digit.zero?
+          pending_zero = true if result.any?
+          next
+        end
+
+        result << NUMBERS[0] if pending_zero
+        result << NUMBERS[digit] + DIGIT_UNITS[index]
+        pending_zero = false
+      end
+
+      result.join
+    end
+    private_class_method :group_to_chinese
+  end
+end

metadata

@@ -1,85 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: chinese_numbers_characters_converter
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Chris Tai
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: In Taiwan, Bank or other finance facility are using Chinese numerals
-  character substitute for Arabic numerals, because of security and correctly reason.
+        version: '5.0'
+description: Converts integer amounts to Traditional Chinese financial numerals commonly
+  used on Taiwan banking and accounting documents.
 email:
 - jct808@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- chinese_numbers_characters_converter-0.1.0.gem
-- chinese_numbers_characters_converter-1.1.0.gem
-- chinese_numbers_characters_converter.gemspec
-- lib/chinese_numbers_characters_converter.rb
-- lib/chinese_numbers_characters_converter/version.rb
-homepage: https://rubygems.org
+- lib/chinese_number.rb
+- lib/chinese_number/version.rb
+homepage: https://github.com/jct808/chinese_number
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,16 +75,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 4.0.14
 specification_version: 4
-summary: To Convert a Integer to Chinese Number Characters.
+summary: Convert integers to Traditional Chinese financial numerals.
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default => :test

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "chinese_numbers_characters_converter"
-
-# 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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

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

data/chinese_numbers_characters_converter.gemspec

@@ -1,34 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'chinese_numbers_characters_converter/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "chinese_numbers_characters_converter"
-  spec.version       = ChineseNumbersCharactersConverter::VERSION
-  spec.authors       = ["Chris Tai"]
-  spec.email         = ["jct808@gmail.com"]
-
-  spec.summary       = %q{To Convert a Integer to Chinese Number Characters.}
-  spec.description   = %q{In Taiwan, Bank or other finance facility are using Chinese numerals character substitute for Arabic numerals, because of security and correctly reason.}
-  spec.homepage      = "https://rubygems.org"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'minitest', '~> 0'
-
-end

data/lib/chinese_numbers_characters_converter/version.rb

@@ -1,3 +0,0 @@
-module ChineseNumbersCharactersConverter
-  VERSION = "1.2.0"
-end

data/lib/chinese_numbers_characters_converter.rb

@@ -1,27 +0,0 @@
-require "chinese_numbers_characters_converter/version"
-
-module ChineseNumbersCharactersConverter
-  class Converter
-  	
-  	def self.run(str)
-  		number = ["零", "壹", "貳", "參", "肆", "伍", "陸", "柒", "捌", "玖"]
-			dig = ["", "拾", "佰", "仟", "萬", "拾", "佰", "仟", "億", "拾", "佰", "仟"]
-  		@string_a = Array.new
-  		@num_o = str
-  		num_s = str.to_s
-  		num_s = num_s.reverse!
-  		for i in 0..(num_s.to_s).length-1
-      	if ((num_s[i]).to_i != 0)
-        	@string_a.push(number[(num_s[i]).to_i] + dig[i])
-      	end
-    	end
-    	if @string_a.any?
-      	@string_a = @string_a.reverse!()
-      	@string_a.push("元整")
-    	end
-    	@num_o = num_s.reverse!
-    	return @string_a.join
-  	end
-  
-  end
-end