lib/axlsx/workbook/workbook.rb in axlsx-1.0.17 vs lib/axlsx/workbook/workbook.rb in axlsx-1.0.18

- old
+ new

@@ -1,16 +1,18 @@ # -*- coding: utf-8 -*- -module Axlsx +module Axlsx +require 'axlsx/workbook/worksheet/date_time_converter.rb' require 'axlsx/workbook/worksheet/cell.rb' +require 'axlsx/workbook/worksheet/page_margins.rb' require 'axlsx/workbook/worksheet/row.rb' require 'axlsx/workbook/worksheet/worksheet.rb' require 'axlsx/workbook/shared_strings_table.rb' # The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles. # The following parts of the Office Open XML spreadsheet specification are not implimented in this version. - # + # # bookViews # calcPr # customWorkbookViews # definedNames # externalReferences @@ -36,17 +38,17 @@ # Using this option will increase the time required to serialize the document as every string in every cell must be analzed and referenced. # @return [Boolean] attr_reader :use_shared_strings # @see use_shared_strings - def use_shared_strings=(v) + def use_shared_strings=(v) Axlsx::validate_boolean(v) @use_shared_strings = v end - # A collection of worksheets associated with this workbook. + # A collection of worksheets associated with this workbook. # @note The recommended way to manage worksheets is add_worksheet # @see Workbook#add_worksheet # @see Worksheet # @return [SimpleTypedList] attr_reader :worksheets @@ -84,43 +86,35 @@ # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used. @@date1904 = false - # lets come back to this later when we are ready for parsing. + # lets come back to this later when we are ready for parsing. #def self.parse entry # io = entry.get_input_stream # w = self.new # w.parser_xml = Nokogiri::XML(io.read) - # w.parse_string :date1904, "//xmlns:workbookPr/@date1904" + # w.parse_string :date1904, "//xmlns:workbookPr/@date1904" # w #end # Creates a new Workbook # The recomended way to work with workbooks is via Package#workbook - # @option options [Boolean] date1904. If this is not specified, we try to determine if the platform is bsd/darwin and set date1904 to true automatically. + # @option options [Boolean] date1904. If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false. def initialize(options={}) @styles = Styles.new @worksheets = SimpleTypedList.new Worksheet @drawings = SimpleTypedList.new Drawing @charts = SimpleTypedList.new Chart @images = SimpleTypedList.new Pic - self.date1904= options[:date1904].nil? ? is_bsd? : options[:date1904] - yield self if block_given? + self.date1904= !options[:date1904].nil? && options[:date1904] + yield self if block_given? end - # Uses RUBY_PLATFORM constant to determine if the OS is freebsd or darwin - # based on this value we attempt to set date1904. - # @return [Boolean] - def is_bsd? - platform = RUBY_PLATFORM.downcase - platform.include?('freebsd') || platform.include?('darwin') - end - # Instance level access to the class variable 1904 # @return [Boolean] - def date1904() @@date1904; end + def date1904() @@date1904; end # see @date1904 def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end # Sets the date1904 attribute to the provided boolean @@ -132,10 +126,11 @@ def self.date1904() @@date1904; end # Adds a worksheet to this workbook # @return [Worksheet] # @option options [String] name The name of the worksheet. + # @option options [Hash] page_margins The page margins for the worksheet. # @see Worksheet#initialize def add_worksheet(options={}) worksheet = Worksheet.new(self, options) yield worksheet if block_given? worksheet @@ -145,11 +140,11 @@ # @return [Relationships] def relationships r = Relationships.new @worksheets.each do |sheet| r << Relationship.new(WORKSHEET_R, WORKSHEET_PN % (r.size+1)) - end + end r << Relationship.new(STYLES_R, STYLES_PN) if use_shared_strings r << Relationship.new(SHARED_STRINGS_R, SHARED_STRINGS_PN) end r @@ -160,34 +155,39 @@ def shared_strings SharedStringsTable.new(worksheets.collect { |ws| ws.cells }) end # returns a range of cells in a worksheet - # @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to + # @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to # retrieve the cells from. e.g. range('Sheet1!A1:B2') will return an array of four cells [A1, A2, B1, B2] while range('Sheet1!A1') will return a single Cell. # @return [Cell, Array] def [](cell_def) sheet_name = cell_def.split('!')[0] if cell_def.match('!') worksheet = self.worksheets.select { |s| s.name == sheet_name }.first - raise ArgumentError, 'Unknown Sheet' unless sheet_name && worksheet.is_a?(Worksheet) + raise ArgumentError, 'Unknown Sheet' unless sheet_name && worksheet.is_a?(Worksheet) worksheet[cell_def.gsub(/.+!/,"")] end # Serializes the workbook document # @return [String] def to_xml() add_worksheet unless worksheets.size > 0 - builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml| + builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml| xml.workbook(:xmlns => XML_NS, :'xmlns:r' => XML_NS_R) { xml.workbookPr(:date1904=>@@date1904) #<x:workbookProtection workbookPassword="xsd:hexBinary data" lockStructure="1" lockWindows="1" /> + # Required to support rubyXL parsing as it requires sheetView, which requires this. + # and removed because it seems to cause some odd [Grouped] behaviour in excel. + # xml.bookViews { + # xml.workbookView :activeTab=>0 + # } xml.sheets { - @worksheets.each_with_index do |sheet, index| + @worksheets.each_with_index do |sheet, index| xml.sheet(:name=>sheet.name, :sheetId=>index+1, :"r:id"=>sheet.rId) end } } - end + end builder.to_xml(:save_with => 0) end end end