spreadbase 0.1.2 → 0.1.3

data/README.md

@@ -53,6 +53,27 @@ Append a row:
 
     table_2.append_row( [ 'Fabrizio F.' ] )
 
+Read a column, or a range of columns:
+
+    table.column( 0 )
+
+    # [ 'Dish', 'Roasted 6502', '8080, with an 8-bit bus', '65000 with side dishes of Copper and Blitter' ]
+
+    table.column( 0 .. 1 )
+
+    # [ [ 'Dish',  'Roasted 6502', '8080, with an 8-bit bus', '65000 with side dishes of Copper and Blitter' ],
+    #   [ 'Price', 38.911,         8,                         512.0                                          ] ]
+
+Read a row, or a range of rows:
+
+    table.row( 1 )
+
+    # [ 'Roasted 6502', 38.911 ]
+
+    table.row( 1 .. 2 )
+
+    # [ [ 'Roasted 6502', 38.911 ], [ '8080, with an 8-bit bus', 8 ] ]
+
 Read a cell:
 
     price_8080 = document.tables[ 0 ][ 1, 2 ]
@@ -101,6 +122,8 @@ Save the document:
 
     document.save
 
+Enjoy many other APIs.
+
 Notes
 -----
 

data/lib/spreadbase/table.rb

@@ -90,7 +90,7 @@ module SpreadBase # :nodoc:
     #
     # _params_:
     #
-    # +row_index+::                  int (0-based). see notes about the rows indexing.
+    # +row_index+::                  int or range (0-based). see notes about the rows indexing.
     #
     def row( row_index )
       check_row_index( row_index )
@@ -104,9 +104,9 @@ module SpreadBase # :nodoc:
     #
     # _params_:
     #
-    # +row_index+::                  int (0-based). see notes about the rows indexing.
+    # +row_index+::                  int or range (0-based). see notes about the rows indexing.
     #
-    # _returns_ the deleted row
+    # _returns_ the deleted row[s]
     #
     def delete_row( row_index )
       check_row_index( row_index )
@@ -141,35 +141,60 @@ module SpreadBase # :nodoc:
     #
     # _params_:
     #
-    # +column_indentifier+::         either an int (0-based) or the excel-format identifier (AA...).
+    # +column_indentifier+::         for single access, us either an int (0-based) or the excel-format identifier (AA...).
     #                                when int, follow the same idea of the rows indexing (ruby semantics).
+    #                                for multiple access, use a range either of int or excel-format identifiers - pay attention, because ( 'A'..'c' ) is not semantically correct.
+    #                                interestingly, ruby letter ranges convention is the same as the excel columns one.
     #
     def column( column_identifier )
-      column_index = decode_column_identifier( column_identifier )
+      if column_identifier.is_a?( Range )
+        min_index = decode_column_identifier( column_identifier.min )
+        max_index = decode_column_identifier( column_identifier.max )
+
+        ( min_index .. max_index ).map do | column_index |
+          @data.map do | row |
+            row[ column_index ]
+          end
+        end
+      else
+        column_index = decode_column_identifier( column_identifier )
 
-      @data.map do | row |
-        row[ column_index ]
+        @data.map do | row |
+          row[ column_index ]
+        end
       end
     end
 
     # Deletes a column.
     #
-    # WATCH OUT! This method doesn't have the range restrictions that axis indexes generally has, that is, it's possible to delete a column outside the boundaries of the rows - it will return nil for each of those values.
+    # See Table#column for the indexing notes.
     #
     # _params_:
     #
-    # +column_indentifier+::         either an int (0-based) or the excel-format identifier (AA...).
-    #                                when int, follow the same idea of the rows indexing (ruby semantics).
+    # +column_indentifier+::         See Table#column
     #
     # _returns_ the deleted column
     #
     def delete_column( column_identifier )
-      column_index = decode_column_identifier( column_identifier )
+      if column_identifier.is_a?( Range )
+        min_index = decode_column_identifier( column_identifier.min )
+        max_index = decode_column_identifier( column_identifier.max )
+
+        reverse_result = max_index.downto( min_index ).map do | column_index |
+          @data.map do | row |
+            row.slice!( column_index )
+          end
+        end
 
-      @column_width_styles.slice!( column_index )
+        reverse_result.reverse
+      else
+        column_index = decode_column_identifier( column_identifier )
 
-      @data.map do | row |
-        row.slice!( column_index )
+        @column_width_styles.slice!( column_index )
+
+        @data.map do | row |
+          row.slice!( column_index )
+        end
       end
     end
 
@@ -226,6 +251,8 @@ module SpreadBase # :nodoc:
 
       positive_limit = allow_append ? @data.size : @data.size - 1
 
+      row_index = row_index.max if row_index.is_a?( Range )
+
       raise "Invalid row index (#{ row_index }) - allowed 0 to #{ positive_limit }" if row_index < 0 || row_index > positive_limit
     end
 

data/lib/spreadbase/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module SpreadBase
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/elements/table_spec.rb

@@ -102,6 +102,15 @@ describe SpreadBase::Table do
     lambda { @sample_table.row( -1 ) }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 2" )
   end
 
+  it "should access a set of rows by range" do
+    @sample_table.row( ( 0 .. 1 ) ).should == [
+      [ 1,      1.1,        T_BIGDECIMAL ],
+      [ T_DATE, T_DATETIME, T_TIME       ],
+    ]
+
+    lambda { @sample_table.row( ( 0 .. 5 ) ) }.should raise_error( RuntimeError, "Invalid row index (5) - allowed 0 to 2" )
+  end
+
   it "should delete a row" do
     @sample_table.delete_row( 1 ).should == [ T_DATE, T_DATETIME, T_TIME ]
 
@@ -113,6 +122,19 @@ describe SpreadBase::Table do
     lambda { @sample_table.delete_row( -1 ) }.should raise_error( RuntimeError, "Invalid row index (-1) - allowed 0 to 1" )
   end
 
+  it "should delete a set of rows by range" do
+    @sample_table.delete_row( ( 0 .. 1 ) ).should == [
+      [ 1,      1.1,        T_BIGDECIMAL ],
+      [ T_DATE, T_DATETIME, T_TIME       ],
+    ]
+
+    @sample_table.data.should == [
+      [ true,   'a',        nil          ]
+    ]
+
+    lambda { @sample_table.delete_row( ( 0 .. 5 ) ) }.should raise_error( RuntimeError, "Invalid row index (5) - allowed 0 to 0" )
+  end
+
   it "should insert a row" do
     @sample_table.insert_row( 1, [ 4, 5, 6 ] )
 
@@ -152,6 +174,18 @@ describe SpreadBase::Table do
     @sample_table.column( 3 ).should == [ nil, nil, nil ]
   end
 
+  it "should access a set of columns by range" do
+    @sample_table.column( ( 0 .. 1 ) ).should == [
+      [ 1,   T_DATE,     true ],
+      [ 1.1, T_DATETIME, 'a'  ],
+    ]
+
+    @sample_table.column( ( 'C' .. 'D' ) ).should == [
+      [ T_BIGDECIMAL, T_TIME, nil ],
+      [ nil,          nil,    nil ],
+    ]
+  end
+
   it "should delete a column" do
     @sample_table.column_width_styles = [ 'abc', nil, 'cde' ]
 
@@ -170,6 +204,19 @@ describe SpreadBase::Table do
     ]
   end
 
+  it "should delete a set of columns by range" do
+    @sample_table.delete_column( ( 0 .. 1 ) ).should == [
+      [ 1,   T_DATE, true ],
+      [ 1.1, T_DATETIME, 'a'  ],
+    ]
+
+    @sample_table.data.should == [
+      [ T_BIGDECIMAL ],
+      [ T_TIME       ],
+      [ nil          ],
+    ]
+  end
+
   it "should insert a column" do
     # Setup/fill table
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreadbase
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zipruby
-  requirement: &18448480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *18448480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18447960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *18447960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 description: Library for reading/writing OpenOffice Calc documents.
 email:
 - saverio.pub2@gmail.com
@@ -82,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Library for reading/writing OpenOffice Calc documents.