psych 1.1.0

data/ext/psych/psych.h

@@ -0,0 +1,20 @@
+#ifndef PSYCH_H
+#define PSYCH_H
+
+#include <ruby.h>
+
+#ifdef HAVE_RUBY_ENCODING_H
+#include <ruby/encoding.h>
+#endif
+
+#include <yaml.h>
+
+#include <parser.h>
+#include <emitter.h>
+#include <to_ruby.h>
+#include <yaml_tree.h>
+
+extern VALUE mPsych;
+
+
+#endif

data/ext/psych/to_ruby.c

@@ -0,0 +1,41 @@
+#include <psych.h>
+
+VALUE cPsychVisitorsToRuby;
+
+/* call-seq: vis.build_exception(klass, message)
+ *
+ * Create an exception with class +klass+ and +message+
+ */
+static VALUE build_exception(VALUE self, VALUE klass, VALUE mesg)
+{
+    VALUE e = rb_obj_alloc(klass);
+
+    rb_iv_set(e, "mesg", mesg);
+
+    return e;
+}
+
+/* call-seq: vis.path2class(path)
+ *
+ * Convert +path+ string to a class
+ */
+static VALUE path2class(VALUE self, VALUE path)
+{
+#ifdef HAVE_RUBY_ENCODING_H
+    return rb_path_to_class(path);
+#else
+    return rb_path2class(StringValuePtr(path));
+#endif
+}
+
+void Init_psych_to_ruby(void)
+{
+    VALUE psych     = rb_define_module("Psych");
+    VALUE visitors  = rb_define_module_under(psych, "Visitors");
+    VALUE visitor   = rb_define_class_under(visitors, "Visitor", rb_cObject);
+    cPsychVisitorsToRuby = rb_define_class_under(visitors, "ToRuby", visitor);
+
+    rb_define_private_method(cPsychVisitorsToRuby, "build_exception", build_exception, 2);
+    rb_define_private_method(cPsychVisitorsToRuby, "path2class", path2class, 1);
+}
+/* vim: set noet sws=4 sw=4: */

data/ext/psych/to_ruby.h

@@ -0,0 +1,8 @@
+#ifndef PSYCH_TO_RUBY_H
+#define PSYCH_TO_RUBY_H
+
+#include <psych.h>
+
+void Init_psych_to_ruby(void);
+
+#endif

data/ext/psych/yaml_tree.c

@@ -0,0 +1,24 @@
+#include <psych.h>
+
+VALUE cPsychVisitorsYamlTree;
+
+/*
+ * call-seq: private_iv_get(target, prop)
+ *
+ * Get the private instance variable +prop+ from +target+
+ */
+static VALUE private_iv_get(VALUE self, VALUE target, VALUE prop)
+{
+    return rb_attr_get(target, rb_intern(StringValuePtr(prop)));
+}
+
+void Init_psych_yaml_tree(void)
+{
+    VALUE psych     = rb_define_module("Psych");
+    VALUE visitors  = rb_define_module_under(psych, "Visitors");
+    VALUE visitor   = rb_define_class_under(visitors, "Visitor", rb_cObject);
+    cPsychVisitorsYamlTree = rb_define_class_under(visitors, "YAMLTree", visitor);
+
+    rb_define_private_method(cPsychVisitorsYamlTree, "private_iv_get", private_iv_get, 2);
+}
+/* vim: set noet sws=4 sw=4: */

data/ext/psych/yaml_tree.h

@@ -0,0 +1,8 @@
+#ifndef PSYCH_YAML_TREE_H
+#define PSYCH_YAML_TREE_H
+
+#include <psych.h>
+
+void Init_psych_yaml_tree(void);
+
+#endif

data/lib/psych.rb

@@ -0,0 +1,263 @@
+require 'psych.so'
+require 'psych/nodes'
+require 'psych/streaming'
+require 'psych/visitors'
+require 'psych/handler'
+require 'psych/tree_builder'
+require 'psych/parser'
+require 'psych/omap'
+require 'psych/set'
+require 'psych/coder'
+require 'psych/core_ext'
+require 'psych/deprecated'
+require 'psych/json'
+
+###
+# = Overview
+#
+# Psych is a YAML parser and emitter.  Psych leverages
+# libyaml[http://libyaml.org] for it's YAML parsing and emitting capabilities.
+# In addition to wrapping libyaml, Psych also knows how to serialize and
+# de-serialize most Ruby objects to and from the YAML format.
+#
+# = I NEED TO PARSE OR EMIT YAML RIGHT NOW!
+#
+#   # Parse some YAML
+#   Psych.load("--- foo") # => "foo"
+#
+#   # Emit some YAML
+#   Psych.dump("foo")     # => "--- foo\n...\n"
+#   { :a => 'b'}.to_yaml  # => "---\n:a: b\n"
+#
+# Got more time on your hands?  Keep on reading!
+#
+# == YAML Parsing
+#
+# Psych provides a range of interfaces for parsing a YAML document ranging from
+# low level to high level, depending on your parsing needs.  At the lowest
+# level, is an event based parser.  Mid level is access to the raw YAML AST,
+# and at the highest level is the ability to unmarshal YAML to ruby objects.
+#
+# === Low level parsing
+#
+# The lowest level parser should be used when the YAML input is already known,
+# and the developer does not want to pay the price of building an AST or
+# automatic detection and conversion to ruby objects.  See Psych::Parser for
+# more information on using the event based parser.
+#
+# === Mid level parsing
+#
+# Psych provides access to an AST produced from parsing a YAML document.  This
+# tree is built using the Psych::Parser and Psych::TreeBuilder.  The AST can
+# be examined and manipulated freely.  Please see Psych::parse_stream,
+# Psych::Nodes, and Psych::Nodes::Node for more information on dealing with
+# YAML syntax trees.
+#
+# === High level parsing
+#
+# The high level YAML parser provided by Psych simply takes YAML as input and
+# returns a Ruby data structure.  For information on using the high level parser
+# see Psych.load
+#
+# == YAML Emitting
+#
+# Psych provides a range of interfaces ranging from low to high level for
+# producing YAML documents.  Very similar to the YAML parsing interfaces, Psych
+# provides at the lowest level, an event based system, mid-level is building
+# a YAML AST, and the highest level is converting a Ruby object straight to
+# a YAML document.
+#
+# === Low level emitting
+#
+# The lowest level emitter is an event based system.  Events are sent to a
+# Psych::Emitter object.  That object knows how to convert the events to a YAML
+# document.  This interface should be used when document format is known in
+# advance or speed is a concern.  See Psych::Emitter for more information.
+#
+# === Mid level emitting
+#
+# At the mid level is building an AST.  This AST is exactly the same as the AST
+# used when parsing a YAML document.  Users can build an AST by hand and the
+# AST knows how to emit itself as a YAML document.  See Psych::Nodes,
+# Psych::Nodes::Node, and Psych::TreeBuilder for more information on building
+# a YAML AST.
+#
+# === High level emitting
+#
+# The high level emitter has the easiest interface.  Psych simply takes a Ruby
+# data structure and converts it to a YAML document.  See Psych.dump for more
+# information on dumping a Ruby data structure.
+
+module Psych
+  # The version is Psych you're using
+  VERSION         = '1.1.0'
+
+  # The version of libyaml Psych is using
+  LIBYAML_VERSION = Psych.libyaml_version.join '.'
+
+  class Exception < RuntimeError
+  end
+
+  autoload :Stream, 'psych/stream'
+
+  ###
+  # Load +yaml+ in to a Ruby data structure.  If multiple documents are
+  # provided, the object contained in the first document will be returned.
+  #
+  # Example:
+  #
+  #   Psych.load("--- a")           # => 'a'
+  #   Psych.load("---\n - a\n - b") # => ['a', 'b']
+  def self.load yaml
+    result = parse(yaml)
+    result ? result.to_ruby : result
+  end
+
+  ###
+  # Parse a YAML string in +yaml+.  Returns the first object of a YAML AST.
+  #
+  # Example:
+  #
+  #   Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Sequence:0x00>
+  #
+  # See Psych::Nodes for more information about YAML AST.
+  def self.parse yaml
+    children = parse_stream(yaml).children
+    children.empty? ? false : children.first.children.first
+  end
+
+  ###
+  # Parse a file at +filename+. Returns the YAML AST.
+  def self.parse_file filename
+    File.open filename do |f|
+      parse f
+    end
+  end
+
+  ###
+  # Returns a default parser
+  def self.parser
+    Psych::Parser.new(TreeBuilder.new)
+  end
+
+  ###
+  # Parse a YAML string in +yaml+.  Returns the full AST for the YAML document.
+  # This method can handle multiple YAML documents contained in +yaml+.
+  #
+  # Example:
+  #
+  #   Psych.parse_stream("---\n - a\n - b") # => #<Psych::Nodes::Stream:0x00>
+  #
+  # See Psych::Nodes for more information about YAML AST.
+  def self.parse_stream yaml
+    parser = self.parser
+    parser.parse yaml
+    parser.handler.root
+  end
+
+  ###
+  # call-seq:
+  #   Psych.dump(o)               -> string of yaml
+  #   Psych.dump(o, options)      -> string of yaml
+  #   Psych.dump(o, io)           -> io object passed in
+  #   Psych.dump(o, io, options)  -> io object passed in
+  #
+  # Dump Ruby object +o+ to a YAML string.  Optional +options+ may be passed in
+  # to control the output format.  If an IO object is passed in, the YAML will
+  # be dumped to that IO object.
+  #
+  # Example:
+  #
+  #   # Dump an array, get back a YAML string
+  #   Psych.dump(['a', 'b'])  # => "---\n- a\n- b\n"
+  #
+  #   # Dump an array to an IO object
+  #   Psych.dump(['a', 'b'], StringIO.new)  # => #<StringIO:0x000001009d0890>
+  #
+  #   # Dump an array with indentation set
+  #   Psych.dump(['a', ['b']], :indentation => 3) # => "---\n- a\n-  - b\n"
+  #
+  #   # Dump an array to an IO with indentation set
+  #   Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
+  def self.dump o, io = nil, options = {}
+    if Hash === io
+      options = io
+      io      = nil
+    end
+
+    visitor = Psych::Visitors::YAMLTree.new options
+    visitor << o
+    visitor.tree.to_yaml io, options
+  end
+
+  ###
+  # Dump a list of objects as separate documents to a document stream.
+  #
+  # Example:
+  #
+  #   Psych.dump_stream("foo\n  ", {}) # => "--- ! \"foo\\n  \"\n--- {}\n"
+  def self.dump_stream *objects
+    visitor = Psych::Visitors::YAMLTree.new {}
+    objects.each do |o|
+      visitor << o
+    end
+    visitor.tree.to_yaml
+  end
+
+  ###
+  # Dump Ruby object +o+ to a JSON string.
+  def self.to_json o
+    visitor = Psych::Visitors::JSONTree.new
+    visitor << o
+    visitor.tree.to_yaml
+  end
+
+  ###
+  # Load multiple documents given in +yaml+.  Returns the parsed documents
+  # as a list.  For example:
+  #
+  #   Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
+  #
+  def self.load_stream yaml
+    parse_stream(yaml).children.map { |child| child.to_ruby }
+  end
+
+  ###
+  # Load the document contained in +filename+.  Returns the yaml contained in
+  # +filename+ as a ruby object
+  def self.load_file filename
+    self.load File.open(filename)
+  end
+
+  # :stopdoc:
+  @domain_types = {}
+  def self.add_domain_type domain, type_tag, &block
+    key = ['tag', domain, type_tag].join ':'
+    @domain_types[key] = [key, block]
+    @domain_types["tag:#{type_tag}"] = [key, block]
+  end
+
+  def self.add_builtin_type type_tag, &block
+    domain = 'yaml.org,2002'
+    key = ['tag', domain, type_tag].join ':'
+    @domain_types[key] = [key, block]
+  end
+
+  def self.remove_type type_tag
+    @domain_types.delete type_tag
+  end
+
+  @load_tags = {}
+  @dump_tags = {}
+  def self.add_tag tag, klass
+    @load_tags[tag] = klass
+    @dump_tags[klass] = tag
+  end
+
+  class << self
+    attr_accessor :load_tags
+    attr_accessor :dump_tags
+    attr_accessor :domain_types
+  end
+  # :startdoc:
+end

data/lib/psych/coder.rb

@@ -0,0 +1,94 @@
+module Psych
+  ###
+  # If an object defines +encode_with+, then an instance of Psych::Coder will
+  # be passed to the method when the object is being serialized.  The Coder
+  # automatically assumes a Psych::Nodes::Mapping is being emitted.  Other
+  # objects like Sequence and Scalar may be emitted if +seq=+ or +scalar=+ are
+  # called, respectively.
+  class Coder
+    attr_accessor :tag, :style, :implicit, :object
+    attr_reader   :type, :seq
+
+    def initialize tag
+      @map      = {}
+      @seq      = []
+      @implicit = false
+      @type     = :map
+      @tag      = tag
+      @style    = Psych::Nodes::Mapping::BLOCK
+      @scalar   = nil
+      @object   = nil
+    end
+
+    def scalar *args
+      if args.length > 0
+        warn "#{caller[0]}: Coder#scalar(a,b,c) is deprecated" if $VERBOSE
+        @tag, @scalar, _ = args
+        @type = :scalar
+      end
+      @scalar
+    end
+
+    # Emit a map.  The coder will be yielded to the block.
+    def map tag = @tag, style = @style
+      @tag   = tag
+      @style = style
+      yield self if block_given?
+      @map
+    end
+
+    # Emit a scalar with +value+ and +tag+
+    def represent_scalar tag, value
+      self.tag    = tag
+      self.scalar = value
+    end
+
+    # Emit a sequence with +list+ and +tag+
+    def represent_seq tag, list
+      @tag = tag
+      self.seq = list
+    end
+
+    # Emit a sequence with +map+ and +tag+
+    def represent_map tag, map
+      @tag = tag
+      self.map = map
+    end
+
+    # Emit an arbitrary object +obj+ and +tag+
+    def represent_object tag, obj
+      @tag    = tag
+      @type   = :object
+      @object = obj
+    end
+
+    # Emit a scalar with +value+
+    def scalar= value
+      @type   = :scalar
+      @scalar = value
+    end
+
+    # Emit a map with +value+
+    def map= map
+      @type = :map
+      @map  = map
+    end
+
+    def []= k, v
+      @type = :map
+      @map[k] = v
+    end
+    alias :add :[]=
+
+    def [] k
+      @type = :map
+      @map[k]
+    end
+
+    # Emit a sequence of +list+
+    def seq= list
+      @type = :seq
+      @seq  = list
+    end
+  end
+end