Module: XML::Smart

Defined in:
lib/xml/smart.rb,
lib/xml/smart_dom.rb,
lib/xml/smart_qname.rb,
lib/xml/smart_domtext.rb,
lib/xml/smart_domother.rb,
lib/xml/smart_domelement.rb,
lib/xml/smart_domnodeset.rb,
lib/xml/smart_domattribute.rb,
lib/xml/smart_domnamespace.rb,
lib/xml/smart_domattributeset.rb,
lib/xml/smart_domnamespaceset.rb,
lib/xml/smart_processinginstruction.rb

Defined Under Namespace

Classes: Dom, Error, ProcessingInstruction, QName

Constant Summary collapse

VERSION = 


LIBXML_VERSION =





MUTEX =



Mutex.new


COPY =



0


MOVE =



1





Class Method Summary
collapse





Instance Method Summary
collapse






Class Method Details





.modify(name, default = nil, &block) ⇒ Object













Raises:










120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154




# File 'lib/xml/smart.rb', line 120

def self::modify(name,default=nil,&block)
  raise Error, 'first parameter has to be a filename or filehandle' unless name.is_a?(String) || name.is_a?(IO) || name.is_a?(Tempfile)
  raise Error, 'a block is mandatory' unless block_given?
  dom = io = nil
  begin
    if name.is_a?(String) && File.exists?(name)
      MUTEX.synchronize do
        io = ::Kernel::open(name,'r+')
        io.flock(File::LOCK_EX)
      end  
      dom = Dom.new Nokogiri::XML::parse(io){|config| config.noblanks.noent.nsclean.strict }
      io.rewind
    elsif name.is_a?(String) && !File.exists?(name)
      MUTEX.synchronize do
        io = ::Kernel::open(name,'w')
        io.flock(File::LOCK_EX)
      end  
      dom = Smart::string(default)
    elsif name.is_a?(IO) || name.is_a?(Tempfile)  
      MUTEX.synchronize do
        io = name
        io.flock(File::LOCK_EX)
      end
      dom = Dom.new Nokogiri::XML::parse(io){|config| config.noblanks.noent.nsclean.strict }
    end
    block.call(dom)
    dom.save_as(io)
  rescue => e
    puts e.message
    raise Error, "could not open #{name}"
  ensure
    io.flock(File::LOCK_UN) if io
  end
  nil
end












.open(name, default = nil) ⇒ Object













Raises:










156
157
158
159
160
161
162
163
164
165
166




# File 'lib/xml/smart.rb', line 156

def self::open(name,default=nil)
  raise Error, 'first parameter has to be a filename or filehandle' unless name.is_a?(String) || name.is_a?(IO) || name.is_a?(Tempfile)
  raise Error, 'second parameter has to be an xml string' unless default.is_a?(String) || default.nil?
  dom = Smart::open_unprotected(name,default,true)
  if dom && block_given?
    yield dom
    nil
  else  
    dom
  end
end












.open_unprotected(name, default = nil, lock = false) ⇒ Object













Raises:










168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193




# File 'lib/xml/smart.rb', line 168

def self::open_unprotected(name,default=nil,lock=false)
  raise Error, 'first parameter has to be a filename or filehandle' unless name.is_a?(String) || name.is_a?(IO) || name.is_a?(Tempfile)
  raise Error, 'second parameter has to be an xml string' unless default.is_a?(String) || default.nil?
  dom = begin
    io = name.is_a?(String) ? ::Kernel::open(name) : name
    begin
      io.flock(File::LOCK_EX) if lock
      Dom.new Nokogiri::XML::parse(io){|config| config.noblanks.noent.nsclean.strict }
    ensure
      io.flock(File::LOCK_UN)
    end
  rescue => e
    if default.nil?
      puts e.message
      raise Error, "could not open #{name}"
    else
      Smart::string(default)
    end
  end
  if block_given?
    yield dom
    nil
  else  
    dom
  end
end












.string(str) ⇒ Object













Raises:










195
196
197
198
199
200
201
202
203
204




# File 'lib/xml/smart.rb', line 195

def self::string(str)
  raise Error, 'first parameter has to be stringable (:to_s)' unless str.is_a?(String)
  dom = Dom.new Nokogiri::XML::parse(str.to_s){|config| config.noblanks.noent.nsclean.strict }
  if block_given?
    yield dom
    nil
  else  
    dom
  end
end













Instance Method Details





#initialize(name, default = nil) ⇒ Object










118




# File 'lib/xml/smart.rb', line 118

def initialize(name,default=nil); open(name,default); end