oxcelix 0.1.1 → 0.2.0

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--private

data/CHANGES

@@ -0,0 +1,11 @@
+
+08/10: The sheet class now inherits Matrix. Sheet can return a cell based on its excel name. Sheet::data is obsolete - deleted. Moved r, v, s to the Cellvalues module - they are not needed elsewhere but the Cell class. Documentation changes. .yardopts file added.
+slight documentation changes, yard options added to (protected and private methods docs are now readable)
+
+07/10: Changed gem version
+Removed sharedstrings and sheetbase properties as they were useless. Docs updated with the change.
+Update oxcelix.gemspec
+Raised visibility in rdoc, so that all method documentation gets readable.
+Update workbook.rb
+replaced Ox::load_file with IO.read + Ox::load in workbook, as apparently workbook.xml could not be loaded under windows using that method
+Minor typos corrected, added gemspec

data/lib/oxcelix.rb

@@ -13,7 +13,7 @@ require 'oxcelix/sax/xlsheet'
 
 class String
   # Returns true if the given String represents a numeric value 
-  # @return [Bool]
+  # @return [Bool] true if the string represents a numeric value, false if it doesn't.
   def numeric?
     Float(self) != nil rescue false
   end

data/lib/oxcelix/cell.rb

@@ -13,5 +13,6 @@ module Oxcelix
   class Cell
     attr_accessor :xlcoords, :type, :value, :comment, :style
     include Cellhelper
+    include Cellvalues
   end
 end

data/lib/oxcelix/cellhelper.rb

@@ -1,7 +1,7 @@
 
 module Oxcelix
   # The Cellhelper module defines some methods useful to manipulate Cell objects
-  module Cellhelper
+  module Cellvalues
     # Set the excel cell name (eg: 'A2')
     # @param [String] val Excel cell address name
     def r(val); @xlcoords = val; end;
@@ -11,7 +11,9 @@ module Oxcelix
     def v(val); @value = val; end;
     # Set cell style (number format and style) 
     def s(val); @style = val; end;
-    
+  end
+  
+  module Cellhelper
     # When called without parameters, returns the x coordinate of the calling cell object based on the value of #@xlcoords
     # If a parameter is given, #x will return the x coordinate corresponding to the parameter
     # @example find x coordinate (column number) of a cell

data/lib/oxcelix/sax/comments.rb

@@ -1,6 +1,10 @@
 module Oxcelix
 # The Comments class is a parser which builds an array of comments
   class Comments < ::Ox::Sax
+    # @!attribute [rw] commarray
+    #   @return [Array] the array of all comments of a given sheet
+    # @!attribute [rw] comment
+    #   @return [Hash] a hash representing a comment
     attr_accessor :commarray, :comment
     def initialize
       @commarray=[]

data/lib/oxcelix/sax/sharedstrings.rb

@@ -2,6 +2,8 @@ module Oxcelix
   # Ox based SAX parser which pushes shared strings (taken from the sharedString.xml file) to an array 
   # These strings will replace the references in the cells (interpolation). 
   class Sharedstrings < ::Ox::Sax
+    # @!attribute [rw] stringarray
+    #   @return [Array] the array of all the strings found in sharedStrings.xml
     attr_accessor :stringarray
     def initialize
       @stringarray=[]

data/lib/oxcelix/sheet.rb

@@ -1,17 +1,29 @@
 
 module Oxcelix
   # The Sheet class represents an excel sheet.
+  class Sheet < Matrix
+    include Cellhelper
   # @!attribute [rw] name
   #   @return [String] Sheet name
   # @!attribute [rw] sheetId
   #   @return [String] returns the sheetId SheetML internal attribute
   # @!attribute [rw] relationId
-  #   @return [String] returns the relation key used to reference the comments file related to a certain sheet.
-  # @!attribute [rw] data
-  #   @return [Array] stores the collection of cells of a certain sheet. This is the copy of the sum of cellarray and mergedcells.
-  #   This is laterconverted to a matrix
-  class Sheet
-    attr_accessor :name, :sheetId, :relationId, :data
-    def initialize; @data=[]; end
+  #   @return [String] Internal reference key. relationID is used internally by Excel 2010 to e.g. build up the relationship between worksheets and comments
+    attr_accessor :name, :sheetId, :relationId
+
+    # The [] method overrides the standard Matrix::[]. It will now accept Excel-style cell coordinates.
+    # @param [String] i
+    # @return [Cell] the object denoted with the Excel column-row name.
+    # @example Select a cell in a sheet
+    #   w = Oxcelix::Workbook.new('Example.xlsx')
+    #   w.sheets[0][3,1] #=> #<Oxcelix::Cell:0x00000001e00fa0 @xlcoords="B4", @style="0", @type="n", @value="3">
+    #   w.sheets[0]['B4'] #=> #<Oxcelix::Cell:0x00000001e00fa0 @xlcoords="B4", @style="0", @type="n", @value="3">
+    def [](i, *j)
+      if i.is_a? String
+        super(y(i),x(i))
+      else
+        super(i,j[0])
+      end
+    end
   end
 end

data/lib/oxcelix/workbook.rb

@@ -15,13 +15,13 @@ module Oxcelix
   # The Workbook class will open the excel file, and convert it to a collection of
   # Matrix objects
   # @!attribute [rw] sheets
-  #   @return [Array] sheets Collection of {Sheet} objects 
+  #   @return [Array] a collection of {Sheet} objects 
   class Workbook
     include Cellhelper
     include Workbookhelper
     attr_accessor :sheets
     ##
-    # Create a new Workbook object.
+    # Create a new {Workbook} object.
     #
     # filename is the name of the Excel 2007/2010 file to be opened (xlsx)
     #
@@ -176,11 +176,12 @@ module Oxcelix
     # 
     # The matrix will replace the array of cells in the actual sheet.
     # @param [Bool ] copymerge 
-    # @return [Matrix] a Matrix that stores the cell values, and, depending on the copymerge parameter, will copy the merged value
+    # @return [Matrix] a Matrix object that stores the cell values, and, depending on the copymerge parameter, will copy the merged value
     #  into every merged cell
     def matrixto(copymerge)
       @sheets.each_with_index do |sheet, i|
-        m=Matrix.build(sheet[:cells].last.y+1, sheet[:cells].last.x+1) {nil}
+        #m=Matrix.build(sheet[:cells].last.y+1, sheet[:cells].last.x+1) {nil}
+        m=Sheet.build(sheet[:cells].last.y+1, sheet[:cells].last.x+1) {nil}
         sheet[:cells].each do |c|
           m[c.y, c.x]=c
         end
@@ -207,10 +208,8 @@ module Oxcelix
             end
           end
         end
-        s=Sheet.new
-        s.name=@sheets[i][:name]; s.sheetId=@sheets[i][:sheetId]; s.relationId=@sheets[i][:relationId]
-        s.data=m
-        @sheets[i]=s
+        m.name=@sheets[i][:name]; m.sheetId=@sheets[i][:sheetId]; m.relationId=@sheets[i][:relationId]
+        @sheets[i]=m
       end
     end
   end

data/oxcelix.gemspec

@@ -3,8 +3,8 @@
 require 'rake'
 Gem::Specification.new do |s|
   s.name	= 'oxcelix'
-  s.version	= '0.1.1'
-  s.date	= '2013-10-06'
+  s.version	= '0.2.0'
+  s.date	= '2013-10-08'
   s.summary	= 'A fast Excel 2007/2010 file parser'
   s.description	= 'A fast .xlsx file  parser that returns a collection of Matrix objects'
   s.authors	= 'Giovanni Biczo'
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 
   s.files	= FileList["LICENSE", "README.rdoc", "README.md",
 		  "lib/*", "lib/oxcelix/*", "lib/oxcelix/sax/*",
-		  "oxcelix.gemspec", "spec/*"].to_a
+		  "oxcelix.gemspec", "spec/*", ".yardopts", "CHANGES"].to_a
   s.license	= 'MIT'
   
   s.add_runtime_dependency "ox", [">= 2.0.6"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxcelix
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -68,6 +68,8 @@ files:
 - spec/cell_spec.rb
 - spec/matrix_spec.rb
 - spec/string_spec.rb
+- .yardopts
+- CHANGES
 homepage: http://github.com/gbiczo/oxcelix
 licenses:
 - MIT