Project

utanone

0.0
The project is in a healthy, maintained state
Utanone is a helper that counts the number of sounds in Japanese sentences.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

>= 0
~> 13.0
~> 3.0
~> 1.7

Runtime

~> 0.996
~> 1.2.0
 Project Readme

Utanone

Utanone(歌の音) is a helper for creating tanka/haiku poems in Japanese.

形態素解析エンジンMeCabを使用して、入力した短歌/俳句の音数をカウントします。

Requirements

  • MeCab 0.996
    • MeCabのインストールは mecabを参考にしてください
  • Ruby 2.7 or greater

Installation

gem install utanone

Usage

MECAB_PATH の設定

MECAB_PATH を設定する必要があります。

ENV['MECAB_PATH']='/usr/local/lib/libmecab.so'

Uta インスタンスの生成(ref_utaの指定なし)

require 'utanone'

uta = Utanone::Uta.new('あっつい夏の日、3時にアイスクリームを食べちゃったね')

#yomigana

よみがなを返します。

uta.yomigana #=> "アッツイナツノヒ、サンジニアイスクリームヲタベチャッタネ"

#count

文字数をカウントします。

uta.count #=> 27

引数に tanka: true を渡すことで短歌、俳句での音数をカウントします。 (ァ、ィ、ォ、ャ、ュ、ョ は音数としてカウントしません。 は音数としてカウントします。)

uta.count(tanka: true) #=> 26

#correct

よみがなが形態素解析の結果と異なる場合によみがなを訂正できます。戻り値としてよみがなを訂正したUtaインスタンスを返却します。

uta = Utanone::Uta.new('午前四時の灯')
uta.yomigana #=> ゴゼンヨンジノアカリ
corrected_uta = uta.correct(correct_yomigana: 'ゴゼンヨジノトモシビ')
corrected_uta.yomigana #=> ゴゼンヨジノトモシビ

Uta インスタンスの生成(ref_utaの指定あり)

第2引数にref_utaを指定することで、ref_utaが保持しているよみがなを優先して、よみがなを設定します。

下記の例文では形態素解析の結果では「四」は「ヨ」、「灯」は「アカリ」とよみがなが設定されます。

よみがなをそれぞれ「ヨン」、「トモシビ」と修正したUtaインスタンスをref_utaとして第二引数に渡すことで、形態素として「四」「灯」が含まれる場合によみがなを「ヨン」、「トモシビ」として返却します。

uta = Utanone::Uta.new('午前四時の灯')
uta.yomigana #=> "ゴゼンヨンジノアカリ"
ref_uta = uta.correct(correct_yomigana: 'ゴゼンヨジノトモシビ')
ref_uta.yomigana #=> "ゴゼンヨジノトモシビ"

uta2 = Utanone::Uta.new('灯が見える午前四時', ref_uta)
uta2.yomigana #=> "トモシビガミエルゴゼンヨジ"

License

The gem is available as open source under the terms of the MIT License.