workbook 0.4.2 → 0.4.3

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun May  5 14:58:04 2013 by
+  Generated on Sun May 19 23:16:28 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.5.2 (ruby-1.9.3).
 </div>

data/lib/workbook/book.rb

@@ -9,9 +9,9 @@ require 'workbook/readers/csv_reader'
 require 'workbook/readers/txt_reader'
 
 module Workbook
-  # The Book class is the container of sheets. It can be inialized by either the standard initalizer or the open method. The 
+  # The Book class is the container of sheets. It can be inialized by either the standard initalizer or the open method. The
   # Book class can also keep a reference to a template class, storing shared formatting options.
-  # 
+  #
   class Book < Array
     include Workbook::Readers::XlsShared
     include Workbook::Writers::XlsWriter
@@ -21,12 +21,12 @@ module Workbook
     include Workbook::Readers::XlsxReader
     include Workbook::Readers::CsvReader
     include Workbook::Readers::TxtReader
-    
+
     attr_accessor :title
     attr_accessor :template
-    
+
     # @param [Workbook::Sheet, Array] sheet    create a new workbook based on an existing sheet, or initialize a sheet based on the array
-    # @return [Workbook::Book]  
+    # @return [Workbook::Book]
     def initialize sheet=Workbook::Sheet.new([], self, options={})
       if sheet.is_a? Workbook::Sheet
         push sheet
@@ -34,32 +34,32 @@ module Workbook
         push Workbook::Sheet.new(sheet, self, options)
       end
     end
-    
+
     # @return [Workbook::Format] returns the template describing how the document should be/is formatted
     def template
       @template ||= Workbook::Template.new
     end
-    
+
     # @param [Workbook::Format] template    a template describing how the document should be/is formatted
     def template= template
       raise ArgumentError, "format should be a Workboot::Format" unless template.is_a? Workbook::Template
       @template = template
     end
-    
+
     # The title of the workbook
     #
     # @return [String] the title of the workbook
     def title
       @title ? @title : "untitled document"
     end
-    
+
     # Push (like in array) a sheet to the workbook (parameter is optional, default is a new sheet)
     #
     # @param [Workbook::Sheet] sheet
-  	def push sheet=Workbook::Sheet.new
+    def push sheet=Workbook::Sheet.new
       super(sheet)
     end
-    
+
     # Sheet returns the first sheet of a workbook, or an empty one.
     #
     # @return [Workbook::Sheet] The first sheet, and creates an empty one if one doesn't exists
@@ -67,14 +67,14 @@ module Workbook
       push Workbook::Sheet.new unless first
       first
     end
-    
+
     # If the first sheet has any contents
     #
     # @return [Boolean] returns true if the first sheet has contents
     def has_contents?
       sheet.has_contents?
     end
-    
+
     # Loads an external file into an existing worbook
     #
     # @param [String] filename   a string with a reference to the file to be opened
@@ -88,7 +88,7 @@ module Workbook
         open_binary filename, extension
       end
     end
-    
+
     # Open the file in binary, read-only mode, do not read it, but pas it throug to the extension determined loaded
     #
     # @param [String] filename a string with a reference to the file to be opened
@@ -99,7 +99,7 @@ module Workbook
       f = File.open(filename,'rb')
       send("load_#{extension}".to_sym,f)
     end
-    
+
     # Open the file in non-binary, read-only mode, read it and parse it to UTF-8
     #
     # @param [String] filename   a string with a reference to the file to be opened
@@ -111,14 +111,14 @@ module Workbook
       t = text_to_utf8(t)
       send("load_#{extension}".to_sym,t)
     end
-    
-    
+
+
     # Helper method to convert text in a file to UTF-8
-    # 
+    #
     # @param [String] text a string to convert
     def text_to_utf8 text
       if RUBY_VERSION < '1.9'
-        require 'rchardet' 
+        require 'rchardet'
         require 'iconv'
         detected_encoding = CharDet.detect(text)
         detected_encoding = detected_encoding['encoding']
@@ -134,14 +134,14 @@ module Workbook
       end
       return text
     end
-    
+
     # @param [String] filename   The full filename, or path
     #
     # @return [String] The file extension
     def file_extension(filename)
       File.extname(filename).gsub('.','').downcase if filename
     end
-    
+
     # Create an instance from a file, using open.
     #
     # @param [String] filename of the document
@@ -163,7 +163,7 @@ module Workbook
       wb.read(stringio_or_string, filetype)
       wb
     end
-    
+
     # Load the CSV data contained in the given StringIO or String object
     #
     # @param [StringIO] stringio_or_string StringIO stream or String object, with data in CSV format
@@ -176,14 +176,14 @@ module Workbook
     end
 
     # Create or open the existing sheet at an index value
-    # 
+    #
     # @param [Integer] index    the index of the sheet
     def create_or_open_sheet_at index
       s = self[index]
       s = self[index] = Workbook::Sheet.new if s == nil
       s.book = self
-      s 
+      s
     end
-    
+
   end
 end

data/lib/workbook/cell.rb

@@ -5,37 +5,37 @@ require 'workbook/modules/type_parser'
 module Workbook
   class Cell
     include Workbook::Modules::TypeParser
-    
+
     attr_accessor :value
     attr_accessor :format
     attr_accessor :formula
     attr_accessor :colspan
     attr_accessor :rowspan
-    
+
     # Note that these types are sorted by 'importance'
     VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Workbook::NilValue]
-    
+
     # Evaluates a value for class-validity
     #
     # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Object] value the value to evaluate
     # @return [Boolean] returns true when the value is a valid cell value
     def valid_value? value
-      valid_type = false 
-      VALID_TYPES.each {|t| return true if value.is_a? t} 
+      valid_type = false
+      VALID_TYPES.each {|t| return true if value.is_a? t}
       valid_type
     end
-    
+
     # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] value a valid value
     # @param [Hash] options a reference to :format (Workbook::Format) can be specified
     def initialize value=nil, options={}
       if valid_value? value
-        format = options[:format] 
+        format = options[:format]
         @value = value
       else
         raise ArgumentError, "value should be of a primitive type, e.g. a string, or an integer, not a #{value.class} (is_a? [TrueClass,FalseClass,Date,Time,Numeric,String, NilClass])"
       end
     end
-    
+
     # @param [Workbook::Format, Hash] f set the formatting properties of this Cell
     def format= f
       if f.is_a? Workbook::Format
@@ -46,7 +46,7 @@ module Workbook
         @format = Workbook::Format.new
       end
     end
-    
+
     def format
       @format ||= Workbook::Format.new
     end
@@ -60,16 +60,16 @@ module Workbook
         other == self.value
       end
     end
-    
+
     # returns true when the value of the cell is nil.
     # @return [Boolean]
     def nil?
       return value.nil?
     end
-    
+
     # returns a symbol representation of the cell's value
     # @return [Symbol] a symbol representation
-    # @example 
+    # @example
     #
     #     <Workbook::Cell value="yet another value">.to_sym # returns :yet_another_value
     def to_sym
@@ -79,19 +79,19 @@ module Workbook
         v = value.to_s.downcase
         v = v.gsub(' (j/?/leeg)','').gsub(/dd-mm-(.*)/,'').gsub(/\ja\/nee/,'').gsub(/\(\)/,'').gsub(/[\(\)]+/, '')
         v = v.strip.gsub(/(\.|\?|,|\=)/,'').
-            gsub('$','').
-            gsub(/\&/,'en').
-            gsub(/\+/,'_plus_').
-            gsub(/\s/, "_").
-            gsub('–_','').
-            gsub('-_','').
-            gsub('+_','').
-            gsub('/_','_').
-            gsub('/','_').
-            gsub('__','_').
-            gsub('-','')
-            
-        accents = { 
+        gsub('$','').
+        gsub(/\&/,'en').
+        gsub(/\+/,'_plus_').
+        gsub(/\s/, "_").
+        gsub('–_','').
+        gsub('-_','').
+        gsub('+_','').
+        gsub('/_','_').
+        gsub('/','_').
+        gsub('__','_').
+        gsub('-','')
+
+        accents = {
           ['á','à','â','ä','ã'] => 'a',
           ['Ã','Ä','Â','À','�?'] => 'A',
           ['é','è','ê','ë'] => 'e',
@@ -121,7 +121,7 @@ module Workbook
       end
       v
     end
-    
+
     # @param [Workbook::Cell] other cell to compare against, can compare different value-types using #compare_on_class
     def <=> other
       rv = nil
@@ -130,13 +130,13 @@ module Workbook
       rescue NoMethodError => e
         rv = compare_on_class other
       end
-      if rv == nil        
+      if rv == nil
         rv = compare_on_class other
       end
       return rv
 
     end
-    
+
     # Compare on class level
     #
     # @param [Workbook::Cell] other cell to compare against
@@ -147,21 +147,21 @@ module Workbook
       other_value = importance_of_class other_value
       self_value <=> other_value
     end
-    
+
     # Returns the importance of a value's class
     #
     # @param value a potential value for a cell
     def importance_of_class value
-      VALID_TYPES.each_with_index do |c,i|  
+      VALID_TYPES.each_with_index do |c,i|
         return i if value.is_a? c
       end
       return nil
     end
-    
+
     def inspect
       "<Workbook::Cell @value=#{value}>"
     end
-    
+
     # convert value to string, and in case of a Date or Time value, apply formatting
     # @return [String]
     def to_s
@@ -171,7 +171,7 @@ module Workbook
         value.to_s
       end
     end
-    
+
     def colspan
       @colspan.to_i if @colspan.to_i > 1
     end

data/lib/workbook/format.rb

@@ -8,14 +8,14 @@ module Workbook
     alias_method :merge_hash, :merge
     alias_method :merge_hash!, :merge!
     attr_accessor :name, :parent
-    
+
     # Initialize
     # @param [Workbook::Format, Hash] options (e.g. :background, :color
     def initialize options={}, name=nil
       options.each {|k,v| self[k]=v}
       self.name = name
     end
-    
+
     # Does the current format feature a background *color*? (not black or white or transparant).
     def has_background_color? color=:any
       if flattened[:background_color]
@@ -24,7 +24,7 @@ module Workbook
         return false
       end
     end
-    
+
     # Returns a string that can be used as inline cell styling (e.g. `<td style="<%=cell.format.to_css%>"><%=cell%></td>`)
     # @return String very basic CSS styling string
     def to_css
@@ -34,7 +34,7 @@ module Workbook
       css_parts.push("color: #{flattened[:color].to_s}") if flattened[:color]
       css_parts.join("; ")
     end
-    
+
     # Combines the formatting options of one with another, removes as a consequence the reference to the raw object's equivalent.
     # @param [Workbook::Format] other_format
     # @return [Workbook::Format] a new resulting Workbook::Format
@@ -42,15 +42,15 @@ module Workbook
       self.remove_all_raws!
       self.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 
+    # @param [Workbook::Format] other_format
     # @return [Workbook::Format] self
     def merge!(other_format)
       self.remove_all_raws!
       self.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
@@ -63,13 +63,13 @@ module Workbook
       end
       formats.reverse
     end
-    
+
     # 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 
+    def all_names
       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

data/lib/workbook/modules/raw_objects_storage.rb

@@ -1,37 +1,37 @@
 # -*- encoding : utf-8 -*-
 module Workbook
-	module Modules
+  module Modules
     # Adds support for storing raw objects, used in e.g. Format and Template
-		module RawObjectsStorage
-      
-	    # A raw is a 'raw' object, representing a workbook, or cell, or whatever... in a particular format (defined by its class)
+    module RawObjectsStorage
+
+      # A raw is a 'raw' object, representing a workbook, or cell, or whatever... in a particular format (defined by its class)
       def add_raw raw_object
-	      raws[raw_object.class]=raw_object
-	    end
-      
+        raws[raw_object.class]=raw_object
+      end
+
       # Returns true if there is a template for a certain class, otherwise false
-	    def has_raw_for? raw_object_class
-	      raws.each { |tc,t| return true if tc == raw_object_class}
+      def has_raw_for? raw_object_class
+        raws.each { |tc,t| return true if tc == raw_object_class}
         return false
-	    end
-      
+      end
+
       # Returns raw data stored for a type of raw object (if available)
       # @param [Class] raw_object_class (e.g. Spreadsheet::Format for the Spreadsheet-gem)
       def return_raw_for raw_object_class
-	      raws.each { |tc,t| return t if tc == raw_object_class}
+        raws.each { |tc,t| return t if tc == raw_object_class}
         return nil
-      end 
-      
+      end
+
       # Remove all raw data references
       def remove_all_raws!
         @raws = {}
       end
-      
+
       # Return all raw data references
-	    def raws
+      def raws
         @raws = {} unless defined? @raws
         @raws
-	    end
-		end
-	end
+      end
+    end
+  end
 end