Add interscript command (#4)

* Add “interscript” command and fix maps

Author: ronaldtse

Gemfile

@@ -0,0 +1 @@
+source 'https://rubygems.org'

README.adoc

@@ -1,4 +1,4 @@
-= Interoperable Transliteration Schemes and a Ruby implementation
+= Interscript: Interoperable Transliteration Schemes and a Ruby implementation
 
 == Introducation
 
@@ -7,29 +7,34 @@ This repository contains a number of transliteration schemes from:
 * BGN/PCGN
 * ICAO
 * ISO
+* UN (by UNGEGN)
 
-The goal is to achieve quality comparison and easily swappable transliteration schemes.
+The goal is to achieve interoperable transliteration schemes allowing quality comparisons.
 
-== Covered languages
 
-Currently the schemes cover Cyrillic, Armenian, Greek, Arabic and Hebrew.
+== STATUS (work in progress!)
+
+These transliteration systems currently work:
+
+`bgnpcgn-rus-Cyrl-Latn`:: BGN/PCGN Romanization of Russian
+`iso-rus-Cyrl-Latn`::     ISO 9 Romanization of Russian
+`icao-rus-Cyrl-Latn`::    ICAO MRZ Romanization of Russian
+`bas-rus-Cyrl-Latn`::     Bulgaria Academy of Science Streamlined System for Russian
 
 
-== Initial work
+== Usage
 
-The initial work is to:
 
-1. Write a Ruby script that allows transliterating some text (under `samples/`)
-into the target writing system via the files in `maps/`.
+[source,sh]
+----
+interscript samples/rus-Cyrl.txt --system=bas-rus-Cyrl-Latn --output=rus-Latn.txt
+----
 
-2. Initially we only want to compare Russian transcriptions. There are the following definition maps:
 
-.. BGN/PCGN Romanization of Russian (`bgnpcgn-rus-Cyrl-Latn.yaml`)
-.. ISO 9 Romanization of Russian (`iso-rus-Cyrl-Latn.yaml`)
-.. ICAO MRZ Romanization of Russian (`icao-rus-Cyrl-Latn.yaml`)
-.. Bulgaria Academy of Science Streamlined System for Russian (`bas-rus-Cyrl-Latn.yaml`)
 
-3. There should be a command to generate all 4 transliterations at once.
+== Covered languages
+
+Currently the schemes cover Cyrillic, Armenian, Greek, Arabic and Hebrew.
 
 
 == Sources

Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

bin/interscript

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require_relative '../lib/interscript'
+
+if ARGV.empty?
+  puts "write source file, source format, and output file"
+else
+  args = Hash[ ARGV.flat_map{|s| s.scan(/--?([^=\s]+)(?:=(\S+))?/) } ]
+  input = ARGV[0]
+  system_code = args["system"]
+  output_file = args["output"]
+
+  raise "Please enter the system code with --system={system_code}" unless system_code
+
+  if output_file
+    Interscript.instance.transliterate_file(system_code, input, output_file)
+  else
+    puts Interscript.instance.transliterate(system_code, IO.read(input))
+  end
+end
+
+

interscript.gemspec

@@ -0,0 +1,26 @@
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interscript/version'
+require 'rake'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interscript"
+  spec.version       = Interscript::VERSION
+  spec.required_rubygems_version = Gem::Requirement.new('>= 0') if spec.respond_to? :required_rubygems_version=
+  spec.summary       = %q{Interoperable script conversion systems}
+  spec.description   = %q{Interoperable script conversion systems}
+  spec.authors = ['project_contibutors']
+  spec.date = %q{2019-11-17}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.files = FileList['{bin,lib,test}/**/*', 'README.adoc'].to_a
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.bindir = 'bin'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

lib/interscript.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+require 'singleton'
+
+class Interscript
+  include Singleton
+  
+  SYSTEM_DEFINITIONS_PATH = File.expand_path('../../maps', __FILE__)
+
+  def initialize
+    @systems = {}
+  end
+
+  def transliterate_file(system_code, input_file, output_file)
+    input = File.read(input_file)
+    output = transliterate(system_code, input)
+
+    File.open(output_file, "w") do |f|
+      f.puts(output)
+    end
+    puts "Output written to: #{output_file}"
+  end
+
+  def load_system_definition(system_code)
+    @systems[system_code] ||= YAML.load_file(File.join(SYSTEM_DEFINITIONS_PATH, "#{system_code}.yaml"))
+  end
+
+  def get_system(system_code)
+    @systems[system_code]
+  end
+
+  def system_char_map(system_code)
+    get_system(system_code)["map"]["characters"]
+  end
+
+  def system_rules(system_code)
+    get_system(system_code)["map"]["rules"]
+  end
+
+  def transliterate(system_code, string)
+    load_system_definition(system_code)
+
+    # TODO: also need to support regular expressions via system_rules(system_code), before system_char_map
+
+    character_map = system_char_map(system_code)
+
+    string.split('').map do |char|
+      converted_char = character_map[char] ? character_map[char] : char
+      string[char] = converted_char
+    end.join('')
+  end
+
+end
+

lib/interscript/version.rb

@@ -0,0 +1,3 @@
+module Interscript
+  VERSION = "0.9"
+end

maps/bas-rus-Cyrl-Latn-bss.yaml

@@ -57,7 +57,7 @@ tests:
 
 map:
   characters:
-    "\u0027": ""     # '
+    "\u0027": ""    # '
     "\u0410": "A"    # А
     "\u0411": "B"    # Б
     "\u0412": "V"    # В
@@ -146,3 +146,4 @@ map:
 
     # ъ -> (none)
     "\u044a": ""
+

maps/bgnpcgn-rus-Cyrl-Latn-1947.yaml

@@ -154,17 +154,17 @@ tests:
 map:
   rules:
     - pattern: "/([ЄФІЦАаЕеИиЙйОоУуЫыЮюЯяії])\u0415/"
-      result: "\1YE"
+      result: "\\1YE"
     - pattern: "/^\u0415/"
       result: "YE"
     - pattern: "/([йьъ])\u0415/"
-      result: "\1YE"
+      result: "\\1YE"
     - pattern: "/([ЄФІЦАаЕеИиЙйОоУуЫыЮюЯяії])\u0435/"
-      result: "\1ye"
+      result: "\\1ye"
     - pattern: "/^\u0435/"
       result: "ye"
     - pattern: "/([йьъ])\u0435/"
-      result: "\1ye"
+      result: "\\1ye"
 
   characters:
     "\u0410": "A"

maps/icao-rus-Cyrl-Latn-9303.yaml

@@ -11,8 +11,8 @@ map:
     "\u0410": "A"    # А 
     "\u0411": "B"    # Б 
     "\u0414": "D"    # Д 
-    "\u0401": "E"    # Ё 
-    "\u0415": "E"    # Е 
+    "\u0401": "E"    # Ё
+    "\u0415": "E"    # Е
     "\u042D": "E"    # Э 
     "\u0424": "F"    # Ф 
     "\u0413": "G"    # Г 
@@ -97,3 +97,4 @@ map:
     "\u0454": "ie"   # є
     "\u0457": "i"    # ї
     "\u0453": "g"    # ѓ
+