surpass 0.0.4 → 0.0.6

data/webby/content/examples/number-format-string.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'surpass'
+
+book = Workbook.new(__FILE__.gsub(/rb$/, "xls"))
+sheet = book.add_sheet
+
+date_format = StyleFormat.new(:number_format_string => 'DDD MMM YYYY')
+sheet.write(0, 0, Date.today, date_format)
+
+two_dp_format = StyleFormat.new
+two_dp_format.number_format_string = "#,##0.00"
+sheet.write(0, 1, 1002.71828, two_dp_format)
+
+book.save

data/webby/content/examples/patterns.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'surpass'
+
+book = Workbook.new
+sheet = book.add_sheet("Patterns")
+
+per_row = 19
+
+Pattern.fill_directives.sort.each_with_index do |c, i|
+  format = StyleFormat.new
+  format.pattern.pattern = c
+  
+  row = i % per_row
+  label_column = (i/per_row)*2
+  pattern_column = (i/per_row)*2 + 1
+  
+  sheet.write(row, label_column,  c, :font_size => 14)
+  sheet.write(row, pattern_column, nil, format)
+  
+  sheet.write(row, pattern_column + 1, nil, :pattern_fore_colour => 'green', :fill_pattern => c)
+  sheet.write(row, pattern_column + 2, nil, :pattern_fore_colour => 'yellow', :pattern_back_colour => 'blue', :fill_pattern => c)
+  
+  sheet.set_column_width(label_column, 30)
+end
+
+book.save(__FILE__.gsub(/rb$/, "xls"))

data/webby/content/examples/show-greens.sh

@@ -0,0 +1 @@
+surpass -c | grep green

data/webby/content/examples/surpass-info.sh

@@ -0,0 +1 @@
+surpass -h

data/webby/content/index.txt

@@ -0,0 +1,16 @@
+---
+title:  Surpass
+author: Ana Nelson
+layout:  web
+filter:
+  - erb
+  - textile
+---
+
+Homepage of the Surpass project. Surpass is software for creating Excel spreadsheets in pure native Ruby.
+
+h2. Example:
+
+<%= gorg("content/examples/formatting.rb", "1") %>
+
+<img src="examples/formatting.png" />

data/webby/content/installation/index.txt

@@ -0,0 +1,24 @@
+---
+title: Installation
+layout: web
+created_at: 2009-06-24 09:38:29.666689 +01:00
+filter:
+  - erb
+  - textile
+---
+
+h2. Installing Surpass via Rubygems
+
+@sudo gem install surpass@
+
+h2. Installing Surpass from Source
+
+Source code is available from the "Bazaar":http://bazaar-vcs.org repository:
+
+@bzr branch http://ananelson.com/code/surpass@
+
+To install the gem:
+
+@sudo rake gem:install@
+
+from within the surpass directory.

data/webby/content/source/ExcelFormulaLexer.txt

@@ -0,0 +1,7 @@
+---
+title:  ExcelFormulaLexer.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/ExcelFormulaLexer.rb") %>

data/webby/content/source/ExcelFormulaParser.txt

@@ -0,0 +1,7 @@
+---
+title:  ExcelFormulaParser.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/ExcelFormulaParser.rb") %>

data/webby/content/source/biff_record.txt

@@ -0,0 +1,7 @@
+---
+title:  biff_record.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/biff_record.rb") %>

data/webby/content/source/bitmap.txt

@@ -0,0 +1,7 @@
+---
+title:  bitmap.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/bitmap.rb") %>

data/webby/content/source/cell.txt

@@ -0,0 +1,7 @@
+---
+title:  cell.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/cell.rb") %>

data/webby/content/source/chart.txt

@@ -0,0 +1,7 @@
+---
+title:  chart.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/chart.rb") %>

data/webby/content/source/column.txt

@@ -0,0 +1,7 @@
+---
+title:  column.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/column.rb") %>

data/webby/content/source/document.txt

@@ -0,0 +1,7 @@
+---
+title:  document.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/document.rb") %>

data/webby/content/source/excel_formula.txt

@@ -0,0 +1,7 @@
+---
+title:  excel_formula.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/excel_formula.rb") %>

data/webby/content/source/excel_magic.txt

@@ -0,0 +1,7 @@
+---
+title:  excel_magic.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/excel_magic.rb") %>

data/webby/content/source/formatting.txt

@@ -0,0 +1,7 @@
+---
+title:  formatting.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/formatting.rb") %>

data/webby/content/source/row.txt

@@ -0,0 +1,7 @@
+---
+title:  row.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/row.rb") %>

data/webby/content/source/style.txt

@@ -0,0 +1,7 @@
+---
+title:  style.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/style.rb") %>

data/webby/content/source/utilities.txt

@@ -0,0 +1,7 @@
+---
+title:  utilities.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/utilities.rb") %>

data/webby/content/source/workbook.txt

@@ -0,0 +1,7 @@
+---
+title:  workbook.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/workbook.rb") %>

data/webby/content/source/worksheet.txt

@@ -0,0 +1,7 @@
+---
+title:  worksheet.rb
+layout:  web
+filter:
+  - erb
+---
+<%= gorg("/Users/ana/work/surpass/lib/surpass/worksheet.rb") %>

data/webby/content/surpass-manual.erb

@@ -0,0 +1,198 @@
+---
+title:      Surpass Manual
+author:     Ana Nelson
+created_at: 2009-01-30 13:08:32.468894 +00:00
+layout: book
+filter:
+  - erb
+---
+To compile this documentation requires \LaTeX and the gems Gorgyrella and Webby.
+
+This documentation refers to Surpass version <%= Surpass::VERSION %>.
+
+\chapter{Installation and Hello World} % (fold)
+\label{cha:installation_and_hello_world}
+
+\section{Dependencies} % (fold)
+\label{sec:dependencies}
+
+Surpass only needs basic Ruby. It has been tested using Ruby 1.8.6 and JRuby 1.1.5.
+
+For development, you will want to have access to something that can open Microsoft Excel files. This could be Microsoft Excel, Open Office, Google Docs or even a gmail account.
+
+% section dependencies (end)
+
+\section{Gem Installation}
+
+\begin{verbatim}
+sudo gem install surpass
+\end{verbatim}
+
+\section{Source Installation}
+
+\begin{verbatim}
+bzr branch http://ananelson.com/code/surpass
+cd surpass
+sudo rake gem:install
+\end{verbatim}
+
+\section{Hello World}
+
+Let's do a minimal "Hello World" script. We'll need to take care of any imports, initialize a Workbook object, create a Worksheet within the workbook, then write some text. Here's how.
+
+\subsection{Surpass}
+
+<%= gorgl("content/examples/hello-world.rb")%>
+
+\subsection{Result}
+
+And, here's how it looks.
+
+\includegraphics[width=15cm]{examples/hello-world.png}
+
+% chapter installation_and_hello_world (end)
+
+\chapter{Writing Data} % (fold)
+\label{cha:writing_data}
+
+\section{write} % (fold)
+\label{sec:write}
+
+The basic method for writing data to cells is the worksheet's write method.
+
+<%= gorgl("../lib/surpass/worksheet.rb", "write-method")%>
+
+There are two required arguments, the row and column. These are zero-based indexes for the row and column. To write to the first cell in the spreadsheet, you would pass 0, 0. The next argument is the label, this is the value you want written in the cell. This defaults to an empty string (for no particular reason). You can write nil, a String, a Boolean, a Numeric or a Date format. If you pass an object belonging to an unsupported class, you will get an error message, and in this case you should call some method on your object which will return a String or whatever the appropriate label is. The fourth argument is for style, which should be either nil, true, a hash or an instance of the StyleFormat class. See the chapter on Formatting for more information. The style parameter defaults to nil, which means that the default Excel format will be applied.
+
+\section{Writing Arrays of Data} % (fold)
+\label{sec:writing_arrays_of_data}
+
+Frequently, you may want to write more than one value at a time, and so Surpass has convenience methods which handle arrays for you. In the background, these are just looping over the array and calling write() for each value you pass. There's no magic here and, for now at least, no clever optimization. The available methods are write\_array\_to\_row, write\_array\_to\_column, and write\_arrays. The write\_arrays method expects an array of arrays, the first two expect a single array.
+
+<%= gorgl("../lib/surpass/worksheet.rb", "write-arrays") %>
+
+
+% section writing_arrays_of_data (end)
+
+% section write (end)
+
+\section{Autoformatting} % (fold)
+\label{sec:autoformatting}
+
+Autoformats are number formats which are automatically applied to Dates, Floats and similar classes. To have autoformats applied, then pass true as the style parameter to the write function.
+
+Here is the relevant code from row.rb:
+<%= gorgl("../lib/surpass/row.rb", "autoformats") %>
+
+And here are the default formats being defined in style.rb:
+<%= gorgl("../lib/surpass/style.rb", "autoformats") %>
+
+If you use any of the array-writing methods, then autoformatting will be applied by default. To override this behaviour you can pass your own StyleFormat or nil to use the generic default format.
+
+<%= gorgl("content/examples/autoformat.rb") %>
+
+\includegraphics[width=15cm]{examples/autoformat.png}
+
+% section autoformatting (end)
+
+% chapter writing_data (end)
+
+
+\chapter{Formatting} % (fold)
+\label{cha:formatting}
+
+\section{Reference}
+
+There is a command line tool included with Surpass which provides some useful reference data:
+
+<%= gorgl("content/examples/surpass-info.sh") %>
+\begin{verbatim}
+  <%= IO.popen("cd ..; bash webby/content/examples/surpass-info.sh").read %>
+\end{verbatim}
+
+And since you are running this on the command line, you can save or pipe the output to other commands:
+
+<%= gorgl("content/examples/show-greens.sh") %>
+\begin{verbatim}
+  <%= IO.popen("cd ..; bash webby/content/examples/show-greens.sh").read %>
+\end{verbatim}
+
+\section{StyleFormat Class}
+
+The StyleFormat class is a wrapper for the various types of formatting you can apply to a cell. StyleFormat has attributes:
+
+\begin{itemize}
+  \item number\_format\_string
+  \item font
+  \item alignment
+  \item borders
+  \item pattern
+  \item protection
+\end{itemize}
+
+Each of these attributes (except for number\_format\_string) has a corresponding class, and you can look in lib/surpass/formatting.rb for the source.
+
+There are two basic ways to set formatting options. You can pass a hash with formatting options when you initialize a new StyleFormat instance, or you can set individual attributes of the formatting classes. You can also combine both approaches, initializing with a hash and then modifying attributes.
+
+\section{Number Format Strings} % (fold)
+\label{sec:number_format_strings}
+
+This attribute is a simple string, specifying the numeric/date format to be applied to the value stored in a cell.
+
+\newpage
+
+<%= gorgl("content/examples/number-format-string.rb") %>
+\includegraphics[width=16cm]{examples/number-format-string.png}
+
+% section number_format_strings (end)
+
+
+\subsection{Specifying Colours}
+
+Here is a list of available colours:
+
+\begin{multicols}{3}
+\begin{verbatim}
+<%= Formatting::COLOURS.keys.sort.join("\n") %>
+\end{verbatim}
+\end{multicols}
+
+\includegraphics[width=16cm]{examples/colours.png}
+
+\subsection{Border Formats}
+
+Here is a list of available border line types:
+\begin{verbatim}
+  <%= Borders.line_type_directives.join("\n") %>
+\end{verbatim}
+\includegraphics[width=16cm]{examples/borders.png}
+
+\subsection{Fill Patterns}
+
+Here is a list of available fill patterns:
+\begin{verbatim}
+<%= Pattern.fill_directives.join("\n") %>
+\end{verbatim}
+\includegraphics[width=16cm]{examples/patterns.png}
+
+\subsection{Surpass}
+<%= gorgl("content/examples/formatting.rb")%>
+
+And, here's how it looks.
+
+\includegraphics[width=16cm]{examples/formatting.png}
+
+% chapter formatting (end)
+
+\chapter{Saving} % (fold)
+\label{cha:saving}
+
+Typically, you will call the workbook's save() method to write that workbook to a file. You can pass the filename as an argument to save(), or as an argument to new() when you first instantiate a workbook object.
+
+However, you can also call a workbook's data() method, which gives you direct access to a workbook's binary data. You can write this to a file manually, as in this example:
+
+<%= gorgl("content/examples/data.rb") %>
+
+Or, you could use this data as an argument to Rails' send\_data method.
+
+% chapter saving (end)

data/webby/layouts/book.txt

@@ -0,0 +1,29 @@
+---
+extension: tex
+filter:    erb
+---
+\documentclass[a4paper]{book}
+\usepackage{fullpage}
+\usepackage{fancyvrb}
+\usepackage{color}
+\usepackage[ascii]{inputenc}
+\usepackage{hyperref}
+\usepackage[pdftex]{graphicx}
+\usepackage{wrapfig}
+\usepackage{multicol}
+
+<%= pygments_latex_styles %>
+
+
+\title{<%= @page.title %>}
+\author{<%= @page.author %>}
+
+\begin{document}
+
+\maketitle
+
+\tableofcontents
+
+<%= @content %>
+
+\end{document}

data/webby/layouts/default.txt

@@ -0,0 +1,27 @@
+---
+extension: tex
+filter:    erb
+---
+\documentclass[a4paper]{article}
+\usepackage{fullpage}
+\usepackage{fancyvrb}
+\usepackage{color}
+\usepackage[ascii]{inputenc}
+\usepackage{hyperref}
+\usepackage[pdftex]{graphicx}
+\usepackage{wrapfig}
+\usepackage{multicol}
+
+<%= pygments_latex_styles %>
+
+
+\title{<%= @page.title %>}
+\author{<%= @page.author %>}
+
+\begin{document}
+
+\maketitle
+
+<%= @content %>
+
+\end{document}

data/webby/layouts/two_column.txt

@@ -0,0 +1,25 @@
+---
+extension: tex
+filter:    erb
+---
+\documentclass[a4paper, twocolumn]{article}
+\usepackage{fullpage}
+\usepackage{fancyvrb}
+\usepackage{color}
+\usepackage[ascii]{inputenc}
+\usepackage{hyperref}
+\usepackage[pdftex]{graphicx}
+
+<%= pygments_latex_styles %>
+
+
+\title{<%= @page.title %>}
+\author{<%= @page.author %>}
+
+\begin{document}
+
+\maketitle
+
+<%= @content %>
+
+\end{document}

data/webby/layouts/web.txt

@@ -0,0 +1,66 @@
+---
+extension: html
+filter:    erb
+---
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+	
+<!-- ==========================================================	-->
+<!--	Created by Devit Schizoper                          	-->
+<!--	Created HomePages http://LoadFoo.starzonewebhost.com   	-->
+<!--	Created Day 01.12.2006                              	-->
+<!-- ========================================================== -->
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+   <meta http-equiv="content-type" content="text/html;charset=utf-8" />
+	<meta name="author" content="LoadFoO" />
+	<meta name="description" content="Site description" />
+	<meta name="keywords" content="key, words" />
+	<title>Surpass :: <%= @page.title %></title>
+	<link rel="stylesheet" type="text/css" href="/css/style.css" media="screen" />
+	<link rel="stylesheet" href="/css/pygments.css" type="text/css" />
+	<link rel="shortcut icon" href="favicon.ico" />
+</head>
+
+<body>
+<div id="wrap">
+<div id="top">
+<h2><a href="/" title="Back to main page">Surpass</a></h2>
+<div id="menu">
+<ul>
+    <% [
+        ['/installation', "Installation"],
+        ['/examples', "Examples"],
+        ['/source', "Source"],
+        ].each do |a, t| -%>
+    <li><a href="<%= a %>"><%= t %></a></li>
+    <% end -%>
+</ul>
+</div>
+</div>
+<div id="content">
+<div id="left">
+<h2><%= @page.title %></h2>
+<%= @content %>
+</div>
+<div id="right">
+<ul id="nav">
+    <li><a href="<%= manual_filename %>">Download PDF Manual</a></li>
+	<li><a href="http://rubyforge.org/projects/surpass">Rubyforge Project Page</a></li>
+	<li><a href="<%= gzipped_source %>">Download Latest Source (tgz)</a></li>
+</ul>
+	<div class="box">
+		<h2 style="margin-top:17px">Latest News</h2>
+		<ul>
+			<li>...</li>
+		</ul>
+	</div>
+</div>
+<div id="clear"></div></div>
+<div id="footer">
+<p>Site template designed by <a href="http://loadfoo.org/" rel="external">LoadFoO</a>. Valid <a href="http://jigsaw.w3.org/css-validator/check/referer" rel="external">CSS</a> &amp; <a href="http://validator.w3.org/check?uri=referer" rel="external">XHTML</a></p>
+</div>
+</div>
+
+</body>
+</html>

data/webby/output/css/blueprint/ie.css

@@ -0,0 +1,26 @@
+/* -----------------------------------------------------------------------
+
+
+ Blueprint CSS Framework 0.8
+ http://blueprintcss.org
+
+   * Copyright (c) 2007-Present. See LICENSE for more info.
+   * See README for instructions on how to use Blueprint.
+   * For credits and origins, see AUTHORS.
+   * This is a compressed file. See the sources in the 'src' directory.
+
+----------------------------------------------------------------------- */
+
+/* ie.css */
+body {text-align:center;}
+.container {text-align:left;}
+* html .column, * html div.span-1, * html div.span-2, * html div.span-3, * html div.span-4, * html div.span-5, * html div.span-6, * html div.span-7, * html div.span-8, * html div.span-9, * html div.span-10, * html div.span-11, * html div.span-12, * html div.span-13, * html div.span-14, * html div.span-15, * html div.span-16, * html div.span-17, * html div.span-18, * html div.span-19, * html div.span-20, * html div.span-21, * html div.span-22, * html div.span-23, * html div.span-24 {overflow-x:hidden;}
+* html legend {margin:-18px -8px 16px 0;padding:0;}
+ol {margin-left:2em;}
+sup {vertical-align:text-top;}
+sub {vertical-align:text-bottom;}
+html>body p code {*white-space:normal;}
+hr {margin:-8px auto 11px;}
+.clearfix, .container {display:inline-block;}
+* html .clearfix, * html .container {height:1%;}
+fieldset {padding-top:0;}