osheet 0.1.0 → 0.2.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,6 @@
+/pkg/
+/doc/
+/coverage/
+*.log
+/tmp
+/examples/*.xls

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in osheet.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    osheet (0.1.0)
+      enumeration (~> 1.1.0)
+      xmlss (~> 0.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    enumeration (1.1.0)
+    json (1.5.1)
+    kelredd-useful (0.4.1)
+      json
+    leftright (0.9.0)
+    nokogiri (1.4.4)
+    shoulda (2.11.3)
+    test-belt (0.2.1)
+      kelredd-useful (~> 0.4.0)
+      leftright (~> 0.9.0)
+      shoulda (~> 2.11)
+    xmlss (0.0.2)
+      nokogiri (~> 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  enumeration (~> 1.1.0)
+  osheet!
+  test-belt (= 0.2.1)
+  xmlss (~> 0.0.2)

data/README.rdoc

@@ -9,72 +9,114 @@ Pronounced 'oh-sheeeeeet!' - this gem is a DSL wrapper to the spreadsheet gem th
 
     $ gem install osheet
 
-== Basic Usage
+== Basic Example
+    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
 
     require 'osheet'
-    
-    Osheet::Workbook do |wb|
-      wb.worksheet "Users" do |sheet|
-        sheet.column
-        sheet.column
-        sheet.column
-  
-        sheet.row do |r|
-          r.cell "Characters on \"Friends\"", :colspan => 3
-        end
-        sheet.row do |r|
-          r.cell "man, that show was awesome...", :colspan => 3
-        end
 
-        sheet.row do |r|
-          r.cell "", :colspan => 1
-          r.cell 'only concern yourself with these columns', :colspan => 2
-        end
-  
-        sheet.row do |r|
-          r.cell "id"
-          r.cell "name"
-          r.cell "description"
-        end
-  
-        sheet.row do |r|
-          r.cell 1
-          r.cell "Ross"
-          r.cell "the nerdy one, brother of Monica, dated Rachel, likes impregnating women, loves Rachel"
-        end
-  
-        sheet.row do |r|
-          r.cell 2
-          r.cell "Rachel"
-          r.cell "the hot one, dated and impregnated by Ross, generally spoiled"
-        end
-  
-        sheet.row do |r|
-          r.cell 3
-          r.cell "Chandler"
-          r.cell "the responsible one, husband of Monica, insecure about everything"
-        end
-  
-        sheet.row do |r|
-          r.cell 4
-          r.cell "Monica"
-          r.cell "the smart one, wife of Chandler, sister of Ross, OCD about cleaning and controlling"
-        end
-  
-        sheet.row do |r|
-          r.cell 5
-          r.cell "Joey"
-          r.cell "the man-whore one, best-friend of Chandler, generally dumb, can't sustain sitcom on own"
+    wb = Osheet::Workbook.new {
+      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
-  
-        sheet.row do |r|
-          r.cell 6
-          r.cell "Phoebe"
-          r.cell "the crazy one, ex-roomate of Rachel, blond, free, weird, yet awesome"
+
+        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
-  
-      end
-    end
+      } # worksheet
+    } # workbook
+
+    file = wb.to_file('stats')  # => <spreadsheet written to ./stats.xls>
+
+== API
+
+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
 
 == Links
 

data/Rakefile

@@ -1,58 +1,7 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-require 'lib/osheet/version'
+require 'test_belt/rake_tasks'
+TestBelt::RakeTasks.for :test
 
-spec = Gem::Specification.new do |s|
-  s.name             = 'osheet'
-  s.version          = Osheet::Version.to_s
-  s.has_rdoc         = true
-  s.extra_rdoc_files = %w(README.rdoc)
-  s.rdoc_options     = %w(--main README.rdoc)
-  s.summary          = "A DSL for generating spreadsheets that doesn't totally suck - pronounced 'Oh sheeeeeet!'"
-  s.author           = 'Kelly Redding'
-  s.email            = 'kelly@kelredd.com'
-  s.homepage         = 'http://github.com/kelredd/osheet'
-  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
-  # s.executables    = ['osheet']
-
-  s.add_development_dependency("shoulda", [">= 2.10.0"])
-  s.add_development_dependency("kelredd-useful", [">= 0.3.0"])
-
-  s.add_dependency("spreadsheet", [">= 0.6.4"])
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-
-  Rcov::RcovTask.new(:coverage) do |t|
-    t.libs       = ['test']
-    t.test_files = FileList["test/**/*_test.rb"]
-    t.verbose    = true
-    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
-  end
-  
-  task :default => :coverage
-  
-rescue LoadError
-  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
-  task :default => :test
-end
-
-desc 'Generate the gemspec to serve this gem'
-task :gemspec do
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, 'w') {|f| f << spec.to_ruby }
-  puts "Created gemspec: #{file}"
-end
+task :default => :build

data/examples/basic.rb

@@ -0,0 +1,73 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/basic.rb
+# $ open examples/basic.xls
+
+require 'rubygems'
+require 'osheet'
+
+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
+
+
+Osheet::Workbook.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')