spreadbase 0.1.2

data/spec/elements/table_spec.rb

@@ -0,0 +1,267 @@
+ # 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 File.expand_path( '../../../lib/spreadbase', __FILE__ )
+require File.expand_path( '../../spec_helpers',      __FILE__ )
+
+include SpecHelpers
+
+describe SpreadBase::Table do
+
+  before :each do
+    @sample_table = SpreadBase::Table.new(
+      'abc', [
+        [ 1,      1.1,        T_BIGDECIMAL ],
+        [ T_DATE, T_DATETIME, T_TIME       ],
+        [ true,   'a',        nil          ]
+      ]
+    )
+  end
+
+  # The full test for checking the row index is here; all the other tests assume that
+  # this routine is called, by checking against the index (-1).
+  #
+  it "should check the row index" do
+    lambda { @sample_table.row( 4 ) }.should raise_error( RuntimeError, "Invalid row index (4) - allowed 0 to 2" )
+
+    # called with :allow_append
+    lambda { @sample_table.insert_row( -1, [] ) }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 3" )
+    lambda { @sample_table.insert_row( 40, [] ) }.should raise_error( RuntimeError, "Invalid row index (40) - allowed 0 to 3" )
+  end
+
+  it "should initialize with data" do
+    expected_data = [
+      [ 1,      1.1,        T_BIGDECIMAL ],
+      [ T_DATE, T_DATETIME, T_TIME       ],
+      [ true,   'a',        nil          ]
+    ]
+
+    @sample_table.data.should == expected_data
+  end
+
+  it "should raise an error when the initialization requirements are not met" do
+    lambda { SpreadBase::Table.new( nil ) }.should raise_error( "Table name required" )
+    lambda { SpreadBase::Table.new( ''  ) }.should raise_error( "Table name required" )
+
+    # This is acceptable
+    #
+    SpreadBase::Table.new( ' ' )
+  end
+
+  it "should access a cell" do
+    @sample_table[ 'a', 0 ].should == 1
+    @sample_table[ 1,   0 ].should == 1.1
+    @sample_table[ 2,   0 ].should == T_BIGDECIMAL
+    @sample_table[ 0,   1 ].should == T_DATE
+    @sample_table[ 'B', 1 ].should == T_DATETIME
+    @sample_table[ 2,   1 ].should == T_TIME
+    @sample_table[ 0,   2 ].should == true
+    @sample_table[ 1,   2 ].should == 'a'
+    @sample_table[ 2,   2 ].should == nil
+
+    lambda { @sample_table[ -1, 0 ] }.should raise_error( RuntimeError, "Negative column indexes not allowed: -1" )
+    lambda { @sample_table[ 0, -1 ] }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 2" )
+    lambda { @sample_table[ 3, 0  ] }.should raise_error( RuntimeError, "Invalid column index (3) for the given row - allowed 0 to 2" )
+  end
+
+  it "should set a cell value" do
+    @sample_table[ 0,   0 ] = 10
+    @sample_table[ 'B', 1 ] = T_TIME
+
+    @sample_table.data.should == [
+      [ 10,     1.1,        T_BIGDECIMAL ],
+      [ T_DATE, T_TIME,     T_TIME       ],
+      [ true,   'a',        nil          ],
+    ]
+
+    lambda { @sample_table[ 0, -1 ] = 33 }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 2" )
+    lambda { @sample_table[ 3, 0  ] = 44 }.should raise_error( RuntimeError, "Invalid column index (3) for the given row - allowed 0 to 2" )
+  end
+
+  it "should access a row" do
+    @sample_table.row( 0 ).should == [ 1,      1.1,        T_BIGDECIMAL ]
+    @sample_table.row( 1 ).should == [ T_DATE, T_DATETIME, T_TIME       ]
+
+    lambda { @sample_table.row( -1 ) }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 2" )
+  end
+
+  it "should delete a row" do
+    @sample_table.delete_row( 1 ).should == [ T_DATE, T_DATETIME, T_TIME ]
+
+    @sample_table.data.should == [
+      [ 1,      1.1,        T_BIGDECIMAL ],
+      [ true,   'a',        nil          ],
+    ]
+
+    lambda { @sample_table.delete_row( -1 ) }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 1" )
+  end
+
+  it "should insert a row" do
+    @sample_table.insert_row( 1, [ 4, 5, 6 ] )
+
+    @sample_table.data.should == [
+      [ 1,      1.1,        T_BIGDECIMAL ],
+      [ 4,      5,          6            ],
+      [ T_DATE, T_DATETIME, T_TIME       ],
+      [ true,   'a',        nil          ],
+    ]
+
+    # illegal row index tested in separate UT
+  end
+
+  it "should insert a row without error if there is no data" do
+    @sample_table.data = []
+
+    @sample_table.insert_row( 0, [ 4, 5 ] )
+
+    @sample_table.data.size.should == 1
+  end
+
+  it "should append a row" do
+    @sample_table.append_row( [ 4, 5, 6 ] )
+
+    @sample_table.data.should == [
+      [ 1,      1.1,        T_BIGDECIMAL ],
+      [ T_DATE, T_DATETIME, T_TIME       ],
+      [ true,   'a',        nil          ],
+      [ 4,      5,          6            ],
+    ]
+  end
+
+  it "should access a column" do
+    @sample_table.column( 0 ).should == [ 1,   T_DATE,     true ]
+    @sample_table.column( 1 ).should == [ 1.1, T_DATETIME, 'a'  ]
+
+    @sample_table.column( 3 ).should == [ nil, nil, nil ]
+  end
+
+  it "should delete a column" do
+    @sample_table.column_width_styles = [ 'abc', nil, 'cde' ]
+
+    @sample_table.delete_column( 0 ).should == [ 1, T_DATE, true ]
+
+    @sample_table.column_width_styles.should == [ nil, 'cde' ]
+
+    @sample_table.delete_column( 3 ).should == [ nil, nil, nil ]
+
+    @sample_table.column_width_styles.should == [ nil, 'cde' ]
+
+    @sample_table.data.should == [
+      [ 1.1,        T_BIGDECIMAL ],
+      [ T_DATETIME, T_TIME       ],
+      [ 'a',        nil          ]
+    ]
+  end
+
+  it "should insert a column" do
+    # Setup/fill table
+
+    @sample_table.column_width_styles = [ 'abc', nil, 'cde' ]
+
+    @sample_table.insert_column( 1, [ 34, 'abc', nil ] )
+
+    @sample_table.data.should == [
+      [ 1,      34,    1.1,        T_BIGDECIMAL ],
+      [ T_DATE, 'abc', T_DATETIME, T_TIME       ],
+      [ true,   nil,   'a',        nil          ],
+    ]
+
+    @sample_table.column_width_styles = [ 'abc', nil, nil, 'cde' ]
+
+    # Empty table
+
+    table = SpreadBase::Table.new( 'abc' )
+
+    table.insert_column( 0, [ 34, 'abc', 1 ] )
+
+    table.data.should == [
+      [ 34,   ],
+      [ 'abc' ],
+      [ 1     ],
+    ]
+
+    @sample_table.column_width_styles = [ nil ]
+  end
+
+  it "should not insert a column if the size is not correct" do
+    lambda { @sample_table.insert_column( 1, [ 34, 'abc' ] ) }.should raise_error( RuntimeError, "Inserting column size (2) different than existing columns size (3)" )
+
+    @sample_table.data.first.size.should == 3
+  end
+
+  it "should insert a column outside the row boundaries" do
+    @sample_table.insert_column( 5, [ 34, 'abc', nil ] )
+
+    @sample_table.data.should == [
+      [ 1,      1.1,        T_BIGDECIMAL, nil, nil, 34    ],
+      [ T_DATE, T_DATETIME, T_TIME,       nil, nil, 'abc' ],
+      [ true,   'a',        nil,          nil, nil, nil   ],
+    ]
+  end
+
+  it "should append a column" do
+    table = SpreadBase::Table.new( 'abc' )
+
+    table.append_column( [ 34, 'abc', 1 ] )
+
+    table.data.should == [
+      [ 34,   ],
+      [ 'abc' ],
+      [ 1     ],
+    ]
+
+    table.append_column( [ 'cute', 'little', 'spielerin' ] )
+
+    table.data.should == [
+      [ 34,    'cute'      ],
+      [ 'abc', 'little'    ],
+      [ 1,     'spielerin' ],
+    ]
+  end
+
+  it "return the data as string (:to_s)" do
+    expected_string = "\
++------------+---------------------------+---------------------------+
+| 1          | 1.1                       | 0.133E1                   |
+| 2012-04-10 | 2012-04-11T23:33:42+00:00 | 2012-04-11 23:33:42 +0200 |
+| true       | a                         |                           |
++------------+---------------------------+---------------------------+
+"
+    @sample_table.to_s.should == expected_string
+  end
+
+  it "return the data as string, with headers (:to_s)" do
+    expected_string = "\
++------------+---------------------------+---------------------------+
+| 1          | 1.1                       | 0.133E1                   |
++------------+---------------------------+---------------------------+
+| 2012-04-10 | 2012-04-11T23:33:42+00:00 | 2012-04-11 23:33:42 +0200 |
+| true       | a                         |                           |
++------------+---------------------------+---------------------------+
+"
+
+    @sample_table.to_s( :with_headers => true ).should == expected_string
+
+    @sample_table.data = []
+
+    @sample_table.to_s( :with_headers => true ).should == ""
+  end
+
+end

data/spec/spec_helpers.rb

@@ -0,0 +1,47 @@
+# 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 'date'
+require 'bigdecimal'
+
+module SpecHelpers
+
+  T_DATE       = Date.new( 2012, 4, 10 )
+  T_DATETIME   = DateTime.new( 2012, 4, 11, 23, 33, 42 )
+  T_TIME       = Time.local( 2012, 4, 11, 23, 33, 42 )
+  T_BIGDECIMAL = BigDecimal.new( '1.33' )
+
+  # This method is cool beyond any argument about the imperfect name.
+  #
+  def assert_size( collection, expected_size )
+    collection.size.should == expected_size
+
+    yield( *collection ) if block_given?
+  end
+
+  def stub_initializer( klazz, *args )
+    instance = klazz.new( *args )
+
+    klazz.stub!( :new ).and_return( instance )
+
+    instance
+  end
+
+end

data/spreadbase.gemspec

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+$:.push( File.expand_path( "../lib", __FILE__ ) )
+
+require "spreadbase/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spreadbase"
+  s.version     = SpreadBase::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ "Saverio Miroddi" ]
+  s.email       = [ "saverio.pub2@gmail.com" ]
+  s.homepage    = ""
+  s.summary     = %q{Library for reading/writing OpenOffice Calc documents.}
+  s.description = %q{Library for reading/writing OpenOffice Calc documents.}
+
+  s.add_runtime_dependency     "zipruby", "~>0.3.6"
+  s.add_development_dependency "rspec",   "~>2.9.0"
+
+  s.files         = `git ls-files`.split( "\n" )
+  s.test_files    = `git ls-files -- {spec,temp,utils}/*`.split( "\n" )
+  s.executables   = []
+  s.require_paths = [ "lib" ]
+end

data/utils/convert_sqlite_to_ods.rb

@@ -0,0 +1,154 @@
+#!/usr/bin/env ruby
+# 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 'rubygems'
+require 'sqlite3'
+require 'spreadbase'
+
+def decode_cmdline_params
+  if [ '-h', '--help' ].include?( ARGV[ 0 ] ) || ARGV.size == 0 || ARGV.size > 1
+    puts "Usage: convert_sqlite_to_ods.rb <filename>"
+
+    exit
+  else
+    ARGV[ 0 ]
+  end
+end
+
+def generate_destination_filename( source_filename )
+  "#{ source_filename }.ods"
+end
+
+def with_database( filename, &block )
+  @db = SQLite3::Database.new( filename )
+  @db.type_translation = true
+  @db.extend( SQLite3::Pragmas )
+
+  yield
+ensure
+  @db.close if @db
+end
+
+def with_spreadsheet( filename )
+  @spreadsheet = SpreadBase::Document.new( filename )
+
+  yield
+ensure
+  @spreadsheet.save if @spreadsheet
+end
+
+def find_tables
+  sql = "
+    SELECT name
+    FROM sqlite_master
+    WHERE type = 'table'
+  "
+
+  @db.execute( sql ).map( &:first ) - [ 'sqlite_sequence' ]
+end
+
+# Sample:
+#
+#     {
+#       "cid"        => 3,
+#       "name"       => "title_en",
+#       "type"       => "TEXT",
+#       "notnull"    => 0,
+#       "dflt_value" => nil,
+#       "pk"         => 0
+#     },
+#
+def find_table_columns( table )
+  raw_data = @db.table_info( table )
+
+  raw_data.map { | column_data | column_data[ 'name' ] }
+end
+
+def create_destination_table( table_name, columns )
+  table = SpreadBase::Table.new( table_name )
+
+  @spreadsheet.tables << table
+
+  table
+end
+
+def select_all_rows( table )
+  sql = "SELECT * FROM #{ table }"
+
+  @db.execute( sql )
+end
+
+def insert_row_into_destination( destination_table, row )
+  # row = row.map do | value |
+  #   if value.is_a?( String )
+  #     begin
+  #       value.encode( 'UTF-8' )
+
+  #       value
+  #     rescue
+  #       puts "#{ value.inspect } => #{ $! }"
+
+  #       value.force_encoding( 'UTF-8' )
+  #     end
+  #   else
+  #     value
+  #   end
+  # end
+
+  # holy crap it's really easy to work with SB. kudos to myself.
+  #
+  destination_table.append_row( row )
+end
+
+# +options+:
+# +insert_headers+::          (true) insert the column names as headers
+#
+def convert_sqlite_to_ods( source_filename, options={} )
+  insert_headers = ! options.has_key?( :insert_headers ) || options[ :insert_headers ]
+
+  destination_filename = generate_destination_filename( source_filename )
+
+  with_database( source_filename ) do
+    with_spreadsheet( destination_filename ) do
+      tables = find_tables
+
+      tables.each do | table |
+        columns = find_table_columns( table )
+
+        destination_table = create_destination_table( table, columns )
+
+        insert_row_into_destination( destination_table, columns ) if insert_headers
+
+        value_rows = select_all_rows( table )
+
+        value_rows.each do | row |
+          insert_row_into_destination( destination_table, row )
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  filename = decode_cmdline_params
+
+  convert_sqlite_to_ods( filename )
+end

data/utils/prettify_file.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# 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'
+
+def pretty_print( file_path, output=$stdout )
+  xml_str = IO.read( file_path )
+
+  root = REXML::Document.new( xml_str )
+
+  xml_formatter = REXML::Formatters::Pretty.new
+  xml_formatter.compact = true
+  xml_formatter.write( root, output )
+
+  nil
+end
+
+def prettify_file( file_path )
+  File.open( file_path, 'r+' ) do | file |
+    pretty_print( file_path, file )
+  end
+end
+
+if __FILE__ == $0
+  file_path = ARGV[ 0 ] || raise( "Usage: prettify_file.rb <file>" )
+
+  prettify_file( file_path )
+end

data/utils/test_ods_folder.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# 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 File.expand_path( '../utils_helpers', __FILE__ )
+
+include UtilsHelpers
+
+def test_ods_folder( folder_path )
+  with_tempfile do | temp_file |
+    relative_compress_to_zip( folder_path, :zip_filename => temp_file.path )
+
+    `openoffice.org3 #{ temp_file.path }`
+  end
+end
+
+# Not sure if 'folder' is an accepted name in the linux world.
+#
+if __FILE__ == $0
+  folder_path = ARGV[ 0 ] || raise( "Usage: test_ods_folder.rb <folder>" )
+
+  test_ods_folder( folder_path )
+end

data/utils/test_recoding_file.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# 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 File.expand_path( '../../lib/spreadbase', __FILE__ )
+
+def test_recoding_file( file_path )
+  destination_file_path = file_path.sub( /\.ods$/, '.2.ods' )
+
+  document = SpreadBase::Document.new( file_path )
+  document.document_path = destination_file_path
+  document.save( :prettify => true )
+
+  `openoffice.org3 #{ destination_file_path }`
+end
+
+if __FILE__ == $0
+  file_path = ARGV[ 0 ] || raise( "Usage: test_recoding_file.rb <file>" )
+
+  test_recoding_file( file_path )
+end

data/utils/test_recoding_from_content.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# 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 File.expand_path( '../../lib/spreadbase', __FILE__ )
+require File.expand_path( '../utils_helpers',     __FILE__ )
+
+include UtilsHelpers
+
+def test_recoding_from_content( file_path )
+  content_xml_data = IO.read( file_path )
+  document         = SpreadBase::Codecs::OpenDocument12.new.decode_content_xml( content_xml_data )
+
+  with_tempfile do | temp_file |
+    document.document_path = temp_file.path
+    document.save( :prettify => true )
+
+    `openoffice.org3 #{ temp_file.path }`
+  end
+end
+
+if __FILE__ == $0
+  file_path = ARGV[ 0 ] || raise( "Usage: test_recoding_from_content.rb <file>" )
+
+  test_recoding_from_content( file_path )
+end