yaml-safe_load_stream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6667796ca4fc279cf5671884e050f362480e906969e7e0ecaad671020bfe4e5
+  data.tar.gz: b74152ff619992542f3e28d490778b93543ccbb62d61155725132b2e816adb01
+SHA512:
+  metadata.gz: b620a941b386afed374694009031a9dbdea7a2479adfa5e485f6bfd3c2b8be502dc0e29383dd1b1f07c0443d544e28eeaa2d03b95dfd50104036de9da128fac1
+  data.tar.gz: bfd7f20f5f0b24d3271a7743feefdf02ef5b807b82ac491edd41296598b8851a861f09317577fcde7a6adf0bf9223ace762381d6d079474dbef199db13025745

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Kontena Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,82 @@
+# YAMLSafeLoadStream
+[![Build Status](https://travis-ci.org/kontena/yaml-safe_load_stream.svg?branch=master)](https://travis-ci.org/kontena/yaml-safe_load_stream)
+[![Gem Version](https://badge.fury.io/rb/yaml-safe_load_stream.svg)](https://badge.fury.io/rb/yaml-safe_load_stream)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/kontena/yaml-safe_load_stream/master)
+
+The Ruby standard library YAML/Psych module defines `YAML.safe_load` for safely loading YAML documents
+
+There's also `YAML.load_stream` for loading multi-document streams.
+
+The problem is, there's no `YAML.safe_load_stream` that would safely load a stream with multiple documents.
+
+This gem adds a very bare bones implementation of that missing feature.
+
+## Usage
+
+There is just one method: `safe_load_stream(yaml_content, optional_filename_to_be_used_in_exception_messages)`
+
+When used with a block, it will yield each document separately:
+
+```ruby
+YAMLSafeLoadStream.safe_load_stream("---\nhello: world\n\n---\nhello: universe\n") do |document|
+  puts document.inspect
+end
+
+# outputs:
+# { 'hello' => 'world' }
+# { 'hello' => 'universe' }
+```
+
+When used without a block, it will return an Array containing documents in the stream:
+
+```ruby
+docs = YAMLSafeLoadStream.safe_load_stream("---\nhello: world\n\n---\nhello: universe\n")
+puts docs.inspect
+
+# outputs:
+# [{ 'hello' => 'world' }, { 'hello' => 'universe' }]
+```
+
+### Directly
+
+```ruby
+require 'yaml/safe_load_stream'
+
+YAMLSafeLoadStream.safe_load_stream("---\nhello: world\n\n---\nhello: universe\n")
+```
+
+### As a refinement
+
+```ruby
+require 'yaml/safe_load_stream'
+using YAMLSafeLoadStream
+
+YAML.safe_load_stream("---\nhello: world\n\n---\nhello: universe\n")
+```
+
+### Requiring the `core-ext`
+
+```ruby
+require 'yaml/safe_load_stream/core-ext'
+YAML.safe_load_stream("---\nhello: world\n\n---\nhello: universe\n")
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaml-safe_load_stream'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml-safe_load_stream
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/yaml-safe_load_stream

data/lib/yaml/safe_load_stream/core-ext.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'yaml/safe_load_stream'
+
+module YAML
+  def self.safe_load_stream(*args, &block)
+    YAMLSafeLoadStream.safe_load_stream(*args, &block)
+  end
+end

data/lib/yaml/safe_load_stream.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module YAMLSafeLoadStream
+  # A safe version of YAML.load_stream.
+  # Parses a multi document stream and raises if it tries to instantiate any
+  # non-standard classes
+  #
+  # @param yaml [String] yaml content
+  # @param filename [String] filename to be used in exception messages
+  # @yield [document] each document in the stream is yielded if a block is given
+  # @return [Array] when a block is not given, returns an Array of documents
+  module_function def safe_load_stream(yaml, filename = nil)
+    streams = []
+    ::YAML.parse_stream(yaml, filename) do |stream|
+      raise_if_tags(stream, filename)
+      if block_given?
+        yield stream.to_ruby
+      else
+        streams << stream.to_ruby
+      end
+    end
+    streams unless block_given?
+  end
+
+  module_function def raise_if_tags(obj, filename = nil, doc_num = 1)
+    doc_num += 1 if obj.is_a?(Psych::Nodes::Document)
+
+    if obj.respond_to?(:tag)
+      tag = obj.tag
+      unless tag.nil?
+        unless tag.to_s.start_with?('tag:yaml.org,')
+          message = "tag #{tag} encountered "
+          message += if obj.respond_to?(:start_line)
+                       "on line #{obj.start_line} column #{obj.start_column} of document #{doc_num}"
+                     else
+                       "in document #{doc_num}"
+                     end
+          message += " in file #{filename}" if filename
+          raise Psych::DisallowedClass, message
+        end
+      end
+    end
+
+    return unless obj.respond_to?(:children)
+
+    Array(obj.children).each do |child|
+      raise_if_tags(child, filename, doc_num)
+    end
+  end
+  private_class_method :raise_if_tags
+
+  refine ::YAML.singleton_class do
+    def safe_load_stream(*args, &block)
+      ::YAMLSafeLoadStream.safe_load_stream(*args, &block)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: yaml-safe_load_stream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kimmo Lehto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The Ruby standard library defines YAML.safe_load and YAML.load_stream
+  but there's no way to safely load a multi document stream. This Gem adds YAML.safe_load_stream.
+email:
+- info@kontena.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/yaml/safe_load_stream.rb
+- lib/yaml/safe_load_stream/core-ext.rb
+homepage: https://github.com/kontena/yaml-safe_load_stream
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.0
+signing_key: 
+specification_version: 4
+summary: Adds YAML.safe_load_stream for safely parsing multi-document YAML streams
+test_files: []