Soroban 0.1.0

data/lib/soroban/parser/grammar.treetop

@@ -0,0 +1,68 @@
+grammar Soroban
+  rule formula
+    '=' space? logical <Formula> / string / number / boolean
+  end
+  rule logical
+    and ( space? 'or' space? and )*
+  end
+  rule and
+    truthval ( space? 'and' space? truthval )*
+  end
+  rule truthval
+    comparison / '(' space? logical space? ')' / boolean
+  end
+  rule boolean
+    'true' / 'false' / 'TRUE' / 'FALSE'
+  end
+  rule comparison
+    expression ( space? comparator space? expression )*
+  end
+  rule comparator
+    '=' <Equal> / '<>' <NotEqual> / '>=' / '<=' / '>' / '<'
+  end
+  rule expression
+    multiplicative ( space? additive_operator space? multiplicative )*
+  end
+  rule additive_operator
+    '+' / '-'
+  end
+  rule multiplicative
+    value ( space? multiplicative_operator space? value )*
+  end
+  rule multiplicative_operator
+    '^' <Pow> / '*' / '/'
+  end
+  rule value
+    ( function / '(' space? expression space? ')' / range / number / boolean / identifier / string / '-' value )
+  end
+  rule function
+    [a-zA-Z]+ '(' space? arguments? space? ')' <Function>
+  end
+  rule arguments
+    logical ( space? ',' space? logical )*
+  end
+  rule number
+    float / integer
+  end
+  rule float
+    [0-9]* '.' [0-9]+
+  end
+  rule integer
+    [0-9]+
+  end
+  rule identifier
+    [a-zA-Z] [a-zA-Z0-9]* <Identifier>
+  end
+  rule label
+    [A-Za-z]+ [1-9] [0-9]* <Label> / '$' [A-Za-z]+ '$' [1-9] [0-9]* <Label>
+  end
+  rule string
+    '"' ('\"' / !'"' .)* '"' / "'" [^']* "'"
+  end
+  rule range
+    label ':' label <Range>
+  end
+  rule space
+    [\s]+
+  end
+end

data/lib/soroban/parser/nodes.rb

@@ -0,0 +1,65 @@
+module Soroban
+
+  class Formula < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      value.gsub(/^= */, '')
+    end
+  end
+
+  class Identifier < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      "@#{value}.get"
+    end
+    def extract(value)
+      value.to_sym
+    end
+  end
+
+  class Function < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      match = /^([^(]*)(.*)$/.match(value)
+      "func_#{match[1].downcase}#{match[2]}"
+    end
+  end
+
+  class Pow < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      "**"
+    end
+  end
+
+  class Equal < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      "=="
+    end
+  end
+
+  class NotEqual < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      "!="
+    end
+  end
+
+  class Label < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      value.gsub('$', '')
+    end
+  end
+
+  class Range < Treetop::Runtime::SyntaxNode
+    def rewrite(value)
+      "'#{value}'"
+    end
+    def extract(value)
+      fc, fr, tc, tr = Soroban::getRange(value) 
+      retval = []
+      (fc..tc).each do |cc|
+        (fr..tr).each do |cr|
+          retval << "#{cc}#{cr}".to_sym
+        end
+      end
+      retval
+    end
+  end
+
+end

data/lib/soroban/parser/rewrite.rb

@@ -0,0 +1,36 @@
+module Treetop
+  module Runtime
+    class SyntaxNode
+
+      def convert(dependencies)
+        if nonterminal?
+          value = ""
+          elements.each { |element| value << element.convert(dependencies) }
+          _add_dependency(dependencies, extract(value))
+          rewrite(value)
+        else
+          _add_dependency(dependencies, extract(text_value))
+          rewrite(text_value)
+        end
+      end
+
+      def rewrite(value)
+        value
+      end
+
+      def extract(value)
+      end
+
+    private
+
+      def _add_dependency(dependencies, value)
+        return if value.nil?
+        dependencies << value
+        dependencies.flatten!
+        dependencies.compact!
+        dependencies.uniq!
+      end
+
+    end
+  end
+end

data/lib/soroban/sheet.rb

@@ -0,0 +1,119 @@
+require 'soroban/helpers'
+require 'soroban/functions'
+require 'soroban/walker'
+require 'soroban/cell'
+
+module Soroban
+
+  # A container for cells.
+  class Sheet
+    attr_reader :bindings
+
+    # Creates a new sheet.
+    def initialize
+      @cells = {}
+      @bindings = {}
+    end
+
+    # Used for calling dynamically defined functions, and for creating new
+    # cells (via `label=`).
+    def method_missing(method, *args, &block)
+      if match = /^func_(.*)$/i.match(method.to_s)
+        return Soroban::call(self, match[1], *args)
+      elsif match = /^([a-z][\w]*)=$/i.match(method.to_s)
+        return _add(match[1], args[0])
+      end
+      super
+    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
+        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))
+    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}'"
+      end
+      _bind(name, label)
+    end
+
+    # Visit each cell in the supplied range, yielding its value.
+    def walk(range)
+      Walker.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") } )]
+    end
+
+    # Return a list of referenced but undefined cells.
+    def missing
+      @cells.values.map.flatten.uniq - @cells.keys
+    end
+
+  private
+
+    def _add(label, contents)
+      internal = "@#{label}"
+      _expose(internal, label)
+      cell = Cell.new(binding)
+      _set(label, cell, contents)
+      instance_variable_set(internal, cell)
+    end
+
+    def _set(label, cell, contents)
+      cell.set(contents)
+      @cells[label.to_sym] = cell.dependencies
+    end
+
+    def _get(label_or_name, cell)
+      label = label_or_name.to_sym
+      name = @cells[label] ? label : @bindings[label]
+      badref = @cells[name] & missing
+      raise Soroban::UndefinedError, "Unmet dependencies #{badref.join(', ')} for #{label}" if badref.length > 0
+      cell.get
+    end
+
+    def _bind(name, label)
+      @bindings[name.to_sym] = label.to_sym
+      internal = "@#{label}"
+      _expose(internal, name)
+    end
+
+    def _expose(internal, name)
+      instance_eval <<-EOV, __FILE__, __LINE__ + 1
+        def #{name}
+          _get("#{name}", #{internal})
+        end
+        def #{name}=(contents)
+          _set("#{name}", #{internal}, contents)
+        end
+      EOV
+    end
+
+  end
+
+end

data/lib/soroban/walker.rb

@@ -0,0 +1,26 @@
+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

data/spec/soroban_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Soroban" do
+
+  let(:sheet) { Soroban::Sheet.new }
+
+  it "can add two numbers" do
+    sheet.x = 2
+    sheet.y = 3
+    sheet.f = "=x+y"
+    sheet.f.should eq(5)
+    sheet.x -= 1
+    sheet.f.should eq(4)
+  end
+
+  it "can iterate over a collection of cells" do
+    sheet.A1 = 'a'
+    sheet.B1 = 'b'
+    sheet.A2 = 'c'
+    sheet.B2 = 'd'
+    data = sheet.walk('A1:B2').to_a
+    data.sort.join.should eq('abcd')
+  end
+
+  it "can set a value" do
+    sheet.set(:foo, 'hello')
+    sheet.foo.should eq('hello')
+  end
+
+  it "can get a value" do
+    sheet.foo = 'hello'
+    sheet.get(:foo).should eq('hello')
+  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)
+  end
+
+  it "can set a hash" do
+    sheet.set("A1:A3", [ 'one', 'two', 'three' ])
+    sheet.set("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.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.input = 5
+    sheet.output.should eq(25)
+    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 define new functions" do
+    Soroban::define :FOO => lambda { |a, b| 2 * a + b / 2 }
+    sheet.A1 = 7
+    sheet.A2 = 8
+    sheet.A3 = "=foo(A1, A2)"
+    sheet.A3.should eq(18)
+    Soroban::functions.should include 'FOO'
+  end
+
+  it "can report on missing cells" do
+    sheet.A3 = "=A2+foo(A3:B4)"
+    expected = [:A2, :A4, :B3, :B4 ]
+    sheet.missing.should =~ expected
+  end
+
+  it "can detect loops when running formulas" do
+    lambda {
+      sheet.A1 = "=A2"
+      sheet.A2 = "=A1"
+      sheet.A2
+    }.should raise_error(Soroban::RecursionError)
+  end
+
+  it "can reject valid ruby code in formulas" do
+    lambda {
+      sheet.set(:A1, "=3**2")
+    }.should raise_error(Soroban::ParseError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'soroban'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification 
+name: Soroban
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Hutchens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 4
+        - 10
+        version: 1.4.10
+  version_requirements: *id001
+  name: treetop
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  version_requirements: *id002
+  name: rspec
+- !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
+        segments: 
+        - 1
+        - 2
+        - 7
+        version: 1.2.7
+  version_requirements: *id008
+  name: rubyXL
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id009
+  name: redcarpet
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/soroban.rb
+- lib/soroban/cell.rb
+- lib/soroban/error.rb
+- lib/soroban/functions.rb
+- lib/soroban/functions/and.rb
+- lib/soroban/functions/average.rb
+- lib/soroban/functions/if.rb
+- lib/soroban/functions/max.rb
+- lib/soroban/functions/min.rb
+- lib/soroban/functions/not.rb
+- lib/soroban/functions/or.rb
+- lib/soroban/functions/sum.rb
+- lib/soroban/functions/vlookup.rb
+- lib/soroban/helpers.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
+- spec/soroban_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jasonhutchens/soroban
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Soroban is a calculating engine that understands Excel formulas.
+test_files: []
+