yalab-ruby-ods 0.0.0

data/README.txt

@@ -0,0 +1,49 @@
+= README
+
+release::	0.0.0
+copyright::	copyright(c) 2006-2009 ya-lab.org all rights reserved.
+
+
+== About yalab-ruby-ods
+
+This library is read and write OpenOffice Document SpreadSheet(ods) file.
+This version only use string of cell format.
+
+
+== Installation
+
+    $ sudo gem install yalab-ruby-ods -s http://gemcutter.org
+
+== Usage
+
+    require 'rubygems'
+    require 'ods'
+
+    ods = Ods.new('some_document.ods')
+
+    sheet = ods.sheets[0]
+    sheet[3, :A].text #=> get A3 cell value
+    sheet[4, :B].text = 'foobar'
+    sheet[4, :B].text #=> foobar
+
+    values = []
+    sheet.rows.each do |row|
+      row.each{|cell|
+        values.push cell.text
+      }
+    end
+
+    new_sheet = ods.create_sheet
+    new_sheet[1, :A].annotation = 'hint'
+    new_sheet[1, :A].text = 'baz'
+
+    ods.save
+
+== License
+
+MIT License
+
+
+== Author
+
+yalab <rudeboyjet@gmail.com>

data/Rakefile

@@ -0,0 +1,12 @@
+require 'jeweler'
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "yalab-ruby-ods"
+  gemspec.summary = "This is using OpenOffice SpreadSheet document file via ruby"
+  gemspec.email = "rudeboyjet@gmail.com"
+  gemspec.homepage = "http://github.com/yalab/ruby-ods"
+  gemspec.description = ""
+  gemspec.authors = ["yalab"]
+  gemspec.add_dependency "nokogiri", ">= 1.4.0"
+  gemspec.add_dependency "rubyzip", ">= 0.9.1"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/nokogiri_ext.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+Nokogiri::XML::Element.module_eval do
+  def add_element(name, attributes={})
+    (prefix, name) = name.split(':') if name.include?(':')
+    node = Nokogiri::XML::Node.new(name, self)
+    attributes.each do |attr, val|
+      node.set_attribute(attr, val)
+    end
+    ns = node.add_namespace_definition(prefix, Ods::NAMESPACES[prefix])
+    node.namespace = ns
+    self.add_child(node)
+    node
+  end
+
+  def fetch(xpath)
+    if node = self.xpath(xpath).first
+      return node
+    end
+
+    return self.add_element(xpath) unless xpath.include?('/')
+
+    xpath = xpath.split('/')
+    last_path = xpath.pop
+    fetch(xpath.join('/')).fetch(last_path)
+  end
+end

data/lib/ods.rb

@@ -0,0 +1,208 @@
+# -*- coding: utf-8 -*-
+require 'forwardable'
+require 'rubygems'
+require 'nokogiri'
+require 'nokogiri_ext'
+require 'zip/zip'
+require 'fileutils'
+
+class Ods
+  attr_reader :content, :sheets
+  XPATH_SHEETS = '//office:body/office:spreadsheet/table:table'
+
+  NAMESPACES = {
+    'office' => 'urn:oasis:names:tc:opendocument:xmlns:office:1.0',
+    'style'  => 'urn:oasis:names:tc:opendocument:xmlns:style:1.0',
+    'text'   => 'urn:oasis:names:tc:opendocument:xmlns:text:1.0',
+    'table'  => 'urn:oasis:names:tc:opendocument:xmlns:table:1.0',
+    'draw'   => 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
+    'fo'     => 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
+    'xlink'  => 'http://www.w3.org/1999/xlink',
+    'dc'     => 'http://purl.org/dc/elements/1.1/',
+    'meta'   => 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
+    'number' => 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0',
+    'presentation' => 'urn:oasis:names:tc:opendocument:xmlns:presentation:1.0',
+    'svg'    => 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0',
+    'chart'  => 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
+    'dr3d'   => 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
+    'math'   => 'http://www.w3.org/1998/Math/MathML',
+    'form'   => 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
+    'script' => 'urn:oasis:names:tc:opendocument:xmlns:script:1.0',
+    'ooo'    => 'http://openoffice.org/2004/office',
+    'ooow'   => 'http://openoffice.org/2004/writer',
+    'oooc'   => 'http://openoffice.org/2004/calc',
+    'dom'    => 'http://www.w3.org/2001/xml-events',
+    'xforms' => 'http://www.w3.org/2002/xforms',
+    'xsd'    => 'http://www.w3.org/2001/XMLSchema',
+    'xsi'    => 'http://www.w3.org/2001/XMLSchema-instance',
+    'rpt'    => 'http://openoffice.org/2005/report',
+    'of'     => 'urn:oasis:names:tc:opendocument:xmlns:of:1.2',
+    'rdfa'   => 'http://docs.oasis-open.org/opendocument/meta/rdfa#',
+    'field'  => 'urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0',
+    'formx'  => 'urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0'
+  }
+
+  def initialize(path)
+    @path = path
+    Zip::ZipFile.open(@path) do |zip|
+      @content = Nokogiri::XML::Document.parse(zip.read('content.xml'))
+    end
+    @sheets = []
+    @content.root.xpath(XPATH_SHEETS).each do |sheet|
+      @sheets.push(Sheet.new(sheet))
+    end
+    @content
+  end
+
+  def save(dest=nil)
+    if dest
+      FileUtils.cp(@path, dest)
+    else
+      dest = @path
+    end
+
+    @sheets.each do |sheet|
+      column = sheet.column
+      max_length = 0
+      column.content.parent.xpath('table:table-row').each do |row|
+        length = row.xpath('table:table-cell').length
+        max_length = length if max_length < length
+      end
+      column.set_attr('repeated', max_length)
+    end
+
+    Zip::ZipFile.open(dest) do |zip|
+      zip.get_output_stream('content.xml') do |io|
+        io << @content.to_s
+      end
+    end
+  end
+
+  def create_sheet
+    parent = @content.root.xpath(XPATH_SHEETS.split('/')[0..-2].join('/'))[0]
+    table = parent.add_element('table:table',
+                               'name'       => "Sheet#{@sheets.length + 1}",
+                               'style-name' => 'ta1',
+                               'print'      => 'false')
+    table.add_element('table:table-column',
+                      'style-name'              => 'co1',
+                      'default-cell-style-name' => 'Default')
+    new_sheet = Sheet.new(table)
+    @sheets.push(new_sheet)
+    new_sheet
+  end
+
+  class Sheet
+    attr_reader :content
+    def initialize(content)
+      @content = content
+    end
+
+    def name
+      @content.attribute('name').to_s
+    end
+
+    def name=(name)
+      @content.set_attribute('table:name', name)
+    end
+
+    def [](row, col)
+      (row - rows.length).times do
+        rows.push(Row.new(@content.add_element('table:table-row',
+                                               'table:style-name' => 'ro1'), rows.length+1))
+      end
+      row = rows[row-1]
+      col = ('A'..col.to_s).to_a.index(col.to_s)
+      cols = row.cols
+      (col - cols.length + 1).times do
+        no = (cols.last) ? cols.last.no.to_s.succ : 'A'
+        cols.push(Cell.new(row.add_element('table:table-cell', 'office:value-type' => 'string'), no))
+      end
+      cols[col]
+    end
+
+    def rows
+      return @rows if @rows
+      @rows = []
+      @content.xpath('./table:table-row').each_with_index{|row, index|
+        @rows << Row.new(row, index+1)
+      }
+      @rows
+    end
+
+    def column
+      Column.new(@content.xpath('table:table-column').first)
+    end
+  end
+
+  class Row
+    extend Forwardable
+
+    def_delegator :@content, :xpath, :xpath
+    def_delegator :@content, :add_element, :add_element
+    attr_reader :no
+
+    def initialize(content, no)
+      @content = content
+      @no = no
+    end
+
+    def cols
+      return @cols if @cols
+      @cols = []
+      no = 'A'
+      xpath('table:table-cell').each{|cell|
+        @cols << Cell.new(cell, no)
+        no.succ!
+      }
+      @cols
+    end
+
+    def create_cell
+
+    end
+  end
+
+  class Cell
+    extend Forwardable
+
+    def_delegator :@content, :fetch, :fetch
+    attr_reader :no
+
+    def initialize(content, no)
+      @content = content
+      @no = no.to_sym
+    end
+
+    def value
+      fetch('text:p').content
+    end
+
+    def value=(value)
+      fetch('text:p').content = value
+    end
+
+    def annotation
+      fetch('office:annotation/text:p').content
+    end
+
+    def annotation=(value)
+      fetch('office:annotation/text:p').content = value
+    end
+  end
+
+  class Column
+    attr_reader :content
+    def initialize(content)
+      @content = content
+    end
+
+    def attr(name)
+      @content['number-columns-' + name]
+    end
+
+    def set_attr(name, value)
+      @content['table:number-columns-' + name] = value.to_s
+    end
+  end
+end

data/test/ods_test.rb

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/ods'
+
+class OdsTest < Test::Unit::TestCase
+  BASE_DIR = File.dirname(File.expand_path(__FILE__))
+  def setup
+    @ods = Ods.new(BASE_DIR + '/cook.ods')
+    @file_path = BASE_DIR + '/modified.ods'
+  end
+
+  def teardown
+    File.unlink(@file_path) if File.exists?(@file_path)
+  end
+
+  def test_sheet_count
+    assert_equal 3, @ods.sheets.length
+  end
+
+  def test_sheet_name
+    assert_equal 'さつま揚げとキャベツのお味噌汁', @ods.sheets[0].name
+  end
+
+  def test_sheet_name_modify
+    modified_name = 'hogehoge'
+    offset = 2
+
+    assert_not_equal modified_name, @ods.sheets[offset].name
+    @ods.sheets[offset].name = modified_name
+    @ods.save(@file_path)
+    modified_ods = Ods.new(@file_path)
+    assert_equal modified_name, modified_ods.sheets[offset].name
+  end
+
+  def test_get_column
+    sheet = @ods.sheets[0]
+    assert_equal 'だし汁', sheet[2, :A].value
+    assert_equal '適量', sheet[6, :B].value
+  end
+
+  def test_modify_column
+    sheet_offset = 0
+    row = 2
+    col = :B
+    sheet = @ods.sheets[sheet_offset]
+    modified_text = '酢味噌'
+    assert_not_equal modified_text, sheet[row, col].value
+    sheet[row, col].value = modified_text
+    @ods.save(@file_path)
+    modified_ods = Ods.new(@file_path)
+    assert_equal modified_text, modified_ods.sheets[sheet_offset][row, col].value
+  end
+
+  def test_access_not_existed_sheet
+    ods_length = @ods.sheets.length
+    new_sheet = @ods.create_sheet
+    assert_equal "Sheet#{ods_length+1}", new_sheet.name
+    assert_equal '', new_sheet[1, :A].value
+    (col, row) = [100, :CC]
+    assert_nothing_raised { new_sheet[col, row].value = 'hoge' }
+    assert_equal 'hoge', new_sheet[col, row].value
+  end
+
+  def test_read_annotation
+    cell = @ods.sheets[0][2, :A]
+    assert_equal '昆布だし', cell.annotation
+  end
+
+  def test_write_annotation
+    sheet_offset = 0
+    row = 3
+    col = :A
+    cell = @ods.sheets[sheet_offset][row, col]
+    assert_equal '', cell.annotation
+    text = 'foobar'
+    cell.annotation = text
+    assert_equal text, @ods.sheets[sheet_offset][row, col].annotation
+  end
+
+  def test_columns_repeated
+    sheet = @ods.create_sheet
+    row = 10
+    col = :C
+    sheet[row, col].value = 'hoge'
+    @ods.save(@file_path)
+
+    modified_ods = Ods.new(@file_path)
+    sheet = modified_ods.sheets[modified_ods.sheets.length-1]
+    assert_equal "3", sheet.column.attr('repeated')
+  end
+
+  def test_each_rows_and_cols
+    sheet = @ods.create_sheet
+    row_offset = 10
+    col_offset = :C
+    sheet[row_offset, col_offset].value = 'foo'
+    count = 0
+    sheet.rows.each do |row|
+      count += 1
+    end
+    assert_instance_of Ods::Row, sheet.rows[0]
+    assert_equal row_offset, count
+
+    count = 0
+    sheet.rows[row_offset-1].cols.each do |col|
+      count += 1
+    end
+    assert_instance_of Ods::Cell, sheet.rows[row_offset-1].cols[0]
+    assert_equal ('A'..col_offset.to_s).to_a.length, count
+  end
+
+  def test_row_no
+    sheet = @ods.sheets[0]
+    count = 0
+    sheet.rows.each_with_index do |row, index|
+      assert_equal index + 1, row.no
+      count += 1
+    end
+
+    sheet[count+1, :A].value = 'hoge'
+    assert_equal count+1, sheet.rows.last.no
+  end
+
+  def test_cell_no
+    sheet = @ods.create_sheet
+    sheet[1, :A].value = 'hoge'
+    sheet[2, :B].value = 'foo'
+    assert_equal :A, sheet.rows.first.cols.first.no
+    assert_equal :A, sheet.rows.first.cols.last.no
+    assert_equal :B, sheet.rows.last.cols.last.no
+  end
+end

data/yalab-ruby-ods.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yalab-ruby-ods}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["yalab"]
+  s.date = %q{2009-11-27}
+  s.description = %q{}
+  s.email = %q{rudeboyjet@gmail.com}
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    "README.txt",
+     "Rakefile",
+     "VERSION",
+     "lib/nokogiri_ext.rb",
+     "lib/ods.rb",
+     "test/cook.ods",
+     "test/ods_test.rb",
+     "yalab-ruby-ods.gemspec"
+  ]
+  s.homepage = %q{http://github.com/yalab/ruby-ods}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{This is using OpenOffice SpreadSheet document file via ruby}
+  s.test_files = [
+    "test/ods_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.0"])
+      s.add_runtime_dependency(%q<rubyzip>, [">= 0.9.1"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.4.0"])
+      s.add_dependency(%q<rubyzip>, [">= 0.9.1"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.4.0"])
+    s.add_dependency(%q<rubyzip>, [">= 0.9.1"])
+  end
+end
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: yalab-ruby-ods
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- yalab
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-27 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+description: ""
+email: rudeboyjet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- README.txt
+- Rakefile
+- VERSION
+- lib/nokogiri_ext.rb
+- lib/ods.rb
+- test/cook.ods
+- test/ods_test.rb
+- yalab-ruby-ods.gemspec
+has_rdoc: true
+homepage: http://github.com/yalab/ruby-ods
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This is using OpenOffice SpreadSheet document file via ruby
+test_files: 
+- test/ods_test.rb