yosina 0.1.0

data/lib/yosina/transliterators.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'transliterators/spaces'
+require_relative 'transliterators/kanji_old_new'
+require_relative 'transliterators/radicals'
+require_relative 'transliterators/ideographic_annotations'
+require_relative 'transliterators/mathematical_alphanumerics'
+require_relative 'transliterators/prolonged_sound_marks'
+require_relative 'transliterators/hyphens'
+require_relative 'transliterators/hira_kata'
+require_relative 'transliterators/hira_kata_composition'
+require_relative 'transliterators/ivs_svs_base'
+require_relative 'transliterators/jisx0201_and_alike'
+require_relative 'transliterators/circled_or_squared'
+require_relative 'transliterators/combined'
+require_relative 'transliterators/japanese_iteration_marks'
+
+module Yosina
+  # Registry for transliterator factories
+  module Transliterators
+    FACTORIES = {
+      spaces: Transliterators::Spaces,
+      kanji_old_new: Transliterators::KanjiOldNew,
+      radicals: Transliterators::Radicals,
+      ideographic_annotations: Transliterators::IdeographicAnnotations,
+      mathematical_alphanumerics: Transliterators::MathematicalAlphanumerics,
+      prolonged_sound_marks: Transliterators::ProlongedSoundMarks,
+      hyphens: Transliterators::Hyphens,
+      hira_kata: Transliterators::HiraKata,
+      hira_kata_composition: Transliterators::HiraKataComposition,
+      ivs_svs_base: Transliterators::IvsSvsBase,
+      jisx0201_and_alike: Transliterators::Jisx0201AndAlike,
+      combined: Transliterators::Combined,
+      circled_or_squared: CircledOrSquared,
+      japanese_iteration_marks: Transliterators::JapaneseIterationMarks
+    }.freeze
+
+    # Get a transliterator factory by name
+    #
+    # @param name [String, Symbol] The name of the transliterator
+    # @return [Module, nil] The transliterator factory module or nil if not found
+    def self.get_factory(name)
+      if name.is_a?(String)
+        # Convert string to symbol format (e.g. 'kanji-old-new' -> :kanji_old_new)
+        name = name.gsub('-', '_').to_sym
+      end
+      FACTORIES[name]
+    end
+
+    # List all available transliterator names
+    #
+    # @return [Array<Symbol>] Array of available transliterator names
+    def self.available_transliterators
+      FACTORIES.keys
+    end
+  end
+end

data/lib/yosina/version.rb

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

data/lib/yosina.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'yosina/version'
+require_relative 'yosina/char'
+require_relative 'yosina/transliterator'
+require_relative 'yosina/chars'
+require_relative 'yosina/recipes'
+require_relative 'yosina/transliterators'
+
+# Main module for Yosina text transliteration library
+module Yosina
+  class Error < StandardError; end
+  class TransliteratorFactoryError < Error; end
+  class TransliterationError < Error; end
+
+  # Frontend convenience function to create a string-to-string transliterator
+  # from a recipe or a list of configs.
+  #
+  # @param configs_or_recipe [Array<TransliteratorConfig>, Array<String>, TransliterationRecipe]
+  #   A recipe or a list of transliterator configs/names
+  # @return [Proc] A transliterator function that takes a string and returns a string
+  def self.make_transliterator(configs_or_recipe)
+    configs = case configs_or_recipe
+              when TransliterationRecipe
+                configs_or_recipe.build_transliterator_configs.map do |config_array|
+                  TransliteratorConfig.new(config_array[0], config_array[1])
+                end
+              when Array
+                configs_or_recipe.map do |item|
+                  case item
+                  when String, Symbol
+                    TransliteratorConfig.new(item)
+                  when Array
+                    TransliteratorConfig.new(item[0], item[1])
+                  else
+                    item
+                  end
+                end
+              else
+                raise ArgumentError, 'configs_or_recipe must be Array or TransliterationRecipe'
+              end
+
+    transliterator = create_chained_transliterator(configs)
+
+    proc do |input|
+      chars = Chars.build_char_array(input)
+      result_chars = transliterator.call(chars)
+      result_chars.to_s
+    end
+  end
+
+  private_class_method def self.create_chained_transliterator(configs)
+    transliterators = configs.map do |config|
+      factory = Transliterators.get_factory(config.name)
+      raise TransliteratorFactoryError, "Unknown transliterator: #{config.name}" unless factory
+
+      factory.call(config.options || {})
+    end
+
+    ChainedTransliterator.new(transliterators)
+  end
+end

data/yosina.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/yosina/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'yosina'
+  spec.version = Yosina::VERSION
+  spec.authors = ['Moriyoshi Koizumi']
+  spec.email = ['mozo@mozo.jp']
+
+  spec.summary = 'Japanese text transliteration library'
+  spec.description = 'Yosina is a transliteration library that specifically deals with the letters and symbols used' \
+                     ' in Japanese writing.'
+  spec.homepage = 'https://github.com/yosina-lib/yosina'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yosina-lib/yosina'
+  spec.metadata['changelog_uri'] = 'https://github.com/yosina-lib/yosina/releases'
+
+  # 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|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[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']
+
+  # Development dependencies
+  spec.add_development_dependency 'minitest', '~> 5.25'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rubocop', '~> 1.79'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.38'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: yosina
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moriyoshi Koizumi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.79'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Yosina is a transliteration library that specifically deals with the
+  letters and symbols used in Japanese writing.
+email:
+- mozo@mozo.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- README.ja.md
+- README.md
+- Rakefile
+- codegen/dataset.rb
+- codegen/emitters.rb
+- codegen/emitters/circled_or_squared_transliterator_data.rb
+- codegen/emitters/combined_transliterator_data.rb
+- codegen/emitters/hyphens_transliterator_data.rb
+- codegen/emitters/ivs_svs_base_transliterator_data.rb
+- codegen/emitters/simple_transliterator.rb
+- codegen/emitters/utils.rb
+- codegen/main.rb
+- lib/yosina.rb
+- lib/yosina/char.rb
+- lib/yosina/chars.rb
+- lib/yosina/recipes.rb
+- lib/yosina/transliterator.rb
+- lib/yosina/transliterators.rb
+- lib/yosina/transliterators/circled_or_squared.rb
+- lib/yosina/transliterators/circled_or_squared_data.rb
+- lib/yosina/transliterators/combined.rb
+- lib/yosina/transliterators/combined_data.rb
+- lib/yosina/transliterators/hira_kata.rb
+- lib/yosina/transliterators/hira_kata_composition.rb
+- lib/yosina/transliterators/hira_kata_table.rb
+- lib/yosina/transliterators/hyphens.rb
+- lib/yosina/transliterators/hyphens_data.rb
+- lib/yosina/transliterators/ideographic_annotations.rb
+- lib/yosina/transliterators/ivs_svs_base.rb
+- lib/yosina/transliterators/ivs_svs_base_data.rb
+- lib/yosina/transliterators/japanese_iteration_marks.rb
+- lib/yosina/transliterators/jisx0201_and_alike.rb
+- lib/yosina/transliterators/kanji_old_new.rb
+- lib/yosina/transliterators/mathematical_alphanumerics.rb
+- lib/yosina/transliterators/prolonged_sound_marks.rb
+- lib/yosina/transliterators/radicals.rb
+- lib/yosina/transliterators/spaces.rb
+- lib/yosina/version.rb
+- yosina.gemspec
+homepage: https://github.com/yosina-lib/yosina
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yosina-lib/yosina
+  source_code_uri: https://github.com/yosina-lib/yosina
+  changelog_uri: https://github.com/yosina-lib/yosina/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+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: Japanese text transliteration library
+test_files: []