Contents

# frozen_string_literal: true

class Pathname

  # Parses the contents of the file indicated by the Pathname as YAML.
  # The returned result will composed of only basic data types, e.g.
  # +nil+, +true+, +false+, +Numeric+, +String+, +Array+, and +Hash+.
  #
  # @example
  #   File.write("in.yaml", "key: value")
  #
  #   Pathname.new("in.yaml").read_yaml  # == { "key" => "value" }
  #
  # @return [nil, true, false, Numeric, String, Array, Hash]
  def read_yaml
    self.open("r") do |f|
      # HACK fix Ruby 2.6 warning, but still support Ruby < 2.6
      if Gem::Version.new(Psych::VERSION) >= Gem::Version.new("3.1.0.pre1")
        YAML.safe_load(f, filename: self)
      else
        YAML.safe_load(f, [], [], false, self)
      end
    end
  end

  # Parses the contents of the file indicated by the Pathname as YAML,
  # deserializing arbitrary data types via type information embedded in
  # the YAML.  This is *UNSAFE* for YAML from an untrusted source.  To
  # consume untrusted YAML, use {Pathname#read_yaml} instead.
  #
  # @example
  #   Point = Struct.new(:x, :y)
  #   point = Point.new(10, 20)
  #   File.write("in.yaml", point.to_yaml)
  #
  #   Pathname.new("in.yaml").load_yaml  # == Point.new(10, 20)
  #
  # @return [Object]
  def load_yaml
    YAML.load_file(self)
  end

end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
pleasant_path-1.3.0	lib/pleasant_path/yaml/pathname.rb