rspreadsheet 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 587955d52821df6027e5a5585c3b11ddda4e8612
-  data.tar.gz: ed1c87deafcc001da840c29f5fbab0ab5ee215ae
+  metadata.gz: 919b62abc1e0fafb23ec3d83f731dd7cf60e65ca
+  data.tar.gz: 4a6ee4722c4b84fa550ddcd2cb5a189c11542ed2
 SHA512:
-  metadata.gz: cc258fa3660d01c25f5670fe5e29e55cf9e49451cb3d55dd96356255fc9b22433f81b338abcb3da55d44659fa2e814659e1c379903ae15170a629687166715cd
-  data.tar.gz: f509167f9de879478bc49b56606132795163e7dfaf893acb89321f11a975ae2311245f48d881532e64c9b32b9270f0a63f881b346bf818052b2aecd91490939a
+  metadata.gz: ff81a47706c13f2649d6002a4a40a91bf1712b24912b03774c82deefadaceb5fc241f3cb05c15bb7e172aa2a902dc6473625de44094fb400c32ce748c907e57f
+  data.tar.gz: dc961d15eb6bd8f0058b8e1139ea87a4edbce6790e693f9f456e1247d39fab85d9a8fc8937f11a87c59f2e4722ce65372e1a198256a2c855ba17a6c87c3362f9

data/.gitignore

@@ -38,3 +38,4 @@ build/
 
 # specific to the project
 /*.ods
+/spec/testfile1/

data/DEVEL_BLOG.md

@@ -1,22 +1,39 @@
-See [GUIDE.md#conventions] for syntax conventions.
+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.
   * Trying to make row Enumerable - perhaps skipping empty or undefined cells.
   * Accessors for nonempty/defined 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.
-  * Allow any of these? 
-    * book['Spring 2014'] in place of book.worksheets('Spring 2014')
+  * Allow any of these:
+    * ``book['Spring 2014']`` as alternative to ``book.worksheets('Spring 2014')`` ?
+    * ``sheet.cells.F13`` as alternative to ``sheet.cells[14,5]`` ?
  
 ## Developing this gem
 
-### How to test
-
-  * by running <code>guard</code> in terminal you will get tested any changes as soon as they are summitted
+### Automated testing
 
+  * ``guard`` will get tested any changes as soon as they are summitted
+  * ``rake spec`` runs all test manually
 
 ### Automated utilities
  
-  * [travis-ci](https://travis-ci.org/gorn/rspreadsheet/jobs/25375065) provides automated testing
+  * [travis-ci](https://travis-ci.org/gorn/rspreadsheet) provides automated testing
   * [github](https://github.com/gorn/rspreadsheet) hosts the repository where you can get the code
   * [coverals](https://coveralls.io/r/gorn/rspreadsheet) checks how well source is covered by tests
+
+### Local manual testing and releasing (to github released, ).
+
+  * ``rake build`` - builds the gem to pkg directory. 
+  * ``sudo rake install`` - If this fails with "mkmf.rb can't find header files for ruby at /usr/lib/ruby/include/ruby.h" you may want to ``sudo aptitude install ruby-dev``
+  * Now can locally and manually use/test the gem. This should not be replacement for automated testing. 
+  * ``rake release`` - creates a version tag in git and pushes the code to github + Rubygems. After this is succesfull the new version appears as release in Github and RubyGems.
+
+alternative way using ``gem`` command
+
+    gem build rspreadsheet.gemspec
+    sudo gem install rspreadsheet-x.y.z.gem
+    gem push rspreadsheet-x.y.z.gem
+
+

data/GUIDE.md

@@ -8,42 +8,43 @@ require 'rspreadsheet'
 book = Rspreadsheet.new
 sheet = book.create_worksheet 'Top icecreams'
 
-sheet[0,0] = 'My top 5'
-p sheet[0,0].class           # => String
-p sheet[0,0]                 # => "My top 5"
+sheet[1,1] = 'My top 5'
+p sheet[1,1].class           # => String
+p sheet[1,1]                 # => "My top 5"
 
 # These are all the same values - alternative syntax
 p sheet.A1
-p sheet[0,0]
-p sheet.cells[0,0].value
-p sheet.rows[0].cells[0].value   
+p sheet[1,1]
+p sheet.cells(0,0).value
+p sheet.rows(0).cells(0).value   
 
 # How to inspect/manipulate the Cell object
-sheet.cells[0,0]            # => Rspreadsheet::Cell
-sheet.cells[0,0].format
-sheet.cells[0,0].format.size = 15
-sheet.cells[0,0].format.weight = bold
-p sheet.cells[0,0].format.bold?  # => true
+sheet.cells(1,1)            # => Rspreadsheet::Cell
+sheet.cells(1,1).format
+sheet.cells(1,1).format.size = 15
+sheet.cells(1,1).format.weight = bold
+p sheet.cells(1,1).format.bold?  # => true
 
 # There are the same assigmenents
 sheet.A1 = value
-sheet[0,0]= value
-sheet.cells[0,0].value = value
+sheet[1,1]= value
+sheet.cells(1,1).value = value
 
 p sheet.A1.class          # => Rspreadsheet::Cell
 
-# build the top ten list
-(1..5).each { |i| sheet[i,0] = i }
-sheet.columns[0].format.bold = true
-sheet.cells[1,1..5] = ['Vanilla', 'Pistacia', 'Chocolate', 'Annanas', 'Strawbery']
+# build the top five list
+(1..5).each { |i| sheet[i,1] = i }
+sheet.columns(1).format.bold = true
+sheet.cells[2,1..5] = ['Vanilla', 'Pistacia', 'Chocolate', 'Annanas', 'Strawbery']
 
-sheet.columns[1][1..3].format.color = :red
+sheet.columns(1).cells(1).format.color = :red
 
 book.save
 
 ```
 ## Conventions
-  * with numeric coordinates row always comes before col as in  [row,col]
+  * all coordinates and arrays are 1-based (spreadsheet world is 1-based, ruby is 0-based do I had to make a decision. I intend to make an global option for this, but in early stage I need to keep things simple. 
+  * with numeric coordinates row always comes before col as in  (row,col)
   * with alphanumerical col always comes before row as in F12
-  * Shorter syntax worksheet[x,y] returns value, longer syntax worksheet.cells[x,y] return cell objects. This allows to work conviniently with values using short syntax and access the cell object if needed (for formatting for example).
+  * Shorter syntax worksheet[x,y] returns value, longer syntax worksheet.cells(x,y) return cell objects. This allows to work conviniently with values using short syntax and access the cell object if needed (for formatting for example).
 

data/README.md

@@ -6,7 +6,9 @@ Manipulating spreadsheets with Ruby. Read, modify, write or create new OpenDocum
 
 ## Contibutions, ideas and wishes welcomed
 
-Please submit issues and/or fork the repository if you have more ideas, wishes, etc ... If you find a bug you are welcomed to submit a pull request preferably including the failing test.
+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.
+
+**Beware: this gem is still in alpha stage (however I use it and it works for what I need).** Currently I am experimenting with syntax to get the feeling what could be the best.
  
 ## Examples of usage
   
@@ -41,7 +43,7 @@ Add this line to your application's Gemfile:
 
     gem 'rspreadsheet'
 
-And then execute:
+And then execute (if this fails install bundle gem):
 
     $ bundle
 

data/lib/rspreadsheet/cell.rb

@@ -40,6 +40,13 @@ class Cell
     @value=avalue
     self
   end
+  def xml
+    self.source_node.to_s
+  end
+  def value_xml
+#     self.source_node.children.first.to_s
+    self.source_node.children.first.children.first.to_s
+  end
   def coordinates
     [row,col]
   end

data/lib/rspreadsheet/row.rb

@@ -8,22 +8,9 @@ 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]
+  def cells(coli)
+    @workbook.cells(@rowi,coli)
   end
 end
 

data/lib/rspreadsheet/tools.rb

@@ -0,0 +1,32 @@
+module Rspreadsheet
+
+# this module contains methods used bz several objects
+module Tools
+  # converts cell adress like 'F12' to pair od integers [row,col]
+  def self.convert_cell_address(*coords)
+    if coords.length == 1
+      coords[0].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-64)+(colname[-2].ord-64)*26+(colname[-3].ord-64)*26*26
+    row = rowname.to_i
+    return [row,col]
+  end
+  
+  # this object represents array which can contain repeated values
+  # inspired valuely by http://www-users.cs.umn.edu/~saad/software/SPARSKIT/paper.ps 
+  class SparseRepeatedArray < Array
+    
+  
+  end
+end
+ 
+end

data/lib/rspreadsheet/version.rb

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

data/lib/rspreadsheet/worksheet.rb

@@ -1,69 +1,64 @@
 require 'rspreadsheet/row'
+require 'rspreadsheet/tools'
 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_delegators :nonemptycells
 
   def initialize(source_node=nil)
     @source_node = source_node
-    @worksheetcells=WorksheetCells.new
-    rowi = 0
+    ## initialize cells
+    @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
+    rowi = 1
     unless @source_node.nil?
       @source_node.elements.select{ |node| node.name == 'table-row'}.each do |row_source_node|
-        coli = 0
+        coli = 1
         row_source_node.elements.select{ |node| node.name == 'table-cell'}.each do |cell_source_node|
-          cells.initialize_cell(rowi,coli,cell_source_node)
+          initialize_cell(rowi,coli,cell_source_node)
           coli += 1
         end
         rowi += 1
       end
     end
+    ## initialize rows
+    @spredsheetrows=Array.new()
+  end
+  def initialize_cell(r,c,source_node)
+    @cells[[r,c]]=Cell.new(r,c,source_node)
+  end
+  def cells(r,c)
+    @cells[[r,c]]
+  end
+  def nonemptycells
+    @cells.values
   end
-  def cells
-    @worksheetcells
+  def rows(rowi)
+    @spredsheetrows[rowi] ||= Row.new(self,rowi)
   end
+  ## syntactic sugar follows
   def [](r,c)
-    cells[r,c].value
+    cells(r,c).value
   end
   def []=(r,c,avalue)
-    cells[r,c].value=avalue
-  end
-  def rows
-    WorksheetRows.new(self)
+    cells(r,c).value=avalue
   end
+  # allows syntax like sheet.F15
   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])
+      row,col = Rspreadsheet::Tools.convert_cell_address($~[1],$~[2])
       assignchar = $~[3]
       if assignchar == '='
-        self.cells[row,col].value = args.first
+        self.cells(row,col).value = args.first
       else
-        self.cells[row,col].value
+        self.cells(row,col).value
       end
     else
       super
@@ -71,42 +66,4 @@ class Worksheet
   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/spec/rspreadsheet_spec.rb

@@ -2,6 +2,27 @@ require 'spec_helper'
 
 $test_filename = './spec/testfile1.ods'
 
+describe Rspreadsheet::Tools do
+  it '=Converts correctly cell adresses' do
+    Rspreadsheet::Tools.convert_cell_address('A1') [0].should == 1
+    Rspreadsheet::Tools.convert_cell_address('A1')[1].should == 1
+    Rspreadsheet::Tools.convert_cell_address('C5')[0].should == 5
+    Rspreadsheet::Tools.convert_cell_address('C5')[1].should == 3
+  end
+end
+
+describe Rspreadsheet::Tools::SparseRepeatedArray do
+  before do
+#     @a = Rspreadsheet::Tools::SparseRepeatedArray.new()
+  end
+#   Float::INFINITY
+  its 'set values can be read back unchanged' do
+    pending
+    @a[3..5]='test'
+    @a[4].should == 'test'
+  end
+end
+
 describe Rspreadsheet do
   it 'can open ods testfile and reads its content correctly' do
     book = Rspreadsheet.new($test_filename)
@@ -9,10 +30,10 @@ describe Rspreadsheet do
     book.worksheets[0].class.should == Rspreadsheet::Worksheet
     s = book.worksheets[0]
     (1..10).each do |i|
-      s[i-1,0].should === i
+      s[i,1].should === i
     end
-    s[0,1].should === 'text'
-    s[1,1].should === Date.new(2014,1,1)
+    s[1,2].should === 'text'
+    s[2,2].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
@@ -48,9 +69,9 @@ describe Rspreadsheet 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.worksheets[0][1,1].should_not == 'xyzxyz'
+    book.worksheets[0][1,1]='xyzxyz'
+    book.worksheets[0][1,1].should == 'xyzxyz'
     book.save(tmp_filename)                    # and save it as temp file
     
     # now compare them
@@ -80,52 +101,61 @@ describe Rspreadsheet::Cell do
     @sheet2 = book2.worksheets[0]
   end
   it 'contains good row and col coordinates' do
-    @cell = @sheet1.cells[1,3]
+    @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 = @sheet2.cells(7,2)
+    @cell.row.should == 7
+    @cell.col.should == 2
+    @cell.coordinates.should == [7,2]
+  end
+  it 'can be referenced by more vars and both are synchronized' do
+    @cell = @sheet1.cells(1,1)
+    @sheet1[1,1] = 'novinka'
     @cell.value.should == 'novinka'
   end
-  it 'can be modyfied by more ways and all are identical' do
-    @cell = @sheet1.cells[2,2]
+  it 'can be modified 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'
+    @sheet1.cells(2,2).value = 'zadruhe'
     @cell.value.should == 'zadruhe'
-    @sheet1.C3 = 'zatreti'
+    @sheet1.B2 = 'zatreti'
     @cell.value.should == 'zatreti'
   end
+  it 'can include links' do
+    @sheet2.A12.should == '[http://example.org/]'
+  end
+  it 'contains good row and col coordinates even after table:number-columns-repeated cells' do
+    pending
+    @cell = @sheet2.cells(13,5)
+    @cell.value.should == 'afterrepeated'
+    @cell.row.should == 13
+    @cell.col.should == 5
+  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'
+    @sheet[1,1].should == nil
+    @sheet[1,1] = 'test text'
+    @sheet[1,1].class.should == String
+    @sheet[1,1].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'
+    @sheet[1,1] = 'test text'
+    @sheet[1,1].should == 'test text'
+    @sheet.cells(1,1).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
+    @sheet.cells(1,1).value = 'test text'
+    @sheet.cells(1,1).class.should == Rspreadsheet::Cell
   end
   it 'has name, which can be changed and is remembered' do
     @sheet.name.should be(nil)
@@ -144,11 +174,9 @@ describe Rspreadsheet::Row do
   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 
+      a = @sheet1.rows(7)
+      c = a.cells(i)
+      c.value.should == i 
     }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Jakub A.Těšínský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -175,6 +175,7 @@ files:
 - lib/rspreadsheet/cell.rb
 - lib/rspreadsheet/empty_file_template.ods
 - lib/rspreadsheet/row.rb
+- lib/rspreadsheet/tools.rb
 - lib/rspreadsheet/version.rb
 - lib/rspreadsheet/workbook.rb
 - lib/rspreadsheet/worksheet.rb