ruby--ruby/lib/yaml.rb

##
# The YAML module allows you to use one of the two YAML engines that ship with
# ruby.  By default Psych is used but the old and unmaintained Syck may be
# chosen.

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

module Psych # :nodoc:
  class EngineManager
    # Returns the YAML engine in use.
    #
    # By default Psych is used but the old and unmaintained Syck may be chosen.
    #
    # See #yamler= for more information.
    attr_reader :yamler

    def initialize # :nodoc:
      @yamler = 'psych'
    end

    def syck? # :nodoc:
      false
    end

    # By default Psych is used but the old and unmaintained Syck may be chosen.
    #
    # After installing the 'syck' gem, you can set the YAML engine to syck:
    #
    #   YAML::ENGINE.yamler = 'syck'
    #
    # To set the YAML engine back to psych:
    #
    #   YAML::ENGINE.yamler = 'psych'
    def yamler= engine
      case engine
      when 'syck' then warn "syck has been removed"
      when 'psych' then @yamler = 'psych'
      else
        raise(ArgumentError, "bad engine")
      end

      engine
    end
  end

  ENGINE = EngineManager.new # :nodoc:
end

# YAML Ain't Markup Language
#
# This module provides a Ruby interface for data serialization in YAML format.
#
# The underlying implementation depends on an engine to handle the parsing and
# serialization for Ruby, by default this will be using the libyaml wrapper
# Psych.
#
# See Psych::EngineManager for details on switching the default YAML engine.
#
# Working with YAML can be very simple, for example:
#
#     require 'yaml' # STEP ONE, 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"
#
# 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.
#
# For more advanced details on the implementation see Psych, and also check out
# yaml.org for spec details and other helpful information.
module YAML
end