calco 0.1.0

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/calco.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'calco/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "calco"
+  gem.version       = Calco::VERSION
+  gem.authors       = ["Jean Lazarou"]
+  gem.email         = ["jean.lazarou@alef1.org"]
+  gem.description   = %q{Implements a DSL used to create and define the content of spreadsheet documents}
+  gem.summary       = %q{DSL for spreadsheet documents}
+  gem.homepage      = "https://github.com/jeanlazarou/calco"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_development_dependency('rspec')
+  
+  gem.add_dependency 'rubyzip', '~> 1.1.0'
+end

data/examples/compute_cells.rb

@@ -0,0 +1,61 @@
+require 'calco/engines/simple_calculator_engine'
+
+#
+# Next example uses a SimpleCaclulatorEngine that does not produce a spreadsheet
+# with formulas but computes the calculations instead.
+#
+
+engine = Calco::SimpleCalculatorEngine.new
+
+doc = spreadsheet(engine) do
+
+  definitions do
+
+    set tax_rate: 0
+    
+    set basic_price: 0
+    set quantity: 1
+    
+    function price: (basic_price * quantity) * (1 + (tax_rate / 100.0))
+    
+  end
+  
+  sheet do
+
+    column value_of(:tax_rate, :absolute)
+
+    column value_of(:basic_price)
+    column value_of(:quantity)
+    
+    column skip
+    
+    column :price, title: 'price'
+
+    tax_rate.absolute_row = 1
+    
+  end
+  
+end
+
+data = [
+  [12, 3],
+  [10.3, 2],
+  [34, 4]
+]
+
+doc.save($stdout) do |spreadsheet|
+  
+  sheet = spreadsheet.current
+  
+  sheet[:tax_rate] = 100
+  
+  data.each_with_index do |item, i|
+    
+    sheet[:basic_price] = item[0]
+    sheet[:quantity] = item[1]
+    
+    sheet.write_row i + 1
+    
+  end
+  
+end

data/examples/data.csv

@@ -0,0 +1,8 @@
+name,birth_date
+Joe,2002/07/11
+Max,1987/06/06
+Lou,1998/11/26
+Phil,2003/01/22
+Jack,2000/02/02
+Mary,1976/12/31
+Louise,1994/09/3

data/examples/example.rb

@@ -0,0 +1,97 @@
+require 'calco'
+
+#
+# Next example shows different uses with formulas (functions) and styles.
+#
+# It 'implements' a calculator that evaluates which of the train or the car
+# is better, depending on several parameters.
+#
+# It prints out the definition.
+# It then prints out a CSV format after changing the engine.
+#
+
+require 'calco/engines/csv_engine'
+
+doc = spreadsheet do
+
+  definitions do
+
+    set distance: 20 # km
+    set fuel_price: 1.4 # €
+    set consumption: 6 # l/100km
+    set trip_duration: 50 # min
+
+    set train_price: 8 # €
+    set train_duration: 65 # min
+
+    function trip_consumption: consumption * (distance / 100)
+
+    function trip_price: consumption * fuel_price * (distance / 100)
+    function benefit: (train_price - trip_price) / train_price
+
+    function best_choice: _if(trip_duration < train_duration, 'car', 'train')
+
+  end
+
+  sheet do
+
+    column value_of(:distance), :title => 'km'
+    column value_of(:trip_duration), :title => 'min'
+    column skip
+
+    column value_of(:train_price), type: '$EUR', :title => 'train'
+    column value_of(:train_duration), :title => 'min'
+    column skip
+
+    column :trip_consumption, :title => 'L'
+    column :trip_price, style: _if(current > train_price, 'Red', 'default'), type: '$EUR', :title => 'price'
+    column :benefit, :type => '%', :title => 'benefit'
+    column skip
+
+    column :best_choice, :title => 'choice'
+    column skip
+
+    column value_of(:fuel_price), type: '$EUR', :title => 'fuel price (1L)'
+    column value_of(:consumption), :title => 'L/100km'
+
+  end
+
+end
+
+puts "Layout definition:"
+
+doc.current[:distance] = 40
+cells = doc.row(3)
+
+cells.each_index do |i|
+
+  print "  #{Calco::COLUMNS[i]}: "
+
+  cell = cells[i]
+
+  puts cell
+
+end
+
+puts "\nCSV output:"
+
+data = [
+  {:distance => 40, :trip_duration => 30, :train_price => 10, :train_duration => 30, :fuel_price => 1.8, :consumption => 7},
+  {:distance => 25, :trip_duration => 30, :train_price => 19, :train_duration => 70, :fuel_price => 1.3, :consumption => 5.4},
+]
+
+doc.engine = Calco::CSVEngine.new
+
+doc.save($stdout) do |spreadsheet|
+
+  sheet = doc.current
+
+  sheet.write_row 0
+
+  data.each_with_index do |entry, i|
+
+    sheet.write_row i + 1, entry
+
+  end
+
+end

data/examples/multiplication_tables.rb

@@ -0,0 +1,73 @@
+require 'date'
+require 'tmpdir'
+
+#
+# Next example shows the use of the office engine, no headers and empty row.
+#
+# It saves an office file in the temporary directory named "res.ods" and uses
+# a template file named "multiplication_tables.ods"
+#
+
+require 'calco/engines/office_engine'
+
+output_file = File.join(Dir.tmpdir, "res.ods")
+
+def relative_path file
+  File.join(File.dirname(__FILE__), file)
+end
+
+engine = Calco::OfficeEngine.new(relative_path('multiplication_tables.ods'), false)
+
+doc = spreadsheet(engine) do
+
+  definitions do
+
+    set multiplicand: 7
+    set multiplier: 0
+    
+    function result: multiplicand * multiplier
+    
+  end
+  
+  sheet('x') do
+
+    column value_of(:multiplier)
+    column 'x'
+    column value_of(:multiplicand)
+    column '='
+    
+    column :result
+
+  end
+  
+end
+
+count = 0
+
+doc.save(output_file) do |spreadsheet|
+  
+  sheet = doc.current
+
+  7.step(10) do |multiplicand|
+  
+    sheet[:multiplicand] = multiplicand
+    
+    1.step(10) do |multiplier|
+      
+      sheet[:multiplier] = multiplier
+      
+      sheet.write_row count
+      
+      count += 1
+
+    end
+    
+    count += 1
+      
+    sheet.empty_row
+    
+  end
+  
+end
+
+puts "Wrote #{output_file} (#{count} rows)"

data/examples/register_function.rb

@@ -0,0 +1,44 @@
+require 'date'
+
+require 'calco'
+
+#
+# Next example shows how to extend the DSL with new built-in functions.
+# It outputs as simple text the resulting spreadsheet (two rows: the headers
+# and one row of data)
+#
+
+# Next functions does not exist in a spreadsheet software.
+# we only show how to declare functions that are missing...
+Calco::BuiltinFunction.declare :now, 0, Integer
+Calco::BuiltinFunction.declare :age, 1, Integer
+
+doc = spreadsheet do
+
+  definitions do
+
+    set some_date: Date.today
+
+    function now: now
+    function age: age(some_date)
+    
+  end
+  
+  sheet do
+
+    column :now, :title => "Today"
+
+    column value_of(:some_date)
+    column :age,  :title => "Age"
+
+  end
+
+end
+
+hash_printer = proc {|k, v| puts "#{k}: #{v}"}
+
+doc.row_to_hash(0).each &hash_printer
+
+doc.current[:some_date] = Date.new(1934, 10, 3)
+puts
+doc.row_to_hash(1).each &hash_printer

data/examples/using_date_functions.rb

@@ -0,0 +1,42 @@
+require 'date'
+
+require 'calco'
+
+#
+# Next example uses date functions and outputs to the console the result as 
+# simple text.
+#
+
+doc = spreadsheet do
+
+  definitions do
+
+    set some_date: Date.today
+
+    function some_year: year(some_date)
+    function age: year(today) - year(some_date)
+    
+  end
+  
+  sheet do
+
+    column value_of(:some_date)
+
+    column :some_year
+    column :age
+
+  end
+
+end
+
+doc.save($stdout) do
+
+  sheet = doc.current
+  
+  sheet[:some_date] = Date.new(1934, 10, 3)
+  sheet.write_row 3
+  
+  sheet[:some_date] = Date.new(2004, 6, 19)
+  sheet.write_row 5
+  
+end

data/examples/write_csv.rb

@@ -0,0 +1,68 @@
+require 'time'
+
+require 'calco/engines/csv_engine'
+
+#
+# Next example presents uses the CSV engine that outputs formulas and save time 
+# values as formulas. LibreOffice opens CSV files containing formulas and is 
+# able to apply them.
+#
+# The example shows how to define an aggregation function (sum) using a Range
+# object marked with the as_grouping method (extension added by Calco to the
+# Ruby Range class).
+#
+# The example uses the Sheet#replace_and_clear method that changes the 
+# definition set for some column.
+#
+# The spreadsheet is a kind ot timesheet.
+#
+
+doc = spreadsheet(Calco::CSVEngine.new) do
+
+  definitions do
+
+    set start_time: ''
+    set end_time: ''
+
+    function duration: end_time - start_time
+
+    function total: sum(duration[(1..-1).as_grouping])
+
+  end
+
+  sheet do
+
+    column value_of(:start_time), :title => "Start"
+    column value_of(:end_time), :title => "End"
+
+    column :duration, :title => "Duration", :id => :duration
+
+  end
+
+end
+
+data = [
+  {:start_time => Time.parse("12:10"), :end_time => Time.parse("15:30")},
+  {:start_time => Time.parse("11:00"), :end_time => Time.parse("16:30")},
+  {:start_time => Time.parse("10:01"), :end_time => Time.parse("12:05")},
+]
+
+doc.save($stdout) do |spreadsheet|
+
+  sheet = doc.current
+
+  sheet.write_row 0
+
+  data.each_with_index do |entry, i|
+
+    sheet.write_row i + 1, entry
+
+  end
+
+  sheet.empty_row
+  
+  sheet.replace_and_clear :duration => :total
+
+  sheet.write_row data.length + 1
+
+end

data/examples/write_ods.rb

@@ -0,0 +1,69 @@
+require 'csv'
+require 'date'
+require 'tmpdir'
+
+#
+# Next example uses the use of the office engine and reads data from a CSV file.
+#
+# It saves an office file in the temporary directory named "res.ods" and uses
+# a template file named "ages.ods"
+#
+# It shows the definition of a cell with a conditional style. Depending on the
+# current value of the cell the style name "adult" or "default" is applied.
+# The "adult" style should be defined in the template file.
+#
+
+require 'calco/engines/office_engine'
+
+output_file = File.join(Dir.tmpdir, "res.ods")
+
+def relative_path file
+  File.join(File.dirname(__FILE__), file)
+end
+
+engine = Calco::OfficeEngine.new(relative_path('ages.ods'))
+
+doc = spreadsheet(engine) do
+
+  definitions do
+
+    set name: ''
+    set birth_date: ''
+    
+    function age: year(today) - year(birth_date)
+    
+  end
+  
+  sheet('Main') do
+
+    has_titles true
+
+    column value_of(:name)
+    column value_of(:birth_date)
+    
+    column :age, style: _if(current > 19, '"adult"', '"default"')
+
+  end
+  
+end
+
+count = 0
+
+doc.save(output_file) do |spreadsheet|
+  
+  sheet = doc.current
+  
+  CSV.foreach(relative_path('data.csv'), :headers => true) do |row|
+    
+    count += 1
+
+    sheet[:name] = row[0]
+    sheet[:birth_date] = Date.parse(row[1])
+    
+    sheet.write_row count
+    
+  end
+  
+end
+
+puts "Wrote #{output_file} (#{count} rows)"