kanji-translator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4f92f7987bc8ed9600c1b5849f56c0538f6af423afd53249ae70bc83e53a383
+  data.tar.gz: 226e287702852d0d05563b4a38aba069caef02e52c56c76d4011ef22e928c43c
+SHA512:
+  metadata.gz: 7e09f7183a129996b4fbfeff7e56b86f51e7b6b53ef7db428bb3c45b4e1bea4acb644251e996dbb68fe05c39785b202d76d7d3aca1d50b9c6299ce15ec1c74a7
+  data.tar.gz: a99f5a503d9b9a1a715d3d9405a86306c110ebc13b0c6bb5c17c494453460f04c05130176a4662138c8d2e24dfa119fd0080f61943c0364e5dd2cab963d24d54

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Hiromu Kodani
+
+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,103 @@
+# Kanji::Translator
+
+漢字を「ひらがな」「カタカナ」「ローマ字（ヘボン式・簡易）」に変換し、スラッグも作れるシンプルなRubyライブラリです。読みは外部サイト（yomikatawa.com）の結果を取得して解析します。
+
+> 注意: 本ライブラリはyomikatawa.comの非公式クライアントです。サイト構造の変更やレート制限の影響を受ける可能性があります。
+
+## インストール
+
+Ruby 3.2以上が必要です。
+
+Rubygems公開後:
+
+```bash
+bundle add kanji-translator
+```
+
+未公開期間にGitHubから使う場合:
+
+```ruby
+# Gemfile
+gem "kanji-translator", git: "https://github.com/dw-kodani/kanji-translator"
+```
+
+## クイックスタート
+
+```ruby
+require "kanji/translator"
+
+Kanji::Translator.to_hira("漢字") #=> "かんじ"
+Kanji::Translator.to_kata("漢字") #=> "カンジ"
+Kanji::Translator.to_roma("漢字") #=> "kanji"
+Kanji::Translator.to_slug("学校案内") #=> "gakkou-annai"
+```
+
+文字列メソッド（任意）:
+
+```ruby
+require "kanji/translator/core_ext/string"
+
+"漢字".to_hira #=> "かんじ"
+"学校案内".to_slug #=> "gakkou-annai"
+```
+
+## API
+
+すべてのメソッドはネットワークを使う可能性があります（読み取得のため）。タイムアウトやリトライはオプションで調整できます。
+
+- `Kanji::Translator.to_hira(text, timeout: 5, retries: 2, backoff: 0.5, user_agent: "kanji-translator/#{VERSION}")`
+  - 読み（ひらがな）を返します。
+- `Kanji::Translator.to_kata(text, **opts)`
+  - ひらがな読みをカタカナに変換して返します。
+- `Kanji::Translator.to_roma(text, **opts)`
+  - 簡易ヘボン式のローマ字（ASCII、小文字）で返します。拗音/促音（ゃゅょ/っ）に対応。長音記号「ー」は無視します（例: おう→ou）。
+- `Kanji::Translator.to_slug(text, separator: "-", downcase: true, collapse: true, **opts)`
+  - `to_roma` の結果をスラッグ化します。
+    - 非英数字を `separator` に置換、連続区切りを圧縮、前後の区切りをトリムします。
+
+例（オプション）:
+
+```ruby
+Kanji::Translator.to_hira("漢字", timeout: 3, retries: 1)
+Kanji::Translator.to_slug("東京タワー 2010") #=> "toukyou-tawa-2010"
+Kanji::Translator.to_slug("Foo Bar", separator: "_") #=> "foo_bar"
+```
+
+### 例外
+
+- `Kanji::Translator::TimeoutError` — 接続/読み取りタイムアウト
+- `Kanji::Translator::HTTPError` — 429/5xxなどのHTTPエラー（一定回数リトライ後に発生）
+- `Kanji::Translator::Error` — パース失敗などの基底例外
+
+429（レート制限）や5xxは指数バックオフで自動リトライします。回数や待機は `retries`/`backoff` で調整可能です。
+
+## 開発
+
+```bash
+bin/setup          # 依存をインストール
+bundle exec rake   # RSpec + RuboCop を実行
+bin/console        # IRBで試す
+```
+
+- Ruby: 3.2+（CIは 3.2/3.3/3.4）
+- テスト: WebMockでHTTPをスタブしています（ネットワーク不要）。VCRの設定は入っていますが現状未使用です。
+- コードスタイル: RuboCop（新Copは自動有効化）。自動修正は `-a`（安全）/`-A`（積極的）を使用。
+
+## リリース
+
+1. バージョン更新: `lib/kanji/translator/version.rb`
+2. 変更履歴: `CHANGELOG.md` を更新
+3. リリース: `bundle exec rake release`
+   - Gitタグ作成 → push → Rubygemsへpush（MFA必須）
+
+## ライセンス
+
+MIT License。詳細は `LICENSE.txt` を参照してください。
+
+## 貢献 / コード・オブ・コンダクト
+
+Issue/Pull Requestは歓迎します。`CODE_OF_CONDUCT.md` に同意の上でご参加ください。連絡先はリポジトリのIssueをご利用ください。
+
+## 謝辞
+
+- 読み取得元: https://yomikatawa.com （非公式）

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/lib/kanji/translator/core_ext/string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "kanji/translator"
+
+class String
+  def to_hira(**)
+    Kanji::Translator.to_hira(self, **)
+  end
+
+  def to_kata(**)
+    Kanji::Translator.to_kata(self, **)
+  end
+
+  def to_roma(**)
+    Kanji::Translator.to_roma(self, **)
+  end
+
+  def to_slug(**)
+    Kanji::Translator.to_slug(self, **)
+  end
+end

data/lib/kanji/translator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kanji
+  module Translator
+    VERSION = "0.1.0"
+  end
+end

data/lib/kanji/translator.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require_relative "translator/version"
+require "net/http"
+require "uri"
+require "nokogiri"
+
+module Kanji
+  module Translator
+    class Error < StandardError; end
+    class HTTPError < Error; end
+    class TimeoutError < Error; end
+
+    USER_AGENT = "kanji-translator/#{VERSION}".freeze
+    HOST = "yomikatawa.com"
+
+    def self.to_hira(text, timeout: 5, retries: 2, backoff: 0.5, user_agent: USER_AGENT)
+      raise ArgumentError, "text must be a String" unless text.is_a?(String)
+
+      body = fetch_page(text, timeout: timeout, retries: retries, backoff: backoff, user_agent: user_agent)
+      parse_hiragana(body)
+    end
+
+    def self.to_kata(text, **)
+      hira = to_hira(text, **)
+      hiragana_to_katakana(hira)
+    end
+
+    def self.to_roma(text, **)
+      hira = to_hira(text, **)
+      hiragana_to_romaji(hira)
+    end
+
+    def self.to_slug(text, separator: "-", downcase: true, collapse: true, **)
+      roma = to_roma(text, **)
+      s = downcase ? roma.downcase : roma.dup
+      sep = separator
+      # Replace non-alphanumeric with separator
+      s = s.gsub(/[^a-z0-9]+/, sep)
+      # Collapse duplicate separators
+      s = s.gsub(/#{Regexp.escape(sep)}{2,}/, sep) if collapse && !sep.empty?
+      # Trim leading/trailing separators
+      s = s.gsub(/^#{Regexp.escape(sep)}|#{Regexp.escape(sep)}$/, "") unless sep.empty?
+      s
+    end
+
+    def self.fetch_page(text, timeout:, retries:, backoff:, user_agent: USER_AGENT)
+      encoded = URI.encode_www_form_component(text)
+      path = "/kanji/#{encoded}"
+      attempt = 0
+
+      begin
+        attempt += 1
+        http = Net::HTTP.new(HOST, 443)
+        http.use_ssl = true
+        http.open_timeout = timeout
+        http.read_timeout = timeout
+
+        req = Net::HTTP::Get.new(path)
+        req["User-Agent"] = user_agent
+
+        resp = http.request(req)
+
+        case resp.code.to_i
+        when 200
+          resp.body
+        when 429
+          raise HTTPError, "rate limited: 429"
+        when 500..599
+          raise HTTPError, "server error: #{resp.code}"
+        else
+          raise HTTPError, "unexpected response: #{resp.code}"
+        end
+      rescue Timeout::Error => e
+        raise TimeoutError, e.message if attempt > retries + 1
+
+        sleep(backoff_for(attempt, base: backoff))
+        retry
+      rescue HTTPError => e
+        if e.message.include?("429") && attempt <= retries
+          # Respect Retry-After if present (best-effort)
+          # WebMock tests usually set 0, production may set seconds
+          retry_after = 0.0
+          sleep(retry_after)
+          sleep(backoff_for(attempt, base: backoff))
+          retry
+        elsif e.message.include?("server error") && attempt <= retries
+          sleep(backoff_for(attempt, base: backoff))
+          retry
+        else
+          raise
+        end
+      end
+    end
+
+    def self.parse_hiragana(html)
+      doc = Nokogiri::HTML(html)
+      cell = doc.at_css("#yomikata tbody tr td")
+      text = cell&.inner_text&.strip
+      raise Error, "failed to parse reading" if text.nil? || text.empty?
+
+      text
+    end
+
+    def self.hiragana_to_katakana(hira)
+      hira.tr("ぁ-ゔゝゞー", "ァ-ヴヽヾー")
+    end
+
+    DIGRAPHS = {
+      "きゃ" => "kya", "きゅ" => "kyu", "きぇ" => "kye", "きょ" => "kyo",
+      "ぎゃ" => "gya", "ぎゅ" => "gyu", "ぎぇ" => "gye", "ぎょ" => "gyo",
+      "しゃ" => "sha", "しゅ" => "shu", "しぇ" => "she", "しょ" => "sho",
+      "じゃ" => "ja",  "じゅ" => "ju",  "じぇ" => "je",  "じょ" => "jo",
+      "ちゃ" => "cha", "ちゅ" => "chu", "ちぇ" => "che", "ちょ" => "cho",
+      "にゃ" => "nya", "にゅ" => "nyu", "にぇ" => "nye", "にょ" => "nyo",
+      "ひゃ" => "hya", "ひゅ" => "hyu", "ひぇ" => "hye", "ひょ" => "hyo",
+      "びゃ" => "bya", "びゅ" => "byu", "びぇ" => "bye", "びょ" => "byo",
+      "ぴゃ" => "pya", "ぴゅ" => "pyu", "ぴぇ" => "pye", "ぴょ" => "pyo",
+      "みゃ" => "mya", "みゅ" => "myu", "みぇ" => "mye", "みょ" => "myo",
+      "りゃ" => "rya", "りゅ" => "ryu", "りぇ" => "rye", "りょ" => "ryo",
+      "ゔぁ" => "va",  "ゔぃ" => "vi",  "ゔぇ" => "ve",  "ゔぉ" => "vo",
+      "ふぁ" => "fa",  "ふぃ" => "fi",  "ふぇ" => "fe",  "ふぉ" => "fo"
+    }.freeze
+
+    BASIC = {
+      "あ" => "a",  "い" => "i",  "う" => "u",  "え" => "e",  "お" => "o",
+      "か" => "ka", "き" => "ki", "く" => "ku", "け" => "ke", "こ" => "ko",
+      "さ" => "sa", "し" => "shi", "す" => "su", "せ" => "se", "そ" => "so",
+      "た" => "ta", "ち" => "chi", "つ" => "tsu", "て" => "te", "と" => "to",
+      "な" => "na", "に" => "ni", "ぬ" => "nu", "ね" => "ne", "の" => "no",
+      "は" => "ha", "ひ" => "hi", "ふ" => "fu", "へ" => "he", "ほ" => "ho",
+      "ま" => "ma", "み" => "mi", "む" => "mu", "め" => "me", "も" => "mo",
+      "や" => "ya", "ゆ" => "yu", "よ" => "yo",
+      "ら" => "ra", "り" => "ri", "る" => "ru", "れ" => "re", "ろ" => "ro",
+      "わ" => "wa", "ゐ" => "wi", "ゑ" => "we", "を" => "o",
+      "ん" => "n",
+      "が" => "ga", "ぎ" => "gi", "ぐ" => "gu", "げ" => "ge", "ご" => "go",
+      "ざ" => "za", "じ" => "ji", "ず" => "zu", "ぜ" => "ze", "ぞ" => "zo",
+      "だ" => "da", "ぢ" => "ji", "づ" => "zu", "で" => "de", "ど" => "do",
+      "ば" => "ba", "び" => "bi", "ぶ" => "bu", "べ" => "be", "ぼ" => "bo",
+      "ぱ" => "pa", "ぴ" => "pi", "ぷ" => "pu", "ぺ" => "pe", "ぽ" => "po",
+      "ぁ" => "a",  "ぃ" => "i",  "ぅ" => "u",  "ぇ" => "e",  "ぉ" => "o",
+      "ゔ" => "vu", "ゎ" => "wa", "ー" => "-"
+    }.freeze
+
+    def self.hiragana_to_romaji(hira)
+      # Handle digraphs first
+      s = hira.dup
+      DIGRAPHS.each { |k, v| s.gsub!(k, v) }
+
+      result = String.new
+      chars = s.chars
+      i = 0
+      while i < chars.length
+        ch = chars[i]
+        nx = chars[i + 1]
+
+        # sokuon (small tsu)
+        if ch == "っ" && nx
+          cons = case nx
+                 when "c" then "t" # chu -> c but doubled as t (match 'c' + 'h')
+                 when /^[a-z]/ then nx[0]
+                 end
+          # If next piece already converted (e.g., from digraph), take first consonant of romaji
+          if cons.nil?
+            # Look ahead: convert nx to romaji to get first consonant
+            nx_romaji = BASIC[nx] || nx
+            cons = nx_romaji[0]
+          end
+          result << cons if cons
+          i += 1
+          next
+        end
+
+        if ch == "ー"
+          # Prolonged sound mark – skip simple handling
+          i += 1
+          next
+        end
+
+        romaji = BASIC[ch]
+        result << (romaji || ch)
+        i += 1
+      end
+
+      # Simple normalization: "nn" before vowels -> "n" (basic handling)
+      result.gsub(/n(?=[aiueoy])/, "n")
+    end
+
+    def self.backoff_for(attempt, base: 0.5)
+      # Exponential backoff with small jitter
+      sleep_s = base * (2**(attempt - 1))
+      jitter = rand * 0.05
+      sleep_s + jitter
+    end
+  end
+end

data/sig/kanji/translator.rbs

@@ -0,0 +1,6 @@
+module Kanji
+  module Translator
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: kanji-translator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiromu Kodani
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: |-
+  Fetches readings for Japanese Kanji from yomikatawa.com and converts them
+  to hiragana, katakana, or Hepburn-style romaji. Includes timeout/retry
+  handling and a simple API.
+email:
+- kodani@dreaw.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kanji/translator.rb
+- lib/kanji/translator/core_ext/string.rb
+- lib/kanji/translator/version.rb
+- sig/kanji/translator.rbs
+homepage: https://github.com/dw-kodani/kanji-translator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dw-kodani/kanji-translator
+  source_code_uri: https://github.com/dw-kodani/kanji-translator
+  changelog_uri: https://github.com/dw-kodani/kanji-translator/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Convert Kanji to Hiragana, Katakana, and Romaji
+test_files: []