soroban 0.1.1 → 0.2.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+bundler_args: --without development document
+notifications:
+  email: false
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/.yardopts

@@ -1,6 +1,7 @@
 --protected
 --no-private
 --exclude lib/soroban/parser/
+--exclude lib/soroban/import/
 -
 README.md
 LICENSE.txt

data/Gemfile

@@ -3,12 +3,23 @@ source "http://rubygems.org"
 gem "treetop", "~> 1.4.10"
 
 group :development do
-  gem "rspec", "~> 2.8.0"
+  gem "rubyXL", "~> 1.2.7"
+  gem "nokogiri", ">= 1.4.4"
+  gem "rubyzip", ">= 0.9.4"
+# gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "rake"
+  gem "rspec", "~> 2.9.0"
   gem "yard", "~> 0.7"
+end
+
+group :document do
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1.3"
-  gem "jeweler", "~> 1.8.3"
-  gem "rcov", ">= 0"
-  gem "rubyXL", "~> 1.2.7"
   gem "redcarpet"
 end
+
+group :gemify do
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -9,21 +9,22 @@ GEM
       rake
       rdoc
     json (1.6.6)
+    nokogiri (1.5.2)
     polyglot (0.3.3)
     rake (0.9.2.2)
-    rcov (1.0.0)
     rdoc (3.12)
       json (~> 1.4)
     redcarpet (2.1.1)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
     rubyXL (1.2.7)
+    rubyzip (0.9.7)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
@@ -33,12 +34,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.3)
   jeweler (~> 1.8.3)
-  rcov
+  nokogiri (>= 1.4.4)
+  rake
   rdoc (~> 3.12)
   redcarpet
-  rspec (~> 2.8.0)
+  rspec (~> 2.9.0)
   rubyXL (~> 1.2.7)
+  rubyzip (>= 0.9.4)
   treetop (~> 1.4.10)
   yard (~> 0.7)

data/README.md

@@ -3,37 +3,56 @@ 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)
+[![Dependency Status](https://gemnasium.com/agworld/soroban.png)](https://gemnasium.com/agworld/soroban)
+
+
 Getting Started
 ---------------
 
-```
-> sudo gem install soroban
-```
+Simply `sudo gem install soroban` and then `require 'soroban'` in your code.
+
+Look at the examples on this page, the [tests](https://github.com/agworld/soroban/blob/master/spec/soroban_spec.rb) and the [API docs](http://rubydoc.info/github/agworld/soroban/master/frames) to get up to speed.
 
 Example Usage
 -------------
 
 ```ruby
-require 'soroban'
-
 s = Soroban::Sheet.new()
 
 s.A1 = 2
-s.set('B1:B5', [1,2,3,4,5])
-s.C1 = "=SUM(B1:B5) + A1 ^ 3"
-s.C2 = "=IF(C1>25,'Large','Tiny')"
+s.set('B1:B5' => [1,2,3,4,5])
+s.C1 = "=SUM(A1, B1:B5, 5) + A1 ^ 3"
+s.C2 = "=IF(C1>30,'Large','Tiny')"
 
-puts s.C1             # => 23
+puts s.C1             # => 30
 
-s.bind(:input, :A1)
-s.bind(:output, :C2)
+s.bind(:input => :A1, :output => :C2)
 
 puts s.output         # => "Tiny"
 
 s.input = 3
 
 puts s.output         # => "Large"
-puts s.C1             # => 42
+puts s.C1             # => 50
+```
+
+Bindings
+--------
+
+Soroban allows you to bind meaningful variable names to individual cells and to ranges of cells. When bound to a range, variables act as an array,.
+
+```ruby
+s.set(:A1 => 'hello', 'B1:B5' => [1,2,3,4,5])
+
+s.bind(:foo => :A1, :bar => 'B1:B5')
+
+puts s.foo            # => 'hello'
+puts s.bar[0]         # => 1
+
+s.bar[0] = 'howdy'
+
+puts s.B1             # => 'howdy'
 ```
 
 Persistence
@@ -54,16 +73,37 @@ s.F1 = "= E1 + SUM(D1:D5)"
 s.missing             # => [:E1, :D1, :D2, :D3, :D4, :D5]
 
 s.E1 = "= D1 ^ D2"
-s.set("D1:D5", [1,2,3,4,5])
+s.set("D1:D5" => [1,2,3,4,5])
 
 s.missing             # => []
 
 s.cells               # => {"F1"=>"= E1 + SUM(D1:D5)", "E1"=>"= D1 ^ D2", "D1"=>"1", "D2"=>"2", "D3"=>"3", "D4"=>"4", "D5"=>"5"}
 ```
 
-This means parsing a file can be done as follows.
+Importers
+---------
+
+Soroban has a built-in importer for xlsx files. It requires the [RubyXL](https://github.com/gilt/rubyXL) gem. Use it as follows:
+
+```ruby
+require 'rubyXL'
+
+BINDINGS = {
+  :gravity => :B1,
+  :mass => :B2,
+  :force => :B10
+}
+
+s = Soroban::Import::rubyXL("/Users/kranzky/Desktop/Physics.xlsx", 0, BINDINGS )
+```
+
+This import process returns a new Soroban::Sheet object that contains all the
+cells required to calculate the values of the bound variables, and which has the
+bindings set up correctly.
+
+You can import other kinds of file using the following pattern:
 
-* Add the cells that correspond to inputs and outputs
+* Add the cells that correspond to bound inputs and outputs
 * Add the cells reported by `missing` (and continue to do so until it's empty)
 * Persist the hash returned by `cells`
 
@@ -75,7 +115,7 @@ you want to iterate over cell values (including computed values of formulas),
 then use `walk`.
 
 ```ruby
-s.set('D1:D5', [1,2,3,4,5])
+s.set('D1:D5' => [1,2,3,4,5])
 s.walk('D1:D5').reduce(:+)    # => 15
 ```
 

data/Rakefile

@@ -33,7 +33,7 @@ end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+  spec.rcov = false
 end
 
 task :default => :spec

data/Soroban.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "soroban"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Hutchens"]
-  s.date = "2012-04-23"
+  s.date = "2012-04-24"
   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 = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     ".yardopts",
     "Gemfile",
     "Gemfile.lock",
@@ -41,13 +42,18 @@ Gem::Specification.new do |s|
     "lib/soroban/functions/sum.rb",
     "lib/soroban/functions/vlookup.rb",
     "lib/soroban/helpers.rb",
+    "lib/soroban/import.rb",
+    "lib/soroban/import/ruby_xl_importer.rb",
+    "lib/soroban/import/ruby_xl_patch.rb",
+    "lib/soroban/label_walker.rb",
     "lib/soroban/parser.rb",
     "lib/soroban/parser/grammar.rb",
     "lib/soroban/parser/grammar.treetop",
     "lib/soroban/parser/nodes.rb",
     "lib/soroban/parser/rewrite.rb",
     "lib/soroban/sheet.rb",
-    "lib/soroban/walker.rb",
+    "lib/soroban/value_walker.rb",
+    "spec/documentation_spec.rb",
     "spec/soroban_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -62,35 +68,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<treetop>, ["~> 1.4.10"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.7"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rubyXL>, ["~> 1.2.7"])
-      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_development_dependency(%q<rubyzip>, [">= 0.9.4"])
     else
       s.add_dependency(%q<treetop>, ["~> 1.4.10"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<yard>, ["~> 0.7"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<rubyXL>, ["~> 1.2.7"])
-      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<rubyzip>, [">= 0.9.4"])
     end
   else
     s.add_dependency(%q<treetop>, ["~> 1.4.10"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<yard>, ["~> 0.7"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<rubyXL>, ["~> 1.2.7"])
-    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<rubyzip>, [">= 0.9.4"])
   end
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/soroban.rb

@@ -1,3 +1,4 @@
 require 'soroban/sheet'
 require 'soroban/cell'
 require 'soroban/error'
+require 'soroban/import'

data/lib/soroban/cell.rb

@@ -11,9 +11,9 @@ module Soroban
 
     # Cells are initialised with a binding to allow formulas to be executed
     # within the context of the sheet which ownes the cell.
-    def initialize(binding)
+    def initialize(context)
       @dependencies = []
-      @binding = binding
+      @binding = context
       @touched = false
     end
 

data/lib/soroban/helpers.rb

@@ -37,9 +37,16 @@ module Soroban
     /^([a-zA-Z]+)([\d]+):([a-zA-Z]+)([\d]+)$/.match(range.to_s).to_a[1..-1]
   end
 
+  # Return the row and column index of the given label.
+  def self.getPos(label)
+    # TODO: fix for labels such as "BC42"
+    match = /^([a-zA-Z]+)([\d]+)$/.match(label.to_s)
+    return match[2].to_i - 1, match[1].upcase[0]-"A"[0]
+  end
+
   # Return an array of values for the supplied arguments (which may be numbers, labels and ranges).
-  def self.getValues(binding, *args)
-    args.map { |arg| Soroban::range?(arg) ? Walker.new(arg, binding).map : arg }.flatten
+  def self.getValues(context, *args)
+    args.map { |arg| Soroban::range?(arg) ? ValueWalker.new(arg, context).to_a : arg }.to_a.flatten
   end
 
 end

data/lib/soroban/import.rb

@@ -0,0 +1 @@
+require 'soroban/import/ruby_xl_importer'

data/lib/soroban/import/ruby_xl_importer.rb

@@ -0,0 +1,56 @@
+module Soroban
+  module Import
+
+    # Use the RubyXL gem to load an xlsx file, returning a new Soroban::Sheet
+    # object. Specify the path to the xlsx file, the index of the sheet to be
+    # imported, and a hash of name => label bindings.
+    def self.rubyXL(path, sheet, bindings)
+      require 'rubyXL'
+      require 'soroban/import/ruby_xl_patch'
+      RubyXLImporter.new(path, sheet, bindings).import
+    end
+
+    private
+
+    class RubyXLImporter
+
+      def initialize(path, index, bindings)
+        @path, @index, @bindings = path, index, bindings
+      end
+
+      def import
+        workbook = RubyXL::Parser.parse(@path)
+        @sheet = workbook.worksheets[@index]
+        @model = Soroban::Sheet.new
+        @bindings.values.each do |label_or_range|
+          if Soroban::range?(label_or_range)
+            LabelWalker.new(label_or_range).each do |label|
+              _addCell(label)
+            end
+          else
+            _addCell(label_or_range)
+          end
+        end
+        while label = @model.missing.first
+          _addCell(label)
+        end
+        @model.bind(@bindings)
+        return @model
+      end
+
+      private
+
+      def _addCell(label)
+        row, col = Soroban::getPos(label)
+        cell = @sheet[row][col]
+        data = cell.formula rescue nil
+        data = "=#{data}" unless data.nil?
+        data ||= cell.value.to_s rescue nil
+        puts "#{label} => #{row},#{col} = #{data}"
+        @model.set(label.to_sym => data)
+      end
+
+    end
+
+  end
+end

data/lib/soroban/import/ruby_xl_patch.rb

@@ -0,0 +1,7 @@
+module RubyXL
+  class Cell < PrivateClass
+    def is_date?
+      return false
+    end
+  end
+end

data/lib/soroban/label_walker.rb

@@ -0,0 +1,24 @@
+module Soroban
+
+  # An enumerable that allows cells in a range to be visited.
+  class LabelWalker
+
+    include Enumerable
+
+    # Create a new walker from a supplied range.
+    def initialize(range)
+      @fc, @fr, @tc, @tr = Soroban::getRange(range)
+    end
+
+    # Yield the label of each cell referenced by the supplied range.
+    def each
+      (@fc..@tc).each do |col|
+        (@fr..@tr).each do |row|
+          yield "#{col}#{row}"
+        end
+      end
+    end
+
+  end
+
+end

data/lib/soroban/sheet.rb

@@ -1,6 +1,7 @@
 require 'soroban/helpers'
 require 'soroban/functions'
-require 'soroban/walker'
+require 'soroban/label_walker'
+require 'soroban/value_walker'
 require 'soroban/cell'
 
 module Soroban
@@ -27,51 +28,70 @@ module Soroban
     end
 
     # Set the contents of one or more cells or ranges.
-    def set(label_or_range, contents)
-      unless range = Soroban::getRange(label_or_range)
-        return _add(label_or_range, contents)
-      end
-      fc, fr, tc, tr = range
-      if fc == tc || fr == tr
-        raise ArgumentError, "Expecting an array when setting #{label_or_range}" unless contents.kind_of? Array
-        cc, cr = fc, fr
-        contents.each do |item|
-          set("#{cc}#{cr}", item)
-          cc.next! if fr == tr
-          cr.next! if fc == tc
+    def set(options_hash)
+      options_hash.each do |label_or_range, contents|
+        unless range = Soroban::getRange(label_or_range)
+          return _add(label_or_range, contents)
+        end
+        fc, fr, tc, tr = range
+        if fc == tc || fr == tr
+          raise ArgumentError, "Expecting an array when setting #{label_or_range}" unless contents.kind_of? Array
+          cc, cr = fc, fr
+          contents.each do |item|
+            set("#{cc}#{cr}" => item)
+            cc.next! if fr == tr
+            cr.next! if fc == tc
+          end
+          raise Soroban::RangeError, "Supplied array doesn't match range length" if cc != tc && cr != tr
+        else
+          raise ArgumentError, "Can only set cells or 1-dimensional ranges of cells"
         end
-        raise Soroban::RangeError, "Supplied array doesn't match range length" if cc != tc && cr != tr
-      else
-        raise ArgumentError, "Can only set cells or 1-dimensional ranges of cells"
       end
     end
 
     # Retrieve the contents of a cell.
     def get(label_or_name)
-      _get(label_or_name, eval("@#{label_or_name}", binding))
+      label = @bindings[label_or_name.to_sym] || label_or_name
+      if Soroban::range?(label)
+        walk(label)
+      else
+        _get(label_or_name, eval("@#{label}", binding))
+      end
     end
 
     # Bind one or more named variables to a cell.
-    def bind(name, label)
-      unless @cells.keys.include?(label.to_sym)
-        raise Soroban::UndefinedError, "Cannot bind '#{name}' to non-existent cell '#{label}'"
+    def bind(options_hash)
+      options_hash.each do |name, label_or_range|
+        if Soroban::range?(label_or_range)
+          LabelWalker.new(label_or_range).each do |label|
+            next if @cells.keys.include?(label.to_sym)
+            raise Soroban::UndefinedError, "Cannot bind '#{name}' to range '#{label_or_range}'; cell #{label} is not defined"
+          end
+          _bind_range(name, label_or_range)
+        else
+          unless @cells.keys.include?(label_or_range.to_sym)
+            raise Soroban::UndefinedError, "Cannot bind '#{name}' to non-existent cell '#{label_or_range}'"
+          end
+          _bind(name, label_or_range)
+        end
       end
-      _bind(name, label)
     end
 
     # Visit each cell in the supplied range, yielding its value.
     def walk(range)
-      Walker.new(range, binding)
+      ValueWalker.new(range, binding)
     end
 
     # Return a hash of `label => contents` for each cell in the sheet.
     def cells
-      Hash[@cells.keys.map { |label| label.to_s }.zip( @cells.keys.map { |label| eval("@#{label}.excel") } )]
+      labels = @cells.keys.map { |label| label.to_sym }
+      contents = labels.map { |label| eval("@#{label}.excel") }
+      Hash[labels.zip(contents)]
     end
 
     # Return a list of referenced but undefined cells.
     def missing
-      @cells.values.map.flatten.uniq - @cells.keys
+      @cells.values.flatten.uniq - @cells.keys
     end
 
   private
@@ -84,14 +104,16 @@ module Soroban
       instance_variable_set(internal, cell)
     end
 
-    def _set(label, cell, contents)
+    def _set(label_or_name, cell, contents)
+      label = label_or_name.to_sym
+      name = @bindings[label] || label
       cell.set(contents)
-      @cells[label.to_sym] = cell.dependencies
+      @cells[name] = cell.dependencies
     end
 
     def _get(label_or_name, cell)
       label = label_or_name.to_sym
-      name = @cells[label] ? label : @bindings[label]
+      name = @bindings[label] || label
       badref = @cells[name] & missing
       raise Soroban::UndefinedError, "Unmet dependencies #{badref.join(', ')} for #{label}" if badref.length > 0
       cell.get
@@ -103,6 +125,15 @@ module Soroban
       _expose(internal, name)
     end
 
+    def _bind_range(name, range)
+      @bindings[name.to_sym] = range.to_s
+      instance_eval <<-EOV, __FILE__, __LINE__ + 1
+        def #{name}
+          walk("#{range}")
+        end
+      EOV
+    end
+
     def _expose(internal, name)
       instance_eval <<-EOV, __FILE__, __LINE__ + 1
         def #{name}

data/lib/soroban/value_walker.rb

@@ -0,0 +1,50 @@
+module Soroban
+
+  # An enumerable that allows cells in a range to be visited.
+  class ValueWalker
+
+    include Enumerable
+
+    # Create a new walker from a supplied range and binding. The binding is
+    # required when calculating the value of each visited cell.
+    def initialize(range, context)
+      @range, @binding = range, context
+      @walker = LabelWalker.new(range)
+    end
+
+    # Yield the value of each cell referenced by the supplied range.
+    def each
+      @walker.each { |label| yield eval("get('#{label}')", @binding) }
+    end
+
+    # Retrieve the value of a cell within the range by index
+    def [](index)
+      labels = @walker.to_a
+      if index < 0 || index >= labels.length
+        raise Soroban::RangeError, "Index #{index} falls outside of '#{@range}'"
+      end
+      eval("get('#{labels[index]}')", @binding)
+    end
+
+    # Set the value of a cell within the range by index
+    def []=(index, value)
+      count = 0
+      @walker.each do |label|
+        if index == count
+          eval("@#{label}.set('#{value}')", @binding)
+          return value
+        end
+        count += 1
+      end
+      raise Soroban::RangeError, "Index #{index} falls outside of '#{@range}'"
+    end
+
+    # Display the range if the user outputs the binding directly
+    def to_s
+      @range
+    end
+    alias inspect to_s
+
+  end
+
+end

data/spec/documentation_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Documentation" do
+
+  it "has documentation that works as advertised" do
+
+    # Example Usage
+
+    s = Soroban::Sheet.new()
+
+    s.A1 = 2
+    s.set('B1:B5' => [1,2,3,4,5])
+    s.C1 = "=SUM(A1, B1:B5, 5) + A1 ^ 3"
+    s.C2 = "=IF(C1>30,'Large','Tiny')"
+
+    puts s.C1             # => 30
+    s.C1.should eq(30)
+
+    s.bind(:input => :A1, :output => :C2)
+
+    puts s.output         # => "Tiny"
+    s.output.should eq('Tiny')
+
+    s.input = 3
+
+    puts s.output         # => "Large"
+    s.output.should eq('Large')
+    puts s.C1             # => 50
+    s.C1.should eq(50)
+
+    # Bindings
+
+    s.set(:A1 => 'hello', 'B1:B5' => [1,2,3,4,5])
+
+    s.bind(:foo => :A1, :bar => 'B1:B5')
+
+    puts s.foo            # => 'hello'
+    s.foo.should eq('hello')
+    puts s.bar[0]         # => 1
+    s.bar[0].should eq(1)
+
+    s.bar[0] = 'howdy'
+    s.bar[0].should eq('howdy')
+
+    puts s.B1             # => 'howdy'
+    s.B1.should eq('howdy')
+
+    # Persistence
+
+    s.F1 = "= E1 + SUM(D1:D5)"
+
+    s.missing             # => [:E1, :D1, :D2, :D3, :D4, :D5]
+    expected = [:E1, :D1, :D2, :D3, :D4, :D5]
+    s.missing.should =~ expected
+
+    s.E1 = "= D1 ^ D2"
+    s.set("D1:D5" => [1,2,3,4,5])
+
+    s.missing             # => []
+    expected = []
+    s.missing.should =~ expected
+
+    s.cells               # => {"F1"=>"= E1 + SUM(D1:D5)", "E1"=>"= D1 ^ D2", "D1"=>"1", "D2"=>"2", "D3"=>"3", "D4"=>"4", "D5"=>"5"}
+
+    # Importers
+
+    # (TBD)
+
+    # Iteration
+
+    s.set('D1:D5' => [1,2,3,4,5])
+    s.walk('D1:D5').reduce(:+)    # => 15
+    s.walk('D1:D5').reduce(:+).should eq(15)
+
+    # Functions
+
+    Soroban::functions            # => ["MIN", "VLOOKUP", "AND", "MAX", "OR", "NOT", "IF", "AVERAGE", "SUM"] 
+
+    Soroban::define :FOO => lambda { |lo, hi|
+      raise ArgumentError if lo > hi
+        rand(hi-lo) + lo
+    }
+
+    s.g = "=FOO(10, 20)"
+
+    puts s.g              # => 17
+
+  end
+
+end

data/spec/soroban_spec.rb

@@ -23,7 +23,7 @@ describe "Soroban" do
   end
 
   it "can set a value" do
-    sheet.set(:foo, 'hello')
+    sheet.set(:foo => 'hello')
     sheet.foo.should eq('hello')
   end
 
@@ -33,38 +33,48 @@ describe "Soroban" do
   end
 
   it "can set an array" do
-    sheet.set("A1:A5", [ 1, 2, 3, 4, 5 ])
-    sheet.B1 = '=SUM(A1:A5)'
-    sheet.B1.should eq(15)
+    sheet.set("A1:A5" => [ 1, 2, 3, 4, 5 ])
+    sheet.set("B2" => 5)
+    sheet.B1 = '=SUM(10, A1:A5, B2)'
+    sheet.B1.should eq(30)
   end
 
   it "can set a hash" do
-    sheet.set("A1:A3", [ 'one', 'two', 'three' ])
-    sheet.set("B1:B3", [ 'mop', 'hai', 'bah' ])
+    sheet.set("A1:A3" => [ 'one', 'two', 'three' ], "B1:B3" => [ 'mop', 'hai', 'bah' ])
     sheet.C1 = '=VLOOKUP("two", A1:B3, 2, 0)'
     sheet.C1.should eq('hai')
   end
 
   it "can iterate over all cells" do
-    sheet.set("A1:A3", [ 1, 2, 3 ])
-    sheet.set("B1:B3", [ 4, 5, 6 ])
-    sheet.set("C1:C3", [ 7, 8, 9 ])
+    sheet.set("A1:A3" => [ 1, 2, 3 ], "B1:B3" => [ 4, 5, 6 ], "C1:C3" => [ 7, 8, 9 ])
     sheet.cells.map { |label, contents| contents.to_i }.sort.should eq [1,2,3,4,5,6,7,8,9]
   end
 
   it "can bind variables to cells" do
     sheet.A1 = 0
     sheet.A2 = "=A1^2"
-    sheet.bind(:input, :A1)
-    sheet.bind(:output, :A2)
+    sheet.bind(:input => :A1, :output => :A2)
     sheet.input = 5
     sheet.output.should eq(25)
+    sheet.get(:input).should eq(5)
     sheet.bindings.keys.should include :input
     sheet.bindings.keys.should include :output
     sheet.bindings.values.should include :A1
     sheet.bindings.values.should include :A2
   end
 
+  it "can bind variables to ranges" do
+    sheet.set("X1:X5" => [1,2,3,4,5], "Z1:Z5" => [6,7,8,9,0])
+    sheet.bind(:foo => "X1:X5", :bar => "Z1:Z5")
+    sheet.foo[0].should eq(1)
+    sheet.foo[4].should eq(5)
+    sheet.bar[0].should eq(6)
+    sheet.bar[3].should eq(9)
+    sheet.bar[4].should eq(0)
+    sheet.bar[2] = 'foo'
+    sheet.Z3.should eq('foo')
+  end
+
   it "can define new functions" do
     Soroban::define :FOO => lambda { |a, b| 2 * a + b / 2 }
     sheet.A1 = 7
@@ -90,7 +100,7 @@ describe "Soroban" do
 
   it "can reject valid ruby code in formulas" do
     lambda {
-      sheet.set(:A1, "=3**2")
+      sheet.set(:A1 => "=3**2")
     }.should raise_error(Soroban::ParseError)
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soroban
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason Hutchens
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-23 00:00:00 Z
+date: 2012-04-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -41,120 +41,46 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 47
+        hash: 17
         segments: 
+        - 1
         - 2
-        - 8
-        - 0
-        version: 2.8.0
+        - 7
+        version: 1.2.7
   version_requirements: *id002
-  name: rspec
+  name: rubyXL
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 7
-        version: "0.7"
-  version_requirements: *id003
-  name: yard
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 3
-        - 12
-        version: "3.12"
-  version_requirements: *id004
-  name: rdoc
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 1
-        - 3
-        version: 1.1.3
-  version_requirements: *id005
-  name: bundler
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 1
-        - 8
-        - 3
-        version: 1.8.3
-  version_requirements: *id006
-  name: jeweler
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id007
-  name: rcov
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 15
         segments: 
         - 1
-        - 2
-        - 7
-        version: 1.2.7
-  version_requirements: *id008
-  name: rubyXL
+        - 4
+        - 4
+        version: 1.4.4
+  version_requirements: *id003
+  name: nokogiri
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 51
         segments: 
         - 0
-        version: "0"
-  version_requirements: *id009
-  name: redcarpet
+        - 9
+        - 4
+        version: 0.9.4
+  version_requirements: *id004
+  name: rubyzip
 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
 executables: []
@@ -167,6 +93,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - Gemfile.lock
@@ -189,13 +116,18 @@ files:
 - lib/soroban/functions/sum.rb
 - lib/soroban/functions/vlookup.rb
 - lib/soroban/helpers.rb
+- lib/soroban/import.rb
+- lib/soroban/import/ruby_xl_importer.rb
+- lib/soroban/import/ruby_xl_patch.rb
+- lib/soroban/label_walker.rb
 - lib/soroban/parser.rb
 - lib/soroban/parser/grammar.rb
 - lib/soroban/parser/grammar.treetop
 - lib/soroban/parser/nodes.rb
 - lib/soroban/parser/rewrite.rb
 - lib/soroban/sheet.rb
-- lib/soroban/walker.rb
+- lib/soroban/value_walker.rb
+- spec/documentation_spec.rb
 - spec/soroban_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/agworld/soroban

data/lib/soroban/walker.rb

@@ -1,26 +0,0 @@
-module Soroban
-
-  # An enumerable that allows cells in a range to be visited.
-  class Walker
-
-    include Enumerable
-
-    # Create a new walker from a supplied range and binding. The binding is
-    # required when calculating the value of each visited cell.
-    def initialize(range, binding)
-      @binding = binding
-      @fc, @fr, @tc, @tr = Soroban::getRange(range)
-    end
-
-    # Yield the value of each cell referenced by the supplied range.
-    def each
-      (@fc..@tc).each do |col|
-        (@fr..@tr).each do |row|
-          yield eval("@#{col}#{row}.get", @binding)
-        end
-      end
-    end
-
-  end
-
-end