excel_to_code 0.2.21 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dfb614b4506cd5feb1fdf4ed13261b19e33af1c
-  data.tar.gz: 5e06790944edc88f7ccea7959e4a1a1a6119fffb
+  metadata.gz: 3ccdb199882da15b8172e1714f446a6bf0327d9e
+  data.tar.gz: 1a6a3be2a554c829a9654a0d567f385f8f8fca92
 SHA512:
-  metadata.gz: 3f5287bc61bfaa773332bfd7361eb062cf3f3246649ce677699374745fdb68cb707899457a003faabd04caa3285483a04a465e8a6864bdcad8a593faa417bf00
-  data.tar.gz: 1dbe79f4c2bf8dcb78db9f033f30ce1dfd0f5e44b3e8004a51b2f42f62507001ae3e3c17e25a19af075af0b67d25598cd214b7b0a39987f994ca7333e6300c2f
+  metadata.gz: e2653de86cca389d7865e7fe853fa1253255b3399953764c3746ed968432ab0c6f6a3fc4cb10bd10de4b7beeefa06d563f85463b697e385b783f19c07b5cc7a3
+  data.tar.gz: 7040c57720a1bfb389106405ac2c6d17e8f2f0602d944456b8cffd3b5ad2033f5104850af57cb2d7a022e06697af9fe1a03689f53fc8c05d25390612c89e7259

data/bin/excel_to_c

@@ -52,6 +52,11 @@ END
   opts.on('--isolate WORKSHEET', "Only performs translation and optimiation of that one worksheet. Useful for debugging an incorrect translation of a large worksheet") do |sheet|
     command.isolate = sheet
   end
+
+  opts.on('-d','--debug', "Does not perform final optimisations of spreadsheet, leaving the resulting code more similar to the original worksheet, but potentially slower") do |sheet|
+    command.should_inline_formulae_that_are_only_used_once = false
+    command.extract_repeated_parts_of_formulae = false
+  end
   
   opts.on("-h", "--help", "Show this message") do
     puts opts

data/bin/excel_to_ruby

@@ -52,6 +52,11 @@ END
   opts.on('--isolate WORKSHEET', "Only performs translation and optimiation of that one worksheet. Useful for debugging an incorrect translation of a large worksheet") do |sheet|
     command.isolate = sheet
   end
+
+  opts.on('-d','--debug', "Does not perform final optimisations of spreadsheet, leaving the resulting code more similar to the original worksheet, but potentially slower") do |sheet|
+    command.should_inline_formulae_that_are_only_used_once = false
+    command.extract_repeated_parts_of_formulae = false
+  end
   
   opts.on("-h", "--help", "Show this message") do
     puts opts

data/src/commands/excel_to_ruby.rb

@@ -38,6 +38,33 @@ class ExcelToRuby < ExcelToX
     c.rewrite(@formulae, @worksheet_c_names, o)
     o.puts
     
+    # Output the named references
+
+    # Getters
+    o.puts "# Start of named references"
+    c.settable = lambda { |ref| false }
+    named_references_ast = {}
+    @named_references_to_keep.each do |ref|
+      c_name = ref.is_a?(Array) ? c_name_for(ref) : ["", c_name_for(ref)]
+      named_references_ast[c_name] = @named_references[ref]
+    end
+
+    c.rewrite(named_references_ast, @worksheet_c_names, o)
+
+    # Setters
+    m = MapNamedReferenceToRubySetter.new
+    m.cells_that_can_be_set_at_runtime = cells_that_can_be_set_at_runtime
+    m.sheet_names = @worksheet_c_names
+    @named_references_that_can_be_set_at_runtime.each do |ref|
+      c_name = c_name_for(ref)
+      ast = @named_references[ref]
+      o.puts "  def #{c_name}=(newValue)"
+      o.puts "    @#{c_name} = newValue"
+      o.puts m.map(ast)
+      o.puts "  end"
+    end
+    o.puts "# End of named references"
+
     log.info "Starting to write initializer"
     o.puts
     o.puts "  # starting initializer"
@@ -50,6 +77,7 @@ class ExcelToRuby < ExcelToX
     o.puts ""
     log.info "Finished writing initializer"
               
+
     o.puts "end"
     close(o)
     log.info "Finished writing code"

data/src/commands/excel_to_x.rb

@@ -87,22 +87,28 @@ class ExcelToX
 
   # Optional attribute. Boolean. 
   #   * true - the generated tests are run
-  #   * false - the generated tests are not run
+  #   * false (default) - the generated tests are not run
   attr_accessor :actually_run_tests
   
   # This is the log file, if set it needs to respond to the same methods as the standard logger library
   attr_accessor :log
 
-  # Optional attribute. Boolean. Default true.
-  #   * true - empty cells and zeros are treated as being equivalent in tests. Numbers greater then 1 are only expected to match with assert_in_epsilon, numbers less than 1 are only expected to match with assert_in_delta
+  # Optional attribute. Boolean.
+  #   * true (default) - empty cells and zeros are treated as being equivalent in tests. Numbers greater then 1 are only expected to match with assert_in_epsilon, numbers less than 1 are only expected to match with assert_in_delta
   #   * false - empty cells and zeros are treated as being different in tests. Numbers must match to full accuracy.
   attr_accessor :sloppy_tests
 
-  # Optional attribute, Boolean. Default true
-  #   * true - the compiler attempts to extract bits of calculation that appear in more than one formula into separate methods. This should increase performance
+  # Optional attribute, Boolean.
+  #   * true (default) - the compiler attempts to inline any calculation that is done in another cell, but only referred to by this cell. This should increase performance
+  #   * false - the compiler leaves calculations in their original cells expanded. This may make debugging easier
+  attr_accessor :should_inline_formulae_that_are_only_used_once
+  
+  # Optional attribute, Boolean.
+  #   * true (default) - the compiler attempts to extract bits of calculation that appear in more than one formula into separate methods. This should increase performance
   #   * false - the compiler leaves calculations fully expanded. This may make debugging easier
   attr_accessor :extract_repeated_parts_of_formulae
 
+
   # Optional attribute, Array. Default nil
   # This is used to help debug large spreadsheets that aren't working correctly.
   # If set to the name of a worksheet then ONLY that worksheet will be run through the 
@@ -189,7 +195,7 @@ class ExcelToX
     filter_named_references
 
     replace_formulae_with_their_results
-    inline_formulae_that_are_only_used_once
+    inline_formulae_that_are_only_used_once if should_inline_formulae_that_are_only_used_once
     remove_any_cells_not_needed_for_outputs
     separate_formulae_elements if extract_repeated_parts_of_formulae
     replace_values_with_constants
@@ -228,6 +234,7 @@ class ExcelToX
 
     # Setting this to false may make it easier to figure out errors
     self.extract_repeated_parts_of_formulae = true if @extract_repeated_parts_of_formulae == nil
+    self.should_inline_formulae_that_are_only_used_once = true if @should_inline_formulae_that_are_only_used_once == nil
 
     # This setting is used for debugging, and makes the system only do the conversion on a subset of the the
     if self.isolate

data/src/compile/c/compile_named_reference_setters.rb

@@ -31,8 +31,8 @@ class MapNamedReferenceToCSetter
   def sheet_reference(sheet,reference)
     s = sheet_names[sheet]
     c = map(reference)
-    return "  // #{s}_#{c} not settable" unless settable(sheet, c)
-    "  set_#{s}_#{c}(#{@new_value_name});"
+    return not_settable_code(s,c) unless settable(sheet, c)
+    settable_code(s,c)
   end
 
   def array(*rows)
@@ -48,8 +48,7 @@ class MapNamedReferenceToCSetter
     end.flatten.join("\n")
     
     @new_value_name = "newValue"
-
-    "  ExcelValue *array = newValue.array;\n#{result}"
+    array_code(result)
   end
 
   def settable(sheet, reference)
@@ -59,8 +58,36 @@ class MapNamedReferenceToCSetter
     settable_refs.include?(reference.upcase.to_sym) 
   end
 
+  def not_settable_code(s,c)
+    "  // #{s}_#{c} not settable"
+  end
+
+  def settable_code(s,c)
+    "  set_#{s}_#{c}(#{@new_value_name});"
+  end
+
+  def array_code(result)
+    "  ExcelValue *array = newValue.array;\n#{result}"
+  end
+
+end
+
+class MapNamedReferenceToRubySetter < MapNamedReferenceToCSetter
+  def not_settable_code(s,c)
+    "    # @#{s}_#{c} not settable"
+  end
+
+  def settable_code(s,c)
+    "    @#{s}_#{c} = #{@new_value_name}"
+  end
+
+  def array_code(result)
+    "    array = newValue\n#{result}"
+  end
 end
 
+
+
 class CompileNamedReferenceSetters
 
   attr_accessor :cells_that_can_be_set_at_runtime

data/src/excel/excel_functions.rb

@@ -3,6 +3,7 @@ end
 
 # Support functions
 require_relative 'excel_functions/number_argument'
+require_relative 'excel_functions/reset'
 
 # Constants
 require_relative 'excel_functions/pi'

data/src/excel/excel_functions/reset.rb

@@ -0,0 +1,14 @@
+module ExcelFunctions
+  
+  # This is a support function for reseting a spreadsheet's instance
+  # variables back to nil, allowing the results to be recalculated
+  def reset()
+    # Set all the instance variables to nil
+    instance_variables.each do |iv|
+      instance_variable_set(iv,nil)
+    end
+    # Reset the settable variables to their defaults
+    initialize
+  end
+  
+end

data/src/excel_to_code.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excel_to_code
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.22
 platform: ruby
 authors:
 - Thomas Counsell, Green on Black Ltd
@@ -186,6 +186,7 @@ files:
 - src/excel/excel_functions/power.rb
 - src/excel/excel_functions/pv.rb
 - src/excel/excel_functions/rank.rb
+- src/excel/excel_functions/reset.rb
 - src/excel/excel_functions/right.rb
 - src/excel/excel_functions/round.rb
 - src/excel/excel_functions/rounddown.rb