Class: RubyXL::OOXMLTopLevelObject

Inherits:
OOXMLObject show all
Defined in:
lib/rubyXL/objects/ooxml_object.rb

Overview

Extension class providing functionality for top-level OOXML objects that are represented by their own .xml files in .xslx zip container.

Constant Summary collapse

SAVE_ORDER = 
500
ROOT = 
::Pathname.new('/')

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OOXMLObjectInstanceMethods

#before_write_xml, #dup, included, #index_in_collection, #initialize, #write_xml

Instance Attribute Details

#root ⇒ Object

Returns the value of attribute root.



401
402
403
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 401

def root
  @root
end

Class Method Details

.parse_file(dirpath, file_path = nil) ⇒ Object

Generates the top-level OOXML object by parsing its XML file from the temporary directory containing the unzipped contents of .xslx

Parameters

  • dirpath - path to the directory with the unzipped .xslx contents.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 423

def self.parse_file(dirpath, file_path = nil)
  file_path = file_path || self.xlsx_path

  case dirpath
  when String then
    full_path = File.join(dirpath, file_path)
    return nil unless File.exist?(full_path)
    # Making sure that the file will be automatically closed immediately after it has been read
    File.open(full_path, 'r') { |f| parse(f) }
  when Zip::File then
    file_path = file_path.relative_path_from(::Pathname.new("/")) if file_path.absolute? # Zip doesn't like absolute paths.
    entry = dirpath.find_entry(file_path)
    # Accomodate for Nokogiri Java implementation which is incapable of reading from a stream
    entry && (entry.get_input_stream { |f| parse(defined?(JRUBY_VERSION) ? f.read : f) })
  end
end

.set_namespaces(namespace_hash) ⇒ Object

Sets the list of namespaces on this object to be added when writing out XML. Valid only on top-level objects.

Parameters

  • namespace_hash - Hash of namespaces in the form of "prefix" => "url"

Examples

set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => '',
               'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r')



415
416
417
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 415

def self.set_namespaces(namespace_hash)
  self.class_variable_set(:@@ooxml_namespaces, namespace_hash)
end

Instance Method Details

#add_to_zip(zip_stream) ⇒ Object

Saves the contents of the object as XML to respective location in .xslx zip container.

Parameters

  • zipfile - ::Zip::File to which the resulting XNMML should be added.



443
444
445
446
447
448
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 443

def add_to_zip(zip_stream)
  xml_string = write_xml
  return if xml_string.empty?
  zip_stream.put_next_entry(self.xlsx_path.relative_path_from(::Pathname.new("/")))
  zip_stream.write(xml_string)
end

#file_index ⇒ Object 



450
451
452
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 450

def file_index
  root.rels_hash[self.class].index{ |f| f.equal?(self) }.to_i + 1
end

#xlsx_path ⇒ Object

Prototype method. For top-level OOXML object, returns the path at which the current object’s XML file is located within the .xslx zip container.



405
406
407
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 405

def xlsx_path
  raise 'Subclass responsebility'
end