osheet-xmlss 1.0.0.rc.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.log
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+.rbenv-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in osheet-xmlss.gemspec
+gemspec
+
+gem 'bundler', '~>1.1'
+gem 'rake',    '~>0.9.2'
+gem "whysoslow", "~> 0.0"
+gem "ruby-prof"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010-Present Kelly Redding
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# Osheet::Xmlss
+
+A writer for Osheet (https://github.com/kellyredding/osheet).  Use this with Osheet to write workbooks in the Xmlss format (https://github.com/kellyredding/xmlss.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'osheet-xmlss'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install osheet-xmlss
+
+Osheet::Xmlss will install Osheet and Xmlss for you and you are all set.
+
+## Usage
+
+```ruby
+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
+# - this example is using the Xmlss writer (https://github.com/kellyredding/xmlss)
+
+Osheet::Workbook.new(Osheet::XmlssWriter.new) {
+  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('stats.xls')
+```
+
+## Writer Options
+
+* `:pp`: (pretty-print) set to a Fixnum to tab-space indent pretty print the output (from Undies, https://github.com/kellyredding/undies)
+
+## API
+
+Check out the Osheet wiki: https://github.com/kelredd/osheet/wiki.  It covers the full Osheet API.
+
+## Examples
+
+I've add a few examples to ./examples.  Please refer first to the API then to these for examples on basic usage, using templates, formatting data, and styling data.
+
+## Links
+
+* *Osheet Wiki*
+  - https://github.com/kellyredding/osheet/wiki
+* *Osheet Source*
+  - http://github.com/kellyredding/osheet
+* *Xmlss Source*
+  - http://github.com/kellyredding/xmlss
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+
+require 'assert/rake_tasks'
+Assert::RakeTasks.for(:test)
+
+require 'bundler/gem_tasks'
+
+task :default => :build
+
+namespace :bench do
+
+  desc "Run the bench script."
+  task :run do
+    require 'bench/bench_runner'
+    OsheetXmlssBenchRunner.new
+  end
+
+  desc "Run the profiler on 1000 rows."
+  task :profiler do
+    require 'bench/profiler_runner'
+    runner = OsheetXmlssProfilerRunner.new(1000)
+    runner.print_flat(STDOUT, :min_percent => 3)
+  end
+
+  desc "Run the example workbook builds."
+  task :examples do
+    require 'examples/trivial'
+    require 'examples/basic'
+    require 'examples/basic_with_templates'
+    require 'examples/formats'
+    require 'examples/formula'
+    require 'examples/styles'
+  end
+
+  desc "Run all the tests, then the example builds, then the profiler."
+  task :all do
+    Rake::Task['test'].invoke
+    Rake::Task['bench:run'].invoke
+    Rake::Task['bench:profiler'].invoke
+    Rake::Task['bench:examples'].invoke
+  end
+
+
+end
+
+task :bench do
+  Rake::Task['bench:run'].invoke
+end
+

data/bench/bench_runner.rb

@@ -0,0 +1,91 @@
+require 'whysoslow'
+require 'stringio'
+
+require 'osheet/xmlss'
+
+class OsheetXmlssBenchResults
+
+  def initialize(row_count)
+    @row_count = row_count
+    @printer = Whysoslow::DefaultPrinter.new({
+      :title => "#{@row_count} rows",
+      :verbose => true
+    })
+    @runner = Whysoslow::Runner.new(@printer)
+  end
+
+  def run
+    @runner.run do
+      data_values = {
+        :number   => 1,
+        :text     => 'text',
+        :currency => 123.45,
+        :text     => "<>&'\"/",
+        :currency => 45.23
+      }
+
+      outstream = StringIO.new(out = "")
+      outstream << Osheet::Workbook.new(Osheet::XmlssWriter.new(:pp => 2), {
+        :bench_row_count => @row_count,
+        :runner => @runner
+      }) {
+        title "bench"
+
+        template(:row, :header) {
+          columns.each do |column|
+            cell {
+              data column.meta[:label]
+            }
+          end
+        }
+
+        template(:row, :data) { |values|
+          columns.each do |col|
+            cell {
+              data values[col.meta[:label]]
+              format col.meta[:label]
+            }
+          end
+        }
+
+        worksheet {
+          name "bench results"
+
+          data_values.keys.each do |label|
+            column {
+              width 200
+              meta(:label => label)
+            }
+          end
+
+          row :header
+
+          10.times do |i|
+            (bench_row_count / 10).times do
+              row :data, data_values
+            end
+            runner.snapshot("#{((i+1)*10).to_s.rjust(3)}%")
+          end
+        }
+      }.to_data
+    end
+  end
+
+end
+
+class OsheetXmlssBenchRunner
+
+  ROWS = [10, 100, 1000]#, 10000]#, 30000]
+
+  def initialize
+    puts "Benchmark Results:"
+    puts
+    ROWS.each do |size|
+      OsheetXmlssBenchResults.new(size).run
+      puts
+    end
+    puts
+  end
+
+end
+

data/bench/profiler.rb

@@ -0,0 +1,6 @@
+# $ bundle exec ruby bench/profiler.rb
+
+require 'bench/profiler_runner'
+
+runner = OsheetXmlssProfilerRunner.new(ARGV[0] ? ARGV[0].to_i : 1000)
+runner.print_flat(STDOUT, :min_percent => 1)