rubyexcel 0.0.7 → 0.0.8

data/lib/README.md

@@ -1,9 +1,9 @@
 RubyExcel
 =========
 
-Designed for Windows with MS Excel
+Designed for Ruby on Windows with MS Excel
 
-**Still under construction! Bugs are inevitable.**
+Please feel free to log any bugs you find at [GitHub](https://github.com/VirtuosoJoel/RubyExcel/issues "Bug Tracker")
 
 Introduction
 ------------
@@ -97,6 +97,7 @@ Reference a cell's value
 
 ```ruby
 s['A7']
+s.A7
 s.cell(7,1).value
 s.range('A7').value
 s.row(7)['A']
@@ -111,6 +112,8 @@ Reference a group of cells
 ```ruby
 s['A1:B3'] #=> Array
 s.range( 'A1:B3' ) #=> Element
+s.range( 'A:A' ) #=> Element (Column)
+s.range( '1:2' ) #=> Element (Rows)
 s.range( 'A1', 'B3' ) #=> Element
 s.range( s.cell( 1, 1 ), s.cell( 3, 2 ) ) #=> Element
 s.row( 1 ) #=> Row
@@ -118,9 +121,11 @@ s.column( 'A' ) #=> Column
 s.column( 1 ) #=> Column
 ```
 
-Detailed Interactions
+Some Examples
 ========
 
+This list may be removed in favour of the gem's documentation on rubydoc.
+
 Workbook
 --------
 
@@ -561,10 +566,6 @@ s.parent.save_excel( 'Output.xlsx' )
 Todo List
 =========
 
-- Allow argument overloading for methods like filter to avoid repetition and increase efficiency.
-
-- Add support for Range notations like "A:A" and "A:B"
-
 - Write TestCases (after learning how to do it)
 
 - Find bugs and extirpate them.

data/lib/rubyexcel.rb

@@ -300,6 +300,32 @@ module RubyExcel
       self
     end
     
+    # {Sheet#advanced_filter!}
+    
+    def advanced_filter( *args )
+      dup.advanced_filter!( *args )
+    end
+
+    # @overload advanced_filter!( header, comparison_operator, search_criteria, ... )
+    #   Filter on multiple criteria
+    #
+    # @example Filter to 'Part': 'Type1' and 'Type3', with Qty greater than 1
+    #   s.advanced_filter!( 'Part', :=~, /Type[13]/, 'Qty', :>, 1 )
+    #
+    # @example Filter to 'Part': 'Type1', with 'Ref2' containing 'X'
+    #   s.advanced_filter!( 'Part', :==, 'Type1', 'Ref2', :include?, 'X' )
+    #
+    #   @param [String] header a header to search under
+    #   @param [Symbol] comparison_operator the operator to compare with
+    #   @param [Object] search_criteria the value to filter by
+    #   @raise [ArgumentError] 'Number of arguments must be a multiple of 3'
+    #   @raise [ArgumentError] 'Operator must be a symbol'
+    #
+    
+    def advanced_filter!( *args )
+      data.advanced_filter!( *args ); self
+    end
+    
     #
     # Access an Element by indices.
     #
@@ -432,6 +458,7 @@ module RubyExcel
     # @yield [Object] the value at the intersection of Column and Row
     # @return [self]
     #
+    
     def filter!( header, &block )
       data.filter!( header, &block ); self
     end
@@ -528,6 +555,35 @@ module RubyExcel
     end
     alias maxcolumn maxcol
     
+    #
+    # Allow shorthand range references
+    #
+    
+    def method_missing(m, *args, &block)
+      method_name = m.to_s.upcase.strip
+      if method_name =~ /\A[A-Z]{1,3}\d+=?\z/
+        if method_name[-1] == '='
+          range( method_name.chop ).value = ( args.length == 1 ? args.first : args )
+        else
+          range( method_name ).value
+        end
+      else
+        super
+      end
+    end
+    
+    #
+    # Allow for certain method_missing calls
+    #
+    
+    def respond_to?(meth)
+      if meth.to_s.upcase.strip =~ /\A[A-Z]{1,3}\d+=?\z/
+        true
+      else
+        super
+      end
+    end
+    
     #
     # Split the Sheet into two Sheets by evaluating each value in a column
     #
@@ -549,6 +605,8 @@ module RubyExcel
     # @note These are all valid arguments:
     #   ('A1') 
     #   ('A1:B2') 
+    #   ('A:A')
+    #   ('1:1')
     #   ('A1', 'B2') 
     #   (cell1) 
     #   (cell1, cell2) 
@@ -563,7 +621,7 @@ module RubyExcel
     #
     
     def reverse_columns!
-      data.reverse_columns!
+      data.reverse_columns!; self
     end
     
     #
@@ -571,7 +629,7 @@ module RubyExcel
     #
     
     def reverse_rows!
-      data.reverse_rows!
+      data.reverse_rows!; self
     end
     
     #

data/lib/rubyexcel/address.rb

@@ -75,9 +75,33 @@ module RubyExcel
 
     def expand( address )
       return [[address]] unless address.include? ':'
-      address.upcase.match( /([A-Z]+)(\d+):([A-Z]+)(\d+)/i )
-      start_col, end_col, start_row, end_row = [ $1, $3 ].sort + [ $2.to_i, $4.to_i ].sort
+      
+      #Extract the relevant boundaries
+      case address
+      
+      # Row
+      when /\A(\d+):(\d+)\z/
+      
+        start_col, end_col, start_row, end_row = [ 'A', col_letter( sheet.maxcol ) ] + [ $1.to_i, $2.to_i ].sort
+        
+      # Column
+      when /\A([A-Z]+):([A-Z]+)\z/
+      
+        start_col, end_col, start_row, end_row = [ $1, $2 ].sort + [ 1, sheet.maxrow ]
+        
+      # Range
+      when /([A-Z]+)(\d+):([A-Z]+)(\d+)/
+      
+        start_col, end_col, start_row, end_row = [ $1, $3 ].sort + [ $2.to_i, $4.to_i ].sort
+        
+      # Invalid
+      else
+        fail ArgumentError, 'Invalid address: ' + address
+      end
+      
+      # Return the array of addresses
       ( start_row..end_row ).map { |r| ( start_col..end_col ).map { |c| c + r.to_s } } 
+      
     end
     
     #

data/lib/rubyexcel/data.rb

@@ -34,6 +34,40 @@ require_relative 'address.rb'
       calc_dimensions
     end
     
+    # @overload advanced_filter!( header, comparison_operator, search_criteria, ... )
+    #   Filter on multiple criteria
+    #
+    # @example Filter to 'Part': 'Type1' and 'Type3', with 'Qty' greater than 1
+    #   s.advanced_filter!( 'Part', :=~, /Type[13]/, 'Qty', :>, 1 )
+    #
+    # @example Filter to 'Part': 'Type1', with 'Ref1' containing 'X'
+    #   s.advanced_filter!( 'Part', :==, 'Type1', 'Ref1', :include?, 'X' )
+    #
+    #   @param [String] header a header to search under
+    #   @param [Symbol] comparison_operator the operator to compare with
+    #   @param [Object] search_criteria the value to filter by
+    #   @raise [ArgumentError] 'Number of arguments must be a multiple of 3'
+    #   @raise [ArgumentError] 'Operator must be a symbol'
+    #
+    
+    def advanced_filter!( *args )
+      hrows = sheet.header_rows
+      args.length % 3 == 0 or fail ArgumentError, 'Number of arguments must be a multiple of 3'
+      1.step( args.length - 2, 3 ) { |i| args[i].is_a?( Symbol ) or fail ArgumentError, 'Operator must be a symbol: ' + args[i].to_s }
+      0.step( args.length - 3, 3 ) { |i| index_by_header( args[i] ) }
+      
+      @data = @data.select.with_index do |row, i|
+        if hrows > i
+          true
+        else
+          args.each_slice(3).map do |h, op, crit|
+            row[ index_by_header( h ) - 1 ].send( op, crit )
+          end.all?
+        end
+      end
+      
+    end
+    
     #
     # Returns a copy of the data
     #
@@ -185,12 +219,11 @@ require_relative 'address.rb'
     # @return [self]
     #
 
-    def filter!( header )
+    def filter( header )
       hrows = sheet.header_rows
       idx = index_by_header( header )
       @data = @data.select.with_index { |row, i| hrows > i || yield( row[ idx -1 ] ) }
       calc_dimensions
-      self
     end
   
     #

data/lib/rubyexcel/element.rb

@@ -1,5 +1,9 @@
 module RubyExcel
 
+  #
+  # A Range or Cell in a Sheet
+  #
+
   class Element
     include Address
     include Enumerable
@@ -28,7 +32,7 @@ module RubyExcel
     #
     
     def initialize( sheet, addr )
-      fail ArgumentError, "Invalid range: #{ addr }" unless addr =~ /\A[A-Z]+\d+:[A-Z]+\d+\z|\A[A-Z]+\d+\z/
+      fail ArgumentError, "Invalid range: #{ addr }" unless addr =~ /\A[A-Z]{1,3}\d+:[A-Z]{1,3}\d+\z|\A[A-Z]{1,3}\d+\z|\A[A-Z]{1,3}:[A-Z]{1,3}\z|\A\d+:\d+\z/
       @sheet = sheet
       @data = sheet.data
       @address = addr
@@ -41,7 +45,7 @@ module RubyExcel
     #
   
     def delete
-      data.delete( self )
+      data.delete( self ); self
     end
     
     #

data/lib/rubyexcel/section.rb

@@ -55,7 +55,7 @@ module RubyExcel
     #
   
     def delete
-      data.delete( self )
+      data.delete( self ); self
     end
   
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyexcel
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies: []
 description: A tabular data structure, mixing Ruby with some of Excel's API style.
 email: VirtuosoJoel@gmail.com