rspreadsheet 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9603ed2713de6f87efb309a9cd9f36388001731
-  data.tar.gz: baa73509ae8527b93fa5dc19596a244ed21f5171
+  metadata.gz: 6cefcb8b1947902d4008ba3f9a77cbf1789addd1
+  data.tar.gz: 841b189fbbe35436ff05e92dcd7fe0cfc368cd0f
 SHA512:
-  metadata.gz: 691688a99bd3900f791502e2efd9b74b5fb745f1044ef349885fec3323ff6e95fc074fcd65c5c55a2b972f50a49715d58381e5b7b00f65c662dc4f5293378b90
-  data.tar.gz: 1a57249cbdceb90ff94a8544a7f370c89124008d6c33dc9777a2aeae83e3fb6e6f4b67bb7380df27496726170d0a84be36feb51083d9fffda525ba34c9ea10d5
+  metadata.gz: 69b9f5968540c86671c39cd93efc04f243cf5c441789e60bedd69a6fdc12a68ccf51016021a9a4bd75fffe65c716cadaeaf79289b6d00fedcdfda46973f62898
+  data.tar.gz: 52eea9086874e653eddab4374c396a82f09741daf55596a5cb393662d4130b25f5273e8664b43134981e5214d2bcfb3ffe9b3b88136c9d6e50a4eaab77f0df15

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://api.travis-ci.org/gorn/rspreadsheet.svg?branch=master)](https://travis-ci.org/gorn/rspreadsheet) [![Coverage Status](https://coveralls.io/repos/gorn/rspreadsheet/badge.png)](https://coveralls.io/r/gorn/rspreadsheet)
  
-Manipulating spreadsheets with Ruby. Read, modify, write or create new OpenDocument Spreadsheet files from ruby code.
+Manipulating spreadsheets with Ruby. Read, modify, write or create new OpenDocument Spreadsheet files from ruby code. 
 
 ## Contibutions, ideas and wishes welcomed
 
@@ -82,8 +82,8 @@ then you might not have installed libxml for ruby. I.e. in debian something like
 
 This project arised from the necessity. Alhought it is not true that there are no ruby gems allowing to acess OpenDOcument spreadsheet, I did not find another decent one which would suit my needs. Most of them also look abandoned and inactive. I have investigated these options:
 
-  * [ruby-ods](https://github.com/yalab/ruby-ods) - this one seems as if it never really started
-  * [rodf](https://github.com/thiagoarrais/rodf)- this only server as builder, it can not read existing files
+  * [ruby-ods](https://github.com/yalab/ruby-ods) - this one seems abandoned, or even as if it never really started
+  * [rodf](https://github.com/thiagoarrais/rodf)- this only serves as builder, it can not read existing files or modify them
   * [rods](http://www.drbreinlinger.de/ruby/rods/) - this is pretty ok, but it has terrible syntax. I first thought of writing wrapper around it, but it turned to be not so easy. Also last commit is 2 years old.
   * [rubiod](https://github.com/netoctone/rubiod) - this one is quite ok, the syntax is definitely better that in rods, but it seems also very abandoned. It does not support formats. This is a closest match.
   * [spreadsheet](https://github.com/zdavatz/spreadsheet) - this does not work with OpenDocument and even with Excel has issues in modyfying document. However since it is supposedly used, and has quite good syntax it might be inspirative. I also find the way this gem handles lazy writing of new rows to Spreadsheet object flawed, as well as strange accesibility of rows array object, which if assigned breaks consistency of sheet.

data/lib/rspreadsheet/cell.rb

@@ -1,9 +1,10 @@
 # @markup markdown
 # @author Jakub Tesinsky
-# @titel rspreadsheet Cell
+# @title rspreadsheet Cell
 
 require 'andand'
 require 'rspreadsheet/xml_tied'
+require 'date'
 
 
 
@@ -72,23 +73,23 @@ class Cell < XMLTiedItem
       gt = guess_cell_type(avalue)
       case
         when gt == nil then raise 'This value type is not storable to cell'
-        when gt == Float 
-          set_type_attribute('float')
+        when gt == Float then
           remove_all_value_attributes_and_content(xmlnode)
+          set_type_attribute('float')
           Tools.set_ns_attribute(xmlnode,'office','value', avalue.to_s) 
           xmlnode << Tools.prepare_ns_node('text','p', avalue.to_f.to_s)
         when gt == String then
-          set_type_attribute('string')
           remove_all_value_attributes_and_content(xmlnode)
+          set_type_attribute('string')
           xmlnode << Tools.prepare_ns_node('text','p', avalue.to_s)
         when gt == Date then 
-          set_type_attribute('date')
           remove_all_value_attributes_and_content(xmlnode)
+          set_type_attribute('date')
           Tools.set_ns_attribute(xmlnode,'office','date-value', avalue.strftime('%Y-%m-%d'))
           xmlnode << Tools.prepare_ns_node('text','p', avalue.strftime('%Y-%m-%d')) 
-        when gt == :percentage
-          set_type_attribute('percentage')
+        when gt == :percentage then
           remove_all_value_attributes_and_content(xmlnode)
+          set_type_attribute('percentage')
           Tools.set_ns_attribute(xmlnode,'office','value', '%0.2d%' % avalue.to_f) 
           xmlnode << Tools.prepare_ns_node('text','p', (avalue.to_f*100).round.to_s+'%')
       end
@@ -98,12 +99,17 @@ class Cell < XMLTiedItem
   end
   def set_type_attribute(typestring)
     Tools.set_ns_attribute(xmlnode,'office','value-type',typestring)
+    Tools.set_ns_attribute(xmlnode,'calcext','value-type',typestring)
   end
-  def remove_all_value_attributes_and_content(node)
+  def remove_all_value_attributes_and_content(node=xmlnode)
     if att = Tools.get_ns_attribute(node, 'office','value') then att.remove! end
     if att = Tools.get_ns_attribute(node, 'office','date-value') then att.remove! end
+    if att = Tools.get_ns_attribute(node, 'table','formula') then att.remove! end
     node.content=''
   end
+  def remove_all_type_attributes
+    set_type_attribute(nil)
+  end
   def relative(rowdiff,coldiff)
     @worksheet.cells(self.rowi+rowdiff, self.coli+coldiff)
   end
@@ -115,6 +121,7 @@ class Cell < XMLTiedItem
       when gct == Date   then :date
       when gct == :percentage then :percentage
       when gct == :unassigned then :unassigned
+      when gct == NilClass then :empty
       when gct == nil then :unknown
       else :unknown
     end
@@ -161,9 +168,11 @@ class Cell < XMLTiedItem
           typeguess
         end
       else # it not have a typeguess
-        if (String(avalue) rescue false) # convertible to String
+        if (avalue.nil?) # if nil then nil
+          NilClass
+        elsif (String(avalue) rescue false) # convertible to String
           String
-        else
+        else # giving up
           nil
         end
       end
@@ -178,6 +187,24 @@ class Cell < XMLTiedItem
   def address
     Tools.convert_cell_coordinates_to_address(coordinates)
   end
+  
+  def formula
+    rawformula = Tools.get_ns_attribute(xmlnode,'table','formula',nil).andand.value
+    if rawformula.nil?
+      nil 
+    elsif rawformula.match(/^of:(.*)$/)
+      $1
+    else
+      raise "Mischmatched value in table:formula attribute - does not start with of: (#{rawformula.to_s})"
+    end
+  end
+  def formula=(formulastring)
+    detach_if_needed
+    raise 'Formula string must begin with "=" character' unless formulastring[0,1] == '='
+    remove_all_value_attributes_and_content(xmlnode)
+    remove_all_type_attributes
+    Tools.set_ns_attribute(xmlnode,'table','formula','of:'+formulastring.to_s)
+  end
 
 end
 
@@ -209,6 +236,7 @@ class CellFormat
   def color=(value);    set_text_style_node_attribute('color',  value) end
   def font_size=(value);set_text_style_node_attribute('font-size',  value) end
   def set_text_style_node_attribute(attribute_name,value)
+    @cell.detach if @cell.mode != :regular
     if text_style_node.nil?
       self.create_text_style_node
       raise 'Style node was not correctly initialized' if text_style_node.nil?
@@ -250,17 +278,22 @@ class CellFormat
   end
   
   def unused_cell_style_name
-    last = cellnode.doc.root.find('./office:automatic-styles/style:style').
+    last = (cellnode.nil? ? [] : cellnode.doc.root.find('./office:automatic-styles/style:style')).
       collect {|node| node['name']}.
       collect{ |name| /^ce(\d*)$/.match(name); $1.andand.to_i}.
       compact.max || 0
     "ce#{last+1}"
   end
-  def automatic_styles_node; cellnode.doc.root.find("./office:automatic-styles").first end
-  def style_name; Tools.get_ns_attribute_value(cellnode,'table','style-name') end
-  def style_node; cellnode.doc.root.find("./office:automatic-styles/style:style[@style:name=\"#{style_name}\"]").first end
-  def text_style_node; cellnode.doc.root.find("./office:automatic-styles/style:style[@style:name=\"#{style_name}\"]/style:text-properties").first end
-  def cell_style_node; cellnode.doc.root.find("./office:automatic-styles/style:style[@style:name=\"#{style_name}\"]/style:table-cell-properties").first end
+  def automatic_styles_node; style_node_with_partial_xpath('') end
+  def style_name; Tools.get_ns_attribute_value(cellnode,'table','style-name',nil) end
+  def style_node; style_node_with_partial_xpath("/style:style[@style:name=\"#{style_name}\"]") end
+  def text_style_node; style_node_with_partial_xpath("/style:style[@style:name=\"#{style_name}\"]/style:text-properties") end
+  def cell_style_node; style_node_with_partial_xpath("/style:style[@style:name=\"#{style_name}\"]/style:table-cell-properties") end
+  def style_node_with_partial_xpath(xpath)
+    return nil if cellnode.nil?
+    cellnode.doc.root.find("./office:automatic-styles#{xpath}").first 
+  end
+
 end
 
 end

data/lib/rspreadsheet/tools.rb

@@ -130,6 +130,7 @@ module Tools
   end
   # sets namespaced attribute "ns_prefix:key" in node to value. if value == delete_value then remove the attribute
   def self.set_ns_attribute(node,ns_prefix,key,value,delete_value=nil)
+    raise 'Tools.set_ns_attribute can not set attribute on nil node' if node.nil?
     ns = Tools.get_namespace(ns_prefix)
     attr = node.attributes.get_attribute_ns(ns.href, key)
     
@@ -152,8 +153,12 @@ module Tools
       node.nil? ? default : node.attributes.get_attribute_ns(Tools.get_namespace(ns_prefix).href,key) || default
     end
   end
-  def self.get_ns_attribute_value(node,ns_prefix,key)
-    Tools.get_ns_attribute(node,ns_prefix,key).andand.value
+  def self.get_ns_attribute_value(node,ns_prefix,key,default=:undefined_default)
+    if default==:undefined_default
+      Tools.get_ns_attribute(node,ns_prefix,key).andand.value
+    else
+      node.nil? ? default : Tools.get_ns_attribute(node,ns_prefix,key,nil).andand.value || default
+    end
   end
   def self.remove_ns_attribute(node,ns_prefix,key)
     node.attributes.get_attribute_ns(Tools.get_namespace(ns_prefix).href,key)

data/lib/rspreadsheet/version.rb

@@ -1,3 +1,3 @@
 module Rspreadsheet
-  VERSION = "0.2.7"
+  VERSION = "0.2.9"
 end

data/spec/cell_spec.rb

@@ -141,7 +141,7 @@ describe Rspreadsheet::Cell do
     
     @cell = @sheet2.cells(16,4)
     @cell.range.should == (1..7)
-    @cell.value.should == ""
+    @cell.value.should == nil
     
     @sheet2.rows(15).range.should == (14..18)
     @sheet2.rows(16).range.should == (14..18)
@@ -155,11 +155,11 @@ describe Rspreadsheet::Cell do
     
     @cellA = @sheet2.cells(16,1)
     @cellA.range.should == (1..2)
-    @cellA.value.should == ""
+    @cellA.value.should be_nil
     
     @cellB = @sheet2.cells(16,5)
     @cellB.range.should == (4..8)
-    @cellB.value.should == ""
+    @cellB.value.should be_nil
 
   end
   it 'inserted has correct class' do # based on real error
@@ -232,7 +232,7 @@ describe Rspreadsheet::Cell do
     expect { @cell.rowi }.to raise_error
     expect { @cell.address }.to raise_error
     
-    @sheet1.cells(2,2).type.should == :string
+    @sheet1.cells(2,2).type.should == :empty
     @sheet1.cells(3,2).type.should == :unassigned
   end
   it 'switches to invalid_reference cell when its row is deleted' do
@@ -271,6 +271,38 @@ describe Rspreadsheet::Cell do
     @sheet2.cells('BA177').should be @sheet2.cells(177,53)
     @sheet2.cells('ADA2').should be @sheet2.cells(2,781)
   end
+  it 'setting format in new file detaches the cell' do
+    @cell = @sheet1.cells(1,1)
+    # bold
+    @cell.format.bold.should be_falsey
+    @cell.format.bold = true
+    @cell.format.bold.should be_truthy
+    @cell.mode.should eq :regular
+  end
+  it 'remembers formula when set' do
+    @cell = @sheet1.cells(1,1)
+    # bold
+    @cell.formula.should be_nil
+    @cell.formula='=1+5'
+    @cell.formula.should eq '=1+5'
+  end
+  it 'unsets cell type when formula set - we can not guess it correctly', :focus do
+    @cell = @sheet1.cells(1,1)
+    @cell.value = 'ahoj'
+    @cell.type.should eq :string
+    @cell.formula='=1+5'
+    typ = @cell.xmlnode.nil? ? 'N/A' : @cell.xmlnode.attributes['value-type']
+    @cell.type.should_not eq :string
+    @cell.type.should eq :empty
+  end
+  it 'wipes out formula after assiging value' do
+    @cell = @sheet1.cells(1,1)
+    @cell.formula='=1+5'
+    @cell.formula.should_not be_nil
+    @cell.value = 'baf'
+    @cell.type.should eq :string
+    @cell.formula.should be_nil
+  end
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - Jakub A.Těšínský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Manipulating spreadsheets with Ruby (read / create / modify OpenDocument