calco 0.1.0

data/lib/calco/spreadsheet.rb

@@ -0,0 +1,172 @@
+require 'singleton'
+
+require_relative 'sheet'
+require_relative 'definition_dsl'
+require_relative 'engines/default_engine'
+
+module Calco
+
+  class Spreadsheet
+
+    def initialize engine = DefaultEngine.new
+      @engine = engine
+      @sheets = []
+      @sheets_by_name = {}
+      @named_styles = {}
+      @definitions = Definitions.new(self)
+    end
+
+    def save to_filename, &data_iterator
+      @engine.save self, to_filename, &data_iterator
+    end
+
+    def definitions &block
+
+      @block_def = block
+      @definitions.instance_eval(&block)
+
+    end
+
+    def sheet name = nil, &block
+
+      if @sheets_by_name[name]
+        @current = sheet = @sheets_by_name[name]
+      else
+
+        sheet = create_sheet(name)
+
+        @sheets << sheet
+
+        name = "Sheet #{@sheets.size}" unless name
+
+        @sheets_by_name[name] = sheet
+
+      end
+
+      sheet.instance_eval(&block) if block_given?
+      sheet.compile
+
+      self
+
+    end
+
+    def percentage_style name, decimal_places, min_digits, text
+      @named_styles[name] = {type: :percentage, decimal_places: decimal_places, min_digits: min_digits, text: text}
+    end
+
+    def cell_style name, other_styles = {}
+
+      other_styles[:type] = :cell
+
+      @named_styles[name] = other_styles
+
+    end
+
+    def column_style name, width
+      @named_styles[name] = {type: :column, width: width}
+    end
+
+    def row_style name, width
+      @named_styles[name] = {type: :row, height: width}
+    end
+
+    def table_style name, styles = {}
+
+      @named_styles[:type] = :table
+
+      @named_styles[name] = styles
+
+    end
+
+    def row row_number
+      @current.row row_number
+    end
+
+    def current name_or_index = nil
+
+      if name_or_index
+        @current = find_sheet!(name_or_index)
+      elsif @current
+        @current
+      else
+        sheet
+        @current
+      end
+
+    end
+
+    def current? name_or_index
+      @current == find_sheet(name_or_index)
+    end
+
+    def [] name_or_index
+      find_sheet(name_or_index)
+    end
+
+    def find_sheet name_or_index
+
+      if name_or_index.is_a?(Fixnum)
+        @sheets[name_or_index]
+      else
+        @sheets_by_name[name_or_index]
+      end
+
+    end
+
+    def find_sheet! name_or_index
+
+      sheet = find_sheet(name_or_index)
+
+      raise "Unknown sheet '#{name_or_index}'" unless sheet
+
+      sheet
+
+    end
+
+    def row_to_hash row_number
+
+      hash = {}
+
+      cells = row(row_number)
+
+      cells.each_index do |i|
+
+        cell = cells[i]
+
+        hash[COLUMNS[i]] = cell
+
+      end
+
+      hash
+
+    end
+
+    def engine= new_engine
+
+      @engine = new_engine
+
+      @sheets.each do |sheet|
+        sheet.compile @engine
+      end
+
+    end
+
+    private
+
+    def create_sheet name
+
+        definitions = Definitions.new(self)
+
+        definitions.instance_eval(&@block_def) if @block_def
+
+        @current = Sheet.new(name, @engine)
+        @current.definitions = definitions
+        @current.owner = self
+
+        @current
+
+    end
+
+  end
+
+end

data/lib/calco/string_functions.rb

@@ -0,0 +1,9 @@
+module Calco
+
+  class BuiltinFunction
+    
+    declare :left, 2, String
+    
+  end
+  
+end

data/lib/calco/style.rb

@@ -0,0 +1,15 @@
+module Calco
+
+  class Style
+
+    def initialize statement
+      @statement = statement
+    end
+
+    def generate row
+      @engine.style(@statement, row)
+    end
+
+  end
+
+end

data/lib/calco/time_functions.rb

@@ -0,0 +1,12 @@
+require 'time'
+
+module Calco
+
+  class BuiltinFunction
+
+    declare :timevalue, 1, Time
+    declare :now, 0, Date
+
+  end
+
+end

data/lib/calco/version.rb

@@ -0,0 +1,3 @@
+module Calco
+  VERSION = "0.1.0"
+end

data/spec/absolute_references_spec.rb

@@ -0,0 +1,86 @@
+
+require 'calco'
+
+describe 'Absolute references' do
+
+  it "supports absolute references" do
+
+    doc = spreadsheet do
+
+      definitions do
+
+        set price: 14.4
+        set tax: 13
+
+        function total: price * (tax / 100 + 1)
+
+      end
+      
+      sheet do
+
+        column value_of(:price)
+        column skip
+        column :total
+
+        column skip
+        column skip
+
+        column value_of(:tax, :absolute)
+
+        tax.absolute_row = 1
+
+      end
+
+    end
+
+    row = doc.row(1)
+
+    expect(row[0]).to eq('14.4')
+    
+    expect(row[2]).to eq('A1*(($F$1/100)+1)')
+    
+    expect(row[5]).to eq('13')
+
+  end
+
+  it "only sets cell content for the absolute row" do
+
+    doc = spreadsheet do
+
+      definitions do
+
+        set tax: 13
+        set some_val: 77
+
+      end
+      
+      sheet do
+
+        column value_of(:tax, :absolute)
+        column value_of(:some_val)
+        column :some_val
+
+        tax.absolute_row = 7
+
+      end
+
+    end
+
+    row = doc.row(1)
+    expect(row[0]).to be_nil
+    expect(row[1]).to eq('77')
+    expect(row[2]).to eq("C1")
+    
+    row = doc.row(7)
+    expect(row[0]).to eq('13')
+    expect(row[1]).to eq('77')
+    expect(row[2]).to eq("C7")
+    
+    row = doc.row(8)
+    expect(row[0]).to be_nil
+    expect(row[1]).to eq('77')
+    expect(row[2]).to eq("C8")
+
+  end
+
+end

data/spec/builtin_functions_spec.rb

@@ -0,0 +1,161 @@
+require 'calco'
+
+describe 'Spreadsheet built-in functions' do
+
+  it "supports 'LEFT'" do
+
+    doc = spreadsheet do
+
+      definitions do
+
+        set name: "Miles"
+
+        function initial: left(name, 1)
+
+      end
+
+      sheet do
+
+        column value_of(:name), title: 'Name'
+        column :initial, title: 'Initial'
+
+      end
+
+    end
+
+    row = doc.row(1)
+
+    expect(row[1]).to eq('LEFT(A1, 1)')
+
+  end
+
+  it "supports 'TODAY' and 'YEAR'" do
+
+    doc = spreadsheet do
+
+      definitions do
+
+        set birth_date: "2004-09-18"
+
+        function age: year(today()) - year(birth_date)
+
+      end
+
+      sheet do
+
+        column value_of(:birth_date), title: 'Birth date'
+        column :age, title: 'Age'
+
+      end
+
+    end
+
+    row = doc.row(1)
+
+    expect(row[1]).to eq('YEAR(TODAY())-YEAR(A1)')
+
+  end
+
+  it "registers new functions" do
+
+    Calco::BuiltinFunction.declare :my_func, 0, Integer
+
+    doc = spreadsheet do
+
+      definitions do
+        function x: my_func
+      end
+
+      sheet do
+        column :x
+      end
+
+    end
+
+    row = doc.row(1)
+
+    expect(row[0]).to eq('MY_FUNC()')
+
+  end
+
+  it "complains if function does not exist" do
+
+    expect {
+
+      spreadsheet do
+
+        definitions do
+          function x: my_func(13)
+        end
+
+      end
+
+    }.to raise_error("Unknown function or variable 'my_func'")
+
+
+  end
+
+  it "complains if wrong number of arguments" do
+
+    Calco::BuiltinFunction.declare :my_func, 0, Integer
+
+    expect {
+
+      spreadsheet do
+
+        definitions do
+
+          function x: my_func(13)
+
+        end
+
+      end
+
+    }.to raise_error(ArgumentError, "Function MY_FUNC requires 0, was 1 ([13])")
+
+
+  end
+
+  it "complains if missing arguments" do
+
+    Calco::BuiltinFunction.declare :my_func, 2, Integer
+
+    expect {
+
+      spreadsheet do
+
+        definitions do
+
+          function x: my_func(13)
+
+        end
+
+      end
+
+    }.to raise_error(ArgumentError, "Function MY_FUNC requires 2, was 1 ([13])")
+
+
+  end
+
+  it "accepts variable arity for functions" do
+
+    Calco::BuiltinFunction.declare :my_func, :n, Integer
+
+    spreadsheet do
+
+      definitions do
+
+        function x: my_func(13, 12, 3)
+        function y: my_func
+
+      end
+
+    end
+
+  end
+
+  after do
+    Calco::BuiltinFunction.undeclare :my_func
+  end
+
+end