rspreadsheet 0.0.1 → 0.0.2

data/lib/rspreadsheet/cell.rb

@@ -0,0 +1,47 @@
+require 'andand'
+
+module Rspreadsheet
+class Cell
+  attr_reader :value,:col,:row, :source_node
+  def initialize(arow,acol,source_node=nil)
+    @col = acol
+    @row = arow
+    @source_node = source_node
+    unless @source_node.nil?
+      @type = @source_node.attributes['value-type'].to_s
+      if (@source_node.children.size == 0) and (not @source_node.attributes?)
+        @value = nil
+      else
+        # here you also ned to read style not only value
+        @value = case @type
+          when 'float'
+            @source_node.attributes['value'].to_f
+          when 'string'
+            @source_node.elements.first.andand.content.to_s
+          when 'date'
+            Date.strptime(@source_node.attributes['date-value'].to_s, '%Y-%m-%d')
+          when 'percentage'  
+            @source_node.attributes['value'].to_f
+          else
+            if @source_node.children.size == 0
+              nil
+            else
+              nil
+#               raise "Unknown type from #{@source_node.to_s} / children size=#{@source_node.children.size.to_s} / type=#{@type}"
+            end
+        end
+      end
+    end
+  end
+  def to_s
+    value
+  end
+  def value=(avalue)
+    @value=avalue
+    self
+  end
+  def coordinates
+    [row,col]
+  end
+end
+end

data/lib/rspreadsheet/row.rb

@@ -0,0 +1,30 @@
+require('rspreadsheet/cell')
+
+# Currently this is only syntax sugar for cells and contains no functionality
+
+module Rspreadsheet
+
+class Row
+  def initialize(workbook,rowi)
+    @rowi = rowi
+    @workbook = workbook
+    @rowcells = RowCells.new(workbook,rowi)
+  end
+  def cells
+    @rowcells
+  end
+end
+
+# this allows the row.cells[c] syntax
+# this object is result of row.cells
+class RowCells
+  def initialize(workbook,rowi)
+    @rowi = rowi
+    @workbook = workbook
+  end
+  def [] coli
+    @workbook.cells[@rowi,coli]
+  end
+end
+
+end

data/lib/rspreadsheet/version.rb

@@ -1,3 +1,3 @@
 module Rspreadsheet
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rspreadsheet/workbook.rb

@@ -0,0 +1,55 @@
+require 'zip'
+require 'libxml'
+
+module Rspreadsheet
+class Workbook
+  attr_reader :worksheets, :filename
+  def initialize(afilename=nil)
+    @worksheets={}
+    @filename = afilename
+    if filename.nil?
+    else
+      @content_xml = Zip::File.open(filename) do |zip|
+        LibXML::XML::Document.io zip.get_input_stream('content.xml')
+      end
+
+      ndx = 0
+      @content_xml.find_first('//office:spreadsheet').each_element { |node|
+        sheet = Worksheet.new(node)
+        @worksheets[ndx]=sheet
+        @worksheets[node.name]=sheet
+        ndx+=1
+      }
+    end
+  end
+  def save(new_filename=nil)
+    if @filename.nil? and new_filename.nil? then raise 'New file should be named on first save.' end
+    # if the filename has changed than first copy the original file to new location (or template if it is a new file)
+    if new_filename
+      FileUtils.cp(@filename || './lib/rspreadsheet/empty_file_template.ods', new_filename)
+      @filename = new_filename
+    end
+    Zip::File.open(@filename) do |zip|
+      # it is easy, because @content_xml in in sync with contents all the time
+      zip.get_output_stream('content.xml') do |f|
+        f.write @content_xml
+      end
+    end
+  end
+  def create_worksheet(node=nil)
+    sheet = Worksheet.new(node)
+    @worksheets[worksheets_count]=sheet
+    @worksheets[node.name]=sheet unless node.nil?
+    return sheet
+  end
+  def worksheets
+    @worksheets
+  end
+  def worksheets_count
+    @worksheets.keys.select{ |k| k.kind_of? Numeric }.size #TODO: ?? max
+  end
+  def worksheet_names
+    @worksheets.keys.reject{ |k| k.kind_of? Numeric }
+  end
+end
+end

data/lib/rspreadsheet/worksheet.rb

@@ -0,0 +1,112 @@
+require 'rspreadsheet/row'
+require 'forwardable'
+
+module Rspreadsheet
+
+module Tools
+  ## converts cell adress like 'F12' to pair od integers [row,col]
+  def self.convert_cell_address(*coords)
+    if coords.length == 1
+      coords.match(/^([A-Z]{1,3})(\d{1,8})$/)
+      colname = $~[1]
+      rowname = $~[2]
+    elsif coords.length == 2
+      colname = coords[0]
+      rowname = coords[1]
+    else
+      raise 'Wrong number of arguments'
+    end
+      
+    colname=colname.rjust(3,'@')
+    col = (colname[-1].ord-65)+(colname[-2].ord-64)*26+(colname[-3].ord-64)*26*26
+    row = rowname.to_i-1
+    return [row,col]
+  end      
+end
+
+class Worksheet
+  attr_accessor :name
+  extend Forwardable
+  def_delegators :@worksheetcells, :nonemptycells
+
+  def initialize(source_node=nil)
+    @source_node = source_node
+    @worksheetcells=WorksheetCells.new
+    rowi = 0
+    unless @source_node.nil?
+      @source_node.elements.select{ |node| node.name == 'table-row'}.each do |row_source_node|
+        coli = 0
+        row_source_node.elements.select{ |node| node.name == 'table-cell'}.each do |cell_source_node|
+          cells.initialize_cell(rowi,coli,cell_source_node)
+          coli += 1
+        end
+        rowi += 1
+      end
+    end
+  end
+  def cells
+    @worksheetcells
+  end
+  def [](r,c)
+    cells[r,c].value
+  end
+  def []=(r,c,avalue)
+    cells[r,c].value=avalue
+  end
+  def rows
+    WorksheetRows.new(self)
+  end
+  def method_missing method_name, *args, &block
+    if method_name.to_s.match(/^([A-Z]{1,3})(\d{1,8})(=?)$/)
+      row,col = Tools.convert_cell_address($~[1],$~[2])
+      assignchar = $~[3]
+      if assignchar == '='
+        self.cells[row,col].value = args.first
+      else
+        self.cells[row,col].value
+      end
+    else
+      super
+    end
+  end
+end
+
+# this allows the sheet.cells[r,c] syntax
+# this object is result of sheet.cells
+class WorksheetCells
+  def initialize
+    @cells = Hash.new do |hash, coords| 
+      # we create empty cell and place it to hash, we do not have to check whether there is a cell in XML already, because it would be in hash as well
+      hash[coords]=Cell.new(coords[0],coords[1])
+      # TODO: create XML empty node here or upon save?
+    end
+  end
+  def [](r,c)
+    cells_object(r,c)
+  end
+  def nonemptycells
+    @cells.values
+  end
+  
+  ### internal
+  def cells_object(r,c)
+    @cells[[r,c]]
+  end
+  def initialize_cell(r,c,source_node)
+    @cells[[r,c]]=Cell.new(r,c,source_node)
+  end
+end
+
+# this allows the sheet.rows[r] syntax
+# this object is result of sheet.rows
+class WorksheetRows
+  def initialize(aworkbook)
+    @workbook = aworkbook
+    @spredsheetrows=Array.new()
+  end
+  def [] rowi
+    @spredsheetrows[rowi] ||= Row.new(@workbook,rowi)
+  end
+end
+
+end

data/lib/rspreadsheet.rb

@@ -1,5 +1,14 @@
 require "rspreadsheet/version"
+require 'rspreadsheet/workbook'
+require 'rspreadsheet/worksheet'
+require 'class_extensions'
 
 module Rspreadsheet
-  # Your code goes here...
+
+  def self.new(filename=nil)
+    Workbook.new(filename)
+  end  
+  def self.open(filename)
+    Workbook.new(filename)
+  end
 end

data/rspreadsheet.gemspec

@@ -9,15 +9,31 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jakub A.Těšínský"]
   spec.email         = ["jAkub.cz (A is at)"]
   spec.summary       = %q{Manipulating spreadsheets with Ruby (read / create / modify OpenDocument Spreadsheet).}
-#   spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.description   = %q{Manipulating spreadsheets with Ruby (read / create / modify OpenDocument Spreadsheet).}
   spec.homepage      = "https://github.com/gorn/rspreadsheet"
-#   spec.license       = "MIT"
+  spec.license       = "GPL"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  # runtime dependencies
+  spec.add_runtime_dependency 'libxml-ruby', '~>2.7'   # parsing XML files
+  spec.add_runtime_dependency 'rubyzip', '~>1.1'       # opening zip files
+  spec.add_runtime_dependency 'andand', '~>1.3'
+  
+  
+  # development dependencies
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", '~>0.9'
+  # testig - see http://bit.ly/1n5yM51
+  spec.add_development_dependency "rspec", '~>2'
+  
+  # optional and testing
+  spec.add_development_dependency "coveralls", '~>0.7'
+  spec.add_development_dependency "test_notifier", '~>2.0' # test notifier for kde and other platforms
+  spec.add_development_dependency "guard", '~>2.6'
+  spec.add_development_dependency "guard-rspec", '~>2.6'
+  
 end

data/spec/rspreadsheet_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+$test_filename = './spec/testfile1.ods'
+
+describe Rspreadsheet do
+  it 'can open ods testfile and reads its content correctly' do
+    book = Rspreadsheet.new($test_filename)
+    book.worksheets[0].should_not == nil
+    book.worksheets[0].class.should == Rspreadsheet::Worksheet
+    s = book.worksheets[0]
+    (1..10).each do |i|
+      s[i-1,0].should === i
+    end
+    s[0,1].should === 'text'
+    s[1,1].should === Date.new(2014,1,1)
+  end
+  it 'can open and save file, and saved file has same cells as original' do
+    tmp_filename = '/tmp/testfile1.ods'        # first delete temp file
+    File.delete(tmp_filename) if File.exists?(tmp_filename)
+    book = Rspreadsheet.new($test_filename)    # than open test file
+    book.save(tmp_filename)                    # and save it as temp file
+    
+    book1 = Rspreadsheet.new($test_filename)   # now open both again
+    book2 = Rspreadsheet.new(tmp_filename)
+    @sheet1 = book1.worksheets[0]
+    @sheet2 = book2.worksheets[0]
+    
+    @sheet1.nonemptycells.each do |cell|       # and test identity
+      @sheet2[cell.row,cell.col].should == cell.value
+    end
+  end
+  it 'can open and save file, and saved file is exactly same as original' do
+    tmp_filename = '/tmp/testfile1.ods'        # first delete temp file
+    File.delete(tmp_filename) if File.exists?(tmp_filename)
+    book = Rspreadsheet.new($test_filename)    # than open test file
+    book.save(tmp_filename)                    # and save it as temp file
+    
+    # now compare them
+    @content_xml1 = Zip::File.open($test_filename) do |zip|
+      LibXML::XML::Document.io zip.get_input_stream('content.xml')
+    end
+    @content_xml2 = Zip::File.open(tmp_filename) do |zip|
+      LibXML::XML::Document.io zip.get_input_stream('content.xml')
+    end
+    @content_xml1.root.equals?(@content_xml2.root).should == true
+  end
+  it 'when open and save file modified, than the file is different' do
+    tmp_filename = '/tmp/testfile1.ods'        # first delete temp file
+    File.delete(tmp_filename) if File.exists?(tmp_filename)
+    book = Rspreadsheet.new($test_filename)    # than open test file
+    book.worksheets[0][0,0].should_not == 'xyzxyz'
+    book.worksheets[0][0,0]='xyzxyz'
+    book.worksheets[0][0,0].should == 'xyzxyz'
+    book.save(tmp_filename)                    # and save it as temp file
+    
+    # now compare them
+    @content_doc1 = Zip::File.open($test_filename) do |zip|
+      LibXML::XML::Document.io zip.get_input_stream('content.xml')
+    end
+    @content_doc2 = Zip::File.open(tmp_filename) do |zip|
+      LibXML::XML::Document.io zip.get_input_stream('content.xml')
+    end
+    @content_doc1.eql?(@content_doc2).should == false
+  end
+  it 'can create file' do
+    book = Rspreadsheet.new
+  end
+  it 'can create new worksheet' do
+    book = Rspreadsheet.new
+    book.create_worksheet
+  end
+end
+
+describe Rspreadsheet::Cell do
+  before do 
+    book1 = Rspreadsheet.new
+    @sheet1 = book1.create_worksheet
+    @sheet1[0,0] = 'text'
+    book2 = Rspreadsheet.new($test_filename)
+    @sheet2 = book2.worksheets[0]
+  end
+  it 'contains good row and col coordinates' do
+    @cell = @sheet1.cells[1,3]
+    @cell.row.should == 1
+    @cell.col.should == 3
+    @cell.coordinates.should == [1,3]
+    
+    @cell = @sheet2.cells[0,1]
+    @cell.row.should == 0
+    @cell.col.should == 1
+    @cell.coordinates.should == [0,1]
+  end
+  it 'can be referenced by more vars and both are synchromized' do
+    @cell = @sheet1.cells[0,0]
+    @sheet1[0,0] = 'novinka'
+    @cell.value.should == 'novinka'
+  end
+  it 'can be modyfied by more ways and all are identical' do
+    @cell = @sheet1.cells[2,2]
+    @sheet1[2,2] = 'zaprve'
+    @cell.value.should == 'zaprve'
+    @sheet1.cells[2,2].value = 'zadruhe'
+    @cell.value.should == 'zadruhe'
+    @sheet1.C3 = 'zatreti'
+    @cell.value.should == 'zatreti'
+  end
+end
+
+
+describe Rspreadsheet::Worksheet do
+  before do
+    book = Rspreadsheet.new
+    @sheet = book.create_worksheet
+  end
+  it 'remembers the value stored to A1 cell' do
+    @sheet[0,0].should == nil
+    @sheet[0,0] = 'test text'
+    @sheet[0,0].class.should == String
+    @sheet[0,0].should == 'test text'
+  end
+  it 'value stored to A1 is accesible using different syntax' do
+    @sheet[0,0] = 'test text'
+    @sheet[0,0].should == 'test text'
+    @sheet.cells[0,0].value.should == 'test text'
+  end
+  it 'makes Cell object accessible' do
+    @sheet.cells[0,0].value = 'test text'
+    @sheet.cells[0,0].class.should == Rspreadsheet::Cell
+  end
+  it 'has name, which can be changed and is remembered' do
+    @sheet.name.should be(nil)
+    @sheet.name = 'Icecream'
+    @sheet.name.should == 'Icecream'
+    @sheet.name = 'Cofee'
+    @sheet.name.should == 'Cofee'    
+  end
+end
+
+describe Rspreadsheet::Row do
+  before do 
+    book1 = Rspreadsheet.new
+    @sheet1 = book1.create_worksheet
+  end
+  it 'allows access to cells in a row' do
+    (2..5).each { |i| @sheet1[7,i] = i }
+    (2..5).each { |i| 
+      a = @sheet1.rows
+      b = a[7]
+      c = b.cells
+      d = c[i]
+      d.value.should == i 
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'rspreadsheet'

metadata

@@ -1,61 +1,190 @@
 --- !ruby/object:Gem::Specification
 name: rspreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jakub A.Těšínský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: andand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: test_notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Manipulating spreadsheets with Ruby (read / create / modify OpenDocument
+  Spreadsheet).
 email:
 - jAkub.cz (A is at)
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- COPYING.txt
+- DEVEL_BLOG.md
 - GUIDE.md
 - Gemfile
-- LICENSE.txt
+- Gemfile.lock
+- Guardfile
+- LICENSE.md
 - README.md
 - Rakefile
+- lib/class_extensions.rb
 - lib/rspreadsheet.rb
+- lib/rspreadsheet/cell.rb
+- lib/rspreadsheet/empty_file_template.ods
+- lib/rspreadsheet/row.rb
 - lib/rspreadsheet/version.rb
+- lib/rspreadsheet/workbook.rb
+- lib/rspreadsheet/worksheet.rb
 - rspreadsheet.gemspec
+- spec/rspreadsheet_spec.rb
+- spec/spec_helper.rb
+- spec/testfile1.ods
 homepage: https://github.com/gorn/rspreadsheet
-licenses: []
+licenses:
+- GPL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -63,19 +192,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Manipulating spreadsheets with Ruby (read / create / modify OpenDocument
   Spreadsheet).
-test_files: []
+test_files:
+- spec/rspreadsheet_spec.rb
+- spec/spec_helper.rb
+- spec/testfile1.ods