psych-with-location 3.0.0.beta3

data/lib/psych/handlers/document_stream.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'psych/tree_builder'
+
+module Psych
+  module Handlers
+    class DocumentStream < Psych::TreeBuilder # :nodoc:
+      def initialize &block
+        super
+        @block = block
+      end
+
+      def start_document version, tag_directives, implicit
+        n = Nodes::Document.new version, tag_directives, implicit
+        push n
+      end
+
+      def end_document implicit_end = !streaming?
+        @last.implicit_end = implicit_end
+        @block.call pop
+      end
+    end
+  end
+end

data/lib/psych/handlers/recorder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'psych/handler'
+
+module Psych
+  module Handlers
+    ###
+    # This handler will capture an event and record the event.  Recorder events
+    # are available vial Psych::Handlers::Recorder#events.
+    #
+    # For example:
+    #
+    #   recorder = Psych::Handlers::Recorder.new
+    #   parser = Psych::Parser.new recorder
+    #   parser.parse '--- foo'
+    #
+    #   recorder.events # => [list of events]
+    #
+    #   # Replay the events
+    #
+    #   emitter = Psych::Emitter.new $stdout
+    #   recorder.events.each do |m, args|
+    #     emitter.send m, *args
+    #   end
+
+    class Recorder < Psych::Handler
+      attr_reader :events
+
+      def initialize
+        @events = []
+        super
+      end
+
+      EVENTS.each do |event|
+        define_method event do |*args|
+          @events << [event, args]
+        end
+      end
+    end
+  end
+end

data/lib/psych/json/ruby_events.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Psych
+  module JSON
+    module RubyEvents # :nodoc:
+      def visit_Time o
+        formatted = format_time o
+        @emitter.scalar formatted, nil, nil, false, true, Nodes::Scalar::DOUBLE_QUOTED
+      end
+
+      def visit_DateTime o
+        visit_Time o.to_time
+      end
+
+      def visit_String o
+        @emitter.scalar o.to_s, nil, nil, false, true, Nodes::Scalar::DOUBLE_QUOTED
+      end
+      alias :visit_Symbol :visit_String
+    end
+  end
+end

data/lib/psych/json/stream.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'psych/json/ruby_events'
+require 'psych/json/yaml_events'
+
+module Psych
+  module JSON
+    class Stream < Psych::Visitors::JSONTree
+      include Psych::JSON::RubyEvents
+      include Psych::Streaming
+      extend Psych::Streaming::ClassMethods
+
+      class Emitter < Psych::Stream::Emitter # :nodoc:
+        include Psych::JSON::YAMLEvents
+      end
+    end
+  end
+end

data/lib/psych/json/tree_builder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'psych/json/yaml_events'
+
+module Psych
+  module JSON
+    ###
+    # Psych::JSON::TreeBuilder is an event based AST builder.  Events are sent
+    # to an instance of Psych::JSON::TreeBuilder and a JSON AST is constructed.
+    class TreeBuilder < Psych::TreeBuilder
+      include Psych::JSON::YAMLEvents
+    end
+  end
+end

data/lib/psych/json/yaml_events.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Psych
+  module JSON
+    module YAMLEvents # :nodoc:
+      def start_document version, tag_directives, implicit
+        super(version, tag_directives, !streaming?)
+      end
+
+      def end_document implicit_end = !streaming?
+        super(implicit_end)
+      end
+
+      def start_mapping anchor, tag, implicit, style
+        super(anchor, nil, true, Nodes::Mapping::FLOW)
+      end
+
+      def start_sequence anchor, tag, implicit, style
+        super(anchor, nil, true, Nodes::Sequence::FLOW)
+      end
+
+      def scalar value, anchor, tag, plain, quoted, style
+        if "tag:yaml.org,2002:null" == tag
+          super('null', nil, nil, true, false, Nodes::Scalar::PLAIN)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/psych/nodes.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+require 'psych/nodes/node'
+require 'psych/nodes/stream'
+require 'psych/nodes/document'
+require 'psych/nodes/sequence'
+require 'psych/nodes/scalar'
+require 'psych/nodes/mapping'
+require 'psych/nodes/alias'
+
+module Psych
+  ###
+  # = Overview
+  #
+  # When using Psych.load to deserialize a YAML document, the document is
+  # translated to an intermediary AST.  That intermediary AST is then
+  # translated in to a Ruby object graph.
+  #
+  # In the opposite direction, when using Psych.dump, the Ruby object graph is
+  # translated to an intermediary AST which is then converted to a YAML
+  # document.
+  #
+  # Psych::Nodes contains all of the classes that make up the nodes of a YAML
+  # AST.  You can manually build an AST and use one of the visitors (see
+  # Psych::Visitors) to convert that AST to either a YAML document or to a
+  # Ruby object graph.
+  #
+  # Here is an example of building an AST that represents a list with one
+  # scalar:
+  #
+  #   # Create our nodes
+  #   stream = Psych::Nodes::Stream.new
+  #   doc    = Psych::Nodes::Document.new
+  #   seq    = Psych::Nodes::Sequence.new
+  #   scalar = Psych::Nodes::Scalar.new('foo')
+  #
+  #   # Build up our tree
+  #   stream.children << doc
+  #   doc.children    << seq
+  #   seq.children    << scalar
+  #
+  # The stream is the root of the tree.  We can then convert the tree to YAML:
+  #
+  #   stream.to_yaml => "---\n- foo\n"
+  #
+  # Or convert it to Ruby:
+  #
+  #   stream.to_ruby => [["foo"]]
+  #
+  # == YAML AST Requirements
+  #
+  # A valid YAML AST *must* have one Psych::Nodes::Stream at the root.  A
+  # Psych::Nodes::Stream node must have 1 or more Psych::Nodes::Document nodes
+  # as children.
+  #
+  # Psych::Nodes::Document nodes must have one and *only* one child.  That child
+  # may be one of:
+  #
+  # * Psych::Nodes::Sequence
+  # * Psych::Nodes::Mapping
+  # * Psych::Nodes::Scalar
+  #
+  # Psych::Nodes::Sequence and Psych::Nodes::Mapping nodes may have many
+  # children, but Psych::Nodes::Mapping nodes should have an even number of
+  # children.
+  #
+  # All of these are valid children for Psych::Nodes::Sequence and
+  # Psych::Nodes::Mapping nodes:
+  #
+  # * Psych::Nodes::Sequence
+  # * Psych::Nodes::Mapping
+  # * Psych::Nodes::Scalar
+  # * Psych::Nodes::Alias
+  #
+  # Psych::Nodes::Scalar and Psych::Nodes::Alias are both terminal nodes and
+  # should not have any children.
+  module Nodes
+  end
+end

data/lib/psych/nodes/alias.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Psych
+  module Nodes
+    ###
+    # This class represents a {YAML Alias}[http://yaml.org/spec/1.1/#alias].
+    # It points to an +anchor+.
+    #
+    # A Psych::Nodes::Alias is a terminal node and may have no children.
+    class Alias < Psych::Nodes::Node
+      # The anchor this alias links to
+      attr_accessor :anchor
+
+      # Create a new Alias that points to an +anchor+
+      def initialize anchor
+        @anchor = anchor
+      end
+    end
+  end
+end

data/lib/psych/nodes/document.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module Psych
+  module Nodes
+    ###
+    # This represents a YAML Document.  This node must be a child of
+    # Psych::Nodes::Stream.  A Psych::Nodes::Document must have one child,
+    # and that child may be one of the following:
+    #
+    # * Psych::Nodes::Sequence
+    # * Psych::Nodes::Mapping
+    # * Psych::Nodes::Scalar
+    class Document < Psych::Nodes::Node
+      # The version of the YAML document
+      attr_accessor :version
+
+      # A list of tag directives for this document
+      attr_accessor :tag_directives
+
+      # Was this document implicitly created?
+      attr_accessor :implicit
+
+      # Is the end of the document implicit?
+      attr_accessor :implicit_end
+
+      ###
+      # Create a new Psych::Nodes::Document object.
+      #
+      # +version+ is a list indicating the YAML version.
+      # +tags_directives+ is a list of tag directive declarations
+      # +implicit+ is a flag indicating whether the document will be implicitly
+      # started.
+      #
+      # == Example:
+      # This creates a YAML document object that represents a YAML 1.1 document
+      # with one tag directive, and has an implicit start:
+      #
+      #   Psych::Nodes::Document.new(
+      #     [1,1],
+      #     [["!", "tag:tenderlovemaking.com,2009:"]],
+      #     true
+      #   )
+      #
+      # == See Also
+      # See also Psych::Handler#start_document
+      def initialize version = [], tag_directives = [], implicit = false
+        super()
+        @version        = version
+        @tag_directives = tag_directives
+        @implicit       = implicit
+        @implicit_end   = true
+      end
+
+      ###
+      # Returns the root node.  A Document may only have one root node:
+      # http://yaml.org/spec/1.1/#id898031
+      def root
+        children.first
+      end
+    end
+  end
+end

data/lib/psych/nodes/mapping.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module Psych
+  module Nodes
+    ###
+    # This class represents a {YAML Mapping}[http://yaml.org/spec/1.1/#mapping].
+    #
+    # A Psych::Nodes::Mapping node may have 0 or more children, but must have
+    # an even number of children.  Here are the valid children a
+    # Psych::Nodes::Mapping node may have:
+    #
+    # * Psych::Nodes::Sequence
+    # * Psych::Nodes::Mapping
+    # * Psych::Nodes::Scalar
+    # * Psych::Nodes::Alias
+    class Mapping < Psych::Nodes::Node
+      # Any Map Style
+      ANY   = 0
+
+      # Block Map Style
+      BLOCK = 1
+
+      # Flow Map Style
+      FLOW  = 2
+
+      # The optional anchor for this mapping
+      attr_accessor :anchor
+
+      # The optional tag for this mapping
+      attr_accessor :tag
+
+      # Is this an implicit mapping?
+      attr_accessor :implicit
+
+      # The style of this mapping
+      attr_accessor :style
+
+      ###
+      # Create a new Psych::Nodes::Mapping object.
+      #
+      # +anchor+ is the anchor associated with the map or +nil+.
+      # +tag+ is the tag associated with the map or +nil+.
+      # +implicit+ is a boolean indicating whether or not the map was implicitly
+      # started.
+      # +style+ is an integer indicating the mapping style.
+      #
+      # == See Also
+      # See also Psych::Handler#start_mapping
+      def initialize anchor = nil, tag = nil, implicit = true, style = BLOCK
+        super()
+        @anchor   = anchor
+        @tag      = tag
+        @implicit = implicit
+        @style    = style
+      end
+    end
+  end
+end

data/lib/psych/nodes/node.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'stringio'
+require 'psych/class_loader'
+require 'psych/scalar_scanner'
+
+module Psych
+  module Nodes
+    ###
+    # The base class for any Node in a YAML parse tree.  This class should
+    # never be instantiated.
+    class Node
+      include Enumerable
+
+      # The children of this node
+      attr_reader :children
+
+      # An associated tag
+      attr_reader :tag
+
+      # The line number where this node start
+      attr_accessor :start_line
+
+      # The column number where this node start
+      attr_accessor :start_column
+
+      # The line number where this node ends
+      attr_accessor :end_line
+
+      # The column number where this node ends
+      attr_accessor :end_column
+
+      # Create a new Psych::Nodes::Node
+      def initialize
+        @children = []
+      end
+
+      ###
+      # Iterate over each node in the tree. Yields each node to +block+ depth
+      # first.
+      def each &block
+        return enum_for :each unless block_given?
+        Visitors::DepthFirst.new(block).accept self
+      end
+
+      ###
+      # Convert this node to Ruby.
+      #
+      # See also Psych::Visitors::ToRuby
+      def to_ruby
+        Visitors::ToRuby.create.accept(self)
+      end
+      alias :transform :to_ruby
+
+      ###
+      # Convert this node to YAML.
+      #
+      # See also Psych::Visitors::Emitter
+      def yaml io = nil, options = {}
+        real_io = io || StringIO.new(''.encode('utf-8'))
+
+        Visitors::Emitter.new(real_io, options).accept self
+        return real_io.string unless io
+        io
+      end
+      alias :to_yaml :yaml
+    end
+  end
+end

data/lib/psych/nodes/scalar.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+module Psych
+  module Nodes
+    ###
+    # This class represents a {YAML Scalar}[http://yaml.org/spec/1.1/#id858081].
+    #
+    # This node type is a terminal node and should not have any children.
+    class Scalar < Psych::Nodes::Node
+      # Any style scalar, the emitter chooses
+      ANY           = 0
+
+      # Plain scalar style
+      PLAIN         = 1
+
+      # Single quoted style
+      SINGLE_QUOTED = 2
+
+      # Double quoted style
+      DOUBLE_QUOTED = 3
+
+      # Literal style
+      LITERAL       = 4
+
+      # Folded style
+      FOLDED        = 5
+
+      # The scalar value
+      attr_accessor :value
+
+      # The anchor value (if there is one)
+      attr_accessor :anchor
+
+      # The tag value (if there is one)
+      attr_accessor :tag
+
+      # Is this a plain scalar?
+      attr_accessor :plain
+
+      # Is this scalar quoted?
+      attr_accessor :quoted
+
+      # The style of this scalar
+      attr_accessor :style
+
+      ###
+      # Create a new Psych::Nodes::Scalar object.
+      #
+      # +value+ is the string value of the scalar
+      # +anchor+ is an associated anchor or nil
+      # +tag+ is an associated tag or nil
+      # +plain+ is a boolean value
+      # +quoted+ is a boolean value
+      # +style+ is an integer idicating the string style
+      #
+      # == See Also
+      #
+      # See also Psych::Handler#scalar
+      def initialize value, anchor = nil, tag = nil, plain = true, quoted = false, style = ANY
+        @value  = value
+        @anchor = anchor
+        @tag    = tag
+        @plain  = plain
+        @quoted = quoted
+        @style  = style
+      end
+    end
+  end
+end