osheet 0.3.0 → 0.4.0

data/README.rdoc

@@ -1,15 +1,17 @@
 = Osheet
-* Osheet is under development and should not be relied upon just yet.  Thx. *
 
 == Description
 
-Pronounced 'oh-sheeeeeet!' - this gem is a DSL wrapper to the spreadsheet gem that hopefully doesn't totally suck.
+A DSL for specifying and generating spreadsheets using Ruby.
 
 == Installation
 
     $ gem install osheet
 
 == Basic Example
+
+    require 'osheet'
+
     fields = ['Sex', 'Age', 'Height', 'Weight']
     data = {
       'Tom' => ['M', 52, "6'2\"", '220 lbs.'],
@@ -19,9 +21,50 @@ Pronounced 'oh-sheeeeeet!' - this gem is a DSL wrapper to the spreadsheet gem th
 
     # this will dump the above data to a single-sheet workbook w/ no styles
 
-    require 'osheet'
+    Osheet::Workbook.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
+      }
 
-    wb = Osheet::Workbook.new {
       worksheet {
         name "Stats: #{fields.join(', ')}"
 
@@ -32,103 +75,34 @@ Pronounced 'oh-sheeeeeet!' - this gem is a DSL wrapper to the spreadsheet gem th
           )
         }
         fields.each_with_index do |f, i|
-          column {
-            width 80
-            meta(
-              :label => f.to_s,
-              :index => i
-            )
-          }
+          column :data, f, 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
-        }
+        row :title
+        row :empty
+        row :header
 
         data.each do |name, stats|
-          row {   # data row
-            cell {
-              data name
-            }
-            stats.each do |stat|
-              cell {
-                data stat
-              }
-            end
-          }
+          row :data, name, stats
         end
-      } # worksheet
-    } # workbook
+      }
+    }.to_file('stats.xls')
 
-    file = wb.to_file('stats')  # => <spreadsheet written to ./stats.xls>
-
-== Examples
+== API
 
-I've add a few examples to ./examples.  Please refer to these for examples on basic usage, using templates, formatting data, and styling data.
+Check out the wiki: https://github.com/kelredd/osheet/wiki.  It covers the full Osheet API.
 
-== API
+== Examples
 
-These classes define how a spreadsheet is constructed.
-=== Osheet::Workbook
-* *style(selector, &block)*: define a style for the workbook
-* *template(for, named, &block)*: define a named template for the workbook
-* *worksheet(&block)*: define a worksheet for the workbook
-# TODO: *use(module)*
-# TODO: *use(file)*
-
-=== Osheet::Worksheet
-* *name(value)*: set the name for this worksheet
-* *column(&block)*: define a column for the worksheet
-* *column(:template, *args): define a templated column for the worksheet
-* *row(&block)*: define a row for the worksheet
-* *row(:template, *args): define a templated row for the worksheet
-
-=== Xmlss::Column
-* *style_class(value)*: (string) the styles selectors should match against
-* *width(value)*: (numeric) set the explicit width for the column
-* *auto_fit_width(value)*: (bool) set whether the column should auto fit it's width, default: false
-* *hidden(value)*: (bool) set whether the column is hidden, default: false
-* *meta(data)*: (anything) a generic way to associate meta-data with the column
-
-=== Xmlss::Row
-* *style_class(value)*: (string) the styles selectors should match against
-* *height(value)*: (numeric) set the explicit width for the column
-* *auto_fit_height(value)*: (bool) set whether the row should auto fit it's height, default: false
-* *hidden(value)*: (bool) set whether the row is hidden, default: false
-* *cell(&block)*: define a cell for the row
-* *cell(:template, *args): define a templated cell for the row
-
-=== Xmlss::Cell
-* *style_class(value)*: (string) the styles selectors should match against
-* *data(value)*: (anything), data the cell should contain.  if not a string, numeric, or date, will cast data to sting using 'inspect'.
-* format(value)*: (anything), optional, custom formatting string for the data (see driver documentation for options)
-* *colspan(value)*: (int) the number of columns (l to r) the cell should occupy, default: 1
-* *rowspan(value)*: (int) the number of rows (t to b) the cell should occupy, default: 1
-* *href(value)*: (string) set the href the data should link to
+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
 
-* *GitHub*
+* *Osheet*
   - http://github.com/kelredd/osheet
 
-* *Spreadsheet*
-  - http://spreadsheet.rubyforge.org/
+* *Wiki*
+  - https://github.com/kelredd/osheet/wiki
 
 == License
 

data/lib/osheet.rb

@@ -8,5 +8,6 @@ require 'osheet/associations'
 require 'osheet/workbook_element'
 require 'osheet/worksheet_element'
 require 'osheet/styled_element'
+require 'osheet/meta_element'
 
 require 'osheet/workbook'

data/lib/osheet/column.rb

@@ -3,6 +3,7 @@ module Osheet
     include WorkbookElement
     include WorksheetElement
     include StyledElement
+    include MetaElement
 
     def initialize(workbook=nil, worksheet=nil, *args, &block)
       @workbook = workbook
@@ -10,7 +11,6 @@ module Osheet
       @width = nil
       @autofit = false
       @hidden = false
-      @meta = nil
       instance_exec(*args, &block) if block_given?
     end
 
@@ -31,8 +31,5 @@ module Osheet
       }
     end
 
-    def meta(value=nil)
-      value.nil? ? @meta : (@meta = value)
-    end
   end
 end

data/lib/osheet/meta_element.rb

@@ -0,0 +1,7 @@
+module Osheet::MetaElement
+
+  def meta(value=nil)
+    value.nil? ? instance_variable_get("@meta") : instance_variable_set("@meta", value)
+  end
+
+end

data/lib/osheet/mixin.rb

@@ -0,0 +1,30 @@
+require 'osheet/style'
+require 'osheet/template'
+
+module Osheet::Mixin
+
+  def self.included(receiver)
+    receiver.send(:extend, ClassMethods)
+  end
+
+  module ClassMethods
+    def style(*selectors, &block)
+      instance_variable_set("@s",
+        (instance_variable_get("@s") || []) << ::Osheet::Style.new(*selectors, &block)
+      )
+    end
+    def styles
+      instance_variable_get("@s") || []
+    end
+
+    def template(element, name, &block)
+      instance_variable_set("@t",
+        (instance_variable_get("@t") || []) << ::Osheet::Template.new(element, name, &block)
+      )
+    end
+    def templates
+      instance_variable_get("@t") || []
+    end
+  end
+
+end

data/lib/osheet/row.rb

@@ -6,6 +6,7 @@ module Osheet
     include WorkbookElement
     include WorksheetElement
     include StyledElement
+    include MetaElement
 
     hm :cells
 

data/lib/osheet/version.rb

@@ -1,3 +1,3 @@
 module Osheet
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/osheet/workbook.rb

@@ -27,6 +27,11 @@ module Osheet
       { :title => @title }
     end
 
+    def use(mixin)
+      (mixin.styles || []).each{ |s| @styles << s }
+      (mixin.templates || []).each{ |t| @templates << t }
+    end
+
     def writer
       XmlssWriter::Base.new(:workbook => self)
     end

data/lib/osheet/worksheet.rb

@@ -5,6 +5,7 @@ module Osheet
   class Worksheet
     include Associations
     include WorkbookElement
+    include MetaElement
 
     hm :columns
     hm :rows

data/lib/osheet/worksheet_element.rb

@@ -5,11 +5,14 @@ module Osheet::WorksheetElement
     end
   end
 
-  def columns
-    if worksheet && worksheet.respond_to?(:columns)
-      worksheet.columns
-    else
-      nil
+  [:columns, :rows].each do |meth|
+    define_method(meth) do
+      if worksheet && worksheet.respond_to?(meth)
+        worksheet.send(meth)
+      else
+        nil
+      end
     end
   end
+
 end

data/osheet.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Kelly Redding"]
   s.email       = ["kelly@kelredd.com"]
   s.homepage    = "http://github.com/kelredd/osheet"
-  s.summary     = %q{A DSL for generating spreadsheets that doesn't totally suck - pronounced 'Oh sheeeeeet!'}
-  s.description = %q{A DSL for specifying and generating rich spreasheetML.  Specify your spreadsheet using the richness of Ruby and easily produce the corresponding spreadsheetML to render in MS Excel.}
+  s.summary     = %q{A DSL for specifying and generating spreadsheets using Ruby}
+  s.description = %q{A DSL for specifying and generating spreadsheets using Ruby}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/mixin_test.rb

@@ -0,0 +1,47 @@
+require "test/helper"
+require 'osheet/mixin'
+require 'test/mixins'
+
+module Osheet
+
+  class MixinBaseTest < Test::Unit::TestCase
+    context "Osheet::Mixin thing" do
+      subject { DefaultMixin }
+
+      should_have_readers :styles, :templates
+      should_have_instance_methods :style, :template
+
+      should "set it's defaults" do
+        assert_equal [], subject.styles
+        assert_equal [], subject.templates
+      end
+    end
+  end
+
+  class MixinStyleTest < Test::Unit::TestCase
+    context "that defines styles" do
+      subject { StyledMixin }
+
+      should "have it's styles defined" do
+        assert_equal 2, subject.styles.size
+        assert_equal 1, subject.styles.first.selectors.size
+        assert_equal '.test', subject.styles.first.selectors.first
+        assert_equal 1, subject.styles.last.selectors.size
+        assert_equal '.test.awesome', subject.styles.last.selectors.first
+      end
+    end
+  end
+
+  class MixinTemplateTest < Test::Unit::TestCase
+    context "that defines templates" do
+      subject { TemplatedMixin }
+
+      should "have it's templates defined" do
+        assert subject.templates
+        assert_equal 3, subject.templates.size
+        assert_kind_of Template, subject.templates.first
+      end
+    end
+  end
+
+end

data/test/mixins.rb

@@ -0,0 +1,31 @@
+require 'osheet/mixin'
+
+class DefaultMixin
+  include Osheet::Mixin
+
+end
+
+class StyledMixin
+  include Osheet::Mixin
+
+  style('.test')
+  style('.test.awesome')
+
+end
+
+class TemplatedMixin
+  include Osheet::Mixin
+
+  template(:column, :yo) { |color|
+    width 200
+    meta(:color => color)
+  }
+  template(:row, :yo_yo) {
+    height 500
+  }
+  template(:worksheet, :go) {
+    column(:yo, 'blue')
+    row(:yo_yo)
+  }
+
+end

data/test/row_test.rb

@@ -14,6 +14,7 @@ module Osheet
       should_have_instance_method :height
       should_have_instance_methods :autofit, :autofit?
       should_have_instance_methods :hidden, :hidden?
+      should_have_instance_method :meta
 
       should "set it's defaults" do
         assert_equal nil, subject.send(:instance_variable_get, "@height")
@@ -23,6 +24,7 @@ module Osheet
         assert !subject.hidden?
 
         assert_equal [], subject.cells
+        assert_equal nil, subject.meta
       end
 
       context "that has attributes" do
@@ -32,6 +34,9 @@ module Osheet
             height  100
             autofit true
             hidden true
+            meta(
+              {}
+            )
           end
         end
 
@@ -41,6 +46,7 @@ module Osheet
           assert subject.autofit?
           assert_equal true, subject.send(:instance_variable_get, "@hidden")
           assert subject.hidden?
+          assert_equal({}, subject.meta)
         end
 
         should "know it's height" do

data/test/workbook_test.rb

@@ -1,5 +1,6 @@
 require "test/helper"
 require 'osheet/workbook'
+require 'test/mixins'
 
 module Osheet
   class WorkbookTest < Test::Unit::TestCase
@@ -8,7 +9,7 @@ module Osheet
       subject { Workbook.new }
 
       should_have_readers :styles, :templates
-      should_have_instance_methods :title, :style, :template, :attributes
+      should_have_instance_methods :title, :style, :template, :attributes, :use
 
       should_hm(Workbook, :worksheets, Worksheet)
 
@@ -138,6 +139,40 @@ module Osheet
 
   end
 
+  class WorkbookMixins < Test::Unit::TestCase
+    context "a workbook w/ mixins" do
+      subject do
+        Workbook.new {
+          use StyledMixin
+          use TemplatedMixin
+        }
+      end
+
+      should "add the mixin styles to it's styles" do
+        assert_equal 2, subject.styles.size
+        assert_equal 1, subject.styles.first.selectors.size
+        assert_equal '.test', subject.styles.first.selectors.first
+        assert_equal 1, subject.styles.last.selectors.size
+        assert_equal '.test.awesome', subject.styles.last.selectors.first
+      end
+
+      should "add the mixin templates to it's templates" do
+        assert subject.templates
+        assert_kind_of TemplateSet, subject.templates
+        assert_equal 3, subject.templates.keys.size
+        assert_kind_of Template, subject.templates.get('column', 'yo')
+        assert_kind_of Template, subject.templates.get('row', 'yo_yo')
+        assert_kind_of Template, subject.templates.get('worksheet', 'go')
+
+        subject.worksheet(:go)
+        assert_equal 1, subject.worksheets.size
+        assert_equal 'blue', subject.worksheets.first.columns.first.meta[:color]
+        assert_equal 500, subject.worksheets.first.rows.first.attributes[:height]
+      end
+
+    end
+  end
+
   class WorkbookWriter < Test::Unit::TestCase
     context "a workbook" do
       subject do

data/test/worksheet_test.rb

@@ -10,11 +10,14 @@ module Osheet
       should_be_a_workbook_element(Worksheet)
 
       should_have_instance_methods :name, :attributes
+      should_have_instance_method :meta
 
       should "set it's defaults" do
         assert_equal nil, subject.send(:instance_variable_get, "@name")
         assert_equal [], subject.columns
         assert_equal [], subject.rows
+
+        assert_equal nil, subject.meta
       end
 
       should_hm(Worksheet, :columns, Column)
@@ -24,6 +27,9 @@ module Osheet
         subject do
           Worksheet.new do
             name "Poo!"
+            meta(
+              {}
+            )
 
             column
 
@@ -36,8 +42,9 @@ module Osheet
           end
         end
 
-        should "set it's name" do
+        should "set it's name and meta" do
           assert_equal "Poo!", subject.send(:instance_variable_get, "@name")
+          assert_equal({}, subject.meta)
         end
 
         should "know it's name" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: osheet
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 -05:00
+date: 2011-04-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,7 +81,7 @@ dependencies:
         version: 0.1.0
   type: :runtime
   version_requirements: *id004
-description: A DSL for specifying and generating rich spreasheetML.  Specify your spreadsheet using the richness of Ruby and easily produce the corresponding spreadsheetML to render in MS Excel.
+description: A DSL for specifying and generating spreadsheets using Ruby
 email: 
 - kelly@kelredd.com
 executables: []
@@ -119,6 +119,8 @@ files:
 - lib/osheet/format/scientific.rb
 - lib/osheet/format/special.rb
 - lib/osheet/format/text.rb
+- lib/osheet/meta_element.rb
+- lib/osheet/mixin.rb
 - lib/osheet/row.rb
 - lib/osheet/style.rb
 - lib/osheet/style_set.rb
@@ -151,6 +153,8 @@ files:
 - test/format/text_test.rb
 - test/format_test.rb
 - test/helper.rb
+- test/mixin_test.rb
+- test/mixins.rb
 - test/osheet_test.rb
 - test/row_test.rb
 - test/style_set_test.rb
@@ -195,7 +199,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A DSL for generating spreadsheets that doesn't totally suck - pronounced 'Oh sheeeeeet!'
+summary: A DSL for specifying and generating spreadsheets using Ruby
 test_files: 
 - test/cell_test.rb
 - test/column_test.rb
@@ -213,6 +217,8 @@ test_files:
 - test/format/text_test.rb
 - test/format_test.rb
 - test/helper.rb
+- test/mixin_test.rb
+- test/mixins.rb
 - test/osheet_test.rb
 - test/row_test.rb
 - test/style_set_test.rb