libexcel 0.1

data/lib/libexcel.rb

@@ -0,0 +1,50 @@
+require 'libxml'
+require 'libexcel/document'
+require 'libexcel/worksheet'
+require 'libexcel/formula'
+
+module LibExcel
+
+  VERSION = "0.1"
+
+  class << self
+
+    # Creates the full Excel XML equation string
+    #
+    # @return [String] the full Excel style equation string
+    def range(args)
+      if args[:cols].nil?
+        (buf = static(args[:rows].first, args[:col])) << ':'
+        buf << static(args[:rows].last, args[:col])
+      elsif args[:rows].nil?
+        (buf = static(args[:row], args[:cols].first)) << ':'
+        buf << static(args[:row], args[:cols].last)
+      else
+        (buf = static(args[:rows].first, args[:cols].first)) << ':'
+        buf << static(args[:rows].last, args[:cols].last)
+      end
+    end
+
+    # Creates part of the Excel XML style equation string
+    #
+    # @example
+    #   static(1, 1)   => "R[1]C[1]"
+    #   static(0, 1)   => "R[0]C[1]"
+    #   static(1)      => "R[1]C"
+    #   static(nil, 1) => "RC[1]"
+    # 
+    # @param [Integer, Integer] the two integer values to be converted
+    # @return [String] the Excel style equation string
+    def static(row, col)
+      if col.nil?
+        "R[#{row}]C"
+      elsif row.nil?
+        "RC[#{col}]"
+      else
+        "R[#{row}]C[#{col}]"
+      end
+    end
+
+  end
+
+end

data/lib/libexcel/document.rb

@@ -0,0 +1,86 @@
+module LibExcel
+
+  # The Document class manages the document section of the Excel XML file.
+  class Document < LibXML::XML::Document
+    include LibXML
+
+    attr_accessor :name
+
+    # Creates the Document object. Calls the +super()+ to get the basics of a
+    # XML document. +name+ is the name of the document.
+    def initialize(name)
+      super()
+
+      @name = name
+      build_document
+      build_root
+    end
+
+    # Appends a worksheet to a Document.  Requires that they worksheet being
+    # appended to the document be a Worksheet.
+    #
+    # @return [Document] the Full XML document
+    def <<(worksheet)
+      if not worksheet.is_a? Worksheet
+        raise ArgumentError, "Need to have a Excel::Worksheet"
+      end
+      root << worksheet
+    end
+
+    private
+      def root
+        super
+      end
+
+      # Setup the common Excel URIs in the root.
+      def build_document
+        self.root = XML::Node.new('Workbook')
+        root['xmlns'] = 'urn:schemas-microsoft-com:office:spreadsheet'
+        root['xmlns:o'] = 'urn:schemas-microsoft-com:office:office'
+        root['xmlns:x'] = 'urn:schemas-microsoft-com:office:excel'
+        root['xmlns:ss'] = 'urn:schemas-microsoft-com:office:spreadsheet'
+        root['xmlns:html'] = 'http://www.w3.org/TR/REC-html40'
+      end
+
+      # Setup the document properties of the document.
+      def build_root
+        root << document_properties = XML::Node.new('DocumentProperties')
+        document_properties['xmlns'] = 'urn:schemas-microsoft-com:office:office'
+
+        document_properties << author = XML::Node.new('Author')
+        author << 'Scarlet'
+        document_properties << last_author = XML::Node.new('LastAuthor')
+        last_author << 'Scarlet'
+        document_properties << version = XML::Node.new('Version')
+        version << '12.256'
+
+        root << office_document_settings = XML::Node.new('OfficeDocumentSettings')
+        office_document_settings['xmlns'] = 'urn:schemas-microsoft-com:office:office'
+        office_document_settings << XML::Node.new('AllowPNG')
+
+        root << excel_workbook = XML::Node.new('ExcelWorkbook')
+        excel_workbook['xmlns'] = 'urn:schemas-microsoft-com:office:excel'
+
+        excel_workbook << window_height = XML::Node.new('WindowHeight', '20260')
+        excel_workbook << window_width = XML::Node.new('WindowWidth', '29600')
+        excel_workbook << window_top_x = XML::Node.new('WindowTopX', '3440')
+        excel_workbook << window_top_y = XML::Node.new('WindowTopY', '-80')
+        excel_workbook << XML::Node.new('Date1904')
+        excel_workbook << XML::Node.new('ProtectStructure', 'False')
+        excel_workbook << XML::Node.new('ProtectWindows', 'False')
+
+        root << styles = XML::Node.new('Styles')
+        styles << style = XML::Node.new('Style')
+        style['ss:ID'] = 'Default'
+        style['ss:Name'] = 'Normal'
+        style << alignment = XML::Node.new('Alignment')
+        alignment['ss:Vertical'] = 'Bottom'
+        style << XML::Node.new('Borders')
+        style << font = XML::Node.new('Font')
+        font['ss:FontName'] = 'Verdana'
+        style << XML::Node.new('Interior')
+        style << XML::Node.new('NumberFormat')
+        style << XML::Node.new('Protection')
+      end
+  end
+end

data/lib/libexcel/formula.rb

@@ -0,0 +1,82 @@
+module LibExcel
+  # Manages a Formula object to be used in a {Excel::Worksheet}.  
+  # Builds an Excel XML formula.  The Formula class responds to any 
+  # +class method+.  Such methods should correspond to their Excel
+  # counterparts.
+  #
+  # Some Excel formulas that will work are:
+  # * COUNTA
+  # * SUM
+  # * etc.
+  #
+  # @example
+  #   formula = Excel::Formula.counta(:row => 1..2)
+  #   # Creates an equivalent formula =COUNTA(1:2)
+  #   
+  class Formula
+    attr_reader :xml
+
+    # <b>Should never be called directly.</b>
+    # Creates the Formula object
+    def initialize(equ)
+      @xml = LibXML::XML::Node.new('Cell')
+      @xml['ss:Formula'] = equ
+    end
+
+    # Creates a new Formula thats references the division of one Formula
+    # by another Formula.
+    #
+    # @return [Formula] A new Formula reference
+    #
+    # @example
+    #   f1 = Excel::Formula.counta(:row => 1..2)
+    #   f2 = Excel::Formula.counta(:row => 1..2)
+    #   f1_divided_f2 = f1/f1
+    def /(formula)
+      org_f = self.xml['ss:Formula']
+      org_f << '/' << formula.xml['ss:Formula'][1..-1]
+      Formula.new(org_f) 
+    end
+
+    def self.node_correct?(node)
+      digit_block = /(\[-?\d+\])?/
+      r_d_block = /R#{digit_block}C#{digit_block}/
+      function = /=[A-Z]+\(#{r_d_block}:#{r_d_block}\)/
+
+      (node['ss:Formula'] =~ function) != nil
+    end
+
+    def self.partition(node)
+      digit_block = /(\[-?\d+\])?/
+      big_block = /R#{digit_block}C#{digit_block}:R#{digit_block}C#{digit_block}/
+
+      m = big_block.match(node['ss:Formula']).to_a[1..4]
+      m.map { |bits| bits.nil? ? nil : bits[1..-2].to_i }
+    end
+
+    # A class method that is a catchall for equation names.
+    def self.method_missing(meth, *args)
+      buffer = "=#{meth.to_s.upcase}(#{LibExcel.range(args.first)})"
+
+      self.new(buffer)
+    end
+
+    private
+    # @deprecated This isn't used in production but still help here
+    # for testings purposes.
+    #
+    # @see Excel.range for the actually production impl
+    def self.build_formula(hash)
+      if hash.is_a? Hash
+        buffer = ""
+        buffer << (hash.include?(:r) ? "R[#{hash[:r]}]" : "R")
+        buffer << (hash.include?(:c) ? "C[#{hash[:c]}]" : "C")
+        buffer << (hash.include?(:r2) ? ":R[#{hash[:r2]}]" : ":R")
+        buffer << (hash.include?(:c2) ? "C[#{hash[:c2]}]" : "C")
+      else
+        buffer = "RC:RC"
+      end
+    end
+
+  end
+end

data/lib/libexcel/worksheet.rb

@@ -0,0 +1,103 @@
+module LibExcel
+  # Manages the worksheet of an {Excel::Document}
+  #
+  # A Worksheet works by first creating a row then by adding one cell
+  # at a time until you call +add_row+ again to start on a new row.
+  #
+  # @example Create a Worksheet and add "hello world" to the first cell.
+  #   worksheet = Excel::Worksheet.new('My worksheet')
+  #   worksheet.add_row
+  #   worksheet.add_cell("hello world")
+  class Worksheet < LibXML::XML::Node
+    include LibXML
+    alias_method :append, :<<
+
+    DEFAULT_COLUMN_WIDTH = '100'
+
+    # Creates the Worksheet object. +name+ is the name of the Excel Document Tab. +name+ gets truncated to 31 chars.
+    def initialize(name)
+      super('Worksheet')
+      # Excel complains if the name is more than 31 chars.
+      self['ss:Name'] = name[0..30]
+      self.append table
+      @f_column = XML::Node.new('Column')
+      @f_column['ss:Width'] = DEFAULT_COLUMN_WIDTH
+      @table << @f_column
+    end
+
+    def name
+      self['ss:Name']
+    end
+
+    def f_column
+      @f_column['ss:Width']
+    end
+
+    # Sets the +name+ and retuncates it to 31 chars.
+    def name=(name)
+      self['ss:Name'] = name[0..30]
+    end
+
+    def f_column=(value)
+      @f_column['ss:Width'] = value.to_s
+    end
+
+    # Creates a row in the Worksheet.  This needs to be called before
+    # you can add data to the Worksheet.
+    def add_row
+      @table << @row = XML::Node.new('Row')
+    end
+
+    def add_cell(raw_data, attributes = {})
+      @row << cell = XML::Node.new('Cell')
+      if attributes[:formula]
+        cell['ss:Formula'] = attributes[:formula]
+      elsif not raw_data.nil?
+        cell << data = XML::Node.new('Data')
+        if raw_data.is_a?(Fixnum) or raw_data.is_a?(Float)
+          data['ss:Type'] = 'Number'
+        elsif raw_data.is_a? String
+          data['ss:Type'] = 'String'
+        end
+
+        data << raw_data
+      else
+        cell << data = XML::Node.new('Data')
+        data['ss:Type'] = 'String'
+        data << raw_data
+      end
+      data
+    end
+
+    # A helper method to add an array of data to the Worksheet.
+    #
+    # @param [Array] the Array of Objects being appended to the Worksheet.
+    def add_array(array)
+      for item in array
+        self.add_cell(item)
+      end
+    end
+
+    # Append anything that responds to +:xml+ to the Worksheet
+    def <<(raw_data)
+      if !raw_data.respond_to?(:xml)
+        raise ArgumentError, "Need to have a Excel::Formula"
+      end
+      @row << raw_data.xml
+    end
+
+    # Creates a reference to a cell in this Worksheet to be used in
+    # another Worksheet.
+    def reference(args, equal = '=')
+      Formula.new("#{equal}'#{name}'!#{LibExcel.static(args[:row], args[:col])}")
+    end
+
+    private
+    def table
+      table = XML::Node.new('Table')
+      table['x:FullColumns'] = '1'
+      table['x:FullRows'] = '1'
+      @table = table
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: libexcel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Silas Baronda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- silas.baronda@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/libexcel.rb
+- lib/libexcel/worksheet.rb
+- lib/libexcel/document.rb
+- lib/libexcel/formula.rb
+has_rdoc: true
+homepage: http://github.com/silasb/libexcel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: XML Excel library for ruby
+test_files: []
+