バージョン:2.7.0 > 種類:ライブラリ | るりまサーチ (Ruby 2.7.0)

日本語文字コードの変換を手軽に行うためのライブラリです。

kconv を require すると String クラスに変換用のメソッドが定義されます。
Kconv にも同等のメソッドが定義されます。 Kconv には
エンコーディングを表す定数も定義されています。

1.9.1 以降では、Ruby の m17n 機能を用いてエンコーディングの変換を
行うことができます。1.8 との互換性が問題でないのならば、
m17n 機能を使うほうがよいでしょう。MIMEのデコード等面倒な問題を
避けることができます。

=== 使用例

//emlist[][ruby]{
require 'kconv...

logger (4.0)

2.7.0

ライブラリ

ログを記録するためのライブラリです。

ログを記録するためのライブラリです。

=== 説明

6段階のログレベルに分けてログを記録します。

: UNKNOWN
常に記録されるべき不明なエラー
: FATAL
プログラムをクラッシュさせるような制御不可能なエラー
: ERROR
制御可能なエラー
: WARN
警告
: INFO
一般的な情報
: DEBUG
低レベルの情報

全てのメッセージは必ずログレベルを持ちます。また Logger オブジェクトも同じように
ログレベルを持ちます。メッセージのログレベルが Logger オブジェクトのログレベルよりも
低い場合メッセージは記録されません。

普段は I...

絞り込み条件を変える

matrix (4.0)

2.7.0

ライブラリ

行列と数ベクトルを扱うためのライブラリです。

行列と数ベクトルを扱うためのライブラリです。

行列、ベクトルの各要素には Ruby の任意の数オブジェクト(Numeric の
サブクラス、Float, Integer, Complex, Rational など)
が使えます。

minitest/autorun (4.0)

2.7.0

ライブラリ

このファイルを Kernel.#require するとテストが test/unit と同じように自動実行されます。

minitest/mock (4.0)

2.7.0

ライブラリ

シンプルなモックライブラリです。

シンプルなモックライブラリです。

このライブラリはbundled gem(gemファイルのみを同梱)です。詳しい内容は下
記のページを参照してください。

* rubygems.org: https://rubygems.org/gems/minitest
* プロジェクトページ: https://github.com/seattlerb/minitest
* リファレンス: https://www.rubydoc.info/gems/minitest

minitest/spec (4.0)

2.7.0

ライブラリ

BDD 風にテストを書くためのクラスやメソッドを定義するためのライブラリです。

BDD 風にテストを書くためのクラスやメソッドを定義するためのライブラリです。

このライブラリはbundled gem(gemファイルのみを同梱)です。詳しい内容は下
記のページを参照してください。

* rubygems.org: https://rubygems.org/gems/minitest
* プロジェクトページ: https://github.com/seattlerb/minitest
* リファレンス: https://www.rubydoc.info/gems/minitest

minitest/unit (4.0)

2.7.0

ライブラリ

ユニットテストを行うためのライブラリです。

ユニットテストを行うためのライブラリです。

このライブラリはbundled gem(gemファイルのみを同梱)です。詳しい内容は下
記のページを参照してください。

* rubygems.org: https://rubygems.org/gems/minitest
* プロジェクトページ: https://github.com/seattlerb/minitest
* リファレンス: https://www.rubydoc.info/gems/minitest

絞り込み条件を変える

mkmf (4.0)

2.7.0

ライブラリ

Ruby の拡張ライブラリのための Makefile を作成するライブラリです。

...す。
このための extconf.rb は以下のように書きます。

require 'mkmf'

dir_config('bar')
if have_header('bar.h') and have_library('bar', 'baz')
create_makefile('foo')
end

拡張ライブラリ foo.so を作成、インストールするには以下のようにします...

monitor (4.0)

2.7.0

ライブラリ

スレッドの同期機構としてのモニター機能を提供するクラスです。また同じスレッドから何度も lock できる Mutex としての機能も提供します。

スレッドの同期機構としてのモニター機能を提供するクラスです。
また同じスレッドから何度も lock できる Mutex としての機能も提供します。

モニターとは、一つの Mutex とそれに関連付けられた複数の
条件変数から構成された、スレッドの同期機構です。
Mutex と条件変数によって同等の機能を実現することは
可能ですが、モニタの利点はライブラリがその関連を保証
していることです。

monitor は以下のような Thread::Mutex としての機能も提供します。
* lock の持ち主がスレッドである Mutex / 何度も lock できる Mutex
* l...

mutex_m (4.0)

2.7.0

ライブラリ

スレッド同期機構である Mutex のモジュール版を提供するライブラリです。

net/ftp (4.0)

2.7.0

ライブラリ

FTP プロトコルを扱うライブラリです。

FTP プロトコルを扱うライブラリです。

基本的には unix の ftp コマンドのような
command-line interface の FTP クライアントを使ったことのある
人にとってわかりやすいインターフェースになっています。
より「Ruby 的」であるインターフェースも用意しています。

FTP については 959、3659 を参考にしてください。

=== バイナリモードとテキストモード
FTP のデータ転送にはテキストモードとバイナリモード
があります。テキストモードで転送する場合には
改行を適宜CRLFに変換します。バイナリモードの場合は
一切の変換をしません。

通常...

net/http (4.0)

2.7.0

ライブラリ

汎用データ転送プロトコル HTTP を扱うライブラリです。実装は 2616 に基きます。

汎用データ転送プロトコル HTTP を扱うライブラリです。
実装は 2616 に基きます。

=== 使用例

==== ウェブサーバからドキュメントを得る (GET)

//emlist[例1: GET して表示するだけ][ruby]{
require 'net/http'
print Net::HTTP.get('www.example.com', '/index.html')
//}

//emlist[例2: URI を使う][ruby]{
require 'net/http'
require 'uri'
print Net::HTTP.get(URI.parse('http://w...

絞り込み条件を変える

net/https (4.0)

2.7.0

ライブラリ

このライブラリは Ruby 1.9.2 で net/http にマージされました。そちらを使ってください。

このライブラリは Ruby 1.9.2 で net/http にマージされました。
そちらを使ってください。

net/imap (4.0)

2.7.0

ライブラリ

このライブラリは Internet Message Access Protocol (IMAP) のクライアントライブラリです。2060 を元に実装されています。

このライブラリは Internet Message Access Protocol (IMAP) の
クライアントライブラリです。2060 を元に
実装されています。

=== IMAP の概要

IMAPを利用するには、まずサーバに接続し、
Net::IMAP#authenticate もしくは
Net::IMAP#login で認証します。
IMAP ではメールボックスという概念が重要です。
メールボックスは階層的な名前を持ちます。
各メールボックスはメールを保持することができます。
メールボックスの実装はサーバソフトウェアによって異なります。
Unixシステムでは、ディレクトリ階層上の
...

net/pop (4.0)

2.7.0

ライブラリ

このライブラリは、POP3 (Post Office Protocol version 3) を用いてPOPサーバからメールを受信する機能を提供するライブラリです。

このライブラリは、POP3 (Post Office Protocol version 3) を
用いてPOPサーバからメールを受信する機能を提供するライブラリです。

POP3 の実装は 1939 に基いています。

2449 で定義されているPOP3拡張には対応していません。
=== 使用例

==== メールの受信

以下のコードは、メールを受信してファイル 'inbox/1' 'inbox/2'... に
書きこみ、サーバ上からメールを消します。

'pop.example.com' は適当なPOP3のサーバのホスト名に、
'YourAccount' と 'YourPassword' ...

net/protocol (4.0)

2.7.0

ライブラリ

ネットワークライブラリ共通の例外クラスを定義しています。

ネットワークライブラリ共通の例外クラスを
定義しています。

net/http や net/pop などでこのライブラリで
定義された例外クラスやそれらを継承した例外クラスを
利用しています。

net/smtp (4.0)

2.7.0

ライブラリ

メールを送信するためのプロトコル SMTP (Simple Mail Transfer Protocol) を扱うライブラリです。

メールを送信するためのプロトコル SMTP (Simple Mail Transfer Protocol)
を扱うライブラリです。

ヘッダなどメールのデータを扱うことはできません。
SMTP の実装は 2821 に基いています。

=== 使用例

==== とにかくメールを送る

SMTP を使ってメールを送るにはまず SMTP.start でセッションを開きます。
第一引数がサーバのアドレスで第二引数がポート番号です。
ブロックを使うと File.open と同じように終端処理を自動的にやってくれる
のでおすすめです。

require 'net/smtp'
Net::SMTP....

絞り込み条件を変える

net/telnet (4.0)

2.7.0

ライブラリ

Telnet プロトコルをクライアント側で扱うライブラリです。

Telnet プロトコルをクライアント側で扱うライブラリです。

このライブラリはbundled gem(gemファイルのみを同梱)です。詳しい内容は下
記のページを参照してください。

* rubygems.org: https://rubygems.org/gems/net-telnet
* プロジェクトページ: https://github.com/ruby/net-telnet
* リファレンス: https://www.rubydoc.info/gems/net-telnet

nkf (4.0)

2.7.0

ライブラリ

nkf を Ruby から使うためのライブラリです。

objspace (4.0)

2.7.0

ライブラリ

このライブラリは ObjectSpace を拡張してオブジェクトやメモリ管理についての統計情報を取得するメソッドをいくつか追加します。

このライブラリは ObjectSpace を拡張してオブジェクトやメモリ管理についての
統計情報を取得するメソッドをいくつか追加します。

MRI の実装について詳しくない一般のユーザはこのライブラリを使ってはいけません。
このライブラリは、メモリプロファイラの開発者や MRI がどのようにメモリを使用するか
知りたい MRI 開発者が使用します。

observer (4.0)

2.7.0

ライブラリ

Observer パターンを扱うためのライブラリです。

open-uri (4.0)

2.7.0

ライブラリ

http/ftp に簡単にアクセスするためのクラスです。

http/ftp に簡単にアクセスするためのクラスです。

=== 使用例

http/ftp の URL を、普通のファイルのように開けます。

require 'open-uri'
URI.open("http://www.ruby-lang.org/") {|f|
f.each_line {|line| p line}
}

開いたファイルオブジェクトは StringIO もしくは Tempfile で
すが OpenURI::Meta モジュールで拡張されていて、メタ情報を獲得する
メソッドが使えます。

require 'open-uri'
URI.ope...

絞り込み条件を変える

open3 (4.0)

2.7.0

ライブラリ

プログラムを実行し、そのプロセスの標準入力・標準出力・標準エラー出力にパイプをつなぎます。

プログラムを実行し、そのプロセスの標準入力・標準出力・
標準エラー出力にパイプをつなぎます。

openssl (4.0)

2.7.0

ライブラリ

OpenSSL(https://www.openssl.org/) を Ruby から扱うためのライブラリです。

OpenSSL(https://www.openssl.org/)
を Ruby から扱うためのライブラリです。

このドキュメントでは SSL/TLS の一般的事項については
解説をしません。利用者は、SSL/TLSの各概念、例えば
以下の事項について理解している必要があります。
* 暗号と認証に関する一般的概念
* セキュリティに対する攻撃法
* 公開鍵暗号と秘密鍵暗号
* 署名の役割、署名の方法とその検証
* 公開鍵基盤(PKI, Public Key Infrastructure)
* X.509 証明書
* 暗号と乱数について
SSLのようなセキュリティ技...

optparse (4.0)

2.7.0

ライブラリ

コマンドラインのオプションを取り扱うためのライブラリです。

コマンドラインのオプションを取り扱うためのライブラリです。

=== チュートリアル

optparse を使う場合、基本的には

(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブロックを opt に登録する。
(3) opt.parse(ARGV) でコマンドラインを実際に parse する。

というような流れになります。

* optiondef
* optionarg
* longoption
* help
* subcmd
* argv
* hyphen_start_file

====[a:optiondef]...

optparse/date (4.0)

2.7.0

ライブラリ

OptionParser#on で使用可能なクラスに Date と DateTime が追加されます。オプションの引数はそれぞれのクラスのインスタンスに変換されてから、 OptionParser#on のブロックに渡されます。

OptionParser#on で使用可能なクラスに Date と DateTime が
追加されます。
オプションの引数はそれぞれのクラスのインスタンスに変換されてから、
OptionParser#on のブロックに渡されます。

//emlist[][ruby]{
require 'optparse/date'
opts = OptionParser.new

opts.on("-d DATE", Date){|d|
p d.to_s #=> 2000-01-01
}
opts.parse!

# ruby command -d 2000/1/1
//}

optparse/shellwords (4.0)

2.7.0

ライブラリ

OptionParser#on で使用可能な引数に Shellwords 追加されます。オプションの引数は Shellwords.#shellwords によって配列に変換されてから、 OptionParser#on のブロックに渡されます。

OptionParser#on で使用可能な引数に Shellwords
追加されます。
オプションの引数は Shellwords.#shellwords によって配列に変換されてから、
OptionParser#on のブロックに渡されます。

//emlist[][ruby]{
require 'optparse/shellwords'
opts = OptionParser.new

opts.on("-s VAL", Shellwords){|a|
p a #=> ["hoge", "foo", "bar"]
}
opts.parse!

# ruby command -s hog...

絞り込み条件を変える

optparse/time (4.0)

2.7.0

ライブラリ

OptionParser#on で使用可能なクラスに Time が追加されます。オプションの引数は Time クラスのインスタンスに変換されてから、 OptionParser#on のブロックに渡されます。

OptionParser#on で使用可能なクラスに Time が
追加されます。
オプションの引数は Time クラスのインスタンスに変換されてから、
OptionParser#on のブロックに渡されます。

//emlist[][ruby]{
require 'optparse/time'
opts = OptionParser.new

opts.on("-t TIME", Time){|t|
p t #=> Sat, Jan 01 2000 00:00:00 +0900
}
opts.parse!

# ruby command -t '2000/01/01 00:00'
//}...

optparse/uri (4.0)

2.7.0

ライブラリ

OptionParser#on で使用可能なクラスに URI が追加されます。オプションの引数は URI クラスのインスタンスに変換されてから、 OptionParser#on のブロックに渡されます。

OptionParser#on で使用可能なクラスに URI が
追加されます。
オプションの引数は URI クラスのインスタンスに変換されてから、
OptionParser#on のブロックに渡されます。

//emlist[][ruby]{
require 'optparse/uri'
opts = OptionParser.new

opts.on("-u URI", URI){|u|
p u #=> #<URI::HTTP:0x201267d4 URL:http://www.example.com>
}
opts.parse!

# ruby command -u http://w...

ostruct (4.0)

2.7.0

ライブラリ

要素を動的に追加・削除できる手軽な構造体を提供するライブラリです。

pathname (4.0)

2.7.0

ライブラリ

パス名をオブジェクト指向らしく扱うためのライブラリです。

power_assert (4.0)

2.7.0

ライブラリ

Ruby向けのPower Assertを提供するライブラリです。

Ruby向けのPower Assertを提供するライブラリです。

このライブラリはbundled gem(gemファイルのみを同梱)です。詳しい内容は下
記のページを参照してください。

* rubygems.org: https://rubygems.org/gems/power_assert
* プロジェクトページ: https://github.com/k-tsj/power_assert
* リファレンス: https://www.rubydoc.info/gems/power_assert

絞り込み条件を変える

pp (4.0)

2.7.0

ライブラリ

オブジェクトなどを見やすく出力するためのライブラリです。

オブジェクトなどを見やすく出力するためのライブラリです。

pp ライブラリは、ユーザがあたらしく定義したクラスに対しても見やすい表示を
するように作られていますので、Kernel.#pp を使う上で余計な作業をする
必要はありません。

=== どちらが読みやすいでしょうか?

p による pretty-print されてない出力:
#<PP:0x81a0d10 @stack=[], @genspace=#<Proc:0x81a0cc0>, @nest=[0], @newline="\n",
@buf=#<PrettyPrint::Group:0x81a0c98 @group=0,...

prettyprint (4.0)

2.7.0

ライブラリ

pretty printing アルゴリズムのためのライブラリです。

pretty printing アルゴリズムのためのライブラリです。

=== 使い方

pretty printing アルゴリズムは読みやすいインデントと改行を決定するためのアルゴリズムです。
インデントと改行はユーザによって与えられたツリー構造から決定されます。
つまりユーザは以下のように表示したい内容を保持したツリーを作成する必要があります。

* PrettyPrint.new でバッファを生成します。このとき、バッファの幅と改行文字を指定します。
* PrettyPrint#text を使って、文字列を適宜挿入します。
* PrettyPrint#group を使って子ノー...

prime (4.0)

2.7.0

ライブラリ

素数や素因数分解を扱うライブラリです。

素数や素因数分解を扱うライブラリです。

ライブラリの中心にあるのは Prime クラスで、これは素数全体を表すシングルトンです。また、素数性と素因数分解に関するメソッドを Integer に追加します。
さらに、 Prime クラスの機能を実現するための低水準のクラスも幾つか提供されています。

//emlist[例][ruby]{
require 'prime'

Prime.each(100) do |prime|
p prime #=> 2, 3, 5, 7, 11, ..., 97
end

2.prime? #=> true
4.prime? #=> false
//}

==...

pstore (4.0)

2.7.0

ライブラリ

Rubyのオブジェクトを外部ファイルに格納するためのライブラリです。

psych (4.0)

2.7.0

ライブラリ

yaml のバックエンドライブラリです。libyaml ベースで作成されており、YAML バージョン 1.1 を扱う事ができます。

yaml のバックエンドライブラリです。libyaml ベースで作成されてお
り、YAML バージョン 1.1 を扱う事ができます。

=== 概要

Psych を用いると YAML のパースと出力ができます。
これらの機能は libyaml http://pyyaml.org/wiki/LibYAML を用いて
実装されています。さらに Ruby の大半のオブジェクトと YAML フォーマットの
データの間を相互に変換することができます。

=== 基本的な使いかた

//emlist[][ruby]{
require 'psych'
# YAML のテキストをパースする
Psych.l...

絞り込み条件を変える

pty (4.0)

2.7.0

ライブラリ

擬似端末(Pseudo tTY)を扱うライブラリです。

racc/parser (4.0)

2.7.0

ライブラリ

パーサジェネレータ Racc のランタイムライブラリです。

rake (4.0)

2.7.0

ライブラリ

Rake というコマンドラインツールを扱うライブラリです。

Rake というコマンドラインツールを扱うライブラリです。

=== Rake とは

Rake は Make によく似た機能を持つ Ruby で書かれたシンプルなビルドツールです。

Rake は以下のような特徴を持っています。

* Rakefile (Rake における Makefile) は標準的な Ruby の文法で書くことができます。
XML ファイルを編集する必要はありませんし、Makefile の風変わりな文法 (タブだっけ？スペースだっけ？) に頭を悩ませる必要もありません。
* ユーザは必須条件をタスクに指定できます。
* Rake は暗黙のタスクを合成...

rake/classic_namespace (4.0)

2.7.0

ライブラリ

このライブラリは古い Rakefile を使用する場合のみ使用してください。

このライブラリは古い Rakefile を使用する場合のみ使用してください。

以下の定数が定義されます。

* Task = Rake::Task
* FileTask = Rake::FileTask
* FileCreationTask = Rake::FileCreationTask
* RakeApp = Rake::Application

rake/clean (4.0)

2.7.0

ライブラリ

このライブラリは Rake タスクを定義しています。

このライブラリは Rake タスクを定義しています。

二つのファイルリストと二つのタスクを定義します。

: CLEAN
clean ターゲットで削除するファイルリストです。

: clean
バックアップファイルを削除します。
CLEAN というファイルリストにパターンを追加するとそのファイルを削除します。

: CLOBBER
clobber ターゲットで削除するファイルリストです。

: clobber
自動生成されたファイルと clean ターゲットで削除されるファイルを削除します。
このターゲットは clean ターゲットに依存しています。
CLOBBE...

絞り込み条件を変える

rake/gempackagetask (4.0)

2.7.0

ライブラリ

Gem Spec ファイルを元にして Gem パッケージを作成するタスクを定義するためのライブラリです。

Gem Spec ファイルを元にして Gem パッケージを作成するタスクを定義するためのライブラリです。

Gem パッケージだけでなく zip, tgz, tar.gz, tar.bz2 の各ファイルを作成する事もできます。

以下のタスクを定義します。

: PACKAGE_DIR/NAME-VERSION.gem
Gem パッケージを作成します。

例:
require 'rubygems'

spec = Gem::Specification.new do |s|
s.platform = Gem::Platform::RUBY
s.summa...

rake/loaders/makefile (4.0)

2.7.0

ライブラリ

Makefile をロードするためのライブラリです。

rake/packagetask (4.0)

2.7.0

ライブラリ

配布するパッケージ (zip, tar, etc...) を作成するためのタスクを定義します。

配布するパッケージ (zip, tar, etc...) を作成するためのタスクを定義します。

このライブラリをロードすると以下のタスクが使用可能になります。

: package
パッケージを作成します。
: clobber_package
作成したパッケージを削除します。このタスクは clobber タスクにも追加されます。
: repackage
パッケージが古くない場合でもパッケージを再作成します。
: PACKAGE_DIR/NAME-VERSION.tgz
Rake::PackageTask#need_tar が真の場合 gzip された tar パッケージを作成...

rake/rake_test_loader (4.0)

2.7.0

ライブラリ

このライブラリを require すると、コマンドラインからテスト対象のファイルをロードします。

このライブラリを require すると、
コマンドラインからテスト対象のファイルをロードします。

rake/rdoctask (4.0)

2.7.0

ライブラリ

ドキュメントを作成するためのタスクを定義します。

ドキュメントを作成するためのタスクを定義します。

以下のタスクを定義します。

: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。

例:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
...

絞り込み条件を変える

rake/runtest (4.0)

2.7.0

ライブラリ

rake/tasklib (4.0)

2.7.0

ライブラリ

タスクのライブラリを作成するためのベースとなるクラスを扱うライブラリです。

rake/testtask (4.0)

2.7.0

ライブラリ

ユニットテストを実行するためのタスクを定義するライブラリです。

rbconfig (4.0)

2.7.0

ライブラリ

Ruby インタプリタ作成時に設定された情報を格納したライブラリです。

rbconfig/sizeof (4.0)

2.7.0

ライブラリ

Ruby インタプリタが作成された環境における、データ型のサイズなどに関する情報を格納したライブラリです。

絞り込み条件を変える

rdoc (4.0)

2.7.0

ライブラリ

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc というドキュメント生成のためのコマンドも含んでいます。

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ...

rdoc/alias (4.0)

2.7.0

ライブラリ

RDoc::Alias を定義するサブライブラリです。

rdoc/anon_class (4.0)

2.7.0

ライブラリ

RDoc::AnonClass を定義するサブライブラリです。

rdoc/any_method (4.0)

2.7.0

ライブラリ

RDoc::AnyMethod を定義するサブライブラリです。

rdoc/attr (4.0)

2.7.0

ライブラリ

RDoc::Attr を定義するサブライブラリです。

絞り込み条件を変える

rdoc/class_module (4.0)

2.7.0

ライブラリ

RDoc::ClassModule を定義するサブライブラリです。

rdoc/code_object (4.0)

2.7.0

ライブラリ

RDoc::CodeObject を定義するサブライブラリです。

rdoc/code_objects (4.0)

2.7.0

ライブラリ

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を表現するためのサブライブラリです。

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。

rdoc/constant (4.0)

2.7.0

ライブラリ

RDoc::Constant を定義するサブライブラリです。

rdoc/context (4.0)

2.7.0

ライブラリ

RDoc::Context と RDoc::Context::Section を定義するサブライブラリです。

RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。

絞り込み条件を変える

rdoc/generator (4.0)

2.7.0

ライブラリ

RDoc が解析したソースコードを RDoc::CodeObject のツリーからその他の形式に出力するためのサブライブラリです。

RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。

RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属しています。

=== ジェネレータの登録

RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。

class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
...

rdoc/generator/darkfish (4.0)

2.7.0

ライブラリ

HTML を生成するためのサブライブラリです。

rdoc/generator/json_index (4.0)

2.7.0

ライブラリ

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデックスを生成するサブライブラリです。

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するサブライブラリです。

This generator is derived from sdoc by Vladimir Kolesnikov and
contains verbatim code written by him.

このジェネレータは HTML ジェネレータと一緒に使うために設計されています。:

class RDoc::Generator::Darkfish
def initialize options
# ...
@base_dir = Pa...

rdoc/generator/markup (4.0)

2.7.0

ライブラリ

ライブラリ内部で使用します。

rdoc/generator/ri (4.0)

2.7.0

ライブラリ

ri のためのファイルを生成するためのサブライブラリです。

絞り込み条件を変える

rdoc/ghost_method (4.0)

2.7.0

ライブラリ

RDoc::GhostMethod を定義するサブライブラリです。

rdoc/include (4.0)

2.7.0

ライブラリ

RDoc::Include を定義するサブライブラリです。

rdoc/known_classes (4.0)

2.7.0

ライブラリ

Ruby の組み込みクラスに関する定数を定義するサブライブラリです。

rdoc/markdown (4.0)

2.7.0

ライブラリ

Markdown 形式で記述されたドキュメントを rdoc 上で解析するためのサブライブラリです。

Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。

詳しくは以下を参照してください。

* https://daringfireball.net/projects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考にプロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな...

rdoc/markdown/entities (4.0)

2.7.0

ライブラリ

HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。

絞り込み条件を変える

rdoc/markup (4.0)

2.7.0

ライブラリ

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン...

rdoc/markup/formatter (4.0)

2.7.0

ライブラリ

RDoc 形式のドキュメントを整形するためのサブライブラリです。

rdoc/markup/to_ansi (4.0)

2.7.0

ライブラリ

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライブラリです。

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。

require 'rdoc/markup/to_ansi'

h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

rdoc/markup/to_bs (4.0)

2.7.0

ライブラリ

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効果を持たせるように見せるサブライブラリです。

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。

require 'rdoc/markup/to_bs'

h = RDoc::Markup::ToBs.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。

テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。

* イタリック体(_word_): word にアンダーラインを付けて...

rdoc/markup/to_html (4.0)

2.7.0

ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

絞り込み条件を変える

rdoc/markup/to_html_crossref (4.0)

2.7.0

ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。

rdoc/markup/to_rdoc (4.0)

2.7.0

ライブラリ

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるためのサブライブラリです。

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。

rdoc/meta_method (4.0)

2.7.0

ライブラリ

RDoc::MetaMethod を定義するサブライブラリです。

rdoc/normal_class (4.0)

2.7.0

ライブラリ

RDoc::NormalClass を定義するサブライブラリです。

rdoc/normal_module (4.0)

2.7.0

ライブラリ

RDoc::NormalModule を定義するサブライブラリです。

絞り込み条件を変える

rdoc/options (4.0)

2.7.0

ライブラリ

rdoc コマンドのオプションを解析するためのサブライブラリです。

rdoc/parser (4.0)

2.7.0

ライブラリ

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。

* #initialize(top_level, file_name, body, options, stats)
* #scan

initialize メソッドは以下の引数を受け取ります。

* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
*...

rdoc/parser/c (4.0)

2.7.0

ライブラリ

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメントを解析するためのサブライブラリです。

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのサブライブラリです。

C 言語で記述された拡張ライブラリなどを解析するのに使用します。
rb_define_class や rb_define_method などで定義されたものに
対応する C 言語の関数のコメントを解析します。

例: Array#flatten の場合。rb_ary_flatten のコメントが解析されます。

/*
* Returns a new array that is a one-dimensional flattening of this
* arra...

rdoc/parser/changelog (4.0)

2.7.0

ライブラリ

ChangeLog ファイルを解析するためのサブライブラリです。

ChangeLog ファイルを解析するためのサブライブラリです。

ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。

このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。

rdoc/parser/markdown (4.0)

2.7.0

ライブラリ

Markdown 形式で記述されたファイルを解析するためのサブライブラリです。

絞り込み条件を変える

rdoc/parser/rd (4.0)

2.7.0

ライブラリ

RD 形式で記述されたファイルを解析するためのサブライブラリです。

rdoc/parser/ruby (4.0)

2.7.0

ライブラリ

Ruby のソースコードを解析するためのサブライブラリです。

Ruby のソースコードを解析するためのサブライブラリです。

拡張子が .rb、.rbw のファイルを解析する事ができます。

=== メタプログラミングされたメソッド

動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。...

rdoc/parser/ruby_tools (4.0)

2.7.0

ライブラリ

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコードのパーサを記述するためのモジュールを定義するサブライブラリです。

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。

rdoc/parser/simple (4.0)

2.7.0

ライブラリ

ソースコード以外のファイルを解析するためのサブライブラリです。

ソースコード以外のファイルを解析するためのサブライブラリです。

ファイルの内容すべてを 1 つの大きなコメントとして処理します。ただし、ファ
イルの先頭が # で始まっていた場合、先頭行は削除されます。

rdoc/parser/text (4.0)

2.7.0

ライブラリ

プログラムを含まないテキストを解析するためのサブライブラリです。

絞り込み条件を変える

<< < 1 2 3 4 > >>

キーワード

検索結果

先頭5件

json/add/ostruct (4.0)

json/add/range (4.0)

json/add/rational (4.0)

json/add/regexp (4.0)

json/add/struct (4.0)

json/add/symbol (4.0)

json/add/time (4.0)

json/editor (4.0)

kconv (4.0)

logger (4.0)

matrix (4.0)

minitest/autorun (4.0)

minitest/mock (4.0)

minitest/spec (4.0)

minitest/unit (4.0)

mkmf (4.0)

monitor (4.0)

mutex_m (4.0)

net/ftp (4.0)

net/http (4.0)

net/https (4.0)

net/imap (4.0)

net/pop (4.0)

net/protocol (4.0)

net/smtp (4.0)

net/telnet (4.0)

nkf (4.0)

objspace (4.0)

observer (4.0)

open-uri (4.0)

open3 (4.0)

openssl (4.0)

optparse (4.0)

optparse/date (4.0)

optparse/shellwords (4.0)

optparse/time (4.0)

optparse/uri (4.0)

ostruct (4.0)

pathname (4.0)

power_assert (4.0)

pp (4.0)

prettyprint (4.0)

prime (4.0)

pstore (4.0)

psych (4.0)

pty (4.0)

racc/parser (4.0)

rake (4.0)

rake/classic_namespace (4.0)

rake/clean (4.0)

rake/gempackagetask (4.0)

rake/loaders/makefile (4.0)

rake/packagetask (4.0)

rake/rake_test_loader (4.0)

rake/rdoctask (4.0)

rake/runtest (4.0)

rake/tasklib (4.0)

rake/testtask (4.0)

rbconfig (4.0)

rbconfig/sizeof (4.0)

rdoc (4.0)

rdoc/alias (4.0)

rdoc/anon_class (4.0)

rdoc/any_method (4.0)

rdoc/attr (4.0)

rdoc/class_module (4.0)

rdoc/code_object (4.0)

rdoc/code_objects (4.0)

rdoc/constant (4.0)

rdoc/context (4.0)

rdoc/generator (4.0)

rdoc/generator/darkfish (4.0)

rdoc/generator/json_index (4.0)

rdoc/generator/markup (4.0)

rdoc/generator/ri (4.0)

rdoc/ghost_method (4.0)

rdoc/include (4.0)