axlsx 1.3.1 → 1.3.2

data/examples/finance.rb

@@ -0,0 +1,82 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+
+require 'axlsx'
+
+# First thing to do is setup our styles. OOXML Style management is unfortunately very different from CSS so we want to use the 
+# add_style helper method on the workbook styles object so we dont go insane.
+
+# I find it easier to declare a hash and then feed that in later
+
+class FinancialReport
+
+  def initialize(data)
+    create_styles
+    prepare
+    insert_data data
+    finalize
+    package
+  end
+
+  def style_hash
+
+    sienna = 'A0522D'
+    {
+      :search_results => { :sz => 10, :b => true },
+      :bold_header => { :b => true },
+      :grey_bg => { :bg_color => "DEDEDE" },
+      :transaction__header => { :fg_color => sienna, :b => true },
+      :transaction_currency => { :fb_color => sienna, :num_fmt => 5 },
+      :transactin_date => { :fg_color => sienna, :format_code => 'yyyy-mm-dd' }
+    }
+  end
+
+  def styles
+    @styles ||= {}
+  end
+
+  def package
+    @package ||= Axlsx::Package.new
+  end
+
+  # Just a place to put some defualt data for the exercise
+  def self.data
+    @data = ['baked',
+             "American Medical Systems Holdings, Inc.",	
+     "Endo Pharmaceuticals Holdings, Inc.",
+     "4371",	
+     Date.new,
+     2757001160, 
+     2519495160, 
+     116,
+     3842,
+     "Medical devices for urology disorders"]
+  end
+
+  #  Populates an array of ['style_name'] = style_index
+  def create_styles
+    package.workbook.styles do |style|
+      style_hash.each do |key, value|
+        styles[key] = style.add_style(value)
+      end
+    end
+  end
+  def prepare
+    package.workbook.add_worksheet(:name => 'All Information') do |sheet|
+      sheet.add_row [nil, 'Search Results'], :style => [nil, styles['search_results']]
+    end
+  end
+
+
+  def insert_data(data)
+    package.workbook.worksheets.first do |sheet|
+      sheet.add_row data, style=> [styles[:
+    end
+  end
+
+  def finalize
+    # package.serialize 'financial.xlsx'
+  end
+end
+f = FinancialReport.new(FinancialReport.data)
+f.package.serialize 'finance.xlsx'

data/lib/axlsx.rb

@@ -5,7 +5,9 @@ require 'axlsx/version.rb'
 require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
 require 'axlsx/util/validators.rb'
-
+require 'axlsx/util/accessors.rb'
+require 'axlsx/util/serialized_attributes'
+require 'axlsx/util/options_parser'
 # to be included with parsable intitites.
 #require 'axlsx/util/parser.rb'
 
@@ -48,9 +50,14 @@ module Axlsx
   # determines the cell range for the items provided
   def self.cell_range(cells, absolute=true)
     return "" unless cells.first.is_a? Cell
-    sort_cells(cells)
+    cells = sort_cells(cells)
     reference = "#{cells.first.reference(absolute)}:#{cells.last.reference(absolute)}"
-    absolute ? "'#{cells.first.row.worksheet.name}'!#{reference}" : reference
+    if absolute
+      escaped_name = cells.first.row.worksheet.name.gsub "'", "''"
+      "'#{escaped_name}'!#{reference}"
+    else
+      reference
+    end
   end
 
   # sorts the array of cells provided to start from the minimum x,y to
@@ -66,7 +73,7 @@ module Axlsx
   def self.coder
     @@coder ||= ::HTMLEntities.new
   end
-  
+
   # returns the x, y position of a cell
   def self.name_to_indices(name)
     raise ArgumentError, 'invalid cell name' unless name.size > 1

data/lib/axlsx/content_type/abstract_content_type.rb

@@ -0,0 +1,32 @@
+module Axlsx
+
+  # This class extracts the common parts from Default and Override
+  class AbstractContentType
+
+    include Axlsx::OptionsParser
+
+    # Initializes an abstract content type
+    # @see Default, Override
+    def initialize(options={})
+       parse_options options
+    end
+
+    # The type of content.
+    # @return [String]
+    attr_reader :content_type
+    alias :ContentType :content_type
+
+    # The content type.
+    # @see Axlsx#validate_content_type
+    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
+    alias :ContentType= :content_type=
+
+    # Serialize the contenty type to xml
+    def to_xml_string(node_name = '', str = '')
+      str << "<#{node_name} "
+      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
+    end
+
+  end
+end

data/lib/axlsx/content_type/content_type.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 module Axlsx
-
+  require 'axlsx/content_type/abstract_content_type.rb'
   require 'axlsx/content_type/default.rb'
   require 'axlsx/content_type/override.rb'
 

data/lib/axlsx/content_type/default.rb

@@ -2,55 +2,24 @@
 module Axlsx
 
   # An default content part. These parts are automatically created by for you based on the content of your package.
-  class Default
+  class Default < AbstractContentType
 
-    #Creates a new Default object
-    # @option options [String] extension
-    # @option options [String] content_type
-    # @raise [ArgumentError] An argument error is raised if both extension and content_type are not specified.
-    def initialize(options={})
-      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
-    end
-
-    # Error string for option validation
-    INVALID_ARGUMENTS = "extension and content_type are required"
+    # The serialization node name for this class
+    NODE_NAME = 'Default'
 
     # The extension of the content type.
     # @return [String]
     attr_reader :extension
     alias :Extension :extension
 
-    # The type of content.
-    # @return [String]
-    attr_reader :content_type
-    alias :ContentType :content_type
-
     # Sets the file extension for this content type.
     def extension=(v) Axlsx::validate_string v; @extension = v end
     alias :Extension= :extension=
 
-    # Sets the content type
-    # @see Axlsx#validate_content_type
-    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
-    alias :ContentType= :content_type=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<Default '
-      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
-      str << '/>'
-    end
-
-    private
-    def validate_options(options)
-      (options[:Extension] || options[:extension]) && (options[:content_type] || options[:ContentType])
+    # Serializes this object to xml
+    def to_xml_string(str ='')
+      super(NODE_NAME, str)
     end
-
   end
 
 end

data/lib/axlsx/content_type/override.rb

@@ -1,27 +1,12 @@
+
 # encoding: UTF-8
 module Axlsx
 
   # An override content part. These parts are automatically created by for you based on the content of your package.
-  class Override
-
-    #Creates a new Override object
-    # @option options [String] PartName
-    # @option options [String] ContentType
-    # @raise [ArgumentError] An argument error is raised if both PartName and ContentType are not specified.
-    def initialize(options={})
-      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
-    end
+  class Override < AbstractContentType
 
-    # Error message for invalid options
-    INVALID_ARGUMENTS = 'part_name and content_type are required'
-
-    # The type of content.
-    # @return [String]
-    attr_reader :content_type
-    alias :ContentType :content_type
+    # Serialization node name for this object
+    NODE_NAME = 'Override'
 
     # The name and location of the part.
     # @return [String]
@@ -32,26 +17,9 @@ module Axlsx
     def part_name=(v) Axlsx::validate_string v; @part_name = v end
     alias :PartName= :part_name=
 
-    # The content type.
-    # @see Axlsx#validate_content_type
-    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
-    alias :ContentType= :content_type=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
+    # Serializes this object to xml
     def to_xml_string(str = '')
-      str << '<Override '
-      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
-      str << '/>'
-    end
-
-    private 
-
-    def validate_options(options)
-      (options[:PartName] || options[:part_name]) && (options[:ContentType] || options[:content_type])
+      super(NODE_NAME, str)
     end
-
   end
-
 end

data/lib/axlsx/doc_props/app.rb

@@ -11,6 +11,8 @@ module Axlsx
   #    DigSig (DigSigBlob)
   class App
 
+    include Axlsx::OptionsParser
+
     # Creates an App object
     # @option options [String] template
     # @option options [String] manager
@@ -35,9 +37,7 @@ module Axlsx
     # @option options [String] app_version
     # @option options [Integer] doc_security
     def initialize(options={})
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
+      parse_options options
     end
 
     # @return [String] The name of the document template.
@@ -223,7 +223,10 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
       str << '<Properties xmlns="' << APP_NS << '" xmlns:vt="' << APP_NS_VT << '">'
-      str << instance_values.map { |key, value| '<' << Axlsx.camel(key) << '>' << value.to_s << '</' << Axlsx.camel(key) << '>' }.join
+      instance_values.each do |key, value|
+        node_name = Axlsx.camel(key)
+        str << "<#{node_name}>#{value}</#{node_name}>"
+      end
       str << '</Properties>'
     end
 

data/lib/axlsx/drawing/axis.rb

@@ -4,6 +4,8 @@ module Axlsx
   # the access class defines common properties and values for a chart axis.
   class Axis
 
+    include Axlsx::OptionsParser
+
     # Creates an Axis object
     # @param [Integer] ax_id the id of this axis
     # @param [Integer] cross_ax the id of the perpendicular axis
@@ -25,9 +27,7 @@ module Axlsx
       self.format_code = "General"
       self.crosses = :autoZero
       self.gridlines = true
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
+      parse_options options
     end
 
     # the fill color to use in the axis shape properties. This should be a 6 character long hex string

data/lib/axlsx/drawing/chart.rb

@@ -6,6 +6,7 @@ module Axlsx
   # @see README for examples
   class Chart
 
+    include Axlsx::OptionsParser
     # Creates a new chart object
     # @param [GraphicalFrame] frame The frame that holds this chart.
     # @option options [Cell, String] title
@@ -21,9 +22,7 @@ module Axlsx
       @show_legend = true
       @series_type = Series
       @title = Title.new
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
       start_at(*options[:start_at]) if options[:start_at]
       end_at(*options[:end_at]) if options[:end_at]
       yield self if block_given?

data/lib/axlsx/drawing/d_lbls.rb

@@ -2,33 +2,40 @@ module Axlsx
   # There are more elements in the dLbls spec that allow for
   # customizations and formatting. For now, I am just implementing the
   # basics.
-
   #The DLbls class manages serialization of data labels
   # showLeaderLines and leaderLines are not currently implemented
   class DLbls
 
-    # These attributes are all boolean so I'm doing a bit of a hand
-    # waving magic show to set up the attriubte accessors
-    # @note 
-    #   not all charts support all methods! 
-    #   Bar3DChart and Line3DChart and ScatterChart do not support d_lbl_pos or show_leader_lines
-    #    
-    BOOLEAN_ATTRIBUTES = [:show_legend_key, :show_val, :show_cat_name, :show_ser_name, :show_percent, :show_bubble_size, :show_leader_lines]
-
+    include Axlsx::Accessors
+    include Axlsx::OptionsParser 
     # creates a new DLbls object
     def initialize(chart_type, options={})
       raise ArgumentError, 'chart_type must inherit from Chart' unless chart_type.superclass == Chart
       @chart_type = chart_type
       initialize_defaults
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
+    # These attributes are all boolean so I'm doing a bit of a hand
+    # waving magic show to set up the attriubte accessors
+    # @note 
+    #   not all charts support all methods! 
+    #   Bar3DChart and Line3DChart and ScatterChart do not support d_lbl_pos or show_leader_lines
+    #    
+    boolean_attr_accessor :show_legend_key, 
+                          :show_val, 
+                          :show_cat_name, 
+                          :show_ser_name, 
+                          :show_percent, 
+                          :show_bubble_size, 
+                          :show_leader_lines
+
     # Initialize all the values to false as Excel requires them to
     # explicitly be disabled or all will show.
     def initialize_defaults
-      BOOLEAN_ATTRIBUTES.each do |attr|
+      [:show_legend_key, :show_val, :show_cat_name, 
+       :show_ser_name, :show_percent, :show_bubble_size, 
+       :show_leader_lines].each do |attr|
         self.send("#{attr}=", false)
       end
     end
@@ -58,24 +65,7 @@ module Axlsx
       @d_lbl_pos = label_position
     end
 
-    # Dynamically create accessors for boolean attriubtes
-    BOOLEAN_ATTRIBUTES.each do |attr|    
-      class_eval %{
-      # The #{attr} attribute reader
-      # @return [Boolean]
-      attr_reader :#{attr} 
-
-      # The #{attr} writer
-      # @param [Boolean] value The value to assign to #{attr}
-      # @return [Boolean]
-      def #{attr}=(value)
-        Axlsx::validate_boolean(value)
-        @#{attr} = value
-      end
-      }
-    end
-
-
+   
     # serializes the data labels
     # @return [String]
     def to_xml_string(str = '')