psych-pure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8599351cebdf6abf0c3438762b7f56a0110fafda0a4c857618305085425805d9
+  data.tar.gz: c9975fe7570058d7aae9a64a46601e8720d46679dfa538290ff45fecf3b3842e
+SHA512:
+  metadata.gz: c964ce5739215506401fd0c7eca965932a54adb4f3c6e5d56f89a5bafe00d98b71b7fe9f8621adc8e5eb403a23a2b7813cee2bf5d88006929ff4d47c5ed5500d
+  data.tar.gz: 55ead208f357b2f52267f505610815fc248ca8e8fbbc248d57ad8a6c7c40d56f7fadea28f7e1a13bbef18d47fe09783076c1d5ed73c87c4f2a36a50c5541bdc3

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2020-10-08
+
+### Added
+
+- 🎉 Initial release. 🎉
+
+[unreleased]: https://github.com/kddnewton/psych-pure/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/kddnewton/psych-pure/compare/24de62...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kddnewton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-present Kevin Newton
+
+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,66 @@
+# Psych::Pure
+
+[![Build Status](https://github.com/kddnewton/psych-pure/workflows/Main/badge.svg)](https://github.com/kddnewton/psych-pure/actions)
+[![Gem Version](https://img.shields.io/gem/v/psych-pure.svg)](https://rubygems.org/gems/psych-pure)
+
+`Psych::Pure` is a YAML library written in Ruby. It functions as an extension of `Psych`, the main CRuby YAML library. The circumstances under which you may choose this library are:
+
+* You have some issue installing `libyaml` and/or you want to avoid a native dependency.
+* You have a need to parse comments from YAML source and/or to write comments out to YAML source.
+* You need to parse exactly according to the YAML 1.2 spec.
+
+Note that this library comes with a couple of caveats:
+
+* It will only parse YAML 1.2. Other previous versions are unsupported.
+* It will only parse UTF-8 strings. Other unicode encodings are unsupported.
+* The parser is significantly slower and less efficient than `Psych::Parser`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "psych-pure"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install psych-pure
+
+## Usage
+
+`Psych::Pure` largely mirrors the various `Psych` APIs. The main entrypoints are:
+
+* `Psych::Pure.parse(source)` - parses a YAML string into a YAML syntax tree
+* `Psych::Pure.load(source)` - loads a YAML string into a Ruby object
+* `Psych::Pure.dump(object)` - dumps a Ruby object to a YAML string
+
+All of the various `parse` APIs come with the additional `comments:` keyword option. This option tells the parser to parse out comments and attach them to the resulting tree. Nodes in the tree are then responsible for maintaining their own leading and trailing comments.
+
+All of the various `load` APIs also come with the additional `comments:` keyword option. This also gets fed into the parser. Because `load` is responsible for loading Ruby objects, the comments are then attached to the loaded objects via `Psych::Pure::YAMLCommentsDelegator`, which is a `SimpleDelegator` that wraps the objects and stores the leading and trailing comments. Those objects are then taken into account in the various `dump` APIs to dump out the comments as well. For example:
+
+```ruby
+result = Psych::Pure.load("- a # comment1\n- c # comment2\n", comments: true)
+# => ["a", "c"]
+
+result.insert(1, "b")
+# => ["a", "b", "c"]
+
+puts Psych::Pure.dump(result)
+# ---
+# - a # comment1
+# - b
+# - c # comment2
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/psych-pure.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/psych/pure/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Psych
+  module Pure
+    VERSION = "0.1.0"
+  end
+end