YaLoremJa

簡易版日本語 lorem です。

Installation

Add this line to your application's Gemfile:

gem 'ya_lorem_ja'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ya_lorem_ja

Usage

require 'ya_lorem_ja'

lorem = YaLoremJa::Lorem.new

# puts a word.
puts lorem.word

# puts ten words.
puts lorem.words(10)

# puts a sentence.
puts lorem.sentence

# puts three sentences.
puts lorem.sentences(3)

# puts a paragraph.
puts lorem.paragraph

# puts five paragraphs.
puts lorem.paragraphs(5)

Interface

Middleman の lorem のインターフェースを参考にしています。

実装しているインターフェースは以下です。

word
words(num_of_words)
sentence
sentences(num_of_sentces)
paragraph(options={})
paragraphs(num_of_paragraph, options={})
date(format)
image(size, options={})

実装

日本語 lorem の簡易版であるため、自然言語処理は一切していません。文を最小単位とした文章リソースから、指定された文字数に収まる文を選択しています。

そのため、 word(or words) が指定された場合は、1単語あたり2〜6文字(コンストラクタで変更可)の範囲でランダムに文字数を決定し、その文字数に収まる文を選択しています。ただし、 word(or words)の場合は、選択した文末に句点が存在する場合、文末の句点を削除します。

sentence(or sentence)が指定された場合は、1文あたり6〜15単語(コンストラクタで変更可)の範囲でランダムに単語数を決定し、単語数×単語の文字数に収まる文を選択しています。複数文(例: sentences(3))を指定した場合は、改行文字(デフォルト "\n", line_breakプロパティで変更可)で各文を結合します。

paragraph(or paragraphs)が指定された場合は、1段落あたり2〜5文(コンストラクタで変更可)の範囲でランダムに文数を決定し、文を選択します。段落の前後に設定するセパレータを、オプション引数の開始セパレータ(:start_sep), 終了セパレータ(:end_sep) で指定できます。 (デフォルトは、開始セパレータは空文字で、終了セパレータは2つ分の改行文字になります。)

文章リソース

文章リソースとして、以下を収録しています。デフォルトでは坂口安吾「風博士」が使用されます。

文書リソースの指定方法は以下になります。

require 'ya_lorem_ja'
# 坂口安吾「風博士」 を使用する場合
lorem_kazehakase = YaLoremJa::Lorem.new
# or 
lorem_kazehakase = YaLoremJa::Lorem.new(:kazehakase)

# 宮沢賢治「注文の多い料理店」を使用する場合
lorem_ryouriten = YaLoremJa::Lorem.new(:chuumon_no_ooi_ryouriten)

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request