Contents

module IMW
  module Formats

    # Provides methods for reading and writing YAML data.
    module Yaml

      include Enumerable

      # Return the content of this resource.
      #
      # Will pass a block to the outermost YAML data structure's each
      # method.
      #
      # @return [Hash, Array, String, Fixnum] whatever the YAML contained
      def load &block
        require 'yaml'
        yaml = YAML.load(io)
        if block_given?
          yaml.each(&block)
        else
          yaml
        end
      end

      # Iterate over the elements in the YAML.
      def each &block
        load(&block)
      end
      
      # Dump the +data+ into this resource.  It must be opened for
      # writing.
      #
      # @param [Hash, String, Array, Fixnum] data the Ruby object to dump
      # @option options [true, false] :persist (false) Don't close the IO object after writing
      def dump data, options={}
        require 'yaml'
        write(data.to_yaml)
        io.close unless options[:persist]
        self
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
imw-0.2.7	lib/imw/formats/yaml.rb
imw-0.2.6	lib/imw/formats/yaml.rb
imw-0.2.5	lib/imw/formats/yaml.rb