caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/rels/relationship.rb

@@ -1,130 +1,127 @@
-# encoding: UTF-8
-module Axlsx
-  # A relationship defines a reference between package parts.
-  # @note Packages automatically manage relationships.
-  class Relationship
-    
-    class << self
-      # Keeps track of relationship ids in use.
-      # @return [Array]
-      def ids_cache
-        Thread.current[:axlsx_relationship_ids_cache] ||= {}
-      end
-
-      # Initialize cached ids.
-      # 
-      # This should be called before serializing a package (see {Package#serialize} and
-      # {Package#to_stream}) to make sure that serialization is idempotent (i.e. 
-      # Relationship instances are generated with the same IDs everytime the package
-      # is serialized).
-      def initialize_ids_cache
-        Thread.current[:axlsx_relationship_ids_cache] = {}
-      end
-      
-      # Clear cached ids.
-      # 
-      # This should be called after serializing a package (see {Package#serialize} and
-      # {Package#to_stream}) to free the memory allocated for cache.
-      # 
-      # Also, calling this avoids memory leaks (cached ids lingering around 
-      # forever). 
-      def clear_ids_cache
-        Thread.current[:axlsx_relationship_ids_cache] = nil
-      end
-      
-      # Generate and return a unique id (eg. `rId123`) Used for setting {#Id}. 
-      #
-      # The generated id depends on the number of previously cached ids, so using
-      # {clear_ids_cache} will automatically reset the generated ids, too.
-      # @return [String]
-      def next_free_id
-        "rId#{ids_cache.size + 1}"
-      end
-    end
-
-    # The id of the relationship (eg. "rId123"). Most instances get their own unique id. 
-    # However, some instances need to share the same id – see {#should_use_same_id_as?}
-    # for details.
-    # @return [String]
-    attr_reader :Id
-    
-    # The location of the relationship target
-    # @return [String]
-    attr_reader :Target
-
-    # The type of relationship
-    # @note Supported types are defined as constants in Axlsx:
-    # @see XML_NS_R
-    # @see TABLE_R
-    # @see PIVOT_TABLE_R
-    # @see WORKBOOK_R
-    # @see WORKSHEET_R
-    # @see APP_R
-    # @see RELS_R
-    # @see CORE_R
-    # @see STYLES_R
-    # @see CHART_R
-    # @see DRAWING_R
-    # @return [String]
-    attr_reader :Type
-
-    # The target mode of the relationship
-    # used for hyperlink type relationships to mark the relationship to an external resource
-    # TargetMode can be specified during initialization by passing in a :target_mode option
-    # Target mode must be :external for now.
-    attr_reader :TargetMode
-
-    # The source object the relations belongs to (e.g. a hyperlink, drawing, ...). Needed when
-    # looking up the relationship for a specific object (see {Relationships#for}).
-    attr_reader :source_obj
-    
-    # Initializes a new relationship. 
-    # @param [Object] source_obj see {#source_obj}
-    # @param [String] type The type of the relationship
-    # @param [String] target The target for the relationship
-    # @option [Symbol] :target_mode only accepts :external.
-    def initialize(source_obj, type, target, options={})
-      @source_obj = source_obj
-      self.Target=target
-      self.Type=type
-      self.TargetMode = options[:target_mode] if options[:target_mode]
-      @Id = (self.class.ids_cache[ids_cache_key] ||= self.class.next_free_id)
-    end
-
-    # @see Target
-    def Target=(v) Axlsx::validate_string v; @Target = v end
-    # @see Type
-    def Type=(v) Axlsx::validate_relationship_type v; @Type = v end
-
-    # @see TargetMode
-    def TargetMode=(v) RestrictionValidator.validate 'Relationship.TargetMode', [:External, :Internal], v; @TargetMode = v; end
-
-    # serialize relationship
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      h = self.instance_values.reject{|k, _| k == "source_obj"}
-      str << '<Relationship '
-      str << (h.map { |key, value| '' << key.to_s << '="' << Axlsx::coder.encode(value.to_s) << '"'}.join(' '))
-      str << '/>'
-    end
-    
-    # A key that determines whether this relationship should use already generated id.
-    #
-    # Instances designating the same relationship need to use the same id. We can not simply
-    # compare the {#Target} attribute, though: `foo/bar.xml`, `../foo/bar.xml`, 
-    # `../../foo/bar.xml` etc. are all different but probably mean the same file (this 
-    # is especially an issue for relationships in the context of pivot tables). So lets
-    # just ignore this attribute for now (except when {#TargetMode} is set to `:External` –
-    # then {#Target} will be an absolute URL and thus can safely be compared).
-    #
-    # @todo Implement comparison of {#Target} based on normalized path names.
-    # @return [Array]
-    def ids_cache_key
-      key = [source_obj, self.Type, self.TargetMode]
-      key << self.Target if self.TargetMode == :External
-      key
-    end
-    
-  end
-end
+module Axlsx
+  # A relationship defines a reference between package parts.
+  # @note Packages automatically manage relationships.
+  class Relationship
+    class << self
+      # Keeps track of relationship ids in use.
+      # @return [Array]
+      def ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] ||= {}
+      end
+
+      # Initialize cached ids.
+      #
+      # This should be called before serializing a package (see {Package#serialize} and
+      # {Package#to_stream}) to make sure that serialization is idempotent (i.e.
+      # Relationship instances are generated with the same IDs everytime the package
+      # is serialized).
+      def initialize_ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] = {}
+      end
+
+      # Clear cached ids.
+      #
+      # This should be called after serializing a package (see {Package#serialize} and
+      # {Package#to_stream}) to free the memory allocated for cache.
+      #
+      # Also, calling this avoids memory leaks (cached ids lingering around
+      # forever).
+      def clear_ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] = nil
+      end
+
+      # Generate and return a unique id (eg. `rId123`) Used for setting {#Id}.
+      #
+      # The generated id depends on the number of previously cached ids, so using
+      # {clear_ids_cache} will automatically reset the generated ids, too.
+      # @return [String]
+      def next_free_id
+        "rId#{ids_cache.size + 1}"
+      end
+    end
+
+    # The id of the relationship (eg. "rId123"). Most instances get their own unique id.
+    # However, some instances need to share the same id – see {#should_use_same_id_as?}
+    # for details.
+    # @return [String]
+    attr_reader :Id
+
+    # The location of the relationship target
+    # @return [String]
+    attr_reader :Target
+
+    # The type of relationship
+    # @note Supported types are defined as constants in Axlsx:
+    # @see XML_NS_R
+    # @see TABLE_R
+    # @see PIVOT_TABLE_R
+    # @see WORKBOOK_R
+    # @see WORKSHEET_R
+    # @see APP_R
+    # @see RELS_R
+    # @see CORE_R
+    # @see STYLES_R
+    # @see CHART_R
+    # @see DRAWING_R
+    # @return [String]
+    attr_reader :Type
+
+    # The target mode of the relationship
+    # used for hyperlink type relationships to mark the relationship to an external resource
+    # TargetMode can be specified during initialization by passing in a :target_mode option
+    # Target mode must be :external for now.
+    attr_reader :TargetMode
+
+    # The source object the relations belongs to (e.g. a hyperlink, drawing, ...). Needed when
+    # looking up the relationship for a specific object (see {Relationships#for}).
+    attr_reader :source_obj
+
+    # Initializes a new relationship.
+    # @param [Object] source_obj see {#source_obj}
+    # @param [String] type The type of the relationship
+    # @param [String] target The target for the relationship
+    # @option [Symbol] :target_mode only accepts :external.
+    def initialize(source_obj, type, target, options = {})
+      @source_obj = source_obj
+      self.Target = target
+      self.Type = type
+      self.TargetMode = options[:target_mode] if options[:target_mode]
+      @Id = (self.class.ids_cache[ids_cache_key] ||= self.class.next_free_id)
+    end
+
+    # @see Target
+    def Target=(v) Axlsx::validate_string v; @Target = v end
+    # @see Type
+    def Type=(v) Axlsx::validate_relationship_type v; @Type = v end
+
+    # @see TargetMode
+    def TargetMode=(v) RestrictionValidator.validate 'Relationship.TargetMode', [:External, :Internal], v; @TargetMode = v; end
+
+    # serialize relationship
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      h = Axlsx.instance_values_for(self).reject { |k, _| k == "source_obj" }
+      str << '<Relationship '
+      str << (h.map { |key, value| '' << key.to_s << '="' << Axlsx::coder.encode(value.to_s) << '"' }.join(' '))
+      str << '/>'
+    end
+
+    # A key that determines whether this relationship should use already generated id.
+    #
+    # Instances designating the same relationship need to use the same id. We can not simply
+    # compare the {#Target} attribute, though: `foo/bar.xml`, `../foo/bar.xml`,
+    # `../../foo/bar.xml` etc. are all different but probably mean the same file (this
+    # is especially an issue for relationships in the context of pivot tables). So lets
+    # just ignore this attribute for now (except when {#TargetMode} is set to `:External` –
+    # then {#Target} will be an absolute URL and thus can safely be compared).
+    #
+    # @todo Implement comparison of {#Target} based on normalized path names.
+    # @return [Array]
+    def ids_cache_key
+      key = [source_obj, self.Type, self.TargetMode]
+      key << self.Target if self.TargetMode == :External
+      key
+    end
+  end
+end

data/lib/axlsx/rels/relationships.rb

@@ -1,32 +1,29 @@
-# encoding: UTF-8
-module Axlsx
-require 'axlsx/rels/relationship.rb'
-
-  # Relationships are a collection of Relations that define how package parts are related.
-  # @note The package automatically manages releationships.
-  class Relationships < SimpleTypedList
-
-    # Creates a new Relationships collection based on SimpleTypedList
-    def initialize
-      super Relationship
-    end
-
-    # The relationship instance for the given source object, or nil if none exists.
-    # @see Relationship#source_obj
-    # @return [Relationship]
-    def for(source_obj)
-      find{ |rel| rel.source_obj == source_obj }
-    end
-
-    # serialize relationships
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<Relationships xmlns="' << RELS_R << '">')
-      each{ |rel| rel.to_xml_string(str) }
-      str << '</Relationships>'
-    end
-
-  end
-end
+module Axlsx
+  require 'axlsx/rels/relationship.rb'
+
+  # Relationships are a collection of Relations that define how package parts are related.
+  # @note The package automatically manages releationships.
+  class Relationships < SimpleTypedList
+    # Creates a new Relationships collection based on SimpleTypedList
+    def initialize
+      super Relationship
+    end
+
+    # The relationship instance for the given source object, or nil if none exists.
+    # @see Relationship#source_obj
+    # @return [Relationship]
+    def for(source_obj)
+      find { |rel| rel.source_obj == source_obj }
+    end
+
+    # serialize relationships
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << ('<Relationships xmlns="' << RELS_R << '">')
+      each { |rel| rel.to_xml_string(str) }
+      str << '</Relationships>'
+    end
+  end
+end

data/lib/axlsx/stylesheet/border.rb

@@ -1,73 +1,70 @@
-# encoding: UTF-8
-module Axlsx
-  # This class details a border used in Office Open XML spreadsheet styles.
-  class Border
-
-    include Axlsx::SerializedAttributes
-    include Axlsx::OptionsParser
-
-    EDGES = [:left, :right, :top, :bottom].freeze
-
-    # Creates a new Border object
-    # @option options [Boolean] diagonal_up
-    # @option options [Boolean] diagonal_down
-    # @option options [Boolean] outline
-    # @example - Making a border
-    #   p = Axlsx::Package.new
-    #   red_border = p.workbook.styles.add_style :border => { :style => :thin, :color => "FFFF0000" }
-    #   ws = p.workbook.add_worksheet
-    #   ws.add_row [1,2,3], :style => red_border
-    #   p.serialize('red_border.xlsx')
-    #
-    # @note The recommended way to manage borders is with Style#add_style
-    # @see Style#add_style
-    def initialize(options={})
-      @prs = SimpleTypedList.new BorderPr
-      parse_options options
-    end
-
-    serializable_attributes :diagonal_up, :diagonal_down, :outline
-
-    # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell.
-    attr_reader :diagonal_up
-    alias :diagonalUp :diagonal_up
-
-    # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
-    attr_reader :diagonal_down
-    alias :diagonalDown :diagonal_down
-
-    # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
-    attr_reader :outline
-
-    # @return [SimpleTypedList] A list of BorderPr objects for this border.
-    attr_reader :prs
-
-    # @see diagonalUp
-    def diagonal_up=(v) Axlsx::validate_boolean v; @diagonal_up = v end
-    alias :diagonalUp= :diagonal_up=
-
-    # @see diagonalDown
-    def diagonal_down=(v) Axlsx::validate_boolean v; @diagonal_down = v end
-    alias :diagonalDown= :diagonal_down=
-
-    # @see outline
-    def outline=(v) Axlsx::validate_boolean v; @outline = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<border '
-      serialized_attributes str
-      str << '>'
-      # enforces order
-      [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
-        @prs.select { |pr| pr.name == k }.each do |part|
-          part.to_xml_string(str)
-        end
-      end
-      str << '</border>'
-    end
-
-  end
-end
+module Axlsx
+  # This class details a border used in Office Open XML spreadsheet styles.
+  class Border
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+
+    EDGES = [:left, :right, :top, :bottom].freeze
+
+    # Creates a new Border object
+    # @option options [Boolean] diagonal_up
+    # @option options [Boolean] diagonal_down
+    # @option options [Boolean] outline
+    # @example - Making a border
+    #   p = Axlsx::Package.new
+    #   red_border = p.workbook.styles.add_style :border => { :style => :thin, :color => "FFFF0000" }
+    #   ws = p.workbook.add_worksheet
+    #   ws.add_row [1,2,3], :style => red_border
+    #   p.serialize('red_border.xlsx')
+    #
+    # @note The recommended way to manage borders is with Style#add_style
+    # @see Style#add_style
+    def initialize(options = {})
+      @prs = SimpleTypedList.new BorderPr
+      parse_options options
+    end
+
+    serializable_attributes :diagonal_up, :diagonal_down, :outline
+
+    # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell.
+    attr_reader :diagonal_up
+    alias :diagonalUp :diagonal_up
+
+    # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
+    attr_reader :diagonal_down
+    alias :diagonalDown :diagonal_down
+
+    # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
+    attr_reader :outline
+
+    # @return [SimpleTypedList] A list of BorderPr objects for this border.
+    attr_reader :prs
+
+    # @see diagonalUp
+    def diagonal_up=(v) Axlsx::validate_boolean v; @diagonal_up = v end
+    alias :diagonalUp= :diagonal_up=
+
+    # @see diagonalDown
+    def diagonal_down=(v) Axlsx::validate_boolean v; @diagonal_down = v end
+    alias :diagonalDown= :diagonal_down=
+
+    # @see outline
+    def outline=(v) Axlsx::validate_boolean v; @outline = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<border '
+      serialized_attributes str
+      str << '>'
+      # enforces order
+      [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
+        @prs.select { |pr| pr.name == k }.each do |part|
+          part.to_xml_string(str)
+        end
+      end
+      str << '</border>'
+    end
+  end
+end

data/lib/axlsx/stylesheet/border_pr.rb

@@ -1,71 +1,69 @@
-# encoding: UTF-8
-module Axlsx
-  # A border part.
-  class BorderPr
-    include Axlsx::OptionsParser
-    # @return [Color] The color of this border part.
-    attr_reader :color
-
-    # @return [Symbol] The syle of this border part.
-    # @note
-    #  The following are allowed
-    #   :none
-    #   :thin
-    #   :medium
-    #   :dashed
-    #   :dotted
-    #   :thick
-    #   :double
-    #   :hair
-    #   :mediumDashed
-    #   :dashDot
-    #   :mediumDashDot
-    #   :dashDotDot
-    #   :mediumDashDotDot
-    #   :slantDashDot
-    attr_reader :style
-
-    # @return [Symbol] The name of this border part
-    # @note
-    #  The following are allowed
-    #   :start
-    #   :end
-    #   :left
-    #   :right
-    #   :top
-    #   :bottom
-    #   :diagonal
-    #   :vertical
-    #   :horizontal
-    attr_reader :name
-
-    # Creates a new Border Part Object
-    # @option options [Color] color
-    # @option options [Symbol] name
-    # @option options [Symbol] style
-    # @see Axlsx::Border
-    def initialize(options={})
-      parse_options(options)
-      #options.each do |o|
-      #  self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      #end
-    end
-
-    # @see name
-    def name=(v) RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v; @name = v end
-    # @see color
-    def color=(v) DataTypeValidator.validate(:color, Color, v); @color = v end
-    # @see style
-    def style=(v) RestrictionValidator.validate "BorderPr.style", [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :mediumDashed, :dashDot, :mediumDashDot, :dashDotDot, :mediumDashDotDot, :slantDashDot], v; @style = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << ('<' << @name.to_s << ' style="' << @style.to_s << '">')
-      @color.to_xml_string(str) if @color.is_a?(Color)
-      str << ('</' << @name.to_s << '>')
-    end
-
-  end
-end
+module Axlsx
+  # A border part.
+  class BorderPr
+    include Axlsx::OptionsParser
+    # @return [Color] The color of this border part.
+    attr_reader :color
+
+    # @return [Symbol] The syle of this border part.
+    # @note
+    #  The following are allowed
+    #   :none
+    #   :thin
+    #   :medium
+    #   :dashed
+    #   :dotted
+    #   :thick
+    #   :double
+    #   :hair
+    #   :mediumDashed
+    #   :dashDot
+    #   :mediumDashDot
+    #   :dashDotDot
+    #   :mediumDashDotDot
+    #   :slantDashDot
+    attr_reader :style
+
+    # @return [Symbol] The name of this border part
+    # @note
+    #  The following are allowed
+    #   :start
+    #   :end
+    #   :left
+    #   :right
+    #   :top
+    #   :bottom
+    #   :diagonal
+    #   :vertical
+    #   :horizontal
+    attr_reader :name
+
+    # Creates a new Border Part Object
+    # @option options [Color] color
+    # @option options [Symbol] name
+    # @option options [Symbol] style
+    # @see Axlsx::Border
+    def initialize(options = {})
+      parse_options(options)
+      # options.each do |o|
+      #  self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      # end
+    end
+
+    # @see name
+    def name=(v) RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v; @name = v end
+    # @see color
+    def color=(v) DataTypeValidator.validate(:color, Color, v); @color = v end
+    # @see style
+    def style=(v) RestrictionValidator.validate "BorderPr.style", [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :mediumDashed, :dashDot, :mediumDashDot, :dashDotDot, :mediumDashDotDot, :slantDashDot], v; @style = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << ('<' << @name.to_s << ' style="' << @style.to_s << '">')
+      @color.to_xml_string(str) if @color.is_a?(Color)
+      str << ('</' << @name.to_s << '>')
+    end
+  end
+end