caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/workbook/worksheet/comment.rb

@@ -1,91 +1,90 @@
-module Axlsx
-
-  # A comment is the text data for a comment
-  class Comment
-
-    include Axlsx::OptionsParser
-    include Axlsx::Accessors
-
-    # Creates a new comment object
-    # @param [Comments] comments The comment collection this comment belongs to
-    # @param [Hash] options
-    # @option [String] author the author of the comment
-    # @option [String] text The text for the comment
-    # @option [String] ref The refence (e.g. 'A3' where this comment will be anchored.
-    # @option [Boolean] visible This controls the visiblity of the associated vml_shape.
-    def initialize(comments, options={})
-      raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
-      @visible = true
-      @comments = comments
-      parse_options options
-      yield self if block_given?
-    end
-
-    string_attr_accessor :text, :author
-    boolean_attr_accessor :visible
-
-    # The owning Comments object
-    # @return [Comments]
-    attr_reader :comments
-
-    # The string based cell position reference (e.g. 'A1') that determines the positioning of this comment
-    # @return [String|Cell]
-    attr_reader :ref
-
-    # TODO
-    # r (Rich Text Run)
-    # rPh (Phonetic Text Run)
-    # phoneticPr (Phonetic Properties)
-
-    # The vml shape that will render this comment
-    # @return [VmlShape]
-    def vml_shape
-      @vml_shape ||= initialize_vml_shape
-    end
-
-    # The index of this author in a unique sorted list of all authors in
-    # the comment.
-    # @return [Integer]
-    def author_index
-      @comments.authors.index(author)
-    end
-
-    # @see ref
-    def ref=(v)
-      Axlsx::DataTypeValidator.validate :comment_ref, [String, Cell], v
-      @ref = v if v.is_a?(String)
-      @ref = v.r if v.is_a?(Cell)
-    end
-
-    # serialize the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = "")
-      author = @comments.authors[author_index]
-      str << ('<comment ref="' << ref << '" authorId="' << author_index.to_s << '">')
-      str << '<text>'
-      unless author.to_s == ""
-        str << '<r><rPr><b/><color indexed="81"/></rPr>'
-        str << ("<t>" << ::CGI.escapeHTML(author.to_s) << ":\n</t></r>")
-      end
-      str << '<r>'
-      str << '<rPr><color indexed="81"/></rPr>'
-      str << ('<t>' << ::CGI.escapeHTML(text) << '</t></r></text>')
-      str << '</comment>'
-    end
-
-    private
-
-    # initialize the vml shape based on this comment's ref/position in the worksheet.
-    # by default, all columns are 5 columns wide and 5 rows high
-    def initialize_vml_shape
-      pos = Axlsx::name_to_indices(ref)
-      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0], :visible => @visible) do |vml|
-        vml.left_column = vml.column
-        vml.right_column = vml.column + 2 
-        vml.top_row = vml.row
-         vml.bottom_row = vml.row + 4
-      end
-    end
-  end
-end
+module Axlsx
+  # A comment is the text data for a comment
+  class Comment
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+
+    # Creates a new comment object
+    # @param [Comments] comments The comment collection this comment belongs to
+    # @param [Hash] options
+    # @option [String] author the author of the comment
+    # @option [String] text The text for the comment
+    # @option [String] ref The refence (e.g. 'A3' where this comment will be anchored.
+    # @option [Boolean] visible This controls the visiblity of the associated vml_shape.
+    def initialize(comments, options = {})
+      raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
+
+      @visible = true
+      @comments = comments
+      parse_options options
+      yield self if block_given?
+    end
+
+    string_attr_accessor :text, :author
+    boolean_attr_accessor :visible
+
+    # The owning Comments object
+    # @return [Comments]
+    attr_reader :comments
+
+    # The string based cell position reference (e.g. 'A1') that determines the positioning of this comment
+    # @return [String|Cell]
+    attr_reader :ref
+
+    # TODO
+    # r (Rich Text Run)
+    # rPh (Phonetic Text Run)
+    # phoneticPr (Phonetic Properties)
+
+    # The vml shape that will render this comment
+    # @return [VmlShape]
+    def vml_shape
+      @vml_shape ||= initialize_vml_shape
+    end
+
+    # The index of this author in a unique sorted list of all authors in
+    # the comment.
+    # @return [Integer]
+    def author_index
+      @comments.authors.index(author)
+    end
+
+    # @see ref
+    def ref=(v)
+      Axlsx::DataTypeValidator.validate :comment_ref, [String, Cell], v
+      @ref = v if v.is_a?(String)
+      @ref = v.r if v.is_a?(Cell)
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = "")
+      author = @comments.authors[author_index]
+      str << ('<comment ref="' << ref << '" authorId="' << author_index.to_s << '">')
+      str << '<text>'
+      unless author.to_s == ""
+        str << '<r><rPr><b/><color indexed="81"/></rPr>'
+        str << ("<t>" << ::CGI.escapeHTML(author.to_s) << ":\n</t></r>")
+      end
+      str << '<r>'
+      str << '<rPr><color indexed="81"/></rPr>'
+      str << ('<t>' << ::CGI.escapeHTML(text) << '</t></r></text>')
+      str << '</comment>'
+    end
+
+    private
+
+    # initialize the vml shape based on this comment's ref/position in the worksheet.
+    # by default, all columns are 5 columns wide and 5 rows high
+    def initialize_vml_shape
+      pos = Axlsx::name_to_indices(ref)
+      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0], :visible => @visible) do |vml|
+        vml.left_column = vml.column
+        vml.right_column = vml.column + 2
+        vml.top_row = vml.row
+        vml.bottom_row = vml.row + 4
+      end
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/comments.rb

@@ -1,82 +1,78 @@
-# -*- coding: utf-8 -*-
-module Axlsx
-
-  # Comments is a collection of Comment objects for a worksheet
-  class Comments < SimpleTypedList
-
-    # the vml_drawing that holds the shapes for comments
-    # @return [VmlDrawing]
-    attr_reader :vml_drawing
-
-    # The worksheet that these comments belong to
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # The index of this collection in the workbook. Effectively the index of the worksheet.
-    # @return [Integer]
-    def index
-      @worksheet.index
-    end
-
-    # The part name for this object
-    # @return [String]
-    def pn
-      "#{COMMENT_PN % (index+1)}"
-    end
-
-    # Creates a new Comments object
-    # @param [Worksheet] worksheet The sheet that these comments belong to.
-    def initialize(worksheet)
-      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
-      super(Comment)
-      @worksheet = worksheet
-      @vml_drawing = VmlDrawing.new(self)
-    end
-
-    # Adds a new comment to the worksheet that owns these comments.
-    # @note the author, text and ref options are required
-    # @option options [String] author The name of the author for this comment
-    # @option options [String] text The text for this comment
-    # @option options [Stirng|Cell] ref The cell that this comment is attached to.
-    def add_comment(options={})
-      raise ArgumentError, "Comment require an author" unless options[:author]
-      raise ArgumentError, "Comment requires text" unless options[:text]
-      raise ArgumentError, "Comment requires ref" unless options[:ref]
-      self << Comment.new(self, options)
-      yield last if block_given?
-      last
-    end
-
-    # A sorted list of the unique authors in the contained comments
-    # @return [Array]
-    def authors
-      map { |comment| comment.author.to_s }.uniq.sort
-    end
-
-    # The relationships required by this object
-    # @return [Array]
-    def relationships
-      [Relationship.new(self, VML_DRAWING_R, "../#{vml_drawing.pn}"),
-       Relationship.new(self, COMMENT_R, "../#{pn}")]
-    end
-
-    # serialize the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str="")
-      str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<comments xmlns="' << XML_NS << '"><authors>')
-      authors.each do  |author|
-        str << ('<author>' << author.to_s << '</author>')
-      end
-      str << '</authors><commentList>'
-      each do |comment|
-        comment.to_xml_string str
-      end
-      str << '</commentList></comments>'
-
-    end
-
-  end
-
-end
+module Axlsx
+  # Comments is a collection of Comment objects for a worksheet
+  class Comments < SimpleTypedList
+    # the vml_drawing that holds the shapes for comments
+    # @return [VmlDrawing]
+    attr_reader :vml_drawing
+
+    # The worksheet that these comments belong to
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # The index of this collection in the workbook. Effectively the index of the worksheet.
+    # @return [Integer]
+    def index
+      @worksheet.index
+    end
+
+    # The part name for this object
+    # @return [String]
+    def pn
+      "#{COMMENT_PN % (index + 1)}"
+    end
+
+    # Creates a new Comments object
+    # @param [Worksheet] worksheet The sheet that these comments belong to.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
+      super(Comment)
+      @worksheet = worksheet
+      @vml_drawing = VmlDrawing.new(self)
+    end
+
+    # Adds a new comment to the worksheet that owns these comments.
+    # @note the author, text and ref options are required
+    # @option options [String] author The name of the author for this comment
+    # @option options [String] text The text for this comment
+    # @option options [Stirng|Cell] ref The cell that this comment is attached to.
+    def add_comment(options = {})
+      raise ArgumentError, "Comment require an author" unless options[:author]
+      raise ArgumentError, "Comment requires text" unless options[:text]
+      raise ArgumentError, "Comment requires ref" unless options[:ref]
+
+      self << Comment.new(self, options)
+      yield last if block_given?
+      last
+    end
+
+    # A sorted list of the unique authors in the contained comments
+    # @return [Array]
+    def authors
+      map { |comment| comment.author.to_s }.uniq.sort
+    end
+
+    # The relationships required by this object
+    # @return [Array]
+    def relationships
+      [Relationship.new(self, VML_DRAWING_R, "../#{vml_drawing.pn}"),
+       Relationship.new(self, COMMENT_R, "../#{pn}")]
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = "")
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << ('<comments xmlns="' << XML_NS << '"><authors>')
+      authors.each do |author|
+        str << ('<author>' << author.to_s << '</author>')
+      end
+      str << '</authors><commentList>'
+      each do |comment|
+        comment.to_xml_string str
+      end
+      str << '</commentList></comments>'
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/conditional_formatting.rb

@@ -1,82 +1,81 @@
-module Axlsx
-  # Conditional formatting allows styling of ranges based on functions
-  #
-  # @note The recommended way to manage conditional formatting is via Worksheet#add_conditional_formatting
-  # @see Worksheet#add_conditional_formatting
-  # @see ConditionalFormattingRule
-  class ConditionalFormatting
-
-   include Axlsx::OptionsParser
-   
-    # Creates a new {ConditionalFormatting} object
-    # @option options [Array] rules The rules to apply
-    # @option options [String] sqref The range to apply the rules to
-    def initialize(options={})
-      @rules = []
-      parse_options options
-    end
-
-    # Range over which the formatting is applied, in "A1:B2" format
-    # @return [String]
-    attr_reader :sqref
-
-    # Rules to apply the formatting to. Can be either a hash of
-    # options to create a {ConditionalFormattingRule}, an array of hashes
-    # for multiple ConditionalFormattingRules, or an array of already
-    # created ConditionalFormattingRules.
-    # @see ConditionalFormattingRule#initialize
-    # @return [Array]
-    attr_reader :rules
-
-     # Add Conditional Formatting Rules to this object. Rules can either
-    # be already created {ConditionalFormattingRule} elements or
-    # hashes of options for automatic creation.  If rules is a hash
-    # instead of an array, assume only one rule being added.
-    #
-    # @example This would apply formatting "1" to cells > 20, and formatting "2" to cells < 1
-    #        conditional_formatting.add_rules [
-    #            { :type => :cellIs, :operator => :greaterThan, :formula => "20", :dxfId => 1, :priority=> 1 },
-    #            { :type => :cellIs, :operator => :lessThan, :formula => "10", :dxfId => 2, :priority=> 2 } ]
-    #
-    # @param [Array|Hash] rules the rules to apply, can be just one in hash form
-    # @see ConditionalFormattingRule#initialize
-    def add_rules(rules)
-      rules = [rules] if rules.is_a? Hash
-      rules.each do |rule|
-        add_rule rule
-      end
-    end
-
-    # Add a ConditionalFormattingRule. If a hash of options is passed
-    # in create a rule on the fly.
-    # @param [ConditionalFormattingRule|Hash] rule A rule to use, or the options necessary to create one.
-    # @see ConditionalFormattingRule#initialize
-    def add_rule(rule)
-      if rule.is_a? Axlsx::ConditionalFormattingRule
-        @rules << rule
-      elsif rule.is_a? Hash
-        @rules << ConditionalFormattingRule.new(rule)
-      end
-    end
-
-    # @see rules
-    def rules=(v); @rules = v end
-    # @see sqref
-    def sqref=(v); Axlsx::validate_string(v); @sqref = v end
-
-    # Serializes the conditional formatting element
-    # @example Conditional Formatting XML looks like:
-    #    <conditionalFormatting sqref="E3:E9">
-    #        <cfRule type="cellIs" dxfId="0" priority="1" operator="greaterThan">
-    #             <formula>0.5</formula>
-    #        </cfRule>
-    #    </conditionalFormatting>
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << ('<conditionalFormatting sqref="' << sqref << '">')
-      str << rules.collect{ |rule| rule.to_xml_string }.join(' ')
-      str << '</conditionalFormatting>'
-    end
-  end
-end
+module Axlsx
+  # Conditional formatting allows styling of ranges based on functions
+  #
+  # @note The recommended way to manage conditional formatting is via Worksheet#add_conditional_formatting
+  # @see Worksheet#add_conditional_formatting
+  # @see ConditionalFormattingRule
+  class ConditionalFormatting
+    include Axlsx::OptionsParser
+
+    # Creates a new {ConditionalFormatting} object
+    # @option options [Array] rules The rules to apply
+    # @option options [String] sqref The range to apply the rules to
+    def initialize(options = {})
+      @rules = []
+      parse_options options
+    end
+
+    # Range over which the formatting is applied, in "A1:B2" format
+    # @return [String]
+    attr_reader :sqref
+
+    # Rules to apply the formatting to. Can be either a hash of
+    # options to create a {ConditionalFormattingRule}, an array of hashes
+    # for multiple ConditionalFormattingRules, or an array of already
+    # created ConditionalFormattingRules.
+    # @see ConditionalFormattingRule#initialize
+    # @return [Array]
+    attr_reader :rules
+
+    # Add Conditional Formatting Rules to this object. Rules can either
+    # be already created {ConditionalFormattingRule} elements or
+    # hashes of options for automatic creation.  If rules is a hash
+    # instead of an array, assume only one rule being added.
+    #
+    # @example This would apply formatting "1" to cells > 20, and formatting "2" to cells < 1
+    #        conditional_formatting.add_rules [
+    #            { :type => :cellIs, :operator => :greaterThan, :formula => "20", :dxfId => 1, :priority=> 1 },
+    #            { :type => :cellIs, :operator => :lessThan, :formula => "10", :dxfId => 2, :priority=> 2 } ]
+    #
+    # @param [Array|Hash] rules the rules to apply, can be just one in hash form
+    # @see ConditionalFormattingRule#initialize
+    def add_rules(rules)
+      rules = [rules] if rules.is_a? Hash
+      rules.each do |rule|
+        add_rule rule
+      end
+    end
+
+    # Add a ConditionalFormattingRule. If a hash of options is passed
+    # in create a rule on the fly.
+    # @param [ConditionalFormattingRule|Hash] rule A rule to use, or the options necessary to create one.
+    # @see ConditionalFormattingRule#initialize
+    def add_rule(rule)
+      if rule.is_a? Axlsx::ConditionalFormattingRule
+        @rules << rule
+      elsif rule.is_a? Hash
+        @rules << ConditionalFormattingRule.new(rule)
+      end
+    end
+
+    # @see rules
+    def rules=(v); @rules = v end
+    # @see sqref
+    def sqref=(v); Axlsx::validate_string(v); @sqref = v end
+
+    # Serializes the conditional formatting element
+    # @example Conditional Formatting XML looks like:
+    #    <conditionalFormatting sqref="E3:E9">
+    #        <cfRule type="cellIs" dxfId="0" priority="1" operator="greaterThan">
+    #             <formula>0.5</formula>
+    #        </cfRule>
+    #    </conditionalFormatting>
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << ('<conditionalFormatting sqref="' << sqref << '">')
+      str << rules.collect { |rule| rule.to_xml_string }.join(' ')
+      str << '</conditionalFormatting>'
+    end
+  end
+end