rubyexcel 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 936bd8860beb086b6066d2221d910730e6b1c7d6
-  data.tar.gz: be5e2a1ed1f5c2fea3229621ee92bc650aab6db2
+  metadata.gz: f035e4c22e84db021bc6552a241b2d21ccffb85f
+  data.tar.gz: 65b7f9a3afc852a6de257dae02a1a441b8118177
 SHA512:
-  metadata.gz: 09f390f15338d999b1611890cf83afc7edc5c1e17b684b8406f26d19ef6d8ebb1d23509098eeb584fb8ea07fba38ae05ae37dd827454d039c3003c4ba40f7bdd
-  data.tar.gz: 92209b9dd520c03d3785a7090ae1a887985606fd9146772e3cad71edee663ed965000fa1de60d5df78dc0ab2c05cd61ef3a3eb46df7890c7ee9978c8791e7ca8
+  metadata.gz: 4b39e0df6ab2591a899252e8c1782dd6142241eabe7d199d2705c42bc3e02682fbcb7a72576666c09cffeda1c58ee6da1a005739219eed19a33d3586ed9f0c21
+  data.tar.gz: 3cbd1db9522e89b233b4b6856fd78a0a5b7d150a52c8f8396e6797c323a30293f799cded9869b40a48c8cee0dd32e6cdc580d18b4a34ea3fc4288971754994e7

data/README.md

@@ -39,7 +39,7 @@ Typical usage:
 About
 -----
 
-This gem is designed as a way to conveniently edit table data before outputting it to Excel (XLSX) or TSV format (which Excel can interpret).
+This gem is designed as a way to conveniently edit table data before outputting it to a variety of formats which Excel can interpret, including WIN32OLE Excel Workbooks.
 It attempts to take as much as possible from Excel's API while providing some of the best bits of Ruby ( e.g. Enumerators, Blocks, Regexp ).
 An important feature is allowing reference to Columns via their Headers for convenience and enhanced code readability.
 As this works directly on the data, processing is faster than using Excel itself.
@@ -130,8 +130,16 @@ s.range( '1:2' ) #=> Range (Rows)
 s.range( 'A1', 'B3' ) #=> Range
 s.range( s.cell( 1, 1 ), s.cell( 3, 2 ) ) #=> Range
 s.row( 1 ) #=> Row
+s.row(1)[1] #=> Value
+s.row(1)[1, 2] #=> Array
+s.row(1)['A', 2] #=> Array
+s.row(1)[1..2] #=> Array
+s.row(1)['A'..'B'] #=> Array
 s.column( 'A' ) #=> Column
 s.column( 1 ) #=> Column
+s.column(1)[1] #=> Value
+s.column(1)[1, 2] #=> Array
+s.column(1)[1..2] #=> Array
 ```
 
 Using headers to reference the data
@@ -403,6 +411,30 @@ Row / Column (Section)
 row = s.row(2)
 col = s.column('B')
 
+#Read a value
+row[1] #=> "Type1"
+row['A'] #=> "Type1"
+col[1] #=> "Ref1"
+
+#Read multiple values
+row[1..2] #=> ["Type1", "QT1"]
+row[1, 2] #=> ["Type1", "QT1"]
+row['A', 2] #=> ["Type1", "QT1"]
+col[1..2] #=> ["Ref1", "QT1"]
+col[1, 2] #=> ["Ref1", "QT1"]
+
+#Write a value
+row[1] = "Type1"
+row['A'] = "Type1"
+col[1] = "Ref1"
+
+#Write multiple values
+row[1..2] = "Type1", "QT1"
+row[1, 2] = "Type1", "QT1"
+row['A', 2] = "Type1", "QT1"
+col[1..2] = "Ref1", "QT1"
+col[1, 2] = "Ref1", "QT1"
+
 =begin
 Append a value
 Note: Only extends the data boundaries when at the first row or column.

data/lib/rubyexcel/address.rb

@@ -49,10 +49,10 @@ module RubyExcel
     # @return [String] the column letter
     #
   
-    def col_letter( index )
+    def col_letter( index, start='A' )
       return index if index.is_a? String
       index > 0 or fail ArgumentError, 'Indexing is 1-based'
-      a = 'A'; ( index - 1 ).times { a.next! }; a
+      a = start.dup; ( index - 1 ).times { a.next! }; a
     end
   
     #
@@ -141,6 +141,34 @@ module RubyExcel
       ( col_letter( address_to_col_index( address ) + col ) ) + ( row_id( address ) + row ).to_s
     end
     
+    #
+    # Translates an address to a row id
+    #
+    # @param [String] address the address to translate
+    # @return [Fixnum] the row id
+    #
+    
+    def row_id( address )
+      address[/\d+/].to_i
+    end
+    
+    #
+    # Step an index forward for an Array-style slice
+    #
+    # @param [Fixnum, String] start the index to start at
+    # @param [Fixnum] slice the amount to advance to (1 means keep the same index)
+    #
+    
+    def step_index( start, slice )
+      if start.is_a?( Fixnum )
+        start + slice - 1
+      else
+        x = start.dup
+        ( slice - 1 ).times { x.next! }
+        x
+      end
+    end
+    
     #
     # Translates two objects to a range address
     #
@@ -154,18 +182,7 @@ module RubyExcel
       addr << ':' + ( obj2.respond_to?( :address ) ? obj2.address : obj2.to_s ) if obj2
       addr
     end
-    
-    #
-    # Translates an address to a row id
-    #
-    # @param [String] address the address to translate
-    # @return [Fixnum] the row id
-    #
-    
-    def row_id( address )
-      address[/\d+/].to_i
-    end
-    
-  end
-  
+
+  end    
+
 end

data/lib/rubyexcel/data.rb

@@ -343,6 +343,7 @@ require_relative 'address.rb'
     
     def read( addr )
       row_idx, col_idx = address_to_indices( addr )
+      return nil if row_idx > rows
       @data[ row_idx-1 ][ col_idx-1 ]
     end
     alias [] read

data/lib/rubyexcel/section.rb

@@ -148,11 +148,20 @@ module RubyExcel
     #
     # Read a value by address
     #
-    # @param [String, Fixnum] id the index or reference of the required value
+    # @param [String, Fixnum, ::Range] start an index or Range of indices.
+    # @param [Fixnum] slice if the first argument is an index, how many cells to read.
     #
   
-    def read( id )
-      data[ translate_address( id ) ]
+    def read( start, slice=nil )
+      if slice
+        ( start..( step_index( start, slice ) ) ).map { |n| data[ translate_address( n ) ] }
+      else
+        if start.is_a?( ::Range ) # Standard Ruby Range
+          start.map { |n| data[ translate_address( n ) ] }
+        else # Single value
+          data[ translate_address( start ) ]
+        end
+      end
     end
     alias [] read
     
@@ -178,17 +187,24 @@ module RubyExcel
     #
     # Write a value by address
     #
-    # @param [String, Fixnum] id the index or reference to write to
-    # @param [Object] val the object to place at the address
+    # @param [Array<String, Fixnum, ::Range, Object>] args the address to write the data to, and the data to write.
     #
     
-    def write( id, val )
-      
-      data[ translate_address( id ) ] = val
+    def write( *args )
+      val = args.pop
+      if args.length == 1
+        if args[0].is_a?( ::Range ) # Standard Ruby Range
+          sheet.range( to_range_address( translate_address( args[0].first ), translate_address( args[0].last ) ) ).value = val
+        else # Single value
+          data[ translate_address( args[0] ) ] = val
+        end
+      else # Slice
+        sheet.range( to_range_address( translate_address( args[0] ), translate_address( step_index( args[0], args[1] ) ) ) ).value = val
+      end
     end
     alias []= write
 
-  end
+  end # Section
 
   #
   # A Row in the Sheet
@@ -296,7 +312,7 @@ module RubyExcel
       col_letter( addr ) + idx.to_s
     end
     
-  end
+  end # Row
 
   #
   # A Column in the Sheet
@@ -356,6 +372,6 @@ module RubyExcel
       idx + addr
     end
     
-  end
+  end # Column
 
-end
+end # RubyExcel

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyexcel
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Joel Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies: []
 description: A tabular data structure in Ruby, with header-based helper methods for
   analysis and editing, and some of Excel's API style. Can output as 2D Array, HTML,