integer_to_japanese 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41cf213b3059ec5834a07b61517f4cca8b71e53a92e2d259b68461326c802778
+  data.tar.gz: 06537b277b42d5e40c0afe3ca88856eaf7cbebd9c8cf55676ded71fb5391a2b6
+SHA512:
+  metadata.gz: 891c06e3ae09f679c12173680a0443c4c765a9be94b5ef1b376090494ffa91cf9bf2de0eeafda51159c131338b79bab90149b9a5bb78b252bc40d3c94b89c55f
+  data.tar.gz: dd96f1e07ca0fec316444fb67ced743dffbdf2e1cd341df25d632d5fd60bbc7ef2bcc2a4cc00e15abd38ff7db2ebb4b2230c9ca0b61a1def8abdfce9611f00cc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 160
+  Exclude:
+    - "spec/**/*"
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in integer_to_japanese.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 かめ
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+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/README.md

@@ -0,0 +1,57 @@
+# IntegerToJapanese
+
+数値を日本語読みにする処理を追加します。
+
+## 追加方法
+
+gemに追加します。
+
+```bash
+$ gem install integer_to_japanese
+```
+
+またはGemfileに追加します。
+
+```ruby
+gem 'integer_to_japanese'
+```
+
+## 使い方
+
+```ruby
+require 'integer_to_japanese'
+
+800.to_hiragana
+#=> "はっぴゃく"
+
+3000.to_katakana
+#=> "サンゼン"
+
+20000.to_kanji
+#=> "二万"
+```
+
+負数の場合はマイナスが付きます。
+
+```ruby
+-100.to_hiragana
+#=> "まいなすひゃく"
+
+# 漢字の場合はカタカナ表記で付きます
+-50.to_kanji
+#=> "マイナス五十"
+```
+
+無量大数を超える位の数字はnilになります。
+
+```ruby
+(10 ** 71).to_kanji
+#=> "千無量大数"
+
+(10 ** 72).to_kanji
+#=> nil
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/integer_to_japanese.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/integer_to_japanese/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "integer_to_japanese"
+  spec.version = IntegerToJapanese::VERSION
+  spec.authors = ["kametter"]
+  spec.email = ["kunikazu.kamei@arabato.jp"]
+
+  spec.summary = "Integerを日本語読みに変換するgem"
+  spec.description = "Integerの値を漢字、ひらがな、カタカナに変換します"
+  spec.homepage = "https://github.com/kametter/integer_to_japanese"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kametter/integer_to_japanese"
+  spec.metadata["changelog_uri"] = "https://github.com/kametter/integer_to_japanese/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/integer_to_japanese/constants.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module IntegerToJapanese
+  module Constants
+    HIRAGANA_MINUS = "まいなす"
+    HIRAGANA_ZERO = "ぜろ"
+    HIRAGANA_WORDS = ["", "いち", "に", "さん", "よん", "ご", "ろく", "なな", "はち", "きゅう"].freeze
+    HIRAGANA_SUB_NUMERAL = ["", "じゅう", "ひゃく", "せん"].freeze
+    HIRAGANA_NUMERAL = ["", "まん", "おく", "ちょう", "けい", "がい", "じょ", "じょう", "こう", "かん", "せい", "さい", "ごく", "ごうがしゃ", "あそうぎ", "なゆた", "ふかしぎ", "むりょうたいすう"].freeze
+    SPECIAL_HIRAGANA_SUB_NUMERALS = {
+      [0, 0].freeze => "", [0, 1].freeze => "", [0, 2].freeze => "", [0, 3].freeze => "",
+      [1, 1].freeze => "じゅう", [1, 2].freeze => "ひゃく", [1, 3].freeze => "せん",
+      [3, 2].freeze => "さんびゃく", [3, 3].freeze => "さんぜん",
+      [6, 2].freeze => "ろっぴゃく",
+      [8, 2].freeze => "はっぴゃく", [8, 3].freeze => "はっせん"
+    }.freeze
+    SPECIAL_NUMERALS = {
+      [1, 3].freeze => "いっちょう", [8, 3].freeze => "はっちょう",
+      [1, 4].freeze => "いっけい", [6, 4].freeze => "ろっけい", [8, 4].freeze => "はっけい",
+      [1, 8].freeze => "いっこう", [6, 8].freeze => "ろっこう", [8, 8].freeze => "はっこう",
+      [1, 9].freeze => "いっかん", [6, 9].freeze => "ろっかん", [8, 9].freeze => "はっかん",
+      [1, 10].freeze => "いっせい", [8, 10].freeze => "はっせい",
+      [1, 11].freeze => "いっさい", [8, 11].freeze => "はっさい"
+    }.freeze
+    SPECIAL_TEN_NUMERALS = {
+      "じゅうちょう" => "じっちょう", "じゅうけい" => "じっけい",
+      "じゅうこう" => "じっこう", "じゅうかん" => "じっかん",
+      "じゅうせい" => "じっせい", "じゅうさい" => "じっさい"
+    }.freeze
+
+    KANJI_MINUS = "マイナス"
+    KANJI_ZERO = "零"
+    KANJI_WORDS = ["", "一", "二", "三", "四", "五", "六", "七", "八", "九"].freeze
+    KANJI_SUB_NUMERAL = ["", "十", "百", "千"].freeze
+    KANJI_NUMERAL = ["", "万", "億", "兆", "京", "垓", "秭", "穰", "溝", "澗", "正", "載", "極", "恒河沙", "阿僧祇", "那由他", "不可思議", "無量大数"].freeze
+    SPECIAL_KANJI_SUB_NUMERALS = {
+      [0, 0].freeze => "", [0, 1].freeze => "", [0, 2].freeze => "", [0, 3].freeze => "",
+      [1, 1].freeze => "十", [1, 2].freeze => "百", [1, 3].freeze => "千"
+    }.freeze
+
+    READABLE_LIMIT_NUMBER =
+      1_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000_000
+  end
+end

data/lib/integer_to_japanese/version.rb

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

data/lib/integer_to_japanese.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative "integer_to_japanese/version"
+require_relative "integer_to_japanese/constants"
+
+# Integer用の日本語変換モジュール
+module IntegerToJapanese
+  include Constants
+
+  # 数値のひらがなよみを返します
+  #
+  # @example
+  #   10.to_hiragana        #=> "じゅう"
+  #   1110.to_hiragana      #=> "せんひゃくじゅう"
+  #   8_000_000.to_hiragana #=> "はっぴゃくまん"
+  # @return [String] ひらがなに変換した文字列
+  # @return [nil] 無量大数の次の位の値の場合
+  def to_hiragana
+    return HIRAGANA_ZERO if zero?
+    return nil if self >= READABLE_LIMIT_NUMBER
+
+    has_numeral = true
+    result = digits_map do |digit, index|
+      converted_digit, has_numeral = convert_digit_to_hiragana(digit, index, has_numeral)
+      converted_digit
+    end
+    "#{negative? ? HIRAGANA_MINUS : nil}#{convert_ten_numerals(result)}"
+  end
+
+  # 数値のカタカナよみを返します
+  #
+  # @example
+  #   10.to_katakana        #=> "ジュウ"
+  #   1110.to_katakana      #=> "センヒャクジュウ"
+  #   8_000_000.to_katakana #=> "ハッピャクマン"
+  # @return [String] カタカナに変換した文字列
+  # @return [nil] 無量大数の次の位の値の場合
+  def to_katakana
+    to_hiragana&.tr("ぁ-ん", "ァ-ン")
+  end
+
+  # 数値漢字よみを返します<br>
+  # ただし負数のマイナスはカタカナを返します
+  #
+  # @example
+  #   10.to_kanji        #=> "十"
+  #   1110.to_kanji      #=> "千百十"
+  #   8_000_000.to_kanji #=> "八百万"
+  #   -100.to_kanji      #=> "マイナス百"
+  # @return [String] 漢字に変換した文字列
+  # @return [nil] 無量大数の次の位の値の場合
+  def to_kanji
+    return KANJI_ZERO if zero?
+    return nil if self >= READABLE_LIMIT_NUMBER
+
+    has_numeral = true
+    result = digits_map do |digit, index|
+      converted_digit, has_numeral = convert_digit_to_kanji(digit, index, has_numeral)
+      converted_digit
+    end
+    "#{negative? ? KANJI_MINUS : nil}#{result}"
+  end
+
+  protected
+
+  # 各桁の変換処理<br>
+  # 各桁をblockの内容で変換し、結果を文字列連結して返す処理
+  def digits_map
+    size_count = abs.digits.size
+    abs.digits.reverse.map.with_index do |digit, reverse_index|
+      index = size_count - 1 - reverse_index
+      yield(digit, index)
+    end.join
+  end
+
+  # 数値をひらがなに変換
+  def convert_digit_to_hiragana(digit, index, has_numeral)
+    result = ""
+    sub_numeral = index % 4
+    digit_word = HIRAGANA_WORDS[digit]
+    has_numeral |= !digit_word.empty?
+    if sub_numeral.zero?
+      # 万、億等の単位表示桁の場合
+      return [result, has_numeral] unless has_numeral
+
+      has_numeral = false
+      numeral = index / 4
+      result = SPECIAL_NUMERALS[[digit, numeral]] || "#{digit_word}#{HIRAGANA_NUMERAL[numeral]}"
+    else
+      # 千、百等のサブ単位表示桁の場合
+      result = SPECIAL_HIRAGANA_SUB_NUMERALS[[digit, sub_numeral]] || "#{digit_word}#{HIRAGANA_SUB_NUMERAL[sub_numeral]}"
+    end
+    [result, has_numeral]
+  end
+
+  # 数値を漢字に変換
+  def convert_digit_to_kanji(digit, index, has_numeral)
+    result = ""
+    sub_numeral = index % 4
+    digit_word = KANJI_WORDS[digit]
+    has_numeral |= !digit_word.empty?
+    if sub_numeral.zero?
+      # 万、億等の単位表示桁の場合
+      return [result, has_numeral] unless has_numeral
+
+      has_numeral = false
+      numeral = index / 4
+      result = "#{digit_word}#{KANJI_NUMERAL[numeral]}"
+    else
+      # 千、百等のサブ単位表示桁の場合
+      result = SPECIAL_KANJI_SUB_NUMERALS[[digit, sub_numeral]] || "#{digit_word}#{KANJI_SUB_NUMERAL[sub_numeral]}"
+    end
+    [result, has_numeral]
+  end
+
+  # 特殊処理として10 + 特定の単位のときに「じゅう」を「じっ」に置換
+  # @example
+  #   convert_ten_numerals("じゅうちょう") #=> "じっちょう"
+  def convert_ten_numerals(string)
+    SPECIAL_TEN_NUMERALS.each do |before, after|
+      string.gsub!(before, after)
+    end
+    string
+  end
+end
+
+class Integer
+  include IntegerToJapanese
+end

data/sig/integer_to_japanese/constants.rbs

@@ -0,0 +1,20 @@
+module IntegerToJapanese
+  module Constants
+    HIRAGANA_MINUS: String
+    HIRAGANA_ZERO: String
+    HIRAGANA_WORDS: Array[String]
+    HIRAGANA_SUB_NUMERAL: Array[String]
+    HIRAGANA_NUMERAL: Array[String]
+    SPECIAL_HIRAGANA_SUB_NUMERALS: Hash[Array[Integer], String]
+    SPECIAL_NUMERALS: Hash[Array[Integer], String]
+    SPECIAL_TEN_NUMERALS: Hash[String, String]
+
+    KANJI_MINUS: String
+    KANJI_ZERO: String
+    KANJI_WORDS: Array[String]
+    KANJI_SUB_NUMERAL: Array[String]
+    KANJI_NUMERAL: Array[String]
+    SPECIAL_KANJI_SUB_NUMERALS: Hash[Array[Integer], String]
+    READABLE_LIMIT_NUMBER: Integer
+  end
+end

data/sig/integer_to_japanese.rbs

@@ -0,0 +1,11 @@
+module IntegerToJapanese
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  def to_hiragana: -> String?
+  def to_katakana: -> String?
+  def to_kanji: -> String?
+  def digits_map: -> String
+  def convert_digit_to_hiragana: -> Array[String|bool]
+  def convert_digit_to_kanji: -> Array[String|bool]
+  def convert_ten_numerals: -> String
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: integer_to_japanese
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kametter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-28 00:00:00.000000000 Z
+dependencies: []
+description: Integerの値を漢字、ひらがな、カタカナに変換します
+email:
+- kunikazu.kamei@arabato.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- integer_to_japanese.gemspec
+- lib/integer_to_japanese.rb
+- lib/integer_to_japanese/constants.rb
+- lib/integer_to_japanese/version.rb
+- sig/integer_to_japanese.rbs
+- sig/integer_to_japanese/constants.rbs
+homepage: https://github.com/kametter/integer_to_japanese
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kametter/integer_to_japanese
+  source_code_uri: https://github.com/kametter/integer_to_japanese
+  changelog_uri: https://github.com/kametter/integer_to_japanese/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: Integerを日本語読みに変換するgem
+test_files: []