excel_to_code 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d2c59c883974dffad372f4ddc7aefd00f1e9847
-  data.tar.gz: 268cb5f552b2e58ac9039321599593cd88811fcb
+  metadata.gz: 17eac22412740a67afd06333f437ce950c03c32d
+  data.tar.gz: 1117fdcb2343478712dc0a72649c429d1b9dc8dd
 SHA512:
-  metadata.gz: 018a1d2825910da4518ebd04328f08638780e6ebbe965b67940bd2f09213cb0783011ce2f34e7039f79a168754fe2a775240f09b703847ddfe6be744ebd0521d
-  data.tar.gz: 72264447d6bc4f05f4f4d8597d41aa6ae10be87b9108ea40747f0690ddac88bcb29358e5ad710b4a478cb79186af6abf277b3599ef649324b68d31ec2acf898c
+  metadata.gz: 5023ee51c9f7a3909c7768ca58da98c368e3bec955a50e67c33df96387e2052e8c3c734f062c894b9102629509582232c7c08d62fd21b9fe718d1f678d6558fa
+  data.tar.gz: e34fd8293696f90562080eeb0f07db35a131d4132883baf62a5edf57f2fa37e36a699a16d355899e27c65c0a13dc262e143e30917593aed1a358868cc6108783

data/src/commands/excel_to_x.rb

@@ -917,6 +917,8 @@ class ExcelToX
     @sheetless_cell_reference_replacer ||= RewriteCellReferencesToIncludeSheetAst.new
     @replace_references_to_blanks_with_zeros ||= ReplaceReferencesToBlanksWithZeros.new(@formulae, nil, inline_ast_decision)
     @fix_subtotal_of_subtotals ||= FixSubtotalOfSubtotals.new(@formulae)
+    # FIXME: Bodge to put it here as well, but seems to be required
+    column_and_row_function_replacement = ReplaceColumnAndRowFunctionsAST.new
 
     #require 'pry'; binding.pry
 
@@ -939,6 +941,8 @@ class ExcelToX
         @replace_arithmetic_on_ranges_replacer.map(ast)
         @replace_string_joins_on_ranges_replacer.map(ast)
         @wrap_formulae_that_return_arrays_replacer.map(ast)
+        column_and_row_function_replacement.current_reference = ref.last
+        column_and_row_function_replacement.replace(ast)
         @replace_references_to_blanks_with_zeros.current_sheet_name = ref.first
         @replace_references_to_blanks_with_zeros.map(ast)
         @fix_subtotal_of_subtotals.map(ast)
@@ -947,7 +951,6 @@ class ExcelToX
         raise
       end
     end
-    #require 'pry'; binding.pry
   end
 
   # These types of cells don't conatain formulae and can therefore be skipped

data/src/compile/c/excel_to_c_runtime.c

@@ -87,6 +87,8 @@ static ExcelValue mod(ExcelValue a_v, ExcelValue b_v);
 static ExcelValue negative(ExcelValue a_v);
 static ExcelValue npv(ExcelValue rate, int number_of_arguments, ExcelValue *arguments);
 static ExcelValue pmt(ExcelValue rate_v, ExcelValue number_of_periods_v, ExcelValue present_value_v);
+static ExcelValue pmt_4(ExcelValue rate_v, ExcelValue number_of_periods_v, ExcelValue present_value_v, ExcelValue final_value_v);
+static ExcelValue pmt_5(ExcelValue rate_v, ExcelValue number_of_periods_v, ExcelValue present_value_v, ExcelValue final_value_v, ExcelValue type_v);
 static ExcelValue power(ExcelValue a_v, ExcelValue b_v);
 static ExcelValue pv_3(ExcelValue a_v, ExcelValue b_v, ExcelValue c_v);
 static ExcelValue pv_4(ExcelValue a_v, ExcelValue b_v, ExcelValue c_v, ExcelValue d_v);
@@ -1527,6 +1529,29 @@ static ExcelValue pmt(ExcelValue rate_v, ExcelValue number_of_periods_v, ExcelVa
 	return EXCEL_NUMBER(-present_value*(rate*(pow((1+rate),number_of_periods)))/((pow((1+rate),number_of_periods))-1));
 }
 
+static ExcelValue pmt_4(ExcelValue rate_v, ExcelValue number_of_periods_v, ExcelValue present_value_v, ExcelValue final_value_v) {
+  CHECK_FOR_PASSED_ERROR(final_value_v)
+    
+    NUMBER(final_value_v, final_value)
+    CHECK_FOR_CONVERSION_ERROR
+      
+    if(final_value == 0) return pmt(rate_v, number_of_periods_v, present_value_v);
+    printf("PMT with non-zero final_value not implemented. halting.");
+    exit(-1);
+}
+
+static ExcelValue pmt_5(ExcelValue rate_v, ExcelValue number_of_periods_v, ExcelValue present_value_v, ExcelValue final_value_v, ExcelValue type_v) {
+  CHECK_FOR_PASSED_ERROR(type_v)
+    
+    NUMBER(type_v, type)
+    CHECK_FOR_CONVERSION_ERROR
+      
+    if(type == 0) return pmt(rate_v, number_of_periods_v, present_value_v);
+    printf("PMT with non-zero type not implemented. halting.");
+    exit(-1);
+}
+
+
 static ExcelValue pv_3(ExcelValue rate_v, ExcelValue nper_v, ExcelValue pmt_v) {
   return pv_4(rate_v, nper_v, pmt_v, ZERO);
 }

data/src/compile/c/excel_to_c_runtime_test.c

@@ -425,6 +425,8 @@ int test_functions() {
   assert((pmt(EXCEL_NUMBER(0.1),EXCEL_NUMBER(10),EXCEL_NUMBER(100)).number - -16.27) < 0.01);
   assert((pmt(EXCEL_NUMBER(0.0123),EXCEL_NUMBER(99.1),EXCEL_NUMBER(123.32)).number - -2.159) < 0.01);
   assert((pmt(EXCEL_NUMBER(0),EXCEL_NUMBER(2),EXCEL_NUMBER(10)).number - -5) < 0.01);
+  assert((pmt_4(EXCEL_NUMBER(0),EXCEL_NUMBER(2),EXCEL_NUMBER(10), EXCEL_NUMBER(0)).number - -5) < 0.01);
+  assert((pmt_5(EXCEL_NUMBER(0),EXCEL_NUMBER(2),EXCEL_NUMBER(10), EXCEL_NUMBER(0), EXCEL_NUMBER(0)).number - -5) < 0.01);
 
   // Test power
   // ... should return power of its arguments

data/src/compile/c/map_formulae_to_c.rb

@@ -69,7 +69,9 @@ class MapFormulaeToC < MapValuesToC
     :'MMULT' => 'mmult',
     :'MOD' => 'mod',
     :'NPV' => 'npv',
-    :'PMT' => 'pmt',
+    :'PMT3' => 'pmt',
+    :'PMT4' => 'pmt_4',
+    :'PMT5' => 'pmt_5',
     :'PV3' => 'pv_3',
     :'PV4' => 'pv_4',
     :'PV5' => 'pv_5',

data/src/compile/ruby/compile_to_ruby_unit_test.rb

@@ -37,6 +37,8 @@ class CompileToRubyUnitTest
         else
           o.puts "  def #{test_name}; assert_equal(#{value}, #{full_reference}); end"
         end
+      when :string
+        o.puts "  def #{test_name}; assert_equal(#{value.gsub(/(\\n|\\r|\r|\n)+/,'')}, #{full_reference}.to_s.gsub(/[\\n\\r]+/,'')); end"
       when :number
         if sloppy
           if value.to_f.abs <= 1

data/src/compile/ruby/map_formulae_to_ruby.rb

@@ -17,6 +17,7 @@ class MapFormulaeToRuby < MapValuesToRuby
     :'>' => 'more_than?',
     :'>=' => 'more_than_or_equal?',
     :'ABS' => 'abs',
+    :'ADDRESS' => 'address',
     :'AND' => 'excel_and',
     :'AVERAGE' => 'average',
     :'AVERAGEIFS' => 'averageifs',

data/src/excel/excel_functions.rb

@@ -119,3 +119,5 @@ require_relative 'excel_functions/npv'
 require_relative 'excel_functions/iserror'
 
 require_relative 'excel_functions/char'
+
+require_relative 'excel_functions/address'

data/src/excel/excel_functions/address.rb

@@ -0,0 +1,57 @@
+module ExcelFunctions
+
+  # ADDRESS(row_num,column_num,abs_num,a1,sheet_text)
+  # row_num
+  # The row number to use in the cell reference.
+  # column_num
+  # The column number to use in the cell reference.
+  # abs_num
+  # Specifies the type of reference to return.
+  # 1 or omitted returns the following type of reference: absolute.
+  # 2 returns the following type of reference: absolute row; relative column.
+  # 3 returns the following type of reference: relative row; absolute column.
+  # 4 returns the following type of reference: relative.
+  # a1
+  # A logical value that specifies the A1 or R1C1 reference style.
+  # If a1 is TRUE or omitted, ADDRESS returns an A1-style reference.
+  # If a1 is FALSE, ADDRESS returns an R1C1-style reference.
+  # sheet_text
+  # Text specifying the name of the sheet to be used as the external reference.
+  # If sheet_text is omitted, no sheet name is used.  
+  def address(row_num, column_num, abs_num = 1, a1 = true, sheet_text = nil)
+    raise NotSupportedException.new("address() function R1C1 references not implemented") if a1 == false
+
+    return row_num if row_num.is_a?(Symbol)
+    return column_num if column_num.is_a?(Symbol)
+    return abs_num if abs_num.is_a?(Symbol)
+    return a1 if a1.is_a?(Symbol)
+    return sheet_text if sheet_text.is_a?(Symbol)
+    
+    row_num = number_argument(row_num)
+    column_num = number_argument(column_num)
+    abs_num = number_argument(abs_num)
+    
+    return :value if row_num < 1
+    return :value if column_num < 1
+    return :value if abs_num < 1
+    return :value if abs_num > 4
+    
+    row = row_num.to_i.to_s
+    column = Reference.column_letters_for_column_number[column_num.to_i].to_s
+    
+    ref = case abs_num
+    when 1; "$"+column+"$"+row
+    when 2; "" +column+"$" +row
+    when 3; "$"+column+"" +row
+    when 4;  ""+column+"" +row
+    end
+    
+    if sheet_text
+      ref = "'#{sheet_text}'!"+ref
+    end
+    
+    ref
+
+  end
+  
+end

data/src/excel/excel_functions/pmt.rb

@@ -1,14 +1,23 @@
 module ExcelFunctions
   
-  def pmt(rate,number_of_periods,present_value)
+  def pmt(rate,number_of_periods,present_value, final_value = 0, type = 0)
+    
     rate = number_argument(rate)
     number_of_periods = number_argument(number_of_periods)
     present_value = number_argument(present_value)
-    
+    final_value = number_argument(final_value)
+    type = number_argument(type)
+
     return rate if rate.is_a?(Symbol)
     return number_of_periods if number_of_periods.is_a?(Symbol)
     return present_value if present_value.is_a?(Symbol)
+    return final_value if final_value.is_a?(Symbol)
+    return type if type.is_a?(Symbol)
+    
     return :num if number_of_periods == 0
+
+    raise NotSupportedException.new("pmt() function non zero final value not implemented") unless final_value == 0
+    raise NotSupportedException.new("pmt() function non zero type not implemented") unless type == 0
     
     return -(present_value / number_of_periods) if rate == 0
     -present_value*(rate*((1+rate)**number_of_periods))/(((1+rate)**number_of_periods)-1)

data/src/excel/formula_peg.rb

@@ -230,7 +230,7 @@ class Formula < RubyPeg
   end
   
   def space
-    ignore { terminal(/[ \n]*/) }
+    ignore { terminal(/[ \n\r]*/) }
   end
   
   def null

data/src/excel/formula_peg.txt

@@ -41,7 +41,7 @@ boolean                          = boolean_true | boolean_false
 boolean_true                    := `'TRUE'
 boolean_false                   := `'FALSE'
 prefix                          := /[-+]/ thing
-space                            = `/[ \n]*/
+space                            = `/[ \n\r]*/
 null                            := &','
 error                           := '#REF!' | '#NAME?' | '#VALUE!' | '#DIV/0!' | '#N/A' | '#NUM!'
 

data/src/excel/reference.rb

@@ -32,6 +32,10 @@ class Reference < String
     letters
   end
   
+  def self.column_letters_for_column_number
+    @@column_letters_for_column_number
+  end
+  
   attr_reader :excel_row_number, :excel_column_number, :excel_column, :excel_row
   
   def calculate_excel_variables

data/src/excel_to_code.rb

@@ -1,5 +1,5 @@
 class ExcelToCode
-  def self.version() "0.3.15" end
+  def self.version() "0.3.16" end
 end
 
 require_relative 'commands'

data/src/extract/extract_data_from_worksheet.rb

@@ -81,10 +81,10 @@ class ExtractDataFromWorksheet < ::Ox::Sax
 
       unless @formula.empty?
         begin
-          formula_text = @formula.join.gsub(/[\r\n]+/,'')
+          formula_text = @formula.join
           ast = @fp.parse(formula_text)
-        rescue ExternalReferenceException => e
-          e.ref = key # Attach the sheet and reference to the exception
+        rescue ExcelToCodeException => e
+          e.ref = key if e.respond_to?(:ref) # Attach the sheet and reference to the exception
           raise
         end
         unless ast

data/src/extract/extract_shared_strings.rb

@@ -26,7 +26,7 @@ class ExtractSharedStrings < ::Ox::Sax
   def text(string)
     return unless @current
     # FIXME: SHOULDN'T ELINMATE NEWLINES
-    @current << string.gsub("\n","")
+    @current << string#.gsub("\n","")
   end
   
 end

data/src/rewrite/caching_formula_parser.rb

@@ -17,7 +17,7 @@ class ExternalReferenceException < ExcelToCodeException
 
     Sorry, ExcelToCode can't handle external references
 
-    It found one in #{ref.join("!")}
+    It found one in #{ref && ref.join("!")}
     The formula was #{formula_text}
     Which was parsed to #{full_ast}
     Which seemed to have an external reference at #{reference_ast}
@@ -29,6 +29,32 @@ class ExternalReferenceException < ExcelToCodeException
   end
 end
 
+class ParseFailedException < ExcelToCodeException
+
+  attr_accessor :formula_text
+  attr_accessor :ref
+
+  def initialize(formula_text)
+    @formula_text = formula_text
+  end
+
+  def message
+    <<-END
+
+
+    Sorry, ExcelToCode couldn't parse one of the formulae
+
+    It was in #{ref && ref.join("!")}
+    The formula was #{formula_text}
+
+    Please report the problem at http://github.com/tamc/excel_to_code/issues
+
+    END
+  end
+
+end
+
+
 class CachingFormulaParser
   include Singleton
 
@@ -56,10 +82,11 @@ class CachingFormulaParser
   def parse(text)
     ast = Formula.parse(text)
     @text = text # Kept in case of Exception below
-    @full_ast = ast.to_ast[1] # Kept in case of Exception below
     if ast
+      @full_ast = ast.to_ast[1] # Kept in case of Exception below
       map(ast.to_ast[1])
     else
+      raise ParseFailedException.new(text)
       nil
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excel_to_code
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Thomas Counsell, Green on Black Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypeg
@@ -150,6 +150,7 @@ files:
 - src/excel/excel_functions.rb
 - src/excel/excel_functions/abs.rb
 - src/excel/excel_functions/add.rb
+- src/excel/excel_functions/address.rb
 - src/excel/excel_functions/and.rb
 - src/excel/excel_functions/apply_to_range.rb
 - src/excel/excel_functions/average.rb