rspreadsheet 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cefcb8b1947902d4008ba3f9a77cbf1789addd1
-  data.tar.gz: 841b189fbbe35436ff05e92dcd7fe0cfc368cd0f
+  metadata.gz: 09a4b24ab468ec79d6c6e0f079ab4e98ff9dd534
+  data.tar.gz: 768912df8317bbad53cc0761bb0d23adabb6b976
 SHA512:
-  metadata.gz: 69b9f5968540c86671c39cd93efc04f243cf5c441789e60bedd69a6fdc12a68ccf51016021a9a4bd75fffe65c716cadaeaf79289b6d00fedcdfda46973f62898
-  data.tar.gz: 52eea9086874e653eddab4374c396a82f09741daf55596a5cb393662d4130b25f5273e8664b43134981e5214d2bcfb3ffe9b3b88136c9d6e50a4eaab77f0df15
+  metadata.gz: cb06852ec036f391e3b8a3c3ef25a5f0a9111d19e23bb52f37db49b78adb49dd8fb510ad22cc29516c00c2afb1eef5909fba882c9269d8ca10237760f6303592
+  data.tar.gz: fafe3fea122b4ff9f13430b69103b2153c5fcaa808f05bf55c2f838f26c3e4a9b3fedf7c728e0820d96ac343979daa0f70e59b9fd4498a76368823f7dab47daa

data/DEVEL_BLOG.md

@@ -2,7 +2,7 @@ See [GUIDE.md](GUIDE.md#conventions) for syntax conventions.
 
 ## Ideas/wishlist
 
-  * In future inntroduce syntax like ``sheet.range('C3:E4')`` for mass operations. Also maybe ``sheet.cells('C3')`` or ``sheet.cells(3, 'C')`` etc.
+  * In future inntroduce syntax like `sheet.range('C3:E4')` for mass operations.
   * Trying to make row Enumerable - perhaps skipping empty or undefined cells.
   * Maybe insted two syntaxes for accessing cell, we make both of them do the same and return Proxy object which would act either as value or cell.
   * Document that there is a little distinction betwean RSpreadsheet and RSpreadsheet::Workbook. The former delegates everythink to the other.
@@ -19,6 +19,9 @@ Guiding ideas
   * all cells and rows only server as proxy. they hold index and worksheet pointer and everytime read or write is done, the xml is newly searched. until there is a xmlnode caching we have no problem
   * all cells returned for particular coordinates are **always the same object**. This way we have no problem to synchronize changes.
     
+## Known Issues
+  * currently there is a confusing syntax @worksheet.rows(1).cells[5] which returns a cell object in SIXT column, which is not intended. It is side effecto of Row#cells returning an array
+    
 ## Developing this gem
 
 ### Automated testing
@@ -35,7 +38,7 @@ Guiding ideas
 ### Local testing and releasing (to github and rubygems).
 
 1. make changes
-2. test if all tests pass (run `bundle exex guard` to test automatically). If not go to 1
+2. test if all tests pass (run `bundle exec guard` to test automatically). If not go to 1
 3. build and install locally
     * ``rake build`` - builds the gem to pkg directory (if something gets wrong, sometimes comit go git gelps)
     * ``sudo rake install`` - installs gem to local system [^1]

data/README.md

@@ -2,22 +2,17 @@
 
 [![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
-
-If you need any help or find a bug please [submit an issue](https://github.com/gorn/rspreadsheet/issues) here. I appreciate any feedback and even if you can not help with code, it is interesting for me to hear from you. Different people have different needs and I want to hear about them. If you are a programmer and you have any ideas, wishes, etc you are welcomed to fork the repository and submit a pull request preferably including a failing test.
+The gem allows you to acces your file and modify any cell of it, **without** touching the rest of the file, which makes it compatible with all advanced features of ODS files (both existing and future ones). You do not have to worry if it supports feature XY, if it does not, it won't touch it. This itself makes it distinct from most of [similar gems](#why-another-opendocument-spreadsheet-gem). Alhought this gem is still in beta stage I use in everyday and it works fine.
 
-Alhought this gem is still in alpha stage I use in my project it and it works fine. Currently I am experimenting with syntax to get stabilized. **Any suggestions regarding the syntax is very welcomed**
- 
 ## Examples of usage
-  
+
 ```ruby
 require 'rspreadsheet'
 book = Rspreadsheet.open('./test.ods')
 sheet = book.worksheets(1)
 
-
 # get value of a cell B5 (there are more ways to do this)
 sheet.B5                       # => 'cell value'
 sheet[5,2]                     # => 'cell value'
@@ -32,12 +27,14 @@ sheet.cells(5,2).value = 1.78
 sheet.cells(5,2).format.bold = true
 sheet.cells(5,2).format.background_color = '#FF0000'
 
-# calculating sum of cells in row
+# calculate sum of cells in row
 sheet.rows(5).cellvalues.sum
 sheet.rows(5).cells.sum{ |cell| cell.value.to_f }
 
-# iterating over list of people and displaying the data
+# or set formula to a cell
+sheet.A1.formula='=SUM(A2:A9)'
 
+# iterating over list of people and displaying the data
 total = 0
 sheet.rows.each do |row|
   puts "Sponsor #{row[1]} with email #{row[2]} has donated #{row[3]} USD."
@@ -58,29 +55,36 @@ This is also pubished as Gist **where you can leave you comments and suggestions
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'rspreadsheet'
-
-And then execute (if this fails install bundle gem):
-
-    $ bundle
-
-Or install it yourself as:
+Gem is on [Rubygems](https://rubygems.org/gems/rspreadsheet) so you can install it by
 
     $ gem install rspreadsheet
-    
-gem is hosted on Rubygems - https://rubygems.org/gems/rspreadsheet
 
-If you get this or similar error
+or add <code>gem 'rspreadsheet'</code> to your Gemfile and execute  <code>bundle</code>. 
+
+If you get this error
 
     mkmf.rb can't find header files for ruby at /usr/lib/ruby/include/ruby.h 
     
 then you might not have installed libxml for ruby. I.e. in debian something like <code>sudo aptitude install ruby-libxml</code> or using equivalent command in other package managers.
 
-## Motivation and Ideas
+## Contibutions, ideas and wishes welcomed
+
+### Nonprogrammers
+If you need any help or find a bug please [submit an issue](https://github.com/gorn/rspreadsheet/issues) here. I appreciate any feedback and even if you can not help with code, it is interesting for me to hear from you. Different people have different needs and I want to hear about them. If you are a programmer and you have any ideas, wishes, etc you are welcomed to fork the repository and submit a pull request preferably including a failing test.
 
-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:
+Alhought this gem is still in beta stage I use in everyday and it works fine. Currently I am experimenting with syntax to get stabilized. **Any suggestions regarding the syntax is very welcomed**
+
+### Programmers
+
+1. [Fork it](http://github.com/gorn/rspreadsheet/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+ 
+## Why another OpenDocument spreadsheet gem?
+
+I would be glad to safe myself work, but surprisingly, there are not that many gems for OpenDocument spreadsheets. Most of them also look abandoned and inactive, or can only read or write spreadsheets, but not modify them. I have investigated these options (you might as well):
 
   * [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
@@ -91,15 +95,6 @@ This project arised from the necessity. Alhought it is not true that there are n
 
 One of the main ideas is that the manipulation with OpenDOcument files should be forward compatible and as much current data preserving as possible. The parts of the file which are not needed for the change should not be changed. This is different to some of the mentioned gems, which generate the document from scratch, therefore any advanced features present in the original file which are not directly supported are lost.
 
-  
-## Contributing
-
-1. [Fork it](http://github.com/gorn/rspreadsheet/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
 ## Further reading
 
 * [Advanced Guide](GUIDE.md) how to use the gem

data/lib/rspreadsheet/cell.rb

@@ -205,6 +205,7 @@ class Cell < XMLTiedItem
     remove_all_type_attributes
     Tools.set_ns_attribute(xmlnode,'table','formula','of:'+formulastring.to_s)
   end
+  def blank?; self.type==:empty or self.type==:unassigned end
 
 end
 
@@ -293,7 +294,6 @@ class CellFormat
     return nil if cellnode.nil?
     cellnode.doc.root.find("./office:automatic-styles#{xpath}").first 
   end
-
 end
 
 end

data/lib/rspreadsheet/row.rb

@@ -9,15 +9,18 @@ module Rspreadsheet
 #
 #     @row = @worksheet.rows(5)
 #
-# Mostly you will this object to access row cells
+# Mostly you will this object to access row cells values
 #
-#     @row.cells(2)     # identical to @worksheet.rows(5).cells(2)
-#     @row[2]           # identical to @worksheet[5,2] or @row.cells(2)
+#     @row[2]           # identical to @worksheet[5,2] or @row.cells(2).value
 #
-# or manipulate rows
+# or directly row `Cell` objects
+#
+#     @row.cells(2)     # => identical to @worksheet.rows(5).cells(2)
+#
+# You can use it to manipulate rows
 #
 #     @row.add_row_above   # adds empty row above
-#     @row.delete          # deletes row
+#     @row.delete          # deletes row 
 #
 # and shifts all other rows down/up appropriatelly.
 
@@ -43,12 +46,35 @@ class Row < XMLTiedItem
   
   ## @return [String or Float or Date] value of the cell
   # @param coli [Integer] colum index of the cell 
-  # returns value of the cell at column `coli`
+  # returns value of the cell at column `coli`. 
+  #  
+  #     @row = @worksheet.rows(5)     # with cells containing names of months
+  #     @row[1]                       # => "January" 
+  #     @row.cells(2).value           # => "February"  
+  #     @row[1].class                 # => String
   def [](coli); cells(coli).value end
-  ## @param coli [Integer] colum index of the cell 
-  # @param avalue [String or Float or Date] colum index of the cell  
-  # sets value of the cell at column `coli`
+  # @param avalue [Array] 
+  # sets value of cell in column `coli`
   def []=(coli,avalue); cells(coli).value=avalue end
+  # @param avalue [Array] array with values 
+  # sets values of cells of row to values from `avalue`. *Attention*: it deletes the rest of row
+  #  
+  #     @row = @worksheet.rows(5)     
+  #     @row.values = ["January", "Feb", nil, 4] # =>  | January | Feb |  | 4 |
+  #     @row[2] = "foo")                         # =>  | January | foo |  | 4 |
+  def cellvalues=(avalue)
+    self.truncate
+    avalue.each_with_index{ |val,i| self[i+1] = val }
+  end
+  ## @return [Array
+  # return array of cell values 
+  # 
+  #     @worksheet[3,3] = "text"
+  #     @worksheet[3,1] = 123
+  #     @worksheet.rows(3).cellvalues            # => [123, nil, "text"]
+  def cellvalues
+    cells.collect{|c| c.value}
+  end
  # @!endgroup
   
  # @!group Other methods
@@ -72,9 +98,6 @@ class Row < XMLTiedItem
   def add_row_above
     parent.add_row_above(rowi)
   end
-  def cellvalues
-    cells.collect{|c| c.value}
-  end
   
  # @!group Private methods, which should not be called directly
   # @private

data/lib/rspreadsheet/tools.rb

@@ -11,7 +11,7 @@ module Tools
   # converts cell adress like 'F12' to pair od integers [row,col]
   def self.convert_cell_address_to_coordinates(*addr)
     if addr.length == 1
-      addr[0].match(/^([A-Za-z]{1,3})(\d{1,8})$/)
+      addr[0].to_s.match(/^([A-Za-z]{1,3})(\d{1,8})$/)
       colname = $~[1]
       rowname = $~[2].to_i
     elsif addr.length == 2

data/lib/rspreadsheet/version.rb

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

data/lib/rspreadsheet/worksheet.rb

@@ -63,9 +63,17 @@ class Worksheet
   def [](*params)
     cells(*params).andand.value
   end
-  # Aets value of the cell given either by  row,column integer coordinates of by address. It also sets the type of the cell according to type of the value. For details #see Cell.value=
+  # Sets value of the cell given either by  row,column integer coordinates of by address. 
+  # It also sets the type of the cell according to type of the value. For details #see Cell.value=
+  # This also allows syntax like
+  #
+  #      @sheet[1] = ['Jan', 'Feb', 'Mar']
   def []=(*params)
-    cells(*params[0..-2]).andand.value = params.last 
+    if (params.size == 2) and params[0].kind_of?(Integer) 
+      rows(params[0]).cellvalues = params[1]
+    else
+      cells(*params[0..-2]).andand.value = params.last 
+    end
   end
   # Returns a Cell object placed in row and column or on a Cell on string address
   # @param [(Integer,Integer), String] either row and column of the cell (i.e. 3,5) or a string containing it address i.e. 'F12'

data/lib/rspreadsheet/xml_tied.rb

@@ -64,10 +64,12 @@ class XMLTiedItem < XMLTied
 
 end
 
-# abstrac class. All successort MUST implement: prepare_subitem
+# abstract class. All importers MUST implement: prepare_subitem (and delete)
 # terminology
 #  item, subitem is object from @itemcache (quite often subclass of XMLTiedItem)
 #  node, subnode is LibXML::XML::Node object
+#
+# this class is made to be included, not subclassed - the reason is in delete method which calls super
 # @private
 
 module XMLTiedArray
@@ -94,7 +96,7 @@ module XMLTiedArray
   def subitem(aindex)
     aindex = aindex.to_i
     if aindex.to_i<=0
-      nil
+      nil # TODO> maybe optionally raise 'Item index should be greater then 0'
     else 
       @itemcache[aindex] ||= prepare_subitem(aindex)
     end
@@ -109,11 +111,13 @@ module XMLTiedArray
   end
   
   def subitems_array
-    (1..(find_first_unused_index_respect_repeated(subitem_xml_options)-1)).collect do |i|
+    (1..self.size).collect do |i|
       subitem(i)
     end
   end
   
+  def size; find_first_unused_index_respect_repeated(subitem_xml_options)-1 end
+      
   def find_subnode_respect_repeated(axmlnode, aindex, options)
     result1, result2 = find_subnode_with_range_respect_repeated(axmlnode, aindex, options)
     return result1
@@ -189,6 +193,7 @@ module XMLTiedArray
   
   def find_first_unused_index_respect_repeated(options)
     index = 0
+    return 1 if xmlnode.nil?
     xmlnode.elements.select{|node| node.name == options[:xml_items_node_name]}.each do |node|
       repeated = (node.attributes[options[:xml_repeated_attribute]] || 1).to_i
       index = index+repeated
@@ -222,7 +227,7 @@ module XMLTiedArray
       item.delete   # delete item - this destroys its subitems, xmlnode and invalidates it
       @itemcache.delete(key)  # delete the entry from the hash, normally this would mean this ceases to exist, if user does not have reference stored somewhere. Of he does, the object is invalidated anyways
     end
-    super # this for example for Row objects calls XMLTiedItem.delete
+    super # this for example for Row objects calls XMLTiedItem.delete because Row is subclass of XMLTiedItem
   end
 
   def find_nonempty_subnode_indexes(axmlnode, options)
@@ -238,6 +243,10 @@ module XMLTiedArray
     return result
   end
 
+  # truncate the item completely, deleting all its subitems
+  def truncate
+    subitems.reverse.each{ |subitem| subitem.delete }  # reverse je tu jen kvuli performanci, aby to mazal zezadu
+  end  
 end
 
 end 

data/spec/row_spec.rb

@@ -11,10 +11,19 @@ describe Rspreadsheet::Row do
     @c.value = 3
     @c.value.should == 3 
   end
+  it 'allows access to cells using different syntax' do
+    @row = @sheet1.rows(1)
+    @row.cells(1).value = 77
+    @row.cells(1).value.should == 77
+    @row.cells.first.value.should == 77
+    @row.cells.first.value = 88
+    @row.cells(1).value.should == 88
+    @row[1]= 99
+    @row.cells(1).value.should == 99
+  end
   it 'can be detached and changes to unrepeated if done' do
     @row = @sheet1.rows(5)
     @row.xmlnode.andand.name.should_not == 'table-row'
-    
     @row2 = @row.detach
     @row2.xmlnode.name.should == 'table-row'
     @row2.is_repeated?.should == false    
@@ -204,6 +213,44 @@ describe Rspreadsheet::Row do
     @sheet1.rows(14).should be @row
     @sheet1.rows(14).cells(1).value.should eq 'data1'
   end
+  it 'has no cells when empty' do
+    @row = @sheet1.rows(2)
+    @row.cells.size.should == 0
+  end
+  it 'has 1 cells when assigned to first one' do
+    @row = @sheet1.rows(2)
+    @row.cells(1).value = 'foo'
+    @row.cells.size.should == 1
+  end
+  it 'can be mass assigned by cellvalues= method' do
+    @row = @sheet1.rows(2)
+#     @row.size.should == 0
+    @row.cellvalues= ['January',nil,3]
+    @row.size.should == 3
+    @row.cells(1).value.should == 'January' 
+    @row.cells(2).blank?.should be_truthy
+    @row.cells(3).value.should == 3
+    @row.cellvalues = [1]
+    @row.size.should == 1
+    @row.cells(1).value.should == 1
+    @row.cells(3).blank?.should be_truthy
+  end
+  it 'can be mass assigned by sheet[]= method', :focus do
+    @sheet1[1] = ['foo','baz']
+  end
+  it 'cells can be wiped out by truncate method' do
+    @row = @sheet1.rows(1)
+    @row[1]='data'
+    @row[3]='data3'
+    @row.size.should == 3
+    @row.truncate
+    @row.size.should == 0
+  end
 end
 
  
+
+
+
+
+

data/spec/worksheet_spec.rb

@@ -39,9 +39,20 @@ describe Rspreadsheet::Worksheet, :focus do
     @sheet[1,1].should == 'test text'
   end
   it 'value stored to A1 is accesible using different syntax' do
-    @sheet[1,1] = 'test text'
-    @sheet[1,1].should == 'test text'
-    @sheet.cells(1,1).value.should == 'test text'
+    @sheet[2,2] = 'test text'
+    @sheet[2,2].should == 'test text'
+    @sheet.B2.should == 'test text'
+    @sheet['B2'].should == 'test text'
+    @sheet['2','2'].should == 'test text'
+    @sheet['2','B'].should == 'test text'
+    @sheet[2,'B'].should == 'test text'
+    @sheet['B',2].should == 'test text'
+    @sheet['B','2'].should == 'test text'
+    
+    @sheet.cells(2,2).value.should == 'test text'
+    @sheet.cells('B2').value.should == 'test text'
+    @sheet.cells('B','2').value.should == 'test text'
+    @sheet.cells(2,'B').value.should == 'test text'
   end
   it 'makes Cell object accessible' do
     @sheet.cells(1,1).value = 'test text'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Jakub A.Těšínský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby