spreadbase 0.1.2

data/lib/spreadbase/codecs/open_document_12_modules/encoding.rb

@@ -0,0 +1,200 @@
+# encoding: UTF-8
+
+=begin
+Copyright 2012 Saverio Miroddi saverio.pub2 <a-hat!> gmail.com
+
+This file is part of SpreadBase.
+
+SpreadBase is free software: you can redistribute it and/or modify it under the
+terms of the GNU Lesser General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+SpreadBase is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with SpreadBase.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'rexml/document'
+require 'date'
+require 'bigdecimal'
+require 'iconv' if RUBY_VERSION < '1.9'
+
+module SpreadBase # :nodoc:
+
+  module Codecs # :nodoc:
+
+    module OpenDocument12Modules # :nodoc:
+
+      # Module containing the encoding routines of the OpenDocument12 format.
+      #
+      module Encoding
+
+        # Actually a document can be opened even without the office:body element, but we simplify the code
+        # by assuming that at least this tree is present.
+        #
+        BASE_CONTENT_XML = %Q[\
+<?xml version='1.0' encoding='UTF-8'?>
+<office:document-content
+    xmlns:office='urn:oasis:names:tc:opendocument:xmlns:office:1.0'
+    xmlns:style='urn:oasis:names:tc:opendocument:xmlns:style:1.0'
+    xmlns:table='urn:oasis:names:tc:opendocument:xmlns:table:1.0'
+    xmlns:text='urn:oasis:names:tc:opendocument:xmlns:text:1.0'
+    xmlns:fo='urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0'
+    xmlns:number='urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0'
+    xmlns:of='urn:oasis:names:tc:opendocument:xmlns:of:1.2'
+    office:version='1.2'>
+<office:automatic-styles>
+  <number:date-style style:name='N37'>
+    <number:month number:style='long'/>
+    <number:text>/</number:text>
+    <number:day number:style='long'/>
+    <number:text>/</number:text>
+    <number:year/>
+  </number:date-style>
+  <number:date-style style:name='N5050'>
+    <number:month/>
+    <number:text>/</number:text>
+    <number:day/>
+    <number:text>/</number:text>
+    <number:year/>
+    <number:text> </number:text>
+    <number:hours number:style='long'/>
+    <number:text>:</number:text>
+    <number:minutes number:style='long'/>
+    <number:text> </number:text>
+    <number:am-pm/>
+  </number:date-style>
+  <style:style style:name='date' style:family='table-cell' style:data-style-name='N37'/>
+  <style:style style:name='datetime' style:family='table-cell' style:data-style-name='N5050'/>
+  <style:style style:name='boolean' style:family='table-cell' style:data-style-name='N99'/>
+</office:automatic-styles>
+<office:body>
+  <office:spreadsheet/>
+</office:body>
+</office:document-content>] # :nodoc:
+
+        private
+
+        # Returns the XML root node
+        #
+        def encode_to_document_node( el_document, options={} )
+          root_node        = REXML::Document.new( BASE_CONTENT_XML )
+          spreadsheet_node = root_node.elements[ '//office:document-content/office:body/office:spreadsheet' ]
+          styles_node      = root_node.elements[ '//office:document-content/office:automatic-styles'        ]
+
+          el_document.column_width_styles.each do | style_name, column_width |
+            encode_style( styles_node, style_name, column_width )
+          end
+
+          el_document.tables.each do | table |
+            encode_table( table, spreadsheet_node, options )
+          end
+
+          root_node
+        end
+
+        # Currently only encodes column width styles
+        #
+        def encode_style( styles_node, style_name, column_width )
+          style_node = styles_node.add_element( 'style:style', 'style:name' => style_name, 'style:family' => 'table-column' )
+
+          style_node.add_element( 'style:table-column-properties', 'style:column-width' => column_width )
+        end
+
+        def encode_table( table, spreadsheet_node, options={} )
+          table_node = spreadsheet_node.add_element( 'table:table' )
+
+          table_node.attributes[ 'table:name' ] = table.name
+
+          table.column_width_styles.each do | style_name |
+            encode_column( table_node, style_name ) if style_name
+          end
+
+          # At least one column element is required
+          #
+          table_node.add_element( 'table:table-column' ) if table.column_width_styles.size == 0
+
+          table.data.each do | row |
+            encode_row( row, table_node, options )
+          end
+        end
+
+        # Currently only encodes column width styles
+        #
+        def encode_column( table_node, style_name )
+          table_node.add_element( 'table:table-column', 'table:style-name' => style_name )
+        end
+
+        def encode_row( row, table_node, options={} )
+          row_node = table_node.add_element( 'table:table-row' )
+
+          row.each do | value |
+            encode_cell( value, row_node, options )
+          end
+        end
+
+        def encode_cell( value, row_node, options={} )
+          force_18_strings_encoding = options[ :force_18_strings_encoding ] || 'UTF-8'
+
+          cell_node = row_node.add_element( 'table:table-cell' )
+
+          # WATCH OUT!!! DateTime.new.is_a?( Date )!!!
+          #
+          case value
+          when String
+            cell_node.attributes[ 'office:value-type' ] = 'string'
+
+            cell_value_node = cell_node.add_element( 'text:p' )
+
+            if RUBY_VERSION >= '1.9'
+              value = value.encode( 'UTF-8' )
+            else
+              value = Iconv.conv( 'UTF-8', force_18_strings_encoding, value )
+            end
+
+            cell_value_node.text = value
+          when Time, DateTime
+            cell_node.attributes[ 'office:value-type' ] = 'date'
+            cell_node.attributes[ 'table:style-name'  ] = 'datetime'
+
+            encoded_value = value.strftime( '%Y-%m-%dT%H:%M:%S' )
+
+            cell_node.attributes[ 'office:date-value' ] = encoded_value
+          when Date
+            cell_node.attributes[ 'office:value-type' ] = 'date'
+            cell_node.attributes[ 'table:style-name'  ] = 'date'
+
+            encoded_value = value.strftime( '%Y-%m-%d' )
+
+            cell_node.attributes[ 'office:date-value' ] = encoded_value
+          when BigDecimal
+            cell_node.attributes[ 'office:value-type' ] = 'float'
+
+            cell_node.attributes[ 'office:value' ] = value.to_s( 'F' )
+          when Float, Fixnum
+            cell_node.attributes[ 'office:value-type' ] = 'float'
+
+            cell_node.attributes[ 'office:value' ] = value.to_s
+          when true, false
+            cell_node.attributes[ 'office:value-type' ] = 'boolean'
+            cell_node.attributes[ 'table:style-name'  ] = 'boolean'
+
+            cell_node.attributes[ 'office:boolean-value' ] = value.to_s
+          when nil
+            # do nothing
+          else
+            raise "Unrecognized value class: #{ value.class }"
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/spreadbase/document.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+
+=begin
+Copyright 2012 Saverio Miroddi saverio.pub2 <a-hat!> gmail.com
+
+This file is part of SpreadBase.
+
+SpreadBase is free software: you can redistribute it and/or modify it under the
+terms of the GNU Lesser General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+SpreadBase is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with SpreadBase.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module SpreadBase # :nodoc:
+
+  # Represents the abstraction of a document, merging both the file and the
+  # document metadata concepts.
+  #
+  class Document
+
+    attr_accessor :document_path
+
+    attr_accessor :tables
+
+    # Currently contains only the style includining column widths
+    # Format:
+    #
+    #   { '<name>' => '<width>' }
+    #
+    attr_accessor :column_width_styles # :nodoc:
+
+    # _params_:
+    #
+    # +document_path+::               (nil) Document path; if not passed, an empty document is created.
+    #
+    # _options_:
+    #
+    # +force_18_strings_encoding+::   ('UTF-8') on ruby 1.8, when converting to UTF-8, assume the strings are using the specified format.
+    # +floats_as_bigdecimal+::        (false) decode floats as BigDecimal instead of Float
+    #
+    def initialize( document_path=nil, options={} )
+      @document_path = document_path
+      @options       = options.clone
+
+      if @document_path && File.exists?( document_path )
+        document_archive = IO.read( document_path )
+        decoded_document = Codecs::OpenDocument12.new.decode_archive( document_archive, options )
+
+        @column_width_styles = decoded_document.column_width_styles
+        @tables              = decoded_document.tables
+      else
+        @column_width_styles = []
+        @tables              = []
+      end
+    end
+
+    # Saves the document to the disk; before saving, it's required:
+    # - to have at least one table
+    # - to have set the documenth path, either during the initialization, or using the #document_path accessor.
+    #
+    # _options_:
+    #
+    # +prettify+::                   Prettifies the content.xml file before saving.
+    #
+    def save( options={} )
+      options = @options.merge( options )
+
+      raise "At least one table must be present" if @tables.empty?
+      raise "Document path not specified"        if @document_path.nil?
+
+      document_archive = Codecs::OpenDocument12.new.encode_to_archive( self, options )
+
+      File.open( @document_path, 'wb' ) { | file | file << document_archive }
+    end
+
+    # _options_:
+    #
+    # +with_headers+::        Print the tables with headers.
+    #
+    def to_s( options={} )
+      options.merge!( :row_prefix => '  ' )
+
+      tables.inject( '' ) do | output, table |
+        output << "#{ table.name }:" << "\n" << "\n"
+
+        output << table.to_s( options ) << "\n"
+      end
+    end
+
+  end
+
+end

data/lib/spreadbase/helpers/helpers.rb

@@ -0,0 +1,138 @@
+# encoding: UTF-8
+
+=begin
+Copyright 2012 Saverio Miroddi saverio.pub2 <a-hat!> gmail.com
+
+This file is part of SpreadBase.
+
+SpreadBase is free software: you can redistribute it and/or modify it under the
+terms of the GNU Lesser General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+SpreadBase is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with SpreadBase.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module SpreadBase # :nodoc:
+
+  # Currently generic helper class
+  #
+  module Helpers
+
+    # Safe alternative to "[ instance ] * repeats", which returns an array filled with the same instance, which is a recipe for a disaster
+    #
+    # The instance is duplicated Object#clone, when necessary - note that this method is not meant to do a deep copy.
+    #
+    def make_array_from_repetitions( instance, repetitions )
+      ( 1 .. repetitions ).inject( [] ) do | cumulative_result, i |
+        case instance
+        when Fixnum, Float, BigDecimal, Date, Time, TrueClass, FalseClass, NilClass #, DateTime is a Date
+          cumulative_result << instance
+        when String, Array
+          cumulative_result << instance.clone
+        else
+          raise "Unsupported class: #{ }"
+        end
+      end
+    end
+
+    # Prints the 2d-array in a nice, fixed-space table
+    #
+    # _params_:
+    #
+    # +rows+::                  2d-array of values.
+    #                           Empty arrays generate empty strings.
+    #                           Entries can be of different sizes; nils are used as filling values to normalize the rows to the same length.
+    #
+    # _options_:
+    #
+    # +row_prefix+::            Prefix this string to each row.
+    # +with_header+::           First row will be separated from the remaining ones.
+    #
+    # +formatting_block+::      If passed, values will be formatted by the block.
+    #                           If no block is passed, or it returns nil or :standard, the standard formatting is used.
+    #
+    def pretty_print_rows( rows, options={}, &formatting_block )
+      row_prefix   = options[ :row_prefix   ] || ''
+      with_headers = options[ :with_headers ]
+
+      output = ""
+
+      formatting_block = lambda { | value | value.to_s } if ! block_given?
+
+      if rows.size > 0
+        max_column_sizes = [ 0 ] * rows.map( &:size ).max
+
+        # Compute maximum widths
+
+        rows.each do | values |
+          values.each_with_index do | value, i |
+            formatted_value       = pretty_print_value( value, &formatting_block )
+            formatted_value_width = formatted_value.chars.to_a.size
+
+            max_column_sizes[ i ] = formatted_value_width if formatted_value_width > max_column_sizes[ i ]
+          end
+        end
+
+        # Print!
+
+        output << row_prefix << '+-' + max_column_sizes.map { | size | '-' * size }.join( '-+-' ) + '-+' << "\n"
+
+        print_pattern = '| ' + max_column_sizes.map { | size | "%-#{ size }s" }.join( ' | ' ) + ' |'
+
+        rows.each_with_index do | row, row_index |
+          # Ensure that we always have a number of values equal to the max width
+          #
+          formatted_row_values = ( 0 ... max_column_sizes.size ).map do | column_index |
+            value = row[ column_index ]
+
+            pretty_print_value( value, &formatting_block )
+          end
+
+          output << row_prefix << print_pattern % formatted_row_values << "\n"
+
+          if with_headers && row_index == 0
+            output << row_prefix << '+-' + max_column_sizes.map { | size | '-' * size }.join( '-+-' ) + '-+' << "\n"
+          end
+        end
+
+        output << row_prefix << '+-' + max_column_sizes.map { | size | '-' * size }.join( '-+-' ) + '-+' << "\n"
+      end
+
+      output
+    end
+
+    private
+
+    def pretty_print_value( value, &formatting_block )
+      custom_result = block_given? && yield( value )
+
+      if custom_result && custom_result != :standard
+        custom_result
+      else
+        case value
+        when BigDecimal
+          value.to_s( 'F' )
+        when Time, DateTime
+          # Time#to_s renders differently between 1.8.7 and 1.9.3; 1.8.7's rendering is bizarrely
+          # inconsistent with the Date and DateTime ones.
+          #
+          value.strftime( '%Y-%m-%d %H:%M:%S %z' )
+        when String, Date, Numeric, TrueClass, FalseClass
+          value.to_s
+        when nil
+          "NIL"
+        else
+          value.inspect
+        end
+      end
+    end
+
+  end
+
+end