rubyXL-ptr 3.3.27

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30a36596ed8d8dfa9567aac3b553e8064e7ca2c92ac2e842181750cdb6941786
+  data.tar.gz: e4d7b19f3b41b69db294c2575e4a4cfc02295d233171f9b2c6268fc1a3c63099
+SHA512:
+  metadata.gz: 5a8b08b0d5a933878b0b0b8bbcecedec7b2b494800d7db4c29bdbd6a2f0a61261e589d4f3a9043fc9bfbebc733ac95c209f9fc68948a87c316da96b41099f0f4
+  data.tar.gz: e1f349b09c5c1fe8b6fb26af2ca101cffb7ea3e5a60f3c1aee8dae5cc445308b1e6adb587e1fb92fa5a4f934b163bd700202c06aecc7d2153dd7acb57a0118c4

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Dependencies required to run this gem.
+gem "nokogiri", ">= 1.4.4"
+gem "rubyzip", ">= 1.1.6" , :require => 'zip'
+
+# Development dependencies.
+group :development, :test do
+  gem "bundler"
+  gem "rake"
+  gem "jeweler"
+  gem "rspec"
+  gem "simplecov"
+
+#  gem 'stackprof'
+  gem 'ruby-prof'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Vivek Bhagwat, 2013-2014 Wesha
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,229 @@
+= rubyXL
+{<img src="https://badge.fury.io/rb/rubyXL.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rubyXL]
+{<img src="https://codeclimate.com/github/weshatheleopard/rubyXL.png" alt="Code Climate" />}[https://codeclimate.com/github/weshatheleopard/rubyXL]
+
+This gem supports operating on +xlsx+ files (Open XML format). While it is capable
+of properly parsing the entire OOXML structure, its current main emphasis is on
+reading files produced by MS Excel, making minor modifications to them and saving
+them to be opened again, while preserving as much of the structure as possible.
+
+Please note that proprietary binary +xls+ format is *not* supported.
+
+== To Install:
+  gem install rubyXL
+
+== To Use:
+  require 'rubyXL' # Assuming rubygems is already required
+
+=== Parsing an existing workbook
+  workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
+
+=== Creating a new Workbook
+  workbook = RubyXL::Workbook.new
+
+=== Accessing
+
+==== Accessing a Worksheet
+  workbook.worksheets[0] # Returns first worksheet
+  workbook[0]            # Returns first worksheet
+  workbook['Sheet1']     # Finds and returns worksheet titled "Sheet1"
+
+==== Accessing a Row (Array of Cells)
+Please note that worksheet is a _sparse_ array of rows. Your code *must* expect that any row it plucks from the array may be <tt>nil</tt>.
+
+  worksheet = workbook[0]
+  worksheet.sheet_data[0] # Returns first row of the worksheet
+  worksheet[0]            # Returns first row of the worksheet
+
+==== Accessing a Cell object
+Please note that row is a _sparse_ array of cells. Your code *must* expect that any cell it plucks from the array may be <tt>nil</tt>.
+
+  worksheet = workbook[0]
+  worksheet.sheet_data[0][0] # Returns cell A1 in the worksheet
+  worksheet[0][0]            # Returns cell A1 in the worksheet
+
+==== Wrappers for accessing Cell properties
+  cell = workbook[0][0][0]
+  cell.is_struckthrough  # Returns +true+ if the cell is struckthrough, other boolean properties have same syntax
+  cell.font_name
+  cell.font_size
+  cell.font_color
+  cell.fill_color
+  cell.horizontal_alignment
+  cell.vertical_alignment
+  cell.get_border(:top)
+  cell.get_border_color(:top)
+
+==== Wrappers for accessing Row properties 
+Please note: these methods are being phased out in favor of the OOXML object model.
+  worksheet = workbook[0]
+  worksheet.get_row_fill(0)
+  worksheet.get_row_font_name(0)
+  worksheet.get_row_font_size(0)
+  worksheet.get_row_font_color(0)
+  worksheet.is_row_underlined(0)
+  worksheet.get_row_height(0)
+  worksheet.get_row_alignment(0, true)
+  worksheet.get_row_alignment(0, false)
+  worksheet.get_row_border(0, :right)
+  worksheet.get_row_border_color(0, :right)
+
+==== Accessing column properties
+Please note: these methods are being phased out in favor of the OOXML object model.
+  worksheet = workbook[0]
+  worksheet.get_column_fill(0)
+  worksheet.get_column_font_name(0)
+  worksheet.get_column_font_size(0)
+  worksheet.get_column_font_color(0)
+  worksheet.is_column_underlined(0)
+  worksheet.get_column_width(0)
+  worksheet.get_column_alignment(0, :horizontal)
+  worksheet.get_column_alignment(0, :vertical)
+  worksheet.get_column_border(0, :right)
+  worksheet.get_column_border_color(0, :right)
+
+==== Table reading
+In order to discourage unnecessary reshuffling of data in memory, methods +extract_data+ and +get_table+ are being deprecated. You should access and iterate through rows and cells directly:
+
+  worksheet.each { |row|
+     row && row.cells.each { |cell|
+       val = cell && cell.value
+       do_whatever_you_want(val)
+     }
+  }
+
+=== Modifying
+
+==== Adding Worksheets
+  worksheet = workbook.add_worksheet('Sheet2')
+
+==== Renaming Worksheets
+  worksheet.sheet_name = 'Cool New Name'
+
+==== Adding Cells
+  worksheet.add_cell(0, 0, 'A1')      # Sets cell A1 to string "A1"
+  worksheet.add_cell(0, 1, '', 'A1')  # Sets formula in the cell B1 to '=A1'
+ 
+==== Changing Cells
+  worksheet[0][0].change_contents("", worksheet[0][0].formula) # Sets value of cell A1 to empty string, preserves formula
+
+==== Changing Fonts
+  worksheet.sheet_data[0][0].change_font_bold(true) # Makes A1 bold
+  worksheet.change_row_italics(0,true)              # Makes first row italicized
+  worksheet.change_column_font_name(0, 'Courier')   # Makes first column have font Courier
+
+==== Changing Fills	
+  worksheet.sheet_data[0][0].change_fill('0ba53d')  # Sets A1 to have fill #0ba53d
+  worksheet.change_row_fill(0, '0ba53d')            # Sets first row to have fill #0ba53d
+  worksheet.change_column_fill(0, '0ba53d')         # Sets first column to have fill #0ba53d
+
+==== Changing Borders
+  # Possible weights: hairline, thin, medium, thick
+  # Possible "directions": top, bottom, left, right, diagonal
+  worksheet.sheet_data[0][0].change_border(:top, 'thin')  # Sets A1 to have a top, thin border
+  worksheet.change_row_border(0, :left, 'hairline')       # Sets first row to have a left, hairline border
+  worksheet.change_column_border(0, :diagonal, 'medium')  # Sets first column to have diagonal, medium border
+
+  # Set the border style first so there's something to color.
+  worksheet.change_row_border_color(0, :top, '0ba53d')    # Sets first row to have a green top border
+  worksheet.change_column_border_color(0, :top, '0ba53d') # Sets first column to have a green top border
+
+==== Changing Alignment
+===== Horizontal
+center, distributed, justify, left, right
+  worksheet.sheet_data[0][0].change_horizontal_alignment('center') # Sets A1 to be centered
+  worksheet.change_row_horizontal_alignment(0, 'justify')          # Sets first row to be justified
+  worksheet.change_column_horizontal_alignment(0, 'right')         # Sets first column to be right-aligned
+
+===== Vertical
+bottom, center, distributed, top
+  worksheet.sheet_data[0][0].change_vertical_alignment('bottom')  # Sets A1 to be bottom aligned
+  worksheet.change_row_vertical_alignment(0, 'distributed')       # Sets first row to be distributed vertically
+  worksheet.change_column_vertical_alignment(0, 'top')            # Sets first column to be top aligned
+
+==== Changing Row Height
+  worksheet.change_row_height(0, 30)  # Sets first row height to 30
+
+==== Changing Column Width
+  worksheet.change_column_width(0, 30)  # Sets first column width to 30
+
+==== Merging Cells
+  worksheet.merge_cells(0, 0, 1, 1)  # Merges A1:B2
+
+==== Insert Row
+This method will insert a row at specified index, pushing all rows below it down. It also copies styles from row above.
+
+WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted rows
+  worksheet.insert_row(1)
+
+==== Insert Column
+This method will insert a column at specified index, pushing all columns to the right of it one to the right. It also copies styles from column to the left
+
+WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted columns
+  worksheet.insert_column(1)
+
+==== Delete Row
+This method will delete a row at specified index, pushing all rows below it up.
+
+WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted rows
+  worksheet.delete_row(1)
+
+==== Delete Column
+This method will delete a column at specified index, pushing all columns to the right of it left.
+
+WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted columns
+  worksheet.delete_column(1)
+
+==== Insert Cell
+This method will insert a cell at specified position. It takes a :right or :down option, to shift cells either left or down upon inserting (nil means replacing the cell)
+
+WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted cells
+  worksheet.insert_cell(0, 0, "blah", formula = nil, :right)  # Inserts cell at A1, shifts cells in first row right
+  worksheet.insert_cell(0, 0, "blah", formula = nil, :down)   # Inserts cell at A1, shifts cells in first column down
+  worksheet.insert_cell(0, 0, "blah")                         # Inserts cell at A1, shifts nothing
+
+==== Delete Cell
+This method will delete a cell at specified position. It takes a :left or :up option, to shift cells either up or left upon deletion (nil means simply deleting the cell contents)
+
+WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted cells
+  worksheet.delete_cell(0, 0, :left)  # Deletes A1, shifts contents of first row left
+  worksheet.delete_cell(0, 0, :up)    # Deletes A1, shifts contents of first column up
+  worksheet.delete_cell(0, 0)         # Deletes A1, does not shift cells
+
+==== Modifying Cell Format
+  cell = worksheet[0][0]
+  cell.set_number_format '0.0000%'    # For formats, see https://support.office.com/en-us/article/5026bbd6-04bc-48cd-bf33-80f18b4eae68
+
+== I/O
+
+By default, the gem operates with files on the local filesystem:
+
+  workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
+  workbook.write("path/to/desired/Excel/file.xlsx")
+
+It can also operate on +StringIO+ objects, thus eliminating the need to save the +xlsx+ file to disk. This capability comes in handy for web servers.
+
+  workbook = RubyXL::Parser.parse_buffer(buffer)
+  workbook.stream
+
+== Miscellaneous
+  RubyXL::Reference.ind2ref(0,0) == 'A1'    # Converts row and column index to Excel-style cell reference
+  RubyXL::Reference.ref2ind('A1') == [0, 0] # Converts Excel-style cell reference to row and column index
+
+== For more information
+Take a look at the files in spec/lib/ for rspecs on most methods
+
+== Contributing to rubyXL
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Vivek Bhagwat, 2013-2016 Wesha.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,103 @@
+# encoding: utf-8
+require 'rubygems'
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rubyXL"
+  gem.homepage = "http://github.com/gilt/rubyXL"
+  gem.license = "MIT"
+  gem.summary = %Q{rubyXL is a gem which allows the parsing, creation, and manipulation of Microsoft Excel (.xlsx/.xlsm) Documents}
+  gem.description = %Q{rubyXL is a gem which allows the parsing, creation, and manipulation of Microsoft Excel (.xlsx/.xlsm) Documents}
+  gem.email = "bhagwat.vivek@gmail.com"
+  gem.authors = ["Vivek Bhagwat", 'Wesha']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new 
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.warning = true
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rubyXL #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Dump profiling data with stackprof"
+task :stackprof do
+  require 'benchmark'
+  require 'stackprof'
+
+  $:.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
+  require './lib/rubyXL'
+
+  spreadsheets = Dir.glob(File.join("test", "input", "*.xls?")).sort!
+
+  spreadsheets.each { |input|
+    puts "<<<--- Profiling parsing of #{input}..."
+    doc = nil
+    StackProf.run(:mode => :cpu, :interval => 100, 
+                  :out  => "tmp/stackprof-cpu-parse-#{File.basename(input)}.dump") { 
+      doc = RubyXL::Parser.parse(input)
+    }
+
+    output = File.join("test", "output", File.basename(input))
+    puts  "--->>> Profiling writing of #{output}..."
+    StackProf.run(:mode => :cpu, :interval => 100, 
+                  :out  => "tmp/stackprof-cpu-write-#{File.basename(input)}.dump") {
+      doc.write(output)
+    }
+  }
+end
+
+desc "Dump profiling data with ruby-prof"
+task :rubyprof do
+  require 'benchmark'
+  require 'ruby-prof'
+
+  $:.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
+  require './lib/rubyXL'
+
+  spreadsheets = Dir.glob(File.join("test", "input", "*.xls?")).sort!
+
+  spreadsheets.each { |input|
+    puts "<<<--- Profiling parsing of #{input}..."
+    doc = nil
+    result = RubyProf.profile {
+      doc = RubyXL::Parser.parse(input)
+    }
+    printer = RubyProf::CallStackPrinter.new(result)
+    File.open("tmp/ruby-prof-parse-#{File.basename(input)}.html", 'w') { |f| printer.print(f, {}) }
+
+    output = File.join("test", "output", File.basename(input))
+    puts  "--->>> Profiling writing of #{output}..."
+    result = RubyProf.profile {
+      doc.write(output)
+    }
+    printer = RubyProf::CallStackPrinter.new(result)
+    File.open("tmp/ruby-prof-write-#{File.basename(input)}.html", 'w') { |f| printer.print(f, {}) }
+  }
+end

data/VERSION

@@ -0,0 +1 @@
+3.3.27

data/lib/rubyXL.rb

@@ -0,0 +1,12 @@
+require 'rubyXL/objects/root'
+require 'rubyXL/parser'
+
+module RubyXL
+
+  # Convert any path passed to absolute path (within the XLSX file).
+  def self.from_root(path)
+    return path unless path.absolute?
+    path.relative_path_from(OOXMLTopLevelObject::ROOT)
+  end
+
+end

data/lib/rubyXL/cell.rb

@@ -0,0 +1,54 @@
+module RubyXL
+
+  # http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.cellvalues(v=office.14).aspx
+  module DataType
+    SHARED_STRING = 's'
+    RAW_STRING    = 'str'
+    INLINE_STRING = 'inlineStr'
+    ERROR         = 'e'
+    BOOLEAN       = 'b'
+    NUMBER        = 'n'
+    DATE          = 'd'  # Only available in Office2010.
+  end
+
+  module LegacyCell
+    attr_accessor :formula, :worksheet
+
+    def workbook
+      @worksheet.workbook
+    end
+
+    private
+
+    def validate_workbook()
+      unless workbook.nil? || workbook.worksheets.nil?
+        workbook.worksheets.each { |sheet|
+          unless sheet.nil? || sheet.sheet_data.nil? || sheet.sheet_data[row].nil?
+            if sheet.sheet_data[row][column] == self
+              return
+            end
+          end
+        }
+      end
+      raise "This cell #{self} is not in workbook #{workbook}"
+    end
+
+    def validate_worksheet()
+      return if @worksheet && @worksheet[row] && @worksheet[row][column].equal?(self)
+      raise "Cell #{self} is not in worksheet #{worksheet}"
+    end
+
+    def get_cell_xf
+      workbook.cell_xfs[self.style_index || 0]
+    end
+
+    def get_cell_font
+      workbook.fonts[get_cell_xf.font_id]
+    end
+
+    def get_cell_border
+      workbook.borders[get_cell_xf.border_id]
+    end
+
+  end
+end