lib/rbyaml.rb

   1 # Copyright (c) 2006 Ola Bini
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  19 # SOFTWARE.
  20
  21 require 'rbyaml/yaml'
  22 require 'rbyaml/stream'
  23 require 'rbyaml/dumper'
  24
  25 module RbYAML
  26   def self.dump(obj, io = nil, opts={})
  27     _dump(obj,io,Dumper,opts)
  28   end
  29
  30   def self.load( io )
  31     _load(io) rescue false
  32   end
  33
  34   def self.load_file( filepath )
  35     File.open( filepath ) do |f|
  36       load( f )
  37     end
  38   end
  39
  40   # this operation does not make sense in RbYAML (right now)
  41   def self.parse( io )
  42     raise NotImplementedError
  43     #    yp = @@parser.new( :Model => :Generic ).load( io )
  44   end
  45
  46   # this operation does not make sense in RbYAML (right now)
  47   def self.parse_file( filepath )
  48     raise NotImplementedError
  49     #    File.open( filepath ) do |f|
  50     #      parse( f )
  51     #    end
  52   end
  53
  54   def self.each_document( io, &block )
  55     _load_all(io,&block)
  56   end
  57
  58   def self.load_documents( io, &doc_proc )
  59     each_document( io, &doc_proc )
  60   end
  61
  62   # this operation does not make sense in RbYAML (right now)
  63   def self.each_node( io, &doc_proc )
  64     raise NotImplementedError
  65     #    yp = @@parser.new( :Model => :Generic ).load_documents( io, &doc_proc )
  66   end
  67
  68   # this operation does not make sense in RbYAML (right now)
  69   def self.parse_documents( io, &doc_proc )
  70     raise NotImplementedError
  71     #    YAML.each_node( io, &doc_proc )
  72   end
  73
  74   def self.load_stream( io )
  75     d = nil
  76     load_documents(io) { |doc|
  77       d = Stream.new( nil ) if not d
  78       d.add( doc )
  79     }
  80     d
  81   end
  82
  83   def self.dump_stream( *objs )
  84     d = RbYAML::Stream.new
  85     objs.each do |doc|
  86       d.add( doc )
  87     end
  88     d.emit
  89   end
  90
  91
  92   def self.add_builtin_ctor(type_tag, &transfer_proc)
  93     BaseConstructor::add_constructor("tag:yaml.org,2002:#{ type_tag }",transfer_proc)
  94   end
  95
  96   # this operation does not make sense in RbYAML (right now)
  97   def self.add_domain_type( domain, type_re, &transfer_proc )
  98     raise NotImplementedError
  99     #    @@loader.add_domain_type( domain, type_re, &transfer_proc )
 100   end
 101
 102   # this operation does not make sense in RbYAML (right now)
 103   def self.add_builtin_type( type_re, &transfer_proc )
 104     raise NotImplementedError
 105     #    @@loader.add_builtin_type( type_re, &transfer_proc )
 106   end
 107
 108   # this operation does not make sense in RbYAML (right now)
 109   def self.add_ruby_type( type_tag, &transfer_proc )
 110     raise NotImplementedError
 111     #    @@loader.add_ruby_type( type, &transfer_proc )
 112   end
 113
 114   # this operation does not make sense in RbYAML (right now)
 115   def self.add_private_type( type_re, &transfer_proc )
 116     raise NotImplementedError
 117     #    @@loader.add_private_type( type_re, &transfer_proc )
 118   end
 119
 120   def self.detect_implicit( val )
 121     SimpleDetector.detect(val)
 122   end
 123
 124   # Convert a type_id to a taguri
 125   def self.tagurize(val)
 126     val.class == String ? "#{RbYAML::Parser::DEFAULT_TAGS["!!"]}#{val}" : val
 127   end
 128
 129   # this operation does not make sense in RbYAML (right now)
 130   def self.transfer( type_id, obj )
 131     raise NotImplementedError
 132     #    @@loader.transfer( type_id, obj )
 133   end
 134
 135   # this operation does not make sense in RbYAML (right now)
 136   def self.try_implicit( obj )
 137     raise NotImplementedError
 138     #    YAML.transfer( YAML.detect_implicit( obj ), obj )
 139   end
 140
 141   def self.read_type_class( type, obj_class )
 142     scheme, domain, type, tclass = type.split( ':', 4 )
 143     tclass.split( "::" ).each { |c| obj_class = obj_class.const_get( c ) } if tclass
 144     return [ type, obj_class ]
 145   end
 146
 147   def self.object_maker( obj_class, val )
 148     if Hash === val
 149       o = obj_class.allocate
 150       val.each_pair { |k,v|
 151         o.instance_variable_set("@#{k}", v)
 152       }
 153       o
 154     else
 155       raise YAMLError, "Invalid object explicitly tagged !ruby/Object: " + val.inspect
 156     end
 157   end
 158
 159   def self.quick_emit(oid, opts = {})
 160     if Dumper === opts then
 161       rep = opts
 162     else
 163       stream = StringIO.new
 164       dumper = Dumper.new stream, opts
 165       dumper.serializer.open
 166       rep = dumper.representer
 167     end
 168
 169     node = RbYAML.quick_emit_node oid, rep do |out|
 170       yield out
 171
 172       #map = {}
 173       #to_yaml_properties.each do |m|
 174       #  map[m[1..-1]] = instance_variable_get(m)
 175       #end
 176       #out.map taguri, map, to_yaml_style
 177     end
 178
 179     dumper.serializer.serialize node
 180
 181     dumper.serializer.close
 182     stream.string
 183   end
 184
 185   def self.quick_emit_node( oid, rep, &e )
 186     e.call(rep)
 187   end
 188 end
 189
 190 require 'rbyaml/tag'
 191 require 'rbyaml/types'
 192 require 'rbyaml/rubytypes'