workbook 0.8.1 → 0.9.0

data/lib/workbook/format.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
-
-# -*- encoding : utf-8 -*-
 # frozen_string_literal: true
-require 'workbook/modules/raw_objects_storage'
+
+require "workbook/modules/raw_objects_storage"
 
 module Workbook
   # Format is an object used for maintinaing a cell's formatting. It can belong to many cells. It maintains a relation to the raw template's equivalent, to preserve attributes Workbook cannot modify/access.
@@ -26,25 +25,25 @@ module Workbook
     #
     # @param [Workbook::Format, Hash] options (e.g. :background, :color, :background_color, :font_weight (integer or css-type labels)
     # @return [String] the name of the format, default: nil
-    def initialize options={}, name=nil
+    def initialize options = {}, name = nil
       if options.is_a? String
         name = options
       else
-        options.each {|k,v| self[k]=v}
+        options.each { |k, v| self[k] = v }
       end
       self.name = name
     end
 
     # Does the current format feature a background *color*? (not black or white or transparant).
-    def has_background_color? color=:any
+    def has_background_color? color = :any
       bg_color = flattened[:background_color] ? flattened[:background_color].to_s.downcase : nil
 
-      if color != :any and bg_color
-        return bg_color == color.to_s.downcase
+      if (color != :any) && bg_color
+        bg_color == color.to_s.downcase
       elsif bg_color
-        return !(flattened[:background_color].downcase=='#ffffff' or flattened[:background_color]=='#000000')
+        !((flattened[:background_color].downcase == "#ffffff") || (flattened[:background_color] == "#000000"))
       else
-        return false
+        false
       end
     end
 
@@ -52,9 +51,9 @@ module Workbook
     # @return String very basic CSS styling string
     def to_css
       css_parts = []
-      background = [flattened[:background_color].to_s,flattened[:background].to_s].join(" ").strip
-      css_parts.push("background: #{background}") if background and background != ""
-      css_parts.push("color: #{flattened[:color].to_s}") if flattened[:color]
+      background = [flattened[:background_color].to_s, flattened[:background].to_s].join(" ").strip
+      css_parts.push("background: #{background}") if background && (background != "")
+      css_parts.push("color: #{flattened[:color]}") if flattened[:color]
       css_parts.join("; ")
     end
 
@@ -62,22 +61,22 @@ module Workbook
     # @param [Workbook::Format] other_format
     # @return [Workbook::Format] a new resulting Workbook::Format
     def merge(other_format)
-      self.remove_all_raws!
-      self.merge_hash(other_format)
+      remove_all_raws!
+      merge_hash(other_format)
     end
 
     # Applies the formatting options of self with another, removes as a consequence the reference to the raw object's equivalent.
     # @param [Workbook::Format] other_format
     # @return [Workbook::Format] self
     def merge!(other_format)
-      self.remove_all_raws!
-      self.merge_hash!(other_format)
+      remove_all_raws!
+      merge_hash!(other_format)
     end
 
     # returns an array of all formats this style is inheriting from (including itself)
     # @return [Array<Workbook::Format>] an array of Workbook::Formats
     def formats
-      formats=[]
+      formats = []
       f = self
       formats << f
       while f.parent
@@ -90,23 +89,23 @@ module Workbook
     # returns an array of all format-names this style is inheriting from (and this style)
     # @return [Array<String>] an array of Workbook::Formats
     def all_names
-      formats.collect{|a| a.name}
+      formats.collect { |a| a.name }
     end
 
     # Applies the formatting options of self with its parents until no parent can be found
     # @return [Workbook::Format] new Workbook::Format that is the result of merging current style with all its parent's styles.
     def flattened
-      ff=Workbook::Format.new()
-      formats.each{|a| ff.merge!(a) }
-      return ff
+      ff = Workbook::Format.new
+      formats.each { |a| ff.merge!(a) }
+      ff
     end
 
     # Formatting is sometimes the only way to detect the cells' type.
     def derived_type
       if self[:numberformat]
-        if self[:numberformat].to_s.match("h")
+        if self[:numberformat].to_s.match?("h")
           :time
-        elsif self[:numberformat].to_s.match(/y/i)
+        elsif /y/i.match?(self[:numberformat].to_s)
           :date
         end
       end

data/lib/workbook/generatetypes.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-["Numeric","String","Time","Date","TrueClass","FalseClass","NilClass"].each do |type|
-  f = File.open(File.join(File.dirname(__FILE__),"types","#{type}.rb"),'w+')
+["Numeric", "String", "Time", "Date", "TrueClass", "FalseClass", "NilClass"].each do |type|
+  f = File.open(File.join(File.dirname(__FILE__), "types", "#{type}.rb"), "w+")
   puts f.inspect
-  doc="require 'workbook/cell'
+  doc = "require 'workbook/cell'
 
 module Workbook
   module Types
@@ -12,5 +12,5 @@ module Workbook
     end
   end
 end"
-f.write(doc)
+  f.write(doc)
 end

data/lib/workbook/modules/cache.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-
-# -*- encoding : utf-8 -*-
 # frozen_string_literal: true
+
 module Workbook
   module Modules
     # Adds simple caching
@@ -33,12 +32,12 @@ module Workbook
 
       # Check if currently stored key is available and still valid
       # @return [Boolean]
-      def valid_cache_key?(key, expires=nil)
+      def valid_cache_key?(key, expires = nil)
         cache_valid_from
-        rv = (@cache[key] and (@cache[key][:inserted_at] > cache_valid_from) and (expires.nil? or @cache[key][:inserted_at] < expires)) ? true : false
-        rv
+        @cache[key] && (@cache[key][:inserted_at] > cache_valid_from) && (expires.nil? || (@cache[key][:inserted_at] < expires))
       end
-      def fetch_cache(key, expires=nil)
+
+      def fetch_cache(key, expires = nil)
         @cache ||= {}
         if valid_cache_key?(key, expires)
           return @cache[key][:value]
@@ -48,7 +47,7 @@ module Workbook
             inserted_at: Time.now
           }
         end
-        return @cache[key][:value]
+        @cache[key][:value]
       end
     end
   end

data/lib/workbook/modules/cell.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
-
-# -*- encoding : utf-8 -*-
 # frozen_string_literal: true
-require 'workbook/modules/type_parser'
-require 'workbook/nil_value'
-require 'date'
+
+require "workbook/modules/type_parser"
+require "workbook/nil_value"
+require "date"
 
 module Workbook
   module Modules
@@ -12,50 +11,51 @@ module Workbook
       include Workbook::Modules::TypeParser
 
       CHARACTER_REPACEMENTS = {
-        [/[\(\)\.\?\,\!\=\$\:]/,] => '',
-        [/\&/] => 'amp',
-        [/\+/] => '_plus_',
-        [/\s/,'/_','/',"\\"] => '_',
-        ['–_','-_','+_','-'] => '',
-        ['__']=>'_',
-        ['>']=>'gt',
-        ['<']=>'lt',
-        ['á','à','â','ä','ã','å'] => 'a',
-        ['Ã','Ä','Â','À','�?','Å'] => 'A',
-        ['é','è','ê','ë'] => 'e',
-        ['Ë','É','È','Ê'] => 'E',
-        ['í','ì','î','ï'] => 'i',
-        ['�?','Î','Ì','�?'] => 'I',
-        ['ó','ò','ô','ö','õ'] => 'o',
-        ['Õ','Ö','Ô','Ò','Ó'] => 'O',
-        ['ú','ù','û','ü'] => 'u',
-        ['Ú','Û','Ù','Ü'] => 'U',
-        ['ç'] => 'c',
-        ['Ç'] => 'C',
-        ['š', 'ś'] => 's',
-        ['Š', 'Ś'] => 'S',
-        ['ž','ź'] => 'z',
-        ['Ž','Ź'] => 'Z',
-        ['ñ'] => 'n',
-        ['Ñ'] => 'N',
-        ['#'] => 'hash',
-        ['*'] => 'asterisk'
+        [/[().?,!=$:]/] => "",
+        [/&/] => "amp",
+        [/\+/] => "_plus_",
+        [/\s/, "/_", "/", "\\"] => "_",
+        ["–_", "-_", "+_", "-"] => "",
+        ["__"] => "_",
+        [">"] => "gt",
+        ["<"] => "lt",
+        ["á", "à", "â", "ä", "ã", "å"] => "a",
+        ["Ã", "Ä", "Â", "À", "�?", "Å"] => "A",
+        ["é", "è", "ê", "ë"] => "e",
+        ["Ë", "É", "È", "Ê"] => "E",
+        ["í", "ì", "î", "ï"] => "i",
+        ["�?", "Î", "Ì", "�?"] => "I",
+        ["ó", "ò", "ô", "ö", "õ"] => "o",
+        ["Õ", "Ö", "Ô", "Ò", "Ó"] => "O",
+        ["ú", "ù", "û", "ü"] => "u",
+        ["Ú", "Û", "Ù", "Ü"] => "U",
+        ["ç"] => "c",
+        ["Ç"] => "C",
+        ["š", "ś"] => "s",
+        ["Š", "Ś"] => "S",
+        ["ž", "ź"] => "z",
+        ["Ž", "Ź"] => "Z",
+        ["ñ"] => "n",
+        ["Ñ"] => "N",
+        ["#"] => "hash",
+        ["*"] => "asterisk"
       }
       CLASS_CELLTYPE_MAPPING = {
-       'Numeric' => :integer,
-       'Integer' => :integer,
-       'Fixnum' => :integer,
-       'Float' => :float,
-       'String' => :string,
-       'Symbol' => :string,
-       'Time' => :time,
-       'Date' => :date,
-       'DateTime' => :datetime,
-       'ActiveSupport::TimeWithZone' => :datetime,
-       'TrueClass' => :boolean,
-       'FalseClass' => :boolean,
-       'NilClass' => :nil,
-       'Workbook::NilValue' => :nil
+        "BigDecimal" => :decimal,
+        "Numeric" => :integer,
+        "Integer" => :integer,
+        "Fixnum" => :integer,
+        "Float" => :float,
+        "String" => :string,
+        "Symbol" => :string,
+        "Time" => :time,
+        "Date" => :date,
+        "DateTime" => :datetime,
+        "ActiveSupport::TimeWithZone" => :datetime,
+        "TrueClass" => :boolean,
+        "FalseClass" => :boolean,
+        "NilClass" => :nil,
+        "Workbook::NilValue" => :nil
       }
       # Note that these types are sorted by 'importance'
 
@@ -80,7 +80,7 @@ module Workbook
       end
 
       def row= r
-        @row= r
+        @row = r
       end
 
       # Change the current value
@@ -109,18 +109,25 @@ module Workbook
         @value
       end
 
+      # Returns the column object for the cell
+      #
+      # @return [Workbook::Column] the column the cell belongs to
+      def column
+        table.columns[index]
+      end
+
       # Returns the sheet its at.
       #
       # @return [Workbook::Table]
       def table
-        row.table if row
+        row&.table
       end
 
       # Quick assessor to the book's template, if it exists
       #
       # @return [Workbook::Template]
       def template
-        row.template if row
+        row&.template
       end
 
       # Change the current format
@@ -131,7 +138,7 @@ module Workbook
           @workbook_format = f
         elsif f.is_a? Hash
           @workbook_format = Workbook::Format.new(f)
-        elsif f.class == NilClass
+        elsif f.instance_of?(NilClass)
           @workbook_format = Workbook::Format.new
         end
       end
@@ -141,7 +148,7 @@ module Workbook
       # @return [Workbook::Format] the current format
       def format
         # return @workbook_format if @workbook_format
-        if row and template and row.header? and !defined?(@workbook_format)
+        if row && template && row.header? && !defined?(@workbook_format)
           @workbook_format = template.create_or_find_format_by(:header)
         else
           @workbook_format ||= Workbook::Format.new
@@ -155,9 +162,9 @@ module Workbook
       # @return [Boolean]
       def ==(other)
         if other.is_a? Cell
-          other.value == self.value
+          other.value == value
         else
-          other == self.value
+          other == value
         end
       end
 
@@ -168,7 +175,7 @@ module Workbook
       end
 
       def nil_or_empty?
-        value.nil? || value.to_s == ""
+        value.nil? || value.strip.to_s == ""
       end
 
       def value_to_s
@@ -181,46 +188,24 @@ module Workbook
       #
       #     <Workbook::Cell value="yet another value">.to_sym # returns :yet_another_value
       def to_sym
-        return @to_sym if @to_sym
-        v = nil
-        unless nil_or_empty?
-          if cell_type == :integer
-            v = "num#{value}".to_sym
-          elsif cell_type == :float
-            v = "num#{value}".sub(".","_").to_sym
-          else
-            v = value_to_s.strip
-            ends_with_exclamationmark = (v[-1] == '!')
-            ends_with_questionmark = (v[-1] == '?')
-
-            v = _replace_possibly_problematic_characters_from_string(v)
-
-            v = v.encode(Encoding.find('ASCII'), {:invalid => :replace, :undef => :replace, :replace => ''})
-
-            v = "#{v}!" if ends_with_exclamationmark
-            v = "#{v}?" if ends_with_questionmark
-            v = v.downcase.to_sym
-          end
-        end
-        @to_sym = v
-        return @to_sym
+        @to_sym ||= ::Workbook::Cell.value_to_sym(value)
       end
 
       # Compare
       #
       # @param [Workbook::Cell] other cell to compare against (based on value), can compare different value-types using #compare_on_class
-      # @return [Fixnum] -1, 0, 1
+      # @return [Integer] -1, 0, 1
       def <=> other
         rv = nil
         begin
-          rv = self.value <=> other.value
+          rv = value <=> other.value
         rescue NoMethodError
           rv = compare_on_class other
         end
-        if rv == nil
+        if rv.nil?
           rv = compare_on_class other
         end
-        return rv
+        rv
       end
 
       # Compare on class level
@@ -229,7 +214,7 @@ module Workbook
       def compare_on_class other
         other_value = nil
         other_value = other.value if other
-        self_value = importance_of_class self.value
+        self_value = importance_of_class value
         other_value = importance_of_class other_value
         self_value <=> other_value
       end
@@ -245,14 +230,14 @@ module Workbook
       #
       # @return [Boolean] index of the cell
       def format?
-        format and format.keys.count > 0
+        format && (format.keys.count > 0)
       end
 
       # Returns the index of the cell within the row, returns nil if no row is present
       #
       # @return [Integer, NilClass] index of the cell
       def index
-        row.index self if row
+        row&.index self
       end
 
       # Returns the key (a Symbol) of the cell, based on its table's header
@@ -265,6 +250,7 @@ module Workbook
       def inspect
         txt = "<Workbook::Cell @value=#{value}"
         txt += " @format=#{format}" if format?
+        txt += " @cell_type=#{cell_type}"
         txt += ">"
         txt
       end
@@ -272,9 +258,9 @@ module Workbook
       # convert value to string, and in case of a Date or Time value, apply formatting
       # @return [String]
       def to_s
-        if (self.is_a? Date or self.is_a? Time) and format[:number_format]
+        if (is_a?(Date) || is_a?(Time)) && format[:number_format]
           value.strftime(format[:number_format])
-        elsif (self.class == Workbook::Cell)
+        elsif instance_of?(Workbook::Cell)
           value.to_s
         else
           super
@@ -284,26 +270,17 @@ module Workbook
       def colspan= c
         @colspan = c
       end
+
       def rowspan= r
         @rowspan = r
       end
 
       def colspan
-        @colspan.to_i if defined?(@colspan) and @colspan.to_i > 1
-      end
-      def rowspan
-        @rowspan.to_i if defined?(@rowspan) and @rowspan.to_i > 1
+        @colspan.to_i if defined?(@colspan) && (@colspan.to_i > 1)
       end
 
-      private
-
-      def _replace_possibly_problematic_characters_from_string(string)
-        Workbook::Modules::Cell::CHARACTER_REPACEMENTS.each do |ac,rep|
-          ac.each do |s|
-            string = string.gsub(s, rep)
-          end
-        end
-        string
+      def rowspan
+        @rowspan.to_i if defined?(@rowspan) && (@rowspan.to_i > 1)
       end
     end
   end