osheet 0.1.0 → 0.2.0

data/examples/formats.rb

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

data/examples/trivial.rb

@@ -0,0 +1,21 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/trivial.rb
+# $ open examples/trivial.xls
+
+require 'rubygems'
+require 'osheet'
+
+Osheet::Workbook.new {
+  title "basic"
+  worksheet {
+    name "one dollar"
+    column
+    row {
+      cell {
+        data 1
+        format :currency
+      }
+    }
+  }
+}.to_file('examples/trivial.xls')

data/lib/osheet/associations.rb

@@ -0,0 +1,62 @@
+module Osheet::Associations
+
+  def self.included(receiver)
+    receiver.send(:extend, ClassMethods)
+  end
+
+  module ClassMethods
+
+    # A has many esque association helper
+    #  - will provide a collection reader
+    #  - will define a 'singular' item method for adding to the collection
+    #  - will support adding to the collection both by black and template
+    def hm(collection)
+      unless collection.to_s =~ /s$/
+        raise ArgumentError, "association item names must end in 's'"
+      end
+      plural = collection.to_s
+      singular = plural.to_s.sub(/s$/, '')
+      klass = Osheet.const_get(singular.capitalize)
+
+      # define collection reader
+      self.send(:define_method, plural, Proc.new do
+        if instance_variable_get("@#{plural}").nil?
+          instance_variable_set("@#{plural}", [])
+        end
+        instance_variable_get("@#{plural}")
+      end)
+
+      # define collection item writer
+      self.send(:define_method, singular) do |*args, &block|
+        if instance_variable_get("@#{plural}").nil?
+          instance_variable_set("@#{plural}", [])
+        end
+        instance_variable_get("@#{plural}") << if self.respond_to?(:workbook)
+          # on: worksheet, column, row
+          # creating: column, row, cell
+          worksheet = self.respond_to?(:worksheet) ? self.worksheet : self
+          if self.workbook && (template = self.workbook.templates.get(singular, args.first))
+            # add by template
+            klass.new(self.workbook, worksheet, *args[1..-1], &template)
+          else
+            # add by block
+            klass.new(self.workbook, worksheet, &block)
+          end
+        else
+          # on: workbook
+          # creating: worksheet
+          if (template = self.templates.get(singular, args.first))
+            # add by template
+            klass.new(self, *args[1..-1], &template)
+          else
+            # add by block
+            klass.new(self, &block)
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/osheet/cell.rb

@@ -1,18 +1,52 @@
-require 'osheet/base'
+require 'date'
+require 'osheet/format'
 
 module Osheet
-  class Cell < Osheet::Base
+  class Cell
+    include WorkbookElement
+    include WorksheetElement
+    include StyledElement
 
-    attr_accessor :data
+    def initialize(workbook=nil, worksheet=nil, *args, &block)
+      @workbook = workbook
+      @worksheet = worksheet
+      @data = nil
+      @format = Format.new(:general)
+      @rowspan = 1
+      @colspan = 1
+      @href = nil
+      instance_exec(*args, &block) if block_given?
+    end
+
+    def data(value)
+      @data = case value
+      when ::String, ::Numeric, ::Date, ::Time, ::DateTime
+        value
+      when ::Symbol
+        value.to_s
+      else
+        value.inspect.to_s
+      end
+    end
 
-    ATTRS = [:format, :rowspan, :colspan]
-    ATTRS.each {|a| attr_accessor a}
+    def format(type, opts={})
+      @format = Format.new(type, opts)
+    end
+
+    def rowspan(value); @rowspan = value; end
+    def colspan(value); @colspan = value; end
+    def href(value); @href = value; end
 
-    def initialize(data='', args={})
-      @data = data
-      set_args ATTRS, args
-      super(args)
+    def attributes
+      {
+        :style_class => @style_class,
+        :data => @data,
+        :format => @format,
+        :colspan => @colspan,
+        :rowspan => @rowspan,
+        :href => @href,
+      }
     end
-    
+
   end
 end

data/lib/osheet/column.rb

@@ -1,11 +1,38 @@
-require 'osheet/base'
-
 module Osheet
-  class Column < Osheet::Base
-    
-    def initialize(args={})
-      super(args)
+  class Column
+    include WorkbookElement
+    include WorksheetElement
+    include StyledElement
+
+    def initialize(workbook=nil, worksheet=nil, *args, &block)
+      @workbook = workbook
+      @worksheet = worksheet
+      @width = nil
+      @autofit = false
+      @hidden = false
+      @meta = nil
+      instance_exec(*args, &block) if block_given?
+    end
+
+    def width(value=nil)
+      !value.nil? ? @width = value : @width
+    end
+    def autofit(value); @autofit = !!value; end
+    def autofit?; @autofit; end
+    def hidden(value); @hidden = !!value; end
+    def hidden?; @hidden; end
+
+    def attributes
+      {
+        :style_class => @style_class,
+        :width => @width,
+        :autofit => @autofit,
+        :hidden => @hidden
+      }
+    end
+
+    def meta(value=nil)
+      value.nil? ? @meta : (@meta = value)
     end
-    
   end
 end

data/lib/osheet/format/accounting.rb

@@ -0,0 +1,21 @@
+require 'enumeration'
+require 'osheet/format/currency'
+
+module Osheet::Format
+
+  class Accounting < Osheet::Format::Currency
+
+    protected
+
+    # used by 'key' in Numeric base class
+    def key_prefix
+      "accounting"
+    end
+
+    # used by 'numeric_style' in Numeric base class
+    def symbol_suffix
+      "* "
+    end
+
+  end
+end

data/lib/osheet/format/currency.rb

@@ -0,0 +1,23 @@
+require 'enumeration'
+require 'osheet/format/numeric'
+
+module Osheet::Format
+
+  class Currency < Osheet::Format::Numeric
+    def initialize(opts={})
+      super({
+        :symbol => :dollar,
+        :decimal_places => 2,
+        :comma_separator => true
+      }.merge(opts))
+    end
+
+    protected
+
+    # used by 'key' in Numeric base class
+    def key_prefix
+      "currency"
+    end
+
+  end
+end

data/lib/osheet/format/custom.rb

@@ -0,0 +1,13 @@
+module Osheet::Format
+
+  class Custom
+
+    def initialize(type)
+      @type = type
+    end
+
+    def style; @type; end
+    def key; "custom_#{@type}"; end
+
+  end
+end

data/lib/osheet/format/datetime.rb

@@ -0,0 +1,13 @@
+module Osheet::Format
+
+  class Datetime
+
+    def initialize(string)
+      @string = string
+    end
+
+    def style; @string; end
+    def key; "datetime_#{@string}"; end
+
+  end
+end

data/lib/osheet/format/fraction.rb

@@ -0,0 +1,33 @@
+require 'enumeration'
+
+module Osheet::Format
+
+  class Fraction
+    include Enumeration
+
+    enum(:type, {
+      :one_digit => '?/?',
+      :two_digits => '??/??',
+      :three_digits => '???/???',
+      :halves => '?/2',
+      :quarters => '?/4',
+      :eighths => '?/8',
+      :sixteenths => '??/16',
+      :tenths => '?/10',
+      :hundredths => '??/100'
+    })
+
+    def initialize(opts={})
+      self.type = opts[:type] || :two_digits
+    end
+
+    def style
+      "#\ #{type}"
+    end
+
+    def key
+      "fraction_#{type_key.to_s.gsub('_', '')}"
+    end
+
+  end
+end

data/lib/osheet/format/general.rb

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

data/lib/osheet/format/number.rb

@@ -0,0 +1,13 @@
+require 'enumeration'
+require 'osheet/format/numeric'
+
+module Osheet::Format
+
+  class Number < Osheet::Format::Numeric
+
+    def initialize(opts={})
+      super
+    end
+
+  end
+end