rspreadsheet 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b2c92247a04812100d02a3145ee69d112aa434b6ea2365c6f416a7be5d399eef
-  data.tar.gz: 728f3fb25da67aa9cd4b31f5d1ddec687b9ddc7bc749f6baefe4bb926048b2ca
+SHA1:
+  metadata.gz: e7334a14b9121a8cfefe62a271f865b0be259f32
+  data.tar.gz: b76797efc38071ebc4d2120eb051e220f45e3657
 SHA512:
-  metadata.gz: 73dc5875e271ff2fd0e67997ced78078538147d8beeec3c2d61e3eb2bcde0f60a3b80a758f1e1e396c76347fea2bfe1d1db0a727c13d75f8e01218291010a5b3
-  data.tar.gz: 637a92a312e621f4482499bfb27235ffcdb57e8a936834b7f492024b67284a8b89884429c6eaf40cb94a67b523a6b52f7b4479c6d1f672e649635c5ec551ef89
+  metadata.gz: 456b8b7240c21d4bcc6c4faa82775c46310517e26e7051025ddfb852bceff1375860d7c2b350e36fd92c183ba8019228d8e7ba2db7319d581a61f95b91118118
+  data.tar.gz: a28c423ecb3a1e9b8644a7dfcf6c6f063a817d9a710edb80388a050e0738b0dd421783ab940987023725223af8d618df3753537b89c98478c169cf3da78e1f14

data/GUIDE.md

@@ -43,6 +43,9 @@ workbook.save(any_io_object)        # file can be saved to any IO like object as
 ### Date and Time
 OpenDocument and ruby have different models of date, time and datetime. Ruby containg three different objects. Time and DateTime cover all cases, Date covers dates only. OpenDocument distinguishes two groups - time of a day (time) and everything else (date). To simplify things a little we return cell values containg time of day as Time object and cell values containg datetime of date as DateTime. I am aware that this is very arbitrary choice, but it is very practical. This way and to some extend the types of values from OpenDocument are preserved when read from files, beeing acted upon and written back to spreadshhet.
 
+### Merged cells 
+Even when a cell spans more rows and collumns, you must access by coordinates of its topleft corner. In fact, the "hidden" cells under are still there and their content is usually preserved.
+
 
 ## Examples
 

data/lib/helpers/class_extensions.rb

@@ -107,6 +107,10 @@ else # Monkeypatching
       each_element { |e| result << e }
       return result
     end
+    # TODO: posoudit jestli by to nebylo rychlejsi takto
+#     def elements
+#       children.select { |e| e.element? }
+#     end
   end
 
 end

data/lib/rspreadsheet/cell.rb

@@ -33,8 +33,7 @@ class Cell < XMLTiedItem
   attr_reader :rowi
   
   # @!group XMLTiedItem related methods and extensions  
-  def xml_options; {:xml_items_node_name => 'table-cell', :xml_repeated_attribute => 'number-columns-repeated'} end
-  def parent; row end
+  def parent; row end #TODO: otazka zda je treba definovat zde, mozna uz je to v XMLTiedItem osefovano
   def coli; index end
     
   def set_rowi(arowi); @rowi = arowi end # this should ONLY be used by parent row
@@ -65,7 +64,8 @@ class Cell < XMLTiedItem
   end
   def value
     gt = guess_cell_type
-    if (self.mode == :regular) or (self.mode == :repeated)
+    amode = self.mode 
+    if (amode == :regular) or (amode == :repeated)
       case 
         when gt == nil then nil
         when gt == Float then xmlnode.attributes['value'].to_f
@@ -75,10 +75,10 @@ class Cell < XMLTiedItem
         when gt == :percentage then xmlnode.attributes['value'].to_f
         when gt == :currency then xmlnode.attributes['value'].to_d
       end
-    elsif self.mode == :outbound
+    elsif amode == :outbound
       nil
     else
-      raise "Unknown cell mode #{self.mode}"
+      raise "Unknown cell mode #{amode}"
     end
   end
   

data/lib/rspreadsheet/image.rb

@@ -17,7 +17,7 @@ class WorksheetImages
   end
   
   # @!group XMLTiedArray_WithRepeatableItems related methods    
-  def subitem_xml_options; {:xml_items_node_name => 'frame', :xml_items_node_namespace => 'draw'} end
+  def subnode_options; {:node_name => 'frame', :node_namespace => 'draw'} end
   def prepare_subitem(index); Image.new(self,index) end
   def xmlnode; @worksheet.xmlnode.find('./table:shapes').first end
   def prepare_empty_xmlnode
@@ -105,9 +105,6 @@ class Image < XMLTiedItem
     Tools.set_ns_attribute(xml_image_subnode,'xlink','href', value ) 
   end    
     
-  # @!group XMLTiedItem related methods
-  def xml_options; {:xml_items_node_name => 'frame'} end
-
 #    
 # Note: when creating new empty image we might have included xlink:type attribute but specification
 # says it has default value simple [1] so we omit it. The same goes for 

data/lib/rspreadsheet/row.rb

@@ -25,6 +25,14 @@ module Rspreadsheet
 
 class Row < XMLTiedItem
   include XMLTiedArray_WithRepeatableItems
+  # @!group XMLTiedArray_WithRepeatableItems related methods
+  def subnode_options; {
+    :node_name => 'table-cell', 
+    :alt_node_names => ['covered-table-cell'], 
+    :repeated_attribute => 'number-columns-repeated'
+  } end
+  def prepare_subitem(coli); Cell.new(worksheet,rowi,coli) end
+  
   ## @return [Worksheet] worksheet which contains the row
   # @!attribute [r] worksheet
   def worksheet; parent end
@@ -93,7 +101,7 @@ class Row < XMLTiedItem
     if myxmlnode.nil?
       []
     else
-      worksheet.find_nonempty_subnode_indexes(myxmlnode, subitem_xml_options)
+      worksheet.find_nonempty_subnode_indexes(myxmlnode, subnode_options)
     end
   end
   alias :used_range :range
@@ -118,13 +126,6 @@ class Row < XMLTiedItem
     @itemcache.each_value{ |cell| cell.set_rowi(rowi) }
   end
   
- private
-  # @!group XMLTiedArray_WithRepeatableItems related methods
-  def subitem_xml_options; {:xml_items_node_name => 'table-cell', :xml_repeated_attribute => 'number-columns-repeated'} end
-  def prepare_subitem(coli); Cell.new(worksheet,rowi,coli) end
-  # @!group XMLTiedItem related methods and extensions
-  def xml_options; {:xml_items_node_name => 'table-row', :xml_repeated_attribute => 'number-rows-repeated'} end
-
 end
 
 end

data/lib/rspreadsheet/version.rb

@@ -1,3 +1,3 @@
 module Rspreadsheet
-  VERSION = "0.4.8"
+  VERSION = "0.4.9"
 end

data/lib/rspreadsheet/worksheet.rb

@@ -10,7 +10,12 @@ module Rspreadsheet
 class Worksheet
   include XMLTiedArray_WithRepeatableItems
   attr_accessor :xmlnode
-  def subitem_xml_options; {:xml_items_node_name => 'table-row', :xml_repeated_attribute => 'number-rows-repeated'} end
+  # @!group XMLTiedArray related methods
+  def subnode_options; {
+    :node_name => 'table-row', 
+    :ignore_groupings => ['table-header-rows'], 
+    :repeated_attribute => 'number-rows-repeated'
+  } end
 
   def initialize(xmlnode_or_sheet_name,workbook) # workbook is here ONLY because of inserting images - to find unique name - it would be much better if it should bot be there
     initialize_xml_tied_array
@@ -105,7 +110,8 @@ class Worksheet
       when 0 then raise 'Not implemented yet' #TODO: return list of all cells
       when 1..2
         r,c = Rspreadsheet::Tools.a2c(*params)
-        row(r).andand.cell(c)
+        arow = row(r)
+        arow.andand.cell(c)
       else raise ArgumentError.new('Wrong number of arguments.')
     end
   end

data/lib/rspreadsheet/xml_tied_array.rb

@@ -1,4 +1,5 @@
 require 'helpers/class_extensions'
+require 'pry'
 
 module Rspreadsheet
 
@@ -29,20 +30,30 @@ end
 #               of course util you want to insert something. If this may happens, importer must
 #               provide method prepare_empty_xmlnode which prepares (and returns) empty xml node.
 #               It is lazy called, as late as possible.
-#   * subitem_xml_options - returns hash of options used to locate subitems in xml (TODO: rewrite in clear way)
+#   * subnode_options - returns hash of options used to locate subitems in xml with these values
+#     * subnode_options[:node_name] - how the relevant subitems are named (string)
+#     * subnode_options[:alt_node_names] - array of strings of alternative names to :node_name
+#       these are recognized in searching, but never created when creating new node.
+#     * subnode_options[:node_namespace] - namespace of relevant subitems (defaults to table)
+#     * subnode_options[:repeated_attribute] - attribute of elements which tell how many 
+#       times this is repeated (this is only used in XMLTiedArray_WithRepeatableItems)
+#     * subnode_options[:ignore_groupings] - some subnodes can rather be groups of subnodes, these
+#       groups need to be expanded and nodes put out of them 
 #   * intilize must call initialize_xml_tied_array
 #
-# 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.
-#
-# Note for developers:
-# Beware that the implementation of methods needs to be done in a way that it continues to
-# work when items are "repeatable" - see XMLTiedArray_WithRepeatableItems. When impractical or impossible
-# please implement the corresponding method in XMLTiedArray_WithRepeatableItems or at least override it there
-# and make it raise exception.
+#== Notes for developers
+# 
+#   * This class is made to be included.
+#   * Terminology
+#     * item, subitem is object from @itemcache (quite often subclass of XMLTiedItem)
+#     * node, subnode is LibXML::XML::Node object
+#   * usual flow is that when user asks for an item the proxy item object is created (prepare_item) which
+#     only contains index etx, but no values. When the values are needed, it asks its parent to get the xmlnode, it first 
+#     uses xmlsubnodes method to get all sumbodes and then by respecting the repeating finds apropriate node.
+#   * Beware that the implementation of methods needs to be done in a way that it continues to
+#     work when items are "repeatable" - see XMLTiedArray_WithRepeatableItems. When impractical or impossible
+#     please implement the corresponding method in XMLTiedArray_WithRepeatableItems or at least override it there
+#     and make it raise exception.
 # 
 # @private
 module XMLTiedArray
@@ -122,7 +133,7 @@ module XMLTiedArray
   # returns xmlnode with index
   # DOES not respect repeated_attribute
   def my_subnode(aindex)
-    raise 'Using method which does not respect repeated_attribute with options that are using it. You probably donot want to do that.' unless subitem_xml_options[:xml_repeated_attribute].nil?
+    raise 'Using method which does not respect repeated_attribute with options that are using it. You probably donot want to do that.' unless subnode_options[:repeated_attribute].nil?
     return xmlsubnodes[aindex-1]
   end
 
@@ -150,8 +161,8 @@ module XMLTiedArray
  
   def prepare_empty_subnode
     Tools.prepare_ns_node(
-      subitem_xml_options[:xml_items_node_namespace] || 'table',
-      subitem_xml_options[:xml_items_node_name]
+      subnode_options[:node_namespace] || 'table',
+      subnode_options[:node_name]
     )
   end
   
@@ -165,16 +176,45 @@ module XMLTiedArray
   # @!group finding and accessing subnodes
   # array containing subnodes of xmlnode which represent subitems
   def xmlsubnodes
-    return [] if xmlnode.nil?
-    ele = xmlnode.elements
-    return [] if ele.empty?
-    so = subitem_xml_options[:xml_items_node_name]
-    
-    ele.select do |node| 
-      node.andand.name == so
+    axmlnode = self.xmlnode
+    return [] if axmlnode.nil?
+    node_name = subnode_options[:node_name]
+    alt_node_names = subnode_options[:alt_node_names] || []
+    ignore_groupings = subnode_options[:ignore_groupings] || []
+
+    result = []
+    axmlnode.children.each do |node|
+      if ignore_groupings.include?(node.andand.name)
+        node.children.each do |subnode|
+          result << subnode
+        end
+      else
+        result << node
+      end
+    end
+
+    result.select do |node|
+      node.element? &&                        # nejde o textový node 
+      ( (node_name == node.andand.name) ||    # a jde o node s pořadovaným názvem
+        alt_node_names.include?(node.andand.name) )  # nebo s alternativním přípustným názvem
     end
   end
     
 end
 
 end 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/rspreadsheet/xml_tied_item.rb

@@ -14,8 +14,6 @@ using ClassExtensions if RUBY_VERSION > '2.1'
 #      more so subitem can implement parent and index methods.
 
 # @private
-# abstract class. All successors have some options. MUST implement: 
-#   * xml_options
 #
 # If you override intializer make sure you call initialize_xml_tied_item(aparent,aindex).
 # 
@@ -42,9 +40,7 @@ class XMLTiedItem < XMLTied
   def set_index(aindex); @xml_tied_item_index=aindex end
   def index=(aindex); @xml_tied_item_index=aindex end
   
-  # `xml_options[:xml_items_node_name]` gives the name of the tag representing cell
-  # `xml_options[:number-columns-repeated]` gives the name of the previous tag which sais how many times the item is repeated
-  def xml_options; abstract end
+  def name_of_repeated_attribute; parent.subnode_options[:repeated_attribute] end
     
   def initialize_xml_tied_item(aparent,aindex)
     @xml_tied_parent = aparent unless aparent.nil?
@@ -58,7 +54,7 @@ class XMLTiedItem < XMLTied
      else :regular
    end
   end
-  def repeated; (Tools.get_ns_attribute_value(xmlnode, 'table', xml_options[:xml_repeated_attribute]) || 1 ).to_i end
+  def repeated; (Tools.get_ns_attribute_value(xmlnode, 'table', name_of_repeated_attribute) || 1 ).to_i end
   def repeated?; mode==:repeated || mode==:outbound end
   alias :is_repeated? :repeated?
   def xmlnode

data/lib/rspreadsheet/xml_tied_repeatable.rb

@@ -29,10 +29,11 @@ module XMLTiedArray_WithRepeatableItems
   end
 
   def find_subnode_with_range(aindex)
-    options = subitem_xml_options
+    options = subnode_options
     rightindex = 0
-    xmlsubnodes.each do |node|
-      repeated = (node.attributes[options[:xml_repeated_attribute]] || 1).to_i
+    xmlsub = self.xmlsubnodes
+    xmlsub.each do |node|
+      repeated = (node.attributes[options[:repeated_attribute]] || 1).to_i
       leftindex = rightindex + 1 
       rightindex = rightindex+repeated
       if rightindex>= aindex
@@ -50,7 +51,7 @@ module XMLTiedArray_WithRepeatableItems
   
   def insert_new_empty_subnode_before_respect_repeatable(aindex)
     axmlnode = xmlnode
-    options = subitem_xml_options
+    options = subnode_options
     node,index_range = find_subnode_with_range(aindex)
     
     if !node.nil? # found the node, now do the insert
@@ -69,20 +70,20 @@ module XMLTiedArray_WithRepeatableItems
   
   def prepare_repeated_subnode(times_repeated,options)
     result = prepare_empty_subnode
-    Tools.set_ns_attribute(result,'table',options[:xml_repeated_attribute],times_repeated, 1)
+    Tools.set_ns_attribute(result,'table',options[:repeated_attribute],times_repeated, 1)
     result
   end
   
   def clone_before_and_set_repeated_attribute(node,times_repeated,options)
     newnode = node.copy(true)
-    Tools.set_ns_attribute(newnode,'table',options[:xml_repeated_attribute],times_repeated,1)
+    Tools.set_ns_attribute(newnode,'table',options[:repeated_attribute],times_repeated,1)
     node.prev = newnode
   end
   
   # detaches subnode with aindex  
   def detach_my_subnode_respect_repeated(aindex)
     axmlnode = xmlnode
-    options = subitem_xml_options
+    options = subnode_options
     node,index_range = find_subnode_with_range(aindex)
     if index_range.size > 1 # pokud potřebuje vůbec detachovat
       if !node.nil? # detach subnode
@@ -105,14 +106,14 @@ module XMLTiedArray_WithRepeatableItems
   end
   
   def how_many_times_node_is_repeated(node)   # adding respect to repeated nodes
-    (node.attributes[subitem_xml_options[:xml_repeated_attribute]] || 1).to_i
+    (node.attributes[subnode_options[:repeated_attribute]] || 1).to_i
   end
   
   
   # clean up item from xml (handle possible detachments) and itemcache. leave the object invalidation on the object
   # this should not be called from nowhere but XMLTiedItem.delete
   def delete_subitem(aindex)
-#     options = subitem_xml_options
+#     options = subnode_options
     delete_my_subnode_respect_repeated(aindex)  # vymaž node z xml
     @itemcache.delete(aindex)
     @itemcache.keys.sort.select{|i| i>=aindex+1 }.each do |i| 
@@ -132,8 +133,8 @@ module XMLTiedArray_WithRepeatableItems
   def find_nonempty_subnode_indexes(axmlnode, options)
     index = 0
     result = []
-    axmlnode.elements.select{|node| node.name == options[:xml_items_node_name]}.each do |node|
-      repeated = (node.attributes[options[:xml_repeated_attribute]] || 1).to_i
+    axmlnode.elements.select{|node| node.name == options[:node_name]}.each do |node|
+      repeated = (node.attributes[options[:repeated_attribute]] || 1).to_i
       index = index + repeated
       if !(node.content.nil? or node.content.empty? or node.content =='') and (repeated==1)
         result << index

data/reinstall_local_gem.sh

@@ -8,7 +8,7 @@ sudo rm -f Gemfile.lock
 git add .
 
 # builds the gem to pkg directory and installs gem to local system
-sudo rake install
+sudo bundle exec rake install
 
 # Note 1: If the last step 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``

data/spec/cell_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'pry'
 
 describe Rspreadsheet::Cell do
   before do 
@@ -351,4 +352,19 @@ describe Rspreadsheet::Cell do
     inscell = @sheet1.insert_cell_before(2,4) # should not move cells with data
     @sheet1.C2.should == 'test' 
   end
+
+  it 'Does not ignore cells covered by other merged cells (issue 42)' do
+    sheet = Rspreadsheet.new('./spec/testfile-issue-42-43.ods').sheet(1)
+    sheet.C1.should == 'week1'
+    sheet.C2.should == 'week2'
+    sheet.C3.should == 'week3'
+    sheet.C4.should == 'week4'
+    sheet.C7.should == 'week7'        
+  end
+  it 'Does not ignore rows repeated on every page = header rows (issue 43)' do
+    sheet = Rspreadsheet.new('./spec/testfile-issue-42-43.ods').sheet(2)
+    sheet.A1.should == 'Schedule'
+    sheet.B2.should == 'Course'
+    sheet.A3.should == 'Teacher'
+  end
 end

data/spec/xml_tied_spec.rb

@@ -19,7 +19,7 @@ describe Rspreadsheet::XMLTiedArray do
   
   it 'raises when prepare_empty_xmlnode fails in insert_new_empty_subnode_before' do
     class TestXMLTiedArray 
-      def subitem_xml_options; {} end
+      def subnode_options; {} end
       def xmlnode; nil end
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Jakub A.Těšínský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -42,36 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +165,7 @@ files:
 - spec/test-image-blue.png
 - spec/test-image.png
 - spec/testfile-issue-40.ods
+- spec/testfile-issue-42-43.ods
 - spec/testfile1.ods
 - spec/testfile2-images.ods
 - spec/tools_spec.rb
@@ -197,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Manipulating LibreOffice Calc (OpenDocument Spreadsheet) files from Ruby
@@ -217,6 +212,7 @@ test_files:
 - spec/test-image-blue.png
 - spec/test-image.png
 - spec/testfile-issue-40.ods
+- spec/testfile-issue-42-43.ods
 - spec/testfile1.ods
 - spec/testfile2-images.ods
 - spec/tools_spec.rb