thai_keyboard_corrector 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ade7acc9f2b07c72e55d0f89cfe1c3a23002f5c01ba19e5eff0b27b1c1d483ca
+  data.tar.gz: f010ec32ab5064c6346643162e029876d5c7450e4d584bf3d7cdc4e569ed1b59
+SHA512:
+  metadata.gz: 1005a6452fd77bd31271c0db49612ff39f8451a4be5de998524d2ccf5edbce384b753a90ec681b17ca9a8127327333e4847156ec502c02e850fdb370c7acedbb
+  data.tar.gz: b18cffcd017adb5f5d1dd64782f0a8b87c1bdccffa96028765c5a8ca48ddd284127092fa34d12160d72aaa83088bf7c50e5a0fc0feead296409e04554fbe2cc4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Chayut Orapinpatipat
+
+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,93 @@
+# 🇹🇭 Thai Keyboard Corrector – แก้ไขข้อความไทยพิมพ์ผิด
+
+**Thai Keyboard Corrector** (TKC) แก้ปัญหาการพิมพ์ **สลับแป้น** ระหว่างแป้นพิมพ์ภาษาไทยเกษมณี (Thai Kedmanee) และแป้นภาษาอังกฤษ QWERTY  
+ตัวอย่าง `l;ylfu` ➜ **สวัสดี** │ `ฟหกด` ➜ **asdf**
+
+---
+
+## Features
+
+|  |  |
+|---------|---------|
+| Detects text that *looks* like **Thai-in-English** (`:thai_in_en`) or **English-in-Thai** (`:en_in_th`). | ตรวจจับข้อความที่พิมพ์สลับแป้น ทั้ง ไทยในอังกฤษ และ อังกฤษในไทย |
+| Converts both directions with a **fixed key-position map** (no locale files). | แปลงกลับได้ทั้งสองทางด้วยตารางแมปคีย์ถาวร |
+| **Pure Ruby, zero dependencies** – works ≥ Ruby 2.7. | เขียนด้วย Ruby ล้วน ๆ ไม่พึ่งไลบรารีภายนอก |
+| Offers a **clean Ruby API** *and* a **CLI tool** (`thai_kbd_correct`). | ใช้ง่ายผ่านโค้ด Ruby หรือ CLI |
+
+---
+
+## Installation
+
+```bash
+gem install thai_keyboard_corrector
+````
+
+(หรือเพิ่ม `gem "thai_keyboard_corrector"` ใน Gemfile)
+
+---
+
+## Usage – Ruby API
+
+```ruby
+require "thai_keyboard_corrector"
+
+# 1. Auto-correct if layout seems wrong
+ThaiKeyboardCorrector.correct("l;ylfu")   # => "สวัสดี"
+ThaiKeyboardCorrector.correct("้รทัืฟทำ รห")     # => "asdf"
+
+# 2. Detect layout (returns a Symbol)
+ThaiKeyboardCorrector.detect_layout("้รทัืฟทำรห")  # => :thai
+ThaiKeyboardCorrector.detect_layout("l;ylfu")  # => :thai_in_en
+ThaiKeyboardCorrector.detect_layout("ฟหกด")    # => :en_in_th
+ThaiKeyboardCorrector.detect_layout("helloส")  # => :mixed
+```
+
+### Detection Symbols
+
+| Symbol        | Meaning                                                      |
+| ------------- | ------------------------------------------------------------ |
+| `:thai`       | Normal Thai text                                             |
+| `:en`         | Normal English text                                          |
+| `:thai_in_en` | Thai characters typed on **EN** layout (needs flip EN→TH)    |
+| `:en_in_th`   | English characters typed on **TH** layout (needs flip TH→EN) |
+| `:mixed`      | Contains both Thai & English letters in correct positions    |
+| `:unknown`    | Blank or symbols only                                        |
+
+---
+
+## Usage – CLI
+
+```bash
+$ thai_kbd_correct "l;ylfu"
+สวัสดี
+
+$ echo "ฟหกด" | thai_kbd_correct
+asdf
+```
+
+Flags:
+
+| Flag    | ใช้ทำอะไร                         |
+| ------- | --------------------------------- |
+| `-f th` | บังคับแปลง EN→TH (ข้ามการตรวจจับ) |
+| `-f en` | บังคับแปลง TH→EN                  |
+| `-h`    | แสดงวิธีใช้                       |
+
+---
+
+## 🛠️ Development
+
+```bash
+git clone https://github.com/<you>/thai_keyboard_corrector.git
+cd thai_keyboard_corrector
+bundle install
+bundle exec rspec          # ✅  tests should pass
+bundle exec rubocop -A     # ✅  style conforms
+```
+
+---
+
+## License
+
+© 2025 Chayut Orapinpatipat
+Released under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.

data/bin/thai_kbd_correct

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/thai_keyboard_corrector'
+require 'optparse'
+
+options = { force: nil }
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: thai_kbd_correct [options] <text>'
+  opts.on('-fLAYOUT', '--force=LAYOUT', 'Force convert (en|th)') { |v| options[:force] = v }
+  opts.on('-h', '--help', 'Show help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+input_text = ARGV.empty? ? $stdin.read : ARGV.join(' ')
+
+if options[:force] == 'th'
+  puts ThaiKeyboardCorrector::Mapping.map_eng_to_thai(input_text)
+elsif options[:force] == 'en'
+  puts ThaiKeyboardCorrector::Mapping.map_thai_to_eng(input_text)
+else
+  puts ThaiKeyboardCorrector.correct(input_text)
+end

data/lib/thai_keyboard_corrector/detector.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ThaiKeyboardCorrector
+  # This module detects the layout of a given string.
+  module Detector
+    THAI_RANGE = (0x0E00..0x0E7F).freeze
+    THRESHOLD  = 0.7
+    VOWELS     = 'aeiouy'
+    FULL_HIT   = 1.0 - Float::EPSILON
+
+    module_function
+
+    # Returns :thai_in_en, :en_in_th, :thai, :en, :mixed, :unknown
+    def detect_layout(str)
+      clean = str.strip
+      return :unknown if clean.empty?
+
+      thai_cnt, latin_cnt = char_stats(clean)
+      return :unknown if thai_cnt.zero? && latin_cnt.zero?
+
+      # ---------- pure-Latin ----------
+      if thai_cnt.zero?
+        # ▼ Treat 1-3-letter words as Thai-in-EN (they’re almost never real English)
+        return :thai_in_en if clean.length <= 3 &&
+                              hit_ratio(clean, Mapping::ENG_TO_THAI) >= FULL_HIT
+
+        return :thai_in_en if clean.match?(/[^A-Za-z]/) &&
+                              hit_ratio(clean, Mapping::ENG_TO_THAI) >= THRESHOLD
+
+        return :en
+      end
+
+      # ---------- pure-Thai ----------
+      if latin_cnt.zero?
+        return :thai if clean.length < 4 # ignore tiny words like “ดี”
+
+        eng = Mapping.map_thai_to_eng(clean)
+        vowelish = eng.count(VOWELS).positive?
+        if eng.match?(/\A[a-z]+\z/i) && vowelish &&
+           hit_ratio(clean, Mapping::THAI_TO_ENG) >= THRESHOLD
+          return :en_in_th
+        end
+
+        return :thai
+      end
+
+      # ---------- mixed ----------
+      return :mixed if thai_cnt.positive? && latin_cnt.positive?
+      return :thai_in_en if hit_ratio(clean, Mapping::ENG_TO_THAI) >= THRESHOLD
+      return :en_in_th   if hit_ratio(clean, Mapping::THAI_TO_ENG) >= THRESHOLD
+
+      :mixed
+    end
+
+    # helpers ----------------------------------------------------------------
+    def char_stats(str)
+      clean = str.gsub(/\s+/, '') # remove ALL Unicode whitespace
+      thai  = clean.each_char.count { |c| THAI_RANGE.include?(c.ord) }
+      latin = clean.each_char.count { |c| c =~ /[A-Za-z]/ }
+      [thai, latin]
+    end
+    private_class_method :char_stats
+
+    def hit_ratio(str, table)
+      chars = str.gsub(/\s+/, '').chars # whitespace-free array
+      return 0.0 if chars.empty?
+
+      hits = chars.count { |c| table.key?(c) }
+      hits.to_f / chars.length
+    end
+    private_class_method :hit_ratio
+  end
+end

data/lib/thai_keyboard_corrector/mapping.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ThaiKeyboardCorrector
+  # Mapping module provides methods to convert between English and Thai characters
+  module Mapping
+    # Base (lower-case) map
+    BASE = {
+      'q' => 'ๆ', 'w' => 'ไ', 'e' => 'ำ', 'r' => 'พ', 't' => 'ะ',
+      'y' => 'ั', 'u' => 'ี', 'i' => 'ร', 'o' => 'น', 'p' => 'ย',
+      '[' => 'บ', ']' => 'ล',
+      'a' => 'ฟ', 's' => 'ห', 'd' => 'ก', 'f' => 'ด', 'g' => 'เ',
+      'h' => '้', 'j' => '่', 'k' => 'า', 'l' => 'ส', ';' => 'ว', "'" => 'ง',
+      'z' => 'ผ', 'x' => 'ป', 'c' => 'แ', 'v' => 'อ', 'b' => 'ิ',
+      'n' => 'ื', 'm' => 'ท', ',' => 'ม', '.' => 'ใ', '/' => 'ฝ'
+    }.freeze
+
+    ENG_TO_THAI = BASE.merge(BASE.transform_keys(&:upcase)).freeze
+    THAI_TO_ENG = BASE.invert.freeze # ⇒ always lower-case
+
+    module_function
+
+    def map_eng_to_thai(str)
+      str.chars.map { |c| ENG_TO_THAI.fetch(c, c) }.join
+    end
+
+    def map_thai_to_eng(str)
+      str.chars.map { |c| THAI_TO_ENG.fetch(c, c) }.join
+    end
+  end
+end

data/lib/thai_keyboard_corrector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ThaiKeyboardCorrector
+  VERSION = '0.1.1'
+end

data/lib/thai_keyboard_corrector.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'thai_keyboard_corrector/version'
+require 'thai_keyboard_corrector/mapping'
+require 'thai_keyboard_corrector/detector'
+
+# Main entry point
+module ThaiKeyboardCorrector
+  module_function
+
+  # Corrects a string if it appears to be typed on the wrong layout.
+  # @param str [String] input string
+  # @return [String] corrected or original string
+  def correct(str)
+    case detect_layout(str)
+    when :thai_in_en
+      Mapping.map_eng_to_thai(str)
+    when :en_in_th
+      Mapping.map_thai_to_eng(str)
+    else
+      str
+    end
+  end
+
+  # Detects keyboard layout scenario for the given string.
+  # @param str [String]
+  # @return [Symbol] one of :thai_in_en, :en_in_th, :thai, :en, :mixed, :unknown
+  def detect_layout(str)
+    Detector.detect_layout(str)
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: thai_keyboard_corrector
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chayut Orapinpatipat
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Detects and converts Thai text mistakenly typed on an English QWERTY
+  layout (and vice versa) back to its intended form. Perfect for search bars, chat
+  apps, and form inputs.
+email:
+- chayut_o@hotmail.com
+executables:
+- thai_kbd_correct
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/thai_kbd_correct
+- lib/thai_keyboard_corrector.rb
+- lib/thai_keyboard_corrector/detector.rb
+- lib/thai_keyboard_corrector/mapping.rb
+- lib/thai_keyboard_corrector/version.rb
+homepage: https://github.com/chayuto/thai_keyboard_corrector
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Corrects Thai text typed on the wrong keyboard layout (EN/TH) and vice versa.
+test_files: []