soroban 0.7.3 → 0.8.0

data/lib/soroban/value_walker.rb

@@ -1,6 +1,9 @@
+require 'soroban/errors'
+require 'soroban/label_walker'
+
 module Soroban
 
-  # An enumerable that allows cells in a range to be visited.
+  # An enumerable that allows values of cells in a range to be visited.
   class ValueWalker
 
     include Enumerable
@@ -8,40 +11,37 @@ module Soroban
     # 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)
+      @_range, @_binding = range, context
+      @_labels = Soroban::LabelWalker.new(range).to_a
     end
 
     # Yield the value of each cell referenced by the supplied range.
     def each
-      @walker.each { |label| yield eval("get('#{label}')", @binding) }
+      @_labels.each { |label| yield eval("get('#{label}')", @_binding) }
     end
 
-    # Retrieve the value of a cell within the range by index
+    # Get the value of a cell within the range by index. Will raise a RangeError
+    # if the index is outside of the range.
     def [](index)
-      labels = @walker.to_a
-      if index < 0 || index >= labels.length
-        raise Soroban::RangeError, "Index #{index} falls outside of '#{@range}'"
+      if index < 0 || index >= @_labels.length
+        raise Soroban::RangeError, "Index #{index} falls outside of '#{@_range}'"
       end
-      eval("get('#{labels[index]}')", @binding)
+      eval("get('#{@_labels[index]}')", @_binding)
     end
 
-    # Set the value of a cell within the range by index
+    # Set the value of a cell within the range by index. Will raise a RangeError
+    # if the index is outside of the range.
     def []=(index, value)
-      count = 0
-      @walker.each do |label|
-        if index == count
-          eval("@#{label}.set('#{value}')", @binding)
-          return value
-        end
-        count += 1
+      if index < 0 || index >= @_labels.length
+        raise Soroban::RangeError, "Index #{index} falls outside of '#{@_range}'"
       end
-      raise Soroban::RangeError, "Index #{index} falls outside of '#{@range}'"
+      eval("@#{@_labels[index]}.set('#{value}')", @_binding)
+      return value
     end
 
     # Display the range if the user outputs the binding directly
     def to_s
-      @range
+      @_range
     end
     alias inspect to_s
 

data/spec/documentation_spec.rb

@@ -2,93 +2,81 @@ 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()
+  let(:s) { Soroban::Sheet.new }
 
+  it "usage works" do
     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
+#   puts s.C1             # => 30
     s.C1.should eq(30)
 
     s.bind(:input => :A1, :output => :C2)
 
-    puts s.output         # => "Tiny"
+#   puts s.output         # => "Tiny"
     s.output.should eq('Tiny')
 
     s.input = 3
 
-    puts s.output         # => "Large"
+#   puts s.output         # => "Large"
     s.output.should eq('Large')
-    puts s.C1             # => 50
+#   puts s.C1             # => 50
     s.C1.should eq(50)
+  end
 
-    # Bindings
-
-    s = Soroban::Sheet.new()
-
+  it "bindings work" do
     s.set(:A1 => 'hello', 'B1:B5' => [1,2,3,4,5])
 
     s.bind(:foo => :A1, :bar => 'B1:B5')
 
-    puts s.foo            # => 'hello'
+#   puts s.foo            # => 'hello'
     s.foo.should eq('hello')
-    puts s.bar[0]         # => 1
+#   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'
+#   puts s.B1             # => 'howdy'
     s.B1.should eq('howdy')
+  end
 
-    # Persistence
-
-    s = Soroban::Sheet.new()
-
+  it "persistence works" do
     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.missing             # => [:E1, :D1, :D2, :D3, :D4, :D5]
+    s.missing.should =~ [:E1, :D1, :D2, :D3, :D4, :D5]
 
     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)
+#   s.missing             # => []
+    s.missing.should =~ []
 
-    # Iteration
+#   s.cells               # => {:F1=>"= E1 + SUM(D1:D5)", :E1=>"= D1 ^ D2", :D1=>"1", :D2=>"2", :D3=>"3", :D4=>"4", :D5=>"5"}
+    s.cells.keys.should =~ [:F1, :E1, :D1, :D2, :D3, :D4, :D5]
+    s.cells[:D3].should eq("3") 
+  end
 
+  it "iteration works" do
     s.set('D1:D5' => [1,2,3,4,5])
-    s.walk('D1:D5').reduce(:+)    # => 15
+#   s.walk('D1:D5').reduce(:+)    # => 15
     s.walk('D1:D5').reduce(:+).should eq(15)
+  end
 
-    # Functions
-
-    Soroban::functions            # => ["MIN", "VLOOKUP", "AND", "MAX", "OR", "NOT", "IF", "AVERAGE", "SUM"] 
+  it "functions work" do
+#   Soroban::functions    # => ["AND", "AVERAGE", "EXP", "IF", "LN", "MAX", "MIN", "NOT", "OR", "SUM", "VLOOKUP"]
+    Soroban::Functions.all.should =~ ["AND", "AVERAGE", "EXP", "IF", "LN", "MAX", "MIN", "NOT", "OR", "SUM", "VLOOKUP"]
 
-    Soroban::define :FOO => lambda { |lo, hi|
+    Soroban::Functions.define :FOO => lambda { |lo, hi|
       raise ArgumentError if lo > hi
-        rand(hi-lo) + lo
+      rand(hi-lo) + lo
     }
 
     s.g = "=FOO(10, 20)"
 
-    puts s.g              # => 17
-
+#   puts s.g              # => 17
+    s.g.between?(10, 20).should be_true
   end
 
 end

data/spec/import_spec.rb

@@ -1,33 +1,25 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-has_rubyxl = begin
-  Gem::Specification::find_by_name("rubyXL") 
-rescue Gem::LoadError
-  false
-end
-
-describe "Documentation", :if => has_rubyxl do
-
-  it "can import xlsx files using RubyXL" do
+describe "Documentation", :if => defined?(RubyXL) do
 
+  it "importers work" do
     BINDINGS = {
       :planet => :B1,
       :mass => :B2,
       :force => :B3
     }
 
-    s = Soroban::Import::rubyXL("files/Physics.xlsx", 0, BINDINGS )
+    s = Soroban::Import::rubyXL("files/Physics.xlsx", 0, BINDINGS)
 
     s.planet = 'Earth'
     s.mass = 80
-    puts s.force          # => 783.459251241996
+#   puts s.force          # => 783.459251241996
     s.force.should be_within(0.01).of(783.46)
 
     s.planet = 'Venus'
     s.mass = 80
-    puts s.force          # => 710.044826106394
+#   puts s.force          # => 710.044826106394
     s.force.should be_within(0.01).of(710.04)
-
   end
 
 end

data/spec/soroban_spec.rb

@@ -102,15 +102,19 @@ describe "Soroban" do
   end
 
   it "can define new functions" do
-    Soroban::define :FOO => lambda { |a, b| 2 * a + b / 2 }
+    Soroban::Functions.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'
+    Soroban::Functions.all.should include 'FOO'
   end
 
   it "can report on missing cells" do
+    sheet.A3 = "=A2"
+    expected = [:A2]
+    sheet.missing.should =~ expected
+
     sheet.A3 = "=A2+foo(A3:B4)"
     expected = [:A2, :A4, :B3, :B4 ]
     sheet.missing.should =~ expected

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rspec'
+
+begin
+  require 'RubyXL'
+rescue LoadError
+  # it is OK for the user not to have RubyXL
+end
+
 require 'soroban'
 
 # Requires supporting files with custom matchers and macros, etc,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soroban
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 3
-  version: 0.7.3
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Jason Hutchens
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-03-20 00:00:00 Z
+date: 2014-03-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: treetop
@@ -105,7 +105,7 @@ files:
 - files/Physics.xlsx
 - lib/soroban.rb
 - lib/soroban/cell.rb
-- lib/soroban/error.rb
+- lib/soroban/errors.rb
 - lib/soroban/functions.rb
 - lib/soroban/functions/and.rb
 - lib/soroban/functions/average.rb

data/lib/soroban/error.rb

@@ -1,20 +0,0 @@
-module Soroban
-
-  # Thrown if an invalid formula is assigned to a cell.
-  class ParseError < StandardError
-  end
-
-  # Thrown if calculation of a cell's formula depends on the value of the same
-  # cell.
-  class RecursionError < StandardError
-  end
-
-  # Thrown if a referenced cell falls outside the limits of a supplied range.
-  class RangeError < StandardError
-  end
-
-  # Thrown is access is attempted to an undefined cell.
-  class UndefinedError < StandardError
-  end
-
-end