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.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OOXMLObjectClassMethods

#define_attribute, #define_child_node, #define_element_name, #obtain_class_variable, #parse, #set_countable

Methods included from OOXMLObjectInstanceMethods

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

Class Method Details

.parse_file(dirpath) ⇒ 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.



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

def self.parse_file(dirpath)
  full_path = File.join(dirpath, xlsx_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) }
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('xmlns'   => 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
               'xmlns:r' => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships')



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

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

.xlsx_path ⇒ Object 



395
396
397
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 395

def self.xlsx_path
  raise 'Subclass responsebility'
end

Instance Method Details

#add_to_zip(zipfile) ⇒ 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.



423
424
425
426
427
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 423

def add_to_zip(zipfile)
  xml_string = write_xml
  return if xml_string.empty?
  zipfile.get_output_stream(self.xlsx_path) { |f| f << xml_string }
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.



391
392
393
 
# File 'lib/rubyXL/objects/ooxml_object.rb', line 391

def xlsx_path
  self.class.xlsx_path
end