osheet-xmlss 1.0.0.rc.1

data/bench/profiler_runner.rb

@@ -0,0 +1,40 @@
+require 'ruby-prof'
+require 'osheet/xmlss'
+
+class OsheetXmlssProfilerRunner
+
+  attr_reader :result
+
+  def initialize(n)
+
+    RubyProf.measure_mode = RubyProf::MEMORY
+    @result = RubyProf.profile do
+      Osheet::Workbook.new {
+        title "basic"
+        worksheet {
+          name "one dollar"
+          5.times { column }
+
+          1000.times do
+            row {
+              [1, "text", 123.45, "0001267", "$45.23"].each do |data_value|
+                cell { data data_value }
+              end
+            }
+          end
+        }
+      }.to_file('./bench/profiler_1000.xls', :pp => 2)
+    end
+
+  end
+
+  def print_flat(outstream, opts={})
+    RubyProf::FlatPrinter.new(@result).print(outstream, opts)
+    #RubyProf::GraphPrinter.new(@result).print(outstream, opts)
+  end
+
+  def print_graph(outstream, opts={})
+    RubyProf::GraphPrinter.new(@result).print(outstream, opts)
+  end
+
+end

data/examples/basic.rb

@@ -0,0 +1,77 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/basic.rb
+# $ open examples/basic.xls
+
+require 'rubygems'
+require 'osheet/xmlss'
+
+fields = ['Sex', 'Age', 'Height', 'Weight']
+data = {
+  'Tom' => ['M', 52, "6'2\"", '220 lbs.'],
+  'Dick' => ['M', 33, "6'5\"", '243 lbs.'],
+  'Sally' => ['F', 29, "5'3\"", '132 lbs.']
+}
+
+# this will dump the above data to a single-sheet workbook w/ no styles
+
+puts "building examples/basic.rb ..."
+
+Osheet::Workbook.new(Osheet::XmlssWriter.new) {
+  title "basic"
+  worksheet {
+    name "Stats: #{fields.join(', ')}"
+
+    column {
+      width 200
+      meta(
+        :label => "Name"
+      )
+    }
+    fields.each_with_index do |f, i|
+      column {
+        width 80
+        meta(
+          :label => f.to_s,
+          :index => i
+        )
+      }
+    end
+
+    row {     # title row
+      cell {
+        colspan columns.count
+        data worksheet.name
+      }
+    }
+    row {     # empty row
+      cell {
+        colspan columns.count
+        data ''
+      }
+    }
+    row {     # header row
+      columns.each do |column|
+        cell {
+          data column.meta[:label]
+        }
+      end
+    }
+
+    data.each do |name, stats|
+      row {   # data row
+        cell {
+          data name
+        }
+        stats.each do |stat|
+          cell {
+            data stat
+          }
+        end
+      }
+    end
+  }
+}.to_file('examples/basic.xls')
+
+puts "open examples/basic.xls"
+

data/examples/basic.xls

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet" xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"><Styles></Styles><Worksheet ss:Name="Stats Sex, Age, Height, Weight"><Table><Column ss:Width="200" /><Column ss:Width="80" /><Column ss:Width="80" /><Column ss:Width="80" /><Column ss:Width="80" /><Row><Cell ss:MergeAcross="4"><Data ss:Type="String">Stats: Sex, Age, Height, Weight</Data></Cell></Row><Row><Cell ss:MergeAcross="4"><Data ss:Type="String"></Data></Cell></Row><Row><Cell><Data ss:Type="String">Name</Data></Cell><Cell><Data ss:Type="String">Sex</Data></Cell><Cell><Data ss:Type="String">Age</Data></Cell><Cell><Data ss:Type="String">Height</Data></Cell><Cell><Data ss:Type="String">Weight</Data></Cell></Row><Row><Cell><Data ss:Type="String">Sally</Data></Cell><Cell><Data ss:Type="String">F</Data></Cell><Cell><Data ss:Type="Number">29</Data></Cell><Cell><Data ss:Type="String">5&#x27;3&quot;</Data></Cell><Cell><Data ss:Type="String">132 lbs.</Data></Cell></Row><Row><Cell><Data ss:Type="String">Dick</Data></Cell><Cell><Data ss:Type="String">M</Data></Cell><Cell><Data ss:Type="Number">33</Data></Cell><Cell><Data ss:Type="String">6&#x27;5&quot;</Data></Cell><Cell><Data ss:Type="String">243 lbs.</Data></Cell></Row><Row><Cell><Data ss:Type="String">Tom</Data></Cell><Cell><Data ss:Type="String">M</Data></Cell><Cell><Data ss:Type="Number">52</Data></Cell><Cell><Data ss:Type="String">6&#x27;2&quot;</Data></Cell><Cell><Data ss:Type="String">220 lbs.</Data></Cell></Row></Table></Worksheet></Workbook>

data/examples/basic_with_templates.rb

@@ -0,0 +1,87 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/basic_with_templates.rb
+# $ open examples/basic_with_templates.xls
+
+require 'rubygems'
+require 'osheet/xmlss'
+
+fields = ['Sex', 'Age', 'Height', 'Weight']
+data = {
+  'Tom' => ['M', 52, "6'2\"", '220 lbs.'],
+  'Dick' => ['M', 33, "6'5\"", '243 lbs.'],
+  'Sally' => ['F', 29, "5'3\"", '132 lbs.']
+}
+
+# this will dump the above data to a single-sheet workbook w/ no styles
+
+puts "building examples/basic_with_templats.rb ..."
+
+Osheet::Workbook.new(Osheet::XmlssWriter.new(:pp => 2)) {
+  title "basic"
+
+  template(:column, :data) { |field, index|
+    width 80
+    meta(
+      :label => field.to_s,
+      :index => index
+    )
+  }
+
+  template(:row, :title) {
+    cell {
+      colspan columns.count
+      data worksheet.name
+    }
+  }
+
+  template(:row, :empty) {
+    cell {
+      colspan columns.count
+      data ''
+    }
+  }
+
+  template(:row, :header) {
+    columns.each do |column|
+      cell {
+        data column.meta[:label]
+      }
+    end
+  }
+
+  template(:row, :data) { |name, stats|
+    cell {
+      data name
+    }
+    stats.each do |stat|
+      cell {
+        data stat
+      }
+    end
+  }
+
+  worksheet {
+    name "Stats: #{fields.join(', ')}"
+
+    column {
+      width 200
+      meta(
+        :label => "Name"
+      )
+    }
+    fields.each_with_index do |f, i|
+      column :data, f, i
+    end
+
+    row :title
+    row :empty
+    row :header
+
+    data.each do |name, stats|
+      row :data, name, stats
+    end
+  }
+}.to_file('examples/basic_with_templates.xls')
+
+puts "open examples/basic_with_templates.xls"

data/examples/basic_with_templates.xls

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet" xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet">
+  <Styles>
+    
+  </Styles>
+  <Worksheet ss:Name="Stats Sex, Age, Height, Weight">
+    <Table>
+      <Column ss:Width="200" />
+      <Column ss:Width="80" />
+      <Column ss:Width="80" />
+      <Column ss:Width="80" />
+      <Column ss:Width="80" />
+      <Row>
+        <Cell ss:MergeAcross="4">
+          <Data ss:Type="String">Stats: Sex, Age, Height, Weight</Data>
+        </Cell>
+      </Row>
+      <Row>
+        <Cell ss:MergeAcross="4">
+          <Data ss:Type="String"></Data>
+        </Cell>
+      </Row>
+      <Row>
+        <Cell>
+          <Data ss:Type="String">Name</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">Sex</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">Age</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">Height</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">Weight</Data>
+        </Cell>
+      </Row>
+      <Row>
+        <Cell>
+          <Data ss:Type="String">Sally</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">F</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="Number">29</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">5&#x27;3&quot;</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">132 lbs.</Data>
+        </Cell>
+      </Row>
+      <Row>
+        <Cell>
+          <Data ss:Type="String">Dick</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">M</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="Number">33</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">6&#x27;5&quot;</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">243 lbs.</Data>
+        </Cell>
+      </Row>
+      <Row>
+        <Cell>
+          <Data ss:Type="String">Tom</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">M</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="Number">52</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">6&#x27;2&quot;</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="String">220 lbs.</Data>
+        </Cell>
+      </Row>
+    </Table>
+  </Worksheet>
+</Workbook>

data/examples/formats.rb

@@ -0,0 +1,370 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/formats.rb
+# $ open examples/formats.xls
+
+require 'rubygems'
+require 'osheet/xmlss'
+
+puts "building examples/formats.rb ..."
+
+Osheet::Workbook.new(Osheet::XmlssWriter.new(:pp => 2)) {
+  title "formats"
+
+
+
+  # number format examples
+  worksheet {
+    name "number"
+
+    column {
+      width 250
+      meta(:label => 'Format')
+    }
+    [1000, -20000].each do |n|
+      column {
+        width 125
+        meta(:label => n.to_s, :value => n)
+      }
+    end
+
+    # header row
+    row {
+      columns.each do |col|
+        cell{ data col.meta[:label] }
+      end
+    }
+
+    # data rows
+    [
+      {},
+      {
+        :decimal_places => 1,
+        :negative_numbers => :red
+      },
+      {
+        :decimal_places => 2,
+        :comma_separator => true,
+        :negative_numbers => :black_parenth
+      },
+      {
+        :decimal_places => 8,
+        :comma_separator => true,
+        :negative_numbers => :red_parenth
+      }
+    ].each do |opts|
+      row {
+        cell {
+          data Osheet::Format.new(:number, opts).key
+        }
+        columns[1..-1].each do |col|
+          cell {
+            data col.meta[:value]
+            format :number, opts
+          }
+        end
+      }
+    end
+  }
+
+
+  # currency/accounting format examples
+  worksheet {
+    name "currency, accounting"
+
+    column {
+      width 250
+      meta(:label => 'Format')
+    }
+    [1000, -20000].each do |n|
+      column {
+        width 125
+        meta(:label => n.to_s, :value => n)
+      }
+    end
+
+    # header row
+    row {
+      columns.each do |col|
+        cell{ data col.meta[:label] }
+      end
+    }
+
+    data_opts = [
+      {},
+      {
+        :symbol => :euro,
+        :decimal_places => 0,
+        :negative_numbers => :red
+      },
+      {
+        :decimal_places => 1,
+        :comma_separator => false,
+        :negative_numbers => :black_parenth
+      },
+      {
+        :decimal_places => 8,
+        :comma_separator => true,
+        :negative_numbers => :red_parenth
+      }
+    ]
+
+    # currency data rows
+    data_opts.each do |opts|
+      row {
+        cell {
+          data Osheet::Format.new(:currency, opts).key
+        }
+        columns[1..-1].each do |col|
+          cell {
+            data col.meta[:value]
+            format :currency, opts
+          }
+        end
+      }
+    end
+
+    # accounting data rows
+    data_opts.each do |opts|
+      row {
+        cell {
+          data Osheet::Format.new(:accounting, opts).key
+        }
+        columns[1..-1].each do |col|
+          cell {
+            data col.meta[:value]
+            format :accounting, opts
+          }
+        end
+      }
+    end
+  }
+
+
+
+  # percentage format examples
+  worksheet {
+    name "percentage, scientific"
+
+    column {
+      width 250
+      meta(:label => 'Format')
+    }
+    [1000, -20000].each do |n|
+      column {
+        width 125
+        meta(:label => n.to_s, :value => n)
+      }
+    end
+
+    # header row
+    row {
+      columns.each do |col|
+        cell{ data col.meta[:label] }
+      end
+    }
+
+    data_opts = [
+      {},
+      {
+        :decimal_places => 0,
+        :negative_numbers => :red
+      },
+      {
+        :decimal_places => 1,
+        :comma_separator => false,
+        :negative_numbers => :black_parenth
+      },
+      {
+        :decimal_places => 8,
+        :comma_separator => true,
+        :negative_numbers => :red_parenth
+      }
+    ]
+
+    # percentage data rows
+    data_opts.each do |opts|
+      row {
+        cell {
+          data Osheet::Format.new(:percentage, opts).key
+        }
+        columns[1..-1].each do |col|
+          cell {
+            data col.meta[:value]
+            format :percentage, opts
+          }
+        end
+      }
+    end
+
+    # scientific data rows
+    data_opts.each do |opts|
+      row {
+        cell {
+          data Osheet::Format.new(:scientific, opts).key
+        }
+        columns[1..-1].each do |col|
+          cell {
+            data col.meta[:value]
+            format :scientific, opts
+          }
+        end
+      }
+    end
+  }
+
+
+
+  # fraction format examples
+  worksheet {
+    name "fractions"
+
+    column {
+      width 250
+      meta(:label => 'Format')
+    }
+    column {
+      width 125
+      meta(:label => 'Fraction Example')
+    }
+
+    # header row
+    row {
+      columns.each do |col|
+        cell{ data col.meta[:label] }
+      end
+    }
+
+    # fraction data rows
+    data_opts = {
+      :one_digit => 0.5,
+      :two_digits => 0.0125,
+      :three_digits => 0.01,
+      :halves => 0.5,
+      :quarters => 0.25,
+      :eighths => 0.125,
+      :sixteenths => 0.0625,
+      :tenths => 0.1,
+      :hundredths => 0.01
+    }
+    data_opts.each do |k,v|
+      row {
+        cell {
+          data Osheet::Format.new(:fraction, :type => k).key
+        }
+        cell {
+          data v
+          format :fraction, :type => k
+        }
+      }
+    end
+  }
+
+
+
+  # text format examples
+  worksheet {
+    name "text, special, custom"
+
+    column {
+      width 250
+      meta(:label => 'Format')
+    }
+    column {
+      width 125
+      meta(:label => 'Result')
+    }
+
+    # header row
+    row {
+      columns.each do |col|
+        cell{ data col.meta[:label] }
+      end
+    }
+
+    # text data row
+    row {
+      cell {
+        data Osheet::Format.new(:text).key
+      }
+      cell {
+        data "001122 blah blah"
+        format :text
+      }
+    }
+
+    # special data rows
+    {
+      :zip_code => 12345,
+      :zip_code_plus_4 => 123456789,
+      :phone_number => 5551112222,
+      :social_security_number => 333224444
+    }.each do |k,v|
+      row {
+        cell {
+          data Osheet::Format.new(:special, :type => k).key
+        }
+        cell {
+          data v
+          format :special, :type => k
+        }
+      }
+    end
+
+    # custom data row
+    row {
+      cell {
+        data Osheet::Format.new(:custom, '@').key
+      }
+      cell {
+        data "001122 blah blah"
+        format :custom, '@'
+      }
+    }
+  }
+
+
+
+  # datetime format examples
+  worksheet {
+    name "date, time"
+
+    column {
+      width 250
+      meta(:label => 'Format')
+    }
+    column {
+      width 125
+      meta(:label => 'Datetime')
+    }
+
+    # header row
+    row {
+      columns.each do |col|
+        cell{ data col.meta[:label] }
+      end
+    }
+
+    # datetime data row
+    [ 'm','d','y', 'mm', 'dd', 'yy', 'yyyy',
+      'mm/dd/yy', 'mm/dd/yyyy', 'mmmm', 'mmmmm', 'mmmmm',
+      'h','m','s', 'hh', 'mm', 'ss',
+      'h:mm:ss', 'h:mm:ss.0', 'hh:mm:ss AM/PM'
+    ].each do |s|
+      row {
+        cell {
+          data Osheet::Format.new(:datetime, s).key
+        }
+        cell {
+          data Date.today
+          format :datetime, s
+        }
+      }
+    end
+  }
+
+
+
+}.to_file('examples/formats.xls')
+
+puts "open examples/formats.xls"