osheet 1.0.0.rc.4 → 1.0.0

data/.gitignore

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

data/Gemfile

@@ -1,7 +1,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in osheet.gemspec
 gemspec
 
-gem 'bundler', '~>1.1'
-gem 'rake', '~>0.9.2'
+gem 'rake'
+gem 'pry'

data/LICENSE.txt

@@ -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,129 @@
+#  Osheet
+
+## Description
+
+A DSL for specifying and generating spreadsheets using Ruby.
+
+## Simple Usage Example
+
+This example uses the Xmlss writer provided by Osheet::Xmlss (https://github.com/kellyredding/osheet-xmlss).
+
+```ruby
+require 'osheet'
+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')
+```
+
+## API
+
+Check out the wiki: https://github.com/kelredd/osheet/wiki.  It covers the full Osheet API.
+
+## Examples
+
+I've added 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*
+  - http://github.com/kelredd/osheet
+
+* *Wiki*
+  - https://github.com/kelredd/osheet/wiki
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'whysoslow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whysoslow
+
+## 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

@@ -1,7 +1 @@
-require 'assert/rake_tasks'
-include Assert::RakeTasks
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-task :default => :build
+require "bundler/gem_tasks"

data/lib/osheet/cell.rb

@@ -1,5 +1,4 @@
 require 'date'
-
 require 'osheet/format'
 require 'osheet/meta_element'
 require 'osheet/styled_element'

data/lib/osheet/column.rb

@@ -1,5 +1,6 @@
 require 'osheet/meta_element'
 require 'osheet/styled_element'
+require 'osheet/format'
 
 module Osheet
   class Column
@@ -10,9 +11,9 @@ module Osheet
     attr_reader :format
 
     def initialize(width=nil)
-      @width = width
+      @width   = width
       @autofit = false
-      @hidden = false
+      @hidden  = false
       @format  = Format.new(:general)
     end
 

data/lib/osheet/format.rb

@@ -10,21 +10,21 @@ require 'osheet/format/text'
 require 'osheet/format/special'
 require 'osheet/format/custom'
 
-module Osheet::Format
+module Osheet
+  module Format
 
-  VALUES = [
-    :general, :number, :currency, :accounting,
-    :datetime, :percentage, :fraction, :scientific,
-    :text, :special, :custom
-  ]
+    VALUES = [
+      :general, :number, :currency, :accounting,
+      :datetime, :percentage, :fraction, :scientific,
+      :text, :special, :custom
+    ]
 
-  class << self
-    def new(type, *args)
+    def self.new(type, *args)
       unless VALUES.include?(type.to_sym)
         raise ArgumentError, "'#{type.inspect}' is not a valid format type"
       end
       self.const_get(type.to_s.capitalize).new(*args)
     end
-  end
 
+  end
 end

data/lib/osheet/format/accounting.rb

@@ -2,7 +2,6 @@ require 'enumeration'
 require 'osheet/format/currency'
 
 module Osheet::Format
-
   class Accounting < Osheet::Format::Currency
 
     protected

data/lib/osheet/format/currency.rb

@@ -2,8 +2,8 @@ require 'enumeration'
 require 'osheet/format/numeric'
 
 module Osheet::Format
-
   class Currency < Osheet::Format::Numeric
+
     def initialize(opts={})
       super({
         :symbol => 'dollar',

data/lib/osheet/format/custom.rb

@@ -1,5 +1,4 @@
 module Osheet::Format
-
   class Custom
 
     def initialize(type)

data/lib/osheet/format/datetime.rb

@@ -1,5 +1,4 @@
 module Osheet::Format
-
   class Datetime
 
     def initialize(string)

data/lib/osheet/format/fraction.rb

@@ -1,7 +1,6 @@
 require 'enumeration'
 
 module Osheet::Format
-
   class Fraction
     include Enumeration
 

data/lib/osheet/format/general.rb

@@ -1,9 +1,9 @@
 module Osheet::Format
-
   class General
+
     def initialize(opts={}); end
     def style; nil; end
     def key; ''; end
-  end
 
+  end
 end

data/lib/osheet/format/number.rb

@@ -2,7 +2,6 @@ require 'enumeration'
 require 'osheet/format/numeric'
 
 module Osheet::Format
-
   class Number < Osheet::Format::Numeric
 
     def initialize(opts={})

data/lib/osheet/format/numeric.rb

@@ -3,16 +3,17 @@
 require 'enumeration'
 
 module Osheet::Format
-
   class Numeric
     include Enumeration
 
     attr_accessor :decimal_places, :comma_separator
+
     enum :symbol, {
       :none => "none",
       :dollar => "dollar",
       :euro => "euro"
     }
+
     enum :negative_numbers, {
       :black => "black",
       :black_parenth => "black_parenth",

data/lib/osheet/format/percentage.rb

@@ -2,8 +2,8 @@ require 'enumeration'
 require 'osheet/format/numeric'
 
 module Osheet::Format
-
   class Percentage < Osheet::Format::Numeric
+
     def initialize(opts={})
       super({
         :decimal_places => 2
@@ -21,5 +21,6 @@ module Osheet::Format
     def decimal_places_suffix
       "%"
     end
+
   end
 end

data/lib/osheet/format/scientific.rb

@@ -2,8 +2,8 @@ require 'enumeration'
 require 'osheet/format/numeric'
 
 module Osheet::Format
-
   class Scientific < Osheet::Format::Numeric
+
     def initialize(opts={})
       super({
         :decimal_places => 2
@@ -21,5 +21,6 @@ module Osheet::Format
     def decimal_places_suffix
       "E+00"
     end
+
   end
 end

data/lib/osheet/format/special.rb

@@ -1,7 +1,6 @@
 require 'enumeration'
 
 module Osheet::Format
-
   class Special
     include Enumeration
 

data/lib/osheet/format/text.rb

@@ -1,5 +1,4 @@
 module Osheet::Format
-
   class Text
 
     def initialize(opts={}); end

data/lib/osheet/mixin.rb

@@ -46,6 +46,7 @@ module Osheet::Mixin
     def partials
       instance_variable_get("@p") || []
     end
+
   end
 
 end

data/lib/osheet/row.rb

@@ -1,6 +1,5 @@
 require 'osheet/meta_element'
 require 'osheet/styled_element'
-
 require 'osheet/cell'
 
 module Osheet

data/lib/osheet/style.rb

@@ -53,5 +53,6 @@ module Osheet
       selector =~ /^[^.]/ ||
       selector =~ />+/
     end
+
   end
 end

data/lib/osheet/styled_element.rb

@@ -23,4 +23,5 @@ module Osheet::StyledElement
     style_class =~ /\.+/ ||
     style_class =~ />+/
   end
+
 end

data/lib/osheet/version.rb

@@ -1,3 +1,3 @@
 module Osheet
-  VERSION = "1.0.0.rc.4"
+  VERSION = "1.0.0"
 end

data/lib/osheet/workbook.rb

@@ -5,7 +5,6 @@ require 'osheet/workbook_api'
 
 module Osheet
 
-
   class Workbook
 
     # This 'Workbook' class is really just a scope for workbook builds to run
@@ -96,8 +95,6 @@ module Osheet
 
   end
 
-
-
   class Workbook::ElementStack
 
     # this class is just a wrapper to Array.  I want to treat this as a
@@ -133,5 +130,4 @@ module Osheet
 
   end
 
-
 end