rubyXL 3.3.29 → 3.4.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 07e72e7675b581c19399a3f4f5ce60790b3e1cb2
-  data.tar.gz: f2a67aee8be9391fd9d58c44886cff21a3df5af7
+SHA256:
+  metadata.gz: 14119a8af99822bbe1fd209a060d5374e92fe921750766cc83fa2cebdf586963
+  data.tar.gz: a3870a59650bd9b32c82bd6ad950aa720cb9f50370b96956eecb522d1c8e8fce
 SHA512:
-  metadata.gz: 7aa59896e1ca74f38545b426e0d8fad613fd341ec06781724df2c82e94857149129b328ff5186b09cc0df377d78140c1162aa69bec3013b288f35c030f823c27
-  data.tar.gz: 2cf93d0b03520e8cc7ec955dee92fdd14dacca0647369e7a071ce02598b2db63597326d928143d2ec674c560b8aa26a57fc4c2c0996fc8d634d584128c1b099e
+  metadata.gz: 27f8bf50de4801721703c78a73b156626998d37a7fa1ce76a05e2848d9bf233a29ed91044567b2b02a8cd29487872f2a5ed2eeeb65c45ae6b3fed8b4bfccea25
+  data.tar.gz: 7ba264f255d544ba9efb9bb5aaa272a2ba84442930bf41eb72c6a63571b0ed21a69255975c843b796725ce17ca29c81950b1784a0c027a54dc35e4801ea0870e

data/.circleci/config.yml

@@ -0,0 +1,60 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: cimg/ruby:3.1.4
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.rubocop.yml

@@ -0,0 +1,124 @@
+#inherit_from: .rubocop_todo.yml
+
+#require:
+#  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - test/**/*
+    - tmp/*
+    - vendor/**/*
+    - Gemfile
+    - rubyXL.gemspec
+
+# "Excessive" parentheses are your friend. You will understand it in time, Luke.
+Style/TernaryParentheses:
+  Enabled: false
+
+# Implicity is evil. Unwilingness to type a couple extra characters is laziness.
+Style/RedundantConstantBase:
+  Enabled: false
+
+# I don't see a good reason in this. Unless you are paid per line.
+Style/CommentedKeyword:
+  Enabled: false
+
+# Yes, some things are "redundant" but they are there exactly to drive home some point...
+Style/RedundantSelf:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/MultilineIfThen:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+Style/MultilineWhenThen:
+  Enabled: false
+
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: space 
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table 
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
+
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# v3.4.25 (May 19, 2022)
+
+* Improve code style and consistently (@weshatheleopard)
+* Update `Gemfile.lock`, dependency versions used when developing the gem (@weshatheleopard)
+
+# v3.4.24 (May 16, 2022)
+
+* Add `Cell#add_hyperlink` for adding a hyperlink to a cell (@weshatheleopard)
+* Add `Reference#valid?` for checking if a cell reference is valid (@weshatheleopard)
+* Add `Worksheet#cell_at` for finding a cell by its Excel-style reference (@weshatheleopard)
+* Prevent creation of sheets with reserved names (specifically, `History`) (@weshatheleopard)
+* Update `Gemfile.lock`, dependency versions used when developing the gem (@weshatheleopard)

data/Gemfile

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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Vivek Bhagwat, 2013-2014 Wesha
+Copyright (c) 2011 Vivek Bhagwat, 2013-2020 Wesha
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,13 +1,14 @@
 = 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]
+{rdoc-image:https://badge.fury.io/rb/rubyXL.svg}[http://badge.fury.io/rb/rubyXL]
+{rdoc-image:https://codeclimate.com/github/weshatheleopard/rubyXL.png}[https://codeclimate.com/github/weshatheleopard/rubyXL]
+{rdoc-image:https://circleci.com/gh/weshatheleopard/rubyXL.svg?style=svg}[https://circleci.com/gh/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.
+Please note that proprietary binary +xls+ format is *not* supported by this gem. If you need to parse those files, try {spreadsheet}[https://github.com/zdavatz/spreadsheet] gem.
 
 == To Install:
   gem install rubyXL
@@ -15,6 +16,18 @@ Please note that proprietary binary +xls+ format is *not* supported.
 == To Use:
   require 'rubyXL' # Assuming rubygems is already required
 
+=== Convenience methods
+
+Starting with version 3.4.0, the main data structure has been separated from the convenience methods that provide access to individual features of the +xlsx+ format, in order to decrease the memory footprint. If you intend to use these features, you will need to additionally include the respective files:
+  require 'rubyXL/convenience_methods/cell'
+  require 'rubyXL/convenience_methods/color'
+  require 'rubyXL/convenience_methods/font'
+  require 'rubyXL/convenience_methods/workbook'
+  require 'rubyXL/convenience_methods/worksheet'
+
+If you do not care about your RAM usage, just include them all at once by adding the following line to your code so it can continue operating just as before:
+  require 'rubyXL/convenience_methods'
+
 === Parsing an existing workbook
   workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
 
@@ -26,7 +39,7 @@ Please note that proprietary binary +xls+ format is *not* supported.
 ==== Accessing a Worksheet
   workbook.worksheets[0] # Returns first worksheet
   workbook[0]            # Returns first worksheet
-  workbook['Sheet1']     # Finds and returns worksheet titled "Sheet1"
+  workbook['Sheet1']     # Finds and returns worksheet titled "Sheet1". Note that sheet names in Excel are limited to 31 character.
 
 ==== 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>.
@@ -42,6 +55,14 @@ Please note that row is a _sparse_ array of cells. Your code *must* expect that
   worksheet.sheet_data[0][0] # Returns cell A1 in the worksheet
   worksheet[0][0]            # Returns cell A1 in the worksheet
 
+  cell = worksheet[0][0]
+  cell.value                 # Returns a properly converted value in the cell (if the file claims that the cell
+                             # is holding a number, returns a respective Integer or Float, and so on).
+
+Or, if you prefer Excel-style references (single-cell only!)
+
+  cell = worksheet.cell_at('B11')
+
 ==== 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
@@ -53,6 +74,7 @@ Please note that row is a _sparse_ array of cells. Your code *must* expect that
   cell.vertical_alignment
   cell.get_border(:top)
   cell.get_border_color(:top)
+  cell.text_rotation
 
 ==== Wrappers for accessing Row properties 
 Please note: these methods are being phased out in favor of the OOXML object model.
@@ -82,23 +104,13 @@ Please note: these methods are being phased out in favor of the OOXML object mod
   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'
+  worksheet.sheet_name = 'Cool New Name' # Note that sheet name is limited to 31 characters by Excel.
 
 ==== Adding Cells
   worksheet.add_cell(0, 0, 'A1')      # Sets cell A1 to string "A1"
@@ -130,16 +142,24 @@ In order to discourage unnecessary reshuffling of data in memory, methods +extra
 
 ==== Changing Alignment
 ===== Horizontal
-center, distributed, justify, left, right
+  # Possible alignments: 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
+  # Possible alignments: 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
+  
+===== Rotation
+  # Possible values:
+  # * 0-90 - degrees counterclockwise, around the bottom LEFT corner of the cell;
+  # * 91-179 - degrees clockwise, around the bottom RIGHT corner of the cell;
+  # * 180-254 - degrees clockwise, around the bottom LEFT corner of the cell, text becomes progressively invisible
+  # * 255 - text is in normal rotation but displayed vertically (one letter under another), line feed starts new line to the right of the previous.
+  worksheet.sheet_data[0][0].change_text_rotation(90)  # Sets A1 to be rotated by 90 degrees
 
 ==== Changing Row Height
   worksheet.change_row_height(0, 30)  # Sets first row height to 30
@@ -148,7 +168,9 @@ bottom, center, distributed, top
   worksheet.change_column_width(0, 30)  # Sets first column width to 30
 
 ==== Merging Cells
-  worksheet.merge_cells(0, 0, 1, 1)  # Merges A1:B2
+  worksheet.merge_cells(0, 1, 2, 3)  # Merges B1:D3
+  worksheet.merge_cells('A2:C4')     # Merges A2:C4
+  worksheet.merge_cells(row_from: 0, row_to: 1, col_from 2:, col_to: 3) # Merges C1:D2
 
 ==== Insert Row
 This method will insert a row at specified index, pushing all rows below it down. It also copies styles from row above.
@@ -193,6 +215,14 @@ WARNING: Use of this method WILL break formulas referencing cells which have bee
 ==== 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
+  cell.change_text_wrap(true)         # Makes the text in the cell to wrap.
+  cell.change_shrink_to_fit(true)     # Makes the text in the cell to shrink to fit.
+  cell.change_text_indent(1)          # Indents the text in the cell by 1 level
+
+==== Add hyperlink to a Cell
+  cell.add_hyperlink('http://example.com')
+  cell.add_hyperlink('http://example.com', 'Some tooltip text')
+
 
 == I/O
 
@@ -210,6 +240,14 @@ It can also operate on +StringIO+ objects, thus eliminating the need to save the
   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
 
+=== Suppress warnings about malformed input files
+
+  RubyXL.class_variable_set(:@@suppress_warnings, true)
+
+== Data validation (colloquially referred to as "dropdown list")
+
+  worksheet.add_validation_list("A1", [ "value1", "value2" ])
+
 == For more information
 Take a look at the files in spec/lib/ for rspecs on most methods
 
@@ -225,5 +263,5 @@ Take a look at the files in spec/lib/ for rspecs on most methods
 
 == Copyright
 
-Copyright (c) 2011 Vivek Bhagwat, 2013-2016 Wesha.
+Copyright (c) 2011 Vivek Bhagwat, 2013-2022 Wesha.
 See LICENSE.txt for further details.

data/Rakefile

@@ -1,28 +1,28 @@
-# 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"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
+require 'juwelier'
+Juwelier::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']
+  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']
+#  gem.required_ruby_version = '>2.1'
   # dependencies defined in Gemfile
 end
-Jeweler::RubygemsDotOrgTasks.new 
+Juwelier::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -33,12 +33,12 @@ Rake::TestTask.new(:test) do |test|
 end
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+RSpec::Core::RakeTask.new(:rspec)
+task :default => :rspec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "rubyXL #{version}"
@@ -46,42 +46,42 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc "Dump profiling data with stackprof"
+desc 'Dump profiling data with stackprof'
 task :stackprof do
   require 'benchmark'
   require 'stackprof'
 
-  $:.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
   require './lib/rubyXL'
 
-  spreadsheets = Dir.glob(File.join("test", "input", "*.xls?")).sort!
+  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") { 
+    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, 
+    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"
+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
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
   require './lib/rubyXL'
 
-  spreadsheets = Dir.glob(File.join("test", "input", "*.xls?")).sort!
+  spreadsheets = Dir.glob(File.join('test', 'input', '*.xls?')).sort!
 
   spreadsheets.each { |input|
     puts "<<<--- Profiling parsing of #{input}..."
@@ -92,8 +92,8 @@ task :rubyprof do
     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}..."
+    output = File.join('test', 'output', File.basename(input))
+    puts "--->>> Profiling writing of #{output}..."
     result = RubyProf.profile {
       doc.write(output)
     }

data/VERSION

@@ -1 +1 @@
-3.3.29
+3.4.33

data/lib/rubyXL/cell.rb

@@ -1,26 +1,12 @@
 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()
+    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?
@@ -33,22 +19,9 @@ module RubyXL
       raise "This cell #{self} is not in workbook #{workbook}"
     end
 
-    def validate_worksheet()
+    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