YPS: YAML Positioning System

YPS (YAML Positioning System) is a Ruby gem designed to enhance the way YAML files are parsed by adding valuable position information to each parsed element, including file names, line numbers, and column details. This functionality is particularly beneficial for developers, as it streamlines debugging and error reporting processes by enabling precise location tracking of issues within the original YAML structure.

Features

• Comprehensive YAML Parsing: YPS provides methods to load YAML strings and files while attaching position metadata to the parsed Ruby objects, assisting in quick identification and resolution of issues.
• Flexible APIs: Utilize the following methods to load YAML data with position information:
  • YPS.safe_load, YPS.load, YPS.safe_load_stream, YPS.load_stream: For loading YAML strings with position data.
  • YPS.safe_load_file, YPS.load_file, YPS.safe_load_stream_file, YPS.load_stream_file: For loading YAML from files with position data.

Example Usage

Below is an example demonstrating how YPS enriches YAML loading with position information:

require 'yps'

yaml = YPS.load(<<~'YAML')
children:
  - name: kanta
    age: 8
  - name: kaede
    age: 3
YAML

yaml['children'].each do |child|
  child.each do |key, value|
    puts "#{key}: #{value} (#{value.position})"
  end
end

In this example, the output will include the position of each key-value pair within the original YAML, facilitating easier debugging:

name: kanta (filename: unknown line 2 column 11)
age: 8 (filename: unknown line 3 column 10)
name: kaede (filename: unknown line 4 column 11)
age: 3 (filename: unknown line 5 column 10)

YPS not only optimizes the debugging process but also enhances code maintainability by clearly linking errors back to their origins in the YAML configuration files. For further details and comprehensive API documentation, visit here.

Contributions are encouraged, and issues can be reported via the Issue Tracker. Pull requests and discussions are also welcomed on GitHub.