lib/roo/excelx/cell/base.rb

Summary

Maintainability
A
1 hr
Test Coverage
# frozen_string_literal: true

require "roo/helpers/default_attr_reader"

module Roo
  class Excelx
    class Cell
      class Base
        extend Roo::Helpers::DefaultAttrReader
        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_with_default default_type: :base, style: 1


        # 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)
          @cell_value = value
          @cell_type = excelx_type if excelx_type
          @formula = formula if formula
          @style = style unless style == 1
          @coordinate = coordinate
          @value = link ? Roo::Link.new(link, value) : value
        end

        def type
          if formula?
            :formula
          elsif link?
            :link
          else
            default_type
          end
        end

        def formula?
          !!(defined?(@formula) && @formula)
        end

        def link?
          Roo::Link === @value
        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.'
          link?
        end

        # DEPRECATED: Please use link? instead.
        def link
          warn '[DEPRECATION] `link` is deprecated.  Please use `link?` instead.'
          link?
        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

        def presence
          empty? ? nil : self
        end
      end
    end
  end
end