soroban 0.5.4 → 0.7.2

data/Gemfile

@@ -6,6 +6,7 @@ group :development do
   gem "rubyXL", "~> 1.2.7"
   gem "nokogiri", ">= 1.4.4"
   gem "rubyzip", ">= 0.9.4"
+  gem "awesome_print"
 end
 
 group :test do

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    awesome_print (1.1.0)
     diff-lcs (1.1.3)
     git (1.2.5)
     jeweler (1.8.4)
@@ -8,11 +9,11 @@ GEM
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.6)
+    json (1.7.7)
     nokogiri (1.5.6)
     polyglot (0.3.3)
     rake (10.0.3)
-    rdoc (3.12)
+    rdoc (3.12.2)
       json (~> 1.4)
     redcarpet (2.2.2)
     rspec (2.12.0)
@@ -22,18 +23,19 @@ GEM
     rspec-core (2.12.2)
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.1)
+    rspec-mocks (2.12.2)
     rubyXL (1.2.10)
     rubyzip (0.9.9)
     treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    yard (0.8.3)
+    yard (0.8.5.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   jeweler (~> 1.8.3)
   nokogiri (>= 1.4.4)
   rake

data/README.md

@@ -3,8 +3,9 @@ Soroban
 
 Soroban is a calculating engine that understands Excel formulas.
 
-[![Build Status](https://secure.travis-ci.org/agworld/soroban.png)](http://travis-ci.org/#!/agworld/soroban)
+[![Code Climate](https://codeclimate.com/github/agworld/soroban.png)](https://codeclimate.com/github/agworld/soroban)
 [![Dependency Status](https://gemnasium.com/agworld/soroban.png)](https://gemnasium.com/agworld/soroban)
+[![Build Status](https://secure.travis-ci.org/agworld/soroban.png)](http://travis-ci.org/#!/agworld/soroban)
 
 
 Getting Started
@@ -146,6 +147,13 @@ s.g = "=FOO(10, 20)"
 puts s.g              # => 17
 ```
 
+Compilation
+-----------
+
+Rather than interact with a `Soroban::Sheet` object at runtime, you can compile
+the sheet into a Ruby or JavaScript class which you can then either save out to
+a file or evaluate directly. This is slightly less flexible, but more efficient.
+
 Contributing to Soroban
 -----------------------
  

data/Soroban.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "soroban"
-  s.version = "0.5.4"
+  s.version = "0.7.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Hutchens"]
-  s.date = "2013-01-18"
+  s.date = "2013-09-03"
   s.description = "Soroban makes it easy to extract and execute formulas from Excel spreadsheets. It rewrites Excel formulas as Ruby expressions, and allows you to bind named variables to spreadsheet cells to easily manipulate inputs and capture outputs."
   s.email = "jason.hutchens@agworld.com.au"
   s.extra_rdoc_files = [
@@ -55,6 +55,7 @@ Gem::Specification.new do |s|
     "lib/soroban/parser/nodes.rb",
     "lib/soroban/parser/rewrite.rb",
     "lib/soroban/sheet.rb",
+    "lib/soroban/tabulator.rb",
     "lib/soroban/value_walker.rb",
     "spec/documentation_spec.rb",
     "spec/import_spec.rb",
@@ -64,7 +65,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/agworld/soroban"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "Soroban is a calculating engine that understands Excel formulas."
 
   if s.respond_to? :specification_version then
@@ -75,17 +76,20 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rubyXL>, ["~> 1.2.7"])
       s.add_development_dependency(%q<nokogiri>, [">= 1.4.4"])
       s.add_development_dependency(%q<rubyzip>, [">= 0.9.4"])
+      s.add_development_dependency(%q<awesome_print>, [">= 0"])
     else
       s.add_dependency(%q<treetop>, ["~> 1.4.10"])
       s.add_dependency(%q<rubyXL>, ["~> 1.2.7"])
       s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
       s.add_dependency(%q<rubyzip>, [">= 0.9.4"])
+      s.add_dependency(%q<awesome_print>, [">= 0"])
     end
   else
     s.add_dependency(%q<treetop>, ["~> 1.4.10"])
     s.add_dependency(%q<rubyXL>, ["~> 1.2.7"])
     s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
     s.add_dependency(%q<rubyzip>, [">= 0.9.4"])
+    s.add_dependency(%q<awesome_print>, [">= 0"])
   end
 end
 

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.7.2

data/lib/soroban/cell.rb

@@ -7,7 +7,7 @@ module Soroban
   # representation of its contents, and the executable Ruby version of same, as
   # generated via a rewrite grammar. Cells also store their dependencies.
   class Cell
-    attr_reader :excel, :ruby, :dependencies
+    attr_reader :excel, :javascript, :dependencies
 
     # Cells are initialised with a binding to allow formulas to be executed
     # within the context of the sheet which owns the cell.
@@ -18,12 +18,19 @@ module Soroban
       @value = nil
     end
 
+    def to_compiled_ruby
+      @tree.to_compiled_ruby
+    end
+
     # Set the contents of a cell, and store the executable Ruby version.
     def set(contents)
       contents = contents.to_s
       contents = "'#{contents}'" if Soroban::unknown?(contents)
       clear
-      @excel, @ruby = contents, _convert(contents)
+      @excel = contents
+      @tree = Soroban::parser.parse(@excel)
+      raise Soroban::ParseError, Soroban::parser.failure_reason if @tree.nil?
+      @ruby = _to_ruby
     end
 
     # Clear the cached value of a cell to force it to be recalculated
@@ -45,10 +52,12 @@ module Soroban
 
   private
 
-    def _convert(contents)
-      tree = Soroban::parser.parse(contents)
-      raise Soroban::ParseError, Soroban::parser.failure_reason if tree.nil?
-      tree.convert(@dependencies.clear)
+    def _to_ruby
+      @tree.to_ruby(@dependencies.clear)
+    end
+
+    def _to_javascript
+      @tree.to_javascript(@dependencies.clear)
     end
 
   end

data/lib/soroban/parser/nodes.rb

@@ -1,67 +1,103 @@
 module Soroban
 
   class Formula < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       value.gsub(/^= */, '')
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class Identifier < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "@#{value}.get"
     end
+    def compile_ruby(value)
+      "@cells[:#{value}].call"
+    end
     def extract(value)
       value.to_sym
     end
   end
 
   class IntegerValue < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "#{value.to_f}"
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class FloatValue < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "#{value.to_f}"
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class Function < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       match = /^([^(]*)(.*)$/.match(value)
       "func_#{match[1].downcase}#{match[2]}"
     end
+    def compile_ruby(value)
+      match = /^([A-Z]+)\((.*)\)$/.match(value)
+      name, args = match[1], match[2].split(',')
+      case name
+        when 'VLOOKUP'
+          find, table, column, _ = args
+          table = table[1...-1]
+          column = column.to_i
+          table_key = "'#{table}_#{column}'"
+          code = []
+          code << "begin"
+          code << "        @cache[#{table_key}] ||= {"
+          cols = Tabulator.new(table).get
+          lookup = Hash[cols[0].zip(cols[column-1])]
+          code << lookup.map do |key, val|
+            "          @cells[:#{key}].call => @cells[:#{val}].call"
+          end.join(",\n")
+          code << "        }"
+          code << "        @cache[#{table_key}][#{find}] || 0.0"
+          code << "      end"
+          code.join("\n")
+        else
+          value
+      end
+    end
   end
 
   class Pow < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "**"
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class Equal < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "=="
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class NotEqual < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "!="
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class Label < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       value.gsub('$', '')
     end
+    alias :compile_ruby :rewrite_ruby
   end
 
   class Range < Treetop::Runtime::SyntaxNode
-    def rewrite(value)
+    def rewrite_ruby(value)
       "'#{value}'"
     end
+    alias :compile_ruby :rewrite_ruby
     def extract(value)
       LabelWalker.new(value).map { |label| "#{label}".to_sym }
     end

data/lib/soroban/parser/rewrite.rb

@@ -2,19 +2,49 @@ module Treetop
   module Runtime
     class SyntaxNode
 
-      def convert(dependencies)
+      def to_ruby(dependencies)
         if nonterminal?
           value = ""
-          elements.each { |element| value << element.convert(dependencies) }
+          elements.each { |element| value << element.to_ruby(dependencies) }
           _add_dependency(dependencies, extract(value))
-          rewrite(value)
+          rewrite_ruby(value)
         else
           _add_dependency(dependencies, extract(text_value))
-          rewrite(text_value)
+          rewrite_ruby(text_value)
         end
       end
 
-      def rewrite(value)
+      def to_compiled_ruby
+        if nonterminal?
+          value = ""
+          elements.each { |element| value << element.to_compiled_ruby }
+          compile_ruby(value)
+        else
+          compile_ruby(text_value)
+        end
+      end
+
+      def to_javascript(dependencies)
+        if nonterminal?
+          value = ""
+          elements.each { |element| value << element.to_javascript(dependencies) }
+          _add_dependency(dependencies, extract(value))
+          rewrite_javascript(value)
+        else
+          _add_dependency(dependencies, extract(text_value))
+          rewrite_javascript(text_value)
+        end
+      end
+
+      def compile_ruby(value)
+        value
+      end
+
+      def rewrite_ruby(value)
+        value
+      end
+
+      def rewrite_javascript(value)
         value
       end
 

data/lib/soroban/sheet.rb

@@ -2,8 +2,11 @@ require 'soroban/helpers'
 require 'soroban/functions'
 require 'soroban/label_walker'
 require 'soroban/value_walker'
+require 'soroban/tabulator'
 require 'soroban/cell'
 
+require 'set'
+
 module Soroban
 
   # A container for cells.
@@ -14,10 +17,62 @@ module Soroban
     def initialize(logger=nil)
       @logger = logger
       @cells = {}
+      @compiled = {}
       @changes = Hash.new{ |h, k| h[k] = Set.new }
       @bindings = {}
     end
 
+    def factory(name)
+      eval(self.to_ruby(name), TOPLEVEL_BINDING)
+      Object::const_get('Soroban').const_get('Model').const_get(name).new
+    end
+
+    # Return a string containing a ruby class that implements the sheet. You can
+    # call eval() on this string to create the class, which you can then
+    # instantiate. Set inputs on the instance and read outputs off.
+    def to_ruby(class_name)
+      data = []
+      data << "module Soroban"
+      data << "module Model"
+      data << "class #{class_name}"
+      data << "  def initialize"
+      data << "    @binds = {"
+      data << bindings.map do |name, cell|
+        "      '#{name}' => :#{cell}"
+      end.join(",\n")
+      data << "    }"
+      data << "    @cache = {}"
+      data << "    @cells = {"
+      data << @compiled.map do |label, cell|
+        "      :#{label} => lambda { @cache[:#{label}] ||= #{cell.to_compiled_ruby} }"
+      end.join(",\n")
+      data << "    }"
+      data << "  end"
+      data << "  def clear"
+      data << "    @cache.clear"
+      data << "  end"
+      data << "  def get(name)"
+      data << "    @cells[@binds[name]].call"
+      data << "  end"
+      data << "  def set(name, value)"
+      data << "    self.clear"
+      data << "    @cells[@binds[name]] = lambda { @cache[@binds[name]] ||= value }"
+      data << "  end"
+      bindings.each do |name, cell|
+        data << "  def #{name}"
+        data << "    get('#{name}')"
+        data << "  end"
+        data << "  def #{name}=(value)"
+        data << "    set('#{name}', value)"
+        data << "  end"
+      end
+      data << "end"
+      data << "end"
+      data << "end"
+      puts data.join("\n")
+      data.join("\n")
+    end
+
     # Used for calling dynamically defined functions, and for creating new
     # cells (via `label=`).
     def method_missing(method, *args, &block)
@@ -125,6 +180,7 @@ module Soroban
       internal = "@#{label}"
       _expose(internal, label)
       cell = Cell.new(binding)
+      @compiled[label] = cell
       _set(label, cell, contents)
       instance_variable_set(internal, cell)
     end

data/lib/soroban/tabulator.rb

@@ -0,0 +1,34 @@
+module Soroban
+
+  # An enumerable that splits a range of cells into an nxm array
+  class Tabulator
+
+    include Enumerable
+
+    # Create a new walker from a supplied range.
+    def initialize(range)
+      @fc, @fr, @tc, @tr = Soroban::getRange(range)
+    end
+
+    def get
+      row = []
+      cols = [row]
+      col_ref, row_ref = @fc, @fr
+      while true do
+        row << "#{col_ref}#{row_ref}".to_sym
+        break if row_ref == @tr && col_ref == @tc
+        if row_ref == @tr
+          row = []
+          cols << row
+          row_ref = @fr
+          col_ref = col_ref.next
+        else
+          row_ref = row_ref.next
+        end
+      end
+      cols
+    end
+
+  end
+
+end

data/spec/import_spec.rb

@@ -28,6 +28,47 @@ describe "Documentation", :if => has_rubyxl do
     puts s.force          # => 710.044826106394
     s.force.should be_within(0.01).of(710.04)
 
+    require 'benchmark'
+
+    i_time = Benchmark.realtime do
+      1000.times do
+        s.planet = 'Earth'
+        s.mass = 80
+        s.force
+        s.planet = 'Venus'
+        s.mass = 80
+        s.force
+      end
+    end
+
+    puts "Interpreted Time: #{i_time}"
+
+    eval(s.to_ruby("Test"))
+    model = Soroban::Model::Test.new
+
+    model.planet = 'Earth'
+    model.mass = 80
+    model.force.should be_within(0.01).of(783.46)
+
+    model.planet = 'Venus'
+    model.mass = 80
+    model.force.should be_within(0.01).of(710.04)
+
+    c_time = Benchmark.realtime do
+      1000.times do
+        model.planet = 'Earth'
+        model.mass = 80
+        model.force
+        model.planet = 'Venus'
+        model.mass = 80
+        model.force
+      end
+    end
+
+    puts "Compiled Time: #{c_time}"
+
+    (10.0 * c_time).should be < i_time 
+
   end
 
 end

data/spec/soroban_spec.rb

@@ -61,6 +61,12 @@ describe "Soroban" do
     sheet.bindings.keys.should include :output
     sheet.bindings.values.should include :A1
     sheet.bindings.values.should include :A2
+
+    model = sheet.factory('Test')
+    model.input = 5
+    model.output.should eq(25)
+    model.input = 4
+    model.output.should eq(16)
   end
 
   it "can bind variables to ranges" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soroban
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
-  - 4
-  version: 0.5.4
+  - 7
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Jason Hutchens
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-18 00:00:00 Z
+date: 2013-09-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: treetop
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,11 +30,11 @@ dependencies:
         - 10
         version: 1.4.10
   type: :runtime
-  requirement: *id001
+  version_requirements: *id001
+  name: treetop
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rubyXL
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,11 +46,11 @@ dependencies:
         - 7
         version: 1.2.7
   type: :development
-  requirement: *id002
+  version_requirements: *id002
+  name: rubyXL
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,11 +62,11 @@ dependencies:
         - 4
         version: 1.4.4
   type: :development
-  requirement: *id003
+  version_requirements: *id003
+  name: nokogiri
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rubyzip
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,7 +78,22 @@ dependencies:
         - 4
         version: 0.9.4
   type: :development
-  requirement: *id004
+  version_requirements: *id004
+  name: rubyzip
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+  name: awesome_print
   prerelease: false
 description: Soroban makes it easy to extract and execute formulas from Excel spreadsheets. It rewrites Excel formulas as Ruby expressions, and allows you to bind named variables to spreadsheet cells to easily manipulate inputs and capture outputs.
 email: jason.hutchens@agworld.com.au
@@ -129,6 +143,7 @@ files:
 - lib/soroban/parser/nodes.rb
 - lib/soroban/parser/rewrite.rb
 - lib/soroban/sheet.rb
+- lib/soroban/tabulator.rb
 - lib/soroban/value_walker.rb
 - spec/documentation_spec.rb
 - spec/import_spec.rb
@@ -163,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Soroban is a calculating engine that understands Excel formulas.