yps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43d89afcf4628612d4c00e6d902eb95bd92757e755b79297c72d73eac901ad53
+  data.tar.gz: e55453abcb53201a61704a790966ea0f7765e75e40856cf91f0365acd355a729
+SHA512:
+  metadata.gz: 29070662eff8e6b0d3210d444e88466b6c8fed647c0ca9742d1b4ca5196a195b90740d154836d8439eec89117fbcbfd99f1a67bab6d627c18508a7add5e754d1
+  data.tar.gz: aa948cb48fac9b1b83b306c093fa8df9c573b676928a00848fd7e8c03a012fab040f2829b2e2ac584ee103ff3018be9e22c2f34645e985606a67a3731bd45bc6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Taichi Ishitani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+[![Gem Version](https://badge.fury.io/rb/yps.svg)](https://badge.fury.io/rb/yps)
+[![CI](https://github.com/taichi-ishitani/yps/actions/workflows/ci.yml/badge.svg)](https://github.com/taichi-ishitani/yps/actions/workflows/ci.yml)
+[![Maintainability](https://qlty.sh/gh/taichi-ishitani/projects/yps/maintainability.svg)](https://qlty.sh/gh/taichi-ishitani/projects/yps)
+[![codecov](https://codecov.io/gh/taichi-ishitani/yps/graph/badge.svg?token=JwmT4kfLYG)](https://codecov.io/gh/taichi-ishitani/yps)
+
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A231E3I)
+
+# YPS: YAML Positioning System
+
+YPS is a gem to parse YAML and add position information (file name, line and column) to each parsed elements.
+This is useful for error reporting and debugging, allowing developers to precisely locate an issue within the original YAML file.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add yps
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install yps
+```
+
+## Usage
+
+You can use the methods below to load a YAML code into Ruby objects with their position information (file name, line, and column).
+
+* `YPS.safe_load`/`YPS.load`
+    * Load the given YAML string into Ruby objects with position information.
+* `YPS.safe_load_file`/`YPS.load_file`
+    * Load the YAML code read from the given file path into Ruby objects with position information.
+
+Parsed objects, except for hash keys, have their own position information.
+You can use the `position` method to get position information in the original YAML of the receiver object.
+
+```ruby
+require 'yps'
+
+yaml = YPS.load(<<~'YAML')
+children:
+  - name: kanta
+    age: 8
+  - name: kaede
+    age: 3
+YAML
+
+# output
+# 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)
+yaml['children'].each do |child|
+  child.each do |key, value|
+    puts "#{key}: #{value} (#{value.position})"
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taichi-ishitani/yps.
+
+* [Issue Tracker](https://github.com/taichi-ishitani/yps/issues)
+* [Pull Requesst](https://github.com/taichi-ishitani/yps/pulls)
+* [Discussion](https://github.com/taichi-ishitani/yps/discussions)
+
+## Copyright & License
+
+Copyright &copy; 2025 Taichi Ishitani.
+YPS is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE.txt](LICENSE.txt) for further details.
+
+## Code of Conduct
+
+Everyone interacting in the YPS project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/taichi-ishitani/yps/blob/master/CODE_OF_CONDUCT.md).

data/lib/yps/node_extension.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module YPS # :nodoc: all
+  module NodeExtension
+    refine Psych::Nodes::Node do
+      attr_accessor :filename
+
+      def mapping_key?
+        @mapping_key || false
+      end
+
+      def mapping_key
+        @mapping_key = true
+      end
+    end
+  end
+end

data/lib/yps/parser.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module YPS # :nodoc: all
+  using NodeExtension
+
+  class Handler < Psych::Handlers::DocumentStream
+    attr_accessor :filename
+
+    def scalar(...)
+      node = super
+
+      # The given value was added to @last.children as a mappking key inside super.
+      # Therefore, it is a mappking key if size of @last.children is odd.
+      if @last.mapping? && @last.children.size.odd?
+        node.mapping_key
+      end
+
+      node
+    end
+
+    def set_start_location(node) # rubocop:disable Naming/AccessorMethodName
+      super
+      node.filename = filename
+    end
+  end
+
+  class Parser < Psych::Parser
+    def initialize(&)
+      super(Handler.new(&))
+    end
+
+    def parse(yaml, filename)
+      @handler.filename = filename
+      super
+    end
+  end
+end

data/lib/yps/value.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module YPS
+  ##
+  # Position is a placeholder retaining position information of a parsed object.
+  #
+  # Fields:
+  # +filename+::
+  #   File name of the original YAML file.
+  # +line+::
+  #   Line number in the original YAML string where a parsed object is started.
+  # +column+::
+  #   Column number in the original YAML string where a parsed object is started.
+  class Position
+    def initialize(filename, line, column) # :nodoc:
+      @filename = filename
+      @line = line
+      @column = column
+      freeze
+    end
+
+    ##
+    # Accessor for the filename of the orignal YAML file
+    attr_reader :filename
+
+    ##
+    # Accessor for the line number where the parsed object is started.
+    attr_reader :line
+
+    ##
+    # Accessor for the column number where the parsed object is started.
+    attr_reader :column
+
+    ##
+    # Return a string representing the position information.
+    def to_s
+      "filename: #{filename || 'unknown'} line #{line} column #{column}"
+    end
+
+    ##
+    # Equality operator.
+    # Check whether or not self and +other+ point the same position.
+    def ==(other)
+      filename == other.filename && line == other.line && column == other.column
+    end
+  end
+
+  ##
+  # Value is a wrapper class for a parsed object and serves two main functions:
+  #
+  # 1. As a placeholder and accessor for the position information of
+  #    the wrapped object (via the #position method).
+  # 2. Forwarding received method calls to the wrapped object.
+  class Value < SimpleDelegator
+    def initialize(value, position) # :nodoc:
+      super(value)
+      @position = position
+    end
+
+    ##
+    # Accessor for the wrapped object
+    def value
+      __getobj__
+    end
+
+    ##
+    # Accessor for the position information of the wrapped object
+    attr_reader :position
+  end
+end

data/lib/yps/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module YPS
+  # The version of YPS
+  VERSION = '0.1.0'
+end

data/lib/yps/visitors.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module YPS # :nodoc: all
+  module Visitors
+    using NodeExtension
+
+    module Common
+      def initialize(scanner, class_loader, value_class, symbolize_names:, freeze:)
+        super(scanner, class_loader, symbolize_names:, freeze:)
+        @value_class = value_class
+      end
+
+      def accept(node)
+        object = super
+        create_wrapped_object(object, node)
+      end
+
+      private
+
+      def create_wrapped_object(object, node)
+        return object if node.document? || node.mapping_key?
+
+        pos = Position.new(node.filename, node.start_line + 1, node.start_column + 1)
+        obj = @value_class.new(object, pos)
+        @freeze && obj.freeze || obj
+      end
+    end
+
+    class ToRuby < Psych::Visitors::ToRuby
+      include Common
+    end
+
+    class NoAliasRuby < Psych::Visitors::NoAliasRuby
+      include Common
+    end
+  end
+end

data/lib/yps.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'psych'
+
+require_relative 'yps/version'
+require_relative 'yps/value'
+require_relative 'yps/node_extension'
+require_relative 'yps/parser'
+require_relative 'yps/visitors'
+
+##
+# = YPS: YAML Positioning Sysmte
+#
+# YPS is a gem to parse YAML and
+# add position information (file name, line and column) to each parsed elements.
+# This is useful for error reporting and debugging,
+# allowing developers to precisely locate an issue within the original YAML file.
+module YPS
+  class << self
+    ##
+    # Safely load the YAML string in +yaml+ and add position information (file name line and column)
+    # to each parsed objects except for hash keys.
+    #
+    # Parsed objects will be wrapped by YPS::Value class to add the accessor returning the position information.
+    # You can use the +value_class+ to specify your own wrapper class.
+    #
+    # Classes which are allowed to be loaded by default are same
+    # as the Psych.safe_load[https://docs.ruby-lang.org/en/master/Psych.html#method-c-safe_load] method.
+    #
+    # Arguments:
+    # +yaml+::
+    #   String or IO object containing the YAML string to be parsed.
+    # +permitted_classes+::
+    #   Array containing additional classes allowed to be loaded.
+    # +permitted_symbols+::
+    #   Array containing Symbols allowed to be loaded. By default, any symbol can be loaded.
+    # +aliases+::
+    #   Aliases can be used if set to true. By default, aliases are not allowed.
+    # +filename+::
+    #   File name string which will be added to the position information of each parsed object.
+    # +fallback+::
+    #   An object which will be returned when an empty YAML string is given.
+    # +symbolize_names+::
+    #   All hash keys will be symbolized if set to true.
+    # +freeze+::
+    #   All parsed objects will be frozen if set to true.
+    # +strict_integer+::
+    #   Integer literals are not allowed to include commas ',' if set to true.
+    #   Such literals will be parsed as String objects.
+    #   For Ruby 3.1, this option is ignored.
+    # +value_class+::
+    #   Specify a class wrapping parsed objects. By default, YPS::Value is used.
+    #
+    # See also Psych.safe_load[https://docs.ruby-lang.org/en/master/Psych.html#method-c-safe_load].
+    def safe_load( # rubocop:disable Metrics/ParameterLists
+      yaml,
+      permitted_classes: [], permitted_symbols: [], aliases: false,
+      filename: nil, fallback: nil, symbolize_names: false, freeze: false,
+      strict_integer: false, value_class: Value
+    )
+      result = parse(yaml, filename)
+      return fallback unless result
+
+      class_loader =
+        Psych::ClassLoader::Restricted.new(
+          permitted_classes.map(&:to_s), permitted_symbols.map(&:to_s)
+        )
+      scanner =
+        if RUBY_VERSION >= '3.2.0'
+          Psych::ScalarScanner.new(class_loader, strict_integer:)
+        else
+          Psych::ScalarScanner.new(class_loader)
+        end
+      visitor =
+        if aliases
+          Visitors::ToRuby.new(scanner, class_loader, value_class, symbolize_names:, freeze:)
+        else
+          Visitors::NoAliasRuby.new(scanner, class_loader, value_class, symbolize_names:, freeze:)
+        end
+
+      visitor.accept(result)
+    end
+
+    ##
+    # Similar to +YPS.safe_load+, but Symbol is allowed to be loaded by default.
+    #
+    # See also Psych.load[https://docs.ruby-lang.org/en/master/Psych.html#method-c-load].
+    def load(yaml, permitted_classes: [Symbol], **kwargs)
+      safe_load(yaml, permitted_classes:, **kwargs)
+    end
+
+    ##
+    # Similar to +YPS.safe_load+, but the YAML string is read from the file specified by the +filename+ argument.
+    #
+    # See also YPS.safe_load
+    def safe_load_file(filename, **kwargs)
+      File.open(filename, 'r:bom|utf-8') do |f|
+        safe_load(f, filename:, **kwargs)
+      end
+    end
+
+    ##
+    # Similar to +YPS.load+, but the YAML string is read from the file specified by the +filename+ argument.
+    #
+    # See also YPS.load
+    def load_file(filename, **kwargs)
+      File.open(filename, 'r:bom|utf-8') do |f|
+        load(f, filename:, **kwargs)
+      end
+    end
+
+    private
+
+    def parse(yaml, filename)
+      Parser
+        .new { |node| return node }
+        .parse(yaml, filename)
+
+      false
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: yps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taichi Ishitani
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: YPS is a gem to parse YAML and add position information (file name, line
+  and column) to each parsed elements. This is useful for error reporting and debugging,
+  allowing developers to precisely locate an issue within the original YAML file.
+email:
+- taichi730@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/yps.rb
+- lib/yps/node_extension.rb
+- lib/yps/parser.rb
+- lib/yps/value.rb
+- lib/yps/version.rb
+- lib/yps/visitors.rb
+homepage: https://github.com/taichi-ishitani/yps
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/taichi-ishitani/yps
+  source_code_uri: https://github.com/taichi-ishitani/yps
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--main"
+- README.md
+- "--title"
+- 'YPS: YAML Positioning System'
+- "--show-hash"
+- "--line-numbers"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: 'YPS: YAML Positioning System'
+test_files: []