mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
7833e69c2e
* test/psych/*: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46097 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
59 lines
1.7 KiB
Ruby
59 lines
1.7 KiB
Ruby
##
|
|
# The YAML module is an alias of Psych, the YAML engine for Ruby.
|
|
|
|
begin
|
|
require 'psych'
|
|
rescue LoadError
|
|
warn "#{caller[0]}:"
|
|
warn "It seems your ruby installation is missing psych (for YAML output)."
|
|
warn "To eliminate this warning, please install libyaml and reinstall your ruby."
|
|
raise
|
|
end
|
|
|
|
YAML = Psych # :nodoc:
|
|
|
|
# YAML Ain't Markup Language
|
|
#
|
|
# This module provides a Ruby interface for data serialization in YAML format.
|
|
#
|
|
# The underlying implementation is the libyaml wrapper Psych.
|
|
#
|
|
# == Usage
|
|
#
|
|
# Working with YAML can be very simple, for example:
|
|
#
|
|
# require 'yaml'
|
|
# # Parse a YAML string
|
|
# YAML.load("--- foo") #=> "foo"
|
|
#
|
|
# # Emit some YAML
|
|
# YAML.dump("foo") # => "--- foo\n...\n"
|
|
# { :a => 'b'}.to_yaml # => "---\n:a: b\n"
|
|
#
|
|
# == Security
|
|
#
|
|
# Do not use YAML to load untrusted data. Doing so is unsafe and could allow
|
|
# malicious input to execute arbitrary code inside your application. Please see
|
|
# doc/security.rdoc for more information.
|
|
#
|
|
# == History
|
|
#
|
|
# Syck was the original for YAML implementation in Ruby's standard library
|
|
# developed by why the lucky stiff.
|
|
#
|
|
# You can still use Syck, if you prefer, for parsing and emitting YAML, but you
|
|
# must install the 'syck' gem now in order to use it.
|
|
#
|
|
# In older Ruby versions, ie. <= 1.9, Syck is still provided, however it was
|
|
# completely removed with the release of Ruby 2.0.0.
|
|
#
|
|
# == More info
|
|
#
|
|
# For more advanced details on the implementation see Psych, and also check out
|
|
# http://yaml.org for spec details and other helpful information.
|
|
#
|
|
# Pysch is maintained by Aaron Patterson on github: https://github.com/tenderlove/psych
|
|
#
|
|
# Syck can also be found on github: https://github.com/tenderlove/syck
|
|
module YAML
|
|
end
|