ライブラリ
-
irb
/ context (1) - psych (72)
-
rubygems
/ commands / build _ command (1) -
rubygems
/ commands / specification _ command (1) -
rubygems
/ config _ file (1) -
rubygems
/ exceptions (1) -
rubygems
/ package / tar _ input (1) -
rubygems
/ server (1) -
rubygems
/ specification (3) - yaml (1)
-
yaml
/ dbm (25) -
yaml
/ store (3)
クラス
-
Gem
:: Commands :: BuildCommand (1) -
Gem
:: ConfigFile (1) -
Gem
:: Package :: TarInput (1) -
Gem
:: Server (1) -
Gem
:: Specification (3) -
IRB
:: Context (1) - Object (3)
-
Psych
:: Handler (8) -
Psych
:: Nodes :: Document (3) -
Psych
:: Nodes :: Mapping (1) -
Psych
:: Nodes :: Node (3) -
Psych
:: Nodes :: Sequence (1) -
Psych
:: Parser (2) -
Psych
:: ScalarScanner (1) -
Psych
:: Stream (4) -
Psych
:: Visitors :: YAMLTree (10) -
RDoc
:: Options (1) -
YAML
:: DBM (24) -
YAML
:: Store (2)
キーワード
-
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (1) - << (1)
- Alias (1)
- BadAlias (1)
- DBM (1)
- Document (1)
- Emitter (1)
- EndOfYAMLException (1)
-
LIBYAML
_ VERSION (1) - Mapping (1)
- Mark (1)
-
NEWS for Ruby 2
. 0 . 0 (1) - Node (1)
- Nodes (1)
- Omap (1)
- Parser (1)
- Psych (1)
- Scalar (1)
- ScalarScanner (1)
- Sequence (1)
- Set (1)
- SpecificationCommand (1)
- Store (1)
- Stream (2)
- SyntaxError (1)
- TreeBuilder (1)
- VERSION (1)
- YAMLTree (1)
- [] (1)
- []= (1)
- alias (1)
- delete (1)
-
delete
_ if (1) - dump (2)
-
dump
_ stream (1) - each (1)
-
each
_ pair (1) -
each
_ value (1) -
end
_ document (1) -
end
_ stream (1) - fetch (1)
- finish (2)
- finished (1)
- finished? (1)
-
from
_ yaml (1) -
has
_ value? (1) - index (1)
-
inspect
_ mode= (1) - invert (1)
- irb (1)
- key (1)
-
libyaml
_ version (1) - load (1)
-
load
_ file (2) -
load
_ gemspec (1) -
load
_ stream (2) - new (8)
-
normalize
_ yaml _ input (1) - parse (2)
-
parse
_ file (1) -
parse
_ stream (2) - psych (1)
-
psych
_ to _ yaml (1) -
psych
_ y (1) - push (1)
- rdoc (1)
- reject (1)
- replace (1)
-
ruby 1
. 8 . 2 feature (1) - rubygems (1)
-
rubygems
/ commands / generate _ index _ command (1) -
rubygems
/ commands / mirror _ command (1) -
rubygems
/ commands / specification _ command (1) -
rubygems
/ server (1) -
safe
_ load (1) - scalar (1)
- select (2)
- shift (1)
- start (3)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - started (1)
- started? (1)
- store (1)
- tag (1)
-
to
_ a (1) -
to
_ hash (1) -
to
_ yaml (2) - tokenize (1)
- tree (1)
- update (1)
- values (1)
-
values
_ at (1) - version (1)
- version= (1)
- y (1)
- yaml (3)
-
yaml
/ dbm (1) -
yaml
/ store (1) - yaml? (1)
-
yaml
_ initialize (1) -
yaml
_ tag (1)
検索結果
先頭5件
-
YAML (114169.0)
-
YAML (YAML Ain't Markup Language) を扱うモジュールです。
YAML (YAML Ain't Markup Language) を扱うモジュールです。
YAML オブジェクトは実際は Psych オブジェクトです。その他のオブジェ
クトも同様に実体は別のオブジェクトです。もし確認したいメソッドの記述が
見つからない場合は、psych ライブラリを確認してください。
//emlist[例][ruby]{
require "yaml"
p YAML # => Psych
p YAML::Stream # => Psych::Stream
//} -
yaml (19123.0)
-
構造化されたデータを表現するフォーマットであるYAML (YAML Ain't Markup Language) を扱うためのライブラリです。
構造化されたデータを表現するフォーマットであるYAML (YAML Ain't Markup Language) を扱うためのライブラリです。
//emlist[例1: 構造化された配列][ruby]{
require 'yaml'
data = ["Taro san", "Jiro san", "Saburo san"]
str_r = YAML.dump(data)
str_l = <<~YAML_EOT
---
- Taro san
- Jiro san
- Saburo san
YAML_EOT
p str_r == str_l # => true
//}
... -
Object
# psych _ to _ yaml(options = {}) -> String (18427.0) -
オブジェクトを YAML document に変換します。
オブジェクトを YAML document に変換します。
options でオプションを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。
syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予定であるため、特別の事情がない限り to_yaml を用いてください。
@param options 出力オプション
@see Psych.dump -
Object
# to _ yaml(options = {}) -> String (18427.0) -
オブジェクトを YAML document に変換します。
オブジェクトを YAML document に変換します。
options でオプションを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。
syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予定であるため、特別の事情がない限り to_yaml を用いてください。
@param options 出力オプション
@see Psych.dump -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (18373.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (18373.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
Gem
:: Specification . from _ yaml(input) -> Gem :: Specification (18370.0) -
YAML ファイルから gemspec をロードします。
YAML ファイルから gemspec をロードします。
YAML ファイルから Gem::Specification をロードすると、通常の Ruby オブジェクトの
初期化ルーチン (#initialize) を通りません。このメソッドは初期化ルーチンの一部を実行し、
gemspec のバージョンチェックも行います。
@param input 文字列か IO オブジェクトを指定します。 -
Object
. yaml _ tag(tag) -> () (18358.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
@param tag 対象のクラスに関連付けるタグの文字列
=== Example
require 'psych'
class Foo
def initialize(x)
@x = x
end
attr_reader :x
end
# Dumps Ruby object normally
p Psych.dump(Foo.new(3))
... -
Gem
:: Commands :: BuildCommand # yaml?(filename) -> bool (18352.0) -
与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。
与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。
@param filename ファイル名を指定します。 -
Gem
:: Specification . normalize _ yaml _ input(input) -> String (18352.0) -
YAML 形式の gemspec を正しくフォーマットします。
YAML 形式の gemspec を正しくフォーマットします。
@param input 文字列か IO オブジェクトを指定します。 -
Gem
:: Server # yaml(request , response) -> () (18304.0) -
メソッド名に対応する URI に対するリクエストを処理するメソッドです。
メソッド名に対応する URI に対するリクエストを処理するメソッドです。
@param request WEBrick::HTTPRequest オブジェクトが自動的に指定されます。
@param response WEBrick::HTTPResponse オブジェクトが自動的に指定されます。 -
Gem
:: Specification # yaml _ initialize (18304.0) -
@todo
@todo -
Psych
. libyaml _ version -> [Integer , Integer , Integer] (18301.0) -
libyaml のバージョンを返します。
libyaml のバージョンを返します。
[major, minor patch-level] という 3 つの整数からなる配列を返します。
@see Psych::LIBYAML_VERSION -
Psych
:: LIBYAML _ VERSION -> String (18301.0) -
libyaml のバージョン。
libyaml のバージョン。 -
yaml
/ store (18085.0) -
RubyのオブジェクトをYAML形式の外部ファイルに格納するためのクラスです。
RubyのオブジェクトをYAML形式の外部ファイルに格納するためのクラスです。
例:
require 'yaml/store'
Person = Struct.new :first_name, :last_name
people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]
store = YAML::Store.new "test.store"
store.transaction do
store["people"] = people
store["greeting"... -
Psych
:: Visitors :: YAMLTree (18067.0) -
Ruby オブジェクトから YAML の AST を構築するためのクラスです。
Ruby オブジェクトから YAML の AST を構築するためのクラスです。
=== 例
builder = Psych::Visitors::YAMLTree.new
builder << { :foo => 'bar' }
builder << ["baz", "bazbaz"]
builder.tree # => #<Psych::Nodes::Stream ... > A stream containing two documents
puts tree.to_yaml
# =>
# ---
# :foo: bar
# ---
# - baz... -
yaml
/ dbm (18055.0) -
DBM の値に文字列以外も格納できるように拡張するためのサブライブラ リです。
DBM の値に文字列以外も格納できるように拡張するためのサブライブラ
リです。
DBM はキー、値のどちらも文字列である必要がありますが、
YAML::DBM は YAML 形式に変換できるオブジェクトであれば値として格
納する事ができます。ただし、キーは文字列である必要があります。
使い方は DBM と同じです。DBM と YAML も併せて参照して
ください。 -
Gem
:: EndOfYAMLException (18049.0) -
YAML データが不正である場合に使用する例外です。
YAML データが不正である場合に使用する例外です。 -
YAML
:: Store . new(file _ name , thread _ safe = false , yaml _ opts = {}) -> YAML :: Store (9649.0) -
自身を初期化します。
自身を初期化します。
@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。
@param thread_safe 自身をスレッドセーフにして初期化するかどうか。
@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。 -
YAML
:: Store . new(file _ name , yaml _ opts = {}) -> YAML :: Store (9649.0) -
自身を初期化します。
自身を初期化します。
@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。
@param thread_safe 自身をスレッドセーフにして初期化するかどうか。
@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。 -
Psych
:: Visitors :: YAMLTree . new(options = {} , emitter = Psych :: TreeBuilder . new , ss = Psych :: ScalarScanner . new) -> Psych :: Visitors :: YAMLTree (9337.0) -
YAMLTree オブジェクトを生成します。
YAMLTree オブジェクトを生成します。
options には構築される YAML AST に設定されるオプション設定を指定します。
Psych.dump と同じオプションが指定できます。
emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。
ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner オブジェクトを渡します。
emitter, ss は通常デフォルトのものから変える必要はないでしょう。
@param... -
YAML
:: DBM # each -> YAML :: DBM (9307.0) -
自身のキーと値を引数としてブロックを評価します。
自身のキーと値を引数としてブロックを評価します。
自身を返します。 -
YAML
:: DBM # each _ pair {|key , val| . . . } -> YAML :: DBM (9307.0) -
自身のキーと値を引数としてブロックを評価します。
自身のキーと値を引数としてブロックを評価します。
自身を返します。 -
YAML
:: DBM # delete _ if {|key , val| . . . } -> YAML :: DBM (9304.0) -
ブロックを評価した値が真であれば該当する要素を削除します。
ブロックを評価した値が真であれば該当する要素を削除します。
自身を返します。このメソッドは self を破壊的に変更します。
@raise DBMError 要素の削除に失敗した場合に発生します。 -
YAML
:: DBM # each _ value {|val| . . . } -> YAML :: DBM (9304.0) -
値を引数としてブロックを評価します。
値を引数としてブロックを評価します。
自身を返します。 -
YAML
:: DBM # replace(other) -> YAML :: DBM (9304.0) -
self の内容を other の内容で置き換えます。
self の内容を other の内容で置き換えます。
@param other Hash、DBM オブジェクトを指定します。
@raise DBMError 更新に失敗した場合に発生します。
自身を返します。 -
YAML
:: Store (9097.0) -
PStore の YAML 版です。 Marshal.#dump したバイナリ形式の 代わりに YAML 形式でファイルに保存します。
PStore の YAML 版です。
Marshal.#dump したバイナリ形式の
代わりに YAML 形式でファイルに保存します。
使い方は PStore とほとんど同じです。
インターフェースは Hash に似ています。 -
Psych
:: Visitors :: YAMLTree # start(encoding = Nodes :: Stream :: UTF8) -> Psych :: Nodes :: Stream (9067.0) -
Ruby オブジェクトから YAML AST への変換のための準備をします。
Ruby オブジェクトから YAML AST への変換のための準備をします。
Psych::Visitors::YAMLTree#push が呼び出されたとき、
まだこのメソッドが呼び出されていなければ push メソッドがこの
メソッドを呼び出し、変換の準備をします。
encoding には以下のいずれかを指定できます。
* Psych::Nodes::Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE
@param encoding YAML AST に設定するエンコーディング -
YAML
:: DBM :: VERSION -> String (9049.0) -
yaml/dbm のバージョンを文字列で返します。
yaml/dbm のバージョンを文字列で返します。 -
YAML
:: DBM # index(value) -> String | nil (9037.0) -
value を持つ要素のキーを返します。
value を持つ要素のキーを返します。
対応するキーが見つからなかった場合は nil を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。
[注意] 非推奨のメソッドです。代わりに #key を使用してください。
@see YAML::DBM#key -
Psych
:: Visitors :: YAMLTree # <<(object) (9019.0) -
変換対象の Ruby オブジェクトを追加します。
変換対象の Ruby オブジェクトを追加します。
@param object YAML AST へ変換する Ruby オブジェクト -
Psych
:: Visitors :: YAMLTree # push(object) (9019.0) -
変換対象の Ruby オブジェクトを追加します。
変換対象の Ruby オブジェクトを追加します。
@param object YAML AST へ変換する Ruby オブジェクト -
YAML
:: DBM # [](key) -> object | nil (9019.0) -
データベースからキーを探して対応する要素の値を返します。
データベースからキーを探して対応する要素の値を返します。
対応する値が見つからなかった場合は nil を返します。DBM#[] とは異
なり、IndexError は発生しません。
@param key キーを文字列で指定します。
@see YAML::DBM#fetch -
YAML
:: DBM # []=(key , value) -> object (9019.0) -
key に対して value を格納します。
key に対して value を格納します。
val で指定したオブジェクトを返します。
@param key キーを文字列で指定します。
@param value 値を指定します。YAML 形式に変換できるオブジェクトが指定で
きます。
@raise DBMError 要素の格納に失敗した場合に発生します。 -
YAML
:: DBM # fetch(key , ifnone = nil) -> object (9019.0) -
データベースからキーを探して対応する要素の値を返します。
データベースからキーを探して対応する要素の値を返します。
対応する値が見つからなかった場合は ifnone で指定した値を返します。
@param key キーを文字列で指定します。
@see YAML::DBM#[] -
YAML
:: DBM # has _ value?(value) -> bool (9019.0) -
value を値とする組がデータベース中に存在する時、真を返します。
value を値とする組がデータベース中に存在する時、真を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。 -
YAML
:: DBM # key(value) -> String | nil (9019.0) -
value を持つ要素のキーを返します。
value を持つ要素のキーを返します。
対応するキーが見つからなかった場合は nil を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。 -
YAML
:: DBM # select { . . . } -> [[String , object]] (9019.0) -
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。
@param keys キーを文字列で指定します。複数指定することができます。
ブロックを与えるかどうかで戻り値が異なる事に注意してください。
@see YAML::DBM#values_at -
YAML
:: DBM # select(*keys) -> [object] (9019.0) -
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。
@param keys キーを文字列で指定します。複数指定することができます。
ブロックを与えるかどうかで戻り値が異なる事に注意してください。
@see YAML::DBM#values_at -
YAML
:: DBM # store(key , value) -> object (9019.0) -
key に対して value を格納します。
key に対して value を格納します。
val で指定したオブジェクトを返します。
@param key キーを文字列で指定します。
@param value 値を指定します。YAML 形式に変換できるオブジェクトが指定で
きます。
@raise DBMError 要素の格納に失敗した場合に発生します。 -
Psych
:: Visitors :: YAMLTree # finish -> Psych :: Nodes :: Stream|nil (9001.0) -
変換を終了し、構築した AST を返します。
変換を終了し、構築した AST を返します。
このメソッドは2回呼び出さないでください。
@see Psych::Visitors::YAMLTree#tree -
Psych
:: Visitors :: YAMLTree # finished -> bool (9001.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # finished? -> bool (9001.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # started -> bool (9001.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # started? -> bool (9001.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # tree -> Psych :: Nodes :: Stream|nil (9001.0) -
変換を終了し、構築した AST を返します。
変換を終了し、構築した AST を返します。
内部で finish を呼び出し、変換処理を終了します。
このメソッドを2回以上呼ぶと、2回目以降は nil を返します。
@see Psych::Visitors::YAMLTree#finish -
YAML
:: DBM (9001.0) -
DBM の値に文字列以外も格納できるように拡張したクラスです。
DBM の値に文字列以外も格納できるように拡張したクラスです。 -
YAML
:: DBM # delete(key) -> object | nil (9001.0) -
key をキーとする要素を削除します。
key をキーとする要素を削除します。
削除した要素を返します。key に対応する値が見つからなかった場合は nil を
返します。
@param key キーを文字列で指定します。
@raise DBMError 要素の削除に失敗した場合に発生します。 -
YAML
:: DBM # invert -> {object => String} (9001.0) -
値からキーへのハッシュを返します。
値からキーへのハッシュを返します。
異なるキーに対して等しい値が登録されている場合の結果は不定であることに
注意してください、そのような場合にこのメソッドを利用することは意図され
ていません。 -
YAML
:: DBM # reject {|key , val| . . . } -> {String => object} (9001.0) -
ブロックを評価した値が真であれば該当する要素を削除します。
ブロックを評価した値が真であれば該当する要素を削除します。
新しく Hash オブジェクトを作成して返します。 -
YAML
:: DBM # shift -> [String , object] (9001.0) -
データベース中のキー、値を一つ取り出し、データベースから削除します。
データベース中のキー、値を一つ取り出し、データベースから削除します。
[キー, 値]を返します。取得される要素の順番は保証されません。 -
YAML
:: DBM # to _ a -> [[String , object]] (9001.0) -
キーと値のペアを配列に変換して返します。
キーと値のペアを配列に変換して返します。 -
YAML
:: DBM # to _ hash -> Hash (9001.0) -
自身のキー、値をハッシュにしたものを返します。
自身のキー、値をハッシュにしたものを返します。 -
YAML
:: DBM # update(other) -> self (9001.0) -
自身と other の内容をマージ(統合)します。
自身と other の内容をマージ(統合)します。
重複するキーに対応する値は other の内容で上書きされます。
@param other Hash、DBM オブジェクトを指定します。
@raise DBMError 更新に失敗した場合に発生します。 -
YAML
:: DBM # values -> object (9001.0) -
データベース中に存在する値全てを含む配列を返します。
データベース中に存在する値全てを含む配列を返します。 -
YAML
:: DBM # values _ at(*keys) -> [object] (9001.0) -
keys に対応する値を配列に格納して返します。
keys に対応する値を配列に格納して返します。
対応するキーが見つからなかった要素には nil が格納されます。
@param keys キーを文字列で指定します。複数指定することができます。 -
Psych
. parse _ stream(yaml) -> Psych :: Nodes :: Stream (505.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes
//emlist[例][ruby]{
Psych.parse_stream("--... -
Psych
. parse _ stream(yaml) {|node| . . . } -> () (505.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes
//emlist[例][ruby]{
Psych.parse_stream("--... -
Psych
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil , symbolize _ names: false) -> object (496.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
デフォルトでは以下のクラスのオブジェクトしか変換しません。
* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash
再帰的なデータ構造はデフォルトでは許可されていません。
任意のクラスを許可するには whitelist_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:
//emlist[][ruby]{
Psych.s... -
Psych
. load(yaml , filename = nil , fallback: false , symbolize _ names: false) -> object (460.0) -
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
入力に複数のドキュメントが含まれている場合は、先頭のものを変換して
返します。
filename はパース中に発生した例外のメッセージに用います。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@param symbolize_... -
Psych
. parse(yaml , filename = nil) -> Psych :: Nodes :: Document (454.0) -
YAML ドキュメントをパースし、YAML の AST を返します。
YAML ドキュメントをパースし、YAML の AST を返します。
入力に複数のドキュメントが含まれている場合は、先頭のものを AST に変換して
返します。
filename はパース中に発生した例外のメッセージに用います。
AST については Psych::Nodes を参照してください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたと... -
psych (439.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... -
Psych
. load _ stream(yaml , filename=nil) -> [object] (409.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。
複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。
ブロックなしの場合はオブジェクトの配列を返します。
//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}
ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。
//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n...") do |ruby|
list << ru... -
Psych
. load _ stream(yaml , filename=nil) {|obj| . . . } -> () (409.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。
複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。
ブロックなしの場合はオブジェクトの配列を返します。
//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}
ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。
//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n...") do |ruby|
list << ru... -
Psych
:: Parser # parse(yaml) -> self (352.0) -
YAML ドキュメントをパースし、イベントハンドラに イベントを逐次通知します。
YAML ドキュメントをパースし、イベントハンドラに
イベントを逐次通知します。
@see Psych::Parser.new, Psych::Handler, Psych::Parser#handler -
Psych
:: Nodes :: Sequence (205.0) -
YAML sequence http://yaml.org/spec/1.1/#sequence/syntax を表すクラスです。
YAML sequence http://yaml.org/spec/1.1/#sequence/syntax を表すクラスです。
YAML sequence とは基本的にはリスト、配列です。以下のような例が考えられます。
%YAML 1.1
---
- I am
- a Sequence
YAML sequence には anchor を付加することができます。
この例では Psych::Nodes::Sequence#anchor は "A" を返します。
%YAML 1.1
---
&A [
"This sequence",
"has an... -
Psych
:: Parser (175.0) -
YAML のパーサ。
YAML のパーサ。
このクラスは YAML ドキュメントをパースし、コンストラクタに渡された
ハンドラにイベントを通知(呼び出し)します。
このイベントを使って YAML の AST を構築したり YAML ドキュメントを
別のフォーマット変換したりします。
Psych::Emitter を使うとパースしたドキュメントを元通りに出力
することもできます。
Psych::Parser が生成するイベントは Psych::Handler
を見てください。
以下の例では YAML ドキュメント に含まれているスカラー値を表示します。
# Handler for detecting s... -
Psych
:: Nodes (163.0) -
Psych が中間データとして利用している AST (Abstract Syntax Tree) に 関するモジュール。
Psych が中間データとして利用している AST (Abstract Syntax Tree) に
関するモジュール。
Psych.load によって YAML ドキュメントを Ruby オブジェクトに変換
するときには、一度中間的な AST に変換され、その AST が Ruby の
オブジェクトに変換されます。
逆向き、つまり Psych.dump で Ruby のオブジェクトを
YAML ドキュメントに変換するときには、中間的な AST に変換してから
それを YAML ドキュメントに変換します。
YAML AST の各ノードのクラスはすべて Psych::Nodes の下にあり... -
Psych
:: Nodes :: Alias (133.0) -
YAML の alias http://yaml.org/spec/1.1/#alias を表すクラス。
YAML の alias http://yaml.org/spec/1.1/#alias を表すクラス。
anchor で別の YAML の要素を指します。
alias は YAML の AST の葉のノードであり、子ノードを持ちません。 -
Psych
:: Emitter (121.0) -
Psych::Parser でパースし、生じたイベントから YAML ドキュメントを再構築するようなハンドラです。
Psych::Parser でパースし、生じたイベントから
YAML ドキュメントを再構築するようなハンドラです。
以下の例では STDIN から YAML ドキュメントを入力し、
再構築した YAML ドキュメントを STDERR に出力します。
parser = Psych::Parser.new(Psych::Emitter.new($stderr))
parser.parse($stdin)
また、以下のようにイベントを手動で発生させることで
YAML ドキュメントを構築させることもできます。
各メソッドの意味については Psych::Handler を参照してください... -
Psych
:: Handler # start _ document(version , tag _ directives , implicit) -> () (121.0) -
YAML ドキュメントの始まりで呼び出されます。
YAML ドキュメントの始まりで呼び出されます。
version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。
tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。
implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。
必要に応じてこのメソッドを override してください。
@param version ... -
Psych
:: Nodes :: Mapping (115.0) -
YAML の mapping http://yaml.org/spec/1.1/#mapping を表すクラスです。
YAML の mapping http://yaml.org/spec/1.1/#mapping を表すクラスです。
Psych::Nodes::Mapping は 0 個以上の子ノードを持つことができます。
子ノードの個数は偶数でなければなりません。
子ノードは以下のいずれかクラスのインスタンスでなければなりません。
* Psych::Nodes::Sequence
* Psych::Nodes::Mapping
* Psych::Nodes::Scalar
* Psych::Nodes::Alias
子ノードは mapping のキーと値が交互に並んでいます。
as... -
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (109.0) -
1.6.8から1.8.0への変更点(まとめ) * ((<1.6.8から1.8.0への変更点(まとめ)/インタプリタの変更>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加されたクラス/モジュール>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加されたメソッド>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加された定数>)) * ((<1.6.8から1.8.0への変更点(まとめ)/拡張されたクラス/メソッド(互換性のある変更)>)) * ((<1.6.8から1.8.0への変更点(まとめ)/変更されたクラス/メソッド(互換性のない変更)>)) * ((<1.6.8から1.8.0への変更点(まとめ)/文法の変更>)) * ((<1.6.8から1.8.0への変更点(まとめ)/正規表現>)) * ((<1.6.8から1.8.0への変更点(まとめ)/Marshal>)) * ((<1.6.8から1.8.0への変更点(まとめ)/Windows 対応>)) * ((<1.6.8から1.8.0への変更点(まとめ)/廃止された(される予定の)機能>)) * ((<1.6.8から1.8.0への変更点(まとめ)/ライブラリ>)) * ((<1.6.8から1.8.0への変更点(まとめ)/拡張ライブラリAPI>)) * ((<1.6.8から1.8.0への変更点(まとめ)/バグ修正>)) * ((<1.6.8から1.8.0への変更点(まとめ)/サポートプラットフォームの追加>))
1.6.8から1.8.0への変更点(まとめ)
* ((<1.6.8から1.8.0への変更点(まとめ)/インタプリタの変更>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加されたクラス/モジュール>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加されたメソッド>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加された定数>))
* ((<1.6.8から1.8.0への変更点(まとめ)/拡張されたクラス/メソッド(互換性のある変更)>))
* ((<1.6.8から1.8.0への変更点(まとめ)/変更されたクラス/メソッド(互換性のない変更)>))... -
Psych
:: TreeBuilder (103.0) -
YAML AST を構築するためのクラスです。
YAML AST を構築するためのクラスです。
Psych::Parser.new に渡して YAML ドキュメントを YAML AST に変換する
ことができます。
また、Psych::Visitors::YAMLTree.new に渡して Ruby オブジェクト
を YAML AST に変換することもできます。
=== Example
parser = Psych::Parser.new Psych::TreeBuilder.new
parser.parse('--- foo')
parser.handler.root # => #<Psych::Nodes::Stre... -
Psych
:: Nodes :: Scalar (97.0) -
YAML の scalar http://yaml.org/spec/1.1/#id858081 を表すクラスです。
YAML の scalar http://yaml.org/spec/1.1/#id858081 を表すクラスです。
これは AST の葉にあたるノードであり、子ノードを持ちません。 -
irb (91.0)
-
irb は Interactive Ruby の略です。 irb を使うと、Ruby の式を標準入力から簡単に入力・実行することができます。
irb は Interactive Ruby の略です。
irb を使うと、Ruby の式を標準入力から簡単に入力・実行することができます。
=== irb の使い方
Ruby さえ知っていれば irb を使うのは簡単です。
irb コマンドを実行すると、以下のようなプロンプトが表れます。
$ irb
irb(main):001:0>
あとは Ruby の式を入力するだけで、その式が実行され、結果が表示されます。
irb(main):001:0> 1+2
3
irb(main):002:0> class Foo
irb(main):003:1> def f... -
rubygems
/ commands / generate _ index _ command (91.0) -
ある Gem サーバに対するインデックスを作成するためのライブラリです。
ある Gem サーバに対するインデックスを作成するためのライブラリです。
Usage: gem generate_index [options]
Options:
-d, --directory=DIRNAME repository base dir containing gems subdir
Common Options:
-h, --help このコマンドのヘルプを表示します
-V, --[no-]verbose 表示を詳細にします
... -
Psych
. dump(o , io , options = {}) -> () (85.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
Ruby のオブジェクト o を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。
options で出力に関するオプションを以下の指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン... -
Psych
. dump(o , options = {}) -> String (85.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
Ruby のオブジェクト o を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。
options で出力に関するオプションを以下の指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン... -
Gem
:: ConfigFile # load _ file(file _ name) -> object (67.0) -
与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。
与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。
@param file_name YAML 形式で記述された設定ファイル名を指定します。 -
Gem
:: Package :: TarInput # load _ gemspec(io) -> Gem :: Specification | nil (67.0) -
YAML 形式の gemspec を io から読み込みます。
YAML 形式の gemspec を io から読み込みます。
@param io 文字列か IO オブジェクトを指定します。
@see Gem::Specification.from_yaml -
Kernel
# psych _ y(*objects) -> String (67.0) -
objects を YAML document に変換します。
objects を YAML document に変換します。
このメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。
@param objects YAML document に変換する Ruby のオブジェクト -
Kernel
# y(*objects) -> String (67.0) -
objects を YAML document に変換します。
objects を YAML document に変換します。
このメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。
@param objects YAML document に変換する Ruby のオブジェクト -
Psych
. load _ file(filename) -> object (67.0) -
filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。
filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。
@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します -
Psych
. parse _ file(filename) -> Psych :: Nodes :: Document (67.0) -
filename で指定したファイルをパースして YAML の AST を返します。
filename で指定したファイルをパースして YAML の AST を返します。
@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します -
Psych
:: Handler # start _ stream(encoding) -> () (67.0) -
YAML ストリームの始まりで呼び出されます。
YAML ストリームの始まりで呼び出されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリームには
複数のドキュメントが含まれている可能性があります。
必要に応じてこのメソッドを override してください。
@param encoding ストリームのエンコーディング(整数値) -
Psych
:: Nodes :: Stream (67.0) -
YAML stream を表すクラス。
YAML stream を表すクラス。
YAML の AST のルートノードとなるオブジェクトのクラス。
このノードの子ノードは1個以上でなければならず、また
Psych::Nodes::Document オブジェクトでなければなりません。 -
Psych
:: Stream (67.0) -
入力されたオブジェクトから変換された YAML document を指定した IO に出力する機能を持つクラスです。
入力されたオブジェクトから変換された YAML document を指定した
IO に出力する機能を持つクラスです。
start で変換を開始し、push で変換する Ruby オブジェクトを渡し、
最後に finish を呼ぶことで変換を完了します。
stream = Psych::Stream.new($stdout)
stream.start
stream.push({:foo => 'bar'})
stream.finish
YAML document は(バッファリングされずに)直接 $stdout に出力されます。
finish を確実に呼び出すためには Ps... -
rubygems
/ commands / specification _ command (67.0) -
指定された Gem パッケージの gemspec の情報を YAML 形式で表示するためのライブラリです。
指定された Gem パッケージの gemspec の情報を YAML 形式で表示するためのライブラリです。
Usage: gem specification [GEMFILE] [options]
Options:
-v, --version VERSION Specify version of gem to examine
--platform PLATFORM Specify the platform of gem to specification
--all ... -
IRB
:: Context # inspect _ mode=(opt) (55.0) -
実行結果の出力方式を opt に設定します。
実行結果の出力方式を opt に設定します。
@param opt 以下のいずれかを指定します。
: false, :to_s, :raw
出力結果を to_s したものを表示します。
: true, :p, :inspect
出力結果を inspect したものを表示します。
: :pp, :pretty_inspect
出力結果を pretty_inspect したものを表示します。
: :yaml, :YAML
出力結果を YAML 形式にしたものを表示します。
: :marshal, :Marshal, :MARSHAL, Marshal
出力結果を Marsh... -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (55.0) -
mapping の開始を見付けたときに呼び出されます。
mapping の開始を見付けたときに呼び出されます。
anchor には map に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には map に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には map が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
... -
Psych
:: Handler # start _ sequence(anchor , tag , implicit , style) -> () (55.0) -
sequence の開始を見付けたときに呼び出されます。
sequence の開始を見付けたときに呼び出されます。
anchor には sequence に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には sequence に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には sequence が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes:... -
Gem
:: Commands :: SpecificationCommand (49.0) -
指定された Gem パッケージの gemspec の情報を YAML 形式で表示するためのクラスです。
指定された Gem パッケージの gemspec の情報を YAML 形式で表示するためのクラスです。 -
Psych (49.0)
-
yaml のバックエンドのためのモジュールです。
yaml のバックエンドのためのモジュールです。 -
Psych
. dump _ stream(*objects) -> String (49.0) -
オブジェクト列を YAML ドキュメント列に変換します。
オブジェクト列を YAML ドキュメント列に変換します。
@param objects 変換対象のオブジェクト列
//emlist[例][ruby]{
Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//} -
Psych
:: BadAlias (49.0) -
YAML の alias が不正である(本体が見つからない)というエラーを表す例外です。
YAML の alias が不正である(本体が見つからない)というエラーを表す例外です。 -
Psych
:: Handler # end _ stream -> () (49.0) -
YAML stream の終端を見付けたときに呼び出されます。
YAML stream の終端を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Nodes :: Document (49.0) -
YAML ドキュメントを表すクラスです。
YAML ドキュメントを表すクラスです。
このノードは Psych::Nodes::Stream の子ノードでなければ
なりません。このノードは1個の子ノードを持たなければなりません。
またこの子ノードは以下のいずれかである必要があります。
* Psych::Nodes::Sequence
* Psych::Nodes::Mapping
* Psych::Nodes::Scalar
この唯一の子ノードは「ルート」とも呼ばれ、Psych::Nodes::Document#root で
アクセスすることができます。 -
Psych
:: Nodes :: Document # version -> [Integer] (49.0) -
YAML ドキュメントのバージョンを返します。
YAML ドキュメントのバージョンを返します。
@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new -
Psych
:: Nodes :: Document # version=(ver) (49.0) -
YAML ドキュメントのバージョンを設定します。
YAML ドキュメントのバージョンを設定します。
@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new