roo 2.1.1 → 2.2.0

data/lib/roo/excelx/cell/base.rb

@@ -0,0 +1,94 @@
+module Roo
+  class Excelx
+    class Cell
+      class Base
+        attr_reader :cell_type, :cell_value, :value
+
+        # FIXME: I think style should be deprecated. Having a style attribute
+        #        for a cell doesn't really accomplish much. It seems to be used
+        #        when you want to export to excelx.
+        attr_reader :style
+
+
+        # FIXME: Updating a cell's value should be able tochange the cell's type,
+        #        but that isn't currently possible. This will cause weird bugs
+        #        when one changes the value of a Number cell to a String. e.g.
+        #
+        #           cell = Cell::Number(*args)
+        #           cell.value = 'Hello'
+        #           cell.formatted_value # => Some unexpected value
+        #
+        #        Here are two possible solutions to such issues:
+        #        1. Don't allow a cell's value to be updated. Use a method like
+        #          `Sheet.update_cell` instead. The simple solution.
+        #        2. When `cell.value = ` is called, use injection to try and
+        #           change the type of cell on the fly. But deciding what type
+        #           of value to pass to `cell.value=`. isn't always obvious. e.g.
+        #           `cell.value = Time.now` should convert a cell to a DateTime,
+        #           not a Time cell. Time cells would be hard to recognize because
+        #           they are integers. This approach would require a significant
+        #           change to the code as written. The complex solution.
+        #
+        #        If the first solution is used, then this method should be
+        #        deprecated.
+        attr_writer :value
+
+        def initialize(value, formula, excelx_type, style, link, coordinate)
+          @link = !!link
+          @cell_value = value
+          @cell_type = excelx_type
+          @formula = formula
+          @style = style
+          @coordinate = coordinate
+          @type = :base
+          @value = link? ? Roo::Link.new(link, value) : value
+        end
+
+        def type
+          if formula?
+            :formula
+          elsif link?
+            :link
+          else
+            @type
+          end
+        end
+
+        def formula?
+          !!@formula
+        end
+
+        def link?
+          !!@link
+        end
+
+        alias_method :formatted_value, :value
+
+        def to_s
+          formatted_value
+        end
+
+        # DEPRECATED: Please use link instead.
+        def hyperlink
+          warn '[DEPRECATION] `hyperlink` is deprecated.  Please use `link` instead.'
+        end
+
+        # DEPRECATED: Please use cell_value instead.
+        def excelx_value
+          warn '[DEPRECATION] `excelx_value` is deprecated.  Please use `cell_value` instead.'
+          cell_value
+        end
+
+        # DEPRECATED: Please use cell_type instead.
+        def excelx_type
+          warn '[DEPRECATION] `excelx_type` is deprecated.  Please use `cell_type` instead.'
+          cell_type
+        end
+
+        def empty?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/boolean.rb

@@ -0,0 +1,27 @@
+module Roo
+  class Excelx
+    class Cell
+      class Boolean < Cell::Base
+        attr_reader :value, :formula, :format, :cell_type, :cell_value, :link, :coordinate
+
+        def initialize(value, formula, style, link, coordinate)
+          super(value, formula, nil, style, link, coordinate)
+          @type = @cell_type = :boolean
+          @value = link? ? Roo::Link.new(link, value) : create_boolean(value)
+        end
+
+        def formatted_value
+          value ? 'TRUE'.freeze : 'FALSE'.freeze
+        end
+
+        private
+
+        def create_boolean(value)
+          # FIXME: Using a boolean will cause methods like Base#to_csv to fail.
+          #       Roo is using some method to ignore false/nil values.
+          value.to_i == 1 ? true : false
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/date.rb

@@ -0,0 +1,28 @@
+require 'date'
+
+module Roo
+  class Excelx
+    class Cell
+      class Date < Roo::Excelx::Cell::DateTime
+        attr_reader :value, :formula, :format, :cell_type, :cell_value, :link, :coordinate
+
+        def initialize(value, formula, excelx_type, style, link, base_date, coordinate)
+          # NOTE: Pass all arguments to the parent class, DateTime.
+          super
+          @type = :date
+          @format = excelx_type.last
+          @value = link? ? Roo::Link.new(link, value) : create_date(base_date, value)
+        end
+
+        private
+
+        def create_date(base_date, value)
+          date = base_date + value.to_i
+          yyyy, mm, dd = date.strftime('%Y-%m-%d').split('-')
+
+          ::Date.new(yyyy.to_i, mm.to_i, dd.to_i)
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/datetime.rb

@@ -0,0 +1,101 @@
+require 'date'
+
+module Roo
+  class Excelx
+    class Cell
+      class DateTime < Cell::Base
+        attr_reader :value, :formula, :format, :cell_value, :link, :coordinate
+
+        def initialize(value, formula, excelx_type, style, link, base_date, coordinate)
+          super(value, formula, excelx_type, style, link, coordinate)
+          @type = :datetime
+          @format = excelx_type.last
+          @value = link? ? Roo::Link.new(link, value) : create_datetime(base_date, value)
+        end
+
+        # Public: Returns formatted value for a datetime. Format's can be an
+        #         standard excel format, or a custom format.
+        #
+        #         Standard formats follow certain conventions. Date fields for
+        #         days, months, and years are separated with hyhens or
+        #         slashes ("-", /") (e.g. 01-JAN, 1/13/15). Time fields for
+        #         hours, minutes, and seconds are separated with a colon (e.g.
+        #         12:45:01).
+        #
+        #         If a custom format follows those conventions, then the custom
+        #         format will be used for the a cell's formatted value.
+        #         Otherwise, the formatted value will be in the following
+        #         format: 'YYYY-mm-dd HH:MM:SS' (e.g. "2015-07-10 20:33:15").
+        #
+        # Examples
+        #    formatted_value #=> '01-JAN'
+        #
+        # Returns a String representation of a cell's value.
+        def formatted_value
+          date_regex = /(?<date>[dmy]+[\-\/][dmy]+([\-\/][dmy]+)?)/
+          time_regex = /(?<time>(\[?[h]\]?+:)?[m]+(:?ss|:?s)?)/
+
+          formatter = @format.downcase.split(' ').map do |part|
+            if part[date_regex] == part
+              part.gsub(/#{DATE_FORMATS.keys.join('|')}/, DATE_FORMATS)
+            elsif part[time_regex]
+              part.gsub(/#{TIME_FORMATS.keys.join('|')}/, TIME_FORMATS)
+            else
+              warn 'Unable to parse custom format. Using "YYYY-mm-dd HH:MM:SS" format.'
+              return @value.strftime('%F %T')
+            end
+          end.join(' ')
+
+          @value.strftime(formatter)
+        end
+
+        private
+
+        DATE_FORMATS = {
+          'yyyy'.freeze => '%Y'.freeze,  # Year: 2000
+          'yy'.freeze => '%y'.freeze,    # Year: 00
+          # mmmmm => J-D
+          'mmmm'.freeze => '%B'.freeze,  # Month: January
+          'mmm'.freeze => '%^b'.freeze,   # Month: JAN
+          'mm'.freeze => '%m'.freeze,    # Month: 01
+          'm'.freeze => '%-m'.freeze,    # Month: 1
+          'dddd'.freeze => '%A'.freeze,  # Day of the Week: Sunday
+          'ddd'.freeze => '%^a'.freeze,   # Day of the Week: SUN
+          'dd'.freeze => '%d'.freeze,    # Day of the Month: 01
+          'd'.freeze => '%-d'.freeze,    # Day of the Month: 1
+          # '\\\\'.freeze => ''.freeze,  # NOTE: Fixes a custom format's output.
+        }
+
+        TIME_FORMATS = {
+          'hh'.freeze => '%H'.freeze,    # Hour (24): 01
+          'h'.freeze => '%-k'.freeze,    # Hour (24): 1
+          # 'hh'.freeze => '%I'.freeze,    # Hour (12): 08
+          # 'h'.freeze => '%-l'.freeze,    # Hour (12): 8
+          'mm'.freeze => '%M'.freeze,    # Minute: 01
+          # FIXME: is this used? Seems like 'm' is used for month, not minute.
+          'm'.freeze => '%-M'.freeze,    # Minute: 1
+          'ss'.freeze => '%S'.freeze,    # Seconds: 01
+          's'.freeze => '%-S'.freeze,    # Seconds: 1
+          'am/pm'.freeze => '%p'.freeze, # Meridian: AM
+          '000'.freeze => '%3N'.freeze,  # Fractional Seconds: thousandth.
+          '00'.freeze => '%2N'.freeze,   # Fractional Seconds: hundredth.
+          '0'.freeze => '%1N'.freeze,    # Fractional Seconds: tenths.
+        }
+
+        def create_datetime(base_date, value)
+          date = base_date + value.to_f.round(6)
+          datetime_string = date.strftime('%Y-%m-%d %H:%M:%S.%N')
+          t = round_datetime(datetime_string)
+
+          ::DateTime.civil(t.year, t.month, t.day, t.hour, t.min, t.sec)
+        end
+
+        def round_datetime(datetime_string)
+          /(?<yyyy>\d+)-(?<mm>\d+)-(?<dd>\d+) (?<hh>\d+):(?<mi>\d+):(?<ss>\d+.\d+)/ =~ datetime_string
+
+          ::Time.new(yyyy.to_i, mm.to_i, dd.to_i, hh.to_i, mi.to_i, ss.to_r).round(0)
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/empty.rb

@@ -0,0 +1,19 @@
+
+module Roo
+  class Excelx
+    class Cell
+      class Empty < Cell::Base
+        attr_reader :value, :formula, :format, :cell_type, :cell_value, :hyperlink, :coordinate
+
+        def initialize(coordinate)
+          @value = @formula = @format = @cell_type = @cell_value = @hyperlink = nil
+          @coordinate = coordinate
+        end
+
+        def empty?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/number.rb

@@ -0,0 +1,80 @@
+module Roo
+  class Excelx
+    class Cell
+      class Number < Cell::Base
+        attr_reader :value, :formula, :format, :cell_value, :link, :coordinate
+
+        def initialize(value, formula, excelx_type, style, link, coordinate)
+          super
+          # FIXME: change @type to number. This will break brittle tests.
+          # FIXME: Excelx_type is an array, but the first value isn't used.
+          @type = :float
+          @format = excelx_type.last
+          @value = link? ? Roo::Link.new(link, value) : create_numeric(value)
+        end
+
+        def create_numeric(number)
+          case @format
+          when /%/
+            Float(number)
+          when /\.0/
+            Float(number)
+          else
+            number.include?('.') ? Float(number) : Integer(number)
+          end
+        end
+
+        def formatted_value
+          formatter = formats[@format]
+          if formatter.is_a? Proc
+            formatter.call(@cell_value)
+          else
+            Kernel.format(formatter, @cell_value)
+          end
+        end
+
+        def formats
+          # FIXME: numbers can be other colors besides red:
+          # [BLACK], [BLUE], [CYAN], [GREEN], [MAGENTA], [RED], [WHITE], [YELLOW], [COLOR n]
+          {
+            'General' => '%.0f',
+            '0' => '%.0f',
+            '0.00' => '%.2f',
+            '#,##0' => proc do |number|
+              Kernel.format('%.0f', number).reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+            end,
+            '#,##0.00' => proc do |number|
+              Kernel.format('%.2f', number).reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+            end,
+            '0%' =>  proc do |number|
+              Kernel.format('%d%', number.to_f * 100)
+            end,
+            '0.00%' => proc do |number|
+              Kernel.format('%.2f%', number.to_f * 100)
+            end,
+            '0.00E+00' => '%.2E',
+            '#,##0 ;(#,##0)' => proc do |number|
+              formatter = number.to_i > 0 ? '%.0f' : '(%.0f)'
+              Kernel.format(formatter, number.to_f.abs).reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+            end,
+            '#,##0 ;[Red](#,##0)' => proc do |number|
+              formatter = number.to_i > 0 ? '%.0f' : '[Red](%.0f)'
+              Kernel.format(formatter, number.to_f.abs).reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+            end,
+            '#,##0.00;(#,##0.00)' => proc do |number|
+              formatter = number.to_i > 0 ? '%.2f' : '(%.2f)'
+              Kernel.format(formatter, number.to_f.abs).reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+            end,
+            '#,##0.00;[Red](#,##0.00)' => proc do |number|
+              formatter = number.to_i > 0 ? '%.2f' : '[Red](%.2f)'
+              Kernel.format(formatter, number.to_f.abs).reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+            end,
+            # FIXME: not quite sure what the format should look like in this case.
+            '##0.0E+0' => '%.1E',
+            '@' => proc { |number| number }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/string.rb

@@ -0,0 +1,19 @@
+module Roo
+  class Excelx
+    class Cell
+      class String < Cell::Base
+        attr_reader :value, :formula, :format, :cell_type, :cell_value, :link, :coordinate
+
+        def initialize(value, formula, style, link, coordinate)
+          super(value, formula, nil, style, link, coordinate)
+          @type = @cell_type = :string
+          @value = link? ? Roo::Link.new(link, value) : value
+        end
+
+        def empty?
+          value.empty?
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/cell/time.rb

@@ -0,0 +1,43 @@
+require 'date'
+
+module Roo
+  class Excelx
+    class Cell
+      class Time < Roo::Excelx::Cell::DateTime
+        attr_reader :value, :formula, :format, :cell_value, :link, :coordinate
+
+        def initialize(value, formula, excelx_type, style, link, base_date, coordinate)
+          # NOTE: Pass all arguments to DateTime super class.
+          super
+          @type = :time
+          @format = excelx_type.last
+          @datetime = create_datetime(base_date, value)
+          @value = link? ? Roo::Link.new(link, value) : (value.to_f * 86_400).to_i
+        end
+
+        def formatted_value
+          formatter = @format.gsub(/#{TIME_FORMATS.keys.join('|')}/, TIME_FORMATS)
+          @datetime.strftime(formatter)
+        end
+
+        alias_method :to_s, :formatted_value
+
+        private
+
+        def create_datetime(base_date, value)
+          date = base_date + value.to_f.round(6)
+          datetime_string = date.strftime('%Y-%m-%d %H:%M:%S.%N')
+          t = round_datetime(datetime_string)
+
+          ::DateTime.civil(t.year, t.month, t.day, t.hour, t.min, t.sec)
+        end
+
+        def round_datetime(datetime_string)
+          /(?<yyyy>\d+)-(?<mm>\d+)-(?<dd>\d+) (?<hh>\d+):(?<mi>\d+):(?<ss>\d+.\d+)/ =~ datetime_string
+
+          ::Time.new(yyyy.to_i, mm.to_i, dd.to_i, hh.to_i, mi.to_i, ss.to_r).round(0)
+        end
+      end
+    end
+  end
+end

data/lib/roo/excelx/comments.rb

@@ -20,3 +20,36 @@ module Roo
     end
   end
 end
+# xl/comments1.xml
+#   <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+#   <comments xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
+#     <authors>
+#       <author />
+#     </authors>
+#     <commentList>
+#       <comment ref="B4" authorId="0">
+#         <text>
+#           <r>
+#             <rPr>
+#               <sz val="10" />
+#               <rFont val="Arial" />
+#               <family val="2" />
+#             </rPr>
+#             <t>Comment for B4</t>
+#           </r>
+#         </text>
+#       </comment>
+#       <comment ref="B5" authorId="0">
+#         <text>
+#           <r>
+#             <rPr>
+#             <sz val="10" />
+#             <rFont val="Arial" />
+#             <family val="2" />
+#           </rPr>
+#             <t>Comment for B5</t>
+#           </r>
+#         </text>
+#       </comment>
+#     </commentList>
+#   </comments>