utanone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca2cf7d743435c6d391f6640733aa4df39459874837eedafc9563b6450c0cd43
+  data.tar.gz: b962d0cfd06c692f351b03b66d4a880118498cdd925a1464beeec45b1bb3817b
+SHA512:
+  metadata.gz: bdab2b8bf25ad48447b7f20751a6209b8ed3ee6c955d634d5f857ea535156095f55482e3da36732962175f8daabb716b3fd6c2cfe01b8978aee31cf113721422
+  data.tar.gz: 760648236b6d36a216fc9e881b3436e2b85e2e42208577f729a450fc2ad30174d0b7dd00bfc95ce43cc9c85174f57ea01be519e9558507f5e4ab11742d57b378

data/.env.sample

@@ -0,0 +1 @@
+MECAB_PATH=/usr/local/Cellar/mecab/0.996/lib/libmecab.dylib 

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  TargetRubyVersion: 3.0.1
+  Exclude:
+    - Gemfile
+    - "*.md"
+    - "*.text"
+    - utanone.gemspec
+    - "bin/*"
+    - Rakefile
+    - "vendor/**/*"
+    - "tmp/**/*"
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 8
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## [0.1.0] - 2021-09-29
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 yuriko11d@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in utanone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 yuko yuri
+
+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,85 @@
+# Utanone
+
+Utanone(歌の音) is a helper for creating tanka/haiku poems in Japanese.
+
+形態素解析エンジン[MeCab](https://taku910.github.io/mecab/)を使用して、入力した短歌/俳句の音数をカウントします。
+
+## Requirements
+- [MeCab 0.996](http://taku910.github.io/mecab/)
+  - MeCabのインストールは [mecab](https://github.com/markburns/mecab)を参考にしてください
+- Ruby 2.7 or greater
+
+## Installation
+
+```ruby
+gem install utanone
+```
+
+## Usage
+### MECAB_PATH の設定
+`MECAB_PATH` を設定する必要があります。
+
+```
+ENV['MECAB_PATH']='/usr/local/lib/libmecab.so'
+```
+
+### Uta インスタンスの生成（ref_utaの指定なし）
+
+```ruby
+require 'utanone'
+
+uta = Utanone::Uta.new('あっつい夏の日、3時にアイスクリームを食べちゃったね')
+```
+
+### #yomigana
+
+よみがなを返します。
+```ruby
+uta.yomigana #=> "アッツイナツノヒ、サンジニアイスクリームヲタベチャッタネ"
+```
+
+### #count
+
+文字数をカウントします。
+
+```ruby
+uta.count #=> 27
+```
+
+引数に `tanka: true` を渡すことで短歌、俳句での音数をカウントします。
+（`ァ、ィ、ォ、ャ、ュ、ョ` は音数としてカウントしません。`ッ` は音数としてカウントします。）
+
+```ruby
+uta.count(tanka: true) #=> 26
+```
+
+### #correct
+よみがなが形態素解析の結果と異なる場合によみがなを訂正できます。戻り値としてよみがなを訂正したUtaインスタンスを返却します。
+
+```ruby
+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として第二引数に渡すことで、形態素として「四」「灯」が含まれる場合によみがなを「ヨン」、「トモシビ」として返却します。
+
+```ruby
+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](https://opensource.org/licenses/MIT).

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "utanone"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/utanone/uta.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'natto'
+module Utanone
+  class Uta
+    attr_reader :original_str, :parsed_morphemes
+
+    EXCLUDING_COUNTING_RUBY_BY_TANKA = /ァ|ィ|ォ|ャ|ュ|ョ/
+    EXCLUDING_COUNTING_LEXICAL_CATEGORIES = %w[記号].freeze
+
+    def initialize(str, ref_uta = nil)
+      @original_str = str
+      @parsed_morphemes = parse_to_hash(str, ref_uta)
+    end
+
+    def yomigana
+      @parsed_morphemes.map { _1[:ruby] }.join
+    end
+
+    def count(tanka: false)
+      words_hash_without_symbol = @parsed_morphemes.reject{ Utanone::Uta::EXCLUDING_COUNTING_LEXICAL_CATEGORIES.include?(_1[:lexical_category]) }
+      count_size = 0
+      words_hash_without_symbol.each do |h|
+        if tanka
+          # tanka オプションを入れた場合は ァ|ィ|ォ|ャ|ュ|ョ は音数に数えない
+          count_size += h[:ruby].size - h[:ruby].scan(Utanone::Uta::EXCLUDING_COUNTING_RUBY_BY_TANKA).size
+        else
+          count_size += h[:ruby].size
+        end
+      end
+      count_size
+    end
+
+    def correct(correct_yomigana:) # rubocop:disable Metrics/AbcSize
+      return self if yomigana == correct_yomigana
+
+      # 訂正したよみがなで再作成したUtaインスタンスを作成するので、一旦コピーする
+      corrected_uta = Uta.new(@original_str)
+
+      corrected_uta.parsed_morphemes.each_with_index do |morpheme, i|
+        # 形態素ごとによみがなの修正が必要であれば修正する
+        if correct_yomigana[0, morpheme[:ruby].size] == morpheme[:ruby]
+          # よみがなが一致したらそのまま処理を続行する
+          # 比較したよみがな部分は訂正済みよみがなから削除する
+          correct_yomigana.slice!(0, morpheme[:ruby].size)
+          next
+        else
+          # よみがなが不一致なら修正する
+          next_morpheme = corrected_uta.parsed_morphemes[i + 1]
+          if next_morpheme
+            # 修正済みよみがなから次の形態素に一致する箇所を探すことで修正したい形態素のよみがなを取得する
+            next_morpheme_start = correct_yomigana.index(next_morpheme[:ruby])
+
+            # 一致箇所がなければ修正ができないものとして処理を中断する（よみがな不一致が連続すると修正できない）
+            # TODO: 再帰を使って連続したよみがな不一致も修正できないか
+            break unless next_morpheme_start
+
+            # 取得できた場合は修正する
+            morpheme[:ruby] = correct_yomigana[0, next_morpheme_start]
+            correct_yomigana.slice!(0, morpheme[:ruby].size)
+          else
+            # 最後の形態素だった時
+            morpheme[:ruby] = correct_yomigana
+          end
+        end
+      end
+      corrected_uta
+    end
+
+    private
+
+    def parse_to_hash(str, ref_uta)
+      parsed_str_enum = natto.enum_parse(conversion_number(str))
+
+      parsed_str_enum.each_with_object([]) do |result, array|
+        next if result.is_eos?
+
+        morpheme = separated_element(result)
+
+        if ref_uta
+          # ref_utaとして参照するUtaオブジェクトが渡されている場合は読みを参照するUtaオブジェクトから取得する
+          ref_morpheme = ref_uta.parsed_morphemes.find { _1[:word] == morpheme[:word] }
+          morpheme[:ruby] = ref_morpheme[:ruby] if ref_morpheme
+        end
+
+        raise Utanone::ParseError unless morpheme[:ruby]
+
+        array << morpheme
+      end
+    rescue Natto::MeCabError
+      raise Utanone::ParseError
+    end
+
+    def conversion_number(str)
+      # 半角数字を全角数字にしないと読みが取れないので変換する
+      str.tr('0-9a-zA-Z', '０-９ａ-ｚＡ-Ｚ')
+    end
+
+    def separated_element(result)
+      # 形態素
+      word = result.surface
+
+      splited_result = result.feature.split(/\t|,/)
+
+      # 品詞
+      lexical_category = splited_result[0]
+
+      # 読み
+      ruby = splited_result[7]
+
+      {
+        word: word,
+        ruby: ruby,
+        lexical_category: lexical_category
+      }
+    end
+
+    def natto
+      @natto ||= Natto::MeCab.new
+    end
+  end
+end

data/lib/utanone/utanone.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+require_relative 'uta'
+module Utanone
+  class ParseError < StandardError; end
+end

data/lib/utanone/version.rb

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

data/utanone.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/utanone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'utanone'
+  spec.version       = Utanone::VERSION
+  spec.authors       = ['yuriko1211']
+  spec.email         = ['yuriko11d@gmail.com']
+
+  spec.summary       = 'Utanone is a helper that counts the number of sounds in Japanese sentences.'
+  spec.description   = 'Utanone is a helper that counts the number of sounds in Japanese sentences.'
+  spec.homepage      = 'https://github.com/yuriko1211/utanone'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yuriko1211/utanone'
+  spec.metadata['changelog_uri'] = 'https://github.com/yuriko1211/utanone/blob/main/CHANGELOG.md'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mecab', '~> 0.996'
+  spec.add_dependency 'natto', '~> 1.2.0'
+
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: utanone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yuriko1211
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mecab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.996'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.996'
+- !ruby/object:Gem::Dependency
+  name: natto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Utanone is a helper that counts the number of sounds in Japanese sentences.
+email:
+- yuriko11d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/utanone/uta.rb
+- lib/utanone/utanone.rb
+- lib/utanone/version.rb
+- utanone.gemspec
+homepage: https://github.com/yuriko1211/utanone
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yuriko1211/utanone
+  source_code_uri: https://github.com/yuriko1211/utanone
+  changelog_uri: https://github.com/yuriko1211/utanone/blob/main/CHANGELOG.md
+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.2.15
+signing_key:
+specification_version: 4
+summary: Utanone is a helper that counts the number of sounds in Japanese sentences.
+test_files: []