bonio-axlsx 2.2.1

data/lib/axlsx/drawing/val_axis.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+module Axlsx
+  # the ValAxis class defines a chart value axis.
+  class ValAxis < Axis
+
+    # This element specifies how the value axis crosses the category axis.
+    # must be one of [:between, :midCat]
+    # @return [Symbol]
+    attr_reader :cross_between
+    alias :crossBetween :cross_between
+
+    # Creates a new ValAxis object
+    # @option options [Symbol] crosses_between
+    def initialize(options={})
+      self.cross_between = :between
+      super(options)
+    end
+
+    # @see cross_between
+    def cross_between=(v)
+      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
+      @cross_between = v
+    end
+    alias :crossBetween= :cross_between=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:valAx>'
+      super(str)
+      str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
+      str << '</c:valAx>'
+    end
+
+  end
+end

data/lib/axlsx/drawing/view_3D.rb

@@ -0,0 +1,115 @@
+# encoding: UTF-8
+module Axlsx
+  # 3D attributes for a chart.
+  class View3D
+
+    include Axlsx::OptionsParser
+
+    # Creates a new View3D for charts
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
+    # @option options [Integer] perspective
+    def initialize(options={})
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
+      parse_options options
+    end
+
+    # Validation for hPercent
+    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)/
+
+    # validation for depthPercent
+    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)/
+
+    # x rotation for the chart
+    # must be between -90 and 90
+    # @return [Integer]
+    attr_reader :rot_x
+    alias :rotX :rot_x
+
+    # height of chart as % of chart width
+    # must be between 5% and 500%
+    # @return [String]
+    attr_reader :h_percent
+    alias :hPercent :h_percent
+
+    # y rotation for the chart
+    # must be between 0 and 360
+    # @return [Integer]
+    attr_reader :rot_y
+    alias :rotY :rot_y
+
+    # depth or chart as % of chart width
+    # must be between 20% and 2000%
+    # @return [String]
+    attr_reader :depth_percent
+    alias :depthPercent :depth_percent
+
+    # Chart axis are at right angles
+    # @return [Boolean]
+    attr_reader :r_ang_ax
+    alias :rAngAx :r_ang_ax
+
+    # field of view angle
+    # @return [Integer]
+    attr_reader :perspective
+
+    # @see rot_x
+    def rot_x=(v)
+      RangeValidator.validate "View3D.rot_x", -90, 90, v
+      @rot_x = v
+    end
+    alias :rotX= :rot_x=
+
+      # @see h_percent
+      def h_percent=(v)
+        RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+        @h_percent = v
+      end
+    alias :hPercent= :h_percent=
+
+      # @see rot_y
+      def rot_y=(v) 
+        RangeValidator.validate "View3D.rot_y", 0, 360, v
+        @rot_y = v
+      end
+    alias :rotY= :rot_y=
+
+      # @see depth_percent
+      def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    alias :depthPercent= :depth_percent=
+
+      # @see r_ang_ax
+      def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    alias :rAngAx= :r_ang_ax=
+
+      # @see perspective
+      def perspective=(v)
+        RangeValidator.validate "View3D.perspective", 0, 240, v
+        @perspective = v
+      end
+
+    # DataTypeValidator.validate "#{self.class}.perspective", [Integer], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:view3D>'
+      %w(rot_x h_percent rot_y depth_percent r_ang_ax perspective).each do |key|
+        str << element_for_attribute(key, 'c')
+      end
+      str << '</c:view3D>'
+    end
+
+    private
+    # Note: move this to Axlsx module if we find the smae pattern elsewhere.
+    def element_for_attribute(name, namespace='')
+      val = instance_values[name]
+      return "" if val == nil
+      "<%s:%s val='%s'/>" % [namespace, Axlsx::camel(name, false), val]
+    end
+  end
+end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -0,0 +1,42 @@
+module Axlsx
+
+  # a vml drawing used for comments in excel.
+  class VmlDrawing
+
+    # creates a new Vml Drawing object.
+    # @param [Comments] comments the comments object this drawing is associated with
+    def initialize(comments)
+      raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
+      @comments = comments
+    end
+
+    # The part name for this vml drawing
+    # @return [String]
+    def pn
+      "#{VML_DRAWING_PN}" % (@comments.worksheet.index + 1)
+    end
+
+    # serialize the vml_drawing to xml.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << <<BAD_PROGRAMMER
+<xml xmlns:v="urn:schemas-microsoft-com:vml"
+ xmlns:o="urn:schemas-microsoft-com:office:office"
+ xmlns:x="urn:schemas-microsoft-com:office:excel">
+ <o:shapelayout v:ext="edit">
+  <o:idmap v:ext="edit" data="#{@comments.worksheet.index+1}"/>
+ </o:shapelayout>
+ <v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202"
+  path="m0,0l0,21600,21600,21600,21600,0xe">
+  <v:stroke joinstyle="miter"/>
+  <v:path gradientshapeok="t" o:connecttype="rect"/>
+ </v:shapetype>
+BAD_PROGRAMMER
+      @comments.each { |comment| comment.vml_shape.to_xml_string str }
+      str << "</xml>"
+
+    end
+
+  end
+end

data/lib/axlsx/drawing/vml_shape.rb

@@ -0,0 +1,66 @@
+module Axlsx
+
+  # A VmlShape is used to position and render a comment.
+  class VmlShape
+
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+
+    # Creates a new VmlShape
+    # @option options [Integer] row
+    # @option options [Integer] column
+    # @option options [Integer] left_column
+    # @option options [Integer] left_offset
+    # @option options [Integer] top_row
+    # @option options [Integer] top_offset
+    # @option options [Integer] right_column
+    # @option options [Integer] right_offset
+    # @option options [Integer] bottom_row
+    # @option options [Integer] bottom_offset
+    def initialize(options={})
+      @row = @column = @left_column = @top_row = @right_column = @bottom_row = 0
+      @left_offset = 15
+      @top_offset = 2
+      @right_offset = 50
+      @bottom_offset = 5
+      @visible = true
+      @id = (0...8).map{65.+(rand(25)).chr}.join
+      parse_options options
+      yield self if block_given?
+    end
+
+    unsigned_int_attr_accessor :row, :column, :left_column, :left_offset, :top_row, :top_offset,
+                               :right_column, :right_offset, :bottom_row, :bottom_offset
+
+    boolean_attr_accessor :visible
+
+    # serialize the shape to a string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str ='')
+str << <<SHAME_ON_YOU
+
+<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto"
+  style="visibility:#{@visible ? 'visible' : 'hidden'}">
+  <v:fill color2="#ffffa1 [80]"/>
+  <v:shadow on="t" obscured="t"/>
+  <v:path o:connecttype="none"/>
+  <v:textbox style='mso-fit-text-with-word-wrap:t'>
+   <div style='text-align:left'></div>
+  </v:textbox>
+
+  <x:ClientData ObjectType="Note">
+   <x:MoveWithCells/>
+   <x:SizeWithCells/>
+   <x:Anchor>#{left_column}, #{left_offset}, #{top_row}, #{top_offset}, #{right_column}, #{right_offset}, #{bottom_row}, #{bottom_offset}</x:Anchor>
+   <x:AutoFill>False</x:AutoFill>
+   <x:Row>#{row}</x:Row>
+   <x:Column>#{column}</x:Column>
+   #{@visible ? '<x:Visible/>' : ''}
+  </x:ClientData>
+ </v:shape>
+SHAME_ON_YOU
+
+    end
+  end
+end

data/lib/axlsx/package.rb

@@ -0,0 +1,363 @@
+# encoding: UTF-8
+module Axlsx
+  # Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
+  # xlsx document including valdation and serialization.
+  class Package
+    include Axlsx::OptionsParser
+
+    # provides access to the app doc properties for this package
+    # see App
+    attr_reader :app
+
+    # provides access to the core doc properties for the package
+    # see Core
+    attr_reader :core
+
+    # Initializes your package
+    #
+    # @param [Hash] options A hash that you can use to specify the author and workbook for this package.
+    # @option options [String] :author The author of the document
+    # @option options [Time] :created_at Timestamp in the document properties (defaults to current time).
+    # @option options [Boolean] :use_shared_strings This is passed to the workbook to specify that shared strings should be used when serializing the package.
+    # @example Package.new :author => 'you!', :workbook => Workbook.new
+    def initialize(options={})
+      @workbook = nil
+      @core, @app = Core.new, App.new
+      @core.creator = options[:author] || @core.creator
+      @core.created = options[:created_at]
+      parse_options options
+      yield self if block_given?
+    end
+
+    # Shortcut to specify that the workbook should use autowidth
+    # @see Workbook#use_autowidth
+    def use_autowidth=(v)
+      Axlsx::validate_boolean(v);
+      workbook.use_autowidth = v
+    end
+
+
+
+    # Shortcut to determine if the workbook is configured to use shared strings
+    # @see Workbook#use_shared_strings
+    def use_shared_strings
+      workbook.use_shared_strings
+    end
+
+    # Shortcut to specify that the workbook should use shared strings
+    # @see Workbook#use_shared_strings
+    def use_shared_strings=(v)
+      Axlsx::validate_boolean(v);
+      workbook.use_shared_strings = v
+    end
+    # The workbook this package will serialize or validate.
+    # @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
+    # @raise ArgumentError if workbook parameter is not a Workbook instance.
+    # @note As there are multiple ways to instantiate a workbook for the package,
+    #   here are a few examples:
+    #     # assign directly during package instanciation
+    #     wb = Package.new(:workbook => Workbook.new).workbook
+    #
+    #     # get a fresh workbook automatically from the package
+    #     wb = Pacakge.new().workbook
+    #     #     # set the workbook after creating the package
+    #     wb = Package.new().workbook = Workbook.new
+    def workbook
+      @workbook || @workbook = Workbook.new
+      yield @workbook if block_given?
+      @workbook
+    end
+
+    #def self.parse(input, confirm_valid = false)
+    #  p = Package.new
+    #  z = Zip::File.open(input)
+    #  p.workbook = Workbook.parse z.get_entry(WORKBOOK_PN)
+    #  p
+    #end
+
+    # @see workbook
+    def workbook=(workbook) DataTypeValidator.validate :Package_workbook, Workbook, workbook; @workbook = workbook; end
+
+    # Serialize your workbook to disk as an xlsx document.
+    #
+    # @param [String] output The name of the file you want to serialize your package to
+    # @param [Boolean] confirm_valid Validate the package prior to serialization.
+    # @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
+    # @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
+    #   confirm_valid should be used in the rare case that you cannot open the serialized file.
+    # @see Package#validate
+    # @example
+    #   # This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
+    #   # Take a look at the README for an example of how to do it!
+    #
+    #   #serialize to a file
+    #   p = Axlsx::Package.new
+    #   # ......add cool stuff to your workbook......
+    #   p.serialize("example.xlsx")
+    #
+    #   # Serialize to a stream
+    #   s = p.to_stream()
+    #   File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
+    def serialize(output, confirm_valid=false)
+      return false unless !confirm_valid || self.validate.empty?
+      Relationship.clear_cached_instances
+      Zip::OutputStream.open(output) do |zip|
+        write_parts(zip)
+      end
+      true
+    end
+
+
+    # Serialize your workbook to a StringIO instance
+    # @param [Boolean] confirm_valid Validate the package prior to serialization.
+    # @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
+    def to_stream(confirm_valid=false)
+      return false unless !confirm_valid || self.validate.empty?
+      Relationship.clear_cached_instances
+      zip = write_parts(Zip::OutputStream.new(StringIO.new, true))
+      stream = zip.close_buffer
+      stream.rewind
+      stream
+    end
+
+    # Encrypt the package into a CFB using the password provided
+    # This is not ready yet
+    def encrypt(file_name, password)
+      return false
+      # moc = MsOffCrypto.new(file_name, password)
+      # moc.save
+    end
+
+    # Validate all parts of the package against xsd schema.
+    # @return [Array] An array of all validation errors found.
+    # @note This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip and OpenPackagingConventions-XMLSchema.zip
+    #   as per ECMA-376, Third edition. opc schema require an internet connection to import remote schema from dublin core for dc,
+    #   dcterms and xml namespaces. Those remote schema are included in this gem, and the original files have been altered to
+    #   refer to the local versions.
+    #
+    #   If by chance you are able to creat a package that does not validate it indicates that the internal
+    #   validation is not robust enough and needs to be improved. Please report your errors to the gem author.
+    # @see http://www.ecma-international.org/publications/standards/Ecma-376.htm
+    # @example
+    #  # The following will output any error messages found in serialization.
+    #  p = Axlsx::Package.new
+    #  # ... code to create sheets, charts, styles etc.
+    #  p.validate.each { |error| puts error.message }
+    def validate
+      errors = []
+      parts.each do |part|
+        unless part[:schema].nil?
+          if part[:doc].is_a? String
+            errors.concat validate_single_doc(part[:schema], part[:doc])
+          else
+            errors.concat validate_single_doc(part[:schema], part[:doc].to_xml_string)
+          end
+        end
+      end
+      errors
+    end
+
+    private
+
+    # Writes the package parts to a zip archive.
+    # @param [Zip::OutputStream] zip
+    # @return [Zip::OutputStream]
+    def write_parts(zip)
+      p = parts
+      p.each do |part|
+        #next unless part[:entry] == CORE_PN
+        unless part[:doc].nil?
+          zip.put_next_entry(zip_entry_for_part(part))
+          if part[:doc].is_a? String
+            entry = ['1.9.2', '1.9.3'].include?(RUBY_VERSION) ? part[:doc].force_encoding('BINARY') : part[:doc]
+            zip.puts(entry)
+          else
+            part[:doc].to_xml_string(zip)
+          end
+        end
+        unless part[:path].nil?
+          zip.put_next_entry(zip_entry_for_part(part))
+          # binread for 1.9.3
+          zip.write IO.respond_to?(:binread) ? IO.binread(part[:path]) : IO.read(part[:path])
+        end
+      end
+      zip
+    end
+
+    # Generate a Entry for the given package part.
+    # The important part here is to explicitly set the timestamp for the zip entry: Serializing axlsx packages
+    # with identical contents should result in identical zip files – however, the timestamp of a zip entry
+    # defaults to the time of serialization and therefore the zip file contents would be different every time
+    # the package is serialized.
+    #
+    # Note: {Core#created} also defaults to the current time – so to generate identical axlsx packages you have
+    # to set this explicitly, too (eg. with `Package.new(created_at: Time.local(2013, 1, 1))`).
+    #
+    # @param part A hash describing a part of this pacakge (see {#parts})
+    # @return [Zip::Entry]
+    def zip_entry_for_part(part)
+      timestamp = Zip::DOSTime.at(@core.created.to_i)
+      Zip::Entry.new("", part[:entry], "", "", 0, 0, Zip::Entry::DEFLATED, 0, timestamp)
+    end
+
+    # The parts of a package
+    # @return [Array] An array of hashes that define the entry, document and schema for each part of the package.
+    # @private
+    def parts
+      parts = [
+       {:entry => RELS_PN, :doc => relationships, :schema => RELS_XSD},
+       {:entry => "xl/#{STYLES_PN}", :doc => workbook.styles, :schema => SML_XSD},
+       {:entry => CORE_PN, :doc => @core, :schema => CORE_XSD},
+       {:entry => APP_PN, :doc => @app, :schema => APP_XSD},
+       {:entry => WORKBOOK_RELS_PN, :doc => workbook.relationships, :schema => RELS_XSD},
+       {:entry => CONTENT_TYPES_PN, :doc => content_types, :schema => CONTENT_TYPES_XSD},
+       {:entry => WORKBOOK_PN, :doc => workbook, :schema => SML_XSD}
+      ]
+
+      workbook.drawings.each do |drawing|
+        parts << {:entry => "xl/#{drawing.rels_pn}", :doc => drawing.relationships, :schema => RELS_XSD}
+        parts << {:entry => "xl/#{drawing.pn}", :doc => drawing, :schema => DRAWING_XSD}
+      end
+
+
+      workbook.tables.each do |table|
+        parts << {:entry => "xl/#{table.pn}", :doc => table, :schema => SML_XSD}
+      end
+      workbook.pivot_tables.each do |pivot_table|
+        cache_definition = pivot_table.cache_definition
+        parts << {:entry => "xl/#{pivot_table.rels_pn}", :doc => pivot_table.relationships, :schema => RELS_XSD}
+        parts << {:entry => "xl/#{pivot_table.pn}", :doc => pivot_table} #, :schema => SML_XSD}
+        parts << {:entry => "xl/#{cache_definition.pn}", :doc => cache_definition} #, :schema => SML_XSD}
+      end
+
+      workbook.comments.each do|comment|
+        if comment.size > 0
+          parts << { :entry => "xl/#{comment.pn}", :doc => comment, :schema => SML_XSD }
+          parts << { :entry => "xl/#{comment.vml_drawing.pn}", :doc => comment.vml_drawing, :schema => nil }
+        end
+      end
+
+      workbook.charts.each do |chart|
+        parts << {:entry => "xl/#{chart.pn}", :doc => chart, :schema => DRAWING_XSD}
+      end
+
+      workbook.images.each do |image|
+        parts << {:entry => "xl/#{image.pn}", :path => image.image_src}
+      end
+
+      if use_shared_strings
+        parts << {:entry => "xl/#{SHARED_STRINGS_PN}", :doc => workbook.shared_strings, :schema => SML_XSD}
+      end
+
+      workbook.worksheets.each do |sheet|
+        parts << {:entry => "xl/#{sheet.rels_pn}", :doc => sheet.relationships, :schema => RELS_XSD}
+        parts << {:entry => "xl/#{sheet.pn}", :doc => sheet, :schema => SML_XSD}
+      end
+      parts
+    end
+
+    # Performs xsd validation for a signle document
+    #
+    # @param [String] schema path to the xsd schema to be used in validation.
+    # @param [String] doc The xml text to be validated
+    # @return [Array] An array of all validation errors encountered.
+    # @private
+    def validate_single_doc(schema, doc)
+      schema = Nokogiri::XML::Schema(File.open(schema))
+      doc = Nokogiri::XML(doc)
+      errors = []
+      schema.validate(doc).each do |error|
+        errors << error
+      end
+      errors
+    end
+
+    # Appends override objects for drawings, charts, and sheets as they exist in your workbook to the default content types.
+    # @return [ContentType]
+    # @private
+    def content_types
+      c_types = base_content_types
+      workbook.drawings.each do |drawing|
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{drawing.pn}",
+                                       :ContentType => DRAWING_CT)
+      end
+
+      workbook.charts.each do |chart|
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{chart.pn}",
+                                       :ContentType => CHART_CT)
+      end
+
+      workbook.tables.each do |table|
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{table.pn}",
+                                       :ContentType => TABLE_CT)
+      end
+
+      workbook.pivot_tables.each do |pivot_table|
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{pivot_table.pn}",
+                                       :ContentType => PIVOT_TABLE_CT)
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{pivot_table.cache_definition.pn}",
+                                       :ContentType => PIVOT_TABLE_CACHE_DEFINITION_CT)
+      end
+
+      workbook.comments.each do |comment|
+        if comment.size > 0
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{comment.pn}",
+                                       :ContentType => COMMENT_CT)
+        end
+      end
+
+      if workbook.comments.size > 0
+        c_types << Axlsx::Default.new(:Extension => "vml", :ContentType => VML_DRAWING_CT)
+      end
+
+      workbook.worksheets.each do |sheet|
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{sheet.pn}",
+                                         :ContentType => WORKSHEET_CT)
+      end
+      exts = workbook.images.map { |image| image.extname.downcase }
+      exts.uniq.each do |ext|
+        ct = if  ['jpeg', 'jpg'].include?(ext)
+               JPEG_CT
+             elsif ext == 'gif'
+               GIF_CT
+             elsif ext == 'png'
+               PNG_CT
+             end
+        c_types << Axlsx::Default.new(:ContentType => ct, :Extension => ext )
+      end
+      if use_shared_strings
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{SHARED_STRINGS_PN}",
+                                       :ContentType => SHARED_STRINGS_CT)
+      end
+      c_types
+    end
+
+    # Creates the minimum content types for generating a valid xlsx document.
+    # @return [ContentType]
+    # @private
+    def base_content_types
+      c_types = ContentType.new()
+      c_types << Default.new(:ContentType => RELS_CT, :Extension => RELS_EX)
+      c_types << Default.new(:Extension => XML_EX, :ContentType => XML_CT)
+      c_types << Override.new(:PartName => "/#{APP_PN}", :ContentType => APP_CT)
+      c_types << Override.new(:PartName => "/#{CORE_PN}", :ContentType => CORE_CT)
+      c_types << Override.new(:PartName => "/xl/#{STYLES_PN}", :ContentType => STYLES_CT)
+      c_types << Axlsx::Override.new(:PartName => "/#{WORKBOOK_PN}", :ContentType => WORKBOOK_CT)
+      c_types.lock
+      c_types
+    end
+
+    # Creates the relationships required for a valid xlsx document
+    # @return [Relationships]
+    # @private
+    def relationships
+      rels = Axlsx::Relationships.new
+      rels << Relationship.new(self, WORKBOOK_R, WORKBOOK_PN)
+      rels << Relationship.new(self, CORE_R, CORE_PN)
+      rels << Relationship.new(self, APP_R, APP_PN)
+      rels.lock
+      rels
+    end
+  end
+end
+