soroban 0.7.3 → 0.8.0

data/lib/soroban/parser/grammar.treetop

@@ -1,68 +1,72 @@
-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 / '-' float / '-' integer )
-  end
-  rule float
-    [0-9]* '.' [0-9]+ <FloatValue>
-  end
-  rule integer
-    [0-9]+ <IntegerValue>
-  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
+module Soroban
+
+  grammar Excel
+    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 / '-' float / '-' integer )
+    end
+    rule float
+      [0-9]* '.' [0-9]+ <FloatValue>
+    end
+    rule integer
+      [0-9]+ <IntegerValue>
+    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
+
 end

data/lib/soroban/parser/nodes.rb

@@ -1,70 +1,72 @@
 module Soroban
+  module Excel
 
-  class Formula < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      value.gsub(/^= */, '')
+    class Formula < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        value.gsub(/^= */, '')
+      end
     end
-  end
 
-  class Identifier < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "@#{value}.get"
-    end
-    def extract(value)
-      value.to_sym
+    class Identifier < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "@#{value}.get"
+      end
+      def extract_labels(value)
+        value.to_sym
+      end
     end
-  end
 
-  class IntegerValue < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "#{value.to_f}"
+    class IntegerValue < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "#{value.to_f}"
+      end
     end
-  end
 
-  class FloatValue < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "#{value.to_f}"
+    class FloatValue < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "#{value.to_f}"
+      end
     end
-  end
 
-  class Function < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      match = /^([^(]*)(.*)$/.match(value)
-      "func_#{match[1].downcase}#{match[2]}"
+    class Function < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        match = /^([^(]*)(.*)$/.match(value)
+        "func_#{match[1].downcase}#{match[2]}"
+      end
     end
-  end
 
-  class Pow < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "**"
+    class Pow < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "**"
+      end
     end
-  end
 
-  class Equal < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "=="
+    class Equal < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "=="
+      end
     end
-  end
 
-  class NotEqual < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "!="
+    class NotEqual < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "!="
+      end
     end
-  end
 
-  class Label < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      value.gsub('$', '')
+    class Label < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        value.gsub('$', '')
+      end
     end
-  end
 
-  class Range < Treetop::Runtime::SyntaxNode
-    def rewrite_ruby(value)
-      "'#{value}'"
+    class Range < Treetop::Runtime::SyntaxNode
+      def rewrite_ruby(value)
+        "'#{value}'"
+      end
+      def extract_labels(value)
+        Soroban::LabelWalker.new(value).map { |label| "#{label}".to_sym }
+      end
     end
-    def extract(value)
-      LabelWalker.new(value).map { |label| "#{label}".to_sym }
-    end
-  end
 
+  end
 end

data/lib/soroban/parser/rewrite.rb

@@ -1,36 +1,43 @@
 module Treetop
   module Runtime
-    class SyntaxNode
 
-      def to_ruby(dependencies)
+    # Each node in the AST produced by the treetop parser implements to_ruby,
+    # which allows the Soroban sheet to store the ruby version of the Excel
+    # contents of each cell in the sheet (and which also gathers and stores the
+    # dependencies that call has on other cells). Each concrete syntax node may
+    # override rewrite_ruby and extract_labels.
+    class SyntaxNode
+      def to_ruby(cell)
         if nonterminal?
           value = ""
-          elements.each { |element| value << element.to_ruby(dependencies) }
-          _add_dependency(dependencies, extract(value))
+          elements.each { |element| value << element.to_ruby(cell) }
+          _add_dependency(cell, value)
           rewrite_ruby(value)
         else
-          _add_dependency(dependencies, extract(text_value))
+          _add_dependency(cell, text_value)
           rewrite_ruby(text_value)
         end
       end
 
+      # Return the ruby version of the Excel value. By default this does
+      # nothing; see nodes.rb for concrete implementations. 
       def rewrite_ruby(value)
         value
       end
 
-      def extract(value)
+      # Return either a single label of the form :A1, or an array of labels of
+      # the form [:B1, :B2, ...]. This is used to keep track of the dependencies
+      # of this particular cell.
+      def extract_labels(value)
+        nil
       end
 
     private
 
-      def _add_dependency(dependencies, value)
-        return if value.nil?
-        dependencies << value
-        dependencies.flatten!
-        dependencies.compact!
-        dependencies.uniq!
+      def _add_dependency(cell, value)
+        cell.add_dependencies(extract_labels(value))
       end
-
     end
+
   end
 end

data/lib/soroban/sheet.rb

@@ -1,22 +1,26 @@
+unless defined?(Set)
+  require 'set'
+end
+
+require 'soroban/errors'
 require 'soroban/helpers'
 require 'soroban/functions'
+require 'soroban/cell'
 require 'soroban/label_walker'
 require 'soroban/value_walker'
-require 'soroban/cell'
-
-require 'set'
 
 module Soroban
 
-  # A container for cells.
+  # A container for cells. This is what the end user of Soroban will manipulate,
+  # either directly or via an importer that returns a Sheet instance.
   class Sheet
     attr_reader :bindings
 
     # Creates a new sheet.
     def initialize(logger=nil)
-      @logger = logger
-      @cells = {}
-      @changes = Hash.new{ |h, k| h[k] = Set.new }
+      @_logger = logger
+      @_cells = {}
+      @_changes = Hash.new { |h, k| h[k] = Set.new }
       @bindings = {}
     end
 
@@ -24,7 +28,7 @@ module Soroban
     # cells (via `label=`).
     def method_missing(method, *args, &block)
       if match = /^func_(.*)$/i.match(method.to_s)
-        return Soroban::call(self, match[1], *args)
+        return Soroban::Functions.call(self, match[1], *args)
       elsif match = /^([a-z][\w]*)=$/i.match(method.to_s)
         return _add(match[1], args[0])
       end
@@ -35,11 +39,11 @@ module Soroban
     def set(options_hash)
       options_hash.each do |label_or_range, contents|
         _debug("setting '#{label_or_range}' to '#{contents}'")
-        unless range = Soroban::getRange(label_or_range)
+        unless Soroban::Helpers.range?(label_or_range)
           _add(label_or_range, contents)
           next
         end
-        fc, fr, tc, tr = range
+        fc, fr, tc, tr = Soroban::Helpers.getRange(label_or_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
@@ -59,7 +63,7 @@ module Soroban
     def get(label_or_name)
       label = @bindings[label_or_name.to_sym] || label_or_name
       _debug("retrieving '#{label_or_name}' from '#{label}'}")
-      if Soroban::range?(label)
+      if Soroban::Helpers.range?(label)
         walk(label)
       else
         _get(label_or_name, eval("@#{label}", binding))
@@ -70,14 +74,14 @@ module Soroban
     def bind(options_hash)
       options_hash.each do |name, label_or_range|
         _debug("binding '#{name}' to '#{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)
+        if Soroban::Helpers.range?(label_or_range)
+          Soroban::LabelWalker.new(label_or_range).each do |label|
+            next if @_cells.has_key?(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)
+          unless @_cells.has_key?(label_or_range.to_sym)
             raise Soroban::UndefinedError, "Cannot bind '#{name}' to non-existent cell '#{label_or_range}'"
           end
           _bind(name, label_or_range)
@@ -87,34 +91,34 @@ module Soroban
 
     # Visit each cell in the supplied range, yielding its value.
     def walk(range)
-      ValueWalker.new(range, binding)
+      Soroban::ValueWalker.new(range, binding)
     end
 
     # Return a hash of `label => contents` for each cell in the sheet.
     def cells
-      labels = @cells.keys.map { |label| label.to_sym }
+      labels = @_cells.keys.map(&:to_sym)
       contents = labels.map { |label| eval("@#{label}.excel") }
       Hash[labels.zip(contents)]
     end
 
-    # Return a list of referenced but undefined cells.
+    # Return an array of referenced but undefined cells.
     def missing
-      @cells.values.flatten.uniq - @cells.keys
+      (@_cells.values.reduce(:|) - @_cells.keys).to_a
     end
 
   private
 
     def _debug(message)
-      return if @logger.nil?
-      @logger.debug "SOROBAN: #{message}"
+      return if @_logger.nil?
+      @_logger.debug "SOROBAN: #{message}"
     end
 
     def _link(name, dependencies)
-      dependencies.each { |target| @changes[target] << name if name != target }
+      dependencies.each { |target| @_changes[target] << name if name != target }
     end
 
     def _unlink(name, dependencies)
-      dependencies.each { |target| @changes[target].delete(name) }
+      dependencies.each { |target| @_changes[target].delete(name) }
     end
 
     def _add(label, contents)
@@ -126,7 +130,7 @@ module Soroban
       end
       internal = "@#{label}"
       _expose(internal, label)
-      cell = Cell.new(binding)
+      cell = Soroban::Cell.new(binding)
       _set(label, cell, contents)
       instance_variable_set(internal, cell)
     end
@@ -136,14 +140,14 @@ module Soroban
       name = @bindings[label] || label
       _unlink(name, cell.dependencies)
       cell.set(contents)
-      @cells[name] = cell.dependencies
+      @_cells[name] = cell.dependencies
       _link(name, cell.dependencies)
       _clear(name)
     end
 
     def _clear(name)
-      @changes[name].each do |target|
-        next unless @cells.has_key?(target)
+      @_changes[name].each do |target|
+        next unless @_cells.has_key?(target)
         begin
           eval("@#{target.to_s}.clear")
           _clear(target)
@@ -155,8 +159,8 @@ module Soroban
     def _get(label_or_name, cell)
       label = label_or_name.to_sym
       name = @bindings[label] || label
-      badref = @cells[name] & missing
-      raise Soroban::UndefinedError, "Unmet dependencies #{badref.join(', ')} for #{label}" if badref.length > 0
+      badref = @_cells[name] & missing
+      raise Soroban::UndefinedError, "Unmet dependencies #{badref.to_a.join(', ')} for #{label}" if badref.length > 0
       cell.get
     end