rubyexcel 0.1.1 → 0.1.2

data/lib/README.md

@@ -93,11 +93,10 @@ wb = s.parent
 ```
 
 Using the Mechanize gem to get data
+--------
 
 This example is for context, there are many potential data sources
 
---------
-
 ```ruby
 s = RubyExcel::Workbook.new.load( CSV.parse( Mechanize.new.get('http://example.com/myfile.csv').content ) )
 ```
@@ -134,8 +133,6 @@ s.column( 1 ) #=> Column
 Some Examples
 ========
 
-This list may be removed in favour of the gem's documentation on rubydoc.
-
 Common Operations
 --------
 
@@ -143,10 +140,16 @@ Common Operations
 #Append a Column by adding a header
 s << 'Numbers'
 x = 1
+
 #Iterate through the rest of the rows while appending data
 s.rows(2) { |row| row << x; x+=1 }
 
+#
+
+#Split the data into multiple sheets by part number
+wb = s.split( 'Part' )
 
+#Will add more examples here later.
 
 ```
 
@@ -273,7 +276,7 @@ s.maxcol #=> 5
 s.columns.count #=> 5
 
 #Partition the sheet into two, given a header and a block (like Filter)
-#Note: this keeps the headers intact in both outputs sheets
+#Note: this keeps the headers intact in both output sheets
 type_1_and_3, other = s.partition( 'Part' ) { |value| value =~ /Type[13]/ }
 type_1_and_3, other = s.partition( 'Part', &/Type[13]/ )
 
@@ -285,6 +288,10 @@ s.reverse_columns!
 s.sort! { |r1,r2| r1['A'] <=> r2['A'] }
 s.sort_by! { |r| r['A'] }
 
+#Split a Sheet into a Workbook of Sheets by a column (selected by header)
+wb = s.split( 'Part' )
+#=> <Workbook: [Sheet:Type1, Sheet:Type2, Sheet:Type3, Sheet:Type4]>
+
 #Sum all elements in a column by criteria in another column (selected by header)
 #Parameters: Header to pass to the block, Header to sum, Block.
 #Note: Now also accepts Column objects in place of headers.

data/lib/rubyexcel/data.rb

@@ -35,6 +35,26 @@ require_relative 'address.rb'
       @data = input_data.dup
       calc_dimensions
     end
+
+    #
+    # Append an object to Data
+    #
+    # @param [Object] other the data to append
+    # @return [self]
+    #    
+    
+    def <<( other )
+      case other
+      when Array  ; multi_array?( other ) ? @data += other : @data << other
+      when Hash   ; @data += _convert_hash( other )
+      when Sheet  ; empty? ? @data = other.data.all.dup : @data += other.data.dup.no_headers
+      when Row    ; @data << other.to_a.dup
+      when Column ; @data.map!.with_index { |row, i| row << other[ i+1 ] }
+      else        ; @data[0] << other
+      end
+      calc_dimensions
+      self
+    end
     
     # @overload advanced_filter!( header, comparison_operator, search_criteria, ... )
     #   Filter on multiple criteria
@@ -239,7 +259,8 @@ require_relative 'address.rb'
     #
     
     def headers
-      sheet.header_rows > 0 ? @data[ 0..sheet.header_rows-1 ] : nil
+      return nil if sheet.header_rows.nil? || sheet.header_rows.zero?
+       @data[ 0..sheet.header_rows-1 ]
     end
     
     #
@@ -285,6 +306,7 @@ require_relative 'address.rb'
     #
     
     def no_headers
+      return @data unless sheet.header_rows
       @data[ sheet.header_rows..-1 ]
     end
     
@@ -399,6 +421,14 @@ require_relative 'address.rb'
       @data = @data.map { |ar| ar.length == cols ? ar : ar + Array.new( cols - ar.length, nil) }
     end
     
+    def _convert_hash(h)
+      _hash_to_a(h).each_slice(2).map { |a1,a2| a1 << a2.last }
+    end
+    
+    def _hash_to_a(h)
+      h.map { |k,v| v.is_a?(Hash) ? _hash_to_a(v).map { |val| ([ k ] + [ val ]).flatten(1) } : [ k, v ] }.flatten(1)
+    end
+    
   end
 
 end

data/lib/rubyexcel/section.rb

@@ -142,6 +142,15 @@ module RubyExcel
       return to_enum( :map! ) unless block_given?
       each_address { |addr| data[addr] = ( yield data[addr] ) }
     end
+    
+    #
+    # Replaces each value with the result of the block, skipping headers
+    #
+  
+    def map_without_headers!
+      return to_enum( :map_without_headers! ) unless block_given?
+      each_address_without_headers { |addr| data[addr] = ( yield data[addr] ) }
+    end
   
     #
     # Read a value by address

data/lib/rubyexcel.rb

@@ -285,21 +285,16 @@ module RubyExcel
     end
     
     #
-    # Append data to the Sheet
+    # Append an object to the Sheet
     #
-    # @param [Array<Array>, Hash<Hash>, RubyExcel::Sheet] other the data to append
+    # @param [Object] other the object to append
     # @return [self]
     # @note When adding another Sheet it won't import the headers unless this Sheet is empty.
-    # @note Anything other than an an Array, Hash, or Sheet will be appended to the first row
+    # @note Anything other than an an Array, Hash, Row, Column or Sheet will be appended to the first row
     #
     
     def <<( other )
-      case other
-      when Array ; load( data.all + other, header_rows )
-      when Hash  ; load( data.all + _convert_hash( other ), header_rows )
-      when Sheet ; empty? ? load( other.to_a, other.header_rows ) : load( data.all + other.data.no_headers, header_rows )
-      else       ; row(1) << other
-      end
+      data << other
       self
     end
     
@@ -675,16 +670,37 @@ module RubyExcel
     
     # {Sheet#sort_by!}
     
-    def sort_by( &block )
-      dup.sort_by!( &block )
+    def sort_by( header )
+      dup.sort_by!( header )
     end
     
     #
-    # Sort the data by the block value (avoiding headers)
+    # Sort the data by a column, selected by header
+    #
+    # @param [String] header the header to sort the Sheet by
     #
     
-    def sort_by!( &block )
-      data.sort_by!( &block ); self
+    def sort_by!( header )
+      idx = data.index_by_header( header ) - 1
+      sort_method = lambda { |array| array[idx] }
+      data.sort_by!( &sort_method )
+      self
+    end
+    
+    #
+    # Break the Sheet into a Workbook with multiple Sheets, split by the values under a header.
+    #
+    # @param [String] header the header to split by
+    # @return [RubyExcel::Workbook] a new workbook containing the split Sheets (each with headers)
+    #
+    
+    def split( header )
+      wb = Workbook.new
+      ch( header ).each_wh.to_a.uniq.each { |name| wb.add( name ).load( data.headers ) }
+      rows( header_rows+1 ) do |row|
+        wb.sheets( row.val( header ) ) << row
+      end
+      wb
     end
     
     #
@@ -775,16 +791,6 @@ module RubyExcel
       return_col[ row_id( find_col.find( &block ) ) ] rescue nil
     end
     
-    private
-    
-    def _hash_to_a(h)
-      h.map { |k,v| v.is_a?(Hash) ? _hash_to_a(v).map { |val| ([ k ] + [ val ]).flatten(1) } : [ k, v ] }.flatten(1)
-    end
-
-    def _convert_hash(h)
-      _hash_to_a(h).each_slice(2).map { |a1,a2| a1 << a2.last }
-    end
-
   end # Sheet
   
 end # RubyExcel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyexcel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies: []
-description: A tabular data structure, mixing Ruby with some of Excel's API style.
+description: A tabular data structure in Ruby, with header-based helper methods and
+  some of Excel's API style.
 email: VirtuosoJoel@gmail.com
 executables: []
 extensions: []